1 /* SPDX-License-Identifier: GPL-2.0-only */
3  *  linux/include/linux/mmc/host.h
12 #include <linux/fault-inject.h>
15 #include <linux/mmc/core.h>
16 #include <linux/mmc/card.h>
17 #include <linux/mmc/pm.h>
18 #include <linux/dma-direction.h>
19 #include <linux/blk-crypto-profile.h>
20 #include <linux/mmc/sd_uhs2.h>
187 	 * ios->clock might be 0. For some controllers, setting 0Hz
196 	 *   0 for a read/write card
197 	 *   1 for a read-only card
198 	 *   -ENOSYS when not supported (equal to NULL callback)
205 	 *   0 for a absent card
206 	 *   1 for a present card
207 	 *   -ENOSYS when not supported (equal to NULL callback)
217 	void	(*init_card)(struct mmc_host *host, struct mmc_card *card);
221 	/* Check if the card is pulling dat[0] low */
231 	int	(*execute_hs400_tuning)(struct mmc_host *host, struct mmc_card *card);
233 	/* Optional callback to prepare for SD high-speed tuning */
234 	int	(*prepare_sd_hs_tuning)(struct mmc_host *host, struct mmc_card *card);
236 	/* Optional callback to execute SD high-speed tuning */
237 	int	(*execute_sd_hs_tuning)(struct mmc_host *host, struct mmc_card *card);
251 	int	(*select_drive_strength)(struct mmc_card *card,
254 	/* Reset the eMMC card via RST_n */
262 	int	(*multi_io_quirk)(struct mmc_card *card,
265 	/* Initialize an SD express card, mandatory for MMC_CAP2_SD_EXP. */
269 	 * The uhs2_control callback is used to execute SD UHS-II specific
271 	 * SD UHS-II interface (MMC_CAP2_SD_UHS2). Expected return values are a
279 	int	(*cqe_enable)(struct mmc_host *host, struct mmc_card *card);
280 	/* Free resources, and make the CQE non-operational */
284 	 * effect of ->cqe_off().
290 	 * Prepare the CQE and host controller to accept non-CQ commands. There
291 	 * is no corresponding ->cqe_on(), instead ->cqe_request() is required
315 	 * (data->error or cmd->error for DCMD).  Requests that did not error
322  * struct mmc_slot - MMC slot functions
324  * @cd_irq:		MMC/SD-card slot hotplug detection IRQ or -EINVAL
325  * @handler_priv:	MMC/SD-card slot context
327  * Some MMC/SD host controllers implement slot-functions like card and
328  * write-protect detection natively. However, a large number of controllers
330  * such slot-function drivers.
342 	struct regulator *vmmc;		/* Card power supply */
361 	u32			ocr_avail_sdio;	/* SDIO-specific OCR */
362 	u32			ocr_avail_sd;	/* SD-specific OCR */
363 	u32			ocr_avail_mmc;	/* MMC-specific OCR */
369 #define MMC_VDD_165_195		0x00000080	/* VDD voltage 1.65 - 1.95 */
390 #define MMC_CAP_MMC_HIGHSPEED	(1 << 1)	/* Can do MMC high-speed timing */
391 #define MMC_CAP_SD_HIGHSPEED	(1 << 2)	/* Can do SD high-speed timing */
394 #define MMC_CAP_NEEDS_POLL	(1 << 5)	/* Needs polling for card-detection */
396 #define MMC_CAP_AGGRESSIVE_PM	(1 << 7)	/* Suspend (e)MMC/SD at idle  */
398 #define MMC_CAP_WAIT_WHILE_BUSY	(1 << 9)	/* Waits while card is busy */
420 #define MMC_CAP_CD_WAKE		(1 << 28)	/* Enable card detect wake */
423 #define MMC_CAP_HW_RESET	(1 << 31)	/* Reset the eMMC card via RST_n */
436 #define MMC_CAP2_SD_UHS2	(1 << 9)	/* SD UHS-II support */
437 #define MMC_CAP2_CD_ACTIVE_HIGH	(1 << 10)	/* Card-detect signal active high */
438 #define MMC_CAP2_RO_ACTIVE_HIGH	(1 << 11)	/* Write-protect signal active high */
447 …_WRITE_PROTECT (1 << 18)	/* No physical write protect pin, assume that card is always read-write */
451 #define MMC_CAP2_NO_MMC		(1 << 22)	/* Do not send (e)MMC commands during initialization */
461 #define MMC_CAP2_ALT_GPT_TEGRA	(1 << 28)	/* Host with eMMC that has GPT entry at a non-standard loc…
463 	bool			uhs2_sd_tran;	/* UHS-II flag for SD_TRAN state */
464 	bool			uhs2_app_cmd;	/* UHS-II flag for APP command */
465 	struct sd_uhs2_caps	uhs2_caps;	/* Host UHS-II capabilities */
467 	int			fixed_drv_type;	/* fixed driver type for non-removable media */
472 	unsigned int		max_seg_size;	/* lim->max_segment_size */
473 	unsigned short		max_segs;	/* lim->max_segments */
476 	unsigned int		max_blk_size;	/* maximum size of one mmc block */
489 	unsigned int		can_retune:1;	/* re-tuning can be used */
490 	unsigned int		doing_retune:1;	/* re-tuning in progress */
491 	unsigned int		retune_now:1;	/* do re-tuning at next req */
492 	unsigned int		retune_paused:1; /* re-tuning is temporarily disabled */
497 	int			rescan_disable;	/* disable card detection */
500 	int			need_retune;	/* re-tuning is needed */
501 	int			hold_retune;	/* hold off re-tuning */
502 	unsigned int		retune_period;	/* re-tuning period in secs */
503 	struct timer_list	retune_timer;	/* for periodic re-tuning */
507 	struct mmc_card		*card;		/* device attached to this host */  member
515 	int			detect_change;	/* card detect flag */
585 	return (void *)host->private;  in mmc_priv()
601 #define mmc_host_is_spi(host)	((host)->caps & MMC_CAP_SPI)
603 #define mmc_dev(x)	((x)->parent)
604 #define mmc_classdev(x)	(&(x)->class_dev)
605 #define mmc_hostname(x)	(dev_name(&(x)->class_dev))
619 	return host->sdio_irqs > 0;  in sdio_irq_claimed()
624 	host->ops->enable_sdio_irq(host, 0);  in mmc_signal_sdio_irq()
625 	host->sdio_irq_pending = true;  in mmc_signal_sdio_irq()
626 	if (host->sdio_irq_thread)  in mmc_signal_sdio_irq()
627 		wake_up_process(host->sdio_irq_thread);  in mmc_signal_sdio_irq()
633 int mmc_regulator_set_ocr(struct mmc_host *mmc,
636 int mmc_regulator_set_vqmmc(struct mmc_host *mmc, struct mmc_ios *ios);
637 int mmc_regulator_set_vqmmc2(struct mmc_host *mmc, struct mmc_ios *ios);
639 static inline int mmc_regulator_set_ocr(struct mmc_host *mmc,  in mmc_regulator_set_ocr()  argument
646 static inline int mmc_regulator_set_vqmmc(struct mmc_host *mmc,  in mmc_regulator_set_vqmmc()  argument
649 	return -EINVAL;  in mmc_regulator_set_vqmmc()
652 static inline int mmc_regulator_set_vqmmc2(struct mmc_host *mmc,  in mmc_regulator_set_vqmmc2()  argument
655 	return -EINVAL;  in mmc_regulator_set_vqmmc2()
659 int mmc_regulator_get_supply(struct mmc_host *mmc);
660 int mmc_regulator_enable_vqmmc(struct mmc_host *mmc);
661 void mmc_regulator_disable_vqmmc(struct mmc_host *mmc);
665 	return !(host->caps & MMC_CAP_NONREMOVABLE);  in mmc_card_is_removable()
670 	return host->pm_flags & MMC_PM_KEEP_POWER;  in mmc_card_keep_power()
675 	return host->pm_flags & MMC_PM_WAKE_SDIO_IRQ;  in mmc_card_wake_sdio_irq()
679 static inline int mmc_card_hs(struct mmc_card *card)  in mmc_card_hs()  argument
681 	return card->host->ios.timing == MMC_TIMING_SD_HS ||  in mmc_card_hs()
682 		card->host->ios.timing == MMC_TIMING_MMC_HS;  in mmc_card_hs()
686 static inline int mmc_card_uhs(struct mmc_card *card)  in mmc_card_uhs()  argument
688 	return card->host->ios.timing >= MMC_TIMING_UHS_SDR12 &&  in mmc_card_uhs()
689 		card->host->ios.timing <= MMC_TIMING_UHS_DDR50;  in mmc_card_uhs()
694 	return host->ios.timing == MMC_TIMING_UHS2_SPEED_A ||  in mmc_card_uhs2()
695 	       host->ios.timing == MMC_TIMING_UHS2_SPEED_A_HD ||  in mmc_card_uhs2()
696 	       host->ios.timing == MMC_TIMING_UHS2_SPEED_B ||  in mmc_card_uhs2()
697 	       host->ios.timing == MMC_TIMING_UHS2_SPEED_B_HD;  in mmc_card_uhs2()
704 	if (host->can_retune)  in mmc_retune_needed()
705 		host->need_retune = 1;  in mmc_retune_needed()
710 	return host->can_retune == 1;  in mmc_can_retune()
715 	return host->doing_retune == 1;  in mmc_doing_retune()
720 	return host->doing_retune == 1 || host->doing_init_tune == 1;  in mmc_doing_tune()
725 	return data->flags & MMC_DATA_WRITE ? DMA_TO_DEVICE : DMA_FROM_DEVICE;  in mmc_get_dma_dir()
731 	host->err_stats[stat] += 1;  in mmc_debugfs_err_stats_inc()
736 	return host->ios.timing == MMC_TIMING_UHS2_SPEED_A_HD ||  in mmc_card_uhs2_hd_mode()
737 	       host->ios.timing == MMC_TIMING_UHS2_SPEED_B_HD;  in mmc_card_uhs2_hd_mode()
740 int mmc_sd_switch(struct mmc_card *card, bool mode, int group,
742 int mmc_send_status(struct mmc_card *card, u32 *status);
745 int mmc_get_ext_csd(struct mmc_card *card, u8 **new_ext_csd);