can: Factor out dlc2len().
[libsigrokdecode.git] / decoders / sdcard_spi / pd.py
1 ##
2 ## This file is part of the libsigrokdecode project.
3 ##
4 ## Copyright (C) 2012-2014 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 from common.sdcard import (cmd_names, acmd_names)
22
23 class Decoder(srd.Decoder):
24     api_version = 3
25     id = 'sdcard_spi'
26     name = 'SD card (SPI mode)'
27     longname = 'Secure Digital card (SPI mode)'
28     desc = 'Secure Digital card (SPI mode) low-level protocol.'
29     license = 'gplv2+'
30     inputs = ['spi']
31     outputs = []
32     tags = ['Memory']
33     annotations = \
34         tuple(('cmd%d' % i, 'CMD%d' % i) for i in range(64)) + \
35         tuple(('acmd%d' % i, 'ACMD%d' % i) for i in range(64)) + ( \
36         ('r1', 'R1 reply'),
37         ('r1b', 'R1B reply'),
38         ('r2', 'R2 reply'),
39         ('r3', 'R3 reply'),
40         ('r7', 'R7 reply'),
41         ('bits', 'Bits'),
42         ('bit-warnings', 'Bit warnings'),
43     )
44     annotation_rows = (
45         ('bits', 'Bits', (133, 134)),
46         ('cmd-reply', 'Commands/replies', tuple(range(133))),
47     )
48
49     def __init__(self):
50         self.reset()
51
52     def reset(self):
53         self.state = 'IDLE'
54         self.ss, self.es = 0, 0
55         self.ss_bit, self.es_bit = 0, 0
56         self.ss_cmd, self.es_cmd = 0, 0
57         self.cmd_token = []
58         self.cmd_token_bits = []
59         self.is_acmd = False # Indicates CMD vs. ACMD
60         self.blocklen = 0
61         self.read_buf = []
62         self.cmd_str = ''
63         self.is_cmd24 = False
64         self.cmd24_start_token_found = False
65
66     def start(self):
67         self.out_ann = self.register(srd.OUTPUT_ANN)
68
69     def putx(self, data):
70         self.put(self.ss_cmd, self.es_cmd, self.out_ann, data)
71
72     def putc(self, cmd, desc):
73         self.putx([cmd, ['%s: %s' % (self.cmd_str, desc)]])
74
75     def putb(self, data):
76         self.put(self.ss_bit, self.es_bit, self.out_ann, data)
77
78     def cmd_name(self, cmd):
79         c = acmd_names if self.is_acmd else cmd_names
80         s = c.get(cmd, 'Unknown')
81         # SD mode names for CMD32/33: ERASE_WR_BLK_{START,END}.
82         # SPI mode names for CMD32/33: ERASE_WR_BLK_{START,END}_ADDR.
83         if cmd in (32, 33):
84             s += '_ADDR'
85         return s
86
87     def handle_command_token(self, mosi, miso):
88         # Command tokens (6 bytes) are sent (MSB-first) by the host.
89         #
90         # Format:
91         #  - CMD[47:47]: Start bit (always 0)
92         #  - CMD[46:46]: Transmitter bit (1 == host)
93         #  - CMD[45:40]: Command index (BCD; valid: 0-63)
94         #  - CMD[39:08]: Argument
95         #  - CMD[07:01]: CRC7
96         #  - CMD[00:00]: End bit (always 1)
97
98         if len(self.cmd_token) == 0:
99             self.ss_cmd = self.ss
100
101         self.cmd_token.append(mosi)
102         self.cmd_token_bits.append(self.mosi_bits)
103
104         # All command tokens are 6 bytes long.
105         if len(self.cmd_token) < 6:
106             return
107
108         self.es_cmd = self.es
109
110         t = self.cmd_token
111
112         # CMD or ACMD?
113         s = 'ACMD' if self.is_acmd else 'CMD'
114
115         def tb(byte, bit):
116             return self.cmd_token_bits[5 - byte][bit]
117
118         # Bits[47:47]: Start bit (always 0)
119         bit, self.ss_bit, self.es_bit = tb(5, 7)[0], tb(5, 7)[1], tb(5, 7)[2]
120         if bit == 0:
121             self.putb([134, ['Start bit: %d' % bit]])
122         else:
123             self.putb([135, ['Start bit: %s (Warning: Must be 0!)' % bit]])
124
125         # Bits[46:46]: Transmitter bit (1 == host)
126         bit, self.ss_bit, self.es_bit = tb(5, 6)[0], tb(5, 6)[1], tb(5, 6)[2]
127         if bit == 1:
128             self.putb([134, ['Transmitter bit: %d' % bit]])
129         else:
130             self.putb([135, ['Transmitter bit: %d (Warning: Must be 1!)' % bit]])
131
132         # Bits[45:40]: Command index (BCD; valid: 0-63)
133         cmd = self.cmd_index = t[0] & 0x3f
134         self.ss_bit, self.es_bit = tb(5, 5)[1], tb(5, 0)[2]
135         self.putb([134, ['Command: %s%d (%s)' % (s, cmd, self.cmd_name(cmd))]])
136
137         # Bits[39:8]: Argument
138         self.arg = (t[1] << 24) | (t[2] << 16) | (t[3] << 8) | t[4]
139         self.ss_bit, self.es_bit = tb(4, 7)[1], tb(1, 0)[2]
140         self.putb([134, ['Argument: 0x%04x' % self.arg]])
141
142         # Bits[7:1]: CRC7
143         # TODO: Check CRC7.
144         crc = t[5] >> 1
145         self.ss_bit, self.es_bit = tb(0, 7)[1], tb(0, 1)[2]
146         self.putb([134, ['CRC7: 0x%01x' % crc]])
147
148         # Bits[0:0]: End bit (always 1)
149         bit, self.ss_bit, self.es_bit = tb(0, 0)[0], tb(0, 0)[1], tb(0, 0)[2]
150         if bit == 1:
151             self.putb([134, ['End bit: %d' % bit]])
152         else:
153             self.putb([135, ['End bit: %d (Warning: Must be 1!)' % bit]])
154
155         # Handle command.
156         if cmd in (0, 1, 9, 16, 17, 24, 41, 49, 55, 59):
157             self.state = 'HANDLE CMD%d' % cmd
158             self.cmd_str = '%s%d (%s)' % (s, cmd, self.cmd_name(cmd))
159         else:
160             self.state = 'HANDLE CMD999'
161             a = '%s%d: %02x %02x %02x %02x %02x %02x' % ((s, cmd) + tuple(t))
162             self.putx([cmd, [a]])
163
164     def handle_cmd0(self):
165         # CMD0: GO_IDLE_STATE
166         self.putc(0, 'Reset the SD card')
167         self.state = 'GET RESPONSE R1'
168
169     def handle_cmd1(self):
170         # CMD1: SEND_OP_COND
171         self.putc(1, 'Send HCS info and activate the card init process')
172         hcs = (self.arg & (1 << 30)) >> 30
173         self.ss_bit = self.cmd_token_bits[5 - 4][6][1]
174         self.es_bit = self.cmd_token_bits[5 - 4][6][2]
175         self.putb([134, ['HCS: %d' % hcs]])
176         self.state = 'GET RESPONSE R1'
177
178     def handle_cmd9(self):
179         # CMD9: SEND_CSD (128 bits / 16 bytes)
180         self.putc(9, 'Ask card to send its card specific data (CSD)')
181         if len(self.read_buf) == 0:
182             self.ss_cmd = self.ss
183         self.read_buf.append(self.miso)
184         # FIXME
185         ### if len(self.read_buf) < 16:
186         if len(self.read_buf) < 16 + 4:
187             return
188         self.es_cmd = self.es
189         self.read_buf = self.read_buf[4:] # TODO: Document or redo.
190         self.putx([9, ['CSD: %s' % self.read_buf]])
191         # TODO: Decode all bits.
192         self.read_buf = []
193         ### self.state = 'GET RESPONSE R1'
194         self.state = 'IDLE'
195
196     def handle_cmd10(self):
197         # CMD10: SEND_CID (128 bits / 16 bytes)
198         self.putc(10, 'Ask card to send its card identification (CID)')
199         self.read_buf.append(self.miso)
200         if len(self.read_buf) < 16:
201             return
202         self.putx([10, ['CID: %s' % self.read_buf]])
203         # TODO: Decode all bits.
204         self.read_buf = []
205         self.state = 'GET RESPONSE R1'
206
207     def handle_cmd16(self):
208         # CMD16: SET_BLOCKLEN
209         self.blocklen = self.arg
210         # TODO: Sanity check on block length.
211         self.putc(16, 'Set the block length to %d bytes' % self.blocklen)
212         self.state = 'GET RESPONSE R1'
213
214     def handle_cmd17(self):
215         # CMD17: READ_SINGLE_BLOCK
216         self.putc(17, 'Read a block from address 0x%04x' % self.arg)
217         if len(self.read_buf) == 0:
218             self.ss_cmd = self.ss
219         self.read_buf.append(self.miso)
220         if len(self.read_buf) < self.blocklen + 2: # FIXME
221             return
222         self.es_cmd = self.es
223         self.read_buf = self.read_buf[2:] # FIXME
224         self.putx([17, ['Block data: %s' % self.read_buf]])
225         self.read_buf = []
226         self.state = 'GET RESPONSE R1'
227
228     def handle_cmd24(self):
229         # CMD24: WRITE_BLOCK
230         self.putc(24, 'Write a block to address 0x%04x' % self.arg)
231         self.is_cmd24 = True
232         self.state = 'GET RESPONSE R1'
233
234     def handle_cmd49(self):
235         self.state = 'GET RESPONSE R1'
236
237     def handle_cmd55(self):
238         # CMD55: APP_CMD
239         self.putc(55, 'Next command is an application-specific command')
240         self.is_acmd = True
241         self.state = 'GET RESPONSE R1'
242
243     def handle_cmd59(self):
244         # CMD59: CRC_ON_OFF
245         crc_on_off = self.arg & (1 << 0)
246         s = 'on' if crc_on_off == 1 else 'off'
247         self.putc(59, 'Turn the SD card CRC option %s' % s)
248         self.state = 'GET RESPONSE R1'
249
250     def handle_acmd41(self):
251         # ACMD41: SD_SEND_OP_COND
252         self.putc(64 + 41, 'Send HCS info and activate the card init process')
253         self.state = 'GET RESPONSE R1'
254
255     def handle_cmd999(self):
256         self.state = 'GET RESPONSE R1'
257
258     def handle_cid_register(self):
259         # Card Identification (CID) register, 128bits
260
261         cid = self.cid
262
263         # Manufacturer ID: CID[127:120] (8 bits)
264         mid = cid[15]
265
266         # OEM/Application ID: CID[119:104] (16 bits)
267         oid = (cid[14] << 8) | cid[13]
268
269         # Product name: CID[103:64] (40 bits)
270         pnm = 0
271         for i in range(12, 8 - 1, -1):
272             pnm <<= 8
273             pnm |= cid[i]
274
275         # Product revision: CID[63:56] (8 bits)
276         prv = cid[7]
277
278         # Product serial number: CID[55:24] (32 bits)
279         psn = 0
280         for i in range(6, 3 - 1, -1):
281             psn <<= 8
282             psn |= cid[i]
283
284         # RESERVED: CID[23:20] (4 bits)
285
286         # Manufacturing date: CID[19:8] (12 bits)
287         # TODO
288
289         # CRC7 checksum: CID[7:1] (7 bits)
290         # TODO
291
292         # Not used, always 1: CID[0:0] (1 bit)
293         # TODO
294
295     def handle_response_r1(self, res):
296         # The R1 response token format (1 byte).
297         # Sent by the card after every command except for SEND_STATUS.
298
299         self.ss_cmd, self.es_cmd = self.miso_bits[7][1], self.miso_bits[0][2]
300         self.putx([65, ['R1: 0x%02x' % res]])
301
302         def putbit(bit, data):
303             b = self.miso_bits[bit]
304             self.ss_bit, self.es_bit = b[1], b[2]
305             self.putb([134, data])
306
307         # Bit 0: 'In idle state' bit
308         s = '' if (res & (1 << 0)) else 'not '
309         putbit(0, ['Card is %sin idle state' % s])
310
311         # Bit 1: 'Erase reset' bit
312         s = '' if (res & (1 << 1)) else 'not '
313         putbit(1, ['Erase sequence %scleared' % s])
314
315         # Bit 2: 'Illegal command' bit
316         s = 'I' if (res & (1 << 2)) else 'No i'
317         putbit(2, ['%sllegal command detected' % s])
318
319         # Bit 3: 'Communication CRC error' bit
320         s = 'failed' if (res & (1 << 3)) else 'was successful'
321         putbit(3, ['CRC check of last command %s' % s])
322
323         # Bit 4: 'Erase sequence error' bit
324         s = 'E' if (res & (1 << 4)) else 'No e'
325         putbit(4, ['%srror in the sequence of erase commands' % s])
326
327         # Bit 5: 'Address error' bit
328         s = 'M' if (res & (1 << 4)) else 'No m'
329         putbit(5, ['%sisaligned address used in command' % s])
330
331         # Bit 6: 'Parameter error' bit
332         s = '' if (res & (1 << 4)) else 'not '
333         putbit(6, ['Command argument %soutside allowed range' % s])
334
335         # Bit 7: Always set to 0
336         putbit(7, ['Bit 7 (always 0)'])
337
338         if self.is_cmd24:
339             self.state = 'HANDLE DATA BLOCK CMD24'
340
341     def handle_response_r1b(self, res):
342         # TODO
343         pass
344
345     def handle_response_r2(self, res):
346         # TODO
347         pass
348
349     def handle_response_r3(self, res):
350         # TODO
351         pass
352
353     # Note: Response token formats R4 and R5 are reserved for SDIO.
354
355     # TODO: R6?
356
357     def handle_response_r7(self, res):
358         # TODO
359         pass
360
361     def handle_data_cmd24(self, mosi):
362         if self.cmd24_start_token_found:
363             if len(self.read_buf) == 0:
364                 self.ss_data = self.ss
365                 if not self.blocklen:
366                     # Assume a fixed block size when inspection of the
367                     # previous traffic did not provide the respective
368                     # parameter value.
369                     # TODO Make the default block size a user adjustable option?
370                     self.blocklen = 512
371             self.read_buf.append(mosi)
372             # Wait until block transfer completed.
373             if len(self.read_buf) < self.blocklen:
374                 return
375             self.es_data = self.es
376             self.put(self.ss_data, self.es_data, self.out_ann, [24, ['Block data: %s' % self.read_buf]])
377             self.read_buf = []
378             self.state = 'DATA RESPONSE'
379         elif mosi == 0xfe:
380             self.put(self.ss, self.es, self.out_ann, [24, ['Start Block']])
381             self.cmd24_start_token_found = True
382
383     def handle_data_response(self, miso):
384         # Data Response token (1 byte).
385         #
386         # Format:
387         #  - Bits[7:5]: Don't care.
388         #  - Bits[4:4]: Always 0.
389         #  - Bits[3:1]: Status.
390         #    - 010: Data accepted.
391         #    - 101: Data rejected due to a CRC error.
392         #    - 110: Data rejected due to a write error.
393         #  - Bits[0:0]: Always 1.
394         miso &= 0x1f
395         if miso & 0x11 != 0x01:
396             # This is not the byte we are waiting for.
397             # Should we return to IDLE here?
398             return
399         m = self.miso_bits
400         self.put(m[7][1], m[5][2], self.out_ann, [134, ['Don\'t care']])
401         self.put(m[4][1], m[4][2], self.out_ann, [134, ['Always 0']])
402         if miso == 0x05:
403             self.put(m[3][1], m[1][2], self.out_ann, [134, ['Data accepted']])
404         elif miso == 0x0b:
405             self.put(m[3][1], m[1][2], self.out_ann, [134, ['Data rejected (CRC error)']])
406         elif miso == 0x0d:
407             self.put(m[3][1], m[1][2], self.out_ann, [134, ['Data rejected (write error)']])
408         self.put(m[0][1], m[0][2], self.out_ann, [134, ['Always 1']])
409         ann_class = None
410         if self.is_cmd24:
411             ann_class = 24
412         if ann_class is not None:
413             self.put(self.ss, self.es, self.out_ann, [ann_class, ['Data Response']])
414         self.state = 'IDLE'
415
416     def decode(self, ss, es, data):
417         ptype, mosi, miso = data
418
419         # For now, only use DATA and BITS packets.
420         if ptype not in ('DATA', 'BITS'):
421             return
422
423         # Store the individual bit values and ss/es numbers. The next packet
424         # is guaranteed to be a 'DATA' packet belonging to this 'BITS' one.
425         if ptype == 'BITS':
426             self.miso_bits, self.mosi_bits = miso, mosi
427             return
428
429         self.ss, self.es = ss, es
430
431         # State machine.
432         if self.state == 'IDLE':
433             # Ignore stray 0xff bytes, some devices seem to send those!?
434             if mosi == 0xff: # TODO?
435                 return
436             self.state = 'GET COMMAND TOKEN'
437             self.handle_command_token(mosi, miso)
438         elif self.state == 'GET COMMAND TOKEN':
439             self.handle_command_token(mosi, miso)
440         elif self.state.startswith('HANDLE CMD'):
441             self.miso, self.mosi = miso, mosi
442             # Call the respective handler method for the command.
443             a, cmdstr = 'a' if self.is_acmd else '', self.state[10:].lower()
444             handle_cmd = getattr(self, 'handle_%scmd%s' % (a, cmdstr))
445             handle_cmd()
446             self.cmd_token = []
447             self.cmd_token_bits = []
448             # Leave ACMD mode again after the first command after CMD55.
449             if self.is_acmd and cmdstr != '55':
450                 self.is_acmd = False
451         elif self.state.startswith('GET RESPONSE'):
452             # Ignore stray 0xff bytes, some devices seem to send those!?
453             if miso == 0xff: # TODO?
454                 return
455             # Call the respective handler method for the response.
456             # Assume return to IDLE state, but allow response handlers
457             # to advance to some other state when applicable.
458             s = 'handle_response_%s' % self.state[13:].lower()
459             handle_response = getattr(self, s)
460             self.state = 'IDLE'
461             handle_response(miso)
462         elif self.state == 'HANDLE DATA BLOCK CMD24':
463             self.handle_data_cmd24(mosi)
464         elif self.state == 'DATA RESPONSE':
465             self.handle_data_response(miso)