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