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/device.h>
14 #include <linux/mmc/core.h>
15 #include <linux/mod_devicetable.h>
16
17 struct mmc_cid {
18 unsigned int manfid;
19 char prod_name[8];
20 unsigned char prv;
21 unsigned int serial;
22 unsigned short oemid;
23 unsigned short year;
24 unsigned char hwrev;
25 unsigned char fwrev;
26 unsigned char month;
27 };
28
29 struct mmc_csd {
30 unsigned char structure;
31 unsigned char mmca_vsn;
32 unsigned short cmdclass;
33 unsigned short tacc_clks;
34 unsigned int tacc_ns;
35 unsigned int c_size;
36 unsigned int r2w_factor;
37 unsigned int max_dtr;
38 unsigned int erase_size; /* In sectors */
39 unsigned int read_blkbits;
40 unsigned int write_blkbits;
41 unsigned int capacity;
42 unsigned int read_partial:1,
43 read_misalign:1,
44 write_partial:1,
45 write_misalign:1,
46 dsr_imp:1;
47 };
48
49 struct mmc_ext_csd {
50 u8 rev;
51 u8 erase_group_def;
52 u8 sec_feature_support;
53 u8 rel_sectors;
54 u8 rel_param;
55 u8 part_config;
56 u8 cache_ctrl;
57 u8 rst_n_function;
58 u8 max_packed_writes;
59 u8 max_packed_reads;
60 u8 packed_event_en;
61 unsigned int part_time; /* Units: ms */
62 unsigned int sa_timeout; /* Units: 100ns */
63 unsigned int generic_cmd6_time; /* Units: 10ms */
64 unsigned int power_off_longtime; /* Units: ms */
65 u8 power_off_notification; /* state */
66 unsigned int hs_max_dtr;
67 unsigned int hs200_max_dtr;
68 #define MMC_HIGH_26_MAX_DTR 26000000
69 #define MMC_HIGH_52_MAX_DTR 52000000
70 #define MMC_HIGH_DDR_MAX_DTR 52000000
71 #define MMC_HS200_MAX_DTR 200000000
72 unsigned int sectors;
73 unsigned int hc_erase_size; /* In sectors */
74 unsigned int hc_erase_timeout; /* In milliseconds */
75 unsigned int sec_trim_mult; /* Secure trim multiplier */
76 unsigned int sec_erase_mult; /* Secure erase multiplier */
77 unsigned int trim_timeout; /* In milliseconds */
78 bool partition_setting_completed; /* enable bit */
79 unsigned long long enhanced_area_offset; /* Units: Byte */
80 unsigned int enhanced_area_size; /* Units: KB */
81 unsigned int cache_size; /* Units: KB */
82 bool hpi_en; /* HPI enablebit */
83 bool hpi; /* HPI support bit */
84 unsigned int hpi_cmd; /* cmd used as HPI */
85 bool bkops; /* background support bit */
86 bool man_bkops_en; /* manual bkops enable bit */
87 unsigned int data_sector_size; /* 512 bytes or 4KB */
88 unsigned int data_tag_unit_size; /* DATA TAG UNIT size */
89 unsigned int boot_ro_lock; /* ro lock support */
90 bool boot_ro_lockable;
91 bool ffu_capable; /* Firmware upgrade support */
92 #define MMC_FIRMWARE_LEN 8
93 u8 fwrev[MMC_FIRMWARE_LEN]; /* FW version */
94 u8 raw_exception_status; /* 54 */
95 u8 raw_partition_support; /* 160 */
96 u8 raw_rpmb_size_mult; /* 168 */
97 u8 raw_erased_mem_count; /* 181 */
98 u8 raw_ext_csd_structure; /* 194 */
99 u8 raw_card_type; /* 196 */
100 u8 out_of_int_time; /* 198 */
101 u8 raw_pwr_cl_52_195; /* 200 */
102 u8 raw_pwr_cl_26_195; /* 201 */
103 u8 raw_pwr_cl_52_360; /* 202 */
104 u8 raw_pwr_cl_26_360; /* 203 */
105 u8 raw_s_a_timeout; /* 217 */
106 u8 raw_hc_erase_gap_size; /* 221 */
107 u8 raw_erase_timeout_mult; /* 223 */
108 u8 raw_hc_erase_grp_size; /* 224 */
109 u8 raw_sec_trim_mult; /* 229 */
110 u8 raw_sec_erase_mult; /* 230 */
111 u8 raw_sec_feature_support;/* 231 */
112 u8 raw_trim_mult; /* 232 */
113 u8 raw_pwr_cl_200_195; /* 236 */
114 u8 raw_pwr_cl_200_360; /* 237 */
115 u8 raw_pwr_cl_ddr_52_195; /* 238 */
116 u8 raw_pwr_cl_ddr_52_360; /* 239 */
117 u8 raw_pwr_cl_ddr_200_360; /* 253 */
118 u8 raw_bkops_status; /* 246 */
119 u8 raw_sectors[4]; /* 212 - 4 bytes */
120
121 unsigned int feature_support;
122 #define MMC_DISCARD_FEATURE BIT(0) /* CMD38 feature */
123 };
124
125 struct sd_scr {
126 unsigned char sda_vsn;
127 unsigned char sda_spec3;
128 unsigned char bus_widths;
129 #define SD_SCR_BUS_WIDTH_1 (1<<0)
130 #define SD_SCR_BUS_WIDTH_4 (1<<2)
131 unsigned char cmds;
132 #define SD_SCR_CMD20_SUPPORT (1<<0)
133 #define SD_SCR_CMD23_SUPPORT (1<<1)
134 };
135
136 struct sd_ssr {
137 unsigned int au; /* In sectors */
138 unsigned int erase_timeout; /* In milliseconds */
139 unsigned int erase_offset; /* In milliseconds */
140 };
141
142 struct sd_switch_caps {
143 unsigned int hs_max_dtr;
144 unsigned int uhs_max_dtr;
145 #define HIGH_SPEED_MAX_DTR 50000000
146 #define UHS_SDR104_MAX_DTR 208000000
147 #define UHS_SDR50_MAX_DTR 100000000
148 #define UHS_DDR50_MAX_DTR 50000000
149 #define UHS_SDR25_MAX_DTR UHS_DDR50_MAX_DTR
150 #define UHS_SDR12_MAX_DTR 25000000
151 unsigned int sd3_bus_mode;
152 #define UHS_SDR12_BUS_SPEED 0
153 #define HIGH_SPEED_BUS_SPEED 1
154 #define UHS_SDR25_BUS_SPEED 1
155 #define UHS_SDR50_BUS_SPEED 2
156 #define UHS_SDR104_BUS_SPEED 3
157 #define UHS_DDR50_BUS_SPEED 4
158
159 #define SD_MODE_HIGH_SPEED (1 << HIGH_SPEED_BUS_SPEED)
160 #define SD_MODE_UHS_SDR12 (1 << UHS_SDR12_BUS_SPEED)
161 #define SD_MODE_UHS_SDR25 (1 << UHS_SDR25_BUS_SPEED)
162 #define SD_MODE_UHS_SDR50 (1 << UHS_SDR50_BUS_SPEED)
163 #define SD_MODE_UHS_SDR104 (1 << UHS_SDR104_BUS_SPEED)
164 #define SD_MODE_UHS_DDR50 (1 << UHS_DDR50_BUS_SPEED)
165 unsigned int sd3_drv_type;
166 #define SD_DRIVER_TYPE_B 0x01
167 #define SD_DRIVER_TYPE_A 0x02
168 #define SD_DRIVER_TYPE_C 0x04
169 #define SD_DRIVER_TYPE_D 0x08
170 unsigned int sd3_curr_limit;
171 #define SD_SET_CURRENT_LIMIT_200 0
172 #define SD_SET_CURRENT_LIMIT_400 1
173 #define SD_SET_CURRENT_LIMIT_600 2
174 #define SD_SET_CURRENT_LIMIT_800 3
175 #define SD_SET_CURRENT_NO_CHANGE (-1)
176
177 #define SD_MAX_CURRENT_200 (1 << SD_SET_CURRENT_LIMIT_200)
178 #define SD_MAX_CURRENT_400 (1 << SD_SET_CURRENT_LIMIT_400)
179 #define SD_MAX_CURRENT_600 (1 << SD_SET_CURRENT_LIMIT_600)
180 #define SD_MAX_CURRENT_800 (1 << SD_SET_CURRENT_LIMIT_800)
181 };
182
183 struct sdio_cccr {
184 unsigned int sdio_vsn;
185 unsigned int sd_vsn;
186 unsigned int multi_block:1,
187 low_speed:1,
188 wide_bus:1,
189 high_power:1,
190 high_speed:1,
191 disable_cd:1;
192 };
193
194 struct sdio_cis {
195 unsigned short vendor;
196 unsigned short device;
197 unsigned short blksize;
198 unsigned int max_dtr;
199 };
200
201 struct mmc_host;
202 struct mmc_ios;
203 struct sdio_func;
204 struct sdio_func_tuple;
205
206 #define SDIO_MAX_FUNCS 7
207
208 enum mmc_blk_status {
209 MMC_BLK_SUCCESS = 0,
210 MMC_BLK_PARTIAL,
211 MMC_BLK_CMD_ERR,
212 MMC_BLK_RETRY,
213 MMC_BLK_ABORT,
214 MMC_BLK_DATA_ERR,
215 MMC_BLK_ECC_ERR,
216 MMC_BLK_NOMEDIUM,
217 MMC_BLK_NEW_REQUEST,
218 };
219
220 /* The number of MMC physical partitions. These consist of:
221 * boot partitions (2), general purpose partitions (4) and
222 * RPMB partition (1) in MMC v4.4.
223 */
224 #define MMC_NUM_BOOT_PARTITION 2
225 #define MMC_NUM_GP_PARTITION 4
226 #define MMC_NUM_PHY_PARTITION 7
227 #define MAX_MMC_PART_NAME_LEN 20
228
229 /*
230 * MMC Physical partitions
231 */
232 struct mmc_part {
233 unsigned int size; /* partition size (in bytes) */
234 unsigned int part_cfg; /* partition type */
235 char name[MAX_MMC_PART_NAME_LEN];
236 bool force_ro; /* to make boot parts RO by default */
237 unsigned int area_type;
238 #define MMC_BLK_DATA_AREA_MAIN (1<<0)
239 #define MMC_BLK_DATA_AREA_BOOT (1<<1)
240 #define MMC_BLK_DATA_AREA_GP (1<<2)
241 #define MMC_BLK_DATA_AREA_RPMB (1<<3)
242 };
243
244 /*
245 * MMC device
246 */
247 struct mmc_card {
248 struct mmc_host *host; /* the host this device belongs to */
249 struct device dev; /* the device */
250 u32 ocr; /* the current OCR setting */
251 unsigned int rca; /* relative card address of device */
252 unsigned int type; /* card type */
253 #define MMC_TYPE_MMC 0 /* MMC card */
254 #define MMC_TYPE_SD 1 /* SD card */
255 #define MMC_TYPE_SDIO 2 /* SDIO card */
256 #define MMC_TYPE_SD_COMBO 3 /* SD combo (IO+mem) card */
257 unsigned int state; /* (our) card state */
258 #define MMC_STATE_PRESENT (1<<0) /* present in sysfs */
259 #define MMC_STATE_READONLY (1<<1) /* card is read-only */
260 #define MMC_STATE_BLOCKADDR (1<<2) /* card uses block-addressing */
261 #define MMC_CARD_SDXC (1<<3) /* card is SDXC */
262 #define MMC_CARD_REMOVED (1<<4) /* card has been removed */
263 #define MMC_STATE_DOING_BKOPS (1<<5) /* card is doing BKOPS */
264 #define MMC_STATE_SUSPENDED (1<<6) /* card is suspended */
265 unsigned int quirks; /* card quirks */
266 #define MMC_QUIRK_LENIENT_FN0 (1<<0) /* allow SDIO FN0 writes outside of the VS CCCR range */
267 #define MMC_QUIRK_BLKSZ_FOR_BYTE_MODE (1<<1) /* use func->cur_blksize */
268 /* for byte mode */
269 #define MMC_QUIRK_NONSTD_SDIO (1<<2) /* non-standard SDIO card attached */
270 /* (missing CIA registers) */
271 #define MMC_QUIRK_BROKEN_CLK_GATING (1<<3) /* clock gating the sdio bus will make card fail */
272 #define MMC_QUIRK_NONSTD_FUNC_IF (1<<4) /* SDIO card has nonstd function interfaces */
273 #define MMC_QUIRK_DISABLE_CD (1<<5) /* disconnect CD/DAT[3] resistor */
274 #define MMC_QUIRK_INAND_CMD38 (1<<6) /* iNAND devices have broken CMD38 */
275 #define MMC_QUIRK_BLK_NO_CMD23 (1<<7) /* Avoid CMD23 for regular multiblock */
276 #define MMC_QUIRK_BROKEN_BYTE_MODE_512 (1<<8) /* Avoid sending 512 bytes in */
277 /* byte mode */
278 #define MMC_QUIRK_LONG_READ_TIME (1<<9) /* Data read time > CSD says */
279 #define MMC_QUIRK_SEC_ERASE_TRIM_BROKEN (1<<10) /* Skip secure for erase/trim */
280 #define MMC_QUIRK_BROKEN_IRQ_POLLING (1<<11) /* Polling SDIO_CCCR_INTx could create a fake interrupt */
281
282 unsigned int erase_size; /* erase size in sectors */
283 unsigned int erase_shift; /* if erase unit is power 2 */
284 unsigned int pref_erase; /* in sectors */
285 u8 erased_byte; /* value of erased bytes */
286
287 u32 raw_cid[4]; /* raw card CID */
288 u32 raw_csd[4]; /* raw card CSD */
289 u32 raw_scr[2]; /* raw card SCR */
290 struct mmc_cid cid; /* card identification */
291 struct mmc_csd csd; /* card specific */
292 struct mmc_ext_csd ext_csd; /* mmc v4 extended card specific */
293 struct sd_scr scr; /* extra SD information */
294 struct sd_ssr ssr; /* yet more SD information */
295 struct sd_switch_caps sw_caps; /* switch (CMD6) caps */
296
297 unsigned int sdio_funcs; /* number of SDIO functions */
298 struct sdio_cccr cccr; /* common card info */
299 struct sdio_cis cis; /* common tuple info */
300 struct sdio_func *sdio_func[SDIO_MAX_FUNCS]; /* SDIO functions (devices) */
301 struct sdio_func *sdio_single_irq; /* SDIO function when only one IRQ active */
302 unsigned num_info; /* number of info strings */
303 const char **info; /* info strings */
304 struct sdio_func_tuple *tuples; /* unknown common tuples */
305
306 unsigned int sd_bus_speed; /* Bus Speed Mode set for the card */
307 unsigned int mmc_avail_type; /* supported device type by both host and card */
308
309 struct dentry *debugfs_root;
310 struct mmc_part part[MMC_NUM_PHY_PARTITION]; /* physical partitions */
311 unsigned int nr_parts;
312 };
313
314 /*
315 * This function fill contents in mmc_part.
316 */
mmc_part_add(struct mmc_card * card,unsigned int size,unsigned int part_cfg,char * name,int idx,bool ro,int area_type)317 static inline void mmc_part_add(struct mmc_card *card, unsigned int size,
318 unsigned int part_cfg, char *name, int idx, bool ro,
319 int area_type)
320 {
321 card->part[card->nr_parts].size = size;
322 card->part[card->nr_parts].part_cfg = part_cfg;
323 sprintf(card->part[card->nr_parts].name, name, idx);
324 card->part[card->nr_parts].force_ro = ro;
325 card->part[card->nr_parts].area_type = area_type;
326 card->nr_parts++;
327 }
328
mmc_large_sector(struct mmc_card * card)329 static inline bool mmc_large_sector(struct mmc_card *card)
330 {
331 return card->ext_csd.data_sector_size == 4096;
332 }
333
334 /*
335 * The world is not perfect and supplies us with broken mmc/sdio devices.
336 * For at least some of these bugs we need a work-around.
337 */
338
339 struct mmc_fixup {
340 /* CID-specific fields. */
341 const char *name;
342
343 /* Valid revision range */
344 u64 rev_start, rev_end;
345
346 unsigned int manfid;
347 unsigned short oemid;
348
349 /* SDIO-specfic fields. You can use SDIO_ANY_ID here of course */
350 u16 cis_vendor, cis_device;
351
352 void (*vendor_fixup)(struct mmc_card *card, int data);
353 int data;
354 };
355
356 #define CID_MANFID_ANY (-1u)
357 #define CID_OEMID_ANY ((unsigned short) -1)
358 #define CID_NAME_ANY (NULL)
359
360 #define END_FIXUP { NULL }
361
362 #define _FIXUP_EXT(_name, _manfid, _oemid, _rev_start, _rev_end, \
363 _cis_vendor, _cis_device, \
364 _fixup, _data) \
365 { \
366 .name = (_name), \
367 .manfid = (_manfid), \
368 .oemid = (_oemid), \
369 .rev_start = (_rev_start), \
370 .rev_end = (_rev_end), \
371 .cis_vendor = (_cis_vendor), \
372 .cis_device = (_cis_device), \
373 .vendor_fixup = (_fixup), \
374 .data = (_data), \
375 }
376
377 #define MMC_FIXUP_REV(_name, _manfid, _oemid, _rev_start, _rev_end, \
378 _fixup, _data) \
379 _FIXUP_EXT(_name, _manfid, \
380 _oemid, _rev_start, _rev_end, \
381 SDIO_ANY_ID, SDIO_ANY_ID, \
382 _fixup, _data) \
383
384 #define MMC_FIXUP(_name, _manfid, _oemid, _fixup, _data) \
385 MMC_FIXUP_REV(_name, _manfid, _oemid, 0, -1ull, _fixup, _data)
386
387 #define SDIO_FIXUP(_vendor, _device, _fixup, _data) \
388 _FIXUP_EXT(CID_NAME_ANY, CID_MANFID_ANY, \
389 CID_OEMID_ANY, 0, -1ull, \
390 _vendor, _device, \
391 _fixup, _data) \
392
393 #define cid_rev(hwrev, fwrev, year, month) \
394 (((u64) hwrev) << 40 | \
395 ((u64) fwrev) << 32 | \
396 ((u64) year) << 16 | \
397 ((u64) month))
398
399 #define cid_rev_card(card) \
400 cid_rev(card->cid.hwrev, \
401 card->cid.fwrev, \
402 card->cid.year, \
403 card->cid.month)
404
405 /*
406 * Unconditionally quirk add/remove.
407 */
408
add_quirk(struct mmc_card * card,int data)409 static inline void __maybe_unused add_quirk(struct mmc_card *card, int data)
410 {
411 card->quirks |= data;
412 }
413
remove_quirk(struct mmc_card * card,int data)414 static inline void __maybe_unused remove_quirk(struct mmc_card *card, int data)
415 {
416 card->quirks &= ~data;
417 }
418
419 #define mmc_card_mmc(c) ((c)->type == MMC_TYPE_MMC)
420 #define mmc_card_sd(c) ((c)->type == MMC_TYPE_SD)
421 #define mmc_card_sdio(c) ((c)->type == MMC_TYPE_SDIO)
422
423 #define mmc_card_present(c) ((c)->state & MMC_STATE_PRESENT)
424 #define mmc_card_readonly(c) ((c)->state & MMC_STATE_READONLY)
425 #define mmc_card_blockaddr(c) ((c)->state & MMC_STATE_BLOCKADDR)
426 #define mmc_card_ext_capacity(c) ((c)->state & MMC_CARD_SDXC)
427 #define mmc_card_removed(c) ((c) && ((c)->state & MMC_CARD_REMOVED))
428 #define mmc_card_doing_bkops(c) ((c)->state & MMC_STATE_DOING_BKOPS)
429 #define mmc_card_suspended(c) ((c)->state & MMC_STATE_SUSPENDED)
430
431 #define mmc_card_set_present(c) ((c)->state |= MMC_STATE_PRESENT)
432 #define mmc_card_set_readonly(c) ((c)->state |= MMC_STATE_READONLY)
433 #define mmc_card_set_blockaddr(c) ((c)->state |= MMC_STATE_BLOCKADDR)
434 #define mmc_card_set_ext_capacity(c) ((c)->state |= MMC_CARD_SDXC)
435 #define mmc_card_set_removed(c) ((c)->state |= MMC_CARD_REMOVED)
436 #define mmc_card_set_doing_bkops(c) ((c)->state |= MMC_STATE_DOING_BKOPS)
437 #define mmc_card_clr_doing_bkops(c) ((c)->state &= ~MMC_STATE_DOING_BKOPS)
438 #define mmc_card_set_suspended(c) ((c)->state |= MMC_STATE_SUSPENDED)
439 #define mmc_card_clr_suspended(c) ((c)->state &= ~MMC_STATE_SUSPENDED)
440
441 /*
442 * Quirk add/remove for MMC products.
443 */
444
add_quirk_mmc(struct mmc_card * card,int data)445 static inline void __maybe_unused add_quirk_mmc(struct mmc_card *card, int data)
446 {
447 if (mmc_card_mmc(card))
448 card->quirks |= data;
449 }
450
remove_quirk_mmc(struct mmc_card * card,int data)451 static inline void __maybe_unused remove_quirk_mmc(struct mmc_card *card,
452 int data)
453 {
454 if (mmc_card_mmc(card))
455 card->quirks &= ~data;
456 }
457
458 /*
459 * Quirk add/remove for SD products.
460 */
461
add_quirk_sd(struct mmc_card * card,int data)462 static inline void __maybe_unused add_quirk_sd(struct mmc_card *card, int data)
463 {
464 if (mmc_card_sd(card))
465 card->quirks |= data;
466 }
467
remove_quirk_sd(struct mmc_card * card,int data)468 static inline void __maybe_unused remove_quirk_sd(struct mmc_card *card,
469 int data)
470 {
471 if (mmc_card_sd(card))
472 card->quirks &= ~data;
473 }
474
mmc_card_lenient_fn0(const struct mmc_card * c)475 static inline int mmc_card_lenient_fn0(const struct mmc_card *c)
476 {
477 return c->quirks & MMC_QUIRK_LENIENT_FN0;
478 }
479
mmc_blksz_for_byte_mode(const struct mmc_card * c)480 static inline int mmc_blksz_for_byte_mode(const struct mmc_card *c)
481 {
482 return c->quirks & MMC_QUIRK_BLKSZ_FOR_BYTE_MODE;
483 }
484
mmc_card_disable_cd(const struct mmc_card * c)485 static inline int mmc_card_disable_cd(const struct mmc_card *c)
486 {
487 return c->quirks & MMC_QUIRK_DISABLE_CD;
488 }
489
mmc_card_nonstd_func_interface(const struct mmc_card * c)490 static inline int mmc_card_nonstd_func_interface(const struct mmc_card *c)
491 {
492 return c->quirks & MMC_QUIRK_NONSTD_FUNC_IF;
493 }
494
mmc_card_broken_byte_mode_512(const struct mmc_card * c)495 static inline int mmc_card_broken_byte_mode_512(const struct mmc_card *c)
496 {
497 return c->quirks & MMC_QUIRK_BROKEN_BYTE_MODE_512;
498 }
499
mmc_card_long_read_time(const struct mmc_card * c)500 static inline int mmc_card_long_read_time(const struct mmc_card *c)
501 {
502 return c->quirks & MMC_QUIRK_LONG_READ_TIME;
503 }
504
mmc_card_broken_irq_polling(const struct mmc_card * c)505 static inline int mmc_card_broken_irq_polling(const struct mmc_card *c)
506 {
507 return c->quirks & MMC_QUIRK_BROKEN_IRQ_POLLING;
508 }
509
510 #define mmc_card_name(c) ((c)->cid.prod_name)
511 #define mmc_card_id(c) (dev_name(&(c)->dev))
512
513 #define mmc_dev_to_card(d) container_of(d, struct mmc_card, dev)
514
515 /*
516 * MMC device driver (e.g., Flash card, I/O card...)
517 */
518 struct mmc_driver {
519 struct device_driver drv;
520 int (*probe)(struct mmc_card *);
521 void (*remove)(struct mmc_card *);
522 void (*shutdown)(struct mmc_card *);
523 };
524
525 extern int mmc_register_driver(struct mmc_driver *);
526 extern void mmc_unregister_driver(struct mmc_driver *);
527
528 extern void mmc_fixup_device(struct mmc_card *card,
529 const struct mmc_fixup *table);
530
531 #endif /* LINUX_MMC_CARD_H */
532