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