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