[net-next-2.6.git] / drivers / pcmcia / cs_internal.h

/*
 * cs_internal.h -- definitions internal to the PCMCIA core modules
 *
 * 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.
 *
 * The initial developer of the original code is David A. Hinds
 * <dahinds@users.sourceforge.net>.  Portions created by David A. Hinds
 * are Copyright (C) 1999 David A. Hinds.  All Rights Reserved.
 *
 * (C) 1999		David A. Hinds
 * (C) 2003 - 2008	Dominik Brodowski
 *
 *
 * This file contains definitions _only_ needed by the PCMCIA core modules.
 * It must not be included by PCMCIA socket drivers or by PCMCIA device
 * drivers.
 */

#ifndef _LINUX_CS_INTERNAL_H
#define _LINUX_CS_INTERNAL_H

#include <linux/kref.h>

/* Flags in client state */
#define CLIENT_WIN_REQ(i)	(0x1<<(i))

/* Each card function gets one of these guys */
typedef struct config_t {
	struct kref	ref;
	unsigned int	state;
	unsigned int	Attributes;
	unsigned int	IntType;
	unsigned int	ConfigBase;
	unsigned char	Status, Pin, Copy, Option, ExtStatus;
	unsigned int	CardValues;
	io_req_t	io;
	struct {
		u_int	Attributes;
	} irq;
} config_t;


struct cis_cache_entry {
	struct list_head	node;
	unsigned int		addr;
	unsigned int		len;
	unsigned int		attr;
	unsigned char		cache[0];
};

struct pccard_resource_ops {
	int	(*validate_mem)		(struct pcmcia_socket *s);
	int	(*adjust_io_region)	(struct resource *res,
					 unsigned long r_start,
					 unsigned long r_end,
					 struct pcmcia_socket *s);
	struct resource* (*find_io)	(unsigned long base, int num,
					 unsigned long align,
					 struct pcmcia_socket *s);
	struct resource* (*find_mem)	(unsigned long base, unsigned long num,
					 unsigned long align, int low,
					 struct pcmcia_socket *s);
	int	(*add_io)		(struct pcmcia_socket *s,
					 unsigned int action,
					 unsigned long r_start,
					 unsigned long r_end);
	int	(*add_mem)		(struct pcmcia_socket *s,
					 unsigned int action,
					 unsigned long r_start,
					 unsigned long r_end);
	int	(*init)			(struct pcmcia_socket *s);
	void	(*exit)			(struct pcmcia_socket *s);
};

/* Flags in config state */
#define CONFIG_LOCKED		0x01
#define CONFIG_IRQ_REQ		0x02
#define CONFIG_IO_REQ		0x04

/* Flags in socket state */
#define SOCKET_PRESENT		0x0008
#define SOCKET_INUSE		0x0010
#define SOCKET_SUSPEND		0x0080
#define SOCKET_WIN_REQ(i)	(0x0100<<(i))
#define SOCKET_CARDBUS		0x8000
#define SOCKET_CARDBUS_CONFIG	0x10000

static inline int cs_socket_get(struct pcmcia_socket *skt)
{
	int ret;

	WARN_ON(skt->state & SOCKET_INUSE);

	ret = try_module_get(skt->owner);
	if (ret)
		skt->state |= SOCKET_INUSE;
	return ret;
}

static inline void cs_socket_put(struct pcmcia_socket *skt)
{
	if (skt->state & SOCKET_INUSE) {
		skt->state &= ~SOCKET_INUSE;
		module_put(skt->owner);
	}
}


/*
 * Stuff internal to module "pcmcia_core":
 */

/* cistpl.c */
int verify_cis_cache(struct pcmcia_socket *s);

/* rsrc_mgr.c */
void release_resource_db(struct pcmcia_socket *s);

/* socket_sysfs.c */
extern int pccard_sysfs_add_socket(struct device *dev);
extern void pccard_sysfs_remove_socket(struct device *dev);

/* cardbus.c */
int cb_alloc(struct pcmcia_socket *s);
void cb_free(struct pcmcia_socket *s);
int read_cb_mem(struct pcmcia_socket *s, int space, u_int addr, u_int len,
		void *ptr);


/*
 * Stuff exported by module "pcmcia_core" to module "pcmcia"
 */

struct pcmcia_callback{
	struct module	*owner;
	int		(*event) (struct pcmcia_socket *s,
				  event_t event, int priority);
	void		(*requery) (struct pcmcia_socket *s, int new_cis);
	int		(*suspend) (struct pcmcia_socket *s);
	int		(*resume) (struct pcmcia_socket *s);
};

/* cs.c */
extern struct rw_semaphore pcmcia_socket_list_rwsem;
extern struct list_head pcmcia_socket_list;
extern struct class pcmcia_socket_class;

int pccard_register_pcmcia(struct pcmcia_socket *s, struct pcmcia_callback *c);
struct pcmcia_socket *pcmcia_get_socket_by_nr(unsigned int nr);

int pcmcia_suspend_card(struct pcmcia_socket *skt);
int pcmcia_resume_card(struct pcmcia_socket *skt);

int pcmcia_eject_card(struct pcmcia_socket *skt);
int pcmcia_insert_card(struct pcmcia_socket *skt);

struct pcmcia_socket *pcmcia_get_socket(struct pcmcia_socket *skt);
void pcmcia_put_socket(struct pcmcia_socket *skt);

/* cistpl.c */
int pcmcia_read_cis_mem(struct pcmcia_socket *s, int attr,
			u_int addr, u_int len, void *ptr);
void pcmcia_write_cis_mem(struct pcmcia_socket *s, int attr,
			  u_int addr, u_int len, void *ptr);
void release_cis_mem(struct pcmcia_socket *s);
void destroy_cis_cache(struct pcmcia_socket *s);
int pccard_read_tuple(struct pcmcia_socket *s, unsigned int function,
		      cisdata_t code, void *parse);
int pcmcia_replace_cis(struct pcmcia_socket *s,
		       const u8 *data, const size_t len);
int pccard_validate_cis(struct pcmcia_socket *s, unsigned int *count);

/* loop over CIS entries */
int pccard_loop_tuple(struct pcmcia_socket *s, unsigned int function,
		      cisdata_t code, cisparse_t *parse, void *priv_data,
		      int (*loop_tuple) (tuple_t *tuple,
					 cisparse_t *parse,
					 void *priv_data));

int pccard_get_first_tuple(struct pcmcia_socket *s, unsigned int function,
			tuple_t *tuple);

int pccard_get_next_tuple(struct pcmcia_socket *s, unsigned int function,
			tuple_t *tuple);

int pccard_get_tuple_data(struct pcmcia_socket *s, tuple_t *tuple);


/* rsrc_mgr.c */
int pcmcia_validate_mem(struct pcmcia_socket *s);
struct resource *pcmcia_find_io_region(unsigned long base,
				       int num,
				       unsigned long align,
				       struct pcmcia_socket *s);
int pcmcia_adjust_io_region(struct resource *res,
			    unsigned long r_start,
			    unsigned long r_end,
			    struct pcmcia_socket *s);
struct resource *pcmcia_find_mem_region(u_long base,
					u_long num,
					u_long align,
					int low,
					struct pcmcia_socket *s);

/*
 * Stuff internal to module "pcmcia".
 */
/* ds.c */
extern struct bus_type pcmcia_bus_type;

/* pcmcia_resource.c */
extern int pcmcia_release_configuration(struct pcmcia_device *p_dev);

#ifdef CONFIG_PCMCIA_IOCTL
/* ds.c */
extern spinlock_t pcmcia_dev_list_lock;

extern struct pcmcia_device *pcmcia_get_dev(struct pcmcia_device *p_dev);
extern void pcmcia_put_dev(struct pcmcia_device *p_dev);

struct pcmcia_device *pcmcia_device_add(struct pcmcia_socket *s,
					unsigned int function);

/* pcmcia_ioctl.c */
extern void __init pcmcia_setup_ioctl(void);
extern void __exit pcmcia_cleanup_ioctl(void);
extern void handle_event(struct pcmcia_socket *s, event_t event);
extern int handle_request(struct pcmcia_socket *s, event_t event);

#else /* CONFIG_PCMCIA_IOCTL */

static inline void __init pcmcia_setup_ioctl(void) { return; }
static inline void __exit pcmcia_cleanup_ioctl(void) { return; }
static inline void handle_event(struct pcmcia_socket *s, event_t event)
{
	return;
}
static inline int handle_request(struct pcmcia_socket *s, event_t event)
{
	return 0;
}

#endif /* CONFIG_PCMCIA_IOCTL */

#endif /* _LINUX_CS_INTERNAL_H */
Commit	Line	Data
1da177e4	1	/*
dc953e55	2	* cs_internal.h -- definitions internal to the PCMCIA core modules
1da177e4 LT	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	* The initial developer of the original code is David A. Hinds
	9	* <dahinds@users.sourceforge.net>. Portions created by David A. Hinds
	10	* are Copyright (C) 1999 David A. Hinds. All Rights Reserved.
	11	*
	12	* (C) 1999 David A. Hinds
dc953e55 DB	13	* (C) 2003 - 2008 Dominik Brodowski
	14	*
	15	*
	16	* This file contains definitions _only_ needed by the PCMCIA core modules.
	17	* It must not be included by PCMCIA socket drivers or by PCMCIA device
	18	* drivers.
1da177e4 LT	19	*/
	20
	21	#ifndef _LINUX_CS_INTERNAL_H
	22	#define _LINUX_CS_INTERNAL_H
	23
360b65b9	24	#include <linux/kref.h>
1da177e4	25
1da177e4	26	/* Flags in client state */
e2d40963	27	#define CLIENT_WIN_REQ(i) (0x1<<(i))
1da177e4	28
1da177e4 LT	29	/* Each card function gets one of these guys */
1da177e4 LT	30	typedef struct config_t {
360b65b9	31	struct kref ref;
dc953e55 DB	32	unsigned int state;
	33	unsigned int Attributes;
	34	unsigned int IntType;
	35	unsigned int ConfigBase;
	36	unsigned char Status, Pin, Copy, Option, ExtStatus;
	37	unsigned int CardValues;
	38	io_req_t io;
	39	struct {
	40	u_int Attributes;
	41	} irq;
1da177e4 LT	42	} config_t;
1da177e4 LT	43
dc953e55	44
1da177e4 LT	45	struct cis_cache_entry {
	46	struct list_head node;
	47	unsigned int addr;
	48	unsigned int len;
	49	unsigned int attr;
	50	unsigned char cache[0];
	51	};
	52
c23889ca DB	53	struct pccard_resource_ops {
	54	int (validate_mem) (struct pcmcia_socket s);
	55	int (adjust_io_region) (struct resource res,
	56	unsigned long r_start,
	57	unsigned long r_end,
	58	struct pcmcia_socket *s);
	59	struct resource* (*find_io) (unsigned long base, int num,
	60	unsigned long align,
	61	struct pcmcia_socket *s);
	62	struct resource* (*find_mem) (unsigned long base, unsigned long num,
	63	unsigned long align, int low,
	64	struct pcmcia_socket *s);
	65	int (add_io) (struct pcmcia_socket s,
	66	unsigned int action,
	67	unsigned long r_start,
	68	unsigned long r_end);
	69	int (add_mem) (struct pcmcia_socket s,
	70	unsigned int action,
	71	unsigned long r_start,
	72	unsigned long r_end);
	73	int (init) (struct pcmcia_socket s);
	74	void (exit) (struct pcmcia_socket s);
	75	};
	76
1da177e4 LT	77	/* Flags in config state */
	78	#define CONFIG_LOCKED 0x01
	79	#define CONFIG_IRQ_REQ 0x02
	80	#define CONFIG_IO_REQ 0x04
	81
	82	/* Flags in socket state */
	83	#define SOCKET_PRESENT 0x0008
	84	#define SOCKET_INUSE 0x0010
	85	#define SOCKET_SUSPEND 0x0080
	86	#define SOCKET_WIN_REQ(i) (0x0100<<(i))
1da177e4 LT	87	#define SOCKET_CARDBUS 0x8000
	88	#define SOCKET_CARDBUS_CONFIG 0x10000
	89
	90	static inline int cs_socket_get(struct pcmcia_socket *skt)
	91	{
	92	int ret;
	93
	94	WARN_ON(skt->state & SOCKET_INUSE);
	95
	96	ret = try_module_get(skt->owner);
	97	if (ret)
	98	skt->state \|= SOCKET_INUSE;
	99	return ret;
	100	}
	101
	102	static inline void cs_socket_put(struct pcmcia_socket *skt)
	103	{
	104	if (skt->state & SOCKET_INUSE) {
	105	skt->state &= ~SOCKET_INUSE;
	106	module_put(skt->owner);
	107	}
	108	}
	109
dc953e55 DB	110
	111	/*
	112	* Stuff internal to module "pcmcia_core":
	113	*/
	114
	115	/* cistpl.c */
	116	int verify_cis_cache(struct pcmcia_socket *s);
	117
	118	/* rsrc_mgr.c */
	119	void release_resource_db(struct pcmcia_socket *s);
	120
	121	/* socket_sysfs.c */
	122	extern int pccard_sysfs_add_socket(struct device *dev);
	123	extern void pccard_sysfs_remove_socket(struct device *dev);
	124
	125	/* cardbus.c */
	126	int cb_alloc(struct pcmcia_socket *s);
	127	void cb_free(struct pcmcia_socket *s);
	128	int read_cb_mem(struct pcmcia_socket *s, int space, u_int addr, u_int len,
	129	void *ptr);
	130
	131
	132
	133	/*
	134	* Stuff exported by module "pcmcia_core" to module "pcmcia"
	135	*/
	136
	137	struct pcmcia_callback{
	138	struct module *owner;
	139	int (event) (struct pcmcia_socket s,
	140	event_t event, int priority);
	141	void (requery) (struct pcmcia_socket s, int new_cis);
	142	int (suspend) (struct pcmcia_socket s);
	143	int (resume) (struct pcmcia_socket s);
	144	};
	145
	146	/* cs.c */
	147	extern struct rw_semaphore pcmcia_socket_list_rwsem;
	148	extern struct list_head pcmcia_socket_list;
c23889ca DB	149	extern struct class pcmcia_socket_class;
c23889ca DB	150
dc953e55	151	int pccard_register_pcmcia(struct pcmcia_socket s, struct pcmcia_callback c);
c23889ca	152	struct pcmcia_socket *pcmcia_get_socket_by_nr(unsigned int nr);
dc953e55	153
994917f8 DB	154	int pcmcia_suspend_card(struct pcmcia_socket *skt);
	155	int pcmcia_resume_card(struct pcmcia_socket *skt);
	156
	157	int pcmcia_eject_card(struct pcmcia_socket *skt);
	158	int pcmcia_insert_card(struct pcmcia_socket *skt);
	159
	160	struct pcmcia_socket pcmcia_get_socket(struct pcmcia_socket skt);
	161	void pcmcia_put_socket(struct pcmcia_socket *skt);
	162
dc953e55 DB	163	/* cistpl.c */
	164	int pcmcia_read_cis_mem(struct pcmcia_socket *s, int attr,
	165	u_int addr, u_int len, void *ptr);
	166	void pcmcia_write_cis_mem(struct pcmcia_socket *s, int attr,
	167	u_int addr, u_int len, void *ptr);
	168	void release_cis_mem(struct pcmcia_socket *s);
	169	void destroy_cis_cache(struct pcmcia_socket *s);
	170	int pccard_read_tuple(struct pcmcia_socket *s, unsigned int function,
	171	cisdata_t code, void *parse);
994917f8 DB	172	int pcmcia_replace_cis(struct pcmcia_socket *s,
994917f8 DB	173	const u8 *data, const size_t len);
84897fc0	174	int pccard_validate_cis(struct pcmcia_socket s, unsigned int count);
dc953e55	175
91284224 DB	176	/* loop over CIS entries */
	177	int pccard_loop_tuple(struct pcmcia_socket *s, unsigned int function,
	178	cisdata_t code, cisparse_t parse, void priv_data,
	179	int (loop_tuple) (tuple_t tuple,
	180	cisparse_t *parse,
	181	void *priv_data));
	182
18a7a19b DB	183	int pccard_get_first_tuple(struct pcmcia_socket *s, unsigned int function,
	184	tuple_t *tuple);
	185
	186	int pccard_get_next_tuple(struct pcmcia_socket *s, unsigned int function,
	187	tuple_t *tuple);
	188
	189	int pccard_get_tuple_data(struct pcmcia_socket s, tuple_t tuple);
	190
	191
dc953e55 DB	192	/* rsrc_mgr.c */
	193	int pcmcia_validate_mem(struct pcmcia_socket *s);
	194	struct resource *pcmcia_find_io_region(unsigned long base,
	195	int num,
	196	unsigned long align,
	197	struct pcmcia_socket *s);
	198	int pcmcia_adjust_io_region(struct resource *res,
	199	unsigned long r_start,
	200	unsigned long r_end,
	201	struct pcmcia_socket *s);
	202	struct resource *pcmcia_find_mem_region(u_long base,
	203	u_long num,
	204	u_long align,
	205	int low,
	206	struct pcmcia_socket *s);
	207
b60a5ede DB	208	/*
	209	* Stuff internal to module "pcmcia".
	210	*/
	211	/* ds.c */
	212	extern struct bus_type pcmcia_bus_type;
	213
	214	/* pcmcia_resource.c */
	215	extern int pcmcia_release_configuration(struct pcmcia_device *p_dev);
	216
	217	#ifdef CONFIG_PCMCIA_IOCTL
	218	/* ds.c */
	219	extern spinlock_t pcmcia_dev_list_lock;
	220
	221	extern struct pcmcia_device pcmcia_get_dev(struct pcmcia_device p_dev);
	222	extern void pcmcia_put_dev(struct pcmcia_device *p_dev);
	223
	224	struct pcmcia_device pcmcia_device_add(struct pcmcia_socket s,
	225	unsigned int function);
	226
	227	/* pcmcia_ioctl.c */
	228	extern void __init pcmcia_setup_ioctl(void);
	229	extern void __exit pcmcia_cleanup_ioctl(void);
	230	extern void handle_event(struct pcmcia_socket *s, event_t event);
	231	extern int handle_request(struct pcmcia_socket *s, event_t event);
	232
	233	#else /* CONFIG_PCMCIA_IOCTL */
	234
	235	static inline void __init pcmcia_setup_ioctl(void) { return; }
	236	static inline void __exit pcmcia_cleanup_ioctl(void) { return; }
	237	static inline void handle_event(struct pcmcia_socket *s, event_t event)
	238	{
	239	return;
	240	}
	241	static inline int handle_request(struct pcmcia_socket *s, event_t event)
	242	{
	243	return 0;
	244	}
	245
	246	#endif /* CONFIG_PCMCIA_IOCTL */
	247
1da177e4	248	#endif /* _LINUX_CS_INTERNAL_H */