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 /* Maximum block size for MMC */
 276 #define MMC_MAX_BLOCK_LEN       512
 277
 278 /* The number of MMC physical partitions.  These consist of:
 279  * boot partitions (2), general purpose partitions (4) in MMC v4.4.
 280  */
 281 #define MMC_NUM_BOOT_PARTITION  2
 282 #define MMC_PART_RPMB           3       /* RPMB partition number */
 283
 284 /* Driver model support */
 285
 286 /**
 287  * struct mmc_uclass_priv - Holds information about a device used by the uclass
 288  */
 289 struct mmc_uclass_priv {
 290         struct mmc *mmc;
 291 };
 292
 293 /**
 294  * mmc_get_mmc_dev() - get the MMC struct pointer for a device
 295  *
 296  * Provided that the device is already probed and ready for use, this value
 297  * will be available.
 298  *
 299  * @dev:        Device
 300  * @return associated mmc struct pointer if available, else NULL
 301  */
 302 struct mmc *mmc_get_mmc_dev(struct udevice *dev);
 303
 304 /* End of driver model support */
 305
 306 struct mmc_cid {
 307         unsigned long psn;
 308         unsigned short oid;
 309         unsigned char mid;
 310         unsigned char prv;
 311         unsigned char mdt;
 312         char pnm[7];
 313 };
 314
 315 struct mmc_cmd {
 316         ushort cmdidx;
 317         uint resp_type;
 318         uint cmdarg;
 319         uint response[4];
 320 };
 321
 322 struct mmc_data {
 323         union {
 324                 char *dest;
 325                 const char *src; /* src buffers don't get written to */
 326         };
 327         uint flags;
 328         uint blocks;
 329         uint blocksize;
 330 };
 331
 332 /* forward decl. */
 333 struct mmc;
 334
 335 #if CONFIG_IS_ENABLED(DM_MMC)
 336 struct dm_mmc_ops {
 337         /**
 338          * send_cmd() - Send a command to the MMC device
 339          *
 340          * @dev:        Device to receive the command
 341          * @cmd:        Command to send
 342          * @data:       Additional data to send/receive
 343          * @return 0 if OK, -ve on error
 344          */
 345         int (*send_cmd)(struct udevice *dev, struct mmc_cmd *cmd,
 346                         struct mmc_data *data);
 347
 348         /**
 349          * set_ios() - Set the I/O speed/width for an MMC device
 350          *
 351          * @dev:        Device to update
 352          * @return 0 if OK, -ve on error
 353          */
 354         int (*set_ios)(struct udevice *dev);
 355
 356         /**
 357          * get_cd() - See whether a card is present
 358          *
 359          * @dev:        Device to check
 360          * @return 0 if not present, 1 if present, -ve on error
 361          */
 362         int (*get_cd)(struct udevice *dev);
 363
 364         /**
 365          * get_wp() - See whether a card has write-protect enabled
 366          *
 367          * @dev:        Device to check
 368          * @return 0 if write-enabled, 1 if write-protected, -ve on error
 369          */
 370         int (*get_wp)(struct udevice *dev);
 371 };
 372
 373 #define mmc_get_ops(dev)        ((struct dm_mmc_ops *)(dev)->driver->ops)
 374
 375 int dm_mmc_send_cmd(struct udevice *dev, struct mmc_cmd *cmd,
 376                     struct mmc_data *data);
 377 int dm_mmc_set_ios(struct udevice *dev);
 378 int dm_mmc_get_cd(struct udevice *dev);
 379 int dm_mmc_get_wp(struct udevice *dev);
 380
 381 /* Transition functions for compatibility */
 382 int mmc_set_ios(struct mmc *mmc);
 383 int mmc_getcd(struct mmc *mmc);
 384 int mmc_getwp(struct mmc *mmc);
 385
 386 #else
 387 struct mmc_ops {
 388         int (*send_cmd)(struct mmc *mmc,
 389                         struct mmc_cmd *cmd, struct mmc_data *data);
 390         int (*set_ios)(struct mmc *mmc);
 391         int (*init)(struct mmc *mmc);
 392         int (*getcd)(struct mmc *mmc);
 393         int (*getwp)(struct mmc *mmc);
 394 };
 395 #endif
 396
 397 struct mmc_config {
 398         const char *name;
 399 #if !CONFIG_IS_ENABLED(DM_MMC)
 400         const struct mmc_ops *ops;
 401 #endif
 402         uint host_caps;
 403         uint voltages;
 404         uint f_min;
 405         uint f_max;
 406         uint b_max;
 407         unsigned char part_type;
 408 };
 409
 410 struct sd_ssr {
 411         unsigned int au;                /* In sectors */
 412         unsigned int erase_timeout;     /* In milliseconds */
 413         unsigned int erase_offset;      /* In milliseconds */
 414 };
 415
 416 enum bus_mode {
 417         MMC_LEGACY,
 418         SD_LEGACY,
 419         MMC_HS,
 420         SD_HS,
 421         UHS_SDR12,
 422         UHS_SDR25,
 423         UHS_SDR50,
 424         UHS_SDR104,
 425         UHS_DDR50,
 426         MMC_HS_52,
 427         MMC_DDR_52,
 428         MMC_HS_200,
 429         MMC_MODES_END
 430 };
 431
 432 const char *mmc_mode_name(enum bus_mode mode);
 433 void mmc_dump_capabilities(const char *text, uint caps);
 434
 435 static inline bool mmc_is_mode_ddr(enum bus_mode mode)
 436 {
 437         if ((mode == MMC_DDR_52) || (mode == UHS_DDR50))
 438                 return true;
 439         else
 440                 return false;
 441 }
 442
 443 /*
 444  * With CONFIG_DM_MMC enabled, struct mmc can be accessed from the MMC device
 445  * with mmc_get_mmc_dev().
 446  *
 447  * TODO struct mmc should be in mmc_private but it's hard to fix right now
 448  */
 449 struct mmc {
 450 #if !CONFIG_IS_ENABLED(BLK)
 451         struct list_head link;
 452 #endif
 453         const struct mmc_config *cfg;   /* provided configuration */
 454         uint version;
 455         void *priv;
 456         uint has_init;
 457         int high_capacity;
 458         uint bus_width;
 459         uint clock;
 460         uint card_caps;
 461         uint ocr;
 462         uint dsr;
 463         uint dsr_imp;
 464         uint scr[2];
 465         uint csd[4];
 466         uint cid[4];
 467         ushort rca;
 468         u8 part_support;
 469         u8 part_attr;
 470         u8 wr_rel_set;
 471         u8 part_config;
 472         uint tran_speed;
 473         uint legacy_speed; /* speed for the legacy mode provided by the card */
 474         uint read_bl_len;
 475         uint write_bl_len;
 476         uint erase_grp_size;    /* in 512-byte sectors */
 477         uint hc_wp_grp_size;    /* in 512-byte sectors */
 478         struct sd_ssr   ssr;    /* SD status register */
 479         u64 capacity;
 480         u64 capacity_user;
 481         u64 capacity_boot;
 482         u64 capacity_rpmb;
 483         u64 capacity_gp[4];
 484         u64 enh_user_start;
 485         u64 enh_user_size;
 486 #if !CONFIG_IS_ENABLED(BLK)
 487         struct blk_desc block_dev;
 488 #endif
 489         char op_cond_pending;   /* 1 if we are waiting on an op_cond command */
 490         char init_in_progress;  /* 1 if we have done mmc_start_init() */
 491         char preinit;           /* start init as early as possible */
 492         int ddr_mode;
 493 #if CONFIG_IS_ENABLED(DM_MMC)
 494         struct udevice *dev;    /* Device for this MMC controller */
 495 #if CONFIG_IS_ENABLED(DM_REGULATOR)
 496         struct udevice *vmmc_supply;    /* Main voltage regulator (Vcc)*/
 497         struct udevice *vqmmc_supply;   /* IO voltage regulator (Vccq)*/
 498 #endif
 499 #endif
 500         u8 *ext_csd;
 501         enum bus_mode selected_mode;
 502 };
 503
 504 struct mmc_hwpart_conf {
 505         struct {
 506                 uint enh_start; /* in 512-byte sectors */
 507                 uint enh_size;  /* in 512-byte sectors, if 0 no enh area */
 508                 unsigned wr_rel_change : 1;
 509                 unsigned wr_rel_set : 1;
 510         } user;
 511         struct {
 512                 uint size;      /* in 512-byte sectors */
 513                 unsigned enhanced : 1;
 514                 unsigned wr_rel_change : 1;
 515                 unsigned wr_rel_set : 1;
 516         } gp_part[4];
 517 };
 518
 519 enum mmc_hwpart_conf_mode {
 520         MMC_HWPART_CONF_CHECK,
 521         MMC_HWPART_CONF_SET,
 522         MMC_HWPART_CONF_COMPLETE,
 523 };
 524
 525 struct mmc *mmc_create(const struct mmc_config *cfg, void *priv);
 526
 527 /**
 528  * mmc_bind() - Set up a new MMC device ready for probing
 529  *
 530  * A child block device is bound with the IF_TYPE_MMC interface type. This
 531  * allows the device to be used with CONFIG_BLK
 532  *
 533  * @dev:        MMC device to set up
 534  * @mmc:        MMC struct
 535  * @cfg:        MMC configuration
 536  * @return 0 if OK, -ve on error
 537  */
 538 int mmc_bind(struct udevice *dev, struct mmc *mmc,
 539              const struct mmc_config *cfg);
 540 void mmc_destroy(struct mmc *mmc);
 541
 542 /**
 543  * mmc_unbind() - Unbind a MMC device's child block device
 544  *
 545  * @dev:        MMC device
 546  * @return 0 if OK, -ve on error
 547  */
 548 int mmc_unbind(struct udevice *dev);
 549 int mmc_initialize(bd_t *bis);
 550 int mmc_init(struct mmc *mmc);
 551 int mmc_read(struct mmc *mmc, u64 src, uchar *dst, int size);
 552 int mmc_set_clock(struct mmc *mmc, uint clock);
 553 struct mmc *find_mmc_device(int dev_num);
 554 int mmc_set_dev(int dev_num);
 555 void print_mmc_devices(char separator);
 556
 557 /**
 558  * get_mmc_num() - get the total MMC device number
 559  *
 560  * @return 0 if there is no MMC device, else the number of devices
 561  */
 562 int get_mmc_num(void);
 563 int mmc_switch_part(struct mmc *mmc, unsigned int part_num);
 564 int mmc_hwpart_config(struct mmc *mmc, const struct mmc_hwpart_conf *conf,
 565                       enum mmc_hwpart_conf_mode mode);
 566
 567 #if !CONFIG_IS_ENABLED(DM_MMC)
 568 int mmc_getcd(struct mmc *mmc);
 569 int board_mmc_getcd(struct mmc *mmc);
 570 int mmc_getwp(struct mmc *mmc);
 571 int board_mmc_getwp(struct mmc *mmc);
 572 #endif
 573
 574 int mmc_set_dsr(struct mmc *mmc, u16 val);
 575 /* Function to change the size of boot partition and rpmb partitions */
 576 int mmc_boot_partition_size_change(struct mmc *mmc, unsigned long bootsize,
 577                                         unsigned long rpmbsize);
 578 /* Function to modify the PARTITION_CONFIG field of EXT_CSD */
 579 int mmc_set_part_conf(struct mmc *mmc, u8 ack, u8 part_num, u8 access);
 580 /* Function to modify the BOOT_BUS_WIDTH field of EXT_CSD */
 581 int mmc_set_boot_bus_width(struct mmc *mmc, u8 width, u8 reset, u8 mode);
 582 /* Function to modify the RST_n_FUNCTION field of EXT_CSD */
 583 int mmc_set_rst_n_function(struct mmc *mmc, u8 enable);
 584 /* Functions to read / write the RPMB partition */
 585 int mmc_rpmb_set_key(struct mmc *mmc, void *key);
 586 int mmc_rpmb_get_counter(struct mmc *mmc, unsigned long *counter);
 587 int mmc_rpmb_read(struct mmc *mmc, void *addr, unsigned short blk,
 588                   unsigned short cnt, unsigned char *key);
 589 int mmc_rpmb_write(struct mmc *mmc, void *addr, unsigned short blk,
 590                    unsigned short cnt, unsigned char *key);
 591 #ifdef CONFIG_CMD_BKOPS_ENABLE
 592 int mmc_set_bkops_enable(struct mmc *mmc);
 593 #endif
 594
 595 /**
 596  * Start device initialization and return immediately; it does not block on
 597  * polling OCR (operation condition register) status.  Then you should call
 598  * mmc_init, which would block on polling OCR status and complete the device
 599  * initializatin.
 600  *
 601  * @param mmc   Pointer to a MMC device struct
 602  * @return 0 on success, IN_PROGRESS on waiting for OCR status, <0 on error.
 603  */
 604 int mmc_start_init(struct mmc *mmc);
 605
 606 /**
 607  * Set preinit flag of mmc device.
 608  *
 609  * This will cause the device to be pre-inited during mmc_initialize(),
 610  * which may save boot time if the device is not accessed until later.
 611  * Some eMMC devices take 200-300ms to init, but unfortunately they
 612  * must be sent a series of commands to even get them to start preparing
 613  * for operation.
 614  *
 615  * @param mmc           Pointer to a MMC device struct
 616  * @param preinit       preinit flag value
 617  */
 618 void mmc_set_preinit(struct mmc *mmc, int preinit);
 619
 620 #ifdef CONFIG_MMC_SPI
 621 #define mmc_host_is_spi(mmc)    ((mmc)->cfg->host_caps & MMC_MODE_SPI)
 622 #else
 623 #define mmc_host_is_spi(mmc)    0
 624 #endif
 625 struct mmc *mmc_spi_init(uint bus, uint cs, uint speed, uint mode);
 626
 627 void board_mmc_power_init(void);
 628 int board_mmc_init(bd_t *bis);
 629 int cpu_mmc_init(bd_t *bis);
 630 int mmc_get_env_addr(struct mmc *mmc, int copy, u32 *env_addr);
 631 int mmc_get_env_dev(void);
 632
 633 /* Set block count limit because of 16 bit register limit on some hardware*/
 634 #ifndef CONFIG_SYS_MMC_MAX_BLK_COUNT
 635 #define CONFIG_SYS_MMC_MAX_BLK_COUNT 65535
 636 #endif
 637
 638 /**
 639  * mmc_get_blk_desc() - Get the block descriptor for an MMC device
 640  *
 641  * @mmc:        MMC device
 642  * @return block device if found, else NULL
 643  */
 644 struct blk_desc *mmc_get_blk_desc(struct mmc *mmc);
 645
 646 #endif /* _MMC_H_ */