mmc: quirks: Add/remove quirks conditional support.
[~shefty/rdma-dev.git] / include / linux / mmc / card.h
1 /*
2  *  linux/include/linux/mmc/card.h
3  *
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.
7  *
8  *  Card driver specific definitions.
9  */
10 #ifndef LINUX_MMC_CARD_H
11 #define LINUX_MMC_CARD_H
12
13 #include <linux/mmc/core.h>
14 #include <linux/mod_devicetable.h>
15
16 struct mmc_cid {
17         unsigned int            manfid;
18         char                    prod_name[8];
19         unsigned int            serial;
20         unsigned short          oemid;
21         unsigned short          year;
22         unsigned char           hwrev;
23         unsigned char           fwrev;
24         unsigned char           month;
25 };
26
27 struct mmc_csd {
28         unsigned char           structure;
29         unsigned char           mmca_vsn;
30         unsigned short          cmdclass;
31         unsigned short          tacc_clks;
32         unsigned int            tacc_ns;
33         unsigned int            c_size;
34         unsigned int            r2w_factor;
35         unsigned int            max_dtr;
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,
41                                 read_misalign:1,
42                                 write_partial:1,
43                                 write_misalign:1;
44 };
45
46 struct mmc_ext_csd {
47         u8                      rev;
48         u8                      erase_group_def;
49         u8                      sec_feature_support;
50         u8                      rel_sectors;
51         u8                      rel_param;
52         u8                      part_config;
53         unsigned int            part_time;              /* Units: ms */
54         unsigned int            sa_timeout;             /* Units: 100ns */
55         unsigned int            hs_max_dtr;
56         unsigned int            sectors;
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 */
67 };
68
69 struct sd_scr {
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)
75 };
76
77 struct sd_ssr {
78         unsigned int            au;                     /* In sectors */
79         unsigned int            erase_timeout;          /* In milliseconds */
80         unsigned int            erase_offset;           /* In milliseconds */
81 };
82
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
97
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
113
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)
118 };
119
120 struct sdio_cccr {
121         unsigned int            sdio_vsn;
122         unsigned int            sd_vsn;
123         unsigned int            multi_block:1,
124                                 low_speed:1,
125                                 wide_bus:1,
126                                 high_power:1,
127                                 high_speed:1,
128                                 disable_cd:1;
129 };
130
131 struct sdio_cis {
132         unsigned short          vendor;
133         unsigned short          device;
134         unsigned short          blksize;
135         unsigned int            max_dtr;
136 };
137
138 struct mmc_host;
139 struct sdio_func;
140 struct sdio_func_tuple;
141
142 #define SDIO_MAX_FUNCS          7
143
144 /*
145  * MMC device
146  */
147 struct mmc_card {
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 */
167                                                 /* for byte mode */
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 */
174
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 */
179
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 */
189
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         struct sdio_func        *sdio_single_irq; /* SDIO function when only one IRQ active */
195         unsigned                num_info;       /* number of info strings */
196         const char              **info;         /* info strings */
197         struct sdio_func_tuple  *tuples;        /* unknown common tuples */
198
199         unsigned int            sd_bus_speed;   /* Bus Speed Mode set for the card */
200
201         struct dentry           *debugfs_root;
202 };
203
204 /*
205  *  The world is not perfect and supplies us with broken mmc/sdio devices.
206  *  For at least some of these bugs we need a work-around.
207  */
208
209 struct mmc_fixup {
210         /* CID-specific fields. */
211         const char *name;
212
213         /* Valid revision range */
214         u64 rev_start, rev_end;
215
216         unsigned int manfid;
217         unsigned short oemid;
218
219         /* SDIO-specfic fields. You can use SDIO_ANY_ID here of course */
220         u16 cis_vendor, cis_device;
221
222         void (*vendor_fixup)(struct mmc_card *card, int data);
223         int data;
224 };
225
226 #define CID_MANFID_ANY (-1u)
227 #define CID_OEMID_ANY ((unsigned short) -1)
228 #define CID_NAME_ANY (NULL)
229
230 #define END_FIXUP { 0 }
231
232 #define _FIXUP_EXT(_name, _manfid, _oemid, _rev_start, _rev_end,        \
233                    _cis_vendor, _cis_device,                            \
234                    _fixup, _data)                                       \
235         {                                                  \
236                 .name = (_name),                           \
237                 .manfid = (_manfid),                       \
238                 .oemid = (_oemid),                         \
239                 .rev_start = (_rev_start),                 \
240                 .rev_end = (_rev_end),                     \
241                 .cis_vendor = (_cis_vendor),               \
242                 .cis_device = (_cis_device),               \
243                 .vendor_fixup = (_fixup),                  \
244                 .data = (_data),                           \
245          }
246
247 #define MMC_FIXUP_REV(_name, _manfid, _oemid, _rev_start, _rev_end,     \
248                       _fixup, _data)                                    \
249         _FIXUP_EXT(_name, _manfid,                                      \
250                    _oemid, _rev_start, _rev_end,                        \
251                    SDIO_ANY_ID, SDIO_ANY_ID,                            \
252                    _fixup, _data)                                       \
253
254 #define MMC_FIXUP(_name, _manfid, _oemid, _fixup, _data) \
255         MMC_FIXUP_REV(_name, _manfid, _oemid, 0, -1ull, _fixup, _data)
256
257 #define SDIO_FIXUP(_vendor, _device, _fixup, _data)                     \
258         _FIXUP_EXT(CID_NAME_ANY, CID_MANFID_ANY,                        \
259                     CID_OEMID_ANY, 0, -1ull,                            \
260                    _vendor, _device,                                    \
261                    _fixup, _data)                                       \
262
263 #define cid_rev(hwrev, fwrev, year, month)      \
264         (((u64) hwrev) << 40 |                  \
265          ((u64) fwrev) << 32 |                  \
266          ((u64) year) << 16 |                   \
267          ((u64) month))
268
269 #define cid_rev_card(card)                \
270         cid_rev(card->cid.hwrev,          \
271                     card->cid.fwrev,      \
272                     card->cid.year,       \
273                     card->cid.month)
274
275 /*
276  * Unconditionally quirk add/remove.
277  */
278
279 static inline void __maybe_unused add_quirk(struct mmc_card *card, int data)
280 {
281         card->quirks |= data;
282 }
283
284 static inline void __maybe_unused remove_quirk(struct mmc_card *card, int data)
285 {
286         card->quirks &= ~data;
287 }
288
289 #define mmc_card_mmc(c)         ((c)->type == MMC_TYPE_MMC)
290 #define mmc_card_sd(c)          ((c)->type == MMC_TYPE_SD)
291 #define mmc_card_sdio(c)        ((c)->type == MMC_TYPE_SDIO)
292
293 #define mmc_card_present(c)     ((c)->state & MMC_STATE_PRESENT)
294 #define mmc_card_readonly(c)    ((c)->state & MMC_STATE_READONLY)
295 #define mmc_card_highspeed(c)   ((c)->state & MMC_STATE_HIGHSPEED)
296 #define mmc_card_blockaddr(c)   ((c)->state & MMC_STATE_BLOCKADDR)
297 #define mmc_card_ddr_mode(c)    ((c)->state & MMC_STATE_HIGHSPEED_DDR)
298 #define mmc_sd_card_uhs(c) ((c)->state & MMC_STATE_ULTRAHIGHSPEED)
299 #define mmc_card_ext_capacity(c) ((c)->state & MMC_CARD_SDXC)
300
301 #define mmc_card_set_present(c) ((c)->state |= MMC_STATE_PRESENT)
302 #define mmc_card_set_readonly(c) ((c)->state |= MMC_STATE_READONLY)
303 #define mmc_card_set_highspeed(c) ((c)->state |= MMC_STATE_HIGHSPEED)
304 #define mmc_card_set_blockaddr(c) ((c)->state |= MMC_STATE_BLOCKADDR)
305 #define mmc_card_set_ddr_mode(c) ((c)->state |= MMC_STATE_HIGHSPEED_DDR)
306 #define mmc_sd_card_set_uhs(c) ((c)->state |= MMC_STATE_ULTRAHIGHSPEED)
307 #define mmc_card_set_ext_capacity(c) ((c)->state |= MMC_CARD_SDXC)
308
309 /*
310  * Quirk add/remove for MMC products.
311  */
312
313 static inline void __maybe_unused add_quirk_mmc(struct mmc_card *card, int data)
314 {
315         if (mmc_card_mmc(card))
316                 card->quirks |= data;
317 }
318
319 static inline void __maybe_unused remove_quirk_mmc(struct mmc_card *card,
320                                                    int data)
321 {
322         if (mmc_card_mmc(card))
323                 card->quirks &= ~data;
324 }
325
326 /*
327  * Quirk add/remove for SD products.
328  */
329
330 static inline void __maybe_unused add_quirk_sd(struct mmc_card *card, int data)
331 {
332         if (mmc_card_sd(card))
333                 card->quirks |= data;
334 }
335
336 static inline void __maybe_unused remove_quirk_sd(struct mmc_card *card,
337                                                    int data)
338 {
339         if (mmc_card_sd(card))
340                 card->quirks &= ~data;
341 }
342
343 static inline int mmc_card_lenient_fn0(const struct mmc_card *c)
344 {
345         return c->quirks & MMC_QUIRK_LENIENT_FN0;
346 }
347
348 static inline int mmc_blksz_for_byte_mode(const struct mmc_card *c)
349 {
350         return c->quirks & MMC_QUIRK_BLKSZ_FOR_BYTE_MODE;
351 }
352
353 static inline int mmc_card_disable_cd(const struct mmc_card *c)
354 {
355         return c->quirks & MMC_QUIRK_DISABLE_CD;
356 }
357
358 static inline int mmc_card_nonstd_func_interface(const struct mmc_card *c)
359 {
360         return c->quirks & MMC_QUIRK_NONSTD_FUNC_IF;
361 }
362
363 #define mmc_card_name(c)        ((c)->cid.prod_name)
364 #define mmc_card_id(c)          (dev_name(&(c)->dev))
365
366 #define mmc_dev_to_card(d)      container_of(d, struct mmc_card, dev)
367
368 #define mmc_list_to_card(l)     container_of(l, struct mmc_card, node)
369 #define mmc_get_drvdata(c)      dev_get_drvdata(&(c)->dev)
370 #define mmc_set_drvdata(c,d)    dev_set_drvdata(&(c)->dev, d)
371
372 /*
373  * MMC device driver (e.g., Flash card, I/O card...)
374  */
375 struct mmc_driver {
376         struct device_driver drv;
377         int (*probe)(struct mmc_card *);
378         void (*remove)(struct mmc_card *);
379         int (*suspend)(struct mmc_card *, pm_message_t);
380         int (*resume)(struct mmc_card *);
381 };
382
383 extern int mmc_register_driver(struct mmc_driver *);
384 extern void mmc_unregister_driver(struct mmc_driver *);
385
386 extern void mmc_fixup_device(struct mmc_card *card,
387                              const struct mmc_fixup *table);
388
389 #endif