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