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',
74 for i in range(63 + 1):
75 l.append(['cmd%d' % i, 'CMD%d' % i])
78 class Decoder(srd.Decoder):
81 name = 'SD card (SPI mode)'
82 longname = 'Secure Digital card (SPI mode)'
83 desc = 'Secure Digital card (SPI mode) low-level protocol.'
86 outputs = ['sdcard_spi']
90 annotations = ann_cmd_list() + [
91 ['cmd-desc', 'Command description'],
98 ['bit-warnings', 'Bit warnings'],
101 ('bits', 'Bits', (70, 71)),
102 ('cmd-reply', 'Commands/replies',
103 tuple(range(0, 63 + 1)) + tuple(range(65, 69 + 1))),
104 ('cmd-token', 'Command tokens', (64,)),
107 def __init__(self, **kwargs):
110 self.ss, self.es = 0, 0
111 self.bit_ss, self.bit_es = 0, 0
112 self.cmd_ss, self.cmd_es = 0, 0
114 self.cmd_token_bits = []
115 self.is_acmd = False # Indicates CMD vs. ACMD
121 # self.out_python = self.register(srd.OUTPUT_PYTHON)
122 self.out_ann = self.register(srd.OUTPUT_ANN)
124 def putx(self, data):
125 self.put(self.cmd_ss, self.cmd_es, self.out_ann, data)
127 def putc(self, cmd, desc):
128 self.putx([cmd, ['%s: %s' % (self.cmd_str, desc)]])
130 def putb(self, data):
131 self.put(self.bit_ss, self.bit_es, self.out_ann, data)
133 def handle_command_token(self, mosi, miso):
134 # Command tokens (6 bytes) are sent (MSB-first) by the host.
137 # - CMD[47:47]: Start bit (always 0)
138 # - CMD[46:46]: Transmitter bit (1 == host)
139 # - CMD[45:40]: Command index (BCD; valid: 0-63)
140 # - CMD[39:08]: Argument
142 # - CMD[00:00]: End bit (always 1)
144 if len(self.cmd_token) == 0:
145 self.cmd_ss = self.ss
147 self.cmd_token.append(mosi)
148 self.cmd_token_bits.append(self.mosi_bits)
150 # All command tokens are 6 bytes long.
151 if len(self.cmd_token) < 6:
154 self.cmd_es = self.es
159 s = 'ACMD' if self.is_acmd else 'CMD'
162 return self.cmd_token_bits[5 - byte][7 - bit]
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]
167 self.putb([70, ['Start bit: %d' % bit]])
169 self.putb([71, ['Start bit: %s (Warning: Must be 0!)' % bit]])
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]
174 self.putb([70, ['Transmitter bit: %d' % bit]])
176 self.putb([71, ['Transmitter bit: %d (Warning: Must be 1!)' % bit]])
178 # Bits[45:40]: Command index (BCD; valid: 0-63)
179 cmd = self.cmd_index = t[0] & 0x3f
180 self.bit_ss, self.bit_es = tb(5, 5)[1], tb(5, 0)[2]
181 self.putb([70, ['Command: %s%d (%s)' % (s, cmd, cmd_name[cmd])]])
183 # Bits[39:8]: Argument
184 self.arg = (t[1] << 24) | (t[2] << 16) | (t[3] << 8) | t[4]
185 self.bit_ss, self.bit_es = tb(4, 7)[1], tb(1, 0)[2]
186 self.putb([70, ['Argument: 0x%04x' % self.arg]])
191 self.bit_ss, self.bit_es = tb(0, 7)[1], tb(0, 1)[2]
192 self.putb([70, ['CRC7: 0x%01x' % crc]])
194 # Bits[0:0]: End bit (always 1)
195 bit, self.bit_ss, self.bit_es = tb(0, 0)[0], tb(0, 0)[1], tb(0, 0)[2]
196 self.putb([70, ['End bit: %d' % bit]])
198 self.putb([70, ['End bit: %d' % bit]])
200 self.putb([71, ['End bit: %d (Warning: Must be 1!)' % bit]])
203 if cmd in (0, 1, 9, 16, 17, 41, 49, 55, 59):
204 self.state = 'HANDLE CMD%d' % cmd
205 self.cmd_str = '%s%d (%s)' % (s, cmd, cmd_name[cmd])
207 self.state = 'HANDLE CMD999'
208 a = '%s%d: %02x %02x %02x %02x %02x %02x' % ((s, cmd) + tuple(t))
209 self.putx([cmd, [a]])
212 if self.is_acmd and cmd != 55:
215 def handle_cmd0(self):
216 # CMD0: GO_IDLE_STATE
217 self.putc(0, 'Reset the SD card')
218 self.state = 'GET RESPONSE R1'
220 def handle_cmd1(self):
222 self.putc(1, 'Send HCS info and activate the card init process')
223 hcs = (self.arg & (1 << 30)) >> 30
224 self.bit_ss = self.cmd_token_bits[5 - 4][7 - 6][1]
225 self.bit_es = self.cmd_token_bits[5 - 4][7 - 6][2]
226 self.putb([70, ['HCS: %d' % hcs]])
227 self.state = 'GET RESPONSE R1'
229 def handle_cmd9(self):
230 # CMD9: SEND_CSD (128 bits / 16 bytes)
231 self.putc(9, 'Ask card to send its card specific data (CSD)')
232 if len(self.read_buf) == 0:
233 self.cmd_ss = self.ss
234 self.read_buf.append(self.miso)
236 ### if len(self.read_buf) < 16:
237 if len(self.read_buf) < 16 + 4:
239 self.cmd_es = self.es
240 self.read_buf = self.read_buf[4:] ### TODO: Document or redo.
241 self.putx([9, ['CSD: %s' % self.read_buf]])
242 # TODO: Decode all bits.
244 ### self.state = 'GET RESPONSE R1'
247 def handle_cmd10(self):
248 # CMD10: SEND_CID (128 bits / 16 bytes)
249 self.putc(10, 'Ask card to send its card identification (CID)')
250 self.read_buf.append(self.miso)
251 if len(self.read_buf) < 16:
253 self.putx([10, ['CID: %s' % self.read_buf]])
254 # TODO: Decode all bits.
256 self.state = 'GET RESPONSE R1'
258 def handle_cmd16(self):
259 # CMD16: SET_BLOCKLEN
260 self.blocklen = self.arg
261 # TODO: Sanity check on block length.
262 self.putc(16, 'Set the block length to %d bytes' % self.blocklen)
263 self.state = 'GET RESPONSE R1'
265 def handle_cmd17(self):
266 # CMD17: READ_SINGLE_BLOCK
267 self.putc(17, 'Read a block from address 0x%04x' % self.arg)
268 if len(self.read_buf) == 0:
269 self.cmd_ss = self.ss
270 self.read_buf.append(self.miso)
271 if len(self.read_buf) < self.blocklen + 2: # FIXME
273 self.cmd_es = self.es
274 self.read_buf = self.read_buf[2:] # FIXME
275 self.putx([17, ['Block data: %s' % self.read_buf]])
277 self.state = 'GET RESPONSE R1'
279 def handle_cmd41(self):
280 # ACMD41: SD_SEND_OP_COND
281 self.putc(41, 'Send HCS info and activate the card init process')
282 self.state = 'GET RESPONSE R1'
284 def handle_cmd49(self):
285 self.state = 'GET RESPONSE R1'
287 def handle_cmd55(self):
289 self.putc(55, 'Next command is an application-specific command')
291 self.state = 'GET RESPONSE R1'
293 def handle_cmd59(self):
295 crc_on_off = self.arg & (1 << 0)
296 s = 'on' if crc_on_off == 1 else 'off'
297 self.putc(59, 'Turn the SD card CRC option %s' % s)
298 self.state = 'GET RESPONSE R1'
300 def handle_cmd999(self):
301 self.state = 'GET RESPONSE R1'
303 def handle_cid_register(self):
304 # Card Identification (CID) register, 128bits
308 # Manufacturer ID: CID[127:120] (8 bits)
311 # OEM/Application ID: CID[119:104] (16 bits)
312 oid = (cid[14] << 8) | cid[13]
314 # Product name: CID[103:64] (40 bits)
316 for i in range(12, 8 - 1, -1):
320 # Product revision: CID[63:56] (8 bits)
323 # Product serial number: CID[55:24] (32 bits)
325 for i in range(6, 3 - 1, -1):
329 # RESERVED: CID[23:20] (4 bits)
331 # Manufacturing date: CID[19:8] (12 bits)
334 # CRC7 checksum: CID[7:1] (7 bits)
337 # Not used, always 1: CID[0:0] (1 bit)
340 def handle_response_r1(self, res):
341 # The R1 response token format (1 byte).
342 # Sent by the card after every command except for SEND_STATUS.
344 self.cmd_ss, self.cmd_es = self.miso_bits[0][1], self.miso_bits[7][2]
345 self.putx([65, ['R1: 0x%02x' % res]])
347 def putbit(bit, data):
348 b = self.miso_bits[7 - bit]
349 self.bit_ss, self.bit_es = b[1], b[2]
350 self.putb([70, data])
352 # Bit 0: 'In idle state' bit
353 s = '' if (res & (1 << 0)) else 'not '
354 putbit(0, ['Card is %sin idle state' % s])
356 # Bit 1: 'Erase reset' bit
357 s = '' if (res & (1 << 1)) else 'not '
358 putbit(1, ['Erase sequence %scleared' % s])
360 # Bit 2: 'Illegal command' bit
361 s = 'I' if (res & (1 << 2)) else 'No i'
362 putbit(2, ['%sllegal command detected' % s])
364 # Bit 3: 'Communication CRC error' bit
365 s = 'failed' if (res & (1 << 3)) else 'was successful'
366 putbit(3, ['CRC check of last command %s' % s])
368 # Bit 4: 'Erase sequence error' bit
369 s = 'E' if (res & (1 << 4)) else 'No e'
370 putbit(4, ['%srror in the sequence of erase commands' % s])
372 # Bit 5: 'Address error' bit
373 s = 'M' if (res & (1 << 4)) else 'No m'
374 putbit(5, ['%sisaligned address used in command' % s])
376 # Bit 6: 'Parameter error' bit
377 s = '' if (res & (1 << 4)) else 'not '
378 putbit(6, ['Command argument %soutside allowed range' % s])
380 # Bit 7: Always set to 0
381 putbit(7, ['Bit 7 (always 0)'])
385 def handle_response_r1b(self, res):
389 def handle_response_r2(self, res):
393 def handle_response_r3(self, res):
397 # Note: Response token formats R4 and R5 are reserved for SDIO.
401 def handle_response_r7(self, res):
405 def decode(self, ss, es, data):
406 ptype, mosi, miso = data
408 # For now, only use DATA and BITS packets.
409 if ptype not in ('DATA', 'BITS'):
412 # Store the individual bit values and ss/es numbers. The next packet
413 # is guaranteed to be a 'DATA' packet belonging to this 'BITS' one.
415 self.miso_bits, self.mosi_bits = miso, mosi
418 self.ss, self.es = ss, es
421 if self.state == 'IDLE':
422 # Ignore stray 0xff bytes, some devices seem to send those!?
423 if mosi == 0xff: # TODO?
425 self.state = 'GET COMMAND TOKEN'
426 self.handle_command_token(mosi, miso)
427 elif self.state == 'GET COMMAND TOKEN':
428 self.handle_command_token(mosi, miso)
429 elif self.state.startswith('HANDLE CMD'):
430 self.miso, self.mosi = miso, mosi
431 # Call the respective handler method for the command.
432 s = 'handle_cmd%s' % self.state[10:].lower()
433 handle_cmd = getattr(self, s)
436 self.cmd_token_bits = []
437 elif self.state.startswith('GET RESPONSE'):
438 # Ignore stray 0xff bytes, some devices seem to send those!?
439 if miso == 0xff: # TODO?
442 # Call the respective handler method for the response.
443 s = 'handle_response_%s' % self.state[13:].lower()
444 handle_response = getattr(self, s)
445 handle_response(miso)
449 raise Exception('Invalid state: %s' % self.state)