1 | /*- |
---|
2 | * SPDX-License-Identifier: BSD-2-Clause-FreeBSD |
---|
3 | * |
---|
4 | * Copyright (c) 2006 M. Warner Losh. All rights reserved. |
---|
5 | * Copyright (c) 2017 Marius Strobl <marius@FreeBSD.org> |
---|
6 | * Copyright (c) 2015-2016 Ilya Bakulin <kibab@FreeBSD.org> |
---|
7 | * |
---|
8 | * Redistribution and use in source and binary forms, with or without |
---|
9 | * modification, are permitted provided that the following conditions |
---|
10 | * are met: |
---|
11 | * 1. Redistributions of source code must retain the above copyright |
---|
12 | * notice, this list of conditions and the following disclaimer. |
---|
13 | * 2. Redistributions in binary form must reproduce the above copyright |
---|
14 | * notice, this list of conditions and the following disclaimer in the |
---|
15 | * documentation and/or other materials provided with the distribution. |
---|
16 | * |
---|
17 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR |
---|
18 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
---|
19 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. |
---|
20 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, |
---|
21 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
---|
22 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
---|
23 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
---|
24 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
---|
25 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF |
---|
26 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
---|
27 | * |
---|
28 | * Portions of this software may have been developed with reference to |
---|
29 | * the SD Simplified Specification. The following disclaimer may apply: |
---|
30 | * |
---|
31 | * The following conditions apply to the release of the simplified |
---|
32 | * specification ("Simplified Specification") by the SD Card Association and |
---|
33 | * the SD Group. The Simplified Specification is a subset of the complete SD |
---|
34 | * Specification which is owned by the SD Card Association and the SD |
---|
35 | * Group. This Simplified Specification is provided on a non-confidential |
---|
36 | * basis subject to the disclaimers below. Any implementation of the |
---|
37 | * Simplified Specification may require a license from the SD Card |
---|
38 | * Association, SD Group, SD-3C LLC or other third parties. |
---|
39 | * |
---|
40 | * Disclaimers: |
---|
41 | * |
---|
42 | * The information contained in the Simplified Specification is presented only |
---|
43 | * as a standard specification for SD Cards and SD Host/Ancillary products and |
---|
44 | * is provided "AS-IS" without any representations or warranties of any |
---|
45 | * kind. No responsibility is assumed by the SD Group, SD-3C LLC or the SD |
---|
46 | * Card Association for any damages, any infringements of patents or other |
---|
47 | * right of the SD Group, SD-3C LLC, the SD Card Association or any third |
---|
48 | * parties, which may result from its use. No license is granted by |
---|
49 | * implication, estoppel or otherwise under any patent or other rights of the |
---|
50 | * SD Group, SD-3C LLC, the SD Card Association or any third party. Nothing |
---|
51 | * herein shall be construed as an obligation by the SD Group, the SD-3C LLC |
---|
52 | * or the SD Card Association to disclose or distribute any technical |
---|
53 | * information, know-how or other confidential information to any third party. |
---|
54 | * |
---|
55 | * $FreeBSD$ |
---|
56 | */ |
---|
57 | |
---|
58 | #ifndef DEV_MMC_MMCREG_H |
---|
59 | #define DEV_MMC_MMCREG_H |
---|
60 | #ifdef __rtems__ |
---|
61 | #include <rtems/thread.h> |
---|
62 | #endif /* __rtems__ */ |
---|
63 | |
---|
64 | /* |
---|
65 | * This file contains the register definitions for the mmc and sd buses. |
---|
66 | * They are taken from publicly available sources. |
---|
67 | */ |
---|
68 | |
---|
69 | struct mmc_data; |
---|
70 | struct mmc_request; |
---|
71 | |
---|
72 | struct mmc_command { |
---|
73 | uint32_t opcode; |
---|
74 | uint32_t arg; |
---|
75 | uint32_t resp[4]; |
---|
76 | uint32_t flags; /* Expected responses */ |
---|
77 | #define MMC_RSP_PRESENT (1ul << 0) /* Response */ |
---|
78 | #define MMC_RSP_136 (1ul << 1) /* 136 bit response */ |
---|
79 | #define MMC_RSP_CRC (1ul << 2) /* Expect valid crc */ |
---|
80 | #define MMC_RSP_BUSY (1ul << 3) /* Card may send busy */ |
---|
81 | #define MMC_RSP_OPCODE (1ul << 4) /* Response include opcode */ |
---|
82 | #define MMC_RSP_MASK 0x1ful |
---|
83 | #define MMC_CMD_AC (0ul << 5) /* Addressed Command, no data */ |
---|
84 | #define MMC_CMD_ADTC (1ul << 5) /* Addressed Data transfer cmd */ |
---|
85 | #define MMC_CMD_BC (2ul << 5) /* Broadcast command, no response */ |
---|
86 | #define MMC_CMD_BCR (3ul << 5) /* Broadcast command with response */ |
---|
87 | #define MMC_CMD_MASK (3ul << 5) |
---|
88 | |
---|
89 | /* Possible response types defined in the standard: */ |
---|
90 | #define MMC_RSP_NONE (0) |
---|
91 | #define MMC_RSP_R1 (MMC_RSP_PRESENT | MMC_RSP_CRC | MMC_RSP_OPCODE) |
---|
92 | #define MMC_RSP_R1B (MMC_RSP_PRESENT | MMC_RSP_CRC | MMC_RSP_OPCODE | MMC_RSP_BUSY) |
---|
93 | #define MMC_RSP_R2 (MMC_RSP_PRESENT | MMC_RSP_136 | MMC_RSP_CRC) |
---|
94 | #define MMC_RSP_R3 (MMC_RSP_PRESENT) |
---|
95 | #define MMC_RSP_R4 (MMC_RSP_PRESENT) |
---|
96 | #define MMC_RSP_R5 (MMC_RSP_PRESENT | MMC_RSP_CRC | MMC_RSP_OPCODE) |
---|
97 | #define MMC_RSP_R5B (MMC_RSP_PRESENT | MMC_RSP_CRC | MMC_RSP_OPCODE | MMC_RSP_BUSY) |
---|
98 | #define MMC_RSP_R6 (MMC_RSP_PRESENT | MMC_RSP_CRC | MMC_RSP_OPCODE) |
---|
99 | #define MMC_RSP_R7 (MMC_RSP_PRESENT | MMC_RSP_CRC | MMC_RSP_OPCODE) |
---|
100 | #define MMC_RSP(x) ((x) & MMC_RSP_MASK) |
---|
101 | uint32_t retries; |
---|
102 | uint32_t error; |
---|
103 | #define MMC_ERR_NONE 0 |
---|
104 | #define MMC_ERR_TIMEOUT 1 |
---|
105 | #define MMC_ERR_BADCRC 2 |
---|
106 | #define MMC_ERR_FIFO 3 |
---|
107 | #define MMC_ERR_FAILED 4 |
---|
108 | #define MMC_ERR_INVALID 5 |
---|
109 | #define MMC_ERR_NO_MEMORY 6 |
---|
110 | #define MMC_ERR_MAX 6 |
---|
111 | struct mmc_data *data; /* Data segment with cmd */ |
---|
112 | struct mmc_request *mrq; /* backpointer to request */ |
---|
113 | }; |
---|
114 | |
---|
115 | /* |
---|
116 | * R1 responses |
---|
117 | * |
---|
118 | * Types (per SD 2.0 standard) |
---|
119 | * e : error bit |
---|
120 | * s : status bit |
---|
121 | * r : detected and set for the actual command response |
---|
122 | * x : Detected and set during command execution. The host can get |
---|
123 | * the status by issuing a command with R1 response. |
---|
124 | * |
---|
125 | * Clear Condition (per SD 2.0 standard) |
---|
126 | * a : according to the card current state. |
---|
127 | * b : always related to the previous command. reception of a valid |
---|
128 | * command will clear it (with a delay of one command). |
---|
129 | * c : clear by read |
---|
130 | */ |
---|
131 | #define R1_OUT_OF_RANGE (1u << 31) /* erx, c */ |
---|
132 | #define R1_ADDRESS_ERROR (1u << 30) /* erx, c */ |
---|
133 | #define R1_BLOCK_LEN_ERROR (1u << 29) /* erx, c */ |
---|
134 | #define R1_ERASE_SEQ_ERROR (1u << 28) /* er, c */ |
---|
135 | #define R1_ERASE_PARAM (1u << 27) /* erx, c */ |
---|
136 | #define R1_WP_VIOLATION (1u << 26) /* erx, c */ |
---|
137 | #define R1_CARD_IS_LOCKED (1u << 25) /* sx, a */ |
---|
138 | #define R1_LOCK_UNLOCK_FAILED (1u << 24) /* erx, c */ |
---|
139 | #define R1_COM_CRC_ERROR (1u << 23) /* er, b */ |
---|
140 | #define R1_ILLEGAL_COMMAND (1u << 22) /* er, b */ |
---|
141 | #define R1_CARD_ECC_FAILED (1u << 21) /* erx, c */ |
---|
142 | #define R1_CC_ERROR (1u << 20) /* erx, c */ |
---|
143 | #define R1_ERROR (1u << 19) /* erx, c */ |
---|
144 | #define R1_CSD_OVERWRITE (1u << 16) /* erx, c */ |
---|
145 | #define R1_WP_ERASE_SKIP (1u << 15) /* erx, c */ |
---|
146 | #define R1_CARD_ECC_DISABLED (1u << 14) /* sx, a */ |
---|
147 | #define R1_ERASE_RESET (1u << 13) /* sr, c */ |
---|
148 | #define R1_CURRENT_STATE_MASK (0xfu << 9) /* sx, b */ |
---|
149 | #define R1_READY_FOR_DATA (1u << 8) /* sx, a */ |
---|
150 | #define R1_SWITCH_ERROR (1u << 7) /* sx, c */ |
---|
151 | #define R1_APP_CMD (1u << 5) /* sr, c */ |
---|
152 | #define R1_AKE_SEQ_ERROR (1u << 3) /* er, c */ |
---|
153 | #define R1_STATUS(x) ((x) & 0xFFFFE000) |
---|
154 | #define R1_CURRENT_STATE(x) (((x) & R1_CURRENT_STATE_MASK) >> 9) |
---|
155 | #define R1_STATE_IDLE 0 |
---|
156 | #define R1_STATE_READY 1 |
---|
157 | #define R1_STATE_IDENT 2 |
---|
158 | #define R1_STATE_STBY 3 |
---|
159 | #define R1_STATE_TRAN 4 |
---|
160 | #define R1_STATE_DATA 5 |
---|
161 | #define R1_STATE_RCV 6 |
---|
162 | #define R1_STATE_PRG 7 |
---|
163 | #define R1_STATE_DIS 8 |
---|
164 | |
---|
165 | /* R4 responses (SDIO) */ |
---|
166 | #define R4_IO_NUM_FUNCTIONS(ocr) (((ocr) >> 28) & 0x3) |
---|
167 | #define R4_IO_MEM_PRESENT (0x1 << 27) |
---|
168 | #define R4_IO_OCR_MASK 0x00fffff0 |
---|
169 | |
---|
170 | /* |
---|
171 | * R5 responses |
---|
172 | * |
---|
173 | * Types (per SD 2.0 standard) |
---|
174 | * e : error bit |
---|
175 | * s : status bit |
---|
176 | * r : detected and set for the actual command response |
---|
177 | * x : Detected and set during command execution. The host can get |
---|
178 | * the status by issuing a command with R1 response. |
---|
179 | * |
---|
180 | * Clear Condition (per SD 2.0 standard) |
---|
181 | * a : according to the card current state. |
---|
182 | * b : always related to the previous command. reception of a valid |
---|
183 | * command will clear it (with a delay of one command). |
---|
184 | * c : clear by read |
---|
185 | */ |
---|
186 | #define R5_COM_CRC_ERROR (1u << 15) /* er, b */ |
---|
187 | #define R5_ILLEGAL_COMMAND (1u << 14) /* er, b */ |
---|
188 | #define R5_IO_CURRENT_STATE_MASK (3u << 12) /* s, b */ |
---|
189 | #define R5_IO_CURRENT_STATE(x) (((x) & R5_IO_CURRENT_STATE_MASK) >> 12) |
---|
190 | #define R5_ERROR (1u << 11) /* erx, c */ |
---|
191 | #define R5_FUNCTION_NUMBER (1u << 9) /* er, c */ |
---|
192 | #define R5_OUT_OF_RANGE (1u << 8) /* er, c */ |
---|
193 | |
---|
194 | struct mmc_data { |
---|
195 | size_t len; /* size of the data */ |
---|
196 | size_t xfer_len; |
---|
197 | void *data; /* data buffer */ |
---|
198 | uint32_t flags; |
---|
199 | #define MMC_DATA_WRITE (1UL << 0) |
---|
200 | #define MMC_DATA_READ (1UL << 1) |
---|
201 | #define MMC_DATA_STREAM (1UL << 2) |
---|
202 | #define MMC_DATA_MULTI (1UL << 3) |
---|
203 | struct mmc_request *mrq; |
---|
204 | }; |
---|
205 | |
---|
206 | struct mmc_request { |
---|
207 | struct mmc_command *cmd; |
---|
208 | struct mmc_command *stop; |
---|
209 | void (*done)(struct mmc_request *); /* Completion function */ |
---|
210 | void *done_data; /* requestor set data */ |
---|
211 | uint32_t flags; |
---|
212 | #ifndef __rtems__ |
---|
213 | #define MMC_REQ_DONE 1 |
---|
214 | #endif /* __rtems__ */ |
---|
215 | #define MMC_TUNE_DONE 2 |
---|
216 | #ifdef __rtems__ |
---|
217 | rtems_binary_semaphore req_done; |
---|
218 | #endif /* __rtems__ */ |
---|
219 | }; |
---|
220 | |
---|
221 | /* Command definitions */ |
---|
222 | |
---|
223 | /* Class 0 and 1: Basic commands & read stream commands */ |
---|
224 | #define MMC_GO_IDLE_STATE 0 |
---|
225 | #define MMC_SEND_OP_COND 1 |
---|
226 | #define MMC_ALL_SEND_CID 2 |
---|
227 | #define MMC_SET_RELATIVE_ADDR 3 |
---|
228 | #define SD_SEND_RELATIVE_ADDR 3 |
---|
229 | #define MMC_SET_DSR 4 |
---|
230 | #define MMC_SLEEP_AWAKE 5 |
---|
231 | #define IO_SEND_OP_COND 5 |
---|
232 | #define MMC_SWITCH_FUNC 6 |
---|
233 | #define MMC_SWITCH_FUNC_CMDS 0 |
---|
234 | #define MMC_SWITCH_FUNC_SET 1 |
---|
235 | #define MMC_SWITCH_FUNC_CLR 2 |
---|
236 | #define MMC_SWITCH_FUNC_WR 3 |
---|
237 | #define MMC_SELECT_CARD 7 |
---|
238 | #define MMC_DESELECT_CARD 7 |
---|
239 | #define MMC_SEND_EXT_CSD 8 |
---|
240 | #define SD_SEND_IF_COND 8 |
---|
241 | #define MMC_SEND_CSD 9 |
---|
242 | #define MMC_SEND_CID 10 |
---|
243 | #define MMC_READ_DAT_UNTIL_STOP 11 |
---|
244 | #define MMC_STOP_TRANSMISSION 12 |
---|
245 | #define MMC_SEND_STATUS 13 |
---|
246 | #define MMC_BUSTEST_R 14 |
---|
247 | #define MMC_GO_INACTIVE_STATE 15 |
---|
248 | #define MMC_BUSTEST_W 19 |
---|
249 | |
---|
250 | /* Class 2: Block oriented read commands */ |
---|
251 | #define MMC_SET_BLOCKLEN 16 |
---|
252 | #define MMC_READ_SINGLE_BLOCK 17 |
---|
253 | #define MMC_READ_MULTIPLE_BLOCK 18 |
---|
254 | #define MMC_SEND_TUNING_BLOCK 19 |
---|
255 | #define MMC_SEND_TUNING_BLOCK_HS200 21 |
---|
256 | |
---|
257 | /* Class 3: Stream write commands */ |
---|
258 | #define MMC_WRITE_DAT_UNTIL_STOP 20 |
---|
259 | /* reserved: 22 */ |
---|
260 | |
---|
261 | /* Class 4: Block oriented write commands */ |
---|
262 | #define MMC_SET_BLOCK_COUNT 23 |
---|
263 | #define MMC_WRITE_BLOCK 24 |
---|
264 | #define MMC_WRITE_MULTIPLE_BLOCK 25 |
---|
265 | #define MMC_PROGARM_CID 26 |
---|
266 | #define MMC_PROGRAM_CSD 27 |
---|
267 | |
---|
268 | /* Class 6: Block oriented write protection commands */ |
---|
269 | #define MMC_SET_WRITE_PROT 28 |
---|
270 | #define MMC_CLR_WRITE_PROT 29 |
---|
271 | #define MMC_SEND_WRITE_PROT 30 |
---|
272 | /* reserved: 31 */ |
---|
273 | |
---|
274 | /* Class 5: Erase commands */ |
---|
275 | #define SD_ERASE_WR_BLK_START 32 |
---|
276 | #define SD_ERASE_WR_BLK_END 33 |
---|
277 | /* 34 -- reserved old command */ |
---|
278 | #define MMC_ERASE_GROUP_START 35 |
---|
279 | #define MMC_ERASE_GROUP_END 36 |
---|
280 | /* 37 -- reserved old command */ |
---|
281 | #define MMC_ERASE 38 |
---|
282 | #define MMC_ERASE_ERASE 0x00000000 |
---|
283 | #define MMC_ERASE_TRIM 0x00000001 |
---|
284 | #define MMC_ERASE_FULE 0x00000002 |
---|
285 | #define MMC_ERASE_DISCARD 0x00000003 |
---|
286 | #define MMC_ERASE_SECURE_ERASE 0x80000000 |
---|
287 | #define MMC_ERASE_SECURE_TRIM1 0x80000001 |
---|
288 | #define MMC_ERASE_SECURE_TRIM2 0x80008000 |
---|
289 | |
---|
290 | /* Class 9: I/O mode commands */ |
---|
291 | #define MMC_FAST_IO 39 |
---|
292 | #define MMC_GO_IRQ_STATE 40 |
---|
293 | /* reserved: 41 */ |
---|
294 | |
---|
295 | /* Class 7: Lock card */ |
---|
296 | #define MMC_LOCK_UNLOCK 42 |
---|
297 | /* reserved: 43 */ |
---|
298 | /* reserved: 44 */ |
---|
299 | /* reserved: 45 */ |
---|
300 | /* reserved: 46 */ |
---|
301 | /* reserved: 47 */ |
---|
302 | /* reserved: 48 */ |
---|
303 | /* reserved: 49 */ |
---|
304 | /* reserved: 50 */ |
---|
305 | /* reserved: 51 */ |
---|
306 | /* reserved: 54 */ |
---|
307 | |
---|
308 | /* Class 8: Application specific commands */ |
---|
309 | #define MMC_APP_CMD 55 |
---|
310 | #define MMC_GEN_CMD 56 |
---|
311 | /* reserved: 57 */ |
---|
312 | /* reserved: 58 */ |
---|
313 | /* reserved: 59 */ |
---|
314 | /* reserved for mfg: 60 */ |
---|
315 | /* reserved for mfg: 61 */ |
---|
316 | /* reserved for mfg: 62 */ |
---|
317 | /* reserved for mfg: 63 */ |
---|
318 | |
---|
319 | /* Class 9: I/O cards (sd) */ |
---|
320 | #define SD_IO_RW_DIRECT 52 |
---|
321 | /* CMD52 arguments */ |
---|
322 | #define SD_ARG_CMD52_READ (0 << 31) |
---|
323 | #define SD_ARG_CMD52_WRITE (1 << 31) |
---|
324 | #define SD_ARG_CMD52_FUNC_SHIFT 28 |
---|
325 | #define SD_ARG_CMD52_FUNC_MASK 0x7 |
---|
326 | #define SD_ARG_CMD52_EXCHANGE (1 << 27) |
---|
327 | #define SD_ARG_CMD52_REG_SHIFT 9 |
---|
328 | #define SD_ARG_CMD52_REG_MASK 0x1ffff |
---|
329 | #define SD_ARG_CMD52_DATA_SHIFT 0 |
---|
330 | #define SD_ARG_CMD52_DATA_MASK 0xff |
---|
331 | #define SD_R5_DATA(resp) ((resp)[0] & 0xff) |
---|
332 | |
---|
333 | #define SD_IO_RW_EXTENDED 53 |
---|
334 | /* CMD53 arguments */ |
---|
335 | #define SD_ARG_CMD53_READ (0 << 31) |
---|
336 | #define SD_ARG_CMD53_WRITE (1 << 31) |
---|
337 | #define SD_ARG_CMD53_FUNC_SHIFT 28 |
---|
338 | #define SD_ARG_CMD53_FUNC_MASK 0x7 |
---|
339 | #define SD_ARG_CMD53_BLOCK_MODE (1 << 27) |
---|
340 | #define SD_ARG_CMD53_INCREMENT (1 << 26) |
---|
341 | #define SD_ARG_CMD53_REG_SHIFT 9 |
---|
342 | #define SD_ARG_CMD53_REG_MASK 0x1ffff |
---|
343 | #define SD_ARG_CMD53_LENGTH_SHIFT 0 |
---|
344 | #define SD_ARG_CMD53_LENGTH_MASK 0x1ff |
---|
345 | #define SD_ARG_CMD53_LENGTH_MAX 64 /* XXX should be 511? */ |
---|
346 | |
---|
347 | /* Class 10: Switch function commands */ |
---|
348 | #define SD_SWITCH_FUNC 6 |
---|
349 | /* reserved: 34 */ |
---|
350 | /* reserved: 35 */ |
---|
351 | /* reserved: 36 */ |
---|
352 | /* reserved: 37 */ |
---|
353 | /* reserved: 50 */ |
---|
354 | /* reserved: 57 */ |
---|
355 | |
---|
356 | /* Application specific commands for SD */ |
---|
357 | #define ACMD_SET_BUS_WIDTH 6 |
---|
358 | #define ACMD_SD_STATUS 13 |
---|
359 | #define ACMD_SEND_NUM_WR_BLOCKS 22 |
---|
360 | #define ACMD_SET_WR_BLK_ERASE_COUNT 23 |
---|
361 | #define ACMD_SD_SEND_OP_COND 41 |
---|
362 | #define ACMD_SET_CLR_CARD_DETECT 42 |
---|
363 | #define ACMD_SEND_SCR 51 |
---|
364 | |
---|
365 | /* |
---|
366 | * EXT_CSD fields |
---|
367 | */ |
---|
368 | #define EXT_CSD_FLUSH_CACHE 32 /* W/E */ |
---|
369 | #define EXT_CSD_CACHE_CTRL 33 /* R/W/E */ |
---|
370 | #define EXT_CSD_EXT_PART_ATTR 52 /* R/W, 2 bytes */ |
---|
371 | #define EXT_CSD_ENH_START_ADDR 136 /* R/W, 4 bytes */ |
---|
372 | #define EXT_CSD_ENH_SIZE_MULT 140 /* R/W, 3 bytes */ |
---|
373 | #define EXT_CSD_GP_SIZE_MULT 143 /* R/W, 12 bytes */ |
---|
374 | #define EXT_CSD_PART_SET 155 /* R/W */ |
---|
375 | #define EXT_CSD_PART_ATTR 156 /* R/W */ |
---|
376 | #define EXT_CSD_PART_SUPPORT 160 /* RO */ |
---|
377 | #define EXT_CSD_RPMB_MULT 168 /* RO */ |
---|
378 | #define EXT_CSD_BOOT_WP_STATUS 174 /* RO */ |
---|
379 | #define EXT_CSD_ERASE_GRP_DEF 175 /* R/W */ |
---|
380 | #define EXT_CSD_PART_CONFIG 179 /* R/W */ |
---|
381 | #define EXT_CSD_BUS_WIDTH 183 /* R/W */ |
---|
382 | #define EXT_CSD_STROBE_SUPPORT 184 /* RO */ |
---|
383 | #define EXT_CSD_HS_TIMING 185 /* R/W */ |
---|
384 | #define EXT_CSD_POWER_CLASS 187 /* R/W */ |
---|
385 | #define EXT_CSD_CARD_TYPE 196 /* RO */ |
---|
386 | #define EXT_CSD_DRIVER_STRENGTH 197 /* RO */ |
---|
387 | #define EXT_CSD_REV 192 /* RO */ |
---|
388 | #define EXT_CSD_PART_SWITCH_TO 199 /* RO */ |
---|
389 | #define EXT_CSD_PWR_CL_52_195 200 /* RO */ |
---|
390 | #define EXT_CSD_PWR_CL_26_195 201 /* RO */ |
---|
391 | #define EXT_CSD_PWR_CL_52_360 202 /* RO */ |
---|
392 | #define EXT_CSD_PWR_CL_26_360 203 /* RO */ |
---|
393 | #define EXT_CSD_SEC_CNT 212 /* RO, 4 bytes */ |
---|
394 | #define EXT_CSD_HC_WP_GRP_SIZE 221 /* RO */ |
---|
395 | #define EXT_CSD_ERASE_TO_MULT 223 /* RO */ |
---|
396 | #define EXT_CSD_ERASE_GRP_SIZE 224 /* RO */ |
---|
397 | #define EXT_CSD_BOOT_SIZE_MULT 226 /* RO */ |
---|
398 | #define EXT_CSD_SEC_FEATURE_SUPPORT 231 /* RO */ |
---|
399 | #define EXT_CSD_PWR_CL_200_195 236 /* RO */ |
---|
400 | #define EXT_CSD_PWR_CL_200_360 237 /* RO */ |
---|
401 | #define EXT_CSD_PWR_CL_52_195_DDR 238 /* RO */ |
---|
402 | #define EXT_CSD_PWR_CL_52_360_DDR 239 /* RO */ |
---|
403 | #define EXT_CSD_CACHE_FLUSH_POLICY 249 /* RO */ |
---|
404 | #define EXT_CSD_GEN_CMD6_TIME 248 /* RO */ |
---|
405 | #define EXT_CSD_CACHE_SIZE 249 /* RO, 4 bytes */ |
---|
406 | #define EXT_CSD_PWR_CL_200_360_DDR 253 /* RO */ |
---|
407 | |
---|
408 | /* |
---|
409 | * EXT_CSD field definitions |
---|
410 | */ |
---|
411 | #define EXT_CSD_FLUSH_CACHE_FLUSH 0x01 |
---|
412 | #define EXT_CSD_FLUSH_CACHE_BARRIER 0x02 |
---|
413 | |
---|
414 | #define EXT_CSD_CACHE_CTRL_CACHE_EN 0x01 |
---|
415 | |
---|
416 | #define EXT_CSD_EXT_PART_ATTR_DEFAULT 0x0 |
---|
417 | #define EXT_CSD_EXT_PART_ATTR_SYSTEMCODE 0x1 |
---|
418 | #define EXT_CSD_EXT_PART_ATTR_NPERSISTENT 0x2 |
---|
419 | |
---|
420 | #define EXT_CSD_PART_SET_COMPLETED 0x01 |
---|
421 | |
---|
422 | #define EXT_CSD_PART_ATTR_ENH_USR 0x01 |
---|
423 | #define EXT_CSD_PART_ATTR_ENH_GP0 0x02 |
---|
424 | #define EXT_CSD_PART_ATTR_ENH_GP1 0x04 |
---|
425 | #define EXT_CSD_PART_ATTR_ENH_GP2 0x08 |
---|
426 | #define EXT_CSD_PART_ATTR_ENH_GP3 0x10 |
---|
427 | #define EXT_CSD_PART_ATTR_ENH_MASK 0x1f |
---|
428 | |
---|
429 | #define EXT_CSD_PART_SUPPORT_EN 0x01 |
---|
430 | #define EXT_CSD_PART_SUPPORT_ENH_ATTR_EN 0x02 |
---|
431 | #define EXT_CSD_PART_SUPPORT_EXT_ATTR_EN 0x04 |
---|
432 | |
---|
433 | #define EXT_CSD_BOOT_WP_STATUS_BOOT0_PWR 0x01 |
---|
434 | #define EXT_CSD_BOOT_WP_STATUS_BOOT0_PERM 0x02 |
---|
435 | #define EXT_CSD_BOOT_WP_STATUS_BOOT0_MASK 0x03 |
---|
436 | #define EXT_CSD_BOOT_WP_STATUS_BOOT1_PWR 0x04 |
---|
437 | #define EXT_CSD_BOOT_WP_STATUS_BOOT1_PERM 0x08 |
---|
438 | #define EXT_CSD_BOOT_WP_STATUS_BOOT1_MASK 0x0c |
---|
439 | |
---|
440 | #define EXT_CSD_ERASE_GRP_DEF_EN 0x01 |
---|
441 | |
---|
442 | #define EXT_CSD_PART_CONFIG_ACC_DEFAULT 0x00 |
---|
443 | #define EXT_CSD_PART_CONFIG_ACC_BOOT0 0x01 |
---|
444 | #define EXT_CSD_PART_CONFIG_ACC_BOOT1 0x02 |
---|
445 | #define EXT_CSD_PART_CONFIG_ACC_RPMB 0x03 |
---|
446 | #define EXT_CSD_PART_CONFIG_ACC_GP0 0x04 |
---|
447 | #define EXT_CSD_PART_CONFIG_ACC_GP1 0x05 |
---|
448 | #define EXT_CSD_PART_CONFIG_ACC_GP2 0x06 |
---|
449 | #define EXT_CSD_PART_CONFIG_ACC_GP3 0x07 |
---|
450 | #define EXT_CSD_PART_CONFIG_ACC_MASK 0x07 |
---|
451 | #define EXT_CSD_PART_CONFIG_BOOT0 0x08 |
---|
452 | #define EXT_CSD_PART_CONFIG_BOOT1 0x10 |
---|
453 | #define EXT_CSD_PART_CONFIG_BOOT_USR 0x38 |
---|
454 | #define EXT_CSD_PART_CONFIG_BOOT_MASK 0x38 |
---|
455 | #define EXT_CSD_PART_CONFIG_BOOT_ACK 0x40 |
---|
456 | |
---|
457 | #define EXT_CSD_CMD_SET_NORMAL 1 |
---|
458 | #define EXT_CSD_CMD_SET_SECURE 2 |
---|
459 | #define EXT_CSD_CMD_SET_CPSECURE 4 |
---|
460 | |
---|
461 | #define EXT_CSD_HS_TIMING_BC 0 |
---|
462 | #define EXT_CSD_HS_TIMING_HS 1 |
---|
463 | #define EXT_CSD_HS_TIMING_HS200 2 |
---|
464 | #define EXT_CSD_HS_TIMING_HS400 3 |
---|
465 | #define EXT_CSD_HS_TIMING_DRV_STR_SHIFT 4 |
---|
466 | |
---|
467 | #define EXT_CSD_POWER_CLASS_8BIT_MASK 0xf0 |
---|
468 | #define EXT_CSD_POWER_CLASS_8BIT_SHIFT 4 |
---|
469 | #define EXT_CSD_POWER_CLASS_4BIT_MASK 0x0f |
---|
470 | #define EXT_CSD_POWER_CLASS_4BIT_SHIFT 0 |
---|
471 | |
---|
472 | #define EXT_CSD_CARD_TYPE_HS_26 0x0001 |
---|
473 | #define EXT_CSD_CARD_TYPE_HS_52 0x0002 |
---|
474 | #define EXT_CSD_CARD_TYPE_DDR_52_1_8V 0x0004 |
---|
475 | #define EXT_CSD_CARD_TYPE_DDR_52_1_2V 0x0008 |
---|
476 | #define EXT_CSD_CARD_TYPE_HS200_1_8V 0x0010 |
---|
477 | #define EXT_CSD_CARD_TYPE_HS200_1_2V 0x0020 |
---|
478 | #define EXT_CSD_CARD_TYPE_HS400_1_8V 0x0040 |
---|
479 | #define EXT_CSD_CARD_TYPE_HS400_1_2V 0x0080 |
---|
480 | |
---|
481 | #define EXT_CSD_BUS_WIDTH_1 0 |
---|
482 | #define EXT_CSD_BUS_WIDTH_4 1 |
---|
483 | #define EXT_CSD_BUS_WIDTH_8 2 |
---|
484 | #define EXT_CSD_BUS_WIDTH_4_DDR 5 |
---|
485 | #define EXT_CSD_BUS_WIDTH_8_DDR 6 |
---|
486 | #define EXT_CSD_BUS_WIDTH_ES 0x80 |
---|
487 | |
---|
488 | #define EXT_CSD_STROBE_SUPPORT_EN 0x01 |
---|
489 | |
---|
490 | #define EXT_CSD_SEC_FEATURE_SUPPORT_ER_EN 0x01 |
---|
491 | #define EXT_CSD_SEC_FEATURE_SUPPORT_BD_BLK_EN 0x04 |
---|
492 | #define EXT_CSD_SEC_FEATURE_SUPPORT_GB_CL_EN 0x10 |
---|
493 | #define EXT_CSD_SEC_FEATURE_SUPPORT_SANITIZE 0x40 |
---|
494 | |
---|
495 | #define EXT_CSD_CACHE_FLUSH_POLICY_FIFO 0x01 |
---|
496 | |
---|
497 | /* |
---|
498 | * Vendor specific EXT_CSD fields |
---|
499 | */ |
---|
500 | /* SanDisk iNAND */ |
---|
501 | #define EXT_CSD_INAND_CMD38 113 |
---|
502 | #define EXT_CSD_INAND_CMD38_ERASE 0x00 |
---|
503 | #define EXT_CSD_INAND_CMD38_TRIM 0x01 |
---|
504 | #define EXT_CSD_INAND_CMD38_SECURE_ERASE 0x80 |
---|
505 | #define EXT_CSD_INAND_CMD38_SECURE_TRIM1 0x81 |
---|
506 | #define EXT_CSD_INAND_CMD38_SECURE_TRIM2 0x82 |
---|
507 | |
---|
508 | #define MMC_TYPE_HS_26_MAX 26000000 |
---|
509 | #define MMC_TYPE_HS_52_MAX 52000000 |
---|
510 | #define MMC_TYPE_DDR52_MAX 52000000 |
---|
511 | #define MMC_TYPE_HS200_HS400ES_MAX 200000000 |
---|
512 | |
---|
513 | /* |
---|
514 | * SD bus widths |
---|
515 | */ |
---|
516 | #define SD_BUS_WIDTH_1 0 |
---|
517 | #define SD_BUS_WIDTH_4 2 |
---|
518 | |
---|
519 | /* |
---|
520 | * SD Switch |
---|
521 | */ |
---|
522 | #define SD_SWITCH_MODE_CHECK 0 |
---|
523 | #define SD_SWITCH_MODE_SET 1 |
---|
524 | #define SD_SWITCH_GROUP1 0 |
---|
525 | #define SD_SWITCH_NORMAL_MODE 0 |
---|
526 | #define SD_SWITCH_HS_MODE 1 |
---|
527 | #define SD_SWITCH_SDR50_MODE 2 |
---|
528 | #define SD_SWITCH_SDR104_MODE 3 |
---|
529 | #define SD_SWITCH_DDR50 4 |
---|
530 | #define SD_SWITCH_NOCHANGE 0xF |
---|
531 | |
---|
532 | #define SD_CLR_CARD_DETECT 0 |
---|
533 | #define SD_SET_CARD_DETECT 1 |
---|
534 | |
---|
535 | #define SD_HS_MAX 50000000 |
---|
536 | #define SD_DDR50_MAX 50000000 |
---|
537 | #define SD_SDR12_MAX 25000000 |
---|
538 | #define SD_SDR25_MAX 50000000 |
---|
539 | #define SD_SDR50_MAX 100000000 |
---|
540 | #define SD_SDR104_MAX 208000000 |
---|
541 | |
---|
542 | /* Specifications require 400 kHz max. during ID phase. */ |
---|
543 | #define SD_MMC_CARD_ID_FREQUENCY 400000 |
---|
544 | |
---|
545 | /* |
---|
546 | * SDIO Direct & Extended I/O |
---|
547 | */ |
---|
548 | #define SD_IO_RW_WR (1u << 31) |
---|
549 | #define SD_IO_RW_FUNC(x) (((x) & 0x7) << 28) |
---|
550 | #define SD_IO_RW_RAW (1u << 27) |
---|
551 | #define SD_IO_RW_INCR (1u << 26) |
---|
552 | #define SD_IO_RW_ADR(x) (((x) & 0x1FFFF) << 9) |
---|
553 | #define SD_IO_RW_DAT(x) (((x) & 0xFF) << 0) |
---|
554 | #define SD_IO_RW_LEN(x) (((x) & 0xFF) << 0) |
---|
555 | |
---|
556 | #define SD_IOE_RW_LEN(x) (((x) & 0x1FF) << 0) |
---|
557 | #define SD_IOE_RW_BLK (1u << 27) |
---|
558 | |
---|
559 | /* Card Common Control Registers (CCCR) */ |
---|
560 | #define SD_IO_CCCR_START 0x00000 |
---|
561 | #define SD_IO_CCCR_SIZE 0x100 |
---|
562 | #define SD_IO_CCCR_FN_ENABLE 0x02 |
---|
563 | #define SD_IO_CCCR_FN_READY 0x03 |
---|
564 | #define SD_IO_CCCR_INT_ENABLE 0x04 |
---|
565 | #define SD_IO_CCCR_INT_PENDING 0x05 |
---|
566 | #define SD_IO_CCCR_CTL 0x06 |
---|
567 | #define CCCR_CTL_RES (1 << 3) |
---|
568 | #define SD_IO_CCCR_BUS_WIDTH 0x07 |
---|
569 | #define CCCR_BUS_WIDTH_4 (1 << 1) |
---|
570 | #define CCCR_BUS_WIDTH_1 (1 << 0) |
---|
571 | #define SD_IO_CCCR_CARDCAP 0x08 |
---|
572 | #define SD_IO_CCCR_CISPTR 0x09 /* XXX 9-10, 10-11, or 9-12 */ |
---|
573 | |
---|
574 | /* Function Basic Registers (FBR) */ |
---|
575 | #define SD_IO_FBR_START 0x00100 |
---|
576 | #define SD_IO_FBR_SIZE 0x00700 |
---|
577 | |
---|
578 | /* Card Information Structure (CIS) */ |
---|
579 | #define SD_IO_CIS_START 0x01000 |
---|
580 | #define SD_IO_CIS_SIZE 0x17000 |
---|
581 | |
---|
582 | /* CIS tuple codes (based on PC Card 16) */ |
---|
583 | #define SD_IO_CISTPL_VERS_1 0x15 |
---|
584 | #define SD_IO_CISTPL_MANFID 0x20 |
---|
585 | #define SD_IO_CISTPL_FUNCID 0x21 |
---|
586 | #define SD_IO_CISTPL_FUNCE 0x22 |
---|
587 | #define SD_IO_CISTPL_END 0xff |
---|
588 | |
---|
589 | /* CISTPL_FUNCID codes */ |
---|
590 | /* OpenBSD incorrectly defines 0x0c as FUNCTION_WLAN */ |
---|
591 | /* #define SDMMC_FUNCTION_WLAN 0x0c */ |
---|
592 | |
---|
593 | /* OCR bits */ |
---|
594 | |
---|
595 | /* |
---|
596 | * in SD 2.0 spec, bits 8-14 are now marked reserved |
---|
597 | * Low voltage in SD2.0 spec is bit 7, TBD voltage |
---|
598 | * Low voltage in MC 3.31 spec is bit 7, 1.65-1.95V |
---|
599 | * Specs prior to MMC 3.31 defined bits 0-7 as voltages down to 1.5V. |
---|
600 | * 3.31 redefined them to be reserved and also said that cards had to |
---|
601 | * support the 2.7-3.6V and fixed the OCR to be 0xfff8000 for high voltage |
---|
602 | * cards. MMC 4.0 says that a dual voltage card responds with 0xfff8080. |
---|
603 | * Looks like the fine-grained control of the voltage tolerance ranges |
---|
604 | * was abandoned. |
---|
605 | * |
---|
606 | * The MMC_OCR_CCS appears to be valid for only SD cards. |
---|
607 | */ |
---|
608 | #define MMC_OCR_VOLTAGE 0x3fffffffU /* Vdd Voltage mask */ |
---|
609 | #define MMC_OCR_LOW_VOLTAGE (1u << 7) /* Low Voltage Range -- tbd */ |
---|
610 | #define MMC_OCR_MIN_VOLTAGE_SHIFT 7 |
---|
611 | #define MMC_OCR_200_210 (1U << 8) /* Vdd voltage 2.00 ~ 2.10 */ |
---|
612 | #define MMC_OCR_210_220 (1U << 9) /* Vdd voltage 2.10 ~ 2.20 */ |
---|
613 | #define MMC_OCR_220_230 (1U << 10) /* Vdd voltage 2.20 ~ 2.30 */ |
---|
614 | #define MMC_OCR_230_240 (1U << 11) /* Vdd voltage 2.30 ~ 2.40 */ |
---|
615 | #define MMC_OCR_240_250 (1U << 12) /* Vdd voltage 2.40 ~ 2.50 */ |
---|
616 | #define MMC_OCR_250_260 (1U << 13) /* Vdd voltage 2.50 ~ 2.60 */ |
---|
617 | #define MMC_OCR_260_270 (1U << 14) /* Vdd voltage 2.60 ~ 2.70 */ |
---|
618 | #define MMC_OCR_270_280 (1U << 15) /* Vdd voltage 2.70 ~ 2.80 */ |
---|
619 | #define MMC_OCR_280_290 (1U << 16) /* Vdd voltage 2.80 ~ 2.90 */ |
---|
620 | #define MMC_OCR_290_300 (1U << 17) /* Vdd voltage 2.90 ~ 3.00 */ |
---|
621 | #define MMC_OCR_300_310 (1U << 18) /* Vdd voltage 3.00 ~ 3.10 */ |
---|
622 | #define MMC_OCR_310_320 (1U << 19) /* Vdd voltage 3.10 ~ 3.20 */ |
---|
623 | #define MMC_OCR_320_330 (1U << 20) /* Vdd voltage 3.20 ~ 3.30 */ |
---|
624 | #define MMC_OCR_330_340 (1U << 21) /* Vdd voltage 3.30 ~ 3.40 */ |
---|
625 | #define MMC_OCR_340_350 (1U << 22) /* Vdd voltage 3.40 ~ 3.50 */ |
---|
626 | #define MMC_OCR_350_360 (1U << 23) /* Vdd voltage 3.50 ~ 3.60 */ |
---|
627 | #define MMC_OCR_MAX_VOLTAGE_SHIFT 23 |
---|
628 | #define MMC_OCR_S18R (1U << 24) /* Switching to 1.8 V requested (SD) */ |
---|
629 | #define MMC_OCR_S18A MMC_OCR_S18R /* Switching to 1.8 V accepted (SD) */ |
---|
630 | #define MMC_OCR_XPC (1U << 28) /* SDXC Power Control */ |
---|
631 | #define MMC_OCR_ACCESS_MODE_BYTE (0U << 29) /* Access Mode Byte (MMC) */ |
---|
632 | #define MMC_OCR_ACCESS_MODE_SECT (1U << 29) /* Access Mode Sector (MMC) */ |
---|
633 | #define MMC_OCR_ACCESS_MODE_MASK (3U << 29) |
---|
634 | #define MMC_OCR_CCS (1u << 30) /* Card Capacity status (SD vs SDHC) */ |
---|
635 | #define MMC_OCR_CARD_BUSY (1U << 31) /* Card Power up status */ |
---|
636 | |
---|
637 | /* CSD -- decoded structure */ |
---|
638 | struct mmc_cid { |
---|
639 | uint32_t mid; |
---|
640 | char pnm[8]; |
---|
641 | uint32_t psn; |
---|
642 | uint16_t oid; |
---|
643 | uint16_t mdt_year; |
---|
644 | uint8_t mdt_month; |
---|
645 | uint8_t prv; |
---|
646 | uint8_t fwrev; |
---|
647 | }; |
---|
648 | |
---|
649 | struct mmc_csd { |
---|
650 | uint8_t csd_structure; |
---|
651 | uint8_t spec_vers; |
---|
652 | uint16_t ccc; |
---|
653 | uint16_t tacc; |
---|
654 | uint32_t nsac; |
---|
655 | uint32_t r2w_factor; |
---|
656 | uint32_t tran_speed; |
---|
657 | uint32_t read_bl_len; |
---|
658 | uint32_t write_bl_len; |
---|
659 | uint32_t vdd_r_curr_min; |
---|
660 | uint32_t vdd_r_curr_max; |
---|
661 | uint32_t vdd_w_curr_min; |
---|
662 | uint32_t vdd_w_curr_max; |
---|
663 | uint32_t wp_grp_size; |
---|
664 | uint32_t erase_sector; |
---|
665 | uint64_t capacity; |
---|
666 | unsigned int read_bl_partial:1, |
---|
667 | read_blk_misalign:1, |
---|
668 | write_bl_partial:1, |
---|
669 | write_blk_misalign:1, |
---|
670 | dsr_imp:1, |
---|
671 | erase_blk_en:1, |
---|
672 | wp_grp_enable:1; |
---|
673 | }; |
---|
674 | |
---|
675 | struct mmc_scr { |
---|
676 | unsigned char sda_vsn; |
---|
677 | unsigned char bus_widths; |
---|
678 | #define SD_SCR_BUS_WIDTH_1 (1 << 0) |
---|
679 | #define SD_SCR_BUS_WIDTH_4 (1 << 2) |
---|
680 | }; |
---|
681 | |
---|
682 | struct mmc_sd_status { |
---|
683 | uint8_t bus_width; |
---|
684 | uint8_t secured_mode; |
---|
685 | uint16_t card_type; |
---|
686 | uint16_t prot_area; |
---|
687 | uint8_t speed_class; |
---|
688 | uint8_t perf_move; |
---|
689 | uint8_t au_size; |
---|
690 | uint16_t erase_size; |
---|
691 | uint8_t erase_timeout; |
---|
692 | uint8_t erase_offset; |
---|
693 | }; |
---|
694 | |
---|
695 | struct mmc_quirk { |
---|
696 | uint32_t mid; |
---|
697 | #define MMC_QUIRK_MID_ANY ((uint32_t)-1) |
---|
698 | uint16_t oid; |
---|
699 | #define MMC_QUIRK_OID_ANY ((uint16_t)-1) |
---|
700 | const char *pnm; |
---|
701 | uint32_t quirks; |
---|
702 | #define MMC_QUIRK_INAND_CMD38 0x0001 |
---|
703 | #define MMC_QUIRK_BROKEN_TRIM 0x0002 |
---|
704 | }; |
---|
705 | |
---|
706 | #define MMC_QUIRKS_FMT "\020" "\001INAND_CMD38" "\002BROKEN_TRIM" |
---|
707 | |
---|
708 | /* |
---|
709 | * Various MMC/SD constants |
---|
710 | */ |
---|
711 | #define MMC_BOOT_RPMB_BLOCK_SIZE (128 * 1024) |
---|
712 | |
---|
713 | #define MMC_EXTCSD_SIZE 512 |
---|
714 | |
---|
715 | #define MMC_PART_GP_MAX 4 |
---|
716 | #define MMC_PART_MAX 8 |
---|
717 | |
---|
718 | #define MMC_TUNING_MAX 64 /* Maximum tuning iterations */ |
---|
719 | #define MMC_TUNING_LEN 64 /* Size of tuning data */ |
---|
720 | #define MMC_TUNING_LEN_HS200 128 /* Size of tuning data in HS200 mode */ |
---|
721 | |
---|
722 | /* |
---|
723 | * Older versions of the MMC standard had a variable sector size. However, |
---|
724 | * I've been able to find no old MMC or SD cards that have a non 512 |
---|
725 | * byte sector size anywhere, so we assume that such cards are very rare |
---|
726 | * and only note their existence in passing here... |
---|
727 | */ |
---|
728 | #define MMC_SECTOR_SIZE 512 |
---|
729 | |
---|
730 | #endif /* DEV_MMCREG_H */ |
---|