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/timer.h>
16 #include <linux/sched.h>
17 #include <linux/device.h>
18 #include <linux/fault-inject.h>
20 #include <linux/mmc/core.h>
21 #include <linux/mmc/card.h>
22 #include <linux/mmc/mmc.h>
23 #include <linux/mmc/pm.h>
26 unsigned int clock
; /* clock rate */
29 /* vdd stores the bit number of the selected voltage range from below. */
31 unsigned char bus_mode
; /* command output mode */
33 #define MMC_BUSMODE_OPENDRAIN 1
34 #define MMC_BUSMODE_PUSHPULL 2
36 unsigned char chip_select
; /* SPI chip select */
38 #define MMC_CS_DONTCARE 0
42 unsigned char power_mode
; /* power supply mode */
44 #define MMC_POWER_OFF 0
45 #define MMC_POWER_UP 1
46 #define MMC_POWER_ON 2
47 #define MMC_POWER_UNDEFINED 3
49 unsigned char bus_width
; /* data bus width */
51 #define MMC_BUS_WIDTH_1 0
52 #define MMC_BUS_WIDTH_4 2
53 #define MMC_BUS_WIDTH_8 3
55 unsigned char timing
; /* timing specification used */
57 #define MMC_TIMING_LEGACY 0
58 #define MMC_TIMING_MMC_HS 1
59 #define MMC_TIMING_SD_HS 2
60 #define MMC_TIMING_UHS_SDR12 3
61 #define MMC_TIMING_UHS_SDR25 4
62 #define MMC_TIMING_UHS_SDR50 5
63 #define MMC_TIMING_UHS_SDR104 6
64 #define MMC_TIMING_UHS_DDR50 7
65 #define MMC_TIMING_MMC_DDR52 8
66 #define MMC_TIMING_MMC_HS200 9
67 #define MMC_TIMING_MMC_HS400 10
69 unsigned char signal_voltage
; /* signalling voltage (1.8V or 3.3V) */
71 #define MMC_SIGNAL_VOLTAGE_330 0
72 #define MMC_SIGNAL_VOLTAGE_180 1
73 #define MMC_SIGNAL_VOLTAGE_120 2
75 unsigned char drv_type
; /* driver type (A, B, C, D) */
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
82 bool enhanced_strobe
; /* hs400es selection */
87 * It is optional for the host to implement pre_req and post_req in
88 * order to support double buffering of requests (prepare one
89 * request while another request is active).
90 * pre_req() must always be followed by a post_req().
91 * To undo a call made to pre_req(), call post_req() with
92 * a nonzero err condition.
94 void (*post_req
)(struct mmc_host
*host
, struct mmc_request
*req
,
96 void (*pre_req
)(struct mmc_host
*host
, struct mmc_request
*req
);
97 void (*request
)(struct mmc_host
*host
, struct mmc_request
*req
);
100 * Avoid calling the next three functions too often or in a "fast
101 * path", since underlaying controller might implement them in an
102 * expensive and/or slow way. Also note that these functions might
103 * sleep, so don't call them in the atomic contexts!
107 * Notes to the set_ios callback:
108 * ios->clock might be 0. For some controllers, setting 0Hz
109 * as any other frequency works. However, some controllers
110 * explicitly need to disable the clock. Otherwise e.g. voltage
111 * switching might fail because the SDCLK is not really quiet.
113 void (*set_ios
)(struct mmc_host
*host
, struct mmc_ios
*ios
);
116 * Return values for the get_ro callback should be:
117 * 0 for a read/write card
118 * 1 for a read-only card
119 * -ENOSYS when not supported (equal to NULL callback)
120 * or a negative errno value when something bad happened
122 int (*get_ro
)(struct mmc_host
*host
);
125 * Return values for the get_cd callback should be:
126 * 0 for a absent card
127 * 1 for a present card
128 * -ENOSYS when not supported (equal to NULL callback)
129 * or a negative errno value when something bad happened
131 int (*get_cd
)(struct mmc_host
*host
);
133 void (*enable_sdio_irq
)(struct mmc_host
*host
, int enable
);
135 /* optional callback for HC quirks */
136 void (*init_card
)(struct mmc_host
*host
, struct mmc_card
*card
);
138 int (*start_signal_voltage_switch
)(struct mmc_host
*host
, struct mmc_ios
*ios
);
140 /* Check if the card is pulling dat[0:3] low */
141 int (*card_busy
)(struct mmc_host
*host
);
143 /* The tuning command opcode value is different for SD and eMMC cards */
144 int (*execute_tuning
)(struct mmc_host
*host
, u32 opcode
);
146 /* Prepare HS400 target operating frequency depending host driver */
147 int (*prepare_hs400_tuning
)(struct mmc_host
*host
, struct mmc_ios
*ios
);
148 /* Prepare enhanced strobe depending host driver */
149 void (*hs400_enhanced_strobe
)(struct mmc_host
*host
,
150 struct mmc_ios
*ios
);
151 int (*select_drive_strength
)(struct mmc_card
*card
,
152 unsigned int max_dtr
, int host_drv
,
153 int card_drv
, int *drv_type
);
154 void (*hw_reset
)(struct mmc_host
*host
);
155 void (*card_event
)(struct mmc_host
*host
);
158 * Optional callback to support controllers with HW issues for multiple
159 * I/O. Returns the number of supported blocks for the request.
161 int (*multi_io_quirk
)(struct mmc_card
*card
,
162 unsigned int direction
, int blk_size
);
168 struct mmc_async_req
{
169 /* active mmc request */
170 struct mmc_request
*mrq
;
172 * Check error status of completed mmc request.
173 * Returns 0 if success otherwise non zero.
175 enum mmc_blk_status (*err_check
)(struct mmc_card
*, struct mmc_async_req
*);
179 * struct mmc_slot - MMC slot functions
181 * @cd_irq: MMC/SD-card slot hotplug detection IRQ or -EINVAL
182 * @handler_priv: MMC/SD-card slot context
184 * Some MMC/SD host controllers implement slot-functions like card and
185 * write-protect detection natively. However, a large number of controllers
186 * leave these functions to the CPU. This struct provides a hook to attach
187 * such slot-function drivers.
195 * mmc_context_info - synchronization details for mmc context
196 * @is_done_rcv wake up reason was done request
197 * @is_new_req wake up reason was new request
198 * @is_waiting_last_req mmc context waiting for single running request
201 struct mmc_context_info
{
204 bool is_waiting_last_req
;
205 wait_queue_head_t wait
;
212 struct regulator
*vmmc
; /* Card power supply */
213 struct regulator
*vqmmc
; /* Optional Vccq supply */
217 struct device
*parent
;
218 struct device class_dev
;
220 const struct mmc_host_ops
*ops
;
221 struct mmc_pwrseq
*pwrseq
;
226 u32 ocr_avail_sdio
; /* SDIO-specific OCR */
227 u32 ocr_avail_sd
; /* SD-specific OCR */
228 u32 ocr_avail_mmc
; /* MMC-specific OCR */
229 #ifdef CONFIG_PM_SLEEP
230 struct notifier_block pm_notify
;
236 #define MMC_VDD_165_195 0x00000080 /* VDD voltage 1.65 - 1.95 */
237 #define MMC_VDD_20_21 0x00000100 /* VDD voltage 2.0 ~ 2.1 */
238 #define MMC_VDD_21_22 0x00000200 /* VDD voltage 2.1 ~ 2.2 */
239 #define MMC_VDD_22_23 0x00000400 /* VDD voltage 2.2 ~ 2.3 */
240 #define MMC_VDD_23_24 0x00000800 /* VDD voltage 2.3 ~ 2.4 */
241 #define MMC_VDD_24_25 0x00001000 /* VDD voltage 2.4 ~ 2.5 */
242 #define MMC_VDD_25_26 0x00002000 /* VDD voltage 2.5 ~ 2.6 */
243 #define MMC_VDD_26_27 0x00004000 /* VDD voltage 2.6 ~ 2.7 */
244 #define MMC_VDD_27_28 0x00008000 /* VDD voltage 2.7 ~ 2.8 */
245 #define MMC_VDD_28_29 0x00010000 /* VDD voltage 2.8 ~ 2.9 */
246 #define MMC_VDD_29_30 0x00020000 /* VDD voltage 2.9 ~ 3.0 */
247 #define MMC_VDD_30_31 0x00040000 /* VDD voltage 3.0 ~ 3.1 */
248 #define MMC_VDD_31_32 0x00080000 /* VDD voltage 3.1 ~ 3.2 */
249 #define MMC_VDD_32_33 0x00100000 /* VDD voltage 3.2 ~ 3.3 */
250 #define MMC_VDD_33_34 0x00200000 /* VDD voltage 3.3 ~ 3.4 */
251 #define MMC_VDD_34_35 0x00400000 /* VDD voltage 3.4 ~ 3.5 */
252 #define MMC_VDD_35_36 0x00800000 /* VDD voltage 3.5 ~ 3.6 */
254 u32 caps
; /* Host capabilities */
256 #define MMC_CAP_4_BIT_DATA (1 << 0) /* Can the host do 4 bit transfers */
257 #define MMC_CAP_MMC_HIGHSPEED (1 << 1) /* Can do MMC high-speed timing */
258 #define MMC_CAP_SD_HIGHSPEED (1 << 2) /* Can do SD high-speed timing */
259 #define MMC_CAP_SDIO_IRQ (1 << 3) /* Can signal pending SDIO IRQs */
260 #define MMC_CAP_SPI (1 << 4) /* Talks only SPI protocols */
261 #define MMC_CAP_NEEDS_POLL (1 << 5) /* Needs polling for card-detection */
262 #define MMC_CAP_8_BIT_DATA (1 << 6) /* Can the host do 8 bit transfers */
263 #define MMC_CAP_AGGRESSIVE_PM (1 << 7) /* Suspend (e)MMC/SD at idle */
264 #define MMC_CAP_NONREMOVABLE (1 << 8) /* Nonremovable e.g. eMMC */
265 #define MMC_CAP_WAIT_WHILE_BUSY (1 << 9) /* Waits while card is busy */
266 #define MMC_CAP_ERASE (1 << 10) /* Allow erase/trim commands */
267 #define MMC_CAP_1_8V_DDR (1 << 11) /* can support */
268 /* DDR mode at 1.8V */
269 #define MMC_CAP_1_2V_DDR (1 << 12) /* can support */
270 /* DDR mode at 1.2V */
271 #define MMC_CAP_POWER_OFF_CARD (1 << 13) /* Can power off after boot */
272 #define MMC_CAP_BUS_WIDTH_TEST (1 << 14) /* CMD14/CMD19 bus width ok */
273 #define MMC_CAP_UHS_SDR12 (1 << 15) /* Host supports UHS SDR12 mode */
274 #define MMC_CAP_UHS_SDR25 (1 << 16) /* Host supports UHS SDR25 mode */
275 #define MMC_CAP_UHS_SDR50 (1 << 17) /* Host supports UHS SDR50 mode */
276 #define MMC_CAP_UHS_SDR104 (1 << 18) /* Host supports UHS SDR104 mode */
277 #define MMC_CAP_UHS_DDR50 (1 << 19) /* Host supports UHS DDR50 mode */
278 #define MMC_CAP_DRIVER_TYPE_A (1 << 23) /* Host supports Driver Type A */
279 #define MMC_CAP_DRIVER_TYPE_C (1 << 24) /* Host supports Driver Type C */
280 #define MMC_CAP_DRIVER_TYPE_D (1 << 25) /* Host supports Driver Type D */
281 #define MMC_CAP_CMD_DURING_TFR (1 << 29) /* Commands during data transfer */
282 #define MMC_CAP_CMD23 (1 << 30) /* CMD23 supported. */
283 #define MMC_CAP_HW_RESET (1 << 31) /* Hardware reset */
285 u32 caps2
; /* More host capabilities */
287 #define MMC_CAP2_BOOTPART_NOACC (1 << 0) /* Boot partition no access */
288 #define MMC_CAP2_FULL_PWR_CYCLE (1 << 2) /* Can do full power cycle */
289 #define MMC_CAP2_HS200_1_8V_SDR (1 << 5) /* can support */
290 #define MMC_CAP2_HS200_1_2V_SDR (1 << 6) /* can support */
291 #define MMC_CAP2_HS200 (MMC_CAP2_HS200_1_8V_SDR | \
292 MMC_CAP2_HS200_1_2V_SDR)
293 #define MMC_CAP2_HC_ERASE_SZ (1 << 9) /* High-capacity erase size */
294 #define MMC_CAP2_CD_ACTIVE_HIGH (1 << 10) /* Card-detect signal active high */
295 #define MMC_CAP2_RO_ACTIVE_HIGH (1 << 11) /* Write-protect signal active high */
296 #define MMC_CAP2_PACKED_RD (1 << 12) /* Allow packed read */
297 #define MMC_CAP2_PACKED_WR (1 << 13) /* Allow packed write */
298 #define MMC_CAP2_PACKED_CMD (MMC_CAP2_PACKED_RD | \
300 #define MMC_CAP2_NO_PRESCAN_POWERUP (1 << 14) /* Don't power up before scan */
301 #define MMC_CAP2_HS400_1_8V (1 << 15) /* Can support HS400 1.8V */
302 #define MMC_CAP2_HS400_1_2V (1 << 16) /* Can support HS400 1.2V */
303 #define MMC_CAP2_HS400 (MMC_CAP2_HS400_1_8V | \
305 #define MMC_CAP2_HSX00_1_2V (MMC_CAP2_HS200_1_2V_SDR | MMC_CAP2_HS400_1_2V)
306 #define MMC_CAP2_SDIO_IRQ_NOTHREAD (1 << 17)
307 #define MMC_CAP2_NO_WRITE_PROTECT (1 << 18) /* No physical write protect pin, assume that card is always read-write */
308 #define MMC_CAP2_NO_SDIO (1 << 19) /* Do not send SDIO commands during initialization */
309 #define MMC_CAP2_HS400_ES (1 << 20) /* Host supports enhanced strobe */
310 #define MMC_CAP2_NO_SD (1 << 21) /* Do not send SD commands during initialization */
311 #define MMC_CAP2_NO_MMC (1 << 22) /* Do not send (e)MMC commands during initialization */
313 mmc_pm_flag_t pm_caps
; /* supported pm features */
315 /* host specific block data */
316 unsigned int max_seg_size
; /* see blk_queue_max_segment_size */
317 unsigned short max_segs
; /* see blk_queue_max_segments */
318 unsigned short unused
;
319 unsigned int max_req_size
; /* maximum number of bytes in one req */
320 unsigned int max_blk_size
; /* maximum size of one mmc block */
321 unsigned int max_blk_count
; /* maximum number of blocks in one req */
322 unsigned int max_busy_timeout
; /* max busy timeout in ms */
325 spinlock_t lock
; /* lock for claim and bus ops */
327 struct mmc_ios ios
; /* current io bus settings */
329 /* group bitfields together to minimize padding */
330 unsigned int use_spi_crc
:1;
331 unsigned int claimed
:1; /* host exclusively claimed */
332 unsigned int bus_dead
:1; /* bus has been released */
333 #ifdef CONFIG_MMC_DEBUG
334 unsigned int removed
:1; /* host is being removed */
336 unsigned int can_retune
:1; /* re-tuning can be used */
337 unsigned int doing_retune
:1; /* re-tuning in progress */
338 unsigned int retune_now
:1; /* do re-tuning at next req */
339 unsigned int retune_paused
:1; /* re-tuning is temporarily disabled */
341 int rescan_disable
; /* disable card detection */
342 int rescan_entered
; /* used with nonremovable devices */
344 int need_retune
; /* re-tuning is needed */
345 int hold_retune
; /* hold off re-tuning */
346 unsigned int retune_period
; /* re-tuning period in secs */
347 struct timer_list retune_timer
; /* for periodic re-tuning */
349 bool trigger_card_event
; /* card_event necessary */
351 struct mmc_card
*card
; /* device attached to this host */
353 wait_queue_head_t wq
;
354 struct task_struct
*claimer
; /* task that has host claimed */
355 int claim_cnt
; /* "claim" nesting count */
357 struct delayed_work detect
;
358 int detect_change
; /* card detect flag */
359 struct mmc_slot slot
;
361 const struct mmc_bus_ops
*bus_ops
; /* current bus driver */
362 unsigned int bus_refs
; /* reference counter */
364 unsigned int sdio_irqs
;
365 struct task_struct
*sdio_irq_thread
;
366 bool sdio_irq_pending
;
367 atomic_t sdio_irq_thread_abort
;
369 mmc_pm_flag_t pm_flags
; /* requested pm features */
371 struct led_trigger
*led
; /* activity led */
373 #ifdef CONFIG_REGULATOR
374 bool regulator_enabled
; /* regulator state */
376 struct mmc_supply supply
;
378 struct dentry
*debugfs_root
;
380 struct mmc_async_req
*areq
; /* active async req */
381 struct mmc_context_info context_info
; /* async synchronization info */
383 /* Ongoing data transfer that allows commands during transfer */
384 struct mmc_request
*ongoing_mrq
;
386 #ifdef CONFIG_FAIL_MMC_REQUEST
387 struct fault_attr fail_mmc_request
;
390 unsigned int actual_clock
; /* Actual HC clock rate */
392 unsigned int slotno
; /* used for sdio acpi binding */
394 int dsr_req
; /* DSR value is valid */
395 u32 dsr
; /* optional driver stage (DSR) value */
397 unsigned long private[0] ____cacheline_aligned
;
400 struct mmc_host
*mmc_alloc_host(int extra
, struct device
*);
401 int mmc_add_host(struct mmc_host
*);
402 void mmc_remove_host(struct mmc_host
*);
403 void mmc_free_host(struct mmc_host
*);
404 int mmc_of_parse(struct mmc_host
*host
);
406 static inline void *mmc_priv(struct mmc_host
*host
)
408 return (void *)host
->private;
411 #define mmc_host_is_spi(host) ((host)->caps & MMC_CAP_SPI)
413 #define mmc_dev(x) ((x)->parent)
414 #define mmc_classdev(x) (&(x)->class_dev)
415 #define mmc_hostname(x) (dev_name(&(x)->class_dev))
417 int mmc_power_save_host(struct mmc_host
*host
);
418 int mmc_power_restore_host(struct mmc_host
*host
);
420 void mmc_detect_change(struct mmc_host
*, unsigned long delay
);
421 void mmc_request_done(struct mmc_host
*, struct mmc_request
*);
422 void mmc_command_done(struct mmc_host
*host
, struct mmc_request
*mrq
);
424 static inline void mmc_signal_sdio_irq(struct mmc_host
*host
)
426 host
->ops
->enable_sdio_irq(host
, 0);
427 host
->sdio_irq_pending
= true;
428 if (host
->sdio_irq_thread
)
429 wake_up_process(host
->sdio_irq_thread
);
432 void sdio_run_irqs(struct mmc_host
*host
);
434 #ifdef CONFIG_REGULATOR
435 int mmc_regulator_get_ocrmask(struct regulator
*supply
);
436 int mmc_regulator_set_ocr(struct mmc_host
*mmc
,
437 struct regulator
*supply
,
438 unsigned short vdd_bit
);
439 int mmc_regulator_set_vqmmc(struct mmc_host
*mmc
, struct mmc_ios
*ios
);
441 static inline int mmc_regulator_get_ocrmask(struct regulator
*supply
)
446 static inline int mmc_regulator_set_ocr(struct mmc_host
*mmc
,
447 struct regulator
*supply
,
448 unsigned short vdd_bit
)
453 static inline int mmc_regulator_set_vqmmc(struct mmc_host
*mmc
,
460 int mmc_regulator_get_supply(struct mmc_host
*mmc
);
462 static inline int mmc_card_is_removable(struct mmc_host
*host
)
464 return !(host
->caps
& MMC_CAP_NONREMOVABLE
);
467 static inline int mmc_card_keep_power(struct mmc_host
*host
)
469 return host
->pm_flags
& MMC_PM_KEEP_POWER
;
472 static inline int mmc_card_wake_sdio_irq(struct mmc_host
*host
)
474 return host
->pm_flags
& MMC_PM_WAKE_SDIO_IRQ
;
477 static inline int mmc_host_cmd23(struct mmc_host
*host
)
479 return host
->caps
& MMC_CAP_CMD23
;
482 static inline int mmc_boot_partition_access(struct mmc_host
*host
)
484 return !(host
->caps2
& MMC_CAP2_BOOTPART_NOACC
);
487 static inline int mmc_host_uhs(struct mmc_host
*host
)
490 (MMC_CAP_UHS_SDR12
| MMC_CAP_UHS_SDR25
|
491 MMC_CAP_UHS_SDR50
| MMC_CAP_UHS_SDR104
|
495 static inline int mmc_card_hs(struct mmc_card
*card
)
497 return card
->host
->ios
.timing
== MMC_TIMING_SD_HS
||
498 card
->host
->ios
.timing
== MMC_TIMING_MMC_HS
;
501 static inline int mmc_card_uhs(struct mmc_card
*card
)
503 return card
->host
->ios
.timing
>= MMC_TIMING_UHS_SDR12
&&
504 card
->host
->ios
.timing
<= MMC_TIMING_UHS_DDR50
;
507 static inline bool mmc_card_hs200(struct mmc_card
*card
)
509 return card
->host
->ios
.timing
== MMC_TIMING_MMC_HS200
;
512 static inline bool mmc_card_ddr52(struct mmc_card
*card
)
514 return card
->host
->ios
.timing
== MMC_TIMING_MMC_DDR52
;
517 static inline bool mmc_card_hs400(struct mmc_card
*card
)
519 return card
->host
->ios
.timing
== MMC_TIMING_MMC_HS400
;
522 static inline bool mmc_card_hs400es(struct mmc_card
*card
)
524 return card
->host
->ios
.enhanced_strobe
;
527 void mmc_retune_timer_stop(struct mmc_host
*host
);
529 static inline void mmc_retune_needed(struct mmc_host
*host
)
531 if (host
->can_retune
)
532 host
->need_retune
= 1;
535 static inline void mmc_retune_recheck(struct mmc_host
*host
)
537 if (host
->hold_retune
<= 1)
538 host
->retune_now
= 1;
541 static inline bool mmc_can_retune(struct mmc_host
*host
)
543 return host
->can_retune
== 1;
546 void mmc_retune_pause(struct mmc_host
*host
);
547 void mmc_retune_unpause(struct mmc_host
*host
);
549 #endif /* LINUX_MMC_HOST_H */