[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

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

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

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

	wait_queue_head_t	wq;

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

#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
cd9277c0 PO	44
	45	unsigned char timing; /* timing specification used */
	46
	47	#define MMC_TIMING_LEGACY 0
	48	#define MMC_TIMING_MMC_HS 1
	49	#define MMC_TIMING_SD_HS 2
1da177e4 LT	50	};
	51
	52	struct mmc_host_ops {
	53	void (request)(struct mmc_host host, struct mmc_request *req);
28f52482 AV	54	/*
	55	* Avoid calling these three functions too often or in a "fast path",
	56	* since underlaying controller might implement them in an expensive
	57	* and/or slow way.
	58	*
	59	* Also note that these functions might sleep, so don't call them
	60	* in the atomic contexts!
08f80bb5 AV	61	*
	62	* Return values for the get_ro callback should be:
	63	* 0 for a read/write card
	64	* 1 for a read-only card
	65	* -ENOSYS when not supported (equal to NULL callback)
	66	* or a negative errno value when something bad happened
	67	*
ee63a7d2	68	* Return values for the get_cd callback should be:
08f80bb5 AV	69	* 0 for a absent card
	70	* 1 for a present card
	71	* -ENOSYS when not supported (equal to NULL callback)
	72	* or a negative errno value when something bad happened
28f52482	73	*/
1da177e4	74	void (set_ios)(struct mmc_host host, struct mmc_ios *ios);
a00fc090	75	int (get_ro)(struct mmc_host host);
28f52482 AV	76	int (get_cd)(struct mmc_host host);
28f52482 AV	77
17b759af	78	void (enable_sdio_irq)(struct mmc_host host, int enable);
1da177e4 LT	79	};
	80
	81	struct mmc_card;
	82	struct device;
	83
	84	struct mmc_host {
fcaf71fd GKH	85	struct device *parent;
fcaf71fd GKH	86	struct device class_dev;
dce77377	87	int index;
f57b225e	88	const struct mmc_host_ops *ops;
1da177e4 LT	89	unsigned int f_min;
	90	unsigned int f_max;
	91	u32 ocr_avail;
1da177e4	92
55556da0	93	#define MMC_VDD_165_195 0x00000080 /* VDD voltage 1.65 - 1.95 */
f74d132c PO	94	#define MMC_VDD_20_21 0x00000100 /* VDD voltage 2.0 ~ 2.1 */
	95	#define MMC_VDD_21_22 0x00000200 /* VDD voltage 2.1 ~ 2.2 */
	96	#define MMC_VDD_22_23 0x00000400 /* VDD voltage 2.2 ~ 2.3 */
	97	#define MMC_VDD_23_24 0x00000800 /* VDD voltage 2.3 ~ 2.4 */
	98	#define MMC_VDD_24_25 0x00001000 /* VDD voltage 2.4 ~ 2.5 */
	99	#define MMC_VDD_25_26 0x00002000 /* VDD voltage 2.5 ~ 2.6 */
	100	#define MMC_VDD_26_27 0x00004000 /* VDD voltage 2.6 ~ 2.7 */
	101	#define MMC_VDD_27_28 0x00008000 /* VDD voltage 2.7 ~ 2.8 */
	102	#define MMC_VDD_28_29 0x00010000 /* VDD voltage 2.8 ~ 2.9 */
	103	#define MMC_VDD_29_30 0x00020000 /* VDD voltage 2.9 ~ 3.0 */
	104	#define MMC_VDD_30_31 0x00040000 /* VDD voltage 3.0 ~ 3.1 */
	105	#define MMC_VDD_31_32 0x00080000 /* VDD voltage 3.1 ~ 3.2 */
	106	#define MMC_VDD_32_33 0x00100000 /* VDD voltage 3.2 ~ 3.3 */
	107	#define MMC_VDD_33_34 0x00200000 /* VDD voltage 3.3 ~ 3.4 */
	108	#define MMC_VDD_34_35 0x00400000 /* VDD voltage 3.4 ~ 3.5 */
	109	#define MMC_VDD_35_36 0x00800000 /* VDD voltage 3.5 ~ 3.6 */
	110
f218278a PO	111	unsigned long caps; /* Host capabilities */
	112
	113	#define MMC_CAP_4_BIT_DATA (1 << 0) /* Can the host do 4 bit transfers */
23af6039 PO	114	#define MMC_CAP_MMC_HIGHSPEED (1 << 1) /* Can do MMC high-speed timing */
	115	#define MMC_CAP_SD_HIGHSPEED (1 << 2) /* Can do SD high-speed timing */
	116	#define MMC_CAP_SDIO_IRQ (1 << 3) /* Can signal pending SDIO IRQs */
	117	#define MMC_CAP_SPI (1 << 4) /* Talks only SPI protocols */
	118	#define MMC_CAP_NEEDS_POLL (1 << 5) /* Needs polling for card-detection */
f218278a	119
1da177e4 LT	120	/* host specific block data */
	121	unsigned int max_seg_size; /* see blk_queue_max_segment_size */
	122	unsigned short max_hw_segs; /* see blk_queue_max_hw_segments */
	123	unsigned short max_phys_segs; /* see blk_queue_max_phys_segments */
1da177e4	124	unsigned short unused;
55db890a	125	unsigned int max_req_size; /* maximum number of bytes in one req */
fe4a3c7a	126	unsigned int max_blk_size; /* maximum size of one mmc block */
55db890a	127	unsigned int max_blk_count; /* maximum number of blocks in one req */
1da177e4 LT	128
1da177e4 LT	129	/* private data */
7ea239d9 PO	130	spinlock_t lock; /* lock for claim and bus ops */
7ea239d9 PO	131
1da177e4 LT	132	struct mmc_ios ios; /* current io bus settings */
	133	u32 ocr; /* the current OCR setting */
	134
97018580 DB	135	/* group bitfields together to minimize padding */
	136	unsigned int use_spi_crc:1;
	137	unsigned int claimed:1; /* host exclusively claimed */
	138	unsigned int bus_dead:1; /* bus has been released */
	139	#ifdef CONFIG_MMC_DEBUG
	140	unsigned int removed:1; /* host is being removed */
	141	#endif
	142
b855885e	143	struct mmc_card card; / device attached to this host */
1da177e4 LT	144
1da177e4 LT	145	wait_queue_head_t wq;
f22ee4ed	146
c4028958	147	struct delayed_work detect;
01357dca	148
7ea239d9 PO	149	const struct mmc_bus_ops bus_ops; / current bus driver */
7ea239d9 PO	150	unsigned int bus_refs; /* reference counter */
7ea239d9	151
d1496c39 NP	152	unsigned int sdio_irqs;
	153	struct task_struct *sdio_irq_thread;
	154	atomic_t sdio_irq_thread_abort;
	155
af8350c7 PO	156	#ifdef CONFIG_LEDS_TRIGGERS
	157	struct led_trigger led; / activity led */
	158	#endif
	159
6edd8ee6 HS	160	struct dentry *debugfs_root;
6edd8ee6 HS	161
01357dca	162	unsigned long private[0] ____cacheline_aligned;
1da177e4 LT	163	};
	164
	165	extern struct mmc_host mmc_alloc_host(int extra, struct device );
	166	extern int mmc_add_host(struct mmc_host *);
	167	extern void mmc_remove_host(struct mmc_host *);
	168	extern void mmc_free_host(struct mmc_host *);
	169
01357dca RK	170	static inline void mmc_priv(struct mmc_host host)
	171	{
	172	return (void *)host->private;
	173	}
	174
97018580 DB	175	#define mmc_host_is_spi(host) ((host)->caps & MMC_CAP_SPI)
97018580 DB	176
fcaf71fd	177	#define mmc_dev(x) ((x)->parent)
11354d03	178	#define mmc_classdev(x) (&(x)->class_dev)
d1b26863	179	#define mmc_hostname(x) (dev_name(&(x)->class_dev))
1da177e4	180
3bfffd97	181	extern int mmc_suspend_host(struct mmc_host *, pm_message_t);
1da177e4 LT	182	extern int mmc_resume_host(struct mmc_host *);
1da177e4 LT	183
8dc00335	184	extern void mmc_detect_change(struct mmc_host *, unsigned long delay);
1da177e4 LT	185	extern void mmc_request_done(struct mmc_host , struct mmc_request );
1da177e4 LT	186
17b759af NP	187	static inline void mmc_signal_sdio_irq(struct mmc_host *host)
	188	{
	189	host->ops->enable_sdio_irq(host, 0);
	190	wake_up_process(host->sdio_irq_thread);
	191	}
	192
1da177e4 LT	193	#endif
1da177e4 LT	194