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 */
25 unsigned int power_delay_ms; /* waiting for stable power */
27 /* vdd stores the bit number of the selected voltage range from below. */
29 unsigned char bus_mode; /* command output mode */
31 #define MMC_BUSMODE_OPENDRAIN 1
32 #define MMC_BUSMODE_PUSHPULL 2
34 unsigned char chip_select; /* SPI chip select */
36 #define MMC_CS_DONTCARE 0
40 unsigned char power_mode; /* power supply mode */
42 #define MMC_POWER_OFF 0
43 #define MMC_POWER_UP 1
44 #define MMC_POWER_ON 2
45 #define MMC_POWER_UNDEFINED 3
47 unsigned char bus_width; /* data bus width */
49 #define MMC_BUS_WIDTH_1 0
50 #define MMC_BUS_WIDTH_4 2
51 #define MMC_BUS_WIDTH_8 3
53 unsigned char timing; /* timing specification used */
55 #define MMC_TIMING_LEGACY 0
56 #define MMC_TIMING_MMC_HS 1
57 #define MMC_TIMING_SD_HS 2
58 #define MMC_TIMING_UHS_SDR12 3
59 #define MMC_TIMING_UHS_SDR25 4
60 #define MMC_TIMING_UHS_SDR50 5
61 #define MMC_TIMING_UHS_SDR104 6
62 #define MMC_TIMING_UHS_DDR50 7
63 #define MMC_TIMING_MMC_DDR52 8
64 #define MMC_TIMING_MMC_HS200 9
65 #define MMC_TIMING_MMC_HS400 10
67 unsigned char signal_voltage; /* signalling voltage (1.8V or 3.3V) */
69 #define MMC_SIGNAL_VOLTAGE_330 0
70 #define MMC_SIGNAL_VOLTAGE_180 1
71 #define MMC_SIGNAL_VOLTAGE_120 2
73 unsigned char drv_type; /* driver type (A, B, C, D) */
75 #define MMC_SET_DRIVER_TYPE_B 0
76 #define MMC_SET_DRIVER_TYPE_A 1
77 #define MMC_SET_DRIVER_TYPE_C 2
78 #define MMC_SET_DRIVER_TYPE_D 3
80 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);
134 void (*ack_sdio_irq)(struct mmc_host *host);
136 /* optional callback for HC quirks */
137 void (*init_card)(struct mmc_host *host, struct mmc_card *card);
139 int (*start_signal_voltage_switch)(struct mmc_host *host, struct mmc_ios *ios);
141 /* Check if the card is pulling dat[0:3] low */
142 int (*card_busy)(struct mmc_host *host);
144 /* The tuning command opcode value is different for SD and eMMC cards */
145 int (*execute_tuning)(struct mmc_host *host, u32 opcode);
147 /* Prepare HS400 target operating frequency depending host driver */
148 int (*prepare_hs400_tuning)(struct mmc_host *host, struct mmc_ios *ios);
150 /* Prepare switch to DDR during the HS400 init sequence */
151 int (*hs400_prepare_ddr)(struct mmc_host *host);
153 /* Prepare for switching from HS400 to HS200 */
154 void (*hs400_downgrade)(struct mmc_host *host);
156 /* Complete selection of HS400 */
157 void (*hs400_complete)(struct mmc_host *host);
159 /* Prepare enhanced strobe depending host driver */
160 void (*hs400_enhanced_strobe)(struct mmc_host *host,
161 struct mmc_ios *ios);
162 int (*select_drive_strength)(struct mmc_card *card,
163 unsigned int max_dtr, int host_drv,
164 int card_drv, int *drv_type);
165 void (*hw_reset)(struct mmc_host *host);
166 void (*card_event)(struct mmc_host *host);
169 * Optional callback to support controllers with HW issues for multiple
170 * I/O. Returns the number of supported blocks for the request.
172 int (*multi_io_quirk)(struct mmc_card *card,
173 unsigned int direction, int blk_size);
177 /* Allocate resources, and make the CQE operational */
178 int (*cqe_enable)(struct mmc_host *host, struct mmc_card *card);
179 /* Free resources, and make the CQE non-operational */
180 void (*cqe_disable)(struct mmc_host *host);
182 * Issue a read, write or DCMD request to the CQE. Also deal with the
183 * effect of ->cqe_off().
185 int (*cqe_request)(struct mmc_host *host, struct mmc_request *mrq);
186 /* Free resources (e.g. DMA mapping) associated with the request */
187 void (*cqe_post_req)(struct mmc_host *host, struct mmc_request *mrq);
189 * Prepare the CQE and host controller to accept non-CQ commands. There
190 * is no corresponding ->cqe_on(), instead ->cqe_request() is required
193 void (*cqe_off)(struct mmc_host *host);
195 * Wait for all CQE tasks to complete. Return an error if recovery
198 int (*cqe_wait_for_idle)(struct mmc_host *host);
200 * Notify CQE that a request has timed out. Return false if the request
201 * completed or true if a timeout happened in which case indicate if
202 * recovery is needed.
204 bool (*cqe_timeout)(struct mmc_host *host, struct mmc_request *mrq,
205 bool *recovery_needed);
207 * Stop all CQE activity and prepare the CQE and host controller to
208 * accept recovery commands.
210 void (*cqe_recovery_start)(struct mmc_host *host);
212 * Clear the queue and call mmc_cqe_request_done() on all requests.
213 * Requests that errored will have the error set on the mmc_request
214 * (data->error or cmd->error for DCMD). Requests that did not error
215 * will have zero data bytes transferred.
217 void (*cqe_recovery_finish)(struct mmc_host *host);
220 struct mmc_async_req {
221 /* active mmc request */
222 struct mmc_request *mrq;
224 * Check error status of completed mmc request.
225 * Returns 0 if success otherwise non zero.
227 enum mmc_blk_status (*err_check)(struct mmc_card *, struct mmc_async_req *);
231 * struct mmc_slot - MMC slot functions
233 * @cd_irq: MMC/SD-card slot hotplug detection IRQ or -EINVAL
234 * @handler_priv: MMC/SD-card slot context
236 * Some MMC/SD host controllers implement slot-functions like card and
237 * write-protect detection natively. However, a large number of controllers
238 * leave these functions to the CPU. This struct provides a hook to attach
239 * such slot-function drivers.
243 bool cd_wake_enabled;
248 * mmc_context_info - synchronization details for mmc context
249 * @is_done_rcv wake up reason was done request
250 * @is_new_req wake up reason was new request
251 * @is_waiting_last_req mmc context waiting for single running request
254 struct mmc_context_info {
257 bool is_waiting_last_req;
258 wait_queue_head_t wait;
265 struct regulator *vmmc; /* Card power supply */
266 struct regulator *vqmmc; /* Optional Vccq supply */
270 struct task_struct *task;
274 struct device *parent;
275 struct device class_dev;
277 const struct mmc_host_ops *ops;
278 struct mmc_pwrseq *pwrseq;
283 u32 ocr_avail_sdio; /* SDIO-specific OCR */
284 u32 ocr_avail_sd; /* SD-specific OCR */
285 u32 ocr_avail_mmc; /* MMC-specific OCR */
286 #ifdef CONFIG_PM_SLEEP
287 struct notifier_block pm_notify;
293 #define MMC_VDD_165_195 0x00000080 /* VDD voltage 1.65 - 1.95 */
294 #define MMC_VDD_20_21 0x00000100 /* VDD voltage 2.0 ~ 2.1 */
295 #define MMC_VDD_21_22 0x00000200 /* VDD voltage 2.1 ~ 2.2 */
296 #define MMC_VDD_22_23 0x00000400 /* VDD voltage 2.2 ~ 2.3 */
297 #define MMC_VDD_23_24 0x00000800 /* VDD voltage 2.3 ~ 2.4 */
298 #define MMC_VDD_24_25 0x00001000 /* VDD voltage 2.4 ~ 2.5 */
299 #define MMC_VDD_25_26 0x00002000 /* VDD voltage 2.5 ~ 2.6 */
300 #define MMC_VDD_26_27 0x00004000 /* VDD voltage 2.6 ~ 2.7 */
301 #define MMC_VDD_27_28 0x00008000 /* VDD voltage 2.7 ~ 2.8 */
302 #define MMC_VDD_28_29 0x00010000 /* VDD voltage 2.8 ~ 2.9 */
303 #define MMC_VDD_29_30 0x00020000 /* VDD voltage 2.9 ~ 3.0 */
304 #define MMC_VDD_30_31 0x00040000 /* VDD voltage 3.0 ~ 3.1 */
305 #define MMC_VDD_31_32 0x00080000 /* VDD voltage 3.1 ~ 3.2 */
306 #define MMC_VDD_32_33 0x00100000 /* VDD voltage 3.2 ~ 3.3 */
307 #define MMC_VDD_33_34 0x00200000 /* VDD voltage 3.3 ~ 3.4 */
308 #define MMC_VDD_34_35 0x00400000 /* VDD voltage 3.4 ~ 3.5 */
309 #define MMC_VDD_35_36 0x00800000 /* VDD voltage 3.5 ~ 3.6 */
311 u32 caps; /* Host capabilities */
313 #define MMC_CAP_4_BIT_DATA (1 << 0) /* Can the host do 4 bit transfers */
314 #define MMC_CAP_MMC_HIGHSPEED (1 << 1) /* Can do MMC high-speed timing */
315 #define MMC_CAP_SD_HIGHSPEED (1 << 2) /* Can do SD high-speed timing */
316 #define MMC_CAP_SDIO_IRQ (1 << 3) /* Can signal pending SDIO IRQs */
317 #define MMC_CAP_SPI (1 << 4) /* Talks only SPI protocols */
318 #define MMC_CAP_NEEDS_POLL (1 << 5) /* Needs polling for card-detection */
319 #define MMC_CAP_8_BIT_DATA (1 << 6) /* Can the host do 8 bit transfers */
320 #define MMC_CAP_AGGRESSIVE_PM (1 << 7) /* Suspend (e)MMC/SD at idle */
321 #define MMC_CAP_NONREMOVABLE (1 << 8) /* Nonremovable e.g. eMMC */
322 #define MMC_CAP_WAIT_WHILE_BUSY (1 << 9) /* Waits while card is busy */
323 #define MMC_CAP_ERASE (1 << 10) /* Allow erase/trim commands */
324 #define MMC_CAP_3_3V_DDR (1 << 11) /* Host supports eMMC DDR 3.3V */
325 #define MMC_CAP_1_8V_DDR (1 << 12) /* Host supports eMMC DDR 1.8V */
326 #define MMC_CAP_1_2V_DDR (1 << 13) /* Host supports eMMC DDR 1.2V */
327 #define MMC_CAP_POWER_OFF_CARD (1 << 14) /* Can power off after boot */
328 #define MMC_CAP_BUS_WIDTH_TEST (1 << 15) /* CMD14/CMD19 bus width ok */
329 #define MMC_CAP_UHS_SDR12 (1 << 16) /* Host supports UHS SDR12 mode */
330 #define MMC_CAP_UHS_SDR25 (1 << 17) /* Host supports UHS SDR25 mode */
331 #define MMC_CAP_UHS_SDR50 (1 << 18) /* Host supports UHS SDR50 mode */
332 #define MMC_CAP_UHS_SDR104 (1 << 19) /* Host supports UHS SDR104 mode */
333 #define MMC_CAP_UHS_DDR50 (1 << 20) /* Host supports UHS DDR50 mode */
334 #define MMC_CAP_UHS (MMC_CAP_UHS_SDR12 | MMC_CAP_UHS_SDR25 | \
335 MMC_CAP_UHS_SDR50 | MMC_CAP_UHS_SDR104 | \
337 #define MMC_CAP_SYNC_RUNTIME_PM (1 << 21) /* Synced runtime PM suspends. */
338 #define MMC_CAP_DRIVER_TYPE_A (1 << 23) /* Host supports Driver Type A */
339 #define MMC_CAP_DRIVER_TYPE_C (1 << 24) /* Host supports Driver Type C */
340 #define MMC_CAP_DRIVER_TYPE_D (1 << 25) /* Host supports Driver Type D */
341 #define MMC_CAP_DONE_COMPLETE (1 << 27) /* RW reqs can be completed within mmc_request_done() */
342 #define MMC_CAP_CD_WAKE (1 << 28) /* Enable card detect wake */
343 #define MMC_CAP_CMD_DURING_TFR (1 << 29) /* Commands during data transfer */
344 #define MMC_CAP_CMD23 (1 << 30) /* CMD23 supported. */
345 #define MMC_CAP_HW_RESET (1 << 31) /* Hardware reset */
347 u32 caps2; /* More host capabilities */
349 #define MMC_CAP2_BOOTPART_NOACC (1 << 0) /* Boot partition no access */
350 #define MMC_CAP2_FULL_PWR_CYCLE (1 << 2) /* Can do full power cycle */
351 #define MMC_CAP2_HS200_1_8V_SDR (1 << 5) /* can support */
352 #define MMC_CAP2_HS200_1_2V_SDR (1 << 6) /* can support */
353 #define MMC_CAP2_HS200 (MMC_CAP2_HS200_1_8V_SDR | \
354 MMC_CAP2_HS200_1_2V_SDR)
355 #define MMC_CAP2_CD_ACTIVE_HIGH (1 << 10) /* Card-detect signal active high */
356 #define MMC_CAP2_RO_ACTIVE_HIGH (1 << 11) /* Write-protect signal active high */
357 #define MMC_CAP2_NO_PRESCAN_POWERUP (1 << 14) /* Don't power up before scan */
358 #define MMC_CAP2_HS400_1_8V (1 << 15) /* Can support HS400 1.8V */
359 #define MMC_CAP2_HS400_1_2V (1 << 16) /* Can support HS400 1.2V */
360 #define MMC_CAP2_HS400 (MMC_CAP2_HS400_1_8V | \
362 #define MMC_CAP2_HSX00_1_8V (MMC_CAP2_HS200_1_8V_SDR | MMC_CAP2_HS400_1_8V)
363 #define MMC_CAP2_HSX00_1_2V (MMC_CAP2_HS200_1_2V_SDR | MMC_CAP2_HS400_1_2V)
364 #define MMC_CAP2_SDIO_IRQ_NOTHREAD (1 << 17)
365 #define MMC_CAP2_NO_WRITE_PROTECT (1 << 18) /* No physical write protect pin, assume that card is always read-write */
366 #define MMC_CAP2_NO_SDIO (1 << 19) /* Do not send SDIO commands during initialization */
367 #define MMC_CAP2_HS400_ES (1 << 20) /* Host supports enhanced strobe */
368 #define MMC_CAP2_NO_SD (1 << 21) /* Do not send SD commands during initialization */
369 #define MMC_CAP2_NO_MMC (1 << 22) /* Do not send (e)MMC commands during initialization */
370 #define MMC_CAP2_CQE (1 << 23) /* Has eMMC command queue engine */
371 #define MMC_CAP2_CQE_DCMD (1 << 24) /* CQE can issue a direct command */
372 #define MMC_CAP2_AVOID_3_3V (1 << 25) /* Host must negotiate down from 3.3V */
374 int fixed_drv_type; /* fixed driver type for non-removable media */
376 mmc_pm_flag_t pm_caps; /* supported pm features */
378 /* host specific block data */
379 unsigned int max_seg_size; /* see blk_queue_max_segment_size */
380 unsigned short max_segs; /* see blk_queue_max_segments */
381 unsigned short unused;
382 unsigned int max_req_size; /* maximum number of bytes in one req */
383 unsigned int max_blk_size; /* maximum size of one mmc block */
384 unsigned int max_blk_count; /* maximum number of blocks in one req */
385 unsigned int max_busy_timeout; /* max busy timeout in ms */
388 spinlock_t lock; /* lock for claim and bus ops */
390 struct mmc_ios ios; /* current io bus settings */
392 /* group bitfields together to minimize padding */
393 unsigned int use_spi_crc:1;
394 unsigned int claimed:1; /* host exclusively claimed */
395 unsigned int bus_dead:1; /* bus has been released */
396 unsigned int can_retune:1; /* re-tuning can be used */
397 unsigned int doing_retune:1; /* re-tuning in progress */
398 unsigned int retune_now:1; /* do re-tuning at next req */
399 unsigned int retune_paused:1; /* re-tuning is temporarily disabled */
400 unsigned int use_blk_mq:1; /* use blk-mq */
402 int rescan_disable; /* disable card detection */
403 int rescan_entered; /* used with nonremovable devices */
405 int need_retune; /* re-tuning is needed */
406 int hold_retune; /* hold off re-tuning */
407 unsigned int retune_period; /* re-tuning period in secs */
408 struct timer_list retune_timer; /* for periodic re-tuning */
410 bool trigger_card_event; /* card_event necessary */
412 struct mmc_card *card; /* device attached to this host */
414 wait_queue_head_t wq;
415 struct mmc_ctx *claimer; /* context that has host claimed */
416 int claim_cnt; /* "claim" nesting count */
417 struct mmc_ctx default_ctx; /* default context */
419 struct delayed_work detect;
420 int detect_change; /* card detect flag */
421 struct mmc_slot slot;
423 const struct mmc_bus_ops *bus_ops; /* current bus driver */
424 unsigned int bus_refs; /* reference counter */
426 unsigned int sdio_irqs;
427 struct task_struct *sdio_irq_thread;
428 struct delayed_work sdio_irq_work;
429 bool sdio_irq_pending;
430 atomic_t sdio_irq_thread_abort;
432 mmc_pm_flag_t pm_flags; /* requested pm features */
434 struct led_trigger *led; /* activity led */
436 #ifdef CONFIG_REGULATOR
437 bool regulator_enabled; /* regulator state */
439 struct mmc_supply supply;
441 struct dentry *debugfs_root;
443 /* Ongoing data transfer that allows commands during transfer */
444 struct mmc_request *ongoing_mrq;
446 #ifdef CONFIG_FAIL_MMC_REQUEST
447 struct fault_attr fail_mmc_request;
450 unsigned int actual_clock; /* Actual HC clock rate */
452 unsigned int slotno; /* used for sdio acpi binding */
454 int dsr_req; /* DSR value is valid */
455 u32 dsr; /* optional driver stage (DSR) value */
457 /* Command Queue Engine (CQE) support */
458 const struct mmc_cqe_ops *cqe_ops;
464 unsigned long private[0] ____cacheline_aligned;
469 struct mmc_host *mmc_alloc_host(int extra, struct device *);
470 int mmc_add_host(struct mmc_host *);
471 void mmc_remove_host(struct mmc_host *);
472 void mmc_free_host(struct mmc_host *);
473 int mmc_of_parse(struct mmc_host *host);
474 int mmc_of_parse_voltage(struct device_node *np, u32 *mask);
476 static inline void *mmc_priv(struct mmc_host *host)
478 return (void *)host->private;
481 static inline struct mmc_host *mmc_from_priv(void *priv)
483 return container_of(priv, struct mmc_host, private);
486 #define mmc_host_is_spi(host) ((host)->caps & MMC_CAP_SPI)
488 #define mmc_dev(x) ((x)->parent)
489 #define mmc_classdev(x) (&(x)->class_dev)
490 #define mmc_hostname(x) (dev_name(&(x)->class_dev))
492 void mmc_detect_change(struct mmc_host *, unsigned long delay);
493 void mmc_request_done(struct mmc_host *, struct mmc_request *);
494 void mmc_command_done(struct mmc_host *host, struct mmc_request *mrq);
496 void mmc_cqe_request_done(struct mmc_host *host, struct mmc_request *mrq);
498 static inline void mmc_signal_sdio_irq(struct mmc_host *host)
500 host->ops->enable_sdio_irq(host, 0);
501 host->sdio_irq_pending = true;
502 if (host->sdio_irq_thread)
503 wake_up_process(host->sdio_irq_thread);
506 void sdio_run_irqs(struct mmc_host *host);
507 void sdio_signal_irq(struct mmc_host *host);
509 #ifdef CONFIG_REGULATOR
510 int mmc_regulator_set_ocr(struct mmc_host *mmc,
511 struct regulator *supply,
512 unsigned short vdd_bit);
513 int mmc_regulator_set_vqmmc(struct mmc_host *mmc, struct mmc_ios *ios);
515 static inline int mmc_regulator_set_ocr(struct mmc_host *mmc,
516 struct regulator *supply,
517 unsigned short vdd_bit)
522 static inline int mmc_regulator_set_vqmmc(struct mmc_host *mmc,
529 int mmc_regulator_get_supply(struct mmc_host *mmc);
531 static inline int mmc_card_is_removable(struct mmc_host *host)
533 return !(host->caps & MMC_CAP_NONREMOVABLE);
536 static inline int mmc_card_keep_power(struct mmc_host *host)
538 return host->pm_flags & MMC_PM_KEEP_POWER;
541 static inline int mmc_card_wake_sdio_irq(struct mmc_host *host)
543 return host->pm_flags & MMC_PM_WAKE_SDIO_IRQ;
546 /* TODO: Move to private header */
547 static inline int mmc_card_hs(struct mmc_card *card)
549 return card->host->ios.timing == MMC_TIMING_SD_HS ||
550 card->host->ios.timing == MMC_TIMING_MMC_HS;
553 /* TODO: Move to private header */
554 static inline int mmc_card_uhs(struct mmc_card *card)
556 return card->host->ios.timing >= MMC_TIMING_UHS_SDR12 &&
557 card->host->ios.timing <= MMC_TIMING_UHS_DDR50;
560 void mmc_retune_timer_stop(struct mmc_host *host);
562 static inline void mmc_retune_needed(struct mmc_host *host)
564 if (host->can_retune)
565 host->need_retune = 1;
568 static inline bool mmc_can_retune(struct mmc_host *host)
570 return host->can_retune == 1;
573 static inline bool mmc_doing_retune(struct mmc_host *host)
575 return host->doing_retune == 1;
578 static inline enum dma_data_direction mmc_get_dma_dir(struct mmc_data *data)
580 return data->flags & MMC_DATA_WRITE ? DMA_TO_DEVICE : DMA_FROM_DEVICE;
583 int mmc_send_tuning(struct mmc_host *host, u32 opcode, int *cmd_error);
584 int mmc_abort_tuning(struct mmc_host *host, u32 opcode);
586 #endif /* LINUX_MMC_HOST_H */