]>
Commit | Line | Data |
---|---|---|
47ec18f5 | 1 | ## |
50bd5d25 | 2 | ## This file is part of the libsigrokdecode project. |
47ec18f5 | 3 | ## |
f3297f98 | 4 | ## Copyright (C) 2012-2020 Uwe Hermann <uwe@hermann-uwe.de> |
47ec18f5 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/>. |
47ec18f5 UH |
18 | ## |
19 | ||
47ec18f5 | 20 | import sigrokdecode as srd |
f3297f98 | 21 | from common.srdhelper import SrdIntEnum |
135b790c | 22 | from common.sdcard import (cmd_names, acmd_names) |
47ec18f5 | 23 | |
f3297f98 UH |
24 | responses = '1 1b 2 3 7'.split() |
25 | ||
26 | a = ['CMD%d' % i for i in range(64)] + ['ACMD%d' % i for i in range(64)] + \ | |
27 | ['R' + r.upper() for r in responses] + ['BIT', 'BIT_WARNING'] | |
28 | Ann = SrdIntEnum.from_list('Ann', a) | |
29 | ||
47ec18f5 | 30 | class Decoder(srd.Decoder): |
b197383c | 31 | api_version = 3 |
47ec18f5 UH |
32 | id = 'sdcard_spi' |
33 | name = 'SD card (SPI mode)' | |
34 | longname = 'Secure Digital card (SPI mode)' | |
35 | desc = 'Secure Digital card (SPI mode) low-level protocol.' | |
36 | license = 'gplv2+' | |
37 | inputs = ['spi'] | |
6cbba91f | 38 | outputs = [] |
d6d8a8a4 | 39 | tags = ['Memory'] |
ce71bf0e UH |
40 | annotations = \ |
41 | tuple(('cmd%d' % i, 'CMD%d' % i) for i in range(64)) + \ | |
f3297f98 UH |
42 | tuple(('acmd%d' % i, 'ACMD%d' % i) for i in range(64)) + \ |
43 | tuple(('r%s' % r, 'R%s response' % r) for r in responses) + ( \ | |
e144452b UH |
44 | ('bit', 'Bit'), |
45 | ('bit-warning', 'Bit warning'), | |
da9bcbd9 | 46 | ) |
86f68514 | 47 | annotation_rows = ( |
f3297f98 UH |
48 | ('bits', 'Bits', (Ann.BIT, Ann.BIT_WARNING)), |
49 | ('commands-replies', 'Commands/replies', Ann.prefixes('CMD ACMD R')), | |
86f68514 | 50 | ) |
47ec18f5 | 51 | |
92b7b49f | 52 | def __init__(self): |
10aeb8ea GS |
53 | self.reset() |
54 | ||
55 | def reset(self): | |
47ec18f5 | 56 | self.state = 'IDLE' |
1b3109bc | 57 | self.ss, self.es = 0, 0 |
486b19ce UH |
58 | self.ss_bit, self.es_bit = 0, 0 |
59 | self.ss_cmd, self.es_cmd = 0, 0 | |
1c308e3d | 60 | self.ss_busy, self.es_busy = 0, 0 |
47ec18f5 | 61 | self.cmd_token = [] |
d4ad1cb4 | 62 | self.cmd_token_bits = [] |
47ec18f5 UH |
63 | self.is_acmd = False # Indicates CMD vs. ACMD |
64 | self.blocklen = 0 | |
65 | self.read_buf = [] | |
d780f007 | 66 | self.cmd_str = '' |
8f769505 | 67 | self.is_cmd24 = False |
984e3e3d | 68 | self.cmd24_start_token_found = False |
a66fbd85 PP |
69 | self.is_cmd17 = False |
70 | self.cmd17_start_token_found = False | |
1c308e3d | 71 | self.busy_first_byte = False |
47ec18f5 | 72 | |
8915b346 | 73 | def start(self): |
be465111 | 74 | self.out_ann = self.register(srd.OUTPUT_ANN) |
47ec18f5 | 75 | |
47ec18f5 | 76 | def putx(self, data): |
486b19ce | 77 | self.put(self.ss_cmd, self.es_cmd, self.out_ann, data) |
47ec18f5 | 78 | |
d780f007 UH |
79 | def putc(self, cmd, desc): |
80 | self.putx([cmd, ['%s: %s' % (self.cmd_str, desc)]]) | |
81 | ||
1b3109bc | 82 | def putb(self, data): |
486b19ce | 83 | self.put(self.ss_bit, self.es_bit, self.out_ann, data) |
1b3109bc | 84 | |
ce71bf0e UH |
85 | def cmd_name(self, cmd): |
86 | c = acmd_names if self.is_acmd else cmd_names | |
ada4c3a3 UH |
87 | s = c.get(cmd, 'Unknown') |
88 | # SD mode names for CMD32/33: ERASE_WR_BLK_{START,END}. | |
89 | # SPI mode names for CMD32/33: ERASE_WR_BLK_{START,END}_ADDR. | |
90 | if cmd in (32, 33): | |
91 | s += '_ADDR' | |
92 | return s | |
ce71bf0e | 93 | |
47ec18f5 UH |
94 | def handle_command_token(self, mosi, miso): |
95 | # Command tokens (6 bytes) are sent (MSB-first) by the host. | |
96 | # | |
97 | # Format: | |
98 | # - CMD[47:47]: Start bit (always 0) | |
99 | # - CMD[46:46]: Transmitter bit (1 == host) | |
100 | # - CMD[45:40]: Command index (BCD; valid: 0-63) | |
101 | # - CMD[39:08]: Argument | |
102 | # - CMD[07:01]: CRC7 | |
103 | # - CMD[00:00]: End bit (always 1) | |
104 | ||
1b3109bc | 105 | if len(self.cmd_token) == 0: |
486b19ce | 106 | self.ss_cmd = self.ss |
1b3109bc | 107 | |
47ec18f5 | 108 | self.cmd_token.append(mosi) |
d4ad1cb4 | 109 | self.cmd_token_bits.append(self.mosi_bits) |
47ec18f5 UH |
110 | |
111 | # All command tokens are 6 bytes long. | |
112 | if len(self.cmd_token) < 6: | |
113 | return | |
114 | ||
486b19ce | 115 | self.es_cmd = self.es |
1b3109bc | 116 | |
47ec18f5 UH |
117 | t = self.cmd_token |
118 | ||
119 | # CMD or ACMD? | |
120 | s = 'ACMD' if self.is_acmd else 'CMD' | |
47ec18f5 | 121 | |
d4ad1cb4 | 122 | def tb(byte, bit): |
c82620fc | 123 | return self.cmd_token_bits[5 - byte][bit] |
d4ad1cb4 UH |
124 | |
125 | # Bits[47:47]: Start bit (always 0) | |
486b19ce | 126 | bit, self.ss_bit, self.es_bit = tb(5, 7)[0], tb(5, 7)[1], tb(5, 7)[2] |
21e7a67e | 127 | if bit == 0: |
f3297f98 | 128 | self.putb([Ann.BIT, ['Start bit: %d' % bit]]) |
21e7a67e | 129 | else: |
f3297f98 | 130 | self.putb([Ann.BIT_WARNING, ['Start bit: %s (Warning: Must be 0!)' % bit]]) |
47ec18f5 | 131 | |
d4ad1cb4 | 132 | # Bits[46:46]: Transmitter bit (1 == host) |
486b19ce | 133 | bit, self.ss_bit, self.es_bit = tb(5, 6)[0], tb(5, 6)[1], tb(5, 6)[2] |
21e7a67e | 134 | if bit == 1: |
f3297f98 | 135 | self.putb([Ann.BIT, ['Transmitter bit: %d' % bit]]) |
21e7a67e | 136 | else: |
f3297f98 | 137 | self.putb([Ann.BIT_WARNING, ['Transmitter bit: %d (Warning: Must be 1!)' % bit]]) |
47ec18f5 | 138 | |
d4ad1cb4 | 139 | # Bits[45:40]: Command index (BCD; valid: 0-63) |
49176fec | 140 | cmd = self.cmd_index = t[0] & 0x3f |
486b19ce | 141 | self.ss_bit, self.es_bit = tb(5, 5)[1], tb(5, 0)[2] |
f3297f98 | 142 | self.putb([Ann.BIT, ['Command: %s%d (%s)' % (s, cmd, self.cmd_name(cmd))]]) |
47ec18f5 | 143 | |
d4ad1cb4 | 144 | # Bits[39:8]: Argument |
47ec18f5 | 145 | self.arg = (t[1] << 24) | (t[2] << 16) | (t[3] << 8) | t[4] |
486b19ce | 146 | self.ss_bit, self.es_bit = tb(4, 7)[1], tb(1, 0)[2] |
f3297f98 | 147 | self.putb([Ann.BIT, ['Argument: 0x%04x' % self.arg]]) |
47ec18f5 | 148 | |
0b5fc074 UH |
149 | # Bits[7:1]: CRC7 |
150 | # TODO: Check CRC7. | |
d4ad1cb4 | 151 | crc = t[5] >> 1 |
486b19ce | 152 | self.ss_bit, self.es_bit = tb(0, 7)[1], tb(0, 1)[2] |
f3297f98 | 153 | self.putb([Ann.BIT, ['CRC7: 0x%01x' % crc]]) |
d4ad1cb4 UH |
154 | |
155 | # Bits[0:0]: End bit (always 1) | |
486b19ce | 156 | bit, self.ss_bit, self.es_bit = tb(0, 0)[0], tb(0, 0)[1], tb(0, 0)[2] |
21e7a67e | 157 | if bit == 1: |
f3297f98 | 158 | self.putb([Ann.BIT, ['End bit: %d' % bit]]) |
21e7a67e | 159 | else: |
f3297f98 | 160 | self.putb([Ann.BIT_WARNING, ['End bit: %d (Warning: Must be 1!)' % bit]]) |
47ec18f5 UH |
161 | |
162 | # Handle command. | |
8f769505 | 163 | if cmd in (0, 1, 9, 16, 17, 24, 41, 49, 55, 59): |
47ec18f5 | 164 | self.state = 'HANDLE CMD%d' % cmd |
ce71bf0e | 165 | self.cmd_str = '%s%d (%s)' % (s, cmd, self.cmd_name(cmd)) |
0b5fc074 UH |
166 | else: |
167 | self.state = 'HANDLE CMD999' | |
168 | a = '%s%d: %02x %02x %02x %02x %02x %02x' % ((s, cmd) + tuple(t)) | |
d780f007 | 169 | self.putx([cmd, [a]]) |
47ec18f5 | 170 | |
d780f007 | 171 | def handle_cmd0(self): |
47ec18f5 | 172 | # CMD0: GO_IDLE_STATE |
f3297f98 | 173 | self.putc(Ann.CMD0, 'Reset the SD card') |
47ec18f5 UH |
174 | self.state = 'GET RESPONSE R1' |
175 | ||
176 | def handle_cmd1(self): | |
177 | # CMD1: SEND_OP_COND | |
f3297f98 | 178 | self.putc(Ann.CMD1, 'Send HCS info and activate the card init process') |
47ec18f5 | 179 | hcs = (self.arg & (1 << 30)) >> 30 |
486b19ce UH |
180 | self.ss_bit = self.cmd_token_bits[5 - 4][6][1] |
181 | self.es_bit = self.cmd_token_bits[5 - 4][6][2] | |
f3297f98 | 182 | self.putb([Ann.BIT, ['HCS: %d' % hcs]]) |
47ec18f5 UH |
183 | self.state = 'GET RESPONSE R1' |
184 | ||
185 | def handle_cmd9(self): | |
186 | # CMD9: SEND_CSD (128 bits / 16 bytes) | |
f3297f98 | 187 | self.putc(Ann.CMD9, 'Ask card to send its card specific data (CSD)') |
1b3109bc | 188 | if len(self.read_buf) == 0: |
486b19ce | 189 | self.ss_cmd = self.ss |
47ec18f5 UH |
190 | self.read_buf.append(self.miso) |
191 | # FIXME | |
192 | ### if len(self.read_buf) < 16: | |
193 | if len(self.read_buf) < 16 + 4: | |
194 | return | |
486b19ce | 195 | self.es_cmd = self.es |
35b380b1 | 196 | self.read_buf = self.read_buf[4:] # TODO: Document or redo. |
f3297f98 | 197 | self.putx([Ann.CMD9, ['CSD: %s' % self.read_buf]]) |
47ec18f5 UH |
198 | # TODO: Decode all bits. |
199 | self.read_buf = [] | |
200 | ### self.state = 'GET RESPONSE R1' | |
201 | self.state = 'IDLE' | |
202 | ||
203 | def handle_cmd10(self): | |
204 | # CMD10: SEND_CID (128 bits / 16 bytes) | |
f3297f98 | 205 | self.putc(Ann.CMD10, 'Ask card to send its card identification (CID)') |
47ec18f5 UH |
206 | self.read_buf.append(self.miso) |
207 | if len(self.read_buf) < 16: | |
208 | return | |
f3297f98 | 209 | self.putx([Ann.CMD10, ['CID: %s' % self.read_buf]]) |
47ec18f5 UH |
210 | # TODO: Decode all bits. |
211 | self.read_buf = [] | |
212 | self.state = 'GET RESPONSE R1' | |
213 | ||
214 | def handle_cmd16(self): | |
215 | # CMD16: SET_BLOCKLEN | |
0b5fc074 | 216 | self.blocklen = self.arg |
47ec18f5 | 217 | # TODO: Sanity check on block length. |
f3297f98 | 218 | self.putc(Ann.CMD16, 'Set the block length to %d bytes' % self.blocklen) |
47ec18f5 UH |
219 | self.state = 'GET RESPONSE R1' |
220 | ||
221 | def handle_cmd17(self): | |
222 | # CMD17: READ_SINGLE_BLOCK | |
f3297f98 | 223 | self.putc(Ann.CMD17, 'Read a block from address 0x%04x' % self.arg) |
a66fbd85 | 224 | self.is_cmd17 = True |
47ec18f5 UH |
225 | self.state = 'GET RESPONSE R1' |
226 | ||
8f769505 | 227 | def handle_cmd24(self): |
dab5420e | 228 | # CMD24: WRITE_BLOCK |
f3297f98 | 229 | self.putc(Ann.CMD24, 'Write a block to address 0x%04x' % self.arg) |
984e3e3d | 230 | self.is_cmd24 = True |
8f769505 PP |
231 | self.state = 'GET RESPONSE R1' |
232 | ||
47ec18f5 UH |
233 | def handle_cmd49(self): |
234 | self.state = 'GET RESPONSE R1' | |
235 | ||
236 | def handle_cmd55(self): | |
237 | # CMD55: APP_CMD | |
f3297f98 | 238 | self.putc(Ann.CMD55, 'Next command is an application-specific command') |
47ec18f5 UH |
239 | self.is_acmd = True |
240 | self.state = 'GET RESPONSE R1' | |
241 | ||
242 | def handle_cmd59(self): | |
243 | # CMD59: CRC_ON_OFF | |
244 | crc_on_off = self.arg & (1 << 0) | |
245 | s = 'on' if crc_on_off == 1 else 'off' | |
f3297f98 | 246 | self.putc(Ann.CMD59, 'Turn the SD card CRC option %s' % s) |
0b5fc074 UH |
247 | self.state = 'GET RESPONSE R1' |
248 | ||
ce71bf0e UH |
249 | def handle_acmd41(self): |
250 | # ACMD41: SD_SEND_OP_COND | |
f3297f98 | 251 | self.putc(Ann.ACMD41, 'Send HCS info and activate the card init process') |
ce71bf0e UH |
252 | self.state = 'GET RESPONSE R1' |
253 | ||
0b5fc074 | 254 | def handle_cmd999(self): |
47ec18f5 UH |
255 | self.state = 'GET RESPONSE R1' |
256 | ||
257 | def handle_cid_register(self): | |
258 | # Card Identification (CID) register, 128bits | |
259 | ||
260 | cid = self.cid | |
261 | ||
262 | # Manufacturer ID: CID[127:120] (8 bits) | |
263 | mid = cid[15] | |
264 | ||
265 | # OEM/Application ID: CID[119:104] (16 bits) | |
266 | oid = (cid[14] << 8) | cid[13] | |
267 | ||
268 | # Product name: CID[103:64] (40 bits) | |
269 | pnm = 0 | |
270 | for i in range(12, 8 - 1, -1): | |
271 | pnm <<= 8 | |
272 | pnm |= cid[i] | |
273 | ||
274 | # Product revision: CID[63:56] (8 bits) | |
275 | prv = cid[7] | |
276 | ||
277 | # Product serial number: CID[55:24] (32 bits) | |
278 | psn = 0 | |
279 | for i in range(6, 3 - 1, -1): | |
280 | psn <<= 8 | |
281 | psn |= cid[i] | |
282 | ||
283 | # RESERVED: CID[23:20] (4 bits) | |
284 | ||
285 | # Manufacturing date: CID[19:8] (12 bits) | |
286 | # TODO | |
287 | ||
288 | # CRC7 checksum: CID[7:1] (7 bits) | |
289 | # TODO | |
290 | ||
291 | # Not used, always 1: CID[0:0] (1 bit) | |
292 | # TODO | |
293 | ||
294 | def handle_response_r1(self, res): | |
295 | # The R1 response token format (1 byte). | |
296 | # Sent by the card after every command except for SEND_STATUS. | |
297 | ||
486b19ce | 298 | self.ss_cmd, self.es_cmd = self.miso_bits[7][1], self.miso_bits[0][2] |
f3297f98 | 299 | self.putx([Ann.R1, ['R1: 0x%02x' % res]]) |
47ec18f5 | 300 | |
a74855de | 301 | def putbit(bit, data): |
c82620fc | 302 | b = self.miso_bits[bit] |
486b19ce | 303 | self.ss_bit, self.es_bit = b[1], b[2] |
f3297f98 | 304 | self.putb([Ann.BIT, data]) |
47ec18f5 | 305 | |
a74855de | 306 | # Bit 0: 'In idle state' bit |
47ec18f5 | 307 | s = '' if (res & (1 << 0)) else 'not ' |
a74855de | 308 | putbit(0, ['Card is %sin idle state' % s]) |
47ec18f5 | 309 | |
a74855de | 310 | # Bit 1: 'Erase reset' bit |
47ec18f5 | 311 | s = '' if (res & (1 << 1)) else 'not ' |
a74855de | 312 | putbit(1, ['Erase sequence %scleared' % s]) |
47ec18f5 | 313 | |
a74855de | 314 | # Bit 2: 'Illegal command' bit |
47ec18f5 | 315 | s = 'I' if (res & (1 << 2)) else 'No i' |
a74855de | 316 | putbit(2, ['%sllegal command detected' % s]) |
47ec18f5 | 317 | |
a74855de | 318 | # Bit 3: 'Communication CRC error' bit |
47ec18f5 | 319 | s = 'failed' if (res & (1 << 3)) else 'was successful' |
a74855de | 320 | putbit(3, ['CRC check of last command %s' % s]) |
47ec18f5 | 321 | |
a74855de | 322 | # Bit 4: 'Erase sequence error' bit |
47ec18f5 | 323 | s = 'E' if (res & (1 << 4)) else 'No e' |
a74855de | 324 | putbit(4, ['%srror in the sequence of erase commands' % s]) |
47ec18f5 | 325 | |
a74855de | 326 | # Bit 5: 'Address error' bit |
47ec18f5 | 327 | s = 'M' if (res & (1 << 4)) else 'No m' |
a74855de | 328 | putbit(5, ['%sisaligned address used in command' % s]) |
47ec18f5 | 329 | |
a74855de | 330 | # Bit 6: 'Parameter error' bit |
47ec18f5 | 331 | s = '' if (res & (1 << 4)) else 'not ' |
a74855de UH |
332 | putbit(6, ['Command argument %soutside allowed range' % s]) |
333 | ||
334 | # Bit 7: Always set to 0 | |
335 | putbit(7, ['Bit 7 (always 0)']) | |
47ec18f5 | 336 | |
a66fbd85 PP |
337 | if self.is_cmd17: |
338 | self.state = 'HANDLE DATA BLOCK CMD17' | |
8f769505 PP |
339 | if self.is_cmd24: |
340 | self.state = 'HANDLE DATA BLOCK CMD24' | |
47ec18f5 UH |
341 | |
342 | def handle_response_r1b(self, res): | |
343 | # TODO | |
344 | pass | |
345 | ||
346 | def handle_response_r2(self, res): | |
347 | # TODO | |
348 | pass | |
349 | ||
350 | def handle_response_r3(self, res): | |
351 | # TODO | |
352 | pass | |
353 | ||
354 | # Note: Response token formats R4 and R5 are reserved for SDIO. | |
355 | ||
356 | # TODO: R6? | |
357 | ||
358 | def handle_response_r7(self, res): | |
359 | # TODO | |
360 | pass | |
361 | ||
a66fbd85 PP |
362 | def handle_data_cmd17(self, miso): |
363 | # CMD17 returns one byte R1, then some bytes 0xff, then a Start Block | |
364 | # (single byte 0xfe), then self.blocklen bytes of data, then always | |
365 | # 2 bytes of CRC. | |
366 | if self.cmd17_start_token_found: | |
367 | if len(self.read_buf) == 0: | |
368 | self.ss_data = self.ss | |
369 | if not self.blocklen: | |
370 | # Assume a fixed block size when inspection of the previous | |
371 | # traffic did not provide the respective parameter value. | |
372 | # TODO: Make the default block size a PD option? | |
373 | self.blocklen = 512 | |
374 | self.read_buf.append(miso) | |
375 | # Wait until block transfer completed. | |
376 | if len(self.read_buf) < self.blocklen: | |
377 | return | |
378 | if len(self.read_buf) == self.blocklen: | |
379 | self.es_data = self.es | |
f3297f98 | 380 | self.put(self.ss_data, self.es_data, self.out_ann, [Ann.CMD17, ['Block data: %s' % self.read_buf]]) |
a66fbd85 PP |
381 | elif len(self.read_buf) == (self.blocklen + 1): |
382 | self.ss_crc = self.ss | |
383 | elif len(self.read_buf) == (self.blocklen + 2): | |
384 | self.es_crc = self.es | |
385 | # TODO: Check CRC. | |
f3297f98 | 386 | self.put(self.ss_crc, self.es_crc, self.out_ann, [Ann.CMD17, ['CRC']]) |
a66fbd85 PP |
387 | self.state = 'IDLE' |
388 | elif miso == 0xfe: | |
f3297f98 | 389 | self.put(self.ss, self.es, self.out_ann, [Ann.CMD17, ['Start Block']]) |
a66fbd85 PP |
390 | self.cmd17_start_token_found = True |
391 | ||
8f769505 | 392 | def handle_data_cmd24(self, mosi): |
984e3e3d | 393 | if self.cmd24_start_token_found: |
8f769505 PP |
394 | if len(self.read_buf) == 0: |
395 | self.ss_data = self.ss | |
984e3e3d GS |
396 | if not self.blocklen: |
397 | # Assume a fixed block size when inspection of the | |
398 | # previous traffic did not provide the respective | |
399 | # parameter value. | |
400 | # TODO Make the default block size a user adjustable option? | |
401 | self.blocklen = 512 | |
8f769505 | 402 | self.read_buf.append(mosi) |
8f769505 PP |
403 | # Wait until block transfer completed. |
404 | if len(self.read_buf) < self.blocklen: | |
405 | return | |
406 | self.es_data = self.es | |
f3297f98 | 407 | self.put(self.ss_data, self.es_data, self.out_ann, [Ann.CMD24, ['Block data: %s' % self.read_buf]]) |
8f769505 PP |
408 | self.read_buf = [] |
409 | self.state = 'DATA RESPONSE' | |
410 | elif mosi == 0xfe: | |
f3297f98 | 411 | self.put(self.ss, self.es, self.out_ann, [Ann.CMD24, ['Start Block']]) |
984e3e3d | 412 | self.cmd24_start_token_found = True |
8f769505 PP |
413 | |
414 | def handle_data_response(self, miso): | |
8f461b61 UH |
415 | # Data Response token (1 byte). |
416 | # | |
417 | # Format: | |
418 | # - Bits[7:5]: Don't care. | |
419 | # - Bits[4:4]: Always 0. | |
420 | # - Bits[3:1]: Status. | |
421 | # - 010: Data accepted. | |
422 | # - 101: Data rejected due to a CRC error. | |
423 | # - 110: Data rejected due to a write error. | |
424 | # - Bits[0:0]: Always 1. | |
984e3e3d GS |
425 | miso &= 0x1f |
426 | if miso & 0x11 != 0x01: | |
8f769505 PP |
427 | # This is not the byte we are waiting for. |
428 | # Should we return to IDLE here? | |
429 | return | |
ebe297ad | 430 | m = self.miso_bits |
f3297f98 UH |
431 | self.put(m[7][1], m[5][2], self.out_ann, [Ann.BIT, ['Don\'t care']]) |
432 | self.put(m[4][1], m[4][2], self.out_ann, [Ann.BIT, ['Always 0']]) | |
8f769505 | 433 | if miso == 0x05: |
f3297f98 | 434 | self.put(m[3][1], m[1][2], self.out_ann, [Ann.BIT, ['Data accepted']]) |
984e3e3d | 435 | elif miso == 0x0b: |
f3297f98 | 436 | self.put(m[3][1], m[1][2], self.out_ann, [Ann.BIT, ['Data rejected (CRC error)']]) |
984e3e3d | 437 | elif miso == 0x0d: |
f3297f98 UH |
438 | self.put(m[3][1], m[1][2], self.out_ann, [Ann.BIT, ['Data rejected (write error)']]) |
439 | self.put(m[0][1], m[0][2], self.out_ann, [Ann.BIT, ['Always 1']]) | |
927e2ba6 UH |
440 | cls = Ann.CMD24 if self.is_cmd24 else None |
441 | if cls is not None: | |
442 | self.put(self.ss, self.es, self.out_ann, [cls, ['Data Response']]) | |
1c308e3d PP |
443 | if self.is_cmd24: |
444 | # We just send a block of data to be written to the card, | |
445 | # this takes some time. | |
446 | self.state = 'WAIT WHILE CARD BUSY' | |
447 | self.busy_first_byte = True | |
448 | else: | |
449 | self.state = 'IDLE' | |
450 | ||
451 | def wait_while_busy(self, miso): | |
452 | if miso != 0x00: | |
927e2ba6 UH |
453 | cls = Ann.CMD24 if self.is_cmd24 else None |
454 | if cls is not None: | |
455 | self.put(self.ss_busy, self.es_busy, self.out_ann, [cls, ['Card is busy']]) | |
1c308e3d PP |
456 | self.state = 'IDLE' |
457 | return | |
458 | else: | |
459 | if self.busy_first_byte: | |
460 | self.ss_busy = self.ss | |
461 | self.busy_first_byte = False | |
462 | else: | |
463 | self.es_busy = self.es | |
8f769505 | 464 | |
47ec18f5 UH |
465 | def decode(self, ss, es, data): |
466 | ptype, mosi, miso = data | |
467 | ||
d4ad1cb4 UH |
468 | # For now, only use DATA and BITS packets. |
469 | if ptype not in ('DATA', 'BITS'): | |
470 | return | |
471 | ||
472 | # Store the individual bit values and ss/es numbers. The next packet | |
473 | # is guaranteed to be a 'DATA' packet belonging to this 'BITS' one. | |
474 | if ptype == 'BITS': | |
475 | self.miso_bits, self.mosi_bits = miso, mosi | |
47ec18f5 UH |
476 | return |
477 | ||
1b3109bc | 478 | self.ss, self.es = ss, es |
47ec18f5 UH |
479 | |
480 | # State machine. | |
481 | if self.state == 'IDLE': | |
482 | # Ignore stray 0xff bytes, some devices seem to send those!? | |
483 | if mosi == 0xff: # TODO? | |
484 | return | |
485 | self.state = 'GET COMMAND TOKEN' | |
486 | self.handle_command_token(mosi, miso) | |
487 | elif self.state == 'GET COMMAND TOKEN': | |
488 | self.handle_command_token(mosi, miso) | |
489 | elif self.state.startswith('HANDLE CMD'): | |
490 | self.miso, self.mosi = miso, mosi | |
491 | # Call the respective handler method for the command. | |
ce71bf0e UH |
492 | a, cmdstr = 'a' if self.is_acmd else '', self.state[10:].lower() |
493 | handle_cmd = getattr(self, 'handle_%scmd%s' % (a, cmdstr)) | |
47ec18f5 | 494 | handle_cmd() |
0b5fc074 UH |
495 | self.cmd_token = [] |
496 | self.cmd_token_bits = [] | |
ce71bf0e UH |
497 | # Leave ACMD mode again after the first command after CMD55. |
498 | if self.is_acmd and cmdstr != '55': | |
499 | self.is_acmd = False | |
47ec18f5 UH |
500 | elif self.state.startswith('GET RESPONSE'): |
501 | # Ignore stray 0xff bytes, some devices seem to send those!? | |
502 | if miso == 0xff: # TODO? | |
503 | return | |
47ec18f5 | 504 | # Call the respective handler method for the response. |
984e3e3d GS |
505 | # Assume return to IDLE state, but allow response handlers |
506 | # to advance to some other state when applicable. | |
47ec18f5 | 507 | s = 'handle_response_%s' % self.state[13:].lower() |
47ec18f5 | 508 | handle_response = getattr(self, s) |
984e3e3d | 509 | self.state = 'IDLE' |
47ec18f5 | 510 | handle_response(miso) |
a66fbd85 PP |
511 | elif self.state == 'HANDLE DATA BLOCK CMD17': |
512 | self.handle_data_cmd17(miso) | |
8f769505 | 513 | elif self.state == 'HANDLE DATA BLOCK CMD24': |
984e3e3d | 514 | self.handle_data_cmd24(mosi) |
8f769505 | 515 | elif self.state == 'DATA RESPONSE': |
984e3e3d | 516 | self.handle_data_response(miso) |
1c308e3d PP |
517 | elif self.state == 'WAIT WHILE CARD BUSY': |
518 | self.wait_while_busy(miso) |