171f95118Swdenk /* 24a6ee172SJerry Huang * Copyright 2008,2010 Freescale Semiconductor, Inc 3272cc70bSAndy Fleming * Andy Fleming 4272cc70bSAndy Fleming * 5272cc70bSAndy Fleming * Based (loosely) on the Linux code 671f95118Swdenk * 71a459660SWolfgang Denk * SPDX-License-Identifier: GPL-2.0+ 871f95118Swdenk */ 971f95118Swdenk 1071f95118Swdenk #ifndef _MMC_H_ 1171f95118Swdenk #define _MMC_H_ 1271f95118Swdenk 13272cc70bSAndy Fleming #include <linux/list.h> 143697e599SPeng Fan #include <linux/sizes.h> 150d986e61SLad, Prabhakar #include <linux/compiler.h> 1607a2d42cSMateusz Zalega #include <part.h> 17272cc70bSAndy Fleming 184b7cee53SPantelis Antoniou /* SD/MMC version bits; 8 flags, 8 major, 8 minor, 8 change */ 194b7cee53SPantelis Antoniou #define SD_VERSION_SD (1U << 31) 204b7cee53SPantelis Antoniou #define MMC_VERSION_MMC (1U << 30) 214b7cee53SPantelis Antoniou 224b7cee53SPantelis Antoniou #define MAKE_SDMMC_VERSION(a, b, c) \ 234b7cee53SPantelis Antoniou ((((u32)(a)) << 16) | ((u32)(b) << 8) | (u32)(c)) 244b7cee53SPantelis Antoniou #define MAKE_SD_VERSION(a, b, c) \ 254b7cee53SPantelis Antoniou (SD_VERSION_SD | MAKE_SDMMC_VERSION(a, b, c)) 264b7cee53SPantelis Antoniou #define MAKE_MMC_VERSION(a, b, c) \ 274b7cee53SPantelis Antoniou (MMC_VERSION_MMC | MAKE_SDMMC_VERSION(a, b, c)) 284b7cee53SPantelis Antoniou 294b7cee53SPantelis Antoniou #define EXTRACT_SDMMC_MAJOR_VERSION(x) \ 304b7cee53SPantelis Antoniou (((u32)(x) >> 16) & 0xff) 314b7cee53SPantelis Antoniou #define EXTRACT_SDMMC_MINOR_VERSION(x) \ 324b7cee53SPantelis Antoniou (((u32)(x) >> 8) & 0xff) 334b7cee53SPantelis Antoniou #define EXTRACT_SDMMC_CHANGE_VERSION(x) \ 344b7cee53SPantelis Antoniou ((u32)(x) & 0xff) 354b7cee53SPantelis Antoniou 364b7cee53SPantelis Antoniou #define SD_VERSION_3 MAKE_SD_VERSION(3, 0, 0) 374b7cee53SPantelis Antoniou #define SD_VERSION_2 MAKE_SD_VERSION(2, 0, 0) 384b7cee53SPantelis Antoniou #define SD_VERSION_1_0 MAKE_SD_VERSION(1, 0, 0) 394b7cee53SPantelis Antoniou #define SD_VERSION_1_10 MAKE_SD_VERSION(1, 10, 0) 404b7cee53SPantelis Antoniou 414b7cee53SPantelis Antoniou #define MMC_VERSION_UNKNOWN MAKE_MMC_VERSION(0, 0, 0) 424b7cee53SPantelis Antoniou #define MMC_VERSION_1_2 MAKE_MMC_VERSION(1, 2, 0) 434b7cee53SPantelis Antoniou #define MMC_VERSION_1_4 MAKE_MMC_VERSION(1, 4, 0) 444b7cee53SPantelis Antoniou #define MMC_VERSION_2_2 MAKE_MMC_VERSION(2, 2, 0) 454b7cee53SPantelis Antoniou #define MMC_VERSION_3 MAKE_MMC_VERSION(3, 0, 0) 464b7cee53SPantelis Antoniou #define MMC_VERSION_4 MAKE_MMC_VERSION(4, 0, 0) 474b7cee53SPantelis Antoniou #define MMC_VERSION_4_1 MAKE_MMC_VERSION(4, 1, 0) 484b7cee53SPantelis Antoniou #define MMC_VERSION_4_2 MAKE_MMC_VERSION(4, 2, 0) 494b7cee53SPantelis Antoniou #define MMC_VERSION_4_3 MAKE_MMC_VERSION(4, 3, 0) 504b7cee53SPantelis Antoniou #define MMC_VERSION_4_41 MAKE_MMC_VERSION(4, 4, 1) 514b7cee53SPantelis Antoniou #define MMC_VERSION_4_5 MAKE_MMC_VERSION(4, 5, 0) 524b7cee53SPantelis Antoniou #define MMC_VERSION_5_0 MAKE_MMC_VERSION(5, 0, 0) 531a3619cfSStefan Wahren #define MMC_VERSION_5_1 MAKE_MMC_VERSION(5, 1, 0) 54272cc70bSAndy Fleming 558caf46d1SJaehoon Chung #define MMC_MODE_HS (1 << 0) 568caf46d1SJaehoon Chung #define MMC_MODE_HS_52MHz (1 << 1) 578caf46d1SJaehoon Chung #define MMC_MODE_4BIT (1 << 2) 588caf46d1SJaehoon Chung #define MMC_MODE_8BIT (1 << 3) 598caf46d1SJaehoon Chung #define MMC_MODE_SPI (1 << 4) 605a20397bSRob Herring #define MMC_MODE_DDR_52MHz (1 << 5) 6162722036SŁukasz Majewski 62272cc70bSAndy Fleming #define SD_DATA_4BIT 0x00040000 63272cc70bSAndy Fleming 644b7cee53SPantelis Antoniou #define IS_SD(x) ((x)->version & SD_VERSION_SD) 653f2da751SAndrew Gabbasov #define IS_MMC(x) ((x)->version & MMC_VERSION_MMC) 66272cc70bSAndy Fleming 67272cc70bSAndy Fleming #define MMC_DATA_READ 1 68272cc70bSAndy Fleming #define MMC_DATA_WRITE 2 69272cc70bSAndy Fleming 70341188b9SHaavard Skinnemoen #define MMC_CMD_GO_IDLE_STATE 0 71341188b9SHaavard Skinnemoen #define MMC_CMD_SEND_OP_COND 1 72341188b9SHaavard Skinnemoen #define MMC_CMD_ALL_SEND_CID 2 73341188b9SHaavard Skinnemoen #define MMC_CMD_SET_RELATIVE_ADDR 3 74341188b9SHaavard Skinnemoen #define MMC_CMD_SET_DSR 4 75272cc70bSAndy Fleming #define MMC_CMD_SWITCH 6 76341188b9SHaavard Skinnemoen #define MMC_CMD_SELECT_CARD 7 77272cc70bSAndy Fleming #define MMC_CMD_SEND_EXT_CSD 8 78341188b9SHaavard Skinnemoen #define MMC_CMD_SEND_CSD 9 79341188b9SHaavard Skinnemoen #define MMC_CMD_SEND_CID 10 80272cc70bSAndy Fleming #define MMC_CMD_STOP_TRANSMISSION 12 81341188b9SHaavard Skinnemoen #define MMC_CMD_SEND_STATUS 13 82341188b9SHaavard Skinnemoen #define MMC_CMD_SET_BLOCKLEN 16 83341188b9SHaavard Skinnemoen #define MMC_CMD_READ_SINGLE_BLOCK 17 84341188b9SHaavard Skinnemoen #define MMC_CMD_READ_MULTIPLE_BLOCK 18 8591fdabc6SPierre Aubert #define MMC_CMD_SET_BLOCK_COUNT 23 86272cc70bSAndy Fleming #define MMC_CMD_WRITE_SINGLE_BLOCK 24 87272cc70bSAndy Fleming #define MMC_CMD_WRITE_MULTIPLE_BLOCK 25 88e6f99a56SLei Wen #define MMC_CMD_ERASE_GROUP_START 35 89e6f99a56SLei Wen #define MMC_CMD_ERASE_GROUP_END 36 90e6f99a56SLei Wen #define MMC_CMD_ERASE 38 91341188b9SHaavard Skinnemoen #define MMC_CMD_APP_CMD 55 92d52ebf10SThomas Chou #define MMC_CMD_SPI_READ_OCR 58 93d52ebf10SThomas Chou #define MMC_CMD_SPI_CRC_ON_OFF 59 943690d6d6SAmar #define MMC_CMD_RES_MAN 62 953690d6d6SAmar 963690d6d6SAmar #define MMC_CMD62_ARG1 0xefac62ec 973690d6d6SAmar #define MMC_CMD62_ARG2 0xcbaea7 983690d6d6SAmar 99341188b9SHaavard Skinnemoen 100341188b9SHaavard Skinnemoen #define SD_CMD_SEND_RELATIVE_ADDR 3 101272cc70bSAndy Fleming #define SD_CMD_SWITCH_FUNC 6 102341188b9SHaavard Skinnemoen #define SD_CMD_SEND_IF_COND 8 103f022d36eSOtavio Salvador #define SD_CMD_SWITCH_UHS18V 11 104341188b9SHaavard Skinnemoen 105341188b9SHaavard Skinnemoen #define SD_CMD_APP_SET_BUS_WIDTH 6 1063697e599SPeng Fan #define SD_CMD_APP_SD_STATUS 13 107e6f99a56SLei Wen #define SD_CMD_ERASE_WR_BLK_START 32 108e6f99a56SLei Wen #define SD_CMD_ERASE_WR_BLK_END 33 109341188b9SHaavard Skinnemoen #define SD_CMD_APP_SEND_OP_COND 41 110272cc70bSAndy Fleming #define SD_CMD_APP_SEND_SCR 51 111272cc70bSAndy Fleming 112272cc70bSAndy Fleming /* SCR definitions in different words */ 113272cc70bSAndy Fleming #define SD_HIGHSPEED_BUSY 0x00020000 114272cc70bSAndy Fleming #define SD_HIGHSPEED_SUPPORTED 0x00020000 115272cc70bSAndy Fleming 1160b453ffeSRabin Vincent #define OCR_BUSY 0x80000000 117272cc70bSAndy Fleming #define OCR_HCS 0x40000000 11831cacbabSRaffaele Recalcati #define OCR_VOLTAGE_MASK 0x007FFF80 11931cacbabSRaffaele Recalcati #define OCR_ACCESS_MODE 0x60000000 120272cc70bSAndy Fleming 1211aa2d074SEric Nelson #define MMC_ERASE_ARG 0x00000000 1221aa2d074SEric Nelson #define MMC_SECURE_ERASE_ARG 0x80000000 1231aa2d074SEric Nelson #define MMC_TRIM_ARG 0x00000001 1241aa2d074SEric Nelson #define MMC_DISCARD_ARG 0x00000003 1251aa2d074SEric Nelson #define MMC_SECURE_TRIM1_ARG 0x80000001 1261aa2d074SEric Nelson #define MMC_SECURE_TRIM2_ARG 0x80008000 127e6f99a56SLei Wen 1285d4fc8d9SRaffaele Recalcati #define MMC_STATUS_MASK (~0x0206BF7F) 1296b2221b0SAndrew Gabbasov #define MMC_STATUS_SWITCH_ERROR (1 << 7) 1305d4fc8d9SRaffaele Recalcati #define MMC_STATUS_RDY_FOR_DATA (1 << 8) 1315d4fc8d9SRaffaele Recalcati #define MMC_STATUS_CURR_STATE (0xf << 9) 132ed018b21SThomas Chou #define MMC_STATUS_ERROR (1 << 19) 1335d4fc8d9SRaffaele Recalcati 134d617c426SJan Kloetzke #define MMC_STATE_PRG (7 << 9) 135d617c426SJan Kloetzke 136272cc70bSAndy Fleming #define MMC_VDD_165_195 0x00000080 /* VDD voltage 1.65 - 1.95 */ 137272cc70bSAndy Fleming #define MMC_VDD_20_21 0x00000100 /* VDD voltage 2.0 ~ 2.1 */ 138272cc70bSAndy Fleming #define MMC_VDD_21_22 0x00000200 /* VDD voltage 2.1 ~ 2.2 */ 139272cc70bSAndy Fleming #define MMC_VDD_22_23 0x00000400 /* VDD voltage 2.2 ~ 2.3 */ 140272cc70bSAndy Fleming #define MMC_VDD_23_24 0x00000800 /* VDD voltage 2.3 ~ 2.4 */ 141272cc70bSAndy Fleming #define MMC_VDD_24_25 0x00001000 /* VDD voltage 2.4 ~ 2.5 */ 142272cc70bSAndy Fleming #define MMC_VDD_25_26 0x00002000 /* VDD voltage 2.5 ~ 2.6 */ 143272cc70bSAndy Fleming #define MMC_VDD_26_27 0x00004000 /* VDD voltage 2.6 ~ 2.7 */ 144272cc70bSAndy Fleming #define MMC_VDD_27_28 0x00008000 /* VDD voltage 2.7 ~ 2.8 */ 145272cc70bSAndy Fleming #define MMC_VDD_28_29 0x00010000 /* VDD voltage 2.8 ~ 2.9 */ 146272cc70bSAndy Fleming #define MMC_VDD_29_30 0x00020000 /* VDD voltage 2.9 ~ 3.0 */ 147272cc70bSAndy Fleming #define MMC_VDD_30_31 0x00040000 /* VDD voltage 3.0 ~ 3.1 */ 148272cc70bSAndy Fleming #define MMC_VDD_31_32 0x00080000 /* VDD voltage 3.1 ~ 3.2 */ 149272cc70bSAndy Fleming #define MMC_VDD_32_33 0x00100000 /* VDD voltage 3.2 ~ 3.3 */ 150272cc70bSAndy Fleming #define MMC_VDD_33_34 0x00200000 /* VDD voltage 3.3 ~ 3.4 */ 151272cc70bSAndy Fleming #define MMC_VDD_34_35 0x00400000 /* VDD voltage 3.4 ~ 3.5 */ 152272cc70bSAndy Fleming #define MMC_VDD_35_36 0x00800000 /* VDD voltage 3.5 ~ 3.6 */ 153272cc70bSAndy Fleming 154272cc70bSAndy Fleming #define MMC_SWITCH_MODE_CMD_SET 0x00 /* Change the command set */ 155272cc70bSAndy Fleming #define MMC_SWITCH_MODE_SET_BITS 0x01 /* Set bits in EXT_CSD byte 156272cc70bSAndy Fleming addressed by index which are 157272cc70bSAndy Fleming 1 in value field */ 158272cc70bSAndy Fleming #define MMC_SWITCH_MODE_CLEAR_BITS 0x02 /* Clear bits in EXT_CSD byte 159272cc70bSAndy Fleming addressed by index, which are 160272cc70bSAndy Fleming 1 in value field */ 161272cc70bSAndy Fleming #define MMC_SWITCH_MODE_WRITE_BYTE 0x03 /* Set target byte to value */ 162272cc70bSAndy Fleming 163272cc70bSAndy Fleming #define SD_SWITCH_CHECK 0 164272cc70bSAndy Fleming #define SD_SWITCH_SWITCH 1 165272cc70bSAndy Fleming 166272cc70bSAndy Fleming /* 167272cc70bSAndy Fleming * EXT_CSD fields 168272cc70bSAndy Fleming */ 169a7f852b6SDiego Santa Cruz #define EXT_CSD_ENH_START_ADDR 136 /* R/W */ 170a7f852b6SDiego Santa Cruz #define EXT_CSD_ENH_SIZE_MULT 140 /* R/W */ 171f866a46dSStephen Warren #define EXT_CSD_GP_SIZE_MULT 143 /* R/W */ 172d7b29129SMarkus Niebel #define EXT_CSD_PARTITION_SETTING 155 /* R/W */ 1731937e5aaSOliver Metz #define EXT_CSD_PARTITIONS_ATTRIBUTE 156 /* R/W */ 174ac9da0e0SDiego Santa Cruz #define EXT_CSD_MAX_ENH_SIZE_MULT 157 /* R */ 1750560db18SLei Wen #define EXT_CSD_PARTITIONING_SUPPORT 160 /* RO */ 17633ace362STom Rini #define EXT_CSD_RST_N_FUNCTION 162 /* R/W */ 177cd3d4880STomas Melin #define EXT_CSD_BKOPS_EN 163 /* R/W & R/W/E */ 1788dda5b0eSDiego Santa Cruz #define EXT_CSD_WR_REL_PARAM 166 /* R */ 1798dda5b0eSDiego Santa Cruz #define EXT_CSD_WR_REL_SET 167 /* R/W */ 180f866a46dSStephen Warren #define EXT_CSD_RPMB_MULT 168 /* RO */ 1810560db18SLei Wen #define EXT_CSD_ERASE_GROUP_DEF 175 /* R/W */ 1823690d6d6SAmar #define EXT_CSD_BOOT_BUS_WIDTH 177 183bc897b1dSLei Wen #define EXT_CSD_PART_CONF 179 /* R/W */ 184272cc70bSAndy Fleming #define EXT_CSD_BUS_WIDTH 183 /* R/W */ 185272cc70bSAndy Fleming #define EXT_CSD_HS_TIMING 185 /* R/W */ 186272cc70bSAndy Fleming #define EXT_CSD_REV 192 /* RO */ 1870560db18SLei Wen #define EXT_CSD_CARD_TYPE 196 /* RO */ 188272cc70bSAndy Fleming #define EXT_CSD_SEC_CNT 212 /* RO, 4 bytes */ 189f866a46dSStephen Warren #define EXT_CSD_HC_WP_GRP_SIZE 221 /* RO */ 1900560db18SLei Wen #define EXT_CSD_HC_ERASE_GRP_SIZE 224 /* RO */ 1918948ea83SStephen Warren #define EXT_CSD_BOOT_MULT 226 /* RO */ 192cd3d4880STomas Melin #define EXT_CSD_BKOPS_SUPPORT 502 /* RO */ 193272cc70bSAndy Fleming 194272cc70bSAndy Fleming /* 195272cc70bSAndy Fleming * EXT_CSD field definitions 196272cc70bSAndy Fleming */ 197272cc70bSAndy Fleming 198272cc70bSAndy Fleming #define EXT_CSD_CMD_SET_NORMAL (1 << 0) 199272cc70bSAndy Fleming #define EXT_CSD_CMD_SET_SECURE (1 << 1) 200272cc70bSAndy Fleming #define EXT_CSD_CMD_SET_CPSECURE (1 << 2) 201272cc70bSAndy Fleming 202272cc70bSAndy Fleming #define EXT_CSD_CARD_TYPE_26 (1 << 0) /* Card can run at 26MHz */ 203272cc70bSAndy Fleming #define EXT_CSD_CARD_TYPE_52 (1 << 1) /* Card can run at 52MHz */ 204d22e3d46SJaehoon Chung #define EXT_CSD_CARD_TYPE_DDR_1_8V (1 << 2) 205d22e3d46SJaehoon Chung #define EXT_CSD_CARD_TYPE_DDR_1_2V (1 << 3) 206d22e3d46SJaehoon Chung #define EXT_CSD_CARD_TYPE_DDR_52 (EXT_CSD_CARD_TYPE_DDR_1_8V \ 207d22e3d46SJaehoon Chung | EXT_CSD_CARD_TYPE_DDR_1_2V) 208272cc70bSAndy Fleming 209272cc70bSAndy Fleming #define EXT_CSD_BUS_WIDTH_1 0 /* Card is in 1 bit mode */ 210272cc70bSAndy Fleming #define EXT_CSD_BUS_WIDTH_4 1 /* Card is in 4 bit mode */ 211272cc70bSAndy Fleming #define EXT_CSD_BUS_WIDTH_8 2 /* Card is in 8 bit mode */ 212d22e3d46SJaehoon Chung #define EXT_CSD_DDR_BUS_WIDTH_4 5 /* Card is in 4 bit DDR mode */ 213d22e3d46SJaehoon Chung #define EXT_CSD_DDR_BUS_WIDTH_8 6 /* Card is in 8 bit DDR mode */ 214341188b9SHaavard Skinnemoen 2153690d6d6SAmar #define EXT_CSD_BOOT_ACK_ENABLE (1 << 6) 2163690d6d6SAmar #define EXT_CSD_BOOT_PARTITION_ENABLE (1 << 3) 2173690d6d6SAmar #define EXT_CSD_PARTITION_ACCESS_ENABLE (1 << 0) 2183690d6d6SAmar #define EXT_CSD_PARTITION_ACCESS_DISABLE (0 << 0) 2193690d6d6SAmar 2203690d6d6SAmar #define EXT_CSD_BOOT_ACK(x) (x << 6) 2213690d6d6SAmar #define EXT_CSD_BOOT_PART_NUM(x) (x << 3) 2223690d6d6SAmar #define EXT_CSD_PARTITION_ACCESS(x) (x << 0) 2233690d6d6SAmar 2245a99b9deSTom Rini #define EXT_CSD_BOOT_BUS_WIDTH_MODE(x) (x << 3) 2255a99b9deSTom Rini #define EXT_CSD_BOOT_BUS_WIDTH_RESET(x) (x << 2) 2265a99b9deSTom Rini #define EXT_CSD_BOOT_BUS_WIDTH_WIDTH(x) (x) 2273690d6d6SAmar 228d7b29129SMarkus Niebel #define EXT_CSD_PARTITION_SETTING_COMPLETED (1 << 0) 229d7b29129SMarkus Niebel 230c3dbb4f9SDiego Santa Cruz #define EXT_CSD_ENH_USR (1 << 0) /* user data area is enhanced */ 231c3dbb4f9SDiego Santa Cruz #define EXT_CSD_ENH_GP(x) (1 << ((x)+1)) /* GP part (x+1) is enhanced */ 232c3dbb4f9SDiego Santa Cruz 2338dda5b0eSDiego Santa Cruz #define EXT_CSD_HS_CTRL_REL (1 << 0) /* host controlled WR_REL_SET */ 2348dda5b0eSDiego Santa Cruz 2358dda5b0eSDiego Santa Cruz #define EXT_CSD_WR_DATA_REL_USR (1 << 0) /* user data area WR_REL */ 2368dda5b0eSDiego Santa Cruz #define EXT_CSD_WR_DATA_REL_GP(x) (1 << ((x)+1)) /* GP part (x+1) WR_REL */ 2378dda5b0eSDiego Santa Cruz 2381de97f98SAndy Fleming #define R1_ILLEGAL_COMMAND (1 << 22) 2391de97f98SAndy Fleming #define R1_APP_CMD (1 << 5) 2401de97f98SAndy Fleming 241272cc70bSAndy Fleming #define MMC_RSP_PRESENT (1 << 0) 242272cc70bSAndy Fleming #define MMC_RSP_136 (1 << 1) /* 136 bit response */ 243272cc70bSAndy Fleming #define MMC_RSP_CRC (1 << 2) /* expect valid crc */ 244272cc70bSAndy Fleming #define MMC_RSP_BUSY (1 << 3) /* card may send busy */ 245272cc70bSAndy Fleming #define MMC_RSP_OPCODE (1 << 4) /* response contains opcode */ 246272cc70bSAndy Fleming 247272cc70bSAndy Fleming #define MMC_RSP_NONE (0) 248272cc70bSAndy Fleming #define MMC_RSP_R1 (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE) 249272cc70bSAndy Fleming #define MMC_RSP_R1b (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE| \ 250272cc70bSAndy Fleming MMC_RSP_BUSY) 251272cc70bSAndy Fleming #define MMC_RSP_R2 (MMC_RSP_PRESENT|MMC_RSP_136|MMC_RSP_CRC) 252272cc70bSAndy Fleming #define MMC_RSP_R3 (MMC_RSP_PRESENT) 253272cc70bSAndy Fleming #define MMC_RSP_R4 (MMC_RSP_PRESENT) 254272cc70bSAndy Fleming #define MMC_RSP_R5 (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE) 255272cc70bSAndy Fleming #define MMC_RSP_R6 (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE) 256272cc70bSAndy Fleming #define MMC_RSP_R7 (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE) 257272cc70bSAndy Fleming 258bc897b1dSLei Wen #define MMCPART_NOAVAILABLE (0xff) 259bc897b1dSLei Wen #define PART_ACCESS_MASK (0x7) 260bc897b1dSLei Wen #define PART_SUPPORT (0x1) 261c3dbb4f9SDiego Santa Cruz #define ENHNCD_SUPPORT (0x2) 2621937e5aaSOliver Metz #define PART_ENH_ATTRIB (0x1f) 26371f95118Swdenk 2648bfa195eSSimon Glass /* Maximum block size for MMC */ 2658bfa195eSSimon Glass #define MMC_MAX_BLOCK_LEN 512 2668bfa195eSSimon Glass 2673690d6d6SAmar /* The number of MMC physical partitions. These consist of: 2683690d6d6SAmar * boot partitions (2), general purpose partitions (4) in MMC v4.4. 2693690d6d6SAmar */ 2703690d6d6SAmar #define MMC_NUM_BOOT_PARTITION 2 27191fdabc6SPierre Aubert #define MMC_PART_RPMB 3 /* RPMB partition number */ 2723690d6d6SAmar 273e7ecf7cbSSimon Glass /* Driver model support */ 274e7ecf7cbSSimon Glass 275e7ecf7cbSSimon Glass /** 276e7ecf7cbSSimon Glass * struct mmc_uclass_priv - Holds information about a device used by the uclass 277e7ecf7cbSSimon Glass */ 278e7ecf7cbSSimon Glass struct mmc_uclass_priv { 279e7ecf7cbSSimon Glass struct mmc *mmc; 280e7ecf7cbSSimon Glass }; 281e7ecf7cbSSimon Glass 282e7ecf7cbSSimon Glass /** 283e7ecf7cbSSimon Glass * mmc_get_mmc_dev() - get the MMC struct pointer for a device 284e7ecf7cbSSimon Glass * 285e7ecf7cbSSimon Glass * Provided that the device is already probed and ready for use, this value 286e7ecf7cbSSimon Glass * will be available. 287e7ecf7cbSSimon Glass * 288e7ecf7cbSSimon Glass * @dev: Device 289e7ecf7cbSSimon Glass * @return associated mmc struct pointer if available, else NULL 290e7ecf7cbSSimon Glass */ 291e7ecf7cbSSimon Glass struct mmc *mmc_get_mmc_dev(struct udevice *dev); 292e7ecf7cbSSimon Glass 293e7ecf7cbSSimon Glass /* End of driver model support */ 294e7ecf7cbSSimon Glass 2951de97f98SAndy Fleming struct mmc_cid { 2961de97f98SAndy Fleming unsigned long psn; 2971de97f98SAndy Fleming unsigned short oid; 2981de97f98SAndy Fleming unsigned char mid; 2991de97f98SAndy Fleming unsigned char prv; 3001de97f98SAndy Fleming unsigned char mdt; 3011de97f98SAndy Fleming char pnm[7]; 3021de97f98SAndy Fleming }; 3031de97f98SAndy Fleming 304272cc70bSAndy Fleming struct mmc_cmd { 305272cc70bSAndy Fleming ushort cmdidx; 306272cc70bSAndy Fleming uint resp_type; 307272cc70bSAndy Fleming uint cmdarg; 3080b453ffeSRabin Vincent uint response[4]; 309272cc70bSAndy Fleming }; 310272cc70bSAndy Fleming 311272cc70bSAndy Fleming struct mmc_data { 312272cc70bSAndy Fleming union { 313272cc70bSAndy Fleming char *dest; 314272cc70bSAndy Fleming const char *src; /* src buffers don't get written to */ 315272cc70bSAndy Fleming }; 316272cc70bSAndy Fleming uint flags; 317272cc70bSAndy Fleming uint blocks; 318272cc70bSAndy Fleming uint blocksize; 319272cc70bSAndy Fleming }; 320272cc70bSAndy Fleming 321ab769f22SPantelis Antoniou /* forward decl. */ 322ab769f22SPantelis Antoniou struct mmc; 323ab769f22SPantelis Antoniou 324*c4d660d4SSimon Glass #if CONFIG_IS_ENABLED(DM_MMC_OPS) 3258ca51e51SSimon Glass struct dm_mmc_ops { 3268ca51e51SSimon Glass /** 3278ca51e51SSimon Glass * send_cmd() - Send a command to the MMC device 3288ca51e51SSimon Glass * 3298ca51e51SSimon Glass * @dev: Device to receive the command 3308ca51e51SSimon Glass * @cmd: Command to send 3318ca51e51SSimon Glass * @data: Additional data to send/receive 3328ca51e51SSimon Glass * @return 0 if OK, -ve on error 3338ca51e51SSimon Glass */ 3348ca51e51SSimon Glass int (*send_cmd)(struct udevice *dev, struct mmc_cmd *cmd, 3358ca51e51SSimon Glass struct mmc_data *data); 3368ca51e51SSimon Glass 3378ca51e51SSimon Glass /** 3388ca51e51SSimon Glass * set_ios() - Set the I/O speed/width for an MMC device 3398ca51e51SSimon Glass * 3408ca51e51SSimon Glass * @dev: Device to update 3418ca51e51SSimon Glass * @return 0 if OK, -ve on error 3428ca51e51SSimon Glass */ 3438ca51e51SSimon Glass int (*set_ios)(struct udevice *dev); 3448ca51e51SSimon Glass 3458ca51e51SSimon Glass /** 3468ca51e51SSimon Glass * get_cd() - See whether a card is present 3478ca51e51SSimon Glass * 3488ca51e51SSimon Glass * @dev: Device to check 3498ca51e51SSimon Glass * @return 0 if not present, 1 if present, -ve on error 3508ca51e51SSimon Glass */ 3518ca51e51SSimon Glass int (*get_cd)(struct udevice *dev); 3528ca51e51SSimon Glass 3538ca51e51SSimon Glass /** 3548ca51e51SSimon Glass * get_wp() - See whether a card has write-protect enabled 3558ca51e51SSimon Glass * 3568ca51e51SSimon Glass * @dev: Device to check 3578ca51e51SSimon Glass * @return 0 if write-enabled, 1 if write-protected, -ve on error 3588ca51e51SSimon Glass */ 3598ca51e51SSimon Glass int (*get_wp)(struct udevice *dev); 3608ca51e51SSimon Glass }; 3618ca51e51SSimon Glass 3628ca51e51SSimon Glass #define mmc_get_ops(dev) ((struct dm_mmc_ops *)(dev)->driver->ops) 3638ca51e51SSimon Glass 3648ca51e51SSimon Glass int dm_mmc_send_cmd(struct udevice *dev, struct mmc_cmd *cmd, 3658ca51e51SSimon Glass struct mmc_data *data); 3668ca51e51SSimon Glass int dm_mmc_set_ios(struct udevice *dev); 3678ca51e51SSimon Glass int dm_mmc_get_cd(struct udevice *dev); 3688ca51e51SSimon Glass int dm_mmc_get_wp(struct udevice *dev); 3698ca51e51SSimon Glass 3708ca51e51SSimon Glass /* Transition functions for compatibility */ 3718ca51e51SSimon Glass int mmc_set_ios(struct mmc *mmc); 3728ca51e51SSimon Glass int mmc_getcd(struct mmc *mmc); 3738ca51e51SSimon Glass int mmc_getwp(struct mmc *mmc); 3748ca51e51SSimon Glass 3758ca51e51SSimon Glass #else 376ab769f22SPantelis Antoniou struct mmc_ops { 377ab769f22SPantelis Antoniou int (*send_cmd)(struct mmc *mmc, 378ab769f22SPantelis Antoniou struct mmc_cmd *cmd, struct mmc_data *data); 37907b0b9c0SJaehoon Chung int (*set_ios)(struct mmc *mmc); 380ab769f22SPantelis Antoniou int (*init)(struct mmc *mmc); 381ab769f22SPantelis Antoniou int (*getcd)(struct mmc *mmc); 382ab769f22SPantelis Antoniou int (*getwp)(struct mmc *mmc); 383ab769f22SPantelis Antoniou }; 3848ca51e51SSimon Glass #endif 385ab769f22SPantelis Antoniou 38693bfd616SPantelis Antoniou struct mmc_config { 38793bfd616SPantelis Antoniou const char *name; 388*c4d660d4SSimon Glass #if !CONFIG_IS_ENABLED(DM_MMC_OPS) 38993bfd616SPantelis Antoniou const struct mmc_ops *ops; 3908ca51e51SSimon Glass #endif 39193bfd616SPantelis Antoniou uint host_caps; 392272cc70bSAndy Fleming uint voltages; 393272cc70bSAndy Fleming uint f_min; 394272cc70bSAndy Fleming uint f_max; 39593bfd616SPantelis Antoniou uint b_max; 39693bfd616SPantelis Antoniou unsigned char part_type; 39793bfd616SPantelis Antoniou }; 39893bfd616SPantelis Antoniou 3993697e599SPeng Fan struct sd_ssr { 4003697e599SPeng Fan unsigned int au; /* In sectors */ 4013697e599SPeng Fan unsigned int erase_timeout; /* In milliseconds */ 4023697e599SPeng Fan unsigned int erase_offset; /* In milliseconds */ 4033697e599SPeng Fan }; 4043697e599SPeng Fan 4058ca51e51SSimon Glass /* 4068ca51e51SSimon Glass * With CONFIG_DM_MMC enabled, struct mmc can be accessed from the MMC device 4078ca51e51SSimon Glass * with mmc_get_mmc_dev(). 4088ca51e51SSimon Glass * 4098ca51e51SSimon Glass * TODO struct mmc should be in mmc_private but it's hard to fix right now 4108ca51e51SSimon Glass */ 41193bfd616SPantelis Antoniou struct mmc { 412*c4d660d4SSimon Glass #if !CONFIG_IS_ENABLED(BLK) 41393bfd616SPantelis Antoniou struct list_head link; 41433fb211dSSimon Glass #endif 41593bfd616SPantelis Antoniou const struct mmc_config *cfg; /* provided configuration */ 41693bfd616SPantelis Antoniou uint version; 41793bfd616SPantelis Antoniou void *priv; 41893bfd616SPantelis Antoniou uint has_init; 419272cc70bSAndy Fleming int high_capacity; 420272cc70bSAndy Fleming uint bus_width; 421272cc70bSAndy Fleming uint clock; 422272cc70bSAndy Fleming uint card_caps; 423272cc70bSAndy Fleming uint ocr; 424ab71188cSMarkus Niebel uint dsr; 425ab71188cSMarkus Niebel uint dsr_imp; 426272cc70bSAndy Fleming uint scr[2]; 427272cc70bSAndy Fleming uint csd[4]; 4280b453ffeSRabin Vincent uint cid[4]; 429272cc70bSAndy Fleming ushort rca; 430c3dbb4f9SDiego Santa Cruz u8 part_support; 431c3dbb4f9SDiego Santa Cruz u8 part_attr; 4329e41a00bSDiego Santa Cruz u8 wr_rel_set; 4337ca0d3ddSTom Rini u8 part_config; 434272cc70bSAndy Fleming uint tran_speed; 435272cc70bSAndy Fleming uint read_bl_len; 436272cc70bSAndy Fleming uint write_bl_len; 437a4ff9f83SDiego Santa Cruz uint erase_grp_size; /* in 512-byte sectors */ 438037dc0abSDiego Santa Cruz uint hc_wp_grp_size; /* in 512-byte sectors */ 4393697e599SPeng Fan struct sd_ssr ssr; /* SD status register */ 440272cc70bSAndy Fleming u64 capacity; 441f866a46dSStephen Warren u64 capacity_user; 442f866a46dSStephen Warren u64 capacity_boot; 443f866a46dSStephen Warren u64 capacity_rpmb; 444f866a46dSStephen Warren u64 capacity_gp[4]; 445a7f852b6SDiego Santa Cruz u64 enh_user_start; 446a7f852b6SDiego Santa Cruz u64 enh_user_size; 447*c4d660d4SSimon Glass #if !CONFIG_IS_ENABLED(BLK) 4484101f687SSimon Glass struct blk_desc block_dev; 44933fb211dSSimon Glass #endif 450e9550449SChe-Liang Chiou char op_cond_pending; /* 1 if we are waiting on an op_cond command */ 451e9550449SChe-Liang Chiou char init_in_progress; /* 1 if we have done mmc_start_init() */ 452e9550449SChe-Liang Chiou char preinit; /* start init as early as possible */ 453786e8f81SAndrew Gabbasov int ddr_mode; 454*c4d660d4SSimon Glass #if CONFIG_IS_ENABLED(DM_MMC) 455cffe5d86SSimon Glass struct udevice *dev; /* Device for this MMC controller */ 456cffe5d86SSimon Glass #endif 457272cc70bSAndy Fleming }; 458272cc70bSAndy Fleming 459ac9da0e0SDiego Santa Cruz struct mmc_hwpart_conf { 460ac9da0e0SDiego Santa Cruz struct { 461ac9da0e0SDiego Santa Cruz uint enh_start; /* in 512-byte sectors */ 462ac9da0e0SDiego Santa Cruz uint enh_size; /* in 512-byte sectors, if 0 no enh area */ 4638dda5b0eSDiego Santa Cruz unsigned wr_rel_change : 1; 4648dda5b0eSDiego Santa Cruz unsigned wr_rel_set : 1; 465ac9da0e0SDiego Santa Cruz } user; 466ac9da0e0SDiego Santa Cruz struct { 467ac9da0e0SDiego Santa Cruz uint size; /* in 512-byte sectors */ 4688dda5b0eSDiego Santa Cruz unsigned enhanced : 1; 4698dda5b0eSDiego Santa Cruz unsigned wr_rel_change : 1; 4708dda5b0eSDiego Santa Cruz unsigned wr_rel_set : 1; 471ac9da0e0SDiego Santa Cruz } gp_part[4]; 472ac9da0e0SDiego Santa Cruz }; 473ac9da0e0SDiego Santa Cruz 474ac9da0e0SDiego Santa Cruz enum mmc_hwpart_conf_mode { 475ac9da0e0SDiego Santa Cruz MMC_HWPART_CONF_CHECK, 476ac9da0e0SDiego Santa Cruz MMC_HWPART_CONF_SET, 477ac9da0e0SDiego Santa Cruz MMC_HWPART_CONF_COMPLETE, 478ac9da0e0SDiego Santa Cruz }; 479ac9da0e0SDiego Santa Cruz 48093bfd616SPantelis Antoniou struct mmc *mmc_create(const struct mmc_config *cfg, void *priv); 481ad27dd5eSSimon Glass 482ad27dd5eSSimon Glass /** 483ad27dd5eSSimon Glass * mmc_bind() - Set up a new MMC device ready for probing 484ad27dd5eSSimon Glass * 485ad27dd5eSSimon Glass * A child block device is bound with the IF_TYPE_MMC interface type. This 486ad27dd5eSSimon Glass * allows the device to be used with CONFIG_BLK 487ad27dd5eSSimon Glass * 488ad27dd5eSSimon Glass * @dev: MMC device to set up 489ad27dd5eSSimon Glass * @mmc: MMC struct 490ad27dd5eSSimon Glass * @cfg: MMC configuration 491ad27dd5eSSimon Glass * @return 0 if OK, -ve on error 492ad27dd5eSSimon Glass */ 493ad27dd5eSSimon Glass int mmc_bind(struct udevice *dev, struct mmc *mmc, 494ad27dd5eSSimon Glass const struct mmc_config *cfg); 49593bfd616SPantelis Antoniou void mmc_destroy(struct mmc *mmc); 496ad27dd5eSSimon Glass 497ad27dd5eSSimon Glass /** 498ad27dd5eSSimon Glass * mmc_unbind() - Unbind a MMC device's child block device 499ad27dd5eSSimon Glass * 500ad27dd5eSSimon Glass * @dev: MMC device 501ad27dd5eSSimon Glass * @return 0 if OK, -ve on error 502ad27dd5eSSimon Glass */ 503ad27dd5eSSimon Glass int mmc_unbind(struct udevice *dev); 504272cc70bSAndy Fleming int mmc_initialize(bd_t *bis); 505272cc70bSAndy Fleming int mmc_init(struct mmc *mmc); 506272cc70bSAndy Fleming int mmc_read(struct mmc *mmc, u64 src, uchar *dst, int size); 5074a6ee172SJerry Huang void mmc_set_clock(struct mmc *mmc, uint clock); 508272cc70bSAndy Fleming struct mmc *find_mmc_device(int dev_num); 50989716964SSteve Sakoman int mmc_set_dev(int dev_num); 510272cc70bSAndy Fleming void print_mmc_devices(char separator); 51146683f3dSKever Yang 51246683f3dSKever Yang /** 51346683f3dSKever Yang * get_mmc_num() - get the total MMC device number 51446683f3dSKever Yang * 51546683f3dSKever Yang * @return 0 if there is no MMC device, else the number of devices 51646683f3dSKever Yang */ 517ea6ebe21SLei Wen int get_mmc_num(void); 518b5b838f1SMarek Vasut int mmc_switch_part(struct mmc *mmc, unsigned int part_num); 519ac9da0e0SDiego Santa Cruz int mmc_hwpart_config(struct mmc *mmc, const struct mmc_hwpart_conf *conf, 520ac9da0e0SDiego Santa Cruz enum mmc_hwpart_conf_mode mode); 5218ca51e51SSimon Glass 522*c4d660d4SSimon Glass #if !CONFIG_IS_ENABLED(DM_MMC_OPS) 52348972d90SThierry Reding int mmc_getcd(struct mmc *mmc); 524750121c3SJeroen Hofstee int board_mmc_getcd(struct mmc *mmc); 525d23d8d7eSNikita Kiryanov int mmc_getwp(struct mmc *mmc); 526750121c3SJeroen Hofstee int board_mmc_getwp(struct mmc *mmc); 5278ca51e51SSimon Glass #endif 5288ca51e51SSimon Glass 529ab71188cSMarkus Niebel int mmc_set_dsr(struct mmc *mmc, u16 val); 5303690d6d6SAmar /* Function to change the size of boot partition and rpmb partitions */ 5313690d6d6SAmar int mmc_boot_partition_size_change(struct mmc *mmc, unsigned long bootsize, 5323690d6d6SAmar unsigned long rpmbsize); 533792970b0STom Rini /* Function to modify the PARTITION_CONFIG field of EXT_CSD */ 534792970b0STom Rini int mmc_set_part_conf(struct mmc *mmc, u8 ack, u8 part_num, u8 access); 5355a99b9deSTom Rini /* Function to modify the BOOT_BUS_WIDTH field of EXT_CSD */ 5365a99b9deSTom Rini int mmc_set_boot_bus_width(struct mmc *mmc, u8 width, u8 reset, u8 mode); 53733ace362STom Rini /* Function to modify the RST_n_FUNCTION field of EXT_CSD */ 53833ace362STom Rini int mmc_set_rst_n_function(struct mmc *mmc, u8 enable); 53991fdabc6SPierre Aubert /* Functions to read / write the RPMB partition */ 54091fdabc6SPierre Aubert int mmc_rpmb_set_key(struct mmc *mmc, void *key); 54191fdabc6SPierre Aubert int mmc_rpmb_get_counter(struct mmc *mmc, unsigned long *counter); 54291fdabc6SPierre Aubert int mmc_rpmb_read(struct mmc *mmc, void *addr, unsigned short blk, 54391fdabc6SPierre Aubert unsigned short cnt, unsigned char *key); 54491fdabc6SPierre Aubert int mmc_rpmb_write(struct mmc *mmc, void *addr, unsigned short blk, 54591fdabc6SPierre Aubert unsigned short cnt, unsigned char *key); 546cd3d4880STomas Melin #ifdef CONFIG_CMD_BKOPS_ENABLE 547cd3d4880STomas Melin int mmc_set_bkops_enable(struct mmc *mmc); 548cd3d4880STomas Melin #endif 549cd3d4880STomas Melin 550e9550449SChe-Liang Chiou /** 551e9550449SChe-Liang Chiou * Start device initialization and return immediately; it does not block on 552e9550449SChe-Liang Chiou * polling OCR (operation condition register) status. Then you should call 553e9550449SChe-Liang Chiou * mmc_init, which would block on polling OCR status and complete the device 554e9550449SChe-Liang Chiou * initializatin. 555e9550449SChe-Liang Chiou * 556e9550449SChe-Liang Chiou * @param mmc Pointer to a MMC device struct 557e9550449SChe-Liang Chiou * @return 0 on success, IN_PROGRESS on waiting for OCR status, <0 on error. 558e9550449SChe-Liang Chiou */ 559e9550449SChe-Liang Chiou int mmc_start_init(struct mmc *mmc); 560e9550449SChe-Liang Chiou 561e9550449SChe-Liang Chiou /** 562e9550449SChe-Liang Chiou * Set preinit flag of mmc device. 563e9550449SChe-Liang Chiou * 564e9550449SChe-Liang Chiou * This will cause the device to be pre-inited during mmc_initialize(), 565e9550449SChe-Liang Chiou * which may save boot time if the device is not accessed until later. 566e9550449SChe-Liang Chiou * Some eMMC devices take 200-300ms to init, but unfortunately they 567e9550449SChe-Liang Chiou * must be sent a series of commands to even get them to start preparing 568e9550449SChe-Liang Chiou * for operation. 569e9550449SChe-Liang Chiou * 570e9550449SChe-Liang Chiou * @param mmc Pointer to a MMC device struct 571e9550449SChe-Liang Chiou * @param preinit preinit flag value 572e9550449SChe-Liang Chiou */ 573e9550449SChe-Liang Chiou void mmc_set_preinit(struct mmc *mmc, int preinit); 574e9550449SChe-Liang Chiou 5758687d5c8SPaul Burton #ifdef CONFIG_MMC_SPI 5760b2da7e2STom Rini #define mmc_host_is_spi(mmc) ((mmc)->cfg->host_caps & MMC_MODE_SPI) 5778687d5c8SPaul Burton #else 5788687d5c8SPaul Burton #define mmc_host_is_spi(mmc) 0 5798687d5c8SPaul Burton #endif 580d52ebf10SThomas Chou struct mmc *mmc_spi_init(uint bus, uint cs, uint speed, uint mode); 5811592ef85SReinhard Meyer 58295de9ab2SPaul Kocialkowski void board_mmc_power_init(void); 5833c7ca967SFabio Estevam int board_mmc_init(bd_t *bis); 584750121c3SJeroen Hofstee int cpu_mmc_init(bd_t *bis); 585aeb80555SJeroen Hofstee int mmc_get_env_addr(struct mmc *mmc, int copy, u32 *env_addr); 586aa844fe1SClemens Gruber int mmc_get_env_dev(void); 5873c7ca967SFabio Estevam 588da2364ccSBin Meng struct pci_device_id; 589da2364ccSBin Meng 590da2364ccSBin Meng /** 591da2364ccSBin Meng * pci_mmc_init() - set up PCI MMC devices 592da2364ccSBin Meng * 593da2364ccSBin Meng * This finds all the matching PCI IDs and sets them up as MMC devices. 594da2364ccSBin Meng * 595da2364ccSBin Meng * @name: Name to use for devices 596da2364ccSBin Meng * @mmc_supported: PCI IDs to search for, terminated by {0, 0} 597da2364ccSBin Meng */ 598da2364ccSBin Meng int pci_mmc_init(const char *name, struct pci_device_id *mmc_supported); 599da2364ccSBin Meng 60093bfd616SPantelis Antoniou /* Set block count limit because of 16 bit register limit on some hardware*/ 60193bfd616SPantelis Antoniou #ifndef CONFIG_SYS_MMC_MAX_BLK_COUNT 60293bfd616SPantelis Antoniou #define CONFIG_SYS_MMC_MAX_BLK_COUNT 65535 60393bfd616SPantelis Antoniou #endif 60493bfd616SPantelis Antoniou 605cb5ec33dSSimon Glass /** 606cb5ec33dSSimon Glass * mmc_get_blk_desc() - Get the block descriptor for an MMC device 607cb5ec33dSSimon Glass * 608cb5ec33dSSimon Glass * @mmc: MMC device 609cb5ec33dSSimon Glass * @return block device if found, else NULL 610cb5ec33dSSimon Glass */ 611cb5ec33dSSimon Glass struct blk_desc *mmc_get_blk_desc(struct mmc *mmc); 612cb5ec33dSSimon Glass 61371f95118Swdenk #endif /* _MMC_H_ */ 614