include/mmc.h

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