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);
134 /* optional callback for HC quirks */
135 void (*init_card)(struct mmc_host *host, struct mmc_card *card);
137 int (*start_signal_voltage_switch)(struct mmc_host *host, struct mmc_ios *ios);
139 /* Check if the card is pulling dat[0:3] low */
140 int (*card_busy)(struct mmc_host *host);
142 /* The tuning command opcode value is different for SD and eMMC cards */
143 int (*execute_tuning)(struct mmc_host *host, u32 opcode);
145 /* Prepare HS400 target operating frequency depending host driver */
146 int (*prepare_hs400_tuning)(struct mmc_host *host, struct mmc_ios *ios);
147 /* Prepare enhanced strobe depending host driver */
148 void (*hs400_enhanced_strobe)(struct mmc_host *host,
149 struct mmc_ios *ios);
150 int (*select_drive_strength)(struct mmc_card *card,
151 unsigned int max_dtr, int host_drv,
152 int card_drv, int *drv_type);
153 void (*hw_reset)(struct mmc_host *host);
154 void (*card_event)(struct mmc_host *host);
157 * Optional callback to support controllers with HW issues for multiple
158 * I/O. Returns the number of supported blocks for the request.
160 int (*multi_io_quirk)(struct mmc_card *card,
161 unsigned int direction, int blk_size);
164 struct mmc_async_req {
165 /* active mmc request */
166 struct mmc_request *mrq;
168 * Check error status of completed mmc request.
169 * Returns 0 if success otherwise non zero.
171 enum mmc_blk_status (*err_check)(struct mmc_card *, struct mmc_async_req *);
175 * struct mmc_slot - MMC slot functions
177 * @cd_irq: MMC/SD-card slot hotplug detection IRQ or -EINVAL
178 * @handler_priv: MMC/SD-card slot context
180 * Some MMC/SD host controllers implement slot-functions like card and
181 * write-protect detection natively. However, a large number of controllers
182 * leave these functions to the CPU. This struct provides a hook to attach
183 * such slot-function drivers.
191 * mmc_context_info - synchronization details for mmc context
192 * @is_done_rcv wake up reason was done request
193 * @is_new_req wake up reason was new request
194 * @is_waiting_last_req mmc context waiting for single running request
197 struct mmc_context_info {
200 bool is_waiting_last_req;
201 wait_queue_head_t wait;
208 struct regulator *vmmc; /* Card power supply */
209 struct regulator *vqmmc; /* Optional Vccq supply */
213 struct device *parent;
214 struct device class_dev;
216 const struct mmc_host_ops *ops;
217 struct mmc_pwrseq *pwrseq;
222 u32 ocr_avail_sdio; /* SDIO-specific OCR */
223 u32 ocr_avail_sd; /* SD-specific OCR */
224 u32 ocr_avail_mmc; /* MMC-specific OCR */
225 #ifdef CONFIG_PM_SLEEP
226 struct notifier_block pm_notify;
232 #define MMC_VDD_165_195 0x00000080 /* VDD voltage 1.65 - 1.95 */
233 #define MMC_VDD_20_21 0x00000100 /* VDD voltage 2.0 ~ 2.1 */
234 #define MMC_VDD_21_22 0x00000200 /* VDD voltage 2.1 ~ 2.2 */
235 #define MMC_VDD_22_23 0x00000400 /* VDD voltage 2.2 ~ 2.3 */
236 #define MMC_VDD_23_24 0x00000800 /* VDD voltage 2.3 ~ 2.4 */
237 #define MMC_VDD_24_25 0x00001000 /* VDD voltage 2.4 ~ 2.5 */
238 #define MMC_VDD_25_26 0x00002000 /* VDD voltage 2.5 ~ 2.6 */
239 #define MMC_VDD_26_27 0x00004000 /* VDD voltage 2.6 ~ 2.7 */
240 #define MMC_VDD_27_28 0x00008000 /* VDD voltage 2.7 ~ 2.8 */
241 #define MMC_VDD_28_29 0x00010000 /* VDD voltage 2.8 ~ 2.9 */
242 #define MMC_VDD_29_30 0x00020000 /* VDD voltage 2.9 ~ 3.0 */
243 #define MMC_VDD_30_31 0x00040000 /* VDD voltage 3.0 ~ 3.1 */
244 #define MMC_VDD_31_32 0x00080000 /* VDD voltage 3.1 ~ 3.2 */
245 #define MMC_VDD_32_33 0x00100000 /* VDD voltage 3.2 ~ 3.3 */
246 #define MMC_VDD_33_34 0x00200000 /* VDD voltage 3.3 ~ 3.4 */
247 #define MMC_VDD_34_35 0x00400000 /* VDD voltage 3.4 ~ 3.5 */
248 #define MMC_VDD_35_36 0x00800000 /* VDD voltage 3.5 ~ 3.6 */
250 u32 caps; /* Host capabilities */
252 #define MMC_CAP_4_BIT_DATA (1 << 0) /* Can the host do 4 bit transfers */
253 #define MMC_CAP_MMC_HIGHSPEED (1 << 1) /* Can do MMC high-speed timing */
254 #define MMC_CAP_SD_HIGHSPEED (1 << 2) /* Can do SD high-speed timing */
255 #define MMC_CAP_SDIO_IRQ (1 << 3) /* Can signal pending SDIO IRQs */
256 #define MMC_CAP_SPI (1 << 4) /* Talks only SPI protocols */
257 #define MMC_CAP_NEEDS_POLL (1 << 5) /* Needs polling for card-detection */
258 #define MMC_CAP_8_BIT_DATA (1 << 6) /* Can the host do 8 bit transfers */
259 #define MMC_CAP_AGGRESSIVE_PM (1 << 7) /* Suspend (e)MMC/SD at idle */
260 #define MMC_CAP_NONREMOVABLE (1 << 8) /* Nonremovable e.g. eMMC */
261 #define MMC_CAP_WAIT_WHILE_BUSY (1 << 9) /* Waits while card is busy */
262 #define MMC_CAP_ERASE (1 << 10) /* Allow erase/trim commands */
263 #define MMC_CAP_3_3V_DDR (1 << 11) /* Host supports eMMC DDR 3.3V */
264 #define MMC_CAP_1_8V_DDR (1 << 12) /* Host supports eMMC DDR 1.8V */
265 #define MMC_CAP_1_2V_DDR (1 << 13) /* Host supports eMMC DDR 1.2V */
266 #define MMC_CAP_POWER_OFF_CARD (1 << 14) /* Can power off after boot */
267 #define MMC_CAP_BUS_WIDTH_TEST (1 << 15) /* CMD14/CMD19 bus width ok */
268 #define MMC_CAP_UHS_SDR12 (1 << 16) /* Host supports UHS SDR12 mode */
269 #define MMC_CAP_UHS_SDR25 (1 << 17) /* Host supports UHS SDR25 mode */
270 #define MMC_CAP_UHS_SDR50 (1 << 18) /* Host supports UHS SDR50 mode */
271 #define MMC_CAP_UHS_SDR104 (1 << 19) /* Host supports UHS SDR104 mode */
272 #define MMC_CAP_UHS_DDR50 (1 << 20) /* Host supports UHS DDR50 mode */
273 #define MMC_CAP_DRIVER_TYPE_A (1 << 23) /* Host supports Driver Type A */
274 #define MMC_CAP_DRIVER_TYPE_C (1 << 24) /* Host supports Driver Type C */
275 #define MMC_CAP_DRIVER_TYPE_D (1 << 25) /* Host supports Driver Type D */
276 #define MMC_CAP_CMD_DURING_TFR (1 << 29) /* Commands during data transfer */
277 #define MMC_CAP_CMD23 (1 << 30) /* CMD23 supported. */
278 #define MMC_CAP_HW_RESET (1 << 31) /* Hardware reset */
280 u32 caps2; /* More host capabilities */
282 #define MMC_CAP2_BOOTPART_NOACC (1 << 0) /* Boot partition no access */
283 #define MMC_CAP2_FULL_PWR_CYCLE (1 << 2) /* Can do full power cycle */
284 #define MMC_CAP2_HS200_1_8V_SDR (1 << 5) /* can support */
285 #define MMC_CAP2_HS200_1_2V_SDR (1 << 6) /* can support */
286 #define MMC_CAP2_HS200 (MMC_CAP2_HS200_1_8V_SDR | \
287 MMC_CAP2_HS200_1_2V_SDR)
288 #define MMC_CAP2_HC_ERASE_SZ (1 << 9) /* High-capacity erase size */
289 #define MMC_CAP2_CD_ACTIVE_HIGH (1 << 10) /* Card-detect signal active high */
290 #define MMC_CAP2_RO_ACTIVE_HIGH (1 << 11) /* Write-protect signal active high */
291 #define MMC_CAP2_PACKED_RD (1 << 12) /* Allow packed read */
292 #define MMC_CAP2_PACKED_WR (1 << 13) /* Allow packed write */
293 #define MMC_CAP2_PACKED_CMD (MMC_CAP2_PACKED_RD | \
295 #define MMC_CAP2_NO_PRESCAN_POWERUP (1 << 14) /* Don't power up before scan */
296 #define MMC_CAP2_HS400_1_8V (1 << 15) /* Can support HS400 1.8V */
297 #define MMC_CAP2_HS400_1_2V (1 << 16) /* Can support HS400 1.2V */
298 #define MMC_CAP2_HS400 (MMC_CAP2_HS400_1_8V | \
300 #define MMC_CAP2_HSX00_1_2V (MMC_CAP2_HS200_1_2V_SDR | MMC_CAP2_HS400_1_2V)
301 #define MMC_CAP2_SDIO_IRQ_NOTHREAD (1 << 17)
302 #define MMC_CAP2_NO_WRITE_PROTECT (1 << 18) /* No physical write protect pin, assume that card is always read-write */
303 #define MMC_CAP2_NO_SDIO (1 << 19) /* Do not send SDIO commands during initialization */
304 #define MMC_CAP2_HS400_ES (1 << 20) /* Host supports enhanced strobe */
305 #define MMC_CAP2_NO_SD (1 << 21) /* Do not send SD commands during initialization */
306 #define MMC_CAP2_NO_MMC (1 << 22) /* Do not send (e)MMC commands during initialization */
308 mmc_pm_flag_t pm_caps; /* supported pm features */
310 /* host specific block data */
311 unsigned int max_seg_size; /* see blk_queue_max_segment_size */
312 unsigned short max_segs; /* see blk_queue_max_segments */
313 unsigned short unused;
314 unsigned int max_req_size; /* maximum number of bytes in one req */
315 unsigned int max_blk_size; /* maximum size of one mmc block */
316 unsigned int max_blk_count; /* maximum number of blocks in one req */
317 unsigned int max_busy_timeout; /* max busy timeout in ms */
320 spinlock_t lock; /* lock for claim and bus ops */
322 struct mmc_ios ios; /* current io bus settings */
324 /* group bitfields together to minimize padding */
325 unsigned int use_spi_crc:1;
326 unsigned int claimed:1; /* host exclusively claimed */
327 unsigned int bus_dead:1; /* bus has been released */
328 #ifdef CONFIG_MMC_DEBUG
329 unsigned int removed:1; /* host is being removed */
331 unsigned int can_retune:1; /* re-tuning can be used */
332 unsigned int doing_retune:1; /* re-tuning in progress */
333 unsigned int retune_now:1; /* do re-tuning at next req */
334 unsigned int retune_paused:1; /* re-tuning is temporarily disabled */
336 int rescan_disable; /* disable card detection */
337 int rescan_entered; /* used with nonremovable devices */
339 int need_retune; /* re-tuning is needed */
340 int hold_retune; /* hold off re-tuning */
341 unsigned int retune_period; /* re-tuning period in secs */
342 struct timer_list retune_timer; /* for periodic re-tuning */
344 bool trigger_card_event; /* card_event necessary */
346 struct mmc_card *card; /* device attached to this host */
348 wait_queue_head_t wq;
349 struct task_struct *claimer; /* task that has host claimed */
350 int claim_cnt; /* "claim" nesting count */
352 struct delayed_work detect;
353 int detect_change; /* card detect flag */
354 struct mmc_slot slot;
356 const struct mmc_bus_ops *bus_ops; /* current bus driver */
357 unsigned int bus_refs; /* reference counter */
359 unsigned int sdio_irqs;
360 struct task_struct *sdio_irq_thread;
361 bool sdio_irq_pending;
362 atomic_t sdio_irq_thread_abort;
364 mmc_pm_flag_t pm_flags; /* requested pm features */
366 struct led_trigger *led; /* activity led */
368 #ifdef CONFIG_REGULATOR
369 bool regulator_enabled; /* regulator state */
371 struct mmc_supply supply;
373 struct dentry *debugfs_root;
375 struct mmc_async_req *areq; /* active async req */
376 struct mmc_context_info context_info; /* async synchronization info */
378 /* Ongoing data transfer that allows commands during transfer */
379 struct mmc_request *ongoing_mrq;
381 #ifdef CONFIG_FAIL_MMC_REQUEST
382 struct fault_attr fail_mmc_request;
385 unsigned int actual_clock; /* Actual HC clock rate */
387 unsigned int slotno; /* used for sdio acpi binding */
389 int dsr_req; /* DSR value is valid */
390 u32 dsr; /* optional driver stage (DSR) value */
392 unsigned long private[0] ____cacheline_aligned;
397 struct mmc_host *mmc_alloc_host(int extra, struct device *);
398 int mmc_add_host(struct mmc_host *);
399 void mmc_remove_host(struct mmc_host *);
400 void mmc_free_host(struct mmc_host *);
401 int mmc_of_parse(struct mmc_host *host);
402 int mmc_of_parse_voltage(struct device_node *np, u32 *mask);
404 static inline void *mmc_priv(struct mmc_host *host)
406 return (void *)host->private;
409 #define mmc_host_is_spi(host) ((host)->caps & MMC_CAP_SPI)
411 #define mmc_dev(x) ((x)->parent)
412 #define mmc_classdev(x) (&(x)->class_dev)
413 #define mmc_hostname(x) (dev_name(&(x)->class_dev))
415 int mmc_power_save_host(struct mmc_host *host);
416 int mmc_power_restore_host(struct mmc_host *host);
418 void mmc_detect_change(struct mmc_host *, unsigned long delay);
419 void mmc_request_done(struct mmc_host *, struct mmc_request *);
420 void mmc_command_done(struct mmc_host *host, struct mmc_request *mrq);
422 static inline void mmc_signal_sdio_irq(struct mmc_host *host)
424 host->ops->enable_sdio_irq(host, 0);
425 host->sdio_irq_pending = true;
426 if (host->sdio_irq_thread)
427 wake_up_process(host->sdio_irq_thread);
430 void sdio_run_irqs(struct mmc_host *host);
432 #ifdef CONFIG_REGULATOR
433 int mmc_regulator_get_ocrmask(struct regulator *supply);
434 int mmc_regulator_set_ocr(struct mmc_host *mmc,
435 struct regulator *supply,
436 unsigned short vdd_bit);
437 int mmc_regulator_set_vqmmc(struct mmc_host *mmc, struct mmc_ios *ios);
439 static inline int mmc_regulator_get_ocrmask(struct regulator *supply)
444 static inline int mmc_regulator_set_ocr(struct mmc_host *mmc,
445 struct regulator *supply,
446 unsigned short vdd_bit)
451 static inline int mmc_regulator_set_vqmmc(struct mmc_host *mmc,
458 u32 mmc_vddrange_to_ocrmask(int vdd_min, int vdd_max);
459 int mmc_regulator_get_supply(struct mmc_host *mmc);
461 static inline int mmc_card_is_removable(struct mmc_host *host)
463 return !(host->caps & MMC_CAP_NONREMOVABLE);
466 static inline int mmc_card_keep_power(struct mmc_host *host)
468 return host->pm_flags & MMC_PM_KEEP_POWER;
471 static inline int mmc_card_wake_sdio_irq(struct mmc_host *host)
473 return host->pm_flags & MMC_PM_WAKE_SDIO_IRQ;
476 /* TODO: Move to private header */
477 static inline int mmc_card_hs(struct mmc_card *card)
479 return card->host->ios.timing == MMC_TIMING_SD_HS ||
480 card->host->ios.timing == MMC_TIMING_MMC_HS;
483 /* TODO: Move to private header */
484 static inline int mmc_card_uhs(struct mmc_card *card)
486 return card->host->ios.timing >= MMC_TIMING_UHS_SDR12 &&
487 card->host->ios.timing <= MMC_TIMING_UHS_DDR50;
490 void mmc_retune_timer_stop(struct mmc_host *host);
492 static inline void mmc_retune_needed(struct mmc_host *host)
494 if (host->can_retune)
495 host->need_retune = 1;
498 static inline bool mmc_can_retune(struct mmc_host *host)
500 return host->can_retune == 1;
503 static inline enum dma_data_direction mmc_get_dma_dir(struct mmc_data *data)
505 return data->flags & MMC_DATA_WRITE ? DMA_TO_DEVICE : DMA_FROM_DEVICE;
508 int mmc_send_tuning(struct mmc_host *host, u32 opcode, int *cmd_error);
509 int mmc_abort_tuning(struct mmc_host *host, u32 opcode);
511 #endif /* LINUX_MMC_HOST_H */