blob: 4a9d9d2589c7a93a540e695db0960dcd7aeb1517 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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
Pierre Ossmanaf8350c2007-09-24 07:15:48 +020013#include <linux/leds.h>
Alexey Dobriyand43c36d2009-10-07 17:09:06 +040014#include <linux/sched.h>
Pierre Ossmanaf8350c2007-09-24 07:15:48 +020015
Pierre Ossmanaaac1b42007-02-28 15:33:10 +010016#include <linux/mmc/core.h>
Nicolas Pitreda68c4e2010-03-05 13:43:31 -080017#include <linux/mmc/pm.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070018
19struct mmc_ios {
20 unsigned int clock; /* clock rate */
21 unsigned short vdd;
22
Philip Langdale4be34c92007-03-11 17:15:15 -070023/* vdd stores the bit number of the selected voltage range from below. */
Linus Torvalds1da177e2005-04-16 15:20:36 -070024
25 unsigned char bus_mode; /* command output mode */
26
27#define MMC_BUSMODE_OPENDRAIN 1
28#define MMC_BUSMODE_PUSHPULL 2
29
Pierre Ossman865e9f12005-09-03 16:45:02 +010030 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
Linus Torvalds1da177e2005-04-16 15:20:36 -070036 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
Pierre Ossmanf2182782005-09-06 15:18:55 -070041
42 unsigned char bus_width; /* data bus width */
43
44#define MMC_BUS_WIDTH_1 0
45#define MMC_BUS_WIDTH_4 2
Jarkko Lavinenb30f8af2008-11-17 14:35:21 +020046#define MMC_BUS_WIDTH_8 3
Pierre Ossmancd9277c2007-02-18 12:07:47 +010047
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
Adrian Hunter0f8d8ea2010-08-24 13:20:26 +030053
54 unsigned char ddr; /* dual data rate used */
55
56#define MMC_SDR_MODE 0
Adrian Hunter49e3b5a2010-10-11 12:43:50 +030057#define MMC_1_2V_DDR_MODE 1
58#define MMC_1_8V_DDR_MODE 2
Linus Torvalds1da177e2005-04-16 15:20:36 -070059};
60
61struct mmc_host_ops {
Adrian Hunter8ea926b2009-09-22 16:44:29 -070062 /*
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);
Linus Torvalds1da177e2005-04-16 15:20:36 -070091 void (*request)(struct mmc_host *host, struct mmc_request *req);
Anton Vorontsov28f52482008-06-17 18:17:15 +040092 /*
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!
Anton Vorontsov08f80bb2008-06-17 18:17:39 +040099 *
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 *
Thomas Petazzoniee63a7d2008-09-02 10:14:13 +0200106 * Return values for the get_cd callback should be:
Anton Vorontsov08f80bb2008-06-17 18:17:39 +0400107 * 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
Anton Vorontsov28f52482008-06-17 18:17:15 +0400111 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112 void (*set_ios)(struct mmc_host *host, struct mmc_ios *ios);
Pierre Ossmana00fc092005-09-06 15:18:52 -0700113 int (*get_ro)(struct mmc_host *host);
Anton Vorontsov28f52482008-06-17 18:17:15 +0400114 int (*get_cd)(struct mmc_host *host);
115
Nicolas Pitre17b759a2007-07-24 02:09:39 -0400116 void (*enable_sdio_irq)(struct mmc_host *host, int enable);
Daniel Mack3fcb0272010-04-01 10:03:25 +0200117
118 /* optional callback for HC quirks */
119 void (*init_card)(struct mmc_host *host, struct mmc_card *card);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120};
121
122struct mmc_card;
123struct device;
124
125struct mmc_host {
Greg Kroah-Hartmanfcaf71f2006-09-12 17:00:10 +0200126 struct device *parent;
127 struct device class_dev;
Russell Kingdce77372005-08-19 09:42:52 +0100128 int index;
David Brownellf57b2252006-09-03 06:43:33 -0700129 const struct mmc_host_ops *ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130 unsigned int f_min;
131 unsigned int f_max;
Hein Tibosch88ae8b82010-09-06 09:37:19 +0800132 unsigned int f_init;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 u32 ocr_avail;
Takashi Iwai8f230f42010-12-08 10:04:30 +0100134 u32 ocr_avail_sdio; /* SDIO-specific OCR */
135 u32 ocr_avail_sd; /* SD-specific OCR */
136 u32 ocr_avail_mmc; /* MMC-specific OCR */
Maxim Levitsky4c2ef252010-08-10 18:01:41 -0700137 struct notifier_block pm_notify;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138
Philip Langdale55556da2007-03-16 19:39:00 -0700139#define MMC_VDD_165_195 0x00000080 /* VDD voltage 1.65 - 1.95 */
Pierre Ossmanf74d1322007-02-09 22:49:31 +0100140#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
Pierre Ossmanf2182782005-09-06 15:18:55 -0700157 unsigned long caps; /* Host capabilities */
158
159#define MMC_CAP_4_BIT_DATA (1 << 0) /* Can the host do 4 bit transfers */
Pierre Ossman23af6032008-07-06 01:10:27 +0200160#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 */
Jarkko Lavinenb30f8af2008-11-17 14:35:21 +0200165#define MMC_CAP_8_BIT_DATA (1 << 6) /* Can the host do 8 bit transfers */
Adrian Hunter8ea926b2009-09-22 16:44:29 -0700166#define MMC_CAP_DISABLE (1 << 7) /* Can the host be disabled */
Adrian Hunter9feae242009-09-22 16:44:32 -0700167#define MMC_CAP_NONREMOVABLE (1 << 8) /* Nonremovable e.g. eMMC */
Jarkko Lavinenb1ebe382009-09-22 16:44:34 -0700168#define MMC_CAP_WAIT_WHILE_BUSY (1 << 9) /* Waits while card is busy */
Adrian Hunterdfe86cb2010-08-11 14:17:46 -0700169#define MMC_CAP_ERASE (1 << 10) /* Allow erase/trim commands */
Hanumath Prasaddfc13e82010-09-30 17:37:23 -0400170#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 */
Ohad Ben-Cohened919b02010-11-19 09:29:09 +0200174#define MMC_CAP_POWER_OFF_CARD (1 << 13) /* Can power off after boot */
Pierre Ossmanf2182782005-09-06 15:18:55 -0700175
Nicolas Pitreda68c4e2010-03-05 13:43:31 -0800176 mmc_pm_flag_t pm_caps; /* supported pm features */
177
Linus Walleij04566832010-11-08 21:36:50 -0500178#ifdef CONFIG_MMC_CLKGATE
179 int clk_requests; /* internal reference counter */
180 unsigned int clk_delay; /* number of MCI clk hold cycles */
181 bool clk_gated; /* clock gated */
182 struct work_struct clk_gate_work; /* delayed clock gate */
183 unsigned int clk_old; /* old clock value cache */
184 spinlock_t clk_lock; /* lock for clk fields */
185 struct mutex clk_gate_mutex; /* mutex for clock gating */
186#endif
187
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188 /* host specific block data */
189 unsigned int max_seg_size; /* see blk_queue_max_segment_size */
Martin K. Petersena36274e2010-09-10 01:33:59 -0400190 unsigned short max_segs; /* see blk_queue_max_segments */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 unsigned short unused;
Pierre Ossman55db8902006-11-21 17:55:45 +0100192 unsigned int max_req_size; /* maximum number of bytes in one req */
Pierre Ossmanfe4a3c72006-11-21 17:54:23 +0100193 unsigned int max_blk_size; /* maximum size of one mmc block */
Pierre Ossman55db8902006-11-21 17:55:45 +0100194 unsigned int max_blk_count; /* maximum number of blocks in one req */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195
196 /* private data */
Pierre Ossman7ea239d2006-12-31 00:11:32 +0100197 spinlock_t lock; /* lock for claim and bus ops */
198
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199 struct mmc_ios ios; /* current io bus settings */
200 u32 ocr; /* the current OCR setting */
201
David Brownell97018582007-08-08 09:09:01 -0700202 /* 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
Adrian Hunter8ea926b2009-09-22 16:44:29 -0700210 /* Only used with MMC_CAP_DISABLE */
211 int enabled; /* host is enabled */
Maxim Levitsky4c2ef252010-08-10 18:01:41 -0700212 int rescan_disable; /* disable card detection */
Adrian Hunter8ea926b2009-09-22 16:44:29 -0700213 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
Pierre Ossmanb8558852007-01-03 19:47:29 +0100218 struct mmc_card *card; /* device attached to this host */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219
220 wait_queue_head_t wq;
Adrian Hunter319a3f12009-09-22 16:44:30 -0700221 struct task_struct *claimer; /* task that has host claimed */
222 int claim_cnt; /* "claim" nesting count */
Pierre Ossmanf22ee4e2006-12-26 15:11:23 +0100223
David Howellsc4028952006-11-22 14:57:56 +0000224 struct delayed_work detect;
Russell King01357dc2005-09-08 22:46:00 +0100225
Pierre Ossman7ea239d2006-12-31 00:11:32 +0100226 const struct mmc_bus_ops *bus_ops; /* current bus driver */
227 unsigned int bus_refs; /* reference counter */
Pierre Ossman7ea239d2006-12-31 00:11:32 +0100228
Nicolas Pitred1496c32007-06-30 16:29:41 +0200229 unsigned int sdio_irqs;
230 struct task_struct *sdio_irq_thread;
231 atomic_t sdio_irq_thread_abort;
232
Nicolas Pitreda68c4e2010-03-05 13:43:31 -0800233 mmc_pm_flag_t pm_flags; /* requested pm features */
234
Pierre Ossmanaf8350c2007-09-24 07:15:48 +0200235#ifdef CONFIG_LEDS_TRIGGERS
236 struct led_trigger *led; /* activity led */
237#endif
238
Linus Walleij99fc5132010-09-29 01:08:27 -0400239#ifdef CONFIG_REGULATOR
240 bool regulator_enabled; /* regulator state */
241#endif
242
Haavard Skinnemoen6edd8ee2008-07-24 14:18:57 +0200243 struct dentry *debugfs_root;
244
Russell King01357dc2005-09-08 22:46:00 +0100245 unsigned long private[0] ____cacheline_aligned;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246};
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
Russell King01357dc2005-09-08 22:46:00 +0100253static inline void *mmc_priv(struct mmc_host *host)
254{
255 return (void *)host->private;
256}
257
David Brownell97018582007-08-08 09:09:01 -0700258#define mmc_host_is_spi(host) ((host)->caps & MMC_CAP_SPI)
259
Greg Kroah-Hartmanfcaf71f2006-09-12 17:00:10 +0200260#define mmc_dev(x) ((x)->parent)
Pierre Ossman11354d02007-01-14 01:41:45 +0100261#define mmc_classdev(x) (&(x)->class_dev)
Kay Sieversd1b26862008-11-08 21:37:46 +0100262#define mmc_hostname(x) (dev_name(&(x)->class_dev))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263
Matt Fleming1a13f8f2010-05-26 14:42:08 -0700264extern int mmc_suspend_host(struct mmc_host *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265extern int mmc_resume_host(struct mmc_host *);
266
Ohad Ben-Cohen12ae6372010-10-02 13:54:06 +0200267extern int mmc_power_save_host(struct mmc_host *host);
268extern int mmc_power_restore_host(struct mmc_host *host);
Adrian Huntereae1aee2009-09-22 16:44:33 -0700269
Richard Purdie8dc00332005-09-08 17:53:01 +0100270extern void mmc_detect_change(struct mmc_host *, unsigned long delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271extern void mmc_request_done(struct mmc_host *, struct mmc_request *);
272
Nicolas Pitre17b759a2007-07-24 02:09:39 -0400273static 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
David Brownell5c139412009-03-11 03:30:43 -0800279struct regulator;
280
Linus Walleij99fc5132010-09-29 01:08:27 -0400281#ifdef CONFIG_REGULATOR
David Brownell5c139412009-03-11 03:30:43 -0800282int mmc_regulator_get_ocrmask(struct regulator *supply);
Linus Walleij99fc5132010-09-29 01:08:27 -0400283int 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
David Brownell5c139412009-03-11 03:30:43 -0800299
Jarkko Lavinenb1ebe382009-09-22 16:44:34 -0700300int 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
Adrian Hunter8ea926b2009-09-22 16:44:29 -0700304int mmc_host_enable(struct mmc_host *host);
305int mmc_host_disable(struct mmc_host *host);
306int mmc_host_lazy_disable(struct mmc_host *host);
Maxim Levitsky4c2ef252010-08-10 18:01:41 -0700307int mmc_pm_notify(struct notifier_block *notify_block, unsigned long, void *);
Adrian Hunter8ea926b2009-09-22 16:44:29 -0700308
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
Matt Fleming71d7d3d2010-09-27 09:42:19 +0100315/* 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
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323#endif
324