[linux-2.6-block.git] / drivers / pcmcia / cs_internal.h

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * cs_internal.h -- definitions internal to the PCMCIA core modules
 *
 * 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 - 2010	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))

/* Flag to access all functions */
#define BIND_FN_ALL	0xff

/* Each card function gets one of these guys */
typedef struct config_t {
	struct kref	ref;
	unsigned int	state;

	struct resource io[MAX_IO_WIN]; /* io ports */
	struct resource mem[MAX_WIN];   /* mem areas */
} 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	(*find_io)		(struct pcmcia_socket *s,
					 unsigned int attr,
					 unsigned int *base,
					 unsigned int num,
					 unsigned int align,
					 struct resource **parent);
	struct resource* (*find_mem)	(unsigned long base, unsigned long num,
					 unsigned long align, int low,
					 struct pcmcia_socket *s);
	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_IN_RESUME	0x0040
#define SOCKET_SUSPEND		0x0080
#define SOCKET_WIN_REQ(i)	(0x0100<<(i))
#define SOCKET_CARDBUS		0x8000
#define SOCKET_CARDBUS_CONFIG	0x10000


/*
 * Stuff internal to module "pcmcia_rsrc":
 */
extern int static_init(struct pcmcia_socket *s);
extern struct resource *pcmcia_make_resource(resource_size_t start,
					resource_size_t end,
					unsigned long flags, const char *name);

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

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


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

struct pcmcia_callback{
	struct module	*owner;
	int		(*add) (struct pcmcia_socket *s);
	int		(*remove) (struct pcmcia_socket *s);
	void		(*requery) (struct pcmcia_socket *s);
	int		(*validate) (struct pcmcia_socket *s, unsigned int *i);
	int		(*suspend) (struct pcmcia_socket *s);
	int		(*early_resume) (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);

void pcmcia_parse_uevents(struct pcmcia_socket *socket, unsigned int events);
#define PCMCIA_UEVENT_EJECT	0x0001
#define PCMCIA_UEVENT_INSERT	0x0002
#define PCMCIA_UEVENT_SUSPEND	0x0004
#define PCMCIA_UEVENT_RESUME	0x0008
#define PCMCIA_UEVENT_REQUERY	0x0010

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

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

struct pcmcia_device;

/* pcmcia_resource.c */
extern int pcmcia_release_configuration(struct pcmcia_device *p_dev);
extern int pcmcia_validate_mem(struct pcmcia_socket *s);
extern struct resource *pcmcia_find_mem_region(u_long base,
					       u_long num,
					       u_long align,
					       int low,
					       struct pcmcia_socket *s);

void pcmcia_cleanup_irq(struct pcmcia_socket *s);
int pcmcia_setup_irq(struct pcmcia_device *p_dev);

/* cistpl.c */
extern const struct bin_attribute pccard_cis_attr;

int pcmcia_read_cis_mem(struct pcmcia_socket *s, int attr,
			u_int addr, u_int len, void *ptr);
int 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);
int verify_cis_cache(struct pcmcia_socket *s);

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

#endif /* _LINUX_CS_INTERNAL_H */
Commit	Line	Data
d2912cb1	1	/* SPDX-License-Identifier: GPL-2.0-only */
1da177e4	2	/*
dc953e55	3	* cs_internal.h -- definitions internal to the PCMCIA core modules
1da177e4	4	*
1da177e4 LT	5	* The initial developer of the original code is David A. Hinds
	6	* <dahinds@users.sourceforge.net>. Portions created by David A. Hinds
	7	* are Copyright (C) 1999 David A. Hinds. All Rights Reserved.
	8	*
	9	* (C) 1999 David A. Hinds
7b24e798	10	* (C) 2003 - 2010 Dominik Brodowski
dc953e55	11	*
dc953e55 DB	12	* This file contains definitions _only_ needed by the PCMCIA core modules.
	13	* It must not be included by PCMCIA socket drivers or by PCMCIA device
	14	* drivers.
1da177e4 LT	15	*/
	16
	17	#ifndef _LINUX_CS_INTERNAL_H
	18	#define _LINUX_CS_INTERNAL_H
	19
360b65b9	20	#include <linux/kref.h>
1da177e4	21
1da177e4	22	/* Flags in client state */
e2d40963	23	#define CLIENT_WIN_REQ(i) (0x1<<(i))
1da177e4	24
a3d0d4d8 DB	25	/* Flag to access all functions */
	26	#define BIND_FN_ALL 0xff
	27
1da177e4 LT	28	/* Each card function gets one of these guys */
1da177e4 LT	29	typedef struct config_t {
360b65b9	30	struct kref ref;
dc953e55	31	unsigned int state;
2ce4905e DB	32
2ce4905e DB	33	struct resource io[MAX_IO_WIN]; /* io ports */
0ca724d3	34	struct resource mem[MAX_WIN]; /* mem areas */
1da177e4 LT	35	} config_t;
1da177e4 LT	36
dc953e55	37
1da177e4 LT	38	struct cis_cache_entry {
	39	struct list_head node;
	40	unsigned int addr;
	41	unsigned int len;
	42	unsigned int attr;
	43	unsigned char cache[0];
	44	};
	45
c23889ca DB	46	struct pccard_resource_ops {
c23889ca DB	47	int (validate_mem) (struct pcmcia_socket s);
b19a7275 DB	48	int (find_io) (struct pcmcia_socket s,
	49	unsigned int attr,
	50	unsigned int *base,
	51	unsigned int num,
ad0c7be2 DB	52	unsigned int align,
ad0c7be2 DB	53	struct resource **parent);
c23889ca DB	54	struct resource* (*find_mem) (unsigned long base, unsigned long num,
	55	unsigned long align, int low,
	56	struct pcmcia_socket *s);
c23889ca DB	57	int (init) (struct pcmcia_socket s);
	58	void (exit) (struct pcmcia_socket s);
	59	};
	60
1da177e4 LT	61	/* Flags in config state */
	62	#define CONFIG_LOCKED 0x01
	63	#define CONFIG_IRQ_REQ 0x02
	64	#define CONFIG_IO_REQ 0x04
	65
	66	/* Flags in socket state */
	67	#define SOCKET_PRESENT 0x0008
	68	#define SOCKET_INUSE 0x0010
dbdd0f58	69	#define SOCKET_IN_RESUME 0x0040
1da177e4 LT	70	#define SOCKET_SUSPEND 0x0080
1da177e4 LT	71	#define SOCKET_WIN_REQ(i) (0x0100<<(i))
1da177e4 LT	72	#define SOCKET_CARDBUS 0x8000
	73	#define SOCKET_CARDBUS_CONFIG 0x10000
	74
dc953e55	75
49b1153a DB	76	/*
	77	* Stuff internal to module "pcmcia_rsrc":
	78	*/
	79	extern int static_init(struct pcmcia_socket *s);
a6c6193a AC	80	extern struct resource *pcmcia_make_resource(resource_size_t start,
	81	resource_size_t end,
	82	unsigned long flags, const char *name);
49b1153a	83
dc953e55 DB	84	/*
	85	* Stuff internal to module "pcmcia_core":
	86	*/
	87
dc953e55 DB	88	/* socket_sysfs.c */
	89	extern int pccard_sysfs_add_socket(struct device *dev);
	90	extern void pccard_sysfs_remove_socket(struct device *dev);
	91
	92	/* cardbus.c */
	93	int cb_alloc(struct pcmcia_socket *s);
	94	void cb_free(struct pcmcia_socket *s);
dc953e55 DB	95
	96
	97
	98	/*
	99	* Stuff exported by module "pcmcia_core" to module "pcmcia"
	100	*/
	101
	102	struct pcmcia_callback{
	103	struct module *owner;
7b24e798 DB	104	int (add) (struct pcmcia_socket s);
7b24e798 DB	105	int (remove) (struct pcmcia_socket s);
af461fc1	106	void (requery) (struct pcmcia_socket s);
6e7b51a7	107	int (validate) (struct pcmcia_socket s, unsigned int *i);
dc953e55	108	int (suspend) (struct pcmcia_socket s);
7b24e798	109	int (early_resume) (struct pcmcia_socket s);
dc953e55 DB	110	int (resume) (struct pcmcia_socket s);
	111	};
	112
	113	/* cs.c */
	114	extern struct rw_semaphore pcmcia_socket_list_rwsem;
	115	extern struct list_head pcmcia_socket_list;
c23889ca DB	116	extern struct class pcmcia_socket_class;
c23889ca DB	117
dc953e55	118	int pccard_register_pcmcia(struct pcmcia_socket s, struct pcmcia_callback c);
c23889ca	119	struct pcmcia_socket *pcmcia_get_socket_by_nr(unsigned int nr);
dc953e55	120
f971dbd5 DB	121	void pcmcia_parse_uevents(struct pcmcia_socket *socket, unsigned int events);
	122	#define PCMCIA_UEVENT_EJECT 0x0001
	123	#define PCMCIA_UEVENT_INSERT 0x0002
	124	#define PCMCIA_UEVENT_SUSPEND 0x0004
	125	#define PCMCIA_UEVENT_RESUME 0x0008
af461fc1	126	#define PCMCIA_UEVENT_REQUERY 0x0010
994917f8 DB	127
	128	struct pcmcia_socket pcmcia_get_socket(struct pcmcia_socket skt);
	129	void pcmcia_put_socket(struct pcmcia_socket *skt);
	130
6e7b51a7 DB	131	/*
	132	* Stuff internal to module "pcmcia".
	133	*/
	134	/* ds.c */
	135	extern struct bus_type pcmcia_bus_type;
	136
5716d415 DB	137	struct pcmcia_device;
5716d415 DB	138
6e7b51a7 DB	139	/* pcmcia_resource.c */
6e7b51a7 DB	140	extern int pcmcia_release_configuration(struct pcmcia_device *p_dev);
a3ac9af5 DB	141	extern int pcmcia_validate_mem(struct pcmcia_socket *s);
	142	extern struct resource *pcmcia_find_mem_region(u_long base,
	143	u_long num,
	144	u_long align,
	145	int low,
	146	struct pcmcia_socket *s);
	147
6f0f38c4 DB	148	void pcmcia_cleanup_irq(struct pcmcia_socket *s);
6f0f38c4 DB	149	int pcmcia_setup_irq(struct pcmcia_device *p_dev);
6e7b51a7	150
dc953e55	151	/* cistpl.c */
c151206b	152	extern const struct bin_attribute pccard_cis_attr;
6e7b51a7	153
dc953e55 DB	154	int pcmcia_read_cis_mem(struct pcmcia_socket *s, int attr,
dc953e55 DB	155	u_int addr, u_int len, void *ptr);
1d5cc192 DB	156	int pcmcia_write_cis_mem(struct pcmcia_socket *s, int attr,
1d5cc192 DB	157	u_int addr, u_int len, void *ptr);
dc953e55 DB	158	void release_cis_mem(struct pcmcia_socket *s);
	159	void destroy_cis_cache(struct pcmcia_socket *s);
	160	int pccard_read_tuple(struct pcmcia_socket *s, unsigned int function,
	161	cisdata_t code, void *parse);
994917f8 DB	162	int pcmcia_replace_cis(struct pcmcia_socket *s,
994917f8 DB	163	const u8 *data, const size_t len);
84897fc0	164	int pccard_validate_cis(struct pcmcia_socket s, unsigned int count);
6e7b51a7	165	int verify_cis_cache(struct pcmcia_socket *s);
dc953e55	166
91284224 DB	167	int pccard_loop_tuple(struct pcmcia_socket *s, unsigned int function,
	168	cisdata_t code, cisparse_t parse, void priv_data,
	169	int (loop_tuple) (tuple_t tuple,
	170	cisparse_t *parse,
	171	void *priv_data));
	172
18a7a19b DB	173	int pccard_get_first_tuple(struct pcmcia_socket *s, unsigned int function,
	174	tuple_t *tuple);
	175
	176	int pccard_get_next_tuple(struct pcmcia_socket *s, unsigned int function,
	177	tuple_t *tuple);
	178
	179	int pccard_get_tuple_data(struct pcmcia_socket s, tuple_t tuple);
	180
1da177e4	181	#endif /* _LINUX_CS_INTERNAL_H */