staging: hv: Fixed bounce kmap problem by using correct index
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / include / linux / mmc / host.h
blob1575b52c3bfafa663d0fcfbea24c91269dfa83cb
1 /*
2 * linux/include/linux/mmc/host.h
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.
8 * Host driver specific definitions.
9 */
10 #ifndef LINUX_MMC_HOST_H
11 #define LINUX_MMC_HOST_H
13 #include <linux/leds.h>
14 #include <linux/sched.h>
16 #include <linux/mmc/core.h>
17 #include <linux/mmc/pm.h>
19 struct mmc_ios {
20 unsigned int clock; /* clock rate */
21 unsigned short vdd;
23 /* vdd stores the bit number of the selected voltage range from below. */
25 unsigned char bus_mode; /* command output mode */
27 #define MMC_BUSMODE_OPENDRAIN 1
28 #define MMC_BUSMODE_PUSHPULL 2
30 unsigned char chip_select; /* SPI chip select */
32 #define MMC_CS_DONTCARE 0
33 #define MMC_CS_HIGH 1
34 #define MMC_CS_LOW 2
36 unsigned char power_mode; /* power supply mode */
38 #define MMC_POWER_OFF 0
39 #define MMC_POWER_UP 1
40 #define MMC_POWER_ON 2
42 unsigned char bus_width; /* data bus width */
44 #define MMC_BUS_WIDTH_1 0
45 #define MMC_BUS_WIDTH_4 2
46 #define MMC_BUS_WIDTH_8 3
48 unsigned char timing; /* timing specification used */
50 #define MMC_TIMING_LEGACY 0
51 #define MMC_TIMING_MMC_HS 1
52 #define MMC_TIMING_SD_HS 2
55 struct mmc_host_ops {
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.
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.
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.
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.
83 int (*enable)(struct mmc_host *host);
84 int (*disable)(struct mmc_host *host, int lazy);
85 void (*request)(struct mmc_host *host, struct mmc_request *req);
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.
91 * Also note that these functions might sleep, so don't call them
92 * in the atomic contexts!
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
100 * Return values for the get_cd callback should be:
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
106 void (*set_ios)(struct mmc_host *host, struct mmc_ios *ios);
107 int (*get_ro)(struct mmc_host *host);
108 int (*get_cd)(struct mmc_host *host);
110 void (*enable_sdio_irq)(struct mmc_host *host, int enable);
112 /* optional callback for HC quirks */
113 void (*init_card)(struct mmc_host *host, struct mmc_card *card);
116 struct mmc_card;
117 struct device;
119 struct mmc_host {
120 struct device *parent;
121 struct device class_dev;
122 int index;
123 const struct mmc_host_ops *ops;
124 unsigned int f_min;
125 unsigned int f_max;
126 u32 ocr_avail;
127 struct notifier_block pm_notify;
129 #define MMC_VDD_165_195 0x00000080 /* VDD voltage 1.65 - 1.95 */
130 #define MMC_VDD_20_21 0x00000100 /* VDD voltage 2.0 ~ 2.1 */
131 #define MMC_VDD_21_22 0x00000200 /* VDD voltage 2.1 ~ 2.2 */
132 #define MMC_VDD_22_23 0x00000400 /* VDD voltage 2.2 ~ 2.3 */
133 #define MMC_VDD_23_24 0x00000800 /* VDD voltage 2.3 ~ 2.4 */
134 #define MMC_VDD_24_25 0x00001000 /* VDD voltage 2.4 ~ 2.5 */
135 #define MMC_VDD_25_26 0x00002000 /* VDD voltage 2.5 ~ 2.6 */
136 #define MMC_VDD_26_27 0x00004000 /* VDD voltage 2.6 ~ 2.7 */
137 #define MMC_VDD_27_28 0x00008000 /* VDD voltage 2.7 ~ 2.8 */
138 #define MMC_VDD_28_29 0x00010000 /* VDD voltage 2.8 ~ 2.9 */
139 #define MMC_VDD_29_30 0x00020000 /* VDD voltage 2.9 ~ 3.0 */
140 #define MMC_VDD_30_31 0x00040000 /* VDD voltage 3.0 ~ 3.1 */
141 #define MMC_VDD_31_32 0x00080000 /* VDD voltage 3.1 ~ 3.2 */
142 #define MMC_VDD_32_33 0x00100000 /* VDD voltage 3.2 ~ 3.3 */
143 #define MMC_VDD_33_34 0x00200000 /* VDD voltage 3.3 ~ 3.4 */
144 #define MMC_VDD_34_35 0x00400000 /* VDD voltage 3.4 ~ 3.5 */
145 #define MMC_VDD_35_36 0x00800000 /* VDD voltage 3.5 ~ 3.6 */
147 unsigned long caps; /* Host capabilities */
149 #define MMC_CAP_4_BIT_DATA (1 << 0) /* Can the host do 4 bit transfers */
150 #define MMC_CAP_MMC_HIGHSPEED (1 << 1) /* Can do MMC high-speed timing */
151 #define MMC_CAP_SD_HIGHSPEED (1 << 2) /* Can do SD high-speed timing */
152 #define MMC_CAP_SDIO_IRQ (1 << 3) /* Can signal pending SDIO IRQs */
153 #define MMC_CAP_SPI (1 << 4) /* Talks only SPI protocols */
154 #define MMC_CAP_NEEDS_POLL (1 << 5) /* Needs polling for card-detection */
155 #define MMC_CAP_8_BIT_DATA (1 << 6) /* Can the host do 8 bit transfers */
156 #define MMC_CAP_DISABLE (1 << 7) /* Can the host be disabled */
157 #define MMC_CAP_NONREMOVABLE (1 << 8) /* Nonremovable e.g. eMMC */
158 #define MMC_CAP_WAIT_WHILE_BUSY (1 << 9) /* Waits while card is busy */
159 #define MMC_CAP_ERASE (1 << 10) /* Allow erase/trim commands */
161 mmc_pm_flag_t pm_caps; /* supported pm features */
163 /* host specific block data */
164 unsigned int max_seg_size; /* see blk_queue_max_segment_size */
165 unsigned short max_hw_segs; /* see blk_queue_max_hw_segments */
166 unsigned short max_phys_segs; /* see blk_queue_max_phys_segments */
167 unsigned short unused;
168 unsigned int max_req_size; /* maximum number of bytes in one req */
169 unsigned int max_blk_size; /* maximum size of one mmc block */
170 unsigned int max_blk_count; /* maximum number of blocks in one req */
172 /* private data */
173 spinlock_t lock; /* lock for claim and bus ops */
175 struct mmc_ios ios; /* current io bus settings */
176 u32 ocr; /* the current OCR setting */
178 /* group bitfields together to minimize padding */
179 unsigned int use_spi_crc:1;
180 unsigned int claimed:1; /* host exclusively claimed */
181 unsigned int bus_dead:1; /* bus has been released */
182 #ifdef CONFIG_MMC_DEBUG
183 unsigned int removed:1; /* host is being removed */
184 #endif
186 /* Only used with MMC_CAP_DISABLE */
187 int enabled; /* host is enabled */
188 int rescan_disable; /* disable card detection */
189 int nesting_cnt; /* "enable" nesting count */
190 int en_dis_recurs; /* detect recursion */
191 unsigned int disable_delay; /* disable delay in msecs */
192 struct delayed_work disable; /* disabling work */
194 struct mmc_card *card; /* device attached to this host */
196 wait_queue_head_t wq;
197 struct task_struct *claimer; /* task that has host claimed */
198 int claim_cnt; /* "claim" nesting count */
200 struct delayed_work detect;
202 const struct mmc_bus_ops *bus_ops; /* current bus driver */
203 unsigned int bus_refs; /* reference counter */
205 unsigned int sdio_irqs;
206 struct task_struct *sdio_irq_thread;
207 atomic_t sdio_irq_thread_abort;
209 mmc_pm_flag_t pm_flags; /* requested pm features */
211 #ifdef CONFIG_LEDS_TRIGGERS
212 struct led_trigger *led; /* activity led */
213 #endif
215 struct dentry *debugfs_root;
217 unsigned long private[0] ____cacheline_aligned;
220 extern struct mmc_host *mmc_alloc_host(int extra, struct device *);
221 extern int mmc_add_host(struct mmc_host *);
222 extern void mmc_remove_host(struct mmc_host *);
223 extern void mmc_free_host(struct mmc_host *);
225 static inline void *mmc_priv(struct mmc_host *host)
227 return (void *)host->private;
230 #define mmc_host_is_spi(host) ((host)->caps & MMC_CAP_SPI)
232 #define mmc_dev(x) ((x)->parent)
233 #define mmc_classdev(x) (&(x)->class_dev)
234 #define mmc_hostname(x) (dev_name(&(x)->class_dev))
236 extern int mmc_suspend_host(struct mmc_host *);
237 extern int mmc_resume_host(struct mmc_host *);
239 extern void mmc_power_save_host(struct mmc_host *host);
240 extern void mmc_power_restore_host(struct mmc_host *host);
242 extern void mmc_detect_change(struct mmc_host *, unsigned long delay);
243 extern void mmc_request_done(struct mmc_host *, struct mmc_request *);
245 static inline void mmc_signal_sdio_irq(struct mmc_host *host)
247 host->ops->enable_sdio_irq(host, 0);
248 wake_up_process(host->sdio_irq_thread);
251 struct regulator;
253 int mmc_regulator_get_ocrmask(struct regulator *supply);
254 int mmc_regulator_set_ocr(struct regulator *supply, unsigned short vdd_bit);
256 int mmc_card_awake(struct mmc_host *host);
257 int mmc_card_sleep(struct mmc_host *host);
258 int mmc_card_can_sleep(struct mmc_host *host);
260 int mmc_host_enable(struct mmc_host *host);
261 int mmc_host_disable(struct mmc_host *host);
262 int mmc_host_lazy_disable(struct mmc_host *host);
263 int mmc_pm_notify(struct notifier_block *notify_block, unsigned long, void *);
265 static inline void mmc_set_disable_delay(struct mmc_host *host,
266 unsigned int disable_delay)
268 host->disable_delay = disable_delay;
271 #endif