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