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>
28 unsigned char structure;
29 unsigned char mmca_vsn;
30 unsigned short cmdclass;
31 unsigned short tacc_clks;
33 unsigned int r2w_factor;
35 unsigned int erase_size; /* In sectors */
36 unsigned int read_blkbits;
37 unsigned int write_blkbits;
38 unsigned int capacity;
39 unsigned int read_partial:1,
48 u8 sec_feature_support;
52 unsigned int part_time; /* Units: ms */
53 unsigned int sa_timeout; /* Units: 100ns */
54 unsigned int hs_max_dtr;
56 unsigned int card_type;
57 unsigned int hc_erase_size; /* In sectors */
58 unsigned int hc_erase_timeout; /* In milliseconds */
59 unsigned int sec_trim_mult; /* Secure trim multiplier */
60 unsigned int sec_erase_mult; /* Secure erase multiplier */
61 unsigned int trim_timeout; /* In milliseconds */
62 bool enhanced_area_en; /* enable bit */
63 unsigned long long enhanced_area_offset; /* Units: Byte */
64 unsigned int enhanced_area_size; /* Units: KB */
65 unsigned int boot_size; /* in bytes */
69 unsigned char sda_vsn;
70 unsigned char sda_spec3;
71 unsigned char bus_widths;
72 #define SD_SCR_BUS_WIDTH_1 (1<<0)
73 #define SD_SCR_BUS_WIDTH_4 (1<<2)
77 unsigned int au; /* In sectors */
78 unsigned int erase_timeout; /* In milliseconds */
79 unsigned int erase_offset; /* In milliseconds */
82 struct sd_switch_caps {
83 unsigned int hs_max_dtr;
84 unsigned int sd3_bus_mode;
85 unsigned int sd3_drv_type;
86 #define SD_DRIVER_TYPE_B 0x01
87 #define SD_DRIVER_TYPE_A 0x02
88 #define SD_DRIVER_TYPE_C 0x04
89 #define SD_DRIVER_TYPE_D 0x08
90 unsigned int sd3_curr_limit;
94 unsigned int sdio_vsn;
96 unsigned int multi_block:1,
105 unsigned short vendor;
106 unsigned short device;
107 unsigned short blksize;
108 unsigned int max_dtr;
113 struct sdio_func_tuple;
115 #define SDIO_MAX_FUNCS 7
121 struct mmc_host *host; /* the host this device belongs to */
122 struct device dev; /* the device */
123 unsigned int rca; /* relative card address of device */
124 unsigned int type; /* card type */
125 #define MMC_TYPE_MMC 0 /* MMC card */
126 #define MMC_TYPE_SD 1 /* SD card */
127 #define MMC_TYPE_SDIO 2 /* SDIO card */
128 #define MMC_TYPE_SD_COMBO 3 /* SD combo (IO+mem) card */
129 unsigned int state; /* (our) card state */
130 #define MMC_STATE_PRESENT (1<<0) /* present in sysfs */
131 #define MMC_STATE_READONLY (1<<1) /* card is read-only */
132 #define MMC_STATE_HIGHSPEED (1<<2) /* card is in high speed mode */
133 #define MMC_STATE_BLOCKADDR (1<<3) /* card uses block-addressing */
134 #define MMC_STATE_HIGHSPEED_DDR (1<<4) /* card is in high speed mode */
135 unsigned int quirks; /* card quirks */
136 #define MMC_QUIRK_LENIENT_FN0 (1<<0) /* allow SDIO FN0 writes outside of the VS CCCR range */
137 #define MMC_QUIRK_BLKSZ_FOR_BYTE_MODE (1<<1) /* use func->cur_blksize */
139 #define MMC_QUIRK_NONSTD_SDIO (1<<2) /* non-standard SDIO card attached */
140 /* (missing CIA registers) */
141 #define MMC_QUIRK_BROKEN_CLK_GATING (1<<3) /* clock gating the sdio bus will make card fail */
142 #define MMC_QUIRK_NONSTD_FUNC_IF (1<<4) /* SDIO card has nonstd function interfaces */
143 #define MMC_QUIRK_DISABLE_CD (1<<5) /* disconnect CD/DAT[3] resistor */
144 #define MMC_QUIRK_INAND_CMD38 (1<<6) /* iNAND devices have broken CMD38 */
146 unsigned int erase_size; /* erase size in sectors */
147 unsigned int erase_shift; /* if erase unit is power 2 */
148 unsigned int pref_erase; /* in sectors */
149 u8 erased_byte; /* value of erased bytes */
151 u32 raw_cid[4]; /* raw card CID */
152 u32 raw_csd[4]; /* raw card CSD */
153 u32 raw_scr[2]; /* raw card SCR */
154 struct mmc_cid cid; /* card identification */
155 struct mmc_csd csd; /* card specific */
156 struct mmc_ext_csd ext_csd; /* mmc v4 extended card specific */
157 struct sd_scr scr; /* extra SD information */
158 struct sd_ssr ssr; /* yet more SD information */
159 struct sd_switch_caps sw_caps; /* switch (CMD6) caps */
161 unsigned int sdio_funcs; /* number of SDIO functions */
162 struct sdio_cccr cccr; /* common card info */
163 struct sdio_cis cis; /* common tuple info */
164 struct sdio_func *sdio_func[SDIO_MAX_FUNCS]; /* SDIO functions (devices) */
165 unsigned num_info; /* number of info strings */
166 const char **info; /* info strings */
167 struct sdio_func_tuple *tuples; /* unknown common tuples */
169 struct dentry *debugfs_root;
173 * The world is not perfect and supplies us with broken mmc/sdio devices.
174 * For at least some of these bugs we need a work-around.
178 /* CID-specific fields. */
181 /* Valid revision range */
182 u64 rev_start, rev_end;
185 unsigned short oemid;
187 /* SDIO-specfic fields. You can use SDIO_ANY_ID here of course */
188 u16 cis_vendor, cis_device;
190 void (*vendor_fixup)(struct mmc_card *card, int data);
194 #define CID_MANFID_ANY (-1u)
195 #define CID_OEMID_ANY ((unsigned short) -1)
196 #define CID_NAME_ANY (NULL)
198 #define END_FIXUP { 0 }
200 #define _FIXUP_EXT(_name, _manfid, _oemid, _rev_start, _rev_end, \
201 _cis_vendor, _cis_device, \
205 .manfid = (_manfid), \
207 .rev_start = (_rev_start), \
208 .rev_end = (_rev_end), \
209 .cis_vendor = (_cis_vendor), \
210 .cis_device = (_cis_device), \
211 .vendor_fixup = (_fixup), \
215 #define MMC_FIXUP_REV(_name, _manfid, _oemid, _rev_start, _rev_end, \
217 _FIXUP_EXT(_name, _manfid, \
218 _oemid, _rev_start, _rev_end, \
219 SDIO_ANY_ID, SDIO_ANY_ID, \
222 #define MMC_FIXUP(_name, _manfid, _oemid, _fixup, _data) \
223 MMC_FIXUP_REV(_name, _manfid, _oemid, 0, -1ull, _fixup, _data)
225 #define SDIO_FIXUP(_vendor, _device, _fixup, _data) \
226 _FIXUP_EXT(CID_NAME_ANY, CID_MANFID_ANY, \
227 CID_OEMID_ANY, 0, -1ull, \
231 #define cid_rev(hwrev, fwrev, year, month) \
232 (((u64) hwrev) << 40 | \
233 ((u64) fwrev) << 32 | \
234 ((u64) year) << 16 | \
237 #define cid_rev_card(card) \
238 cid_rev(card->cid.hwrev, \
244 * This hook just adds a quirk unconditionally.
246 static inline void __maybe_unused add_quirk(struct mmc_card *card, int data)
248 card->quirks |= data;
252 * This hook just removes a quirk unconditionally.
254 static inline void __maybe_unused remove_quirk(struct mmc_card *card, int data)
256 card->quirks &= ~data;
259 #define mmc_card_mmc(c) ((c)->type == MMC_TYPE_MMC)
260 #define mmc_card_sd(c) ((c)->type == MMC_TYPE_SD)
261 #define mmc_card_sdio(c) ((c)->type == MMC_TYPE_SDIO)
263 #define mmc_card_present(c) ((c)->state & MMC_STATE_PRESENT)
264 #define mmc_card_readonly(c) ((c)->state & MMC_STATE_READONLY)
265 #define mmc_card_highspeed(c) ((c)->state & MMC_STATE_HIGHSPEED)
266 #define mmc_card_blockaddr(c) ((c)->state & MMC_STATE_BLOCKADDR)
267 #define mmc_card_ddr_mode(c) ((c)->state & MMC_STATE_HIGHSPEED_DDR)
269 #define mmc_card_set_present(c) ((c)->state |= MMC_STATE_PRESENT)
270 #define mmc_card_set_readonly(c) ((c)->state |= MMC_STATE_READONLY)
271 #define mmc_card_set_highspeed(c) ((c)->state |= MMC_STATE_HIGHSPEED)
272 #define mmc_card_set_blockaddr(c) ((c)->state |= MMC_STATE_BLOCKADDR)
273 #define mmc_card_set_ddr_mode(c) ((c)->state |= MMC_STATE_HIGHSPEED_DDR)
275 static inline int mmc_card_lenient_fn0(const struct mmc_card *c)
277 return c->quirks & MMC_QUIRK_LENIENT_FN0;
280 static inline int mmc_blksz_for_byte_mode(const struct mmc_card *c)
282 return c->quirks & MMC_QUIRK_BLKSZ_FOR_BYTE_MODE;
285 static inline int mmc_card_disable_cd(const struct mmc_card *c)
287 return c->quirks & MMC_QUIRK_DISABLE_CD;
290 static inline int mmc_card_nonstd_func_interface(const struct mmc_card *c)
292 return c->quirks & MMC_QUIRK_NONSTD_FUNC_IF;
295 #define mmc_card_name(c) ((c)->cid.prod_name)
296 #define mmc_card_id(c) (dev_name(&(c)->dev))
298 #define mmc_dev_to_card(d) container_of(d, struct mmc_card, dev)
300 #define mmc_list_to_card(l) container_of(l, struct mmc_card, node)
301 #define mmc_get_drvdata(c) dev_get_drvdata(&(c)->dev)
302 #define mmc_set_drvdata(c,d) dev_set_drvdata(&(c)->dev, d)
305 * MMC device driver (e.g., Flash card, I/O card...)
308 struct device_driver drv;
309 int (*probe)(struct mmc_card *);
310 void (*remove)(struct mmc_card *);
311 int (*suspend)(struct mmc_card *, pm_message_t);
312 int (*resume)(struct mmc_card *);
315 extern int mmc_register_driver(struct mmc_driver *);
316 extern void mmc_unregister_driver(struct mmc_driver *);
318 extern void mmc_fixup_device(struct mmc_card *card,
319 const struct mmc_fixup *table);