]>
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 |
2729ea3e | 22 | from common.sdcard import (cmd_names, acmd_names, accepted_voltages, sd_status) |
08c41387 | 23 | |
6266715a | 24 | responses = '1 1b 2 3 6 7'.split() |
9677dcf6 | 25 | token_fields = 'START TRANSMISSION CMD ARG CRC END'.split() |
2729ea3e UH |
26 | reg_card_status = 'OUT_OF_RANGE ADDRESS_ERROR BLOCK_LEN_ERROR ERASE_SEQ_ERROR \ |
27 | ERASE_PARAM WP_VIOLATION CARD_IS_LOCKED LOCK_UNLOCK_FAILED COM_CRC_ERROR \ | |
28 | ILLEGAL_COMMAND CARD_ECC_FAILED CC_ERROR ERROR RSVD_DEFERRED_RESPONSE \ | |
29 | CSD_OVERWRITE WP_ERASE_SKIP CARD_ECC_DISABLED ERASE_RESET CURRENT_STATE \ | |
30 | READY_FOR_DATA RSVD FX_EVENT APP_CMD RSVD_SDIO AKE_SEQ_ERROR RSVD_APP_CMD \ | |
31 | RSVD_TESTMODE'.split() | |
b13f3595 | 32 | reg_cid = 'MID OID PNM PRV PSN RSVD MDT CRC ONE'.split() |
73957cba UH |
33 | reg_csd = 'CSD_STRUCTURE RSVD TAAC NSAC TRAN_SPEED CCC READ_BL_LEN \ |
34 | READ_BL_PARTIAL WRITE_BLK_MISALIGN READ_BLK_MISALIGN DSR_IMP C_SIZE \ | |
35 | VDD_R_CURR_MIN VDD_R_CURR_MAX VDD_W_CURR_MIN VDD_W_CURR_MAX C_SIZE_MULT \ | |
36 | ERASE_BLK_EN SECTOR_SIZE WP_GRP_SIZE WP_GRP_ENABLE R2W_FACTOR \ | |
37 | WRITE_BL_LEN WRITE_BL_PARTIAL FILE_FORMAT_GRP COPY PERM_WRITE_PROTECT \ | |
38 | TMP_WRITE_PROTECT FILE_FORMAT CRC ONE'.split() | |
6266715a | 39 | |
a32575cd UH |
40 | Pin = SrdIntEnum.from_str('Pin', 'CMD CLK DAT0 DAT1 DAT2 DAT3') |
41 | ||
9f08e757 | 42 | a = ['CMD%d' % i for i in range(64)] + ['ACMD%d' % i for i in range(64)] + \ |
604b5f9d | 43 | ['RESPONSE_R' + r.upper() for r in responses] + \ |
2729ea3e | 44 | ['R_STATUS_' + r for r in reg_card_status] + \ |
b13f3595 | 45 | ['R_CID_' + r for r in reg_cid] + \ |
73957cba | 46 | ['R_CSD_' + r for r in reg_csd] + \ |
b1c5d4db | 47 | ['BIT_' + r for r in ('0', '1')] + \ |
9677dcf6 | 48 | ['F_' + f for f in token_fields] + \ |
b1c5d4db | 49 | ['DECODED_BIT', 'DECODED_F'] |
9f08e757 UH |
50 | Ann = SrdIntEnum.from_list('Ann', a) |
51 | ||
624710c9 UH |
52 | s = ['GET_COMMAND_TOKEN', 'HANDLE_CMD999'] + \ |
53 | ['HANDLE_CMD%d' % i for i in range(64)] + \ | |
54 | ['HANDLE_ACMD%d' % i for i in range(64)] + \ | |
6266715a | 55 | ['GET_RESPONSE_R%s' % r.upper() for r in responses] |
624710c9 UH |
56 | St = SrdStrEnum.from_list('St', s) |
57 | ||
07da8a9b UH |
58 | class Bit: |
59 | def __init__(self, s, e, b): | |
60 | self.ss, self.es, self.bit = s, e ,b | |
61 | ||
08c41387 | 62 | class Decoder(srd.Decoder): |
11535843 | 63 | api_version = 3 |
08c41387 UH |
64 | id = 'sdcard_sd' |
65 | name = 'SD card (SD mode)' | |
66 | longname = 'Secure Digital card (SD mode)' | |
67 | desc = 'Secure Digital card (SD mode) low-level protocol.' | |
68 | license = 'gplv2+' | |
69 | inputs = ['logic'] | |
6cbba91f | 70 | outputs = [] |
d6d8a8a4 | 71 | tags = ['Memory'] |
08c41387 UH |
72 | channels = ( |
73 | {'id': 'cmd', 'name': 'CMD', 'desc': 'Command'}, | |
74 | {'id': 'clk', 'name': 'CLK', 'desc': 'Clock'}, | |
75 | ) | |
76 | optional_channels = ( | |
77 | {'id': 'dat0', 'name': 'DAT0', 'desc': 'Data pin 0'}, | |
78 | {'id': 'dat1', 'name': 'DAT1', 'desc': 'Data pin 1'}, | |
79 | {'id': 'dat2', 'name': 'DAT2', 'desc': 'Data pin 2'}, | |
80 | {'id': 'dat3', 'name': 'DAT3', 'desc': 'Data pin 3'}, | |
81 | ) | |
82 | annotations = \ | |
83 | tuple(('cmd%d' % i, 'CMD%d' % i) for i in range(64)) + \ | |
6266715a | 84 | tuple(('acmd%d' % i, 'ACMD%d' % i) for i in range(64)) + \ |
b13f3595 | 85 | tuple(('response_r%s' % r, 'R%s' % r) for r in responses) + \ |
2729ea3e | 86 | tuple(('reg_status_' + r.lower(), 'Status: ' + r) for r in reg_card_status) + \ |
b13f3595 | 87 | tuple(('reg_cid_' + r.lower(), 'CID: ' + r) for r in reg_cid) + \ |
73957cba | 88 | tuple(('reg_csd_' + r.lower(), 'CSD: ' + r) for r in reg_csd) + \ |
b1c5d4db | 89 | tuple(('bit_' + r, 'Bit ' + r) for r in ('0', '1')) + \ |
9677dcf6 | 90 | tuple(('field-' + r.lower(), r) for r in token_fields) + \ |
b13f3595 | 91 | ( \ |
e144452b UH |
92 | ('decoded-bit', 'Decoded bit'), |
93 | ('decoded-field', 'Decoded field'), | |
08c41387 UH |
94 | ) |
95 | annotation_rows = ( | |
b1c5d4db | 96 | ('raw-bits', 'Raw bits', Ann.prefixes('BIT_')), |
b13f3595 | 97 | ('decoded-bits', 'Decoded bits', (Ann.DECODED_BIT,) + Ann.prefixes('R_')), |
9f08e757 UH |
98 | ('decoded-fields', 'Decoded fields', (Ann.DECODED_F,)), |
99 | ('fields', 'Fields', Ann.prefixes('F_')), | |
604b5f9d | 100 | ('commands', 'Commands', Ann.prefixes('CMD ACMD RESPONSE_')), |
08c41387 UH |
101 | ) |
102 | ||
92b7b49f | 103 | def __init__(self): |
10aeb8ea GS |
104 | self.reset() |
105 | ||
106 | def reset(self): | |
624710c9 | 107 | self.state = St.GET_COMMAND_TOKEN |
08c41387 | 108 | self.token = [] |
08c41387 UH |
109 | self.is_acmd = False # Indicates CMD vs. ACMD |
110 | self.cmd = None | |
f8eb6c3f | 111 | self.last_cmd = None |
08c41387 UH |
112 | self.arg = None |
113 | ||
114 | def start(self): | |
115 | self.out_ann = self.register(srd.OUTPUT_ANN) | |
116 | ||
08c41387 | 117 | def putt(self, data): |
07da8a9b | 118 | self.put(self.token[0].ss, self.token[47].es, self.out_ann, data) |
08c41387 | 119 | |
08c41387 | 120 | def putf(self, s, e, data): |
07da8a9b | 121 | self.put(self.token[s].ss, self.token[e].es, self.out_ann, data) |
08c41387 UH |
122 | |
123 | def puta(self, s, e, data): | |
07da8a9b | 124 | self.put(self.token[47 - 8 - e].ss, self.token[47 - 8 - s].es, |
08c41387 UH |
125 | self.out_ann, data) |
126 | ||
0671a9de | 127 | def putc(self, desc): |
608b9c03 | 128 | cmd = Ann.ACMD0 + self.cmd if self.is_acmd else self.cmd |
f8eb6c3f | 129 | self.last_cmd = cmd |
08c41387 UH |
130 | self.putt([cmd, ['%s: %s' % (self.cmd_str, desc), self.cmd_str, |
131 | self.cmd_str.split(' ')[0]]]) | |
132 | ||
6266715a | 133 | def putr(self, r): |
604b5f9d | 134 | self.putt([r, ['Response: %s' % r.name.split('_')[1]]]) |
08c41387 | 135 | |
08c41387 UH |
136 | def cmd_name(self, cmd): |
137 | c = acmd_names if self.is_acmd else cmd_names | |
138 | return c.get(cmd, 'Unknown') | |
139 | ||
4dfde5a5 | 140 | def get_token_bits(self, cmd_pin, n): |
08c41387 | 141 | # Get a bit, return True if we already got 'n' bits, False otherwise. |
07da8a9b | 142 | self.token.append(Bit(self.samplenum, self.samplenum, cmd_pin)) |
08c41387 | 143 | if len(self.token) > 0: |
07da8a9b | 144 | self.token[len(self.token) - 2].es = self.samplenum |
08c41387 UH |
145 | if len(self.token) < n: |
146 | return False | |
07da8a9b | 147 | self.token[n - 1].es += self.token[n - 1].ss - self.token[n - 2].ss |
08c41387 UH |
148 | return True |
149 | ||
150 | def handle_common_token_fields(self): | |
151 | s = self.token | |
152 | ||
153 | # Annotations for each individual bit. | |
154 | for bit in range(len(self.token)): | |
b1c5d4db | 155 | self.putf(bit, bit, [Ann.BIT_0 + s[bit].bit, ['%d' % s[bit].bit]]) |
08c41387 UH |
156 | |
157 | # CMD[47:47]: Start bit (always 0) | |
9f08e757 | 158 | self.putf(0, 0, [Ann.F_START, ['Start bit', 'Start', 'S']]) |
08c41387 UH |
159 | |
160 | # CMD[46:46]: Transmission bit (1 == host) | |
07da8a9b | 161 | t = 'host' if s[1].bit == 1 else 'card' |
9677dcf6 | 162 | self.putf(1, 1, [Ann.F_TRANSMISSION, ['Transmission: ' + t, 'T: ' + t, 'T']]) |
08c41387 UH |
163 | |
164 | # CMD[45:40]: Command index (BCD; valid: 0-63) | |
07da8a9b | 165 | self.cmd = int('0b' + ''.join([str(s[i].bit) for i in range(2, 8)]), 2) |
08c41387 | 166 | c = '%s (%d)' % (self.cmd_name(self.cmd), self.cmd) |
9f08e757 | 167 | self.putf(2, 7, [Ann.F_CMD, ['Command: ' + c, 'Cmd: ' + c, |
08c41387 UH |
168 | 'CMD%d' % self.cmd, 'Cmd', 'C']]) |
169 | ||
170 | # CMD[39:08]: Argument | |
07da8a9b | 171 | self.arg = int('0b' + ''.join([str(s[i].bit) for i in range(8, 40)]), 2) |
9f08e757 | 172 | self.putf(8, 39, [Ann.F_ARG, ['Argument: 0x%08x' % self.arg, 'Arg', 'A']]) |
08c41387 UH |
173 | |
174 | # CMD[07:01]: CRC7 | |
07da8a9b | 175 | self.crc = int('0b' + ''.join([str(s[i].bit) for i in range(40, 47)]), 2) |
9f08e757 | 176 | self.putf(40, 46, [Ann.F_CRC, ['CRC: 0x%x' % self.crc, 'CRC', 'C']]) |
08c41387 UH |
177 | |
178 | # CMD[00:00]: End bit (always 1) | |
9f08e757 | 179 | self.putf(47, 47, [Ann.F_END, ['End bit', 'End', 'E']]) |
08c41387 | 180 | |
4dfde5a5 | 181 | def get_command_token(self, cmd_pin): |
08c41387 UH |
182 | # Command tokens (48 bits) are sent serially (MSB-first) by the host |
183 | # (over the CMD line), either to one SD card or to multiple ones. | |
184 | # | |
185 | # Format: | |
186 | # - Bits[47:47]: Start bit (always 0) | |
187 | # - Bits[46:46]: Transmission bit (1 == host) | |
188 | # - Bits[45:40]: Command index (BCD; valid: 0-63) | |
189 | # - Bits[39:08]: Argument | |
190 | # - Bits[07:01]: CRC7 | |
191 | # - Bits[00:00]: End bit (always 1) | |
192 | ||
4dfde5a5 | 193 | if not self.get_token_bits(cmd_pin, 48): |
08c41387 UH |
194 | return |
195 | ||
196 | self.handle_common_token_fields() | |
197 | ||
198 | # Handle command. | |
199 | s = 'ACMD' if self.is_acmd else 'CMD' | |
200 | self.cmd_str = '%s%d (%s)' % (s, self.cmd, self.cmd_name(self.cmd)) | |
1e9dfe60 | 201 | if hasattr(self, 'handle_%s%d' % (s.lower(), self.cmd)): |
624710c9 | 202 | self.state = St['HANDLE_CMD%d' % self.cmd] |
08c41387 | 203 | else: |
624710c9 | 204 | self.state = St.HANDLE_CMD999 |
0671a9de | 205 | self.putc('%s%d' % (s, self.cmd)) |
08c41387 UH |
206 | |
207 | def handle_cmd0(self): | |
208 | # CMD0 (GO_IDLE_STATE) -> no response | |
9f08e757 | 209 | self.puta(0, 31, [Ann.DECODED_F, ['Stuff bits', 'Stuff', 'SB', 'S']]) |
0671a9de | 210 | self.putc('Reset all SD cards') |
624710c9 | 211 | self.token, self.state = [], St.GET_COMMAND_TOKEN |
08c41387 UH |
212 | |
213 | def handle_cmd2(self): | |
214 | # CMD2 (ALL_SEND_CID) -> R2 | |
9f08e757 | 215 | self.puta(0, 31, [Ann.DECODED_F, ['Stuff bits', 'Stuff', 'SB', 'S']]) |
0671a9de | 216 | self.putc('Ask card for CID number') |
624710c9 | 217 | self.token, self.state = [], St.GET_RESPONSE_R2 |
08c41387 UH |
218 | |
219 | def handle_cmd3(self): | |
220 | # CMD3 (SEND_RELATIVE_ADDR) -> R6 | |
9f08e757 | 221 | self.puta(0, 31, [Ann.DECODED_F, ['Stuff bits', 'Stuff', 'SB', 'S']]) |
0671a9de | 222 | self.putc('Ask card for new relative card address (RCA)') |
624710c9 | 223 | self.token, self.state = [], St.GET_RESPONSE_R6 |
08c41387 UH |
224 | |
225 | def handle_cmd6(self): | |
226 | # CMD6 (SWITCH_FUNC) -> R1 | |
0671a9de | 227 | self.putc('Switch/check card function') |
624710c9 | 228 | self.token, self.state = [], St.GET_RESPONSE_R1 |
08c41387 UH |
229 | |
230 | def handle_cmd7(self): | |
231 | # CMD7 (SELECT/DESELECT_CARD) -> R1b | |
0671a9de | 232 | self.putc('Select / deselect card') |
624710c9 | 233 | self.token, self.state = [], St.GET_RESPONSE_R6 |
08c41387 UH |
234 | |
235 | def handle_cmd8(self): | |
236 | # CMD8 (SEND_IF_COND) -> R7 | |
9f08e757 UH |
237 | self.puta(12, 31, [Ann.DECODED_F, ['Reserved', 'Res', 'R']]) |
238 | self.puta(8, 11, [Ann.DECODED_F, ['Supply voltage', 'Voltage', 'VHS', 'V']]) | |
239 | self.puta(0, 7, [Ann.DECODED_F, ['Check pattern', 'Check pat', 'Check', 'C']]) | |
0671a9de | 240 | self.putc('Send interface condition to card') |
624710c9 | 241 | self.token, self.state = [], St.GET_RESPONSE_R7 |
08c41387 UH |
242 | # TODO: Handle case when card doesn't reply with R7 (no reply at all). |
243 | ||
244 | def handle_cmd9(self): | |
245 | # CMD9 (SEND_CSD) -> R2 | |
9f08e757 UH |
246 | self.puta(16, 31, [Ann.DECODED_F, ['RCA', 'R']]) |
247 | self.puta(0, 15, [Ann.DECODED_F, ['Stuff bits', 'Stuff', 'SB', 'S']]) | |
0671a9de | 248 | self.putc('Send card-specific data (CSD)') |
624710c9 | 249 | self.token, self.state = [], St.GET_RESPONSE_R2 |
08c41387 UH |
250 | |
251 | def handle_cmd10(self): | |
252 | # CMD10 (SEND_CID) -> R2 | |
9f08e757 UH |
253 | self.puta(16, 31, [Ann.DECODED_F, ['RCA', 'R']]) |
254 | self.puta(0, 15, [Ann.DECODED_F, ['Stuff bits', 'Stuff', 'SB', 'S']]) | |
0671a9de | 255 | self.putc('Send card identification data (CID)') |
624710c9 | 256 | self.token, self.state = [], St.GET_RESPONSE_R2 |
08c41387 UH |
257 | |
258 | def handle_cmd13(self): | |
259 | # CMD13 (SEND_STATUS) -> R1 | |
9f08e757 UH |
260 | self.puta(16, 31, [Ann.DECODED_F, ['RCA', 'R']]) |
261 | self.puta(0, 15, [Ann.DECODED_F, ['Stuff bits', 'Stuff', 'SB', 'S']]) | |
0671a9de | 262 | self.putc('Send card status register') |
624710c9 | 263 | self.token, self.state = [], St.GET_RESPONSE_R1 |
08c41387 UH |
264 | |
265 | def handle_cmd16(self): | |
266 | # CMD16 (SET_BLOCKLEN) -> R1 | |
9f08e757 | 267 | self.puta(0, 31, [Ann.DECODED_F, ['Block length', 'Blocklen', 'BL', 'B']]) |
0671a9de | 268 | self.putc('Set the block length to %d bytes' % self.arg) |
624710c9 | 269 | self.token, self.state = [], St.GET_RESPONSE_R1 |
08c41387 UH |
270 | |
271 | def handle_cmd55(self): | |
272 | # CMD55 (APP_CMD) -> R1 | |
9f08e757 UH |
273 | self.puta(16, 31, [Ann.DECODED_F, ['RCA', 'R']]) |
274 | self.puta(0, 15, [Ann.DECODED_F, ['Stuff bits', 'Stuff', 'SB', 'S']]) | |
0671a9de | 275 | self.putc('Next command is an application-specific command') |
08c41387 | 276 | self.is_acmd = True |
624710c9 | 277 | self.token, self.state = [], St.GET_RESPONSE_R1 |
08c41387 UH |
278 | |
279 | def handle_acmd6(self): | |
280 | # ACMD6 (SET_BUS_WIDTH) -> R1 | |
0671a9de | 281 | self.putc('Read SD config register (SCR)') |
624710c9 | 282 | self.token, self.state = [], St.GET_RESPONSE_R1 |
08c41387 UH |
283 | |
284 | def handle_acmd13(self): | |
285 | # ACMD13 (SD_STATUS) -> R1 | |
9f08e757 | 286 | self.puta(0, 31, [Ann.DECODED_F, ['Stuff bits', 'Stuff', 'SB', 'S']]) |
0671a9de | 287 | self.putc('Set SD status') |
624710c9 | 288 | self.token, self.state = [], St.GET_RESPONSE_R1 |
08c41387 UH |
289 | |
290 | def handle_acmd41(self): | |
291 | # ACMD41 (SD_SEND_OP_COND) -> R3 | |
9f08e757 UH |
292 | self.puta(0, 23, [Ann.DECODED_F, |
293 | ['VDD voltage window', 'VDD volt', 'VDD', 'V']]) | |
294 | self.puta(24, 24, [Ann.DECODED_F, ['S18R']]) | |
295 | self.puta(25, 27, [Ann.DECODED_F, ['Reserved', 'Res', 'R']]) | |
296 | self.puta(28, 28, [Ann.DECODED_F, ['XPC']]) | |
297 | self.puta(29, 29, [Ann.DECODED_F, | |
298 | ['Reserved for eSD', 'Reserved', 'Res', 'R']]) | |
299 | self.puta(30, 30, [Ann.DECODED_F, | |
300 | ['Host capacity support info', 'Host capacity', 'HCS', 'H']]) | |
301 | self.puta(31, 31, [Ann.DECODED_F, ['Reserved', 'Res', 'R']]) | |
0671a9de | 302 | self.putc('Send HCS info and activate the card init process') |
624710c9 | 303 | self.token, self.state = [], St.GET_RESPONSE_R3 |
08c41387 UH |
304 | |
305 | def handle_acmd51(self): | |
306 | # ACMD51 (SEND_SCR) -> R1 | |
0671a9de | 307 | self.putc('Read SD config register (SCR)') |
624710c9 | 308 | self.token, self.state = [], St.GET_RESPONSE_R1 |
08c41387 UH |
309 | |
310 | def handle_cmd999(self): | |
624710c9 | 311 | self.token, self.state = [], St.GET_RESPONSE_R1 |
08c41387 UH |
312 | |
313 | def handle_acmd999(self): | |
624710c9 | 314 | self.token, self.state = [], St.GET_RESPONSE_R1 |
08c41387 | 315 | |
2729ea3e UH |
316 | def handle_reg_status(self): |
317 | self.putf(8, 8, [Ann.R_STATUS_OUT_OF_RANGE, ['OUT_OF_RANGE']]) | |
318 | self.putf(9, 9, [Ann.R_STATUS_ADDRESS_ERROR, ['ADDRESS_ERROR']]) | |
319 | self.putf(10, 10, [Ann.R_STATUS_BLOCK_LEN_ERROR, ['BLOCK_LEN_ERROR']]) | |
320 | self.putf(11, 11, [Ann.R_STATUS_ERASE_SEQ_ERROR, ['ERASE_SEQ_ERROR']]) | |
321 | self.putf(12, 12, [Ann.R_STATUS_ERASE_PARAM, ['ERASE_PARAM']]) | |
322 | self.putf(13, 13, [Ann.R_STATUS_WP_VIOLATION, ['WP_VIOLATION']]) | |
323 | self.putf(14, 14, [Ann.R_STATUS_CARD_IS_LOCKED, ['CARD_IS_LOCKED']]) | |
324 | self.putf(15, 15, [Ann.R_STATUS_LOCK_UNLOCK_FAILED, ['LOCK_UNLOCK_FAILED']]) | |
325 | self.putf(16, 16, [Ann.R_STATUS_COM_CRC_ERROR, ['COM_CRC_ERROR']]) | |
326 | self.putf(17, 17, [Ann.R_STATUS_ILLEGAL_COMMAND, ['ILLEGAL_COMMAND']]) | |
327 | self.putf(18, 18, [Ann.R_STATUS_CARD_ECC_FAILED, ['CARD_ECC_FAILED']]) | |
328 | self.putf(19, 19, [Ann.R_STATUS_CC_ERROR, ['CC_ERROR']]) | |
329 | self.putf(20, 20, [Ann.R_STATUS_ERROR, ['ERROR']]) | |
330 | self.putf(21, 21, [Ann.R_STATUS_RSVD, ['Reserved', 'RSVD', 'R']]) | |
331 | self.putf(22, 22, [Ann.R_STATUS_RSVD_DEFERRED_RESPONSE, ['Reserved for DEFERRED_RESPONSE', 'RSVD_DEFERRED_RESPONSE']]) | |
332 | self.putf(23, 23, [Ann.R_STATUS_CSD_OVERWRITE, ['CSD_OVERWRITE']]) | |
333 | self.putf(24, 24, [Ann.R_STATUS_WP_ERASE_SKIP, ['WP_ERASE_SKIP']]) | |
334 | self.putf(25, 25, [Ann.R_STATUS_CARD_ECC_DISABLED, ['CARD_ECC_DISABLED']]) | |
335 | self.putf(26, 26, [Ann.R_STATUS_ERASE_RESET, ['ERASE_RESET']]) | |
336 | self.putf(27, 30, [Ann.R_STATUS_CURRENT_STATE, ['CURRENT_STATE']]) | |
337 | self.putf(31, 31, [Ann.R_STATUS_READY_FOR_DATA, ['READY_FOR_DATA']]) | |
338 | self.putf(32, 32, [Ann.R_STATUS_RSVD, ['RSVD']]) | |
339 | self.putf(33, 33, [Ann.R_STATUS_FX_EVENT, ['FX_EVENT']]) | |
340 | self.putf(34, 34, [Ann.R_STATUS_APP_CMD, ['APP_CMD']]) | |
341 | self.putf(35, 35, [Ann.R_STATUS_RSVD_SDIO, ['Reserved for SDIO card', 'RSVD_SDIO']]) | |
342 | self.putf(36, 36, [Ann.R_STATUS_AKE_SEQ_ERROR, ['AKE_SEQ_ERROR']]) | |
343 | self.putf(37, 37, [Ann.R_STATUS_RSVD_APP_CMD, ['Reserved for application specific commands', 'RSVD_APP_CMD']]) | |
344 | self.putf(38, 39, [Ann.R_STATUS_RSVD_TESTMODE, ['Reserved for manufacturer test mode', 'RSVD_TESTMODE']]) | |
345 | ||
b13f3595 UH |
346 | def handle_reg_cid(self): |
347 | self.putf(8, 15, [Ann.R_CID_MID, ['Manufacturer ID', 'MID']]) | |
348 | self.putf(16, 31, [Ann.R_CID_OID, ['OEM/application ID', 'OID']]) | |
349 | self.putf(32, 71, [Ann.R_CID_PNM, ['Product name', 'PNM']]) | |
350 | self.putf(72, 79, [Ann.R_CID_PRV, ['Product revision', 'PRV']]) | |
351 | self.putf(80, 111, [Ann.R_CID_PSN, ['Product serial number', 'PSN']]) | |
352 | self.putf(112, 115, [Ann.R_CID_RSVD, ['Reserved', 'RSVD', 'R']]) | |
353 | self.putf(116, 127, [Ann.R_CID_MDT, ['Manufacturing date', 'MDT']]) | |
354 | self.putf(128, 134, [Ann.R_CID_CRC, ['CRC7 checksum', 'CRC']]) | |
355 | self.putf(135, 135, [Ann.R_CID_ONE, ['Always 1', '1']]) | |
356 | ||
73957cba UH |
357 | def handle_reg_csd(self): |
358 | self.putf(8, 9, [Ann.R_CSD_CSD_STRUCTURE, ['CSD structure', 'CSD_STRUCTURE']]) | |
359 | self.putf(10, 15, [Ann.R_CSD_RSVD, ['Reserved', 'RSVD', 'R']]) | |
360 | self.putf(16, 23, [Ann.R_CSD_TAAC, ['Data read access-time - 1', 'TAAC']]) | |
361 | self.putf(24, 31, [Ann.R_CSD_NSAC, ['Data read access-time - 2 in CLK cycles (NSAC * 100)', 'NSAC']]) | |
362 | self.putf(32, 39, [Ann.R_CSD_TRAN_SPEED, ['Max. data transfer rate', 'TRAN_SPEED']]) | |
363 | self.putf(40, 51, [Ann.R_CSD_CCC, ['Card command classes', 'CCC']]) | |
364 | self.putf(52, 55, [Ann.R_CSD_READ_BL_LEN, ['Max. read data block length', 'READ_BL_LEN']]) | |
365 | self.putf(56, 56, [Ann.R_CSD_READ_BL_PARTIAL, ['Partial blocks for read allowed', 'READ_BL_PARTIAL']]) | |
366 | self.putf(57, 57, [Ann.R_CSD_WRITE_BLK_MISALIGN, ['Write block misalignment', 'WRITE_BLK_MISALIGN']]) | |
367 | self.putf(58, 58, [Ann.R_CSD_READ_BLK_MISALIGN, ['Read block misalignment', 'READ_BLK_MISALIGN']]) | |
368 | self.putf(59, 59, [Ann.R_CSD_DSR_IMP, ['DSR implemented', 'DSR_IMP']]) | |
369 | self.putf(60, 61, [Ann.R_CSD_RSVD, ['Reserved', 'RSVD', 'R']]) | |
370 | self.putf(62, 73, [Ann.R_CSD_C_SIZE, ['Device size', 'C_SIZE']]) | |
371 | self.putf(74, 76, [Ann.R_CSD_VDD_R_CURR_MIN, ['Max. read current @VDD min', 'VDD_R_CURR_MIN']]) | |
372 | self.putf(77, 79, [Ann.R_CSD_VDD_R_CURR_MAX, ['Max. read current @VDD max', 'VDD_R_CURR_MAX']]) | |
373 | self.putf(80, 82, [Ann.R_CSD_VDD_W_CURR_MIN, ['Max. write current @VDD min', 'VDD_W_CURR_MIN']]) | |
374 | self.putf(83, 85, [Ann.R_CSD_VDD_W_CURR_MAX, ['Max. write current @VDD max', 'VDD_W_CURR_MAX']]) | |
375 | self.putf(86, 88, [Ann.R_CSD_C_SIZE_MULT, ['Device size multiplier', 'C_SIZE_MULT']]) | |
376 | self.putf(89, 89, [Ann.R_CSD_ERASE_BLK_EN, ['Erase single block enable', 'ERASE_BLK_EN']]) | |
377 | self.putf(90, 96, [Ann.R_CSD_SECTOR_SIZE, ['Erase sector size', 'SECTOR_SIZE']]) | |
378 | self.putf(97, 103, [Ann.R_CSD_WP_GRP_SIZE, ['Write protect group size', 'WP_GRP_SIZE']]) | |
379 | self.putf(104, 104, [Ann.R_CSD_WP_GRP_ENABLE, ['Write protect group enable', 'WP_GRP_ENABLE']]) | |
380 | self.putf(105, 106, [Ann.R_CSD_RSVD, ['Reserved', 'RSVD', 'R']]) | |
381 | self.putf(107, 109, [Ann.R_CSD_R2W_FACTOR, ['Write speed factor', 'R2W_FACTOR']]) | |
382 | self.putf(110, 113, [Ann.R_CSD_WRITE_BL_LEN, ['Max. write data block length', 'WRITE_BL_LEN']]) | |
383 | self.putf(114, 114, [Ann.R_CSD_WRITE_BL_PARTIAL, ['Partial blocks for write allowed', 'WRITE_BL_PARTIAL']]) | |
384 | self.putf(115, 119, [Ann.R_CSD_RSVD, ['Reserved', 'RSVD']]) | |
385 | self.putf(120, 120, [Ann.R_CSD_FILE_FORMAT_GRP, ['File format group', 'FILE_FORMAT_GRP']]) | |
386 | self.putf(121, 121, [Ann.R_CSD_COPY, ['Copy flag', 'COPY']]) | |
387 | self.putf(122, 122, [Ann.R_CSD_PERM_WRITE_PROTECT, ['Permanent write protection', 'PERM_WRITE_PROTECT']]) | |
388 | self.putf(123, 123, [Ann.R_CSD_TMP_WRITE_PROTECT, ['Temporary write protection', 'TMP_WRITE_PROTECT']]) | |
389 | self.putf(124, 125, [Ann.R_CSD_FILE_FORMAT, ['File format', 'FILE_FORMAT']]) | |
390 | self.putf(126, 127, [Ann.R_CSD_RSVD, ['Reserved', 'RSVD', 'R']]) | |
391 | self.putf(128, 134, [Ann.R_CSD_CRC, ['CRC', 'CRC', 'C']]) | |
392 | self.putf(135, 135, [Ann.R_CSD_ONE, ['Always 1', '1']]) | |
393 | ||
08c41387 UH |
394 | # Response tokens can have one of four formats (depends on content). |
395 | # They can have a total length of 48 or 136 bits. | |
396 | # They're sent serially (MSB-first) by the card that the host | |
397 | # addressed previously, or (synchronously) by all connected cards. | |
398 | ||
4dfde5a5 | 399 | def handle_response_r1(self, cmd_pin): |
08c41387 UH |
400 | # R1: Normal response command |
401 | # - Bits[47:47]: Start bit (always 0) | |
402 | # - Bits[46:46]: Transmission bit (0 == card) | |
403 | # - Bits[45:40]: Command index (BCD; valid: 0-63) | |
404 | # - Bits[39:08]: Card status | |
405 | # - Bits[07:01]: CRC7 | |
406 | # - Bits[00:00]: End bit (always 1) | |
4dfde5a5 | 407 | if not self.get_token_bits(cmd_pin, 48): |
08c41387 UH |
408 | return |
409 | self.handle_common_token_fields() | |
604b5f9d | 410 | self.putr(Ann.RESPONSE_R1) |
9f08e757 | 411 | self.puta(0, 31, [Ann.DECODED_F, ['Card status', 'Status', 'S']]) |
2729ea3e UH |
412 | self.handle_reg_status() |
413 | ||
624710c9 | 414 | self.token, self.state = [], St.GET_COMMAND_TOKEN |
08c41387 | 415 | |
4dfde5a5 | 416 | def handle_response_r1b(self, cmd_pin): |
08c41387 | 417 | # R1b: Same as R1 with an optional busy signal (on the data line) |
4dfde5a5 | 418 | if not self.get_token_bits(cmd_pin, 48): |
08c41387 UH |
419 | return |
420 | self.handle_common_token_fields() | |
9f08e757 | 421 | self.puta(0, 31, [Ann.DECODED_F, ['Card status', 'Status', 'S']]) |
604b5f9d | 422 | self.putr(Ann.RESPONSE_R1B) |
624710c9 | 423 | self.token, self.state = [], St.GET_COMMAND_TOKEN |
08c41387 | 424 | |
4dfde5a5 | 425 | def handle_response_r2(self, cmd_pin): |
08c41387 UH |
426 | # R2: CID/CSD register |
427 | # - Bits[135:135]: Start bit (always 0) | |
428 | # - Bits[134:134]: Transmission bit (0 == card) | |
429 | # - Bits[133:128]: Reserved (always 0b111111) | |
430 | # - Bits[127:001]: CID or CSD register including internal CRC7 | |
431 | # - Bits[000:000]: End bit (always 1) | |
4dfde5a5 | 432 | if not self.get_token_bits(cmd_pin, 136): |
08c41387 UH |
433 | return |
434 | # Annotations for each individual bit. | |
435 | for bit in range(len(self.token)): | |
b1c5d4db | 436 | self.putf(bit, bit, [Ann.BIT_0 + self.token[bit].bit, ['%d' % self.token[bit].bit]]) |
9f08e757 | 437 | self.putf(0, 0, [Ann.F_START, ['Start bit', 'Start', 'S']]) |
07da8a9b | 438 | t = 'host' if self.token[1].bit == 1 else 'card' |
9677dcf6 | 439 | self.putf(1, 1, [Ann.F_TRANSMISSION, ['Transmission: ' + t, 'T: ' + t, 'T']]) |
9f08e757 UH |
440 | self.putf(2, 7, [Ann.F_CMD, ['Reserved', 'Res', 'R']]) |
441 | self.putf(8, 134, [Ann.F_ARG, ['Argument', 'Arg', 'A']]) | |
442 | self.putf(135, 135, [Ann.F_END, ['End bit', 'End', 'E']]) | |
443 | self.putf(8, 134, [Ann.DECODED_F, ['CID/CSD register', 'CID/CSD', 'C']]) | |
604b5f9d | 444 | self.putf(0, 135, [Ann.RESPONSE_R2, ['Response: R2']]) |
b13f3595 UH |
445 | |
446 | if self.last_cmd in (Ann.CMD2, Ann.CMD10): | |
447 | self.handle_reg_cid() | |
448 | ||
73957cba UH |
449 | if self.last_cmd == Ann.CMD9: |
450 | self.handle_reg_csd() | |
451 | ||
624710c9 | 452 | self.token, self.state = [], St.GET_COMMAND_TOKEN |
08c41387 | 453 | |
4dfde5a5 | 454 | def handle_response_r3(self, cmd_pin): |
08c41387 UH |
455 | # R3: OCR register |
456 | # - Bits[47:47]: Start bit (always 0) | |
457 | # - Bits[46:46]: Transmission bit (0 == card) | |
458 | # - Bits[45:40]: Reserved (always 0b111111) | |
459 | # - Bits[39:08]: OCR register | |
460 | # - Bits[07:01]: Reserved (always 0b111111) | |
461 | # - Bits[00:00]: End bit (always 1) | |
4dfde5a5 | 462 | if not self.get_token_bits(cmd_pin, 48): |
08c41387 | 463 | return |
604b5f9d | 464 | self.putr(Ann.RESPONSE_R3) |
08c41387 UH |
465 | # Annotations for each individual bit. |
466 | for bit in range(len(self.token)): | |
b1c5d4db | 467 | self.putf(bit, bit, [Ann.BIT_0 + self.token[bit].bit, ['%d' % self.token[bit].bit]]) |
9f08e757 | 468 | self.putf(0, 0, [Ann.F_START, ['Start bit', 'Start', 'S']]) |
07da8a9b | 469 | t = 'host' if self.token[1].bit == 1 else 'card' |
9677dcf6 | 470 | self.putf(1, 1, [Ann.F_TRANSMISSION, ['Transmission: ' + t, 'T: ' + t, 'T']]) |
9f08e757 UH |
471 | self.putf(2, 7, [Ann.F_CMD, ['Reserved', 'Res', 'R']]) |
472 | self.putf(8, 39, [Ann.F_ARG, ['Argument', 'Arg', 'A']]) | |
473 | self.putf(40, 46, [Ann.F_CRC, ['Reserved', 'Res', 'R']]) | |
474 | self.putf(47, 47, [Ann.F_END, ['End bit', 'End', 'E']]) | |
475 | self.puta(0, 31, [Ann.DECODED_F, ['OCR register', 'OCR reg', 'OCR', 'O']]) | |
624710c9 | 476 | self.token, self.state = [], St.GET_COMMAND_TOKEN |
08c41387 | 477 | |
4dfde5a5 | 478 | def handle_response_r6(self, cmd_pin): |
08c41387 UH |
479 | # R6: Published RCA response |
480 | # - Bits[47:47]: Start bit (always 0) | |
481 | # - Bits[46:46]: Transmission bit (0 == card) | |
482 | # - Bits[45:40]: Command index (always 0b000011) | |
483 | # - Bits[39:24]: Argument[31:16]: New published RCA of the card | |
484 | # - Bits[23:08]: Argument[15:0]: Card status bits | |
485 | # - Bits[07:01]: CRC7 | |
486 | # - Bits[00:00]: End bit (always 1) | |
4dfde5a5 | 487 | if not self.get_token_bits(cmd_pin, 48): |
08c41387 UH |
488 | return |
489 | self.handle_common_token_fields() | |
9f08e757 UH |
490 | self.puta(0, 15, [Ann.DECODED_F, ['Card status bits', 'Status', 'S']]) |
491 | self.puta(16, 31, [Ann.DECODED_F, ['Relative card address', 'RCA', 'R']]) | |
604b5f9d | 492 | self.putr(Ann.RESPONSE_R6) |
624710c9 | 493 | self.token, self.state = [], St.GET_COMMAND_TOKEN |
08c41387 | 494 | |
4dfde5a5 | 495 | def handle_response_r7(self, cmd_pin): |
08c41387 UH |
496 | # R7: Card interface condition |
497 | # - Bits[47:47]: Start bit (always 0) | |
498 | # - Bits[46:46]: Transmission bit (0 == card) | |
499 | # - Bits[45:40]: Command index (always 0b001000) | |
500 | # - Bits[39:20]: Reserved bits (all-zero) | |
501 | # - Bits[19:16]: Voltage accepted | |
502 | # - Bits[15:08]: Echo-back of check pattern | |
503 | # - Bits[07:01]: CRC7 | |
504 | # - Bits[00:00]: End bit (always 1) | |
4dfde5a5 | 505 | if not self.get_token_bits(cmd_pin, 48): |
08c41387 UH |
506 | return |
507 | self.handle_common_token_fields() | |
508 | ||
604b5f9d | 509 | self.putr(Ann.RESPONSE_R7) |
08c41387 UH |
510 | |
511 | # Arg[31:12]: Reserved bits (all-zero) | |
9f08e757 | 512 | self.puta(12, 31, [Ann.DECODED_F, ['Reserved', 'Res', 'R']]) |
08c41387 UH |
513 | |
514 | # Arg[11:08]: Voltage accepted | |
07da8a9b | 515 | v = ''.join(str(i.bit) for i in self.token[28:32]) |
08c41387 | 516 | av = accepted_voltages.get(int('0b' + v, 2), 'Unknown') |
9f08e757 UH |
517 | self.puta(8, 11, [Ann.DECODED_F, |
518 | ['Voltage accepted: ' + av, 'Voltage', 'Volt', 'V']]) | |
08c41387 UH |
519 | |
520 | # Arg[07:00]: Echo-back of check pattern | |
9f08e757 UH |
521 | self.puta(0, 7, [Ann.DECODED_F, |
522 | ['Echo-back of check pattern', 'Echo', 'E']]) | |
08c41387 | 523 | |
624710c9 | 524 | self.token, self.state = [], St.GET_COMMAND_TOKEN |
08c41387 | 525 | |
11535843 GS |
526 | def decode(self): |
527 | while True: | |
08c41387 | 528 | # Wait for a rising CLK edge. |
4dfde5a5 | 529 | (cmd_pin, clk, dat0, dat1, dat2, dat3) = self.wait({Pin.CLK: 'r'}) |
08c41387 UH |
530 | |
531 | # State machine. | |
624710c9 | 532 | if self.state == St.GET_COMMAND_TOKEN: |
08c41387 UH |
533 | if len(self.token) == 0: |
534 | # Wait for start bit (CMD = 0). | |
4dfde5a5 | 535 | if cmd_pin != 0: |
08c41387 | 536 | continue |
4dfde5a5 | 537 | self.get_command_token(cmd_pin) |
624710c9 | 538 | elif self.state.value.startswith('HANDLE_CMD'): |
08c41387 | 539 | # Call the respective handler method for the command. |
624710c9 | 540 | a, cmdstr = 'a' if self.is_acmd else '', self.state.value[10:].lower() |
08c41387 UH |
541 | handle_cmd = getattr(self, 'handle_%scmd%s' % (a, cmdstr)) |
542 | handle_cmd() | |
543 | # Leave ACMD mode again after the first command after CMD55. | |
544 | if self.is_acmd and cmdstr not in ('55', '63'): | |
545 | self.is_acmd = False | |
624710c9 | 546 | elif self.state.value.startswith('GET_RESPONSE'): |
08c41387 UH |
547 | if len(self.token) == 0: |
548 | # Wait for start bit (CMD = 0). | |
4dfde5a5 | 549 | if cmd_pin != 0: |
08c41387 UH |
550 | continue |
551 | # Call the respective handler method for the response. | |
624710c9 | 552 | s = 'handle_response_%s' % self.state.value[13:].lower() |
08c41387 | 553 | handle_response = getattr(self, s) |
4dfde5a5 | 554 | handle_response(cmd_pin) |