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