[deliverable/linux.git] / include / linux / mmc / host.h

/*
 *  linux/include/linux/mmc/host.h
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 *
 *  Host driver specific definitions.
 */
#ifndef LINUX_MMC_HOST_H
#define LINUX_MMC_HOST_H

#include <linux/leds.h>
#include <linux/sched.h>
#include <linux/device.h>
#include <linux/fault-inject.h>

#include <linux/mmc/core.h>
#include <linux/mmc/pm.h>

struct mmc_ios {
	unsigned int	clock;			/* clock rate */
	unsigned short	vdd;

/* vdd stores the bit number of the selected voltage range from below. */

	unsigned char	bus_mode;		/* command output mode */

#define MMC_BUSMODE_OPENDRAIN	1
#define MMC_BUSMODE_PUSHPULL	2

	unsigned char	chip_select;		/* SPI chip select */

#define MMC_CS_DONTCARE		0
#define MMC_CS_HIGH		1
#define MMC_CS_LOW		2

	unsigned char	power_mode;		/* power supply mode */

#define MMC_POWER_OFF		0
#define MMC_POWER_UP		1
#define MMC_POWER_ON		2

	unsigned char	bus_width;		/* data bus width */

#define MMC_BUS_WIDTH_1		0
#define MMC_BUS_WIDTH_4		2
#define MMC_BUS_WIDTH_8		3

	unsigned char	timing;			/* timing specification used */

#define MMC_TIMING_LEGACY	0
#define MMC_TIMING_MMC_HS	1
#define MMC_TIMING_SD_HS	2
#define MMC_TIMING_UHS_SDR12	MMC_TIMING_LEGACY
#define MMC_TIMING_UHS_SDR25	MMC_TIMING_SD_HS
#define MMC_TIMING_UHS_SDR50	3
#define MMC_TIMING_UHS_SDR104	4
#define MMC_TIMING_UHS_DDR50	5
#define MMC_TIMING_MMC_HS200	6

#define MMC_SDR_MODE		0
#define MMC_1_2V_DDR_MODE	1
#define MMC_1_8V_DDR_MODE	2
#define MMC_1_2V_SDR_MODE	3
#define MMC_1_8V_SDR_MODE	4

	unsigned char	signal_voltage;		/* signalling voltage (1.8V or 3.3V) */

#define MMC_SIGNAL_VOLTAGE_330	0
#define MMC_SIGNAL_VOLTAGE_180	1
#define MMC_SIGNAL_VOLTAGE_120	2

	unsigned char	drv_type;		/* driver type (A, B, C, D) */

#define MMC_SET_DRIVER_TYPE_B	0
#define MMC_SET_DRIVER_TYPE_A	1
#define MMC_SET_DRIVER_TYPE_C	2
#define MMC_SET_DRIVER_TYPE_D	3
};

struct mmc_host_ops {
	/*
	 * Hosts that support power saving can use the 'enable' and 'disable'
	 * methods to exit and enter power saving states. 'enable' is called
	 * when the host is claimed and 'disable' is called (or scheduled with
	 * a delay) when the host is released. The 'disable' is scheduled if
	 * the disable delay set by 'mmc_set_disable_delay()' is non-zero,
	 * otherwise 'disable' is called immediately. 'disable' may be
	 * scheduled repeatedly, to permit ever greater power saving at the
	 * expense of ever greater latency to re-enable. Rescheduling is
	 * determined by the return value of the 'disable' method. A positive
	 * value gives the delay in milliseconds.
	 *
	 * In the case where a host function (like set_ios) may be called
	 * with or without the host claimed, enabling and disabling can be
	 * done directly and will nest correctly. Call 'mmc_host_enable()' and
	 * 'mmc_host_lazy_disable()' for this purpose, but note that these
	 * functions must be paired.
	 *
	 * Alternatively, 'mmc_host_enable()' may be paired with
	 * 'mmc_host_disable()' which calls 'disable' immediately.  In this
	 * case the 'disable' method will be called with 'lazy' set to 0.
	 * This is mainly useful for error paths.
	 *
	 * Because lazy disable may be called from a work queue, the 'disable'
	 * method must claim the host when 'lazy' != 0, which will work
	 * correctly because recursion is detected and handled.
	 */
	int (*enable)(struct mmc_host *host);
	int (*disable)(struct mmc_host *host, int lazy);
	/*
	 * It is optional for the host to implement pre_req and post_req in
	 * order to support double buffering of requests (prepare one
	 * request while another request is active).
	 * pre_req() must always be followed by a post_req().
	 * To undo a call made to pre_req(), call post_req() with
	 * a nonzero err condition.
	 */
	void	(*post_req)(struct mmc_host *host, struct mmc_request *req,
			    int err);
	void	(*pre_req)(struct mmc_host *host, struct mmc_request *req,
			   bool is_first_req);
	void	(*request)(struct mmc_host *host, struct mmc_request *req);
	/*
	 * Avoid calling these three functions too often or in a "fast path",
	 * since underlaying controller might implement them in an expensive
	 * and/or slow way.
	 *
	 * Also note that these functions might sleep, so don't call them
	 * in the atomic contexts!
	 *
	 * Return values for the get_ro callback should be:
	 *   0 for a read/write card
	 *   1 for a read-only card
	 *   -ENOSYS when not supported (equal to NULL callback)
	 *   or a negative errno value when something bad happened
	 *
	 * Return values for the get_cd callback should be:
	 *   0 for a absent card
	 *   1 for a present card
	 *   -ENOSYS when not supported (equal to NULL callback)
	 *   or a negative errno value when something bad happened
	 */
	void	(*set_ios)(struct mmc_host *host, struct mmc_ios *ios);
	int	(*get_ro)(struct mmc_host *host);
	int	(*get_cd)(struct mmc_host *host);

	void	(*enable_sdio_irq)(struct mmc_host *host, int enable);

	/* optional callback for HC quirks */
	void	(*init_card)(struct mmc_host *host, struct mmc_card *card);

	int	(*start_signal_voltage_switch)(struct mmc_host *host, struct mmc_ios *ios);

	/* The tuning command opcode value is different for SD and eMMC cards */
	int	(*execute_tuning)(struct mmc_host *host, u32 opcode);
	void	(*enable_preset_value)(struct mmc_host *host, bool enable);
	int	(*select_drive_strength)(unsigned int max_dtr, int host_drv, int card_drv);
	void	(*hw_reset)(struct mmc_host *host);
};

struct mmc_card;
struct device;

struct mmc_async_req {
	/* active mmc request */
	struct mmc_request	*mrq;
	/*
	 * Check error status of completed mmc request.
	 * Returns 0 if success otherwise non zero.
	 */
	int (*err_check) (struct mmc_card *, struct mmc_async_req *);
};

struct mmc_hotplug {
	unsigned int irq;
	void *handler_priv;
};

struct mmc_host {
	struct device		*parent;
	struct device		class_dev;
	int			index;
	const struct mmc_host_ops *ops;
	unsigned int		f_min;
	unsigned int		f_max;
	unsigned int		f_init;
	u32			ocr_avail;
	u32			ocr_avail_sdio;	/* SDIO-specific OCR */
	u32			ocr_avail_sd;	/* SD-specific OCR */
	u32			ocr_avail_mmc;	/* MMC-specific OCR */
	struct notifier_block	pm_notify;

#define MMC_VDD_165_195		0x00000080	/* VDD voltage 1.65 - 1.95 */
#define MMC_VDD_20_21		0x00000100	/* VDD voltage 2.0 ~ 2.1 */
#define MMC_VDD_21_22		0x00000200	/* VDD voltage 2.1 ~ 2.2 */
#define MMC_VDD_22_23		0x00000400	/* VDD voltage 2.2 ~ 2.3 */
#define MMC_VDD_23_24		0x00000800	/* VDD voltage 2.3 ~ 2.4 */
#define MMC_VDD_24_25		0x00001000	/* VDD voltage 2.4 ~ 2.5 */
#define MMC_VDD_25_26		0x00002000	/* VDD voltage 2.5 ~ 2.6 */
#define MMC_VDD_26_27		0x00004000	/* VDD voltage 2.6 ~ 2.7 */
#define MMC_VDD_27_28		0x00008000	/* VDD voltage 2.7 ~ 2.8 */
#define MMC_VDD_28_29		0x00010000	/* VDD voltage 2.8 ~ 2.9 */
#define MMC_VDD_29_30		0x00020000	/* VDD voltage 2.9 ~ 3.0 */
#define MMC_VDD_30_31		0x00040000	/* VDD voltage 3.0 ~ 3.1 */
#define MMC_VDD_31_32		0x00080000	/* VDD voltage 3.1 ~ 3.2 */
#define MMC_VDD_32_33		0x00100000	/* VDD voltage 3.2 ~ 3.3 */
#define MMC_VDD_33_34		0x00200000	/* VDD voltage 3.3 ~ 3.4 */
#define MMC_VDD_34_35		0x00400000	/* VDD voltage 3.4 ~ 3.5 */
#define MMC_VDD_35_36		0x00800000	/* VDD voltage 3.5 ~ 3.6 */

	unsigned long		caps;		/* Host capabilities */

#define MMC_CAP_4_BIT_DATA	(1 << 0)	/* Can the host do 4 bit transfers */
#define MMC_CAP_MMC_HIGHSPEED	(1 << 1)	/* Can do MMC high-speed timing */
#define MMC_CAP_SD_HIGHSPEED	(1 << 2)	/* Can do SD high-speed timing */
#define MMC_CAP_SDIO_IRQ	(1 << 3)	/* Can signal pending SDIO IRQs */
#define MMC_CAP_SPI		(1 << 4)	/* Talks only SPI protocols */
#define MMC_CAP_NEEDS_POLL	(1 << 5)	/* Needs polling for card-detection */
#define MMC_CAP_8_BIT_DATA	(1 << 6)	/* Can the host do 8 bit transfers */
#define MMC_CAP_DISABLE		(1 << 7)	/* Can the host be disabled */
#define MMC_CAP_NONREMOVABLE	(1 << 8)	/* Nonremovable e.g. eMMC */
#define MMC_CAP_WAIT_WHILE_BUSY	(1 << 9)	/* Waits while card is busy */
#define MMC_CAP_ERASE		(1 << 10)	/* Allow erase/trim commands */
#define MMC_CAP_1_8V_DDR	(1 << 11)	/* can support */
						/* DDR mode at 1.8V */
#define MMC_CAP_1_2V_DDR	(1 << 12)	/* can support */
						/* DDR mode at 1.2V */
#define MMC_CAP_POWER_OFF_CARD	(1 << 13)	/* Can power off after boot */
#define MMC_CAP_BUS_WIDTH_TEST	(1 << 14)	/* CMD14/CMD19 bus width ok */
#define MMC_CAP_UHS_SDR12	(1 << 15)	/* Host supports UHS SDR12 mode */
#define MMC_CAP_UHS_SDR25	(1 << 16)	/* Host supports UHS SDR25 mode */
#define MMC_CAP_UHS_SDR50	(1 << 17)	/* Host supports UHS SDR50 mode */
#define MMC_CAP_UHS_SDR104	(1 << 18)	/* Host supports UHS SDR104 mode */
#define MMC_CAP_UHS_DDR50	(1 << 19)	/* Host supports UHS DDR50 mode */
#define MMC_CAP_SET_XPC_330	(1 << 20)	/* Host supports >150mA current at 3.3V */
#define MMC_CAP_SET_XPC_300	(1 << 21)	/* Host supports >150mA current at 3.0V */
#define MMC_CAP_SET_XPC_180	(1 << 22)	/* Host supports >150mA current at 1.8V */
#define MMC_CAP_DRIVER_TYPE_A	(1 << 23)	/* Host supports Driver Type A */
#define MMC_CAP_DRIVER_TYPE_C	(1 << 24)	/* Host supports Driver Type C */
#define MMC_CAP_DRIVER_TYPE_D	(1 << 25)	/* Host supports Driver Type D */
#define MMC_CAP_MAX_CURRENT_200	(1 << 26)	/* Host max current limit is 200mA */
#define MMC_CAP_MAX_CURRENT_400	(1 << 27)	/* Host max current limit is 400mA */
#define MMC_CAP_MAX_CURRENT_600	(1 << 28)	/* Host max current limit is 600mA */
#define MMC_CAP_MAX_CURRENT_800	(1 << 29)	/* Host max current limit is 800mA */
#define MMC_CAP_CMD23		(1 << 30)	/* CMD23 supported. */
#define MMC_CAP_HW_RESET	(1 << 31)	/* Hardware reset */

	unsigned int		caps2;		/* More host capabilities */

#define MMC_CAP2_BOOTPART_NOACC	(1 << 0)	/* Boot partition no access */
#define MMC_CAP2_CACHE_CTRL	(1 << 1)	/* Allow cache control */
#define MMC_CAP2_POWEROFF_NOTIFY (1 << 2)	/* Notify poweroff supported */
#define MMC_CAP2_NO_MULTI_READ	(1 << 3)	/* Multiblock reads don't work */
#define MMC_CAP2_NO_SLEEP_CMD	(1 << 4)	/* Don't allow sleep command */
#define MMC_CAP2_HS200_1_8V_SDR	(1 << 5)        /* can support */
#define MMC_CAP2_HS200_1_2V_SDR	(1 << 6)        /* can support */
#define MMC_CAP2_HS200		(MMC_CAP2_HS200_1_8V_SDR | \
				 MMC_CAP2_HS200_1_2V_SDR)

	mmc_pm_flag_t		pm_caps;	/* supported pm features */
	unsigned int        power_notify_type;
#define MMC_HOST_PW_NOTIFY_NONE		0
#define MMC_HOST_PW_NOTIFY_SHORT	1
#define MMC_HOST_PW_NOTIFY_LONG		2

#ifdef CONFIG_MMC_CLKGATE
	int			clk_requests;	/* internal reference counter */
	unsigned int		clk_delay;	/* number of MCI clk hold cycles */
	bool			clk_gated;	/* clock gated */
	struct delayed_work	clk_gate_work; /* delayed clock gate */
	unsigned int		clk_old;	/* old clock value cache */
	spinlock_t		clk_lock;	/* lock for clk fields */
	struct mutex		clk_gate_mutex;	/* mutex for clock gating */
	struct device_attribute clkgate_delay_attr;
	unsigned long           clkgate_delay;
#endif

	/* host specific block data */
	unsigned int		max_seg_size;	/* see blk_queue_max_segment_size */
	unsigned short		max_segs;	/* see blk_queue_max_segments */
	unsigned short		unused;
	unsigned int		max_req_size;	/* maximum number of bytes in one req */
	unsigned int		max_blk_size;	/* maximum size of one mmc block */
	unsigned int		max_blk_count;	/* maximum number of blocks in one req */
	unsigned int		max_discard_to;	/* max. discard timeout in ms */

	/* private data */
	spinlock_t		lock;		/* lock for claim and bus ops */

	struct mmc_ios		ios;		/* current io bus settings */
	u32			ocr;		/* the current OCR setting */

	/* group bitfields together to minimize padding */
	unsigned int		use_spi_crc:1;
	unsigned int		claimed:1;	/* host exclusively claimed */
	unsigned int		bus_dead:1;	/* bus has been released */
#ifdef CONFIG_MMC_DEBUG
	unsigned int		removed:1;	/* host is being removed */
#endif

	/* Only used with MMC_CAP_DISABLE */
	int			enabled;	/* host is enabled */
	int			rescan_disable;	/* disable card detection */
	int			nesting_cnt;	/* "enable" nesting count */
	int			en_dis_recurs;	/* detect recursion */
	unsigned int		disable_delay;	/* disable delay in msecs */
	struct delayed_work	disable;	/* disabling work */

	struct mmc_card		*card;		/* device attached to this host */

	wait_queue_head_t	wq;
	struct task_struct	*claimer;	/* task that has host claimed */
	int			claim_cnt;	/* "claim" nesting count */

	struct delayed_work	detect;
	int			detect_change;	/* card detect flag */
	struct mmc_hotplug	hotplug;

	const struct mmc_bus_ops *bus_ops;	/* current bus driver */
	unsigned int		bus_refs;	/* reference counter */

	unsigned int		sdio_irqs;
	struct task_struct	*sdio_irq_thread;
	atomic_t		sdio_irq_thread_abort;

	mmc_pm_flag_t		pm_flags;	/* requested pm features */

#ifdef CONFIG_LEDS_TRIGGERS
	struct led_trigger	*led;		/* activity led */
#endif

#ifdef CONFIG_REGULATOR
	bool			regulator_enabled; /* regulator state */
#endif

	struct dentry		*debugfs_root;

	struct mmc_async_req	*areq;		/* active async req */

#ifdef CONFIG_FAIL_MMC_REQUEST
	struct fault_attr	fail_mmc_request;
#endif

	unsigned int		actual_clock;	/* Actual HC clock rate */

	unsigned long		private[0] ____cacheline_aligned;
};

extern struct mmc_host *mmc_alloc_host(int extra, struct device *);
extern int mmc_add_host(struct mmc_host *);
extern void mmc_remove_host(struct mmc_host *);
extern void mmc_free_host(struct mmc_host *);

static inline void *mmc_priv(struct mmc_host *host)
{
	return (void *)host->private;
}

#define mmc_host_is_spi(host)	((host)->caps & MMC_CAP_SPI)

#define mmc_dev(x)	((x)->parent)
#define mmc_classdev(x)	(&(x)->class_dev)
#define mmc_hostname(x)	(dev_name(&(x)->class_dev))

extern int mmc_suspend_host(struct mmc_host *);
extern int mmc_resume_host(struct mmc_host *);

extern int mmc_power_save_host(struct mmc_host *host);
extern int mmc_power_restore_host(struct mmc_host *host);

extern void mmc_detect_change(struct mmc_host *, unsigned long delay);
extern void mmc_request_done(struct mmc_host *, struct mmc_request *);

extern int mmc_cache_ctrl(struct mmc_host *, u8);

static inline void mmc_signal_sdio_irq(struct mmc_host *host)
{
	host->ops->enable_sdio_irq(host, 0);
	wake_up_process(host->sdio_irq_thread);
}

struct regulator;

#ifdef CONFIG_REGULATOR
int mmc_regulator_get_ocrmask(struct regulator *supply);
int mmc_regulator_set_ocr(struct mmc_host *mmc,
			struct regulator *supply,
			unsigned short vdd_bit);
#else
static inline int mmc_regulator_get_ocrmask(struct regulator *supply)
{
	return 0;
}

static inline int mmc_regulator_set_ocr(struct mmc_host *mmc,
				 struct regulator *supply,
				 unsigned short vdd_bit)
{
	return 0;
}
#endif

int mmc_card_awake(struct mmc_host *host);
int mmc_card_sleep(struct mmc_host *host);
int mmc_card_can_sleep(struct mmc_host *host);

int mmc_host_enable(struct mmc_host *host);
int mmc_host_disable(struct mmc_host *host);
int mmc_host_lazy_disable(struct mmc_host *host);
int mmc_pm_notify(struct notifier_block *notify_block, unsigned long, void *);

static inline void mmc_set_disable_delay(struct mmc_host *host,
					 unsigned int disable_delay)
{
	host->disable_delay = disable_delay;
}

/* Module parameter */
extern bool mmc_assume_removable;

static inline int mmc_card_is_removable(struct mmc_host *host)
{
	return !(host->caps & MMC_CAP_NONREMOVABLE) && mmc_assume_removable;
}

static inline int mmc_card_keep_power(struct mmc_host *host)
{
	return host->pm_flags & MMC_PM_KEEP_POWER;
}

static inline int mmc_card_wake_sdio_irq(struct mmc_host *host)
{
	return host->pm_flags & MMC_PM_WAKE_SDIO_IRQ;
}

static inline int mmc_host_cmd23(struct mmc_host *host)
{
	return host->caps & MMC_CAP_CMD23;
}

static inline int mmc_boot_partition_access(struct mmc_host *host)
{
	return !(host->caps2 & MMC_CAP2_BOOTPART_NOACC);
}

#endif /* LINUX_MMC_HOST_H */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* linux/include/linux/mmc/host.h
	3	*
	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.
	7	*
	8	* Host driver specific definitions.
	9	*/
	10	#ifndef LINUX_MMC_HOST_H
	11	#define LINUX_MMC_HOST_H
	12
af8350c7	13	#include <linux/leds.h>
d43c36dc	14	#include <linux/sched.h>
313162d0	15	#include <linux/device.h>
1b676f70	16	#include <linux/fault-inject.h>
af8350c7	17
aaac1b47	18	#include <linux/mmc/core.h>
da68c4eb	19	#include <linux/mmc/pm.h>
1da177e4 LT	20
	21	struct mmc_ios {
	22	unsigned int clock; /* clock rate */
	23	unsigned short vdd;
	24
4be34c99	25	/* vdd stores the bit number of the selected voltage range from below. */
1da177e4 LT	26
	27	unsigned char bus_mode; /* command output mode */
	28
	29	#define MMC_BUSMODE_OPENDRAIN 1
	30	#define MMC_BUSMODE_PUSHPULL 2
	31
865e9f13 PO	32	unsigned char chip_select; /* SPI chip select */
	33
	34	#define MMC_CS_DONTCARE 0
	35	#define MMC_CS_HIGH 1
	36	#define MMC_CS_LOW 2
	37
1da177e4 LT	38	unsigned char power_mode; /* power supply mode */
	39
	40	#define MMC_POWER_OFF 0
	41	#define MMC_POWER_UP 1
	42	#define MMC_POWER_ON 2
f218278a PO	43
	44	unsigned char bus_width; /* data bus width */
	45
	46	#define MMC_BUS_WIDTH_1 0
	47	#define MMC_BUS_WIDTH_4 2
b30f8af3	48	#define MMC_BUS_WIDTH_8 3
cd9277c0 PO	49
	50	unsigned char timing; /* timing specification used */
	51
	52	#define MMC_TIMING_LEGACY 0
	53	#define MMC_TIMING_MMC_HS 1
	54	#define MMC_TIMING_SD_HS 2
49c468fc AN	55	#define MMC_TIMING_UHS_SDR12 MMC_TIMING_LEGACY
	56	#define MMC_TIMING_UHS_SDR25 MMC_TIMING_SD_HS
	57	#define MMC_TIMING_UHS_SDR50 3
	58	#define MMC_TIMING_UHS_SDR104 4
	59	#define MMC_TIMING_UHS_DDR50 5
a4924c71	60	#define MMC_TIMING_MMC_HS200 6
0f8d8ea6	61
0f8d8ea6	62	#define MMC_SDR_MODE 0
49e3b5a4 AH	63	#define MMC_1_2V_DDR_MODE 1
49e3b5a4 AH	64	#define MMC_1_8V_DDR_MODE 2
a4924c71 G	65	#define MMC_1_2V_SDR_MODE 3
a4924c71 G	66	#define MMC_1_8V_SDR_MODE 4
f2119df6 AN	67
	68	unsigned char signal_voltage; /* signalling voltage (1.8V or 3.3V) */
	69
	70	#define MMC_SIGNAL_VOLTAGE_330 0
	71	#define MMC_SIGNAL_VOLTAGE_180 1
4c4cb171	72	#define MMC_SIGNAL_VOLTAGE_120 2
d6d50a15 AN	73
	74	unsigned char drv_type; /* driver type (A, B, C, D) */
	75
	76	#define MMC_SET_DRIVER_TYPE_B 0
	77	#define MMC_SET_DRIVER_TYPE_A 1
	78	#define MMC_SET_DRIVER_TYPE_C 2
	79	#define MMC_SET_DRIVER_TYPE_D 3
1da177e4 LT	80	};
	81
	82	struct mmc_host_ops {
8ea926b2 AH	83	/*
	84	* Hosts that support power saving can use the 'enable' and 'disable'
	85	* methods to exit and enter power saving states. 'enable' is called
	86	* when the host is claimed and 'disable' is called (or scheduled with
	87	* a delay) when the host is released. The 'disable' is scheduled if
	88	* the disable delay set by 'mmc_set_disable_delay()' is non-zero,
	89	* otherwise 'disable' is called immediately. 'disable' may be
	90	* scheduled repeatedly, to permit ever greater power saving at the
	91	* expense of ever greater latency to re-enable. Rescheduling is
	92	* determined by the return value of the 'disable' method. A positive
	93	* value gives the delay in milliseconds.
	94	*
	95	* In the case where a host function (like set_ios) may be called
	96	* with or without the host claimed, enabling and disabling can be
	97	* done directly and will nest correctly. Call 'mmc_host_enable()' and
	98	* 'mmc_host_lazy_disable()' for this purpose, but note that these
	99	* functions must be paired.
	100	*
	101	* Alternatively, 'mmc_host_enable()' may be paired with
	102	* 'mmc_host_disable()' which calls 'disable' immediately. In this
	103	* case the 'disable' method will be called with 'lazy' set to 0.
	104	* This is mainly useful for error paths.
	105	*
	106	* Because lazy disable may be called from a work queue, the 'disable'
	107	* method must claim the host when 'lazy' != 0, which will work
	108	* correctly because recursion is detected and handled.
	109	*/
	110	int (enable)(struct mmc_host host);
	111	int (disable)(struct mmc_host host, int lazy);
aa8b683a PF	112	/*
	113	* It is optional for the host to implement pre_req and post_req in
	114	* order to support double buffering of requests (prepare one
	115	* request while another request is active).
7c8a2829 PF	116	* pre_req() must always be followed by a post_req().
	117	* To undo a call made to pre_req(), call post_req() with
	118	* a nonzero err condition.
aa8b683a PF	119	*/
	120	void (post_req)(struct mmc_host host, struct mmc_request *req,
	121	int err);
	122	void (pre_req)(struct mmc_host host, struct mmc_request *req,
	123	bool is_first_req);
1da177e4	124	void (request)(struct mmc_host host, struct mmc_request *req);
28f52482 AV	125	/*
	126	* Avoid calling these three functions too often or in a "fast path",
	127	* since underlaying controller might implement them in an expensive
	128	* and/or slow way.
	129	*
	130	* Also note that these functions might sleep, so don't call them
	131	* in the atomic contexts!
08f80bb5 AV	132	*
	133	* Return values for the get_ro callback should be:
	134	* 0 for a read/write card
	135	* 1 for a read-only card
	136	* -ENOSYS when not supported (equal to NULL callback)
	137	* or a negative errno value when something bad happened
	138	*
ee63a7d2	139	* Return values for the get_cd callback should be:
08f80bb5 AV	140	* 0 for a absent card
	141	* 1 for a present card
	142	* -ENOSYS when not supported (equal to NULL callback)
	143	* or a negative errno value when something bad happened
28f52482	144	*/
1da177e4	145	void (set_ios)(struct mmc_host host, struct mmc_ios *ios);
a00fc090	146	int (get_ro)(struct mmc_host host);
28f52482 AV	147	int (get_cd)(struct mmc_host host);
28f52482 AV	148
17b759af	149	void (enable_sdio_irq)(struct mmc_host host, int enable);
3fcb027d DM	150
	151	/* optional callback for HC quirks */
	152	void (init_card)(struct mmc_host host, struct mmc_card *card);
f2119df6 AN	153
f2119df6 AN	154	int (start_signal_voltage_switch)(struct mmc_host host, struct mmc_ios *ios);
a4924c71 G	155
	156	/* The tuning command opcode value is different for SD and eMMC cards */
	157	int (execute_tuning)(struct mmc_host host, u32 opcode);
4d55c5a1	158	void (enable_preset_value)(struct mmc_host host, bool enable);
ca8e99b3	159	int (*select_drive_strength)(unsigned int max_dtr, int host_drv, int card_drv);
b2499518	160	void (hw_reset)(struct mmc_host host);
1da177e4 LT	161	};
	162
	163	struct mmc_card;
	164	struct device;
	165
aa8b683a PF	166	struct mmc_async_req {
	167	/* active mmc request */
	168	struct mmc_request *mrq;
	169	/*
	170	* Check error status of completed mmc request.
	171	* Returns 0 if success otherwise non zero.
	172	*/
	173	int (err_check) (struct mmc_card , struct mmc_async_req *);
	174	};
	175
b67e1980 GL	176	struct mmc_hotplug {
	177	unsigned int irq;
	178	void *handler_priv;
	179	};
	180
1da177e4	181	struct mmc_host {
fcaf71fd GKH	182	struct device *parent;
fcaf71fd GKH	183	struct device class_dev;
dce77377	184	int index;
f57b225e	185	const struct mmc_host_ops *ops;
1da177e4 LT	186	unsigned int f_min;
1da177e4 LT	187	unsigned int f_max;
88ae8b86	188	unsigned int f_init;
1da177e4	189	u32 ocr_avail;
8f230f45 TI	190	u32 ocr_avail_sdio; /* SDIO-specific OCR */
	191	u32 ocr_avail_sd; /* SD-specific OCR */
	192	u32 ocr_avail_mmc; /* MMC-specific OCR */
4c2ef25f	193	struct notifier_block pm_notify;
1da177e4	194
55556da0	195	#define MMC_VDD_165_195 0x00000080 /* VDD voltage 1.65 - 1.95 */
f74d132c PO	196	#define MMC_VDD_20_21 0x00000100 /* VDD voltage 2.0 ~ 2.1 */
	197	#define MMC_VDD_21_22 0x00000200 /* VDD voltage 2.1 ~ 2.2 */
	198	#define MMC_VDD_22_23 0x00000400 /* VDD voltage 2.2 ~ 2.3 */
	199	#define MMC_VDD_23_24 0x00000800 /* VDD voltage 2.3 ~ 2.4 */
	200	#define MMC_VDD_24_25 0x00001000 /* VDD voltage 2.4 ~ 2.5 */
	201	#define MMC_VDD_25_26 0x00002000 /* VDD voltage 2.5 ~ 2.6 */
	202	#define MMC_VDD_26_27 0x00004000 /* VDD voltage 2.6 ~ 2.7 */
	203	#define MMC_VDD_27_28 0x00008000 /* VDD voltage 2.7 ~ 2.8 */
	204	#define MMC_VDD_28_29 0x00010000 /* VDD voltage 2.8 ~ 2.9 */
	205	#define MMC_VDD_29_30 0x00020000 /* VDD voltage 2.9 ~ 3.0 */
	206	#define MMC_VDD_30_31 0x00040000 /* VDD voltage 3.0 ~ 3.1 */
	207	#define MMC_VDD_31_32 0x00080000 /* VDD voltage 3.1 ~ 3.2 */
	208	#define MMC_VDD_32_33 0x00100000 /* VDD voltage 3.2 ~ 3.3 */
	209	#define MMC_VDD_33_34 0x00200000 /* VDD voltage 3.3 ~ 3.4 */
	210	#define MMC_VDD_34_35 0x00400000 /* VDD voltage 3.4 ~ 3.5 */
	211	#define MMC_VDD_35_36 0x00800000 /* VDD voltage 3.5 ~ 3.6 */
	212
f218278a PO	213	unsigned long caps; /* Host capabilities */
	214
	215	#define MMC_CAP_4_BIT_DATA (1 << 0) /* Can the host do 4 bit transfers */
23af6039 PO	216	#define MMC_CAP_MMC_HIGHSPEED (1 << 1) /* Can do MMC high-speed timing */
	217	#define MMC_CAP_SD_HIGHSPEED (1 << 2) /* Can do SD high-speed timing */
	218	#define MMC_CAP_SDIO_IRQ (1 << 3) /* Can signal pending SDIO IRQs */
	219	#define MMC_CAP_SPI (1 << 4) /* Talks only SPI protocols */
	220	#define MMC_CAP_NEEDS_POLL (1 << 5) /* Needs polling for card-detection */
b30f8af3	221	#define MMC_CAP_8_BIT_DATA (1 << 6) /* Can the host do 8 bit transfers */
8ea926b2	222	#define MMC_CAP_DISABLE (1 << 7) /* Can the host be disabled */
9feae246	223	#define MMC_CAP_NONREMOVABLE (1 << 8) /* Nonremovable e.g. eMMC */
b1ebe384	224	#define MMC_CAP_WAIT_WHILE_BUSY (1 << 9) /* Waits while card is busy */
dfe86cba	225	#define MMC_CAP_ERASE (1 << 10) /* Allow erase/trim commands */
dfc13e84 HP	226	#define MMC_CAP_1_8V_DDR (1 << 11) /* can support */
	227	/* DDR mode at 1.8V */
	228	#define MMC_CAP_1_2V_DDR (1 << 12) /* can support */
	229	/* DDR mode at 1.2V */
ed919b01	230	#define MMC_CAP_POWER_OFF_CARD (1 << 13) /* Can power off after boot */
22113efd	231	#define MMC_CAP_BUS_WIDTH_TEST (1 << 14) /* CMD14/CMD19 bus width ok */
f2119df6 AN	232	#define MMC_CAP_UHS_SDR12 (1 << 15) /* Host supports UHS SDR12 mode */
	233	#define MMC_CAP_UHS_SDR25 (1 << 16) /* Host supports UHS SDR25 mode */
	234	#define MMC_CAP_UHS_SDR50 (1 << 17) /* Host supports UHS SDR50 mode */
	235	#define MMC_CAP_UHS_SDR104 (1 << 18) /* Host supports UHS SDR104 mode */
	236	#define MMC_CAP_UHS_DDR50 (1 << 19) /* Host supports UHS DDR50 mode */
	237	#define MMC_CAP_SET_XPC_330 (1 << 20) /* Host supports >150mA current at 3.3V */
	238	#define MMC_CAP_SET_XPC_300 (1 << 21) /* Host supports >150mA current at 3.0V */
	239	#define MMC_CAP_SET_XPC_180 (1 << 22) /* Host supports >150mA current at 1.8V */
d6d50a15 AN	240	#define MMC_CAP_DRIVER_TYPE_A (1 << 23) /* Host supports Driver Type A */
	241	#define MMC_CAP_DRIVER_TYPE_C (1 << 24) /* Host supports Driver Type C */
	242	#define MMC_CAP_DRIVER_TYPE_D (1 << 25) /* Host supports Driver Type D */
5371c927 AN	243	#define MMC_CAP_MAX_CURRENT_200 (1 << 26) /* Host max current limit is 200mA */
	244	#define MMC_CAP_MAX_CURRENT_400 (1 << 27) /* Host max current limit is 400mA */
	245	#define MMC_CAP_MAX_CURRENT_600 (1 << 28) /* Host max current limit is 600mA */
	246	#define MMC_CAP_MAX_CURRENT_800 (1 << 29) /* Host max current limit is 800mA */
d0c97cfb	247	#define MMC_CAP_CMD23 (1 << 30) /* CMD23 supported. */
b2499518	248	#define MMC_CAP_HW_RESET (1 << 31) /* Hardware reset */
f218278a	249
f7c56ef2 AH	250	unsigned int caps2; /* More host capabilities */
	251
	252	#define MMC_CAP2_BOOTPART_NOACC (1 << 0) /* Boot partition no access */
881d1c25	253	#define MMC_CAP2_CACHE_CTRL (1 << 1) /* Allow cache control */
bec8726a	254	#define MMC_CAP2_POWEROFF_NOTIFY (1 << 2) /* Notify poweroff supported */
2bf22b39	255	#define MMC_CAP2_NO_MULTI_READ (1 << 3) /* Multiblock reads don't work */
aa9df4fb	256	#define MMC_CAP2_NO_SLEEP_CMD (1 << 4) /* Don't allow sleep command */
a4924c71 G	257	#define MMC_CAP2_HS200_1_8V_SDR (1 << 5) /* can support */
	258	#define MMC_CAP2_HS200_1_2V_SDR (1 << 6) /* can support */
	259	#define MMC_CAP2_HS200 (MMC_CAP2_HS200_1_8V_SDR \| \
	260	MMC_CAP2_HS200_1_2V_SDR)
f7c56ef2	261
da68c4eb	262	mmc_pm_flag_t pm_caps; /* supported pm features */
bec8726a G	263	unsigned int power_notify_type;
	264	#define MMC_HOST_PW_NOTIFY_NONE 0
	265	#define MMC_HOST_PW_NOTIFY_SHORT 1
	266	#define MMC_HOST_PW_NOTIFY_LONG 2
da68c4eb	267
04566831 LW	268	#ifdef CONFIG_MMC_CLKGATE
	269	int clk_requests; /* internal reference counter */
	270	unsigned int clk_delay; /* number of MCI clk hold cycles */
	271	bool clk_gated; /* clock gated */
597dd9d7	272	struct delayed_work clk_gate_work; /* delayed clock gate */
04566831 LW	273	unsigned int clk_old; /* old clock value cache */
04566831 LW	274	spinlock_t clk_lock; /* lock for clk fields */
86f315bb	275	struct mutex clk_gate_mutex; /* mutex for clock gating */
597dd9d7 SRT	276	struct device_attribute clkgate_delay_attr;
597dd9d7 SRT	277	unsigned long clkgate_delay;
04566831 LW	278	#endif
04566831 LW	279
1da177e4 LT	280	/* host specific block data */
1da177e4 LT	281	unsigned int max_seg_size; /* see blk_queue_max_segment_size */
a36274e0	282	unsigned short max_segs; /* see blk_queue_max_segments */
1da177e4	283	unsigned short unused;
55db890a	284	unsigned int max_req_size; /* maximum number of bytes in one req */
fe4a3c7a	285	unsigned int max_blk_size; /* maximum size of one mmc block */
55db890a	286	unsigned int max_blk_count; /* maximum number of blocks in one req */
e056a1b5	287	unsigned int max_discard_to; /* max. discard timeout in ms */
1da177e4 LT	288
1da177e4 LT	289	/* private data */
7ea239d9 PO	290	spinlock_t lock; /* lock for claim and bus ops */
7ea239d9 PO	291
1da177e4 LT	292	struct mmc_ios ios; /* current io bus settings */
	293	u32 ocr; /* the current OCR setting */
	294
97018580 DB	295	/* group bitfields together to minimize padding */
	296	unsigned int use_spi_crc:1;
	297	unsigned int claimed:1; /* host exclusively claimed */
	298	unsigned int bus_dead:1; /* bus has been released */
	299	#ifdef CONFIG_MMC_DEBUG
	300	unsigned int removed:1; /* host is being removed */
	301	#endif
	302
8ea926b2 AH	303	/* Only used with MMC_CAP_DISABLE */
8ea926b2 AH	304	int enabled; /* host is enabled */
4c2ef25f	305	int rescan_disable; /* disable card detection */
8ea926b2 AH	306	int nesting_cnt; /* "enable" nesting count */
	307	int en_dis_recurs; /* detect recursion */
	308	unsigned int disable_delay; /* disable delay in msecs */
	309	struct delayed_work disable; /* disabling work */
	310
b855885e	311	struct mmc_card card; / device attached to this host */
1da177e4 LT	312
1da177e4 LT	313	wait_queue_head_t wq;
319a3f14 AH	314	struct task_struct claimer; / task that has host claimed */
319a3f14 AH	315	int claim_cnt; /* "claim" nesting count */
f22ee4ed	316
c4028958	317	struct delayed_work detect;
d3049504	318	int detect_change; /* card detect flag */
b67e1980	319	struct mmc_hotplug hotplug;
01357dca	320
7ea239d9 PO	321	const struct mmc_bus_ops bus_ops; / current bus driver */
7ea239d9 PO	322	unsigned int bus_refs; /* reference counter */
7ea239d9	323
d1496c39 NP	324	unsigned int sdio_irqs;
	325	struct task_struct *sdio_irq_thread;
	326	atomic_t sdio_irq_thread_abort;
	327
da68c4eb NP	328	mmc_pm_flag_t pm_flags; /* requested pm features */
da68c4eb NP	329
af8350c7 PO	330	#ifdef CONFIG_LEDS_TRIGGERS
	331	struct led_trigger led; / activity led */
	332	#endif
	333
99fc5131 LW	334	#ifdef CONFIG_REGULATOR
	335	bool regulator_enabled; /* regulator state */
	336	#endif
	337
6edd8ee6 HS	338	struct dentry *debugfs_root;
6edd8ee6 HS	339
aa8b683a PF	340	struct mmc_async_req areq; / active async req */
aa8b683a PF	341
1b676f70 PF	342	#ifdef CONFIG_FAIL_MMC_REQUEST
	343	struct fault_attr fail_mmc_request;
	344	#endif
	345
df16219f GC	346	unsigned int actual_clock; /* Actual HC clock rate */
df16219f GC	347
01357dca	348	unsigned long private[0] ____cacheline_aligned;
1da177e4 LT	349	};
	350
	351	extern struct mmc_host mmc_alloc_host(int extra, struct device );
	352	extern int mmc_add_host(struct mmc_host *);
	353	extern void mmc_remove_host(struct mmc_host *);
	354	extern void mmc_free_host(struct mmc_host *);
	355
01357dca RK	356	static inline void mmc_priv(struct mmc_host host)
	357	{
	358	return (void *)host->private;
	359	}
	360
97018580 DB	361	#define mmc_host_is_spi(host) ((host)->caps & MMC_CAP_SPI)
97018580 DB	362
fcaf71fd	363	#define mmc_dev(x) ((x)->parent)
11354d03	364	#define mmc_classdev(x) (&(x)->class_dev)
d1b26863	365	#define mmc_hostname(x) (dev_name(&(x)->class_dev))
1da177e4	366
1a13f8fa	367	extern int mmc_suspend_host(struct mmc_host *);
1da177e4 LT	368	extern int mmc_resume_host(struct mmc_host *);
1da177e4 LT	369
12ae637f OBC	370	extern int mmc_power_save_host(struct mmc_host *host);
12ae637f OBC	371	extern int mmc_power_restore_host(struct mmc_host *host);
eae1aeee	372
8dc00335	373	extern void mmc_detect_change(struct mmc_host *, unsigned long delay);
1da177e4 LT	374	extern void mmc_request_done(struct mmc_host , struct mmc_request );
1da177e4 LT	375
881d1c25 SJ	376	extern int mmc_cache_ctrl(struct mmc_host *, u8);
881d1c25 SJ	377
17b759af NP	378	static inline void mmc_signal_sdio_irq(struct mmc_host *host)
	379	{
	380	host->ops->enable_sdio_irq(host, 0);
	381	wake_up_process(host->sdio_irq_thread);
	382	}
	383
5c13941a DB	384	struct regulator;
5c13941a DB	385
99fc5131	386	#ifdef CONFIG_REGULATOR
5c13941a	387	int mmc_regulator_get_ocrmask(struct regulator *supply);
99fc5131 LW	388	int mmc_regulator_set_ocr(struct mmc_host *mmc,
	389	struct regulator *supply,
	390	unsigned short vdd_bit);
	391	#else
	392	static inline int mmc_regulator_get_ocrmask(struct regulator *supply)
	393	{
	394	return 0;
	395	}
	396
	397	static inline int mmc_regulator_set_ocr(struct mmc_host *mmc,
	398	struct regulator *supply,
	399	unsigned short vdd_bit)
	400	{
	401	return 0;
	402	}
	403	#endif
5c13941a	404
b1ebe384 JL	405	int mmc_card_awake(struct mmc_host *host);
	406	int mmc_card_sleep(struct mmc_host *host);
	407	int mmc_card_can_sleep(struct mmc_host *host);
	408
8ea926b2 AH	409	int mmc_host_enable(struct mmc_host *host);
	410	int mmc_host_disable(struct mmc_host *host);
	411	int mmc_host_lazy_disable(struct mmc_host *host);
4c2ef25f	412	int mmc_pm_notify(struct notifier_block notify_block, unsigned long, void );
8ea926b2 AH	413
	414	static inline void mmc_set_disable_delay(struct mmc_host *host,
	415	unsigned int disable_delay)
	416	{
	417	host->disable_delay = disable_delay;
	418	}
	419
71d7d3d1	420	/* Module parameter */
90ab5ee9	421	extern bool mmc_assume_removable;
71d7d3d1 MF	422
	423	static inline int mmc_card_is_removable(struct mmc_host *host)
	424	{
	425	return !(host->caps & MMC_CAP_NONREMOVABLE) && mmc_assume_removable;
	426	}
	427
a5e9425d	428	static inline int mmc_card_keep_power(struct mmc_host *host)
080bc977 OBC	429	{
	430	return host->pm_flags & MMC_PM_KEEP_POWER;
	431	}
	432
6b93d01f OBC	433	static inline int mmc_card_wake_sdio_irq(struct mmc_host *host)
	434	{
	435	return host->pm_flags & MMC_PM_WAKE_SDIO_IRQ;
	436	}
d0c97cfb AW	437
	438	static inline int mmc_host_cmd23(struct mmc_host *host)
	439	{
	440	return host->caps & MMC_CAP_CMD23;
	441	}
f7c56ef2 AH	442
	443	static inline int mmc_boot_partition_access(struct mmc_host *host)
	444	{
	445	return !(host->caps2 & MMC_CAP2_BOOTPART_NOACC);
	446	}
	447
100e9186	448	#endif /* LINUX_MMC_HOST_H */