mmc: core: Add quirk for long data read time
[linux-2.6.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         u8                      cache_ctrl;
54         u8                      rst_n_function;
55         unsigned int            part_time;              /* Units: ms */
56         unsigned int            sa_timeout;             /* Units: 100ns */
57         unsigned int            generic_cmd6_time;      /* Units: 10ms */
58         unsigned int            power_off_longtime;     /* Units: ms */
59         unsigned int            hs_max_dtr;
60         unsigned int            sectors;
61         unsigned int            card_type;
62         unsigned int            hc_erase_size;          /* In sectors */
63         unsigned int            hc_erase_timeout;       /* In milliseconds */
64         unsigned int            sec_trim_mult;  /* Secure trim multiplier  */
65         unsigned int            sec_erase_mult; /* Secure erase multiplier */
66         unsigned int            trim_timeout;           /* In milliseconds */
67         bool                    enhanced_area_en;       /* enable bit */
68         unsigned long long      enhanced_area_offset;   /* Units: Byte */
69         unsigned int            enhanced_area_size;     /* Units: KB */
70         unsigned int            cache_size;             /* Units: KB */
71         bool                    hpi_en;                 /* HPI enablebit */
72         bool                    hpi;                    /* HPI support bit */
73         unsigned int            hpi_cmd;                /* cmd used as HPI */
74         u8                      raw_partition_support;  /* 160 */
75         u8                      raw_erased_mem_count;   /* 181 */
76         u8                      raw_ext_csd_structure;  /* 194 */
77         u8                      raw_card_type;          /* 196 */
78         u8                      out_of_int_time;        /* 198 */
79         u8                      raw_s_a_timeout;                /* 217 */
80         u8                      raw_hc_erase_gap_size;  /* 221 */
81         u8                      raw_erase_timeout_mult; /* 223 */
82         u8                      raw_hc_erase_grp_size;  /* 224 */
83         u8                      raw_sec_trim_mult;      /* 229 */
84         u8                      raw_sec_erase_mult;     /* 230 */
85         u8                      raw_sec_feature_support;/* 231 */
86         u8                      raw_trim_mult;          /* 232 */
87         u8                      raw_sectors[4];         /* 212 - 4 bytes */
88
89         unsigned int            feature_support;
90 #define MMC_DISCARD_FEATURE     BIT(0)                  /* CMD38 feature */
91 };
92
93 struct sd_scr {
94         unsigned char           sda_vsn;
95         unsigned char           sda_spec3;
96         unsigned char           bus_widths;
97 #define SD_SCR_BUS_WIDTH_1      (1<<0)
98 #define SD_SCR_BUS_WIDTH_4      (1<<2)
99         unsigned char           cmds;
100 #define SD_SCR_CMD20_SUPPORT   (1<<0)
101 #define SD_SCR_CMD23_SUPPORT   (1<<1)
102 };
103
104 struct sd_ssr {
105         unsigned int            au;                     /* In sectors */
106         unsigned int            erase_timeout;          /* In milliseconds */
107         unsigned int            erase_offset;           /* In milliseconds */
108 };
109
110 struct sd_switch_caps {
111         unsigned int            hs_max_dtr;
112         unsigned int            uhs_max_dtr;
113 #define UHS_SDR104_MAX_DTR      208000000
114 #define UHS_SDR50_MAX_DTR       100000000
115 #define UHS_DDR50_MAX_DTR       50000000
116 #define UHS_SDR25_MAX_DTR       UHS_DDR50_MAX_DTR
117 #define UHS_SDR12_MAX_DTR       25000000
118         unsigned int            sd3_bus_mode;
119 #define UHS_SDR12_BUS_SPEED     0
120 #define UHS_SDR25_BUS_SPEED     1
121 #define UHS_SDR50_BUS_SPEED     2
122 #define UHS_SDR104_BUS_SPEED    3
123 #define UHS_DDR50_BUS_SPEED     4
124
125 #define SD_MODE_UHS_SDR12       (1 << UHS_SDR12_BUS_SPEED)
126 #define SD_MODE_UHS_SDR25       (1 << UHS_SDR25_BUS_SPEED)
127 #define SD_MODE_UHS_SDR50       (1 << UHS_SDR50_BUS_SPEED)
128 #define SD_MODE_UHS_SDR104      (1 << UHS_SDR104_BUS_SPEED)
129 #define SD_MODE_UHS_DDR50       (1 << UHS_DDR50_BUS_SPEED)
130         unsigned int            sd3_drv_type;
131 #define SD_DRIVER_TYPE_B        0x01
132 #define SD_DRIVER_TYPE_A        0x02
133 #define SD_DRIVER_TYPE_C        0x04
134 #define SD_DRIVER_TYPE_D        0x08
135         unsigned int            sd3_curr_limit;
136 #define SD_SET_CURRENT_LIMIT_200        0
137 #define SD_SET_CURRENT_LIMIT_400        1
138 #define SD_SET_CURRENT_LIMIT_600        2
139 #define SD_SET_CURRENT_LIMIT_800        3
140
141 #define SD_MAX_CURRENT_200      (1 << SD_SET_CURRENT_LIMIT_200)
142 #define SD_MAX_CURRENT_400      (1 << SD_SET_CURRENT_LIMIT_400)
143 #define SD_MAX_CURRENT_600      (1 << SD_SET_CURRENT_LIMIT_600)
144 #define SD_MAX_CURRENT_800      (1 << SD_SET_CURRENT_LIMIT_800)
145 };
146
147 struct sdio_cccr {
148         unsigned int            sdio_vsn;
149         unsigned int            sd_vsn;
150         unsigned int            multi_block:1,
151                                 low_speed:1,
152                                 wide_bus:1,
153                                 high_power:1,
154                                 high_speed:1,
155                                 disable_cd:1;
156 };
157
158 struct sdio_cis {
159         unsigned short          vendor;
160         unsigned short          device;
161         unsigned short          blksize;
162         unsigned int            max_dtr;
163 };
164
165 struct mmc_host;
166 struct sdio_func;
167 struct sdio_func_tuple;
168
169 #define SDIO_MAX_FUNCS          7
170
171 /* The number of MMC physical partitions.  These consist of:
172  * boot partitions (2), general purpose partitions (4) in MMC v4.4.
173  */
174 #define MMC_NUM_BOOT_PARTITION  2
175 #define MMC_NUM_GP_PARTITION    4
176 #define MMC_NUM_PHY_PARTITION   6
177 #define MAX_MMC_PART_NAME_LEN   20
178
179 /*
180  * MMC Physical partitions
181  */
182 struct mmc_part {
183         unsigned int    size;   /* partition size (in bytes) */
184         unsigned int    part_cfg;       /* partition type */
185         char    name[MAX_MMC_PART_NAME_LEN];
186         bool    force_ro;       /* to make boot parts RO by default */
187 };
188
189 /*
190  * MMC device
191  */
192 struct mmc_card {
193         struct mmc_host         *host;          /* the host this device belongs to */
194         struct device           dev;            /* the device */
195         unsigned int            rca;            /* relative card address of device */
196         unsigned int            type;           /* card type */
197 #define MMC_TYPE_MMC            0               /* MMC card */
198 #define MMC_TYPE_SD             1               /* SD card */
199 #define MMC_TYPE_SDIO           2               /* SDIO card */
200 #define MMC_TYPE_SD_COMBO       3               /* SD combo (IO+mem) card */
201         unsigned int            state;          /* (our) card state */
202 #define MMC_STATE_PRESENT       (1<<0)          /* present in sysfs */
203 #define MMC_STATE_READONLY      (1<<1)          /* card is read-only */
204 #define MMC_STATE_HIGHSPEED     (1<<2)          /* card is in high speed mode */
205 #define MMC_STATE_BLOCKADDR     (1<<3)          /* card uses block-addressing */
206 #define MMC_STATE_HIGHSPEED_DDR (1<<4)          /* card is in high speed mode */
207 #define MMC_STATE_ULTRAHIGHSPEED (1<<5)         /* card is in ultra high speed mode */
208 #define MMC_CARD_SDXC           (1<<6)          /* card is SDXC */
209         unsigned int            quirks;         /* card quirks */
210 #define MMC_QUIRK_LENIENT_FN0   (1<<0)          /* allow SDIO FN0 writes outside of the VS CCCR range */
211 #define MMC_QUIRK_BLKSZ_FOR_BYTE_MODE (1<<1)    /* use func->cur_blksize */
212                                                 /* for byte mode */
213 #define MMC_QUIRK_NONSTD_SDIO   (1<<2)          /* non-standard SDIO card attached */
214                                                 /* (missing CIA registers) */
215 #define MMC_QUIRK_BROKEN_CLK_GATING (1<<3)      /* clock gating the sdio bus will make card fail */
216 #define MMC_QUIRK_NONSTD_FUNC_IF (1<<4)         /* SDIO card has nonstd function interfaces */
217 #define MMC_QUIRK_DISABLE_CD    (1<<5)          /* disconnect CD/DAT[3] resistor */
218 #define MMC_QUIRK_INAND_CMD38   (1<<6)          /* iNAND devices have broken CMD38 */
219 #define MMC_QUIRK_BLK_NO_CMD23  (1<<7)          /* Avoid CMD23 for regular multiblock */
220 #define MMC_QUIRK_BROKEN_BYTE_MODE_512 (1<<8)   /* Avoid sending 512 bytes in */
221 #define MMC_QUIRK_LONG_READ_TIME (1<<9)         /* Data read time > CSD says */
222                                                 /* byte mode */
223         unsigned int    poweroff_notify_state;  /* eMMC4.5 notify feature */
224 #define MMC_NO_POWER_NOTIFICATION       0
225 #define MMC_POWERED_ON                  1
226 #define MMC_POWEROFF_SHORT              2
227 #define MMC_POWEROFF_LONG               3
228
229         unsigned int            erase_size;     /* erase size in sectors */
230         unsigned int            erase_shift;    /* if erase unit is power 2 */
231         unsigned int            pref_erase;     /* in sectors */
232         u8                      erased_byte;    /* value of erased bytes */
233
234         u32                     raw_cid[4];     /* raw card CID */
235         u32                     raw_csd[4];     /* raw card CSD */
236         u32                     raw_scr[2];     /* raw card SCR */
237         struct mmc_cid          cid;            /* card identification */
238         struct mmc_csd          csd;            /* card specific */
239         struct mmc_ext_csd      ext_csd;        /* mmc v4 extended card specific */
240         struct sd_scr           scr;            /* extra SD information */
241         struct sd_ssr           ssr;            /* yet more SD information */
242         struct sd_switch_caps   sw_caps;        /* switch (CMD6) caps */
243
244         unsigned int            sdio_funcs;     /* number of SDIO functions */
245         struct sdio_cccr        cccr;           /* common card info */
246         struct sdio_cis         cis;            /* common tuple info */
247         struct sdio_func        *sdio_func[SDIO_MAX_FUNCS]; /* SDIO functions (devices) */
248         struct sdio_func        *sdio_single_irq; /* SDIO function when only one IRQ active */
249         unsigned                num_info;       /* number of info strings */
250         const char              **info;         /* info strings */
251         struct sdio_func_tuple  *tuples;        /* unknown common tuples */
252
253         unsigned int            sd_bus_speed;   /* Bus Speed Mode set for the card */
254
255         struct dentry           *debugfs_root;
256         struct mmc_part part[MMC_NUM_PHY_PARTITION]; /* physical partitions */
257         unsigned int    nr_parts;
258 };
259
260 /*
261  * This function fill contents in mmc_part.
262  */
263 static inline void mmc_part_add(struct mmc_card *card, unsigned int size,
264                         unsigned int part_cfg, char *name, int idx, bool ro)
265 {
266         card->part[card->nr_parts].size = size;
267         card->part[card->nr_parts].part_cfg = part_cfg;
268         sprintf(card->part[card->nr_parts].name, name, idx);
269         card->part[card->nr_parts].force_ro = ro;
270         card->nr_parts++;
271 }
272
273 /*
274  *  The world is not perfect and supplies us with broken mmc/sdio devices.
275  *  For at least some of these bugs we need a work-around.
276  */
277
278 struct mmc_fixup {
279         /* CID-specific fields. */
280         const char *name;
281
282         /* Valid revision range */
283         u64 rev_start, rev_end;
284
285         unsigned int manfid;
286         unsigned short oemid;
287
288         /* SDIO-specfic fields. You can use SDIO_ANY_ID here of course */
289         u16 cis_vendor, cis_device;
290
291         void (*vendor_fixup)(struct mmc_card *card, int data);
292         int data;
293 };
294
295 #define CID_MANFID_ANY (-1u)
296 #define CID_OEMID_ANY ((unsigned short) -1)
297 #define CID_NAME_ANY (NULL)
298
299 #define END_FIXUP { 0 }
300
301 #define _FIXUP_EXT(_name, _manfid, _oemid, _rev_start, _rev_end,        \
302                    _cis_vendor, _cis_device,                            \
303                    _fixup, _data)                                       \
304         {                                                  \
305                 .name = (_name),                           \
306                 .manfid = (_manfid),                       \
307                 .oemid = (_oemid),                         \
308                 .rev_start = (_rev_start),                 \
309                 .rev_end = (_rev_end),                     \
310                 .cis_vendor = (_cis_vendor),               \
311                 .cis_device = (_cis_device),               \
312                 .vendor_fixup = (_fixup),                  \
313                 .data = (_data),                           \
314          }
315
316 #define MMC_FIXUP_REV(_name, _manfid, _oemid, _rev_start, _rev_end,     \
317                       _fixup, _data)                                    \
318         _FIXUP_EXT(_name, _manfid,                                      \
319                    _oemid, _rev_start, _rev_end,                        \
320                    SDIO_ANY_ID, SDIO_ANY_ID,                            \
321                    _fixup, _data)                                       \
322
323 #define MMC_FIXUP(_name, _manfid, _oemid, _fixup, _data) \
324         MMC_FIXUP_REV(_name, _manfid, _oemid, 0, -1ull, _fixup, _data)
325
326 #define SDIO_FIXUP(_vendor, _device, _fixup, _data)                     \
327         _FIXUP_EXT(CID_NAME_ANY, CID_MANFID_ANY,                        \
328                     CID_OEMID_ANY, 0, -1ull,                            \
329                    _vendor, _device,                                    \
330                    _fixup, _data)                                       \
331
332 #define cid_rev(hwrev, fwrev, year, month)      \
333         (((u64) hwrev) << 40 |                  \
334          ((u64) fwrev) << 32 |                  \
335          ((u64) year) << 16 |                   \
336          ((u64) month))
337
338 #define cid_rev_card(card)                \
339         cid_rev(card->cid.hwrev,          \
340                     card->cid.fwrev,      \
341                     card->cid.year,       \
342                     card->cid.month)
343
344 /*
345  * Unconditionally quirk add/remove.
346  */
347
348 static inline void __maybe_unused add_quirk(struct mmc_card *card, int data)
349 {
350         card->quirks |= data;
351 }
352
353 static inline void __maybe_unused remove_quirk(struct mmc_card *card, int data)
354 {
355         card->quirks &= ~data;
356 }
357
358 #define mmc_card_mmc(c)         ((c)->type == MMC_TYPE_MMC)
359 #define mmc_card_sd(c)          ((c)->type == MMC_TYPE_SD)
360 #define mmc_card_sdio(c)        ((c)->type == MMC_TYPE_SDIO)
361
362 #define mmc_card_present(c)     ((c)->state & MMC_STATE_PRESENT)
363 #define mmc_card_readonly(c)    ((c)->state & MMC_STATE_READONLY)
364 #define mmc_card_highspeed(c)   ((c)->state & MMC_STATE_HIGHSPEED)
365 #define mmc_card_blockaddr(c)   ((c)->state & MMC_STATE_BLOCKADDR)
366 #define mmc_card_ddr_mode(c)    ((c)->state & MMC_STATE_HIGHSPEED_DDR)
367 #define mmc_sd_card_uhs(c) ((c)->state & MMC_STATE_ULTRAHIGHSPEED)
368 #define mmc_card_ext_capacity(c) ((c)->state & MMC_CARD_SDXC)
369
370 #define mmc_card_set_present(c) ((c)->state |= MMC_STATE_PRESENT)
371 #define mmc_card_set_readonly(c) ((c)->state |= MMC_STATE_READONLY)
372 #define mmc_card_set_highspeed(c) ((c)->state |= MMC_STATE_HIGHSPEED)
373 #define mmc_card_set_blockaddr(c) ((c)->state |= MMC_STATE_BLOCKADDR)
374 #define mmc_card_set_ddr_mode(c) ((c)->state |= MMC_STATE_HIGHSPEED_DDR)
375 #define mmc_sd_card_set_uhs(c) ((c)->state |= MMC_STATE_ULTRAHIGHSPEED)
376 #define mmc_card_set_ext_capacity(c) ((c)->state |= MMC_CARD_SDXC)
377
378 /*
379  * Quirk add/remove for MMC products.
380  */
381
382 static inline void __maybe_unused add_quirk_mmc(struct mmc_card *card, int data)
383 {
384         if (mmc_card_mmc(card))
385                 card->quirks |= data;
386 }
387
388 static inline void __maybe_unused remove_quirk_mmc(struct mmc_card *card,
389                                                    int data)
390 {
391         if (mmc_card_mmc(card))
392                 card->quirks &= ~data;
393 }
394
395 /*
396  * Quirk add/remove for SD products.
397  */
398
399 static inline void __maybe_unused add_quirk_sd(struct mmc_card *card, int data)
400 {
401         if (mmc_card_sd(card))
402                 card->quirks |= data;
403 }
404
405 static inline void __maybe_unused remove_quirk_sd(struct mmc_card *card,
406                                                    int data)
407 {
408         if (mmc_card_sd(card))
409                 card->quirks &= ~data;
410 }
411
412 static inline int mmc_card_lenient_fn0(const struct mmc_card *c)
413 {
414         return c->quirks & MMC_QUIRK_LENIENT_FN0;
415 }
416
417 static inline int mmc_blksz_for_byte_mode(const struct mmc_card *c)
418 {
419         return c->quirks & MMC_QUIRK_BLKSZ_FOR_BYTE_MODE;
420 }
421
422 static inline int mmc_card_disable_cd(const struct mmc_card *c)
423 {
424         return c->quirks & MMC_QUIRK_DISABLE_CD;
425 }
426
427 static inline int mmc_card_nonstd_func_interface(const struct mmc_card *c)
428 {
429         return c->quirks & MMC_QUIRK_NONSTD_FUNC_IF;
430 }
431
432 static inline int mmc_card_broken_byte_mode_512(const struct mmc_card *c)
433 {
434         return c->quirks & MMC_QUIRK_BROKEN_BYTE_MODE_512;
435 }
436
437 static inline int mmc_card_long_read_time(const struct mmc_card *c)
438 {
439         return c->quirks & MMC_QUIRK_LONG_READ_TIME;
440 }
441
442 #define mmc_card_name(c)        ((c)->cid.prod_name)
443 #define mmc_card_id(c)          (dev_name(&(c)->dev))
444
445 #define mmc_dev_to_card(d)      container_of(d, struct mmc_card, dev)
446
447 #define mmc_list_to_card(l)     container_of(l, struct mmc_card, node)
448 #define mmc_get_drvdata(c)      dev_get_drvdata(&(c)->dev)
449 #define mmc_set_drvdata(c,d)    dev_set_drvdata(&(c)->dev, d)
450
451 /*
452  * MMC device driver (e.g., Flash card, I/O card...)
453  */
454 struct mmc_driver {
455         struct device_driver drv;
456         int (*probe)(struct mmc_card *);
457         void (*remove)(struct mmc_card *);
458         int (*suspend)(struct mmc_card *, pm_message_t);
459         int (*resume)(struct mmc_card *);
460 };
461
462 extern int mmc_register_driver(struct mmc_driver *);
463 extern void mmc_unregister_driver(struct mmc_driver *);
464
465 extern void mmc_fixup_device(struct mmc_card *card,
466                              const struct mmc_fixup *table);
467
468 #endif /* LINUX_MMC_CARD_H */