[mirror_ubuntu-zesty-kernel.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/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);
	void	(*set_ios)(struct mmc_host *host, struct mmc_ios *ios);
	int	(*get_ro)(struct mmc_host *host);
};

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_145_150		0x00000001	/* VDD voltage 1.45 - 1.50 */
#define MMC_VDD_150_155		0x00000002	/* VDD voltage 1.50 - 1.55 */
#define MMC_VDD_155_160		0x00000004	/* VDD voltage 1.55 - 1.60 */
#define MMC_VDD_160_165		0x00000008	/* VDD voltage 1.60 - 1.65 */
#define MMC_VDD_165_170		0x00000010	/* VDD voltage 1.65 - 1.70 */
#define MMC_VDD_17_18		0x00000020	/* VDD voltage 1.7 - 1.8 */
#define MMC_VDD_18_19		0x00000040	/* VDD voltage 1.8 - 1.9 */
#define MMC_VDD_19_20		0x00000080	/* VDD voltage 1.9 - 2.0 */
#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_MULTIWRITE	(1 << 1)	/* Can accurately report bytes sent to card on error */
#define MMC_CAP_BYTEBLOCK	(1 << 2)	/* Can do non-log2 block sizes */
#define MMC_CAP_MMC_HIGHSPEED	(1 << 3)	/* Can do MMC high-speed timing */
#define MMC_CAP_SD_HIGHSPEED	(1 << 4)	/* Can do SD high-speed timing */

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

	unsigned int		mode;		/* current card mode of host */
#define MMC_MODE_MMC		0
#define MMC_MODE_SD		1

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

	wait_queue_head_t	wq;
	unsigned int		claimed:1;	/* host exclusively claimed */

	struct delayed_work	detect;
#ifdef CONFIG_MMC_DEBUG
	unsigned int		removed:1;	/* host is being removed */
#endif

	const struct mmc_bus_ops *bus_ops;	/* current bus driver */
	unsigned int		bus_refs;	/* reference counter */
	unsigned int		bus_dead:1;	/* bus has been released */

	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_dev(x)	((x)->parent)
#define mmc_classdev(x)	(&(x)->class_dev)
#define mmc_hostname(x)	((x)->class_dev.bus_id)

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

#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
aaac1b47	13	#include <linux/mmc/core.h>
1da177e4 LT	14
	15	struct mmc_ios {
	16	unsigned int clock; /* clock rate */
	17	unsigned short vdd;
	18
4be34c99	19	/* vdd stores the bit number of the selected voltage range from below. */
1da177e4 LT	20
	21	unsigned char bus_mode; /* command output mode */
	22
	23	#define MMC_BUSMODE_OPENDRAIN 1
	24	#define MMC_BUSMODE_PUSHPULL 2
	25
865e9f13 PO	26	unsigned char chip_select; /* SPI chip select */
	27
	28	#define MMC_CS_DONTCARE 0
	29	#define MMC_CS_HIGH 1
	30	#define MMC_CS_LOW 2
	31
1da177e4 LT	32	unsigned char power_mode; /* power supply mode */
	33
	34	#define MMC_POWER_OFF 0
	35	#define MMC_POWER_UP 1
	36	#define MMC_POWER_ON 2
f218278a PO	37
	38	unsigned char bus_width; /* data bus width */
	39
	40	#define MMC_BUS_WIDTH_1 0
	41	#define MMC_BUS_WIDTH_4 2
cd9277c0 PO	42
	43	unsigned char timing; /* timing specification used */
	44
	45	#define MMC_TIMING_LEGACY 0
	46	#define MMC_TIMING_MMC_HS 1
	47	#define MMC_TIMING_SD_HS 2
1da177e4 LT	48	};
	49
	50	struct mmc_host_ops {
	51	void (request)(struct mmc_host host, struct mmc_request *req);
	52	void (set_ios)(struct mmc_host host, struct mmc_ios *ios);
a00fc090	53	int (get_ro)(struct mmc_host host);
1da177e4 LT	54	};
	55
	56	struct mmc_card;
	57	struct device;
	58
	59	struct mmc_host {
fcaf71fd GKH	60	struct device *parent;
fcaf71fd GKH	61	struct device class_dev;
dce77377	62	int index;
f57b225e	63	const struct mmc_host_ops *ops;
1da177e4 LT	64	unsigned int f_min;
	65	unsigned int f_max;
	66	u32 ocr_avail;
1da177e4	67
f74d132c PO	68	#define MMC_VDD_145_150 0x00000001 /* VDD voltage 1.45 - 1.50 */
	69	#define MMC_VDD_150_155 0x00000002 /* VDD voltage 1.50 - 1.55 */
	70	#define MMC_VDD_155_160 0x00000004 /* VDD voltage 1.55 - 1.60 */
	71	#define MMC_VDD_160_165 0x00000008 /* VDD voltage 1.60 - 1.65 */
	72	#define MMC_VDD_165_170 0x00000010 /* VDD voltage 1.65 - 1.70 */
	73	#define MMC_VDD_17_18 0x00000020 /* VDD voltage 1.7 - 1.8 */
	74	#define MMC_VDD_18_19 0x00000040 /* VDD voltage 1.8 - 1.9 */
	75	#define MMC_VDD_19_20 0x00000080 /* VDD voltage 1.9 - 2.0 */
	76	#define MMC_VDD_20_21 0x00000100 /* VDD voltage 2.0 ~ 2.1 */
	77	#define MMC_VDD_21_22 0x00000200 /* VDD voltage 2.1 ~ 2.2 */
	78	#define MMC_VDD_22_23 0x00000400 /* VDD voltage 2.2 ~ 2.3 */
	79	#define MMC_VDD_23_24 0x00000800 /* VDD voltage 2.3 ~ 2.4 */
	80	#define MMC_VDD_24_25 0x00001000 /* VDD voltage 2.4 ~ 2.5 */
	81	#define MMC_VDD_25_26 0x00002000 /* VDD voltage 2.5 ~ 2.6 */
	82	#define MMC_VDD_26_27 0x00004000 /* VDD voltage 2.6 ~ 2.7 */
	83	#define MMC_VDD_27_28 0x00008000 /* VDD voltage 2.7 ~ 2.8 */
	84	#define MMC_VDD_28_29 0x00010000 /* VDD voltage 2.8 ~ 2.9 */
	85	#define MMC_VDD_29_30 0x00020000 /* VDD voltage 2.9 ~ 3.0 */
	86	#define MMC_VDD_30_31 0x00040000 /* VDD voltage 3.0 ~ 3.1 */
	87	#define MMC_VDD_31_32 0x00080000 /* VDD voltage 3.1 ~ 3.2 */
	88	#define MMC_VDD_32_33 0x00100000 /* VDD voltage 3.2 ~ 3.3 */
	89	#define MMC_VDD_33_34 0x00200000 /* VDD voltage 3.3 ~ 3.4 */
	90	#define MMC_VDD_34_35 0x00400000 /* VDD voltage 3.4 ~ 3.5 */
	91	#define MMC_VDD_35_36 0x00800000 /* VDD voltage 3.5 ~ 3.6 */
	92
f218278a PO	93	unsigned long caps; /* Host capabilities */
	94
	95	#define MMC_CAP_4_BIT_DATA (1 << 0) /* Can the host do 4 bit transfers */
db53f28b	96	#define MMC_CAP_MULTIWRITE (1 << 1) /* Can accurately report bytes sent to card on error */
42431acb	97	#define MMC_CAP_BYTEBLOCK (1 << 2) /* Can do non-log2 block sizes */
cd9277c0 PO	98	#define MMC_CAP_MMC_HIGHSPEED (1 << 3) /* Can do MMC high-speed timing */
cd9277c0 PO	99	#define MMC_CAP_SD_HIGHSPEED (1 << 4) /* Can do SD high-speed timing */
f218278a	100
1da177e4 LT	101	/* host specific block data */
	102	unsigned int max_seg_size; /* see blk_queue_max_segment_size */
	103	unsigned short max_hw_segs; /* see blk_queue_max_hw_segments */
	104	unsigned short max_phys_segs; /* see blk_queue_max_phys_segments */
1da177e4	105	unsigned short unused;
55db890a	106	unsigned int max_req_size; /* maximum number of bytes in one req */
fe4a3c7a	107	unsigned int max_blk_size; /* maximum size of one mmc block */
55db890a	108	unsigned int max_blk_count; /* maximum number of blocks in one req */
1da177e4 LT	109
1da177e4 LT	110	/* private data */
7ea239d9 PO	111	spinlock_t lock; /* lock for claim and bus ops */
7ea239d9 PO	112
1da177e4 LT	113	struct mmc_ios ios; /* current io bus settings */
	114	u32 ocr; /* the current OCR setting */
	115
335eadf2 PO	116	unsigned int mode; /* current card mode of host */
	117	#define MMC_MODE_MMC 0
	118	#define MMC_MODE_SD 1
	119
b855885e	120	struct mmc_card card; / device attached to this host */
1da177e4 LT	121
1da177e4 LT	122	wait_queue_head_t wq;
f22ee4ed PO	123	unsigned int claimed:1; /* host exclusively claimed */
f22ee4ed PO	124
c4028958	125	struct delayed_work detect;
3b91e550 PO	126	#ifdef CONFIG_MMC_DEBUG
	127	unsigned int removed:1; /* host is being removed */
	128	#endif
01357dca	129
7ea239d9 PO	130	const struct mmc_bus_ops bus_ops; / current bus driver */
	131	unsigned int bus_refs; /* reference counter */
	132	unsigned int bus_dead:1; /* bus has been released */
	133
01357dca	134	unsigned long private[0] ____cacheline_aligned;
1da177e4 LT	135	};
	136
	137	extern struct mmc_host mmc_alloc_host(int extra, struct device );
	138	extern int mmc_add_host(struct mmc_host *);
	139	extern void mmc_remove_host(struct mmc_host *);
	140	extern void mmc_free_host(struct mmc_host *);
	141
01357dca RK	142	static inline void mmc_priv(struct mmc_host host)
	143	{
	144	return (void *)host->private;
	145	}
	146
fcaf71fd	147	#define mmc_dev(x) ((x)->parent)
11354d03	148	#define mmc_classdev(x) (&(x)->class_dev)
fcaf71fd	149	#define mmc_hostname(x) ((x)->class_dev.bus_id)
1da177e4	150
3bfffd97	151	extern int mmc_suspend_host(struct mmc_host *, pm_message_t);
1da177e4 LT	152	extern int mmc_resume_host(struct mmc_host *);
1da177e4 LT	153
8dc00335	154	extern void mmc_detect_change(struct mmc_host *, unsigned long delay);
1da177e4 LT	155	extern void mmc_request_done(struct mmc_host , struct mmc_request );
	156
	157	#endif
	158