can: Random whitespace and cosmetic fixes.
[libsigrokdecode.git] / 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 ## Copyright (C) 2019 Stephan Thiele <stephan.thiele@mailbox.org>
6 ##
7 ## This program is free software; you can redistribute it and/or modify
8 ## it under the terms of the GNU General Public License as published by
9 ## the Free Software Foundation; either version 2 of the License, or
10 ## (at your option) any later version.
11 ##
12 ## This program is distributed in the hope that it will be useful,
13 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
14 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 ## GNU General Public License for more details.
16 ##
17 ## You should have received a copy of the GNU General Public License
18 ## along with this program; if not, see <http://www.gnu.org/licenses/>.
19 ##
20
21 import sigrokdecode as srd
22
23 class SamplerateError(Exception):
24     pass
25
26 class Decoder(srd.Decoder):
27     api_version = 3
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 = []
35     tags = ['Automotive']
36     channels = (
37         {'id': 'can_rx', 'name': 'CAN RX', 'desc': 'CAN bus line'},
38     )
39     options = (
40         {'id': 'nominal_bitrate', 'desc': 'Nominal bitrate (bits/s)', 'default': 1000000},
41         {'id': 'fast_bitrate', 'desc': 'Fast bitrate (bits/s)', 'default': 2000000},
42         {'id': 'sample_point', 'desc': 'Sample point (%)', 'default': 70.0},
43     )
44     annotations = (
45         ('data', 'CAN payload data'),
46         ('sof', 'Start of frame'),
47         ('eof', 'End of frame'),
48         ('id', 'Identifier'),
49         ('ext-id', 'Extended identifier'),
50         ('full-id', 'Full identifier'),
51         ('ide', 'Identifier extension bit'),
52         ('reserved-bit', 'Reserved bit 0 and 1'),
53         ('rtr', 'Remote transmission request'),
54         ('srr', 'Substitute remote request'),
55         ('dlc', 'Data length count'),
56         ('crc-sequence', 'CRC sequence'),
57         ('crc-delimiter', 'CRC delimiter'),
58         ('ack-slot', 'ACK slot'),
59         ('ack-delimiter', 'ACK delimiter'),
60         ('stuff-bit', 'Stuff bit'),
61         ('warnings', 'Human-readable warnings'),
62         ('bit', 'Bit'),
63     )
64     annotation_rows = (
65         ('bits', 'Bits', (15, 17)),
66         ('fields', 'Fields', tuple(range(15))),
67         ('warnings', 'Warnings', (16,)),
68     )
69
70     def __init__(self):
71         self.reset()
72
73     def dlc2len(self, dlc):
74         return [0, 1, 2, 3, 4, 5, 6, 7, 8, 12, 16, 20, 24, 32, 48, 64][dlc]
75
76     def reset(self):
77         self.samplerate = None
78         self.reset_variables()
79
80     def start(self):
81         self.out_ann = self.register(srd.OUTPUT_ANN)
82
83     def metadata(self, key, value):
84         if key == srd.SRD_CONF_SAMPLERATE:
85             self.samplerate = value
86             self.bit_width = float(self.samplerate) / float(self.options['nominal_bitrate'])
87             self.sample_point = (self.bit_width / 100.0) * self.options['sample_point']
88
89     # Generic helper for CAN bit annotations.
90     def putg(self, ss, es, data):
91         left, right = int(self.sample_point), int(self.bit_width - self.sample_point)
92         self.put(ss - left, es + right, self.out_ann, data)
93
94     # Single-CAN-bit annotation using the current samplenum.
95     def putx(self, data):
96         self.putg(self.samplenum, self.samplenum, data)
97
98     # Single-CAN-bit annotation using the samplenum of CAN bit 12.
99     def put12(self, data):
100         self.putg(self.ss_bit12, self.ss_bit12, data)
101
102     # Single-CAN-bit annotation using the samplenum of CAN bit 32.
103     def put32(self, data):
104         self.putg(self.ss_bit32, self.ss_bit32, data)
105
106     # Multi-CAN-bit annotation from self.ss_block to current samplenum.
107     def putb(self, data):
108         self.putg(self.ss_block, self.samplenum, data)
109
110     def reset_variables(self):
111         self.state = 'IDLE'
112         self.sof = self.frame_type = self.dlc = None
113         self.rawbits = [] # All bits, including stuff bits
114         self.bits = [] # Only actual CAN frame bits (no stuff bits)
115         self.curbit = 0 # Current bit of CAN frame (bit 0 == SOF)
116         self.last_databit = 999 # Positive value that bitnum+x will never match
117         self.ss_block = None
118         self.ss_bit12 = None
119         self.ss_bit32 = None
120         self.ss_databytebits = []
121         self.fd = False
122         self.rtr = None
123
124     # Poor man's clock synchronization. Use signal edges which change to
125     # dominant state in rather simple ways. This naive approach is neither
126     # aware of the SYNC phase's width nor the specific location of the edge,
127     # but improves the decoder's reliability when the input signal's bitrate
128     # does not exactly match the nominal rate.
129     def dom_edge_seen(self, force = False):
130         self.dom_edge_snum = self.samplenum
131         self.dom_edge_bcount = self.curbit
132
133     def bit_sampled(self):
134         # EMPTY
135         pass
136
137     # Determine the position of the next desired bit's sample point.
138     def get_sample_point(self, bitnum):
139         samplenum = self.dom_edge_snum
140         samplenum += int(self.bit_width * (bitnum - self.dom_edge_bcount))
141         samplenum += int(self.sample_point)
142         return samplenum
143
144     def is_stuff_bit(self):
145         # CAN uses NRZ encoding and bit stuffing.
146         # After 5 identical bits, a stuff bit of opposite value is added.
147         # But not in the CRC delimiter, ACK, and end of frame fields.
148         if len(self.bits) > self.last_databit + 17:
149             return False
150         last_6_bits = self.rawbits[-6:]
151         if last_6_bits not in ([0, 0, 0, 0, 0, 1], [1, 1, 1, 1, 1, 0]):
152             return False
153
154         # Stuff bit. Keep it in self.rawbits, but drop it from self.bits.
155         self.bits.pop() # Drop last bit.
156         return True
157
158     def is_valid_crc(self, crc_bits):
159         return True # TODO
160
161     def decode_error_frame(self, bits):
162         pass # TODO
163
164     def decode_overload_frame(self, bits):
165         pass # TODO
166
167     # Both standard and extended frames end with CRC, CRC delimiter, ACK,
168     # ACK delimiter, and EOF fields. Handle them in a common function.
169     # Returns True if the frame ended (EOF), False otherwise.
170     def decode_frame_end(self, can_rx, bitnum):
171
172         # Remember start of CRC sequence (see below).
173         if bitnum == (self.last_databit + 1):
174             self.ss_block = self.samplenum
175             if self.fd:
176                 if self.dlc2len(self.dlc) < 16:
177                     self.crc_len = 27 # 17 + SBC + stuff bits
178                 else:
179                     self.crc_len = 32 # 21 + SBC + stuff bits
180             else:
181                 self.crc_len = 15
182
183         # CRC sequence (15 bits, 17 bits or 21 bits)
184         elif bitnum == (self.last_databit + self.crc_len):
185             if self.fd:
186                 if self.dlc2len(self.dlc) < 16:
187                     crc_type = "CRC-17"
188                 else:
189                     crc_type = "CRC-21"
190             else:
191                 crc_type = "CRC" # TODO: CRC-15 (will break existing tests)
192
193             x = self.last_databit + 1
194             crc_bits = self.bits[x:x + self.crc_len + 1]
195             self.crc = int(''.join(str(d) for d in crc_bits), 2)
196             self.putb([11, ['%s sequence: 0x%04x' % (crc_type, self.crc),
197                             '%s: 0x%04x' % (crc_type, self.crc), '%s' % crc_type]])
198             if not self.is_valid_crc(crc_bits):
199                 self.putb([16, ['CRC is invalid']])
200
201         # CRC delimiter bit (recessive)
202         elif bitnum == (self.last_databit + self.crc_len + 1):
203             self.putx([12, ['CRC delimiter: %d' % can_rx,
204                             'CRC d: %d' % can_rx, 'CRC d']])
205             if can_rx != 1:
206                 self.putx([16, ['CRC delimiter must be a recessive bit']])
207
208         # ACK slot bit (dominant: ACK, recessive: NACK)
209         elif bitnum == (self.last_databit + self.crc_len + 2):
210             ack = 'ACK' if can_rx == 0 else 'NACK'
211             self.putx([13, ['ACK slot: %s' % ack, 'ACK s: %s' % ack, 'ACK s']])
212
213         # ACK delimiter bit (recessive)
214         elif bitnum == (self.last_databit + self.crc_len + 3):
215             self.putx([14, ['ACK delimiter: %d' % can_rx,
216                             'ACK d: %d' % can_rx, 'ACK d']])
217             if can_rx != 1:
218                 self.putx([16, ['ACK delimiter must be a recessive bit']])
219
220         # Remember start of EOF (see below).
221         elif bitnum == (self.last_databit + self.crc_len + 4):
222             self.ss_block = self.samplenum
223
224         # End of frame (EOF), 7 recessive bits
225         elif bitnum == (self.last_databit + self.crc_len + 10):
226             self.putb([2, ['End of frame', 'EOF', 'E']])
227             if self.rawbits[-7:] != [1, 1, 1, 1, 1, 1, 1]:
228                 self.putb([16, ['End of frame (EOF) must be 7 recessive bits']])
229             self.reset_variables()
230             return True
231
232         return False
233
234     # Returns True if the frame ended (EOF), False otherwise.
235     def decode_standard_frame(self, can_rx, bitnum):
236
237         # Bit 14: FDF (Flexible data format)
238         # Has to be sent dominant when FD frame, has to be sent recessive
239         # when classic CAN frame.
240         if bitnum == 14:
241             self.fd = True if can_rx else False
242             if self.fd:
243                 self.putx([7, ['Flexible data format: %d' % can_rx,
244                                'FDF: %d' % can_rx, 'FDF']])
245             else:
246                 self.putx([7, ['Reserved bit 0: %d' % can_rx,
247                                'RB0: %d' % can_rx, 'RB0']])
248
249             if self.fd:
250                 # Bit 12: Substitute remote request (SRR) bit
251                 self.put12([8, ['Substitute remote request', 'SRR']])
252                 self.dlc_start = 18
253             else:
254                 # Bit 12: Remote transmission request (RTR) bit
255                 # Data frame: dominant, remote frame: recessive
256                 # Remote frames do not contain a data field.
257                 rtr = 'remote' if self.bits[12] == 1 else 'data'
258                 self.put12([8, ['Remote transmission request: %s frame' % rtr,
259                                 'RTR: %s frame' % rtr, 'RTR']])
260                 self.dlc_start = 15
261
262         if bitnum == 15 and self.fd:
263             self.putx([7, ['Reserved: %d' % can_rx, 'R0: %d' % can_rx, 'R0']])
264
265         if bitnum == 16 and self.fd:
266             self.putx([7, ['Bit rate switch: %d' % can_rx, 'BRS: %d' % can_rx, 'BRS']])
267
268         if bitnum == 17 and self.fd:
269             self.putx([7, ['Error state indicator: %d' % can_rx, 'ESI: %d' % can_rx, 'ESI']])
270
271         # Remember start of DLC (see below).
272         elif bitnum == self.dlc_start:
273             self.ss_block = self.samplenum
274
275         # Bits 15-18: Data length code (DLC), in number of bytes (0-8).
276         elif bitnum == self.dlc_start + 3:
277             self.dlc = int(''.join(str(d) for d in self.bits[self.dlc_start:self.dlc_start + 4]), 2)
278             self.putb([10, ['Data length code: %d' % self.dlc,
279                             'DLC: %d' % self.dlc, 'DLC']])
280             self.last_databit = self.dlc_start + 3 + (self.dlc2len(self.dlc) * 8)
281             if self.dlc > 8 and not self.fd:
282                 self.putb([16, ['Data length code (DLC) > 8 is not allowed']])
283
284         # Remember all databyte bits, except the very last one.
285         elif bitnum in range(self.dlc_start + 4, self.last_databit):
286             self.ss_databytebits.append(self.samplenum)
287
288         # Bits 19-X: Data field (0-8 bytes, depending on DLC)
289         # The bits within a data byte are transferred MSB-first.
290         elif bitnum == self.last_databit:
291             self.ss_databytebits.append(self.samplenum) # Last databyte bit.
292             for i in range(self.dlc2len(self.dlc)):
293                 x = self.dlc_start + 4 + (8 * i)
294                 b = int(''.join(str(d) for d in self.bits[x:x + 8]), 2)
295                 ss = self.ss_databytebits[i * 8]
296                 es = self.ss_databytebits[((i + 1) * 8) - 1]
297                 self.putg(ss, es, [0, ['Data byte %d: 0x%02x' % (i, b),
298                                        'DB %d: 0x%02x' % (i, b), 'DB']])
299             self.ss_databytebits = []
300
301         elif bitnum > self.last_databit:
302             return self.decode_frame_end(can_rx, bitnum)
303
304         return False
305
306     # Returns True if the frame ended (EOF), False otherwise.
307     def decode_extended_frame(self, can_rx, bitnum):
308
309         # Remember start of EID (see below).
310         if bitnum == 14:
311             self.ss_block = self.samplenum
312             self.fd = False
313             self.dlc_start = 35
314
315         # Bits 14-31: Extended identifier (EID[17..0])
316         elif bitnum == 31:
317             self.eid = int(''.join(str(d) for d in self.bits[14:]), 2)
318             s = '%d (0x%x)' % (self.eid, self.eid)
319             self.putb([4, ['Extended Identifier: %s' % s,
320                            'Extended ID: %s' % s, 'Extended ID', 'EID']])
321
322             self.fullid = self.id << 18 | self.eid
323             s = '%d (0x%x)' % (self.fullid, self.fullid)
324             self.putb([5, ['Full Identifier: %s' % s, 'Full ID: %s' % s,
325                            'Full ID', 'FID']])
326
327             # Bit 12: Substitute remote request (SRR) bit
328             self.put12([9, ['Substitute remote request: %d' % self.bits[12],
329                             'SRR: %d' % self.bits[12], 'SRR']])
330
331         # Bit 32: Remote transmission request (RTR) bit
332         # Data frame: dominant, remote frame: recessive
333         # Remote frames do not contain a data field.
334
335         # Remember start of RTR (see below).
336         if bitnum == 32:
337             self.ss_bit32 = self.samplenum
338             self.rtr = can_rx
339
340             if not self.fd:
341                rtr = 'remote' if can_rx == 1 else 'data'
342                self.putx([8, ['Remote transmission request: %s frame' % rtr,
343                               'RTR: %s frame' % rtr, 'RTR']])
344
345         # Bit 33: RB1 (reserved bit)
346         elif bitnum == 33:
347             self.fd = True if can_rx else False
348             if self.fd:
349                 self.dlc_start = 37
350                 self.putx([7, ['Flexible data format: %d' % can_rx,
351                                'FDF: %d' % can_rx, 'FDF']])
352                 self.put32([7, ['Reserved bit 1: %d' % self.rtr,
353                                 'RB1: %d' % self.rtr, 'RB1']])
354             else:
355                 self.putx([7, ['Reserved bit 1: %d' % can_rx,
356                                'RB1: %d' % can_rx, 'RB1']])
357
358         # Bit 34: RB0 (reserved bit)
359         elif bitnum == 34:
360             self.putx([7, ['Reserved bit 0: %d' % can_rx,
361                            'RB0: %d' % can_rx, 'RB0']])
362
363         elif bitnum == 35 and self.fd:
364             self.putx([7, ['Bit rate switch: %d' % can_rx,
365                            'BRS: %d' % can_rx, 'BRS']])
366
367         elif bitnum == 36 and self.fd:
368             self.putx([7, ['Error state indicator: %d' % can_rx,
369                            'ESI: %d' % can_rx, 'ESI']])
370
371         # Remember start of DLC (see below).
372         elif bitnum == self.dlc_start:
373             self.ss_block = self.samplenum
374
375         # Bits 35-38: Data length code (DLC), in number of bytes (0-8).
376         elif bitnum == self.dlc_start + 3:
377             self.dlc = int(''.join(str(d) for d in self.bits[self.dlc_start:self.dlc_start + 4]), 2)
378             self.putb([10, ['Data length code: %d' % self.dlc,
379                             'DLC: %d' % self.dlc, 'DLC']])
380             self.last_databit = self.dlc_start + 3 + (self.dlc2len(self.dlc) * 8)
381
382         # Remember all databyte bits, except the very last one.
383         elif bitnum in range(self.dlc_start + 4, self.last_databit):
384             self.ss_databytebits.append(self.samplenum)
385
386         # Bits 39-X: Data field (0-8 bytes, depending on DLC)
387         # The bits within a data byte are transferred MSB-first.
388         elif bitnum == self.last_databit:
389             self.ss_databytebits.append(self.samplenum) # Last databyte bit.
390             for i in range(self.dlc2len(self.dlc)):
391                 x = self.dlc_start + 4 + (8 * i)
392                 b = int(''.join(str(d) for d in self.bits[x:x + 8]), 2)
393                 ss = self.ss_databytebits[i * 8]
394                 es = self.ss_databytebits[((i + 1) * 8) - 1]
395                 self.putg(ss, es, [0, ['Data byte %d: 0x%02x' % (i, b),
396                                        'DB %d: 0x%02x' % (i, b), 'DB']])
397             self.ss_databytebits = []
398
399         elif bitnum > self.last_databit:
400             return self.decode_frame_end(can_rx, bitnum)
401
402         return False
403
404     def handle_bit(self, can_rx):
405         self.rawbits.append(can_rx)
406         self.bits.append(can_rx)
407
408         # Get the index of the current CAN frame bit (without stuff bits).
409         bitnum = len(self.bits) - 1
410
411         # If this is a stuff bit, remove it from self.bits and ignore it.
412         if self.is_stuff_bit():
413             self.putx([15, [str(can_rx)]])
414             self.curbit += 1 # Increase self.curbit (bitnum is not affected).
415             return
416         else:
417             self.putx([17, [str(can_rx)]])
418
419         # Bit 0: Start of frame (SOF) bit
420         if bitnum == 0:
421             self.putx([1, ['Start of frame', 'SOF', 'S']])
422             if can_rx != 0:
423                 self.putx([16, ['Start of frame (SOF) must be a dominant bit']])
424
425         # Remember start of ID (see below).
426         elif bitnum == 1:
427             self.ss_block = self.samplenum
428
429         # Bits 1-11: Identifier (ID[10..0])
430         # The bits ID[10..4] must NOT be all recessive.
431         elif bitnum == 11:
432             self.id = int(''.join(str(d) for d in self.bits[1:]), 2)
433             s = '%d (0x%x)' % (self.id, self.id),
434             self.putb([3, ['Identifier: %s' % s, 'ID: %s' % s, 'ID']])
435             if (self.id & 0x7f0) == 0x7f0:
436                 self.putb([16, ['Identifier bits 10..4 must not be all recessive']])
437
438         # RTR or SRR bit, depending on frame type (gets handled later).
439         elif bitnum == 12:
440             # self.putx([0, ['RTR/SRR: %d' % can_rx]]) # Debug only.
441             self.ss_bit12 = self.samplenum
442
443         # Bit 13: Identifier extension (IDE) bit
444         # Standard frame: dominant, extended frame: recessive
445         elif bitnum == 13:
446             ide = self.frame_type = 'standard' if can_rx == 0 else 'extended'
447             self.putx([6, ['Identifier extension bit: %s frame' % ide,
448                            'IDE: %s frame' % ide, 'IDE']])
449
450         # Bits 14-X: Frame-type dependent, passed to the resp. handlers.
451         elif bitnum >= 14:
452             if self.frame_type == 'standard':
453                 done = self.decode_standard_frame(can_rx, bitnum)
454             else:
455                 done = self.decode_extended_frame(can_rx, bitnum)
456
457             # The handlers return True if a frame ended (EOF).
458             if done:
459                 return
460
461         # After a frame there are 3 intermission bits (recessive).
462         # After these bits, the bus is considered free.
463
464         self.curbit += 1
465
466     def decode(self):
467         if not self.samplerate:
468             raise SamplerateError('Cannot decode without samplerate.')
469
470         while True:
471             # State machine.
472             if self.state == 'IDLE':
473                 # Wait for a dominant state (logic 0) on the bus.
474                 (can_rx,) = self.wait({0: 'l'})
475                 self.sof = self.samplenum
476                 self.dom_edge_seen(force = True)
477                 self.state = 'GET BITS'
478             elif self.state == 'GET BITS':
479                 # Wait until we're in the correct bit/sampling position.
480                 pos = self.get_sample_point(self.curbit)
481                 (can_rx,) = self.wait([{'skip': pos - self.samplenum}, {0: 'f'}])
482                 if self.matched[1]:
483                     self.dom_edge_seen()
484                 if self.matched[0]:
485                     self.handle_bit(can_rx)
486                     self.bit_sampled()