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

/*
 *  linux/include/linux/mmc/card.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.
 *
 *  Card driver specific definitions.
 */
#ifndef LINUX_MMC_CARD_H
#define LINUX_MMC_CARD_H

#include <linux/mmc/core.h>

struct mmc_cid {
	unsigned int		manfid;
	char			prod_name[8];
	unsigned int		serial;
	unsigned short		oemid;
	unsigned short		year;
	unsigned char		hwrev;
	unsigned char		fwrev;
	unsigned char		month;
};

struct mmc_csd {
	unsigned char		mmca_vsn;
	unsigned short		cmdclass;
	unsigned short		tacc_clks;
	unsigned int		tacc_ns;
	unsigned int		r2w_factor;
	unsigned int		max_dtr;
	unsigned int		read_blkbits;
	unsigned int		write_blkbits;
	unsigned int		capacity;
	unsigned int		read_partial:1,
				read_misalign:1,
				write_partial:1,
				write_misalign:1;
};

struct mmc_ext_csd {
	unsigned int		hs_max_dtr;
	unsigned int		sectors;
};

struct sd_scr {
	unsigned char		sda_vsn;
	unsigned char		bus_widths;
#define SD_SCR_BUS_WIDTH_1	(1<<0)
#define SD_SCR_BUS_WIDTH_4	(1<<2)
};

struct sd_switch_caps {
	unsigned int		hs_max_dtr;
};

struct sdio_cccr {
	unsigned int		sdio_vsn;
	unsigned int		sd_vsn;
	unsigned int		multi_block:1,
				low_speed:1,
				wide_bus:1,
				high_power:1,
				high_speed:1;
};

struct sdio_cis {
	unsigned short		vendor;
	unsigned short		device;
	unsigned short		blksize;
	unsigned int		max_dtr;
};

struct mmc_host;
struct sdio_func;
struct sdio_func_tuple;

#define SDIO_MAX_FUNCS		7

/*
 * MMC device
 */
struct mmc_card {
	struct mmc_host		*host;		/* the host this device belongs to */
	struct device		dev;		/* the device */
	unsigned int		rca;		/* relative card address of device */
	unsigned int		type;		/* card type */
#define MMC_TYPE_MMC		0		/* MMC card */
#define MMC_TYPE_SD		1		/* SD card */
#define MMC_TYPE_SDIO		2		/* SDIO card */
	unsigned int		state;		/* (our) card state */
#define MMC_STATE_PRESENT	(1<<0)		/* present in sysfs */
#define MMC_STATE_READONLY	(1<<1)		/* card is read-only */
#define MMC_STATE_HIGHSPEED	(1<<2)		/* card is in high speed mode */
#define MMC_STATE_BLOCKADDR	(1<<3)		/* card uses block-addressing */

	u32			raw_cid[4];	/* raw card CID */
	u32			raw_csd[4];	/* raw card CSD */
	u32			raw_scr[2];	/* raw card SCR */
	struct mmc_cid		cid;		/* card identification */
	struct mmc_csd		csd;		/* card specific */
	struct mmc_ext_csd	ext_csd;	/* mmc v4 extended card specific */
	struct sd_scr		scr;		/* extra SD information */
	struct sd_switch_caps	sw_caps;	/* switch (CMD6) caps */

	unsigned int		sdio_funcs;	/* number of SDIO functions */
	struct sdio_cccr	cccr;		/* common card info */
	struct sdio_cis		cis;		/* common tuple info */
	struct sdio_func	*sdio_func[SDIO_MAX_FUNCS]; /* SDIO functions (devices) */
	unsigned		num_info;	/* number of info strings */
	const char		**info;		/* info strings */
	struct sdio_func_tuple	*tuples;	/* unknown common tuples */

	struct dentry		*debugfs_root;
};

#define mmc_card_mmc(c)		((c)->type == MMC_TYPE_MMC)
#define mmc_card_sd(c)		((c)->type == MMC_TYPE_SD)
#define mmc_card_sdio(c)	((c)->type == MMC_TYPE_SDIO)

#define mmc_card_present(c)	((c)->state & MMC_STATE_PRESENT)
#define mmc_card_readonly(c)	((c)->state & MMC_STATE_READONLY)
#define mmc_card_highspeed(c)	((c)->state & MMC_STATE_HIGHSPEED)
#define mmc_card_blockaddr(c)	((c)->state & MMC_STATE_BLOCKADDR)

#define mmc_card_set_present(c)	((c)->state |= MMC_STATE_PRESENT)
#define mmc_card_set_readonly(c) ((c)->state |= MMC_STATE_READONLY)
#define mmc_card_set_highspeed(c) ((c)->state |= MMC_STATE_HIGHSPEED)
#define mmc_card_set_blockaddr(c) ((c)->state |= MMC_STATE_BLOCKADDR)

#define mmc_card_name(c)	((c)->cid.prod_name)
#define mmc_card_id(c)		(dev_name(&(c)->dev))

#define mmc_list_to_card(l)	container_of(l, struct mmc_card, node)
#define mmc_get_drvdata(c)	dev_get_drvdata(&(c)->dev)
#define mmc_set_drvdata(c,d)	dev_set_drvdata(&(c)->dev, d)

/*
 * MMC device driver (e.g., Flash card, I/O card...)
 */
struct mmc_driver {
	struct device_driver drv;
	int (*probe)(struct mmc_card *);
	void (*remove)(struct mmc_card *);
	int (*suspend)(struct mmc_card *, pm_message_t);
	int (*resume)(struct mmc_card *);
};

extern int mmc_register_driver(struct mmc_driver *);
extern void mmc_unregister_driver(struct mmc_driver *);

#endif
Commit	Line	Data
1da177e4 LT	1	/*
	2	* linux/include/linux/mmc/card.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	* Card driver specific definitions.
	9	*/
	10	#ifndef LINUX_MMC_CARD_H
	11	#define LINUX_MMC_CARD_H
	12
aaac1b47	13	#include <linux/mmc/core.h>
1da177e4 LT	14
	15	struct mmc_cid {
	16	unsigned int manfid;
	17	char prod_name[8];
	18	unsigned int serial;
	19	unsigned short oemid;
	20	unsigned short year;
	21	unsigned char hwrev;
	22	unsigned char fwrev;
	23	unsigned char month;
	24	};
	25
	26	struct mmc_csd {
	27	unsigned char mmca_vsn;
	28	unsigned short cmdclass;
	29	unsigned short tacc_clks;
	30	unsigned int tacc_ns;
37be4e78	31	unsigned int r2w_factor;
1da177e4 LT	32	unsigned int max_dtr;
1da177e4 LT	33	unsigned int read_blkbits;
a6f6c96b	34	unsigned int write_blkbits;
1da177e4	35	unsigned int capacity;
a6f6c96b RK	36	unsigned int read_partial:1,
a6f6c96b RK	37	read_misalign:1,
ce11a161	38	write_partial:1,
a6f6c96b	39	write_misalign:1;
1da177e4 LT	40	};
1da177e4 LT	41
bce40a36 PL	42	struct mmc_ext_csd {
bce40a36 PL	43	unsigned int hs_max_dtr;
85a18ad9	44	unsigned int sectors;
bce40a36 PL	45	};
bce40a36 PL	46
b57c43ad PO	47	struct sd_scr {
	48	unsigned char sda_vsn;
	49	unsigned char bus_widths;
	50	#define SD_SCR_BUS_WIDTH_1 (1<<0)
	51	#define SD_SCR_BUS_WIDTH_4 (1<<2)
	52	};
	53
7ccd266e PO	54	struct sd_switch_caps {
	55	unsigned int hs_max_dtr;
	56	};
	57
35c66c19 PO	58	struct sdio_cccr {
	59	unsigned int sdio_vsn;
	60	unsigned int sd_vsn;
	61	unsigned int multi_block:1,
	62	low_speed:1,
	63	wide_bus:1,
	64	high_power:1,
	65	high_speed:1;
	66	};
	67
1a632f8c PO	68	struct sdio_cis {
	69	unsigned short vendor;
	70	unsigned short device;
	71	unsigned short blksize;
	72	unsigned int max_dtr;
	73	};
	74
1da177e4	75	struct mmc_host;
e29a7d73	76	struct sdio_func;
1a632f8c	77	struct sdio_func_tuple;
e29a7d73 PO	78
e29a7d73 PO	79	#define SDIO_MAX_FUNCS 7
1da177e4 LT	80
	81	/*
	82	* MMC device
	83	*/
	84	struct mmc_card {
1da177e4 LT	85	struct mmc_host host; / the host this device belongs to */
	86	struct device dev; /* the device */
	87	unsigned int rca; /* relative card address of device */
9c2c0af9 PO	88	unsigned int type; /* card type */
	89	#define MMC_TYPE_MMC 0 /* MMC card */
	90	#define MMC_TYPE_SD 1 /* SD card */
5c4e6f13	91	#define MMC_TYPE_SDIO 2 /* SDIO card */
1da177e4 LT	92	unsigned int state; /* (our) card state */
1da177e4 LT	93	#define MMC_STATE_PRESENT (1<<0) /* present in sysfs */
bd766312 PO	94	#define MMC_STATE_READONLY (1<<1) /* card is read-only */
	95	#define MMC_STATE_HIGHSPEED (1<<2) /* card is in high speed mode */
	96	#define MMC_STATE_BLOCKADDR (1<<3) /* card uses block-addressing */
e29a7d73	97
1da177e4 LT	98	u32 raw_cid[4]; /* raw card CID */
1da177e4 LT	99	u32 raw_csd[4]; /* raw card CSD */
b57c43ad	100	u32 raw_scr[2]; /* raw card SCR */
1da177e4 LT	101	struct mmc_cid cid; /* card identification */
1da177e4 LT	102	struct mmc_csd csd; /* card specific */
bce40a36	103	struct mmc_ext_csd ext_csd; /* mmc v4 extended card specific */
b57c43ad	104	struct sd_scr scr; /* extra SD information */
7ccd266e	105	struct sd_switch_caps sw_caps; /* switch (CMD6) caps */
e29a7d73 PO	106
e29a7d73 PO	107	unsigned int sdio_funcs; /* number of SDIO functions */
35c66c19	108	struct sdio_cccr cccr; /* common card info */
1a632f8c	109	struct sdio_cis cis; /* common tuple info */
e29a7d73	110	struct sdio_func sdio_func[SDIO_MAX_FUNCS]; / SDIO functions (devices) */
759bdc7a PO	111	unsigned num_info; /* number of info strings */
759bdc7a PO	112	const char *info; / info strings */
1a632f8c	113	struct sdio_func_tuple tuples; / unknown common tuples */
f4b7f927 HS	114
f4b7f927 HS	115	struct dentry *debugfs_root;
1da177e4 LT	116	};
1da177e4 LT	117
9c2c0af9 PO	118	#define mmc_card_mmc(c) ((c)->type == MMC_TYPE_MMC)
9c2c0af9 PO	119	#define mmc_card_sd(c) ((c)->type == MMC_TYPE_SD)
5c4e6f13	120	#define mmc_card_sdio(c) ((c)->type == MMC_TYPE_SDIO)
9c2c0af9	121
1da177e4	122	#define mmc_card_present(c) ((c)->state & MMC_STATE_PRESENT)
a00fc090	123	#define mmc_card_readonly(c) ((c)->state & MMC_STATE_READONLY)
bce40a36	124	#define mmc_card_highspeed(c) ((c)->state & MMC_STATE_HIGHSPEED)
fba68bd2	125	#define mmc_card_blockaddr(c) ((c)->state & MMC_STATE_BLOCKADDR)
1da177e4 LT	126
1da177e4 LT	127	#define mmc_card_set_present(c) ((c)->state \|= MMC_STATE_PRESENT)
a00fc090	128	#define mmc_card_set_readonly(c) ((c)->state \|= MMC_STATE_READONLY)
bce40a36	129	#define mmc_card_set_highspeed(c) ((c)->state \|= MMC_STATE_HIGHSPEED)
fba68bd2	130	#define mmc_card_set_blockaddr(c) ((c)->state \|= MMC_STATE_BLOCKADDR)
1da177e4 LT	131
1da177e4 LT	132	#define mmc_card_name(c) ((c)->cid.prod_name)
d1b26863	133	#define mmc_card_id(c) (dev_name(&(c)->dev))
1da177e4 LT	134
	135	#define mmc_list_to_card(l) container_of(l, struct mmc_card, node)
	136	#define mmc_get_drvdata(c) dev_get_drvdata(&(c)->dev)
	137	#define mmc_set_drvdata(c,d) dev_set_drvdata(&(c)->dev, d)
	138
	139	/*
	140	* MMC device driver (e.g., Flash card, I/O card...)
	141	*/
	142	struct mmc_driver {
	143	struct device_driver drv;
	144	int (probe)(struct mmc_card );
	145	void (remove)(struct mmc_card );
	146	int (suspend)(struct mmc_card , pm_message_t);
	147	int (resume)(struct mmc_card );
	148	};
	149
	150	extern int mmc_register_driver(struct mmc_driver *);
	151	extern void mmc_unregister_driver(struct mmc_driver *);
	152
1da177e4	153	#endif