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/sched.h>
14 #include <linux/device.h>
15 #include <linux/fault-inject.h>
17 #include <linux/mmc/core.h>
18 #include <linux/mmc/card.h>
19 #include <linux/mmc/pm.h>
20 #include <linux/dma-direction.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
44 #define MMC_POWER_UNDEFINED 3
46 unsigned char bus_width
; /* data bus width */
48 #define MMC_BUS_WIDTH_1 0
49 #define MMC_BUS_WIDTH_4 2
50 #define MMC_BUS_WIDTH_8 3
52 unsigned char timing
; /* timing specification used */
54 #define MMC_TIMING_LEGACY 0
55 #define MMC_TIMING_MMC_HS 1
56 #define MMC_TIMING_SD_HS 2
57 #define MMC_TIMING_UHS_SDR12 3
58 #define MMC_TIMING_UHS_SDR25 4
59 #define MMC_TIMING_UHS_SDR50 5
60 #define MMC_TIMING_UHS_SDR104 6
61 #define MMC_TIMING_UHS_DDR50 7
62 #define MMC_TIMING_MMC_DDR52 8
63 #define MMC_TIMING_MMC_HS200 9
64 #define MMC_TIMING_MMC_HS400 10
66 unsigned char signal_voltage
; /* signalling voltage (1.8V or 3.3V) */
68 #define MMC_SIGNAL_VOLTAGE_330 0
69 #define MMC_SIGNAL_VOLTAGE_180 1
70 #define MMC_SIGNAL_VOLTAGE_120 2
72 unsigned char drv_type
; /* driver type (A, B, C, D) */
74 #define MMC_SET_DRIVER_TYPE_B 0
75 #define MMC_SET_DRIVER_TYPE_A 1
76 #define MMC_SET_DRIVER_TYPE_C 2
77 #define MMC_SET_DRIVER_TYPE_D 3
79 bool enhanced_strobe
; /* hs400es selection */
86 * It is optional for the host to implement pre_req and post_req in
87 * order to support double buffering of requests (prepare one
88 * request while another request is active).
89 * pre_req() must always be followed by a post_req().
90 * To undo a call made to pre_req(), call post_req() with
91 * a nonzero err condition.
93 void (*post_req
)(struct mmc_host
*host
, struct mmc_request
*req
,
95 void (*pre_req
)(struct mmc_host
*host
, struct mmc_request
*req
);
96 void (*request
)(struct mmc_host
*host
, struct mmc_request
*req
);
99 * Avoid calling the next three functions too often or in a "fast
100 * path", since underlaying controller might implement them in an
101 * expensive and/or slow way. Also note that these functions might
102 * sleep, so don't call them in the atomic contexts!
106 * Notes to the set_ios callback:
107 * ios->clock might be 0. For some controllers, setting 0Hz
108 * as any other frequency works. However, some controllers
109 * explicitly need to disable the clock. Otherwise e.g. voltage
110 * switching might fail because the SDCLK is not really quiet.
112 void (*set_ios
)(struct mmc_host
*host
, struct mmc_ios
*ios
);
115 * Return values for the get_ro callback should be:
116 * 0 for a read/write card
117 * 1 for a read-only card
118 * -ENOSYS when not supported (equal to NULL callback)
119 * or a negative errno value when something bad happened
121 int (*get_ro
)(struct mmc_host
*host
);
124 * Return values for the get_cd callback should be:
125 * 0 for a absent card
126 * 1 for a present card
127 * -ENOSYS when not supported (equal to NULL callback)
128 * or a negative errno value when something bad happened
130 int (*get_cd
)(struct mmc_host
*host
);
132 void (*enable_sdio_irq
)(struct mmc_host
*host
, int enable
);
133 void (*ack_sdio_irq
)(struct mmc_host
*host
);
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
);
166 /* Allocate resources, and make the CQE operational */
167 int (*cqe_enable
)(struct mmc_host
*host
, struct mmc_card
*card
);
168 /* Free resources, and make the CQE non-operational */
169 void (*cqe_disable
)(struct mmc_host
*host
);
171 * Issue a read, write or DCMD request to the CQE. Also deal with the
172 * effect of ->cqe_off().
174 int (*cqe_request
)(struct mmc_host
*host
, struct mmc_request
*mrq
);
175 /* Free resources (e.g. DMA mapping) associated with the request */
176 void (*cqe_post_req
)(struct mmc_host
*host
, struct mmc_request
*mrq
);
178 * Prepare the CQE and host controller to accept non-CQ commands. There
179 * is no corresponding ->cqe_on(), instead ->cqe_request() is required
182 void (*cqe_off
)(struct mmc_host
*host
);
184 * Wait for all CQE tasks to complete. Return an error if recovery
187 int (*cqe_wait_for_idle
)(struct mmc_host
*host
);
189 * Notify CQE that a request has timed out. Return false if the request
190 * completed or true if a timeout happened in which case indicate if
191 * recovery is needed.
193 bool (*cqe_timeout
)(struct mmc_host
*host
, struct mmc_request
*mrq
,
194 bool *recovery_needed
);
196 * Stop all CQE activity and prepare the CQE and host controller to
197 * accept recovery commands.
199 void (*cqe_recovery_start
)(struct mmc_host
*host
);
201 * Clear the queue and call mmc_cqe_request_done() on all requests.
202 * Requests that errored will have the error set on the mmc_request
203 * (data->error or cmd->error for DCMD). Requests that did not error
204 * will have zero data bytes transferred.
206 void (*cqe_recovery_finish
)(struct mmc_host
*host
);
209 struct mmc_async_req
{
210 /* active mmc request */
211 struct mmc_request
*mrq
;
213 * Check error status of completed mmc request.
214 * Returns 0 if success otherwise non zero.
216 enum mmc_blk_status (*err_check
)(struct mmc_card
*, struct mmc_async_req
*);
220 * struct mmc_slot - MMC slot functions
222 * @cd_irq: MMC/SD-card slot hotplug detection IRQ or -EINVAL
223 * @handler_priv: MMC/SD-card slot context
225 * Some MMC/SD host controllers implement slot-functions like card and
226 * write-protect detection natively. However, a large number of controllers
227 * leave these functions to the CPU. This struct provides a hook to attach
228 * such slot-function drivers.
232 bool cd_wake_enabled
;
237 * mmc_context_info - synchronization details for mmc context
238 * @is_done_rcv wake up reason was done request
239 * @is_new_req wake up reason was new request
240 * @is_waiting_last_req mmc context waiting for single running request
243 struct mmc_context_info
{
246 bool is_waiting_last_req
;
247 wait_queue_head_t wait
;
254 struct regulator
*vmmc
; /* Card power supply */
255 struct regulator
*vqmmc
; /* Optional Vccq supply */
259 struct task_struct
*task
;
263 struct device
*parent
;
264 struct device class_dev
;
266 const struct mmc_host_ops
*ops
;
267 struct mmc_pwrseq
*pwrseq
;
272 u32 ocr_avail_sdio
; /* SDIO-specific OCR */
273 u32 ocr_avail_sd
; /* SD-specific OCR */
274 u32 ocr_avail_mmc
; /* MMC-specific OCR */
275 #ifdef CONFIG_PM_SLEEP
276 struct notifier_block pm_notify
;
282 #define MMC_VDD_165_195 0x00000080 /* VDD voltage 1.65 - 1.95 */
283 #define MMC_VDD_20_21 0x00000100 /* VDD voltage 2.0 ~ 2.1 */
284 #define MMC_VDD_21_22 0x00000200 /* VDD voltage 2.1 ~ 2.2 */
285 #define MMC_VDD_22_23 0x00000400 /* VDD voltage 2.2 ~ 2.3 */
286 #define MMC_VDD_23_24 0x00000800 /* VDD voltage 2.3 ~ 2.4 */
287 #define MMC_VDD_24_25 0x00001000 /* VDD voltage 2.4 ~ 2.5 */
288 #define MMC_VDD_25_26 0x00002000 /* VDD voltage 2.5 ~ 2.6 */
289 #define MMC_VDD_26_27 0x00004000 /* VDD voltage 2.6 ~ 2.7 */
290 #define MMC_VDD_27_28 0x00008000 /* VDD voltage 2.7 ~ 2.8 */
291 #define MMC_VDD_28_29 0x00010000 /* VDD voltage 2.8 ~ 2.9 */
292 #define MMC_VDD_29_30 0x00020000 /* VDD voltage 2.9 ~ 3.0 */
293 #define MMC_VDD_30_31 0x00040000 /* VDD voltage 3.0 ~ 3.1 */
294 #define MMC_VDD_31_32 0x00080000 /* VDD voltage 3.1 ~ 3.2 */
295 #define MMC_VDD_32_33 0x00100000 /* VDD voltage 3.2 ~ 3.3 */
296 #define MMC_VDD_33_34 0x00200000 /* VDD voltage 3.3 ~ 3.4 */
297 #define MMC_VDD_34_35 0x00400000 /* VDD voltage 3.4 ~ 3.5 */
298 #define MMC_VDD_35_36 0x00800000 /* VDD voltage 3.5 ~ 3.6 */
300 u32 caps
; /* Host capabilities */
302 #define MMC_CAP_4_BIT_DATA (1 << 0) /* Can the host do 4 bit transfers */
303 #define MMC_CAP_MMC_HIGHSPEED (1 << 1) /* Can do MMC high-speed timing */
304 #define MMC_CAP_SD_HIGHSPEED (1 << 2) /* Can do SD high-speed timing */
305 #define MMC_CAP_SDIO_IRQ (1 << 3) /* Can signal pending SDIO IRQs */
306 #define MMC_CAP_SPI (1 << 4) /* Talks only SPI protocols */
307 #define MMC_CAP_NEEDS_POLL (1 << 5) /* Needs polling for card-detection */
308 #define MMC_CAP_8_BIT_DATA (1 << 6) /* Can the host do 8 bit transfers */
309 #define MMC_CAP_AGGRESSIVE_PM (1 << 7) /* Suspend (e)MMC/SD at idle */
310 #define MMC_CAP_NONREMOVABLE (1 << 8) /* Nonremovable e.g. eMMC */
311 #define MMC_CAP_WAIT_WHILE_BUSY (1 << 9) /* Waits while card is busy */
312 #define MMC_CAP_ERASE (1 << 10) /* Allow erase/trim commands */
313 #define MMC_CAP_3_3V_DDR (1 << 11) /* Host supports eMMC DDR 3.3V */
314 #define MMC_CAP_1_8V_DDR (1 << 12) /* Host supports eMMC DDR 1.8V */
315 #define MMC_CAP_1_2V_DDR (1 << 13) /* Host supports eMMC DDR 1.2V */
316 #define MMC_CAP_POWER_OFF_CARD (1 << 14) /* Can power off after boot */
317 #define MMC_CAP_BUS_WIDTH_TEST (1 << 15) /* CMD14/CMD19 bus width ok */
318 #define MMC_CAP_UHS_SDR12 (1 << 16) /* Host supports UHS SDR12 mode */
319 #define MMC_CAP_UHS_SDR25 (1 << 17) /* Host supports UHS SDR25 mode */
320 #define MMC_CAP_UHS_SDR50 (1 << 18) /* Host supports UHS SDR50 mode */
321 #define MMC_CAP_UHS_SDR104 (1 << 19) /* Host supports UHS SDR104 mode */
322 #define MMC_CAP_UHS_DDR50 (1 << 20) /* Host supports UHS DDR50 mode */
323 /* (1 << 21) is free for reuse */
324 #define MMC_CAP_DRIVER_TYPE_A (1 << 23) /* Host supports Driver Type A */
325 #define MMC_CAP_DRIVER_TYPE_C (1 << 24) /* Host supports Driver Type C */
326 #define MMC_CAP_DRIVER_TYPE_D (1 << 25) /* Host supports Driver Type D */
327 #define MMC_CAP_DONE_COMPLETE (1 << 27) /* RW reqs can be completed within mmc_request_done() */
328 #define MMC_CAP_CD_WAKE (1 << 28) /* Enable card detect wake */
329 #define MMC_CAP_CMD_DURING_TFR (1 << 29) /* Commands during data transfer */
330 #define MMC_CAP_CMD23 (1 << 30) /* CMD23 supported. */
331 #define MMC_CAP_HW_RESET (1 << 31) /* Hardware reset */
333 u32 caps2
; /* More host capabilities */
335 #define MMC_CAP2_BOOTPART_NOACC (1 << 0) /* Boot partition no access */
336 #define MMC_CAP2_FULL_PWR_CYCLE (1 << 2) /* Can do full power cycle */
337 #define MMC_CAP2_HS200_1_8V_SDR (1 << 5) /* can support */
338 #define MMC_CAP2_HS200_1_2V_SDR (1 << 6) /* can support */
339 #define MMC_CAP2_HS200 (MMC_CAP2_HS200_1_8V_SDR | \
340 MMC_CAP2_HS200_1_2V_SDR)
341 #define MMC_CAP2_CD_ACTIVE_HIGH (1 << 10) /* Card-detect signal active high */
342 #define MMC_CAP2_RO_ACTIVE_HIGH (1 << 11) /* Write-protect signal active high */
343 #define MMC_CAP2_NO_PRESCAN_POWERUP (1 << 14) /* Don't power up before scan */
344 #define MMC_CAP2_HS400_1_8V (1 << 15) /* Can support HS400 1.8V */
345 #define MMC_CAP2_HS400_1_2V (1 << 16) /* Can support HS400 1.2V */
346 #define MMC_CAP2_HS400 (MMC_CAP2_HS400_1_8V | \
348 #define MMC_CAP2_HSX00_1_2V (MMC_CAP2_HS200_1_2V_SDR | MMC_CAP2_HS400_1_2V)
349 #define MMC_CAP2_SDIO_IRQ_NOTHREAD (1 << 17)
350 #define MMC_CAP2_NO_WRITE_PROTECT (1 << 18) /* No physical write protect pin, assume that card is always read-write */
351 #define MMC_CAP2_NO_SDIO (1 << 19) /* Do not send SDIO commands during initialization */
352 #define MMC_CAP2_HS400_ES (1 << 20) /* Host supports enhanced strobe */
353 #define MMC_CAP2_NO_SD (1 << 21) /* Do not send SD commands during initialization */
354 #define MMC_CAP2_NO_MMC (1 << 22) /* Do not send (e)MMC commands during initialization */
355 #define MMC_CAP2_CQE (1 << 23) /* Has eMMC command queue engine */
356 #define MMC_CAP2_CQE_DCMD (1 << 24) /* CQE can issue a direct command */
358 int fixed_drv_type
; /* fixed driver type for non-removable media */
360 mmc_pm_flag_t pm_caps
; /* supported pm features */
362 /* host specific block data */
363 unsigned int max_seg_size
; /* see blk_queue_max_segment_size */
364 unsigned short max_segs
; /* see blk_queue_max_segments */
365 unsigned short unused
;
366 unsigned int max_req_size
; /* maximum number of bytes in one req */
367 unsigned int max_blk_size
; /* maximum size of one mmc block */
368 unsigned int max_blk_count
; /* maximum number of blocks in one req */
369 unsigned int max_busy_timeout
; /* max busy timeout in ms */
372 spinlock_t lock
; /* lock for claim and bus ops */
374 struct mmc_ios ios
; /* current io bus settings */
376 /* group bitfields together to minimize padding */
377 unsigned int use_spi_crc
:1;
378 unsigned int claimed
:1; /* host exclusively claimed */
379 unsigned int bus_dead
:1; /* bus has been released */
380 unsigned int can_retune
:1; /* re-tuning can be used */
381 unsigned int doing_retune
:1; /* re-tuning in progress */
382 unsigned int retune_now
:1; /* do re-tuning at next req */
383 unsigned int retune_paused
:1; /* re-tuning is temporarily disabled */
384 unsigned int use_blk_mq
:1; /* use blk-mq */
386 int rescan_disable
; /* disable card detection */
387 int rescan_entered
; /* used with nonremovable devices */
389 int need_retune
; /* re-tuning is needed */
390 int hold_retune
; /* hold off re-tuning */
391 unsigned int retune_period
; /* re-tuning period in secs */
392 struct timer_list retune_timer
; /* for periodic re-tuning */
394 bool trigger_card_event
; /* card_event necessary */
396 struct mmc_card
*card
; /* device attached to this host */
398 wait_queue_head_t wq
;
399 struct mmc_ctx
*claimer
; /* context that has host claimed */
400 int claim_cnt
; /* "claim" nesting count */
401 struct mmc_ctx default_ctx
; /* default context */
403 struct delayed_work detect
;
404 int detect_change
; /* card detect flag */
405 struct mmc_slot slot
;
407 const struct mmc_bus_ops
*bus_ops
; /* current bus driver */
408 unsigned int bus_refs
; /* reference counter */
410 unsigned int sdio_irqs
;
411 struct task_struct
*sdio_irq_thread
;
412 struct delayed_work sdio_irq_work
;
413 bool sdio_irq_pending
;
414 atomic_t sdio_irq_thread_abort
;
416 mmc_pm_flag_t pm_flags
; /* requested pm features */
418 struct led_trigger
*led
; /* activity led */
420 #ifdef CONFIG_REGULATOR
421 bool regulator_enabled
; /* regulator state */
423 struct mmc_supply supply
;
425 struct dentry
*debugfs_root
;
427 /* Ongoing data transfer that allows commands during transfer */
428 struct mmc_request
*ongoing_mrq
;
430 #ifdef CONFIG_FAIL_MMC_REQUEST
431 struct fault_attr fail_mmc_request
;
434 unsigned int actual_clock
; /* Actual HC clock rate */
436 unsigned int slotno
; /* used for sdio acpi binding */
438 int dsr_req
; /* DSR value is valid */
439 u32 dsr
; /* optional driver stage (DSR) value */
441 /* Command Queue Engine (CQE) support */
442 const struct mmc_cqe_ops
*cqe_ops
;
448 unsigned long private[0] ____cacheline_aligned
;
453 struct mmc_host
*mmc_alloc_host(int extra
, struct device
*);
454 int mmc_add_host(struct mmc_host
*);
455 void mmc_remove_host(struct mmc_host
*);
456 void mmc_free_host(struct mmc_host
*);
457 int mmc_of_parse(struct mmc_host
*host
);
458 int mmc_of_parse_voltage(struct device_node
*np
, u32
*mask
);
460 static inline void *mmc_priv(struct mmc_host
*host
)
462 return (void *)host
->private;
465 #define mmc_host_is_spi(host) ((host)->caps & MMC_CAP_SPI)
467 #define mmc_dev(x) ((x)->parent)
468 #define mmc_classdev(x) (&(x)->class_dev)
469 #define mmc_hostname(x) (dev_name(&(x)->class_dev))
471 int mmc_power_save_host(struct mmc_host
*host
);
472 int mmc_power_restore_host(struct mmc_host
*host
);
474 void mmc_detect_change(struct mmc_host
*, unsigned long delay
);
475 void mmc_request_done(struct mmc_host
*, struct mmc_request
*);
476 void mmc_command_done(struct mmc_host
*host
, struct mmc_request
*mrq
);
478 void mmc_cqe_request_done(struct mmc_host
*host
, struct mmc_request
*mrq
);
480 static inline void mmc_signal_sdio_irq(struct mmc_host
*host
)
482 host
->ops
->enable_sdio_irq(host
, 0);
483 host
->sdio_irq_pending
= true;
484 if (host
->sdio_irq_thread
)
485 wake_up_process(host
->sdio_irq_thread
);
488 void sdio_run_irqs(struct mmc_host
*host
);
489 void sdio_signal_irq(struct mmc_host
*host
);
491 #ifdef CONFIG_REGULATOR
492 int mmc_regulator_get_ocrmask(struct regulator
*supply
);
493 int mmc_regulator_set_ocr(struct mmc_host
*mmc
,
494 struct regulator
*supply
,
495 unsigned short vdd_bit
);
496 int mmc_regulator_set_vqmmc(struct mmc_host
*mmc
, struct mmc_ios
*ios
);
498 static inline int mmc_regulator_get_ocrmask(struct regulator
*supply
)
503 static inline int mmc_regulator_set_ocr(struct mmc_host
*mmc
,
504 struct regulator
*supply
,
505 unsigned short vdd_bit
)
510 static inline int mmc_regulator_set_vqmmc(struct mmc_host
*mmc
,
517 u32
mmc_vddrange_to_ocrmask(int vdd_min
, int vdd_max
);
518 int mmc_regulator_get_supply(struct mmc_host
*mmc
);
520 static inline int mmc_card_is_removable(struct mmc_host
*host
)
522 return !(host
->caps
& MMC_CAP_NONREMOVABLE
);
525 static inline int mmc_card_keep_power(struct mmc_host
*host
)
527 return host
->pm_flags
& MMC_PM_KEEP_POWER
;
530 static inline int mmc_card_wake_sdio_irq(struct mmc_host
*host
)
532 return host
->pm_flags
& MMC_PM_WAKE_SDIO_IRQ
;
535 /* TODO: Move to private header */
536 static inline int mmc_card_hs(struct mmc_card
*card
)
538 return card
->host
->ios
.timing
== MMC_TIMING_SD_HS
||
539 card
->host
->ios
.timing
== MMC_TIMING_MMC_HS
;
542 /* TODO: Move to private header */
543 static inline int mmc_card_uhs(struct mmc_card
*card
)
545 return card
->host
->ios
.timing
>= MMC_TIMING_UHS_SDR12
&&
546 card
->host
->ios
.timing
<= MMC_TIMING_UHS_DDR50
;
549 void mmc_retune_timer_stop(struct mmc_host
*host
);
551 static inline void mmc_retune_needed(struct mmc_host
*host
)
553 if (host
->can_retune
)
554 host
->need_retune
= 1;
557 static inline bool mmc_can_retune(struct mmc_host
*host
)
559 return host
->can_retune
== 1;
562 static inline enum dma_data_direction
mmc_get_dma_dir(struct mmc_data
*data
)
564 return data
->flags
& MMC_DATA_WRITE
? DMA_TO_DEVICE
: DMA_FROM_DEVICE
;
567 int mmc_send_tuning(struct mmc_host
*host
, u32 opcode
, int *cmd_error
);
568 int mmc_abort_tuning(struct mmc_host
*host
, u32 opcode
);
570 #endif /* LINUX_MMC_HOST_H */