]>
Commit | Line | Data |
---|---|---|
1da177e4 LT |
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 | ||
313162d0 | 13 | #include <linux/device.h> |
32780cd1 | 14 | #include <linux/mod_devicetable.h> |
1da177e4 LT |
15 | |
16 | struct mmc_cid { | |
17 | unsigned int manfid; | |
18 | char prod_name[8]; | |
51e7e8b6 | 19 | unsigned char prv; |
1da177e4 LT |
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 | ||
28 | struct mmc_csd { | |
6da24b78 | 29 | unsigned char structure; |
1da177e4 LT |
30 | unsigned char mmca_vsn; |
31 | unsigned short cmdclass; | |
4406ae21 SL |
32 | unsigned short taac_clks; |
33 | unsigned int taac_ns; | |
3a303511 | 34 | unsigned int c_size; |
37be4e78 | 35 | unsigned int r2w_factor; |
1da177e4 | 36 | unsigned int max_dtr; |
dfe86cba | 37 | unsigned int erase_size; /* In sectors */ |
1da177e4 | 38 | unsigned int read_blkbits; |
a6f6c96b | 39 | unsigned int write_blkbits; |
1da177e4 | 40 | unsigned int capacity; |
a6f6c96b RK |
41 | unsigned int read_partial:1, |
42 | read_misalign:1, | |
ce11a161 | 43 | write_partial:1, |
3d705d14 SH |
44 | write_misalign:1, |
45 | dsr_imp:1; | |
1da177e4 LT |
46 | }; |
47 | ||
bce40a36 | 48 | struct mmc_ext_csd { |
b1ebe384 | 49 | u8 rev; |
dfe86cba AH |
50 | u8 erase_group_def; |
51 | u8 sec_feature_support; | |
f4c5522b AW |
52 | u8 rel_sectors; |
53 | u8 rel_param; | |
371a689f | 54 | u8 part_config; |
881d1c25 | 55 | u8 cache_ctrl; |
b2499518 | 56 | u8 rst_n_function; |
abd9ac14 SJ |
57 | u8 max_packed_writes; |
58 | u8 max_packed_reads; | |
59 | u8 packed_event_en; | |
371a689f | 60 | unsigned int part_time; /* Units: ms */ |
b1ebe384 | 61 | unsigned int sa_timeout; /* Units: 100ns */ |
b23cf0bd | 62 | unsigned int generic_cmd6_time; /* Units: 10ms */ |
bec8726a | 63 | unsigned int power_off_longtime; /* Units: ms */ |
e6c08586 | 64 | u8 power_off_notification; /* state */ |
bce40a36 | 65 | unsigned int hs_max_dtr; |
577fb131 | 66 | unsigned int hs200_max_dtr; |
96cf5f02 SJ |
67 | #define MMC_HIGH_26_MAX_DTR 26000000 |
68 | #define MMC_HIGH_52_MAX_DTR 52000000 | |
69 | #define MMC_HIGH_DDR_MAX_DTR 52000000 | |
70 | #define MMC_HS200_MAX_DTR 200000000 | |
85a18ad9 | 71 | unsigned int sectors; |
dfe86cba AH |
72 | unsigned int hc_erase_size; /* In sectors */ |
73 | unsigned int hc_erase_timeout; /* In milliseconds */ | |
74 | unsigned int sec_trim_mult; /* Secure trim multiplier */ | |
75 | unsigned int sec_erase_mult; /* Secure erase multiplier */ | |
76 | unsigned int trim_timeout; /* In milliseconds */ | |
69803d4f | 77 | bool partition_setting_completed; /* enable bit */ |
709de99d CD |
78 | unsigned long long enhanced_area_offset; /* Units: Byte */ |
79 | unsigned int enhanced_area_size; /* Units: KB */ | |
881d1c25 | 80 | unsigned int cache_size; /* Units: KB */ |
eb0d8f13 JC |
81 | bool hpi_en; /* HPI enablebit */ |
82 | bool hpi; /* HPI support bit */ | |
83 | unsigned int hpi_cmd; /* cmd used as HPI */ | |
950d56ac | 84 | bool bkops; /* background support bit */ |
0501be64 | 85 | bool man_bkops_en; /* manual bkops enable bit */ |
efff8e78 | 86 | bool auto_bkops_en; /* auto bkops enable bit */ |
4265900e SD |
87 | unsigned int data_sector_size; /* 512 bytes or 4KB */ |
88 | unsigned int data_tag_unit_size; /* DATA TAG UNIT size */ | |
add710ea JR |
89 | unsigned int boot_ro_lock; /* ro lock support */ |
90 | bool boot_ro_lockable; | |
0f762426 | 91 | bool ffu_capable; /* Firmware upgrade support */ |
b658af71 | 92 | bool cmdq_en; /* Command Queue enabled */ |
925ff3a7 AH |
93 | bool cmdq_support; /* Command Queue supported */ |
94 | unsigned int cmdq_depth; /* Command Queue depth */ | |
0f762426 GG |
95 | #define MMC_FIRMWARE_LEN 8 |
96 | u8 fwrev[MMC_FIRMWARE_LEN]; /* FW version */ | |
c148e9ff | 97 | u8 raw_exception_status; /* 54 */ |
f39b2dd9 | 98 | u8 raw_partition_support; /* 160 */ |
090d25fe | 99 | u8 raw_rpmb_size_mult; /* 168 */ |
f39b2dd9 | 100 | u8 raw_erased_mem_count; /* 181 */ |
81ac2af6 | 101 | u8 strobe_support; /* 184 */ |
f39b2dd9 PR |
102 | u8 raw_ext_csd_structure; /* 194 */ |
103 | u8 raw_card_type; /* 196 */ | |
b097e07f | 104 | u8 raw_driver_strength; /* 197 */ |
eb0d8f13 | 105 | u8 out_of_int_time; /* 198 */ |
60443712 FS |
106 | u8 raw_pwr_cl_52_195; /* 200 */ |
107 | u8 raw_pwr_cl_26_195; /* 201 */ | |
108 | u8 raw_pwr_cl_52_360; /* 202 */ | |
109 | u8 raw_pwr_cl_26_360; /* 203 */ | |
110 | u8 raw_s_a_timeout; /* 217 */ | |
f39b2dd9 PR |
111 | u8 raw_hc_erase_gap_size; /* 221 */ |
112 | u8 raw_erase_timeout_mult; /* 223 */ | |
113 | u8 raw_hc_erase_grp_size; /* 224 */ | |
114 | u8 raw_sec_trim_mult; /* 229 */ | |
115 | u8 raw_sec_erase_mult; /* 230 */ | |
116 | u8 raw_sec_feature_support;/* 231 */ | |
117 | u8 raw_trim_mult; /* 232 */ | |
60443712 FS |
118 | u8 raw_pwr_cl_200_195; /* 236 */ |
119 | u8 raw_pwr_cl_200_360; /* 237 */ | |
120 | u8 raw_pwr_cl_ddr_52_195; /* 238 */ | |
121 | u8 raw_pwr_cl_ddr_52_360; /* 239 */ | |
0a5b6438 | 122 | u8 raw_pwr_cl_ddr_200_360; /* 253 */ |
950d56ac | 123 | u8 raw_bkops_status; /* 246 */ |
f39b2dd9 | 124 | u8 raw_sectors[4]; /* 212 - 4 bytes */ |
46bc5c40 JL |
125 | u8 pre_eol_info; /* 267 */ |
126 | u8 device_life_time_est_typ_a; /* 268 */ | |
127 | u8 device_life_time_est_typ_b; /* 269 */ | |
b3bf9153 KP |
128 | |
129 | unsigned int feature_support; | |
130 | #define MMC_DISCARD_FEATURE BIT(0) /* CMD38 feature */ | |
bce40a36 PL |
131 | }; |
132 | ||
b57c43ad PO |
133 | struct sd_scr { |
134 | unsigned char sda_vsn; | |
013909c4 | 135 | unsigned char sda_spec3; |
b57c43ad PO |
136 | unsigned char bus_widths; |
137 | #define SD_SCR_BUS_WIDTH_1 (1<<0) | |
138 | #define SD_SCR_BUS_WIDTH_4 (1<<2) | |
f0d89972 AW |
139 | unsigned char cmds; |
140 | #define SD_SCR_CMD20_SUPPORT (1<<0) | |
141 | #define SD_SCR_CMD23_SUPPORT (1<<1) | |
b57c43ad PO |
142 | }; |
143 | ||
dfe86cba AH |
144 | struct sd_ssr { |
145 | unsigned int au; /* In sectors */ | |
146 | unsigned int erase_timeout; /* In milliseconds */ | |
147 | unsigned int erase_offset; /* In milliseconds */ | |
148 | }; | |
149 | ||
7ccd266e PO |
150 | struct sd_switch_caps { |
151 | unsigned int hs_max_dtr; | |
49c468fc | 152 | unsigned int uhs_max_dtr; |
fffe5d5a | 153 | #define HIGH_SPEED_MAX_DTR 50000000 |
49c468fc AN |
154 | #define UHS_SDR104_MAX_DTR 208000000 |
155 | #define UHS_SDR50_MAX_DTR 100000000 | |
156 | #define UHS_DDR50_MAX_DTR 50000000 | |
157 | #define UHS_SDR25_MAX_DTR UHS_DDR50_MAX_DTR | |
158 | #define UHS_SDR12_MAX_DTR 25000000 | |
013909c4 | 159 | unsigned int sd3_bus_mode; |
49c468fc | 160 | #define UHS_SDR12_BUS_SPEED 0 |
fffe5d5a | 161 | #define HIGH_SPEED_BUS_SPEED 1 |
49c468fc AN |
162 | #define UHS_SDR25_BUS_SPEED 1 |
163 | #define UHS_SDR50_BUS_SPEED 2 | |
164 | #define UHS_SDR104_BUS_SPEED 3 | |
165 | #define UHS_DDR50_BUS_SPEED 4 | |
166 | ||
fffe5d5a | 167 | #define SD_MODE_HIGH_SPEED (1 << HIGH_SPEED_BUS_SPEED) |
49c468fc AN |
168 | #define SD_MODE_UHS_SDR12 (1 << UHS_SDR12_BUS_SPEED) |
169 | #define SD_MODE_UHS_SDR25 (1 << UHS_SDR25_BUS_SPEED) | |
170 | #define SD_MODE_UHS_SDR50 (1 << UHS_SDR50_BUS_SPEED) | |
171 | #define SD_MODE_UHS_SDR104 (1 << UHS_SDR104_BUS_SPEED) | |
172 | #define SD_MODE_UHS_DDR50 (1 << UHS_DDR50_BUS_SPEED) | |
013909c4 | 173 | unsigned int sd3_drv_type; |
d6d50a15 AN |
174 | #define SD_DRIVER_TYPE_B 0x01 |
175 | #define SD_DRIVER_TYPE_A 0x02 | |
176 | #define SD_DRIVER_TYPE_C 0x04 | |
177 | #define SD_DRIVER_TYPE_D 0x08 | |
013909c4 | 178 | unsigned int sd3_curr_limit; |
5371c927 AN |
179 | #define SD_SET_CURRENT_LIMIT_200 0 |
180 | #define SD_SET_CURRENT_LIMIT_400 1 | |
181 | #define SD_SET_CURRENT_LIMIT_600 2 | |
182 | #define SD_SET_CURRENT_LIMIT_800 3 | |
0aa67700 | 183 | #define SD_SET_CURRENT_NO_CHANGE (-1) |
5371c927 AN |
184 | |
185 | #define SD_MAX_CURRENT_200 (1 << SD_SET_CURRENT_LIMIT_200) | |
186 | #define SD_MAX_CURRENT_400 (1 << SD_SET_CURRENT_LIMIT_400) | |
187 | #define SD_MAX_CURRENT_600 (1 << SD_SET_CURRENT_LIMIT_600) | |
188 | #define SD_MAX_CURRENT_800 (1 << SD_SET_CURRENT_LIMIT_800) | |
7ccd266e PO |
189 | }; |
190 | ||
35c66c19 PO |
191 | struct sdio_cccr { |
192 | unsigned int sdio_vsn; | |
193 | unsigned int sd_vsn; | |
194 | unsigned int multi_block:1, | |
195 | low_speed:1, | |
196 | wide_bus:1, | |
197 | high_power:1, | |
006ebd5d OBC |
198 | high_speed:1, |
199 | disable_cd:1; | |
35c66c19 PO |
200 | }; |
201 | ||
1a632f8c PO |
202 | struct sdio_cis { |
203 | unsigned short vendor; | |
204 | unsigned short device; | |
205 | unsigned short blksize; | |
206 | unsigned int max_dtr; | |
207 | }; | |
208 | ||
1da177e4 | 209 | struct mmc_host; |
e29a7d73 | 210 | struct sdio_func; |
1a632f8c | 211 | struct sdio_func_tuple; |
7b410d07 | 212 | struct mmc_queue_req; |
e29a7d73 PO |
213 | |
214 | #define SDIO_MAX_FUNCS 7 | |
1da177e4 | 215 | |
e0c368d5 | 216 | /* The number of MMC physical partitions. These consist of: |
b3683994 YS |
217 | * boot partitions (2), general purpose partitions (4) and |
218 | * RPMB partition (1) in MMC v4.4. | |
e0c368d5 NJ |
219 | */ |
220 | #define MMC_NUM_BOOT_PARTITION 2 | |
221 | #define MMC_NUM_GP_PARTITION 4 | |
b3683994 | 222 | #define MMC_NUM_PHY_PARTITION 7 |
a6029e1f | 223 | #define MAX_MMC_PART_NAME_LEN 20 |
e0c368d5 NJ |
224 | |
225 | /* | |
226 | * MMC Physical partitions | |
227 | */ | |
228 | struct mmc_part { | |
229 | unsigned int size; /* partition size (in bytes) */ | |
230 | unsigned int part_cfg; /* partition type */ | |
a6029e1f | 231 | char name[MAX_MMC_PART_NAME_LEN]; |
e0c368d5 | 232 | bool force_ro; /* to make boot parts RO by default */ |
add710ea JR |
233 | unsigned int area_type; |
234 | #define MMC_BLK_DATA_AREA_MAIN (1<<0) | |
235 | #define MMC_BLK_DATA_AREA_BOOT (1<<1) | |
236 | #define MMC_BLK_DATA_AREA_GP (1<<2) | |
090d25fe | 237 | #define MMC_BLK_DATA_AREA_RPMB (1<<3) |
e0c368d5 NJ |
238 | }; |
239 | ||
1da177e4 LT |
240 | /* |
241 | * MMC device | |
242 | */ | |
243 | struct mmc_card { | |
1da177e4 LT |
244 | struct mmc_host *host; /* the host this device belongs to */ |
245 | struct device dev; /* the device */ | |
69041150 | 246 | u32 ocr; /* the current OCR setting */ |
1da177e4 | 247 | unsigned int rca; /* relative card address of device */ |
9c2c0af9 PO |
248 | unsigned int type; /* card type */ |
249 | #define MMC_TYPE_MMC 0 /* MMC card */ | |
250 | #define MMC_TYPE_SD 1 /* SD card */ | |
5c4e6f13 | 251 | #define MMC_TYPE_SDIO 2 /* SDIO card */ |
7310ece8 | 252 | #define MMC_TYPE_SD_COMBO 3 /* SD combo (IO+mem) card */ |
1da177e4 | 253 | unsigned int state; /* (our) card state */ |
7c979ec7 OBC |
254 | unsigned int quirks; /* card quirks */ |
255 | #define MMC_QUIRK_LENIENT_FN0 (1<<0) /* allow SDIO FN0 writes outside of the VS CCCR range */ | |
3fb7fb4a BZ |
256 | #define MMC_QUIRK_BLKSZ_FOR_BYTE_MODE (1<<1) /* use func->cur_blksize */ |
257 | /* for byte mode */ | |
6f51be3d GI |
258 | #define MMC_QUIRK_NONSTD_SDIO (1<<2) /* non-standard SDIO card attached */ |
259 | /* (missing CIA registers) */ | |
eab40687 | 260 | #define MMC_QUIRK_NONSTD_FUNC_IF (1<<4) /* SDIO card has nonstd function interfaces */ |
2059a02d | 261 | #define MMC_QUIRK_DISABLE_CD (1<<5) /* disconnect CD/DAT[3] resistor */ |
6a7a6b45 | 262 | #define MMC_QUIRK_INAND_CMD38 (1<<6) /* iNAND devices have broken CMD38 */ |
d0c97cfb | 263 | #define MMC_QUIRK_BLK_NO_CMD23 (1<<7) /* Avoid CMD23 for regular multiblock */ |
9a0da648 | 264 | #define MMC_QUIRK_BROKEN_BYTE_MODE_512 (1<<8) /* Avoid sending 512 bytes in */ |
e5624054 | 265 | /* byte mode */ |
6de5fc9c | 266 | #define MMC_QUIRK_LONG_READ_TIME (1<<9) /* Data read time > CSD says */ |
3550ccdb | 267 | #define MMC_QUIRK_SEC_ERASE_TRIM_BROKEN (1<<10) /* Skip secure for erase/trim */ |
e5624054 | 268 | #define MMC_QUIRK_BROKEN_IRQ_POLLING (1<<11) /* Polling SDIO_CCCR_INTx could create a fake interrupt */ |
b5b4ff0a | 269 | #define MMC_QUIRK_TRIM_BROKEN (1<<12) /* Skip trim */ |
5320226a | 270 | #define MMC_QUIRK_BROKEN_HPI (1<<13) /* Disable broken HPI support */ |
b5b4ff0a | 271 | |
9d4579a8 AH |
272 | bool reenable_cmdq; /* Re-enable Command Queue */ |
273 | ||
dfe86cba AH |
274 | unsigned int erase_size; /* erase size in sectors */ |
275 | unsigned int erase_shift; /* if erase unit is power 2 */ | |
276 | unsigned int pref_erase; /* in sectors */ | |
642c28ab | 277 | unsigned int eg_boundary; /* don't cross erase-group boundaries */ |
dfe86cba AH |
278 | u8 erased_byte; /* value of erased bytes */ |
279 | ||
1da177e4 LT |
280 | u32 raw_cid[4]; /* raw card CID */ |
281 | u32 raw_csd[4]; /* raw card CSD */ | |
b57c43ad | 282 | u32 raw_scr[2]; /* raw card SCR */ |
5275a652 | 283 | u32 raw_ssr[16]; /* raw card SSR */ |
1da177e4 LT |
284 | struct mmc_cid cid; /* card identification */ |
285 | struct mmc_csd csd; /* card specific */ | |
bce40a36 | 286 | struct mmc_ext_csd ext_csd; /* mmc v4 extended card specific */ |
b57c43ad | 287 | struct sd_scr scr; /* extra SD information */ |
dfe86cba | 288 | struct sd_ssr ssr; /* yet more SD information */ |
7ccd266e | 289 | struct sd_switch_caps sw_caps; /* switch (CMD6) caps */ |
e29a7d73 PO |
290 | |
291 | unsigned int sdio_funcs; /* number of SDIO functions */ | |
35c66c19 | 292 | struct sdio_cccr cccr; /* common card info */ |
1a632f8c | 293 | struct sdio_cis cis; /* common tuple info */ |
e29a7d73 | 294 | struct sdio_func *sdio_func[SDIO_MAX_FUNCS]; /* SDIO functions (devices) */ |
06e8935f | 295 | struct sdio_func *sdio_single_irq; /* SDIO function when only one IRQ active */ |
759bdc7a PO |
296 | unsigned num_info; /* number of info strings */ |
297 | const char **info; /* info strings */ | |
1a632f8c | 298 | struct sdio_func_tuple *tuples; /* unknown common tuples */ |
f4b7f927 | 299 | |
49c468fc | 300 | unsigned int sd_bus_speed; /* Bus Speed Mode set for the card */ |
2415c0ef | 301 | unsigned int mmc_avail_type; /* supported device type by both host and card */ |
3853a042 | 302 | unsigned int drive_strength; /* for UHS-I, HS200 or HS400 */ |
49c468fc | 303 | |
f4b7f927 | 304 | struct dentry *debugfs_root; |
e0c368d5 NJ |
305 | struct mmc_part part[MMC_NUM_PHY_PARTITION]; /* physical partitions */ |
306 | unsigned int nr_parts; | |
7b410d07 | 307 | |
7b410d07 | 308 | unsigned int bouncesz; /* Bounce buffer size */ |
1da177e4 LT |
309 | }; |
310 | ||
ce39f9d1 SJ |
311 | static inline bool mmc_large_sector(struct mmc_card *card) |
312 | { | |
313 | return card->ext_csd.data_sector_size == 4096; | |
314 | } | |
315 | ||
33e6d74d UH |
316 | bool mmc_card_is_blockaddr(struct mmc_card *card); |
317 | ||
9c2c0af9 PO |
318 | #define mmc_card_mmc(c) ((c)->type == MMC_TYPE_MMC) |
319 | #define mmc_card_sd(c) ((c)->type == MMC_TYPE_SD) | |
5c4e6f13 | 320 | #define mmc_card_sdio(c) ((c)->type == MMC_TYPE_SDIO) |
9c2c0af9 | 321 | |
100e9186 | 322 | #endif /* LINUX_MMC_CARD_H */ |