card.h 16 KB

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