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