sdio: introduce API for special power management features
[linux-2.6.git] / include / linux / mmc / host.h
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
13 #include <linux/leds.h>
14 #include <linux/sched.h>
15
16 #include <linux/mmc/core.h>
17 #include <linux/mmc/pm.h>
18
19 struct mmc_ios {
20         unsigned int    clock;                  /* clock rate */
21         unsigned short  vdd;
22
23 /* vdd stores the bit number of the selected voltage range from below. */
24
25         unsigned char   bus_mode;               /* command output mode */
26
27 #define MMC_BUSMODE_OPENDRAIN   1
28 #define MMC_BUSMODE_PUSHPULL    2
29
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
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
41
42         unsigned char   bus_width;              /* data bus width */
43
44 #define MMC_BUS_WIDTH_1         0
45 #define MMC_BUS_WIDTH_4         2
46 #define MMC_BUS_WIDTH_8         3
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
53 };
54
55 struct mmc_host_ops {
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);
85         void    (*request)(struct mmc_host *host, struct mmc_request *req);
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!
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          *
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
105          */
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);
109
110         void    (*enable_sdio_irq)(struct mmc_host *host, int enable);
111 };
112
113 struct mmc_card;
114 struct device;
115
116 struct mmc_host {
117         struct device           *parent;
118         struct device           class_dev;
119         int                     index;
120         const struct mmc_host_ops *ops;
121         unsigned int            f_min;
122         unsigned int            f_max;
123         u32                     ocr_avail;
124
125 #define MMC_VDD_165_195         0x00000080      /* VDD voltage 1.65 - 1.95 */
126 #define MMC_VDD_20_21           0x00000100      /* VDD voltage 2.0 ~ 2.1 */
127 #define MMC_VDD_21_22           0x00000200      /* VDD voltage 2.1 ~ 2.2 */
128 #define MMC_VDD_22_23           0x00000400      /* VDD voltage 2.2 ~ 2.3 */
129 #define MMC_VDD_23_24           0x00000800      /* VDD voltage 2.3 ~ 2.4 */
130 #define MMC_VDD_24_25           0x00001000      /* VDD voltage 2.4 ~ 2.5 */
131 #define MMC_VDD_25_26           0x00002000      /* VDD voltage 2.5 ~ 2.6 */
132 #define MMC_VDD_26_27           0x00004000      /* VDD voltage 2.6 ~ 2.7 */
133 #define MMC_VDD_27_28           0x00008000      /* VDD voltage 2.7 ~ 2.8 */
134 #define MMC_VDD_28_29           0x00010000      /* VDD voltage 2.8 ~ 2.9 */
135 #define MMC_VDD_29_30           0x00020000      /* VDD voltage 2.9 ~ 3.0 */
136 #define MMC_VDD_30_31           0x00040000      /* VDD voltage 3.0 ~ 3.1 */
137 #define MMC_VDD_31_32           0x00080000      /* VDD voltage 3.1 ~ 3.2 */
138 #define MMC_VDD_32_33           0x00100000      /* VDD voltage 3.2 ~ 3.3 */
139 #define MMC_VDD_33_34           0x00200000      /* VDD voltage 3.3 ~ 3.4 */
140 #define MMC_VDD_34_35           0x00400000      /* VDD voltage 3.4 ~ 3.5 */
141 #define MMC_VDD_35_36           0x00800000      /* VDD voltage 3.5 ~ 3.6 */
142
143         unsigned long           caps;           /* Host capabilities */
144
145 #define MMC_CAP_4_BIT_DATA      (1 << 0)        /* Can the host do 4 bit transfers */
146 #define MMC_CAP_MMC_HIGHSPEED   (1 << 1)        /* Can do MMC high-speed timing */
147 #define MMC_CAP_SD_HIGHSPEED    (1 << 2)        /* Can do SD high-speed timing */
148 #define MMC_CAP_SDIO_IRQ        (1 << 3)        /* Can signal pending SDIO IRQs */
149 #define MMC_CAP_SPI             (1 << 4)        /* Talks only SPI protocols */
150 #define MMC_CAP_NEEDS_POLL      (1 << 5)        /* Needs polling for card-detection */
151 #define MMC_CAP_8_BIT_DATA      (1 << 6)        /* Can the host do 8 bit transfers */
152 #define MMC_CAP_DISABLE         (1 << 7)        /* Can the host be disabled */
153 #define MMC_CAP_NONREMOVABLE    (1 << 8)        /* Nonremovable e.g. eMMC */
154 #define MMC_CAP_WAIT_WHILE_BUSY (1 << 9)        /* Waits while card is busy */
155
156         mmc_pm_flag_t           pm_caps;        /* supported pm features */
157
158         /* host specific block data */
159         unsigned int            max_seg_size;   /* see blk_queue_max_segment_size */
160         unsigned short          max_hw_segs;    /* see blk_queue_max_hw_segments */
161         unsigned short          max_phys_segs;  /* see blk_queue_max_phys_segments */
162         unsigned short          unused;
163         unsigned int            max_req_size;   /* maximum number of bytes in one req */
164         unsigned int            max_blk_size;   /* maximum size of one mmc block */
165         unsigned int            max_blk_count;  /* maximum number of blocks in one req */
166
167         /* private data */
168         spinlock_t              lock;           /* lock for claim and bus ops */
169
170         struct mmc_ios          ios;            /* current io bus settings */
171         u32                     ocr;            /* the current OCR setting */
172
173         /* group bitfields together to minimize padding */
174         unsigned int            use_spi_crc:1;
175         unsigned int            claimed:1;      /* host exclusively claimed */
176         unsigned int            bus_dead:1;     /* bus has been released */
177 #ifdef CONFIG_MMC_DEBUG
178         unsigned int            removed:1;      /* host is being removed */
179 #endif
180
181         /* Only used with MMC_CAP_DISABLE */
182         int                     enabled;        /* host is enabled */
183         int                     nesting_cnt;    /* "enable" nesting count */
184         int                     en_dis_recurs;  /* detect recursion */
185         unsigned int            disable_delay;  /* disable delay in msecs */
186         struct delayed_work     disable;        /* disabling work */
187
188         struct mmc_card         *card;          /* device attached to this host */
189
190         wait_queue_head_t       wq;
191         struct task_struct      *claimer;       /* task that has host claimed */
192         int                     claim_cnt;      /* "claim" nesting count */
193
194         struct delayed_work     detect;
195
196         const struct mmc_bus_ops *bus_ops;      /* current bus driver */
197         unsigned int            bus_refs;       /* reference counter */
198
199         unsigned int            sdio_irqs;
200         struct task_struct      *sdio_irq_thread;
201         atomic_t                sdio_irq_thread_abort;
202
203         mmc_pm_flag_t           pm_flags;       /* requested pm features */
204
205 #ifdef CONFIG_LEDS_TRIGGERS
206         struct led_trigger      *led;           /* activity led */
207 #endif
208
209         struct dentry           *debugfs_root;
210
211         unsigned long           private[0] ____cacheline_aligned;
212 };
213
214 extern struct mmc_host *mmc_alloc_host(int extra, struct device *);
215 extern int mmc_add_host(struct mmc_host *);
216 extern void mmc_remove_host(struct mmc_host *);
217 extern void mmc_free_host(struct mmc_host *);
218
219 static inline void *mmc_priv(struct mmc_host *host)
220 {
221         return (void *)host->private;
222 }
223
224 #define mmc_host_is_spi(host)   ((host)->caps & MMC_CAP_SPI)
225
226 #define mmc_dev(x)      ((x)->parent)
227 #define mmc_classdev(x) (&(x)->class_dev)
228 #define mmc_hostname(x) (dev_name(&(x)->class_dev))
229
230 extern int mmc_suspend_host(struct mmc_host *, pm_message_t);
231 extern int mmc_resume_host(struct mmc_host *);
232
233 extern void mmc_power_save_host(struct mmc_host *host);
234 extern void mmc_power_restore_host(struct mmc_host *host);
235
236 extern void mmc_detect_change(struct mmc_host *, unsigned long delay);
237 extern void mmc_request_done(struct mmc_host *, struct mmc_request *);
238
239 static inline void mmc_signal_sdio_irq(struct mmc_host *host)
240 {
241         host->ops->enable_sdio_irq(host, 0);
242         wake_up_process(host->sdio_irq_thread);
243 }
244
245 struct regulator;
246
247 int mmc_regulator_get_ocrmask(struct regulator *supply);
248 int mmc_regulator_set_ocr(struct regulator *supply, unsigned short vdd_bit);
249
250 int mmc_card_awake(struct mmc_host *host);
251 int mmc_card_sleep(struct mmc_host *host);
252 int mmc_card_can_sleep(struct mmc_host *host);
253
254 int mmc_host_enable(struct mmc_host *host);
255 int mmc_host_disable(struct mmc_host *host);
256 int mmc_host_lazy_disable(struct mmc_host *host);
257
258 static inline void mmc_set_disable_delay(struct mmc_host *host,
259                                          unsigned int disable_delay)
260 {
261         host->disable_delay = disable_delay;
262 }
263
264 #endif
265