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