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