]>
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 | |
17 | ## along with this program; if not, write to the Free Software | |
18 | ## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA | |
19 | ## | |
20 | ||
677d597b | 21 | import sigrokdecode as srd |
f44d2db2 | 22 | |
4cace3b8 | 23 | ''' |
c515eed7 | 24 | OUTPUT_PYTHON format: |
4cace3b8 UH |
25 | |
26 | UART packet: | |
27 | [<packet-type>, <rxtx>, <packet-data>] | |
28 | ||
29 | This is the list of <packet-type>s and their respective <packet-data>: | |
30 | - 'STARTBIT': The data is the (integer) value of the start bit (0/1). | |
31 | - 'DATA': The data is the (integer) value of the UART data. Valid values | |
32 | range from 0 to 512 (as the data can be up to 9 bits in size). | |
4aedd5b8 | 33 | - 'DATABITS': List of data bits and their ss/es numbers. |
4cace3b8 UH |
34 | - 'PARITYBIT': The data is the (integer) value of the parity bit (0/1). |
35 | - 'STOPBIT': The data is the (integer) value of the stop bit (0 or 1). | |
36 | - 'INVALID STARTBIT': The data is the (integer) value of the start bit (0/1). | |
37 | - 'INVALID STOPBIT': The data is the (integer) value of the stop bit (0/1). | |
38 | - 'PARITY ERROR': The data is a tuple with two entries. The first one is | |
39 | the expected parity value, the second is the actual parity value. | |
40 | - TODO: Frame error? | |
41 | ||
42 | The <rxtx> field is 0 for RX packets, 1 for TX packets. | |
43 | ''' | |
44 | ||
97cca21f UH |
45 | # Used for differentiating between the two data directions. |
46 | RX = 0 | |
47 | TX = 1 | |
48 | ||
f44d2db2 UH |
49 | # Given a parity type to check (odd, even, zero, one), the value of the |
50 | # parity bit, the value of the data, and the length of the data (5-9 bits, | |
51 | # usually 8 bits) return True if the parity is correct, False otherwise. | |
a7fc4c34 | 52 | # 'none' is _not_ allowed as value for 'parity_type'. |
f44d2db2 UH |
53 | def parity_ok(parity_type, parity_bit, data, num_data_bits): |
54 | ||
55 | # Handle easy cases first (parity bit is always 1 or 0). | |
a7fc4c34 | 56 | if parity_type == 'zero': |
f44d2db2 | 57 | return parity_bit == 0 |
a7fc4c34 | 58 | elif parity_type == 'one': |
f44d2db2 UH |
59 | return parity_bit == 1 |
60 | ||
61 | # Count number of 1 (high) bits in the data (and the parity bit itself!). | |
ac941bf9 | 62 | ones = bin(data).count('1') + parity_bit |
f44d2db2 UH |
63 | |
64 | # Check for odd/even parity. | |
a7fc4c34 | 65 | if parity_type == 'odd': |
ac941bf9 | 66 | return (ones % 2) == 1 |
a7fc4c34 | 67 | elif parity_type == 'even': |
ac941bf9 | 68 | return (ones % 2) == 0 |
f44d2db2 UH |
69 | else: |
70 | raise Exception('Invalid parity type: %d' % parity_type) | |
71 | ||
677d597b | 72 | class Decoder(srd.Decoder): |
a2c2afd9 | 73 | api_version = 1 |
f44d2db2 UH |
74 | id = 'uart' |
75 | name = 'UART' | |
3d3da57d | 76 | longname = 'Universal Asynchronous Receiver/Transmitter' |
a465436e | 77 | desc = 'Asynchronous, serial bus.' |
f44d2db2 UH |
78 | license = 'gplv2+' |
79 | inputs = ['logic'] | |
80 | outputs = ['uart'] | |
da9bcbd9 | 81 | optional_probes = ( |
f44d2db2 UH |
82 | # Allow specifying only one of the signals, e.g. if only one data |
83 | # direction exists (or is relevant). | |
29ed0f4c UH |
84 | {'id': 'rx', 'name': 'RX', 'desc': 'UART receive line'}, |
85 | {'id': 'tx', 'name': 'TX', 'desc': 'UART transmit line'}, | |
da9bcbd9 | 86 | ) |
84c1c0b5 BV |
87 | options = ( |
88 | {'id': 'baudrate', 'desc': 'Baud rate', 'default': 115200}, | |
89 | {'id': 'num_data_bits', 'desc': 'Data bits', 'default': 8, | |
90 | 'values': (5, 6, 7, 8, 9)}, | |
91 | {'id': 'parity_type', 'desc': 'Parity type', 'default': 'none', | |
92 | 'values': ('none', 'odd', 'even', 'zero', 'one')}, | |
93 | {'id': 'parity_check', 'desc': 'Check parity?', 'default': 'yes', | |
94 | 'values': ('yes', 'no')}, | |
95 | {'id': 'num_stop_bits', 'desc': 'Stop bits', 'default': 1.0, | |
96 | 'values': (0.0, 0.5, 1.0, 1.5)}, | |
97 | {'id': 'bit_order', 'desc': 'Bit order', 'default': 'lsb-first', | |
98 | 'values': ('lsb-first', 'msb-first')}, | |
99 | {'id': 'format', 'desc': 'Data format', 'default': 'ascii', | |
100 | 'values': ('ascii', 'dec', 'hex', 'oct', 'bin')}, | |
f44d2db2 | 101 | # TODO: Options to invert the signal(s). |
84c1c0b5 | 102 | ) |
da9bcbd9 BV |
103 | annotations = ( |
104 | ('rx-data', 'RX data'), | |
105 | ('tx-data', 'TX data'), | |
106 | ('rx-start', 'RX start bits'), | |
107 | ('tx-start', 'TX start bits'), | |
108 | ('rx-parity-ok', 'RX parity OK bits'), | |
109 | ('tx-parity-ok', 'TX parity OK bits'), | |
110 | ('rx-parity-err', 'RX parity error bits'), | |
111 | ('tx-parity-err', 'TX parity error bits'), | |
112 | ('rx-stop', 'RX stop bits'), | |
113 | ('tx-stop', 'TX stop bits'), | |
114 | ('rx-warnings', 'RX warnings'), | |
115 | ('tx-warnings', 'TX warnings'), | |
116 | ('rx-data-bits', 'RX data bits'), | |
117 | ('tx-data-bits', 'TX data bits'), | |
118 | ) | |
2ce20a91 | 119 | annotation_rows = ( |
4e3b276a | 120 | ('rx-data', 'RX', (0, 2, 4, 6, 8)), |
4aedd5b8 | 121 | ('rx-data-bits', 'RX bits', (12,)), |
4e3b276a | 122 | ('rx-warnings', 'RX warnings', (10,)), |
4aedd5b8 UH |
123 | ('tx-data', 'TX', (1, 3, 5, 7, 9)), |
124 | ('tx-data-bits', 'TX bits', (13,)), | |
4e3b276a | 125 | ('tx-warnings', 'TX warnings', (11,)), |
2ce20a91 | 126 | ) |
0bb7bcf3 UH |
127 | binary = ( |
128 | ('rx', 'RX dump'), | |
129 | ('tx', 'TX dump'), | |
130 | ('rxtx', 'RX/TX dump'), | |
131 | ) | |
f44d2db2 | 132 | |
97cca21f | 133 | def putx(self, rxtx, data): |
15ac6604 UH |
134 | s, halfbit = self.startsample[rxtx], int(self.bit_width / 2) |
135 | self.put(s - halfbit, self.samplenum + halfbit, self.out_ann, data) | |
136 | ||
4aedd5b8 UH |
137 | def putpx(self, rxtx, data): |
138 | s, halfbit = self.startsample[rxtx], int(self.bit_width / 2) | |
139 | self.put(s - halfbit, self.samplenum + halfbit, self.out_python, data) | |
140 | ||
15ac6604 UH |
141 | def putg(self, data): |
142 | s, halfbit = self.samplenum, int(self.bit_width / 2) | |
143 | self.put(s - halfbit, s + halfbit, self.out_ann, data) | |
144 | ||
145 | def putp(self, data): | |
146 | s, halfbit = self.samplenum, int(self.bit_width / 2) | |
c515eed7 | 147 | self.put(s - halfbit, s + halfbit, self.out_python, data) |
97cca21f | 148 | |
0bb7bcf3 UH |
149 | def putbin(self, rxtx, data): |
150 | s, halfbit = self.startsample[rxtx], int(self.bit_width / 2) | |
151 | self.put(s - halfbit, self.samplenum + halfbit, self.out_bin, data) | |
152 | ||
f44d2db2 | 153 | def __init__(self, **kwargs): |
f372d597 | 154 | self.samplerate = None |
f44d2db2 | 155 | self.samplenum = 0 |
97cca21f UH |
156 | self.frame_start = [-1, -1] |
157 | self.startbit = [-1, -1] | |
158 | self.cur_data_bit = [0, 0] | |
159 | self.databyte = [0, 0] | |
1ccef461 | 160 | self.paritybit = [-1, -1] |
97cca21f UH |
161 | self.stopbit1 = [-1, -1] |
162 | self.startsample = [-1, -1] | |
2b716038 | 163 | self.state = ['WAIT FOR START BIT', 'WAIT FOR START BIT'] |
83be7b83 UH |
164 | self.oldbit = [1, 1] |
165 | self.oldpins = [1, 1] | |
4aedd5b8 | 166 | self.databits = [[], []] |
f44d2db2 | 167 | |
f372d597 | 168 | def start(self): |
c515eed7 | 169 | self.out_python = self.register(srd.OUTPUT_PYTHON) |
0bb7bcf3 | 170 | self.out_bin = self.register(srd.OUTPUT_BINARY) |
be465111 | 171 | self.out_ann = self.register(srd.OUTPUT_ANN) |
f44d2db2 | 172 | |
f372d597 BV |
173 | def metadata(self, key, value): |
174 | if key == srd.SRD_CONF_SAMPLERATE: | |
175 | self.samplerate = value; | |
176 | # The width of one UART bit in number of samples. | |
177 | self.bit_width = float(self.samplerate) / float(self.options['baudrate']) | |
f44d2db2 | 178 | |
f44d2db2 | 179 | # Return true if we reached the middle of the desired bit, false otherwise. |
97cca21f | 180 | def reached_bit(self, rxtx, bitnum): |
f44d2db2 UH |
181 | # bitpos is the samplenumber which is in the middle of the |
182 | # specified UART bit (0 = start bit, 1..x = data, x+1 = parity bit | |
183 | # (if used) or the first stop bit, and so on). | |
97cca21f | 184 | bitpos = self.frame_start[rxtx] + (self.bit_width / 2.0) |
f44d2db2 UH |
185 | bitpos += bitnum * self.bit_width |
186 | if self.samplenum >= bitpos: | |
187 | return True | |
188 | return False | |
189 | ||
97cca21f UH |
190 | def reached_bit_last(self, rxtx, bitnum): |
191 | bitpos = self.frame_start[rxtx] + ((bitnum + 1) * self.bit_width) | |
f44d2db2 UH |
192 | if self.samplenum >= bitpos: |
193 | return True | |
194 | return False | |
195 | ||
97cca21f | 196 | def wait_for_start_bit(self, rxtx, old_signal, signal): |
f44d2db2 UH |
197 | # The start bit is always 0 (low). As the idle UART (and the stop bit) |
198 | # level is 1 (high), the beginning of a start bit is a falling edge. | |
199 | if not (old_signal == 1 and signal == 0): | |
200 | return | |
201 | ||
202 | # Save the sample number where the start bit begins. | |
97cca21f | 203 | self.frame_start[rxtx] = self.samplenum |
f44d2db2 | 204 | |
2b716038 | 205 | self.state[rxtx] = 'GET START BIT' |
f44d2db2 | 206 | |
97cca21f | 207 | def get_start_bit(self, rxtx, signal): |
f44d2db2 | 208 | # Skip samples until we're in the middle of the start bit. |
97cca21f | 209 | if not self.reached_bit(rxtx, 0): |
1bb57ab8 | 210 | return |
f44d2db2 | 211 | |
97cca21f | 212 | self.startbit[rxtx] = signal |
f44d2db2 | 213 | |
5cc4b6a0 | 214 | # The startbit must be 0. If not, we report an error. |
97cca21f | 215 | if self.startbit[rxtx] != 0: |
15ac6604 | 216 | self.putp(['INVALID STARTBIT', rxtx, self.startbit[rxtx]]) |
5cc4b6a0 | 217 | # TODO: Abort? Ignore rest of the frame? |
f44d2db2 | 218 | |
97cca21f UH |
219 | self.cur_data_bit[rxtx] = 0 |
220 | self.databyte[rxtx] = 0 | |
221 | self.startsample[rxtx] = -1 | |
f44d2db2 | 222 | |
2b716038 | 223 | self.state[rxtx] = 'GET DATA BITS' |
f44d2db2 | 224 | |
15ac6604 | 225 | self.putp(['STARTBIT', rxtx, self.startbit[rxtx]]) |
2ce20a91 | 226 | self.putg([rxtx + 2, ['Start bit', 'Start', 'S']]) |
f44d2db2 | 227 | |
97cca21f | 228 | def get_data_bits(self, rxtx, signal): |
f44d2db2 | 229 | # Skip samples until we're in the middle of the desired data bit. |
97cca21f | 230 | if not self.reached_bit(rxtx, self.cur_data_bit[rxtx] + 1): |
1bb57ab8 | 231 | return |
f44d2db2 | 232 | |
15ac6604 | 233 | # Save the sample number of the middle of the first data bit. |
97cca21f UH |
234 | if self.startsample[rxtx] == -1: |
235 | self.startsample[rxtx] = self.samplenum | |
f44d2db2 UH |
236 | |
237 | # Get the next data bit in LSB-first or MSB-first fashion. | |
a7fc4c34 | 238 | if self.options['bit_order'] == 'lsb-first': |
97cca21f | 239 | self.databyte[rxtx] >>= 1 |
fd4aa8aa UH |
240 | self.databyte[rxtx] |= \ |
241 | (signal << (self.options['num_data_bits'] - 1)) | |
a7fc4c34 | 242 | elif self.options['bit_order'] == 'msb-first': |
97cca21f UH |
243 | self.databyte[rxtx] <<= 1 |
244 | self.databyte[rxtx] |= (signal << 0) | |
f44d2db2 | 245 | else: |
a7fc4c34 | 246 | raise Exception('Invalid bit order value: %s', |
4a04ece4 | 247 | self.options['bit_order']) |
f44d2db2 | 248 | |
4aedd5b8 UH |
249 | self.putg([rxtx + 12, ['%d' % signal]]) |
250 | ||
251 | # Store individual data bits and their start/end samplenumbers. | |
252 | s, halfbit = self.samplenum, int(self.bit_width / 2) | |
253 | self.databits[rxtx].append([signal, s - halfbit, s + halfbit]) | |
254 | ||
f44d2db2 | 255 | # Return here, unless we already received all data bits. |
4a04ece4 | 256 | if self.cur_data_bit[rxtx] < self.options['num_data_bits'] - 1: |
97cca21f | 257 | self.cur_data_bit[rxtx] += 1 |
1bb57ab8 | 258 | return |
f44d2db2 | 259 | |
2b716038 | 260 | self.state[rxtx] = 'GET PARITY BIT' |
f44d2db2 | 261 | |
4aedd5b8 UH |
262 | self.putpx(rxtx, ['DATABITS', rxtx, self.databits[rxtx]]) |
263 | self.putpx(rxtx, ['DATA', rxtx, self.databyte[rxtx]]) | |
f44d2db2 | 264 | |
3006c663 UH |
265 | b, f = self.databyte[rxtx], self.options['format'] |
266 | if f == 'ascii': | |
e0a0123d | 267 | c = chr(b) if b in range(30, 126 + 1) else '[%02X]' % b |
8705ddc8 | 268 | self.putx(rxtx, [rxtx, [c]]) |
3006c663 | 269 | elif f == 'dec': |
6d6b32d6 | 270 | self.putx(rxtx, [rxtx, [str(b)]]) |
3006c663 | 271 | elif f == 'hex': |
6d6b32d6 | 272 | self.putx(rxtx, [rxtx, [hex(b)[2:].zfill(2).upper()]]) |
3006c663 | 273 | elif f == 'oct': |
6d6b32d6 | 274 | self.putx(rxtx, [rxtx, [oct(b)[2:].zfill(3)]]) |
3006c663 | 275 | elif f == 'bin': |
6d6b32d6 | 276 | self.putx(rxtx, [rxtx, [bin(b)[2:].zfill(8)]]) |
3006c663 UH |
277 | else: |
278 | raise Exception('Invalid data format option: %s' % f) | |
f44d2db2 | 279 | |
0bb7bcf3 UH |
280 | self.putbin(rxtx, (rxtx, bytes([b]))) |
281 | self.putbin(rxtx, (2, bytes([b]))) | |
282 | ||
4aedd5b8 UH |
283 | self.databits = [[], []] |
284 | ||
97cca21f | 285 | def get_parity_bit(self, rxtx, signal): |
f44d2db2 | 286 | # If no parity is used/configured, skip to the next state immediately. |
a7fc4c34 | 287 | if self.options['parity_type'] == 'none': |
2b716038 | 288 | self.state[rxtx] = 'GET STOP BITS' |
1bb57ab8 | 289 | return |
f44d2db2 UH |
290 | |
291 | # Skip samples until we're in the middle of the parity bit. | |
4a04ece4 | 292 | if not self.reached_bit(rxtx, self.options['num_data_bits'] + 1): |
1bb57ab8 | 293 | return |
f44d2db2 | 294 | |
97cca21f | 295 | self.paritybit[rxtx] = signal |
f44d2db2 | 296 | |
2b716038 | 297 | self.state[rxtx] = 'GET STOP BITS' |
f44d2db2 | 298 | |
ac941bf9 | 299 | if parity_ok(self.options['parity_type'], self.paritybit[rxtx], |
4a04ece4 | 300 | self.databyte[rxtx], self.options['num_data_bits']): |
15ac6604 | 301 | self.putp(['PARITYBIT', rxtx, self.paritybit[rxtx]]) |
2ce20a91 | 302 | self.putg([rxtx + 4, ['Parity bit', 'Parity', 'P']]) |
f44d2db2 | 303 | else: |
61132abd | 304 | # TODO: Return expected/actual parity values. |
15ac6604 | 305 | self.putp(['PARITY ERROR', rxtx, (0, 1)]) # FIXME: Dummy tuple... |
4e3b276a | 306 | self.putg([rxtx + 6, ['Parity error', 'Parity err', 'PE']]) |
f44d2db2 UH |
307 | |
308 | # TODO: Currently only supports 1 stop bit. | |
97cca21f | 309 | def get_stop_bits(self, rxtx, signal): |
f44d2db2 | 310 | # Skip samples until we're in the middle of the stop bit(s). |
a7fc4c34 | 311 | skip_parity = 0 if self.options['parity_type'] == 'none' else 1 |
4a04ece4 UH |
312 | b = self.options['num_data_bits'] + 1 + skip_parity |
313 | if not self.reached_bit(rxtx, b): | |
1bb57ab8 | 314 | return |
f44d2db2 | 315 | |
97cca21f | 316 | self.stopbit1[rxtx] = signal |
f44d2db2 | 317 | |
5cc4b6a0 | 318 | # Stop bits must be 1. If not, we report an error. |
97cca21f | 319 | if self.stopbit1[rxtx] != 1: |
15ac6604 | 320 | self.putp(['INVALID STOPBIT', rxtx, self.stopbit1[rxtx]]) |
4e3b276a | 321 | self.putg([rxtx + 8, ['Frame error', 'Frame err', 'FE']]) |
5cc4b6a0 | 322 | # TODO: Abort? Ignore the frame? Other? |
f44d2db2 | 323 | |
2b716038 | 324 | self.state[rxtx] = 'WAIT FOR START BIT' |
f44d2db2 | 325 | |
15ac6604 | 326 | self.putp(['STOPBIT', rxtx, self.stopbit1[rxtx]]) |
2ce20a91 | 327 | self.putg([rxtx + 4, ['Stop bit', 'Stop', 'T']]) |
f44d2db2 | 328 | |
decde15e | 329 | def decode(self, ss, es, data): |
f372d597 BV |
330 | if self.samplerate is None: |
331 | raise Exception("Cannot decode without samplerate.") | |
2fcd7c22 UH |
332 | for (self.samplenum, pins) in data: |
333 | ||
b0827236 UH |
334 | # Note: Ignoring identical samples here for performance reasons |
335 | # is not possible for this PD, at least not in the current state. | |
336 | # if self.oldpins == pins: | |
337 | # continue | |
2fcd7c22 | 338 | self.oldpins, (rx, tx) = pins, pins |
f44d2db2 | 339 | |
3dd546c1 UH |
340 | # Either RX or TX (but not both) can be omitted. |
341 | has_pin = [rx in (0, 1), tx in (0, 1)] | |
342 | if has_pin == [False, False]: | |
343 | raise Exception('Either TX or RX (or both) pins required.') | |
344 | ||
f44d2db2 | 345 | # State machine. |
97cca21f | 346 | for rxtx in (RX, TX): |
3dd546c1 UH |
347 | # Don't try to handle RX (or TX) if not supplied. |
348 | if not has_pin[rxtx]: | |
349 | continue | |
350 | ||
97cca21f UH |
351 | signal = rx if (rxtx == RX) else tx |
352 | ||
2b716038 | 353 | if self.state[rxtx] == 'WAIT FOR START BIT': |
97cca21f | 354 | self.wait_for_start_bit(rxtx, self.oldbit[rxtx], signal) |
2b716038 | 355 | elif self.state[rxtx] == 'GET START BIT': |
97cca21f | 356 | self.get_start_bit(rxtx, signal) |
2b716038 | 357 | elif self.state[rxtx] == 'GET DATA BITS': |
97cca21f | 358 | self.get_data_bits(rxtx, signal) |
2b716038 | 359 | elif self.state[rxtx] == 'GET PARITY BIT': |
97cca21f | 360 | self.get_parity_bit(rxtx, signal) |
2b716038 | 361 | elif self.state[rxtx] == 'GET STOP BITS': |
97cca21f UH |
362 | self.get_stop_bits(rxtx, signal) |
363 | else: | |
0eeeb544 | 364 | raise Exception('Invalid state: %s' % self.state[rxtx]) |
97cca21f UH |
365 | |
366 | # Save current RX/TX values for the next round. | |
367 | self.oldbit[rxtx] = signal | |
f44d2db2 | 368 |