Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
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/mutex.h>
15#include <linux/sched.h>
16#include <linux/device.h>
17#include <linux/fault-inject.h>
18
19#include <linux/mmc/core.h>
20#include <linux/mmc/pm.h>
21
22struct 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 3
57#define MMC_TIMING_UHS_SDR25 4
58#define MMC_TIMING_UHS_SDR50 5
59#define MMC_TIMING_UHS_SDR104 6
60#define MMC_TIMING_UHS_DDR50 7
61#define MMC_TIMING_MMC_HS200 8
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
83struct 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 void (*card_event)(struct mmc_host *host);
140};
141
142struct mmc_card;
143struct device;
144
145struct mmc_async_req {
146 /* active mmc request */
147 struct mmc_request *mrq;
148 /*
149 * Check error status of completed mmc request.
150 * Returns 0 if success otherwise non zero.
151 */
152 int (*err_check) (struct mmc_card *, struct mmc_async_req *);
153};
154
155/**
156 * struct mmc_slot - MMC slot functions
157 *
158 * @cd_irq: MMC/SD-card slot hotplug detection IRQ or -EINVAL
159 * @lock: protect the @handler_priv pointer
160 * @handler_priv: MMC/SD-card slot context
161 *
162 * Some MMC/SD host controllers implement slot-functions like card and
163 * write-protect detection natively. However, a large number of controllers
164 * leave these functions to the CPU. This struct provides a hook to attach
165 * such slot-function drivers.
166 */
167struct mmc_slot {
168 int cd_irq;
169 struct mutex lock;
170 void *handler_priv;
171};
172
173struct regulator;
174
175struct mmc_supply {
176 struct regulator *vmmc; /* Card power supply */
177 struct regulator *vqmmc; /* Optional Vccq supply */
178};
179
180struct mmc_host {
181 struct device *parent;
182 struct device class_dev;
183 int index;
184 const struct mmc_host_ops *ops;
185 unsigned int f_min;
186 unsigned int f_max;
187 unsigned int f_init;
188 u32 ocr_avail;
189 u32 ocr_avail_sdio; /* SDIO-specific OCR */
190 u32 ocr_avail_sd; /* SD-specific OCR */
191 u32 ocr_avail_mmc; /* MMC-specific OCR */
192 struct notifier_block pm_notify;
193 u32 max_current_330;
194 u32 max_current_300;
195 u32 max_current_180;
196
197#define MMC_VDD_165_195 0x00000080 /* VDD voltage 1.65 - 1.95 */
198#define MMC_VDD_20_21 0x00000100 /* VDD voltage 2.0 ~ 2.1 */
199#define MMC_VDD_21_22 0x00000200 /* VDD voltage 2.1 ~ 2.2 */
200#define MMC_VDD_22_23 0x00000400 /* VDD voltage 2.2 ~ 2.3 */
201#define MMC_VDD_23_24 0x00000800 /* VDD voltage 2.3 ~ 2.4 */
202#define MMC_VDD_24_25 0x00001000 /* VDD voltage 2.4 ~ 2.5 */
203#define MMC_VDD_25_26 0x00002000 /* VDD voltage 2.5 ~ 2.6 */
204#define MMC_VDD_26_27 0x00004000 /* VDD voltage 2.6 ~ 2.7 */
205#define MMC_VDD_27_28 0x00008000 /* VDD voltage 2.7 ~ 2.8 */
206#define MMC_VDD_28_29 0x00010000 /* VDD voltage 2.8 ~ 2.9 */
207#define MMC_VDD_29_30 0x00020000 /* VDD voltage 2.9 ~ 3.0 */
208#define MMC_VDD_30_31 0x00040000 /* VDD voltage 3.0 ~ 3.1 */
209#define MMC_VDD_31_32 0x00080000 /* VDD voltage 3.1 ~ 3.2 */
210#define MMC_VDD_32_33 0x00100000 /* VDD voltage 3.2 ~ 3.3 */
211#define MMC_VDD_33_34 0x00200000 /* VDD voltage 3.3 ~ 3.4 */
212#define MMC_VDD_34_35 0x00400000 /* VDD voltage 3.4 ~ 3.5 */
213#define MMC_VDD_35_36 0x00800000 /* VDD voltage 3.5 ~ 3.6 */
214
215 u32 caps; /* Host capabilities */
216
217#define MMC_CAP_4_BIT_DATA (1 << 0) /* Can the host do 4 bit transfers */
218#define MMC_CAP_MMC_HIGHSPEED (1 << 1) /* Can do MMC high-speed timing */
219#define MMC_CAP_SD_HIGHSPEED (1 << 2) /* Can do SD high-speed timing */
220#define MMC_CAP_SDIO_IRQ (1 << 3) /* Can signal pending SDIO IRQs */
221#define MMC_CAP_SPI (1 << 4) /* Talks only SPI protocols */
222#define MMC_CAP_NEEDS_POLL (1 << 5) /* Needs polling for card-detection */
223#define MMC_CAP_8_BIT_DATA (1 << 6) /* Can the host do 8 bit transfers */
224
225#define MMC_CAP_NONREMOVABLE (1 << 8) /* Nonremovable e.g. eMMC */
226#define MMC_CAP_WAIT_WHILE_BUSY (1 << 9) /* Waits while card is busy */
227#define MMC_CAP_ERASE (1 << 10) /* Allow erase/trim commands */
228#define MMC_CAP_1_8V_DDR (1 << 11) /* can support */
229 /* DDR mode at 1.8V */
230#define MMC_CAP_1_2V_DDR (1 << 12) /* can support */
231 /* DDR mode at 1.2V */
232#define MMC_CAP_POWER_OFF_CARD (1 << 13) /* Can power off after boot */
233#define MMC_CAP_BUS_WIDTH_TEST (1 << 14) /* CMD14/CMD19 bus width ok */
234#define MMC_CAP_UHS_SDR12 (1 << 15) /* Host supports UHS SDR12 mode */
235#define MMC_CAP_UHS_SDR25 (1 << 16) /* Host supports UHS SDR25 mode */
236#define MMC_CAP_UHS_SDR50 (1 << 17) /* Host supports UHS SDR50 mode */
237#define MMC_CAP_UHS_SDR104 (1 << 18) /* Host supports UHS SDR104 mode */
238#define MMC_CAP_UHS_DDR50 (1 << 19) /* Host supports UHS DDR50 mode */
239#define MMC_CAP_DRIVER_TYPE_A (1 << 23) /* Host supports Driver Type A */
240#define MMC_CAP_DRIVER_TYPE_C (1 << 24) /* Host supports Driver Type C */
241#define MMC_CAP_DRIVER_TYPE_D (1 << 25) /* Host supports Driver Type D */
242#define MMC_CAP_CMD23 (1 << 30) /* CMD23 supported. */
243#define MMC_CAP_HW_RESET (1 << 31) /* Hardware reset */
244
245 u32 caps2; /* More host capabilities */
246
247#define MMC_CAP2_BOOTPART_NOACC (1 << 0) /* Boot partition no access */
248#define MMC_CAP2_CACHE_CTRL (1 << 1) /* Allow cache control */
249#define MMC_CAP2_POWEROFF_NOTIFY (1 << 2) /* Notify poweroff supported */
250#define MMC_CAP2_NO_MULTI_READ (1 << 3) /* Multiblock reads don't work */
251#define MMC_CAP2_NO_SLEEP_CMD (1 << 4) /* Don't allow sleep command */
252#define MMC_CAP2_HS200_1_8V_SDR (1 << 5) /* can support */
253#define MMC_CAP2_HS200_1_2V_SDR (1 << 6) /* can support */
254#define MMC_CAP2_HS200 (MMC_CAP2_HS200_1_8V_SDR | \
255 MMC_CAP2_HS200_1_2V_SDR)
256#define MMC_CAP2_BROKEN_VOLTAGE (1 << 7) /* Use the broken voltage */
257#define MMC_CAP2_DETECT_ON_ERR (1 << 8) /* On I/O err check card removal */
258#define MMC_CAP2_HC_ERASE_SZ (1 << 9) /* High-capacity erase size */
259#define MMC_CAP2_CD_ACTIVE_HIGH (1 << 10) /* Card-detect signal active high */
260#define MMC_CAP2_RO_ACTIVE_HIGH (1 << 11) /* Write-protect signal active high */
261
262 mmc_pm_flag_t pm_caps; /* supported pm features */
263
264#ifdef CONFIG_MMC_CLKGATE
265 int clk_requests; /* internal reference counter */
266 unsigned int clk_delay; /* number of MCI clk hold cycles */
267 bool clk_gated; /* clock gated */
268 struct delayed_work clk_gate_work; /* delayed clock gate */
269 unsigned int clk_old; /* old clock value cache */
270 spinlock_t clk_lock; /* lock for clk fields */
271 struct mutex clk_gate_mutex; /* mutex for clock gating */
272 struct device_attribute clkgate_delay_attr;
273 unsigned long clkgate_delay;
274#endif
275
276 /* host specific block data */
277 unsigned int max_seg_size; /* see blk_queue_max_segment_size */
278 unsigned short max_segs; /* see blk_queue_max_segments */
279 unsigned short unused;
280 unsigned int max_req_size; /* maximum number of bytes in one req */
281 unsigned int max_blk_size; /* maximum size of one mmc block */
282 unsigned int max_blk_count; /* maximum number of blocks in one req */
283 unsigned int max_discard_to; /* max. discard timeout in ms */
284
285 /* private data */
286 spinlock_t lock; /* lock for claim and bus ops */
287
288 struct mmc_ios ios; /* current io bus settings */
289 u32 ocr; /* the current OCR setting */
290
291 /* group bitfields together to minimize padding */
292 unsigned int use_spi_crc:1;
293 unsigned int claimed:1; /* host exclusively claimed */
294 unsigned int bus_dead:1; /* bus has been released */
295#ifdef CONFIG_MMC_DEBUG
296 unsigned int removed:1; /* host is being removed */
297#endif
298
299 int rescan_disable; /* disable card detection */
300 int rescan_entered; /* used with nonremovable devices */
301
302 struct mmc_card *card; /* device attached to this host */
303
304 wait_queue_head_t wq;
305 struct task_struct *claimer; /* task that has host claimed */
306 int claim_cnt; /* "claim" nesting count */
307
308 struct delayed_work detect;
309 int detect_change; /* card detect flag */
310 struct mmc_slot slot;
311
312 const struct mmc_bus_ops *bus_ops; /* current bus driver */
313 unsigned int bus_refs; /* reference counter */
314
315 unsigned int sdio_irqs;
316 struct task_struct *sdio_irq_thread;
317 bool sdio_irq_pending;
318 atomic_t sdio_irq_thread_abort;
319
320 mmc_pm_flag_t pm_flags; /* requested pm features */
321
322#ifdef CONFIG_LEDS_TRIGGERS
323 struct led_trigger *led; /* activity led */
324#endif
325
326#ifdef CONFIG_REGULATOR
327 bool regulator_enabled; /* regulator state */
328#endif
329 struct mmc_supply supply;
330
331 struct dentry *debugfs_root;
332
333 struct mmc_async_req *areq; /* active async req */
334
335#ifdef CONFIG_FAIL_MMC_REQUEST
336 struct fault_attr fail_mmc_request;
337#endif
338
339 unsigned int actual_clock; /* Actual HC clock rate */
340
341 unsigned long private[0] ____cacheline_aligned;
342};
343
344extern struct mmc_host *mmc_alloc_host(int extra, struct device *);
345extern int mmc_add_host(struct mmc_host *);
346extern void mmc_remove_host(struct mmc_host *);
347extern void mmc_free_host(struct mmc_host *);
348
349static inline void *mmc_priv(struct mmc_host *host)
350{
351 return (void *)host->private;
352}
353
354#define mmc_host_is_spi(host) ((host)->caps & MMC_CAP_SPI)
355
356#define mmc_dev(x) ((x)->parent)
357#define mmc_classdev(x) (&(x)->class_dev)
358#define mmc_hostname(x) (dev_name(&(x)->class_dev))
359
360extern int mmc_suspend_host(struct mmc_host *);
361extern int mmc_resume_host(struct mmc_host *);
362
363extern int mmc_power_save_host(struct mmc_host *host);
364extern int mmc_power_restore_host(struct mmc_host *host);
365
366extern void mmc_detect_change(struct mmc_host *, unsigned long delay);
367extern void mmc_request_done(struct mmc_host *, struct mmc_request *);
368
369extern int mmc_cache_ctrl(struct mmc_host *, u8);
370
371static inline void mmc_signal_sdio_irq(struct mmc_host *host)
372{
373 host->ops->enable_sdio_irq(host, 0);
374 host->sdio_irq_pending = true;
375 wake_up_process(host->sdio_irq_thread);
376}
377
378#ifdef CONFIG_REGULATOR
379int mmc_regulator_get_ocrmask(struct regulator *supply);
380int mmc_regulator_set_ocr(struct mmc_host *mmc,
381 struct regulator *supply,
382 unsigned short vdd_bit);
383int mmc_regulator_get_supply(struct mmc_host *mmc);
384#else
385static inline int mmc_regulator_get_ocrmask(struct regulator *supply)
386{
387 return 0;
388}
389
390static inline int mmc_regulator_set_ocr(struct mmc_host *mmc,
391 struct regulator *supply,
392 unsigned short vdd_bit)
393{
394 return 0;
395}
396
397static inline int mmc_regulator_get_supply(struct mmc_host *mmc)
398{
399 return 0;
400}
401#endif
402
403int mmc_card_awake(struct mmc_host *host);
404int mmc_card_sleep(struct mmc_host *host);
405int mmc_card_can_sleep(struct mmc_host *host);
406
407int mmc_pm_notify(struct notifier_block *notify_block, unsigned long, void *);
408
409/* Module parameter */
410extern bool mmc_assume_removable;
411
412static inline int mmc_card_is_removable(struct mmc_host *host)
413{
414 return !(host->caps & MMC_CAP_NONREMOVABLE) && mmc_assume_removable;
415}
416
417static inline int mmc_card_keep_power(struct mmc_host *host)
418{
419 return host->pm_flags & MMC_PM_KEEP_POWER;
420}
421
422static inline int mmc_card_wake_sdio_irq(struct mmc_host *host)
423{
424 return host->pm_flags & MMC_PM_WAKE_SDIO_IRQ;
425}
426
427static inline int mmc_host_cmd23(struct mmc_host *host)
428{
429 return host->caps & MMC_CAP_CMD23;
430}
431
432static inline int mmc_boot_partition_access(struct mmc_host *host)
433{
434 return !(host->caps2 & MMC_CAP2_BOOTPART_NOACC);
435}
436
437#ifdef CONFIG_MMC_CLKGATE
438void mmc_host_clk_hold(struct mmc_host *host);
439void mmc_host_clk_release(struct mmc_host *host);
440unsigned int mmc_host_clk_rate(struct mmc_host *host);
441
442#else
443static inline void mmc_host_clk_hold(struct mmc_host *host)
444{
445}
446
447static inline void mmc_host_clk_release(struct mmc_host *host)
448{
449}
450
451static inline unsigned int mmc_host_clk_rate(struct mmc_host *host)
452{
453 return host->ios.clock;
454}
455#endif
456#endif /* LINUX_MMC_HOST_H */