blob: 477733c00d61ee10f2b0ead973a19607ad673b47 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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
Paul Gortmaker313162d2012-01-30 11:46:54 -050013#include <linux/device.h>
Pierre Ossmanaaac1b42007-02-28 15:33:10 +010014#include <linux/mmc/core.h>
Andrei Warkentin32780cd2011-04-11 17:02:15 -050015#include <linux/mod_devicetable.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070016
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 {
Kyungmin Park6da24b72010-08-10 18:01:36 -070029 unsigned char structure;
Linus Torvalds1da177e2005-04-16 15:20:36 -070030 unsigned char mmca_vsn;
31 unsigned short cmdclass;
32 unsigned short tacc_clks;
33 unsigned int tacc_ns;
Arindam Nath3a303512011-05-05 12:19:03 +053034 unsigned int c_size;
Russell King37be4e72006-05-02 17:24:59 +010035 unsigned int r2w_factor;
Linus Torvalds1da177e2005-04-16 15:20:36 -070036 unsigned int max_dtr;
Adrian Hunterdfe86cb2010-08-11 14:17:46 -070037 unsigned int erase_size; /* In sectors */
Linus Torvalds1da177e2005-04-16 15:20:36 -070038 unsigned int read_blkbits;
Russell Kinga6f6c962006-01-03 22:38:44 +000039 unsigned int write_blkbits;
Linus Torvalds1da177e2005-04-16 15:20:36 -070040 unsigned int capacity;
Russell Kinga6f6c962006-01-03 22:38:44 +000041 unsigned int read_partial:1,
42 read_misalign:1,
Russell Kingce11a162006-01-04 12:40:39 +000043 write_partial:1,
Russell Kinga6f6c962006-01-03 22:38:44 +000044 write_misalign:1;
Linus Torvalds1da177e2005-04-16 15:20:36 -070045};
46
Philip Langdalebce40a32006-10-21 12:35:02 +020047struct mmc_ext_csd {
Jarkko Lavinenb1ebe382009-09-22 16:44:34 -070048 u8 rev;
Adrian Hunterdfe86cb2010-08-11 14:17:46 -070049 u8 erase_group_def;
50 u8 sec_feature_support;
Andrei Warkentinf4c55222011-03-31 18:40:00 -050051 u8 rel_sectors;
52 u8 rel_param;
Andrei Warkentin371a6892011-04-11 18:10:25 -050053 u8 part_config;
Seungwon Jeon881d1c22011-10-14 14:03:21 +090054 u8 cache_ctrl;
Adrian Hunterb2499512011-08-29 16:42:11 +030055 u8 rst_n_function;
Seungwon Jeonc70e9662012-09-27 16:12:47 +020056 u8 max_packed_writes;
57 u8 max_packed_reads;
58 u8 packed_event_en;
Andrei Warkentin371a6892011-04-11 18:10:25 -050059 unsigned int part_time; /* Units: ms */
Jarkko Lavinenb1ebe382009-09-22 16:44:34 -070060 unsigned int sa_timeout; /* Units: 100ns */
Seungwon Jeonb23cf0b2011-09-23 14:15:29 +090061 unsigned int generic_cmd6_time; /* Units: 10ms */
Girish K Sbec87262011-10-13 12:04:16 +053062 unsigned int power_off_longtime; /* Units: ms */
Philip Langdalebce40a32006-10-21 12:35:02 +020063 unsigned int hs_max_dtr;
Seungwon Jeonfe201cd2012-04-25 16:17:37 +090064#define MMC_HIGH_26_MAX_DTR 26000000
65#define MMC_HIGH_52_MAX_DTR 52000000
66#define MMC_HIGH_DDR_MAX_DTR 52000000
67#define MMC_HS200_MAX_DTR 200000000
Pierre Ossman85a18ad2007-02-17 22:15:27 +010068 unsigned int sectors;
Hanumath Prasaddfc13e82010-09-30 17:37:23 -040069 unsigned int card_type;
Adrian Hunterdfe86cb2010-08-11 14:17:46 -070070 unsigned int hc_erase_size; /* In sectors */
71 unsigned int hc_erase_timeout; /* In milliseconds */
72 unsigned int sec_trim_mult; /* Secure trim multiplier */
73 unsigned int sec_erase_mult; /* Secure erase multiplier */
74 unsigned int trim_timeout; /* In milliseconds */
Chuanxiao Dong709de992011-01-22 04:09:41 +080075 bool enhanced_area_en; /* enable bit */
76 unsigned long long enhanced_area_offset; /* Units: Byte */
77 unsigned int enhanced_area_size; /* Units: KB */
Seungwon Jeon881d1c22011-10-14 14:03:21 +090078 unsigned int cache_size; /* Units: KB */
Jaehoon Chungeb0d8f12011-10-18 01:26:42 -040079 bool hpi_en; /* HPI enablebit */
80 bool hpi; /* HPI support bit */
81 unsigned int hpi_cmd; /* cmd used as HPI */
Jaehoon Chungc1a56a12012-09-24 14:44:45 +020082 bool bkops; /* background support bit */
83 bool bkops_en; /* background enable bit */
Saugata Das42659002011-12-21 13:09:17 +053084 unsigned int data_sector_size; /* 512 bytes or 4KB */
85 unsigned int data_tag_unit_size; /* DATA TAG UNIT size */
Johan Rudholmadd710e2011-12-02 08:51:06 +010086 unsigned int boot_ro_lock; /* ro lock support */
87 bool boot_ro_lockable;
Jaehoon Chungc1a56a12012-09-24 14:44:45 +020088 u8 raw_exception_status; /* 53 */
Philip Rakityf39b2dd2011-07-07 09:04:55 -070089 u8 raw_partition_support; /* 160 */
90 u8 raw_erased_mem_count; /* 181 */
91 u8 raw_ext_csd_structure; /* 194 */
92 u8 raw_card_type; /* 196 */
Jaehoon Chungeb0d8f12011-10-18 01:26:42 -040093 u8 out_of_int_time; /* 198 */
Philip Rakityf39b2dd2011-07-07 09:04:55 -070094 u8 raw_s_a_timeout; /* 217 */
95 u8 raw_hc_erase_gap_size; /* 221 */
96 u8 raw_erase_timeout_mult; /* 223 */
97 u8 raw_hc_erase_grp_size; /* 224 */
98 u8 raw_sec_trim_mult; /* 229 */
99 u8 raw_sec_erase_mult; /* 230 */
100 u8 raw_sec_feature_support;/* 231 */
101 u8 raw_trim_mult; /* 232 */
Jaehoon Chungc1a56a12012-09-24 14:44:45 +0200102 u8 raw_bkops_status; /* 246 */
Philip Rakityf39b2dd2011-07-07 09:04:55 -0700103 u8 raw_sectors[4]; /* 212 - 4 bytes */
Kyungmin Parkb3bf9152011-10-18 09:34:04 +0900104
105 unsigned int feature_support;
106#define MMC_DISCARD_FEATURE BIT(0) /* CMD38 feature */
Philip Langdalebce40a32006-10-21 12:35:02 +0200107};
108
Pierre Ossmanb57c43a2005-09-06 15:18:53 -0700109struct sd_scr {
110 unsigned char sda_vsn;
Arindam Nath013909c2011-05-05 12:18:58 +0530111 unsigned char sda_spec3;
Pierre Ossmanb57c43a2005-09-06 15:18:53 -0700112 unsigned char bus_widths;
113#define SD_SCR_BUS_WIDTH_1 (1<<0)
114#define SD_SCR_BUS_WIDTH_4 (1<<2)
Andrei Warkentinf0d89972011-05-23 15:06:38 -0500115 unsigned char cmds;
116#define SD_SCR_CMD20_SUPPORT (1<<0)
117#define SD_SCR_CMD23_SUPPORT (1<<1)
Pierre Ossmanb57c43a2005-09-06 15:18:53 -0700118};
119
Adrian Hunterdfe86cb2010-08-11 14:17:46 -0700120struct sd_ssr {
121 unsigned int au; /* In sectors */
122 unsigned int erase_timeout; /* In milliseconds */
123 unsigned int erase_offset; /* In milliseconds */
124};
125
Pierre Ossman7ccd2662006-11-08 23:03:10 +0100126struct sd_switch_caps {
127 unsigned int hs_max_dtr;
Arindam Nath49c468f2011-05-05 12:19:01 +0530128 unsigned int uhs_max_dtr;
Qiang Liufffe5d52011-11-08 08:43:08 -0500129#define HIGH_SPEED_MAX_DTR 50000000
Arindam Nath49c468f2011-05-05 12:19:01 +0530130#define UHS_SDR104_MAX_DTR 208000000
131#define UHS_SDR50_MAX_DTR 100000000
132#define UHS_DDR50_MAX_DTR 50000000
133#define UHS_SDR25_MAX_DTR UHS_DDR50_MAX_DTR
134#define UHS_SDR12_MAX_DTR 25000000
Arindam Nath013909c2011-05-05 12:18:58 +0530135 unsigned int sd3_bus_mode;
Arindam Nath49c468f2011-05-05 12:19:01 +0530136#define UHS_SDR12_BUS_SPEED 0
Qiang Liufffe5d52011-11-08 08:43:08 -0500137#define HIGH_SPEED_BUS_SPEED 1
Arindam Nath49c468f2011-05-05 12:19:01 +0530138#define UHS_SDR25_BUS_SPEED 1
139#define UHS_SDR50_BUS_SPEED 2
140#define UHS_SDR104_BUS_SPEED 3
141#define UHS_DDR50_BUS_SPEED 4
142
Qiang Liufffe5d52011-11-08 08:43:08 -0500143#define SD_MODE_HIGH_SPEED (1 << HIGH_SPEED_BUS_SPEED)
Arindam Nath49c468f2011-05-05 12:19:01 +0530144#define SD_MODE_UHS_SDR12 (1 << UHS_SDR12_BUS_SPEED)
145#define SD_MODE_UHS_SDR25 (1 << UHS_SDR25_BUS_SPEED)
146#define SD_MODE_UHS_SDR50 (1 << UHS_SDR50_BUS_SPEED)
147#define SD_MODE_UHS_SDR104 (1 << UHS_SDR104_BUS_SPEED)
148#define SD_MODE_UHS_DDR50 (1 << UHS_DDR50_BUS_SPEED)
Arindam Nath013909c2011-05-05 12:18:58 +0530149 unsigned int sd3_drv_type;
Arindam Nathd6d50a12011-05-05 12:18:59 +0530150#define SD_DRIVER_TYPE_B 0x01
151#define SD_DRIVER_TYPE_A 0x02
152#define SD_DRIVER_TYPE_C 0x04
153#define SD_DRIVER_TYPE_D 0x08
Arindam Nath013909c2011-05-05 12:18:58 +0530154 unsigned int sd3_curr_limit;
Arindam Nath5371c922011-05-05 12:19:02 +0530155#define SD_SET_CURRENT_LIMIT_200 0
156#define SD_SET_CURRENT_LIMIT_400 1
157#define SD_SET_CURRENT_LIMIT_600 2
158#define SD_SET_CURRENT_LIMIT_800 3
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)
Pierre Ossman7ccd2662006-11-08 23:03:10 +0100164};
165
Pierre Ossman35c66c12007-06-11 20:25:43 +0200166struct 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,
Ohad Ben-Cohen006ebd52009-09-22 16:45:07 -0700173 high_speed:1,
174 disable_cd:1;
Pierre Ossman35c66c12007-06-11 20:25:43 +0200175};
176
Pierre Ossman1a632f82007-07-30 15:15:30 +0200177struct sdio_cis {
178 unsigned short vendor;
179 unsigned short device;
180 unsigned short blksize;
181 unsigned int max_dtr;
182};
183
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184struct mmc_host;
Pierre Ossmane29a7d72007-05-26 13:48:18 +0200185struct sdio_func;
Pierre Ossman1a632f82007-07-30 15:15:30 +0200186struct sdio_func_tuple;
Pierre Ossmane29a7d72007-05-26 13:48:18 +0200187
188#define SDIO_MAX_FUNCS 7
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189
Tatyana Brokhman464fbe12012-10-07 10:33:13 +0200190enum mmc_packed_stop_reasons {
191 EXCEEDS_SEGMENTS = 0,
192 EXCEEDS_SECTORS,
193 WRONG_DATA_DIR,
194 FLUSH_OR_DISCARD,
195 EMPTY_QUEUE,
196 REL_WRITE,
197 THRESHOLD,
Tatyana Brokhman1718ef22012-10-04 11:11:08 +0200198 LARGE_SEC_ALIGN,
Tatyana Brokhman464fbe12012-10-07 10:33:13 +0200199 MAX_REASONS,
200};
201
202struct mmc_wr_pack_stats {
203 u32 *packing_events;
204 u32 pack_stop_reason[MAX_REASONS];
205 spinlock_t lock;
206 bool enabled;
207 bool print_in_read;
208};
209
Namjae Jeone0c368d2011-10-06 23:41:38 +0900210/* The number of MMC physical partitions. These consist of:
211 * boot partitions (2), general purpose partitions (4) in MMC v4.4.
212 */
213#define MMC_NUM_BOOT_PARTITION 2
214#define MMC_NUM_GP_PARTITION 4
215#define MMC_NUM_PHY_PARTITION 6
Namjae Jeona6029e12011-10-13 00:43:14 +0900216#define MAX_MMC_PART_NAME_LEN 20
Namjae Jeone0c368d2011-10-06 23:41:38 +0900217
218/*
219 * MMC Physical partitions
220 */
221struct mmc_part {
222 unsigned int size; /* partition size (in bytes) */
223 unsigned int part_cfg; /* partition type */
Namjae Jeona6029e12011-10-13 00:43:14 +0900224 char name[MAX_MMC_PART_NAME_LEN];
Namjae Jeone0c368d2011-10-06 23:41:38 +0900225 bool force_ro; /* to make boot parts RO by default */
Johan Rudholmadd710e2011-12-02 08:51:06 +0100226 unsigned int area_type;
227#define MMC_BLK_DATA_AREA_MAIN (1<<0)
228#define MMC_BLK_DATA_AREA_BOOT (1<<1)
229#define MMC_BLK_DATA_AREA_GP (1<<2)
Namjae Jeone0c368d2011-10-06 23:41:38 +0900230};
231
Maya Erez5f360692012-10-10 03:47:54 +0200232/**
233 * struct mmc_bkops_info - BKOPS data
234 * @dw: Idle time bkops delayed work
235 * @host_suspend_tout_ms: The host controller idle time,
236 * before getting into suspend
237 * @delay_ms: The time to start the BKOPS
238 * delayed work once MMC thread is idle
239 * @poll_for_completion: Poll on BKOPS completion
240 * @cancel_delayed_work: A flag to indicate if the delayed work
241 * should be cancelled
242 * @started_delayed_bkops: A flag to indicate if the delayed
243 * work was scheduled
244 * @sectors_changed: number of sectors written or
245 * discard since the last idle BKOPS were scheduled
246 */
247struct mmc_bkops_info {
248 struct delayed_work dw;
249 unsigned int host_suspend_tout_ms;
250 unsigned int delay_ms;
Yaniv Gardie6c6b4b2012-10-11 11:36:24 +0200251 unsigned int min_sectors_to_queue_delayed_work;
Maya Erez5f360692012-10-10 03:47:54 +0200252/*
253 * A default time for checking the need for non urgent BKOPS once mmcqd
254 * is idle.
255 */
256#define MMC_IDLE_BKOPS_TIME_MS 2000
257 struct work_struct poll_for_completion;
258/* Polling timeout and interval for waiting on non-blocking BKOPs completion */
259#define BKOPS_COMPLETION_POLLING_TIMEOUT_MS 10000 /* in ms */
260#define BKOPS_COMPLETION_POLLING_INTERVAL_MS 1000 /* in ms */
261 bool cancel_delayed_work;
262 bool started_delayed_bkops;
263 unsigned int sectors_changed;
264/*
265 * Since canceling the delayed work might have significant effect on the
266 * performance of small requests we won't queue the delayed work every time
267 * mmcqd thread is idle.
268 * The delayed work for idle BKOPS will be scheduled only after a significant
269 * amount of write or discard data.
270 * 100MB is chosen based on benchmark tests.
271 */
272#define BKOPS_MIN_SECTORS_TO_QUEUE_DELAYED_WORK 204800 /* 100MB */
273};
274
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275/*
276 * MMC device
277 */
278struct mmc_card {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279 struct mmc_host *host; /* the host this device belongs to */
280 struct device dev; /* the device */
281 unsigned int rca; /* relative card address of device */
Pierre Ossman9c2c0af2006-12-26 15:25:58 +0100282 unsigned int type; /* card type */
283#define MMC_TYPE_MMC 0 /* MMC card */
284#define MMC_TYPE_SD 1 /* SD card */
Pierre Ossman5c4e6f12007-05-21 20:23:20 +0200285#define MMC_TYPE_SDIO 2 /* SDIO card */
Michal Miroslaw7310ece2010-08-10 18:01:40 -0700286#define MMC_TYPE_SD_COMBO 3 /* SD combo (IO+mem) card */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287 unsigned int state; /* (our) card state */
288#define MMC_STATE_PRESENT (1<<0) /* present in sysfs */
Pierre Ossmanbd766312007-05-01 16:11:57 +0200289#define MMC_STATE_READONLY (1<<1) /* card is read-only */
290#define MMC_STATE_HIGHSPEED (1<<2) /* card is in high speed mode */
291#define MMC_STATE_BLOCKADDR (1<<3) /* card uses block-addressing */
Hanumath Prasaddfc13e82010-09-30 17:37:23 -0400292#define MMC_STATE_HIGHSPEED_DDR (1<<4) /* card is in high speed mode */
Arindam Nath3a303512011-05-05 12:19:03 +0530293#define MMC_STATE_ULTRAHIGHSPEED (1<<5) /* card is in ultra high speed mode */
294#define MMC_CARD_SDXC (1<<6) /* card is SDXC */
Adrian Hunterd3049502011-11-28 16:22:00 +0200295#define MMC_CARD_REMOVED (1<<7) /* card has been removed */
Girish K Sa4924c72012-01-11 14:04:52 -0500296#define MMC_STATE_HIGHSPEED_200 (1<<8) /* card is in HS200 mode */
Girish K S3e73c362012-01-31 15:44:03 +0530297#define MMC_STATE_SLEEP (1<<9) /* card is in sleep state */
Jaehoon Chungc1a56a12012-09-24 14:44:45 +0200298#define MMC_STATE_DOING_BKOPS (1<<10) /* card is doing BKOPS */
Ohad Ben-Cohen7c979ec2009-09-22 16:45:18 -0700299 unsigned int quirks; /* card quirks */
300#define MMC_QUIRK_LENIENT_FN0 (1<<0) /* allow SDIO FN0 writes outside of the VS CCCR range */
Bing Zhao3fb7fb42010-03-05 13:43:25 -0800301#define MMC_QUIRK_BLKSZ_FOR_BYTE_MODE (1<<1) /* use func->cur_blksize */
302 /* for byte mode */
Grazvydas Ignotas6f51be32010-08-10 18:01:50 -0700303#define MMC_QUIRK_NONSTD_SDIO (1<<2) /* non-standard SDIO card attached */
304 /* (missing CIA registers) */
Pierre Tardydb993502011-02-06 19:03:47 +0100305#define MMC_QUIRK_BROKEN_CLK_GATING (1<<3) /* clock gating the sdio bus will make card fail */
Ohad Ben-Coheneab40682011-04-05 17:50:14 +0300306#define MMC_QUIRK_NONSTD_FUNC_IF (1<<4) /* SDIO card has nonstd function interfaces */
Ohad Ben-Cohen2059a022011-04-05 18:02:25 +0300307#define MMC_QUIRK_DISABLE_CD (1<<5) /* disconnect CD/DAT[3] resistor */
Andrei Warkentin6a7a6b42011-04-12 15:06:53 -0500308#define MMC_QUIRK_INAND_CMD38 (1<<6) /* iNAND devices have broken CMD38 */
Andrei Warkentind0c97cf2011-05-23 15:06:36 -0500309#define MMC_QUIRK_BLK_NO_CMD23 (1<<7) /* Avoid CMD23 for regular multiblock */
Stefan Nilsson XK9a0da642011-09-15 17:43:04 +0200310#define MMC_QUIRK_BROKEN_BYTE_MODE_512 (1<<8) /* Avoid sending 512 bytes in */
Stefan Nilsson XK6de5fc92011-11-03 09:44:12 +0100311#define MMC_QUIRK_LONG_READ_TIME (1<<9) /* Data read time > CSD says */
Stefan Nilsson XK9a0da642011-09-15 17:43:04 +0200312 /* byte mode */
Pratibhasagar V3a18bbd2012-04-17 14:41:19 +0530313#define MMC_QUIRK_INAND_DATA_TIMEOUT (1<<8) /* For incorrect data timeout */
Saugata Das76058d72012-06-06 17:01:47 -0700314 unsigned int poweroff_notify_state; /* eMMC4.5 notify
315 feature */
Girish K Sbec87262011-10-13 12:04:16 +0530316#define MMC_NO_POWER_NOTIFICATION 0
317#define MMC_POWERED_ON 1
Pierre Ossmane29a7d72007-05-26 13:48:18 +0200318
Adrian Hunterdfe86cb2010-08-11 14:17:46 -0700319 unsigned int erase_size; /* erase size in sectors */
320 unsigned int erase_shift; /* if erase unit is power 2 */
321 unsigned int pref_erase; /* in sectors */
322 u8 erased_byte; /* value of erased bytes */
323
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324 u32 raw_cid[4]; /* raw card CID */
325 u32 raw_csd[4]; /* raw card CSD */
Pierre Ossmanb57c43a2005-09-06 15:18:53 -0700326 u32 raw_scr[2]; /* raw card SCR */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327 struct mmc_cid cid; /* card identification */
328 struct mmc_csd csd; /* card specific */
Philip Langdalebce40a32006-10-21 12:35:02 +0200329 struct mmc_ext_csd ext_csd; /* mmc v4 extended card specific */
Pierre Ossmanb57c43a2005-09-06 15:18:53 -0700330 struct sd_scr scr; /* extra SD information */
Adrian Hunterdfe86cb2010-08-11 14:17:46 -0700331 struct sd_ssr ssr; /* yet more SD information */
Pierre Ossman7ccd2662006-11-08 23:03:10 +0100332 struct sd_switch_caps sw_caps; /* switch (CMD6) caps */
Pierre Ossmane29a7d72007-05-26 13:48:18 +0200333
334 unsigned int sdio_funcs; /* number of SDIO functions */
Pierre Ossman35c66c12007-06-11 20:25:43 +0200335 struct sdio_cccr cccr; /* common card info */
Pierre Ossman1a632f82007-07-30 15:15:30 +0200336 struct sdio_cis cis; /* common tuple info */
Pierre Ossmane29a7d72007-05-26 13:48:18 +0200337 struct sdio_func *sdio_func[SDIO_MAX_FUNCS]; /* SDIO functions (devices) */
Stefan Nilsson XK06e89352011-05-11 17:48:05 +0200338 struct sdio_func *sdio_single_irq; /* SDIO function when only one IRQ active */
Pierre Ossman759bdc72007-09-19 18:42:16 +0200339 unsigned num_info; /* number of info strings */
340 const char **info; /* info strings */
Pierre Ossman1a632f82007-07-30 15:15:30 +0200341 struct sdio_func_tuple *tuples; /* unknown common tuples */
Haavard Skinnemoenf4b7f922008-07-24 14:18:58 +0200342
Arindam Nath49c468f2011-05-05 12:19:01 +0530343 unsigned int sd_bus_speed; /* Bus Speed Mode set for the card */
344
Haavard Skinnemoenf4b7f922008-07-24 14:18:58 +0200345 struct dentry *debugfs_root;
Namjae Jeone0c368d2011-10-06 23:41:38 +0900346 struct mmc_part part[MMC_NUM_PHY_PARTITION]; /* physical partitions */
347 unsigned int nr_parts;
Maya Ereze544d7002012-06-04 06:09:47 +0300348
Tatyana Brokhman464fbe12012-10-07 10:33:13 +0200349 struct mmc_wr_pack_stats wr_pack_stats; /* packed commands stats*/
Maya Erez5f360692012-10-10 03:47:54 +0200350
351 struct mmc_bkops_info bkops_info;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352};
353
Andrei Warkentin32780cd2011-04-11 17:02:15 -0500354/*
Namjae Jeone0c368d2011-10-06 23:41:38 +0900355 * This function fill contents in mmc_part.
356 */
357static inline void mmc_part_add(struct mmc_card *card, unsigned int size,
Johan Rudholmadd710e2011-12-02 08:51:06 +0100358 unsigned int part_cfg, char *name, int idx, bool ro,
359 int area_type)
Namjae Jeone0c368d2011-10-06 23:41:38 +0900360{
361 card->part[card->nr_parts].size = size;
362 card->part[card->nr_parts].part_cfg = part_cfg;
363 sprintf(card->part[card->nr_parts].name, name, idx);
364 card->part[card->nr_parts].force_ro = ro;
Johan Rudholmadd710e2011-12-02 08:51:06 +0100365 card->part[card->nr_parts].area_type = area_type;
Namjae Jeone0c368d2011-10-06 23:41:38 +0900366 card->nr_parts++;
367}
368
Seungwon Jeon53f8f572012-09-27 15:00:26 +0200369static inline bool mmc_large_sec(struct mmc_card *card)
370{
371 return card->ext_csd.data_sector_size == 4096;
372}
373
Namjae Jeone0c368d2011-10-06 23:41:38 +0900374/*
Andrei Warkentin32780cd2011-04-11 17:02:15 -0500375 * The world is not perfect and supplies us with broken mmc/sdio devices.
376 * For at least some of these bugs we need a work-around.
377 */
378
379struct mmc_fixup {
380 /* CID-specific fields. */
381 const char *name;
382
383 /* Valid revision range */
384 u64 rev_start, rev_end;
385
386 unsigned int manfid;
387 unsigned short oemid;
388
389 /* SDIO-specfic fields. You can use SDIO_ANY_ID here of course */
390 u16 cis_vendor, cis_device;
391
392 void (*vendor_fixup)(struct mmc_card *card, int data);
393 int data;
394};
395
Randy Dunlap853c6ca2011-04-12 12:59:09 -0400396#define CID_MANFID_ANY (-1u)
Andrei Warkentin32780cd2011-04-11 17:02:15 -0500397#define CID_OEMID_ANY ((unsigned short) -1)
398#define CID_NAME_ANY (NULL)
399
400#define END_FIXUP { 0 }
401
402#define _FIXUP_EXT(_name, _manfid, _oemid, _rev_start, _rev_end, \
403 _cis_vendor, _cis_device, \
404 _fixup, _data) \
405 { \
406 .name = (_name), \
407 .manfid = (_manfid), \
408 .oemid = (_oemid), \
409 .rev_start = (_rev_start), \
410 .rev_end = (_rev_end), \
411 .cis_vendor = (_cis_vendor), \
412 .cis_device = (_cis_device), \
413 .vendor_fixup = (_fixup), \
414 .data = (_data), \
415 }
416
417#define MMC_FIXUP_REV(_name, _manfid, _oemid, _rev_start, _rev_end, \
418 _fixup, _data) \
419 _FIXUP_EXT(_name, _manfid, \
420 _oemid, _rev_start, _rev_end, \
421 SDIO_ANY_ID, SDIO_ANY_ID, \
422 _fixup, _data) \
423
424#define MMC_FIXUP(_name, _manfid, _oemid, _fixup, _data) \
425 MMC_FIXUP_REV(_name, _manfid, _oemid, 0, -1ull, _fixup, _data)
426
427#define SDIO_FIXUP(_vendor, _device, _fixup, _data) \
428 _FIXUP_EXT(CID_NAME_ANY, CID_MANFID_ANY, \
429 CID_OEMID_ANY, 0, -1ull, \
430 _vendor, _device, \
431 _fixup, _data) \
432
433#define cid_rev(hwrev, fwrev, year, month) \
434 (((u64) hwrev) << 40 | \
435 ((u64) fwrev) << 32 | \
436 ((u64) year) << 16 | \
437 ((u64) month))
438
439#define cid_rev_card(card) \
440 cid_rev(card->cid.hwrev, \
441 card->cid.fwrev, \
442 card->cid.year, \
443 card->cid.month)
444
445/*
Andrei Warkentinc59de922011-05-23 15:06:35 -0500446 * Unconditionally quirk add/remove.
Andrei Warkentin32780cd2011-04-11 17:02:15 -0500447 */
Andrei Warkentinc59de922011-05-23 15:06:35 -0500448
Andrei Warkentin32780cd2011-04-11 17:02:15 -0500449static inline void __maybe_unused add_quirk(struct mmc_card *card, int data)
450{
451 card->quirks |= data;
452}
453
Andrei Warkentin32780cd2011-04-11 17:02:15 -0500454static inline void __maybe_unused remove_quirk(struct mmc_card *card, int data)
455{
456 card->quirks &= ~data;
457}
Pierre Tardy57f0adc2011-02-06 19:03:46 +0100458
Pierre Ossman9c2c0af2006-12-26 15:25:58 +0100459#define mmc_card_mmc(c) ((c)->type == MMC_TYPE_MMC)
460#define mmc_card_sd(c) ((c)->type == MMC_TYPE_SD)
Pierre Ossman5c4e6f12007-05-21 20:23:20 +0200461#define mmc_card_sdio(c) ((c)->type == MMC_TYPE_SDIO)
Pierre Ossman9c2c0af2006-12-26 15:25:58 +0100462
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463#define mmc_card_present(c) ((c)->state & MMC_STATE_PRESENT)
Pierre Ossmana00fc092005-09-06 15:18:52 -0700464#define mmc_card_readonly(c) ((c)->state & MMC_STATE_READONLY)
Philip Langdalebce40a32006-10-21 12:35:02 +0200465#define mmc_card_highspeed(c) ((c)->state & MMC_STATE_HIGHSPEED)
Girish K Sa4924c72012-01-11 14:04:52 -0500466#define mmc_card_hs200(c) ((c)->state & MMC_STATE_HIGHSPEED_200)
Philip Langdalefba68bd2007-01-04 06:57:32 -0800467#define mmc_card_blockaddr(c) ((c)->state & MMC_STATE_BLOCKADDR)
Hanumath Prasaddfc13e82010-09-30 17:37:23 -0400468#define mmc_card_ddr_mode(c) ((c)->state & MMC_STATE_HIGHSPEED_DDR)
Philip Rakitya303c532011-11-14 19:14:38 -0800469#define mmc_card_uhs(c) ((c)->state & MMC_STATE_ULTRAHIGHSPEED)
470#define mmc_sd_card_uhs(c) ((c)->state & MMC_STATE_ULTRAHIGHSPEED)
Arindam Nath3a303512011-05-05 12:19:03 +0530471#define mmc_card_ext_capacity(c) ((c)->state & MMC_CARD_SDXC)
Adrian Hunterd3049502011-11-28 16:22:00 +0200472#define mmc_card_removed(c) ((c) && ((c)->state & MMC_CARD_REMOVED))
Girish K S3e73c362012-01-31 15:44:03 +0530473#define mmc_card_is_sleep(c) ((c)->state & MMC_STATE_SLEEP)
Jaehoon Chungc1a56a12012-09-24 14:44:45 +0200474#define mmc_card_doing_bkops(c) ((c)->state & MMC_STATE_DOING_BKOPS)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475
476#define mmc_card_set_present(c) ((c)->state |= MMC_STATE_PRESENT)
Pierre Ossmana00fc092005-09-06 15:18:52 -0700477#define mmc_card_set_readonly(c) ((c)->state |= MMC_STATE_READONLY)
Philip Langdalebce40a32006-10-21 12:35:02 +0200478#define mmc_card_set_highspeed(c) ((c)->state |= MMC_STATE_HIGHSPEED)
Girish K Sa4924c72012-01-11 14:04:52 -0500479#define mmc_card_set_hs200(c) ((c)->state |= MMC_STATE_HIGHSPEED_200)
Philip Langdalefba68bd2007-01-04 06:57:32 -0800480#define mmc_card_set_blockaddr(c) ((c)->state |= MMC_STATE_BLOCKADDR)
Hanumath Prasaddfc13e82010-09-30 17:37:23 -0400481#define mmc_card_set_ddr_mode(c) ((c)->state |= MMC_STATE_HIGHSPEED_DDR)
Philip Rakitya303c532011-11-14 19:14:38 -0800482#define mmc_card_set_uhs(c) ((c)->state |= MMC_STATE_ULTRAHIGHSPEED)
Arindam Nath3a303512011-05-05 12:19:03 +0530483#define mmc_sd_card_set_uhs(c) ((c)->state |= MMC_STATE_ULTRAHIGHSPEED)
484#define mmc_card_set_ext_capacity(c) ((c)->state |= MMC_CARD_SDXC)
Adrian Hunterd3049502011-11-28 16:22:00 +0200485#define mmc_card_set_removed(c) ((c)->state |= MMC_CARD_REMOVED)
Girish K S3e73c362012-01-31 15:44:03 +0530486#define mmc_card_set_sleep(c) ((c)->state |= MMC_STATE_SLEEP)
Jaehoon Chungc1a56a12012-09-24 14:44:45 +0200487#define mmc_card_set_doing_bkops(c) ((c)->state |= MMC_STATE_DOING_BKOPS)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488
Jaehoon Chungc1a56a12012-09-24 14:44:45 +0200489#define mmc_card_clr_doing_bkops(c) ((c)->state &= ~MMC_STATE_DOING_BKOPS)
Girish K S3e73c362012-01-31 15:44:03 +0530490#define mmc_card_clr_sleep(c) ((c)->state &= ~MMC_STATE_SLEEP)
Andrei Warkentinc59de922011-05-23 15:06:35 -0500491/*
492 * Quirk add/remove for MMC products.
493 */
494
495static inline void __maybe_unused add_quirk_mmc(struct mmc_card *card, int data)
496{
497 if (mmc_card_mmc(card))
498 card->quirks |= data;
499}
500
501static inline void __maybe_unused remove_quirk_mmc(struct mmc_card *card,
502 int data)
503{
504 if (mmc_card_mmc(card))
505 card->quirks &= ~data;
506}
507
508/*
509 * Quirk add/remove for SD products.
510 */
511
512static inline void __maybe_unused add_quirk_sd(struct mmc_card *card, int data)
513{
514 if (mmc_card_sd(card))
515 card->quirks |= data;
516}
517
518static inline void __maybe_unused remove_quirk_sd(struct mmc_card *card,
519 int data)
520{
521 if (mmc_card_sd(card))
522 card->quirks &= ~data;
523}
524
Ohad Ben-Cohen7c979ec2009-09-22 16:45:18 -0700525static inline int mmc_card_lenient_fn0(const struct mmc_card *c)
526{
527 return c->quirks & MMC_QUIRK_LENIENT_FN0;
528}
529
Bing Zhao3fb7fb42010-03-05 13:43:25 -0800530static inline int mmc_blksz_for_byte_mode(const struct mmc_card *c)
531{
532 return c->quirks & MMC_QUIRK_BLKSZ_FOR_BYTE_MODE;
533}
534
Ohad Ben-Cohen2059a022011-04-05 18:02:25 +0300535static inline int mmc_card_disable_cd(const struct mmc_card *c)
536{
537 return c->quirks & MMC_QUIRK_DISABLE_CD;
538}
539
Ohad Ben-Coheneab40682011-04-05 17:50:14 +0300540static inline int mmc_card_nonstd_func_interface(const struct mmc_card *c)
541{
542 return c->quirks & MMC_QUIRK_NONSTD_FUNC_IF;
543}
544
Stefan Nilsson XK9a0da642011-09-15 17:43:04 +0200545static inline int mmc_card_broken_byte_mode_512(const struct mmc_card *c)
546{
547 return c->quirks & MMC_QUIRK_BROKEN_BYTE_MODE_512;
548}
549
Stefan Nilsson XK6de5fc92011-11-03 09:44:12 +0100550static inline int mmc_card_long_read_time(const struct mmc_card *c)
551{
552 return c->quirks & MMC_QUIRK_LONG_READ_TIME;
553}
554
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555#define mmc_card_name(c) ((c)->cid.prod_name)
Kay Sieversd1b26862008-11-08 21:37:46 +0100556#define mmc_card_id(c) (dev_name(&(c)->dev))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557
Andy Shevchenko265cdc92010-09-17 20:32:25 -0400558#define mmc_dev_to_card(d) container_of(d, struct mmc_card, dev)
Andy Shevchenko453722b2010-08-20 10:46:46 +0300559
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560#define mmc_list_to_card(l) container_of(l, struct mmc_card, node)
561#define mmc_get_drvdata(c) dev_get_drvdata(&(c)->dev)
562#define mmc_set_drvdata(c,d) dev_set_drvdata(&(c)->dev, d)
563
564/*
565 * MMC device driver (e.g., Flash card, I/O card...)
566 */
567struct mmc_driver {
568 struct device_driver drv;
569 int (*probe)(struct mmc_card *);
570 void (*remove)(struct mmc_card *);
Chuanxiao Dong32d317c2012-04-11 19:54:38 +0800571 int (*suspend)(struct mmc_card *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572 int (*resume)(struct mmc_card *);
573};
574
575extern int mmc_register_driver(struct mmc_driver *);
576extern void mmc_unregister_driver(struct mmc_driver *);
577
Andrei Warkentin32780cd2011-04-11 17:02:15 -0500578extern void mmc_fixup_device(struct mmc_card *card,
579 const struct mmc_fixup *table);
Tatyana Brokhman464fbe12012-10-07 10:33:13 +0200580extern struct mmc_wr_pack_stats *mmc_blk_get_packed_statistics(
581 struct mmc_card *card);
582extern void mmc_blk_init_packed_statistics(struct mmc_card *card);
Andrei Warkentin32780cd2011-04-11 17:02:15 -0500583
Robert P. J. Day100e9182011-05-27 16:04:03 -0400584#endif /* LINUX_MMC_CARD_H */