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