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