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>
19 #include <linux/blkdev.h>
21 #include <linux/mmc/core.h>
22 #include <linux/mmc/card.h>
23 #include <linux/mmc/mmc.h>
24 #include <linux/mmc/pm.h>
27 unsigned int clock; /* clock rate */
30 /* vdd stores the bit number of the selected voltage range from below. */
32 unsigned char bus_mode; /* command output mode */
34 #define MMC_BUSMODE_OPENDRAIN 1
35 #define MMC_BUSMODE_PUSHPULL 2
37 unsigned char chip_select; /* SPI chip select */
39 #define MMC_CS_DONTCARE 0
43 unsigned char power_mode; /* power supply mode */
45 #define MMC_POWER_OFF 0
46 #define MMC_POWER_UP 1
47 #define MMC_POWER_ON 2
48 #define MMC_POWER_UNDEFINED 3
50 unsigned char bus_width; /* data bus width */
52 #define MMC_BUS_WIDTH_1 0
53 #define MMC_BUS_WIDTH_4 2
54 #define MMC_BUS_WIDTH_8 3
56 unsigned char timing; /* timing specification used */
58 #define MMC_TIMING_LEGACY 0
59 #define MMC_TIMING_MMC_HS 1
60 #define MMC_TIMING_SD_HS 2
61 #define MMC_TIMING_UHS_SDR12 3
62 #define MMC_TIMING_UHS_SDR25 4
63 #define MMC_TIMING_UHS_SDR50 5
64 #define MMC_TIMING_UHS_SDR104 6
65 #define MMC_TIMING_UHS_DDR50 7
66 #define MMC_TIMING_MMC_DDR52 8
67 #define MMC_TIMING_MMC_HS200 9
68 #define MMC_TIMING_MMC_HS400 10
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
83 bool enhanced_strobe; /* hs400 enhanced strobe selection */
88 * It is optional for the host to implement pre_req and post_req in
89 * order to support double buffering of requests (prepare one
90 * request while another request is active).
91 * pre_req() must always be followed by a post_req().
92 * To undo a call made to pre_req(), call post_req() with
93 * a nonzero err condition.
95 void (*post_req)(struct mmc_host *host, struct mmc_request *req,
97 void (*pre_req)(struct mmc_host *host, struct mmc_request *req,
99 void (*request)(struct mmc_host *host, struct mmc_request *req);
101 * Avoid calling these three functions too often or in a "fast path",
102 * since underlaying controller might implement them in an expensive
105 * Also note that these functions might sleep, so don't call them
106 * in the atomic contexts!
108 * Return values for the get_ro callback should be:
109 * 0 for a read/write card
110 * 1 for a read-only card
111 * -ENOSYS when not supported (equal to NULL callback)
112 * or a negative errno value when something bad happened
114 * Return values for the get_cd callback should be:
115 * 0 for a absent card
116 * 1 for a present card
117 * -ENOSYS when not supported (equal to NULL callback)
118 * or a negative errno value when something bad happened
120 void (*set_ios)(struct mmc_host *host, struct mmc_ios *ios);
121 int (*get_ro)(struct mmc_host *host);
122 int (*get_cd)(struct mmc_host *host);
124 void (*enable_sdio_irq)(struct mmc_host *host, int enable);
126 /* optional callback for HC quirks */
127 void (*init_card)(struct mmc_host *host, struct mmc_card *card);
129 int (*start_signal_voltage_switch)(struct mmc_host *host, struct mmc_ios *ios);
131 /* Check if the card is pulling dat[0:3] low */
132 int (*card_busy)(struct mmc_host *host);
133 int (*set_sdio_status)(struct mmc_host *host, int val);
135 /* The tuning command opcode value is different for SD and eMMC cards */
136 int (*execute_tuning)(struct mmc_host *host, u32 opcode);
138 /* Prepare HS400 target operating frequency depending host driver */
139 int (*prepare_hs400_tuning)(struct mmc_host *host, struct mmc_ios *ios);
140 /* Prepare enhanced strobe depending host driver */
141 void (*hs400_enhanced_strobe)(struct mmc_host *host, struct mmc_ios *ios);
142 int (*select_drive_strength)(struct mmc_card *card,
143 unsigned int max_dtr, int host_drv,
144 int card_drv, int *drv_type);
145 void (*hw_reset)(struct mmc_host *host);
146 void (*card_event)(struct mmc_host *host);
149 * Optional callback to support controllers with HW issues for multiple
150 * I/O. Returns the number of supported blocks for the request.
152 int (*multi_io_quirk)(struct mmc_card *card,
153 unsigned int direction, int blk_size);
159 struct mmc_async_req {
160 /* active mmc request */
161 struct mmc_request *mrq;
163 * Check error status of completed mmc request.
164 * Returns 0 if success otherwise non zero.
166 int (*err_check) (struct mmc_card *, struct mmc_async_req *);
170 * struct mmc_slot - MMC slot functions
172 * @cd_irq: MMC/SD-card slot hotplug detection IRQ or -EINVAL
173 * @handler_priv: MMC/SD-card slot context
175 * Some MMC/SD host controllers implement slot-functions like card and
176 * write-protect detection natively. However, a large number of controllers
177 * leave these functions to the CPU. This struct provides a hook to attach
178 * such slot-function drivers.
186 * mmc_context_info - synchronization details for mmc context
187 * @is_done_rcv wake up reason was done request
188 * @is_new_req wake up reason was new request
189 * @is_waiting_last_req mmc context waiting for single running request
191 * @lock lock to protect data fields
193 struct mmc_context_info {
196 bool is_waiting_last_req;
197 wait_queue_head_t wait;
205 struct regulator *vmmc; /* Card power supply */
206 struct regulator *vqmmc; /* Optional Vccq supply */
210 struct device *parent;
211 struct device class_dev;
213 const struct mmc_host_ops *ops;
214 struct mmc_pwrseq *pwrseq;
219 u32 ocr_avail_sdio; /* SDIO-specific OCR */
220 u32 ocr_avail_sd; /* SD-specific OCR */
221 u32 ocr_avail_mmc; /* MMC-specific OCR */
222 struct notifier_block pm_notify;
227 #define MMC_VDD_165_195 0x00000080 /* VDD voltage 1.65 - 1.95 */
228 #define MMC_VDD_20_21 0x00000100 /* VDD voltage 2.0 ~ 2.1 */
229 #define MMC_VDD_21_22 0x00000200 /* VDD voltage 2.1 ~ 2.2 */
230 #define MMC_VDD_22_23 0x00000400 /* VDD voltage 2.2 ~ 2.3 */
231 #define MMC_VDD_23_24 0x00000800 /* VDD voltage 2.3 ~ 2.4 */
232 #define MMC_VDD_24_25 0x00001000 /* VDD voltage 2.4 ~ 2.5 */
233 #define MMC_VDD_25_26 0x00002000 /* VDD voltage 2.5 ~ 2.6 */
234 #define MMC_VDD_26_27 0x00004000 /* VDD voltage 2.6 ~ 2.7 */
235 #define MMC_VDD_27_28 0x00008000 /* VDD voltage 2.7 ~ 2.8 */
236 #define MMC_VDD_28_29 0x00010000 /* VDD voltage 2.8 ~ 2.9 */
237 #define MMC_VDD_29_30 0x00020000 /* VDD voltage 2.9 ~ 3.0 */
238 #define MMC_VDD_30_31 0x00040000 /* VDD voltage 3.0 ~ 3.1 */
239 #define MMC_VDD_31_32 0x00080000 /* VDD voltage 3.1 ~ 3.2 */
240 #define MMC_VDD_32_33 0x00100000 /* VDD voltage 3.2 ~ 3.3 */
241 #define MMC_VDD_33_34 0x00200000 /* VDD voltage 3.3 ~ 3.4 */
242 #define MMC_VDD_34_35 0x00400000 /* VDD voltage 3.4 ~ 3.5 */
243 #define MMC_VDD_35_36 0x00800000 /* VDD voltage 3.5 ~ 3.6 */
245 u32 caps; /* Host capabilities */
247 #define MMC_CAP_4_BIT_DATA (1 << 0) /* Can the host do 4 bit transfers */
248 #define MMC_CAP_MMC_HIGHSPEED (1 << 1) /* Can do MMC high-speed timing */
249 #define MMC_CAP_SD_HIGHSPEED (1 << 2) /* Can do SD high-speed timing */
250 #define MMC_CAP_SDIO_IRQ (1 << 3) /* Can signal pending SDIO IRQs */
251 #define MMC_CAP_SPI (1 << 4) /* Talks only SPI protocols */
252 #define MMC_CAP_NEEDS_POLL (1 << 5) /* Needs polling for card-detection */
253 #define MMC_CAP_8_BIT_DATA (1 << 6) /* Can the host do 8 bit transfers */
254 #define MMC_CAP_AGGRESSIVE_PM (1 << 7) /* Suspend (e)MMC/SD at idle */
255 #define MMC_CAP_NONREMOVABLE (1 << 8) /* Nonremovable e.g. eMMC */
256 #define MMC_CAP_WAIT_WHILE_BUSY (1 << 9) /* Waits while card is busy */
257 #define MMC_CAP_ERASE (1 << 10) /* Allow erase/trim commands */
258 #define MMC_CAP_1_8V_DDR (1 << 11) /* can support */
259 /* DDR mode at 1.8V */
260 #define MMC_CAP_1_2V_DDR (1 << 12) /* can support */
261 /* DDR mode at 1.2V */
262 #define MMC_CAP_POWER_OFF_CARD (1 << 13) /* Can power off after boot */
263 #define MMC_CAP_BUS_WIDTH_TEST (1 << 14) /* CMD14/CMD19 bus width ok */
264 #define MMC_CAP_UHS_SDR12 (1 << 15) /* Host supports UHS SDR12 mode */
265 #define MMC_CAP_UHS_SDR25 (1 << 16) /* Host supports UHS SDR25 mode */
266 #define MMC_CAP_UHS_SDR50 (1 << 17) /* Host supports UHS SDR50 mode */
267 #define MMC_CAP_UHS_SDR104 (1 << 18) /* Host supports UHS SDR104 mode */
268 #define MMC_CAP_UHS_DDR50 (1 << 19) /* Host supports UHS DDR50 mode */
269 #define MMC_CAP_RUNTIME_RESUME (1 << 20) /* Resume at runtime_resume. */
270 #define MMC_CAP_DRIVER_TYPE_A (1 << 23) /* Host supports Driver Type A */
271 #define MMC_CAP_DRIVER_TYPE_C (1 << 24) /* Host supports Driver Type C */
272 #define MMC_CAP_DRIVER_TYPE_D (1 << 25) /* Host supports Driver Type D */
273 #define MMC_CAP_CMD23 (1 << 30) /* CMD23 supported. */
274 #define MMC_CAP_HW_RESET (1 << 31) /* Hardware reset */
276 u32 caps2; /* More host capabilities */
278 #define MMC_CAP2_BOOTPART_NOACC (1 << 0) /* Boot partition no access */
279 #define MMC_CAP2_FULL_PWR_CYCLE (1 << 2) /* Can do full power cycle */
280 #define MMC_CAP2_HS200_1_8V_SDR (1 << 5) /* can support */
281 #define MMC_CAP2_HS200_1_2V_SDR (1 << 6) /* can support */
282 #define MMC_CAP2_HS200 (MMC_CAP2_HS200_1_8V_SDR | \
283 MMC_CAP2_HS200_1_2V_SDR)
284 #define MMC_CAP2_HC_ERASE_SZ (1 << 9) /* High-capacity erase size */
285 #define MMC_CAP2_CD_ACTIVE_HIGH (1 << 10) /* Card-detect signal active high */
286 #define MMC_CAP2_RO_ACTIVE_HIGH (1 << 11) /* Write-protect signal active high */
287 #define MMC_CAP2_PACKED_RD (1 << 12) /* Allow packed read */
288 #define MMC_CAP2_PACKED_WR (1 << 13) /* Allow packed write */
289 #define MMC_CAP2_PACKED_CMD (MMC_CAP2_PACKED_RD | \
291 #define MMC_CAP2_NO_PRESCAN_POWERUP (1 << 14) /* Don't power up before scan */
292 #define MMC_CAP2_HS400_1_8V (1 << 15) /* Can support HS400 1.8V */
293 #define MMC_CAP2_HS400_1_2V (1 << 16) /* Can support HS400 1.2V */
294 #define MMC_CAP2_HS400 (MMC_CAP2_HS400_1_8V | \
296 #define MMC_CAP2_HSX00_1_2V (MMC_CAP2_HS200_1_2V_SDR | MMC_CAP2_HS400_1_2V)
297 #define MMC_CAP2_SDIO_IRQ_NOTHREAD (1 << 17)
298 #define MMC_CAP2_NO_WRITE_PROTECT (1 << 18) /* No physical write protect pin, assume that card is always read-write */
299 #define MMC_CAP2_HS400_ES (1 << 20) /* Host supports enhanced strobe */
301 mmc_pm_flag_t pm_caps; /* supported pm features */
303 u32 restrict_caps; /* Indicate slot specific card type */
304 #define RESTRICT_CARD_TYPE_SD (1 << 0) /* Can support Secure-Digital Card */
305 #define RESTRICT_CARD_TYPE_SDIO (1 << 1) /* Can support Secure-Digital I/O Card or Combo-Mem */
306 #define RESTRICT_CARD_TYPE_EMMC (1 << 2) /* Can support embedded Multi-Media Card */
308 /* host specific block data */
309 unsigned int max_seg_size; /* see blk_queue_max_segment_size */
310 unsigned short max_segs; /* see blk_queue_max_segments */
311 unsigned short unused;
312 unsigned int max_req_size; /* maximum number of bytes in one req */
313 unsigned int max_blk_size; /* maximum size of one mmc block */
314 unsigned int max_blk_count; /* maximum number of blocks in one req */
315 unsigned int max_busy_timeout; /* max busy timeout in ms */
318 spinlock_t lock; /* lock for claim and bus ops */
320 struct mmc_ios ios; /* current io bus settings */
322 /* group bitfields together to minimize padding */
323 unsigned int use_spi_crc:1;
324 unsigned int claimed:1; /* host exclusively claimed */
325 unsigned int bus_dead:1; /* bus has been released */
326 #ifdef CONFIG_MMC_DEBUG
327 unsigned int removed:1; /* host is being removed */
329 unsigned int can_retune:1; /* re-tuning can be used */
330 unsigned int doing_retune:1; /* re-tuning in progress */
331 unsigned int retune_now:1; /* do re-tuning at next req */
333 int rescan_disable; /* disable card detection */
334 int rescan_entered; /* used with nonremovable devices */
336 int need_retune; /* re-tuning is needed */
337 int hold_retune; /* hold off re-tuning */
338 unsigned int retune_period; /* re-tuning period in secs */
339 struct timer_list retune_timer; /* for periodic re-tuning */
341 bool trigger_card_event; /* card_event necessary */
343 struct mmc_card *card; /* device attached to this host */
345 wait_queue_head_t wq;
346 struct task_struct *claimer; /* task that has host claimed */
347 int claim_cnt; /* "claim" nesting count */
349 struct delayed_work detect;
350 int detect_change; /* card detect flag */
351 struct mmc_slot slot;
353 const struct mmc_bus_ops *bus_ops; /* current bus driver */
354 unsigned int bus_refs; /* reference counter */
356 unsigned int sdio_irqs;
357 struct task_struct *sdio_irq_thread;
358 bool sdio_irq_pending;
359 atomic_t sdio_irq_thread_abort;
361 mmc_pm_flag_t pm_flags; /* requested pm features */
363 struct led_trigger *led; /* activity led */
365 #ifdef CONFIG_REGULATOR
366 bool regulator_enabled; /* regulator state */
368 struct mmc_supply supply;
370 struct dentry *debugfs_root;
372 struct mmc_async_req *areq; /* active async req */
373 struct mmc_context_info context_info; /* async synchronization info */
375 #ifdef CONFIG_FAIL_MMC_REQUEST
376 struct fault_attr fail_mmc_request;
379 unsigned int actual_clock; /* Actual HC clock rate */
381 unsigned int slotno; /* used for sdio acpi binding */
383 int dsr_req; /* DSR value is valid */
384 u32 dsr; /* optional driver stage (DSR) value */
386 #ifdef CONFIG_MMC_EMBEDDED_SDIO
388 struct sdio_cis *cis;
389 struct sdio_cccr *cccr;
390 struct sdio_embedded_func *funcs;
392 } embedded_sdio_data;
396 int latency_hist_enabled;
397 struct io_latency_state io_lat_s;
400 unsigned long private[0] ____cacheline_aligned;
403 struct mmc_host *mmc_alloc_host(int extra, struct device *);
404 int mmc_add_host(struct mmc_host *);
405 void mmc_remove_host(struct mmc_host *);
406 void mmc_free_host(struct mmc_host *);
407 int mmc_of_parse(struct mmc_host *host);
409 #ifdef CONFIG_MMC_EMBEDDED_SDIO
410 extern void mmc_set_embedded_sdio_data(struct mmc_host *host,
411 struct sdio_cis *cis,
412 struct sdio_cccr *cccr,
413 struct sdio_embedded_func *funcs,
417 static inline void *mmc_priv(struct mmc_host *host)
419 return (void *)host->private;
422 #define mmc_host_is_spi(host) ((host)->caps & MMC_CAP_SPI)
424 #define mmc_dev(x) ((x)->parent)
425 #define mmc_classdev(x) (&(x)->class_dev)
426 #define mmc_hostname(x) (dev_name(&(x)->class_dev))
428 int mmc_power_save_host(struct mmc_host *host);
429 int mmc_power_restore_host(struct mmc_host *host);
431 void mmc_detect_change(struct mmc_host *, unsigned long delay);
432 void mmc_request_done(struct mmc_host *, struct mmc_request *);
434 static inline void mmc_signal_sdio_irq(struct mmc_host *host)
436 host->ops->enable_sdio_irq(host, 0);
437 host->sdio_irq_pending = true;
438 if (host->sdio_irq_thread)
439 wake_up_process(host->sdio_irq_thread);
442 void sdio_run_irqs(struct mmc_host *host);
444 #ifdef CONFIG_REGULATOR
445 int mmc_regulator_get_ocrmask(struct regulator *supply);
446 int mmc_regulator_set_ocr(struct mmc_host *mmc,
447 struct regulator *supply,
448 unsigned short vdd_bit);
449 int mmc_regulator_set_vqmmc(struct mmc_host *mmc, struct mmc_ios *ios);
451 static inline int mmc_regulator_get_ocrmask(struct regulator *supply)
456 static inline int mmc_regulator_set_ocr(struct mmc_host *mmc,
457 struct regulator *supply,
458 unsigned short vdd_bit)
463 static inline int mmc_regulator_set_vqmmc(struct mmc_host *mmc,
470 int mmc_regulator_get_supply(struct mmc_host *mmc);
472 int mmc_pm_notify(struct notifier_block *notify_block, unsigned long, void *);
474 static inline int mmc_card_is_removable(struct mmc_host *host)
476 return !(host->caps & MMC_CAP_NONREMOVABLE);
479 static inline int mmc_card_keep_power(struct mmc_host *host)
481 return host->pm_flags & MMC_PM_KEEP_POWER;
484 static inline int mmc_card_wake_sdio_irq(struct mmc_host *host)
486 return host->pm_flags & MMC_PM_WAKE_SDIO_IRQ;
489 static inline int mmc_host_cmd23(struct mmc_host *host)
491 return host->caps & MMC_CAP_CMD23;
494 static inline int mmc_boot_partition_access(struct mmc_host *host)
496 return !(host->caps2 & MMC_CAP2_BOOTPART_NOACC);
499 static inline int mmc_host_uhs(struct mmc_host *host)
502 (MMC_CAP_UHS_SDR12 | MMC_CAP_UHS_SDR25 |
503 MMC_CAP_UHS_SDR50 | MMC_CAP_UHS_SDR104 |
507 static inline int mmc_host_hs400_enhanced_strobe(struct mmc_host *host)
509 return host->caps2 & MMC_CAP2_HS400_ES;
512 static inline int mmc_host_packed_wr(struct mmc_host *host)
514 return host->caps2 & MMC_CAP2_PACKED_WR;
517 static inline int mmc_card_hs(struct mmc_card *card)
519 return card->host->ios.timing == MMC_TIMING_SD_HS ||
520 card->host->ios.timing == MMC_TIMING_MMC_HS;
523 static inline int mmc_card_uhs(struct mmc_card *card)
525 return card->host->ios.timing >= MMC_TIMING_UHS_SDR12 &&
526 card->host->ios.timing <= MMC_TIMING_UHS_DDR50;
529 static inline bool mmc_card_hs200(struct mmc_card *card)
531 return card->host->ios.timing == MMC_TIMING_MMC_HS200;
534 static inline bool mmc_card_ddr52(struct mmc_card *card)
536 return card->host->ios.timing == MMC_TIMING_MMC_DDR52;
539 static inline bool mmc_card_hs400(struct mmc_card *card)
541 return card->host->ios.timing == MMC_TIMING_MMC_HS400;
544 static inline bool mmc_card_hs400es(struct mmc_card *card)
546 return card->host->ios.enhanced_strobe;
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 void mmc_retune_recheck(struct mmc_host *host)
559 if (host->hold_retune <= 1)
560 host->retune_now = 1;
563 #endif /* LINUX_MMC_HOST_H */