]>
Commit | Line | Data |
---|---|---|
702fa251 | 1 | ## |
50bd5d25 | 2 | ## This file is part of the libsigrokdecode project. |
702fa251 | 3 | ## |
e20f455c | 4 | ## Copyright (C) 2012-2013 Uwe Hermann <uwe@hermann-uwe.de> |
38b40330 | 5 | ## Copyright (C) 2019 Stephan Thiele <stephan.thiele@mailbox.org> |
702fa251 UH |
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 | |
4539e9ca | 18 | ## along with this program; if not, see <http://www.gnu.org/licenses/>. |
702fa251 | 19 | ## |
702fa251 UH |
20 | |
21 | import sigrokdecode as srd | |
22 | ||
21cda951 UH |
23 | class SamplerateError(Exception): |
24 | pass | |
25 | ||
702fa251 | 26 | class Decoder(srd.Decoder): |
64d87119 | 27 | api_version = 3 |
702fa251 UH |
28 | id = 'can' |
29 | name = 'CAN' | |
9e1437a0 | 30 | longname = 'Controller Area Network' |
702fa251 UH |
31 | desc = 'Field bus protocol for distributed realtime control.' |
32 | license = 'gplv2+' | |
33 | inputs = ['logic'] | |
6cbba91f | 34 | outputs = [] |
d6d8a8a4 | 35 | tags = ['Automotive'] |
6a15597a | 36 | channels = ( |
702fa251 | 37 | {'id': 'can_rx', 'name': 'CAN RX', 'desc': 'CAN bus line'}, |
da9bcbd9 | 38 | ) |
84c1c0b5 | 39 | options = ( |
2d9e1115 ST |
40 | {'id': 'nominal_bitrate', 'desc': 'Nominal Bitrate (bits/s)', 'default': 1000000}, |
41 | {'id': 'fast_bitrate', 'desc': 'Fast Bitrate (bits/s)', 'default': 2000000}, | |
b0918d40 | 42 | {'id': 'sample_point', 'desc': 'Sample point (%)', 'default': 70.0}, |
84c1c0b5 | 43 | ) |
da9bcbd9 BV |
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'), | |
544038d9 | 62 | ('bit', 'Bit'), |
d4a28d0f UH |
63 | ) |
64 | annotation_rows = ( | |
544038d9 | 65 | ('bits', 'Bits', (15, 17)), |
2fac4493 UH |
66 | ('fields', 'Fields', tuple(range(15))), |
67 | ('warnings', 'Warnings', (16,)), | |
da9bcbd9 | 68 | ) |
702fa251 | 69 | |
92b7b49f | 70 | def __init__(self): |
10aeb8ea GS |
71 | self.reset() |
72 | ||
0102e92b ST |
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 | ||
10aeb8ea | 76 | def reset(self): |
f372d597 | 77 | self.samplerate = None |
702fa251 UH |
78 | self.reset_variables() |
79 | ||
f372d597 | 80 | def start(self): |
be465111 | 81 | self.out_ann = self.register(srd.OUTPUT_ANN) |
702fa251 | 82 | |
f372d597 BV |
83 | def metadata(self, key, value): |
84 | if key == srd.SRD_CONF_SAMPLERATE: | |
85 | self.samplerate = value | |
2d9e1115 | 86 | self.bit_width = float(self.samplerate) / float(self.options['nominal_bitrate']) |
300f9194 | 87 | self.sample_point = (self.bit_width / 100.0) * self.options['sample_point'] |
702fa251 | 88 | |
4b1813b4 UH |
89 | # Generic helper for CAN bit annotations. |
90 | def putg(self, ss, es, data): | |
300f9194 | 91 | left, right = int(self.sample_point), int(self.bit_width - self.sample_point) |
4b1813b4 UH |
92 | self.put(ss - left, es + right, self.out_ann, data) |
93 | ||
94 | # Single-CAN-bit annotation using the current samplenum. | |
e20f455c | 95 | def putx(self, data): |
4b1813b4 UH |
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 | ||
6c890c08 | 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 | ||
4b1813b4 UH |
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) | |
e20f455c | 109 | |
702fa251 UH |
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 | |
4b1813b4 UH |
117 | self.ss_block = None |
118 | self.ss_bit12 = None | |
6c890c08 | 119 | self.ss_bit32 = None |
4b1813b4 | 120 | self.ss_databytebits = [] |
6c890c08 | 121 | self.fd = False |
122 | self.rtr = None | |
702fa251 | 123 | |
45a50880 GS |
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 | ||
64d87119 GS |
137 | # Determine the position of the next desired bit's sample point. |
138 | def get_sample_point(self, bitnum): | |
45a50880 GS |
139 | samplenum = self.dom_edge_snum |
140 | samplenum += int(self.bit_width * (bitnum - self.dom_edge_bcount)) | |
141 | samplenum += int(self.sample_point) | |
300f9194 | 142 | return samplenum |
702fa251 UH |
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. | |
a0128522 | 147 | # But not in the CRC delimiter, ACK, and end of frame fields. |
cffb6592 | 148 | if len(self.bits) > self.last_databit + 17: |
a0128522 | 149 | return False |
702fa251 UH |
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. | |
702fa251 UH |
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 | ||
4b1813b4 UH |
172 | # Remember start of CRC sequence (see below). |
173 | if bitnum == (self.last_databit + 1): | |
174 | self.ss_block = self.samplenum | |
175 | ||
741dba78 | 176 | if self.fd: |
fd41596a | 177 | if self.dlc2len(self.dlc) < 16: |
741dba78 ST |
178 | self.crc_len = 27 # 17 + SBC + stuff bits |
179 | else: | |
fd41596a | 180 | self.crc_len = 32 # 21 + SBC + stuff bits |
741dba78 ST |
181 | else: |
182 | self.crc_len = 15 | |
183 | ||
184 | # CRC sequence (15 bits, 17 bits or 21 bits) | |
185 | elif bitnum == (self.last_databit + self.crc_len): | |
186 | if self.fd: | |
fd41596a | 187 | if self.dlc2len(self.dlc) < 16: |
741dba78 ST |
188 | crc_type = "CRC-17" |
189 | else: | |
190 | crc_type = "CRC-21" | |
191 | else: | |
b177af15 | 192 | crc_type = "CRC" # TODO: CRC-15 (will break existing tests) |
741dba78 | 193 | |
702fa251 | 194 | x = self.last_databit + 1 |
741dba78 | 195 | crc_bits = self.bits[x:x + self.crc_len + 1] |
702fa251 | 196 | self.crc = int(''.join(str(d) for d in crc_bits), 2) |
741dba78 ST |
197 | self.putb([11, ['%s sequence: 0x%04x' % (crc_type, self.crc), |
198 | '%s: 0x%04x' % (crc_type, self.crc), '%s' % crc_type]]) | |
702fa251 | 199 | if not self.is_valid_crc(crc_bits): |
74c9bb3c | 200 | self.putb([16, ['CRC is invalid']]) |
702fa251 UH |
201 | |
202 | # CRC delimiter bit (recessive) | |
741dba78 | 203 | elif bitnum == (self.last_databit + self.crc_len + 1): |
74c9bb3c UH |
204 | self.putx([12, ['CRC delimiter: %d' % can_rx, |
205 | 'CRC d: %d' % can_rx, 'CRC d']]) | |
2fac4493 UH |
206 | if can_rx != 1: |
207 | self.putx([16, ['CRC delimiter must be a recessive bit']]) | |
702fa251 UH |
208 | |
209 | # ACK slot bit (dominant: ACK, recessive: NACK) | |
741dba78 | 210 | elif bitnum == (self.last_databit + self.crc_len + 2): |
702fa251 | 211 | ack = 'ACK' if can_rx == 0 else 'NACK' |
74c9bb3c | 212 | self.putx([13, ['ACK slot: %s' % ack, 'ACK s: %s' % ack, 'ACK s']]) |
702fa251 UH |
213 | |
214 | # ACK delimiter bit (recessive) | |
741dba78 | 215 | elif bitnum == (self.last_databit + self.crc_len + 3): |
74c9bb3c UH |
216 | self.putx([14, ['ACK delimiter: %d' % can_rx, |
217 | 'ACK d: %d' % can_rx, 'ACK d']]) | |
2fac4493 UH |
218 | if can_rx != 1: |
219 | self.putx([16, ['ACK delimiter must be a recessive bit']]) | |
702fa251 | 220 | |
4b1813b4 | 221 | # Remember start of EOF (see below). |
741dba78 | 222 | elif bitnum == (self.last_databit + self.crc_len + 4): |
4b1813b4 UH |
223 | self.ss_block = self.samplenum |
224 | ||
702fa251 | 225 | # End of frame (EOF), 7 recessive bits |
b177af15 | 226 | elif bitnum == (self.last_databit + self.crc_len + 10): |
74c9bb3c | 227 | self.putb([2, ['End of frame', 'EOF', 'E']]) |
2fac4493 UH |
228 | if self.rawbits[-7:] != [1, 1, 1, 1, 1, 1, 1]: |
229 | self.putb([16, ['End of frame (EOF) must be 7 recessive bits']]) | |
702fa251 UH |
230 | self.reset_variables() |
231 | return True | |
232 | ||
233 | return False | |
234 | ||
235 | # Returns True if the frame ended (EOF), False otherwise. | |
236 | def decode_standard_frame(self, can_rx, bitnum): | |
237 | ||
38b40330 ST |
238 | # Bit 14: FDF (Flexible Data Format) |
239 | # Has to be sent dominant when FD frame, has to be sent recessive when classic CAN frame. | |
702fa251 | 240 | if bitnum == 14: |
38b40330 ST |
241 | self.fd = True if can_rx else False |
242 | ||
b177af15 ST |
243 | if self.fd: |
244 | self.putx([7, ['Flexible Data Format: %d' % can_rx, | |
245 | 'FDF: %d' % can_rx, | |
246 | 'FDF']]) | |
247 | else: | |
248 | self.putx([7, ['Reserved bit 0: %d' % can_rx, | |
249 | 'RB0: %d' % can_rx, | |
250 | 'RB0']]) | |
38b40330 ST |
251 | |
252 | # SRR Substitute Remote Request | |
253 | if self.fd: | |
254 | self.put12([8, ['Substitute Remote Request', 'SRR']]) | |
7f75d507 | 255 | self.dlc_start = 18 |
38b40330 ST |
256 | else: |
257 | # Bit 12: Remote transmission request (RTR) bit | |
258 | # Data frame: dominant, remote frame: recessive | |
259 | # Remote frames do not contain a data field. | |
260 | rtr = 'remote' if self.bits[12] == 1 else 'data' | |
261 | self.put12([8, ['Remote transmission request: %s frame' % rtr, | |
262 | 'RTR: %s frame' % rtr, 'RTR']]) | |
7f75d507 | 263 | self.dlc_start = 15 |
38b40330 | 264 | |
7f75d507 ST |
265 | if bitnum == 15: |
266 | if self.fd: | |
267 | self.putx([7, ['Reserved: %d' % can_rx, 'R0: %d' % can_rx, 'R0']]) | |
268 | ||
269 | if bitnum == 16: | |
270 | if self.fd: | |
271 | self.putx([7, ['Bit rate switch: %d' % can_rx, 'BRS: %d' % can_rx, 'BRS']]) | |
702fa251 | 272 | |
7f75d507 ST |
273 | if bitnum == 17: |
274 | if self.fd: | |
275 | self.putx([7, ['Error state indicator: %d' % can_rx, 'ESI: %d' % can_rx, 'ESI']]) | |
4b1813b4 UH |
276 | |
277 | # Remember start of DLC (see below). | |
7f75d507 | 278 | elif bitnum == self.dlc_start: |
4b1813b4 | 279 | self.ss_block = self.samplenum |
702fa251 UH |
280 | |
281 | # Bits 15-18: Data length code (DLC), in number of bytes (0-8). | |
7f75d507 ST |
282 | elif bitnum == self.dlc_start + 3: |
283 | self.dlc = int(''.join(str(d) for d in self.bits[self.dlc_start:self.dlc_start + 4]), 2) | |
b177af15 ST |
284 | self.putb([10, ['Data length code: %d' % self.dlc, |
285 | 'DLC: %d' % self.dlc, 'DLC']]) | |
fd41596a | 286 | self.last_databit = self.dlc_start + 3 + (self.dlc2len(self.dlc) * 8) |
b177af15 ST |
287 | if self.dlc > 8 and not self.fd: |
288 | self.putb([16, ['Data length code (DLC) > 8 is not allowed']]) | |
702fa251 | 289 | |
4b1813b4 | 290 | # Remember all databyte bits, except the very last one. |
7f75d507 | 291 | elif bitnum in range(self.dlc_start + 4, self.last_databit): |
4b1813b4 UH |
292 | self.ss_databytebits.append(self.samplenum) |
293 | ||
702fa251 UH |
294 | # Bits 19-X: Data field (0-8 bytes, depending on DLC) |
295 | # The bits within a data byte are transferred MSB-first. | |
296 | elif bitnum == self.last_databit: | |
4b1813b4 | 297 | self.ss_databytebits.append(self.samplenum) # Last databyte bit. |
fd41596a | 298 | for i in range(self.dlc2len(self.dlc)): |
7f75d507 | 299 | x = self.dlc_start + 4 + (8 * i) |
702fa251 | 300 | b = int(''.join(str(d) for d in self.bits[x:x + 8]), 2) |
4b1813b4 UH |
301 | ss = self.ss_databytebits[i * 8] |
302 | es = self.ss_databytebits[((i + 1) * 8) - 1] | |
534ae912 UH |
303 | self.putg(ss, es, [0, ['Data byte %d: 0x%02x' % (i, b), |
304 | 'DB %d: 0x%02x' % (i, b), 'DB']]) | |
4b1813b4 | 305 | self.ss_databytebits = [] |
702fa251 UH |
306 | |
307 | elif bitnum > self.last_databit: | |
308 | return self.decode_frame_end(can_rx, bitnum) | |
309 | ||
310 | return False | |
311 | ||
312 | # Returns True if the frame ended (EOF), False otherwise. | |
313 | def decode_extended_frame(self, can_rx, bitnum): | |
314 | ||
4b1813b4 UH |
315 | # Remember start of EID (see below). |
316 | if bitnum == 14: | |
317 | self.ss_block = self.samplenum | |
655f8b16 | 318 | self.fd = False |
319 | self.dlc_start = 35 | |
4b1813b4 | 320 | |
702fa251 | 321 | # Bits 14-31: Extended identifier (EID[17..0]) |
4b1813b4 | 322 | elif bitnum == 31: |
702fa251 | 323 | self.eid = int(''.join(str(d) for d in self.bits[14:]), 2) |
534ae912 | 324 | s = '%d (0x%x)' % (self.eid, self.eid) |
74c9bb3c | 325 | self.putb([4, ['Extended Identifier: %s' % s, |
534ae912 | 326 | 'Extended ID: %s' % s, 'Extended ID', 'EID']]) |
702fa251 UH |
327 | |
328 | self.fullid = self.id << 18 | self.eid | |
534ae912 | 329 | s = '%d (0x%x)' % (self.fullid, self.fullid) |
74c9bb3c | 330 | self.putb([5, ['Full Identifier: %s' % s, 'Full ID: %s' % s, |
534ae912 | 331 | 'Full ID', 'FID']]) |
702fa251 UH |
332 | |
333 | # Bit 12: Substitute remote request (SRR) bit | |
74c9bb3c | 334 | self.put12([9, ['Substitute remote request: %d' % self.bits[12], |
534ae912 | 335 | 'SRR: %d' % self.bits[12], 'SRR']]) |
702fa251 UH |
336 | |
337 | # Bit 32: Remote transmission request (RTR) bit | |
338 | # Data frame: dominant, remote frame: recessive | |
339 | # Remote frames do not contain a data field. | |
655f8b16 | 340 | |
341 | # Remember start of RTR (see below). | |
702fa251 | 342 | if bitnum == 32: |
6c890c08 | 343 | self.ss_bit32 = self.samplenum |
344 | self.rtr = can_rx | |
702fa251 | 345 | |
6c890c08 | 346 | if not self.fd: |
347 | rtr = 'remote' if can_rx == 1 else 'data' | |
348 | self.putx([8, ['Remote transmission request: %s frame' % rtr, | |
349 | 'RTR: %s frame' % rtr, 'RTR']]) | |
655f8b16 | 350 | |
702fa251 UH |
351 | # Bit 33: RB1 (reserved bit) |
352 | elif bitnum == 33: | |
655f8b16 | 353 | self.fd = True if can_rx else False |
354 | ||
355 | if self.fd: | |
356 | self.dlc_start = 37 | |
357 | self.putx([7, ['Flexible Data Format: %d' % can_rx, | |
358 | 'FDF: %d' % can_rx, 'FDF']]) | |
6c890c08 | 359 | |
360 | self.put32([7, ['Reserved bit 1: %d' % self.rtr, | |
361 | 'RB1: %d' % self.rtr, 'RB1']]) | |
655f8b16 | 362 | else: |
363 | self.putx([7, ['Reserved bit 1: %d' % can_rx, | |
364 | 'RB1: %d' % can_rx, 'RB1']]) | |
702fa251 UH |
365 | |
366 | # Bit 34: RB0 (reserved bit) | |
367 | elif bitnum == 34: | |
74c9bb3c | 368 | self.putx([7, ['Reserved bit 0: %d' % can_rx, |
534ae912 | 369 | 'RB0: %d' % can_rx, 'RB0']]) |
702fa251 | 370 | |
655f8b16 | 371 | elif bitnum == 35 and self.fd: |
372 | self.putx([7, ['Bit rate switch: %d' % can_rx, | |
373 | 'BRS: %d' % can_rx, 'BRS']]) | |
374 | ||
375 | elif bitnum == 36 and self.fd: | |
376 | self.putx([7, ['Error state indicator: %d' % can_rx, | |
377 | 'ESI: %d' % can_rx, 'ESI']]) | |
378 | ||
4b1813b4 | 379 | # Remember start of DLC (see below). |
655f8b16 | 380 | elif bitnum == self.dlc_start: |
4b1813b4 UH |
381 | self.ss_block = self.samplenum |
382 | ||
702fa251 | 383 | # Bits 35-38: Data length code (DLC), in number of bytes (0-8). |
655f8b16 | 384 | elif bitnum == self.dlc_start + 3: |
385 | self.dlc = int(''.join(str(d) for d in self.bits[self.dlc_start:self.dlc_start + 4]), 2) | |
b177af15 ST |
386 | self.putb([10, ['Data length code: %d' % self.dlc, |
387 | 'DLC: %d' % self.dlc, 'DLC']]) | |
655f8b16 | 388 | self.last_databit = self.dlc_start + 3 + (self.dlc2len(self.dlc) * 8) |
702fa251 | 389 | |
4b1813b4 | 390 | # Remember all databyte bits, except the very last one. |
655f8b16 | 391 | elif bitnum in range(self.dlc_start + 4, self.last_databit): |
4b1813b4 UH |
392 | self.ss_databytebits.append(self.samplenum) |
393 | ||
702fa251 UH |
394 | # Bits 39-X: Data field (0-8 bytes, depending on DLC) |
395 | # The bits within a data byte are transferred MSB-first. | |
396 | elif bitnum == self.last_databit: | |
4b1813b4 | 397 | self.ss_databytebits.append(self.samplenum) # Last databyte bit. |
fd41596a | 398 | for i in range(self.dlc2len(self.dlc)): |
655f8b16 | 399 | x = self.dlc_start + 4 + (8 * i) |
702fa251 | 400 | b = int(''.join(str(d) for d in self.bits[x:x + 8]), 2) |
4b1813b4 UH |
401 | ss = self.ss_databytebits[i * 8] |
402 | es = self.ss_databytebits[((i + 1) * 8) - 1] | |
534ae912 UH |
403 | self.putg(ss, es, [0, ['Data byte %d: 0x%02x' % (i, b), |
404 | 'DB %d: 0x%02x' % (i, b), 'DB']]) | |
4b1813b4 | 405 | self.ss_databytebits = [] |
702fa251 UH |
406 | |
407 | elif bitnum > self.last_databit: | |
408 | return self.decode_frame_end(can_rx, bitnum) | |
409 | ||
410 | return False | |
411 | ||
412 | def handle_bit(self, can_rx): | |
413 | self.rawbits.append(can_rx) | |
414 | self.bits.append(can_rx) | |
415 | ||
416 | # Get the index of the current CAN frame bit (without stuff bits). | |
417 | bitnum = len(self.bits) - 1 | |
418 | ||
702fa251 UH |
419 | # If this is a stuff bit, remove it from self.bits and ignore it. |
420 | if self.is_stuff_bit(): | |
544038d9 | 421 | self.putx([15, [str(can_rx)]]) |
702fa251 UH |
422 | self.curbit += 1 # Increase self.curbit (bitnum is not affected). |
423 | return | |
544038d9 UH |
424 | else: |
425 | self.putx([17, [str(can_rx)]]) | |
702fa251 UH |
426 | |
427 | # Bit 0: Start of frame (SOF) bit | |
428 | if bitnum == 0: | |
2fac4493 UH |
429 | self.putx([1, ['Start of frame', 'SOF', 'S']]) |
430 | if can_rx != 0: | |
74c9bb3c | 431 | self.putx([16, ['Start of frame (SOF) must be a dominant bit']]) |
702fa251 | 432 | |
4b1813b4 UH |
433 | # Remember start of ID (see below). |
434 | elif bitnum == 1: | |
435 | self.ss_block = self.samplenum | |
436 | ||
702fa251 UH |
437 | # Bits 1-11: Identifier (ID[10..0]) |
438 | # The bits ID[10..4] must NOT be all recessive. | |
439 | elif bitnum == 11: | |
440 | self.id = int(''.join(str(d) for d in self.bits[1:]), 2) | |
534ae912 | 441 | s = '%d (0x%x)' % (self.id, self.id), |
74c9bb3c | 442 | self.putb([3, ['Identifier: %s' % s, 'ID: %s' % s, 'ID']]) |
2fac4493 UH |
443 | if (self.id & 0x7f0) == 0x7f0: |
444 | self.putb([16, ['Identifier bits 10..4 must not be all recessive']]) | |
702fa251 UH |
445 | |
446 | # RTR or SRR bit, depending on frame type (gets handled later). | |
447 | elif bitnum == 12: | |
4b1813b4 UH |
448 | # self.putx([0, ['RTR/SRR: %d' % can_rx]]) # Debug only. |
449 | self.ss_bit12 = self.samplenum | |
702fa251 UH |
450 | |
451 | # Bit 13: Identifier extension (IDE) bit | |
452 | # Standard frame: dominant, extended frame: recessive | |
453 | elif bitnum == 13: | |
454 | ide = self.frame_type = 'standard' if can_rx == 0 else 'extended' | |
74c9bb3c | 455 | self.putx([6, ['Identifier extension bit: %s frame' % ide, |
534ae912 | 456 | 'IDE: %s frame' % ide, 'IDE']]) |
702fa251 UH |
457 | |
458 | # Bits 14-X: Frame-type dependent, passed to the resp. handlers. | |
459 | elif bitnum >= 14: | |
460 | if self.frame_type == 'standard': | |
461 | done = self.decode_standard_frame(can_rx, bitnum) | |
462 | else: | |
463 | done = self.decode_extended_frame(can_rx, bitnum) | |
464 | ||
465 | # The handlers return True if a frame ended (EOF). | |
466 | if done: | |
467 | return | |
468 | ||
469 | # After a frame there are 3 intermission bits (recessive). | |
470 | # After these bits, the bus is considered free. | |
471 | ||
472 | self.curbit += 1 | |
473 | ||
64d87119 | 474 | def decode(self): |
21cda951 UH |
475 | if not self.samplerate: |
476 | raise SamplerateError('Cannot decode without samplerate.') | |
702fa251 | 477 | |
64d87119 | 478 | while True: |
702fa251 UH |
479 | # State machine. |
480 | if self.state == 'IDLE': | |
481 | # Wait for a dominant state (logic 0) on the bus. | |
64d87119 | 482 | (can_rx,) = self.wait({0: 'l'}) |
702fa251 | 483 | self.sof = self.samplenum |
45a50880 | 484 | self.dom_edge_seen(force = True) |
702fa251 UH |
485 | self.state = 'GET BITS' |
486 | elif self.state == 'GET BITS': | |
487 | # Wait until we're in the correct bit/sampling position. | |
64d87119 | 488 | pos = self.get_sample_point(self.curbit) |
45a50880 GS |
489 | (can_rx,) = self.wait([{'skip': pos - self.samplenum}, {0: 'f'}]) |
490 | if self.matched[1]: | |
491 | self.dom_edge_seen() | |
492 | if self.matched[0]: | |
493 | self.handle_bit(can_rx) | |
494 | self.bit_sampled() |