2 ## This file is part of the libsigrokdecode project.
4 ## Copyright (C) 2012-2014 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, write to the Free Software
18 ## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
21 import sigrokdecode as srd
24 # Normal commands (CMD)
31 12: 'STOP_TRANSMISSION',
34 17: 'READ_SINGLE_BLOCK',
35 18: 'READ_MULTIPLE_BLOCK',
37 25: 'WRITE_MULTIPLE_BLOCK',
41 30: 'SEND_WRITE_PROT',
42 32: 'ERASE_WR_BLK_START_ADDR',
43 33: 'ERASE_WR_BLK_END_ADDR',
50 # CMD60-63: Reserved for manufacturer
52 # Application-specific commands (ACMD)
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',
72 class Decoder(srd.Decoder):
75 name = 'SD card (SPI mode)'
76 longname = 'Secure Digital card (SPI mode)'
77 desc = 'Secure Digital card (SPI mode) low-level protocol.'
80 outputs = ['sdcard_spi']
82 [['cmd%d' % i, 'CMD%d' % i] for i in range(63 + 1)] + [
83 ['cmd-desc', 'Command description'],
90 ['bit-warnings', 'Bit warnings'],
93 ('bits', 'Bits', (70, 71)),
94 ('cmd-reply', 'Commands/replies',
95 tuple(range(0, 63 + 1)) + tuple(range(65, 69 + 1))),
96 ('cmd-token', 'Command tokens', (64,)),
99 def __init__(self, **kwargs):
102 self.ss, self.es = 0, 0
103 self.bit_ss, self.bit_es = 0, 0
104 self.cmd_ss, self.cmd_es = 0, 0
106 self.cmd_token_bits = []
107 self.is_acmd = False # Indicates CMD vs. ACMD
113 # self.out_python = self.register(srd.OUTPUT_PYTHON)
114 self.out_ann = self.register(srd.OUTPUT_ANN)
116 def putx(self, data):
117 self.put(self.cmd_ss, self.cmd_es, self.out_ann, data)
119 def putc(self, cmd, desc):
120 self.putx([cmd, ['%s: %s' % (self.cmd_str, desc)]])
122 def putb(self, data):
123 self.put(self.bit_ss, self.bit_es, self.out_ann, data)
125 def handle_command_token(self, mosi, miso):
126 # Command tokens (6 bytes) are sent (MSB-first) by the host.
129 # - CMD[47:47]: Start bit (always 0)
130 # - CMD[46:46]: Transmitter bit (1 == host)
131 # - CMD[45:40]: Command index (BCD; valid: 0-63)
132 # - CMD[39:08]: Argument
134 # - CMD[00:00]: End bit (always 1)
136 if len(self.cmd_token) == 0:
137 self.cmd_ss = self.ss
139 self.cmd_token.append(mosi)
140 self.cmd_token_bits.append(self.mosi_bits)
142 # All command tokens are 6 bytes long.
143 if len(self.cmd_token) < 6:
146 self.cmd_es = self.es
151 s = 'ACMD' if self.is_acmd else 'CMD'
154 return self.cmd_token_bits[5 - byte][bit]
156 # Bits[47:47]: Start bit (always 0)
157 bit, self.bit_ss, self.bit_es = tb(5, 7)[0], tb(5, 7)[1], tb(5, 7)[2]
159 self.putb([70, ['Start bit: %d' % bit]])
161 self.putb([71, ['Start bit: %s (Warning: Must be 0!)' % bit]])
163 # Bits[46:46]: Transmitter bit (1 == host)
164 bit, self.bit_ss, self.bit_es = tb(5, 6)[0], tb(5, 6)[1], tb(5, 6)[2]
166 self.putb([70, ['Transmitter bit: %d' % bit]])
168 self.putb([71, ['Transmitter bit: %d (Warning: Must be 1!)' % bit]])
170 # Bits[45:40]: Command index (BCD; valid: 0-63)
171 cmd = self.cmd_index = t[0] & 0x3f
172 self.bit_ss, self.bit_es = tb(5, 5)[1], tb(5, 0)[2]
173 self.putb([70, ['Command: %s%d (%s)' % (s, cmd, cmd_name[cmd])]])
175 # Bits[39:8]: Argument
176 self.arg = (t[1] << 24) | (t[2] << 16) | (t[3] << 8) | t[4]
177 self.bit_ss, self.bit_es = tb(4, 7)[1], tb(1, 0)[2]
178 self.putb([70, ['Argument: 0x%04x' % self.arg]])
183 self.bit_ss, self.bit_es = tb(0, 7)[1], tb(0, 1)[2]
184 self.putb([70, ['CRC7: 0x%01x' % crc]])
186 # Bits[0:0]: End bit (always 1)
187 bit, self.bit_ss, self.bit_es = tb(0, 0)[0], tb(0, 0)[1], tb(0, 0)[2]
188 self.putb([70, ['End bit: %d' % bit]])
190 self.putb([70, ['End bit: %d' % bit]])
192 self.putb([71, ['End bit: %d (Warning: Must be 1!)' % bit]])
195 if cmd in (0, 1, 9, 16, 17, 41, 49, 55, 59):
196 self.state = 'HANDLE CMD%d' % cmd
197 self.cmd_str = '%s%d (%s)' % (s, cmd, cmd_name[cmd])
199 self.state = 'HANDLE CMD999'
200 a = '%s%d: %02x %02x %02x %02x %02x %02x' % ((s, cmd) + tuple(t))
201 self.putx([cmd, [a]])
204 if self.is_acmd and cmd != 55:
207 def handle_cmd0(self):
208 # CMD0: GO_IDLE_STATE
209 self.putc(0, 'Reset the SD card')
210 self.state = 'GET RESPONSE R1'
212 def handle_cmd1(self):
214 self.putc(1, 'Send HCS info and activate the card init process')
215 hcs = (self.arg & (1 << 30)) >> 30
216 self.bit_ss = self.cmd_token_bits[5 - 4][6][1]
217 self.bit_es = self.cmd_token_bits[5 - 4][6][2]
218 self.putb([70, ['HCS: %d' % hcs]])
219 self.state = 'GET RESPONSE R1'
221 def handle_cmd9(self):
222 # CMD9: SEND_CSD (128 bits / 16 bytes)
223 self.putc(9, 'Ask card to send its card specific data (CSD)')
224 if len(self.read_buf) == 0:
225 self.cmd_ss = self.ss
226 self.read_buf.append(self.miso)
228 ### if len(self.read_buf) < 16:
229 if len(self.read_buf) < 16 + 4:
231 self.cmd_es = self.es
232 self.read_buf = self.read_buf[4:] ### TODO: Document or redo.
233 self.putx([9, ['CSD: %s' % self.read_buf]])
234 # TODO: Decode all bits.
236 ### self.state = 'GET RESPONSE R1'
239 def handle_cmd10(self):
240 # CMD10: SEND_CID (128 bits / 16 bytes)
241 self.putc(10, 'Ask card to send its card identification (CID)')
242 self.read_buf.append(self.miso)
243 if len(self.read_buf) < 16:
245 self.putx([10, ['CID: %s' % self.read_buf]])
246 # TODO: Decode all bits.
248 self.state = 'GET RESPONSE R1'
250 def handle_cmd16(self):
251 # CMD16: SET_BLOCKLEN
252 self.blocklen = self.arg
253 # TODO: Sanity check on block length.
254 self.putc(16, 'Set the block length to %d bytes' % self.blocklen)
255 self.state = 'GET RESPONSE R1'
257 def handle_cmd17(self):
258 # CMD17: READ_SINGLE_BLOCK
259 self.putc(17, 'Read a block from address 0x%04x' % self.arg)
260 if len(self.read_buf) == 0:
261 self.cmd_ss = self.ss
262 self.read_buf.append(self.miso)
263 if len(self.read_buf) < self.blocklen + 2: # FIXME
265 self.cmd_es = self.es
266 self.read_buf = self.read_buf[2:] # FIXME
267 self.putx([17, ['Block data: %s' % self.read_buf]])
269 self.state = 'GET RESPONSE R1'
271 def handle_cmd41(self):
272 # ACMD41: SD_SEND_OP_COND
273 self.putc(41, 'Send HCS info and activate the card init process')
274 self.state = 'GET RESPONSE R1'
276 def handle_cmd49(self):
277 self.state = 'GET RESPONSE R1'
279 def handle_cmd55(self):
281 self.putc(55, 'Next command is an application-specific command')
283 self.state = 'GET RESPONSE R1'
285 def handle_cmd59(self):
287 crc_on_off = self.arg & (1 << 0)
288 s = 'on' if crc_on_off == 1 else 'off'
289 self.putc(59, 'Turn the SD card CRC option %s' % s)
290 self.state = 'GET RESPONSE R1'
292 def handle_cmd999(self):
293 self.state = 'GET RESPONSE R1'
295 def handle_cid_register(self):
296 # Card Identification (CID) register, 128bits
300 # Manufacturer ID: CID[127:120] (8 bits)
303 # OEM/Application ID: CID[119:104] (16 bits)
304 oid = (cid[14] << 8) | cid[13]
306 # Product name: CID[103:64] (40 bits)
308 for i in range(12, 8 - 1, -1):
312 # Product revision: CID[63:56] (8 bits)
315 # Product serial number: CID[55:24] (32 bits)
317 for i in range(6, 3 - 1, -1):
321 # RESERVED: CID[23:20] (4 bits)
323 # Manufacturing date: CID[19:8] (12 bits)
326 # CRC7 checksum: CID[7:1] (7 bits)
329 # Not used, always 1: CID[0:0] (1 bit)
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.
336 self.cmd_ss, self.cmd_es = self.miso_bits[7][1], self.miso_bits[0][2]
337 self.putx([65, ['R1: 0x%02x' % res]])
339 def putbit(bit, data):
340 b = self.miso_bits[bit]
341 self.bit_ss, self.bit_es = b[1], b[2]
342 self.putb([70, data])
344 # Bit 0: 'In idle state' bit
345 s = '' if (res & (1 << 0)) else 'not '
346 putbit(0, ['Card is %sin idle state' % s])
348 # Bit 1: 'Erase reset' bit
349 s = '' if (res & (1 << 1)) else 'not '
350 putbit(1, ['Erase sequence %scleared' % s])
352 # Bit 2: 'Illegal command' bit
353 s = 'I' if (res & (1 << 2)) else 'No i'
354 putbit(2, ['%sllegal command detected' % s])
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])
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])
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])
368 # Bit 6: 'Parameter error' bit
369 s = '' if (res & (1 << 4)) else 'not '
370 putbit(6, ['Command argument %soutside allowed range' % s])
372 # Bit 7: Always set to 0
373 putbit(7, ['Bit 7 (always 0)'])
377 def handle_response_r1b(self, res):
381 def handle_response_r2(self, res):
385 def handle_response_r3(self, res):
389 # Note: Response token formats R4 and R5 are reserved for SDIO.
393 def handle_response_r7(self, res):
397 def decode(self, ss, es, data):
398 ptype, mosi, miso = data
400 # For now, only use DATA and BITS packets.
401 if ptype not in ('DATA', 'BITS'):
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.
407 self.miso_bits, self.mosi_bits = miso, mosi
410 self.ss, self.es = ss, es
413 if self.state == 'IDLE':
414 # Ignore stray 0xff bytes, some devices seem to send those!?
415 if mosi == 0xff: # TODO?
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)
428 self.cmd_token_bits = []
429 elif self.state.startswith('GET RESPONSE'):
430 # Ignore stray 0xff bytes, some devices seem to send those!?
431 if miso == 0xff: # TODO?
434 # Call the respective handler method for the response.
435 s = 'handle_response_%s' % self.state[13:].lower()
436 handle_response = getattr(self, s)
437 handle_response(miso)
441 raise Exception('Invalid state: %s' % self.state)