2 * linux/include/linux/mmc/card.h
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.
8 * Card driver specific definitions.
10 #ifndef LINUX_MMC_CARD_H
11 #define LINUX_MMC_CARD_H
13 #include <linux/device.h>
14 #include <linux/mmc/core.h>
15 #include <linux/mod_devicetable.h>
30 unsigned char structure
;
31 unsigned char mmca_vsn
;
32 unsigned short cmdclass
;
33 unsigned short tacc_clks
;
36 unsigned int r2w_factor
;
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,
52 u8 sec_feature_support
;
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
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 bool cmdq_support
; /* Command Queue supported */
93 unsigned int cmdq_depth
; /* Command Queue depth */
94 #define MMC_FIRMWARE_LEN 8
95 u8 fwrev
[MMC_FIRMWARE_LEN
]; /* FW version */
96 u8 raw_exception_status
; /* 54 */
97 u8 raw_partition_support
; /* 160 */
98 u8 raw_rpmb_size_mult
; /* 168 */
99 u8 raw_erased_mem_count
; /* 181 */
100 u8 strobe_support
; /* 184 */
101 u8 raw_ext_csd_structure
; /* 194 */
102 u8 raw_card_type
; /* 196 */
103 u8 raw_driver_strength
; /* 197 */
104 u8 out_of_int_time
; /* 198 */
105 u8 raw_pwr_cl_52_195
; /* 200 */
106 u8 raw_pwr_cl_26_195
; /* 201 */
107 u8 raw_pwr_cl_52_360
; /* 202 */
108 u8 raw_pwr_cl_26_360
; /* 203 */
109 u8 raw_s_a_timeout
; /* 217 */
110 u8 raw_hc_erase_gap_size
; /* 221 */
111 u8 raw_erase_timeout_mult
; /* 223 */
112 u8 raw_hc_erase_grp_size
; /* 224 */
113 u8 raw_sec_trim_mult
; /* 229 */
114 u8 raw_sec_erase_mult
; /* 230 */
115 u8 raw_sec_feature_support
;/* 231 */
116 u8 raw_trim_mult
; /* 232 */
117 u8 raw_pwr_cl_200_195
; /* 236 */
118 u8 raw_pwr_cl_200_360
; /* 237 */
119 u8 raw_pwr_cl_ddr_52_195
; /* 238 */
120 u8 raw_pwr_cl_ddr_52_360
; /* 239 */
121 u8 raw_pwr_cl_ddr_200_360
; /* 253 */
122 u8 raw_bkops_status
; /* 246 */
123 u8 raw_sectors
[4]; /* 212 - 4 bytes */
125 unsigned int feature_support
;
126 #define MMC_DISCARD_FEATURE BIT(0) /* CMD38 feature */
130 unsigned char sda_vsn
;
131 unsigned char sda_spec3
;
132 unsigned char bus_widths
;
133 #define SD_SCR_BUS_WIDTH_1 (1<<0)
134 #define SD_SCR_BUS_WIDTH_4 (1<<2)
136 #define SD_SCR_CMD20_SUPPORT (1<<0)
137 #define SD_SCR_CMD23_SUPPORT (1<<1)
141 unsigned int au
; /* In sectors */
142 unsigned int erase_timeout
; /* In milliseconds */
143 unsigned int erase_offset
; /* In milliseconds */
146 struct sd_switch_caps
{
147 unsigned int hs_max_dtr
;
148 unsigned int uhs_max_dtr
;
149 #define HIGH_SPEED_MAX_DTR 50000000
150 #define UHS_SDR104_MAX_DTR 208000000
151 #define UHS_SDR50_MAX_DTR 100000000
152 #define UHS_DDR50_MAX_DTR 50000000
153 #define UHS_SDR25_MAX_DTR UHS_DDR50_MAX_DTR
154 #define UHS_SDR12_MAX_DTR 25000000
155 unsigned int sd3_bus_mode
;
156 #define UHS_SDR12_BUS_SPEED 0
157 #define HIGH_SPEED_BUS_SPEED 1
158 #define UHS_SDR25_BUS_SPEED 1
159 #define UHS_SDR50_BUS_SPEED 2
160 #define UHS_SDR104_BUS_SPEED 3
161 #define UHS_DDR50_BUS_SPEED 4
163 #define SD_MODE_HIGH_SPEED (1 << HIGH_SPEED_BUS_SPEED)
164 #define SD_MODE_UHS_SDR12 (1 << UHS_SDR12_BUS_SPEED)
165 #define SD_MODE_UHS_SDR25 (1 << UHS_SDR25_BUS_SPEED)
166 #define SD_MODE_UHS_SDR50 (1 << UHS_SDR50_BUS_SPEED)
167 #define SD_MODE_UHS_SDR104 (1 << UHS_SDR104_BUS_SPEED)
168 #define SD_MODE_UHS_DDR50 (1 << UHS_DDR50_BUS_SPEED)
169 unsigned int sd3_drv_type
;
170 #define SD_DRIVER_TYPE_B 0x01
171 #define SD_DRIVER_TYPE_A 0x02
172 #define SD_DRIVER_TYPE_C 0x04
173 #define SD_DRIVER_TYPE_D 0x08
174 unsigned int sd3_curr_limit
;
175 #define SD_SET_CURRENT_LIMIT_200 0
176 #define SD_SET_CURRENT_LIMIT_400 1
177 #define SD_SET_CURRENT_LIMIT_600 2
178 #define SD_SET_CURRENT_LIMIT_800 3
179 #define SD_SET_CURRENT_NO_CHANGE (-1)
181 #define SD_MAX_CURRENT_200 (1 << SD_SET_CURRENT_LIMIT_200)
182 #define SD_MAX_CURRENT_400 (1 << SD_SET_CURRENT_LIMIT_400)
183 #define SD_MAX_CURRENT_600 (1 << SD_SET_CURRENT_LIMIT_600)
184 #define SD_MAX_CURRENT_800 (1 << SD_SET_CURRENT_LIMIT_800)
188 unsigned int sdio_vsn
;
190 unsigned int multi_block
:1,
199 unsigned short vendor
;
200 unsigned short device
;
201 unsigned short blksize
;
202 unsigned int max_dtr
;
208 struct sdio_func_tuple
;
210 #define SDIO_MAX_FUNCS 7
212 /* The number of MMC physical partitions. These consist of:
213 * boot partitions (2), general purpose partitions (4) and
214 * RPMB partition (1) in MMC v4.4.
216 #define MMC_NUM_BOOT_PARTITION 2
217 #define MMC_NUM_GP_PARTITION 4
218 #define MMC_NUM_PHY_PARTITION 7
219 #define MAX_MMC_PART_NAME_LEN 20
222 * MMC Physical partitions
225 unsigned int size
; /* partition size (in bytes) */
226 unsigned int part_cfg
; /* partition type */
227 char name
[MAX_MMC_PART_NAME_LEN
];
228 bool force_ro
; /* to make boot parts RO by default */
229 unsigned int area_type
;
230 #define MMC_BLK_DATA_AREA_MAIN (1<<0)
231 #define MMC_BLK_DATA_AREA_BOOT (1<<1)
232 #define MMC_BLK_DATA_AREA_GP (1<<2)
233 #define MMC_BLK_DATA_AREA_RPMB (1<<3)
240 struct mmc_host
*host
; /* the host this device belongs to */
241 struct device dev
; /* the device */
242 u32 ocr
; /* the current OCR setting */
243 unsigned int rca
; /* relative card address of device */
244 unsigned int type
; /* card type */
245 #define MMC_TYPE_MMC 0 /* MMC card */
246 #define MMC_TYPE_SD 1 /* SD card */
247 #define MMC_TYPE_SDIO 2 /* SDIO card */
248 #define MMC_TYPE_SD_COMBO 3 /* SD combo (IO+mem) card */
249 unsigned int state
; /* (our) card state */
250 #define MMC_STATE_PRESENT (1<<0) /* present in sysfs */
251 #define MMC_STATE_READONLY (1<<1) /* card is read-only */
252 #define MMC_STATE_BLOCKADDR (1<<2) /* card uses block-addressing */
253 #define MMC_CARD_SDXC (1<<3) /* card is SDXC */
254 #define MMC_CARD_REMOVED (1<<4) /* card has been removed */
255 #define MMC_STATE_DOING_BKOPS (1<<5) /* card is doing BKOPS */
256 #define MMC_STATE_SUSPENDED (1<<6) /* card is suspended */
257 unsigned int quirks
; /* card quirks */
258 #define MMC_QUIRK_LENIENT_FN0 (1<<0) /* allow SDIO FN0 writes outside of the VS CCCR range */
259 #define MMC_QUIRK_BLKSZ_FOR_BYTE_MODE (1<<1) /* use func->cur_blksize */
261 #define MMC_QUIRK_NONSTD_SDIO (1<<2) /* non-standard SDIO card attached */
262 /* (missing CIA registers) */
263 #define MMC_QUIRK_NONSTD_FUNC_IF (1<<4) /* SDIO card has nonstd function interfaces */
264 #define MMC_QUIRK_DISABLE_CD (1<<5) /* disconnect CD/DAT[3] resistor */
265 #define MMC_QUIRK_INAND_CMD38 (1<<6) /* iNAND devices have broken CMD38 */
266 #define MMC_QUIRK_BLK_NO_CMD23 (1<<7) /* Avoid CMD23 for regular multiblock */
267 #define MMC_QUIRK_BROKEN_BYTE_MODE_512 (1<<8) /* Avoid sending 512 bytes in */
269 #define MMC_QUIRK_LONG_READ_TIME (1<<9) /* Data read time > CSD says */
270 #define MMC_QUIRK_SEC_ERASE_TRIM_BROKEN (1<<10) /* Skip secure for erase/trim */
271 #define MMC_QUIRK_BROKEN_IRQ_POLLING (1<<11) /* Polling SDIO_CCCR_INTx could create a fake interrupt */
272 #define MMC_QUIRK_TRIM_BROKEN (1<<12) /* Skip trim */
273 #define MMC_QUIRK_BROKEN_HPI (1<<13) /* Disable broken HPI support */
276 unsigned int erase_size
; /* erase size in sectors */
277 unsigned int erase_shift
; /* if erase unit is power 2 */
278 unsigned int pref_erase
; /* in sectors */
279 unsigned int eg_boundary
; /* don't cross erase-group boundaries */
280 u8 erased_byte
; /* value of erased bytes */
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 u32 raw_ssr
[16]; /* raw card SSR */
286 struct mmc_cid cid
; /* card identification */
287 struct mmc_csd csd
; /* card specific */
288 struct mmc_ext_csd ext_csd
; /* mmc v4 extended card specific */
289 struct sd_scr scr
; /* extra SD information */
290 struct sd_ssr ssr
; /* yet more SD information */
291 struct sd_switch_caps sw_caps
; /* switch (CMD6) caps */
293 unsigned int sdio_funcs
; /* number of SDIO functions */
294 struct sdio_cccr cccr
; /* common card info */
295 struct sdio_cis cis
; /* common tuple info */
296 struct sdio_func
*sdio_func
[SDIO_MAX_FUNCS
]; /* SDIO functions (devices) */
297 struct sdio_func
*sdio_single_irq
; /* SDIO function when only one IRQ active */
298 unsigned num_info
; /* number of info strings */
299 const char **info
; /* info strings */
300 struct sdio_func_tuple
*tuples
; /* unknown common tuples */
302 unsigned int sd_bus_speed
; /* Bus Speed Mode set for the card */
303 unsigned int mmc_avail_type
; /* supported device type by both host and card */
304 unsigned int drive_strength
; /* for UHS-I, HS200 or HS400 */
306 struct dentry
*debugfs_root
;
307 struct mmc_part part
[MMC_NUM_PHY_PARTITION
]; /* physical partitions */
308 unsigned int nr_parts
;
312 * This function fill contents in mmc_part.
314 static inline void mmc_part_add(struct mmc_card
*card
, unsigned int size
,
315 unsigned int part_cfg
, char *name
, int idx
, bool ro
,
318 card
->part
[card
->nr_parts
].size
= size
;
319 card
->part
[card
->nr_parts
].part_cfg
= part_cfg
;
320 sprintf(card
->part
[card
->nr_parts
].name
, name
, idx
);
321 card
->part
[card
->nr_parts
].force_ro
= ro
;
322 card
->part
[card
->nr_parts
].area_type
= area_type
;
326 static inline bool mmc_large_sector(struct mmc_card
*card
)
328 return card
->ext_csd
.data_sector_size
== 4096;
332 * The world is not perfect and supplies us with broken mmc/sdio devices.
333 * For at least some of these bugs we need a work-around.
337 /* CID-specific fields. */
340 /* Valid revision range */
341 u64 rev_start
, rev_end
;
344 unsigned short oemid
;
346 /* SDIO-specfic fields. You can use SDIO_ANY_ID here of course */
347 u16 cis_vendor
, cis_device
;
350 unsigned int ext_csd_rev
;
352 void (*vendor_fixup
)(struct mmc_card
*card
, int data
);
356 #define CID_MANFID_ANY (-1u)
357 #define CID_OEMID_ANY ((unsigned short) -1)
358 #define CID_NAME_ANY (NULL)
360 #define EXT_CSD_REV_ANY (-1u)
362 #define CID_MANFID_SANDISK 0x2
363 #define CID_MANFID_TOSHIBA 0x11
364 #define CID_MANFID_MICRON 0x13
365 #define CID_MANFID_SAMSUNG 0x15
366 #define CID_MANFID_KINGSTON 0x70
367 #define CID_MANFID_HYNIX 0x90
369 #define END_FIXUP { NULL }
371 #define _FIXUP_EXT(_name, _manfid, _oemid, _rev_start, _rev_end, \
372 _cis_vendor, _cis_device, \
373 _fixup, _data, _ext_csd_rev) \
376 .manfid = (_manfid), \
378 .rev_start = (_rev_start), \
379 .rev_end = (_rev_end), \
380 .cis_vendor = (_cis_vendor), \
381 .cis_device = (_cis_device), \
382 .vendor_fixup = (_fixup), \
384 .ext_csd_rev = (_ext_csd_rev), \
387 #define MMC_FIXUP_REV(_name, _manfid, _oemid, _rev_start, _rev_end, \
388 _fixup, _data, _ext_csd_rev) \
389 _FIXUP_EXT(_name, _manfid, \
390 _oemid, _rev_start, _rev_end, \
391 SDIO_ANY_ID, SDIO_ANY_ID, \
392 _fixup, _data, _ext_csd_rev) \
394 #define MMC_FIXUP(_name, _manfid, _oemid, _fixup, _data) \
395 MMC_FIXUP_REV(_name, _manfid, _oemid, 0, -1ull, _fixup, _data, \
398 #define MMC_FIXUP_EXT_CSD_REV(_name, _manfid, _oemid, _fixup, _data, \
400 MMC_FIXUP_REV(_name, _manfid, _oemid, 0, -1ull, _fixup, _data, \
403 #define SDIO_FIXUP(_vendor, _device, _fixup, _data) \
404 _FIXUP_EXT(CID_NAME_ANY, CID_MANFID_ANY, \
405 CID_OEMID_ANY, 0, -1ull, \
407 _fixup, _data, EXT_CSD_REV_ANY) \
409 #define cid_rev(hwrev, fwrev, year, month) \
410 (((u64) hwrev) << 40 | \
411 ((u64) fwrev) << 32 | \
412 ((u64) year) << 16 | \
415 #define cid_rev_card(card) \
416 cid_rev(card->cid.hwrev, \
422 * Unconditionally quirk add/remove.
425 static inline void __maybe_unused
add_quirk(struct mmc_card
*card
, int data
)
427 card
->quirks
|= data
;
430 static inline void __maybe_unused
remove_quirk(struct mmc_card
*card
, int data
)
432 card
->quirks
&= ~data
;
435 #define mmc_card_mmc(c) ((c)->type == MMC_TYPE_MMC)
436 #define mmc_card_sd(c) ((c)->type == MMC_TYPE_SD)
437 #define mmc_card_sdio(c) ((c)->type == MMC_TYPE_SDIO)
439 #define mmc_card_present(c) ((c)->state & MMC_STATE_PRESENT)
440 #define mmc_card_readonly(c) ((c)->state & MMC_STATE_READONLY)
441 #define mmc_card_blockaddr(c) ((c)->state & MMC_STATE_BLOCKADDR)
442 #define mmc_card_ext_capacity(c) ((c)->state & MMC_CARD_SDXC)
443 #define mmc_card_removed(c) ((c) && ((c)->state & MMC_CARD_REMOVED))
444 #define mmc_card_doing_bkops(c) ((c)->state & MMC_STATE_DOING_BKOPS)
445 #define mmc_card_suspended(c) ((c)->state & MMC_STATE_SUSPENDED)
447 #define mmc_card_set_present(c) ((c)->state |= MMC_STATE_PRESENT)
448 #define mmc_card_set_readonly(c) ((c)->state |= MMC_STATE_READONLY)
449 #define mmc_card_set_blockaddr(c) ((c)->state |= MMC_STATE_BLOCKADDR)
450 #define mmc_card_set_ext_capacity(c) ((c)->state |= MMC_CARD_SDXC)
451 #define mmc_card_set_removed(c) ((c)->state |= MMC_CARD_REMOVED)
452 #define mmc_card_set_doing_bkops(c) ((c)->state |= MMC_STATE_DOING_BKOPS)
453 #define mmc_card_clr_doing_bkops(c) ((c)->state &= ~MMC_STATE_DOING_BKOPS)
454 #define mmc_card_set_suspended(c) ((c)->state |= MMC_STATE_SUSPENDED)
455 #define mmc_card_clr_suspended(c) ((c)->state &= ~MMC_STATE_SUSPENDED)
458 * Quirk add/remove for MMC products.
461 static inline void __maybe_unused
add_quirk_mmc(struct mmc_card
*card
, int data
)
463 if (mmc_card_mmc(card
))
464 card
->quirks
|= data
;
467 static inline void __maybe_unused
remove_quirk_mmc(struct mmc_card
*card
,
470 if (mmc_card_mmc(card
))
471 card
->quirks
&= ~data
;
475 * Quirk add/remove for SD products.
478 static inline void __maybe_unused
add_quirk_sd(struct mmc_card
*card
, int data
)
480 if (mmc_card_sd(card
))
481 card
->quirks
|= data
;
484 static inline void __maybe_unused
remove_quirk_sd(struct mmc_card
*card
,
487 if (mmc_card_sd(card
))
488 card
->quirks
&= ~data
;
491 static inline int mmc_card_lenient_fn0(const struct mmc_card
*c
)
493 return c
->quirks
& MMC_QUIRK_LENIENT_FN0
;
496 static inline int mmc_blksz_for_byte_mode(const struct mmc_card
*c
)
498 return c
->quirks
& MMC_QUIRK_BLKSZ_FOR_BYTE_MODE
;
501 static inline int mmc_card_disable_cd(const struct mmc_card
*c
)
503 return c
->quirks
& MMC_QUIRK_DISABLE_CD
;
506 static inline int mmc_card_nonstd_func_interface(const struct mmc_card
*c
)
508 return c
->quirks
& MMC_QUIRK_NONSTD_FUNC_IF
;
511 static inline int mmc_card_broken_byte_mode_512(const struct mmc_card
*c
)
513 return c
->quirks
& MMC_QUIRK_BROKEN_BYTE_MODE_512
;
516 static inline int mmc_card_long_read_time(const struct mmc_card
*c
)
518 return c
->quirks
& MMC_QUIRK_LONG_READ_TIME
;
521 static inline int mmc_card_broken_irq_polling(const struct mmc_card
*c
)
523 return c
->quirks
& MMC_QUIRK_BROKEN_IRQ_POLLING
;
526 static inline int mmc_card_broken_hpi(const struct mmc_card
*c
)
528 return c
->quirks
& MMC_QUIRK_BROKEN_HPI
;
531 #define mmc_card_name(c) ((c)->cid.prod_name)
532 #define mmc_card_id(c) (dev_name(&(c)->dev))
534 #define mmc_dev_to_card(d) container_of(d, struct mmc_card, dev)
537 * MMC device driver (e.g., Flash card, I/O card...)
540 struct device_driver drv
;
541 int (*probe
)(struct mmc_card
*);
542 void (*remove
)(struct mmc_card
*);
543 void (*shutdown
)(struct mmc_card
*);
546 extern int mmc_register_driver(struct mmc_driver
*);
547 extern void mmc_unregister_driver(struct mmc_driver
*);
549 extern void mmc_fixup_device(struct mmc_card
*card
,
550 const struct mmc_fixup
*table
);
552 #endif /* LINUX_MMC_CARD_H */