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; /* hs400 enhanced strobe 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,
98 void (*request)(struct mmc_host *host, struct mmc_request *req);
100 * Avoid calling these three functions too often or in a "fast path",
101 * since underlaying controller might implement them in an expensive
104 * Also note that these functions might sleep, so don't call them
105 * in the atomic contexts!
107 * Return values for the get_ro callback should be:
108 * 0 for a read/write card
109 * 1 for a read-only card
110 * -ENOSYS when not supported (equal to NULL callback)
111 * or a negative errno value when something bad happened
113 * Return values for the get_cd callback should be:
114 * 0 for a absent card
115 * 1 for a present card
116 * -ENOSYS when not supported (equal to NULL callback)
117 * or a negative errno value when something bad happened
119 void (*set_ios)(struct mmc_host *host, struct mmc_ios *ios);
120 int (*get_ro)(struct mmc_host *host);
121 int (*get_cd)(struct mmc_host *host);
123 void (*enable_sdio_irq)(struct mmc_host *host, int enable);
125 /* optional callback for HC quirks */
126 void (*init_card)(struct mmc_host *host, struct mmc_card *card);
128 int (*start_signal_voltage_switch)(struct mmc_host *host, struct mmc_ios *ios);
130 /* Check if the card is pulling dat[0:3] low */
131 int (*card_busy)(struct mmc_host *host);
132 int (*set_sdio_status)(struct mmc_host *host, int val);
134 /* The tuning command opcode value is different for SD and eMMC cards */
135 int (*execute_tuning)(struct mmc_host *host, u32 opcode);
137 /* Prepare HS400 target operating frequency depending host driver */
138 int (*prepare_hs400_tuning)(struct mmc_host *host, struct mmc_ios *ios);
139 /* Prepare enhanced strobe depending host driver */
140 void (*hs400_enhanced_strobe)(struct mmc_host *host, struct mmc_ios *ios);
141 int (*select_drive_strength)(struct mmc_card *card,
142 unsigned int max_dtr, int host_drv,
143 int card_drv, int *drv_type);
144 void (*hw_reset)(struct mmc_host *host);
145 void (*card_event)(struct mmc_host *host);
148 * Optional callback to support controllers with HW issues for multiple
149 * I/O. Returns the number of supported blocks for the request.
151 int (*multi_io_quirk)(struct mmc_card *card,
152 unsigned int direction, int blk_size);
158 struct mmc_async_req {
159 /* active mmc request */
160 struct mmc_request *mrq;
162 * Check error status of completed mmc request.
163 * Returns 0 if success otherwise non zero.
165 int (*err_check) (struct mmc_card *, struct mmc_async_req *);
169 * struct mmc_slot - MMC slot functions
171 * @cd_irq: MMC/SD-card slot hotplug detection IRQ or -EINVAL
172 * @handler_priv: MMC/SD-card slot context
174 * Some MMC/SD host controllers implement slot-functions like card and
175 * write-protect detection natively. However, a large number of controllers
176 * leave these functions to the CPU. This struct provides a hook to attach
177 * such slot-function drivers.
185 * mmc_context_info - synchronization details for mmc context
186 * @is_done_rcv wake up reason was done request
187 * @is_new_req wake up reason was new request
188 * @is_waiting_last_req mmc context waiting for single running request
190 * @lock lock to protect data fields
192 struct mmc_context_info {
195 bool is_waiting_last_req;
196 wait_queue_head_t wait;
204 struct regulator *vmmc; /* Card power supply */
205 struct regulator *vqmmc; /* Optional Vccq supply */
209 struct device *parent;
210 struct device class_dev;
212 const struct mmc_host_ops *ops;
213 struct mmc_pwrseq *pwrseq;
218 u32 ocr_avail_sdio; /* SDIO-specific OCR */
219 u32 ocr_avail_sd; /* SD-specific OCR */
220 u32 ocr_avail_mmc; /* MMC-specific OCR */
221 struct notifier_block pm_notify;
226 #define MMC_VDD_165_195 0x00000080 /* VDD voltage 1.65 - 1.95 */
227 #define MMC_VDD_20_21 0x00000100 /* VDD voltage 2.0 ~ 2.1 */
228 #define MMC_VDD_21_22 0x00000200 /* VDD voltage 2.1 ~ 2.2 */
229 #define MMC_VDD_22_23 0x00000400 /* VDD voltage 2.2 ~ 2.3 */
230 #define MMC_VDD_23_24 0x00000800 /* VDD voltage 2.3 ~ 2.4 */
231 #define MMC_VDD_24_25 0x00001000 /* VDD voltage 2.4 ~ 2.5 */
232 #define MMC_VDD_25_26 0x00002000 /* VDD voltage 2.5 ~ 2.6 */
233 #define MMC_VDD_26_27 0x00004000 /* VDD voltage 2.6 ~ 2.7 */
234 #define MMC_VDD_27_28 0x00008000 /* VDD voltage 2.7 ~ 2.8 */
235 #define MMC_VDD_28_29 0x00010000 /* VDD voltage 2.8 ~ 2.9 */
236 #define MMC_VDD_29_30 0x00020000 /* VDD voltage 2.9 ~ 3.0 */
237 #define MMC_VDD_30_31 0x00040000 /* VDD voltage 3.0 ~ 3.1 */
238 #define MMC_VDD_31_32 0x00080000 /* VDD voltage 3.1 ~ 3.2 */
239 #define MMC_VDD_32_33 0x00100000 /* VDD voltage 3.2 ~ 3.3 */
240 #define MMC_VDD_33_34 0x00200000 /* VDD voltage 3.3 ~ 3.4 */
241 #define MMC_VDD_34_35 0x00400000 /* VDD voltage 3.4 ~ 3.5 */
242 #define MMC_VDD_35_36 0x00800000 /* VDD voltage 3.5 ~ 3.6 */
244 u32 caps; /* Host capabilities */
246 #define MMC_CAP_4_BIT_DATA (1 << 0) /* Can the host do 4 bit transfers */
247 #define MMC_CAP_MMC_HIGHSPEED (1 << 1) /* Can do MMC high-speed timing */
248 #define MMC_CAP_SD_HIGHSPEED (1 << 2) /* Can do SD high-speed timing */
249 #define MMC_CAP_SDIO_IRQ (1 << 3) /* Can signal pending SDIO IRQs */
250 #define MMC_CAP_SPI (1 << 4) /* Talks only SPI protocols */
251 #define MMC_CAP_NEEDS_POLL (1 << 5) /* Needs polling for card-detection */
252 #define MMC_CAP_8_BIT_DATA (1 << 6) /* Can the host do 8 bit transfers */
253 #define MMC_CAP_AGGRESSIVE_PM (1 << 7) /* Suspend (e)MMC/SD at idle */
254 #define MMC_CAP_NONREMOVABLE (1 << 8) /* Nonremovable e.g. eMMC */
255 #define MMC_CAP_WAIT_WHILE_BUSY (1 << 9) /* Waits while card is busy */
256 #define MMC_CAP_ERASE (1 << 10) /* Allow erase/trim commands */
257 #define MMC_CAP_1_8V_DDR (1 << 11) /* can support */
258 /* DDR mode at 1.8V */
259 #define MMC_CAP_1_2V_DDR (1 << 12) /* can support */
260 /* DDR mode at 1.2V */
261 #define MMC_CAP_POWER_OFF_CARD (1 << 13) /* Can power off after boot */
262 #define MMC_CAP_BUS_WIDTH_TEST (1 << 14) /* CMD14/CMD19 bus width ok */
263 #define MMC_CAP_UHS_SDR12 (1 << 15) /* Host supports UHS SDR12 mode */
264 #define MMC_CAP_UHS_SDR25 (1 << 16) /* Host supports UHS SDR25 mode */
265 #define MMC_CAP_UHS_SDR50 (1 << 17) /* Host supports UHS SDR50 mode */
266 #define MMC_CAP_UHS_SDR104 (1 << 18) /* Host supports UHS SDR104 mode */
267 #define MMC_CAP_UHS_DDR50 (1 << 19) /* Host supports UHS DDR50 mode */
268 #define MMC_CAP_RUNTIME_RESUME (1 << 20) /* Resume at runtime_resume. */
269 #define MMC_CAP_DRIVER_TYPE_A (1 << 23) /* Host supports Driver Type A */
270 #define MMC_CAP_DRIVER_TYPE_C (1 << 24) /* Host supports Driver Type C */
271 #define MMC_CAP_DRIVER_TYPE_D (1 << 25) /* Host supports Driver Type D */
272 #define MMC_CAP_CMD23 (1 << 30) /* CMD23 supported. */
273 #define MMC_CAP_HW_RESET (1 << 31) /* Hardware reset */
275 u32 caps2; /* More host capabilities */
277 #define MMC_CAP2_BOOTPART_NOACC (1 << 0) /* Boot partition no access */
278 #define MMC_CAP2_FULL_PWR_CYCLE (1 << 2) /* Can do full power cycle */
279 #define MMC_CAP2_HS200_1_8V_SDR (1 << 5) /* can support */
280 #define MMC_CAP2_HS200_1_2V_SDR (1 << 6) /* can support */
281 #define MMC_CAP2_HS200 (MMC_CAP2_HS200_1_8V_SDR | \
282 MMC_CAP2_HS200_1_2V_SDR)
283 #define MMC_CAP2_HC_ERASE_SZ (1 << 9) /* High-capacity erase size */
284 #define MMC_CAP2_CD_ACTIVE_HIGH (1 << 10) /* Card-detect signal active high */
285 #define MMC_CAP2_RO_ACTIVE_HIGH (1 << 11) /* Write-protect signal active high */
286 #define MMC_CAP2_PACKED_RD (1 << 12) /* Allow packed read */
287 #define MMC_CAP2_PACKED_WR (1 << 13) /* Allow packed write */
288 #define MMC_CAP2_PACKED_CMD (MMC_CAP2_PACKED_RD | \
290 #define MMC_CAP2_NO_PRESCAN_POWERUP (1 << 14) /* Don't power up before scan */
291 #define MMC_CAP2_HS400_1_8V (1 << 15) /* Can support HS400 1.8V */
292 #define MMC_CAP2_HS400_1_2V (1 << 16) /* Can support HS400 1.2V */
293 #define MMC_CAP2_HS400 (MMC_CAP2_HS400_1_8V | \
295 #define MMC_CAP2_HSX00_1_2V (MMC_CAP2_HS200_1_2V_SDR | MMC_CAP2_HS400_1_2V)
296 #define MMC_CAP2_SDIO_IRQ_NOTHREAD (1 << 17)
297 #define MMC_CAP2_NO_WRITE_PROTECT (1 << 18) /* No physical write protect pin, assume that card is always read-write */
298 #define MMC_CAP2_HS400_ES (1 << 20) /* Host supports enhanced strobe */
300 mmc_pm_flag_t pm_caps; /* supported pm features */
302 u32 restrict_caps; /* Indicate slot specific card type */
303 #define RESTRICT_CARD_TYPE_SD (1 << 0) /* Can support Secure-Digital Card */
304 #define RESTRICT_CARD_TYPE_SDIO (1 << 1) /* Can support Secure-Digital I/O Card or Combo-Mem */
305 #define RESTRICT_CARD_TYPE_EMMC (1 << 2) /* Can support embedded Multi-Media Card */
307 /* host specific block data */
308 unsigned int max_seg_size; /* see blk_queue_max_segment_size */
309 unsigned short max_segs; /* see blk_queue_max_segments */
310 unsigned short unused;
311 unsigned int max_req_size; /* maximum number of bytes in one req */
312 unsigned int max_blk_size; /* maximum size of one mmc block */
313 unsigned int max_blk_count; /* maximum number of blocks in one req */
314 unsigned int max_busy_timeout; /* max busy timeout in ms */
317 spinlock_t lock; /* lock for claim and bus ops */
319 struct mmc_ios ios; /* current io bus settings */
321 /* group bitfields together to minimize padding */
322 unsigned int use_spi_crc:1;
323 unsigned int claimed:1; /* host exclusively claimed */
324 unsigned int bus_dead:1; /* bus has been released */
325 #ifdef CONFIG_MMC_DEBUG
326 unsigned int removed:1; /* host is being removed */
328 unsigned int can_retune:1; /* re-tuning can be used */
329 unsigned int doing_retune:1; /* re-tuning in progress */
330 unsigned int retune_now:1; /* do re-tuning at next req */
332 int rescan_disable; /* disable card detection */
333 int rescan_entered; /* used with nonremovable devices */
335 int need_retune; /* re-tuning is needed */
336 int hold_retune; /* hold off re-tuning */
337 unsigned int retune_period; /* re-tuning period in secs */
338 struct timer_list retune_timer; /* for periodic re-tuning */
340 bool trigger_card_event; /* card_event necessary */
342 struct mmc_card *card; /* device attached to this host */
344 wait_queue_head_t wq;
345 struct task_struct *claimer; /* task that has host claimed */
346 int claim_cnt; /* "claim" nesting count */
348 struct delayed_work detect;
349 int detect_change; /* card detect flag */
350 struct mmc_slot slot;
352 const struct mmc_bus_ops *bus_ops; /* current bus driver */
353 unsigned int bus_refs; /* reference counter */
355 unsigned int sdio_irqs;
356 struct task_struct *sdio_irq_thread;
357 bool sdio_irq_pending;
358 atomic_t sdio_irq_thread_abort;
360 mmc_pm_flag_t pm_flags; /* requested pm features */
362 struct led_trigger *led; /* activity led */
364 #ifdef CONFIG_REGULATOR
365 bool regulator_enabled; /* regulator state */
367 struct mmc_supply supply;
369 struct dentry *debugfs_root;
371 struct mmc_async_req *areq; /* active async req */
372 struct mmc_context_info context_info; /* async synchronization info */
374 #ifdef CONFIG_FAIL_MMC_REQUEST
375 struct fault_attr fail_mmc_request;
378 unsigned int actual_clock; /* Actual HC clock rate */
380 unsigned int slotno; /* used for sdio acpi binding */
382 int dsr_req; /* DSR value is valid */
383 u32 dsr; /* optional driver stage (DSR) value */
385 #ifdef CONFIG_MMC_EMBEDDED_SDIO
387 struct sdio_cis *cis;
388 struct sdio_cccr *cccr;
389 struct sdio_embedded_func *funcs;
391 } embedded_sdio_data;
394 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);
403 #ifdef CONFIG_MMC_EMBEDDED_SDIO
404 extern void mmc_set_embedded_sdio_data(struct mmc_host *host,
405 struct sdio_cis *cis,
406 struct sdio_cccr *cccr,
407 struct sdio_embedded_func *funcs,
411 static inline void *mmc_priv(struct mmc_host *host)
413 return (void *)host->private;
416 #define mmc_host_is_spi(host) ((host)->caps & MMC_CAP_SPI)
418 #define mmc_dev(x) ((x)->parent)
419 #define mmc_classdev(x) (&(x)->class_dev)
420 #define mmc_hostname(x) (dev_name(&(x)->class_dev))
422 int mmc_power_save_host(struct mmc_host *host);
423 int mmc_power_restore_host(struct mmc_host *host);
425 void mmc_detect_change(struct mmc_host *, unsigned long delay);
426 void mmc_request_done(struct mmc_host *, struct mmc_request *);
428 static inline void mmc_signal_sdio_irq(struct mmc_host *host)
430 host->ops->enable_sdio_irq(host, 0);
431 host->sdio_irq_pending = true;
432 if (host->sdio_irq_thread)
433 wake_up_process(host->sdio_irq_thread);
436 void sdio_run_irqs(struct mmc_host *host);
438 #ifdef CONFIG_REGULATOR
439 int mmc_regulator_get_ocrmask(struct regulator *supply);
440 int mmc_regulator_set_ocr(struct mmc_host *mmc,
441 struct regulator *supply,
442 unsigned short vdd_bit);
443 int mmc_regulator_set_vqmmc(struct mmc_host *mmc, struct mmc_ios *ios);
445 static inline int mmc_regulator_get_ocrmask(struct regulator *supply)
450 static inline int mmc_regulator_set_ocr(struct mmc_host *mmc,
451 struct regulator *supply,
452 unsigned short vdd_bit)
457 static inline int mmc_regulator_set_vqmmc(struct mmc_host *mmc,
464 int mmc_regulator_get_supply(struct mmc_host *mmc);
466 int mmc_pm_notify(struct notifier_block *notify_block, unsigned long, void *);
468 static inline int mmc_card_is_removable(struct mmc_host *host)
470 return !(host->caps & MMC_CAP_NONREMOVABLE);
473 static inline int mmc_card_keep_power(struct mmc_host *host)
475 return host->pm_flags & MMC_PM_KEEP_POWER;
478 static inline int mmc_card_wake_sdio_irq(struct mmc_host *host)
480 return host->pm_flags & MMC_PM_WAKE_SDIO_IRQ;
483 static inline int mmc_host_cmd23(struct mmc_host *host)
485 return host->caps & MMC_CAP_CMD23;
488 static inline int mmc_boot_partition_access(struct mmc_host *host)
490 return !(host->caps2 & MMC_CAP2_BOOTPART_NOACC);
493 static inline int mmc_host_uhs(struct mmc_host *host)
496 (MMC_CAP_UHS_SDR12 | MMC_CAP_UHS_SDR25 |
497 MMC_CAP_UHS_SDR50 | MMC_CAP_UHS_SDR104 |
501 static inline int mmc_host_hs400_enhanced_strobe(struct mmc_host *host)
503 return host->caps2 & MMC_CAP2_HS400_ES;
506 static inline int mmc_host_packed_wr(struct mmc_host *host)
508 return host->caps2 & MMC_CAP2_PACKED_WR;
511 static inline int mmc_card_hs(struct mmc_card *card)
513 return card->host->ios.timing == MMC_TIMING_SD_HS ||
514 card->host->ios.timing == MMC_TIMING_MMC_HS;
517 static inline int mmc_card_uhs(struct mmc_card *card)
519 return card->host->ios.timing >= MMC_TIMING_UHS_SDR12 &&
520 card->host->ios.timing <= MMC_TIMING_UHS_DDR50;
523 static inline bool mmc_card_hs200(struct mmc_card *card)
525 return card->host->ios.timing == MMC_TIMING_MMC_HS200;
528 static inline bool mmc_card_ddr52(struct mmc_card *card)
530 return card->host->ios.timing == MMC_TIMING_MMC_DDR52;
533 static inline bool mmc_card_hs400(struct mmc_card *card)
535 return card->host->ios.timing == MMC_TIMING_MMC_HS400;
538 static inline bool mmc_card_hs400es(struct mmc_card *card)
540 return card->host->ios.enhanced_strobe;
543 void mmc_retune_timer_stop(struct mmc_host *host);
545 static inline void mmc_retune_needed(struct mmc_host *host)
547 if (host->can_retune)
548 host->need_retune = 1;
551 static inline void mmc_retune_recheck(struct mmc_host *host)
553 if (host->hold_retune <= 1)
554 host->retune_now = 1;
557 #endif /* LINUX_MMC_HOST_H */