]>
Commit | Line | Data |
---|---|---|
f44d2db2 | 1 | ## |
50bd5d25 | 2 | ## This file is part of the libsigrokdecode project. |
f44d2db2 | 3 | ## |
0bb7bcf3 | 4 | ## Copyright (C) 2011-2014 Uwe Hermann <uwe@hermann-uwe.de> |
f44d2db2 UH |
5 | ## |
6 | ## This program is free software; you can redistribute it and/or modify | |
7 | ## it under the terms of the GNU General Public License as published by | |
8 | ## the Free Software Foundation; either version 2 of the License, or | |
9 | ## (at your option) any later version. | |
10 | ## | |
11 | ## This program is distributed in the hope that it will be useful, | |
12 | ## but WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 | ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
14 | ## GNU General Public License for more details. | |
15 | ## | |
16 | ## You should have received a copy of the GNU General Public License | |
4539e9ca | 17 | ## along with this program; if not, see <http://www.gnu.org/licenses/>. |
f44d2db2 UH |
18 | ## |
19 | ||
677d597b | 20 | import sigrokdecode as srd |
5166b031 | 21 | from common.srdhelper import bitpack |
b5712ccb | 22 | from math import floor, ceil |
f44d2db2 | 23 | |
4cace3b8 | 24 | ''' |
c515eed7 | 25 | OUTPUT_PYTHON format: |
4cace3b8 | 26 | |
bf69977d UH |
27 | Packet: |
28 | [<ptype>, <rxtx>, <pdata>] | |
4cace3b8 | 29 | |
bf69977d | 30 | This is the list of <ptype>s and their respective <pdata> values: |
4cace3b8 | 31 | - 'STARTBIT': The data is the (integer) value of the start bit (0/1). |
0c7d5a56 UH |
32 | - 'DATA': This is always a tuple containing two items: |
33 | - 1st item: the (integer) value of the UART data. Valid values | |
6ffd71c1 | 34 | range from 0 to 511 (as the data can be up to 9 bits in size). |
0c7d5a56 | 35 | - 2nd item: the list of individual data bits and their ss/es numbers. |
4cace3b8 UH |
36 | - 'PARITYBIT': The data is the (integer) value of the parity bit (0/1). |
37 | - 'STOPBIT': The data is the (integer) value of the stop bit (0 or 1). | |
38 | - 'INVALID STARTBIT': The data is the (integer) value of the start bit (0/1). | |
39 | - 'INVALID STOPBIT': The data is the (integer) value of the stop bit (0/1). | |
40 | - 'PARITY ERROR': The data is a tuple with two entries. The first one is | |
41 | the expected parity value, the second is the actual parity value. | |
42 | - TODO: Frame error? | |
43 | ||
44 | The <rxtx> field is 0 for RX packets, 1 for TX packets. | |
45 | ''' | |
46 | ||
97cca21f UH |
47 | # Used for differentiating between the two data directions. |
48 | RX = 0 | |
49 | TX = 1 | |
50 | ||
f44d2db2 UH |
51 | # Given a parity type to check (odd, even, zero, one), the value of the |
52 | # parity bit, the value of the data, and the length of the data (5-9 bits, | |
53 | # usually 8 bits) return True if the parity is correct, False otherwise. | |
a7fc4c34 | 54 | # 'none' is _not_ allowed as value for 'parity_type'. |
f44d2db2 UH |
55 | def parity_ok(parity_type, parity_bit, data, num_data_bits): |
56 | ||
57 | # Handle easy cases first (parity bit is always 1 or 0). | |
a7fc4c34 | 58 | if parity_type == 'zero': |
f44d2db2 | 59 | return parity_bit == 0 |
a7fc4c34 | 60 | elif parity_type == 'one': |
f44d2db2 UH |
61 | return parity_bit == 1 |
62 | ||
63 | # Count number of 1 (high) bits in the data (and the parity bit itself!). | |
ac941bf9 | 64 | ones = bin(data).count('1') + parity_bit |
f44d2db2 UH |
65 | |
66 | # Check for odd/even parity. | |
a7fc4c34 | 67 | if parity_type == 'odd': |
ac941bf9 | 68 | return (ones % 2) == 1 |
a7fc4c34 | 69 | elif parity_type == 'even': |
ac941bf9 | 70 | return (ones % 2) == 0 |
f44d2db2 | 71 | |
21cda951 UH |
72 | class SamplerateError(Exception): |
73 | pass | |
74 | ||
f04964c6 UH |
75 | class ChannelError(Exception): |
76 | pass | |
77 | ||
677d597b | 78 | class Decoder(srd.Decoder): |
dcd3d626 | 79 | api_version = 3 |
f44d2db2 UH |
80 | id = 'uart' |
81 | name = 'UART' | |
3d3da57d | 82 | longname = 'Universal Asynchronous Receiver/Transmitter' |
a465436e | 83 | desc = 'Asynchronous, serial bus.' |
f44d2db2 UH |
84 | license = 'gplv2+' |
85 | inputs = ['logic'] | |
86 | outputs = ['uart'] | |
6a15597a | 87 | optional_channels = ( |
f44d2db2 UH |
88 | # Allow specifying only one of the signals, e.g. if only one data |
89 | # direction exists (or is relevant). | |
29ed0f4c UH |
90 | {'id': 'rx', 'name': 'RX', 'desc': 'UART receive line'}, |
91 | {'id': 'tx', 'name': 'TX', 'desc': 'UART transmit line'}, | |
da9bcbd9 | 92 | ) |
84c1c0b5 BV |
93 | options = ( |
94 | {'id': 'baudrate', 'desc': 'Baud rate', 'default': 115200}, | |
95 | {'id': 'num_data_bits', 'desc': 'Data bits', 'default': 8, | |
96 | 'values': (5, 6, 7, 8, 9)}, | |
97 | {'id': 'parity_type', 'desc': 'Parity type', 'default': 'none', | |
98 | 'values': ('none', 'odd', 'even', 'zero', 'one')}, | |
99 | {'id': 'parity_check', 'desc': 'Check parity?', 'default': 'yes', | |
100 | 'values': ('yes', 'no')}, | |
101 | {'id': 'num_stop_bits', 'desc': 'Stop bits', 'default': 1.0, | |
102 | 'values': (0.0, 0.5, 1.0, 1.5)}, | |
103 | {'id': 'bit_order', 'desc': 'Bit order', 'default': 'lsb-first', | |
104 | 'values': ('lsb-first', 'msb-first')}, | |
ea36c198 | 105 | {'id': 'format', 'desc': 'Data format', 'default': 'hex', |
84c1c0b5 | 106 | 'values': ('ascii', 'dec', 'hex', 'oct', 'bin')}, |
4eafeeef DB |
107 | {'id': 'invert_rx', 'desc': 'Invert RX?', 'default': 'no', |
108 | 'values': ('yes', 'no')}, | |
109 | {'id': 'invert_tx', 'desc': 'Invert TX?', 'default': 'no', | |
110 | 'values': ('yes', 'no')}, | |
84c1c0b5 | 111 | ) |
da9bcbd9 BV |
112 | annotations = ( |
113 | ('rx-data', 'RX data'), | |
114 | ('tx-data', 'TX data'), | |
115 | ('rx-start', 'RX start bits'), | |
116 | ('tx-start', 'TX start bits'), | |
117 | ('rx-parity-ok', 'RX parity OK bits'), | |
118 | ('tx-parity-ok', 'TX parity OK bits'), | |
119 | ('rx-parity-err', 'RX parity error bits'), | |
120 | ('tx-parity-err', 'TX parity error bits'), | |
121 | ('rx-stop', 'RX stop bits'), | |
122 | ('tx-stop', 'TX stop bits'), | |
123 | ('rx-warnings', 'RX warnings'), | |
124 | ('tx-warnings', 'TX warnings'), | |
125 | ('rx-data-bits', 'RX data bits'), | |
126 | ('tx-data-bits', 'TX data bits'), | |
127 | ) | |
2ce20a91 | 128 | annotation_rows = ( |
4e3b276a | 129 | ('rx-data', 'RX', (0, 2, 4, 6, 8)), |
4aedd5b8 | 130 | ('rx-data-bits', 'RX bits', (12,)), |
4e3b276a | 131 | ('rx-warnings', 'RX warnings', (10,)), |
4aedd5b8 UH |
132 | ('tx-data', 'TX', (1, 3, 5, 7, 9)), |
133 | ('tx-data-bits', 'TX bits', (13,)), | |
4e3b276a | 134 | ('tx-warnings', 'TX warnings', (11,)), |
2ce20a91 | 135 | ) |
0bb7bcf3 UH |
136 | binary = ( |
137 | ('rx', 'RX dump'), | |
138 | ('tx', 'TX dump'), | |
139 | ('rxtx', 'RX/TX dump'), | |
140 | ) | |
96a044da | 141 | idle_state = ['WAIT FOR START BIT', 'WAIT FOR START BIT'] |
f44d2db2 | 142 | |
97cca21f | 143 | def putx(self, rxtx, data): |
b5712ccb PA |
144 | s, halfbit = self.startsample[rxtx], self.bit_width / 2.0 |
145 | self.put(s - floor(halfbit), self.samplenum + ceil(halfbit), self.out_ann, data) | |
15ac6604 | 146 | |
4aedd5b8 | 147 | def putpx(self, rxtx, data): |
b5712ccb PA |
148 | s, halfbit = self.startsample[rxtx], self.bit_width / 2.0 |
149 | self.put(s - floor(halfbit), self.samplenum + ceil(halfbit), self.out_python, data) | |
4aedd5b8 | 150 | |
15ac6604 | 151 | def putg(self, data): |
b5712ccb PA |
152 | s, halfbit = self.samplenum, self.bit_width / 2.0 |
153 | self.put(s - floor(halfbit), s + ceil(halfbit), self.out_ann, data) | |
15ac6604 UH |
154 | |
155 | def putp(self, data): | |
b5712ccb PA |
156 | s, halfbit = self.samplenum, self.bit_width / 2.0 |
157 | self.put(s - floor(halfbit), s + ceil(halfbit), self.out_python, data) | |
97cca21f | 158 | |
0bb7bcf3 | 159 | def putbin(self, rxtx, data): |
b5712ccb | 160 | s, halfbit = self.startsample[rxtx], self.bit_width / 2.0 |
2f370328 | 161 | self.put(s - floor(halfbit), self.samplenum + ceil(halfbit), self.out_binary, data) |
0bb7bcf3 | 162 | |
92b7b49f | 163 | def __init__(self): |
10aeb8ea GS |
164 | self.reset() |
165 | ||
166 | def reset(self): | |
f372d597 | 167 | self.samplerate = None |
f44d2db2 | 168 | self.samplenum = 0 |
97cca21f UH |
169 | self.frame_start = [-1, -1] |
170 | self.startbit = [-1, -1] | |
171 | self.cur_data_bit = [0, 0] | |
e9a3c933 | 172 | self.datavalue = [0, 0] |
1ccef461 | 173 | self.paritybit = [-1, -1] |
97cca21f UH |
174 | self.stopbit1 = [-1, -1] |
175 | self.startsample = [-1, -1] | |
2b716038 | 176 | self.state = ['WAIT FOR START BIT', 'WAIT FOR START BIT'] |
4aedd5b8 | 177 | self.databits = [[], []] |
f44d2db2 | 178 | |
f372d597 | 179 | def start(self): |
c515eed7 | 180 | self.out_python = self.register(srd.OUTPUT_PYTHON) |
2f370328 | 181 | self.out_binary = self.register(srd.OUTPUT_BINARY) |
be465111 | 182 | self.out_ann = self.register(srd.OUTPUT_ANN) |
98b89139 | 183 | self.bw = (self.options['num_data_bits'] + 7) // 8 |
f44d2db2 | 184 | |
f372d597 BV |
185 | def metadata(self, key, value): |
186 | if key == srd.SRD_CONF_SAMPLERATE: | |
35b380b1 | 187 | self.samplerate = value |
f372d597 BV |
188 | # The width of one UART bit in number of samples. |
189 | self.bit_width = float(self.samplerate) / float(self.options['baudrate']) | |
f44d2db2 | 190 | |
dcd3d626 | 191 | def get_sample_point(self, rxtx, bitnum): |
0b83932c | 192 | # Determine absolute sample number of a bit slot's sample point. |
f44d2db2 UH |
193 | # bitpos is the samplenumber which is in the middle of the |
194 | # specified UART bit (0 = start bit, 1..x = data, x+1 = parity bit | |
195 | # (if used) or the first stop bit, and so on). | |
b5712ccb PA |
196 | # The samples within bit are 0, 1, ..., (bit_width - 1), therefore |
197 | # index of the middle sample within bit window is (bit_width - 1) / 2. | |
198 | bitpos = self.frame_start[rxtx] + (self.bit_width - 1) / 2.0 | |
f44d2db2 | 199 | bitpos += bitnum * self.bit_width |
dcd3d626 GS |
200 | return bitpos |
201 | ||
dcd3d626 | 202 | def wait_for_start_bit(self, rxtx, signal): |
f44d2db2 | 203 | # Save the sample number where the start bit begins. |
97cca21f | 204 | self.frame_start[rxtx] = self.samplenum |
f44d2db2 | 205 | |
2b716038 | 206 | self.state[rxtx] = 'GET START BIT' |
f44d2db2 | 207 | |
97cca21f | 208 | def get_start_bit(self, rxtx, signal): |
97cca21f | 209 | self.startbit[rxtx] = signal |
f44d2db2 | 210 | |
711d0602 GS |
211 | # The startbit must be 0. If not, we report an error and wait |
212 | # for the next start bit (assuming this one was spurious). | |
97cca21f | 213 | if self.startbit[rxtx] != 0: |
15ac6604 | 214 | self.putp(['INVALID STARTBIT', rxtx, self.startbit[rxtx]]) |
76a4498f | 215 | self.putg([rxtx + 10, ['Frame error', 'Frame err', 'FE']]) |
711d0602 GS |
216 | self.state[rxtx] = 'WAIT FOR START BIT' |
217 | return | |
f44d2db2 | 218 | |
97cca21f | 219 | self.cur_data_bit[rxtx] = 0 |
e9a3c933 | 220 | self.datavalue[rxtx] = 0 |
97cca21f | 221 | self.startsample[rxtx] = -1 |
f44d2db2 | 222 | |
15ac6604 | 223 | self.putp(['STARTBIT', rxtx, self.startbit[rxtx]]) |
2ce20a91 | 224 | self.putg([rxtx + 2, ['Start bit', 'Start', 'S']]) |
f44d2db2 | 225 | |
4bb42a91 GS |
226 | self.state[rxtx] = 'GET DATA BITS' |
227 | ||
97cca21f | 228 | def get_data_bits(self, rxtx, signal): |
15ac6604 | 229 | # Save the sample number of the middle of the first data bit. |
97cca21f UH |
230 | if self.startsample[rxtx] == -1: |
231 | self.startsample[rxtx] = self.samplenum | |
f44d2db2 | 232 | |
4aedd5b8 UH |
233 | self.putg([rxtx + 12, ['%d' % signal]]) |
234 | ||
235 | # Store individual data bits and their start/end samplenumbers. | |
236 | s, halfbit = self.samplenum, int(self.bit_width / 2) | |
237 | self.databits[rxtx].append([signal, s - halfbit, s + halfbit]) | |
238 | ||
f44d2db2 | 239 | # Return here, unless we already received all data bits. |
5e3c79fd GS |
240 | self.cur_data_bit[rxtx] += 1 |
241 | if self.cur_data_bit[rxtx] < self.options['num_data_bits']: | |
1bb57ab8 | 242 | return |
f44d2db2 | 243 | |
5166b031 GS |
244 | # Convert accumulated data bits to a data value. |
245 | bits = [b[0] for b in self.databits[rxtx]] | |
246 | if self.options['bit_order'] == 'msb-first': | |
247 | bits.reverse() | |
248 | self.datavalue[rxtx] = bitpack(bits) | |
7cf698c5 | 249 | self.putpx(rxtx, ['DATA', rxtx, |
e9a3c933 | 250 | (self.datavalue[rxtx], self.databits[rxtx])]) |
f44d2db2 | 251 | |
6ffd71c1 GS |
252 | b = self.datavalue[rxtx] |
253 | formatted = self.format_value(b) | |
254 | if formatted is not None: | |
255 | self.putx(rxtx, [rxtx, [formatted]]) | |
f44d2db2 | 256 | |
98b89139 UH |
257 | bdata = b.to_bytes(self.bw, byteorder='big') |
258 | self.putbin(rxtx, [rxtx, bdata]) | |
259 | self.putbin(rxtx, [2, bdata]) | |
0bb7bcf3 | 260 | |
c1fc50b1 | 261 | self.databits[rxtx] = [] |
4aedd5b8 | 262 | |
4bb42a91 GS |
263 | # Advance to either reception of the parity bit, or reception of |
264 | # the STOP bits if parity is not applicable. | |
265 | self.state[rxtx] = 'GET PARITY BIT' | |
266 | if self.options['parity_type'] == 'none': | |
267 | self.state[rxtx] = 'GET STOP BITS' | |
268 | ||
6ffd71c1 GS |
269 | def format_value(self, v): |
270 | # Format value 'v' according to configured options. | |
271 | # Reflects the user selected kind of representation, as well as | |
272 | # the number of data bits in the UART frames. | |
273 | ||
274 | fmt, bits = self.options['format'], self.options['num_data_bits'] | |
275 | ||
276 | # Assume "is printable" for values from 32 to including 126, | |
277 | # below 32 is "control" and thus not printable, above 127 is | |
278 | # "not ASCII" in its strict sense, 127 (DEL) is not printable, | |
279 | # fall back to hex representation for non-printables. | |
280 | if fmt == 'ascii': | |
281 | if v in range(32, 126 + 1): | |
282 | return chr(v) | |
283 | hexfmt = "[{:02X}]" if bits <= 8 else "[{:03X}]" | |
284 | return hexfmt.format(v) | |
285 | ||
286 | # Mere number to text conversion without prefix and padding | |
287 | # for the "decimal" output format. | |
288 | if fmt == 'dec': | |
289 | return "{:d}".format(v) | |
290 | ||
291 | # Padding with leading zeroes for hex/oct/bin formats, but | |
292 | # without a prefix for density -- since the format is user | |
293 | # specified, there is no ambiguity. | |
294 | if fmt == 'hex': | |
295 | digits = (bits + 4 - 1) // 4 | |
296 | fmtchar = "X" | |
297 | elif fmt == 'oct': | |
298 | digits = (bits + 3 - 1) // 3 | |
299 | fmtchar = "o" | |
300 | elif fmt == 'bin': | |
301 | digits = bits | |
302 | fmtchar = "b" | |
303 | else: | |
304 | fmtchar = None | |
305 | if fmtchar is not None: | |
306 | fmt = "{{:0{:d}{:s}}}".format(digits, fmtchar) | |
307 | return fmt.format(v) | |
308 | ||
309 | return None | |
310 | ||
97cca21f | 311 | def get_parity_bit(self, rxtx, signal): |
97cca21f | 312 | self.paritybit[rxtx] = signal |
f44d2db2 | 313 | |
ac941bf9 | 314 | if parity_ok(self.options['parity_type'], self.paritybit[rxtx], |
e9a3c933 | 315 | self.datavalue[rxtx], self.options['num_data_bits']): |
15ac6604 | 316 | self.putp(['PARITYBIT', rxtx, self.paritybit[rxtx]]) |
2ce20a91 | 317 | self.putg([rxtx + 4, ['Parity bit', 'Parity', 'P']]) |
f44d2db2 | 318 | else: |
61132abd | 319 | # TODO: Return expected/actual parity values. |
15ac6604 | 320 | self.putp(['PARITY ERROR', rxtx, (0, 1)]) # FIXME: Dummy tuple... |
4e3b276a | 321 | self.putg([rxtx + 6, ['Parity error', 'Parity err', 'PE']]) |
f44d2db2 | 322 | |
4bb42a91 GS |
323 | self.state[rxtx] = 'GET STOP BITS' |
324 | ||
f44d2db2 | 325 | # TODO: Currently only supports 1 stop bit. |
97cca21f | 326 | def get_stop_bits(self, rxtx, signal): |
97cca21f | 327 | self.stopbit1[rxtx] = signal |
f44d2db2 | 328 | |
5cc4b6a0 | 329 | # Stop bits must be 1. If not, we report an error. |
97cca21f | 330 | if self.stopbit1[rxtx] != 1: |
15ac6604 | 331 | self.putp(['INVALID STOPBIT', rxtx, self.stopbit1[rxtx]]) |
76a4498f | 332 | self.putg([rxtx + 10, ['Frame error', 'Frame err', 'FE']]) |
5cc4b6a0 | 333 | # TODO: Abort? Ignore the frame? Other? |
f44d2db2 | 334 | |
15ac6604 | 335 | self.putp(['STOPBIT', rxtx, self.stopbit1[rxtx]]) |
2ce20a91 | 336 | self.putg([rxtx + 4, ['Stop bit', 'Stop', 'T']]) |
f44d2db2 | 337 | |
4bb42a91 GS |
338 | self.state[rxtx] = 'WAIT FOR START BIT' |
339 | ||
dcd3d626 | 340 | def get_wait_cond(self, rxtx, inv): |
0b83932c UH |
341 | # Return condititions that are suitable for Decoder.wait(). Those |
342 | # conditions either match the falling edge of the START bit, or | |
343 | # the sample point of the next bit time. | |
dcd3d626 GS |
344 | state = self.state[rxtx] |
345 | if state == 'WAIT FOR START BIT': | |
346 | return {rxtx: 'r' if inv else 'f'} | |
347 | if state == 'GET START BIT': | |
348 | bitnum = 0 | |
349 | elif state == 'GET DATA BITS': | |
350 | bitnum = 1 + self.cur_data_bit[rxtx] | |
351 | elif state == 'GET PARITY BIT': | |
352 | bitnum = 1 + self.options['num_data_bits'] | |
353 | elif state == 'GET STOP BITS': | |
354 | bitnum = 1 + self.options['num_data_bits'] | |
355 | bitnum += 0 if self.options['parity_type'] == 'none' else 1 | |
0b83932c UH |
356 | want_num = ceil(self.get_sample_point(rxtx, bitnum)) |
357 | return {'skip': want_num - self.samplenum} | |
dcd3d626 | 358 | |
0de2810f | 359 | def inspect_sample(self, rxtx, signal, inv): |
0b83932c | 360 | # Inspect a sample returned by .wait() for the specified UART line. |
0de2810f GS |
361 | if inv: |
362 | signal = not signal | |
363 | ||
364 | state = self.state[rxtx] | |
365 | if state == 'WAIT FOR START BIT': | |
366 | self.wait_for_start_bit(rxtx, signal) | |
367 | elif state == 'GET START BIT': | |
368 | self.get_start_bit(rxtx, signal) | |
369 | elif state == 'GET DATA BITS': | |
370 | self.get_data_bits(rxtx, signal) | |
371 | elif state == 'GET PARITY BIT': | |
372 | self.get_parity_bit(rxtx, signal) | |
373 | elif state == 'GET STOP BITS': | |
374 | self.get_stop_bits(rxtx, signal) | |
375 | ||
dcd3d626 | 376 | def decode(self): |
21cda951 UH |
377 | if not self.samplerate: |
378 | raise SamplerateError('Cannot decode without samplerate.') | |
2fcd7c22 | 379 | |
dcd3d626 GS |
380 | has_pin = [self.has_channel(ch) for ch in (RX, TX)] |
381 | if has_pin == [False, False]: | |
382 | raise ChannelError('Either TX or RX (or both) pins required.') | |
383 | ||
384 | opt = self.options | |
385 | inv = [opt['invert_rx'] == 'yes', opt['invert_tx'] == 'yes'] | |
7d62e5b3 | 386 | cond_idx = [None] * len(has_pin) |
dcd3d626 GS |
387 | |
388 | while True: | |
389 | conds = [] | |
390 | if has_pin[RX]: | |
7d62e5b3 | 391 | cond_idx[RX] = len(conds) |
dcd3d626 GS |
392 | conds.append(self.get_wait_cond(RX, inv[RX])) |
393 | if has_pin[TX]: | |
7d62e5b3 | 394 | cond_idx[TX] = len(conds) |
dcd3d626 GS |
395 | conds.append(self.get_wait_cond(TX, inv[TX])) |
396 | (rx, tx) = self.wait(conds) | |
7d62e5b3 | 397 | if cond_idx[RX] is not None and self.matched[cond_idx[RX]]: |
0de2810f | 398 | self.inspect_sample(RX, rx, inv[RX]) |
7d62e5b3 | 399 | if cond_idx[TX] is not None and self.matched[cond_idx[TX]]: |
0de2810f | 400 | self.inspect_sample(TX, tx, inv[TX]) |