2 ## This file is part of the libsigrokdecode project.
4 ## Copyright (C) 2012-2020 Uwe Hermann <uwe@hermann-uwe.de>
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.
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.
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/>.
20 import sigrokdecode as srd
21 from common.srdhelper import SrdIntEnum
22 from common.sdcard import (cmd_names, acmd_names)
24 responses = '1 1b 2 3 7'.split()
26 a = ['CMD%d' % i for i in range(64)] + ['ACMD%d' % i for i in range(64)] + \
27 ['R' + r.upper() for r in responses] + ['BIT', 'BIT_WARNING']
28 Ann = SrdIntEnum.from_list('Ann', a)
30 class Decoder(srd.Decoder):
33 name = 'SD card (SPI mode)'
34 longname = 'Secure Digital card (SPI mode)'
35 desc = 'Secure Digital card (SPI mode) low-level protocol.'
41 tuple(('cmd%d' % i, 'CMD%d' % i) for i in range(64)) + \
42 tuple(('acmd%d' % i, 'ACMD%d' % i) for i in range(64)) + \
43 tuple(('r%s' % r, 'R%s response' % r) for r in responses) + ( \
45 ('bit-warning', 'Bit warning'),
48 ('bits', 'Bits', (Ann.BIT, Ann.BIT_WARNING)),
49 ('commands-replies', 'Commands/replies', Ann.prefixes('CMD ACMD R')),
57 self.ss, self.es = 0, 0
58 self.ss_bit, self.es_bit = 0, 0
59 self.ss_cmd, self.es_cmd = 0, 0
60 self.ss_busy, self.es_busy = 0, 0
62 self.cmd_token_bits = []
63 self.is_acmd = False # Indicates CMD vs. ACMD
68 self.cmd24_start_token_found = False
70 self.cmd17_start_token_found = False
71 self.busy_first_byte = False
74 self.out_ann = self.register(srd.OUTPUT_ANN)
77 self.put(self.ss_cmd, self.es_cmd, self.out_ann, data)
79 def putc(self, cmd, desc):
80 self.putx([cmd, ['%s: %s' % (self.cmd_str, desc)]])
83 self.put(self.ss_bit, self.es_bit, self.out_ann, data)
85 def cmd_name(self, cmd):
86 c = acmd_names if self.is_acmd else cmd_names
87 s = c.get(cmd, 'Unknown')
88 # SD mode names for CMD32/33: ERASE_WR_BLK_{START,END}.
89 # SPI mode names for CMD32/33: ERASE_WR_BLK_{START,END}_ADDR.
94 def handle_command_token(self, mosi, miso):
95 # Command tokens (6 bytes) are sent (MSB-first) by the host.
98 # - CMD[47:47]: Start bit (always 0)
99 # - CMD[46:46]: Transmitter bit (1 == host)
100 # - CMD[45:40]: Command index (BCD; valid: 0-63)
101 # - CMD[39:08]: Argument
103 # - CMD[00:00]: End bit (always 1)
105 if len(self.cmd_token) == 0:
106 self.ss_cmd = self.ss
108 self.cmd_token.append(mosi)
109 self.cmd_token_bits.append(self.mosi_bits)
111 # All command tokens are 6 bytes long.
112 if len(self.cmd_token) < 6:
115 self.es_cmd = self.es
120 s = 'ACMD' if self.is_acmd else 'CMD'
123 return self.cmd_token_bits[5 - byte][bit]
125 # Bits[47:47]: Start bit (always 0)
126 bit, self.ss_bit, self.es_bit = tb(5, 7)[0], tb(5, 7)[1], tb(5, 7)[2]
128 self.putb([Ann.BIT, ['Start bit: %d' % bit]])
130 self.putb([Ann.BIT_WARNING, ['Start bit: %s (Warning: Must be 0!)' % bit]])
132 # Bits[46:46]: Transmitter bit (1 == host)
133 bit, self.ss_bit, self.es_bit = tb(5, 6)[0], tb(5, 6)[1], tb(5, 6)[2]
135 self.putb([Ann.BIT, ['Transmitter bit: %d' % bit]])
137 self.putb([Ann.BIT_WARNING, ['Transmitter bit: %d (Warning: Must be 1!)' % bit]])
139 # Bits[45:40]: Command index (BCD; valid: 0-63)
140 cmd = self.cmd_index = t[0] & 0x3f
141 self.ss_bit, self.es_bit = tb(5, 5)[1], tb(5, 0)[2]
142 self.putb([Ann.BIT, ['Command: %s%d (%s)' % (s, cmd, self.cmd_name(cmd))]])
144 # Bits[39:8]: Argument
145 self.arg = (t[1] << 24) | (t[2] << 16) | (t[3] << 8) | t[4]
146 self.ss_bit, self.es_bit = tb(4, 7)[1], tb(1, 0)[2]
147 self.putb([Ann.BIT, ['Argument: 0x%04x' % self.arg]])
152 self.ss_bit, self.es_bit = tb(0, 7)[1], tb(0, 1)[2]
153 self.putb([Ann.BIT, ['CRC7: 0x%01x' % crc]])
155 # Bits[0:0]: End bit (always 1)
156 bit, self.ss_bit, self.es_bit = tb(0, 0)[0], tb(0, 0)[1], tb(0, 0)[2]
158 self.putb([Ann.BIT, ['End bit: %d' % bit]])
160 self.putb([Ann.BIT_WARNING, ['End bit: %d (Warning: Must be 1!)' % bit]])
163 if cmd in (0, 1, 9, 16, 17, 24, 41, 49, 55, 59):
164 self.state = 'HANDLE CMD%d' % cmd
165 self.cmd_str = '%s%d (%s)' % (s, cmd, self.cmd_name(cmd))
167 self.state = 'HANDLE CMD999'
168 a = '%s%d: %02x %02x %02x %02x %02x %02x' % ((s, cmd) + tuple(t))
169 self.putx([cmd, [a]])
171 def handle_cmd0(self):
172 # CMD0: GO_IDLE_STATE
173 self.putc(Ann.CMD0, 'Reset the SD card')
174 self.state = 'GET RESPONSE R1'
176 def handle_cmd1(self):
178 self.putc(Ann.CMD1, 'Send HCS info and activate the card init process')
179 hcs = (self.arg & (1 << 30)) >> 30
180 self.ss_bit = self.cmd_token_bits[5 - 4][6][1]
181 self.es_bit = self.cmd_token_bits[5 - 4][6][2]
182 self.putb([Ann.BIT, ['HCS: %d' % hcs]])
183 self.state = 'GET RESPONSE R1'
185 def handle_cmd9(self):
186 # CMD9: SEND_CSD (128 bits / 16 bytes)
187 self.putc(Ann.CMD9, 'Ask card to send its card specific data (CSD)')
188 if len(self.read_buf) == 0:
189 self.ss_cmd = self.ss
190 self.read_buf.append(self.miso)
192 ### if len(self.read_buf) < 16:
193 if len(self.read_buf) < 16 + 4:
195 self.es_cmd = self.es
196 self.read_buf = self.read_buf[4:] # TODO: Document or redo.
197 self.putx([Ann.CMD9, ['CSD: %s' % self.read_buf]])
198 # TODO: Decode all bits.
200 ### self.state = 'GET RESPONSE R1'
203 def handle_cmd10(self):
204 # CMD10: SEND_CID (128 bits / 16 bytes)
205 self.putc(Ann.CMD10, 'Ask card to send its card identification (CID)')
206 self.read_buf.append(self.miso)
207 if len(self.read_buf) < 16:
209 self.putx([Ann.CMD10, ['CID: %s' % self.read_buf]])
210 # TODO: Decode all bits.
212 self.state = 'GET RESPONSE R1'
214 def handle_cmd16(self):
215 # CMD16: SET_BLOCKLEN
216 self.blocklen = self.arg
217 # TODO: Sanity check on block length.
218 self.putc(Ann.CMD16, 'Set the block length to %d bytes' % self.blocklen)
219 self.state = 'GET RESPONSE R1'
221 def handle_cmd17(self):
222 # CMD17: READ_SINGLE_BLOCK
223 self.putc(Ann.CMD17, 'Read a block from address 0x%04x' % self.arg)
225 self.state = 'GET RESPONSE R1'
227 def handle_cmd24(self):
229 self.putc(Ann.CMD24, 'Write a block to address 0x%04x' % self.arg)
231 self.state = 'GET RESPONSE R1'
233 def handle_cmd49(self):
234 self.state = 'GET RESPONSE R1'
236 def handle_cmd55(self):
238 self.putc(Ann.CMD55, 'Next command is an application-specific command')
240 self.state = 'GET RESPONSE R1'
242 def handle_cmd59(self):
244 crc_on_off = self.arg & (1 << 0)
245 s = 'on' if crc_on_off == 1 else 'off'
246 self.putc(Ann.CMD59, 'Turn the SD card CRC option %s' % s)
247 self.state = 'GET RESPONSE R1'
249 def handle_acmd41(self):
250 # ACMD41: SD_SEND_OP_COND
251 self.putc(Ann.ACMD41, 'Send HCS info and activate the card init process')
252 self.state = 'GET RESPONSE R1'
254 def handle_cmd999(self):
255 self.state = 'GET RESPONSE R1'
257 def handle_cid_register(self):
258 # Card Identification (CID) register, 128bits
262 # Manufacturer ID: CID[127:120] (8 bits)
265 # OEM/Application ID: CID[119:104] (16 bits)
266 oid = (cid[14] << 8) | cid[13]
268 # Product name: CID[103:64] (40 bits)
270 for i in range(12, 8 - 1, -1):
274 # Product revision: CID[63:56] (8 bits)
277 # Product serial number: CID[55:24] (32 bits)
279 for i in range(6, 3 - 1, -1):
283 # RESERVED: CID[23:20] (4 bits)
285 # Manufacturing date: CID[19:8] (12 bits)
288 # CRC7 checksum: CID[7:1] (7 bits)
291 # Not used, always 1: CID[0:0] (1 bit)
294 def handle_response_r1(self, res):
295 # The R1 response token format (1 byte).
296 # Sent by the card after every command except for SEND_STATUS.
298 self.ss_cmd, self.es_cmd = self.miso_bits[7][1], self.miso_bits[0][2]
299 self.putx([Ann.R1, ['R1: 0x%02x' % res]])
301 def putbit(bit, data):
302 b = self.miso_bits[bit]
303 self.ss_bit, self.es_bit = b[1], b[2]
304 self.putb([Ann.BIT, data])
306 # Bit 0: 'In idle state' bit
307 s = '' if (res & (1 << 0)) else 'not '
308 putbit(0, ['Card is %sin idle state' % s])
310 # Bit 1: 'Erase reset' bit
311 s = '' if (res & (1 << 1)) else 'not '
312 putbit(1, ['Erase sequence %scleared' % s])
314 # Bit 2: 'Illegal command' bit
315 s = 'I' if (res & (1 << 2)) else 'No i'
316 putbit(2, ['%sllegal command detected' % s])
318 # Bit 3: 'Communication CRC error' bit
319 s = 'failed' if (res & (1 << 3)) else 'was successful'
320 putbit(3, ['CRC check of last command %s' % s])
322 # Bit 4: 'Erase sequence error' bit
323 s = 'E' if (res & (1 << 4)) else 'No e'
324 putbit(4, ['%srror in the sequence of erase commands' % s])
326 # Bit 5: 'Address error' bit
327 s = 'M' if (res & (1 << 4)) else 'No m'
328 putbit(5, ['%sisaligned address used in command' % s])
330 # Bit 6: 'Parameter error' bit
331 s = '' if (res & (1 << 4)) else 'not '
332 putbit(6, ['Command argument %soutside allowed range' % s])
334 # Bit 7: Always set to 0
335 putbit(7, ['Bit 7 (always 0)'])
338 self.state = 'HANDLE DATA BLOCK CMD17'
340 self.state = 'HANDLE DATA BLOCK CMD24'
342 def handle_response_r1b(self, res):
346 def handle_response_r2(self, res):
350 def handle_response_r3(self, res):
354 # Note: Response token formats R4 and R5 are reserved for SDIO.
358 def handle_response_r7(self, res):
362 def handle_data_cmd17(self, miso):
363 # CMD17 returns one byte R1, then some bytes 0xff, then a Start Block
364 # (single byte 0xfe), then self.blocklen bytes of data, then always
366 if self.cmd17_start_token_found:
367 if len(self.read_buf) == 0:
368 self.ss_data = self.ss
369 if not self.blocklen:
370 # Assume a fixed block size when inspection of the previous
371 # traffic did not provide the respective parameter value.
372 # TODO: Make the default block size a PD option?
374 self.read_buf.append(miso)
375 # Wait until block transfer completed.
376 if len(self.read_buf) < self.blocklen:
378 if len(self.read_buf) == self.blocklen:
379 self.es_data = self.es
380 self.put(self.ss_data, self.es_data, self.out_ann, [Ann.CMD17, ['Block data: %s' % self.read_buf]])
381 elif len(self.read_buf) == (self.blocklen + 1):
382 self.ss_crc = self.ss
383 elif len(self.read_buf) == (self.blocklen + 2):
384 self.es_crc = self.es
386 self.put(self.ss_crc, self.es_crc, self.out_ann, [Ann.CMD17, ['CRC']])
389 self.put(self.ss, self.es, self.out_ann, [Ann.CMD17, ['Start Block']])
390 self.cmd17_start_token_found = True
392 def handle_data_cmd24(self, mosi):
393 if self.cmd24_start_token_found:
394 if len(self.read_buf) == 0:
395 self.ss_data = self.ss
396 if not self.blocklen:
397 # Assume a fixed block size when inspection of the
398 # previous traffic did not provide the respective
400 # TODO Make the default block size a user adjustable option?
402 self.read_buf.append(mosi)
403 # Wait until block transfer completed.
404 if len(self.read_buf) < self.blocklen:
406 self.es_data = self.es
407 self.put(self.ss_data, self.es_data, self.out_ann, [Ann.CMD24, ['Block data: %s' % self.read_buf]])
409 self.state = 'DATA RESPONSE'
411 self.put(self.ss, self.es, self.out_ann, [Ann.CMD24, ['Start Block']])
412 self.cmd24_start_token_found = True
414 def handle_data_response(self, miso):
415 # Data Response token (1 byte).
418 # - Bits[7:5]: Don't care.
419 # - Bits[4:4]: Always 0.
420 # - Bits[3:1]: Status.
421 # - 010: Data accepted.
422 # - 101: Data rejected due to a CRC error.
423 # - 110: Data rejected due to a write error.
424 # - Bits[0:0]: Always 1.
426 if miso & 0x11 != 0x01:
427 # This is not the byte we are waiting for.
428 # Should we return to IDLE here?
431 self.put(m[7][1], m[5][2], self.out_ann, [Ann.BIT, ['Don\'t care']])
432 self.put(m[4][1], m[4][2], self.out_ann, [Ann.BIT, ['Always 0']])
434 self.put(m[3][1], m[1][2], self.out_ann, [Ann.BIT, ['Data accepted']])
436 self.put(m[3][1], m[1][2], self.out_ann, [Ann.BIT, ['Data rejected (CRC error)']])
438 self.put(m[3][1], m[1][2], self.out_ann, [Ann.BIT, ['Data rejected (write error)']])
439 self.put(m[0][1], m[0][2], self.out_ann, [Ann.BIT, ['Always 1']])
440 cls = Ann.CMD24 if self.is_cmd24 else None
442 self.put(self.ss, self.es, self.out_ann, [cls, ['Data Response']])
444 # We just send a block of data to be written to the card,
445 # this takes some time.
446 self.state = 'WAIT WHILE CARD BUSY'
447 self.busy_first_byte = True
451 def wait_while_busy(self, miso):
453 cls = Ann.CMD24 if self.is_cmd24 else None
455 self.put(self.ss_busy, self.es_busy, self.out_ann, [cls, ['Card is busy']])
459 if self.busy_first_byte:
460 self.ss_busy = self.ss
461 self.busy_first_byte = False
463 self.es_busy = self.es
465 def decode(self, ss, es, data):
466 ptype, mosi, miso = data
468 # For now, only use DATA and BITS packets.
469 if ptype not in ('DATA', 'BITS'):
472 # Store the individual bit values and ss/es numbers. The next packet
473 # is guaranteed to be a 'DATA' packet belonging to this 'BITS' one.
475 self.miso_bits, self.mosi_bits = miso, mosi
478 self.ss, self.es = ss, es
481 if self.state == 'IDLE':
482 # Ignore stray 0xff bytes, some devices seem to send those!?
483 if mosi == 0xff: # TODO?
485 self.state = 'GET COMMAND TOKEN'
486 self.handle_command_token(mosi, miso)
487 elif self.state == 'GET COMMAND TOKEN':
488 self.handle_command_token(mosi, miso)
489 elif self.state.startswith('HANDLE CMD'):
490 self.miso, self.mosi = miso, mosi
491 # Call the respective handler method for the command.
492 a, cmdstr = 'a' if self.is_acmd else '', self.state[10:].lower()
493 handle_cmd = getattr(self, 'handle_%scmd%s' % (a, cmdstr))
496 self.cmd_token_bits = []
497 # Leave ACMD mode again after the first command after CMD55.
498 if self.is_acmd and cmdstr != '55':
500 elif self.state.startswith('GET RESPONSE'):
501 # Ignore stray 0xff bytes, some devices seem to send those!?
502 if miso == 0xff: # TODO?
504 # Call the respective handler method for the response.
505 # Assume return to IDLE state, but allow response handlers
506 # to advance to some other state when applicable.
507 s = 'handle_response_%s' % self.state[13:].lower()
508 handle_response = getattr(self, s)
510 handle_response(miso)
511 elif self.state == 'HANDLE DATA BLOCK CMD17':
512 self.handle_data_cmd17(miso)
513 elif self.state == 'HANDLE DATA BLOCK CMD24':
514 self.handle_data_cmd24(mosi)
515 elif self.state == 'DATA RESPONSE':
516 self.handle_data_response(miso)
517 elif self.state == 'WAIT WHILE CARD BUSY':
518 self.wait_while_busy(miso)