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