2 ## This file is part of the sigrok project.
4 ## Copyright (C) 2011 Uwe Hermann <uwe@hermann-uwe.de>
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.
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.
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
22 # UART protocol decoder
26 # Universal Asynchronous Receiver Transmitter (UART) is a simple serial
27 # communication protocol which allows two devices to talk to each other.
29 # It uses just two data signals and a ground (GND) signal:
30 # - RX/RXD: Receive signal
31 # - TX/TXD: Transmit signal
33 # The protocol is asynchronous, i.e., there is no dedicated clock signal.
34 # Rather, both devices have to agree on a baudrate (number of bits to be
35 # transmitted per second) beforehand. Baudrates can be arbitrary in theory,
36 # but usually the choice is limited by the hardware UARTs that are used.
37 # Common values are 9600 or 115200.
39 # The protocol allows full-duplex transmission, i.e. both devices can send
40 # data at the same time. However, unlike SPI (which is always full-duplex,
41 # i.e., each send operation is automatically also a receive operation), UART
42 # allows one-way communication, too. In such a case only one signal (and GND)
45 # The data is sent over the TX line in so-called 'frames', which consist of:
46 # - Exactly one start bit (always 0/low).
47 # - Between 5 and 9 data bits.
48 # - An (optional) parity bit.
49 # - One or more stop bit(s).
51 # The idle state of the RX/TX line is 1/high. As the start bit is 0/low, the
52 # receiver can continually monitor its RX line for a falling edge, in order
53 # to detect the start bit.
55 # Once detected, it can (due to the agreed-upon baudrate and thus the known
56 # width/duration of one UART bit) sample the state of the RX line "in the
57 # middle" of each (start/data/parity/stop) bit it wants to analyze.
59 # It is configurable whether there is a parity bit in a frame, and if yes,
60 # which type of parity is used:
61 # - None: No parity bit is included.
62 # - Odd: The number of 1 bits in the data (and parity bit itself) is odd.
63 # - Even: The number of 1 bits in the data (and parity bit itself) is even.
64 # - Mark/one: The parity bit is always 1/high (also called 'mark state').
65 # - Space/zero: The parity bit is always 0/low (also called 'space state').
67 # It is also configurable how many stop bits are to be used:
68 # - 1 stop bit (most common case)
70 # - 1.5 stop bits (i.e., one stop bit, but 1.5 times the UART bit width)
71 # - 0.5 stop bits (i.e., one stop bit, but 0.5 times the UART bit width)
73 # The bit order of the 5-9 data bits is LSB-first.
75 # Possible special cases:
76 # - One or both data lines could be inverted, which also means that the idle
77 # state of the signal line(s) is low instead of high.
78 # - Only the data bits on one or both data lines (and the parity bit) could
79 # be inverted (but the start/stop bits remain non-inverted).
80 # - The bit order could be MSB-first instead of LSB-first.
81 # - The baudrate could change in the middle of the communication. This only
82 # happens in very special cases, and can only work if both devices know
83 # to which baudrate they are to switch, and when.
84 # - Theoretically, the baudrate on RX and the one on TX could also be
85 # different, but that's a very obscure case and probably doesn't happen
86 # very often in practice.
89 # - If there is a parity bit, but it doesn't match the expected parity,
90 # this is called a 'parity error'.
91 # - If there are no stop bit(s), that's called a 'frame error'.
98 # Protocol output format:
101 # [<packet-type>, <rxtx>, <packet-data>]
103 # This is the list of <packet-types>s and their respective <packet-data>:
104 # - T_START: The data is the (integer) value of the start bit (0 or 1).
105 # - T_DATA: The data is the (integer) value of the UART data. Valid values
106 # range from 0 to 512 (as the data can be up to 9 bits in size).
107 # - T_PARITY: The data is the (integer) value of the parity bit (0 or 1).
108 # - T_STOP: The data is the (integer) value of the stop bit (0 or 1).
109 # - T_INVALID_START: The data is the (integer) value of the start bit (0 or 1).
110 # - T_INVALID_STOP: The data is the (integer) value of the stop bit (0 or 1).
111 # - T_PARITY_ERROR: The data is a tuple with two entries. The first one is
112 # the expected parity value, the second is the actual parity value.
114 # The <rxtx> field is 0 for RX packets, 1 for TX packets.
117 import sigrokdecode as srd
120 WAIT_FOR_START_BIT = 0
126 # Used for differentiating between the two data directions.
147 # Annotation feed formats
154 # Protocol output packet types
163 # Given a parity type to check (odd, even, zero, one), the value of the
164 # parity bit, the value of the data, and the length of the data (5-9 bits,
165 # usually 8 bits) return True if the parity is correct, False otherwise.
166 # PARITY_NONE is _not_ allowed as value for 'parity_type'.
167 def parity_ok(parity_type, parity_bit, data, num_data_bits):
169 # Handle easy cases first (parity bit is always 1 or 0).
170 if parity_type == PARITY_ZERO:
171 return parity_bit == 0
172 elif parity_type == PARITY_ONE:
173 return parity_bit == 1
175 # Count number of 1 (high) bits in the data (and the parity bit itself!).
176 parity = bin(data).count('1') + parity_bit
178 # Check for odd/even parity.
179 if parity_type == PARITY_ODD:
180 return (parity % 2) == 1
181 elif parity_type == PARITY_EVEN:
182 return (parity % 2) == 0
184 raise Exception('Invalid parity type: %d' % parity_type)
186 class Decoder(srd.Decoder):
189 longname = 'Universal Asynchronous Receiver/Transmitter'
190 desc = 'Universal Asynchronous Receiver/Transmitter (UART)'
192 author = 'Uwe Hermann'
193 email = 'uwe@hermann-uwe.de'
198 # Allow specifying only one of the signals, e.g. if only one data
199 # direction exists (or is relevant).
200 {'id': 'rx', 'name': 'RX', 'desc': 'UART receive line'},
201 {'id': 'tx', 'name': 'TX', 'desc': 'UART transmit line'},
204 'baudrate': ['Baud rate', 115200],
205 'num_data_bits': ['Data bits', 8], # Valid: 5-9.
206 'parity': ['Parity', PARITY_NONE],
207 'parity_check': ['Check parity', True],
208 'num_stop_bits': ['Stop bit(s)', STOP_BITS_1],
209 'bit_order': ['Bit order', LSB_FIRST],
210 # TODO: Options to invert the signal(s).
213 ['ASCII', 'Data bytes as ASCII characters'],
214 ['Decimal', 'Databytes as decimal, integer values'],
215 ['Hex', 'Data bytes in hex format'],
216 ['Octal', 'Data bytes as octal numbers'],
217 ['Bits', 'Data bytes in bit notation (sequence of 0/1 digits)'],
220 def putx(self, rxtx, data):
221 self.put(self.startsample[rxtx], self.samplenum - 1, self.out_ann, data)
223 def __init__(self, **kwargs):
225 self.frame_start = [-1, -1]
226 self.startbit = [-1, -1]
227 self.cur_data_bit = [0, 0]
228 self.databyte = [0, 0]
229 self.stopbit1 = [-1, -1]
230 self.startsample = [-1, -1]
233 self.state = [WAIT_FOR_START_BIT, WAIT_FOR_START_BIT]
235 self.oldbit = [None, None]
237 # Set protocol decoder option defaults.
238 self.baudrate = Decoder.options['baudrate'][1]
239 self.num_data_bits = Decoder.options['num_data_bits'][1]
240 self.parity = Decoder.options['parity'][1]
241 self.check_parity = Decoder.options['parity_check'][1]
242 self.num_stop_bits = Decoder.options['num_stop_bits'][1]
243 self.bit_order = Decoder.options['bit_order'][1]
245 def start(self, metadata):
246 self.samplerate = metadata['samplerate']
247 self.out_proto = self.add(srd.OUTPUT_PROTO, 'uart')
248 self.out_ann = self.add(srd.OUTPUT_ANN, 'uart')
250 # TODO: Override PD options, if user wants that.
252 # The width of one UART bit in number of samples.
253 self.bit_width = float(self.samplerate) / float(self.baudrate)
258 # Return true if we reached the middle of the desired bit, false otherwise.
259 def reached_bit(self, rxtx, bitnum):
260 # bitpos is the samplenumber which is in the middle of the
261 # specified UART bit (0 = start bit, 1..x = data, x+1 = parity bit
262 # (if used) or the first stop bit, and so on).
263 bitpos = self.frame_start[rxtx] + (self.bit_width / 2.0)
264 bitpos += bitnum * self.bit_width
265 if self.samplenum >= bitpos:
269 def reached_bit_last(self, rxtx, bitnum):
270 bitpos = self.frame_start[rxtx] + ((bitnum + 1) * self.bit_width)
271 if self.samplenum >= bitpos:
275 def wait_for_start_bit(self, rxtx, old_signal, signal):
276 # The start bit is always 0 (low). As the idle UART (and the stop bit)
277 # level is 1 (high), the beginning of a start bit is a falling edge.
278 if not (old_signal == 1 and signal == 0):
281 # Save the sample number where the start bit begins.
282 self.frame_start[rxtx] = self.samplenum
284 self.state[rxtx] = GET_START_BIT
286 def get_start_bit(self, rxtx, signal):
287 # Skip samples until we're in the middle of the start bit.
288 if not self.reached_bit(rxtx, 0):
291 self.startbit[rxtx] = signal
293 # The startbit must be 0. If not, we report an error.
294 if self.startbit[rxtx] != 0:
295 self.put(self.frame_start[rxtx], self.samplenum, self.out_proto,
296 [T_INVALID_START, rxtx, self.startbit[rxtx]])
297 # TODO: Abort? Ignore rest of the frame?
299 self.cur_data_bit[rxtx] = 0
300 self.databyte[rxtx] = 0
301 self.startsample[rxtx] = -1
303 self.state[rxtx] = GET_DATA_BITS
305 self.put(self.frame_start[rxtx], self.samplenum, self.out_proto,
306 [T_START, rxtx, self.startbit[rxtx]])
307 self.put(self.frame_start[rxtx], self.samplenum, self.out_ann,
308 [ANN_ASCII, ['Start bit', 'Start', 'S']])
310 def get_data_bits(self, rxtx, signal):
311 # Skip samples until we're in the middle of the desired data bit.
312 if not self.reached_bit(rxtx, self.cur_data_bit[rxtx] + 1):
315 # Save the sample number where the data byte starts.
316 if self.startsample[rxtx] == -1:
317 self.startsample[rxtx] = self.samplenum
319 # Get the next data bit in LSB-first or MSB-first fashion.
320 if self.bit_order == LSB_FIRST:
321 self.databyte[rxtx] >>= 1
322 self.databyte[rxtx] |= (signal << (self.num_data_bits - 1))
323 elif self.bit_order == MSB_FIRST:
324 self.databyte[rxtx] <<= 1
325 self.databyte[rxtx] |= (signal << 0)
327 raise Exception('Invalid bit order value: %d', self.bit_order)
329 # Return here, unless we already received all data bits.
330 if self.cur_data_bit[rxtx] < self.num_data_bits - 1: # TODO? Off-by-one?
331 self.cur_data_bit[rxtx] += 1
334 self.state[rxtx] = GET_PARITY_BIT
336 self.put(self.startsample[rxtx], self.samplenum - 1, self.out_proto,
337 [T_DATA, rxtx, self.databyte[rxtx]])
339 s = 'RX: ' if (rxtx == RX) else 'TX: '
340 self.putx(rxtx, [ANN_ASCII, [s + chr(self.databyte[rxtx])]])
341 self.putx(rxtx, [ANN_DEC, [s + str(self.databyte[rxtx])]])
342 self.putx(rxtx, [ANN_HEX, [s + hex(self.databyte[rxtx]),
343 s + hex(self.databyte[rxtx])[2:]]])
344 self.putx(rxtx, [ANN_OCT, [s + oct(self.databyte[rxtx]),
345 s + oct(self.databyte[rxtx])[2:]]])
346 self.putx(rxtx, [ANN_BITS, [s + bin(self.databyte[rxtx]),
347 s + bin(self.databyte[rxtx])[2:]]])
349 def get_parity_bit(self, rxtx, signal):
350 # If no parity is used/configured, skip to the next state immediately.
351 if self.parity == PARITY_NONE:
352 self.state[rxtx] = GET_STOP_BITS
355 # Skip samples until we're in the middle of the parity bit.
356 if not self.reached_bit(rxtx, self.num_data_bits + 1):
359 self.paritybit[rxtx] = signal
361 self.state[rxtx] = GET_STOP_BITS
363 if parity_ok(self.parity[rxtx], self.paritybit[rxtx],
364 self.databyte[rxtx], self.num_data_bits):
366 self.put(self.samplenum, self.samplenum, self.out_proto,
367 [T_PARITY_BIT, rxtx, self.paritybit[rxtx]])
368 self.put(self.samplenum, self.samplenum, self.out_ann,
369 [ANN_ASCII, ['Parity bit', 'Parity', 'P']])
372 # TODO: Return expected/actual parity values.
373 self.put(self.samplenum, self.samplenum, self.out_proto,
374 [T_PARITY_ERROR, rxtx, (0, 1)]) # FIXME: Dummy tuple...
375 self.put(self.samplenum, self.samplenum, self.out_ann,
376 [ANN_ASCII, ['Parity error', 'Parity err', 'PE']])
378 # TODO: Currently only supports 1 stop bit.
379 def get_stop_bits(self, rxtx, signal):
380 # Skip samples until we're in the middle of the stop bit(s).
381 skip_parity = 0 if self.parity == PARITY_NONE else 1
382 if not self.reached_bit(rxtx, self.num_data_bits + 1 + skip_parity):
385 self.stopbit1[rxtx] = signal
387 # Stop bits must be 1. If not, we report an error.
388 if self.stopbit1[rxtx] != 1:
389 self.put(self.frame_start[rxtx], self.samplenum, self.out_proto,
390 [T_INVALID_STOP, rxtx, self.stopbit1[rxtx]])
391 # TODO: Abort? Ignore the frame? Other?
393 self.state[rxtx] = WAIT_FOR_START_BIT
396 self.put(self.samplenum, self.samplenum, self.out_proto,
397 [T_STOP, rxtx, self.stopbit1[rxtx]])
398 self.put(self.samplenum, self.samplenum, self.out_ann,
399 [ANN_ASCII, ['Stop bit', 'Stop', 'P']])
401 def decode(self, ss, es, data): # TODO
402 for (samplenum, (rx, tx)) in data:
404 # TODO: Start counting at 0 or 1? Increase before or after?
407 # First sample: Save RX/TX value.
408 if self.oldbit[RX] == None:
411 if self.oldbit[TX] == None:
416 for rxtx in (RX, TX):
417 signal = rx if (rxtx == RX) else tx
419 if self.state[rxtx] == WAIT_FOR_START_BIT:
420 self.wait_for_start_bit(rxtx, self.oldbit[rxtx], signal)
421 elif self.state[rxtx] == GET_START_BIT:
422 self.get_start_bit(rxtx, signal)
423 elif self.state[rxtx] == GET_DATA_BITS:
424 self.get_data_bits(rxtx, signal)
425 elif self.state[rxtx] == GET_PARITY_BIT:
426 self.get_parity_bit(rxtx, signal)
427 elif self.state[rxtx] == GET_STOP_BITS:
428 self.get_stop_bits(rxtx, signal)
430 raise Exception('Invalid state: %s' % self.state[rxtx])
432 # Save current RX/TX values for the next round.
433 self.oldbit[rxtx] = signal