c92877b556db18a0de9c05ccce71fded631549af
[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 ##
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         ('bit', 'Bit'),
61     )
62     annotation_rows = (
63         ('bits', 'Bits', (15, 17)),
64         ('fields', 'Fields', tuple(range(15)) + (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
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
169         # Remember start of EOF (see below).
170         elif bitnum == (self.last_databit + 19):
171             self.ss_block = self.samplenum
172
173         # End of frame (EOF), 7 recessive bits
174         elif bitnum == (self.last_databit + 25):
175             self.putb([2, ['End of frame', 'EOF', 'E']])
176             self.reset_variables()
177             return True
178
179         return False
180
181     # Returns True if the frame ended (EOF), False otherwise.
182     def decode_standard_frame(self, can_rx, bitnum):
183
184         # Bit 14: RB0 (reserved bit)
185         # Has to be sent dominant, but receivers should accept recessive too.
186         if bitnum == 14:
187             self.putx([7, ['Reserved bit 0: %d' % can_rx,
188                            'RB0: %d' % can_rx, 'RB0']])
189
190             # Bit 12: Remote transmission request (RTR) bit
191             # Data frame: dominant, remote frame: recessive
192             # Remote frames do not contain a data field.
193             rtr = 'remote' if self.bits[12] == 1 else 'data'
194             self.put12([8, ['Remote transmission request: %s frame' % rtr,
195                             'RTR: %s frame' % rtr, 'RTR']])
196
197         # Remember start of DLC (see below).
198         elif bitnum == 15:
199             self.ss_block = self.samplenum
200
201         # Bits 15-18: Data length code (DLC), in number of bytes (0-8).
202         elif bitnum == 18:
203             self.dlc = int(''.join(str(d) for d in self.bits[15:18 + 1]), 2)
204             self.putb([10, ['Data length code: %d' % self.dlc,
205                             'DLC: %d' % self.dlc, 'DLC']])
206             self.last_databit = 18 + (self.dlc * 8)
207
208         # Remember all databyte bits, except the very last one.
209         elif bitnum in range(19, self.last_databit):
210             self.ss_databytebits.append(self.samplenum)
211
212         # Bits 19-X: Data field (0-8 bytes, depending on DLC)
213         # The bits within a data byte are transferred MSB-first.
214         elif bitnum == self.last_databit:
215             self.ss_databytebits.append(self.samplenum) # Last databyte bit.
216             for i in range(self.dlc):
217                 x = 18 + (8 * i) + 1
218                 b = int(''.join(str(d) for d in self.bits[x:x + 8]), 2)
219                 ss = self.ss_databytebits[i * 8]
220                 es = self.ss_databytebits[((i + 1) * 8) - 1]
221                 self.putg(ss, es, [0, ['Data byte %d: 0x%02x' % (i, b),
222                                        'DB %d: 0x%02x' % (i, b), 'DB']])
223             self.ss_databytebits = []
224
225         elif bitnum > self.last_databit:
226             return self.decode_frame_end(can_rx, bitnum)
227
228         return False
229
230     # Returns True if the frame ended (EOF), False otherwise.
231     def decode_extended_frame(self, can_rx, bitnum):
232
233         # Remember start of EID (see below).
234         if bitnum == 14:
235             self.ss_block = self.samplenum
236
237         # Bits 14-31: Extended identifier (EID[17..0])
238         elif bitnum == 31:
239             self.eid = int(''.join(str(d) for d in self.bits[14:]), 2)
240             s = '%d (0x%x)' % (self.eid, self.eid)
241             self.putb([4, ['Extended Identifier: %s' % s,
242                            'Extended ID: %s' % s, 'Extended ID', 'EID']])
243
244             self.fullid = self.id << 18 | self.eid
245             s = '%d (0x%x)' % (self.fullid, self.fullid)
246             self.putb([5, ['Full Identifier: %s' % s, 'Full ID: %s' % s,
247                            'Full ID', 'FID']])
248
249             # Bit 12: Substitute remote request (SRR) bit
250             self.put12([9, ['Substitute remote request: %d' % self.bits[12],
251                             'SRR: %d' % self.bits[12], 'SRR']])
252
253         # Bit 32: Remote transmission request (RTR) bit
254         # Data frame: dominant, remote frame: recessive
255         # Remote frames do not contain a data field.
256         if bitnum == 32:
257             rtr = 'remote' if can_rx == 1 else 'data'
258             self.putx([8, ['Remote transmission request: %s frame' % rtr,
259                            'RTR: %s frame' % rtr, 'RTR']])
260
261         # Bit 33: RB1 (reserved bit)
262         elif bitnum == 33:
263             self.putx([7, ['Reserved bit 1: %d' % can_rx,
264                            'RB1: %d' % can_rx, 'RB1']])
265
266         # Bit 34: RB0 (reserved bit)
267         elif bitnum == 34:
268             self.putx([7, ['Reserved bit 0: %d' % can_rx,
269                            'RB0: %d' % can_rx, 'RB0']])
270
271         # Remember start of DLC (see below).
272         elif bitnum == 35:
273             self.ss_block = self.samplenum
274
275         # Bits 35-38: Data length code (DLC), in number of bytes (0-8).
276         elif bitnum == 38:
277             self.dlc = int(''.join(str(d) for d in self.bits[35:38 + 1]), 2)
278             self.putb([10, ['Data length code: %d' % self.dlc,
279                             'DLC: %d' % self.dlc, 'DLC']])
280             self.last_databit = 38 + (self.dlc * 8)
281
282         # Remember all databyte bits, except the very last one.
283         elif bitnum in range(39, self.last_databit):
284             self.ss_databytebits.append(self.samplenum)
285
286         # Bits 39-X: Data field (0-8 bytes, depending on DLC)
287         # The bits within a data byte are transferred MSB-first.
288         elif bitnum == self.last_databit:
289             self.ss_databytebits.append(self.samplenum) # Last databyte bit.
290             for i in range(self.dlc):
291                 x = 38 + (8 * i) + 1
292                 b = int(''.join(str(d) for d in self.bits[x:x + 8]), 2)
293                 ss = self.ss_databytebits[i * 8]
294                 es = self.ss_databytebits[((i + 1) * 8) - 1]
295                 self.putg(ss, es, [0, ['Data byte %d: 0x%02x' % (i, b),
296                                        'DB %d: 0x%02x' % (i, b), 'DB']])
297             self.ss_databytebits = []
298
299         elif bitnum > self.last_databit:
300             return self.decode_frame_end(can_rx, bitnum)
301
302         return False
303
304     def handle_bit(self, can_rx):
305         self.rawbits.append(can_rx)
306         self.bits.append(can_rx)
307
308         # Get the index of the current CAN frame bit (without stuff bits).
309         bitnum = len(self.bits) - 1
310
311         # If this is a stuff bit, remove it from self.bits and ignore it.
312         if self.is_stuff_bit():
313             self.putx([15, [str(can_rx)]])
314             self.curbit += 1 # Increase self.curbit (bitnum is not affected).
315             return
316         else:
317             self.putx([17, [str(can_rx)]])
318
319         # Bit 0: Start of frame (SOF) bit
320         if bitnum == 0:
321             if can_rx == 0:
322                 self.putx([1, ['Start of frame', 'SOF', 'S']])
323             else:
324                 self.putx([16, ['Start of frame (SOF) must be a dominant bit']])
325
326         # Remember start of ID (see below).
327         elif bitnum == 1:
328             self.ss_block = self.samplenum
329
330         # Bits 1-11: Identifier (ID[10..0])
331         # The bits ID[10..4] must NOT be all recessive.
332         elif bitnum == 11:
333             self.id = int(''.join(str(d) for d in self.bits[1:]), 2)
334             s = '%d (0x%x)' % (self.id, self.id),
335             self.putb([3, ['Identifier: %s' % s, 'ID: %s' % s, 'ID']])
336
337         # RTR or SRR bit, depending on frame type (gets handled later).
338         elif bitnum == 12:
339             # self.putx([0, ['RTR/SRR: %d' % can_rx]]) # Debug only.
340             self.ss_bit12 = self.samplenum
341
342         # Bit 13: Identifier extension (IDE) bit
343         # Standard frame: dominant, extended frame: recessive
344         elif bitnum == 13:
345             ide = self.frame_type = 'standard' if can_rx == 0 else 'extended'
346             self.putx([6, ['Identifier extension bit: %s frame' % ide,
347                            'IDE: %s frame' % ide, 'IDE']])
348
349         # Bits 14-X: Frame-type dependent, passed to the resp. handlers.
350         elif bitnum >= 14:
351             if self.frame_type == 'standard':
352                 done = self.decode_standard_frame(can_rx, bitnum)
353             else:
354                 done = self.decode_extended_frame(can_rx, bitnum)
355
356             # The handlers return True if a frame ended (EOF).
357             if done:
358                 return
359
360         # After a frame there are 3 intermission bits (recessive).
361         # After these bits, the bus is considered free.
362
363         self.curbit += 1
364
365     def decode(self, ss, es, data):
366         if not self.samplerate:
367             raise SamplerateError('Cannot decode without samplerate.')
368         for (self.samplenum, pins) in data:
369
370             (can_rx,) = pins
371
372             # State machine.
373             if self.state == 'IDLE':
374                 # Wait for a dominant state (logic 0) on the bus.
375                 if can_rx == 1:
376                     continue
377                 self.sof = self.samplenum
378                 self.state = 'GET BITS'
379             elif self.state == 'GET BITS':
380                 # Wait until we're in the correct bit/sampling position.
381                 if not self.reached_bit(self.curbit):
382                     continue
383                 self.handle_bit(can_rx)