1 /* 2 * linux/include/linux/mmc/card.h 3 * 4 * This program is free software; you can redistribute it and/or modify 5 * it under the terms of the GNU General Public License version 2 as 6 * published by the Free Software Foundation. 7 * 8 * Card driver specific definitions. 9 */ 10 #ifndef LINUX_MMC_CARD_H 11 #define LINUX_MMC_CARD_H 12 13 #include <linux/device.h> 14 #include <linux/mmc/core.h> 15 #include <linux/mod_devicetable.h> 16 17 struct mmc_cid { 18 unsigned int manfid; 19 char prod_name[8]; 20 unsigned char prv; 21 unsigned int serial; 22 unsigned short oemid; 23 unsigned short year; 24 unsigned char hwrev; 25 unsigned char fwrev; 26 unsigned char month; 27 }; 28 29 struct mmc_csd { 30 unsigned char structure; 31 unsigned char mmca_vsn; 32 unsigned short cmdclass; 33 unsigned short tacc_clks; 34 unsigned int tacc_ns; 35 unsigned int c_size; 36 unsigned int r2w_factor; 37 unsigned int max_dtr; 38 unsigned int erase_size; /* In sectors */ 39 unsigned int read_blkbits; 40 unsigned int write_blkbits; 41 unsigned int capacity; 42 unsigned int read_partial:1, 43 read_misalign:1, 44 write_partial:1, 45 write_misalign:1, 46 dsr_imp:1; 47 }; 48 49 struct mmc_ext_csd { 50 u8 rev; 51 u8 erase_group_def; 52 u8 sec_feature_support; 53 u8 rel_sectors; 54 u8 rel_param; 55 u8 part_config; 56 u8 cache_ctrl; 57 u8 rst_n_function; 58 u8 max_packed_writes; 59 u8 max_packed_reads; 60 u8 packed_event_en; 61 unsigned int part_time; /* Units: ms */ 62 unsigned int sa_timeout; /* Units: 100ns */ 63 unsigned int generic_cmd6_time; /* Units: 10ms */ 64 unsigned int power_off_longtime; /* Units: ms */ 65 u8 power_off_notification; /* state */ 66 unsigned int hs_max_dtr; 67 unsigned int hs200_max_dtr; 68 #define MMC_HIGH_26_MAX_DTR 26000000 69 #define MMC_HIGH_52_MAX_DTR 52000000 70 #define MMC_HIGH_DDR_MAX_DTR 52000000 71 #define MMC_HS200_MAX_DTR 200000000 72 unsigned int sectors; 73 unsigned int hc_erase_size; /* In sectors */ 74 unsigned int hc_erase_timeout; /* In milliseconds */ 75 unsigned int sec_trim_mult; /* Secure trim multiplier */ 76 unsigned int sec_erase_mult; /* Secure erase multiplier */ 77 unsigned int trim_timeout; /* In milliseconds */ 78 bool partition_setting_completed; /* enable bit */ 79 unsigned long long enhanced_area_offset; /* Units: Byte */ 80 unsigned int enhanced_area_size; /* Units: KB */ 81 unsigned int cache_size; /* Units: KB */ 82 bool hpi_en; /* HPI enablebit */ 83 bool hpi; /* HPI support bit */ 84 unsigned int hpi_cmd; /* cmd used as HPI */ 85 bool bkops; /* background support bit */ 86 bool man_bkops_en; /* manual bkops enable bit */ 87 unsigned int data_sector_size; /* 512 bytes or 4KB */ 88 unsigned int data_tag_unit_size; /* DATA TAG UNIT size */ 89 unsigned int boot_ro_lock; /* ro lock support */ 90 bool boot_ro_lockable; 91 bool ffu_capable; /* Firmware upgrade support */ 92 #define MMC_FIRMWARE_LEN 8 93 u8 fwrev[MMC_FIRMWARE_LEN]; /* FW version */ 94 u8 raw_exception_status; /* 54 */ 95 u8 raw_partition_support; /* 160 */ 96 u8 raw_rpmb_size_mult; /* 168 */ 97 u8 raw_erased_mem_count; /* 181 */ 98 u8 raw_ext_csd_structure; /* 194 */ 99 u8 raw_card_type; /* 196 */ 100 u8 raw_driver_strength; /* 197 */ 101 u8 out_of_int_time; /* 198 */ 102 u8 raw_pwr_cl_52_195; /* 200 */ 103 u8 raw_pwr_cl_26_195; /* 201 */ 104 u8 raw_pwr_cl_52_360; /* 202 */ 105 u8 raw_pwr_cl_26_360; /* 203 */ 106 u8 raw_s_a_timeout; /* 217 */ 107 u8 raw_hc_erase_gap_size; /* 221 */ 108 u8 raw_erase_timeout_mult; /* 223 */ 109 u8 raw_hc_erase_grp_size; /* 224 */ 110 u8 raw_sec_trim_mult; /* 229 */ 111 u8 raw_sec_erase_mult; /* 230 */ 112 u8 raw_sec_feature_support;/* 231 */ 113 u8 raw_trim_mult; /* 232 */ 114 u8 raw_pwr_cl_200_195; /* 236 */ 115 u8 raw_pwr_cl_200_360; /* 237 */ 116 u8 raw_pwr_cl_ddr_52_195; /* 238 */ 117 u8 raw_pwr_cl_ddr_52_360; /* 239 */ 118 u8 raw_pwr_cl_ddr_200_360; /* 253 */ 119 u8 raw_bkops_status; /* 246 */ 120 u8 raw_sectors[4]; /* 212 - 4 bytes */ 121 122 unsigned int feature_support; 123 #define MMC_DISCARD_FEATURE BIT(0) /* CMD38 feature */ 124 }; 125 126 struct sd_scr { 127 unsigned char sda_vsn; 128 unsigned char sda_spec3; 129 unsigned char bus_widths; 130 #define SD_SCR_BUS_WIDTH_1 (1<<0) 131 #define SD_SCR_BUS_WIDTH_4 (1<<2) 132 unsigned char cmds; 133 #define SD_SCR_CMD20_SUPPORT (1<<0) 134 #define SD_SCR_CMD23_SUPPORT (1<<1) 135 }; 136 137 struct sd_ssr { 138 unsigned int au; /* In sectors */ 139 unsigned int erase_timeout; /* In milliseconds */ 140 unsigned int erase_offset; /* In milliseconds */ 141 }; 142 143 struct sd_switch_caps { 144 unsigned int hs_max_dtr; 145 unsigned int uhs_max_dtr; 146 #define HIGH_SPEED_MAX_DTR 50000000 147 #define UHS_SDR104_MAX_DTR 208000000 148 #define UHS_SDR50_MAX_DTR 100000000 149 #define UHS_DDR50_MAX_DTR 50000000 150 #define UHS_SDR25_MAX_DTR UHS_DDR50_MAX_DTR 151 #define UHS_SDR12_MAX_DTR 25000000 152 unsigned int sd3_bus_mode; 153 #define UHS_SDR12_BUS_SPEED 0 154 #define HIGH_SPEED_BUS_SPEED 1 155 #define UHS_SDR25_BUS_SPEED 1 156 #define UHS_SDR50_BUS_SPEED 2 157 #define UHS_SDR104_BUS_SPEED 3 158 #define UHS_DDR50_BUS_SPEED 4 159 160 #define SD_MODE_HIGH_SPEED (1 << HIGH_SPEED_BUS_SPEED) 161 #define SD_MODE_UHS_SDR12 (1 << UHS_SDR12_BUS_SPEED) 162 #define SD_MODE_UHS_SDR25 (1 << UHS_SDR25_BUS_SPEED) 163 #define SD_MODE_UHS_SDR50 (1 << UHS_SDR50_BUS_SPEED) 164 #define SD_MODE_UHS_SDR104 (1 << UHS_SDR104_BUS_SPEED) 165 #define SD_MODE_UHS_DDR50 (1 << UHS_DDR50_BUS_SPEED) 166 unsigned int sd3_drv_type; 167 #define SD_DRIVER_TYPE_B 0x01 168 #define SD_DRIVER_TYPE_A 0x02 169 #define SD_DRIVER_TYPE_C 0x04 170 #define SD_DRIVER_TYPE_D 0x08 171 unsigned int sd3_curr_limit; 172 #define SD_SET_CURRENT_LIMIT_200 0 173 #define SD_SET_CURRENT_LIMIT_400 1 174 #define SD_SET_CURRENT_LIMIT_600 2 175 #define SD_SET_CURRENT_LIMIT_800 3 176 #define SD_SET_CURRENT_NO_CHANGE (-1) 177 178 #define SD_MAX_CURRENT_200 (1 << SD_SET_CURRENT_LIMIT_200) 179 #define SD_MAX_CURRENT_400 (1 << SD_SET_CURRENT_LIMIT_400) 180 #define SD_MAX_CURRENT_600 (1 << SD_SET_CURRENT_LIMIT_600) 181 #define SD_MAX_CURRENT_800 (1 << SD_SET_CURRENT_LIMIT_800) 182 }; 183 184 struct sdio_cccr { 185 unsigned int sdio_vsn; 186 unsigned int sd_vsn; 187 unsigned int multi_block:1, 188 low_speed:1, 189 wide_bus:1, 190 high_power:1, 191 high_speed:1, 192 disable_cd:1; 193 }; 194 195 struct sdio_cis { 196 unsigned short vendor; 197 unsigned short device; 198 unsigned short blksize; 199 unsigned int max_dtr; 200 }; 201 202 struct mmc_host; 203 struct mmc_ios; 204 struct sdio_func; 205 struct sdio_func_tuple; 206 207 #define SDIO_MAX_FUNCS 7 208 209 enum mmc_blk_status { 210 MMC_BLK_SUCCESS = 0, 211 MMC_BLK_PARTIAL, 212 MMC_BLK_CMD_ERR, 213 MMC_BLK_RETRY, 214 MMC_BLK_ABORT, 215 MMC_BLK_DATA_ERR, 216 MMC_BLK_ECC_ERR, 217 MMC_BLK_NOMEDIUM, 218 MMC_BLK_NEW_REQUEST, 219 }; 220 221 /* The number of MMC physical partitions. These consist of: 222 * boot partitions (2), general purpose partitions (4) and 223 * RPMB partition (1) in MMC v4.4. 224 */ 225 #define MMC_NUM_BOOT_PARTITION 2 226 #define MMC_NUM_GP_PARTITION 4 227 #define MMC_NUM_PHY_PARTITION 7 228 #define MAX_MMC_PART_NAME_LEN 20 229 230 /* 231 * MMC Physical partitions 232 */ 233 struct mmc_part { 234 unsigned int size; /* partition size (in bytes) */ 235 unsigned int part_cfg; /* partition type */ 236 char name[MAX_MMC_PART_NAME_LEN]; 237 bool force_ro; /* to make boot parts RO by default */ 238 unsigned int area_type; 239 #define MMC_BLK_DATA_AREA_MAIN (1<<0) 240 #define MMC_BLK_DATA_AREA_BOOT (1<<1) 241 #define MMC_BLK_DATA_AREA_GP (1<<2) 242 #define MMC_BLK_DATA_AREA_RPMB (1<<3) 243 }; 244 245 /* 246 * MMC device 247 */ 248 struct mmc_card { 249 struct mmc_host *host; /* the host this device belongs to */ 250 struct device dev; /* the device */ 251 u32 ocr; /* the current OCR setting */ 252 unsigned int rca; /* relative card address of device */ 253 unsigned int type; /* card type */ 254 #define MMC_TYPE_MMC 0 /* MMC card */ 255 #define MMC_TYPE_SD 1 /* SD card */ 256 #define MMC_TYPE_SDIO 2 /* SDIO card */ 257 #define MMC_TYPE_SD_COMBO 3 /* SD combo (IO+mem) card */ 258 unsigned int state; /* (our) card state */ 259 #define MMC_STATE_PRESENT (1<<0) /* present in sysfs */ 260 #define MMC_STATE_READONLY (1<<1) /* card is read-only */ 261 #define MMC_STATE_BLOCKADDR (1<<2) /* card uses block-addressing */ 262 #define MMC_CARD_SDXC (1<<3) /* card is SDXC */ 263 #define MMC_CARD_REMOVED (1<<4) /* card has been removed */ 264 #define MMC_STATE_DOING_BKOPS (1<<5) /* card is doing BKOPS */ 265 #define MMC_STATE_SUSPENDED (1<<6) /* card is suspended */ 266 unsigned int quirks; /* card quirks */ 267 #define MMC_QUIRK_LENIENT_FN0 (1<<0) /* allow SDIO FN0 writes outside of the VS CCCR range */ 268 #define MMC_QUIRK_BLKSZ_FOR_BYTE_MODE (1<<1) /* use func->cur_blksize */ 269 /* for byte mode */ 270 #define MMC_QUIRK_NONSTD_SDIO (1<<2) /* non-standard SDIO card attached */ 271 /* (missing CIA registers) */ 272 #define MMC_QUIRK_BROKEN_CLK_GATING (1<<3) /* clock gating the sdio bus will make card fail */ 273 #define MMC_QUIRK_NONSTD_FUNC_IF (1<<4) /* SDIO card has nonstd function interfaces */ 274 #define MMC_QUIRK_DISABLE_CD (1<<5) /* disconnect CD/DAT[3] resistor */ 275 #define MMC_QUIRK_INAND_CMD38 (1<<6) /* iNAND devices have broken CMD38 */ 276 #define MMC_QUIRK_BLK_NO_CMD23 (1<<7) /* Avoid CMD23 for regular multiblock */ 277 #define MMC_QUIRK_BROKEN_BYTE_MODE_512 (1<<8) /* Avoid sending 512 bytes in */ 278 /* byte mode */ 279 #define MMC_QUIRK_LONG_READ_TIME (1<<9) /* Data read time > CSD says */ 280 #define MMC_QUIRK_SEC_ERASE_TRIM_BROKEN (1<<10) /* Skip secure for erase/trim */ 281 #define MMC_QUIRK_BROKEN_IRQ_POLLING (1<<11) /* Polling SDIO_CCCR_INTx could create a fake interrupt */ 282 283 unsigned int erase_size; /* erase size in sectors */ 284 unsigned int erase_shift; /* if erase unit is power 2 */ 285 unsigned int pref_erase; /* in sectors */ 286 u8 erased_byte; /* value of erased bytes */ 287 288 u32 raw_cid[4]; /* raw card CID */ 289 u32 raw_csd[4]; /* raw card CSD */ 290 u32 raw_scr[2]; /* raw card SCR */ 291 struct mmc_cid cid; /* card identification */ 292 struct mmc_csd csd; /* card specific */ 293 struct mmc_ext_csd ext_csd; /* mmc v4 extended card specific */ 294 struct sd_scr scr; /* extra SD information */ 295 struct sd_ssr ssr; /* yet more SD information */ 296 struct sd_switch_caps sw_caps; /* switch (CMD6) caps */ 297 298 unsigned int sdio_funcs; /* number of SDIO functions */ 299 struct sdio_cccr cccr; /* common card info */ 300 struct sdio_cis cis; /* common tuple info */ 301 struct sdio_func *sdio_func[SDIO_MAX_FUNCS]; /* SDIO functions (devices) */ 302 struct sdio_func *sdio_single_irq; /* SDIO function when only one IRQ active */ 303 unsigned num_info; /* number of info strings */ 304 const char **info; /* info strings */ 305 struct sdio_func_tuple *tuples; /* unknown common tuples */ 306 307 unsigned int sd_bus_speed; /* Bus Speed Mode set for the card */ 308 unsigned int mmc_avail_type; /* supported device type by both host and card */ 309 unsigned int drive_strength; /* for UHS-I, HS200 or HS400 */ 310 311 struct dentry *debugfs_root; 312 struct mmc_part part[MMC_NUM_PHY_PARTITION]; /* physical partitions */ 313 unsigned int nr_parts; 314 }; 315 316 /* 317 * This function fill contents in mmc_part. 318 */ 319 static inline void mmc_part_add(struct mmc_card *card, unsigned int size, 320 unsigned int part_cfg, char *name, int idx, bool ro, 321 int area_type) 322 { 323 card->part[card->nr_parts].size = size; 324 card->part[card->nr_parts].part_cfg = part_cfg; 325 sprintf(card->part[card->nr_parts].name, name, idx); 326 card->part[card->nr_parts].force_ro = ro; 327 card->part[card->nr_parts].area_type = area_type; 328 card->nr_parts++; 329 } 330 331 static inline bool mmc_large_sector(struct mmc_card *card) 332 { 333 return card->ext_csd.data_sector_size == 4096; 334 } 335 336 /* 337 * The world is not perfect and supplies us with broken mmc/sdio devices. 338 * For at least some of these bugs we need a work-around. 339 */ 340 341 struct mmc_fixup { 342 /* CID-specific fields. */ 343 const char *name; 344 345 /* Valid revision range */ 346 u64 rev_start, rev_end; 347 348 unsigned int manfid; 349 unsigned short oemid; 350 351 /* SDIO-specfic fields. You can use SDIO_ANY_ID here of course */ 352 u16 cis_vendor, cis_device; 353 354 void (*vendor_fixup)(struct mmc_card *card, int data); 355 int data; 356 }; 357 358 #define CID_MANFID_ANY (-1u) 359 #define CID_OEMID_ANY ((unsigned short) -1) 360 #define CID_NAME_ANY (NULL) 361 362 #define END_FIXUP { NULL } 363 364 #define _FIXUP_EXT(_name, _manfid, _oemid, _rev_start, _rev_end, \ 365 _cis_vendor, _cis_device, \ 366 _fixup, _data) \ 367 { \ 368 .name = (_name), \ 369 .manfid = (_manfid), \ 370 .oemid = (_oemid), \ 371 .rev_start = (_rev_start), \ 372 .rev_end = (_rev_end), \ 373 .cis_vendor = (_cis_vendor), \ 374 .cis_device = (_cis_device), \ 375 .vendor_fixup = (_fixup), \ 376 .data = (_data), \ 377 } 378 379 #define MMC_FIXUP_REV(_name, _manfid, _oemid, _rev_start, _rev_end, \ 380 _fixup, _data) \ 381 _FIXUP_EXT(_name, _manfid, \ 382 _oemid, _rev_start, _rev_end, \ 383 SDIO_ANY_ID, SDIO_ANY_ID, \ 384 _fixup, _data) \ 385 386 #define MMC_FIXUP(_name, _manfid, _oemid, _fixup, _data) \ 387 MMC_FIXUP_REV(_name, _manfid, _oemid, 0, -1ull, _fixup, _data) 388 389 #define SDIO_FIXUP(_vendor, _device, _fixup, _data) \ 390 _FIXUP_EXT(CID_NAME_ANY, CID_MANFID_ANY, \ 391 CID_OEMID_ANY, 0, -1ull, \ 392 _vendor, _device, \ 393 _fixup, _data) \ 394 395 #define cid_rev(hwrev, fwrev, year, month) \ 396 (((u64) hwrev) << 40 | \ 397 ((u64) fwrev) << 32 | \ 398 ((u64) year) << 16 | \ 399 ((u64) month)) 400 401 #define cid_rev_card(card) \ 402 cid_rev(card->cid.hwrev, \ 403 card->cid.fwrev, \ 404 card->cid.year, \ 405 card->cid.month) 406 407 /* 408 * Unconditionally quirk add/remove. 409 */ 410 411 static inline void __maybe_unused add_quirk(struct mmc_card *card, int data) 412 { 413 card->quirks |= data; 414 } 415 416 static inline void __maybe_unused remove_quirk(struct mmc_card *card, int data) 417 { 418 card->quirks &= ~data; 419 } 420 421 #define mmc_card_mmc(c) ((c)->type == MMC_TYPE_MMC) 422 #define mmc_card_sd(c) ((c)->type == MMC_TYPE_SD) 423 #define mmc_card_sdio(c) ((c)->type == MMC_TYPE_SDIO) 424 425 #define mmc_card_present(c) ((c)->state & MMC_STATE_PRESENT) 426 #define mmc_card_readonly(c) ((c)->state & MMC_STATE_READONLY) 427 #define mmc_card_blockaddr(c) ((c)->state & MMC_STATE_BLOCKADDR) 428 #define mmc_card_ext_capacity(c) ((c)->state & MMC_CARD_SDXC) 429 #define mmc_card_removed(c) ((c) && ((c)->state & MMC_CARD_REMOVED)) 430 #define mmc_card_doing_bkops(c) ((c)->state & MMC_STATE_DOING_BKOPS) 431 #define mmc_card_suspended(c) ((c)->state & MMC_STATE_SUSPENDED) 432 433 #define mmc_card_set_present(c) ((c)->state |= MMC_STATE_PRESENT) 434 #define mmc_card_set_readonly(c) ((c)->state |= MMC_STATE_READONLY) 435 #define mmc_card_set_blockaddr(c) ((c)->state |= MMC_STATE_BLOCKADDR) 436 #define mmc_card_set_ext_capacity(c) ((c)->state |= MMC_CARD_SDXC) 437 #define mmc_card_set_removed(c) ((c)->state |= MMC_CARD_REMOVED) 438 #define mmc_card_set_doing_bkops(c) ((c)->state |= MMC_STATE_DOING_BKOPS) 439 #define mmc_card_clr_doing_bkops(c) ((c)->state &= ~MMC_STATE_DOING_BKOPS) 440 #define mmc_card_set_suspended(c) ((c)->state |= MMC_STATE_SUSPENDED) 441 #define mmc_card_clr_suspended(c) ((c)->state &= ~MMC_STATE_SUSPENDED) 442 443 /* 444 * Quirk add/remove for MMC products. 445 */ 446 447 static inline void __maybe_unused add_quirk_mmc(struct mmc_card *card, int data) 448 { 449 if (mmc_card_mmc(card)) 450 card->quirks |= data; 451 } 452 453 static inline void __maybe_unused remove_quirk_mmc(struct mmc_card *card, 454 int data) 455 { 456 if (mmc_card_mmc(card)) 457 card->quirks &= ~data; 458 } 459 460 /* 461 * Quirk add/remove for SD products. 462 */ 463 464 static inline void __maybe_unused add_quirk_sd(struct mmc_card *card, int data) 465 { 466 if (mmc_card_sd(card)) 467 card->quirks |= data; 468 } 469 470 static inline void __maybe_unused remove_quirk_sd(struct mmc_card *card, 471 int data) 472 { 473 if (mmc_card_sd(card)) 474 card->quirks &= ~data; 475 } 476 477 static inline int mmc_card_lenient_fn0(const struct mmc_card *c) 478 { 479 return c->quirks & MMC_QUIRK_LENIENT_FN0; 480 } 481 482 static inline int mmc_blksz_for_byte_mode(const struct mmc_card *c) 483 { 484 return c->quirks & MMC_QUIRK_BLKSZ_FOR_BYTE_MODE; 485 } 486 487 static inline int mmc_card_disable_cd(const struct mmc_card *c) 488 { 489 return c->quirks & MMC_QUIRK_DISABLE_CD; 490 } 491 492 static inline int mmc_card_nonstd_func_interface(const struct mmc_card *c) 493 { 494 return c->quirks & MMC_QUIRK_NONSTD_FUNC_IF; 495 } 496 497 static inline int mmc_card_broken_byte_mode_512(const struct mmc_card *c) 498 { 499 return c->quirks & MMC_QUIRK_BROKEN_BYTE_MODE_512; 500 } 501 502 static inline int mmc_card_long_read_time(const struct mmc_card *c) 503 { 504 return c->quirks & MMC_QUIRK_LONG_READ_TIME; 505 } 506 507 static inline int mmc_card_broken_irq_polling(const struct mmc_card *c) 508 { 509 return c->quirks & MMC_QUIRK_BROKEN_IRQ_POLLING; 510 } 511 512 #define mmc_card_name(c) ((c)->cid.prod_name) 513 #define mmc_card_id(c) (dev_name(&(c)->dev)) 514 515 #define mmc_dev_to_card(d) container_of(d, struct mmc_card, dev) 516 517 /* 518 * MMC device driver (e.g., Flash card, I/O card...) 519 */ 520 struct mmc_driver { 521 struct device_driver drv; 522 int (*probe)(struct mmc_card *); 523 void (*remove)(struct mmc_card *); 524 void (*shutdown)(struct mmc_card *); 525 }; 526 527 extern int mmc_register_driver(struct mmc_driver *); 528 extern void mmc_unregister_driver(struct mmc_driver *); 529 530 extern void mmc_fixup_device(struct mmc_card *card, 531 const struct mmc_fixup *table); 532 533 #endif /* LINUX_MMC_CARD_H */ 534