mmc: Enable signal voltage to be selected from mmc core
[platform/kernel/u-boot.git] / include / mmc.h
1 /*
2  * Copyright 2008,2010 Freescale Semiconductor, Inc
3  * Andy Fleming
4  *
5  * Based (loosely) on the Linux code
6  *
7  * SPDX-License-Identifier:     GPL-2.0+
8  */
9
10 #ifndef _MMC_H_
11 #define _MMC_H_
12
13 #include <linux/list.h>
14 #include <linux/sizes.h>
15 #include <linux/compiler.h>
16 #include <part.h>
17
18 /* SD/MMC version bits; 8 flags, 8 major, 8 minor, 8 change */
19 #define SD_VERSION_SD   (1U << 31)
20 #define MMC_VERSION_MMC (1U << 30)
21
22 #define MAKE_SDMMC_VERSION(a, b, c)     \
23         ((((u32)(a)) << 16) | ((u32)(b) << 8) | (u32)(c))
24 #define MAKE_SD_VERSION(a, b, c)        \
25         (SD_VERSION_SD | MAKE_SDMMC_VERSION(a, b, c))
26 #define MAKE_MMC_VERSION(a, b, c)       \
27         (MMC_VERSION_MMC | MAKE_SDMMC_VERSION(a, b, c))
28
29 #define EXTRACT_SDMMC_MAJOR_VERSION(x)  \
30         (((u32)(x) >> 16) & 0xff)
31 #define EXTRACT_SDMMC_MINOR_VERSION(x)  \
32         (((u32)(x) >> 8) & 0xff)
33 #define EXTRACT_SDMMC_CHANGE_VERSION(x) \
34         ((u32)(x) & 0xff)
35
36 #define SD_VERSION_3            MAKE_SD_VERSION(3, 0, 0)
37 #define SD_VERSION_2            MAKE_SD_VERSION(2, 0, 0)
38 #define SD_VERSION_1_0          MAKE_SD_VERSION(1, 0, 0)
39 #define SD_VERSION_1_10         MAKE_SD_VERSION(1, 10, 0)
40
41 #define MMC_VERSION_UNKNOWN     MAKE_MMC_VERSION(0, 0, 0)
42 #define MMC_VERSION_1_2         MAKE_MMC_VERSION(1, 2, 0)
43 #define MMC_VERSION_1_4         MAKE_MMC_VERSION(1, 4, 0)
44 #define MMC_VERSION_2_2         MAKE_MMC_VERSION(2, 2, 0)
45 #define MMC_VERSION_3           MAKE_MMC_VERSION(3, 0, 0)
46 #define MMC_VERSION_4           MAKE_MMC_VERSION(4, 0, 0)
47 #define MMC_VERSION_4_1         MAKE_MMC_VERSION(4, 1, 0)
48 #define MMC_VERSION_4_2         MAKE_MMC_VERSION(4, 2, 0)
49 #define MMC_VERSION_4_3         MAKE_MMC_VERSION(4, 3, 0)
50 #define MMC_VERSION_4_41        MAKE_MMC_VERSION(4, 4, 1)
51 #define MMC_VERSION_4_5         MAKE_MMC_VERSION(4, 5, 0)
52 #define MMC_VERSION_5_0         MAKE_MMC_VERSION(5, 0, 0)
53 #define MMC_VERSION_5_1         MAKE_MMC_VERSION(5, 1, 0)
54
55 #define MMC_CAP(mode)           (1 << mode)
56 #define MMC_MODE_HS             (MMC_CAP(MMC_HS) | MMC_CAP(SD_HS))
57 #define MMC_MODE_HS_52MHz       MMC_CAP(MMC_HS_52)
58 #define MMC_MODE_DDR_52MHz      MMC_CAP(MMC_DDR_52)
59
60 #define MMC_MODE_8BIT           BIT(30)
61 #define MMC_MODE_4BIT           BIT(29)
62 #define MMC_MODE_1BIT           BIT(28)
63 #define MMC_MODE_SPI            BIT(27)
64
65
66 #define SD_DATA_4BIT    0x00040000
67
68 #define IS_SD(x)        ((x)->version & SD_VERSION_SD)
69 #define IS_MMC(x)       ((x)->version & MMC_VERSION_MMC)
70
71 #define MMC_DATA_READ           1
72 #define MMC_DATA_WRITE          2
73
74 #define MMC_CMD_GO_IDLE_STATE           0
75 #define MMC_CMD_SEND_OP_COND            1
76 #define MMC_CMD_ALL_SEND_CID            2
77 #define MMC_CMD_SET_RELATIVE_ADDR       3
78 #define MMC_CMD_SET_DSR                 4
79 #define MMC_CMD_SWITCH                  6
80 #define MMC_CMD_SELECT_CARD             7
81 #define MMC_CMD_SEND_EXT_CSD            8
82 #define MMC_CMD_SEND_CSD                9
83 #define MMC_CMD_SEND_CID                10
84 #define MMC_CMD_STOP_TRANSMISSION       12
85 #define MMC_CMD_SEND_STATUS             13
86 #define MMC_CMD_SET_BLOCKLEN            16
87 #define MMC_CMD_READ_SINGLE_BLOCK       17
88 #define MMC_CMD_READ_MULTIPLE_BLOCK     18
89 #define MMC_CMD_SET_BLOCK_COUNT         23
90 #define MMC_CMD_WRITE_SINGLE_BLOCK      24
91 #define MMC_CMD_WRITE_MULTIPLE_BLOCK    25
92 #define MMC_CMD_ERASE_GROUP_START       35
93 #define MMC_CMD_ERASE_GROUP_END         36
94 #define MMC_CMD_ERASE                   38
95 #define MMC_CMD_APP_CMD                 55
96 #define MMC_CMD_SPI_READ_OCR            58
97 #define MMC_CMD_SPI_CRC_ON_OFF          59
98 #define MMC_CMD_RES_MAN                 62
99
100 #define MMC_CMD62_ARG1                  0xefac62ec
101 #define MMC_CMD62_ARG2                  0xcbaea7
102
103
104 #define SD_CMD_SEND_RELATIVE_ADDR       3
105 #define SD_CMD_SWITCH_FUNC              6
106 #define SD_CMD_SEND_IF_COND             8
107 #define SD_CMD_SWITCH_UHS18V            11
108
109 #define SD_CMD_APP_SET_BUS_WIDTH        6
110 #define SD_CMD_APP_SD_STATUS            13
111 #define SD_CMD_ERASE_WR_BLK_START       32
112 #define SD_CMD_ERASE_WR_BLK_END         33
113 #define SD_CMD_APP_SEND_OP_COND         41
114 #define SD_CMD_APP_SEND_SCR             51
115
116 /* SCR definitions in different words */
117 #define SD_HIGHSPEED_BUSY       0x00020000
118 #define SD_HIGHSPEED_SUPPORTED  0x00020000
119
120 #define OCR_BUSY                0x80000000
121 #define OCR_HCS                 0x40000000
122 #define OCR_VOLTAGE_MASK        0x007FFF80
123 #define OCR_ACCESS_MODE         0x60000000
124
125 #define MMC_ERASE_ARG           0x00000000
126 #define MMC_SECURE_ERASE_ARG    0x80000000
127 #define MMC_TRIM_ARG            0x00000001
128 #define MMC_DISCARD_ARG         0x00000003
129 #define MMC_SECURE_TRIM1_ARG    0x80000001
130 #define MMC_SECURE_TRIM2_ARG    0x80008000
131
132 #define MMC_STATUS_MASK         (~0x0206BF7F)
133 #define MMC_STATUS_SWITCH_ERROR (1 << 7)
134 #define MMC_STATUS_RDY_FOR_DATA (1 << 8)
135 #define MMC_STATUS_CURR_STATE   (0xf << 9)
136 #define MMC_STATUS_ERROR        (1 << 19)
137
138 #define MMC_STATE_PRG           (7 << 9)
139
140 #define MMC_VDD_165_195         0x00000080      /* VDD voltage 1.65 - 1.95 */
141 #define MMC_VDD_20_21           0x00000100      /* VDD voltage 2.0 ~ 2.1 */
142 #define MMC_VDD_21_22           0x00000200      /* VDD voltage 2.1 ~ 2.2 */
143 #define MMC_VDD_22_23           0x00000400      /* VDD voltage 2.2 ~ 2.3 */
144 #define MMC_VDD_23_24           0x00000800      /* VDD voltage 2.3 ~ 2.4 */
145 #define MMC_VDD_24_25           0x00001000      /* VDD voltage 2.4 ~ 2.5 */
146 #define MMC_VDD_25_26           0x00002000      /* VDD voltage 2.5 ~ 2.6 */
147 #define MMC_VDD_26_27           0x00004000      /* VDD voltage 2.6 ~ 2.7 */
148 #define MMC_VDD_27_28           0x00008000      /* VDD voltage 2.7 ~ 2.8 */
149 #define MMC_VDD_28_29           0x00010000      /* VDD voltage 2.8 ~ 2.9 */
150 #define MMC_VDD_29_30           0x00020000      /* VDD voltage 2.9 ~ 3.0 */
151 #define MMC_VDD_30_31           0x00040000      /* VDD voltage 3.0 ~ 3.1 */
152 #define MMC_VDD_31_32           0x00080000      /* VDD voltage 3.1 ~ 3.2 */
153 #define MMC_VDD_32_33           0x00100000      /* VDD voltage 3.2 ~ 3.3 */
154 #define MMC_VDD_33_34           0x00200000      /* VDD voltage 3.3 ~ 3.4 */
155 #define MMC_VDD_34_35           0x00400000      /* VDD voltage 3.4 ~ 3.5 */
156 #define MMC_VDD_35_36           0x00800000      /* VDD voltage 3.5 ~ 3.6 */
157
158 #define MMC_SWITCH_MODE_CMD_SET         0x00 /* Change the command set */
159 #define MMC_SWITCH_MODE_SET_BITS        0x01 /* Set bits in EXT_CSD byte
160                                                 addressed by index which are
161                                                 1 in value field */
162 #define MMC_SWITCH_MODE_CLEAR_BITS      0x02 /* Clear bits in EXT_CSD byte
163                                                 addressed by index, which are
164                                                 1 in value field */
165 #define MMC_SWITCH_MODE_WRITE_BYTE      0x03 /* Set target byte to value */
166
167 #define SD_SWITCH_CHECK         0
168 #define SD_SWITCH_SWITCH        1
169
170 /*
171  * EXT_CSD fields
172  */
173 #define EXT_CSD_ENH_START_ADDR          136     /* R/W */
174 #define EXT_CSD_ENH_SIZE_MULT           140     /* R/W */
175 #define EXT_CSD_GP_SIZE_MULT            143     /* R/W */
176 #define EXT_CSD_PARTITION_SETTING       155     /* R/W */
177 #define EXT_CSD_PARTITIONS_ATTRIBUTE    156     /* R/W */
178 #define EXT_CSD_MAX_ENH_SIZE_MULT       157     /* R */
179 #define EXT_CSD_PARTITIONING_SUPPORT    160     /* RO */
180 #define EXT_CSD_RST_N_FUNCTION          162     /* R/W */
181 #define EXT_CSD_BKOPS_EN                163     /* R/W & R/W/E */
182 #define EXT_CSD_WR_REL_PARAM            166     /* R */
183 #define EXT_CSD_WR_REL_SET              167     /* R/W */
184 #define EXT_CSD_RPMB_MULT               168     /* RO */
185 #define EXT_CSD_ERASE_GROUP_DEF         175     /* R/W */
186 #define EXT_CSD_BOOT_BUS_WIDTH          177
187 #define EXT_CSD_PART_CONF               179     /* R/W */
188 #define EXT_CSD_BUS_WIDTH               183     /* R/W */
189 #define EXT_CSD_HS_TIMING               185     /* R/W */
190 #define EXT_CSD_REV                     192     /* RO */
191 #define EXT_CSD_CARD_TYPE               196     /* RO */
192 #define EXT_CSD_SEC_CNT                 212     /* RO, 4 bytes */
193 #define EXT_CSD_HC_WP_GRP_SIZE          221     /* RO */
194 #define EXT_CSD_HC_ERASE_GRP_SIZE       224     /* RO */
195 #define EXT_CSD_BOOT_MULT               226     /* RO */
196 #define EXT_CSD_BKOPS_SUPPORT           502     /* RO */
197
198 /*
199  * EXT_CSD field definitions
200  */
201
202 #define EXT_CSD_CMD_SET_NORMAL          (1 << 0)
203 #define EXT_CSD_CMD_SET_SECURE          (1 << 1)
204 #define EXT_CSD_CMD_SET_CPSECURE        (1 << 2)
205
206 #define EXT_CSD_CARD_TYPE_26    (1 << 0)        /* Card can run at 26MHz */
207 #define EXT_CSD_CARD_TYPE_52    (1 << 1)        /* Card can run at 52MHz */
208 #define EXT_CSD_CARD_TYPE_DDR_1_8V      (1 << 2)
209 #define EXT_CSD_CARD_TYPE_DDR_1_2V      (1 << 3)
210 #define EXT_CSD_CARD_TYPE_DDR_52        (EXT_CSD_CARD_TYPE_DDR_1_8V \
211                                         | EXT_CSD_CARD_TYPE_DDR_1_2V)
212
213 #define EXT_CSD_BUS_WIDTH_1     0       /* Card is in 1 bit mode */
214 #define EXT_CSD_BUS_WIDTH_4     1       /* Card is in 4 bit mode */
215 #define EXT_CSD_BUS_WIDTH_8     2       /* Card is in 8 bit mode */
216 #define EXT_CSD_DDR_BUS_WIDTH_4 5       /* Card is in 4 bit DDR mode */
217 #define EXT_CSD_DDR_BUS_WIDTH_8 6       /* Card is in 8 bit DDR mode */
218 #define EXT_CSD_DDR_FLAG        BIT(2)  /* Flag for DDR mode */
219
220 #define EXT_CSD_TIMING_LEGACY   0       /* no high speed */
221 #define EXT_CSD_TIMING_HS       1       /* HS */
222 #define EXT_CSD_BOOT_ACK_ENABLE                 (1 << 6)
223 #define EXT_CSD_BOOT_PARTITION_ENABLE           (1 << 3)
224 #define EXT_CSD_PARTITION_ACCESS_ENABLE         (1 << 0)
225 #define EXT_CSD_PARTITION_ACCESS_DISABLE        (0 << 0)
226
227 #define EXT_CSD_BOOT_ACK(x)             (x << 6)
228 #define EXT_CSD_BOOT_PART_NUM(x)        (x << 3)
229 #define EXT_CSD_PARTITION_ACCESS(x)     (x << 0)
230
231 #define EXT_CSD_EXTRACT_BOOT_ACK(x)             (((x) >> 6) & 0x1)
232 #define EXT_CSD_EXTRACT_BOOT_PART(x)            (((x) >> 3) & 0x7)
233 #define EXT_CSD_EXTRACT_PARTITION_ACCESS(x)     ((x) & 0x7)
234
235 #define EXT_CSD_BOOT_BUS_WIDTH_MODE(x)  (x << 3)
236 #define EXT_CSD_BOOT_BUS_WIDTH_RESET(x) (x << 2)
237 #define EXT_CSD_BOOT_BUS_WIDTH_WIDTH(x) (x)
238
239 #define EXT_CSD_PARTITION_SETTING_COMPLETED     (1 << 0)
240
241 #define EXT_CSD_ENH_USR         (1 << 0)        /* user data area is enhanced */
242 #define EXT_CSD_ENH_GP(x)       (1 << ((x)+1))  /* GP part (x+1) is enhanced */
243
244 #define EXT_CSD_HS_CTRL_REL     (1 << 0)        /* host controlled WR_REL_SET */
245
246 #define EXT_CSD_WR_DATA_REL_USR         (1 << 0)        /* user data area WR_REL */
247 #define EXT_CSD_WR_DATA_REL_GP(x)       (1 << ((x)+1))  /* GP part (x+1) WR_REL */
248
249 #define R1_ILLEGAL_COMMAND              (1 << 22)
250 #define R1_APP_CMD                      (1 << 5)
251
252 #define MMC_RSP_PRESENT (1 << 0)
253 #define MMC_RSP_136     (1 << 1)                /* 136 bit response */
254 #define MMC_RSP_CRC     (1 << 2)                /* expect valid crc */
255 #define MMC_RSP_BUSY    (1 << 3)                /* card may send busy */
256 #define MMC_RSP_OPCODE  (1 << 4)                /* response contains opcode */
257
258 #define MMC_RSP_NONE    (0)
259 #define MMC_RSP_R1      (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
260 #define MMC_RSP_R1b     (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE| \
261                         MMC_RSP_BUSY)
262 #define MMC_RSP_R2      (MMC_RSP_PRESENT|MMC_RSP_136|MMC_RSP_CRC)
263 #define MMC_RSP_R3      (MMC_RSP_PRESENT)
264 #define MMC_RSP_R4      (MMC_RSP_PRESENT)
265 #define MMC_RSP_R5      (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
266 #define MMC_RSP_R6      (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
267 #define MMC_RSP_R7      (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
268
269 #define MMCPART_NOAVAILABLE     (0xff)
270 #define PART_ACCESS_MASK        (0x7)
271 #define PART_SUPPORT            (0x1)
272 #define ENHNCD_SUPPORT          (0x2)
273 #define PART_ENH_ATTRIB         (0x1f)
274
275 enum mmc_voltage {
276         MMC_SIGNAL_VOLTAGE_000 = 0,
277         MMC_SIGNAL_VOLTAGE_120,
278         MMC_SIGNAL_VOLTAGE_180,
279         MMC_SIGNAL_VOLTAGE_330
280 };
281
282 /* Maximum block size for MMC */
283 #define MMC_MAX_BLOCK_LEN       512
284
285 /* The number of MMC physical partitions.  These consist of:
286  * boot partitions (2), general purpose partitions (4) in MMC v4.4.
287  */
288 #define MMC_NUM_BOOT_PARTITION  2
289 #define MMC_PART_RPMB           3       /* RPMB partition number */
290
291 /* Driver model support */
292
293 /**
294  * struct mmc_uclass_priv - Holds information about a device used by the uclass
295  */
296 struct mmc_uclass_priv {
297         struct mmc *mmc;
298 };
299
300 /**
301  * mmc_get_mmc_dev() - get the MMC struct pointer for a device
302  *
303  * Provided that the device is already probed and ready for use, this value
304  * will be available.
305  *
306  * @dev:        Device
307  * @return associated mmc struct pointer if available, else NULL
308  */
309 struct mmc *mmc_get_mmc_dev(struct udevice *dev);
310
311 /* End of driver model support */
312
313 struct mmc_cid {
314         unsigned long psn;
315         unsigned short oid;
316         unsigned char mid;
317         unsigned char prv;
318         unsigned char mdt;
319         char pnm[7];
320 };
321
322 struct mmc_cmd {
323         ushort cmdidx;
324         uint resp_type;
325         uint cmdarg;
326         uint response[4];
327 };
328
329 struct mmc_data {
330         union {
331                 char *dest;
332                 const char *src; /* src buffers don't get written to */
333         };
334         uint flags;
335         uint blocks;
336         uint blocksize;
337 };
338
339 /* forward decl. */
340 struct mmc;
341
342 #if CONFIG_IS_ENABLED(DM_MMC)
343 struct dm_mmc_ops {
344         /**
345          * send_cmd() - Send a command to the MMC device
346          *
347          * @dev:        Device to receive the command
348          * @cmd:        Command to send
349          * @data:       Additional data to send/receive
350          * @return 0 if OK, -ve on error
351          */
352         int (*send_cmd)(struct udevice *dev, struct mmc_cmd *cmd,
353                         struct mmc_data *data);
354
355         /**
356          * set_ios() - Set the I/O speed/width for an MMC device
357          *
358          * @dev:        Device to update
359          * @return 0 if OK, -ve on error
360          */
361         int (*set_ios)(struct udevice *dev);
362
363         /**
364          * get_cd() - See whether a card is present
365          *
366          * @dev:        Device to check
367          * @return 0 if not present, 1 if present, -ve on error
368          */
369         int (*get_cd)(struct udevice *dev);
370
371         /**
372          * get_wp() - See whether a card has write-protect enabled
373          *
374          * @dev:        Device to check
375          * @return 0 if write-enabled, 1 if write-protected, -ve on error
376          */
377         int (*get_wp)(struct udevice *dev);
378 };
379
380 #define mmc_get_ops(dev)        ((struct dm_mmc_ops *)(dev)->driver->ops)
381
382 int dm_mmc_send_cmd(struct udevice *dev, struct mmc_cmd *cmd,
383                     struct mmc_data *data);
384 int dm_mmc_set_ios(struct udevice *dev);
385 int dm_mmc_get_cd(struct udevice *dev);
386 int dm_mmc_get_wp(struct udevice *dev);
387
388 /* Transition functions for compatibility */
389 int mmc_set_ios(struct mmc *mmc);
390 int mmc_getcd(struct mmc *mmc);
391 int mmc_getwp(struct mmc *mmc);
392
393 #else
394 struct mmc_ops {
395         int (*send_cmd)(struct mmc *mmc,
396                         struct mmc_cmd *cmd, struct mmc_data *data);
397         int (*set_ios)(struct mmc *mmc);
398         int (*init)(struct mmc *mmc);
399         int (*getcd)(struct mmc *mmc);
400         int (*getwp)(struct mmc *mmc);
401 };
402 #endif
403
404 struct mmc_config {
405         const char *name;
406 #if !CONFIG_IS_ENABLED(DM_MMC)
407         const struct mmc_ops *ops;
408 #endif
409         uint host_caps;
410         uint voltages;
411         uint f_min;
412         uint f_max;
413         uint b_max;
414         unsigned char part_type;
415 };
416
417 struct sd_ssr {
418         unsigned int au;                /* In sectors */
419         unsigned int erase_timeout;     /* In milliseconds */
420         unsigned int erase_offset;      /* In milliseconds */
421 };
422
423 enum bus_mode {
424         MMC_LEGACY,
425         SD_LEGACY,
426         MMC_HS,
427         SD_HS,
428         UHS_SDR12,
429         UHS_SDR25,
430         UHS_SDR50,
431         UHS_SDR104,
432         UHS_DDR50,
433         MMC_HS_52,
434         MMC_DDR_52,
435         MMC_HS_200,
436         MMC_MODES_END
437 };
438
439 const char *mmc_mode_name(enum bus_mode mode);
440 void mmc_dump_capabilities(const char *text, uint caps);
441
442 static inline bool mmc_is_mode_ddr(enum bus_mode mode)
443 {
444         if ((mode == MMC_DDR_52) || (mode == UHS_DDR50))
445                 return true;
446         else
447                 return false;
448 }
449
450 /*
451  * With CONFIG_DM_MMC enabled, struct mmc can be accessed from the MMC device
452  * with mmc_get_mmc_dev().
453  *
454  * TODO struct mmc should be in mmc_private but it's hard to fix right now
455  */
456 struct mmc {
457 #if !CONFIG_IS_ENABLED(BLK)
458         struct list_head link;
459 #endif
460         const struct mmc_config *cfg;   /* provided configuration */
461         uint version;
462         void *priv;
463         uint has_init;
464         int high_capacity;
465         uint bus_width;
466         uint clock;
467         enum mmc_voltage signal_voltage;
468         uint card_caps;
469         uint ocr;
470         uint dsr;
471         uint dsr_imp;
472         uint scr[2];
473         uint csd[4];
474         uint cid[4];
475         ushort rca;
476         u8 part_support;
477         u8 part_attr;
478         u8 wr_rel_set;
479         u8 part_config;
480         uint tran_speed;
481         uint legacy_speed; /* speed for the legacy mode provided by the card */
482         uint read_bl_len;
483         uint write_bl_len;
484         uint erase_grp_size;    /* in 512-byte sectors */
485         uint hc_wp_grp_size;    /* in 512-byte sectors */
486         struct sd_ssr   ssr;    /* SD status register */
487         u64 capacity;
488         u64 capacity_user;
489         u64 capacity_boot;
490         u64 capacity_rpmb;
491         u64 capacity_gp[4];
492         u64 enh_user_start;
493         u64 enh_user_size;
494 #if !CONFIG_IS_ENABLED(BLK)
495         struct blk_desc block_dev;
496 #endif
497         char op_cond_pending;   /* 1 if we are waiting on an op_cond command */
498         char init_in_progress;  /* 1 if we have done mmc_start_init() */
499         char preinit;           /* start init as early as possible */
500         int ddr_mode;
501 #if CONFIG_IS_ENABLED(DM_MMC)
502         struct udevice *dev;    /* Device for this MMC controller */
503 #if CONFIG_IS_ENABLED(DM_REGULATOR)
504         struct udevice *vmmc_supply;    /* Main voltage regulator (Vcc)*/
505         struct udevice *vqmmc_supply;   /* IO voltage regulator (Vccq)*/
506 #endif
507 #endif
508         u8 *ext_csd;
509         enum bus_mode selected_mode;
510 };
511
512 struct mmc_hwpart_conf {
513         struct {
514                 uint enh_start; /* in 512-byte sectors */
515                 uint enh_size;  /* in 512-byte sectors, if 0 no enh area */
516                 unsigned wr_rel_change : 1;
517                 unsigned wr_rel_set : 1;
518         } user;
519         struct {
520                 uint size;      /* in 512-byte sectors */
521                 unsigned enhanced : 1;
522                 unsigned wr_rel_change : 1;
523                 unsigned wr_rel_set : 1;
524         } gp_part[4];
525 };
526
527 enum mmc_hwpart_conf_mode {
528         MMC_HWPART_CONF_CHECK,
529         MMC_HWPART_CONF_SET,
530         MMC_HWPART_CONF_COMPLETE,
531 };
532
533 struct mmc *mmc_create(const struct mmc_config *cfg, void *priv);
534
535 /**
536  * mmc_bind() - Set up a new MMC device ready for probing
537  *
538  * A child block device is bound with the IF_TYPE_MMC interface type. This
539  * allows the device to be used with CONFIG_BLK
540  *
541  * @dev:        MMC device to set up
542  * @mmc:        MMC struct
543  * @cfg:        MMC configuration
544  * @return 0 if OK, -ve on error
545  */
546 int mmc_bind(struct udevice *dev, struct mmc *mmc,
547              const struct mmc_config *cfg);
548 void mmc_destroy(struct mmc *mmc);
549
550 /**
551  * mmc_unbind() - Unbind a MMC device's child block device
552  *
553  * @dev:        MMC device
554  * @return 0 if OK, -ve on error
555  */
556 int mmc_unbind(struct udevice *dev);
557 int mmc_initialize(bd_t *bis);
558 int mmc_init(struct mmc *mmc);
559 int mmc_read(struct mmc *mmc, u64 src, uchar *dst, int size);
560 int mmc_set_clock(struct mmc *mmc, uint clock);
561 struct mmc *find_mmc_device(int dev_num);
562 int mmc_set_dev(int dev_num);
563 void print_mmc_devices(char separator);
564
565 /**
566  * get_mmc_num() - get the total MMC device number
567  *
568  * @return 0 if there is no MMC device, else the number of devices
569  */
570 int get_mmc_num(void);
571 int mmc_switch_part(struct mmc *mmc, unsigned int part_num);
572 int mmc_hwpart_config(struct mmc *mmc, const struct mmc_hwpart_conf *conf,
573                       enum mmc_hwpart_conf_mode mode);
574
575 #if !CONFIG_IS_ENABLED(DM_MMC)
576 int mmc_getcd(struct mmc *mmc);
577 int board_mmc_getcd(struct mmc *mmc);
578 int mmc_getwp(struct mmc *mmc);
579 int board_mmc_getwp(struct mmc *mmc);
580 #endif
581
582 int mmc_set_dsr(struct mmc *mmc, u16 val);
583 /* Function to change the size of boot partition and rpmb partitions */
584 int mmc_boot_partition_size_change(struct mmc *mmc, unsigned long bootsize,
585                                         unsigned long rpmbsize);
586 /* Function to modify the PARTITION_CONFIG field of EXT_CSD */
587 int mmc_set_part_conf(struct mmc *mmc, u8 ack, u8 part_num, u8 access);
588 /* Function to modify the BOOT_BUS_WIDTH field of EXT_CSD */
589 int mmc_set_boot_bus_width(struct mmc *mmc, u8 width, u8 reset, u8 mode);
590 /* Function to modify the RST_n_FUNCTION field of EXT_CSD */
591 int mmc_set_rst_n_function(struct mmc *mmc, u8 enable);
592 /* Functions to read / write the RPMB partition */
593 int mmc_rpmb_set_key(struct mmc *mmc, void *key);
594 int mmc_rpmb_get_counter(struct mmc *mmc, unsigned long *counter);
595 int mmc_rpmb_read(struct mmc *mmc, void *addr, unsigned short blk,
596                   unsigned short cnt, unsigned char *key);
597 int mmc_rpmb_write(struct mmc *mmc, void *addr, unsigned short blk,
598                    unsigned short cnt, unsigned char *key);
599 #ifdef CONFIG_CMD_BKOPS_ENABLE
600 int mmc_set_bkops_enable(struct mmc *mmc);
601 #endif
602
603 /**
604  * Start device initialization and return immediately; it does not block on
605  * polling OCR (operation condition register) status.  Then you should call
606  * mmc_init, which would block on polling OCR status and complete the device
607  * initializatin.
608  *
609  * @param mmc   Pointer to a MMC device struct
610  * @return 0 on success, IN_PROGRESS on waiting for OCR status, <0 on error.
611  */
612 int mmc_start_init(struct mmc *mmc);
613
614 /**
615  * Set preinit flag of mmc device.
616  *
617  * This will cause the device to be pre-inited during mmc_initialize(),
618  * which may save boot time if the device is not accessed until later.
619  * Some eMMC devices take 200-300ms to init, but unfortunately they
620  * must be sent a series of commands to even get them to start preparing
621  * for operation.
622  *
623  * @param mmc           Pointer to a MMC device struct
624  * @param preinit       preinit flag value
625  */
626 void mmc_set_preinit(struct mmc *mmc, int preinit);
627
628 #ifdef CONFIG_MMC_SPI
629 #define mmc_host_is_spi(mmc)    ((mmc)->cfg->host_caps & MMC_MODE_SPI)
630 #else
631 #define mmc_host_is_spi(mmc)    0
632 #endif
633 struct mmc *mmc_spi_init(uint bus, uint cs, uint speed, uint mode);
634
635 void board_mmc_power_init(void);
636 int board_mmc_init(bd_t *bis);
637 int cpu_mmc_init(bd_t *bis);
638 int mmc_get_env_addr(struct mmc *mmc, int copy, u32 *env_addr);
639 int mmc_get_env_dev(void);
640
641 /* Set block count limit because of 16 bit register limit on some hardware*/
642 #ifndef CONFIG_SYS_MMC_MAX_BLK_COUNT
643 #define CONFIG_SYS_MMC_MAX_BLK_COUNT 65535
644 #endif
645
646 /**
647  * mmc_get_blk_desc() - Get the block descriptor for an MMC device
648  *
649  * @mmc:        MMC device
650  * @return block device if found, else NULL
651  */
652 struct blk_desc *mmc_get_blk_desc(struct mmc *mmc);
653
654 #endif /* _MMC_H_ */