blob: e5927095dd8c6fcded4d09c5d2847ab0f626fb62 [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 Jeon79b87fe2012-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 */
Maya Erezf44e64b2012-10-19 20:18:17 +020063 u8 power_off_notification; /* state */
Philip Langdalebce40a32006-10-21 12:35:02 +020064 unsigned int hs_max_dtr;
Seungwon Jeonfe201cd2012-04-25 16:17:37 +090065#define MMC_HIGH_26_MAX_DTR 26000000
66#define MMC_HIGH_52_MAX_DTR 52000000
67#define MMC_HIGH_DDR_MAX_DTR 52000000
68#define MMC_HS200_MAX_DTR 200000000
Pierre Ossman85a18ad2007-02-17 22:15:27 +010069 unsigned int sectors;
Hanumath Prasaddfc13e82010-09-30 17:37:23 -040070 unsigned int card_type;
Adrian Hunterdfe86cb2010-08-11 14:17:46 -070071 unsigned int hc_erase_size; /* In sectors */
72 unsigned int hc_erase_timeout; /* In milliseconds */
73 unsigned int sec_trim_mult; /* Secure trim multiplier */
74 unsigned int sec_erase_mult; /* Secure erase multiplier */
75 unsigned int trim_timeout; /* In milliseconds */
Chuanxiao Dong709de992011-01-22 04:09:41 +080076 bool enhanced_area_en; /* enable bit */
77 unsigned long long enhanced_area_offset; /* Units: Byte */
78 unsigned int enhanced_area_size; /* Units: KB */
Seungwon Jeon881d1c22011-10-14 14:03:21 +090079 unsigned int cache_size; /* Units: KB */
Jaehoon Chungeb0d8f12011-10-18 01:26:42 -040080 bool hpi_en; /* HPI enablebit */
81 bool hpi; /* HPI support bit */
82 unsigned int hpi_cmd; /* cmd used as HPI */
Jaehoon Chungb12ed0e2012-09-24 14:44:45 +020083 bool bkops; /* background support bit */
84 bool bkops_en; /* background enable bit */
Saugata Das42659002011-12-21 13:09:17 +053085 unsigned int data_sector_size; /* 512 bytes or 4KB */
86 unsigned int data_tag_unit_size; /* DATA TAG UNIT size */
Johan Rudholmadd710e2011-12-02 08:51:06 +010087 unsigned int boot_ro_lock; /* ro lock support */
88 bool boot_ro_lockable;
Jaehoon Chungb12ed0e2012-09-24 14:44:45 +020089 u8 raw_exception_status; /* 53 */
Philip Rakityf39b2dd2011-07-07 09:04:55 -070090 u8 raw_partition_support; /* 160 */
91 u8 raw_erased_mem_count; /* 181 */
92 u8 raw_ext_csd_structure; /* 194 */
93 u8 raw_card_type; /* 196 */
Jaehoon Chungeb0d8f12011-10-18 01:26:42 -040094 u8 out_of_int_time; /* 198 */
Philip Rakityf39b2dd2011-07-07 09:04:55 -070095 u8 raw_s_a_timeout; /* 217 */
96 u8 raw_hc_erase_gap_size; /* 221 */
97 u8 raw_erase_timeout_mult; /* 223 */
98 u8 raw_hc_erase_grp_size; /* 224 */
99 u8 raw_sec_trim_mult; /* 229 */
100 u8 raw_sec_erase_mult; /* 230 */
101 u8 raw_sec_feature_support;/* 231 */
102 u8 raw_trim_mult; /* 232 */
Jaehoon Chungb12ed0e2012-09-24 14:44:45 +0200103 u8 raw_bkops_status; /* 246 */
Philip Rakityf39b2dd2011-07-07 09:04:55 -0700104 u8 raw_sectors[4]; /* 212 - 4 bytes */
Kyungmin Parkb3bf9152011-10-18 09:34:04 +0900105
106 unsigned int feature_support;
107#define MMC_DISCARD_FEATURE BIT(0) /* CMD38 feature */
Philip Langdalebce40a32006-10-21 12:35:02 +0200108};
109
Pierre Ossmanb57c43a2005-09-06 15:18:53 -0700110struct sd_scr {
111 unsigned char sda_vsn;
Arindam Nath013909c2011-05-05 12:18:58 +0530112 unsigned char sda_spec3;
Pierre Ossmanb57c43a2005-09-06 15:18:53 -0700113 unsigned char bus_widths;
114#define SD_SCR_BUS_WIDTH_1 (1<<0)
115#define SD_SCR_BUS_WIDTH_4 (1<<2)
Andrei Warkentinf0d89972011-05-23 15:06:38 -0500116 unsigned char cmds;
117#define SD_SCR_CMD20_SUPPORT (1<<0)
118#define SD_SCR_CMD23_SUPPORT (1<<1)
Pierre Ossmanb57c43a2005-09-06 15:18:53 -0700119};
120
Adrian Hunterdfe86cb2010-08-11 14:17:46 -0700121struct sd_ssr {
122 unsigned int au; /* In sectors */
123 unsigned int erase_timeout; /* In milliseconds */
124 unsigned int erase_offset; /* In milliseconds */
125};
126
Pierre Ossman7ccd2662006-11-08 23:03:10 +0100127struct sd_switch_caps {
128 unsigned int hs_max_dtr;
Arindam Nath49c468f2011-05-05 12:19:01 +0530129 unsigned int uhs_max_dtr;
Qiang Liufffe5d52011-11-08 08:43:08 -0500130#define HIGH_SPEED_MAX_DTR 50000000
Arindam Nath49c468f2011-05-05 12:19:01 +0530131#define UHS_SDR104_MAX_DTR 208000000
132#define UHS_SDR50_MAX_DTR 100000000
133#define UHS_DDR50_MAX_DTR 50000000
134#define UHS_SDR25_MAX_DTR UHS_DDR50_MAX_DTR
135#define UHS_SDR12_MAX_DTR 25000000
Arindam Nath013909c2011-05-05 12:18:58 +0530136 unsigned int sd3_bus_mode;
Arindam Nath49c468f2011-05-05 12:19:01 +0530137#define UHS_SDR12_BUS_SPEED 0
Qiang Liufffe5d52011-11-08 08:43:08 -0500138#define HIGH_SPEED_BUS_SPEED 1
Arindam Nath49c468f2011-05-05 12:19:01 +0530139#define UHS_SDR25_BUS_SPEED 1
140#define UHS_SDR50_BUS_SPEED 2
141#define UHS_SDR104_BUS_SPEED 3
142#define UHS_DDR50_BUS_SPEED 4
143
Qiang Liufffe5d52011-11-08 08:43:08 -0500144#define SD_MODE_HIGH_SPEED (1 << HIGH_SPEED_BUS_SPEED)
Arindam Nath49c468f2011-05-05 12:19:01 +0530145#define SD_MODE_UHS_SDR12 (1 << UHS_SDR12_BUS_SPEED)
146#define SD_MODE_UHS_SDR25 (1 << UHS_SDR25_BUS_SPEED)
147#define SD_MODE_UHS_SDR50 (1 << UHS_SDR50_BUS_SPEED)
148#define SD_MODE_UHS_SDR104 (1 << UHS_SDR104_BUS_SPEED)
149#define SD_MODE_UHS_DDR50 (1 << UHS_DDR50_BUS_SPEED)
Arindam Nath013909c2011-05-05 12:18:58 +0530150 unsigned int sd3_drv_type;
Arindam Nathd6d50a12011-05-05 12:18:59 +0530151#define SD_DRIVER_TYPE_B 0x01
152#define SD_DRIVER_TYPE_A 0x02
153#define SD_DRIVER_TYPE_C 0x04
154#define SD_DRIVER_TYPE_D 0x08
Arindam Nath013909c2011-05-05 12:18:58 +0530155 unsigned int sd3_curr_limit;
Arindam Nath5371c922011-05-05 12:19:02 +0530156#define SD_SET_CURRENT_LIMIT_200 0
157#define SD_SET_CURRENT_LIMIT_400 1
158#define SD_SET_CURRENT_LIMIT_600 2
159#define SD_SET_CURRENT_LIMIT_800 3
160
161#define SD_MAX_CURRENT_200 (1 << SD_SET_CURRENT_LIMIT_200)
162#define SD_MAX_CURRENT_400 (1 << SD_SET_CURRENT_LIMIT_400)
163#define SD_MAX_CURRENT_600 (1 << SD_SET_CURRENT_LIMIT_600)
164#define SD_MAX_CURRENT_800 (1 << SD_SET_CURRENT_LIMIT_800)
Pierre Ossman7ccd2662006-11-08 23:03:10 +0100165};
166
Pierre Ossman35c66c12007-06-11 20:25:43 +0200167struct sdio_cccr {
168 unsigned int sdio_vsn;
169 unsigned int sd_vsn;
170 unsigned int multi_block:1,
171 low_speed:1,
172 wide_bus:1,
173 high_power:1,
Ohad Ben-Cohen006ebd52009-09-22 16:45:07 -0700174 high_speed:1,
175 disable_cd:1;
Pierre Ossman35c66c12007-06-11 20:25:43 +0200176};
177
Pierre Ossman1a632f82007-07-30 15:15:30 +0200178struct sdio_cis {
179 unsigned short vendor;
180 unsigned short device;
181 unsigned short blksize;
182 unsigned int max_dtr;
183};
184
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185struct mmc_host;
Pierre Ossmane29a7d72007-05-26 13:48:18 +0200186struct sdio_func;
Pierre Ossman1a632f82007-07-30 15:15:30 +0200187struct sdio_func_tuple;
Pierre Ossmane29a7d72007-05-26 13:48:18 +0200188
189#define SDIO_MAX_FUNCS 7
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190
Tatyana Brokhman10217bc2012-10-07 10:33:13 +0200191enum mmc_packed_stop_reasons {
192 EXCEEDS_SEGMENTS = 0,
193 EXCEEDS_SECTORS,
194 WRONG_DATA_DIR,
195 FLUSH_OR_DISCARD,
196 EMPTY_QUEUE,
197 REL_WRITE,
198 THRESHOLD,
Tatyana Brokhmana07f7712012-10-04 11:11:08 +0200199 LARGE_SEC_ALIGN,
Tatyana Brokhman10217bc2012-10-07 10:33:13 +0200200 MAX_REASONS,
201};
202
203struct mmc_wr_pack_stats {
204 u32 *packing_events;
205 u32 pack_stop_reason[MAX_REASONS];
206 spinlock_t lock;
207 bool enabled;
208 bool print_in_read;
209};
210
Namjae Jeone0c368d2011-10-06 23:41:38 +0900211/* The number of MMC physical partitions. These consist of:
212 * boot partitions (2), general purpose partitions (4) in MMC v4.4.
213 */
214#define MMC_NUM_BOOT_PARTITION 2
215#define MMC_NUM_GP_PARTITION 4
216#define MMC_NUM_PHY_PARTITION 6
Namjae Jeona6029e12011-10-13 00:43:14 +0900217#define MAX_MMC_PART_NAME_LEN 20
Namjae Jeone0c368d2011-10-06 23:41:38 +0900218
219/*
220 * MMC Physical partitions
221 */
222struct mmc_part {
223 unsigned int size; /* partition size (in bytes) */
224 unsigned int part_cfg; /* partition type */
Namjae Jeona6029e12011-10-13 00:43:14 +0900225 char name[MAX_MMC_PART_NAME_LEN];
Namjae Jeone0c368d2011-10-06 23:41:38 +0900226 bool force_ro; /* to make boot parts RO by default */
Johan Rudholmadd710e2011-12-02 08:51:06 +0100227 unsigned int area_type;
228#define MMC_BLK_DATA_AREA_MAIN (1<<0)
229#define MMC_BLK_DATA_AREA_BOOT (1<<1)
230#define MMC_BLK_DATA_AREA_GP (1<<2)
Namjae Jeone0c368d2011-10-06 23:41:38 +0900231};
232
Maya Erez5c46dad2012-10-10 03:47:54 +0200233/**
234 * struct mmc_bkops_info - BKOPS data
235 * @dw: Idle time bkops delayed work
Maya Erez67c157c2013-01-16 09:29:10 +0200236 * @host_delay_ms: The host controller time to start bkops
Maya Erez5c46dad2012-10-10 03:47:54 +0200237 * @delay_ms: The time to start the BKOPS
238 * delayed work once MMC thread is idle
Maya Erez860cef92013-01-16 09:48:25 +0200239 * @min_sectors_to_queue_delayed_work: the changed
240 * number of sectors that should issue check for BKOPS
241 * need
242 * @size_percentage_to_queue_delayed_work: the changed
243 * percentage of sectors that should issue check for
244 * BKOPS need
Maya Erez5c46dad2012-10-10 03:47:54 +0200245 * @poll_for_completion: Poll on BKOPS completion
246 * @cancel_delayed_work: A flag to indicate if the delayed work
247 * should be cancelled
Maya Erez5c46dad2012-10-10 03:47:54 +0200248 * @sectors_changed: number of sectors written or
249 * discard since the last idle BKOPS were scheduled
250 */
251struct mmc_bkops_info {
252 struct delayed_work dw;
Maya Erez67c157c2013-01-16 09:29:10 +0200253 unsigned int host_delay_ms;
Maya Erez5c46dad2012-10-10 03:47:54 +0200254 unsigned int delay_ms;
Yaniv Gardiab0b6b02012-10-11 11:36:24 +0200255 unsigned int min_sectors_to_queue_delayed_work;
Maya Erez860cef92013-01-16 09:48:25 +0200256 unsigned int size_percentage_to_queue_delayed_work;
Maya Erez5c46dad2012-10-10 03:47:54 +0200257/*
258 * A default time for checking the need for non urgent BKOPS once mmcqd
259 * is idle.
260 */
Maya Erez67c157c2013-01-16 09:29:10 +0200261#define MMC_IDLE_BKOPS_TIME_MS 200
Maya Erez5c46dad2012-10-10 03:47:54 +0200262 struct work_struct poll_for_completion;
263/* Polling timeout and interval for waiting on non-blocking BKOPs completion */
Maya Erez014010d2013-01-04 11:04:47 +0200264#define BKOPS_COMPLETION_POLLING_TIMEOUT_MS (4 * 60 * 1000) /* in ms */
Maya Erez5c46dad2012-10-10 03:47:54 +0200265#define BKOPS_COMPLETION_POLLING_INTERVAL_MS 1000 /* in ms */
266 bool cancel_delayed_work;
Maya Erez5c46dad2012-10-10 03:47:54 +0200267 unsigned int sectors_changed;
268/*
269 * Since canceling the delayed work might have significant effect on the
270 * performance of small requests we won't queue the delayed work every time
271 * mmcqd thread is idle.
272 * The delayed work for idle BKOPS will be scheduled only after a significant
273 * amount of write or discard data.
Maya Erez5c46dad2012-10-10 03:47:54 +0200274 */
Maya Erez860cef92013-01-16 09:48:25 +0200275#define BKOPS_SIZE_PERCENTAGE_TO_QUEUE_DELAYED_WORK 1 /* 1% */
Maya Erez5c46dad2012-10-10 03:47:54 +0200276};
277
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278/*
279 * MMC device
280 */
281struct mmc_card {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282 struct mmc_host *host; /* the host this device belongs to */
283 struct device dev; /* the device */
284 unsigned int rca; /* relative card address of device */
Pierre Ossman9c2c0af2006-12-26 15:25:58 +0100285 unsigned int type; /* card type */
286#define MMC_TYPE_MMC 0 /* MMC card */
287#define MMC_TYPE_SD 1 /* SD card */
Pierre Ossman5c4e6f12007-05-21 20:23:20 +0200288#define MMC_TYPE_SDIO 2 /* SDIO card */
Michal Miroslaw7310ece2010-08-10 18:01:40 -0700289#define MMC_TYPE_SD_COMBO 3 /* SD combo (IO+mem) card */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290 unsigned int state; /* (our) card state */
291#define MMC_STATE_PRESENT (1<<0) /* present in sysfs */
Pierre Ossmanbd766312007-05-01 16:11:57 +0200292#define MMC_STATE_READONLY (1<<1) /* card is read-only */
293#define MMC_STATE_HIGHSPEED (1<<2) /* card is in high speed mode */
294#define MMC_STATE_BLOCKADDR (1<<3) /* card uses block-addressing */
Hanumath Prasaddfc13e82010-09-30 17:37:23 -0400295#define MMC_STATE_HIGHSPEED_DDR (1<<4) /* card is in high speed mode */
Arindam Nath3a303512011-05-05 12:19:03 +0530296#define MMC_STATE_ULTRAHIGHSPEED (1<<5) /* card is in ultra high speed mode */
297#define MMC_CARD_SDXC (1<<6) /* card is SDXC */
Adrian Hunterd3049502011-11-28 16:22:00 +0200298#define MMC_CARD_REMOVED (1<<7) /* card has been removed */
Girish K Sa4924c72012-01-11 14:04:52 -0500299#define MMC_STATE_HIGHSPEED_200 (1<<8) /* card is in HS200 mode */
Jaehoon Chungb12ed0e2012-09-24 14:44:45 +0200300#define MMC_STATE_DOING_BKOPS (1<<10) /* card is doing BKOPS */
Maya Erezec0bbad2013-01-16 09:43:45 +0200301#define MMC_STATE_NEED_BKOPS (1<<11) /* card needs to do BKOPS */
Ohad Ben-Cohen7c979ec2009-09-22 16:45:18 -0700302 unsigned int quirks; /* card quirks */
303#define MMC_QUIRK_LENIENT_FN0 (1<<0) /* allow SDIO FN0 writes outside of the VS CCCR range */
Bing Zhao3fb7fb42010-03-05 13:43:25 -0800304#define MMC_QUIRK_BLKSZ_FOR_BYTE_MODE (1<<1) /* use func->cur_blksize */
305 /* for byte mode */
Grazvydas Ignotas6f51be32010-08-10 18:01:50 -0700306#define MMC_QUIRK_NONSTD_SDIO (1<<2) /* non-standard SDIO card attached */
307 /* (missing CIA registers) */
Pierre Tardydb993502011-02-06 19:03:47 +0100308#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 +0300309#define MMC_QUIRK_NONSTD_FUNC_IF (1<<4) /* SDIO card has nonstd function interfaces */
Ohad Ben-Cohen2059a022011-04-05 18:02:25 +0300310#define MMC_QUIRK_DISABLE_CD (1<<5) /* disconnect CD/DAT[3] resistor */
Andrei Warkentin6a7a6b42011-04-12 15:06:53 -0500311#define MMC_QUIRK_INAND_CMD38 (1<<6) /* iNAND devices have broken CMD38 */
Andrei Warkentind0c97cf2011-05-23 15:06:36 -0500312#define MMC_QUIRK_BLK_NO_CMD23 (1<<7) /* Avoid CMD23 for regular multiblock */
Stefan Nilsson XK9a0da642011-09-15 17:43:04 +0200313#define MMC_QUIRK_BROKEN_BYTE_MODE_512 (1<<8) /* Avoid sending 512 bytes in */
Stefan Nilsson XK6de5fc92011-11-03 09:44:12 +0100314#define MMC_QUIRK_LONG_READ_TIME (1<<9) /* Data read time > CSD says */
Stefan Nilsson XK9a0da642011-09-15 17:43:04 +0200315 /* byte mode */
Pratibhasagar V3a18bbd2012-04-17 14:41:19 +0530316#define MMC_QUIRK_INAND_DATA_TIMEOUT (1<<8) /* For incorrect data timeout */
Pierre Ossmane29a7d72007-05-26 13:48:18 +0200317
Adrian Hunterdfe86cb2010-08-11 14:17:46 -0700318 unsigned int erase_size; /* erase size in sectors */
319 unsigned int erase_shift; /* if erase unit is power 2 */
320 unsigned int pref_erase; /* in sectors */
321 u8 erased_byte; /* value of erased bytes */
322
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323 u32 raw_cid[4]; /* raw card CID */
324 u32 raw_csd[4]; /* raw card CSD */
Pierre Ossmanb57c43a2005-09-06 15:18:53 -0700325 u32 raw_scr[2]; /* raw card SCR */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326 struct mmc_cid cid; /* card identification */
327 struct mmc_csd csd; /* card specific */
Philip Langdalebce40a32006-10-21 12:35:02 +0200328 struct mmc_ext_csd ext_csd; /* mmc v4 extended card specific */
Pierre Ossmanb57c43a2005-09-06 15:18:53 -0700329 struct sd_scr scr; /* extra SD information */
Adrian Hunterdfe86cb2010-08-11 14:17:46 -0700330 struct sd_ssr ssr; /* yet more SD information */
Pierre Ossman7ccd2662006-11-08 23:03:10 +0100331 struct sd_switch_caps sw_caps; /* switch (CMD6) caps */
Pierre Ossmane29a7d72007-05-26 13:48:18 +0200332
333 unsigned int sdio_funcs; /* number of SDIO functions */
Pierre Ossman35c66c12007-06-11 20:25:43 +0200334 struct sdio_cccr cccr; /* common card info */
Pierre Ossman1a632f82007-07-30 15:15:30 +0200335 struct sdio_cis cis; /* common tuple info */
Pierre Ossmane29a7d72007-05-26 13:48:18 +0200336 struct sdio_func *sdio_func[SDIO_MAX_FUNCS]; /* SDIO functions (devices) */
Stefan Nilsson XK06e89352011-05-11 17:48:05 +0200337 struct sdio_func *sdio_single_irq; /* SDIO function when only one IRQ active */
Pierre Ossman759bdc72007-09-19 18:42:16 +0200338 unsigned num_info; /* number of info strings */
339 const char **info; /* info strings */
Pierre Ossman1a632f82007-07-30 15:15:30 +0200340 struct sdio_func_tuple *tuples; /* unknown common tuples */
Haavard Skinnemoenf4b7f922008-07-24 14:18:58 +0200341
Arindam Nath49c468f2011-05-05 12:19:01 +0530342 unsigned int sd_bus_speed; /* Bus Speed Mode set for the card */
343
Haavard Skinnemoenf4b7f922008-07-24 14:18:58 +0200344 struct dentry *debugfs_root;
Namjae Jeone0c368d2011-10-06 23:41:38 +0900345 struct mmc_part part[MMC_NUM_PHY_PARTITION]; /* physical partitions */
346 unsigned int nr_parts;
Maya Ereze544d7002012-06-04 06:09:47 +0300347
Tatyana Brokhman10217bc2012-10-07 10:33:13 +0200348 struct mmc_wr_pack_stats wr_pack_stats; /* packed commands stats*/
Maya Erez5c46dad2012-10-10 03:47:54 +0200349
350 struct mmc_bkops_info bkops_info;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351};
352
Andrei Warkentin32780cd2011-04-11 17:02:15 -0500353/*
Namjae Jeone0c368d2011-10-06 23:41:38 +0900354 * This function fill contents in mmc_part.
355 */
356static inline void mmc_part_add(struct mmc_card *card, unsigned int size,
Johan Rudholmadd710e2011-12-02 08:51:06 +0100357 unsigned int part_cfg, char *name, int idx, bool ro,
358 int area_type)
Namjae Jeone0c368d2011-10-06 23:41:38 +0900359{
360 card->part[card->nr_parts].size = size;
361 card->part[card->nr_parts].part_cfg = part_cfg;
362 sprintf(card->part[card->nr_parts].name, name, idx);
363 card->part[card->nr_parts].force_ro = ro;
Johan Rudholmadd710e2011-12-02 08:51:06 +0100364 card->part[card->nr_parts].area_type = area_type;
Namjae Jeone0c368d2011-10-06 23:41:38 +0900365 card->nr_parts++;
366}
367
Seungwon Jeon121b8e82012-09-27 15:00:26 +0200368static inline bool mmc_large_sec(struct mmc_card *card)
369{
370 return card->ext_csd.data_sector_size == 4096;
371}
372
Namjae Jeone0c368d2011-10-06 23:41:38 +0900373/*
Andrei Warkentin32780cd2011-04-11 17:02:15 -0500374 * The world is not perfect and supplies us with broken mmc/sdio devices.
375 * For at least some of these bugs we need a work-around.
376 */
377
378struct mmc_fixup {
379 /* CID-specific fields. */
380 const char *name;
381
382 /* Valid revision range */
383 u64 rev_start, rev_end;
384
385 unsigned int manfid;
386 unsigned short oemid;
387
388 /* SDIO-specfic fields. You can use SDIO_ANY_ID here of course */
389 u16 cis_vendor, cis_device;
390
391 void (*vendor_fixup)(struct mmc_card *card, int data);
392 int data;
393};
394
Randy Dunlap853c6ca2011-04-12 12:59:09 -0400395#define CID_MANFID_ANY (-1u)
Andrei Warkentin32780cd2011-04-11 17:02:15 -0500396#define CID_OEMID_ANY ((unsigned short) -1)
397#define CID_NAME_ANY (NULL)
398
399#define END_FIXUP { 0 }
400
401#define _FIXUP_EXT(_name, _manfid, _oemid, _rev_start, _rev_end, \
402 _cis_vendor, _cis_device, \
403 _fixup, _data) \
404 { \
405 .name = (_name), \
406 .manfid = (_manfid), \
407 .oemid = (_oemid), \
408 .rev_start = (_rev_start), \
409 .rev_end = (_rev_end), \
410 .cis_vendor = (_cis_vendor), \
411 .cis_device = (_cis_device), \
412 .vendor_fixup = (_fixup), \
413 .data = (_data), \
414 }
415
416#define MMC_FIXUP_REV(_name, _manfid, _oemid, _rev_start, _rev_end, \
417 _fixup, _data) \
418 _FIXUP_EXT(_name, _manfid, \
419 _oemid, _rev_start, _rev_end, \
420 SDIO_ANY_ID, SDIO_ANY_ID, \
421 _fixup, _data) \
422
423#define MMC_FIXUP(_name, _manfid, _oemid, _fixup, _data) \
424 MMC_FIXUP_REV(_name, _manfid, _oemid, 0, -1ull, _fixup, _data)
425
426#define SDIO_FIXUP(_vendor, _device, _fixup, _data) \
427 _FIXUP_EXT(CID_NAME_ANY, CID_MANFID_ANY, \
428 CID_OEMID_ANY, 0, -1ull, \
429 _vendor, _device, \
430 _fixup, _data) \
431
432#define cid_rev(hwrev, fwrev, year, month) \
433 (((u64) hwrev) << 40 | \
434 ((u64) fwrev) << 32 | \
435 ((u64) year) << 16 | \
436 ((u64) month))
437
438#define cid_rev_card(card) \
439 cid_rev(card->cid.hwrev, \
440 card->cid.fwrev, \
441 card->cid.year, \
442 card->cid.month)
443
444/*
Andrei Warkentinc59de922011-05-23 15:06:35 -0500445 * Unconditionally quirk add/remove.
Andrei Warkentin32780cd2011-04-11 17:02:15 -0500446 */
Andrei Warkentinc59de922011-05-23 15:06:35 -0500447
Andrei Warkentin32780cd2011-04-11 17:02:15 -0500448static inline void __maybe_unused add_quirk(struct mmc_card *card, int data)
449{
450 card->quirks |= data;
451}
452
Andrei Warkentin32780cd2011-04-11 17:02:15 -0500453static inline void __maybe_unused remove_quirk(struct mmc_card *card, int data)
454{
455 card->quirks &= ~data;
456}
Pierre Tardy57f0adc2011-02-06 19:03:46 +0100457
Pierre Ossman9c2c0af2006-12-26 15:25:58 +0100458#define mmc_card_mmc(c) ((c)->type == MMC_TYPE_MMC)
459#define mmc_card_sd(c) ((c)->type == MMC_TYPE_SD)
Pierre Ossman5c4e6f12007-05-21 20:23:20 +0200460#define mmc_card_sdio(c) ((c)->type == MMC_TYPE_SDIO)
Pierre Ossman9c2c0af2006-12-26 15:25:58 +0100461
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462#define mmc_card_present(c) ((c)->state & MMC_STATE_PRESENT)
Pierre Ossmana00fc092005-09-06 15:18:52 -0700463#define mmc_card_readonly(c) ((c)->state & MMC_STATE_READONLY)
Philip Langdalebce40a32006-10-21 12:35:02 +0200464#define mmc_card_highspeed(c) ((c)->state & MMC_STATE_HIGHSPEED)
Girish K Sa4924c72012-01-11 14:04:52 -0500465#define mmc_card_hs200(c) ((c)->state & MMC_STATE_HIGHSPEED_200)
Philip Langdalefba68bd2007-01-04 06:57:32 -0800466#define mmc_card_blockaddr(c) ((c)->state & MMC_STATE_BLOCKADDR)
Hanumath Prasaddfc13e82010-09-30 17:37:23 -0400467#define mmc_card_ddr_mode(c) ((c)->state & MMC_STATE_HIGHSPEED_DDR)
Philip Rakitya303c532011-11-14 19:14:38 -0800468#define mmc_card_uhs(c) ((c)->state & MMC_STATE_ULTRAHIGHSPEED)
469#define mmc_sd_card_uhs(c) ((c)->state & MMC_STATE_ULTRAHIGHSPEED)
Arindam Nath3a303512011-05-05 12:19:03 +0530470#define mmc_card_ext_capacity(c) ((c)->state & MMC_CARD_SDXC)
Adrian Hunterd3049502011-11-28 16:22:00 +0200471#define mmc_card_removed(c) ((c) && ((c)->state & MMC_CARD_REMOVED))
Jaehoon Chungb12ed0e2012-09-24 14:44:45 +0200472#define mmc_card_doing_bkops(c) ((c)->state & MMC_STATE_DOING_BKOPS)
Maya Erezec0bbad2013-01-16 09:43:45 +0200473#define mmc_card_need_bkops(c) ((c)->state & MMC_STATE_NEED_BKOPS)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474
475#define mmc_card_set_present(c) ((c)->state |= MMC_STATE_PRESENT)
Pierre Ossmana00fc092005-09-06 15:18:52 -0700476#define mmc_card_set_readonly(c) ((c)->state |= MMC_STATE_READONLY)
Philip Langdalebce40a32006-10-21 12:35:02 +0200477#define mmc_card_set_highspeed(c) ((c)->state |= MMC_STATE_HIGHSPEED)
Girish K Sa4924c72012-01-11 14:04:52 -0500478#define mmc_card_set_hs200(c) ((c)->state |= MMC_STATE_HIGHSPEED_200)
Philip Langdalefba68bd2007-01-04 06:57:32 -0800479#define mmc_card_set_blockaddr(c) ((c)->state |= MMC_STATE_BLOCKADDR)
Hanumath Prasaddfc13e82010-09-30 17:37:23 -0400480#define mmc_card_set_ddr_mode(c) ((c)->state |= MMC_STATE_HIGHSPEED_DDR)
Philip Rakitya303c532011-11-14 19:14:38 -0800481#define mmc_card_set_uhs(c) ((c)->state |= MMC_STATE_ULTRAHIGHSPEED)
Arindam Nath3a303512011-05-05 12:19:03 +0530482#define mmc_sd_card_set_uhs(c) ((c)->state |= MMC_STATE_ULTRAHIGHSPEED)
483#define mmc_card_set_ext_capacity(c) ((c)->state |= MMC_CARD_SDXC)
Adrian Hunterd3049502011-11-28 16:22:00 +0200484#define mmc_card_set_removed(c) ((c)->state |= MMC_CARD_REMOVED)
Jaehoon Chungb12ed0e2012-09-24 14:44:45 +0200485#define mmc_card_set_doing_bkops(c) ((c)->state |= MMC_STATE_DOING_BKOPS)
Jaehoon Chungb12ed0e2012-09-24 14:44:45 +0200486#define mmc_card_clr_doing_bkops(c) ((c)->state &= ~MMC_STATE_DOING_BKOPS)
Maya Erezec0bbad2013-01-16 09:43:45 +0200487#define mmc_card_set_need_bkops(c) ((c)->state |= MMC_STATE_NEED_BKOPS)
488#define mmc_card_clr_need_bkops(c) ((c)->state &= ~MMC_STATE_NEED_BKOPS)
Andrei Warkentinc59de922011-05-23 15:06:35 -0500489/*
490 * Quirk add/remove for MMC products.
491 */
492
493static inline void __maybe_unused add_quirk_mmc(struct mmc_card *card, int data)
494{
495 if (mmc_card_mmc(card))
496 card->quirks |= data;
497}
498
499static inline void __maybe_unused remove_quirk_mmc(struct mmc_card *card,
500 int data)
501{
502 if (mmc_card_mmc(card))
503 card->quirks &= ~data;
504}
505
506/*
507 * Quirk add/remove for SD products.
508 */
509
510static inline void __maybe_unused add_quirk_sd(struct mmc_card *card, int data)
511{
512 if (mmc_card_sd(card))
513 card->quirks |= data;
514}
515
516static inline void __maybe_unused remove_quirk_sd(struct mmc_card *card,
517 int data)
518{
519 if (mmc_card_sd(card))
520 card->quirks &= ~data;
521}
522
Ohad Ben-Cohen7c979ec2009-09-22 16:45:18 -0700523static inline int mmc_card_lenient_fn0(const struct mmc_card *c)
524{
525 return c->quirks & MMC_QUIRK_LENIENT_FN0;
526}
527
Bing Zhao3fb7fb42010-03-05 13:43:25 -0800528static inline int mmc_blksz_for_byte_mode(const struct mmc_card *c)
529{
530 return c->quirks & MMC_QUIRK_BLKSZ_FOR_BYTE_MODE;
531}
532
Ohad Ben-Cohen2059a022011-04-05 18:02:25 +0300533static inline int mmc_card_disable_cd(const struct mmc_card *c)
534{
535 return c->quirks & MMC_QUIRK_DISABLE_CD;
536}
537
Ohad Ben-Coheneab40682011-04-05 17:50:14 +0300538static inline int mmc_card_nonstd_func_interface(const struct mmc_card *c)
539{
540 return c->quirks & MMC_QUIRK_NONSTD_FUNC_IF;
541}
542
Stefan Nilsson XK9a0da642011-09-15 17:43:04 +0200543static inline int mmc_card_broken_byte_mode_512(const struct mmc_card *c)
544{
545 return c->quirks & MMC_QUIRK_BROKEN_BYTE_MODE_512;
546}
547
Stefan Nilsson XK6de5fc92011-11-03 09:44:12 +0100548static inline int mmc_card_long_read_time(const struct mmc_card *c)
549{
550 return c->quirks & MMC_QUIRK_LONG_READ_TIME;
551}
552
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553#define mmc_card_name(c) ((c)->cid.prod_name)
Kay Sieversd1b26862008-11-08 21:37:46 +0100554#define mmc_card_id(c) (dev_name(&(c)->dev))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555
Andy Shevchenko265cdc92010-09-17 20:32:25 -0400556#define mmc_dev_to_card(d) container_of(d, struct mmc_card, dev)
Andy Shevchenko453722b2010-08-20 10:46:46 +0300557
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558#define mmc_list_to_card(l) container_of(l, struct mmc_card, node)
559#define mmc_get_drvdata(c) dev_get_drvdata(&(c)->dev)
560#define mmc_set_drvdata(c,d) dev_set_drvdata(&(c)->dev, d)
561
562/*
563 * MMC device driver (e.g., Flash card, I/O card...)
564 */
565struct mmc_driver {
566 struct device_driver drv;
567 int (*probe)(struct mmc_card *);
568 void (*remove)(struct mmc_card *);
Chuanxiao Dong32d317c2012-04-11 19:54:38 +0800569 int (*suspend)(struct mmc_card *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570 int (*resume)(struct mmc_card *);
571};
572
573extern int mmc_register_driver(struct mmc_driver *);
574extern void mmc_unregister_driver(struct mmc_driver *);
575
Andrei Warkentin32780cd2011-04-11 17:02:15 -0500576extern void mmc_fixup_device(struct mmc_card *card,
577 const struct mmc_fixup *table);
Tatyana Brokhman10217bc2012-10-07 10:33:13 +0200578extern struct mmc_wr_pack_stats *mmc_blk_get_packed_statistics(
579 struct mmc_card *card);
580extern void mmc_blk_init_packed_statistics(struct mmc_card *card);
Andrei Warkentin32780cd2011-04-11 17:02:15 -0500581
Robert P. J. Day100e9182011-05-27 16:04:03 -0400582#endif /* LINUX_MMC_CARD_H */