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