Merge tag 'xilinx-for-v2023.01-rc3' of https://source.denx.de/u-boot/custodians/u...
[platform/kernel/u-boot.git] / include / mmc.h
1 /* SPDX-License-Identifier: GPL-2.0+ */
2 /*
3  * Copyright 2008,2010 Freescale Semiconductor, Inc
4  * Andy Fleming
5  *
6  * Based (loosely) on the Linux code
7  */
8
9 #ifndef _MMC_H_
10 #define _MMC_H_
11
12 #include <linux/bitops.h>
13 #include <linux/list.h>
14 #include <linux/sizes.h>
15 #include <linux/compiler.h>
16 #include <linux/dma-direction.h>
17 #include <part.h>
18
19 struct bd_info;
20
21 #if CONFIG_IS_ENABLED(MMC_HS200_SUPPORT)
22 #define MMC_SUPPORTS_TUNING
23 #endif
24 #if CONFIG_IS_ENABLED(MMC_UHS_SUPPORT)
25 #define MMC_SUPPORTS_TUNING
26 #endif
27
28 /* SD/MMC version bits; 8 flags, 8 major, 8 minor, 8 change */
29 #define SD_VERSION_SD   (1U << 31)
30 #define MMC_VERSION_MMC (1U << 30)
31
32 #define MAKE_SDMMC_VERSION(a, b, c)     \
33         ((((u32)(a)) << 16) | ((u32)(b) << 8) | (u32)(c))
34 #define MAKE_SD_VERSION(a, b, c)        \
35         (SD_VERSION_SD | MAKE_SDMMC_VERSION(a, b, c))
36 #define MAKE_MMC_VERSION(a, b, c)       \
37         (MMC_VERSION_MMC | MAKE_SDMMC_VERSION(a, b, c))
38
39 #define EXTRACT_SDMMC_MAJOR_VERSION(x)  \
40         (((u32)(x) >> 16) & 0xff)
41 #define EXTRACT_SDMMC_MINOR_VERSION(x)  \
42         (((u32)(x) >> 8) & 0xff)
43 #define EXTRACT_SDMMC_CHANGE_VERSION(x) \
44         ((u32)(x) & 0xff)
45
46 #define SD_VERSION_3            MAKE_SD_VERSION(3, 0, 0)
47 #define SD_VERSION_2            MAKE_SD_VERSION(2, 0, 0)
48 #define SD_VERSION_1_0          MAKE_SD_VERSION(1, 0, 0)
49 #define SD_VERSION_1_10         MAKE_SD_VERSION(1, 10, 0)
50
51 #define MMC_VERSION_UNKNOWN     MAKE_MMC_VERSION(0, 0, 0)
52 #define MMC_VERSION_1_2         MAKE_MMC_VERSION(1, 2, 0)
53 #define MMC_VERSION_1_4         MAKE_MMC_VERSION(1, 4, 0)
54 #define MMC_VERSION_2_2         MAKE_MMC_VERSION(2, 2, 0)
55 #define MMC_VERSION_3           MAKE_MMC_VERSION(3, 0, 0)
56 #define MMC_VERSION_4           MAKE_MMC_VERSION(4, 0, 0)
57 #define MMC_VERSION_4_1         MAKE_MMC_VERSION(4, 1, 0)
58 #define MMC_VERSION_4_2         MAKE_MMC_VERSION(4, 2, 0)
59 #define MMC_VERSION_4_3         MAKE_MMC_VERSION(4, 3, 0)
60 #define MMC_VERSION_4_4         MAKE_MMC_VERSION(4, 4, 0)
61 #define MMC_VERSION_4_41        MAKE_MMC_VERSION(4, 4, 1)
62 #define MMC_VERSION_4_5         MAKE_MMC_VERSION(4, 5, 0)
63 #define MMC_VERSION_5_0         MAKE_MMC_VERSION(5, 0, 0)
64 #define MMC_VERSION_5_1         MAKE_MMC_VERSION(5, 1, 0)
65
66 #define MMC_CAP(mode)           (1 << mode)
67 #define MMC_MODE_HS             (MMC_CAP(MMC_HS) | MMC_CAP(SD_HS))
68 #define MMC_MODE_HS_52MHz       MMC_CAP(MMC_HS_52)
69 #define MMC_MODE_DDR_52MHz      MMC_CAP(MMC_DDR_52)
70 #define MMC_MODE_HS200          MMC_CAP(MMC_HS_200)
71 #define MMC_MODE_HS400          MMC_CAP(MMC_HS_400)
72 #define MMC_MODE_HS400_ES       MMC_CAP(MMC_HS_400_ES)
73
74 #define MMC_CAP_NONREMOVABLE    BIT(14)
75 #define MMC_CAP_NEEDS_POLL      BIT(15)
76 #define MMC_CAP_CD_ACTIVE_HIGH  BIT(16)
77
78 #define MMC_MODE_8BIT           BIT(30)
79 #define MMC_MODE_4BIT           BIT(29)
80 #define MMC_MODE_1BIT           BIT(28)
81 #define MMC_MODE_SPI            BIT(27)
82
83
84 #define SD_DATA_4BIT    0x00040000
85
86 #define IS_SD(x)        ((x)->version & SD_VERSION_SD)
87 #define IS_MMC(x)       ((x)->version & MMC_VERSION_MMC)
88
89 #define MMC_DATA_READ           1
90 #define MMC_DATA_WRITE          2
91
92 #define MMC_CMD_GO_IDLE_STATE           0
93 #define MMC_CMD_SEND_OP_COND            1
94 #define MMC_CMD_ALL_SEND_CID            2
95 #define MMC_CMD_SET_RELATIVE_ADDR       3
96 #define MMC_CMD_SET_DSR                 4
97 #define MMC_CMD_SWITCH                  6
98 #define MMC_CMD_SELECT_CARD             7
99 #define MMC_CMD_SEND_EXT_CSD            8
100 #define MMC_CMD_SEND_CSD                9
101 #define MMC_CMD_SEND_CID                10
102 #define MMC_CMD_STOP_TRANSMISSION       12
103 #define MMC_CMD_SEND_STATUS             13
104 #define MMC_CMD_SET_BLOCKLEN            16
105 #define MMC_CMD_READ_SINGLE_BLOCK       17
106 #define MMC_CMD_READ_MULTIPLE_BLOCK     18
107 #define MMC_CMD_SEND_TUNING_BLOCK               19
108 #define MMC_CMD_SEND_TUNING_BLOCK_HS200 21
109 #define MMC_CMD_SET_BLOCK_COUNT         23
110 #define MMC_CMD_WRITE_SINGLE_BLOCK      24
111 #define MMC_CMD_WRITE_MULTIPLE_BLOCK    25
112 #define MMC_CMD_ERASE_GROUP_START       35
113 #define MMC_CMD_ERASE_GROUP_END         36
114 #define MMC_CMD_ERASE                   38
115 #define MMC_CMD_APP_CMD                 55
116 #define MMC_CMD_SPI_READ_OCR            58
117 #define MMC_CMD_SPI_CRC_ON_OFF          59
118 #define MMC_CMD_RES_MAN                 62
119
120 #define MMC_CMD62_ARG1                  0xefac62ec
121 #define MMC_CMD62_ARG2                  0xcbaea7
122
123
124 #define SD_CMD_SEND_RELATIVE_ADDR       3
125 #define SD_CMD_SWITCH_FUNC              6
126 #define SD_CMD_SEND_IF_COND             8
127 #define SD_CMD_SWITCH_UHS18V            11
128
129 #define SD_CMD_APP_SET_BUS_WIDTH        6
130 #define SD_CMD_APP_SD_STATUS            13
131 #define SD_CMD_ERASE_WR_BLK_START       32
132 #define SD_CMD_ERASE_WR_BLK_END         33
133 #define SD_CMD_APP_SEND_OP_COND         41
134 #define SD_CMD_APP_SEND_SCR             51
135
136 static inline bool mmc_is_tuning_cmd(uint cmdidx)
137 {
138         if ((cmdidx == MMC_CMD_SEND_TUNING_BLOCK_HS200) ||
139             (cmdidx == MMC_CMD_SEND_TUNING_BLOCK))
140                 return true;
141         return false;
142 }
143
144 /* SCR definitions in different words */
145 #define SD_HIGHSPEED_BUSY       0x00020000
146 #define SD_HIGHSPEED_SUPPORTED  0x00020000
147
148 #define UHS_SDR12_BUS_SPEED     0
149 #define HIGH_SPEED_BUS_SPEED    1
150 #define UHS_SDR25_BUS_SPEED     1
151 #define UHS_SDR50_BUS_SPEED     2
152 #define UHS_SDR104_BUS_SPEED    3
153 #define UHS_DDR50_BUS_SPEED     4
154
155 #define SD_MODE_UHS_SDR12       BIT(UHS_SDR12_BUS_SPEED)
156 #define SD_MODE_UHS_SDR25       BIT(UHS_SDR25_BUS_SPEED)
157 #define SD_MODE_UHS_SDR50       BIT(UHS_SDR50_BUS_SPEED)
158 #define SD_MODE_UHS_SDR104      BIT(UHS_SDR104_BUS_SPEED)
159 #define SD_MODE_UHS_DDR50       BIT(UHS_DDR50_BUS_SPEED)
160
161 #define OCR_BUSY                0x80000000
162 #define OCR_HCS                 0x40000000
163 #define OCR_S18R                0x1000000
164 #define OCR_VOLTAGE_MASK        0x007FFF80
165 #define OCR_ACCESS_MODE         0x60000000
166
167 #define MMC_ERASE_ARG           0x00000000
168 #define MMC_SECURE_ERASE_ARG    0x80000000
169 #define MMC_TRIM_ARG            0x00000001
170 #define MMC_DISCARD_ARG         0x00000003
171 #define MMC_SECURE_TRIM1_ARG    0x80000001
172 #define MMC_SECURE_TRIM2_ARG    0x80008000
173
174 #define MMC_STATUS_MASK         (~0x0206BF7F)
175 #define MMC_STATUS_SWITCH_ERROR (1 << 7)
176 #define MMC_STATUS_RDY_FOR_DATA (1 << 8)
177 #define MMC_STATUS_CURR_STATE   (0xf << 9)
178 #define MMC_STATUS_ERROR        (1 << 19)
179
180 #define MMC_STATE_PRG           (7 << 9)
181 #define MMC_STATE_TRANS         (4 << 9)
182
183 #define MMC_VDD_165_195         0x00000080      /* VDD voltage 1.65 - 1.95 */
184 #define MMC_VDD_20_21           0x00000100      /* VDD voltage 2.0 ~ 2.1 */
185 #define MMC_VDD_21_22           0x00000200      /* VDD voltage 2.1 ~ 2.2 */
186 #define MMC_VDD_22_23           0x00000400      /* VDD voltage 2.2 ~ 2.3 */
187 #define MMC_VDD_23_24           0x00000800      /* VDD voltage 2.3 ~ 2.4 */
188 #define MMC_VDD_24_25           0x00001000      /* VDD voltage 2.4 ~ 2.5 */
189 #define MMC_VDD_25_26           0x00002000      /* VDD voltage 2.5 ~ 2.6 */
190 #define MMC_VDD_26_27           0x00004000      /* VDD voltage 2.6 ~ 2.7 */
191 #define MMC_VDD_27_28           0x00008000      /* VDD voltage 2.7 ~ 2.8 */
192 #define MMC_VDD_28_29           0x00010000      /* VDD voltage 2.8 ~ 2.9 */
193 #define MMC_VDD_29_30           0x00020000      /* VDD voltage 2.9 ~ 3.0 */
194 #define MMC_VDD_30_31           0x00040000      /* VDD voltage 3.0 ~ 3.1 */
195 #define MMC_VDD_31_32           0x00080000      /* VDD voltage 3.1 ~ 3.2 */
196 #define MMC_VDD_32_33           0x00100000      /* VDD voltage 3.2 ~ 3.3 */
197 #define MMC_VDD_33_34           0x00200000      /* VDD voltage 3.3 ~ 3.4 */
198 #define MMC_VDD_34_35           0x00400000      /* VDD voltage 3.4 ~ 3.5 */
199 #define MMC_VDD_35_36           0x00800000      /* VDD voltage 3.5 ~ 3.6 */
200
201 #define MMC_SWITCH_MODE_CMD_SET         0x00 /* Change the command set */
202 #define MMC_SWITCH_MODE_SET_BITS        0x01 /* Set bits in EXT_CSD byte
203                                                 addressed by index which are
204                                                 1 in value field */
205 #define MMC_SWITCH_MODE_CLEAR_BITS      0x02 /* Clear bits in EXT_CSD byte
206                                                 addressed by index, which are
207                                                 1 in value field */
208 #define MMC_SWITCH_MODE_WRITE_BYTE      0x03 /* Set target byte to value */
209
210 #define SD_SWITCH_CHECK         0
211 #define SD_SWITCH_SWITCH        1
212
213 /*
214  * EXT_CSD fields
215  */
216 #define EXT_CSD_ENH_START_ADDR          136     /* R/W */
217 #define EXT_CSD_ENH_SIZE_MULT           140     /* R/W */
218 #define EXT_CSD_GP_SIZE_MULT            143     /* R/W */
219 #define EXT_CSD_PARTITION_SETTING       155     /* R/W */
220 #define EXT_CSD_PARTITIONS_ATTRIBUTE    156     /* R/W */
221 #define EXT_CSD_MAX_ENH_SIZE_MULT       157     /* R */
222 #define EXT_CSD_PARTITIONING_SUPPORT    160     /* RO */
223 #define EXT_CSD_RST_N_FUNCTION          162     /* R/W */
224 #define EXT_CSD_BKOPS_EN                163     /* R/W & R/W/E */
225 #define EXT_CSD_WR_REL_PARAM            166     /* R */
226 #define EXT_CSD_WR_REL_SET              167     /* R/W */
227 #define EXT_CSD_RPMB_MULT               168     /* RO */
228 #define EXT_CSD_USER_WP                 171     /* R/W & R/W/C_P & R/W/E_P */
229 #define EXT_CSD_BOOT_WP                 173     /* R/W & R/W/C_P */
230 #define EXT_CSD_BOOT_WP_STATUS          174     /* R */
231 #define EXT_CSD_ERASE_GROUP_DEF         175     /* R/W */
232 #define EXT_CSD_BOOT_BUS_WIDTH          177
233 #define EXT_CSD_PART_CONF               179     /* R/W */
234 #define EXT_CSD_BUS_WIDTH               183     /* R/W */
235 #define EXT_CSD_STROBE_SUPPORT          184     /* R/W */
236 #define EXT_CSD_HS_TIMING               185     /* R/W */
237 #define EXT_CSD_REV                     192     /* RO */
238 #define EXT_CSD_CARD_TYPE               196     /* RO */
239 #define EXT_CSD_PART_SWITCH_TIME        199     /* RO */
240 #define EXT_CSD_SEC_CNT                 212     /* RO, 4 bytes */
241 #define EXT_CSD_HC_WP_GRP_SIZE          221     /* RO */
242 #define EXT_CSD_HC_ERASE_GRP_SIZE       224     /* RO */
243 #define EXT_CSD_BOOT_MULT               226     /* RO */
244 #define EXT_CSD_GENERIC_CMD6_TIME       248     /* RO */
245 #define EXT_CSD_BKOPS_SUPPORT           502     /* RO */
246
247 /*
248  * EXT_CSD field definitions
249  */
250
251 #define EXT_CSD_CMD_SET_NORMAL          (1 << 0)
252 #define EXT_CSD_CMD_SET_SECURE          (1 << 1)
253 #define EXT_CSD_CMD_SET_CPSECURE        (1 << 2)
254
255 #define EXT_CSD_CARD_TYPE_26    (1 << 0)        /* Card can run at 26MHz */
256 #define EXT_CSD_CARD_TYPE_52    (1 << 1)        /* Card can run at 52MHz */
257 #define EXT_CSD_CARD_TYPE_DDR_1_8V      (1 << 2)
258 #define EXT_CSD_CARD_TYPE_DDR_1_2V      (1 << 3)
259 #define EXT_CSD_CARD_TYPE_DDR_52        (EXT_CSD_CARD_TYPE_DDR_1_8V \
260                                         | EXT_CSD_CARD_TYPE_DDR_1_2V)
261
262 #define EXT_CSD_CARD_TYPE_HS200_1_8V    BIT(4)  /* Card can run at 200MHz */
263                                                 /* SDR mode @1.8V I/O */
264 #define EXT_CSD_CARD_TYPE_HS200_1_2V    BIT(5)  /* Card can run at 200MHz */
265                                                 /* SDR mode @1.2V I/O */
266 #define EXT_CSD_CARD_TYPE_HS200         (EXT_CSD_CARD_TYPE_HS200_1_8V | \
267                                          EXT_CSD_CARD_TYPE_HS200_1_2V)
268 #define EXT_CSD_CARD_TYPE_HS400_1_8V    BIT(6)
269 #define EXT_CSD_CARD_TYPE_HS400_1_2V    BIT(7)
270 #define EXT_CSD_CARD_TYPE_HS400         (EXT_CSD_CARD_TYPE_HS400_1_8V | \
271                                          EXT_CSD_CARD_TYPE_HS400_1_2V)
272
273 #define EXT_CSD_BUS_WIDTH_1     0       /* Card is in 1 bit mode */
274 #define EXT_CSD_BUS_WIDTH_4     1       /* Card is in 4 bit mode */
275 #define EXT_CSD_BUS_WIDTH_8     2       /* Card is in 8 bit mode */
276 #define EXT_CSD_DDR_BUS_WIDTH_4 5       /* Card is in 4 bit DDR mode */
277 #define EXT_CSD_DDR_BUS_WIDTH_8 6       /* Card is in 8 bit DDR mode */
278 #define EXT_CSD_DDR_FLAG        BIT(2)  /* Flag for DDR mode */
279 #define EXT_CSD_BUS_WIDTH_STROBE BIT(7) /* Enhanced strobe mode */
280
281 #define EXT_CSD_TIMING_LEGACY   0       /* no high speed */
282 #define EXT_CSD_TIMING_HS       1       /* HS */
283 #define EXT_CSD_TIMING_HS200    2       /* HS200 */
284 #define EXT_CSD_TIMING_HS400    3       /* HS400 */
285 #define EXT_CSD_DRV_STR_SHIFT   4       /* Driver Strength shift */
286
287 #define EXT_CSD_BOOT_ACK_ENABLE                 (1 << 6)
288 #define EXT_CSD_BOOT_PARTITION_ENABLE           (1 << 3)
289 #define EXT_CSD_PARTITION_ACCESS_ENABLE         (1 << 0)
290 #define EXT_CSD_PARTITION_ACCESS_DISABLE        (0 << 0)
291
292 #define EXT_CSD_BOOT_ACK(x)             (x << 6)
293 #define EXT_CSD_BOOT_PART_NUM(x)        (x << 3)
294 #define EXT_CSD_PARTITION_ACCESS(x)     (x << 0)
295
296 #define EXT_CSD_EXTRACT_BOOT_ACK(x)             (((x) >> 6) & 0x1)
297 #define EXT_CSD_EXTRACT_BOOT_PART(x)            (((x) >> 3) & 0x7)
298 #define EXT_CSD_EXTRACT_PARTITION_ACCESS(x)     ((x) & 0x7)
299
300 #define EXT_CSD_BOOT_BUS_WIDTH_MODE(x)  (x << 3)
301 #define EXT_CSD_BOOT_BUS_WIDTH_RESET(x) (x << 2)
302 #define EXT_CSD_BOOT_BUS_WIDTH_WIDTH(x) (x)
303
304 #define EXT_CSD_PARTITION_SETTING_COMPLETED     (1 << 0)
305
306 #define EXT_CSD_ENH_USR         (1 << 0)        /* user data area is enhanced */
307 #define EXT_CSD_ENH_GP(x)       (1 << ((x)+1))  /* GP part (x+1) is enhanced */
308
309 #define EXT_CSD_HS_CTRL_REL     (1 << 0)        /* host controlled WR_REL_SET */
310
311 #define EXT_CSD_BOOT_WP_B_SEC_WP_SEL    (0x80)  /* enable partition selector */
312 #define EXT_CSD_BOOT_WP_B_PWR_WP_SEC_SEL (0x02) /* partition selector to protect */
313 #define EXT_CSD_BOOT_WP_B_PWR_WP_EN     (0x01)  /* power-on write-protect */
314
315 #define EXT_CSD_WR_DATA_REL_USR         (1 << 0)        /* user data area WR_REL */
316 #define EXT_CSD_WR_DATA_REL_GP(x)       (1 << ((x)+1))  /* GP part (x+1) WR_REL */
317
318 #define R1_ILLEGAL_COMMAND              (1 << 22)
319 #define R1_APP_CMD                      (1 << 5)
320
321 #define MMC_RSP_PRESENT (1 << 0)
322 #define MMC_RSP_136     (1 << 1)                /* 136 bit response */
323 #define MMC_RSP_CRC     (1 << 2)                /* expect valid crc */
324 #define MMC_RSP_BUSY    (1 << 3)                /* card may send busy */
325 #define MMC_RSP_OPCODE  (1 << 4)                /* response contains opcode */
326
327 #define MMC_RSP_NONE    (0)
328 #define MMC_RSP_R1      (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
329 #define MMC_RSP_R1b     (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE| \
330                         MMC_RSP_BUSY)
331 #define MMC_RSP_R2      (MMC_RSP_PRESENT|MMC_RSP_136|MMC_RSP_CRC)
332 #define MMC_RSP_R3      (MMC_RSP_PRESENT)
333 #define MMC_RSP_R4      (MMC_RSP_PRESENT)
334 #define MMC_RSP_R5      (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
335 #define MMC_RSP_R6      (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
336 #define MMC_RSP_R7      (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
337
338 #define MMCPART_NOAVAILABLE     (0xff)
339 #define PART_ACCESS_MASK        (0x7)
340 #define PART_SUPPORT            (0x1)
341 #define ENHNCD_SUPPORT          (0x2)
342 #define PART_ENH_ATTRIB         (0x1f)
343
344 #define MMC_QUIRK_RETRY_SEND_CID        BIT(0)
345 #define MMC_QUIRK_RETRY_SET_BLOCKLEN    BIT(1)
346 #define MMC_QUIRK_RETRY_APP_CMD BIT(2)
347
348 enum mmc_voltage {
349         MMC_SIGNAL_VOLTAGE_000 = 0,
350         MMC_SIGNAL_VOLTAGE_120 = 1,
351         MMC_SIGNAL_VOLTAGE_180 = 2,
352         MMC_SIGNAL_VOLTAGE_330 = 4,
353 };
354
355 #define MMC_ALL_SIGNAL_VOLTAGE (MMC_SIGNAL_VOLTAGE_120 |\
356                                 MMC_SIGNAL_VOLTAGE_180 |\
357                                 MMC_SIGNAL_VOLTAGE_330)
358
359 /* Maximum block size for MMC */
360 #define MMC_MAX_BLOCK_LEN       512
361
362 /* The number of MMC physical partitions.  These consist of:
363  * boot partitions (2), general purpose partitions (4) in MMC v4.4.
364  */
365 #define MMC_NUM_BOOT_PARTITION  2
366 #define MMC_PART_RPMB           3       /* RPMB partition number */
367
368 /* timing specification used */
369 #define MMC_TIMING_LEGACY       0
370 #define MMC_TIMING_MMC_HS       1
371 #define MMC_TIMING_SD_HS        2
372 #define MMC_TIMING_UHS_SDR12    3
373 #define MMC_TIMING_UHS_SDR25    4
374 #define MMC_TIMING_UHS_SDR50    5
375 #define MMC_TIMING_UHS_SDR104   6
376 #define MMC_TIMING_UHS_DDR50    7
377 #define MMC_TIMING_MMC_DDR52    8
378 #define MMC_TIMING_MMC_HS200    9
379 #define MMC_TIMING_MMC_HS400    10
380
381 /* Driver model support */
382
383 /**
384  * struct mmc_uclass_priv - Holds information about a device used by the uclass
385  */
386 struct mmc_uclass_priv {
387         struct mmc *mmc;
388 };
389
390 /**
391  * mmc_get_mmc_dev() - get the MMC struct pointer for a device
392  *
393  * Provided that the device is already probed and ready for use, this value
394  * will be available.
395  *
396  * @dev:        Device
397  * Return: associated mmc struct pointer if available, else NULL
398  */
399 struct mmc *mmc_get_mmc_dev(const struct udevice *dev);
400
401 /* End of driver model support */
402
403 struct mmc_cid {
404         unsigned long psn;
405         unsigned short oid;
406         unsigned char mid;
407         unsigned char prv;
408         unsigned char mdt;
409         char pnm[7];
410 };
411
412 struct mmc_cmd {
413         ushort cmdidx;
414         uint resp_type;
415         uint cmdarg;
416         uint response[4];
417 };
418
419 struct mmc_data {
420         union {
421                 char *dest;
422                 const char *src; /* src buffers don't get written to */
423         };
424         uint flags;
425         uint blocks;
426         uint blocksize;
427 };
428
429 /* forward decl. */
430 struct mmc;
431
432 #if CONFIG_IS_ENABLED(DM_MMC)
433 struct dm_mmc_ops {
434         /**
435          * deferred_probe() - Some configurations that need to be deferred
436          * to just before enumerating the device
437          *
438          * @dev:        Device to init
439          * @return 0 if Ok, -ve if error
440          */
441         int (*deferred_probe)(struct udevice *dev);
442         /**
443          * reinit() - Re-initialization to clear old configuration for
444          * mmc rescan.
445          *
446          * @dev:        Device to reinit
447          * @return 0 if Ok, -ve if error
448          */
449         int (*reinit)(struct udevice *dev);
450         /**
451          * send_cmd() - Send a command to the MMC device
452          *
453          * @dev:        Device to receive the command
454          * @cmd:        Command to send
455          * @data:       Additional data to send/receive
456          * @return 0 if OK, -ve on error
457          */
458         int (*send_cmd)(struct udevice *dev, struct mmc_cmd *cmd,
459                         struct mmc_data *data);
460
461         /**
462          * set_ios() - Set the I/O speed/width for an MMC device
463          *
464          * @dev:        Device to update
465          * @return 0 if OK, -ve on error
466          */
467         int (*set_ios)(struct udevice *dev);
468
469         /**
470          * get_cd() - See whether a card is present
471          *
472          * @dev:        Device to check
473          * @return 0 if not present, 1 if present, -ve on error
474          */
475         int (*get_cd)(struct udevice *dev);
476
477         /**
478          * get_wp() - See whether a card has write-protect enabled
479          *
480          * @dev:        Device to check
481          * @return 0 if write-enabled, 1 if write-protected, -ve on error
482          */
483         int (*get_wp)(struct udevice *dev);
484
485 #ifdef MMC_SUPPORTS_TUNING
486         /**
487          * execute_tuning() - Start the tuning process
488          *
489          * @dev:        Device to start the tuning
490          * @opcode:     Command opcode to send
491          * @return 0 if OK, -ve on error
492          */
493         int (*execute_tuning)(struct udevice *dev, uint opcode);
494 #endif
495
496         /**
497          * wait_dat0() - wait until dat0 is in the target state
498          *              (CLK must be running during the wait)
499          *
500          * @dev:        Device to check
501          * @state:      target state
502          * @timeout_us: timeout in us
503          * @return 0 if dat0 is in the target state, -ve on error
504          */
505         int (*wait_dat0)(struct udevice *dev, int state, int timeout_us);
506
507 #if CONFIG_IS_ENABLED(MMC_HS400_ES_SUPPORT)
508         /* set_enhanced_strobe() - set HS400 enhanced strobe */
509         int (*set_enhanced_strobe)(struct udevice *dev);
510 #endif
511
512         /**
513          * host_power_cycle - host specific tasks in power cycle sequence
514          *                    Called between mmc_power_off() and
515          *                    mmc_power_on()
516          *
517          * @dev:        Device to check
518          * @return 0 if not present, 1 if present, -ve on error
519          */
520         int (*host_power_cycle)(struct udevice *dev);
521
522         /**
523          * get_b_max - get maximum length of single transfer
524          *             Called before reading blocks from the card,
525          *             useful for system which have e.g. DMA limits
526          *             on various memory ranges.
527          *
528          * @dev:        Device to check
529          * @dst:        Destination buffer in memory
530          * @blkcnt:     Total number of blocks in this transfer
531          * @return maximum number of blocks for this transfer
532          */
533         int (*get_b_max)(struct udevice *dev, void *dst, lbaint_t blkcnt);
534
535         /**
536          * hs400_prepare_ddr - prepare to switch to DDR mode
537          *
538          * @dev:        Device to check
539          * @return 0 if success, -ve on error
540          */
541         int (*hs400_prepare_ddr)(struct udevice *dev);
542 };
543
544 #define mmc_get_ops(dev)        ((struct dm_mmc_ops *)(dev)->driver->ops)
545
546 /* Transition functions for compatibility */
547 int mmc_set_ios(struct mmc *mmc);
548 int mmc_getcd(struct mmc *mmc);
549 int mmc_getwp(struct mmc *mmc);
550 int mmc_execute_tuning(struct mmc *mmc, uint opcode);
551 int mmc_wait_dat0(struct mmc *mmc, int state, int timeout_us);
552 int mmc_set_enhanced_strobe(struct mmc *mmc);
553 int mmc_host_power_cycle(struct mmc *mmc);
554 int mmc_deferred_probe(struct mmc *mmc);
555 int mmc_reinit(struct mmc *mmc);
556 int mmc_get_b_max(struct mmc *mmc, void *dst, lbaint_t blkcnt);
557 int mmc_hs400_prepare_ddr(struct mmc *mmc);
558 #else
559 struct mmc_ops {
560         int (*send_cmd)(struct mmc *mmc,
561                         struct mmc_cmd *cmd, struct mmc_data *data);
562         int (*set_ios)(struct mmc *mmc);
563         int (*init)(struct mmc *mmc);
564         int (*getcd)(struct mmc *mmc);
565         int (*getwp)(struct mmc *mmc);
566         int (*host_power_cycle)(struct mmc *mmc);
567         int (*get_b_max)(struct mmc *mmc, void *dst, lbaint_t blkcnt);
568         int (*wait_dat0)(struct mmc *mmc, int state, int timeout_us);
569 };
570
571 static inline int mmc_hs400_prepare_ddr(struct mmc *mmc)
572 {
573         return 0;
574 }
575 #endif
576
577 struct mmc_config {
578         const char *name;
579 #if !CONFIG_IS_ENABLED(DM_MMC)
580         const struct mmc_ops *ops;
581 #endif
582         uint host_caps;
583         uint voltages;
584         uint f_min;
585         uint f_max;
586         uint b_max;
587         unsigned char part_type;
588 #ifdef CONFIG_MMC_PWRSEQ
589         struct udevice *pwr_dev;
590 #endif
591 };
592
593 struct sd_ssr {
594         unsigned int au;                /* In sectors */
595         unsigned int erase_timeout;     /* In milliseconds */
596         unsigned int erase_offset;      /* In milliseconds */
597 };
598
599 enum bus_mode {
600         MMC_LEGACY,
601         MMC_HS,
602         SD_HS,
603         MMC_HS_52,
604         MMC_DDR_52,
605         UHS_SDR12,
606         UHS_SDR25,
607         UHS_SDR50,
608         UHS_DDR50,
609         UHS_SDR104,
610         MMC_HS_200,
611         MMC_HS_400,
612         MMC_HS_400_ES,
613         MMC_MODES_END
614 };
615
616 const char *mmc_mode_name(enum bus_mode mode);
617 void mmc_dump_capabilities(const char *text, uint caps);
618
619 static inline bool mmc_is_mode_ddr(enum bus_mode mode)
620 {
621         if (mode == MMC_DDR_52)
622                 return true;
623 #if CONFIG_IS_ENABLED(MMC_UHS_SUPPORT)
624         else if (mode == UHS_DDR50)
625                 return true;
626 #endif
627 #if CONFIG_IS_ENABLED(MMC_HS400_SUPPORT)
628         else if (mode == MMC_HS_400)
629                 return true;
630 #endif
631 #if CONFIG_IS_ENABLED(MMC_HS400_ES_SUPPORT)
632         else if (mode == MMC_HS_400_ES)
633                 return true;
634 #endif
635         else
636                 return false;
637 }
638
639 #define UHS_CAPS (MMC_CAP(UHS_SDR12) | MMC_CAP(UHS_SDR25) | \
640                   MMC_CAP(UHS_SDR50) | MMC_CAP(UHS_SDR104) | \
641                   MMC_CAP(UHS_DDR50))
642
643 static inline bool supports_uhs(uint caps)
644 {
645 #if CONFIG_IS_ENABLED(MMC_UHS_SUPPORT)
646         return (caps & UHS_CAPS) ? true : false;
647 #else
648         return false;
649 #endif
650 }
651
652 /*
653  * With CONFIG_DM_MMC enabled, struct mmc can be accessed from the MMC device
654  * with mmc_get_mmc_dev().
655  *
656  * TODO struct mmc should be in mmc_private but it's hard to fix right now
657  */
658 struct mmc {
659 #if !CONFIG_IS_ENABLED(BLK)
660         struct list_head link;
661 #endif
662         const struct mmc_config *cfg;   /* provided configuration */
663         uint version;
664         void *priv;
665         uint has_init;
666         int high_capacity;
667         bool clk_disable; /* true if the clock can be turned off */
668         uint bus_width;
669         uint clock;
670         uint saved_clock;
671         enum mmc_voltage signal_voltage;
672         uint card_caps;
673         uint host_caps;
674         uint ocr;
675         uint dsr;
676         uint dsr_imp;
677         uint scr[2];
678         uint csd[4];
679         uint cid[4];
680         ushort rca;
681         u8 part_support;
682         u8 part_attr;
683         u8 wr_rel_set;
684         u8 part_config;
685         u8 gen_cmd6_time;       /* units: 10 ms */
686         u8 part_switch_time;    /* units: 10 ms */
687         uint tran_speed;
688         uint legacy_speed; /* speed for the legacy mode provided by the card */
689         uint read_bl_len;
690 #if CONFIG_IS_ENABLED(MMC_WRITE)
691         uint write_bl_len;
692         uint erase_grp_size;    /* in 512-byte sectors */
693 #endif
694 #if CONFIG_IS_ENABLED(MMC_HW_PARTITIONING)
695         uint hc_wp_grp_size;    /* in 512-byte sectors */
696 #endif
697 #if CONFIG_IS_ENABLED(MMC_WRITE)
698         struct sd_ssr   ssr;    /* SD status register */
699 #endif
700         u64 capacity;
701         u64 capacity_user;
702         u64 capacity_boot;
703         u64 capacity_rpmb;
704         u64 capacity_gp[4];
705 #ifndef CONFIG_SPL_BUILD
706         u64 enh_user_start;
707         u64 enh_user_size;
708 #endif
709 #if !CONFIG_IS_ENABLED(BLK)
710         struct blk_desc block_dev;
711 #endif
712         char op_cond_pending;   /* 1 if we are waiting on an op_cond command */
713         char init_in_progress;  /* 1 if we have done mmc_start_init() */
714         char preinit;           /* start init as early as possible */
715         int ddr_mode;
716 #if CONFIG_IS_ENABLED(DM_MMC)
717         struct udevice *dev;    /* Device for this MMC controller */
718 #if CONFIG_IS_ENABLED(DM_REGULATOR)
719         struct udevice *vmmc_supply;    /* Main voltage regulator (Vcc)*/
720         struct udevice *vqmmc_supply;   /* IO voltage regulator (Vccq)*/
721 #endif
722 #endif
723         u8 *ext_csd;
724         u32 cardtype;           /* cardtype read from the MMC */
725         enum mmc_voltage current_voltage;
726         enum bus_mode selected_mode; /* mode currently used */
727         enum bus_mode best_mode; /* best mode is the supported mode with the
728                                   * highest bandwidth. It may not always be the
729                                   * operating mode due to limitations when
730                                   * accessing the boot partitions
731                                   */
732         u32 quirks;
733         u8 hs400_tuning;
734
735         enum bus_mode user_speed_mode; /* input speed mode from user */
736 };
737
738 #if CONFIG_IS_ENABLED(DM_MMC)
739 #define mmc_to_dev(_mmc)        _mmc->dev
740 #else
741 #define mmc_to_dev(_mmc)        NULL
742 #endif
743
744 struct mmc_hwpart_conf {
745         struct {
746                 uint enh_start; /* in 512-byte sectors */
747                 uint enh_size;  /* in 512-byte sectors, if 0 no enh area */
748                 unsigned wr_rel_change : 1;
749                 unsigned wr_rel_set : 1;
750         } user;
751         struct {
752                 uint size;      /* in 512-byte sectors */
753                 unsigned enhanced : 1;
754                 unsigned wr_rel_change : 1;
755                 unsigned wr_rel_set : 1;
756         } gp_part[4];
757 };
758
759 enum mmc_hwpart_conf_mode {
760         MMC_HWPART_CONF_CHECK,
761         MMC_HWPART_CONF_SET,
762         MMC_HWPART_CONF_COMPLETE,
763 };
764
765 struct mmc *mmc_create(const struct mmc_config *cfg, void *priv);
766
767 /**
768  * mmc_bind() - Set up a new MMC device ready for probing
769  *
770  * A child block device is bound with the UCLASS_MMC interface type. This
771  * allows the device to be used with CONFIG_BLK
772  *
773  * @dev:        MMC device to set up
774  * @mmc:        MMC struct
775  * @cfg:        MMC configuration
776  * Return: 0 if OK, -ve on error
777  */
778 int mmc_bind(struct udevice *dev, struct mmc *mmc,
779              const struct mmc_config *cfg);
780 void mmc_destroy(struct mmc *mmc);
781
782 /**
783  * mmc_unbind() - Unbind a MMC device's child block device
784  *
785  * @dev:        MMC device
786  * Return: 0 if OK, -ve on error
787  */
788 int mmc_unbind(struct udevice *dev);
789 int mmc_initialize(struct bd_info *bis);
790 int mmc_init_device(int num);
791 int mmc_init(struct mmc *mmc);
792 int mmc_send_tuning(struct mmc *mmc, u32 opcode, int *cmd_error);
793 int mmc_send_cmd(struct mmc *mmc, struct mmc_cmd *cmd, struct mmc_data *data);
794 int mmc_deinit(struct mmc *mmc);
795
796 /**
797  * mmc_of_parse() - Parse the device tree to get the capabilities of the host
798  *
799  * @dev:        MMC device
800  * @cfg:        MMC configuration
801  * Return: 0 if OK, -ve on error
802  */
803 int mmc_of_parse(struct udevice *dev, struct mmc_config *cfg);
804
805 #ifdef CONFIG_MMC_PWRSEQ
806 /**
807  * mmc_pwrseq_get_power() - get a power device from device tree
808  *
809  * @dev:        MMC device
810  * @cfg:        MMC configuration
811  * Return: 0 if OK, -ve on error
812  */
813 int mmc_pwrseq_get_power(struct udevice *dev, struct mmc_config *cfg);
814 #endif
815
816 int mmc_read(struct mmc *mmc, u64 src, uchar *dst, int size);
817
818 /**
819  * mmc_voltage_to_mv() - Convert a mmc_voltage in mV
820  *
821  * @voltage:    The mmc_voltage to convert
822  * Return: the value in mV if OK, -EINVAL on error (invalid mmc_voltage value)
823  */
824 int mmc_voltage_to_mv(enum mmc_voltage voltage);
825
826 /**
827  * mmc_set_clock() - change the bus clock
828  * @mmc:        MMC struct
829  * @clock:      bus frequency in Hz
830  * @disable:    flag indicating if the clock must on or off
831  * Return: 0 if OK, -ve on error
832  */
833 int mmc_set_clock(struct mmc *mmc, uint clock, bool disable);
834
835 #define MMC_CLK_ENABLE          false
836 #define MMC_CLK_DISABLE         true
837
838 struct mmc *find_mmc_device(int dev_num);
839 int mmc_set_dev(int dev_num);
840 void print_mmc_devices(char separator);
841
842 /**
843  * get_mmc_num() - get the total MMC device number
844  *
845  * Return: 0 if there is no MMC device, else the number of devices
846  */
847 int get_mmc_num(void);
848 int mmc_switch_part(struct mmc *mmc, unsigned int part_num);
849 int mmc_hwpart_config(struct mmc *mmc, const struct mmc_hwpart_conf *conf,
850                       enum mmc_hwpart_conf_mode mode);
851
852 #if !CONFIG_IS_ENABLED(DM_MMC)
853 int mmc_getcd(struct mmc *mmc);
854 int board_mmc_getcd(struct mmc *mmc);
855 int mmc_getwp(struct mmc *mmc);
856 int board_mmc_getwp(struct mmc *mmc);
857 #endif
858
859 int mmc_set_dsr(struct mmc *mmc, u16 val);
860 /* Function to change the size of boot partition and rpmb partitions */
861 int mmc_boot_partition_size_change(struct mmc *mmc, unsigned long bootsize,
862                                         unsigned long rpmbsize);
863 /* Function to modify the PARTITION_CONFIG field of EXT_CSD */
864 int mmc_set_part_conf(struct mmc *mmc, u8 ack, u8 part_num, u8 access);
865 /* Function to modify the BOOT_BUS_WIDTH field of EXT_CSD */
866 int mmc_set_boot_bus_width(struct mmc *mmc, u8 width, u8 reset, u8 mode);
867 /* Function to modify the RST_n_FUNCTION field of EXT_CSD */
868 int mmc_set_rst_n_function(struct mmc *mmc, u8 enable);
869 /* Functions to read / write the RPMB partition */
870 int mmc_rpmb_set_key(struct mmc *mmc, void *key);
871 int mmc_rpmb_get_counter(struct mmc *mmc, unsigned long *counter);
872 int mmc_rpmb_read(struct mmc *mmc, void *addr, unsigned short blk,
873                   unsigned short cnt, unsigned char *key);
874 int mmc_rpmb_write(struct mmc *mmc, void *addr, unsigned short blk,
875                    unsigned short cnt, unsigned char *key);
876
877 /**
878  * mmc_rpmb_route_frames() - route RPMB data frames
879  * @mmc         Pointer to a MMC device struct
880  * @req         Request data frames
881  * @reqlen      Length of data frames in bytes
882  * @rsp         Supplied buffer for response data frames
883  * @rsplen      Length of supplied buffer for response data frames
884  *
885  * The RPMB data frames are routed to/from some external entity, for
886  * example a Trusted Exectuion Environment in an arm TrustZone protected
887  * secure world. It's expected that it's the external entity who is in
888  * control of the RPMB key.
889  *
890  * Returns 0 on success, < 0 on error.
891  */
892 int mmc_rpmb_route_frames(struct mmc *mmc, void *req, unsigned long reqlen,
893                           void *rsp, unsigned long rsplen);
894
895 #ifdef CONFIG_CMD_BKOPS_ENABLE
896 int mmc_set_bkops_enable(struct mmc *mmc);
897 #endif
898
899 /**
900  * Start device initialization and return immediately; it does not block on
901  * polling OCR (operation condition register) status. Useful for checking
902  * the presence of SD/eMMC when no card detect logic is available.
903  *
904  * @param mmc   Pointer to a MMC device struct
905  * @param quiet Be quiet, do not print error messages when card is not detected.
906  * Return: 0 on success, <0 on error.
907  */
908 int mmc_get_op_cond(struct mmc *mmc, bool quiet);
909
910 /**
911  * Start device initialization and return immediately; it does not block on
912  * polling OCR (operation condition register) status.  Then you should call
913  * mmc_init, which would block on polling OCR status and complete the device
914  * initializatin.
915  *
916  * @param mmc   Pointer to a MMC device struct
917  * Return: 0 on success, <0 on error.
918  */
919 int mmc_start_init(struct mmc *mmc);
920
921 /**
922  * Set preinit flag of mmc device.
923  *
924  * This will cause the device to be pre-inited during mmc_initialize(),
925  * which may save boot time if the device is not accessed until later.
926  * Some eMMC devices take 200-300ms to init, but unfortunately they
927  * must be sent a series of commands to even get them to start preparing
928  * for operation.
929  *
930  * @param mmc           Pointer to a MMC device struct
931  * @param preinit       preinit flag value
932  */
933 void mmc_set_preinit(struct mmc *mmc, int preinit);
934
935 #ifdef CONFIG_MMC_SPI
936 #define mmc_host_is_spi(mmc)    ((mmc)->cfg->host_caps & MMC_MODE_SPI)
937 #else
938 #define mmc_host_is_spi(mmc)    0
939 #endif
940
941 #define mmc_dev(x)      ((x)->dev)
942
943 void board_mmc_power_init(void);
944 int board_mmc_init(struct bd_info *bis);
945 int cpu_mmc_init(struct bd_info *bis);
946 int mmc_get_env_addr(struct mmc *mmc, int copy, u32 *env_addr);
947 # ifdef CONFIG_SYS_MMC_ENV_PART
948 extern uint mmc_get_env_part(struct mmc *mmc);
949 # endif
950 int mmc_get_env_dev(void);
951
952 /* Minimum partition switch timeout in units of 10-milliseconds */
953 #define MMC_MIN_PART_SWITCH_TIME        30 /* 300 ms */
954
955 /**
956  * mmc_get_blk_desc() - Get the block descriptor for an MMC device
957  *
958  * @mmc:        MMC device
959  * Return: block descriptor if found, else NULL
960  */
961 struct blk_desc *mmc_get_blk_desc(struct mmc *mmc);
962
963 /**
964  * mmc_get_blk() - Get the block device for an MMC device
965  *
966  * @dev:        MMC device
967  * @blkp:       Returns pointer to probed block device on sucesss
968  *
969  * Return: 0 on success, -ve on error
970  */
971 int mmc_get_blk(struct udevice *dev, struct udevice **blkp);
972
973 /**
974  * mmc_send_ext_csd() - read the extended CSD register
975  *
976  * @mmc:        MMC device
977  * @ext_csd     a cache aligned buffer of length MMC_MAX_BLOCK_LEN allocated by
978  *              the caller, e.g. using
979  *              ALLOC_CACHE_ALIGN_BUFFER(u8, ext_csd, MMC_MAX_BLOCK_LEN)
980  * Return:      0 for success
981  */
982 int mmc_send_ext_csd(struct mmc *mmc, u8 *ext_csd);
983
984 /**
985  * mmc_boot_wp() - power on write protect boot partitions
986  *
987  * The boot partitions are write protected until the next power cycle.
988  *
989  * Return:      0 for success
990  */
991 int mmc_boot_wp(struct mmc *mmc);
992
993 /**
994  * mmc_boot_wp_single_partition() - set write protection to a boot partition.
995  *
996  * This function sets a single boot partition to protect and leave the
997  * other partition writable.
998  *
999  * @param mmc the mmc device.
1000  * @param partition 0 - first boot partition, 1 - second boot partition.
1001  * @return 0 for success
1002  */
1003 int mmc_boot_wp_single_partition(struct mmc *mmc, int partition);
1004
1005 static inline enum dma_data_direction mmc_get_dma_dir(struct mmc_data *data)
1006 {
1007         return data->flags & MMC_DATA_WRITE ? DMA_TO_DEVICE : DMA_FROM_DEVICE;
1008 }
1009
1010 #endif /* _MMC_H_ */