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