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