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;
55 unsigned int part_time; /* Units: ms */
56 unsigned int sa_timeout; /* Units: 100ns */
57 unsigned int hs_max_dtr;
59 unsigned int card_type;
60 unsigned int hc_erase_size; /* In sectors */
61 unsigned int hc_erase_timeout; /* In milliseconds */
62 unsigned int sec_trim_mult; /* Secure trim multiplier */
63 unsigned int sec_erase_mult; /* Secure erase multiplier */
64 unsigned int trim_timeout; /* In milliseconds */
65 bool enhanced_area_en; /* enable bit */
66 unsigned long long enhanced_area_offset; /* Units: Byte */
67 unsigned int enhanced_area_size; /* Units: KB */
68 u8 raw_partition_support; /* 160 */
69 u8 raw_erased_mem_count; /* 181 */
70 u8 raw_ext_csd_structure; /* 194 */
71 u8 raw_card_type; /* 196 */
72 u8 raw_s_a_timeout; /* 217 */
73 u8 raw_hc_erase_gap_size; /* 221 */
74 u8 raw_erase_timeout_mult; /* 223 */
75 u8 raw_hc_erase_grp_size; /* 224 */
76 u8 raw_sec_trim_mult; /* 229 */
77 u8 raw_sec_erase_mult; /* 230 */
78 u8 raw_sec_feature_support;/* 231 */
79 u8 raw_trim_mult; /* 232 */
80 u8 raw_sectors[4]; /* 212 - 4 bytes */
84 unsigned char sda_vsn;
85 unsigned char sda_spec3;
86 unsigned char bus_widths;
87 #define SD_SCR_BUS_WIDTH_1 (1<<0)
88 #define SD_SCR_BUS_WIDTH_4 (1<<2)
90 #define SD_SCR_CMD20_SUPPORT (1<<0)
91 #define SD_SCR_CMD23_SUPPORT (1<<1)
95 unsigned int au; /* In sectors */
96 unsigned int erase_timeout; /* In milliseconds */
97 unsigned int erase_offset; /* In milliseconds */
100 struct sd_switch_caps {
101 unsigned int hs_max_dtr;
102 unsigned int uhs_max_dtr;
103 #define UHS_SDR104_MAX_DTR 208000000
104 #define UHS_SDR50_MAX_DTR 100000000
105 #define UHS_DDR50_MAX_DTR 50000000
106 #define UHS_SDR25_MAX_DTR UHS_DDR50_MAX_DTR
107 #define UHS_SDR12_MAX_DTR 25000000
108 unsigned int sd3_bus_mode;
109 #define UHS_SDR12_BUS_SPEED 0
110 #define UHS_SDR25_BUS_SPEED 1
111 #define UHS_SDR50_BUS_SPEED 2
112 #define UHS_SDR104_BUS_SPEED 3
113 #define UHS_DDR50_BUS_SPEED 4
115 #define SD_MODE_UHS_SDR12 (1 << UHS_SDR12_BUS_SPEED)
116 #define SD_MODE_UHS_SDR25 (1 << UHS_SDR25_BUS_SPEED)
117 #define SD_MODE_UHS_SDR50 (1 << UHS_SDR50_BUS_SPEED)
118 #define SD_MODE_UHS_SDR104 (1 << UHS_SDR104_BUS_SPEED)
119 #define SD_MODE_UHS_DDR50 (1 << UHS_DDR50_BUS_SPEED)
120 unsigned int sd3_drv_type;
121 #define SD_DRIVER_TYPE_B 0x01
122 #define SD_DRIVER_TYPE_A 0x02
123 #define SD_DRIVER_TYPE_C 0x04
124 #define SD_DRIVER_TYPE_D 0x08
125 unsigned int sd3_curr_limit;
126 #define SD_SET_CURRENT_LIMIT_200 0
127 #define SD_SET_CURRENT_LIMIT_400 1
128 #define SD_SET_CURRENT_LIMIT_600 2
129 #define SD_SET_CURRENT_LIMIT_800 3
131 #define SD_MAX_CURRENT_200 (1 << SD_SET_CURRENT_LIMIT_200)
132 #define SD_MAX_CURRENT_400 (1 << SD_SET_CURRENT_LIMIT_400)
133 #define SD_MAX_CURRENT_600 (1 << SD_SET_CURRENT_LIMIT_600)
134 #define SD_MAX_CURRENT_800 (1 << SD_SET_CURRENT_LIMIT_800)
138 unsigned int sdio_vsn;
140 unsigned int multi_block:1,
149 unsigned short vendor;
150 unsigned short device;
151 unsigned short blksize;
152 unsigned int max_dtr;
157 struct sdio_func_tuple;
159 #define SDIO_MAX_FUNCS 7
161 /* The number of MMC physical partitions. These consist of:
162 * boot partitions (2), general purpose partitions (4) in MMC v4.4.
164 #define MMC_NUM_BOOT_PARTITION 2
165 #define MMC_NUM_GP_PARTITION 4
166 #define MMC_NUM_PHY_PARTITION 6
169 * MMC Physical partitions
172 unsigned int size; /* partition size (in bytes) */
173 unsigned int part_cfg; /* partition type */
174 char name[DISK_NAME_LEN];
175 bool force_ro; /* to make boot parts RO by default */
182 struct mmc_host *host; /* the host this device belongs to */
183 struct device dev; /* the device */
184 unsigned int rca; /* relative card address of device */
185 unsigned int type; /* card type */
186 #define MMC_TYPE_MMC 0 /* MMC card */
187 #define MMC_TYPE_SD 1 /* SD card */
188 #define MMC_TYPE_SDIO 2 /* SDIO card */
189 #define MMC_TYPE_SD_COMBO 3 /* SD combo (IO+mem) card */
190 unsigned int state; /* (our) card state */
191 #define MMC_STATE_PRESENT (1<<0) /* present in sysfs */
192 #define MMC_STATE_READONLY (1<<1) /* card is read-only */
193 #define MMC_STATE_HIGHSPEED (1<<2) /* card is in high speed mode */
194 #define MMC_STATE_BLOCKADDR (1<<3) /* card uses block-addressing */
195 #define MMC_STATE_HIGHSPEED_DDR (1<<4) /* card is in high speed mode */
196 #define MMC_STATE_ULTRAHIGHSPEED (1<<5) /* card is in ultra high speed mode */
197 #define MMC_CARD_SDXC (1<<6) /* card is SDXC */
198 unsigned int quirks; /* card quirks */
199 #define MMC_QUIRK_LENIENT_FN0 (1<<0) /* allow SDIO FN0 writes outside of the VS CCCR range */
200 #define MMC_QUIRK_BLKSZ_FOR_BYTE_MODE (1<<1) /* use func->cur_blksize */
202 #define MMC_QUIRK_NONSTD_SDIO (1<<2) /* non-standard SDIO card attached */
203 /* (missing CIA registers) */
204 #define MMC_QUIRK_BROKEN_CLK_GATING (1<<3) /* clock gating the sdio bus will make card fail */
205 #define MMC_QUIRK_NONSTD_FUNC_IF (1<<4) /* SDIO card has nonstd function interfaces */
206 #define MMC_QUIRK_DISABLE_CD (1<<5) /* disconnect CD/DAT[3] resistor */
207 #define MMC_QUIRK_INAND_CMD38 (1<<6) /* iNAND devices have broken CMD38 */
208 #define MMC_QUIRK_BLK_NO_CMD23 (1<<7) /* Avoid CMD23 for regular multiblock */
209 #define MMC_QUIRK_BROKEN_BYTE_MODE_512 (1<<8) /* Avoid sending 512 bytes in */
212 unsigned int erase_size; /* erase size in sectors */
213 unsigned int erase_shift; /* if erase unit is power 2 */
214 unsigned int pref_erase; /* in sectors */
215 u8 erased_byte; /* value of erased bytes */
217 u32 raw_cid[4]; /* raw card CID */
218 u32 raw_csd[4]; /* raw card CSD */
219 u32 raw_scr[2]; /* raw card SCR */
220 struct mmc_cid cid; /* card identification */
221 struct mmc_csd csd; /* card specific */
222 struct mmc_ext_csd ext_csd; /* mmc v4 extended card specific */
223 struct sd_scr scr; /* extra SD information */
224 struct sd_ssr ssr; /* yet more SD information */
225 struct sd_switch_caps sw_caps; /* switch (CMD6) caps */
227 unsigned int sdio_funcs; /* number of SDIO functions */
228 struct sdio_cccr cccr; /* common card info */
229 struct sdio_cis cis; /* common tuple info */
230 struct sdio_func *sdio_func[SDIO_MAX_FUNCS]; /* SDIO functions (devices) */
231 struct sdio_func *sdio_single_irq; /* SDIO function when only one IRQ active */
232 unsigned num_info; /* number of info strings */
233 const char **info; /* info strings */
234 struct sdio_func_tuple *tuples; /* unknown common tuples */
236 unsigned int sd_bus_speed; /* Bus Speed Mode set for the card */
238 struct dentry *debugfs_root;
239 struct mmc_part part[MMC_NUM_PHY_PARTITION]; /* physical partitions */
240 unsigned int nr_parts;
244 * This function fill contents in mmc_part.
246 static inline void mmc_part_add(struct mmc_card *card, unsigned int size,
247 unsigned int part_cfg, char *name, int idx, bool ro)
249 card->part[card->nr_parts].size = size;
250 card->part[card->nr_parts].part_cfg = part_cfg;
251 sprintf(card->part[card->nr_parts].name, name, idx);
252 card->part[card->nr_parts].force_ro = ro;
257 * The world is not perfect and supplies us with broken mmc/sdio devices.
258 * For at least some of these bugs we need a work-around.
262 /* CID-specific fields. */
265 /* Valid revision range */
266 u64 rev_start, rev_end;
269 unsigned short oemid;
271 /* SDIO-specfic fields. You can use SDIO_ANY_ID here of course */
272 u16 cis_vendor, cis_device;
274 void (*vendor_fixup)(struct mmc_card *card, int data);
278 #define CID_MANFID_ANY (-1u)
279 #define CID_OEMID_ANY ((unsigned short) -1)
280 #define CID_NAME_ANY (NULL)
282 #define END_FIXUP { 0 }
284 #define _FIXUP_EXT(_name, _manfid, _oemid, _rev_start, _rev_end, \
285 _cis_vendor, _cis_device, \
289 .manfid = (_manfid), \
291 .rev_start = (_rev_start), \
292 .rev_end = (_rev_end), \
293 .cis_vendor = (_cis_vendor), \
294 .cis_device = (_cis_device), \
295 .vendor_fixup = (_fixup), \
299 #define MMC_FIXUP_REV(_name, _manfid, _oemid, _rev_start, _rev_end, \
301 _FIXUP_EXT(_name, _manfid, \
302 _oemid, _rev_start, _rev_end, \
303 SDIO_ANY_ID, SDIO_ANY_ID, \
306 #define MMC_FIXUP(_name, _manfid, _oemid, _fixup, _data) \
307 MMC_FIXUP_REV(_name, _manfid, _oemid, 0, -1ull, _fixup, _data)
309 #define SDIO_FIXUP(_vendor, _device, _fixup, _data) \
310 _FIXUP_EXT(CID_NAME_ANY, CID_MANFID_ANY, \
311 CID_OEMID_ANY, 0, -1ull, \
315 #define cid_rev(hwrev, fwrev, year, month) \
316 (((u64) hwrev) << 40 | \
317 ((u64) fwrev) << 32 | \
318 ((u64) year) << 16 | \
321 #define cid_rev_card(card) \
322 cid_rev(card->cid.hwrev, \
328 * Unconditionally quirk add/remove.
331 static inline void __maybe_unused add_quirk(struct mmc_card *card, int data)
333 card->quirks |= data;
336 static inline void __maybe_unused remove_quirk(struct mmc_card *card, int data)
338 card->quirks &= ~data;
341 #define mmc_card_mmc(c) ((c)->type == MMC_TYPE_MMC)
342 #define mmc_card_sd(c) ((c)->type == MMC_TYPE_SD)
343 #define mmc_card_sdio(c) ((c)->type == MMC_TYPE_SDIO)
345 #define mmc_card_present(c) ((c)->state & MMC_STATE_PRESENT)
346 #define mmc_card_readonly(c) ((c)->state & MMC_STATE_READONLY)
347 #define mmc_card_highspeed(c) ((c)->state & MMC_STATE_HIGHSPEED)
348 #define mmc_card_blockaddr(c) ((c)->state & MMC_STATE_BLOCKADDR)
349 #define mmc_card_ddr_mode(c) ((c)->state & MMC_STATE_HIGHSPEED_DDR)
350 #define mmc_sd_card_uhs(c) ((c)->state & MMC_STATE_ULTRAHIGHSPEED)
351 #define mmc_card_ext_capacity(c) ((c)->state & MMC_CARD_SDXC)
353 #define mmc_card_set_present(c) ((c)->state |= MMC_STATE_PRESENT)
354 #define mmc_card_set_readonly(c) ((c)->state |= MMC_STATE_READONLY)
355 #define mmc_card_set_highspeed(c) ((c)->state |= MMC_STATE_HIGHSPEED)
356 #define mmc_card_set_blockaddr(c) ((c)->state |= MMC_STATE_BLOCKADDR)
357 #define mmc_card_set_ddr_mode(c) ((c)->state |= MMC_STATE_HIGHSPEED_DDR)
358 #define mmc_sd_card_set_uhs(c) ((c)->state |= MMC_STATE_ULTRAHIGHSPEED)
359 #define mmc_card_set_ext_capacity(c) ((c)->state |= MMC_CARD_SDXC)
362 * Quirk add/remove for MMC products.
365 static inline void __maybe_unused add_quirk_mmc(struct mmc_card *card, int data)
367 if (mmc_card_mmc(card))
368 card->quirks |= data;
371 static inline void __maybe_unused remove_quirk_mmc(struct mmc_card *card,
374 if (mmc_card_mmc(card))
375 card->quirks &= ~data;
379 * Quirk add/remove for SD products.
382 static inline void __maybe_unused add_quirk_sd(struct mmc_card *card, int data)
384 if (mmc_card_sd(card))
385 card->quirks |= data;
388 static inline void __maybe_unused remove_quirk_sd(struct mmc_card *card,
391 if (mmc_card_sd(card))
392 card->quirks &= ~data;
395 static inline int mmc_card_lenient_fn0(const struct mmc_card *c)
397 return c->quirks & MMC_QUIRK_LENIENT_FN0;
400 static inline int mmc_blksz_for_byte_mode(const struct mmc_card *c)
402 return c->quirks & MMC_QUIRK_BLKSZ_FOR_BYTE_MODE;
405 static inline int mmc_card_disable_cd(const struct mmc_card *c)
407 return c->quirks & MMC_QUIRK_DISABLE_CD;
410 static inline int mmc_card_nonstd_func_interface(const struct mmc_card *c)
412 return c->quirks & MMC_QUIRK_NONSTD_FUNC_IF;
415 static inline int mmc_card_broken_byte_mode_512(const struct mmc_card *c)
417 return c->quirks & MMC_QUIRK_BROKEN_BYTE_MODE_512;
420 #define mmc_card_name(c) ((c)->cid.prod_name)
421 #define mmc_card_id(c) (dev_name(&(c)->dev))
423 #define mmc_dev_to_card(d) container_of(d, struct mmc_card, dev)
425 #define mmc_list_to_card(l) container_of(l, struct mmc_card, node)
426 #define mmc_get_drvdata(c) dev_get_drvdata(&(c)->dev)
427 #define mmc_set_drvdata(c,d) dev_set_drvdata(&(c)->dev, d)
430 * MMC device driver (e.g., Flash card, I/O card...)
433 struct device_driver drv;
434 int (*probe)(struct mmc_card *);
435 void (*remove)(struct mmc_card *);
436 int (*suspend)(struct mmc_card *, pm_message_t);
437 int (*resume)(struct mmc_card *);
440 extern int mmc_register_driver(struct mmc_driver *);
441 extern void mmc_unregister_driver(struct mmc_driver *);
443 extern void mmc_fixup_device(struct mmc_card *card,
444 const struct mmc_fixup *table);
446 #endif /* LINUX_MMC_CARD_H */