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 sa_timeout; /* Units: 100ns */
53 unsigned int hs_max_dtr;
55 unsigned int card_type;
56 unsigned int hc_erase_size; /* In sectors */
57 unsigned int hc_erase_timeout; /* In milliseconds */
58 unsigned int sec_trim_mult; /* Secure trim multiplier */
59 unsigned int sec_erase_mult; /* Secure erase multiplier */
60 unsigned int trim_timeout; /* In milliseconds */
61 bool enhanced_area_en; /* enable bit */
62 unsigned long long enhanced_area_offset; /* Units: Byte */
63 unsigned int enhanced_area_size; /* Units: KB */
67 unsigned char sda_vsn;
68 unsigned char bus_widths;
69 #define SD_SCR_BUS_WIDTH_1 (1<<0)
70 #define SD_SCR_BUS_WIDTH_4 (1<<2)
74 unsigned int au; /* In sectors */
75 unsigned int erase_timeout; /* In milliseconds */
76 unsigned int erase_offset; /* In milliseconds */
79 struct sd_switch_caps {
80 unsigned int hs_max_dtr;
84 unsigned int sdio_vsn;
86 unsigned int multi_block:1,
95 unsigned short vendor;
96 unsigned short device;
97 unsigned short blksize;
103 struct sdio_func_tuple;
105 #define SDIO_MAX_FUNCS 7
111 struct mmc_host *host; /* the host this device belongs to */
112 struct device dev; /* the device */
113 unsigned int rca; /* relative card address of device */
114 unsigned int type; /* card type */
115 #define MMC_TYPE_MMC 0 /* MMC card */
116 #define MMC_TYPE_SD 1 /* SD card */
117 #define MMC_TYPE_SDIO 2 /* SDIO card */
118 #define MMC_TYPE_SD_COMBO 3 /* SD combo (IO+mem) card */
119 unsigned int state; /* (our) card state */
120 #define MMC_STATE_PRESENT (1<<0) /* present in sysfs */
121 #define MMC_STATE_READONLY (1<<1) /* card is read-only */
122 #define MMC_STATE_HIGHSPEED (1<<2) /* card is in high speed mode */
123 #define MMC_STATE_BLOCKADDR (1<<3) /* card uses block-addressing */
124 #define MMC_STATE_HIGHSPEED_DDR (1<<4) /* card is in high speed mode */
125 unsigned int quirks; /* card quirks */
126 #define MMC_QUIRK_LENIENT_FN0 (1<<0) /* allow SDIO FN0 writes outside of the VS CCCR range */
127 #define MMC_QUIRK_BLKSZ_FOR_BYTE_MODE (1<<1) /* use func->cur_blksize */
129 #define MMC_QUIRK_NONSTD_SDIO (1<<2) /* non-standard SDIO card attached */
130 /* (missing CIA registers) */
131 #define MMC_QUIRK_BROKEN_CLK_GATING (1<<3) /* clock gating the sdio bus will make card fail */
132 #define MMC_QUIRK_NONSTD_FUNC_IF (1<<4) /* SDIO card has nonstd function interfaces */
133 #define MMC_QUIRK_DISABLE_CD (1<<5) /* disconnect CD/DAT[3] resistor */
135 unsigned int erase_size; /* erase size in sectors */
136 unsigned int erase_shift; /* if erase unit is power 2 */
137 unsigned int pref_erase; /* in sectors */
138 u8 erased_byte; /* value of erased bytes */
140 u32 raw_cid[4]; /* raw card CID */
141 u32 raw_csd[4]; /* raw card CSD */
142 u32 raw_scr[2]; /* raw card SCR */
143 struct mmc_cid cid; /* card identification */
144 struct mmc_csd csd; /* card specific */
145 struct mmc_ext_csd ext_csd; /* mmc v4 extended card specific */
146 struct sd_scr scr; /* extra SD information */
147 struct sd_ssr ssr; /* yet more SD information */
148 struct sd_switch_caps sw_caps; /* switch (CMD6) caps */
150 unsigned int sdio_funcs; /* number of SDIO functions */
151 struct sdio_cccr cccr; /* common card info */
152 struct sdio_cis cis; /* common tuple info */
153 struct sdio_func *sdio_func[SDIO_MAX_FUNCS]; /* SDIO functions (devices) */
154 unsigned num_info; /* number of info strings */
155 const char **info; /* info strings */
156 struct sdio_func_tuple *tuples; /* unknown common tuples */
158 struct dentry *debugfs_root;
162 * The world is not perfect and supplies us with broken mmc/sdio devices.
163 * For at least some of these bugs we need a work-around.
167 /* CID-specific fields. */
170 /* Valid revision range */
171 u64 rev_start, rev_end;
174 unsigned short oemid;
176 /* SDIO-specfic fields. You can use SDIO_ANY_ID here of course */
177 u16 cis_vendor, cis_device;
179 void (*vendor_fixup)(struct mmc_card *card, int data);
183 #define CID_MANFID_ANY (-1u)
184 #define CID_OEMID_ANY ((unsigned short) -1)
185 #define CID_NAME_ANY (NULL)
187 #define END_FIXUP { 0 }
189 #define _FIXUP_EXT(_name, _manfid, _oemid, _rev_start, _rev_end, \
190 _cis_vendor, _cis_device, \
194 .manfid = (_manfid), \
196 .rev_start = (_rev_start), \
197 .rev_end = (_rev_end), \
198 .cis_vendor = (_cis_vendor), \
199 .cis_device = (_cis_device), \
200 .vendor_fixup = (_fixup), \
204 #define MMC_FIXUP_REV(_name, _manfid, _oemid, _rev_start, _rev_end, \
206 _FIXUP_EXT(_name, _manfid, \
207 _oemid, _rev_start, _rev_end, \
208 SDIO_ANY_ID, SDIO_ANY_ID, \
211 #define MMC_FIXUP(_name, _manfid, _oemid, _fixup, _data) \
212 MMC_FIXUP_REV(_name, _manfid, _oemid, 0, -1ull, _fixup, _data)
214 #define SDIO_FIXUP(_vendor, _device, _fixup, _data) \
215 _FIXUP_EXT(CID_NAME_ANY, CID_MANFID_ANY, \
216 CID_OEMID_ANY, 0, -1ull, \
220 #define cid_rev(hwrev, fwrev, year, month) \
221 (((u64) hwrev) << 40 | \
222 ((u64) fwrev) << 32 | \
223 ((u64) year) << 16 | \
226 #define cid_rev_card(card) \
227 cid_rev(card->cid.hwrev, \
233 * This hook just adds a quirk unconditionally.
235 static inline void __maybe_unused add_quirk(struct mmc_card *card, int data)
237 card->quirks |= data;
241 * This hook just removes a quirk unconditionally.
243 static inline void __maybe_unused remove_quirk(struct mmc_card *card, int data)
245 card->quirks &= ~data;
248 #define mmc_card_mmc(c) ((c)->type == MMC_TYPE_MMC)
249 #define mmc_card_sd(c) ((c)->type == MMC_TYPE_SD)
250 #define mmc_card_sdio(c) ((c)->type == MMC_TYPE_SDIO)
252 #define mmc_card_present(c) ((c)->state & MMC_STATE_PRESENT)
253 #define mmc_card_readonly(c) ((c)->state & MMC_STATE_READONLY)
254 #define mmc_card_highspeed(c) ((c)->state & MMC_STATE_HIGHSPEED)
255 #define mmc_card_blockaddr(c) ((c)->state & MMC_STATE_BLOCKADDR)
256 #define mmc_card_ddr_mode(c) ((c)->state & MMC_STATE_HIGHSPEED_DDR)
258 #define mmc_card_set_present(c) ((c)->state |= MMC_STATE_PRESENT)
259 #define mmc_card_set_readonly(c) ((c)->state |= MMC_STATE_READONLY)
260 #define mmc_card_set_highspeed(c) ((c)->state |= MMC_STATE_HIGHSPEED)
261 #define mmc_card_set_blockaddr(c) ((c)->state |= MMC_STATE_BLOCKADDR)
262 #define mmc_card_set_ddr_mode(c) ((c)->state |= MMC_STATE_HIGHSPEED_DDR)
264 static inline int mmc_card_lenient_fn0(const struct mmc_card *c)
266 return c->quirks & MMC_QUIRK_LENIENT_FN0;
269 static inline int mmc_blksz_for_byte_mode(const struct mmc_card *c)
271 return c->quirks & MMC_QUIRK_BLKSZ_FOR_BYTE_MODE;
274 static inline int mmc_card_disable_cd(const struct mmc_card *c)
276 return c->quirks & MMC_QUIRK_DISABLE_CD;
279 static inline int mmc_card_nonstd_func_interface(const struct mmc_card *c)
281 return c->quirks & MMC_QUIRK_NONSTD_FUNC_IF;
284 #define mmc_card_name(c) ((c)->cid.prod_name)
285 #define mmc_card_id(c) (dev_name(&(c)->dev))
287 #define mmc_dev_to_card(d) container_of(d, struct mmc_card, dev)
289 #define mmc_list_to_card(l) container_of(l, struct mmc_card, node)
290 #define mmc_get_drvdata(c) dev_get_drvdata(&(c)->dev)
291 #define mmc_set_drvdata(c,d) dev_set_drvdata(&(c)->dev, d)
294 * MMC device driver (e.g., Flash card, I/O card...)
297 struct device_driver drv;
298 int (*probe)(struct mmc_card *);
299 void (*remove)(struct mmc_card *);
300 int (*suspend)(struct mmc_card *, pm_message_t);
301 int (*resume)(struct mmc_card *);
304 extern int mmc_register_driver(struct mmc_driver *);
305 extern void mmc_unregister_driver(struct mmc_driver *);
307 extern void mmc_fixup_device(struct mmc_card *card,
308 const struct mmc_fixup *table);