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