]>
Commit | Line | Data |
---|---|---|
f44d2db2 | 1 | ## |
50bd5d25 | 2 | ## This file is part of the libsigrokdecode project. |
f44d2db2 | 3 | ## |
15ac6604 | 4 | ## Copyright (C) 2011-2013 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 | ||
f44d2db2 | 21 | # UART protocol decoder |
f44d2db2 | 22 | |
677d597b | 23 | import sigrokdecode as srd |
f44d2db2 | 24 | |
97cca21f UH |
25 | # Used for differentiating between the two data directions. |
26 | RX = 0 | |
27 | TX = 1 | |
28 | ||
f44d2db2 UH |
29 | # Given a parity type to check (odd, even, zero, one), the value of the |
30 | # parity bit, the value of the data, and the length of the data (5-9 bits, | |
31 | # usually 8 bits) return True if the parity is correct, False otherwise. | |
a7fc4c34 | 32 | # 'none' is _not_ allowed as value for 'parity_type'. |
f44d2db2 UH |
33 | def parity_ok(parity_type, parity_bit, data, num_data_bits): |
34 | ||
35 | # Handle easy cases first (parity bit is always 1 or 0). | |
a7fc4c34 | 36 | if parity_type == 'zero': |
f44d2db2 | 37 | return parity_bit == 0 |
a7fc4c34 | 38 | elif parity_type == 'one': |
f44d2db2 UH |
39 | return parity_bit == 1 |
40 | ||
41 | # Count number of 1 (high) bits in the data (and the parity bit itself!). | |
ac941bf9 | 42 | ones = bin(data).count('1') + parity_bit |
f44d2db2 UH |
43 | |
44 | # Check for odd/even parity. | |
a7fc4c34 | 45 | if parity_type == 'odd': |
ac941bf9 | 46 | return (ones % 2) == 1 |
a7fc4c34 | 47 | elif parity_type == 'even': |
ac941bf9 | 48 | return (ones % 2) == 0 |
f44d2db2 UH |
49 | else: |
50 | raise Exception('Invalid parity type: %d' % parity_type) | |
51 | ||
677d597b | 52 | class Decoder(srd.Decoder): |
a2c2afd9 | 53 | api_version = 1 |
f44d2db2 UH |
54 | id = 'uart' |
55 | name = 'UART' | |
3d3da57d | 56 | longname = 'Universal Asynchronous Receiver/Transmitter' |
a465436e | 57 | desc = 'Asynchronous, serial bus.' |
f44d2db2 UH |
58 | license = 'gplv2+' |
59 | inputs = ['logic'] | |
60 | outputs = ['uart'] | |
29ed0f4c | 61 | probes = [ |
f44d2db2 UH |
62 | # Allow specifying only one of the signals, e.g. if only one data |
63 | # direction exists (or is relevant). | |
29ed0f4c UH |
64 | {'id': 'rx', 'name': 'RX', 'desc': 'UART receive line'}, |
65 | {'id': 'tx', 'name': 'TX', 'desc': 'UART transmit line'}, | |
66 | ] | |
b77614bc | 67 | optional_probes = [] |
f44d2db2 | 68 | options = { |
97cca21f | 69 | 'baudrate': ['Baud rate', 115200], |
f44d2db2 | 70 | 'num_data_bits': ['Data bits', 8], # Valid: 5-9. |
a7fc4c34 UH |
71 | 'parity_type': ['Parity type', 'none'], |
72 | 'parity_check': ['Check parity?', 'yes'], # TODO: Bool supported? | |
73 | 'num_stop_bits': ['Stop bit(s)', '1'], # String! 0, 0.5, 1, 1.5. | |
74 | 'bit_order': ['Bit order', 'lsb-first'], | |
3006c663 | 75 | 'format': ['Data format', 'ascii'], # ascii/dec/hex/oct/bin |
f44d2db2 | 76 | # TODO: Options to invert the signal(s). |
f44d2db2 | 77 | } |
e97b6ef5 | 78 | annotations = [ |
3006c663 | 79 | ['Data', 'UART data'], |
1bb57ab8 | 80 | ] |
f44d2db2 | 81 | |
97cca21f | 82 | def putx(self, rxtx, data): |
15ac6604 UH |
83 | s, halfbit = self.startsample[rxtx], int(self.bit_width / 2) |
84 | self.put(s - halfbit, self.samplenum + halfbit, self.out_ann, data) | |
85 | ||
86 | def putg(self, data): | |
87 | s, halfbit = self.samplenum, int(self.bit_width / 2) | |
88 | self.put(s - halfbit, s + halfbit, self.out_ann, data) | |
89 | ||
90 | def putp(self, data): | |
91 | s, halfbit = self.samplenum, int(self.bit_width / 2) | |
92 | self.put(s - halfbit, s + halfbit, self.out_proto, data) | |
97cca21f | 93 | |
f44d2db2 | 94 | def __init__(self, **kwargs): |
f44d2db2 | 95 | self.samplenum = 0 |
97cca21f UH |
96 | self.frame_start = [-1, -1] |
97 | self.startbit = [-1, -1] | |
98 | self.cur_data_bit = [0, 0] | |
99 | self.databyte = [0, 0] | |
1ccef461 | 100 | self.paritybit = [-1, -1] |
97cca21f UH |
101 | self.stopbit1 = [-1, -1] |
102 | self.startsample = [-1, -1] | |
2b716038 | 103 | self.state = ['WAIT FOR START BIT', 'WAIT FOR START BIT'] |
83be7b83 UH |
104 | self.oldbit = [1, 1] |
105 | self.oldpins = [1, 1] | |
f44d2db2 UH |
106 | |
107 | def start(self, metadata): | |
f44d2db2 | 108 | self.samplerate = metadata['samplerate'] |
56202222 UH |
109 | self.out_proto = self.add(srd.OUTPUT_PROTO, 'uart') |
110 | self.out_ann = self.add(srd.OUTPUT_ANN, 'uart') | |
f44d2db2 | 111 | |
f44d2db2 | 112 | # The width of one UART bit in number of samples. |
4a04ece4 UH |
113 | self.bit_width = \ |
114 | float(self.samplerate) / float(self.options['baudrate']) | |
f44d2db2 UH |
115 | |
116 | def report(self): | |
117 | pass | |
118 | ||
119 | # Return true if we reached the middle of the desired bit, false otherwise. | |
97cca21f | 120 | def reached_bit(self, rxtx, bitnum): |
f44d2db2 UH |
121 | # bitpos is the samplenumber which is in the middle of the |
122 | # specified UART bit (0 = start bit, 1..x = data, x+1 = parity bit | |
123 | # (if used) or the first stop bit, and so on). | |
97cca21f | 124 | bitpos = self.frame_start[rxtx] + (self.bit_width / 2.0) |
f44d2db2 UH |
125 | bitpos += bitnum * self.bit_width |
126 | if self.samplenum >= bitpos: | |
127 | return True | |
128 | return False | |
129 | ||
97cca21f UH |
130 | def reached_bit_last(self, rxtx, bitnum): |
131 | bitpos = self.frame_start[rxtx] + ((bitnum + 1) * self.bit_width) | |
f44d2db2 UH |
132 | if self.samplenum >= bitpos: |
133 | return True | |
134 | return False | |
135 | ||
97cca21f | 136 | def wait_for_start_bit(self, rxtx, old_signal, signal): |
f44d2db2 UH |
137 | # The start bit is always 0 (low). As the idle UART (and the stop bit) |
138 | # level is 1 (high), the beginning of a start bit is a falling edge. | |
139 | if not (old_signal == 1 and signal == 0): | |
140 | return | |
141 | ||
142 | # Save the sample number where the start bit begins. | |
97cca21f | 143 | self.frame_start[rxtx] = self.samplenum |
f44d2db2 | 144 | |
2b716038 | 145 | self.state[rxtx] = 'GET START BIT' |
f44d2db2 | 146 | |
97cca21f | 147 | def get_start_bit(self, rxtx, signal): |
f44d2db2 | 148 | # Skip samples until we're in the middle of the start bit. |
97cca21f | 149 | if not self.reached_bit(rxtx, 0): |
1bb57ab8 | 150 | return |
f44d2db2 | 151 | |
97cca21f | 152 | self.startbit[rxtx] = signal |
f44d2db2 | 153 | |
5cc4b6a0 | 154 | # The startbit must be 0. If not, we report an error. |
97cca21f | 155 | if self.startbit[rxtx] != 0: |
15ac6604 | 156 | self.putp(['INVALID STARTBIT', rxtx, self.startbit[rxtx]]) |
5cc4b6a0 | 157 | # TODO: Abort? Ignore rest of the frame? |
f44d2db2 | 158 | |
97cca21f UH |
159 | self.cur_data_bit[rxtx] = 0 |
160 | self.databyte[rxtx] = 0 | |
161 | self.startsample[rxtx] = -1 | |
f44d2db2 | 162 | |
2b716038 | 163 | self.state[rxtx] = 'GET DATA BITS' |
f44d2db2 | 164 | |
15ac6604 | 165 | self.putp(['STARTBIT', rxtx, self.startbit[rxtx]]) |
3006c663 | 166 | self.putg([0, ['Start bit', 'Start', 'S']]) |
f44d2db2 | 167 | |
97cca21f | 168 | def get_data_bits(self, rxtx, signal): |
f44d2db2 | 169 | # Skip samples until we're in the middle of the desired data bit. |
97cca21f | 170 | if not self.reached_bit(rxtx, self.cur_data_bit[rxtx] + 1): |
1bb57ab8 | 171 | return |
f44d2db2 | 172 | |
15ac6604 | 173 | # Save the sample number of the middle of the first data bit. |
97cca21f UH |
174 | if self.startsample[rxtx] == -1: |
175 | self.startsample[rxtx] = self.samplenum | |
f44d2db2 UH |
176 | |
177 | # Get the next data bit in LSB-first or MSB-first fashion. | |
a7fc4c34 | 178 | if self.options['bit_order'] == 'lsb-first': |
97cca21f | 179 | self.databyte[rxtx] >>= 1 |
fd4aa8aa UH |
180 | self.databyte[rxtx] |= \ |
181 | (signal << (self.options['num_data_bits'] - 1)) | |
a7fc4c34 | 182 | elif self.options['bit_order'] == 'msb-first': |
97cca21f UH |
183 | self.databyte[rxtx] <<= 1 |
184 | self.databyte[rxtx] |= (signal << 0) | |
f44d2db2 | 185 | else: |
a7fc4c34 | 186 | raise Exception('Invalid bit order value: %s', |
4a04ece4 | 187 | self.options['bit_order']) |
f44d2db2 UH |
188 | |
189 | # Return here, unless we already received all data bits. | |
4a04ece4 | 190 | if self.cur_data_bit[rxtx] < self.options['num_data_bits'] - 1: |
97cca21f | 191 | self.cur_data_bit[rxtx] += 1 |
1bb57ab8 | 192 | return |
f44d2db2 | 193 | |
2b716038 | 194 | self.state[rxtx] = 'GET PARITY BIT' |
f44d2db2 | 195 | |
15ac6604 | 196 | self.putp(['DATA', rxtx, self.databyte[rxtx]]) |
f44d2db2 | 197 | |
97cca21f | 198 | s = 'RX: ' if (rxtx == RX) else 'TX: ' |
3006c663 UH |
199 | b, f = self.databyte[rxtx], self.options['format'] |
200 | if f == 'ascii': | |
201 | self.putx(rxtx, [0, [s + chr(b)]]) | |
202 | elif f == 'dec': | |
203 | self.putx(rxtx, [0, [s + str(b)]]) | |
204 | elif f == 'hex': | |
205 | self.putx(rxtx, [0, [s + hex(b)[2:]]]) | |
206 | elif f == 'oct': | |
207 | self.putx(rxtx, [0, [s + oct(b)[2:]]]) | |
208 | elif f == 'bin': | |
209 | self.putx(rxtx, [0, [s + bin(b)[2:]]]) | |
210 | else: | |
211 | raise Exception('Invalid data format option: %s' % f) | |
f44d2db2 | 212 | |
97cca21f | 213 | def get_parity_bit(self, rxtx, signal): |
f44d2db2 | 214 | # If no parity is used/configured, skip to the next state immediately. |
a7fc4c34 | 215 | if self.options['parity_type'] == 'none': |
2b716038 | 216 | self.state[rxtx] = 'GET STOP BITS' |
1bb57ab8 | 217 | return |
f44d2db2 UH |
218 | |
219 | # Skip samples until we're in the middle of the parity bit. | |
4a04ece4 | 220 | if not self.reached_bit(rxtx, self.options['num_data_bits'] + 1): |
1bb57ab8 | 221 | return |
f44d2db2 | 222 | |
97cca21f | 223 | self.paritybit[rxtx] = signal |
f44d2db2 | 224 | |
2b716038 | 225 | self.state[rxtx] = 'GET STOP BITS' |
f44d2db2 | 226 | |
ac941bf9 | 227 | if parity_ok(self.options['parity_type'], self.paritybit[rxtx], |
4a04ece4 | 228 | self.databyte[rxtx], self.options['num_data_bits']): |
15ac6604 | 229 | self.putp(['PARITYBIT', rxtx, self.paritybit[rxtx]]) |
3006c663 | 230 | self.putg([0, ['Parity bit', 'Parity', 'P']]) |
f44d2db2 | 231 | else: |
61132abd | 232 | # TODO: Return expected/actual parity values. |
15ac6604 | 233 | self.putp(['PARITY ERROR', rxtx, (0, 1)]) # FIXME: Dummy tuple... |
3006c663 | 234 | self.putg([0, ['Parity error', 'Parity err', 'PE']]) |
f44d2db2 UH |
235 | |
236 | # TODO: Currently only supports 1 stop bit. | |
97cca21f | 237 | def get_stop_bits(self, rxtx, signal): |
f44d2db2 | 238 | # Skip samples until we're in the middle of the stop bit(s). |
a7fc4c34 | 239 | skip_parity = 0 if self.options['parity_type'] == 'none' else 1 |
4a04ece4 UH |
240 | b = self.options['num_data_bits'] + 1 + skip_parity |
241 | if not self.reached_bit(rxtx, b): | |
1bb57ab8 | 242 | return |
f44d2db2 | 243 | |
97cca21f | 244 | self.stopbit1[rxtx] = signal |
f44d2db2 | 245 | |
5cc4b6a0 | 246 | # Stop bits must be 1. If not, we report an error. |
97cca21f | 247 | if self.stopbit1[rxtx] != 1: |
15ac6604 | 248 | self.putp(['INVALID STOPBIT', rxtx, self.stopbit1[rxtx]]) |
5cc4b6a0 | 249 | # TODO: Abort? Ignore the frame? Other? |
f44d2db2 | 250 | |
2b716038 | 251 | self.state[rxtx] = 'WAIT FOR START BIT' |
f44d2db2 | 252 | |
15ac6604 | 253 | self.putp(['STOPBIT', rxtx, self.stopbit1[rxtx]]) |
3006c663 | 254 | self.putg([0, ['Stop bit', 'Stop', 'T']]) |
f44d2db2 | 255 | |
decde15e UH |
256 | def decode(self, ss, es, data): |
257 | # TODO: Either RX or TX could be omitted (optional probe). | |
2fcd7c22 UH |
258 | for (self.samplenum, pins) in data: |
259 | ||
b0827236 UH |
260 | # Note: Ignoring identical samples here for performance reasons |
261 | # is not possible for this PD, at least not in the current state. | |
262 | # if self.oldpins == pins: | |
263 | # continue | |
2fcd7c22 | 264 | self.oldpins, (rx, tx) = pins, pins |
f44d2db2 | 265 | |
f44d2db2 | 266 | # State machine. |
97cca21f UH |
267 | for rxtx in (RX, TX): |
268 | signal = rx if (rxtx == RX) else tx | |
269 | ||
2b716038 | 270 | if self.state[rxtx] == 'WAIT FOR START BIT': |
97cca21f | 271 | self.wait_for_start_bit(rxtx, self.oldbit[rxtx], signal) |
2b716038 | 272 | elif self.state[rxtx] == 'GET START BIT': |
97cca21f | 273 | self.get_start_bit(rxtx, signal) |
2b716038 | 274 | elif self.state[rxtx] == 'GET DATA BITS': |
97cca21f | 275 | self.get_data_bits(rxtx, signal) |
2b716038 | 276 | elif self.state[rxtx] == 'GET PARITY BIT': |
97cca21f | 277 | self.get_parity_bit(rxtx, signal) |
2b716038 | 278 | elif self.state[rxtx] == 'GET STOP BITS': |
97cca21f UH |
279 | self.get_stop_bits(rxtx, signal) |
280 | else: | |
0eeeb544 | 281 | raise Exception('Invalid state: %s' % self.state[rxtx]) |
97cca21f UH |
282 | |
283 | # Save current RX/TX values for the next round. | |
284 | self.oldbit[rxtx] = signal | |
f44d2db2 | 285 |