X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=decoders%2Fuart%2Fuart.py;h=f0f40c92289bc2c59f7d5a1dd68050ba19e2744a;hp=56bfcfb78c8cc59fb02097c8a5e758e1dfd27f7f;hb=b9e44d1e0964f5c6c99ec52b68a5a6e0bc1ac633;hpb=a2c2afd9357fab233a4f09531618faa81d54d4d9 diff --git a/decoders/uart/uart.py b/decoders/uart/uart.py index 56bfcfb..f0f40c9 100644 --- a/decoders/uart/uart.py +++ b/decoders/uart/uart.py @@ -1,7 +1,7 @@ ## ## This file is part of the sigrok project. ## -## Copyright (C) 2011 Uwe Hermann +## Copyright (C) 2011-2012 Uwe Hermann ## ## This program is free software; you can redistribute it and/or modify ## it under the terms of the GNU General Public License as published by @@ -101,15 +101,18 @@ # [, , ] # # This is the list of s and their respective : -# - T_START: The data is the (integer) value of the start bit (0 or 1). -# - T_DATA: The data is the (integer) value of the UART data. Valid values +# - 'STARTBIT': The data is the (integer) value of the start bit (0 or 1). +# - 'DATA': The data is the (integer) value of the UART data. Valid values # range from 0 to 512 (as the data can be up to 9 bits in size). -# - T_PARITY: The data is the (integer) value of the parity bit (0 or 1). -# - T_STOP: The data is the (integer) value of the stop bit (0 or 1). -# - T_INVALID_START: The data is the (integer) value of the start bit (0 or 1). -# - T_INVALID_STOP: The data is the (integer) value of the stop bit (0 or 1). -# - T_PARITY_ERROR: The data is a tuple with two entries. The first one is +# - 'PARITYBIT': The data is the (integer) value of the parity bit (0 or 1). +# - 'STOPBIT': The data is the (integer) value of the stop bit (0 or 1). +# - 'INVALID STARTBIT': The data is the (integer) value of the start bit +# (0 or 1). +# - 'INVALID STOPBIT': The data is the (integer) value of the stop bit +# (0 or 1). +# - 'PARITY ERROR': The data is a tuple with two entries. The first one is # the expected parity value, the second is the actual parity value. +# - TODO: Frame error? # # The field is 0 for RX packets, 1 for TX packets. # @@ -151,15 +154,6 @@ ANN_HEX = 2 ANN_OCT = 3 ANN_BITS = 4 -# Protocol output packet types -T_START = 0 -T_DATA = 1 -T_PARITY = 2 -T_STOP = 3 -T_INVALID_START = 4 -T_INVALID_STOP = 5 -T_PARITY_ERROR = 6 - # Given a parity type to check (odd, even, zero, one), the value of the # parity bit, the value of the data, and the length of the data (5-9 bits, # usually 8 bits) return True if the parity is correct, False otherwise. @@ -173,13 +167,13 @@ def parity_ok(parity_type, parity_bit, data, num_data_bits): return parity_bit == 1 # Count number of 1 (high) bits in the data (and the parity bit itself!). - parity = bin(data).count('1') + parity_bit + ones = bin(data).count('1') + parity_bit # Check for odd/even parity. if parity_type == PARITY_ODD: - return (parity % 2) == 1 + return (ones % 2) == 1 elif parity_type == PARITY_EVEN: - return (parity % 2) == 0 + return (ones % 2) == 0 else: raise Exception('Invalid parity type: %d' % parity_type) @@ -199,11 +193,12 @@ class Decoder(srd.Decoder): {'id': 'rx', 'name': 'RX', 'desc': 'UART receive line'}, {'id': 'tx', 'name': 'TX', 'desc': 'UART transmit line'}, ] + optional_probes = [] options = { 'baudrate': ['Baud rate', 115200], 'num_data_bits': ['Data bits', 8], # Valid: 5-9. - 'parity': ['Parity', PARITY_NONE], - 'parity_check': ['Check parity', True], + 'parity_type': ['Parity type', PARITY_NONE], + 'parity_check': ['Check parity?', True], # TODO: Bool supported? 'num_stop_bits': ['Stop bit(s)', STOP_BITS_1], 'bit_order': ['Bit order', LSB_FIRST], # TODO: Options to invert the signal(s). @@ -233,23 +228,14 @@ class Decoder(srd.Decoder): self.oldbit = [None, None] - # Set protocol decoder option defaults. - self.baudrate = Decoder.options['baudrate'][1] - self.num_data_bits = Decoder.options['num_data_bits'][1] - self.parity = Decoder.options['parity'][1] - self.check_parity = Decoder.options['parity_check'][1] - self.num_stop_bits = Decoder.options['num_stop_bits'][1] - self.bit_order = Decoder.options['bit_order'][1] - def start(self, metadata): self.samplerate = metadata['samplerate'] self.out_proto = self.add(srd.OUTPUT_PROTO, 'uart') self.out_ann = self.add(srd.OUTPUT_ANN, 'uart') - # TODO: Override PD options, if user wants that. - # The width of one UART bit in number of samples. - self.bit_width = float(self.samplerate) / float(self.baudrate) + self.bit_width = \ + float(self.samplerate) / float(self.options['baudrate']) def report(self): pass @@ -292,7 +278,7 @@ class Decoder(srd.Decoder): # The startbit must be 0. If not, we report an error. if self.startbit[rxtx] != 0: self.put(self.frame_start[rxtx], self.samplenum, self.out_proto, - [T_INVALID_START, rxtx, self.startbit[rxtx]]) + ['INVALID STARTBIT', rxtx, self.startbit[rxtx]]) # TODO: Abort? Ignore rest of the frame? self.cur_data_bit[rxtx] = 0 @@ -302,7 +288,7 @@ class Decoder(srd.Decoder): self.state[rxtx] = GET_DATA_BITS self.put(self.frame_start[rxtx], self.samplenum, self.out_proto, - [T_START, rxtx, self.startbit[rxtx]]) + ['STARTBIT', rxtx, self.startbit[rxtx]]) self.put(self.frame_start[rxtx], self.samplenum, self.out_ann, [ANN_ASCII, ['Start bit', 'Start', 'S']]) @@ -316,24 +302,27 @@ class Decoder(srd.Decoder): self.startsample[rxtx] = self.samplenum # Get the next data bit in LSB-first or MSB-first fashion. - if self.bit_order == LSB_FIRST: + if self.options['bit_order'] == LSB_FIRST: self.databyte[rxtx] >>= 1 - self.databyte[rxtx] |= (signal << (self.num_data_bits - 1)) - elif self.bit_order == MSB_FIRST: + self.databyte[rxtx] |= \ + (signal << (self.options['num_data_bits'] - 1)) + elif self.options['bit_order'] == MSB_FIRST: self.databyte[rxtx] <<= 1 self.databyte[rxtx] |= (signal << 0) else: - raise Exception('Invalid bit order value: %d', self.bit_order) + raise Exception('Invalid bit order value: %d', + self.options['bit_order']) # Return here, unless we already received all data bits. - if self.cur_data_bit[rxtx] < self.num_data_bits - 1: # TODO? Off-by-one? + # TODO? Off-by-one? + if self.cur_data_bit[rxtx] < self.options['num_data_bits'] - 1: self.cur_data_bit[rxtx] += 1 return self.state[rxtx] = GET_PARITY_BIT self.put(self.startsample[rxtx], self.samplenum - 1, self.out_proto, - [T_DATA, rxtx, self.databyte[rxtx]]) + ['DATA', rxtx, self.databyte[rxtx]]) s = 'RX: ' if (rxtx == RX) else 'TX: ' self.putx(rxtx, [ANN_ASCII, [s + chr(self.databyte[rxtx])]]) @@ -347,38 +336,39 @@ class Decoder(srd.Decoder): def get_parity_bit(self, rxtx, signal): # If no parity is used/configured, skip to the next state immediately. - if self.parity == PARITY_NONE: + if self.options['parity_type'] == PARITY_NONE: self.state[rxtx] = GET_STOP_BITS return # Skip samples until we're in the middle of the parity bit. - if not self.reached_bit(rxtx, self.num_data_bits + 1): + if not self.reached_bit(rxtx, self.options['num_data_bits'] + 1): return self.paritybit[rxtx] = signal self.state[rxtx] = GET_STOP_BITS - if parity_ok(self.parity[rxtx], self.paritybit[rxtx], - self.databyte[rxtx], self.num_data_bits): + if parity_ok(self.options['parity_type'], self.paritybit[rxtx], + self.databyte[rxtx], self.options['num_data_bits']): # TODO: Fix range. self.put(self.samplenum, self.samplenum, self.out_proto, - [T_PARITY_BIT, rxtx, self.paritybit[rxtx]]) + ['PARITYBIT', rxtx, self.paritybit[rxtx]]) self.put(self.samplenum, self.samplenum, self.out_ann, [ANN_ASCII, ['Parity bit', 'Parity', 'P']]) else: # TODO: Fix range. # TODO: Return expected/actual parity values. self.put(self.samplenum, self.samplenum, self.out_proto, - [T_PARITY_ERROR, rxtx, (0, 1)]) # FIXME: Dummy tuple... + ['PARITY ERROR', rxtx, (0, 1)]) # FIXME: Dummy tuple... self.put(self.samplenum, self.samplenum, self.out_ann, [ANN_ASCII, ['Parity error', 'Parity err', 'PE']]) # TODO: Currently only supports 1 stop bit. def get_stop_bits(self, rxtx, signal): # Skip samples until we're in the middle of the stop bit(s). - skip_parity = 0 if self.parity == PARITY_NONE else 1 - if not self.reached_bit(rxtx, self.num_data_bits + 1 + skip_parity): + skip_parity = 0 if self.options['parity_type'] == PARITY_NONE else 1 + b = self.options['num_data_bits'] + 1 + skip_parity + if not self.reached_bit(rxtx, b): return self.stopbit1[rxtx] = signal @@ -386,18 +376,19 @@ class Decoder(srd.Decoder): # Stop bits must be 1. If not, we report an error. if self.stopbit1[rxtx] != 1: self.put(self.frame_start[rxtx], self.samplenum, self.out_proto, - [T_INVALID_STOP, rxtx, self.stopbit1[rxtx]]) + ['INVALID STOPBIT', rxtx, self.stopbit1[rxtx]]) # TODO: Abort? Ignore the frame? Other? self.state[rxtx] = WAIT_FOR_START_BIT # TODO: Fix range. self.put(self.samplenum, self.samplenum, self.out_proto, - [T_STOP, rxtx, self.stopbit1[rxtx]]) + ['STOPBIT', rxtx, self.stopbit1[rxtx]]) self.put(self.samplenum, self.samplenum, self.out_ann, [ANN_ASCII, ['Stop bit', 'Stop', 'P']]) - def decode(self, ss, es, data): # TODO + def decode(self, ss, es, data): + # TODO: Either RX or TX could be omitted (optional probe). for (samplenum, (rx, tx)) in data: # TODO: Start counting at 0 or 1? Increase before or after? @@ -426,7 +417,7 @@ class Decoder(srd.Decoder): elif self.state[rxtx] == GET_STOP_BITS: self.get_stop_bits(rxtx, signal) else: - raise Exception('Invalid state: %s' % self.state[rxtx]) + raise Exception('Invalid state: %d' % self.state[rxtx]) # Save current RX/TX values for the next round. self.oldbit[rxtx] = signal