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