2 * linux/include/linux/mmc/host.h
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.
8 * Host driver specific definitions.
10 #ifndef LINUX_MMC_HOST_H
11 #define LINUX_MMC_HOST_H
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>
19 #include <linux/mmc/core.h>
20 #include <linux/mmc/pm.h>
23 unsigned int clock
; /* clock rate */
26 /* vdd stores the bit number of the selected voltage range from below. */
28 unsigned char bus_mode
; /* command output mode */
30 #define MMC_BUSMODE_OPENDRAIN 1
31 #define MMC_BUSMODE_PUSHPULL 2
33 unsigned char chip_select
; /* SPI chip select */
35 #define MMC_CS_DONTCARE 0
39 unsigned char power_mode
; /* power supply mode */
41 #define MMC_POWER_OFF 0
42 #define MMC_POWER_UP 1
43 #define MMC_POWER_ON 2
45 unsigned char bus_width
; /* data bus width */
47 #define MMC_BUS_WIDTH_1 0
48 #define MMC_BUS_WIDTH_4 2
49 #define MMC_BUS_WIDTH_8 3
51 unsigned char timing
; /* timing specification used */
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_DDR52 8
62 #define MMC_TIMING_MMC_HS200 9
64 #define MMC_SDR_MODE 0
65 #define MMC_1_2V_DDR_MODE 1
66 #define MMC_1_8V_DDR_MODE 2
67 #define MMC_1_2V_SDR_MODE 3
68 #define MMC_1_8V_SDR_MODE 4
70 unsigned char signal_voltage
; /* signalling voltage (1.8V or 3.3V) */
72 #define MMC_SIGNAL_VOLTAGE_330 0
73 #define MMC_SIGNAL_VOLTAGE_180 1
74 #define MMC_SIGNAL_VOLTAGE_120 2
76 unsigned char drv_type
; /* driver type (A, B, C, D) */
78 #define MMC_SET_DRIVER_TYPE_B 0
79 #define MMC_SET_DRIVER_TYPE_A 1
80 #define MMC_SET_DRIVER_TYPE_C 2
81 #define MMC_SET_DRIVER_TYPE_D 3
86 * 'enable' is called when the host is claimed and 'disable' is called
87 * when the host is released. 'enable' and 'disable' are deprecated.
89 int (*enable
)(struct mmc_host
*host
);
90 int (*disable
)(struct mmc_host
*host
);
92 * It is optional for the host to implement pre_req and post_req in
93 * order to support double buffering of requests (prepare one
94 * request while another request is active).
95 * pre_req() must always be followed by a post_req().
96 * To undo a call made to pre_req(), call post_req() with
97 * a nonzero err condition.
99 void (*post_req
)(struct mmc_host
*host
, struct mmc_request
*req
,
101 void (*pre_req
)(struct mmc_host
*host
, struct mmc_request
*req
,
103 void (*request
)(struct mmc_host
*host
, struct mmc_request
*req
);
105 * Avoid calling these three functions too often or in a "fast path",
106 * since underlaying controller might implement them in an expensive
109 * Also note that these functions might sleep, so don't call them
110 * in the atomic contexts!
112 * Return values for the get_ro callback should be:
113 * 0 for a read/write card
114 * 1 for a read-only card
115 * -ENOSYS when not supported (equal to NULL callback)
116 * or a negative errno value when something bad happened
118 * Return values for the get_cd callback should be:
119 * 0 for a absent card
120 * 1 for a present card
121 * -ENOSYS when not supported (equal to NULL callback)
122 * or a negative errno value when something bad happened
124 void (*set_ios
)(struct mmc_host
*host
, struct mmc_ios
*ios
);
125 int (*get_ro
)(struct mmc_host
*host
);
126 int (*get_cd
)(struct mmc_host
*host
);
128 void (*enable_sdio_irq
)(struct mmc_host
*host
, int enable
);
130 /* optional callback for HC quirks */
131 void (*init_card
)(struct mmc_host
*host
, struct mmc_card
*card
);
133 int (*start_signal_voltage_switch
)(struct mmc_host
*host
, struct mmc_ios
*ios
);
135 /* Check if the card is pulling dat[0:3] low */
136 int (*card_busy
)(struct mmc_host
*host
);
138 /* The tuning command opcode value is different for SD and eMMC cards */
139 int (*execute_tuning
)(struct mmc_host
*host
, u32 opcode
);
140 int (*select_drive_strength
)(unsigned int max_dtr
, int host_drv
, int card_drv
);
141 void (*hw_reset
)(struct mmc_host
*host
);
142 void (*card_event
)(struct mmc_host
*host
);
148 struct mmc_async_req
{
149 /* active mmc request */
150 struct mmc_request
*mrq
;
152 * Check error status of completed mmc request.
153 * Returns 0 if success otherwise non zero.
155 int (*err_check
) (struct mmc_card
*, struct mmc_async_req
*);
159 * struct mmc_slot - MMC slot functions
161 * @cd_irq: MMC/SD-card slot hotplug detection IRQ or -EINVAL
162 * @lock: protect the @handler_priv pointer
163 * @handler_priv: MMC/SD-card slot context
165 * Some MMC/SD host controllers implement slot-functions like card and
166 * write-protect detection natively. However, a large number of controllers
167 * leave these functions to the CPU. This struct provides a hook to attach
168 * such slot-function drivers.
177 * mmc_context_info - synchronization details for mmc context
178 * @is_done_rcv wake up reason was done request
179 * @is_new_req wake up reason was new request
180 * @is_waiting_last_req mmc context waiting for single running request
182 * @lock lock to protect data fields
184 struct mmc_context_info
{
187 bool is_waiting_last_req
;
188 wait_queue_head_t wait
;
195 struct regulator
*vmmc
; /* Card power supply */
196 struct regulator
*vqmmc
; /* Optional Vccq supply */
200 struct device
*parent
;
201 struct device class_dev
;
203 const struct mmc_host_ops
*ops
;
208 u32 ocr_avail_sdio
; /* SDIO-specific OCR */
209 u32 ocr_avail_sd
; /* SD-specific OCR */
210 u32 ocr_avail_mmc
; /* MMC-specific OCR */
211 struct notifier_block pm_notify
;
216 #define MMC_VDD_165_195 0x00000080 /* VDD voltage 1.65 - 1.95 */
217 #define MMC_VDD_20_21 0x00000100 /* VDD voltage 2.0 ~ 2.1 */
218 #define MMC_VDD_21_22 0x00000200 /* VDD voltage 2.1 ~ 2.2 */
219 #define MMC_VDD_22_23 0x00000400 /* VDD voltage 2.2 ~ 2.3 */
220 #define MMC_VDD_23_24 0x00000800 /* VDD voltage 2.3 ~ 2.4 */
221 #define MMC_VDD_24_25 0x00001000 /* VDD voltage 2.4 ~ 2.5 */
222 #define MMC_VDD_25_26 0x00002000 /* VDD voltage 2.5 ~ 2.6 */
223 #define MMC_VDD_26_27 0x00004000 /* VDD voltage 2.6 ~ 2.7 */
224 #define MMC_VDD_27_28 0x00008000 /* VDD voltage 2.7 ~ 2.8 */
225 #define MMC_VDD_28_29 0x00010000 /* VDD voltage 2.8 ~ 2.9 */
226 #define MMC_VDD_29_30 0x00020000 /* VDD voltage 2.9 ~ 3.0 */
227 #define MMC_VDD_30_31 0x00040000 /* VDD voltage 3.0 ~ 3.1 */
228 #define MMC_VDD_31_32 0x00080000 /* VDD voltage 3.1 ~ 3.2 */
229 #define MMC_VDD_32_33 0x00100000 /* VDD voltage 3.2 ~ 3.3 */
230 #define MMC_VDD_33_34 0x00200000 /* VDD voltage 3.3 ~ 3.4 */
231 #define MMC_VDD_34_35 0x00400000 /* VDD voltage 3.4 ~ 3.5 */
232 #define MMC_VDD_35_36 0x00800000 /* VDD voltage 3.5 ~ 3.6 */
234 u32 caps
; /* Host capabilities */
236 #define MMC_CAP_4_BIT_DATA (1 << 0) /* Can the host do 4 bit transfers */
237 #define MMC_CAP_MMC_HIGHSPEED (1 << 1) /* Can do MMC high-speed timing */
238 #define MMC_CAP_SD_HIGHSPEED (1 << 2) /* Can do SD high-speed timing */
239 #define MMC_CAP_SDIO_IRQ (1 << 3) /* Can signal pending SDIO IRQs */
240 #define MMC_CAP_SPI (1 << 4) /* Talks only SPI protocols */
241 #define MMC_CAP_NEEDS_POLL (1 << 5) /* Needs polling for card-detection */
242 #define MMC_CAP_8_BIT_DATA (1 << 6) /* Can the host do 8 bit transfers */
243 #define MMC_CAP_AGGRESSIVE_PM (1 << 7) /* Suspend (e)MMC/SD at idle */
244 #define MMC_CAP_NONREMOVABLE (1 << 8) /* Nonremovable e.g. eMMC */
245 #define MMC_CAP_WAIT_WHILE_BUSY (1 << 9) /* Waits while card is busy */
246 #define MMC_CAP_ERASE (1 << 10) /* Allow erase/trim commands */
247 #define MMC_CAP_1_8V_DDR (1 << 11) /* can support */
248 /* DDR mode at 1.8V */
249 #define MMC_CAP_1_2V_DDR (1 << 12) /* can support */
250 /* DDR mode at 1.2V */
251 #define MMC_CAP_POWER_OFF_CARD (1 << 13) /* Can power off after boot */
252 #define MMC_CAP_BUS_WIDTH_TEST (1 << 14) /* CMD14/CMD19 bus width ok */
253 #define MMC_CAP_UHS_SDR12 (1 << 15) /* Host supports UHS SDR12 mode */
254 #define MMC_CAP_UHS_SDR25 (1 << 16) /* Host supports UHS SDR25 mode */
255 #define MMC_CAP_UHS_SDR50 (1 << 17) /* Host supports UHS SDR50 mode */
256 #define MMC_CAP_UHS_SDR104 (1 << 18) /* Host supports UHS SDR104 mode */
257 #define MMC_CAP_UHS_DDR50 (1 << 19) /* Host supports UHS DDR50 mode */
258 #define MMC_CAP_RUNTIME_RESUME (1 << 20) /* Resume at runtime_resume. */
259 #define MMC_CAP_DRIVER_TYPE_A (1 << 23) /* Host supports Driver Type A */
260 #define MMC_CAP_DRIVER_TYPE_C (1 << 24) /* Host supports Driver Type C */
261 #define MMC_CAP_DRIVER_TYPE_D (1 << 25) /* Host supports Driver Type D */
262 #define MMC_CAP_CMD23 (1 << 30) /* CMD23 supported. */
263 #define MMC_CAP_HW_RESET (1 << 31) /* Hardware reset */
265 u32 caps2
; /* More host capabilities */
267 #define MMC_CAP2_BOOTPART_NOACC (1 << 0) /* Boot partition no access */
268 #define MMC_CAP2_FULL_PWR_CYCLE (1 << 2) /* Can do full power cycle */
269 #define MMC_CAP2_NO_MULTI_READ (1 << 3) /* Multiblock reads don't work */
270 #define MMC_CAP2_HS200_1_8V_SDR (1 << 5) /* can support */
271 #define MMC_CAP2_HS200_1_2V_SDR (1 << 6) /* can support */
272 #define MMC_CAP2_HS200 (MMC_CAP2_HS200_1_8V_SDR | \
273 MMC_CAP2_HS200_1_2V_SDR)
274 #define MMC_CAP2_HC_ERASE_SZ (1 << 9) /* High-capacity erase size */
275 #define MMC_CAP2_CD_ACTIVE_HIGH (1 << 10) /* Card-detect signal active high */
276 #define MMC_CAP2_RO_ACTIVE_HIGH (1 << 11) /* Write-protect signal active high */
277 #define MMC_CAP2_PACKED_RD (1 << 12) /* Allow packed read */
278 #define MMC_CAP2_PACKED_WR (1 << 13) /* Allow packed write */
279 #define MMC_CAP2_PACKED_CMD (MMC_CAP2_PACKED_RD | \
281 #define MMC_CAP2_NO_PRESCAN_POWERUP (1 << 14) /* Don't power up before scan */
283 mmc_pm_flag_t pm_caps
; /* supported pm features */
285 #ifdef CONFIG_MMC_CLKGATE
286 int clk_requests
; /* internal reference counter */
287 unsigned int clk_delay
; /* number of MCI clk hold cycles */
288 bool clk_gated
; /* clock gated */
289 struct delayed_work clk_gate_work
; /* delayed clock gate */
290 unsigned int clk_old
; /* old clock value cache */
291 spinlock_t clk_lock
; /* lock for clk fields */
292 struct mutex clk_gate_mutex
; /* mutex for clock gating */
293 struct device_attribute clkgate_delay_attr
;
294 unsigned long clkgate_delay
;
297 /* host specific block data */
298 unsigned int max_seg_size
; /* see blk_queue_max_segment_size */
299 unsigned short max_segs
; /* see blk_queue_max_segments */
300 unsigned short unused
;
301 unsigned int max_req_size
; /* maximum number of bytes in one req */
302 unsigned int max_blk_size
; /* maximum size of one mmc block */
303 unsigned int max_blk_count
; /* maximum number of blocks in one req */
304 unsigned int max_busy_timeout
; /* max busy timeout in ms */
307 spinlock_t lock
; /* lock for claim and bus ops */
309 struct mmc_ios ios
; /* current io bus settings */
311 /* group bitfields together to minimize padding */
312 unsigned int use_spi_crc
:1;
313 unsigned int claimed
:1; /* host exclusively claimed */
314 unsigned int bus_dead
:1; /* bus has been released */
315 #ifdef CONFIG_MMC_DEBUG
316 unsigned int removed
:1; /* host is being removed */
319 int rescan_disable
; /* disable card detection */
320 int rescan_entered
; /* used with nonremovable devices */
322 bool trigger_card_event
; /* card_event necessary */
324 struct mmc_card
*card
; /* device attached to this host */
326 wait_queue_head_t wq
;
327 struct task_struct
*claimer
; /* task that has host claimed */
328 int claim_cnt
; /* "claim" nesting count */
330 struct delayed_work detect
;
331 int detect_change
; /* card detect flag */
332 struct mmc_slot slot
;
334 const struct mmc_bus_ops
*bus_ops
; /* current bus driver */
335 unsigned int bus_refs
; /* reference counter */
337 unsigned int sdio_irqs
;
338 struct task_struct
*sdio_irq_thread
;
339 bool sdio_irq_pending
;
340 atomic_t sdio_irq_thread_abort
;
342 mmc_pm_flag_t pm_flags
; /* requested pm features */
344 struct led_trigger
*led
; /* activity led */
346 #ifdef CONFIG_REGULATOR
347 bool regulator_enabled
; /* regulator state */
349 struct mmc_supply supply
;
351 struct dentry
*debugfs_root
;
353 struct mmc_async_req
*areq
; /* active async req */
354 struct mmc_context_info context_info
; /* async synchronization info */
356 #ifdef CONFIG_FAIL_MMC_REQUEST
357 struct fault_attr fail_mmc_request
;
360 unsigned int actual_clock
; /* Actual HC clock rate */
362 unsigned int slotno
; /* used for sdio acpi binding */
364 unsigned long private[0] ____cacheline_aligned
;
367 struct mmc_host
*mmc_alloc_host(int extra
, struct device
*);
368 int mmc_add_host(struct mmc_host
*);
369 void mmc_remove_host(struct mmc_host
*);
370 void mmc_free_host(struct mmc_host
*);
371 int mmc_of_parse(struct mmc_host
*host
);
373 static inline void *mmc_priv(struct mmc_host
*host
)
375 return (void *)host
->private;
378 #define mmc_host_is_spi(host) ((host)->caps & MMC_CAP_SPI)
380 #define mmc_dev(x) ((x)->parent)
381 #define mmc_classdev(x) (&(x)->class_dev)
382 #define mmc_hostname(x) (dev_name(&(x)->class_dev))
384 int mmc_power_save_host(struct mmc_host
*host
);
385 int mmc_power_restore_host(struct mmc_host
*host
);
387 void mmc_detect_change(struct mmc_host
*, unsigned long delay
);
388 void mmc_request_done(struct mmc_host
*, struct mmc_request
*);
390 static inline void mmc_signal_sdio_irq(struct mmc_host
*host
)
392 host
->ops
->enable_sdio_irq(host
, 0);
393 host
->sdio_irq_pending
= true;
394 wake_up_process(host
->sdio_irq_thread
);
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 int mmc_regulator_get_supply(struct mmc_host
*mmc
);
404 static inline int mmc_regulator_get_ocrmask(struct regulator
*supply
)
409 static inline int mmc_regulator_set_ocr(struct mmc_host
*mmc
,
410 struct regulator
*supply
,
411 unsigned short vdd_bit
)
416 static inline int mmc_regulator_get_supply(struct mmc_host
*mmc
)
422 int mmc_pm_notify(struct notifier_block
*notify_block
, unsigned long, void *);
424 static inline int mmc_card_is_removable(struct mmc_host
*host
)
426 return !(host
->caps
& MMC_CAP_NONREMOVABLE
);
429 static inline int mmc_card_keep_power(struct mmc_host
*host
)
431 return host
->pm_flags
& MMC_PM_KEEP_POWER
;
434 static inline int mmc_card_wake_sdio_irq(struct mmc_host
*host
)
436 return host
->pm_flags
& MMC_PM_WAKE_SDIO_IRQ
;
439 static inline int mmc_host_cmd23(struct mmc_host
*host
)
441 return host
->caps
& MMC_CAP_CMD23
;
444 static inline int mmc_boot_partition_access(struct mmc_host
*host
)
446 return !(host
->caps2
& MMC_CAP2_BOOTPART_NOACC
);
449 static inline int mmc_host_uhs(struct mmc_host
*host
)
452 (MMC_CAP_UHS_SDR12
| MMC_CAP_UHS_SDR25
|
453 MMC_CAP_UHS_SDR50
| MMC_CAP_UHS_SDR104
|
457 static inline int mmc_host_packed_wr(struct mmc_host
*host
)
459 return host
->caps2
& MMC_CAP2_PACKED_WR
;
462 #ifdef CONFIG_MMC_CLKGATE
463 void mmc_host_clk_hold(struct mmc_host
*host
);
464 void mmc_host_clk_release(struct mmc_host
*host
);
465 unsigned int mmc_host_clk_rate(struct mmc_host
*host
);
468 static inline void mmc_host_clk_hold(struct mmc_host
*host
)
472 static inline void mmc_host_clk_release(struct mmc_host
*host
)
476 static inline unsigned int mmc_host_clk_rate(struct mmc_host
*host
)
478 return host
->ios
.clock
;
481 #endif /* LINUX_MMC_HOST_H */