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