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