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/mmc/core.h>
14 #include <linux/mod_devicetable.h>
15 #include <linux/genhd.h>
29 unsigned char structure
;
30 unsigned char mmca_vsn
;
31 unsigned short cmdclass
;
32 unsigned short tacc_clks
;
35 unsigned int r2w_factor
;
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,
50 u8 sec_feature_support
;
56 unsigned int part_time
; /* Units: ms */
57 unsigned int sa_timeout
; /* Units: 100ns */
58 unsigned int generic_cmd6_time
; /* Units: 10ms */
59 unsigned int power_off_longtime
; /* Units: ms */
60 unsigned int hs_max_dtr
;
62 unsigned int card_type
;
63 unsigned int hc_erase_size
; /* In sectors */
64 unsigned int hc_erase_timeout
; /* In milliseconds */
65 unsigned int sec_trim_mult
; /* Secure trim multiplier */
66 unsigned int sec_erase_mult
; /* Secure erase multiplier */
67 unsigned int trim_timeout
; /* In milliseconds */
68 bool enhanced_area_en
; /* enable bit */
69 unsigned long long enhanced_area_offset
; /* Units: Byte */
70 unsigned int enhanced_area_size
; /* Units: KB */
71 unsigned int cache_size
; /* Units: KB */
72 u8 raw_partition_support
; /* 160 */
73 u8 raw_erased_mem_count
; /* 181 */
74 u8 raw_ext_csd_structure
; /* 194 */
75 u8 raw_card_type
; /* 196 */
76 u8 raw_s_a_timeout
; /* 217 */
77 u8 raw_hc_erase_gap_size
; /* 221 */
78 u8 raw_erase_timeout_mult
; /* 223 */
79 u8 raw_hc_erase_grp_size
; /* 224 */
80 u8 raw_sec_trim_mult
; /* 229 */
81 u8 raw_sec_erase_mult
; /* 230 */
82 u8 raw_sec_feature_support
;/* 231 */
83 u8 raw_trim_mult
; /* 232 */
84 u8 raw_sectors
[4]; /* 212 - 4 bytes */
86 unsigned int feature_support
;
87 #define MMC_DISCARD_FEATURE BIT(0) /* CMD38 feature */
91 unsigned char sda_vsn
;
92 unsigned char sda_spec3
;
93 unsigned char bus_widths
;
94 #define SD_SCR_BUS_WIDTH_1 (1<<0)
95 #define SD_SCR_BUS_WIDTH_4 (1<<2)
97 #define SD_SCR_CMD20_SUPPORT (1<<0)
98 #define SD_SCR_CMD23_SUPPORT (1<<1)
102 unsigned int au
; /* In sectors */
103 unsigned int erase_timeout
; /* In milliseconds */
104 unsigned int erase_offset
; /* In milliseconds */
107 struct sd_switch_caps
{
108 unsigned int hs_max_dtr
;
109 unsigned int uhs_max_dtr
;
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 UHS_SDR25_BUS_SPEED 1
118 #define UHS_SDR50_BUS_SPEED 2
119 #define UHS_SDR104_BUS_SPEED 3
120 #define UHS_DDR50_BUS_SPEED 4
122 #define SD_MODE_UHS_SDR12 (1 << UHS_SDR12_BUS_SPEED)
123 #define SD_MODE_UHS_SDR25 (1 << UHS_SDR25_BUS_SPEED)
124 #define SD_MODE_UHS_SDR50 (1 << UHS_SDR50_BUS_SPEED)
125 #define SD_MODE_UHS_SDR104 (1 << UHS_SDR104_BUS_SPEED)
126 #define SD_MODE_UHS_DDR50 (1 << UHS_DDR50_BUS_SPEED)
127 unsigned int sd3_drv_type
;
128 #define SD_DRIVER_TYPE_B 0x01
129 #define SD_DRIVER_TYPE_A 0x02
130 #define SD_DRIVER_TYPE_C 0x04
131 #define SD_DRIVER_TYPE_D 0x08
132 unsigned int sd3_curr_limit
;
133 #define SD_SET_CURRENT_LIMIT_200 0
134 #define SD_SET_CURRENT_LIMIT_400 1
135 #define SD_SET_CURRENT_LIMIT_600 2
136 #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)
145 unsigned int sdio_vsn
;
147 unsigned int multi_block
:1,
156 unsigned short vendor
;
157 unsigned short device
;
158 unsigned short blksize
;
159 unsigned int max_dtr
;
164 struct sdio_func_tuple
;
166 #define SDIO_MAX_FUNCS 7
168 /* The number of MMC physical partitions. These consist of:
169 * boot partitions (2), general purpose partitions (4) in MMC v4.4.
171 #define MMC_NUM_BOOT_PARTITION 2
172 #define MMC_NUM_GP_PARTITION 4
173 #define MMC_NUM_PHY_PARTITION 6
176 * MMC Physical partitions
179 unsigned int size
; /* partition size (in bytes) */
180 unsigned int part_cfg
; /* partition type */
181 char name
[DISK_NAME_LEN
];
182 bool force_ro
; /* to make boot parts RO by default */
189 struct mmc_host
*host
; /* the host this device belongs to */
190 struct device dev
; /* the device */
191 unsigned int rca
; /* relative card address of device */
192 unsigned int type
; /* card type */
193 #define MMC_TYPE_MMC 0 /* MMC card */
194 #define MMC_TYPE_SD 1 /* SD card */
195 #define MMC_TYPE_SDIO 2 /* SDIO card */
196 #define MMC_TYPE_SD_COMBO 3 /* SD combo (IO+mem) card */
197 unsigned int state
; /* (our) card state */
198 #define MMC_STATE_PRESENT (1<<0) /* present in sysfs */
199 #define MMC_STATE_READONLY (1<<1) /* card is read-only */
200 #define MMC_STATE_HIGHSPEED (1<<2) /* card is in high speed mode */
201 #define MMC_STATE_BLOCKADDR (1<<3) /* card uses block-addressing */
202 #define MMC_STATE_HIGHSPEED_DDR (1<<4) /* card is in high speed mode */
203 #define MMC_STATE_ULTRAHIGHSPEED (1<<5) /* card is in ultra high speed mode */
204 #define MMC_CARD_SDXC (1<<6) /* card is SDXC */
205 unsigned int quirks
; /* card quirks */
206 #define MMC_QUIRK_LENIENT_FN0 (1<<0) /* allow SDIO FN0 writes outside of the VS CCCR range */
207 #define MMC_QUIRK_BLKSZ_FOR_BYTE_MODE (1<<1) /* use func->cur_blksize */
209 #define MMC_QUIRK_NONSTD_SDIO (1<<2) /* non-standard SDIO card attached */
210 /* (missing CIA registers) */
211 #define MMC_QUIRK_BROKEN_CLK_GATING (1<<3) /* clock gating the sdio bus will make card fail */
212 #define MMC_QUIRK_NONSTD_FUNC_IF (1<<4) /* SDIO card has nonstd function interfaces */
213 #define MMC_QUIRK_DISABLE_CD (1<<5) /* disconnect CD/DAT[3] resistor */
214 #define MMC_QUIRK_INAND_CMD38 (1<<6) /* iNAND devices have broken CMD38 */
215 #define MMC_QUIRK_BLK_NO_CMD23 (1<<7) /* Avoid CMD23 for regular multiblock */
216 #define MMC_QUIRK_BROKEN_BYTE_MODE_512 (1<<8) /* Avoid sending 512 bytes in */
218 unsigned int poweroff_notify_state
; /* eMMC4.5 notify feature */
219 #define MMC_NO_POWER_NOTIFICATION 0
220 #define MMC_POWERED_ON 1
221 #define MMC_POWEROFF_SHORT 2
222 #define MMC_POWEROFF_LONG 3
224 unsigned int erase_size
; /* erase size in sectors */
225 unsigned int erase_shift
; /* if erase unit is power 2 */
226 unsigned int pref_erase
; /* in sectors */
227 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 */
239 unsigned int sdio_funcs
; /* number of SDIO functions */
240 struct sdio_cccr cccr
; /* common card info */
241 struct sdio_cis cis
; /* common tuple info */
242 struct sdio_func
*sdio_func
[SDIO_MAX_FUNCS
]; /* SDIO functions (devices) */
243 struct sdio_func
*sdio_single_irq
; /* SDIO function when only one IRQ active */
244 unsigned num_info
; /* number of info strings */
245 const char **info
; /* info strings */
246 struct sdio_func_tuple
*tuples
; /* unknown common tuples */
248 unsigned int sd_bus_speed
; /* Bus Speed Mode set for the card */
250 struct dentry
*debugfs_root
;
251 struct mmc_part part
[MMC_NUM_PHY_PARTITION
]; /* physical partitions */
252 unsigned int nr_parts
;
256 * This function fill contents in mmc_part.
258 static inline void mmc_part_add(struct mmc_card
*card
, unsigned int size
,
259 unsigned int part_cfg
, char *name
, int idx
, bool ro
)
261 card
->part
[card
->nr_parts
].size
= size
;
262 card
->part
[card
->nr_parts
].part_cfg
= part_cfg
;
263 sprintf(card
->part
[card
->nr_parts
].name
, name
, idx
);
264 card
->part
[card
->nr_parts
].force_ro
= ro
;
269 * The world is not perfect and supplies us with broken mmc/sdio devices.
270 * For at least some of these bugs we need a work-around.
274 /* CID-specific fields. */
277 /* Valid revision range */
278 u64 rev_start
, rev_end
;
281 unsigned short oemid
;
283 /* SDIO-specfic fields. You can use SDIO_ANY_ID here of course */
284 u16 cis_vendor
, cis_device
;
286 void (*vendor_fixup
)(struct mmc_card
*card
, int data
);
290 #define CID_MANFID_ANY (-1u)
291 #define CID_OEMID_ANY ((unsigned short) -1)
292 #define CID_NAME_ANY (NULL)
294 #define END_FIXUP { 0 }
296 #define _FIXUP_EXT(_name, _manfid, _oemid, _rev_start, _rev_end, \
297 _cis_vendor, _cis_device, \
301 .manfid = (_manfid), \
303 .rev_start = (_rev_start), \
304 .rev_end = (_rev_end), \
305 .cis_vendor = (_cis_vendor), \
306 .cis_device = (_cis_device), \
307 .vendor_fixup = (_fixup), \
311 #define MMC_FIXUP_REV(_name, _manfid, _oemid, _rev_start, _rev_end, \
313 _FIXUP_EXT(_name, _manfid, \
314 _oemid, _rev_start, _rev_end, \
315 SDIO_ANY_ID, SDIO_ANY_ID, \
318 #define MMC_FIXUP(_name, _manfid, _oemid, _fixup, _data) \
319 MMC_FIXUP_REV(_name, _manfid, _oemid, 0, -1ull, _fixup, _data)
321 #define SDIO_FIXUP(_vendor, _device, _fixup, _data) \
322 _FIXUP_EXT(CID_NAME_ANY, CID_MANFID_ANY, \
323 CID_OEMID_ANY, 0, -1ull, \
327 #define cid_rev(hwrev, fwrev, year, month) \
328 (((u64) hwrev) << 40 | \
329 ((u64) fwrev) << 32 | \
330 ((u64) year) << 16 | \
333 #define cid_rev_card(card) \
334 cid_rev(card->cid.hwrev, \
340 * Unconditionally quirk add/remove.
343 static inline void __maybe_unused
add_quirk(struct mmc_card
*card
, int data
)
345 card
->quirks
|= data
;
348 static inline void __maybe_unused
remove_quirk(struct mmc_card
*card
, int data
)
350 card
->quirks
&= ~data
;
353 #define mmc_card_mmc(c) ((c)->type == MMC_TYPE_MMC)
354 #define mmc_card_sd(c) ((c)->type == MMC_TYPE_SD)
355 #define mmc_card_sdio(c) ((c)->type == MMC_TYPE_SDIO)
357 #define mmc_card_present(c) ((c)->state & MMC_STATE_PRESENT)
358 #define mmc_card_readonly(c) ((c)->state & MMC_STATE_READONLY)
359 #define mmc_card_highspeed(c) ((c)->state & MMC_STATE_HIGHSPEED)
360 #define mmc_card_blockaddr(c) ((c)->state & MMC_STATE_BLOCKADDR)
361 #define mmc_card_ddr_mode(c) ((c)->state & MMC_STATE_HIGHSPEED_DDR)
362 #define mmc_sd_card_uhs(c) ((c)->state & MMC_STATE_ULTRAHIGHSPEED)
363 #define mmc_card_ext_capacity(c) ((c)->state & MMC_CARD_SDXC)
365 #define mmc_card_set_present(c) ((c)->state |= MMC_STATE_PRESENT)
366 #define mmc_card_set_readonly(c) ((c)->state |= MMC_STATE_READONLY)
367 #define mmc_card_set_highspeed(c) ((c)->state |= MMC_STATE_HIGHSPEED)
368 #define mmc_card_set_blockaddr(c) ((c)->state |= MMC_STATE_BLOCKADDR)
369 #define mmc_card_set_ddr_mode(c) ((c)->state |= MMC_STATE_HIGHSPEED_DDR)
370 #define mmc_sd_card_set_uhs(c) ((c)->state |= MMC_STATE_ULTRAHIGHSPEED)
371 #define mmc_card_set_ext_capacity(c) ((c)->state |= MMC_CARD_SDXC)
374 * Quirk add/remove for MMC products.
377 static inline void __maybe_unused
add_quirk_mmc(struct mmc_card
*card
, int data
)
379 if (mmc_card_mmc(card
))
380 card
->quirks
|= data
;
383 static inline void __maybe_unused
remove_quirk_mmc(struct mmc_card
*card
,
386 if (mmc_card_mmc(card
))
387 card
->quirks
&= ~data
;
391 * Quirk add/remove for SD products.
394 static inline void __maybe_unused
add_quirk_sd(struct mmc_card
*card
, int data
)
396 if (mmc_card_sd(card
))
397 card
->quirks
|= data
;
400 static inline void __maybe_unused
remove_quirk_sd(struct mmc_card
*card
,
403 if (mmc_card_sd(card
))
404 card
->quirks
&= ~data
;
407 static inline int mmc_card_lenient_fn0(const struct mmc_card
*c
)
409 return c
->quirks
& MMC_QUIRK_LENIENT_FN0
;
412 static inline int mmc_blksz_for_byte_mode(const struct mmc_card
*c
)
414 return c
->quirks
& MMC_QUIRK_BLKSZ_FOR_BYTE_MODE
;
417 static inline int mmc_card_disable_cd(const struct mmc_card
*c
)
419 return c
->quirks
& MMC_QUIRK_DISABLE_CD
;
422 static inline int mmc_card_nonstd_func_interface(const struct mmc_card
*c
)
424 return c
->quirks
& MMC_QUIRK_NONSTD_FUNC_IF
;
427 static inline int mmc_card_broken_byte_mode_512(const struct mmc_card
*c
)
429 return c
->quirks
& MMC_QUIRK_BROKEN_BYTE_MODE_512
;
432 #define mmc_card_name(c) ((c)->cid.prod_name)
433 #define mmc_card_id(c) (dev_name(&(c)->dev))
435 #define mmc_dev_to_card(d) container_of(d, struct mmc_card, dev)
437 #define mmc_list_to_card(l) container_of(l, struct mmc_card, node)
438 #define mmc_get_drvdata(c) dev_get_drvdata(&(c)->dev)
439 #define mmc_set_drvdata(c,d) dev_set_drvdata(&(c)->dev, d)
442 * MMC device driver (e.g., Flash card, I/O card...)
445 struct device_driver drv
;
446 int (*probe
)(struct mmc_card
*);
447 void (*remove
)(struct mmc_card
*);
448 int (*suspend
)(struct mmc_card
*, pm_message_t
);
449 int (*resume
)(struct mmc_card
*);
452 extern int mmc_register_driver(struct mmc_driver
*);
453 extern void mmc_unregister_driver(struct mmc_driver
*);
455 extern void mmc_fixup_device(struct mmc_card
*card
,
456 const struct mmc_fixup
*table
);
458 #endif /* LINUX_MMC_CARD_H */