]>
Commit | Line | Data |
---|---|---|
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 PO |
13 | #include <linux/leds.h> |
14 | ||
aaac1b47 | 15 | #include <linux/mmc/core.h> |
1da177e4 LT |
16 | |
17 | struct mmc_ios { | |
18 | unsigned int clock; /* clock rate */ | |
19 | unsigned short vdd; | |
20 | ||
4be34c99 | 21 | /* vdd stores the bit number of the selected voltage range from below. */ |
1da177e4 LT |
22 | |
23 | unsigned char bus_mode; /* command output mode */ | |
24 | ||
25 | #define MMC_BUSMODE_OPENDRAIN 1 | |
26 | #define MMC_BUSMODE_PUSHPULL 2 | |
27 | ||
865e9f13 PO |
28 | unsigned char chip_select; /* SPI chip select */ |
29 | ||
30 | #define MMC_CS_DONTCARE 0 | |
31 | #define MMC_CS_HIGH 1 | |
32 | #define MMC_CS_LOW 2 | |
33 | ||
1da177e4 LT |
34 | unsigned char power_mode; /* power supply mode */ |
35 | ||
36 | #define MMC_POWER_OFF 0 | |
37 | #define MMC_POWER_UP 1 | |
38 | #define MMC_POWER_ON 2 | |
f218278a PO |
39 | |
40 | unsigned char bus_width; /* data bus width */ | |
41 | ||
42 | #define MMC_BUS_WIDTH_1 0 | |
43 | #define MMC_BUS_WIDTH_4 2 | |
b30f8af3 | 44 | #define MMC_BUS_WIDTH_8 3 |
cd9277c0 PO |
45 | |
46 | unsigned char timing; /* timing specification used */ | |
47 | ||
48 | #define MMC_TIMING_LEGACY 0 | |
49 | #define MMC_TIMING_MMC_HS 1 | |
50 | #define MMC_TIMING_SD_HS 2 | |
1da177e4 LT |
51 | }; |
52 | ||
53 | struct mmc_host_ops { | |
8ea926b2 AH |
54 | /* |
55 | * Hosts that support power saving can use the 'enable' and 'disable' | |
56 | * methods to exit and enter power saving states. 'enable' is called | |
57 | * when the host is claimed and 'disable' is called (or scheduled with | |
58 | * a delay) when the host is released. The 'disable' is scheduled if | |
59 | * the disable delay set by 'mmc_set_disable_delay()' is non-zero, | |
60 | * otherwise 'disable' is called immediately. 'disable' may be | |
61 | * scheduled repeatedly, to permit ever greater power saving at the | |
62 | * expense of ever greater latency to re-enable. Rescheduling is | |
63 | * determined by the return value of the 'disable' method. A positive | |
64 | * value gives the delay in milliseconds. | |
65 | * | |
66 | * In the case where a host function (like set_ios) may be called | |
67 | * with or without the host claimed, enabling and disabling can be | |
68 | * done directly and will nest correctly. Call 'mmc_host_enable()' and | |
69 | * 'mmc_host_lazy_disable()' for this purpose, but note that these | |
70 | * functions must be paired. | |
71 | * | |
72 | * Alternatively, 'mmc_host_enable()' may be paired with | |
73 | * 'mmc_host_disable()' which calls 'disable' immediately. In this | |
74 | * case the 'disable' method will be called with 'lazy' set to 0. | |
75 | * This is mainly useful for error paths. | |
76 | * | |
77 | * Because lazy disable may be called from a work queue, the 'disable' | |
78 | * method must claim the host when 'lazy' != 0, which will work | |
79 | * correctly because recursion is detected and handled. | |
80 | */ | |
81 | int (*enable)(struct mmc_host *host); | |
82 | int (*disable)(struct mmc_host *host, int lazy); | |
1da177e4 | 83 | void (*request)(struct mmc_host *host, struct mmc_request *req); |
28f52482 AV |
84 | /* |
85 | * Avoid calling these three functions too often or in a "fast path", | |
86 | * since underlaying controller might implement them in an expensive | |
87 | * and/or slow way. | |
88 | * | |
89 | * Also note that these functions might sleep, so don't call them | |
90 | * in the atomic contexts! | |
08f80bb5 AV |
91 | * |
92 | * Return values for the get_ro callback should be: | |
93 | * 0 for a read/write card | |
94 | * 1 for a read-only card | |
95 | * -ENOSYS when not supported (equal to NULL callback) | |
96 | * or a negative errno value when something bad happened | |
97 | * | |
ee63a7d2 | 98 | * Return values for the get_cd callback should be: |
08f80bb5 AV |
99 | * 0 for a absent card |
100 | * 1 for a present card | |
101 | * -ENOSYS when not supported (equal to NULL callback) | |
102 | * or a negative errno value when something bad happened | |
28f52482 | 103 | */ |
1da177e4 | 104 | void (*set_ios)(struct mmc_host *host, struct mmc_ios *ios); |
a00fc090 | 105 | int (*get_ro)(struct mmc_host *host); |
28f52482 AV |
106 | int (*get_cd)(struct mmc_host *host); |
107 | ||
17b759af | 108 | void (*enable_sdio_irq)(struct mmc_host *host, int enable); |
1da177e4 LT |
109 | }; |
110 | ||
111 | struct mmc_card; | |
112 | struct device; | |
113 | ||
114 | struct mmc_host { | |
fcaf71fd GKH |
115 | struct device *parent; |
116 | struct device class_dev; | |
dce77377 | 117 | int index; |
f57b225e | 118 | const struct mmc_host_ops *ops; |
1da177e4 LT |
119 | unsigned int f_min; |
120 | unsigned int f_max; | |
121 | u32 ocr_avail; | |
1da177e4 | 122 | |
55556da0 | 123 | #define MMC_VDD_165_195 0x00000080 /* VDD voltage 1.65 - 1.95 */ |
f74d132c PO |
124 | #define MMC_VDD_20_21 0x00000100 /* VDD voltage 2.0 ~ 2.1 */ |
125 | #define MMC_VDD_21_22 0x00000200 /* VDD voltage 2.1 ~ 2.2 */ | |
126 | #define MMC_VDD_22_23 0x00000400 /* VDD voltage 2.2 ~ 2.3 */ | |
127 | #define MMC_VDD_23_24 0x00000800 /* VDD voltage 2.3 ~ 2.4 */ | |
128 | #define MMC_VDD_24_25 0x00001000 /* VDD voltage 2.4 ~ 2.5 */ | |
129 | #define MMC_VDD_25_26 0x00002000 /* VDD voltage 2.5 ~ 2.6 */ | |
130 | #define MMC_VDD_26_27 0x00004000 /* VDD voltage 2.6 ~ 2.7 */ | |
131 | #define MMC_VDD_27_28 0x00008000 /* VDD voltage 2.7 ~ 2.8 */ | |
132 | #define MMC_VDD_28_29 0x00010000 /* VDD voltage 2.8 ~ 2.9 */ | |
133 | #define MMC_VDD_29_30 0x00020000 /* VDD voltage 2.9 ~ 3.0 */ | |
134 | #define MMC_VDD_30_31 0x00040000 /* VDD voltage 3.0 ~ 3.1 */ | |
135 | #define MMC_VDD_31_32 0x00080000 /* VDD voltage 3.1 ~ 3.2 */ | |
136 | #define MMC_VDD_32_33 0x00100000 /* VDD voltage 3.2 ~ 3.3 */ | |
137 | #define MMC_VDD_33_34 0x00200000 /* VDD voltage 3.3 ~ 3.4 */ | |
138 | #define MMC_VDD_34_35 0x00400000 /* VDD voltage 3.4 ~ 3.5 */ | |
139 | #define MMC_VDD_35_36 0x00800000 /* VDD voltage 3.5 ~ 3.6 */ | |
140 | ||
f218278a PO |
141 | unsigned long caps; /* Host capabilities */ |
142 | ||
143 | #define MMC_CAP_4_BIT_DATA (1 << 0) /* Can the host do 4 bit transfers */ | |
23af6039 PO |
144 | #define MMC_CAP_MMC_HIGHSPEED (1 << 1) /* Can do MMC high-speed timing */ |
145 | #define MMC_CAP_SD_HIGHSPEED (1 << 2) /* Can do SD high-speed timing */ | |
146 | #define MMC_CAP_SDIO_IRQ (1 << 3) /* Can signal pending SDIO IRQs */ | |
147 | #define MMC_CAP_SPI (1 << 4) /* Talks only SPI protocols */ | |
148 | #define MMC_CAP_NEEDS_POLL (1 << 5) /* Needs polling for card-detection */ | |
b30f8af3 | 149 | #define MMC_CAP_8_BIT_DATA (1 << 6) /* Can the host do 8 bit transfers */ |
8ea926b2 | 150 | #define MMC_CAP_DISABLE (1 << 7) /* Can the host be disabled */ |
f218278a | 151 | |
1da177e4 LT |
152 | /* host specific block data */ |
153 | unsigned int max_seg_size; /* see blk_queue_max_segment_size */ | |
154 | unsigned short max_hw_segs; /* see blk_queue_max_hw_segments */ | |
155 | unsigned short max_phys_segs; /* see blk_queue_max_phys_segments */ | |
1da177e4 | 156 | unsigned short unused; |
55db890a | 157 | unsigned int max_req_size; /* maximum number of bytes in one req */ |
fe4a3c7a | 158 | unsigned int max_blk_size; /* maximum size of one mmc block */ |
55db890a | 159 | unsigned int max_blk_count; /* maximum number of blocks in one req */ |
1da177e4 LT |
160 | |
161 | /* private data */ | |
7ea239d9 PO |
162 | spinlock_t lock; /* lock for claim and bus ops */ |
163 | ||
1da177e4 LT |
164 | struct mmc_ios ios; /* current io bus settings */ |
165 | u32 ocr; /* the current OCR setting */ | |
166 | ||
97018580 DB |
167 | /* group bitfields together to minimize padding */ |
168 | unsigned int use_spi_crc:1; | |
169 | unsigned int claimed:1; /* host exclusively claimed */ | |
170 | unsigned int bus_dead:1; /* bus has been released */ | |
171 | #ifdef CONFIG_MMC_DEBUG | |
172 | unsigned int removed:1; /* host is being removed */ | |
173 | #endif | |
174 | ||
8ea926b2 AH |
175 | /* Only used with MMC_CAP_DISABLE */ |
176 | int enabled; /* host is enabled */ | |
177 | int nesting_cnt; /* "enable" nesting count */ | |
178 | int en_dis_recurs; /* detect recursion */ | |
179 | unsigned int disable_delay; /* disable delay in msecs */ | |
180 | struct delayed_work disable; /* disabling work */ | |
181 | ||
b855885e | 182 | struct mmc_card *card; /* device attached to this host */ |
1da177e4 LT |
183 | |
184 | wait_queue_head_t wq; | |
319a3f14 AH |
185 | struct task_struct *claimer; /* task that has host claimed */ |
186 | int claim_cnt; /* "claim" nesting count */ | |
f22ee4ed | 187 | |
c4028958 | 188 | struct delayed_work detect; |
01357dca | 189 | |
7ea239d9 PO |
190 | const struct mmc_bus_ops *bus_ops; /* current bus driver */ |
191 | unsigned int bus_refs; /* reference counter */ | |
7ea239d9 | 192 | |
d1496c39 NP |
193 | unsigned int sdio_irqs; |
194 | struct task_struct *sdio_irq_thread; | |
195 | atomic_t sdio_irq_thread_abort; | |
196 | ||
af8350c7 PO |
197 | #ifdef CONFIG_LEDS_TRIGGERS |
198 | struct led_trigger *led; /* activity led */ | |
199 | #endif | |
200 | ||
6edd8ee6 HS |
201 | struct dentry *debugfs_root; |
202 | ||
01357dca | 203 | unsigned long private[0] ____cacheline_aligned; |
1da177e4 LT |
204 | }; |
205 | ||
206 | extern struct mmc_host *mmc_alloc_host(int extra, struct device *); | |
207 | extern int mmc_add_host(struct mmc_host *); | |
208 | extern void mmc_remove_host(struct mmc_host *); | |
209 | extern void mmc_free_host(struct mmc_host *); | |
210 | ||
01357dca RK |
211 | static inline void *mmc_priv(struct mmc_host *host) |
212 | { | |
213 | return (void *)host->private; | |
214 | } | |
215 | ||
97018580 DB |
216 | #define mmc_host_is_spi(host) ((host)->caps & MMC_CAP_SPI) |
217 | ||
fcaf71fd | 218 | #define mmc_dev(x) ((x)->parent) |
11354d03 | 219 | #define mmc_classdev(x) (&(x)->class_dev) |
d1b26863 | 220 | #define mmc_hostname(x) (dev_name(&(x)->class_dev)) |
1da177e4 | 221 | |
3bfffd97 | 222 | extern int mmc_suspend_host(struct mmc_host *, pm_message_t); |
1da177e4 LT |
223 | extern int mmc_resume_host(struct mmc_host *); |
224 | ||
8dc00335 | 225 | extern void mmc_detect_change(struct mmc_host *, unsigned long delay); |
1da177e4 LT |
226 | extern void mmc_request_done(struct mmc_host *, struct mmc_request *); |
227 | ||
17b759af NP |
228 | static inline void mmc_signal_sdio_irq(struct mmc_host *host) |
229 | { | |
230 | host->ops->enable_sdio_irq(host, 0); | |
231 | wake_up_process(host->sdio_irq_thread); | |
232 | } | |
233 | ||
5c13941a DB |
234 | struct regulator; |
235 | ||
236 | int mmc_regulator_get_ocrmask(struct regulator *supply); | |
237 | int mmc_regulator_set_ocr(struct regulator *supply, unsigned short vdd_bit); | |
238 | ||
8ea926b2 AH |
239 | int mmc_host_enable(struct mmc_host *host); |
240 | int mmc_host_disable(struct mmc_host *host); | |
241 | int mmc_host_lazy_disable(struct mmc_host *host); | |
242 | ||
243 | static inline void mmc_set_disable_delay(struct mmc_host *host, | |
244 | unsigned int disable_delay) | |
245 | { | |
246 | host->disable_delay = disable_delay; | |
247 | } | |
248 | ||
1da177e4 LT |
249 | #endif |
250 |