decoders/uart/pd.py

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