blob: 9a4e61d158f8f9c43290c53d5814e2f7ee9ae62c [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 */
Maya Erezcec02a42012-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 Chungc1a56a12012-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 Chungc1a56a12012-09-24 14:44:45 +020089 u8 raw_exception_status; /* 53 */
Philip Rakityf39b2dd2011-07-07 09:04:55 -070090 u8 raw_partition_support; /* 160 */
Loic Pallardye12f9ba2012-08-06 15:12:27 +000091 u8 raw_rpmb_size_mult; /* 168 */
Philip Rakityf39b2dd2011-07-07 09:04:55 -070092 u8 raw_erased_mem_count; /* 181 */
93 u8 raw_ext_csd_structure; /* 194 */
94 u8 raw_card_type; /* 196 */
Jaehoon Chungeb0d8f12011-10-18 01:26:42 -040095 u8 out_of_int_time; /* 198 */
Philip Rakityf39b2dd2011-07-07 09:04:55 -070096 u8 raw_s_a_timeout; /* 217 */
97 u8 raw_hc_erase_gap_size; /* 221 */
98 u8 raw_erase_timeout_mult; /* 223 */
99 u8 raw_hc_erase_grp_size; /* 224 */
100 u8 raw_sec_trim_mult; /* 229 */
101 u8 raw_sec_erase_mult; /* 230 */
102 u8 raw_sec_feature_support;/* 231 */
103 u8 raw_trim_mult; /* 232 */
Jaehoon Chungc1a56a12012-09-24 14:44:45 +0200104 u8 raw_bkops_status; /* 246 */
Philip Rakityf39b2dd2011-07-07 09:04:55 -0700105 u8 raw_sectors[4]; /* 212 - 4 bytes */
Kyungmin Parkb3bf9152011-10-18 09:34:04 +0900106
107 unsigned int feature_support;
108#define MMC_DISCARD_FEATURE BIT(0) /* CMD38 feature */
Philip Langdalebce40a32006-10-21 12:35:02 +0200109};
110
Pierre Ossmanb57c43a2005-09-06 15:18:53 -0700111struct sd_scr {
112 unsigned char sda_vsn;
Arindam Nath013909c2011-05-05 12:18:58 +0530113 unsigned char sda_spec3;
Pierre Ossmanb57c43a2005-09-06 15:18:53 -0700114 unsigned char bus_widths;
115#define SD_SCR_BUS_WIDTH_1 (1<<0)
116#define SD_SCR_BUS_WIDTH_4 (1<<2)
Andrei Warkentinf0d89972011-05-23 15:06:38 -0500117 unsigned char cmds;
118#define SD_SCR_CMD20_SUPPORT (1<<0)
119#define SD_SCR_CMD23_SUPPORT (1<<1)
Pierre Ossmanb57c43a2005-09-06 15:18:53 -0700120};
121
Adrian Hunterdfe86cb2010-08-11 14:17:46 -0700122struct sd_ssr {
123 unsigned int au; /* In sectors */
124 unsigned int erase_timeout; /* In milliseconds */
125 unsigned int erase_offset; /* In milliseconds */
126};
127
Pierre Ossman7ccd2662006-11-08 23:03:10 +0100128struct sd_switch_caps {
129 unsigned int hs_max_dtr;
Arindam Nath49c468f2011-05-05 12:19:01 +0530130 unsigned int uhs_max_dtr;
Qiang Liufffe5d52011-11-08 08:43:08 -0500131#define HIGH_SPEED_MAX_DTR 50000000
Arindam Nath49c468f2011-05-05 12:19:01 +0530132#define UHS_SDR104_MAX_DTR 208000000
133#define UHS_SDR50_MAX_DTR 100000000
134#define UHS_DDR50_MAX_DTR 50000000
135#define UHS_SDR25_MAX_DTR UHS_DDR50_MAX_DTR
136#define UHS_SDR12_MAX_DTR 25000000
Arindam Nath013909c2011-05-05 12:18:58 +0530137 unsigned int sd3_bus_mode;
Arindam Nath49c468f2011-05-05 12:19:01 +0530138#define UHS_SDR12_BUS_SPEED 0
Qiang Liufffe5d52011-11-08 08:43:08 -0500139#define HIGH_SPEED_BUS_SPEED 1
Arindam Nath49c468f2011-05-05 12:19:01 +0530140#define UHS_SDR25_BUS_SPEED 1
141#define UHS_SDR50_BUS_SPEED 2
142#define UHS_SDR104_BUS_SPEED 3
143#define UHS_DDR50_BUS_SPEED 4
144
Qiang Liufffe5d52011-11-08 08:43:08 -0500145#define SD_MODE_HIGH_SPEED (1 << HIGH_SPEED_BUS_SPEED)
Arindam Nath49c468f2011-05-05 12:19:01 +0530146#define SD_MODE_UHS_SDR12 (1 << UHS_SDR12_BUS_SPEED)
147#define SD_MODE_UHS_SDR25 (1 << UHS_SDR25_BUS_SPEED)
148#define SD_MODE_UHS_SDR50 (1 << UHS_SDR50_BUS_SPEED)
149#define SD_MODE_UHS_SDR104 (1 << UHS_SDR104_BUS_SPEED)
150#define SD_MODE_UHS_DDR50 (1 << UHS_DDR50_BUS_SPEED)
Arindam Nath013909c2011-05-05 12:18:58 +0530151 unsigned int sd3_drv_type;
Arindam Nathd6d50a12011-05-05 12:18:59 +0530152#define SD_DRIVER_TYPE_B 0x01
153#define SD_DRIVER_TYPE_A 0x02
154#define SD_DRIVER_TYPE_C 0x04
155#define SD_DRIVER_TYPE_D 0x08
Arindam Nath013909c2011-05-05 12:18:58 +0530156 unsigned int sd3_curr_limit;
Arindam Nath5371c922011-05-05 12:19:02 +0530157#define SD_SET_CURRENT_LIMIT_200 0
158#define SD_SET_CURRENT_LIMIT_400 1
159#define SD_SET_CURRENT_LIMIT_600 2
160#define SD_SET_CURRENT_LIMIT_800 3
161
162#define SD_MAX_CURRENT_200 (1 << SD_SET_CURRENT_LIMIT_200)
163#define SD_MAX_CURRENT_400 (1 << SD_SET_CURRENT_LIMIT_400)
164#define SD_MAX_CURRENT_600 (1 << SD_SET_CURRENT_LIMIT_600)
165#define SD_MAX_CURRENT_800 (1 << SD_SET_CURRENT_LIMIT_800)
Pierre Ossman7ccd2662006-11-08 23:03:10 +0100166};
167
Pierre Ossman35c66c12007-06-11 20:25:43 +0200168struct sdio_cccr {
169 unsigned int sdio_vsn;
170 unsigned int sd_vsn;
171 unsigned int multi_block:1,
172 low_speed:1,
173 wide_bus:1,
174 high_power:1,
Ohad Ben-Cohen006ebd52009-09-22 16:45:07 -0700175 high_speed:1,
176 disable_cd:1;
Pierre Ossman35c66c12007-06-11 20:25:43 +0200177};
178
Pierre Ossman1a632f82007-07-30 15:15:30 +0200179struct sdio_cis {
180 unsigned short vendor;
181 unsigned short device;
182 unsigned short blksize;
183 unsigned int max_dtr;
184};
185
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186struct mmc_host;
Pierre Ossmane29a7d72007-05-26 13:48:18 +0200187struct sdio_func;
Pierre Ossman1a632f82007-07-30 15:15:30 +0200188struct sdio_func_tuple;
Konstantin Dorfman9b0f5ec2013-02-12 13:19:48 +0200189struct mmc_queue;
Pierre Ossmane29a7d72007-05-26 13:48:18 +0200190
191#define SDIO_MAX_FUNCS 7
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192
Tatyana Brokhman464fbe12012-10-07 10:33:13 +0200193enum mmc_packed_stop_reasons {
194 EXCEEDS_SEGMENTS = 0,
195 EXCEEDS_SECTORS,
196 WRONG_DATA_DIR,
197 FLUSH_OR_DISCARD,
198 EMPTY_QUEUE,
199 REL_WRITE,
200 THRESHOLD,
Tatyana Brokhman1718ef22012-10-04 11:11:08 +0200201 LARGE_SEC_ALIGN,
Maya Erez64d12462013-01-06 10:19:38 +0200202 RANDOM,
Konstantin Dorfmanb0832972013-02-05 16:26:19 +0200203 FUA,
Tatyana Brokhman464fbe12012-10-07 10:33:13 +0200204 MAX_REASONS,
205};
206
Konstantin Dorfman69bd0fb2012-12-12 16:12:08 +0200207enum mmc_blk_status {
208 MMC_BLK_SUCCESS = 0,
209 MMC_BLK_PARTIAL,
210 MMC_BLK_CMD_ERR,
211 MMC_BLK_RETRY,
212 MMC_BLK_ABORT,
213 MMC_BLK_DATA_ERR,
214 MMC_BLK_ECC_ERR,
215 MMC_BLK_NOMEDIUM,
216 MMC_BLK_NEW_REQUEST,
Konstantin Dorfman9b0f5ec2013-02-12 13:19:48 +0200217 MMC_BLK_URGENT,
Konstantin Dorfmane9382e62013-03-10 17:39:16 +0200218 MMC_BLK_URGENT_DONE,
Konstantin Dorfman69bd0fb2012-12-12 16:12:08 +0200219};
220
Tatyana Brokhman464fbe12012-10-07 10:33:13 +0200221struct mmc_wr_pack_stats {
222 u32 *packing_events;
223 u32 pack_stop_reason[MAX_REASONS];
224 spinlock_t lock;
225 bool enabled;
226 bool print_in_read;
227};
228
Namjae Jeone0c368d2011-10-06 23:41:38 +0900229/* The number of MMC physical partitions. These consist of:
230 * boot partitions (2), general purpose partitions (4) in MMC v4.4.
231 */
232#define MMC_NUM_BOOT_PARTITION 2
233#define MMC_NUM_GP_PARTITION 4
234#define MMC_NUM_PHY_PARTITION 6
Namjae Jeona6029e12011-10-13 00:43:14 +0900235#define MAX_MMC_PART_NAME_LEN 20
Namjae Jeone0c368d2011-10-06 23:41:38 +0900236
237/*
238 * MMC Physical partitions
239 */
240struct mmc_part {
241 unsigned int size; /* partition size (in bytes) */
242 unsigned int part_cfg; /* partition type */
Namjae Jeona6029e12011-10-13 00:43:14 +0900243 char name[MAX_MMC_PART_NAME_LEN];
Namjae Jeone0c368d2011-10-06 23:41:38 +0900244 bool force_ro; /* to make boot parts RO by default */
Johan Rudholmadd710e2011-12-02 08:51:06 +0100245 unsigned int area_type;
246#define MMC_BLK_DATA_AREA_MAIN (1<<0)
247#define MMC_BLK_DATA_AREA_BOOT (1<<1)
248#define MMC_BLK_DATA_AREA_GP (1<<2)
Loic Pallardye12f9ba2012-08-06 15:12:27 +0000249#define MMC_BLK_DATA_AREA_RPMB (1<<3)
Namjae Jeone0c368d2011-10-06 23:41:38 +0900250};
251
Yaniv Gardi4c4383f2012-10-11 18:29:28 +0200252#define BKOPS_NUM_OF_SEVERITY_LEVELS 3
Yaniv Gardie9214c82012-10-18 13:58:18 +0200253#define BKOPS_SEVERITY_1_INDEX 0
254#define BKOPS_SEVERITY_2_INDEX 1
255#define BKOPS_SEVERITY_3_INDEX 2
Yaniv Gardi4c4383f2012-10-11 18:29:28 +0200256struct mmc_bkops_stats {
257 spinlock_t lock;
258 bool enabled;
259 unsigned int hpi; /* hpi issued */
260 unsigned int suspend;/* card sleed issued */
261 bool print_stats;
262 unsigned int bkops_level[BKOPS_NUM_OF_SEVERITY_LEVELS];
Yaniv Gardie9214c82012-10-18 13:58:18 +0200263 bool ignore_card_bkops_status;
Yaniv Gardi4c4383f2012-10-11 18:29:28 +0200264};
265
Maya Erez5f360692012-10-10 03:47:54 +0200266/**
267 * struct mmc_bkops_info - BKOPS data
268 * @dw: Idle time bkops delayed work
Maya Erez70b00222012-12-27 15:40:17 +0200269 * @host_delay_ms: The host controller time to start bkops
Maya Erez5f360692012-10-10 03:47:54 +0200270 * @delay_ms: The time to start the BKOPS
271 * delayed work once MMC thread is idle
Maya Ereze1eae982013-01-05 21:51:06 +0200272 * @min_sectors_to_queue_delayed_work: the changed
273 * number of sectors that should issue check for BKOPS
274 * need
275 * @size_percentage_to_queue_delayed_work: the changed
276 * percentage of sectors that should issue check for
277 * BKOPS need
278 * @bkops_stats: BKOPS statistics
Maya Erez5f360692012-10-10 03:47:54 +0200279 * @poll_for_completion: Poll on BKOPS completion
280 * @cancel_delayed_work: A flag to indicate if the delayed work
281 * should be cancelled
Maya Erez2d33a192013-01-04 15:52:41 +0200282 * @sectors_changed: number of sectors written or
283 * discard since the last idle BKOPS were scheduled
Maya Erez5f360692012-10-10 03:47:54 +0200284 */
285struct mmc_bkops_info {
286 struct delayed_work dw;
Maya Erez70b00222012-12-27 15:40:17 +0200287 unsigned int host_delay_ms;
Maya Erez5f360692012-10-10 03:47:54 +0200288 unsigned int delay_ms;
Maya Erez2d33a192013-01-04 15:52:41 +0200289 unsigned int min_sectors_to_queue_delayed_work;
Maya Ereze1eae982013-01-05 21:51:06 +0200290 unsigned int size_percentage_to_queue_delayed_work;
291 struct mmc_bkops_stats bkops_stats;
Maya Erez5f360692012-10-10 03:47:54 +0200292/*
293 * A default time for checking the need for non urgent BKOPS once mmcqd
294 * is idle.
295 */
Maya Erez70b00222012-12-27 15:40:17 +0200296#define MMC_IDLE_BKOPS_TIME_MS 200
Maya Erez5f360692012-10-10 03:47:54 +0200297 struct work_struct poll_for_completion;
298/* Polling timeout and interval for waiting on non-blocking BKOPs completion */
Maya Erezea1385e2013-01-04 11:04:47 +0200299#define BKOPS_COMPLETION_POLLING_TIMEOUT_MS (4 * 60 * 1000) /* in ms */
Maya Erez5f360692012-10-10 03:47:54 +0200300#define BKOPS_COMPLETION_POLLING_INTERVAL_MS 1000 /* in ms */
301 bool cancel_delayed_work;
Maya Erez2d33a192013-01-04 15:52:41 +0200302 unsigned int sectors_changed;
303/*
304 * Since canceling the delayed work might have significant effect on the
305 * performance of small requests we won't queue the delayed work every time
306 * mmcqd thread is idle.
307 * The delayed work for idle BKOPS will be scheduled only after a significant
308 * amount of write or discard data.
Maya Erez2d33a192013-01-04 15:52:41 +0200309 */
Maya Ereze1eae982013-01-05 21:51:06 +0200310#define BKOPS_SIZE_PERCENTAGE_TO_QUEUE_DELAYED_WORK 1 /* 1% */
Maya Erez5f360692012-10-10 03:47:54 +0200311};
312
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313/*
314 * MMC device
315 */
316struct mmc_card {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317 struct mmc_host *host; /* the host this device belongs to */
318 struct device dev; /* the device */
319 unsigned int rca; /* relative card address of device */
Pierre Ossman9c2c0af2006-12-26 15:25:58 +0100320 unsigned int type; /* card type */
321#define MMC_TYPE_MMC 0 /* MMC card */
322#define MMC_TYPE_SD 1 /* SD card */
Pierre Ossman5c4e6f12007-05-21 20:23:20 +0200323#define MMC_TYPE_SDIO 2 /* SDIO card */
Michal Miroslaw7310ece2010-08-10 18:01:40 -0700324#define MMC_TYPE_SD_COMBO 3 /* SD combo (IO+mem) card */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325 unsigned int state; /* (our) card state */
326#define MMC_STATE_PRESENT (1<<0) /* present in sysfs */
Pierre Ossmanbd766312007-05-01 16:11:57 +0200327#define MMC_STATE_READONLY (1<<1) /* card is read-only */
328#define MMC_STATE_HIGHSPEED (1<<2) /* card is in high speed mode */
329#define MMC_STATE_BLOCKADDR (1<<3) /* card uses block-addressing */
Hanumath Prasaddfc13e82010-09-30 17:37:23 -0400330#define MMC_STATE_HIGHSPEED_DDR (1<<4) /* card is in high speed mode */
Arindam Nath3a303512011-05-05 12:19:03 +0530331#define MMC_STATE_ULTRAHIGHSPEED (1<<5) /* card is in ultra high speed mode */
332#define MMC_CARD_SDXC (1<<6) /* card is SDXC */
Adrian Hunterd3049502011-11-28 16:22:00 +0200333#define MMC_CARD_REMOVED (1<<7) /* card has been removed */
Girish K Sa4924c72012-01-11 14:04:52 -0500334#define MMC_STATE_HIGHSPEED_200 (1<<8) /* card is in HS200 mode */
Jaehoon Chungc1a56a12012-09-24 14:44:45 +0200335#define MMC_STATE_DOING_BKOPS (1<<10) /* card is doing BKOPS */
Maya Erez5f8ac3b2013-01-04 10:55:00 +0200336#define MMC_STATE_NEED_BKOPS (1<<11) /* card needs to do BKOPS */
Ohad Ben-Cohen7c979ec2009-09-22 16:45:18 -0700337 unsigned int quirks; /* card quirks */
338#define MMC_QUIRK_LENIENT_FN0 (1<<0) /* allow SDIO FN0 writes outside of the VS CCCR range */
Bing Zhao3fb7fb42010-03-05 13:43:25 -0800339#define MMC_QUIRK_BLKSZ_FOR_BYTE_MODE (1<<1) /* use func->cur_blksize */
340 /* for byte mode */
Grazvydas Ignotas6f51be32010-08-10 18:01:50 -0700341#define MMC_QUIRK_NONSTD_SDIO (1<<2) /* non-standard SDIO card attached */
342 /* (missing CIA registers) */
Pierre Tardydb993502011-02-06 19:03:47 +0100343#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 +0300344#define MMC_QUIRK_NONSTD_FUNC_IF (1<<4) /* SDIO card has nonstd function interfaces */
Ohad Ben-Cohen2059a022011-04-05 18:02:25 +0300345#define MMC_QUIRK_DISABLE_CD (1<<5) /* disconnect CD/DAT[3] resistor */
Andrei Warkentin6a7a6b42011-04-12 15:06:53 -0500346#define MMC_QUIRK_INAND_CMD38 (1<<6) /* iNAND devices have broken CMD38 */
Andrei Warkentind0c97cf2011-05-23 15:06:36 -0500347#define MMC_QUIRK_BLK_NO_CMD23 (1<<7) /* Avoid CMD23 for regular multiblock */
Stefan Nilsson XK9a0da642011-09-15 17:43:04 +0200348#define MMC_QUIRK_BROKEN_BYTE_MODE_512 (1<<8) /* Avoid sending 512 bytes in */
Stefan Nilsson XK6de5fc92011-11-03 09:44:12 +0100349#define MMC_QUIRK_LONG_READ_TIME (1<<9) /* Data read time > CSD says */
Ian Chenc4856122012-11-01 13:26:21 +0530350#define MMC_QUIRK_SEC_ERASE_TRIM_BROKEN (1<<10) /* Skip secure for erase/trim */
Stefan Nilsson XK9a0da642011-09-15 17:43:04 +0200351 /* byte mode */
Pratibhasagar V3a18bbd2012-04-17 14:41:19 +0530352#define MMC_QUIRK_INAND_DATA_TIMEOUT (1<<8) /* For incorrect data timeout */
Pierre Ossmane29a7d72007-05-26 13:48:18 +0200353
Adrian Hunterdfe86cb2010-08-11 14:17:46 -0700354 unsigned int erase_size; /* erase size in sectors */
355 unsigned int erase_shift; /* if erase unit is power 2 */
356 unsigned int pref_erase; /* in sectors */
357 u8 erased_byte; /* value of erased bytes */
358
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359 u32 raw_cid[4]; /* raw card CID */
360 u32 raw_csd[4]; /* raw card CSD */
Pierre Ossmanb57c43a2005-09-06 15:18:53 -0700361 u32 raw_scr[2]; /* raw card SCR */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362 struct mmc_cid cid; /* card identification */
363 struct mmc_csd csd; /* card specific */
Philip Langdalebce40a32006-10-21 12:35:02 +0200364 struct mmc_ext_csd ext_csd; /* mmc v4 extended card specific */
Pierre Ossmanb57c43a2005-09-06 15:18:53 -0700365 struct sd_scr scr; /* extra SD information */
Adrian Hunterdfe86cb2010-08-11 14:17:46 -0700366 struct sd_ssr ssr; /* yet more SD information */
Pierre Ossman7ccd2662006-11-08 23:03:10 +0100367 struct sd_switch_caps sw_caps; /* switch (CMD6) caps */
Pierre Ossmane29a7d72007-05-26 13:48:18 +0200368
369 unsigned int sdio_funcs; /* number of SDIO functions */
Pierre Ossman35c66c12007-06-11 20:25:43 +0200370 struct sdio_cccr cccr; /* common card info */
Pierre Ossman1a632f82007-07-30 15:15:30 +0200371 struct sdio_cis cis; /* common tuple info */
Pierre Ossmane29a7d72007-05-26 13:48:18 +0200372 struct sdio_func *sdio_func[SDIO_MAX_FUNCS]; /* SDIO functions (devices) */
Stefan Nilsson XK06e89352011-05-11 17:48:05 +0200373 struct sdio_func *sdio_single_irq; /* SDIO function when only one IRQ active */
Pierre Ossman759bdc72007-09-19 18:42:16 +0200374 unsigned num_info; /* number of info strings */
375 const char **info; /* info strings */
Pierre Ossman1a632f82007-07-30 15:15:30 +0200376 struct sdio_func_tuple *tuples; /* unknown common tuples */
Haavard Skinnemoenf4b7f922008-07-24 14:18:58 +0200377
Arindam Nath49c468f2011-05-05 12:19:01 +0530378 unsigned int sd_bus_speed; /* Bus Speed Mode set for the card */
379
Haavard Skinnemoenf4b7f922008-07-24 14:18:58 +0200380 struct dentry *debugfs_root;
Namjae Jeone0c368d2011-10-06 23:41:38 +0900381 struct mmc_part part[MMC_NUM_PHY_PARTITION]; /* physical partitions */
382 unsigned int nr_parts;
Oluwafemi Adeyemi151b4772013-01-03 11:32:53 -0800383 unsigned int part_curr;
Maya Ereze544d7002012-06-04 06:09:47 +0300384
Tatyana Brokhman464fbe12012-10-07 10:33:13 +0200385 struct mmc_wr_pack_stats wr_pack_stats; /* packed commands stats*/
Maya Erez5f360692012-10-10 03:47:54 +0200386
387 struct mmc_bkops_info bkops_info;
Asutosh Dasbbc84782013-02-11 15:31:35 +0530388
389 struct device_attribute rpm_attrib;
390 unsigned int idle_timeout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391};
392
Andrei Warkentin32780cd2011-04-11 17:02:15 -0500393/*
Namjae Jeone0c368d2011-10-06 23:41:38 +0900394 * This function fill contents in mmc_part.
395 */
396static inline void mmc_part_add(struct mmc_card *card, unsigned int size,
Johan Rudholmadd710e2011-12-02 08:51:06 +0100397 unsigned int part_cfg, char *name, int idx, bool ro,
398 int area_type)
Namjae Jeone0c368d2011-10-06 23:41:38 +0900399{
400 card->part[card->nr_parts].size = size;
401 card->part[card->nr_parts].part_cfg = part_cfg;
402 sprintf(card->part[card->nr_parts].name, name, idx);
403 card->part[card->nr_parts].force_ro = ro;
Johan Rudholmadd710e2011-12-02 08:51:06 +0100404 card->part[card->nr_parts].area_type = area_type;
Namjae Jeone0c368d2011-10-06 23:41:38 +0900405 card->nr_parts++;
406}
407
Seungwon Jeon53f8f572012-09-27 15:00:26 +0200408static inline bool mmc_large_sec(struct mmc_card *card)
409{
410 return card->ext_csd.data_sector_size == 4096;
411}
412
Namjae Jeone0c368d2011-10-06 23:41:38 +0900413/*
Andrei Warkentin32780cd2011-04-11 17:02:15 -0500414 * The world is not perfect and supplies us with broken mmc/sdio devices.
415 * For at least some of these bugs we need a work-around.
416 */
417
418struct mmc_fixup {
419 /* CID-specific fields. */
420 const char *name;
421
422 /* Valid revision range */
423 u64 rev_start, rev_end;
424
425 unsigned int manfid;
426 unsigned short oemid;
427
428 /* SDIO-specfic fields. You can use SDIO_ANY_ID here of course */
429 u16 cis_vendor, cis_device;
430
431 void (*vendor_fixup)(struct mmc_card *card, int data);
432 int data;
433};
434
Randy Dunlap853c6ca2011-04-12 12:59:09 -0400435#define CID_MANFID_ANY (-1u)
Andrei Warkentin32780cd2011-04-11 17:02:15 -0500436#define CID_OEMID_ANY ((unsigned short) -1)
437#define CID_NAME_ANY (NULL)
438
439#define END_FIXUP { 0 }
440
441#define _FIXUP_EXT(_name, _manfid, _oemid, _rev_start, _rev_end, \
442 _cis_vendor, _cis_device, \
443 _fixup, _data) \
444 { \
445 .name = (_name), \
446 .manfid = (_manfid), \
447 .oemid = (_oemid), \
448 .rev_start = (_rev_start), \
449 .rev_end = (_rev_end), \
450 .cis_vendor = (_cis_vendor), \
451 .cis_device = (_cis_device), \
452 .vendor_fixup = (_fixup), \
453 .data = (_data), \
454 }
455
456#define MMC_FIXUP_REV(_name, _manfid, _oemid, _rev_start, _rev_end, \
457 _fixup, _data) \
458 _FIXUP_EXT(_name, _manfid, \
459 _oemid, _rev_start, _rev_end, \
460 SDIO_ANY_ID, SDIO_ANY_ID, \
461 _fixup, _data) \
462
463#define MMC_FIXUP(_name, _manfid, _oemid, _fixup, _data) \
464 MMC_FIXUP_REV(_name, _manfid, _oemid, 0, -1ull, _fixup, _data)
465
466#define SDIO_FIXUP(_vendor, _device, _fixup, _data) \
467 _FIXUP_EXT(CID_NAME_ANY, CID_MANFID_ANY, \
468 CID_OEMID_ANY, 0, -1ull, \
469 _vendor, _device, \
470 _fixup, _data) \
471
472#define cid_rev(hwrev, fwrev, year, month) \
473 (((u64) hwrev) << 40 | \
474 ((u64) fwrev) << 32 | \
475 ((u64) year) << 16 | \
476 ((u64) month))
477
478#define cid_rev_card(card) \
479 cid_rev(card->cid.hwrev, \
480 card->cid.fwrev, \
481 card->cid.year, \
482 card->cid.month)
483
484/*
Andrei Warkentinc59de922011-05-23 15:06:35 -0500485 * Unconditionally quirk add/remove.
Andrei Warkentin32780cd2011-04-11 17:02:15 -0500486 */
Andrei Warkentinc59de922011-05-23 15:06:35 -0500487
Andrei Warkentin32780cd2011-04-11 17:02:15 -0500488static inline void __maybe_unused add_quirk(struct mmc_card *card, int data)
489{
490 card->quirks |= data;
491}
492
Andrei Warkentin32780cd2011-04-11 17:02:15 -0500493static inline void __maybe_unused remove_quirk(struct mmc_card *card, int data)
494{
495 card->quirks &= ~data;
496}
Pierre Tardy57f0adc2011-02-06 19:03:46 +0100497
Pierre Ossman9c2c0af2006-12-26 15:25:58 +0100498#define mmc_card_mmc(c) ((c)->type == MMC_TYPE_MMC)
499#define mmc_card_sd(c) ((c)->type == MMC_TYPE_SD)
Pierre Ossman5c4e6f12007-05-21 20:23:20 +0200500#define mmc_card_sdio(c) ((c)->type == MMC_TYPE_SDIO)
Pierre Ossman9c2c0af2006-12-26 15:25:58 +0100501
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502#define mmc_card_present(c) ((c)->state & MMC_STATE_PRESENT)
Pierre Ossmana00fc092005-09-06 15:18:52 -0700503#define mmc_card_readonly(c) ((c)->state & MMC_STATE_READONLY)
Philip Langdalebce40a32006-10-21 12:35:02 +0200504#define mmc_card_highspeed(c) ((c)->state & MMC_STATE_HIGHSPEED)
Girish K Sa4924c72012-01-11 14:04:52 -0500505#define mmc_card_hs200(c) ((c)->state & MMC_STATE_HIGHSPEED_200)
Philip Langdalefba68bd2007-01-04 06:57:32 -0800506#define mmc_card_blockaddr(c) ((c)->state & MMC_STATE_BLOCKADDR)
Hanumath Prasaddfc13e82010-09-30 17:37:23 -0400507#define mmc_card_ddr_mode(c) ((c)->state & MMC_STATE_HIGHSPEED_DDR)
Philip Rakitya303c532011-11-14 19:14:38 -0800508#define mmc_card_uhs(c) ((c)->state & MMC_STATE_ULTRAHIGHSPEED)
509#define mmc_sd_card_uhs(c) ((c)->state & MMC_STATE_ULTRAHIGHSPEED)
Arindam Nath3a303512011-05-05 12:19:03 +0530510#define mmc_card_ext_capacity(c) ((c)->state & MMC_CARD_SDXC)
Adrian Hunterd3049502011-11-28 16:22:00 +0200511#define mmc_card_removed(c) ((c) && ((c)->state & MMC_CARD_REMOVED))
Jaehoon Chungc1a56a12012-09-24 14:44:45 +0200512#define mmc_card_doing_bkops(c) ((c)->state & MMC_STATE_DOING_BKOPS)
Maya Erez5f8ac3b2013-01-04 10:55:00 +0200513#define mmc_card_need_bkops(c) ((c)->state & MMC_STATE_NEED_BKOPS)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514
515#define mmc_card_set_present(c) ((c)->state |= MMC_STATE_PRESENT)
Pierre Ossmana00fc092005-09-06 15:18:52 -0700516#define mmc_card_set_readonly(c) ((c)->state |= MMC_STATE_READONLY)
Philip Langdalebce40a32006-10-21 12:35:02 +0200517#define mmc_card_set_highspeed(c) ((c)->state |= MMC_STATE_HIGHSPEED)
Girish K Sa4924c72012-01-11 14:04:52 -0500518#define mmc_card_set_hs200(c) ((c)->state |= MMC_STATE_HIGHSPEED_200)
Philip Langdalefba68bd2007-01-04 06:57:32 -0800519#define mmc_card_set_blockaddr(c) ((c)->state |= MMC_STATE_BLOCKADDR)
Hanumath Prasaddfc13e82010-09-30 17:37:23 -0400520#define mmc_card_set_ddr_mode(c) ((c)->state |= MMC_STATE_HIGHSPEED_DDR)
Philip Rakitya303c532011-11-14 19:14:38 -0800521#define mmc_card_set_uhs(c) ((c)->state |= MMC_STATE_ULTRAHIGHSPEED)
Arindam Nath3a303512011-05-05 12:19:03 +0530522#define mmc_sd_card_set_uhs(c) ((c)->state |= MMC_STATE_ULTRAHIGHSPEED)
523#define mmc_card_set_ext_capacity(c) ((c)->state |= MMC_CARD_SDXC)
Adrian Hunterd3049502011-11-28 16:22:00 +0200524#define mmc_card_set_removed(c) ((c)->state |= MMC_CARD_REMOVED)
Jaehoon Chungc1a56a12012-09-24 14:44:45 +0200525#define mmc_card_set_doing_bkops(c) ((c)->state |= MMC_STATE_DOING_BKOPS)
Jaehoon Chungc1a56a12012-09-24 14:44:45 +0200526#define mmc_card_clr_doing_bkops(c) ((c)->state &= ~MMC_STATE_DOING_BKOPS)
Maya Erez5f8ac3b2013-01-04 10:55:00 +0200527#define mmc_card_set_need_bkops(c) ((c)->state |= MMC_STATE_NEED_BKOPS)
528#define mmc_card_clr_need_bkops(c) ((c)->state &= ~MMC_STATE_NEED_BKOPS)
Andrei Warkentinc59de922011-05-23 15:06:35 -0500529/*
530 * Quirk add/remove for MMC products.
531 */
532
533static inline void __maybe_unused add_quirk_mmc(struct mmc_card *card, int data)
534{
535 if (mmc_card_mmc(card))
536 card->quirks |= data;
537}
538
539static inline void __maybe_unused remove_quirk_mmc(struct mmc_card *card,
540 int data)
541{
542 if (mmc_card_mmc(card))
543 card->quirks &= ~data;
544}
545
546/*
547 * Quirk add/remove for SD products.
548 */
549
550static inline void __maybe_unused add_quirk_sd(struct mmc_card *card, int data)
551{
552 if (mmc_card_sd(card))
553 card->quirks |= data;
554}
555
556static inline void __maybe_unused remove_quirk_sd(struct mmc_card *card,
557 int data)
558{
559 if (mmc_card_sd(card))
560 card->quirks &= ~data;
561}
562
Ohad Ben-Cohen7c979ec2009-09-22 16:45:18 -0700563static inline int mmc_card_lenient_fn0(const struct mmc_card *c)
564{
565 return c->quirks & MMC_QUIRK_LENIENT_FN0;
566}
567
Bing Zhao3fb7fb42010-03-05 13:43:25 -0800568static inline int mmc_blksz_for_byte_mode(const struct mmc_card *c)
569{
570 return c->quirks & MMC_QUIRK_BLKSZ_FOR_BYTE_MODE;
571}
572
Ohad Ben-Cohen2059a022011-04-05 18:02:25 +0300573static inline int mmc_card_disable_cd(const struct mmc_card *c)
574{
575 return c->quirks & MMC_QUIRK_DISABLE_CD;
576}
577
Ohad Ben-Coheneab40682011-04-05 17:50:14 +0300578static inline int mmc_card_nonstd_func_interface(const struct mmc_card *c)
579{
580 return c->quirks & MMC_QUIRK_NONSTD_FUNC_IF;
581}
582
Stefan Nilsson XK9a0da642011-09-15 17:43:04 +0200583static inline int mmc_card_broken_byte_mode_512(const struct mmc_card *c)
584{
585 return c->quirks & MMC_QUIRK_BROKEN_BYTE_MODE_512;
586}
587
Stefan Nilsson XK6de5fc92011-11-03 09:44:12 +0100588static inline int mmc_card_long_read_time(const struct mmc_card *c)
589{
590 return c->quirks & MMC_QUIRK_LONG_READ_TIME;
591}
592
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593#define mmc_card_name(c) ((c)->cid.prod_name)
Kay Sieversd1b26862008-11-08 21:37:46 +0100594#define mmc_card_id(c) (dev_name(&(c)->dev))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595
Andy Shevchenko265cdc92010-09-17 20:32:25 -0400596#define mmc_dev_to_card(d) container_of(d, struct mmc_card, dev)
Andy Shevchenko453722b2010-08-20 10:46:46 +0300597
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598#define mmc_list_to_card(l) container_of(l, struct mmc_card, node)
599#define mmc_get_drvdata(c) dev_get_drvdata(&(c)->dev)
600#define mmc_set_drvdata(c,d) dev_set_drvdata(&(c)->dev, d)
601
602/*
603 * MMC device driver (e.g., Flash card, I/O card...)
604 */
605struct mmc_driver {
606 struct device_driver drv;
607 int (*probe)(struct mmc_card *);
608 void (*remove)(struct mmc_card *);
Chuanxiao Dong32d317c2012-04-11 19:54:38 +0800609 int (*suspend)(struct mmc_card *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610 int (*resume)(struct mmc_card *);
611};
612
613extern int mmc_register_driver(struct mmc_driver *);
614extern void mmc_unregister_driver(struct mmc_driver *);
615
Andrei Warkentin32780cd2011-04-11 17:02:15 -0500616extern void mmc_fixup_device(struct mmc_card *card,
617 const struct mmc_fixup *table);
Tatyana Brokhman464fbe12012-10-07 10:33:13 +0200618extern struct mmc_wr_pack_stats *mmc_blk_get_packed_statistics(
619 struct mmc_card *card);
620extern void mmc_blk_init_packed_statistics(struct mmc_card *card);
Konstantin Dorfman9b0f5ec2013-02-12 13:19:48 +0200621extern void mmc_blk_disable_wr_packing(struct mmc_queue *mq);
Robert P. J. Day100e9182011-05-27 16:04:03 -0400622#endif /* LINUX_MMC_CARD_H */