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

/*
 *  include/linux/mmc/sdio_func.h
 *
 *  Copyright 2007-2008 Pierre Ossman
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or (at
 * your option) any later version.
 */

#ifndef MMC_SDIO_FUNC_H
#define MMC_SDIO_FUNC_H

#include <linux/device.h>
#include <linux/mod_devicetable.h>

#include <linux/mmc/pm.h>

struct mmc_card;
struct sdio_func;

typedef void (sdio_irq_handler_t)(struct sdio_func *);

/*
 * SDIO function CIS tuple (unknown to the core)
 */
struct sdio_func_tuple {
	struct sdio_func_tuple *next;
	unsigned char code;
	unsigned char size;
	unsigned char data[0];
};

/*
 * SDIO function devices
 */
struct sdio_func {
	struct mmc_card		*card;		/* the card this device belongs to */
	struct device		dev;		/* the device */
	sdio_irq_handler_t	*irq_handler;	/* IRQ callback */
	unsigned int		num;		/* function number */

	unsigned char		class;		/* standard interface class */
	unsigned short		vendor;		/* vendor id */
	unsigned short		device;		/* device id */

	unsigned		max_blksize;	/* maximum block size */
	unsigned		cur_blksize;	/* current block size */

	unsigned		enable_timeout;	/* max enable timeout in msec */

	unsigned int		state;		/* function state */
#define SDIO_STATE_PRESENT	(1<<0)		/* present in sysfs */

	u8			tmpbuf[4];	/* DMA:able scratch buffer */

	unsigned		num_info;	/* number of info strings */
	const char		**info;		/* info strings */

	struct sdio_func_tuple *tuples;
};

#define sdio_func_present(f)	((f)->state & SDIO_STATE_PRESENT)

#define sdio_func_set_present(f) ((f)->state |= SDIO_STATE_PRESENT)

#define sdio_func_id(f)		(dev_name(&(f)->dev))

#define sdio_get_drvdata(f)	dev_get_drvdata(&(f)->dev)
#define sdio_set_drvdata(f,d)	dev_set_drvdata(&(f)->dev, d)
#define dev_to_sdio_func(d)	container_of(d, struct sdio_func, dev)

/*
 * SDIO function device driver
 */
struct sdio_driver {
	char *name;
	const struct sdio_device_id *id_table;

	int (*probe)(struct sdio_func *, const struct sdio_device_id *);
	void (*remove)(struct sdio_func *);

	struct device_driver drv;
};

#define to_sdio_driver(d)	container_of(d, struct sdio_driver, drv)

/**
 * SDIO_DEVICE - macro used to describe a specific SDIO device
 * @vend: the 16 bit manufacturer code
 * @dev: the 16 bit function id
 *
 * This macro is used to create a struct sdio_device_id that matches a
 * specific device. The class field will be set to SDIO_ANY_ID.
 */
#define SDIO_DEVICE(vend,dev) \
	.class = SDIO_ANY_ID, \
	.vendor = (vend), .device = (dev)

/**
 * SDIO_DEVICE_CLASS - macro used to describe a specific SDIO device class
 * @dev_class: the 8 bit standard interface code
 *
 * This macro is used to create a struct sdio_device_id that matches a
 * specific standard SDIO function type.  The vendor and device fields will
 * be set to SDIO_ANY_ID.
 */
#define SDIO_DEVICE_CLASS(dev_class) \
	.class = (dev_class), \
	.vendor = SDIO_ANY_ID, .device = SDIO_ANY_ID

extern int sdio_register_driver(struct sdio_driver *);
extern void sdio_unregister_driver(struct sdio_driver *);

/*
 * SDIO I/O operations
 */
extern void sdio_claim_host(struct sdio_func *func);
extern void sdio_release_host(struct sdio_func *func);

extern int sdio_enable_func(struct sdio_func *func);
extern int sdio_disable_func(struct sdio_func *func);

extern int sdio_set_block_size(struct sdio_func *func, unsigned blksz);

extern int sdio_claim_irq(struct sdio_func *func, sdio_irq_handler_t *handler);
extern int sdio_release_irq(struct sdio_func *func);

extern unsigned int sdio_align_size(struct sdio_func *func, unsigned int sz);

extern u8 sdio_readb(struct sdio_func *func, unsigned int addr, int *err_ret);
extern u16 sdio_readw(struct sdio_func *func, unsigned int addr, int *err_ret);
extern u32 sdio_readl(struct sdio_func *func, unsigned int addr, int *err_ret);

extern int sdio_memcpy_fromio(struct sdio_func *func, void *dst,
	unsigned int addr, int count);
extern int sdio_readsb(struct sdio_func *func, void *dst,
	unsigned int addr, int count);

extern void sdio_writeb(struct sdio_func *func, u8 b,
	unsigned int addr, int *err_ret);
extern void sdio_writew(struct sdio_func *func, u16 b,
	unsigned int addr, int *err_ret);
extern void sdio_writel(struct sdio_func *func, u32 b,
	unsigned int addr, int *err_ret);

extern int sdio_memcpy_toio(struct sdio_func *func, unsigned int addr,
	void *src, int count);
extern int sdio_writesb(struct sdio_func *func, unsigned int addr,
	void *src, int count);

extern unsigned char sdio_f0_readb(struct sdio_func *func,
	unsigned int addr, int *err_ret);
extern void sdio_f0_writeb(struct sdio_func *func, unsigned char b,
	unsigned int addr, int *err_ret);

extern mmc_pm_flag_t sdio_get_host_pm_caps(struct sdio_func *func);
extern int sdio_set_host_pm_flags(struct sdio_func *func, mmc_pm_flag_t flags);

#endif
Commit	Line	Data
e29a7d73 PO	1	/*
	2	* include/linux/mmc/sdio_func.h
	3	*
ad3868b2	4	* Copyright 2007-2008 Pierre Ossman
e29a7d73 PO	5	*
	6	* This program is free software; you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License as published by
	8	* the Free Software Foundation; either version 2 of the License, or (at
	9	* your option) any later version.
	10	*/
	11
	12	#ifndef MMC_SDIO_FUNC_H
	13	#define MMC_SDIO_FUNC_H
	14
3b38bea0 PO	15	#include <linux/device.h>
	16	#include <linux/mod_devicetable.h>
	17
da68c4eb NP	18	#include <linux/mmc/pm.h>
da68c4eb NP	19
e29a7d73	20	struct mmc_card;
d1496c39 NP	21	struct sdio_func;
	22
	23	typedef void (sdio_irq_handler_t)(struct sdio_func *);
e29a7d73	24
b1538bcf NP	25	/*
	26	* SDIO function CIS tuple (unknown to the core)
	27	*/
	28	struct sdio_func_tuple {
	29	struct sdio_func_tuple *next;
	30	unsigned char code;
	31	unsigned char size;
	32	unsigned char data[0];
	33	};
	34
e29a7d73 PO	35	/*
	36	* SDIO function devices
	37	*/
	38	struct sdio_func {
	39	struct mmc_card card; / the card this device belongs to */
	40	struct device dev; /* the device */
d1496c39	41	sdio_irq_handler_t irq_handler; / IRQ callback */
e29a7d73	42	unsigned int num; /* function number */
0597007f PO	43
	44	unsigned char class; /* standard interface class */
	45	unsigned short vendor; /* vendor id */
	46	unsigned short device; /* device id */
	47
9a08f82b DV	48	unsigned max_blksize; /* maximum block size */
9a08f82b DV	49	unsigned cur_blksize; /* current block size */
1a632f8c	50
62a7573e BZ	51	unsigned enable_timeout; /* max enable timeout in msec */
62a7573e BZ	52
e29a7d73 PO	53	unsigned int state; /* function state */
e29a7d73 PO	54	#define SDIO_STATE_PRESENT (1<<0) /* present in sysfs */
b1538bcf	55
112c9db9 PO	56	u8 tmpbuf[4]; /* DMA:able scratch buffer */
112c9db9 PO	57
759bdc7a PO	58	unsigned num_info; /* number of info strings */
	59	const char *info; / info strings */
	60
b1538bcf	61	struct sdio_func_tuple *tuples;
e29a7d73 PO	62	};
	63
	64	#define sdio_func_present(f) ((f)->state & SDIO_STATE_PRESENT)
	65
	66	#define sdio_func_set_present(f) ((f)->state \|= SDIO_STATE_PRESENT)
	67
d1b26863	68	#define sdio_func_id(f) (dev_name(&(f)->dev))
e29a7d73	69
f76c8515 PO	70	#define sdio_get_drvdata(f) dev_get_drvdata(&(f)->dev)
f76c8515 PO	71	#define sdio_set_drvdata(f,d) dev_set_drvdata(&(f)->dev, d)
996ad568	72	#define dev_to_sdio_func(d) container_of(d, struct sdio_func, dev)
f76c8515 PO	73
	74	/*
	75	* SDIO function device driver
	76	*/
	77	struct sdio_driver {
	78	char *name;
3b38bea0	79	const struct sdio_device_id *id_table;
f76c8515	80
3b38bea0	81	int (probe)(struct sdio_func , const struct sdio_device_id *);
f76c8515 PO	82	void (remove)(struct sdio_func );
	83
	84	struct device_driver drv;
	85	};
	86
996ad568 NP	87	#define to_sdio_driver(d) container_of(d, struct sdio_driver, drv)
996ad568 NP	88
3b38bea0 PO	89	/**
	90	* SDIO_DEVICE - macro used to describe a specific SDIO device
	91	* @vend: the 16 bit manufacturer code
	92	* @dev: the 16 bit function id
	93	*
	94	* This macro is used to create a struct sdio_device_id that matches a
	95	* specific device. The class field will be set to SDIO_ANY_ID.
	96	*/
	97	#define SDIO_DEVICE(vend,dev) \
	98	.class = SDIO_ANY_ID, \
	99	.vendor = (vend), .device = (dev)
	100
	101	/**
	102	* SDIO_DEVICE_CLASS - macro used to describe a specific SDIO device class
	103	* @dev_class: the 8 bit standard interface code
	104	*
	105	* This macro is used to create a struct sdio_device_id that matches a
	106	* specific standard SDIO function type. The vendor and device fields will
	107	* be set to SDIO_ANY_ID.
	108	*/
	109	#define SDIO_DEVICE_CLASS(dev_class) \
	110	.class = (dev_class), \
	111	.vendor = SDIO_ANY_ID, .device = SDIO_ANY_ID
	112
f76c8515 PO	113	extern int sdio_register_driver(struct sdio_driver *);
	114	extern void sdio_unregister_driver(struct sdio_driver *);
	115
46f555f2 PO	116	/*
	117	* SDIO I/O operations
	118	*/
	119	extern void sdio_claim_host(struct sdio_func *func);
	120	extern void sdio_release_host(struct sdio_func *func);
	121
fa64efa1 PO	122	extern int sdio_enable_func(struct sdio_func *func);
	123	extern int sdio_disable_func(struct sdio_func *func);
	124
9a08f82b DV	125	extern int sdio_set_block_size(struct sdio_func *func, unsigned blksz);
9a08f82b DV	126
d1496c39 NP	127	extern int sdio_claim_irq(struct sdio_func func, sdio_irq_handler_t handler);
	128	extern int sdio_release_irq(struct sdio_func *func);
	129
ad3868b2 PO	130	extern unsigned int sdio_align_size(struct sdio_func *func, unsigned int sz);
ad3868b2 PO	131
6d373331 TW	132	extern u8 sdio_readb(struct sdio_func func, unsigned int addr, int err_ret);
	133	extern u16 sdio_readw(struct sdio_func func, unsigned int addr, int err_ret);
	134	extern u32 sdio_readl(struct sdio_func func, unsigned int addr, int err_ret);
112c9db9 PO	135
	136	extern int sdio_memcpy_fromio(struct sdio_func func, void dst,
	137	unsigned int addr, int count);
	138	extern int sdio_readsb(struct sdio_func func, void dst,
	139	unsigned int addr, int count);
46f555f2	140
6d373331	141	extern void sdio_writeb(struct sdio_func *func, u8 b,
46f555f2	142	unsigned int addr, int *err_ret);
6d373331	143	extern void sdio_writew(struct sdio_func *func, u16 b,
112c9db9	144	unsigned int addr, int *err_ret);
6d373331	145	extern void sdio_writel(struct sdio_func *func, u32 b,
112c9db9 PO	146	unsigned int addr, int *err_ret);
	147
	148	extern int sdio_memcpy_toio(struct sdio_func *func, unsigned int addr,
	149	void *src, int count);
	150	extern int sdio_writesb(struct sdio_func *func, unsigned int addr,
	151	void *src, int count);
46f555f2	152
7806cdb4 DV	153	extern unsigned char sdio_f0_readb(struct sdio_func *func,
	154	unsigned int addr, int *err_ret);
	155	extern void sdio_f0_writeb(struct sdio_func *func, unsigned char b,
	156	unsigned int addr, int *err_ret);
	157
da68c4eb NP	158	extern mmc_pm_flag_t sdio_get_host_pm_caps(struct sdio_func *func);
	159	extern int sdio_set_host_pm_flags(struct sdio_func *func, mmc_pm_flag_t flags);
	160
e29a7d73 PO	161	#endif
e29a7d73 PO	162