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;
34 unsigned int r2w_factor;
36 unsigned int erase_size; /* In sectors */
37 unsigned int read_blkbits;
38 unsigned int write_blkbits;
39 unsigned int capacity;
40 unsigned int read_partial:1,
49 u8 sec_feature_support;
53 unsigned int part_time; /* Units: ms */
54 unsigned int sa_timeout; /* Units: 100ns */
55 unsigned int hs_max_dtr;
57 unsigned int card_type;
58 unsigned int hc_erase_size; /* In sectors */
59 unsigned int hc_erase_timeout; /* In milliseconds */
60 unsigned int sec_trim_mult; /* Secure trim multiplier */
61 unsigned int sec_erase_mult; /* Secure erase multiplier */
62 unsigned int trim_timeout; /* In milliseconds */
63 bool enhanced_area_en; /* enable bit */
64 unsigned long long enhanced_area_offset; /* Units: Byte */
65 unsigned int enhanced_area_size; /* Units: KB */
66 unsigned int boot_size; /* in bytes */
70 unsigned char sda_vsn;
71 unsigned char sda_spec3;
72 unsigned char bus_widths;
73 #define SD_SCR_BUS_WIDTH_1 (1<<0)
74 #define SD_SCR_BUS_WIDTH_4 (1<<2)
78 unsigned int au; /* In sectors */
79 unsigned int erase_timeout; /* In milliseconds */
80 unsigned int erase_offset; /* In milliseconds */
83 struct sd_switch_caps {
84 unsigned int hs_max_dtr;
85 unsigned int uhs_max_dtr;
86 #define UHS_SDR104_MAX_DTR 208000000
87 #define UHS_SDR50_MAX_DTR 100000000
88 #define UHS_DDR50_MAX_DTR 50000000
89 #define UHS_SDR25_MAX_DTR UHS_DDR50_MAX_DTR
90 #define UHS_SDR12_MAX_DTR 25000000
91 unsigned int sd3_bus_mode;
92 #define UHS_SDR12_BUS_SPEED 0
93 #define UHS_SDR25_BUS_SPEED 1
94 #define UHS_SDR50_BUS_SPEED 2
95 #define UHS_SDR104_BUS_SPEED 3
96 #define UHS_DDR50_BUS_SPEED 4
98 #define SD_MODE_UHS_SDR12 (1 << UHS_SDR12_BUS_SPEED)
99 #define SD_MODE_UHS_SDR25 (1 << UHS_SDR25_BUS_SPEED)
100 #define SD_MODE_UHS_SDR50 (1 << UHS_SDR50_BUS_SPEED)
101 #define SD_MODE_UHS_SDR104 (1 << UHS_SDR104_BUS_SPEED)
102 #define SD_MODE_UHS_DDR50 (1 << UHS_DDR50_BUS_SPEED)
103 unsigned int sd3_drv_type;
104 #define SD_DRIVER_TYPE_B 0x01
105 #define SD_DRIVER_TYPE_A 0x02
106 #define SD_DRIVER_TYPE_C 0x04
107 #define SD_DRIVER_TYPE_D 0x08
108 unsigned int sd3_curr_limit;
109 #define SD_SET_CURRENT_LIMIT_200 0
110 #define SD_SET_CURRENT_LIMIT_400 1
111 #define SD_SET_CURRENT_LIMIT_600 2
112 #define SD_SET_CURRENT_LIMIT_800 3
114 #define SD_MAX_CURRENT_200 (1 << SD_SET_CURRENT_LIMIT_200)
115 #define SD_MAX_CURRENT_400 (1 << SD_SET_CURRENT_LIMIT_400)
116 #define SD_MAX_CURRENT_600 (1 << SD_SET_CURRENT_LIMIT_600)
117 #define SD_MAX_CURRENT_800 (1 << SD_SET_CURRENT_LIMIT_800)
121 unsigned int sdio_vsn;
123 unsigned int multi_block:1,
132 unsigned short vendor;
133 unsigned short device;
134 unsigned short blksize;
135 unsigned int max_dtr;
140 struct sdio_func_tuple;
142 #define SDIO_MAX_FUNCS 7
148 struct mmc_host *host; /* the host this device belongs to */
149 struct device dev; /* the device */
150 unsigned int rca; /* relative card address of device */
151 unsigned int type; /* card type */
152 #define MMC_TYPE_MMC 0 /* MMC card */
153 #define MMC_TYPE_SD 1 /* SD card */
154 #define MMC_TYPE_SDIO 2 /* SDIO card */
155 #define MMC_TYPE_SD_COMBO 3 /* SD combo (IO+mem) card */
156 unsigned int state; /* (our) card state */
157 #define MMC_STATE_PRESENT (1<<0) /* present in sysfs */
158 #define MMC_STATE_READONLY (1<<1) /* card is read-only */
159 #define MMC_STATE_HIGHSPEED (1<<2) /* card is in high speed mode */
160 #define MMC_STATE_BLOCKADDR (1<<3) /* card uses block-addressing */
161 #define MMC_STATE_HIGHSPEED_DDR (1<<4) /* card is in high speed mode */
162 #define MMC_STATE_ULTRAHIGHSPEED (1<<5) /* card is in ultra high speed mode */
163 #define MMC_CARD_SDXC (1<<6) /* card is SDXC */
164 unsigned int quirks; /* card quirks */
165 #define MMC_QUIRK_LENIENT_FN0 (1<<0) /* allow SDIO FN0 writes outside of the VS CCCR range */
166 #define MMC_QUIRK_BLKSZ_FOR_BYTE_MODE (1<<1) /* use func->cur_blksize */
168 #define MMC_QUIRK_NONSTD_SDIO (1<<2) /* non-standard SDIO card attached */
169 /* (missing CIA registers) */
170 #define MMC_QUIRK_BROKEN_CLK_GATING (1<<3) /* clock gating the sdio bus will make card fail */
171 #define MMC_QUIRK_NONSTD_FUNC_IF (1<<4) /* SDIO card has nonstd function interfaces */
172 #define MMC_QUIRK_DISABLE_CD (1<<5) /* disconnect CD/DAT[3] resistor */
173 #define MMC_QUIRK_INAND_CMD38 (1<<6) /* iNAND devices have broken CMD38 */
175 unsigned int erase_size; /* erase size in sectors */
176 unsigned int erase_shift; /* if erase unit is power 2 */
177 unsigned int pref_erase; /* in sectors */
178 u8 erased_byte; /* value of erased bytes */
180 u32 raw_cid[4]; /* raw card CID */
181 u32 raw_csd[4]; /* raw card CSD */
182 u32 raw_scr[2]; /* raw card SCR */
183 struct mmc_cid cid; /* card identification */
184 struct mmc_csd csd; /* card specific */
185 struct mmc_ext_csd ext_csd; /* mmc v4 extended card specific */
186 struct sd_scr scr; /* extra SD information */
187 struct sd_ssr ssr; /* yet more SD information */
188 struct sd_switch_caps sw_caps; /* switch (CMD6) caps */
190 unsigned int sdio_funcs; /* number of SDIO functions */
191 struct sdio_cccr cccr; /* common card info */
192 struct sdio_cis cis; /* common tuple info */
193 struct sdio_func *sdio_func[SDIO_MAX_FUNCS]; /* SDIO functions (devices) */
194 unsigned num_info; /* number of info strings */
195 const char **info; /* info strings */
196 struct sdio_func_tuple *tuples; /* unknown common tuples */
198 unsigned int sd_bus_speed; /* Bus Speed Mode set for the card */
200 struct dentry *debugfs_root;
204 * The world is not perfect and supplies us with broken mmc/sdio devices.
205 * For at least some of these bugs we need a work-around.
209 /* CID-specific fields. */
212 /* Valid revision range */
213 u64 rev_start, rev_end;
216 unsigned short oemid;
218 /* SDIO-specfic fields. You can use SDIO_ANY_ID here of course */
219 u16 cis_vendor, cis_device;
221 void (*vendor_fixup)(struct mmc_card *card, int data);
225 #define CID_MANFID_ANY (-1u)
226 #define CID_OEMID_ANY ((unsigned short) -1)
227 #define CID_NAME_ANY (NULL)
229 #define END_FIXUP { 0 }
231 #define _FIXUP_EXT(_name, _manfid, _oemid, _rev_start, _rev_end, \
232 _cis_vendor, _cis_device, \
236 .manfid = (_manfid), \
238 .rev_start = (_rev_start), \
239 .rev_end = (_rev_end), \
240 .cis_vendor = (_cis_vendor), \
241 .cis_device = (_cis_device), \
242 .vendor_fixup = (_fixup), \
246 #define MMC_FIXUP_REV(_name, _manfid, _oemid, _rev_start, _rev_end, \
248 _FIXUP_EXT(_name, _manfid, \
249 _oemid, _rev_start, _rev_end, \
250 SDIO_ANY_ID, SDIO_ANY_ID, \
253 #define MMC_FIXUP(_name, _manfid, _oemid, _fixup, _data) \
254 MMC_FIXUP_REV(_name, _manfid, _oemid, 0, -1ull, _fixup, _data)
256 #define SDIO_FIXUP(_vendor, _device, _fixup, _data) \
257 _FIXUP_EXT(CID_NAME_ANY, CID_MANFID_ANY, \
258 CID_OEMID_ANY, 0, -1ull, \
262 #define cid_rev(hwrev, fwrev, year, month) \
263 (((u64) hwrev) << 40 | \
264 ((u64) fwrev) << 32 | \
265 ((u64) year) << 16 | \
268 #define cid_rev_card(card) \
269 cid_rev(card->cid.hwrev, \
275 * This hook just adds a quirk unconditionally.
277 static inline void __maybe_unused add_quirk(struct mmc_card *card, int data)
279 card->quirks |= data;
283 * This hook just removes a quirk unconditionally.
285 static inline void __maybe_unused remove_quirk(struct mmc_card *card, int data)
287 card->quirks &= ~data;
290 #define mmc_card_mmc(c) ((c)->type == MMC_TYPE_MMC)
291 #define mmc_card_sd(c) ((c)->type == MMC_TYPE_SD)
292 #define mmc_card_sdio(c) ((c)->type == MMC_TYPE_SDIO)
294 #define mmc_card_present(c) ((c)->state & MMC_STATE_PRESENT)
295 #define mmc_card_readonly(c) ((c)->state & MMC_STATE_READONLY)
296 #define mmc_card_highspeed(c) ((c)->state & MMC_STATE_HIGHSPEED)
297 #define mmc_card_blockaddr(c) ((c)->state & MMC_STATE_BLOCKADDR)
298 #define mmc_card_ddr_mode(c) ((c)->state & MMC_STATE_HIGHSPEED_DDR)
299 #define mmc_sd_card_uhs(c) ((c)->state & MMC_STATE_ULTRAHIGHSPEED)
300 #define mmc_card_ext_capacity(c) ((c)->state & MMC_CARD_SDXC)
302 #define mmc_card_set_present(c) ((c)->state |= MMC_STATE_PRESENT)
303 #define mmc_card_set_readonly(c) ((c)->state |= MMC_STATE_READONLY)
304 #define mmc_card_set_highspeed(c) ((c)->state |= MMC_STATE_HIGHSPEED)
305 #define mmc_card_set_blockaddr(c) ((c)->state |= MMC_STATE_BLOCKADDR)
306 #define mmc_card_set_ddr_mode(c) ((c)->state |= MMC_STATE_HIGHSPEED_DDR)
307 #define mmc_sd_card_set_uhs(c) ((c)->state |= MMC_STATE_ULTRAHIGHSPEED)
308 #define mmc_card_set_ext_capacity(c) ((c)->state |= MMC_CARD_SDXC)
310 static inline int mmc_card_lenient_fn0(const struct mmc_card *c)
312 return c->quirks & MMC_QUIRK_LENIENT_FN0;
315 static inline int mmc_blksz_for_byte_mode(const struct mmc_card *c)
317 return c->quirks & MMC_QUIRK_BLKSZ_FOR_BYTE_MODE;
320 static inline int mmc_card_disable_cd(const struct mmc_card *c)
322 return c->quirks & MMC_QUIRK_DISABLE_CD;
325 static inline int mmc_card_nonstd_func_interface(const struct mmc_card *c)
327 return c->quirks & MMC_QUIRK_NONSTD_FUNC_IF;
330 #define mmc_card_name(c) ((c)->cid.prod_name)
331 #define mmc_card_id(c) (dev_name(&(c)->dev))
333 #define mmc_dev_to_card(d) container_of(d, struct mmc_card, dev)
335 #define mmc_list_to_card(l) container_of(l, struct mmc_card, node)
336 #define mmc_get_drvdata(c) dev_get_drvdata(&(c)->dev)
337 #define mmc_set_drvdata(c,d) dev_set_drvdata(&(c)->dev, d)
340 * MMC device driver (e.g., Flash card, I/O card...)
343 struct device_driver drv;
344 int (*probe)(struct mmc_card *);
345 void (*remove)(struct mmc_card *);
346 int (*suspend)(struct mmc_card *, pm_message_t);
347 int (*resume)(struct mmc_card *);
350 extern int mmc_register_driver(struct mmc_driver *);
351 extern void mmc_unregister_driver(struct mmc_driver *);
353 extern void mmc_fixup_device(struct mmc_card *card,
354 const struct mmc_fixup *table);