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 = 2
  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     # Return True if we reached the desired bit position, False otherwise.
 109     def reached_bit(self, bitnum):
 110         bitpos = int(self.sof + (self.bit_width * bitnum) + self.bitpos)
 111         if self.samplenum >= bitpos:
 112             return True
 113         return False
 114
 115     def is_stuff_bit(self):
 116         # CAN uses NRZ encoding and bit stuffing.
 117         # After 5 identical bits, a stuff bit of opposite value is added.
 118         last_6_bits = self.rawbits[-6:]
 119         if last_6_bits not in ([0, 0, 0, 0, 0, 1], [1, 1, 1, 1, 1, 0]):
 120             return False
 121
 122         # Stuff bit. Keep it in self.rawbits, but drop it from self.bits.
 123         self.bits.pop() # Drop last bit.
 124         return True
 125
 126     def is_valid_crc(self, crc_bits):
 127         return True # TODO
 128
 129     def decode_error_frame(self, bits):
 130         pass # TODO
 131
 132     def decode_overload_frame(self, bits):
 133         pass # TODO
 134
 135     # Both standard and extended frames end with CRC, CRC delimiter, ACK,
 136     # ACK delimiter, and EOF fields. Handle them in a common function.
 137     # Returns True if the frame ended (EOF), False otherwise.
 138     def decode_frame_end(self, can_rx, bitnum):
 139
 140         # Remember start of CRC sequence (see below).
 141         if bitnum == (self.last_databit + 1):
 142             self.ss_block = self.samplenum
 143
 144         # CRC sequence (15 bits)
 145         elif bitnum == (self.last_databit + 15):
 146             x = self.last_databit + 1
 147             crc_bits = self.bits[x:x + 15 + 1]
 148             self.crc = int(''.join(str(d) for d in crc_bits), 2)
 149             self.putb([11, ['CRC sequence: 0x%04x' % self.crc,
 150                             'CRC: 0x%04x' % self.crc, 'CRC']])
 151             if not self.is_valid_crc(crc_bits):
 152                 self.putb([16, ['CRC is invalid']])
 153
 154         # CRC delimiter bit (recessive)
 155         elif bitnum == (self.last_databit + 16):
 156             self.putx([12, ['CRC delimiter: %d' % can_rx,
 157                             'CRC d: %d' % can_rx, 'CRC d']])
 158             if can_rx != 1:
 159                 self.putx([16, ['CRC delimiter must be a recessive bit']])
 160
 161         # ACK slot bit (dominant: ACK, recessive: NACK)
 162         elif bitnum == (self.last_databit + 17):
 163             ack = 'ACK' if can_rx == 0 else 'NACK'
 164             self.putx([13, ['ACK slot: %s' % ack, 'ACK s: %s' % ack, 'ACK s']])
 165
 166         # ACK delimiter bit (recessive)
 167         elif bitnum == (self.last_databit + 18):
 168             self.putx([14, ['ACK delimiter: %d' % can_rx,
 169                             'ACK d: %d' % can_rx, 'ACK d']])
 170             if can_rx != 1:
 171                 self.putx([16, ['ACK delimiter must be a recessive bit']])
 172
 173         # Remember start of EOF (see below).
 174         elif bitnum == (self.last_databit + 19):
 175             self.ss_block = self.samplenum
 176
 177         # End of frame (EOF), 7 recessive bits
 178         elif bitnum == (self.last_databit + 25):
 179             self.putb([2, ['End of frame', 'EOF', 'E']])
 180             if self.rawbits[-7:] != [1, 1, 1, 1, 1, 1, 1]:
 181                 self.putb([16, ['End of frame (EOF) must be 7 recessive bits']])
 182             self.reset_variables()
 183             return True
 184
 185         return False
 186
 187     # Returns True if the frame ended (EOF), False otherwise.
 188     def decode_standard_frame(self, can_rx, bitnum):
 189
 190         # Bit 14: RB0 (reserved bit)
 191         # Has to be sent dominant, but receivers should accept recessive too.
 192         if bitnum == 14:
 193             self.putx([7, ['Reserved bit 0: %d' % can_rx,
 194                            'RB0: %d' % can_rx, 'RB0']])
 195
 196             # Bit 12: Remote transmission request (RTR) bit
 197             # Data frame: dominant, remote frame: recessive
 198             # Remote frames do not contain a data field.
 199             rtr = 'remote' if self.bits[12] == 1 else 'data'
 200             self.put12([8, ['Remote transmission request: %s frame' % rtr,
 201                             'RTR: %s frame' % rtr, 'RTR']])
 202
 203         # Remember start of DLC (see below).
 204         elif bitnum == 15:
 205             self.ss_block = self.samplenum
 206
 207         # Bits 15-18: Data length code (DLC), in number of bytes (0-8).
 208         elif bitnum == 18:
 209             self.dlc = int(''.join(str(d) for d in self.bits[15:18 + 1]), 2)
 210             self.putb([10, ['Data length code: %d' % self.dlc,
 211                             'DLC: %d' % self.dlc, 'DLC']])
 212             self.last_databit = 18 + (self.dlc * 8)
 213             if self.dlc > 8:
 214                 self.putb([16, ['Data length code (DLC) > 8 is not allowed']])
 215
 216         # Remember all databyte bits, except the very last one.
 217         elif bitnum in range(19, self.last_databit):
 218             self.ss_databytebits.append(self.samplenum)
 219
 220         # Bits 19-X: Data field (0-8 bytes, depending on DLC)
 221         # The bits within a data byte are transferred MSB-first.
 222         elif bitnum == self.last_databit:
 223             self.ss_databytebits.append(self.samplenum) # Last databyte bit.
 224             for i in range(self.dlc):
 225                 x = 18 + (8 * i) + 1
 226                 b = int(''.join(str(d) for d in self.bits[x:x + 8]), 2)
 227                 ss = self.ss_databytebits[i * 8]
 228                 es = self.ss_databytebits[((i + 1) * 8) - 1]
 229                 self.putg(ss, es, [0, ['Data byte %d: 0x%02x' % (i, b),
 230                                        'DB %d: 0x%02x' % (i, b), 'DB']])
 231             self.ss_databytebits = []
 232
 233         elif bitnum > self.last_databit:
 234             return self.decode_frame_end(can_rx, bitnum)
 235
 236         return False
 237
 238     # Returns True if the frame ended (EOF), False otherwise.
 239     def decode_extended_frame(self, can_rx, bitnum):
 240
 241         # Remember start of EID (see below).
 242         if bitnum == 14:
 243             self.ss_block = self.samplenum
 244
 245         # Bits 14-31: Extended identifier (EID[17..0])
 246         elif bitnum == 31:
 247             self.eid = int(''.join(str(d) for d in self.bits[14:]), 2)
 248             s = '%d (0x%x)' % (self.eid, self.eid)
 249             self.putb([4, ['Extended Identifier: %s' % s,
 250                            'Extended ID: %s' % s, 'Extended ID', 'EID']])
 251
 252             self.fullid = self.id << 18 | self.eid
 253             s = '%d (0x%x)' % (self.fullid, self.fullid)
 254             self.putb([5, ['Full Identifier: %s' % s, 'Full ID: %s' % s,
 255                            'Full ID', 'FID']])
 256
 257             # Bit 12: Substitute remote request (SRR) bit
 258             self.put12([9, ['Substitute remote request: %d' % self.bits[12],
 259                             'SRR: %d' % self.bits[12], 'SRR']])
 260
 261         # Bit 32: Remote transmission request (RTR) bit
 262         # Data frame: dominant, remote frame: recessive
 263         # Remote frames do not contain a data field.
 264         if bitnum == 32:
 265             rtr = 'remote' if can_rx == 1 else 'data'
 266             self.putx([8, ['Remote transmission request: %s frame' % rtr,
 267                            'RTR: %s frame' % rtr, 'RTR']])
 268
 269         # Bit 33: RB1 (reserved bit)
 270         elif bitnum == 33:
 271             self.putx([7, ['Reserved bit 1: %d' % can_rx,
 272                            'RB1: %d' % can_rx, 'RB1']])
 273
 274         # Bit 34: RB0 (reserved bit)
 275         elif bitnum == 34:
 276             self.putx([7, ['Reserved bit 0: %d' % can_rx,
 277                            'RB0: %d' % can_rx, 'RB0']])
 278
 279         # Remember start of DLC (see below).
 280         elif bitnum == 35:
 281             self.ss_block = self.samplenum
 282
 283         # Bits 35-38: Data length code (DLC), in number of bytes (0-8).
 284         elif bitnum == 38:
 285             self.dlc = int(''.join(str(d) for d in self.bits[35:38 + 1]), 2)
 286             self.putb([10, ['Data length code: %d' % self.dlc,
 287                             'DLC: %d' % self.dlc, 'DLC']])
 288             self.last_databit = 38 + (self.dlc * 8)
 289
 290         # Remember all databyte bits, except the very last one.
 291         elif bitnum in range(39, self.last_databit):
 292             self.ss_databytebits.append(self.samplenum)
 293
 294         # Bits 39-X: Data field (0-8 bytes, depending on DLC)
 295         # The bits within a data byte are transferred MSB-first.
 296         elif bitnum == self.last_databit:
 297             self.ss_databytebits.append(self.samplenum) # Last databyte bit.
 298             for i in range(self.dlc):
 299                 x = 38 + (8 * i) + 1
 300                 b = int(''.join(str(d) for d in self.bits[x:x + 8]), 2)
 301                 ss = self.ss_databytebits[i * 8]
 302                 es = self.ss_databytebits[((i + 1) * 8) - 1]
 303                 self.putg(ss, es, [0, ['Data byte %d: 0x%02x' % (i, b),
 304                                        'DB %d: 0x%02x' % (i, b), 'DB']])
 305             self.ss_databytebits = []
 306
 307         elif bitnum > self.last_databit:
 308             return self.decode_frame_end(can_rx, bitnum)
 309
 310         return False
 311
 312     def handle_bit(self, can_rx):
 313         self.rawbits.append(can_rx)
 314         self.bits.append(can_rx)
 315
 316         # Get the index of the current CAN frame bit (without stuff bits).
 317         bitnum = len(self.bits) - 1
 318
 319         # If this is a stuff bit, remove it from self.bits and ignore it.
 320         if self.is_stuff_bit():
 321             self.putx([15, [str(can_rx)]])
 322             self.curbit += 1 # Increase self.curbit (bitnum is not affected).
 323             return
 324         else:
 325             self.putx([17, [str(can_rx)]])
 326
 327         # Bit 0: Start of frame (SOF) bit
 328         if bitnum == 0:
 329             self.putx([1, ['Start of frame', 'SOF', 'S']])
 330             if can_rx != 0:
 331                 self.putx([16, ['Start of frame (SOF) must be a dominant bit']])
 332
 333         # Remember start of ID (see below).
 334         elif bitnum == 1:
 335             self.ss_block = self.samplenum
 336
 337         # Bits 1-11: Identifier (ID[10..0])
 338         # The bits ID[10..4] must NOT be all recessive.
 339         elif bitnum == 11:
 340             self.id = int(''.join(str(d) for d in self.bits[1:]), 2)
 341             s = '%d (0x%x)' % (self.id, self.id),
 342             self.putb([3, ['Identifier: %s' % s, 'ID: %s' % s, 'ID']])
 343             if (self.id & 0x7f0) == 0x7f0:
 344                 self.putb([16, ['Identifier bits 10..4 must not be all recessive']])
 345
 346         # RTR or SRR bit, depending on frame type (gets handled later).
 347         elif bitnum == 12:
 348             # self.putx([0, ['RTR/SRR: %d' % can_rx]]) # Debug only.
 349             self.ss_bit12 = self.samplenum
 350
 351         # Bit 13: Identifier extension (IDE) bit
 352         # Standard frame: dominant, extended frame: recessive
 353         elif bitnum == 13:
 354             ide = self.frame_type = 'standard' if can_rx == 0 else 'extended'
 355             self.putx([6, ['Identifier extension bit: %s frame' % ide,
 356                            'IDE: %s frame' % ide, 'IDE']])
 357
 358         # Bits 14-X: Frame-type dependent, passed to the resp. handlers.
 359         elif bitnum >= 14:
 360             if self.frame_type == 'standard':
 361                 done = self.decode_standard_frame(can_rx, bitnum)
 362             else:
 363                 done = self.decode_extended_frame(can_rx, bitnum)
 364
 365             # The handlers return True if a frame ended (EOF).
 366             if done:
 367                 return
 368
 369         # After a frame there are 3 intermission bits (recessive).
 370         # After these bits, the bus is considered free.
 371
 372         self.curbit += 1
 373
 374     def decode(self, ss, es, data):
 375         if not self.samplerate:
 376             raise SamplerateError('Cannot decode without samplerate.')
 377         for (self.samplenum, pins) in data:
 378
 379             (can_rx,) = pins
 380
 381             # State machine.
 382             if self.state == 'IDLE':
 383                 # Wait for a dominant state (logic 0) on the bus.
 384                 if can_rx == 1:
 385                     continue
 386                 self.sof = self.samplenum
 387                 self.state = 'GET BITS'
 388             elif self.state == 'GET BITS':
 389                 # Wait until we're in the correct bit/sampling position.
 390                 if not self.reached_bit(self.curbit):
 391                     continue
 392                 self.handle_bit(can_rx)