2 ## This file is part of the libsigrokdecode project.
4 ## Copyright (C) 2015-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 SrdStrEnum
22 from common.sdcard import (cmd_names, acmd_names, accepted_voltages, card_status, sd_status)
24 s = ['GET_COMMAND_TOKEN', 'HANDLE_CMD999'] + \
25 ['HANDLE_CMD%d' % i for i in range(64)] + \
26 ['HANDLE_ACMD%d' % i for i in range(64)] + \
27 ['GET_RESPONSE_R%s' % r for r in ['1', '2', '3', '6', '7']]
28 St = SrdStrEnum.from_list('St', s)
30 class Decoder(srd.Decoder):
33 name = 'SD card (SD mode)'
34 longname = 'Secure Digital card (SD mode)'
35 desc = 'Secure Digital card (SD mode) low-level protocol.'
41 {'id': 'cmd', 'name': 'CMD', 'desc': 'Command'},
42 {'id': 'clk', 'name': 'CLK', 'desc': 'Clock'},
45 {'id': 'dat0', 'name': 'DAT0', 'desc': 'Data pin 0'},
46 {'id': 'dat1', 'name': 'DAT1', 'desc': 'Data pin 1'},
47 {'id': 'dat2', 'name': 'DAT2', 'desc': 'Data pin 2'},
48 {'id': 'dat3', 'name': 'DAT3', 'desc': 'Data pin 3'},
51 tuple(('cmd%d' % i, 'CMD%d' % i) for i in range(64)) + \
52 tuple(('acmd%d' % i, 'ACMD%d' % i) for i in range(64)) + ( \
54 ('field-start', 'Start bit'),
55 ('field-transmission', 'Transmission bit'),
56 ('field-cmd', 'Command'),
57 ('field-arg', 'Argument'),
59 ('field-end', 'End bit'),
60 ('decoded-bit', 'Decoded bit'),
61 ('decoded-field', 'Decoded field'),
64 ('raw-bits', 'Raw bits', (128,)),
65 ('decoded-bits', 'Decoded bits', (135,)),
66 ('decoded-fields', 'Decoded fields', (136,)),
67 ('fields', 'Fields', tuple(range(129, 135))),
68 ('commands', 'Commands', tuple(range(128))),
75 self.state = St.GET_COMMAND_TOKEN
77 self.is_acmd = False # Indicates CMD vs. ACMD
83 self.out_ann = self.register(srd.OUTPUT_ANN)
85 def putbit(self, b, data):
86 self.put(self.token[b][0], self.token[b][1], self.out_ann, [135, data])
89 self.put(self.token[0][0], self.token[47][1], self.out_ann, data)
91 def putf(self, s, e, data):
92 self.put(self.token[s][0], self.token[e][1], self.out_ann, data)
94 def puta(self, s, e, data):
95 self.put(self.token[47 - 8 - e][0], self.token[47 - 8 - s][1],
98 def putc(self, cmd, desc):
100 self.putt([cmd, ['%s: %s' % (self.cmd_str, desc), self.cmd_str,
101 self.cmd_str.split(' ')[0]]])
103 def putr(self, desc):
104 self.putt([self.last_cmd, ['Reply: %s' % desc]])
106 def cmd_name(self, cmd):
107 c = acmd_names if self.is_acmd else cmd_names
108 return c.get(cmd, 'Unknown')
110 def get_token_bits(self, cmd, n):
111 # Get a bit, return True if we already got 'n' bits, False otherwise.
112 self.token.append([self.samplenum, self.samplenum, cmd])
113 if len(self.token) > 0:
114 self.token[len(self.token) - 2][1] = self.samplenum
115 if len(self.token) < n:
117 self.token[n - 1][1] += self.token[n - 1][0] - self.token[n - 2][0]
120 def handle_common_token_fields(self):
123 # Annotations for each individual bit.
124 for bit in range(len(self.token)):
125 self.putf(bit, bit, [128, ['%d' % s[bit][2]]])
127 # CMD[47:47]: Start bit (always 0)
128 self.putf(0, 0, [129, ['Start bit', 'Start', 'S']])
130 # CMD[46:46]: Transmission bit (1 == host)
131 t = 'host' if s[1][2] == 1 else 'card'
132 self.putf(1, 1, [130, ['Transmission: ' + t, 'T: ' + t, 'T']])
134 # CMD[45:40]: Command index (BCD; valid: 0-63)
135 self.cmd = int('0b' + ''.join([str(s[i][2]) for i in range(2, 8)]), 2)
136 c = '%s (%d)' % (self.cmd_name(self.cmd), self.cmd)
137 self.putf(2, 7, [131, ['Command: ' + c, 'Cmd: ' + c,
138 'CMD%d' % self.cmd, 'Cmd', 'C']])
140 # CMD[39:08]: Argument
141 self.arg = int('0b' + ''.join([str(s[i][2]) for i in range(8, 40)]), 2)
142 self.putf(8, 39, [132, ['Argument: 0x%08x' % self.arg, 'Arg', 'A']])
145 self.crc = int('0b' + ''.join([str(s[i][2]) for i in range(40, 47)]), 2)
146 self.putf(40, 46, [133, ['CRC: 0x%x' % self.crc, 'CRC', 'C']])
148 # CMD[00:00]: End bit (always 1)
149 self.putf(47, 47, [134, ['End bit', 'End', 'E']])
151 def get_command_token(self, cmd):
152 # Command tokens (48 bits) are sent serially (MSB-first) by the host
153 # (over the CMD line), either to one SD card or to multiple ones.
156 # - Bits[47:47]: Start bit (always 0)
157 # - Bits[46:46]: Transmission bit (1 == host)
158 # - Bits[45:40]: Command index (BCD; valid: 0-63)
159 # - Bits[39:08]: Argument
160 # - Bits[07:01]: CRC7
161 # - Bits[00:00]: End bit (always 1)
163 if not self.get_token_bits(cmd, 48):
166 self.handle_common_token_fields()
169 s = 'ACMD' if self.is_acmd else 'CMD'
170 self.cmd_str = '%s%d (%s)' % (s, self.cmd, self.cmd_name(self.cmd))
171 if self.cmd in (0, 2, 3, 6, 7, 8, 9, 10, 13, 41, 51, 55):
172 self.state = St['HANDLE_CMD%d' % self.cmd]
174 self.state = St.HANDLE_CMD999
175 self.putc(self.cmd, '%s%d' % (s, self.cmd))
177 def handle_cmd0(self):
178 # CMD0 (GO_IDLE_STATE) -> no response
179 self.puta(0, 31, [136, ['Stuff bits', 'Stuff', 'SB', 'S']])
180 self.putc(0, 'Reset all SD cards')
181 self.token, self.state = [], St.GET_COMMAND_TOKEN
183 def handle_cmd2(self):
184 # CMD2 (ALL_SEND_CID) -> R2
185 self.puta(0, 31, [136, ['Stuff bits', 'Stuff', 'SB', 'S']])
186 self.putc(2, 'Ask card for CID number')
187 self.token, self.state = [], St.GET_RESPONSE_R2
189 def handle_cmd3(self):
190 # CMD3 (SEND_RELATIVE_ADDR) -> R6
191 self.puta(0, 31, [136, ['Stuff bits', 'Stuff', 'SB', 'S']])
192 self.putc(3, 'Ask card for new relative card address (RCA)')
193 self.token, self.state = [], St.GET_RESPONSE_R6
195 def handle_cmd6(self):
196 # CMD6 (SWITCH_FUNC) -> R1
197 self.putc(6, 'Switch/check card function')
198 self.token, self.state = [], St.GET_RESPONSE_R1
200 def handle_cmd7(self):
201 # CMD7 (SELECT/DESELECT_CARD) -> R1b
202 self.putc(7, 'Select / deselect card')
203 self.token, self.state = [], St.GET_RESPONSE_R6
205 def handle_cmd8(self):
206 # CMD8 (SEND_IF_COND) -> R7
207 self.puta(12, 31, [136, ['Reserved', 'Res', 'R']])
208 self.puta(8, 11, [136, ['Supply voltage', 'Voltage', 'VHS', 'V']])
209 self.puta(0, 7, [136, ['Check pattern', 'Check pat', 'Check', 'C']])
210 self.putc(8, 'Send interface condition to card')
211 self.token, self.state = [], St.GET_RESPONSE_R7
212 # TODO: Handle case when card doesn't reply with R7 (no reply at all).
214 def handle_cmd9(self):
215 # CMD9 (SEND_CSD) -> R2
216 self.puta(16, 31, [136, ['RCA', 'R']])
217 self.puta(0, 15, [136, ['Stuff bits', 'Stuff', 'SB', 'S']])
218 self.putc(9, 'Send card-specific data (CSD)')
219 self.token, self.state = [], St.GET_RESPONSE_R2
221 def handle_cmd10(self):
222 # CMD10 (SEND_CID) -> R2
223 self.puta(16, 31, [136, ['RCA', 'R']])
224 self.puta(0, 15, [136, ['Stuff bits', 'Stuff', 'SB', 'S']])
225 self.putc(9, 'Send card identification data (CID)')
226 self.token, self.state = [], St.GET_RESPONSE_R2
228 def handle_cmd13(self):
229 # CMD13 (SEND_STATUS) -> R1
230 self.puta(16, 31, [136, ['RCA', 'R']])
231 self.puta(0, 15, [136, ['Stuff bits', 'Stuff', 'SB', 'S']])
232 self.putc(13, 'Send card status register')
233 self.token, self.state = [], St.GET_RESPONSE_R1
235 def handle_cmd16(self):
236 # CMD16 (SET_BLOCKLEN) -> R1
237 self.puta(0, 31, [136, ['Block length', 'Blocklen', 'BL', 'B']])
238 self.putc(16, 'Set the block length to %d bytes' % self.arg)
239 self.token, self.state = [], St.GET_RESPONSE_R1
241 def handle_cmd55(self):
242 # CMD55 (APP_CMD) -> R1
243 self.puta(16, 31, [136, ['RCA', 'R']])
244 self.puta(0, 15, [136, ['Stuff bits', 'Stuff', 'SB', 'S']])
245 self.putc(55, 'Next command is an application-specific command')
247 self.token, self.state = [], St.GET_RESPONSE_R1
249 def handle_acmd6(self):
250 # ACMD6 (SET_BUS_WIDTH) -> R1
251 self.putc(64 + 6, 'Read SD config register (SCR)')
252 self.token, self.state = [], St.GET_RESPONSE_R1
254 def handle_acmd13(self):
255 # ACMD13 (SD_STATUS) -> R1
256 self.puta(0, 31, [136, ['Stuff bits', 'Stuff', 'SB', 'S']])
257 self.putc(64 + 13, 'Set SD status')
258 self.token, self.state = [], St.GET_RESPONSE_R1
260 def handle_acmd41(self):
261 # ACMD41 (SD_SEND_OP_COND) -> R3
262 self.puta(0, 23, [136, ['VDD voltage window', 'VDD volt', 'VDD', 'V']])
263 self.puta(24, 24, [136, ['S18R']])
264 self.puta(25, 27, [136, ['Reserved', 'Res', 'R']])
265 self.puta(28, 28, [136, ['XPC']])
266 self.puta(29, 29, [136, ['Reserved for eSD', 'Reserved', 'Res', 'R']])
267 self.puta(30, 30, [136, ['Host capacity support info', 'Host capacity',
269 self.puta(31, 31, [136, ['Reserved', 'Res', 'R']])
270 self.putc(64 + 41, 'Send HCS info and activate the card init process')
271 self.token, self.state = [], St.GET_RESPONSE_R3
273 def handle_acmd51(self):
274 # ACMD51 (SEND_SCR) -> R1
275 self.putc(64 + 51, 'Read SD config register (SCR)')
276 self.token, self.state = [], St.GET_RESPONSE_R1
278 def handle_cmd999(self):
279 self.token, self.state = [], St.GET_RESPONSE_R1
281 def handle_acmd999(self):
282 self.token, self.state = [], St.GET_RESPONSE_R1
284 # Response tokens can have one of four formats (depends on content).
285 # They can have a total length of 48 or 136 bits.
286 # They're sent serially (MSB-first) by the card that the host
287 # addressed previously, or (synchronously) by all connected cards.
289 def handle_response_r1(self, cmd):
290 # R1: Normal response command
291 # - Bits[47:47]: Start bit (always 0)
292 # - Bits[46:46]: Transmission bit (0 == card)
293 # - Bits[45:40]: Command index (BCD; valid: 0-63)
294 # - Bits[39:08]: Card status
295 # - Bits[07:01]: CRC7
296 # - Bits[00:00]: End bit (always 1)
297 if not self.get_token_bits(cmd, 48):
299 self.handle_common_token_fields()
301 self.puta(0, 31, [136, ['Card status', 'Status', 'S']])
303 self.putbit(8 + i, [card_status[31 - i]])
304 self.token, self.state = [], St.GET_COMMAND_TOKEN
306 def handle_response_r1b(self, cmd):
307 # R1b: Same as R1 with an optional busy signal (on the data line)
308 if not self.get_token_bits(cmd, 48):
310 self.handle_common_token_fields()
311 self.puta(0, 31, [136, ['Card status', 'Status', 'S']])
313 self.token, self.state = [], St.GET_COMMAND_TOKEN
315 def handle_response_r2(self, cmd):
316 # R2: CID/CSD register
317 # - Bits[135:135]: Start bit (always 0)
318 # - Bits[134:134]: Transmission bit (0 == card)
319 # - Bits[133:128]: Reserved (always 0b111111)
320 # - Bits[127:001]: CID or CSD register including internal CRC7
321 # - Bits[000:000]: End bit (always 1)
322 if not self.get_token_bits(cmd, 136):
324 # Annotations for each individual bit.
325 for bit in range(len(self.token)):
326 self.putf(bit, bit, [128, ['%d' % self.token[bit][2]]])
327 self.putf(0, 0, [129, ['Start bit', 'Start', 'S']])
328 t = 'host' if self.token[1][2] == 1 else 'card'
329 self.putf(1, 1, [130, ['Transmission: ' + t, 'T: ' + t, 'T']])
330 self.putf(2, 7, [131, ['Reserved', 'Res', 'R']])
331 self.putf(8, 134, [132, ['Argument', 'Arg', 'A']])
332 self.putf(135, 135, [134, ['End bit', 'End', 'E']])
333 self.putf(8, 134, [136, ['CID/CSD register', 'CID/CSD', 'C']])
334 self.putf(0, 135, [55, ['R2']])
335 self.token, self.state = [], St.GET_COMMAND_TOKEN
337 def handle_response_r3(self, cmd):
339 # - Bits[47:47]: Start bit (always 0)
340 # - Bits[46:46]: Transmission bit (0 == card)
341 # - Bits[45:40]: Reserved (always 0b111111)
342 # - Bits[39:08]: OCR register
343 # - Bits[07:01]: Reserved (always 0b111111)
344 # - Bits[00:00]: End bit (always 1)
345 if not self.get_token_bits(cmd, 48):
348 # Annotations for each individual bit.
349 for bit in range(len(self.token)):
350 self.putf(bit, bit, [128, ['%d' % self.token[bit][2]]])
351 self.putf(0, 0, [129, ['Start bit', 'Start', 'S']])
352 t = 'host' if self.token[1][2] == 1 else 'card'
353 self.putf(1, 1, [130, ['Transmission: ' + t, 'T: ' + t, 'T']])
354 self.putf(2, 7, [131, ['Reserved', 'Res', 'R']])
355 self.putf(8, 39, [132, ['Argument', 'Arg', 'A']])
356 self.putf(40, 46, [133, ['Reserved', 'Res', 'R']])
357 self.putf(47, 47, [134, ['End bit', 'End', 'E']])
358 self.puta(0, 31, [136, ['OCR register', 'OCR reg', 'OCR', 'O']])
359 self.token, self.state = [], St.GET_COMMAND_TOKEN
361 def handle_response_r6(self, cmd):
362 # R6: Published RCA response
363 # - Bits[47:47]: Start bit (always 0)
364 # - Bits[46:46]: Transmission bit (0 == card)
365 # - Bits[45:40]: Command index (always 0b000011)
366 # - Bits[39:24]: Argument[31:16]: New published RCA of the card
367 # - Bits[23:08]: Argument[15:0]: Card status bits
368 # - Bits[07:01]: CRC7
369 # - Bits[00:00]: End bit (always 1)
370 if not self.get_token_bits(cmd, 48):
372 self.handle_common_token_fields()
373 self.puta(0, 15, [136, ['Card status bits', 'Status', 'S']])
374 self.puta(16, 31, [136, ['Relative card address', 'RCA', 'R']])
376 self.token, self.state = [], St.GET_COMMAND_TOKEN
378 def handle_response_r7(self, cmd):
379 # R7: Card interface condition
380 # - Bits[47:47]: Start bit (always 0)
381 # - Bits[46:46]: Transmission bit (0 == card)
382 # - Bits[45:40]: Command index (always 0b001000)
383 # - Bits[39:20]: Reserved bits (all-zero)
384 # - Bits[19:16]: Voltage accepted
385 # - Bits[15:08]: Echo-back of check pattern
386 # - Bits[07:01]: CRC7
387 # - Bits[00:00]: End bit (always 1)
388 if not self.get_token_bits(cmd, 48):
390 self.handle_common_token_fields()
394 # Arg[31:12]: Reserved bits (all-zero)
395 self.puta(12, 31, [136, ['Reserved', 'Res', 'R']])
397 # Arg[11:08]: Voltage accepted
398 v = ''.join(str(i[2]) for i in self.token[28:32])
399 av = accepted_voltages.get(int('0b' + v, 2), 'Unknown')
400 self.puta(8, 11, [136, ['Voltage accepted: ' + av, 'Voltage', 'Volt', 'V']])
402 # Arg[07:00]: Echo-back of check pattern
403 self.puta(0, 7, [136, ['Echo-back of check pattern', 'Echo', 'E']])
405 self.token, self.state = [], St.GET_COMMAND_TOKEN
409 # Wait for a rising CLK edge.
410 (cmd, clk, dat0, dat1, dat2, dat3) = self.wait({1: 'r'})
413 if self.state == St.GET_COMMAND_TOKEN:
414 if len(self.token) == 0:
415 # Wait for start bit (CMD = 0).
418 self.get_command_token(cmd)
419 elif self.state.value.startswith('HANDLE_CMD'):
420 # Call the respective handler method for the command.
421 a, cmdstr = 'a' if self.is_acmd else '', self.state.value[10:].lower()
422 handle_cmd = getattr(self, 'handle_%scmd%s' % (a, cmdstr))
424 # Leave ACMD mode again after the first command after CMD55.
425 if self.is_acmd and cmdstr not in ('55', '63'):
427 elif self.state.value.startswith('GET_RESPONSE'):
428 if len(self.token) == 0:
429 # Wait for start bit (CMD = 0).
432 # Call the respective handler method for the response.
433 s = 'handle_response_%s' % self.state.value[13:].lower()
434 handle_response = getattr(self, s)