1 /* SPDX-License-Identifier: GPL-2.0-only */ 2 /* 3 * linux/include/linux/mmc/card.h 4 * 5 * Card driver specific definitions. 6 */ 7 #ifndef LINUX_MMC_CARD_H 8 #define LINUX_MMC_CARD_H 9 10 #include <linux/device.h> 11 #include <linux/mod_devicetable.h> 12 13 struct mmc_cid { 14 unsigned int manfid; 15 char prod_name[8]; 16 unsigned char prv; 17 unsigned int serial; 18 unsigned short oemid; 19 unsigned short year; 20 unsigned char hwrev; 21 unsigned char fwrev; 22 unsigned char month; 23 }; 24 25 struct mmc_csd { 26 unsigned char structure; 27 unsigned char mmca_vsn; 28 unsigned short cmdclass; 29 unsigned short taac_clks; 30 unsigned int taac_ns; 31 unsigned int c_size; 32 unsigned int r2w_factor; 33 unsigned int max_dtr; 34 unsigned int erase_size; /* In sectors */ 35 unsigned int read_blkbits; 36 unsigned int write_blkbits; 37 unsigned int capacity; 38 unsigned int read_partial:1, 39 read_misalign:1, 40 write_partial:1, 41 write_misalign:1, 42 dsr_imp:1; 43 }; 44 45 struct mmc_ext_csd { 46 u8 rev; 47 u8 erase_group_def; 48 u8 sec_feature_support; 49 u8 rel_sectors; 50 u8 rel_param; 51 bool enhanced_rpmb_supported; 52 u8 part_config; 53 u8 cache_ctrl; 54 u8 rst_n_function; 55 u8 max_packed_writes; 56 u8 max_packed_reads; 57 u8 packed_event_en; 58 unsigned int part_time; /* Units: ms */ 59 unsigned int sa_timeout; /* Units: 100ns */ 60 unsigned int generic_cmd6_time; /* Units: 10ms */ 61 unsigned int power_off_longtime; /* Units: ms */ 62 u8 power_off_notification; /* state */ 63 unsigned int hs_max_dtr; 64 unsigned int hs200_max_dtr; 65 #define MMC_HIGH_26_MAX_DTR 26000000 66 #define MMC_HIGH_52_MAX_DTR 52000000 67 #define MMC_HIGH_DDR_MAX_DTR 52000000 68 #define MMC_HS200_MAX_DTR 200000000 69 unsigned int sectors; 70 unsigned int hc_erase_size; /* In sectors */ 71 unsigned int hc_erase_timeout; /* In milliseconds */ 72 unsigned int sec_trim_mult; /* Secure trim multiplier */ 73 unsigned int sec_erase_mult; /* Secure erase multiplier */ 74 unsigned int trim_timeout; /* In milliseconds */ 75 bool partition_setting_completed; /* enable bit */ 76 unsigned long long enhanced_area_offset; /* Units: Byte */ 77 unsigned int enhanced_area_size; /* Units: KB */ 78 unsigned int cache_size; /* Units: KB */ 79 bool hpi_en; /* HPI enablebit */ 80 bool hpi; /* HPI support bit */ 81 unsigned int hpi_cmd; /* cmd used as HPI */ 82 bool bkops; /* background support bit */ 83 bool man_bkops_en; /* manual bkops enable bit */ 84 bool auto_bkops_en; /* auto bkops enable bit */ 85 unsigned int data_sector_size; /* 512 bytes or 4KB */ 86 unsigned int data_tag_unit_size; /* DATA TAG UNIT size */ 87 unsigned int boot_ro_lock; /* ro lock support */ 88 bool boot_ro_lockable; 89 bool ffu_capable; /* Firmware upgrade support */ 90 bool cmdq_en; /* Command Queue enabled */ 91 bool cmdq_support; /* Command Queue supported */ 92 unsigned int cmdq_depth; /* Command Queue depth */ 93 #define MMC_FIRMWARE_LEN 8 94 u8 fwrev[MMC_FIRMWARE_LEN]; /* FW version */ 95 u8 raw_exception_status; /* 54 */ 96 u8 raw_partition_support; /* 160 */ 97 u8 raw_rpmb_size_mult; /* 168 */ 98 u8 raw_erased_mem_count; /* 181 */ 99 u8 strobe_support; /* 184 */ 100 u8 raw_ext_csd_structure; /* 194 */ 101 u8 raw_card_type; /* 196 */ 102 u8 raw_driver_strength; /* 197 */ 103 u8 out_of_int_time; /* 198 */ 104 u8 raw_pwr_cl_52_195; /* 200 */ 105 u8 raw_pwr_cl_26_195; /* 201 */ 106 u8 raw_pwr_cl_52_360; /* 202 */ 107 u8 raw_pwr_cl_26_360; /* 203 */ 108 u8 raw_s_a_timeout; /* 217 */ 109 u8 raw_hc_erase_gap_size; /* 221 */ 110 u8 raw_erase_timeout_mult; /* 223 */ 111 u8 raw_hc_erase_grp_size; /* 224 */ 112 u8 raw_sec_trim_mult; /* 229 */ 113 u8 raw_sec_erase_mult; /* 230 */ 114 u8 raw_sec_feature_support;/* 231 */ 115 u8 raw_trim_mult; /* 232 */ 116 u8 raw_pwr_cl_200_195; /* 236 */ 117 u8 raw_pwr_cl_200_360; /* 237 */ 118 u8 raw_pwr_cl_ddr_52_195; /* 238 */ 119 u8 raw_pwr_cl_ddr_52_360; /* 239 */ 120 u8 raw_pwr_cl_ddr_200_360; /* 253 */ 121 u8 raw_bkops_status; /* 246 */ 122 u8 raw_sectors[4]; /* 212 - 4 bytes */ 123 u8 pre_eol_info; /* 267 */ 124 u8 device_life_time_est_typ_a; /* 268 */ 125 u8 device_life_time_est_typ_b; /* 269 */ 126 127 unsigned int feature_support; 128 #define MMC_DISCARD_FEATURE BIT(0) /* CMD38 feature */ 129 }; 130 131 struct sd_scr { 132 unsigned char sda_vsn; 133 unsigned char sda_spec3; 134 unsigned char sda_spec4; 135 unsigned char sda_specx; 136 unsigned char bus_widths; 137 #define SD_SCR_BUS_WIDTH_1 (1<<0) 138 #define SD_SCR_BUS_WIDTH_4 (1<<2) 139 unsigned char cmds; 140 #define SD_SCR_CMD20_SUPPORT (1<<0) 141 #define SD_SCR_CMD23_SUPPORT (1<<1) 142 #define SD_SCR_CMD48_SUPPORT (1<<2) 143 #define SD_SCR_CMD58_SUPPORT (1<<3) 144 }; 145 146 struct sd_ssr { 147 unsigned int au; /* In sectors */ 148 unsigned int erase_timeout; /* In milliseconds */ 149 unsigned int erase_offset; /* In milliseconds */ 150 }; 151 152 struct sd_switch_caps { 153 unsigned int hs_max_dtr; 154 unsigned int uhs_max_dtr; 155 #define HIGH_SPEED_MAX_DTR 50000000 156 #define UHS_SDR104_MAX_DTR 208000000 157 #define UHS_SDR50_MAX_DTR 100000000 158 #define UHS_DDR50_MAX_DTR 50000000 159 #define UHS_SDR25_MAX_DTR UHS_DDR50_MAX_DTR 160 #define UHS_SDR12_MAX_DTR 25000000 161 #define DEFAULT_SPEED_MAX_DTR UHS_SDR12_MAX_DTR 162 unsigned int sd3_bus_mode; 163 #define UHS_SDR12_BUS_SPEED 0 164 #define HIGH_SPEED_BUS_SPEED 1 165 #define UHS_SDR25_BUS_SPEED 1 166 #define UHS_SDR50_BUS_SPEED 2 167 #define UHS_SDR104_BUS_SPEED 3 168 #define UHS_DDR50_BUS_SPEED 4 169 170 #define SD_MODE_HIGH_SPEED (1 << HIGH_SPEED_BUS_SPEED) 171 #define SD_MODE_UHS_SDR12 (1 << UHS_SDR12_BUS_SPEED) 172 #define SD_MODE_UHS_SDR25 (1 << UHS_SDR25_BUS_SPEED) 173 #define SD_MODE_UHS_SDR50 (1 << UHS_SDR50_BUS_SPEED) 174 #define SD_MODE_UHS_SDR104 (1 << UHS_SDR104_BUS_SPEED) 175 #define SD_MODE_UHS_DDR50 (1 << UHS_DDR50_BUS_SPEED) 176 unsigned int sd3_drv_type; 177 #define SD_DRIVER_TYPE_B 0x01 178 #define SD_DRIVER_TYPE_A 0x02 179 #define SD_DRIVER_TYPE_C 0x04 180 #define SD_DRIVER_TYPE_D 0x08 181 unsigned int sd3_curr_limit; 182 #define SD_SET_CURRENT_LIMIT_200 0 183 #define SD_SET_CURRENT_LIMIT_400 1 184 #define SD_SET_CURRENT_LIMIT_600 2 185 #define SD_SET_CURRENT_LIMIT_800 3 186 #define SD_SET_CURRENT_NO_CHANGE (-1) 187 188 #define SD_MAX_CURRENT_200 (1 << SD_SET_CURRENT_LIMIT_200) 189 #define SD_MAX_CURRENT_400 (1 << SD_SET_CURRENT_LIMIT_400) 190 #define SD_MAX_CURRENT_600 (1 << SD_SET_CURRENT_LIMIT_600) 191 #define SD_MAX_CURRENT_800 (1 << SD_SET_CURRENT_LIMIT_800) 192 }; 193 194 struct sd_ext_reg { 195 u8 fno; 196 u8 page; 197 u16 offset; 198 u8 rev; 199 u8 feature_enabled; 200 u8 feature_support; 201 /* Power Management Function. */ 202 #define SD_EXT_POWER_OFF_NOTIFY (1<<0) 203 #define SD_EXT_POWER_SUSTENANCE (1<<1) 204 #define SD_EXT_POWER_DOWN_MODE (1<<2) 205 /* Performance Enhancement Function. */ 206 #define SD_EXT_PERF_FX_EVENT (1<<0) 207 #define SD_EXT_PERF_CARD_MAINT (1<<1) 208 #define SD_EXT_PERF_HOST_MAINT (1<<2) 209 #define SD_EXT_PERF_CACHE (1<<3) 210 #define SD_EXT_PERF_CMD_QUEUE (1<<4) 211 }; 212 213 struct sdio_cccr { 214 unsigned int sdio_vsn; 215 unsigned int sd_vsn; 216 unsigned int multi_block:1, 217 low_speed:1, 218 wide_bus:1, 219 high_power:1, 220 high_speed:1, 221 disable_cd:1; 222 }; 223 224 struct sdio_cis { 225 unsigned short vendor; 226 unsigned short device; 227 unsigned short blksize; 228 unsigned int max_dtr; 229 }; 230 231 struct mmc_host; 232 struct sdio_func; 233 struct sdio_func_tuple; 234 struct mmc_queue_req; 235 236 #define SDIO_MAX_FUNCS 7 237 238 /* The number of MMC physical partitions. These consist of: 239 * boot partitions (2), general purpose partitions (4) and 240 * RPMB partition (1) in MMC v4.4. 241 */ 242 #define MMC_NUM_BOOT_PARTITION 2 243 #define MMC_NUM_GP_PARTITION 4 244 #define MMC_NUM_PHY_PARTITION 7 245 #define MAX_MMC_PART_NAME_LEN 20 246 247 /* 248 * MMC Physical partitions 249 */ 250 struct mmc_part { 251 u64 size; /* partition size (in bytes) */ 252 unsigned int part_cfg; /* partition type */ 253 char name[MAX_MMC_PART_NAME_LEN]; 254 bool force_ro; /* to make boot parts RO by default */ 255 unsigned int area_type; 256 #define MMC_BLK_DATA_AREA_MAIN (1<<0) 257 #define MMC_BLK_DATA_AREA_BOOT (1<<1) 258 #define MMC_BLK_DATA_AREA_GP (1<<2) 259 #define MMC_BLK_DATA_AREA_RPMB (1<<3) 260 }; 261 262 /* 263 * MMC device 264 */ 265 struct mmc_card { 266 struct mmc_host *host; /* the host this device belongs to */ 267 struct device dev; /* the device */ 268 u32 ocr; /* the current OCR setting */ 269 unsigned int rca; /* relative card address of device */ 270 unsigned int type; /* card type */ 271 #define MMC_TYPE_MMC 0 /* MMC card */ 272 #define MMC_TYPE_SD 1 /* SD card */ 273 #define MMC_TYPE_SDIO 2 /* SDIO card */ 274 #define MMC_TYPE_SD_COMBO 3 /* SD combo (IO+mem) card */ 275 unsigned int state; /* (our) card state */ 276 unsigned int quirks; /* card quirks */ 277 unsigned int quirk_max_rate; /* max rate set by quirks */ 278 #define MMC_QUIRK_LENIENT_FN0 (1<<0) /* allow SDIO FN0 writes outside of the VS CCCR range */ 279 #define MMC_QUIRK_BLKSZ_FOR_BYTE_MODE (1<<1) /* use func->cur_blksize */ 280 /* for byte mode */ 281 #define MMC_QUIRK_NONSTD_SDIO (1<<2) /* non-standard SDIO card attached */ 282 /* (missing CIA registers) */ 283 #define MMC_QUIRK_NONSTD_FUNC_IF (1<<4) /* SDIO card has nonstd function interfaces */ 284 #define MMC_QUIRK_DISABLE_CD (1<<5) /* disconnect CD/DAT[3] resistor */ 285 #define MMC_QUIRK_INAND_CMD38 (1<<6) /* iNAND devices have broken CMD38 */ 286 #define MMC_QUIRK_BLK_NO_CMD23 (1<<7) /* Avoid CMD23 for regular multiblock */ 287 #define MMC_QUIRK_BROKEN_BYTE_MODE_512 (1<<8) /* Avoid sending 512 bytes in */ 288 /* byte mode */ 289 #define MMC_QUIRK_LONG_READ_TIME (1<<9) /* Data read time > CSD says */ 290 #define MMC_QUIRK_SEC_ERASE_TRIM_BROKEN (1<<10) /* Skip secure for erase/trim */ 291 #define MMC_QUIRK_BROKEN_IRQ_POLLING (1<<11) /* Polling SDIO_CCCR_INTx could create a fake interrupt */ 292 #define MMC_QUIRK_TRIM_BROKEN (1<<12) /* Skip trim */ 293 #define MMC_QUIRK_BROKEN_HPI (1<<13) /* Disable broken HPI support */ 294 295 bool reenable_cmdq; /* Re-enable Command Queue */ 296 297 unsigned int erase_size; /* erase size in sectors */ 298 unsigned int erase_shift; /* if erase unit is power 2 */ 299 unsigned int pref_erase; /* in sectors */ 300 unsigned int eg_boundary; /* don't cross erase-group boundaries */ 301 unsigned int erase_arg; /* erase / trim / discard */ 302 u8 erased_byte; /* value of erased bytes */ 303 304 u32 raw_cid[4]; /* raw card CID */ 305 u32 raw_csd[4]; /* raw card CSD */ 306 u32 raw_scr[2]; /* raw card SCR */ 307 u32 raw_ssr[16]; /* raw card SSR */ 308 struct mmc_cid cid; /* card identification */ 309 struct mmc_csd csd; /* card specific */ 310 struct mmc_ext_csd ext_csd; /* mmc v4 extended card specific */ 311 struct sd_scr scr; /* extra SD information */ 312 struct sd_ssr ssr; /* yet more SD information */ 313 struct sd_switch_caps sw_caps; /* switch (CMD6) caps */ 314 struct sd_ext_reg ext_power; /* SD extension reg for PM */ 315 struct sd_ext_reg ext_perf; /* SD extension reg for PERF */ 316 317 unsigned int sdio_funcs; /* number of SDIO functions */ 318 atomic_t sdio_funcs_probed; /* number of probed SDIO funcs */ 319 struct sdio_cccr cccr; /* common card info */ 320 struct sdio_cis cis; /* common tuple info */ 321 struct sdio_func *sdio_func[SDIO_MAX_FUNCS]; /* SDIO functions (devices) */ 322 struct sdio_func *sdio_single_irq; /* SDIO function when only one IRQ active */ 323 u8 major_rev; /* major revision number */ 324 u8 minor_rev; /* minor revision number */ 325 unsigned num_info; /* number of info strings */ 326 const char **info; /* info strings */ 327 struct sdio_func_tuple *tuples; /* unknown common tuples */ 328 329 unsigned int sd_bus_speed; /* Bus Speed Mode set for the card */ 330 unsigned int mmc_avail_type; /* supported device type by both host and card */ 331 unsigned int drive_strength; /* for UHS-I, HS200 or HS400 */ 332 333 struct dentry *debugfs_root; 334 struct mmc_part part[MMC_NUM_PHY_PARTITION]; /* physical partitions */ 335 unsigned int nr_parts; 336 337 struct workqueue_struct *complete_wq; /* Private workqueue */ 338 }; 339 340 static inline bool mmc_large_sector(struct mmc_card *card) 341 { 342 return card->ext_csd.data_sector_size == 4096; 343 } 344 345 bool mmc_card_is_blockaddr(struct mmc_card *card); 346 347 #define mmc_card_mmc(c) ((c)->type == MMC_TYPE_MMC) 348 #define mmc_card_sd(c) ((c)->type == MMC_TYPE_SD) 349 #define mmc_card_sdio(c) ((c)->type == MMC_TYPE_SDIO) 350 351 #endif /* LINUX_MMC_CARD_H */ 352