]> git.proxmox.com Git - mirror_ubuntu-zesty-kernel.git/blame - include/linux/mmc/host.h
mmc: quirks: Add/remove quirks conditional support.
[mirror_ubuntu-zesty-kernel.git] / include / linux / mmc / host.h
CommitLineData
1da177e4
LT
1/*
2 * linux/include/linux/mmc/host.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 * Host driver specific definitions.
9 */
10#ifndef LINUX_MMC_HOST_H
11#define LINUX_MMC_HOST_H
12
af8350c7 13#include <linux/leds.h>
d43c36dc 14#include <linux/sched.h>
af8350c7 15
aaac1b47 16#include <linux/mmc/core.h>
da68c4eb 17#include <linux/mmc/pm.h>
1da177e4
LT
18
19struct mmc_ios {
20 unsigned int clock; /* clock rate */
21 unsigned short vdd;
22
4be34c99 23/* vdd stores the bit number of the selected voltage range from below. */
1da177e4
LT
24
25 unsigned char bus_mode; /* command output mode */
26
27#define MMC_BUSMODE_OPENDRAIN 1
28#define MMC_BUSMODE_PUSHPULL 2
29
865e9f13
PO
30 unsigned char chip_select; /* SPI chip select */
31
32#define MMC_CS_DONTCARE 0
33#define MMC_CS_HIGH 1
34#define MMC_CS_LOW 2
35
1da177e4
LT
36 unsigned char power_mode; /* power supply mode */
37
38#define MMC_POWER_OFF 0
39#define MMC_POWER_UP 1
40#define MMC_POWER_ON 2
f218278a
PO
41
42 unsigned char bus_width; /* data bus width */
43
44#define MMC_BUS_WIDTH_1 0
45#define MMC_BUS_WIDTH_4 2
b30f8af3 46#define MMC_BUS_WIDTH_8 3
cd9277c0
PO
47
48 unsigned char timing; /* timing specification used */
49
50#define MMC_TIMING_LEGACY 0
51#define MMC_TIMING_MMC_HS 1
52#define MMC_TIMING_SD_HS 2
49c468fc
AN
53#define MMC_TIMING_UHS_SDR12 MMC_TIMING_LEGACY
54#define MMC_TIMING_UHS_SDR25 MMC_TIMING_SD_HS
55#define MMC_TIMING_UHS_SDR50 3
56#define MMC_TIMING_UHS_SDR104 4
57#define MMC_TIMING_UHS_DDR50 5
0f8d8ea6
AH
58
59 unsigned char ddr; /* dual data rate used */
60
61#define MMC_SDR_MODE 0
49e3b5a4
AH
62#define MMC_1_2V_DDR_MODE 1
63#define MMC_1_8V_DDR_MODE 2
f2119df6
AN
64
65 unsigned char signal_voltage; /* signalling voltage (1.8V or 3.3V) */
66
67#define MMC_SIGNAL_VOLTAGE_330 0
68#define MMC_SIGNAL_VOLTAGE_180 1
4c4cb171 69#define MMC_SIGNAL_VOLTAGE_120 2
d6d50a15
AN
70
71 unsigned char drv_type; /* driver type (A, B, C, D) */
72
73#define MMC_SET_DRIVER_TYPE_B 0
74#define MMC_SET_DRIVER_TYPE_A 1
75#define MMC_SET_DRIVER_TYPE_C 2
76#define MMC_SET_DRIVER_TYPE_D 3
1da177e4
LT
77};
78
79struct mmc_host_ops {
8ea926b2
AH
80 /*
81 * Hosts that support power saving can use the 'enable' and 'disable'
82 * methods to exit and enter power saving states. 'enable' is called
83 * when the host is claimed and 'disable' is called (or scheduled with
84 * a delay) when the host is released. The 'disable' is scheduled if
85 * the disable delay set by 'mmc_set_disable_delay()' is non-zero,
86 * otherwise 'disable' is called immediately. 'disable' may be
87 * scheduled repeatedly, to permit ever greater power saving at the
88 * expense of ever greater latency to re-enable. Rescheduling is
89 * determined by the return value of the 'disable' method. A positive
90 * value gives the delay in milliseconds.
91 *
92 * In the case where a host function (like set_ios) may be called
93 * with or without the host claimed, enabling and disabling can be
94 * done directly and will nest correctly. Call 'mmc_host_enable()' and
95 * 'mmc_host_lazy_disable()' for this purpose, but note that these
96 * functions must be paired.
97 *
98 * Alternatively, 'mmc_host_enable()' may be paired with
99 * 'mmc_host_disable()' which calls 'disable' immediately. In this
100 * case the 'disable' method will be called with 'lazy' set to 0.
101 * This is mainly useful for error paths.
102 *
103 * Because lazy disable may be called from a work queue, the 'disable'
104 * method must claim the host when 'lazy' != 0, which will work
105 * correctly because recursion is detected and handled.
106 */
107 int (*enable)(struct mmc_host *host);
108 int (*disable)(struct mmc_host *host, int lazy);
1da177e4 109 void (*request)(struct mmc_host *host, struct mmc_request *req);
28f52482
AV
110 /*
111 * Avoid calling these three functions too often or in a "fast path",
112 * since underlaying controller might implement them in an expensive
113 * and/or slow way.
114 *
115 * Also note that these functions might sleep, so don't call them
116 * in the atomic contexts!
08f80bb5
AV
117 *
118 * Return values for the get_ro callback should be:
119 * 0 for a read/write card
120 * 1 for a read-only card
121 * -ENOSYS when not supported (equal to NULL callback)
122 * or a negative errno value when something bad happened
123 *
ee63a7d2 124 * Return values for the get_cd callback should be:
08f80bb5
AV
125 * 0 for a absent card
126 * 1 for a present card
127 * -ENOSYS when not supported (equal to NULL callback)
128 * or a negative errno value when something bad happened
28f52482 129 */
1da177e4 130 void (*set_ios)(struct mmc_host *host, struct mmc_ios *ios);
a00fc090 131 int (*get_ro)(struct mmc_host *host);
28f52482
AV
132 int (*get_cd)(struct mmc_host *host);
133
17b759af 134 void (*enable_sdio_irq)(struct mmc_host *host, int enable);
3fcb027d
DM
135
136 /* optional callback for HC quirks */
137 void (*init_card)(struct mmc_host *host, struct mmc_card *card);
f2119df6
AN
138
139 int (*start_signal_voltage_switch)(struct mmc_host *host, struct mmc_ios *ios);
b513ea25 140 int (*execute_tuning)(struct mmc_host *host);
4d55c5a1 141 void (*enable_preset_value)(struct mmc_host *host, bool enable);
1da177e4
LT
142};
143
144struct mmc_card;
145struct device;
146
147struct mmc_host {
fcaf71fd
GKH
148 struct device *parent;
149 struct device class_dev;
dce77377 150 int index;
f57b225e 151 const struct mmc_host_ops *ops;
1da177e4
LT
152 unsigned int f_min;
153 unsigned int f_max;
88ae8b86 154 unsigned int f_init;
1da177e4 155 u32 ocr_avail;
8f230f45
TI
156 u32 ocr_avail_sdio; /* SDIO-specific OCR */
157 u32 ocr_avail_sd; /* SD-specific OCR */
158 u32 ocr_avail_mmc; /* MMC-specific OCR */
4c2ef25f 159 struct notifier_block pm_notify;
1da177e4 160
55556da0 161#define MMC_VDD_165_195 0x00000080 /* VDD voltage 1.65 - 1.95 */
f74d132c
PO
162#define MMC_VDD_20_21 0x00000100 /* VDD voltage 2.0 ~ 2.1 */
163#define MMC_VDD_21_22 0x00000200 /* VDD voltage 2.1 ~ 2.2 */
164#define MMC_VDD_22_23 0x00000400 /* VDD voltage 2.2 ~ 2.3 */
165#define MMC_VDD_23_24 0x00000800 /* VDD voltage 2.3 ~ 2.4 */
166#define MMC_VDD_24_25 0x00001000 /* VDD voltage 2.4 ~ 2.5 */
167#define MMC_VDD_25_26 0x00002000 /* VDD voltage 2.5 ~ 2.6 */
168#define MMC_VDD_26_27 0x00004000 /* VDD voltage 2.6 ~ 2.7 */
169#define MMC_VDD_27_28 0x00008000 /* VDD voltage 2.7 ~ 2.8 */
170#define MMC_VDD_28_29 0x00010000 /* VDD voltage 2.8 ~ 2.9 */
171#define MMC_VDD_29_30 0x00020000 /* VDD voltage 2.9 ~ 3.0 */
172#define MMC_VDD_30_31 0x00040000 /* VDD voltage 3.0 ~ 3.1 */
173#define MMC_VDD_31_32 0x00080000 /* VDD voltage 3.1 ~ 3.2 */
174#define MMC_VDD_32_33 0x00100000 /* VDD voltage 3.2 ~ 3.3 */
175#define MMC_VDD_33_34 0x00200000 /* VDD voltage 3.3 ~ 3.4 */
176#define MMC_VDD_34_35 0x00400000 /* VDD voltage 3.4 ~ 3.5 */
177#define MMC_VDD_35_36 0x00800000 /* VDD voltage 3.5 ~ 3.6 */
178
f218278a
PO
179 unsigned long caps; /* Host capabilities */
180
181#define MMC_CAP_4_BIT_DATA (1 << 0) /* Can the host do 4 bit transfers */
23af6039
PO
182#define MMC_CAP_MMC_HIGHSPEED (1 << 1) /* Can do MMC high-speed timing */
183#define MMC_CAP_SD_HIGHSPEED (1 << 2) /* Can do SD high-speed timing */
184#define MMC_CAP_SDIO_IRQ (1 << 3) /* Can signal pending SDIO IRQs */
185#define MMC_CAP_SPI (1 << 4) /* Talks only SPI protocols */
186#define MMC_CAP_NEEDS_POLL (1 << 5) /* Needs polling for card-detection */
b30f8af3 187#define MMC_CAP_8_BIT_DATA (1 << 6) /* Can the host do 8 bit transfers */
8ea926b2 188#define MMC_CAP_DISABLE (1 << 7) /* Can the host be disabled */
9feae246 189#define MMC_CAP_NONREMOVABLE (1 << 8) /* Nonremovable e.g. eMMC */
b1ebe384 190#define MMC_CAP_WAIT_WHILE_BUSY (1 << 9) /* Waits while card is busy */
dfe86cba 191#define MMC_CAP_ERASE (1 << 10) /* Allow erase/trim commands */
dfc13e84
HP
192#define MMC_CAP_1_8V_DDR (1 << 11) /* can support */
193 /* DDR mode at 1.8V */
194#define MMC_CAP_1_2V_DDR (1 << 12) /* can support */
195 /* DDR mode at 1.2V */
ed919b01 196#define MMC_CAP_POWER_OFF_CARD (1 << 13) /* Can power off after boot */
22113efd 197#define MMC_CAP_BUS_WIDTH_TEST (1 << 14) /* CMD14/CMD19 bus width ok */
f2119df6
AN
198#define MMC_CAP_UHS_SDR12 (1 << 15) /* Host supports UHS SDR12 mode */
199#define MMC_CAP_UHS_SDR25 (1 << 16) /* Host supports UHS SDR25 mode */
200#define MMC_CAP_UHS_SDR50 (1 << 17) /* Host supports UHS SDR50 mode */
201#define MMC_CAP_UHS_SDR104 (1 << 18) /* Host supports UHS SDR104 mode */
202#define MMC_CAP_UHS_DDR50 (1 << 19) /* Host supports UHS DDR50 mode */
203#define MMC_CAP_SET_XPC_330 (1 << 20) /* Host supports >150mA current at 3.3V */
204#define MMC_CAP_SET_XPC_300 (1 << 21) /* Host supports >150mA current at 3.0V */
205#define MMC_CAP_SET_XPC_180 (1 << 22) /* Host supports >150mA current at 1.8V */
d6d50a15
AN
206#define MMC_CAP_DRIVER_TYPE_A (1 << 23) /* Host supports Driver Type A */
207#define MMC_CAP_DRIVER_TYPE_C (1 << 24) /* Host supports Driver Type C */
208#define MMC_CAP_DRIVER_TYPE_D (1 << 25) /* Host supports Driver Type D */
5371c927
AN
209#define MMC_CAP_MAX_CURRENT_200 (1 << 26) /* Host max current limit is 200mA */
210#define MMC_CAP_MAX_CURRENT_400 (1 << 27) /* Host max current limit is 400mA */
211#define MMC_CAP_MAX_CURRENT_600 (1 << 28) /* Host max current limit is 600mA */
212#define MMC_CAP_MAX_CURRENT_800 (1 << 29) /* Host max current limit is 800mA */
f218278a 213
da68c4eb
NP
214 mmc_pm_flag_t pm_caps; /* supported pm features */
215
04566831
LW
216#ifdef CONFIG_MMC_CLKGATE
217 int clk_requests; /* internal reference counter */
218 unsigned int clk_delay; /* number of MCI clk hold cycles */
219 bool clk_gated; /* clock gated */
220 struct work_struct clk_gate_work; /* delayed clock gate */
221 unsigned int clk_old; /* old clock value cache */
222 spinlock_t clk_lock; /* lock for clk fields */
04566831
LW
223#endif
224
1da177e4
LT
225 /* host specific block data */
226 unsigned int max_seg_size; /* see blk_queue_max_segment_size */
a36274e0 227 unsigned short max_segs; /* see blk_queue_max_segments */
1da177e4 228 unsigned short unused;
55db890a 229 unsigned int max_req_size; /* maximum number of bytes in one req */
fe4a3c7a 230 unsigned int max_blk_size; /* maximum size of one mmc block */
55db890a 231 unsigned int max_blk_count; /* maximum number of blocks in one req */
1da177e4
LT
232
233 /* private data */
7ea239d9
PO
234 spinlock_t lock; /* lock for claim and bus ops */
235
1da177e4
LT
236 struct mmc_ios ios; /* current io bus settings */
237 u32 ocr; /* the current OCR setting */
238
97018580
DB
239 /* group bitfields together to minimize padding */
240 unsigned int use_spi_crc:1;
241 unsigned int claimed:1; /* host exclusively claimed */
242 unsigned int bus_dead:1; /* bus has been released */
243#ifdef CONFIG_MMC_DEBUG
244 unsigned int removed:1; /* host is being removed */
245#endif
246
8ea926b2
AH
247 /* Only used with MMC_CAP_DISABLE */
248 int enabled; /* host is enabled */
4c2ef25f 249 int rescan_disable; /* disable card detection */
8ea926b2
AH
250 int nesting_cnt; /* "enable" nesting count */
251 int en_dis_recurs; /* detect recursion */
252 unsigned int disable_delay; /* disable delay in msecs */
253 struct delayed_work disable; /* disabling work */
254
b855885e 255 struct mmc_card *card; /* device attached to this host */
1da177e4
LT
256
257 wait_queue_head_t wq;
319a3f14
AH
258 struct task_struct *claimer; /* task that has host claimed */
259 int claim_cnt; /* "claim" nesting count */
f22ee4ed 260
c4028958 261 struct delayed_work detect;
01357dca 262
7ea239d9
PO
263 const struct mmc_bus_ops *bus_ops; /* current bus driver */
264 unsigned int bus_refs; /* reference counter */
7ea239d9 265
d1496c39
NP
266 unsigned int sdio_irqs;
267 struct task_struct *sdio_irq_thread;
268 atomic_t sdio_irq_thread_abort;
269
da68c4eb
NP
270 mmc_pm_flag_t pm_flags; /* requested pm features */
271
af8350c7
PO
272#ifdef CONFIG_LEDS_TRIGGERS
273 struct led_trigger *led; /* activity led */
274#endif
275
99fc5131
LW
276#ifdef CONFIG_REGULATOR
277 bool regulator_enabled; /* regulator state */
278#endif
279
6edd8ee6
HS
280 struct dentry *debugfs_root;
281
01357dca 282 unsigned long private[0] ____cacheline_aligned;
1da177e4
LT
283};
284
285extern struct mmc_host *mmc_alloc_host(int extra, struct device *);
286extern int mmc_add_host(struct mmc_host *);
287extern void mmc_remove_host(struct mmc_host *);
288extern void mmc_free_host(struct mmc_host *);
289
01357dca
RK
290static inline void *mmc_priv(struct mmc_host *host)
291{
292 return (void *)host->private;
293}
294
97018580
DB
295#define mmc_host_is_spi(host) ((host)->caps & MMC_CAP_SPI)
296
fcaf71fd 297#define mmc_dev(x) ((x)->parent)
11354d03 298#define mmc_classdev(x) (&(x)->class_dev)
d1b26863 299#define mmc_hostname(x) (dev_name(&(x)->class_dev))
1da177e4 300
1a13f8fa 301extern int mmc_suspend_host(struct mmc_host *);
1da177e4
LT
302extern int mmc_resume_host(struct mmc_host *);
303
12ae637f
OBC
304extern int mmc_power_save_host(struct mmc_host *host);
305extern int mmc_power_restore_host(struct mmc_host *host);
eae1aeee 306
8dc00335 307extern void mmc_detect_change(struct mmc_host *, unsigned long delay);
1da177e4
LT
308extern void mmc_request_done(struct mmc_host *, struct mmc_request *);
309
17b759af
NP
310static inline void mmc_signal_sdio_irq(struct mmc_host *host)
311{
312 host->ops->enable_sdio_irq(host, 0);
313 wake_up_process(host->sdio_irq_thread);
314}
315
5c13941a
DB
316struct regulator;
317
99fc5131 318#ifdef CONFIG_REGULATOR
5c13941a 319int mmc_regulator_get_ocrmask(struct regulator *supply);
99fc5131
LW
320int mmc_regulator_set_ocr(struct mmc_host *mmc,
321 struct regulator *supply,
322 unsigned short vdd_bit);
323#else
324static inline int mmc_regulator_get_ocrmask(struct regulator *supply)
325{
326 return 0;
327}
328
329static inline int mmc_regulator_set_ocr(struct mmc_host *mmc,
330 struct regulator *supply,
331 unsigned short vdd_bit)
332{
333 return 0;
334}
335#endif
5c13941a 336
b1ebe384
JL
337int mmc_card_awake(struct mmc_host *host);
338int mmc_card_sleep(struct mmc_host *host);
339int mmc_card_can_sleep(struct mmc_host *host);
340
8ea926b2
AH
341int mmc_host_enable(struct mmc_host *host);
342int mmc_host_disable(struct mmc_host *host);
343int mmc_host_lazy_disable(struct mmc_host *host);
4c2ef25f 344int mmc_pm_notify(struct notifier_block *notify_block, unsigned long, void *);
8ea926b2
AH
345
346static inline void mmc_set_disable_delay(struct mmc_host *host,
347 unsigned int disable_delay)
348{
349 host->disable_delay = disable_delay;
350}
351
71d7d3d1
MF
352/* Module parameter */
353extern int mmc_assume_removable;
354
355static inline int mmc_card_is_removable(struct mmc_host *host)
356{
357 return !(host->caps & MMC_CAP_NONREMOVABLE) && mmc_assume_removable;
358}
359
a5e9425d 360static inline int mmc_card_keep_power(struct mmc_host *host)
080bc977
OBC
361{
362 return host->pm_flags & MMC_PM_KEEP_POWER;
363}
364
6b93d01f
OBC
365static inline int mmc_card_wake_sdio_irq(struct mmc_host *host)
366{
367 return host->pm_flags & MMC_PM_WAKE_SDIO_IRQ;
368}
1da177e4
LT
369#endif
370