sdcard_spi: Use bit-exact annotations in handle_response_r1().
[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, 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 cmd_name = {
24     # Normal commands (CMD)
25     0:  'GO_IDLE_STATE',
26     1:  'SEND_OP_COND',
27     6:  'SWITCH_FUNC',
28     8:  'SEND_IF_COND',
29     9:  'SEND_CSD',
30     10: 'SEND_CID',
31     12: 'STOP_TRANSMISSION',
32     13: 'SEND_STATUS',
33     16: 'SET_BLOCKLEN',
34     17: 'READ_SINGLE_BLOCK',
35     18: 'READ_MULTIPLE_BLOCK',
36     24: 'WRITE_BLOCK',
37     25: 'WRITE_MULTIPLE_BLOCK',
38     27: 'PROGRAM_CSD',
39     28: 'SET_WRITE_PROT',
40     29: 'CLR_WRITE_PROT',
41     30: 'SEND_WRITE_PROT',
42     32: 'ERASE_WR_BLK_START_ADDR',
43     33: 'ERASE_WR_BLK_END_ADDR',
44     38: 'ERASE',
45     42: 'LOCK_UNLOCK',
46     55: 'APP_CMD',
47     56: 'GEN_CMD',
48     58: 'READ_OCR',
49     59: 'CRC_ON_OFF',
50     # CMD60-63: Reserved for manufacturer
51
52     # Application-specific commands (ACMD)
53     13: 'SD_STATUS',
54     18: 'Reserved for SD security applications',
55     22: 'SEND_NUM_WR_BLOCKS',
56     23: 'SET_WR_BLK_ERASE_COUNT',
57     25: 'Reserved for SD security applications',
58     26: 'Reserved for SD security applications',
59     38: 'Reserved for SD security applications',
60     41: 'SD_SEND_OP_COND',
61     42: 'SET_CLR_CARD_DETECT',
62     43: 'Reserved for SD security applications',
63     44: 'Reserved for SD security applications',
64     45: 'Reserved for SD security applications',
65     46: 'Reserved for SD security applications',
66     47: 'Reserved for SD security applications',
67     48: 'Reserved for SD security applications',
68     49: 'Reserved for SD security applications',
69     51: 'SEND_SCR',
70 }
71
72 def ann_cmd_list():
73     l = []
74     for i in range(63 + 1):
75         l.append(['cmd%d' % i, 'CMD%d' % i])
76     return l
77
78 class Decoder(srd.Decoder):
79     api_version = 1
80     id = 'sdcard_spi'
81     name = 'SD card (SPI mode)'
82     longname = 'Secure Digital card (SPI mode)'
83     desc = 'Secure Digital card (SPI mode) low-level protocol.'
84     license = 'gplv2+'
85     inputs = ['spi']
86     outputs = ['sdcard_spi']
87     probes = []
88     optional_probes = []
89     options = {}
90     annotations = ann_cmd_list() + [
91         ['cmd-token', 'Command token'],
92         ['r1', 'R1 reply'],
93         ['r1b', 'R1B reply'],
94         ['r2', 'R2 reply'],
95         ['r3', 'R3 reply'],
96         ['r7', 'R7 reply'],
97         ['bits', 'Bits'],
98     ]
99     annotation_rows = (
100         ('bits', 'Bits', (70,)),
101         ('cmd-reply', 'Commands/replies',
102             tuple(range(0, 63 + 1)) + tuple(range(65, 69 + 1))),
103         ('cmd-token', 'Command tokens', (64,)),
104     )
105
106     def __init__(self, **kwargs):
107         self.state = 'IDLE'
108         self.samplenum = 0
109         self.ss, self.es = 0, 0
110         self.bit_ss, self.bit_es = 0, 0
111         self.cmd_ss, self.cmd_es = 0, 0
112         self.cmd_token = []
113         self.cmd_token_bits = []
114         self.is_acmd = False # Indicates CMD vs. ACMD
115         self.blocklen = 0
116         self.read_buf = []
117
118     def start(self):
119         # self.out_python = self.register(srd.OUTPUT_PYTHON)
120         self.out_ann = self.register(srd.OUTPUT_ANN)
121
122     def putx(self, data):
123         self.put(self.cmd_ss, self.cmd_es, self.out_ann, data)
124
125     def putb(self, data):
126         self.put(self.bit_ss, self.bit_es, self.out_ann, data)
127
128     def handle_command_token(self, mosi, miso):
129         # Command tokens (6 bytes) are sent (MSB-first) by the host.
130         #
131         # Format:
132         #  - CMD[47:47]: Start bit (always 0)
133         #  - CMD[46:46]: Transmitter bit (1 == host)
134         #  - CMD[45:40]: Command index (BCD; valid: 0-63)
135         #  - CMD[39:08]: Argument
136         #  - CMD[07:01]: CRC7
137         #  - CMD[00:00]: End bit (always 1)
138
139         if len(self.cmd_token) == 0:
140             self.cmd_ss = self.ss
141
142         self.cmd_token.append(mosi)
143         self.cmd_token_bits.append(self.mosi_bits)
144         # TODO: Record MISO too?
145
146         # All command tokens are 6 bytes long.
147         if len(self.cmd_token) < 6:
148             return
149
150         self.cmd_es = self.es
151
152         # Received all 6 bytes of the command token. Now decode it.
153
154         t = self.cmd_token
155
156         # CMD or ACMD?
157         s = 'ACMD' if self.is_acmd else 'CMD'
158         # TODO
159         self.putx([64, [s + ': %02x %02x %02x %02x %02x %02x' % tuple(t)]])
160
161         def tb(byte, bit):
162             return self.cmd_token_bits[5 - byte][7 - bit]
163
164         # Bits[47:47]: Start bit (always 0)
165         bit, self.bit_ss, self.bit_es = tb(5, 7)[0], tb(5, 7)[1], tb(5, 7)[2]
166         self.putb([70, ['Start bit: %d' % bit]])
167         if bit != 0:
168             # TODO
169             self.putb([1, ['Warning: Start bit != 0']])
170
171         # Bits[46:46]: Transmitter bit (1 == host)
172         bit, self.bit_ss, self.bit_es = tb(5, 6)[0], tb(5, 6)[1], tb(5, 6)[2]
173         self.putb([70, ['Transmitter bit: %d' % bit]])
174         if bit != 1:
175             # TODO
176             self.putb([1, ['Warning: Transmitter bit != 1']])
177
178         # Bits[45:40]: Command index (BCD; valid: 0-63)
179         cmd = self.cmd_index = t[5] & 0x3f
180         # TODO
181         self.bit_ss, self.bit_es = tb(5, 5)[1], tb(5, 0)[2]
182         self.putb([70, ['Command: %s%d (%s)' % (s, cmd, cmd_name[cmd])]])
183
184         # Bits[39:8]: Argument
185         self.arg = (t[1] << 24) | (t[2] << 16) | (t[3] << 8) | t[4]
186         self.bit_ss, self.bit_es = tb(4, 7)[1], tb(1, 0)[2]
187         self.putb([70, ['Argument: 0x%04x' % self.arg]])
188         # TODO: Sanity check on argument? Must be per-cmd?
189
190         # Bits[7:1]: CRC
191         # TODO: Check CRC.
192         crc = t[5] >> 1
193         self.bit_ss, self.bit_es = tb(0, 7)[1], tb(0, 1)[2]
194         self.putb([70, ['CRC: 0x%01x' % crc]])
195
196         # Bits[0:0]: End bit (always 1)
197         bit, self.bit_ss, self.bit_es = tb(0, 0)[0], tb(0, 0)[1], tb(0, 0)[2]
198         self.putb([70, ['End bit: %d' % bit]])
199         if bit != 1:
200             # TODO
201             self.putb([1, ['Warning: End bit != 1']])
202
203         # Handle command.
204         if cmd in (0, 1, 9, 16, 17, 41, 49, 55, 59):
205             self.state = 'HANDLE CMD%d' % cmd
206
207         # ...
208         if self.is_acmd and cmd != 55:
209             self.is_acmd = False
210
211         self.cmd_token = []
212         self.cmd_token_bits = []
213
214     def handle_cmd0(self, ):
215         # CMD0: GO_IDLE_STATE
216         # TODO
217         self.putx([0, ['CMD0: Card reset / idle state']])
218         self.state = 'GET RESPONSE R1'
219
220     def handle_cmd1(self):
221         # CMD1: SEND_OP_COND
222         # TODO
223         hcs = (self.arg & (1 << 30)) >> 30
224         self.putb([1, ['HCS bit = %d' % hcs]])
225         self.state = 'GET RESPONSE R1'
226
227     def handle_cmd9(self):
228         # CMD9: SEND_CSD (128 bits / 16 bytes)
229         if len(self.read_buf) == 0:
230             self.cmd_ss = self.ss
231         self.read_buf.append(self.miso)
232         # FIXME
233         ### if len(self.read_buf) < 16:
234         if len(self.read_buf) < 16 + 4:
235             return
236         self.cmd_es = self.es
237         self.read_buf = self.read_buf[4:] ### TODO: Document or redo.
238         self.putx([9, ['CSD: %s' % self.read_buf]])
239         # TODO: Decode all bits.
240         self.read_buf = []
241         ### self.state = 'GET RESPONSE R1'
242         self.state = 'IDLE'
243
244     def handle_cmd10(self):
245         # CMD10: SEND_CID (128 bits / 16 bytes)
246         self.read_buf.append(self.miso)
247         if len(self.read_buf) < 16:
248             return
249         self.putx([10, ['CID: %s' % self.read_buf]])
250         # TODO: Decode all bits.
251         self.read_buf = []
252         self.state = 'GET RESPONSE R1'
253
254     def handle_cmd16(self):
255         # CMD16: SET_BLOCKLEN
256         self.blocklen = self.arg # TODO
257         # TODO: Sanity check on block length.
258         self.putx([16, ['Block length: %d' % self.blocklen]])
259         self.state = 'GET RESPONSE R1'
260
261     def handle_cmd17(self):
262         # CMD17: READ_SINGLE_BLOCK
263         if len(self.read_buf) == 0:
264             self.cmd_ss = self.ss
265         self.read_buf.append(self.miso)
266         if len(self.read_buf) == 1:
267             self.putx([0, ['Read block at address: 0x%04x' % self.arg]])
268         if len(self.read_buf) < self.blocklen + 2: # FIXME
269             return
270         self.cmd_es = self.es
271         self.read_buf = self.read_buf[2:] # FIXME
272         self.putx([17, ['Block data: %s' % self.read_buf]])
273         self.read_buf = []
274         self.state = 'GET RESPONSE R1'
275
276     def handle_cmd41(self):
277         # ACMD41: SD_SEND_OP_COND
278         self.state = 'GET RESPONSE R1'
279
280     def handle_cmd49(self):
281         self.state = 'GET RESPONSE R1'
282
283     def handle_cmd55(self):
284         # CMD55: APP_CMD
285         self.is_acmd = True
286         self.state = 'GET RESPONSE R1'
287
288     def handle_cmd59(self):
289         # CMD59: CRC_ON_OFF
290         crc_on_off = self.arg & (1 << 0)
291         s = 'on' if crc_on_off == 1 else 'off'
292         self.putb([59, ['SD card CRC option: %s' % s]])
293         self.state = 'GET RESPONSE R1'
294
295     def handle_cid_register(self):
296         # Card Identification (CID) register, 128bits
297
298         cid = self.cid
299
300         # Manufacturer ID: CID[127:120] (8 bits)
301         mid = cid[15]
302
303         # OEM/Application ID: CID[119:104] (16 bits)
304         oid = (cid[14] << 8) | cid[13]
305
306         # Product name: CID[103:64] (40 bits)
307         pnm = 0
308         for i in range(12, 8 - 1, -1):
309             pnm <<= 8
310             pnm |= cid[i]
311
312         # Product revision: CID[63:56] (8 bits)
313         prv = cid[7]
314
315         # Product serial number: CID[55:24] (32 bits)
316         psn = 0
317         for i in range(6, 3 - 1, -1):
318             psn <<= 8
319             psn |= cid[i]
320
321         # RESERVED: CID[23:20] (4 bits)
322
323         # Manufacturing date: CID[19:8] (12 bits)
324         # TODO
325
326         # CRC7 checksum: CID[7:1] (7 bits)
327         # TODO
328
329         # Not used, always 1: CID[0:0] (1 bit)
330         # TODO
331
332     def handle_response_r1(self, res):
333         # The R1 response token format (1 byte).
334         # Sent by the card after every command except for SEND_STATUS.
335
336         self.cmd_ss, self.cmd_es = self.ss, self.es
337         self.putx([65, ['R1: 0x%02x' % res]])
338
339         def putbit(bit, data):
340             b = self.miso_bits[7 - bit]
341             self.bit_ss, self.bit_es = b[1], b[2]
342             self.putb([70, data])
343
344         # Bit 0: 'In idle state' bit
345         s = '' if (res & (1 << 0)) else 'not '
346         putbit(0, ['Card is %sin idle state' % s])
347
348         # Bit 1: 'Erase reset' bit
349         s = '' if (res & (1 << 1)) else 'not '
350         putbit(1, ['Erase sequence %scleared' % s])
351
352         # Bit 2: 'Illegal command' bit
353         s = 'I' if (res & (1 << 2)) else 'No i'
354         putbit(2, ['%sllegal command detected' % s])
355
356         # Bit 3: 'Communication CRC error' bit
357         s = 'failed' if (res & (1 << 3)) else 'was successful'
358         putbit(3, ['CRC check of last command %s' % s])
359
360         # Bit 4: 'Erase sequence error' bit
361         s = 'E' if (res & (1 << 4)) else 'No e'
362         putbit(4, ['%srror in the sequence of erase commands' % s])
363
364         # Bit 5: 'Address error' bit
365         s = 'M' if (res & (1 << 4)) else 'No m'
366         putbit(5, ['%sisaligned address used in command' % s])
367
368         # Bit 6: 'Parameter error' bit
369         s = '' if (res & (1 << 4)) else 'not '
370         putbit(6, ['Command argument %soutside allowed range' % s])
371
372         # Bit 7: Always set to 0
373         putbit(7, ['Bit 7 (always 0)'])
374
375         self.state = 'IDLE'
376
377     def handle_response_r1b(self, res):
378         # TODO
379         pass
380
381     def handle_response_r2(self, res):
382         # TODO
383         pass
384
385     def handle_response_r3(self, res):
386         # TODO
387         pass
388
389     # Note: Response token formats R4 and R5 are reserved for SDIO.
390
391     # TODO: R6?
392
393     def handle_response_r7(self, res):
394         # TODO
395         pass
396
397     def decode(self, ss, es, data):
398         ptype, mosi, miso = data
399
400         # For now, only use DATA and BITS packets.
401         if ptype not in ('DATA', 'BITS'):
402             return
403
404         # Store the individual bit values and ss/es numbers. The next packet
405         # is guaranteed to be a 'DATA' packet belonging to this 'BITS' one.
406         if ptype == 'BITS':
407             self.miso_bits, self.mosi_bits = miso, mosi
408             return
409
410         self.ss, self.es = ss, es
411
412         # State machine.
413         if self.state == 'IDLE':
414             # Ignore stray 0xff bytes, some devices seem to send those!?
415             if mosi == 0xff: # TODO?
416                 return
417             self.state = 'GET COMMAND TOKEN'
418             self.handle_command_token(mosi, miso)
419         elif self.state == 'GET COMMAND TOKEN':
420             self.handle_command_token(mosi, miso)
421         elif self.state.startswith('HANDLE CMD'):
422             self.miso, self.mosi = miso, mosi
423             # Call the respective handler method for the command.
424             s = 'handle_cmd%s' % self.state[10:].lower()
425             handle_cmd = getattr(self, s)
426             handle_cmd()
427         elif self.state.startswith('GET RESPONSE'):
428             # Ignore stray 0xff bytes, some devices seem to send those!?
429             if miso == 0xff: # TODO?
430                 return
431
432             # Call the respective handler method for the response.
433             s = 'handle_response_%s' % self.state[13:].lower()
434             handle_response = getattr(self, s)
435             handle_response(miso)
436
437             self.state = 'IDLE'
438         else:
439             raise Exception('Invalid state: %s' % self.state)
440