[mirror_ubuntu-bionic-kernel.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


/*
 * 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		(*event) (struct pcmcia_socket *s,
				  event_t event, int priority);
	void		(*requery) (struct pcmcia_socket *s);
	int		(*validate) (struct pcmcia_socket *s, unsigned int *i);
	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);

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;

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


/* cistpl.c */
extern 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);
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);
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);


#ifdef CONFIG_PCMCIA_IOCTL
/* ds.c */
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
dc953e55 DB	90
	91	/*
	92	* Stuff internal to module "pcmcia_core":
	93	*/
	94
dc953e55 DB	95	/* socket_sysfs.c */
	96	extern int pccard_sysfs_add_socket(struct device *dev);
	97	extern void pccard_sysfs_remove_socket(struct device *dev);
	98
	99	/* cardbus.c */
	100	int cb_alloc(struct pcmcia_socket *s);
	101	void cb_free(struct pcmcia_socket *s);
dc953e55 DB	102
	103
	104
	105	/*
	106	* Stuff exported by module "pcmcia_core" to module "pcmcia"
	107	*/
	108
	109	struct pcmcia_callback{
	110	struct module *owner;
	111	int (event) (struct pcmcia_socket s,
	112	event_t event, int priority);
af461fc1	113	void (requery) (struct pcmcia_socket s);
6e7b51a7	114	int (validate) (struct pcmcia_socket s, unsigned int *i);
dc953e55 DB	115	int (suspend) (struct pcmcia_socket s);
	116	int (resume) (struct pcmcia_socket s);
	117	};
	118
	119	/* cs.c */
	120	extern struct rw_semaphore pcmcia_socket_list_rwsem;
	121	extern struct list_head pcmcia_socket_list;
c23889ca DB	122	extern struct class pcmcia_socket_class;
c23889ca DB	123
dc953e55	124	int pccard_register_pcmcia(struct pcmcia_socket s, struct pcmcia_callback c);
c23889ca	125	struct pcmcia_socket *pcmcia_get_socket_by_nr(unsigned int nr);
dc953e55	126
f971dbd5 DB	127	void pcmcia_parse_uevents(struct pcmcia_socket *socket, unsigned int events);
	128	#define PCMCIA_UEVENT_EJECT 0x0001
	129	#define PCMCIA_UEVENT_INSERT 0x0002
	130	#define PCMCIA_UEVENT_SUSPEND 0x0004
	131	#define PCMCIA_UEVENT_RESUME 0x0008
af461fc1	132	#define PCMCIA_UEVENT_REQUERY 0x0010
994917f8 DB	133
	134	struct pcmcia_socket pcmcia_get_socket(struct pcmcia_socket skt);
	135	void pcmcia_put_socket(struct pcmcia_socket *skt);
	136
6e7b51a7 DB	137	/*
	138	* Stuff internal to module "pcmcia".
	139	*/
	140	/* ds.c */
	141	extern struct bus_type pcmcia_bus_type;
	142
	143	/* pcmcia_resource.c */
	144	extern int pcmcia_release_configuration(struct pcmcia_device *p_dev);
a3ac9af5 DB	145	extern int pcmcia_validate_mem(struct pcmcia_socket *s);
	146	extern struct resource *pcmcia_find_mem_region(u_long base,
	147	u_long num,
	148	u_long align,
	149	int low,
	150	struct pcmcia_socket *s);
	151
6e7b51a7	152
dc953e55	153	/* cistpl.c */
6e7b51a7 DB	154	extern struct bin_attribute pccard_cis_attr;
6e7b51a7 DB	155
dc953e55 DB	156	int pcmcia_read_cis_mem(struct pcmcia_socket *s, int attr,
	157	u_int addr, u_int len, void *ptr);
	158	void pcmcia_write_cis_mem(struct pcmcia_socket *s, int attr,
	159	u_int addr, u_int len, void *ptr);
	160	void release_cis_mem(struct pcmcia_socket *s);
	161	void destroy_cis_cache(struct pcmcia_socket *s);
	162	int pccard_read_tuple(struct pcmcia_socket *s, unsigned int function,
	163	cisdata_t code, void *parse);
994917f8 DB	164	int pcmcia_replace_cis(struct pcmcia_socket *s,
994917f8 DB	165	const u8 *data, const size_t len);
84897fc0	166	int pccard_validate_cis(struct pcmcia_socket s, unsigned int count);
6e7b51a7	167	int verify_cis_cache(struct pcmcia_socket *s);
dc953e55	168
91284224 DB	169	int pccard_loop_tuple(struct pcmcia_socket *s, unsigned int function,
	170	cisdata_t code, cisparse_t parse, void priv_data,
	171	int (loop_tuple) (tuple_t tuple,
	172	cisparse_t *parse,
	173	void *priv_data));
	174
18a7a19b DB	175	int pccard_get_first_tuple(struct pcmcia_socket *s, unsigned int function,
	176	tuple_t *tuple);
	177
	178	int pccard_get_next_tuple(struct pcmcia_socket *s, unsigned int function,
	179	tuple_t *tuple);
	180
	181	int pccard_get_tuple_data(struct pcmcia_socket s, tuple_t tuple);
	182
	183
b60a5ede DB	184	#ifdef CONFIG_PCMCIA_IOCTL
b60a5ede DB	185	/* ds.c */
b60a5ede DB	186	extern struct pcmcia_device pcmcia_get_dev(struct pcmcia_device p_dev);
	187	extern void pcmcia_put_dev(struct pcmcia_device *p_dev);
	188
	189	struct pcmcia_device pcmcia_device_add(struct pcmcia_socket s,
	190	unsigned int function);
	191
	192	/* pcmcia_ioctl.c */
	193	extern void __init pcmcia_setup_ioctl(void);
	194	extern void __exit pcmcia_cleanup_ioctl(void);
	195	extern void handle_event(struct pcmcia_socket *s, event_t event);
	196	extern int handle_request(struct pcmcia_socket *s, event_t event);
	197
	198	#else /* CONFIG_PCMCIA_IOCTL */
	199
	200	static inline void __init pcmcia_setup_ioctl(void) { return; }
	201	static inline void __exit pcmcia_cleanup_ioctl(void) { return; }
	202	static inline void handle_event(struct pcmcia_socket *s, event_t event)
	203	{
	204	return;
	205	}
	206	static inline int handle_request(struct pcmcia_socket *s, event_t event)
	207	{
	208	return 0;
	209	}
	210
	211	#endif /* CONFIG_PCMCIA_IOCTL */
	212
1da177e4	213	#endif /* _LINUX_CS_INTERNAL_H */