[linux-2.6-block.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/mmc/core.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
};

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);
	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);
};

struct mmc_card;
struct device;

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;
	u32			ocr_avail;

#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 */

	/* host specific block data */
	unsigned int		max_seg_size;	/* see blk_queue_max_segment_size */
	unsigned short		max_hw_segs;	/* see blk_queue_max_hw_segments */
	unsigned short		max_phys_segs;	/* see blk_queue_max_phys_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 */

	/* 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			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;

	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;

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

	struct dentry		*debugfs_root;

	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 *, pm_message_t);
extern int mmc_resume_host(struct mmc_host *);

extern void mmc_power_save_host(struct mmc_host *host);
extern void 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 *);

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;

int mmc_regulator_get_ocrmask(struct regulator *supply);
int mmc_regulator_set_ocr(struct regulator *supply, unsigned short vdd_bit);

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);

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

#endif
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 PO	13	#include <linux/leds.h>
af8350c7 PO	14
aaac1b47	15	#include <linux/mmc/core.h>
1da177e4 LT	16
	17	struct mmc_ios {
	18	unsigned int clock; /* clock rate */
	19	unsigned short vdd;
	20
4be34c99	21	/* vdd stores the bit number of the selected voltage range from below. */
1da177e4 LT	22
	23	unsigned char bus_mode; /* command output mode */
	24
	25	#define MMC_BUSMODE_OPENDRAIN 1
	26	#define MMC_BUSMODE_PUSHPULL 2
	27
865e9f13 PO	28	unsigned char chip_select; /* SPI chip select */
	29
	30	#define MMC_CS_DONTCARE 0
	31	#define MMC_CS_HIGH 1
	32	#define MMC_CS_LOW 2
	33
1da177e4 LT	34	unsigned char power_mode; /* power supply mode */
	35
	36	#define MMC_POWER_OFF 0
	37	#define MMC_POWER_UP 1
	38	#define MMC_POWER_ON 2
f218278a PO	39
	40	unsigned char bus_width; /* data bus width */
	41
	42	#define MMC_BUS_WIDTH_1 0
	43	#define MMC_BUS_WIDTH_4 2
b30f8af3	44	#define MMC_BUS_WIDTH_8 3
cd9277c0 PO	45
	46	unsigned char timing; /* timing specification used */
	47
	48	#define MMC_TIMING_LEGACY 0
	49	#define MMC_TIMING_MMC_HS 1
	50	#define MMC_TIMING_SD_HS 2
1da177e4 LT	51	};
	52
	53	struct mmc_host_ops {
8ea926b2 AH	54	/*
	55	* Hosts that support power saving can use the 'enable' and 'disable'
	56	* methods to exit and enter power saving states. 'enable' is called
	57	* when the host is claimed and 'disable' is called (or scheduled with
	58	* a delay) when the host is released. The 'disable' is scheduled if
	59	* the disable delay set by 'mmc_set_disable_delay()' is non-zero,
	60	* otherwise 'disable' is called immediately. 'disable' may be
	61	* scheduled repeatedly, to permit ever greater power saving at the
	62	* expense of ever greater latency to re-enable. Rescheduling is
	63	* determined by the return value of the 'disable' method. A positive
	64	* value gives the delay in milliseconds.
	65	*
	66	* In the case where a host function (like set_ios) may be called
	67	* with or without the host claimed, enabling and disabling can be
	68	* done directly and will nest correctly. Call 'mmc_host_enable()' and
	69	* 'mmc_host_lazy_disable()' for this purpose, but note that these
	70	* functions must be paired.
	71	*
	72	* Alternatively, 'mmc_host_enable()' may be paired with
	73	* 'mmc_host_disable()' which calls 'disable' immediately. In this
	74	* case the 'disable' method will be called with 'lazy' set to 0.
	75	* This is mainly useful for error paths.
	76	*
	77	* Because lazy disable may be called from a work queue, the 'disable'
	78	* method must claim the host when 'lazy' != 0, which will work
	79	* correctly because recursion is detected and handled.
	80	*/
	81	int (enable)(struct mmc_host host);
	82	int (disable)(struct mmc_host host, int lazy);
1da177e4	83	void (request)(struct mmc_host host, struct mmc_request *req);
28f52482 AV	84	/*
	85	* Avoid calling these three functions too often or in a "fast path",
	86	* since underlaying controller might implement them in an expensive
	87	* and/or slow way.
	88	*
	89	* Also note that these functions might sleep, so don't call them
	90	* in the atomic contexts!
08f80bb5 AV	91	*
	92	* Return values for the get_ro callback should be:
	93	* 0 for a read/write card
	94	* 1 for a read-only card
	95	* -ENOSYS when not supported (equal to NULL callback)
	96	* or a negative errno value when something bad happened
	97	*
ee63a7d2	98	* Return values for the get_cd callback should be:
08f80bb5 AV	99	* 0 for a absent card
	100	* 1 for a present card
	101	* -ENOSYS when not supported (equal to NULL callback)
	102	* or a negative errno value when something bad happened
28f52482	103	*/
1da177e4	104	void (set_ios)(struct mmc_host host, struct mmc_ios *ios);
a00fc090	105	int (get_ro)(struct mmc_host host);
28f52482 AV	106	int (get_cd)(struct mmc_host host);
28f52482 AV	107
17b759af	108	void (enable_sdio_irq)(struct mmc_host host, int enable);
1da177e4 LT	109	};
	110
	111	struct mmc_card;
	112	struct device;
	113
	114	struct mmc_host {
fcaf71fd GKH	115	struct device *parent;
fcaf71fd GKH	116	struct device class_dev;
dce77377	117	int index;
f57b225e	118	const struct mmc_host_ops *ops;
1da177e4 LT	119	unsigned int f_min;
	120	unsigned int f_max;
	121	u32 ocr_avail;
1da177e4	122
55556da0	123	#define MMC_VDD_165_195 0x00000080 /* VDD voltage 1.65 - 1.95 */
f74d132c PO	124	#define MMC_VDD_20_21 0x00000100 /* VDD voltage 2.0 ~ 2.1 */
	125	#define MMC_VDD_21_22 0x00000200 /* VDD voltage 2.1 ~ 2.2 */
	126	#define MMC_VDD_22_23 0x00000400 /* VDD voltage 2.2 ~ 2.3 */
	127	#define MMC_VDD_23_24 0x00000800 /* VDD voltage 2.3 ~ 2.4 */
	128	#define MMC_VDD_24_25 0x00001000 /* VDD voltage 2.4 ~ 2.5 */
	129	#define MMC_VDD_25_26 0x00002000 /* VDD voltage 2.5 ~ 2.6 */
	130	#define MMC_VDD_26_27 0x00004000 /* VDD voltage 2.6 ~ 2.7 */
	131	#define MMC_VDD_27_28 0x00008000 /* VDD voltage 2.7 ~ 2.8 */
	132	#define MMC_VDD_28_29 0x00010000 /* VDD voltage 2.8 ~ 2.9 */
	133	#define MMC_VDD_29_30 0x00020000 /* VDD voltage 2.9 ~ 3.0 */
	134	#define MMC_VDD_30_31 0x00040000 /* VDD voltage 3.0 ~ 3.1 */
	135	#define MMC_VDD_31_32 0x00080000 /* VDD voltage 3.1 ~ 3.2 */
	136	#define MMC_VDD_32_33 0x00100000 /* VDD voltage 3.2 ~ 3.3 */
	137	#define MMC_VDD_33_34 0x00200000 /* VDD voltage 3.3 ~ 3.4 */
	138	#define MMC_VDD_34_35 0x00400000 /* VDD voltage 3.4 ~ 3.5 */
	139	#define MMC_VDD_35_36 0x00800000 /* VDD voltage 3.5 ~ 3.6 */
	140
f218278a PO	141	unsigned long caps; /* Host capabilities */
	142
	143	#define MMC_CAP_4_BIT_DATA (1 << 0) /* Can the host do 4 bit transfers */
23af6039 PO	144	#define MMC_CAP_MMC_HIGHSPEED (1 << 1) /* Can do MMC high-speed timing */
	145	#define MMC_CAP_SD_HIGHSPEED (1 << 2) /* Can do SD high-speed timing */
	146	#define MMC_CAP_SDIO_IRQ (1 << 3) /* Can signal pending SDIO IRQs */
	147	#define MMC_CAP_SPI (1 << 4) /* Talks only SPI protocols */
	148	#define MMC_CAP_NEEDS_POLL (1 << 5) /* Needs polling for card-detection */
b30f8af3	149	#define MMC_CAP_8_BIT_DATA (1 << 6) /* Can the host do 8 bit transfers */
8ea926b2	150	#define MMC_CAP_DISABLE (1 << 7) /* Can the host be disabled */
9feae246	151	#define MMC_CAP_NONREMOVABLE (1 << 8) /* Nonremovable e.g. eMMC */
f218278a	152
1da177e4 LT	153	/* host specific block data */
	154	unsigned int max_seg_size; /* see blk_queue_max_segment_size */
	155	unsigned short max_hw_segs; /* see blk_queue_max_hw_segments */
	156	unsigned short max_phys_segs; /* see blk_queue_max_phys_segments */
1da177e4	157	unsigned short unused;
55db890a	158	unsigned int max_req_size; /* maximum number of bytes in one req */
fe4a3c7a	159	unsigned int max_blk_size; /* maximum size of one mmc block */
55db890a	160	unsigned int max_blk_count; /* maximum number of blocks in one req */
1da177e4 LT	161
1da177e4 LT	162	/* private data */
7ea239d9 PO	163	spinlock_t lock; /* lock for claim and bus ops */
7ea239d9 PO	164
1da177e4 LT	165	struct mmc_ios ios; /* current io bus settings */
	166	u32 ocr; /* the current OCR setting */
	167
97018580 DB	168	/* group bitfields together to minimize padding */
	169	unsigned int use_spi_crc:1;
	170	unsigned int claimed:1; /* host exclusively claimed */
	171	unsigned int bus_dead:1; /* bus has been released */
	172	#ifdef CONFIG_MMC_DEBUG
	173	unsigned int removed:1; /* host is being removed */
	174	#endif
	175
8ea926b2 AH	176	/* Only used with MMC_CAP_DISABLE */
	177	int enabled; /* host is enabled */
	178	int nesting_cnt; /* "enable" nesting count */
	179	int en_dis_recurs; /* detect recursion */
	180	unsigned int disable_delay; /* disable delay in msecs */
	181	struct delayed_work disable; /* disabling work */
	182
b855885e	183	struct mmc_card card; / device attached to this host */
1da177e4 LT	184
1da177e4 LT	185	wait_queue_head_t wq;
319a3f14 AH	186	struct task_struct claimer; / task that has host claimed */
319a3f14 AH	187	int claim_cnt; /* "claim" nesting count */
f22ee4ed	188
c4028958	189	struct delayed_work detect;
01357dca	190
7ea239d9 PO	191	const struct mmc_bus_ops bus_ops; / current bus driver */
7ea239d9 PO	192	unsigned int bus_refs; /* reference counter */
7ea239d9	193
d1496c39 NP	194	unsigned int sdio_irqs;
	195	struct task_struct *sdio_irq_thread;
	196	atomic_t sdio_irq_thread_abort;
	197
af8350c7 PO	198	#ifdef CONFIG_LEDS_TRIGGERS
	199	struct led_trigger led; / activity led */
	200	#endif
	201
6edd8ee6 HS	202	struct dentry *debugfs_root;
6edd8ee6 HS	203
01357dca	204	unsigned long private[0] ____cacheline_aligned;
1da177e4 LT	205	};
	206
	207	extern struct mmc_host mmc_alloc_host(int extra, struct device );
	208	extern int mmc_add_host(struct mmc_host *);
	209	extern void mmc_remove_host(struct mmc_host *);
	210	extern void mmc_free_host(struct mmc_host *);
	211
01357dca RK	212	static inline void mmc_priv(struct mmc_host host)
	213	{
	214	return (void *)host->private;
	215	}
	216
97018580 DB	217	#define mmc_host_is_spi(host) ((host)->caps & MMC_CAP_SPI)
97018580 DB	218
fcaf71fd	219	#define mmc_dev(x) ((x)->parent)
11354d03	220	#define mmc_classdev(x) (&(x)->class_dev)
d1b26863	221	#define mmc_hostname(x) (dev_name(&(x)->class_dev))
1da177e4	222
3bfffd97	223	extern int mmc_suspend_host(struct mmc_host *, pm_message_t);
1da177e4 LT	224	extern int mmc_resume_host(struct mmc_host *);
1da177e4 LT	225
eae1aeee AH	226	extern void mmc_power_save_host(struct mmc_host *host);
	227	extern void mmc_power_restore_host(struct mmc_host *host);
	228
8dc00335	229	extern void mmc_detect_change(struct mmc_host *, unsigned long delay);
1da177e4 LT	230	extern void mmc_request_done(struct mmc_host , struct mmc_request );
1da177e4 LT	231
17b759af NP	232	static inline void mmc_signal_sdio_irq(struct mmc_host *host)
	233	{
	234	host->ops->enable_sdio_irq(host, 0);
	235	wake_up_process(host->sdio_irq_thread);
	236	}
	237
5c13941a DB	238	struct regulator;
	239
	240	int mmc_regulator_get_ocrmask(struct regulator *supply);
	241	int mmc_regulator_set_ocr(struct regulator *supply, unsigned short vdd_bit);
	242
8ea926b2 AH	243	int mmc_host_enable(struct mmc_host *host);
	244	int mmc_host_disable(struct mmc_host *host);
	245	int mmc_host_lazy_disable(struct mmc_host *host);
	246
	247	static inline void mmc_set_disable_delay(struct mmc_host *host,
	248	unsigned int disable_delay)
	249	{
	250	host->disable_delay = disable_delay;
	251	}
	252
1da177e4 LT	253	#endif
1da177e4 LT	254