]> git.proxmox.com Git - mirror_ubuntu-zesty-kernel.git/blame - include/linux/mmc/host.h
mmc: MMC 4.4 DDR 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
1da177e4
LT
53};
54
55struct mmc_host_ops {
8ea926b2
AH
56 /*
57 * Hosts that support power saving can use the 'enable' and 'disable'
58 * methods to exit and enter power saving states. 'enable' is called
59 * when the host is claimed and 'disable' is called (or scheduled with
60 * a delay) when the host is released. The 'disable' is scheduled if
61 * the disable delay set by 'mmc_set_disable_delay()' is non-zero,
62 * otherwise 'disable' is called immediately. 'disable' may be
63 * scheduled repeatedly, to permit ever greater power saving at the
64 * expense of ever greater latency to re-enable. Rescheduling is
65 * determined by the return value of the 'disable' method. A positive
66 * value gives the delay in milliseconds.
67 *
68 * In the case where a host function (like set_ios) may be called
69 * with or without the host claimed, enabling and disabling can be
70 * done directly and will nest correctly. Call 'mmc_host_enable()' and
71 * 'mmc_host_lazy_disable()' for this purpose, but note that these
72 * functions must be paired.
73 *
74 * Alternatively, 'mmc_host_enable()' may be paired with
75 * 'mmc_host_disable()' which calls 'disable' immediately. In this
76 * case the 'disable' method will be called with 'lazy' set to 0.
77 * This is mainly useful for error paths.
78 *
79 * Because lazy disable may be called from a work queue, the 'disable'
80 * method must claim the host when 'lazy' != 0, which will work
81 * correctly because recursion is detected and handled.
82 */
83 int (*enable)(struct mmc_host *host);
84 int (*disable)(struct mmc_host *host, int lazy);
1da177e4 85 void (*request)(struct mmc_host *host, struct mmc_request *req);
28f52482
AV
86 /*
87 * Avoid calling these three functions too often or in a "fast path",
88 * since underlaying controller might implement them in an expensive
89 * and/or slow way.
90 *
91 * Also note that these functions might sleep, so don't call them
92 * in the atomic contexts!
08f80bb5
AV
93 *
94 * Return values for the get_ro callback should be:
95 * 0 for a read/write card
96 * 1 for a read-only card
97 * -ENOSYS when not supported (equal to NULL callback)
98 * or a negative errno value when something bad happened
99 *
ee63a7d2 100 * Return values for the get_cd callback should be:
08f80bb5
AV
101 * 0 for a absent card
102 * 1 for a present card
103 * -ENOSYS when not supported (equal to NULL callback)
104 * or a negative errno value when something bad happened
28f52482 105 */
1da177e4 106 void (*set_ios)(struct mmc_host *host, struct mmc_ios *ios);
a00fc090 107 int (*get_ro)(struct mmc_host *host);
28f52482
AV
108 int (*get_cd)(struct mmc_host *host);
109
17b759af 110 void (*enable_sdio_irq)(struct mmc_host *host, int enable);
3fcb027d
DM
111
112 /* optional callback for HC quirks */
113 void (*init_card)(struct mmc_host *host, struct mmc_card *card);
1da177e4
LT
114};
115
116struct mmc_card;
117struct device;
118
119struct mmc_host {
fcaf71fd
GKH
120 struct device *parent;
121 struct device class_dev;
dce77377 122 int index;
f57b225e 123 const struct mmc_host_ops *ops;
1da177e4
LT
124 unsigned int f_min;
125 unsigned int f_max;
88ae8b86 126 unsigned int f_init;
1da177e4 127 u32 ocr_avail;
4c2ef25f 128 struct notifier_block pm_notify;
1da177e4 129
55556da0 130#define MMC_VDD_165_195 0x00000080 /* VDD voltage 1.65 - 1.95 */
f74d132c
PO
131#define MMC_VDD_20_21 0x00000100 /* VDD voltage 2.0 ~ 2.1 */
132#define MMC_VDD_21_22 0x00000200 /* VDD voltage 2.1 ~ 2.2 */
133#define MMC_VDD_22_23 0x00000400 /* VDD voltage 2.2 ~ 2.3 */
134#define MMC_VDD_23_24 0x00000800 /* VDD voltage 2.3 ~ 2.4 */
135#define MMC_VDD_24_25 0x00001000 /* VDD voltage 2.4 ~ 2.5 */
136#define MMC_VDD_25_26 0x00002000 /* VDD voltage 2.5 ~ 2.6 */
137#define MMC_VDD_26_27 0x00004000 /* VDD voltage 2.6 ~ 2.7 */
138#define MMC_VDD_27_28 0x00008000 /* VDD voltage 2.7 ~ 2.8 */
139#define MMC_VDD_28_29 0x00010000 /* VDD voltage 2.8 ~ 2.9 */
140#define MMC_VDD_29_30 0x00020000 /* VDD voltage 2.9 ~ 3.0 */
141#define MMC_VDD_30_31 0x00040000 /* VDD voltage 3.0 ~ 3.1 */
142#define MMC_VDD_31_32 0x00080000 /* VDD voltage 3.1 ~ 3.2 */
143#define MMC_VDD_32_33 0x00100000 /* VDD voltage 3.2 ~ 3.3 */
144#define MMC_VDD_33_34 0x00200000 /* VDD voltage 3.3 ~ 3.4 */
145#define MMC_VDD_34_35 0x00400000 /* VDD voltage 3.4 ~ 3.5 */
146#define MMC_VDD_35_36 0x00800000 /* VDD voltage 3.5 ~ 3.6 */
147
f218278a
PO
148 unsigned long caps; /* Host capabilities */
149
150#define MMC_CAP_4_BIT_DATA (1 << 0) /* Can the host do 4 bit transfers */
23af6039
PO
151#define MMC_CAP_MMC_HIGHSPEED (1 << 1) /* Can do MMC high-speed timing */
152#define MMC_CAP_SD_HIGHSPEED (1 << 2) /* Can do SD high-speed timing */
153#define MMC_CAP_SDIO_IRQ (1 << 3) /* Can signal pending SDIO IRQs */
154#define MMC_CAP_SPI (1 << 4) /* Talks only SPI protocols */
155#define MMC_CAP_NEEDS_POLL (1 << 5) /* Needs polling for card-detection */
b30f8af3 156#define MMC_CAP_8_BIT_DATA (1 << 6) /* Can the host do 8 bit transfers */
8ea926b2 157#define MMC_CAP_DISABLE (1 << 7) /* Can the host be disabled */
9feae246 158#define MMC_CAP_NONREMOVABLE (1 << 8) /* Nonremovable e.g. eMMC */
b1ebe384 159#define MMC_CAP_WAIT_WHILE_BUSY (1 << 9) /* Waits while card is busy */
dfe86cba 160#define MMC_CAP_ERASE (1 << 10) /* Allow erase/trim commands */
dfc13e84
HP
161#define MMC_CAP_1_8V_DDR (1 << 11) /* can support */
162 /* DDR mode at 1.8V */
163#define MMC_CAP_1_2V_DDR (1 << 12) /* can support */
164 /* DDR mode at 1.2V */
f218278a 165
da68c4eb
NP
166 mmc_pm_flag_t pm_caps; /* supported pm features */
167
1da177e4
LT
168 /* host specific block data */
169 unsigned int max_seg_size; /* see blk_queue_max_segment_size */
a36274e0 170 unsigned short max_segs; /* see blk_queue_max_segments */
1da177e4 171 unsigned short unused;
55db890a 172 unsigned int max_req_size; /* maximum number of bytes in one req */
fe4a3c7a 173 unsigned int max_blk_size; /* maximum size of one mmc block */
55db890a 174 unsigned int max_blk_count; /* maximum number of blocks in one req */
1da177e4
LT
175
176 /* private data */
7ea239d9
PO
177 spinlock_t lock; /* lock for claim and bus ops */
178
1da177e4
LT
179 struct mmc_ios ios; /* current io bus settings */
180 u32 ocr; /* the current OCR setting */
181
97018580
DB
182 /* group bitfields together to minimize padding */
183 unsigned int use_spi_crc:1;
184 unsigned int claimed:1; /* host exclusively claimed */
185 unsigned int bus_dead:1; /* bus has been released */
186#ifdef CONFIG_MMC_DEBUG
187 unsigned int removed:1; /* host is being removed */
188#endif
189
8ea926b2
AH
190 /* Only used with MMC_CAP_DISABLE */
191 int enabled; /* host is enabled */
4c2ef25f 192 int rescan_disable; /* disable card detection */
8ea926b2
AH
193 int nesting_cnt; /* "enable" nesting count */
194 int en_dis_recurs; /* detect recursion */
195 unsigned int disable_delay; /* disable delay in msecs */
196 struct delayed_work disable; /* disabling work */
197
b855885e 198 struct mmc_card *card; /* device attached to this host */
1da177e4
LT
199
200 wait_queue_head_t wq;
319a3f14
AH
201 struct task_struct *claimer; /* task that has host claimed */
202 int claim_cnt; /* "claim" nesting count */
f22ee4ed 203
c4028958 204 struct delayed_work detect;
01357dca 205
7ea239d9
PO
206 const struct mmc_bus_ops *bus_ops; /* current bus driver */
207 unsigned int bus_refs; /* reference counter */
7ea239d9 208
d1496c39
NP
209 unsigned int sdio_irqs;
210 struct task_struct *sdio_irq_thread;
211 atomic_t sdio_irq_thread_abort;
212
da68c4eb
NP
213 mmc_pm_flag_t pm_flags; /* requested pm features */
214
af8350c7
PO
215#ifdef CONFIG_LEDS_TRIGGERS
216 struct led_trigger *led; /* activity led */
217#endif
218
99fc5131
LW
219#ifdef CONFIG_REGULATOR
220 bool regulator_enabled; /* regulator state */
221#endif
222
6edd8ee6
HS
223 struct dentry *debugfs_root;
224
01357dca 225 unsigned long private[0] ____cacheline_aligned;
1da177e4
LT
226};
227
228extern struct mmc_host *mmc_alloc_host(int extra, struct device *);
229extern int mmc_add_host(struct mmc_host *);
230extern void mmc_remove_host(struct mmc_host *);
231extern void mmc_free_host(struct mmc_host *);
232
01357dca
RK
233static inline void *mmc_priv(struct mmc_host *host)
234{
235 return (void *)host->private;
236}
237
97018580
DB
238#define mmc_host_is_spi(host) ((host)->caps & MMC_CAP_SPI)
239
fcaf71fd 240#define mmc_dev(x) ((x)->parent)
11354d03 241#define mmc_classdev(x) (&(x)->class_dev)
d1b26863 242#define mmc_hostname(x) (dev_name(&(x)->class_dev))
1da177e4 243
1a13f8fa 244extern int mmc_suspend_host(struct mmc_host *);
1da177e4
LT
245extern int mmc_resume_host(struct mmc_host *);
246
eae1aeee
AH
247extern void mmc_power_save_host(struct mmc_host *host);
248extern void mmc_power_restore_host(struct mmc_host *host);
249
8dc00335 250extern void mmc_detect_change(struct mmc_host *, unsigned long delay);
1da177e4
LT
251extern void mmc_request_done(struct mmc_host *, struct mmc_request *);
252
17b759af
NP
253static inline void mmc_signal_sdio_irq(struct mmc_host *host)
254{
255 host->ops->enable_sdio_irq(host, 0);
256 wake_up_process(host->sdio_irq_thread);
257}
258
5c13941a
DB
259struct regulator;
260
99fc5131 261#ifdef CONFIG_REGULATOR
5c13941a 262int mmc_regulator_get_ocrmask(struct regulator *supply);
99fc5131
LW
263int mmc_regulator_set_ocr(struct mmc_host *mmc,
264 struct regulator *supply,
265 unsigned short vdd_bit);
266#else
267static inline int mmc_regulator_get_ocrmask(struct regulator *supply)
268{
269 return 0;
270}
271
272static inline int mmc_regulator_set_ocr(struct mmc_host *mmc,
273 struct regulator *supply,
274 unsigned short vdd_bit)
275{
276 return 0;
277}
278#endif
5c13941a 279
b1ebe384
JL
280int mmc_card_awake(struct mmc_host *host);
281int mmc_card_sleep(struct mmc_host *host);
282int mmc_card_can_sleep(struct mmc_host *host);
283
8ea926b2
AH
284int mmc_host_enable(struct mmc_host *host);
285int mmc_host_disable(struct mmc_host *host);
286int mmc_host_lazy_disable(struct mmc_host *host);
4c2ef25f 287int mmc_pm_notify(struct notifier_block *notify_block, unsigned long, void *);
8ea926b2
AH
288
289static inline void mmc_set_disable_delay(struct mmc_host *host,
290 unsigned int disable_delay)
291{
292 host->disable_delay = disable_delay;
293}
294
71d7d3d1
MF
295/* Module parameter */
296extern int mmc_assume_removable;
297
298static inline int mmc_card_is_removable(struct mmc_host *host)
299{
300 return !(host->caps & MMC_CAP_NONREMOVABLE) && mmc_assume_removable;
301}
302
1da177e4
LT
303#endif
304