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 #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 strobe_support
; /* 184 */
99 u8 raw_ext_csd_structure
; /* 194 */
100 u8 raw_card_type
; /* 196 */
101 u8 raw_driver_strength
; /* 197 */
102 u8 out_of_int_time
; /* 198 */
103 u8 raw_pwr_cl_52_195
; /* 200 */
104 u8 raw_pwr_cl_26_195
; /* 201 */
105 u8 raw_pwr_cl_52_360
; /* 202 */
106 u8 raw_pwr_cl_26_360
; /* 203 */
107 u8 raw_s_a_timeout
; /* 217 */
108 u8 raw_hc_erase_gap_size
; /* 221 */
109 u8 raw_erase_timeout_mult
; /* 223 */
110 u8 raw_hc_erase_grp_size
; /* 224 */
111 u8 raw_sec_trim_mult
; /* 229 */
112 u8 raw_sec_erase_mult
; /* 230 */
113 u8 raw_sec_feature_support
;/* 231 */
114 u8 raw_trim_mult
; /* 232 */
115 u8 raw_pwr_cl_200_195
; /* 236 */
116 u8 raw_pwr_cl_200_360
; /* 237 */
117 u8 raw_pwr_cl_ddr_52_195
; /* 238 */
118 u8 raw_pwr_cl_ddr_52_360
; /* 239 */
119 u8 raw_pwr_cl_ddr_200_360
; /* 253 */
120 u8 raw_bkops_status
; /* 246 */
121 u8 raw_sectors
[4]; /* 212 - 4 bytes */
123 unsigned int feature_support
;
124 #define MMC_DISCARD_FEATURE BIT(0) /* CMD38 feature */
128 unsigned char sda_vsn
;
129 unsigned char sda_spec3
;
130 unsigned char bus_widths
;
131 #define SD_SCR_BUS_WIDTH_1 (1<<0)
132 #define SD_SCR_BUS_WIDTH_4 (1<<2)
134 #define SD_SCR_CMD20_SUPPORT (1<<0)
135 #define SD_SCR_CMD23_SUPPORT (1<<1)
139 unsigned int au
; /* In sectors */
140 unsigned int erase_timeout
; /* In milliseconds */
141 unsigned int erase_offset
; /* In milliseconds */
144 struct sd_switch_caps
{
145 unsigned int hs_max_dtr
;
146 unsigned int uhs_max_dtr
;
147 #define HIGH_SPEED_MAX_DTR 50000000
148 #define UHS_SDR104_MAX_DTR 208000000
149 #define UHS_SDR50_MAX_DTR 100000000
150 #define UHS_DDR50_MAX_DTR 50000000
151 #define UHS_SDR25_MAX_DTR UHS_DDR50_MAX_DTR
152 #define UHS_SDR12_MAX_DTR 25000000
153 unsigned int sd3_bus_mode
;
154 #define UHS_SDR12_BUS_SPEED 0
155 #define HIGH_SPEED_BUS_SPEED 1
156 #define UHS_SDR25_BUS_SPEED 1
157 #define UHS_SDR50_BUS_SPEED 2
158 #define UHS_SDR104_BUS_SPEED 3
159 #define UHS_DDR50_BUS_SPEED 4
161 #define SD_MODE_HIGH_SPEED (1 << HIGH_SPEED_BUS_SPEED)
162 #define SD_MODE_UHS_SDR12 (1 << UHS_SDR12_BUS_SPEED)
163 #define SD_MODE_UHS_SDR25 (1 << UHS_SDR25_BUS_SPEED)
164 #define SD_MODE_UHS_SDR50 (1 << UHS_SDR50_BUS_SPEED)
165 #define SD_MODE_UHS_SDR104 (1 << UHS_SDR104_BUS_SPEED)
166 #define SD_MODE_UHS_DDR50 (1 << UHS_DDR50_BUS_SPEED)
167 unsigned int sd3_drv_type
;
168 #define SD_DRIVER_TYPE_B 0x01
169 #define SD_DRIVER_TYPE_A 0x02
170 #define SD_DRIVER_TYPE_C 0x04
171 #define SD_DRIVER_TYPE_D 0x08
172 unsigned int sd3_curr_limit
;
173 #define SD_SET_CURRENT_LIMIT_200 0
174 #define SD_SET_CURRENT_LIMIT_400 1
175 #define SD_SET_CURRENT_LIMIT_600 2
176 #define SD_SET_CURRENT_LIMIT_800 3
177 #define SD_SET_CURRENT_NO_CHANGE (-1)
179 #define SD_MAX_CURRENT_200 (1 << SD_SET_CURRENT_LIMIT_200)
180 #define SD_MAX_CURRENT_400 (1 << SD_SET_CURRENT_LIMIT_400)
181 #define SD_MAX_CURRENT_600 (1 << SD_SET_CURRENT_LIMIT_600)
182 #define SD_MAX_CURRENT_800 (1 << SD_SET_CURRENT_LIMIT_800)
186 unsigned int sdio_vsn
;
188 unsigned int multi_block
:1,
197 unsigned short vendor
;
198 unsigned short device
;
199 unsigned short blksize
;
200 unsigned int max_dtr
;
206 struct sdio_func_tuple
;
208 #define SDIO_MAX_FUNCS 7
210 enum mmc_blk_status
{
222 /* The number of MMC physical partitions. These consist of:
223 * boot partitions (2), general purpose partitions (4) and
224 * RPMB partition (1) in MMC v4.4.
226 #define MMC_NUM_BOOT_PARTITION 2
227 #define MMC_NUM_GP_PARTITION 4
228 #define MMC_NUM_PHY_PARTITION 7
229 #define MAX_MMC_PART_NAME_LEN 20
232 * MMC Physical partitions
235 unsigned int size
; /* partition size (in bytes) */
236 unsigned int part_cfg
; /* partition type */
237 char name
[MAX_MMC_PART_NAME_LEN
];
238 bool force_ro
; /* to make boot parts RO by default */
239 unsigned int area_type
;
240 #define MMC_BLK_DATA_AREA_MAIN (1<<0)
241 #define MMC_BLK_DATA_AREA_BOOT (1<<1)
242 #define MMC_BLK_DATA_AREA_GP (1<<2)
243 #define MMC_BLK_DATA_AREA_RPMB (1<<3)
250 struct mmc_host
*host
; /* the host this device belongs to */
251 struct device dev
; /* the device */
252 u32 ocr
; /* the current OCR setting */
253 unsigned int rca
; /* relative card address of device */
254 unsigned int type
; /* card type */
255 #define MMC_TYPE_MMC 0 /* MMC card */
256 #define MMC_TYPE_SD 1 /* SD card */
257 #define MMC_TYPE_SDIO 2 /* SDIO card */
258 #define MMC_TYPE_SD_COMBO 3 /* SD combo (IO+mem) card */
259 unsigned int state
; /* (our) card state */
260 #define MMC_STATE_PRESENT (1<<0) /* present in sysfs */
261 #define MMC_STATE_READONLY (1<<1) /* card is read-only */
262 #define MMC_STATE_BLOCKADDR (1<<2) /* card uses block-addressing */
263 #define MMC_CARD_SDXC (1<<3) /* card is SDXC */
264 #define MMC_CARD_REMOVED (1<<4) /* card has been removed */
265 #define MMC_STATE_DOING_BKOPS (1<<5) /* card is doing BKOPS */
266 #define MMC_STATE_SUSPENDED (1<<6) /* card is suspended */
267 unsigned int quirks
; /* card quirks */
268 #define MMC_QUIRK_LENIENT_FN0 (1<<0) /* allow SDIO FN0 writes outside of the VS CCCR range */
269 #define MMC_QUIRK_BLKSZ_FOR_BYTE_MODE (1<<1) /* use func->cur_blksize */
271 #define MMC_QUIRK_NONSTD_SDIO (1<<2) /* non-standard SDIO card attached */
272 /* (missing CIA registers) */
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 */
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 #define MMC_QUIRK_TRIM_BROKEN (1<<12) /* Skip trim */
283 #define MMC_QUIRK_BROKEN_HPI (1<<13) /* Disable broken HPI support */
286 unsigned int erase_size
; /* erase size in sectors */
287 unsigned int erase_shift
; /* if erase unit is power 2 */
288 unsigned int pref_erase
; /* in sectors */
289 unsigned int eg_boundary
; /* don't cross erase-group boundaries */
290 u8 erased_byte
; /* value of erased bytes */
292 u32 raw_cid
[4]; /* raw card CID */
293 u32 raw_csd
[4]; /* raw card CSD */
294 u32 raw_scr
[2]; /* raw card SCR */
295 u32 raw_ssr
[16]; /* raw card SSR */
296 struct mmc_cid cid
; /* card identification */
297 struct mmc_csd csd
; /* card specific */
298 struct mmc_ext_csd ext_csd
; /* mmc v4 extended card specific */
299 struct sd_scr scr
; /* extra SD information */
300 struct sd_ssr ssr
; /* yet more SD information */
301 struct sd_switch_caps sw_caps
; /* switch (CMD6) caps */
303 unsigned int sdio_funcs
; /* number of SDIO functions */
304 struct sdio_cccr cccr
; /* common card info */
305 struct sdio_cis cis
; /* common tuple info */
306 struct sdio_func
*sdio_func
[SDIO_MAX_FUNCS
]; /* SDIO functions (devices) */
307 struct sdio_func
*sdio_single_irq
; /* SDIO function when only one IRQ active */
308 unsigned num_info
; /* number of info strings */
309 const char **info
; /* info strings */
310 struct sdio_func_tuple
*tuples
; /* unknown common tuples */
312 unsigned int sd_bus_speed
; /* Bus Speed Mode set for the card */
313 unsigned int mmc_avail_type
; /* supported device type by both host and card */
314 unsigned int drive_strength
; /* for UHS-I, HS200 or HS400 */
316 struct dentry
*debugfs_root
;
317 struct mmc_part part
[MMC_NUM_PHY_PARTITION
]; /* physical partitions */
318 unsigned int nr_parts
;
322 * This function fill contents in mmc_part.
324 static inline void mmc_part_add(struct mmc_card
*card
, unsigned int size
,
325 unsigned int part_cfg
, char *name
, int idx
, bool ro
,
328 card
->part
[card
->nr_parts
].size
= size
;
329 card
->part
[card
->nr_parts
].part_cfg
= part_cfg
;
330 sprintf(card
->part
[card
->nr_parts
].name
, name
, idx
);
331 card
->part
[card
->nr_parts
].force_ro
= ro
;
332 card
->part
[card
->nr_parts
].area_type
= area_type
;
336 static inline bool mmc_large_sector(struct mmc_card
*card
)
338 return card
->ext_csd
.data_sector_size
== 4096;
342 * The world is not perfect and supplies us with broken mmc/sdio devices.
343 * For at least some of these bugs we need a work-around.
347 /* CID-specific fields. */
350 /* Valid revision range */
351 u64 rev_start
, rev_end
;
354 unsigned short oemid
;
356 /* SDIO-specfic fields. You can use SDIO_ANY_ID here of course */
357 u16 cis_vendor
, cis_device
;
360 unsigned int ext_csd_rev
;
362 void (*vendor_fixup
)(struct mmc_card
*card
, int data
);
366 #define CID_MANFID_ANY (-1u)
367 #define CID_OEMID_ANY ((unsigned short) -1)
368 #define CID_NAME_ANY (NULL)
370 #define EXT_CSD_REV_ANY (-1u)
372 #define CID_MANFID_SANDISK 0x2
373 #define CID_MANFID_TOSHIBA 0x11
374 #define CID_MANFID_MICRON 0x13
375 #define CID_MANFID_SAMSUNG 0x15
376 #define CID_MANFID_KINGSTON 0x70
377 #define CID_MANFID_HYNIX 0x90
379 #define END_FIXUP { NULL }
381 #define _FIXUP_EXT(_name, _manfid, _oemid, _rev_start, _rev_end, \
382 _cis_vendor, _cis_device, \
383 _fixup, _data, _ext_csd_rev) \
386 .manfid = (_manfid), \
388 .rev_start = (_rev_start), \
389 .rev_end = (_rev_end), \
390 .cis_vendor = (_cis_vendor), \
391 .cis_device = (_cis_device), \
392 .vendor_fixup = (_fixup), \
394 .ext_csd_rev = (_ext_csd_rev), \
397 #define MMC_FIXUP_REV(_name, _manfid, _oemid, _rev_start, _rev_end, \
398 _fixup, _data, _ext_csd_rev) \
399 _FIXUP_EXT(_name, _manfid, \
400 _oemid, _rev_start, _rev_end, \
401 SDIO_ANY_ID, SDIO_ANY_ID, \
402 _fixup, _data, _ext_csd_rev) \
404 #define MMC_FIXUP(_name, _manfid, _oemid, _fixup, _data) \
405 MMC_FIXUP_REV(_name, _manfid, _oemid, 0, -1ull, _fixup, _data, \
408 #define MMC_FIXUP_EXT_CSD_REV(_name, _manfid, _oemid, _fixup, _data, \
410 MMC_FIXUP_REV(_name, _manfid, _oemid, 0, -1ull, _fixup, _data, \
413 #define SDIO_FIXUP(_vendor, _device, _fixup, _data) \
414 _FIXUP_EXT(CID_NAME_ANY, CID_MANFID_ANY, \
415 CID_OEMID_ANY, 0, -1ull, \
417 _fixup, _data, EXT_CSD_REV_ANY) \
419 #define cid_rev(hwrev, fwrev, year, month) \
420 (((u64) hwrev) << 40 | \
421 ((u64) fwrev) << 32 | \
422 ((u64) year) << 16 | \
425 #define cid_rev_card(card) \
426 cid_rev(card->cid.hwrev, \
432 * Unconditionally quirk add/remove.
435 static inline void __maybe_unused
add_quirk(struct mmc_card
*card
, int data
)
437 card
->quirks
|= data
;
440 static inline void __maybe_unused
remove_quirk(struct mmc_card
*card
, int data
)
442 card
->quirks
&= ~data
;
445 #define mmc_card_mmc(c) ((c)->type == MMC_TYPE_MMC)
446 #define mmc_card_sd(c) ((c)->type == MMC_TYPE_SD)
447 #define mmc_card_sdio(c) ((c)->type == MMC_TYPE_SDIO)
449 #define mmc_card_present(c) ((c)->state & MMC_STATE_PRESENT)
450 #define mmc_card_readonly(c) ((c)->state & MMC_STATE_READONLY)
451 #define mmc_card_blockaddr(c) ((c)->state & MMC_STATE_BLOCKADDR)
452 #define mmc_card_ext_capacity(c) ((c)->state & MMC_CARD_SDXC)
453 #define mmc_card_removed(c) ((c) && ((c)->state & MMC_CARD_REMOVED))
454 #define mmc_card_doing_bkops(c) ((c)->state & MMC_STATE_DOING_BKOPS)
455 #define mmc_card_suspended(c) ((c)->state & MMC_STATE_SUSPENDED)
457 #define mmc_card_set_present(c) ((c)->state |= MMC_STATE_PRESENT)
458 #define mmc_card_set_readonly(c) ((c)->state |= MMC_STATE_READONLY)
459 #define mmc_card_set_blockaddr(c) ((c)->state |= MMC_STATE_BLOCKADDR)
460 #define mmc_card_set_ext_capacity(c) ((c)->state |= MMC_CARD_SDXC)
461 #define mmc_card_set_removed(c) ((c)->state |= MMC_CARD_REMOVED)
462 #define mmc_card_set_doing_bkops(c) ((c)->state |= MMC_STATE_DOING_BKOPS)
463 #define mmc_card_clr_doing_bkops(c) ((c)->state &= ~MMC_STATE_DOING_BKOPS)
464 #define mmc_card_set_suspended(c) ((c)->state |= MMC_STATE_SUSPENDED)
465 #define mmc_card_clr_suspended(c) ((c)->state &= ~MMC_STATE_SUSPENDED)
468 * Quirk add/remove for MMC products.
471 static inline void __maybe_unused
add_quirk_mmc(struct mmc_card
*card
, int data
)
473 if (mmc_card_mmc(card
))
474 card
->quirks
|= data
;
477 static inline void __maybe_unused
remove_quirk_mmc(struct mmc_card
*card
,
480 if (mmc_card_mmc(card
))
481 card
->quirks
&= ~data
;
485 * Quirk add/remove for SD products.
488 static inline void __maybe_unused
add_quirk_sd(struct mmc_card
*card
, int data
)
490 if (mmc_card_sd(card
))
491 card
->quirks
|= data
;
494 static inline void __maybe_unused
remove_quirk_sd(struct mmc_card
*card
,
497 if (mmc_card_sd(card
))
498 card
->quirks
&= ~data
;
501 static inline int mmc_card_lenient_fn0(const struct mmc_card
*c
)
503 return c
->quirks
& MMC_QUIRK_LENIENT_FN0
;
506 static inline int mmc_blksz_for_byte_mode(const struct mmc_card
*c
)
508 return c
->quirks
& MMC_QUIRK_BLKSZ_FOR_BYTE_MODE
;
511 static inline int mmc_card_disable_cd(const struct mmc_card
*c
)
513 return c
->quirks
& MMC_QUIRK_DISABLE_CD
;
516 static inline int mmc_card_nonstd_func_interface(const struct mmc_card
*c
)
518 return c
->quirks
& MMC_QUIRK_NONSTD_FUNC_IF
;
521 static inline int mmc_card_broken_byte_mode_512(const struct mmc_card
*c
)
523 return c
->quirks
& MMC_QUIRK_BROKEN_BYTE_MODE_512
;
526 static inline int mmc_card_long_read_time(const struct mmc_card
*c
)
528 return c
->quirks
& MMC_QUIRK_LONG_READ_TIME
;
531 static inline int mmc_card_broken_irq_polling(const struct mmc_card
*c
)
533 return c
->quirks
& MMC_QUIRK_BROKEN_IRQ_POLLING
;
536 static inline int mmc_card_broken_hpi(const struct mmc_card
*c
)
538 return c
->quirks
& MMC_QUIRK_BROKEN_HPI
;
541 #define mmc_card_name(c) ((c)->cid.prod_name)
542 #define mmc_card_id(c) (dev_name(&(c)->dev))
544 #define mmc_dev_to_card(d) container_of(d, struct mmc_card, dev)
547 * MMC device driver (e.g., Flash card, I/O card...)
550 struct device_driver drv
;
551 int (*probe
)(struct mmc_card
*);
552 void (*remove
)(struct mmc_card
*);
553 void (*shutdown
)(struct mmc_card
*);
556 extern int mmc_register_driver(struct mmc_driver
*);
557 extern void mmc_unregister_driver(struct mmc_driver
*);
559 extern void mmc_fixup_device(struct mmc_card
*card
,
560 const struct mmc_fixup
*table
);
562 #endif /* LINUX_MMC_CARD_H */