decoders/can/pd.py

   1 ##
   2 ## This file is part of the libsigrokdecode project.
   3 ##
   4 ## Copyright (C) 2012-2013 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, see <http://www.gnu.org/licenses/>.
  18 ##
  19
  20 import sigrokdecode as srd
  21
  22 class SamplerateError(Exception):
  23     pass
  24
  25 class Decoder(srd.Decoder):
  26     api_version = 3
  27     id = 'can'
  28     name = 'CAN'
  29     longname = 'Controller Area Network'
  30     desc = 'Field bus protocol for distributed realtime control.'
  31     license = 'gplv2+'
  32     inputs = ['logic']
  33     outputs = ['can']
  34     channels = (
  35         {'id': 'can_rx', 'name': 'CAN RX', 'desc': 'CAN bus line'},
  36     )
  37     options = (
  38         {'id': 'bitrate', 'desc': 'Bitrate (bits/s)', 'default': 1000000},
  39         {'id': 'sample_point', 'desc': 'Sample point (%)', 'default': 70.0},
  40     )
  41     annotations = (
  42         ('data', 'CAN payload data'),
  43         ('sof', 'Start of frame'),
  44         ('eof', 'End of frame'),
  45         ('id', 'Identifier'),
  46         ('ext-id', 'Extended identifier'),
  47         ('full-id', 'Full identifier'),
  48         ('ide', 'Identifier extension bit'),
  49         ('reserved-bit', 'Reserved bit 0 and 1'),
  50         ('rtr', 'Remote transmission request'),
  51         ('srr', 'Substitute remote request'),
  52         ('dlc', 'Data length count'),
  53         ('crc-sequence', 'CRC sequence'),
  54         ('crc-delimiter', 'CRC delimiter'),
  55         ('ack-slot', 'ACK slot'),
  56         ('ack-delimiter', 'ACK delimiter'),
  57         ('stuff-bit', 'Stuff bit'),
  58         ('warnings', 'Human-readable warnings'),
  59         ('bit', 'Bit'),
  60     )
  61     annotation_rows = (
  62         ('bits', 'Bits', (15, 17)),
  63         ('fields', 'Fields', tuple(range(15))),
  64         ('warnings', 'Warnings', (16,)),
  65     )
  66
  67     def __init__(self):
  68         self.samplerate = None
  69         self.reset_variables()
  70
  71     def start(self):
  72         self.out_ann = self.register(srd.OUTPUT_ANN)
  73
  74     def metadata(self, key, value):
  75         if key == srd.SRD_CONF_SAMPLERATE:
  76             self.samplerate = value
  77             self.bit_width = float(self.samplerate) / float(self.options['bitrate'])
  78             self.bitpos = (self.bit_width / 100.0) * self.options['sample_point']
  79
  80     # Generic helper for CAN bit annotations.
  81     def putg(self, ss, es, data):
  82         left, right = int(self.bitpos), int(self.bit_width - self.bitpos)
  83         self.put(ss - left, es + right, self.out_ann, data)
  84
  85     # Single-CAN-bit annotation using the current samplenum.
  86     def putx(self, data):
  87         self.putg(self.samplenum, self.samplenum, data)
  88
  89     # Single-CAN-bit annotation using the samplenum of CAN bit 12.
  90     def put12(self, data):
  91         self.putg(self.ss_bit12, self.ss_bit12, data)
  92
  93     # Multi-CAN-bit annotation from self.ss_block to current samplenum.
  94     def putb(self, data):
  95         self.putg(self.ss_block, self.samplenum, data)
  96
  97     def reset_variables(self):
  98         self.state = 'IDLE'
  99         self.sof = self.frame_type = self.dlc = None
 100         self.rawbits = [] # All bits, including stuff bits
 101         self.bits = [] # Only actual CAN frame bits (no stuff bits)
 102         self.curbit = 0 # Current bit of CAN frame (bit 0 == SOF)
 103         self.last_databit = 999 # Positive value that bitnum+x will never match
 104         self.ss_block = None
 105         self.ss_bit12 = None
 106         self.ss_databytebits = []
 107
 108     # Determine the position of the next desired bit's sample point.
 109     def get_sample_point(self, bitnum):
 110         bitpos = int(self.sof + (self.bit_width * bitnum) + self.bitpos)
 111         return bitpos
 112
 113     def is_stuff_bit(self):
 114         # CAN uses NRZ encoding and bit stuffing.
 115         # After 5 identical bits, a stuff bit of opposite value is added.
 116         last_6_bits = self.rawbits[-6:]
 117         if last_6_bits not in ([0, 0, 0, 0, 0, 1], [1, 1, 1, 1, 1, 0]):
 118             return False
 119
 120         # Stuff bit. Keep it in self.rawbits, but drop it from self.bits.
 121         self.bits.pop() # Drop last bit.
 122         return True
 123
 124     def is_valid_crc(self, crc_bits):
 125         return True # TODO
 126
 127     def decode_error_frame(self, bits):
 128         pass # TODO
 129
 130     def decode_overload_frame(self, bits):
 131         pass # TODO
 132
 133     # Both standard and extended frames end with CRC, CRC delimiter, ACK,
 134     # ACK delimiter, and EOF fields. Handle them in a common function.
 135     # Returns True if the frame ended (EOF), False otherwise.
 136     def decode_frame_end(self, can_rx, bitnum):
 137
 138         # Remember start of CRC sequence (see below).
 139         if bitnum == (self.last_databit + 1):
 140             self.ss_block = self.samplenum
 141
 142         # CRC sequence (15 bits)
 143         elif bitnum == (self.last_databit + 15):
 144             x = self.last_databit + 1
 145             crc_bits = self.bits[x:x + 15 + 1]
 146             self.crc = int(''.join(str(d) for d in crc_bits), 2)
 147             self.putb([11, ['CRC sequence: 0x%04x' % self.crc,
 148                             'CRC: 0x%04x' % self.crc, 'CRC']])
 149             if not self.is_valid_crc(crc_bits):
 150                 self.putb([16, ['CRC is invalid']])
 151
 152         # CRC delimiter bit (recessive)
 153         elif bitnum == (self.last_databit + 16):
 154             self.putx([12, ['CRC delimiter: %d' % can_rx,
 155                             'CRC d: %d' % can_rx, 'CRC d']])
 156             if can_rx != 1:
 157                 self.putx([16, ['CRC delimiter must be a recessive bit']])
 158
 159         # ACK slot bit (dominant: ACK, recessive: NACK)
 160         elif bitnum == (self.last_databit + 17):
 161             ack = 'ACK' if can_rx == 0 else 'NACK'
 162             self.putx([13, ['ACK slot: %s' % ack, 'ACK s: %s' % ack, 'ACK s']])
 163
 164         # ACK delimiter bit (recessive)
 165         elif bitnum == (self.last_databit + 18):
 166             self.putx([14, ['ACK delimiter: %d' % can_rx,
 167                             'ACK d: %d' % can_rx, 'ACK d']])
 168             if can_rx != 1:
 169                 self.putx([16, ['ACK delimiter must be a recessive bit']])
 170
 171         # Remember start of EOF (see below).
 172         elif bitnum == (self.last_databit + 19):
 173             self.ss_block = self.samplenum
 174
 175         # End of frame (EOF), 7 recessive bits
 176         elif bitnum == (self.last_databit + 25):
 177             self.putb([2, ['End of frame', 'EOF', 'E']])
 178             if self.rawbits[-7:] != [1, 1, 1, 1, 1, 1, 1]:
 179                 self.putb([16, ['End of frame (EOF) must be 7 recessive bits']])
 180             self.reset_variables()
 181             return True
 182
 183         return False
 184
 185     # Returns True if the frame ended (EOF), False otherwise.
 186     def decode_standard_frame(self, can_rx, bitnum):
 187
 188         # Bit 14: RB0 (reserved bit)
 189         # Has to be sent dominant, but receivers should accept recessive too.
 190         if bitnum == 14:
 191             self.putx([7, ['Reserved bit 0: %d' % can_rx,
 192                            'RB0: %d' % can_rx, 'RB0']])
 193
 194             # Bit 12: Remote transmission request (RTR) bit
 195             # Data frame: dominant, remote frame: recessive
 196             # Remote frames do not contain a data field.
 197             rtr = 'remote' if self.bits[12] == 1 else 'data'
 198             self.put12([8, ['Remote transmission request: %s frame' % rtr,
 199                             'RTR: %s frame' % rtr, 'RTR']])
 200
 201         # Remember start of DLC (see below).
 202         elif bitnum == 15:
 203             self.ss_block = self.samplenum
 204
 205         # Bits 15-18: Data length code (DLC), in number of bytes (0-8).
 206         elif bitnum == 18:
 207             self.dlc = int(''.join(str(d) for d in self.bits[15:18 + 1]), 2)
 208             self.putb([10, ['Data length code: %d' % self.dlc,
 209                             'DLC: %d' % self.dlc, 'DLC']])
 210             self.last_databit = 18 + (self.dlc * 8)
 211             if self.dlc > 8:
 212                 self.putb([16, ['Data length code (DLC) > 8 is not allowed']])
 213
 214         # Remember all databyte bits, except the very last one.
 215         elif bitnum in range(19, self.last_databit):
 216             self.ss_databytebits.append(self.samplenum)
 217
 218         # Bits 19-X: Data field (0-8 bytes, depending on DLC)
 219         # The bits within a data byte are transferred MSB-first.
 220         elif bitnum == self.last_databit:
 221             self.ss_databytebits.append(self.samplenum) # Last databyte bit.
 222             for i in range(self.dlc):
 223                 x = 18 + (8 * i) + 1
 224                 b = int(''.join(str(d) for d in self.bits[x:x + 8]), 2)
 225                 ss = self.ss_databytebits[i * 8]
 226                 es = self.ss_databytebits[((i + 1) * 8) - 1]
 227                 self.putg(ss, es, [0, ['Data byte %d: 0x%02x' % (i, b),
 228                                        'DB %d: 0x%02x' % (i, b), 'DB']])
 229             self.ss_databytebits = []
 230
 231         elif bitnum > self.last_databit:
 232             return self.decode_frame_end(can_rx, bitnum)
 233
 234         return False
 235
 236     # Returns True if the frame ended (EOF), False otherwise.
 237     def decode_extended_frame(self, can_rx, bitnum):
 238
 239         # Remember start of EID (see below).
 240         if bitnum == 14:
 241             self.ss_block = self.samplenum
 242
 243         # Bits 14-31: Extended identifier (EID[17..0])
 244         elif bitnum == 31:
 245             self.eid = int(''.join(str(d) for d in self.bits[14:]), 2)
 246             s = '%d (0x%x)' % (self.eid, self.eid)
 247             self.putb([4, ['Extended Identifier: %s' % s,
 248                            'Extended ID: %s' % s, 'Extended ID', 'EID']])
 249
 250             self.fullid = self.id << 18 | self.eid
 251             s = '%d (0x%x)' % (self.fullid, self.fullid)
 252             self.putb([5, ['Full Identifier: %s' % s, 'Full ID: %s' % s,
 253                            'Full ID', 'FID']])
 254
 255             # Bit 12: Substitute remote request (SRR) bit
 256             self.put12([9, ['Substitute remote request: %d' % self.bits[12],
 257                             'SRR: %d' % self.bits[12], 'SRR']])
 258
 259         # Bit 32: Remote transmission request (RTR) bit
 260         # Data frame: dominant, remote frame: recessive
 261         # Remote frames do not contain a data field.
 262         if bitnum == 32:
 263             rtr = 'remote' if can_rx == 1 else 'data'
 264             self.putx([8, ['Remote transmission request: %s frame' % rtr,
 265                            'RTR: %s frame' % rtr, 'RTR']])
 266
 267         # Bit 33: RB1 (reserved bit)
 268         elif bitnum == 33:
 269             self.putx([7, ['Reserved bit 1: %d' % can_rx,
 270                            'RB1: %d' % can_rx, 'RB1']])
 271
 272         # Bit 34: RB0 (reserved bit)
 273         elif bitnum == 34:
 274             self.putx([7, ['Reserved bit 0: %d' % can_rx,
 275                            'RB0: %d' % can_rx, 'RB0']])
 276
 277         # Remember start of DLC (see below).
 278         elif bitnum == 35:
 279             self.ss_block = self.samplenum
 280
 281         # Bits 35-38: Data length code (DLC), in number of bytes (0-8).
 282         elif bitnum == 38:
 283             self.dlc = int(''.join(str(d) for d in self.bits[35:38 + 1]), 2)
 284             self.putb([10, ['Data length code: %d' % self.dlc,
 285                             'DLC: %d' % self.dlc, 'DLC']])
 286             self.last_databit = 38 + (self.dlc * 8)
 287
 288         # Remember all databyte bits, except the very last one.
 289         elif bitnum in range(39, self.last_databit):
 290             self.ss_databytebits.append(self.samplenum)
 291
 292         # Bits 39-X: Data field (0-8 bytes, depending on DLC)
 293         # The bits within a data byte are transferred MSB-first.
 294         elif bitnum == self.last_databit:
 295             self.ss_databytebits.append(self.samplenum) # Last databyte bit.
 296             for i in range(self.dlc):
 297                 x = 38 + (8 * i) + 1
 298                 b = int(''.join(str(d) for d in self.bits[x:x + 8]), 2)
 299                 ss = self.ss_databytebits[i * 8]
 300                 es = self.ss_databytebits[((i + 1) * 8) - 1]
 301                 self.putg(ss, es, [0, ['Data byte %d: 0x%02x' % (i, b),
 302                                        'DB %d: 0x%02x' % (i, b), 'DB']])
 303             self.ss_databytebits = []
 304
 305         elif bitnum > self.last_databit:
 306             return self.decode_frame_end(can_rx, bitnum)
 307
 308         return False
 309
 310     def handle_bit(self, can_rx):
 311         self.rawbits.append(can_rx)
 312         self.bits.append(can_rx)
 313
 314         # Get the index of the current CAN frame bit (without stuff bits).
 315         bitnum = len(self.bits) - 1
 316
 317         # If this is a stuff bit, remove it from self.bits and ignore it.
 318         if self.is_stuff_bit():
 319             self.putx([15, [str(can_rx)]])
 320             self.curbit += 1 # Increase self.curbit (bitnum is not affected).
 321             return
 322         else:
 323             self.putx([17, [str(can_rx)]])
 324
 325         # Bit 0: Start of frame (SOF) bit
 326         if bitnum == 0:
 327             self.putx([1, ['Start of frame', 'SOF', 'S']])
 328             if can_rx != 0:
 329                 self.putx([16, ['Start of frame (SOF) must be a dominant bit']])
 330
 331         # Remember start of ID (see below).
 332         elif bitnum == 1:
 333             self.ss_block = self.samplenum
 334
 335         # Bits 1-11: Identifier (ID[10..0])
 336         # The bits ID[10..4] must NOT be all recessive.
 337         elif bitnum == 11:
 338             self.id = int(''.join(str(d) for d in self.bits[1:]), 2)
 339             s = '%d (0x%x)' % (self.id, self.id),
 340             self.putb([3, ['Identifier: %s' % s, 'ID: %s' % s, 'ID']])
 341             if (self.id & 0x7f0) == 0x7f0:
 342                 self.putb([16, ['Identifier bits 10..4 must not be all recessive']])
 343
 344         # RTR or SRR bit, depending on frame type (gets handled later).
 345         elif bitnum == 12:
 346             # self.putx([0, ['RTR/SRR: %d' % can_rx]]) # Debug only.
 347             self.ss_bit12 = self.samplenum
 348
 349         # Bit 13: Identifier extension (IDE) bit
 350         # Standard frame: dominant, extended frame: recessive
 351         elif bitnum == 13:
 352             ide = self.frame_type = 'standard' if can_rx == 0 else 'extended'
 353             self.putx([6, ['Identifier extension bit: %s frame' % ide,
 354                            'IDE: %s frame' % ide, 'IDE']])
 355
 356         # Bits 14-X: Frame-type dependent, passed to the resp. handlers.
 357         elif bitnum >= 14:
 358             if self.frame_type == 'standard':
 359                 done = self.decode_standard_frame(can_rx, bitnum)
 360             else:
 361                 done = self.decode_extended_frame(can_rx, bitnum)
 362
 363             # The handlers return True if a frame ended (EOF).
 364             if done:
 365                 return
 366
 367         # After a frame there are 3 intermission bits (recessive).
 368         # After these bits, the bus is considered free.
 369
 370         self.curbit += 1
 371
 372     def decode(self):
 373         if not self.samplerate:
 374             raise SamplerateError('Cannot decode without samplerate.')
 375
 376         while True:
 377             # State machine.
 378             if self.state == 'IDLE':
 379                 # Wait for a dominant state (logic 0) on the bus.
 380                 (can_rx,) = self.wait({0: 'l'})
 381                 self.sof = self.samplenum
 382                 self.state = 'GET BITS'
 383             elif self.state == 'GET BITS':
 384                 # Wait until we're in the correct bit/sampling position.
 385                 pos = self.get_sample_point(self.curbit)
 386                 (can_rx,) = self.wait({'skip': pos - self.samplenum})
 387                 self.handle_bit(can_rx)