[mirror_ubuntu-eoan-kernel.git] / include / pcmcia / ds.h

/*
 * ds.h -- 16-bit PCMCIA core support
 *
 * 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
 */

#ifndef _LINUX_DS_H
#define _LINUX_DS_H

#ifdef __KERNEL__
#include <linux/mod_devicetable.h>
#endif

#include <pcmcia/device_id.h>

#ifdef __KERNEL__
#include <linux/device.h>
#include <linux/interrupt.h>
#include <pcmcia/ss.h>
#include <linux/atomic.h>


/*
 * PCMCIA device drivers (16-bit cards only; 32-bit cards require CardBus
 * a.k.a. PCI drivers
 */
struct pcmcia_socket;
struct pcmcia_device;
struct config_t;
struct net_device;

/* dynamic device IDs for PCMCIA device drivers. See
 * Documentation/pcmcia/driver.txt for details.
*/
struct pcmcia_dynids {
	struct mutex		lock;
	struct list_head	list;
};

struct pcmcia_driver {
	const char		*name;

	int (*probe)		(struct pcmcia_device *dev);
	void (*remove)		(struct pcmcia_device *dev);

	int (*suspend)		(struct pcmcia_device *dev);
	int (*resume)		(struct pcmcia_device *dev);

	struct module		*owner;
	const struct pcmcia_device_id	*id_table;
	struct device_driver	drv;
	struct pcmcia_dynids	dynids;
};

/* driver registration */
int pcmcia_register_driver(struct pcmcia_driver *driver);
void pcmcia_unregister_driver(struct pcmcia_driver *driver);

/**
 * module_pcmcia_driver() - Helper macro for registering a pcmcia driver
 * @__pcmcia_driver: pcmcia_driver struct
 *
 * Helper macro for pcmcia drivers which do not do anything special in module
 * init/exit. This eliminates a lot of boilerplate. Each module may only use
 * this macro once, and calling it replaces module_init() and module_exit().
 */
#define module_pcmcia_driver(__pcmcia_driver) \
	module_driver(__pcmcia_driver, pcmcia_register_driver, \
			pcmcia_unregister_driver)

/* for struct resource * array embedded in struct pcmcia_device */
enum {
	PCMCIA_IOPORT_0,
	PCMCIA_IOPORT_1,
	PCMCIA_IOMEM_0,
	PCMCIA_IOMEM_1,
	PCMCIA_IOMEM_2,
	PCMCIA_IOMEM_3,
	PCMCIA_NUM_RESOURCES,
};

struct pcmcia_device {
	/* the socket and the device_no [for multifunction devices]
	   uniquely define a pcmcia_device */
	struct pcmcia_socket	*socket;

	char			*devname;

	u8			device_no;

	/* the hardware "function" device; certain subdevices can
	 * share one hardware "function" device. */
	u8			func;
	struct config_t		*function_config;

	struct list_head	socket_device_list;

	/* device setup */
	unsigned int		irq;
	struct resource		*resource[PCMCIA_NUM_RESOURCES];
	resource_size_t		card_addr;	/* for the 1st IOMEM resource */
	unsigned int		vpp;

	unsigned int		config_flags;	/* CONF_ENABLE_ flags below */
	unsigned int		config_base;
	unsigned int		config_index;
	unsigned int		config_regs;	/* PRESENT_ flags below */
	unsigned int		io_lines;	/* number of I/O lines */

	/* Is the device suspended? */
	u16			suspended:1;

	/* Flags whether io, irq, win configurations were
	 * requested, and whether the configuration is "locked" */
	u16			_irq:1;
	u16			_io:1;
	u16			_win:4;
	u16			_locked:1;

	/* Flag whether a "fuzzy" func_id based match is
	 * allowed. */
	u16			allow_func_id_match:1;

	/* information about this device */
	u16			has_manf_id:1;
	u16			has_card_id:1;
	u16			has_func_id:1;

	u16			reserved:4;

	u8			func_id;
	u16			manf_id;
	u16			card_id;

	char			*prod_id[4];

	u64			dma_mask;
	struct device		dev;

	/* data private to drivers */
	void			*priv;
	unsigned int		open;
};

#define to_pcmcia_dev(n) container_of(n, struct pcmcia_device, dev)
#define to_pcmcia_drv(n) container_of(n, struct pcmcia_driver, drv)


/*
 * CIS access.
 *
 * Please use the following functions to access CIS tuples:
 * - pcmcia_get_tuple()
 * - pcmcia_loop_tuple()
 * - pcmcia_get_mac_from_cis()
 *
 * To parse a tuple_t, pcmcia_parse_tuple() exists. Its interface
 * might change in future.
 */

/* get the very first CIS entry of type @code. Note that buf is pointer
 * to u8 *buf; and that you need to kfree(buf) afterwards. */
size_t pcmcia_get_tuple(struct pcmcia_device *p_dev, cisdata_t code,
			u8 **buf);

/* loop over CIS entries */
int pcmcia_loop_tuple(struct pcmcia_device *p_dev, cisdata_t code,
		      int (*loop_tuple) (struct pcmcia_device *p_dev,
					 tuple_t *tuple,
					 void *priv_data),
		      void *priv_data);

/* get the MAC address from CISTPL_FUNCE */
int pcmcia_get_mac_from_cis(struct pcmcia_device *p_dev,
			    struct net_device *dev);


/* parse a tuple_t */
int pcmcia_parse_tuple(tuple_t *tuple, cisparse_t *parse);

/* loop CIS entries for valid configuration */
int pcmcia_loop_config(struct pcmcia_device *p_dev,
		       int	(*conf_check)	(struct pcmcia_device *p_dev,
						 void *priv_data),
		       void *priv_data);

/* is the device still there? */
struct pcmcia_device *pcmcia_dev_present(struct pcmcia_device *p_dev);

/* low-level interface reset */
int pcmcia_reset_card(struct pcmcia_socket *skt);

/* CIS config */
int pcmcia_read_config_byte(struct pcmcia_device *p_dev, off_t where, u8 *val);
int pcmcia_write_config_byte(struct pcmcia_device *p_dev, off_t where, u8 val);

/* device configuration */
int pcmcia_request_io(struct pcmcia_device *p_dev);

int __must_check pcmcia_request_irq(struct pcmcia_device *p_dev,
				irq_handler_t handler);

int pcmcia_enable_device(struct pcmcia_device *p_dev);

int pcmcia_request_window(struct pcmcia_device *p_dev, struct resource *res,
			unsigned int speed);
int pcmcia_release_window(struct pcmcia_device *p_dev, struct resource *res);
int pcmcia_map_mem_page(struct pcmcia_device *p_dev, struct resource *res,
			unsigned int offset);

int pcmcia_fixup_vpp(struct pcmcia_device *p_dev, unsigned char new_vpp);
int pcmcia_fixup_iowidth(struct pcmcia_device *p_dev);

void pcmcia_disable_device(struct pcmcia_device *p_dev);

/* IO ports */
#define IO_DATA_PATH_WIDTH	0x18
#define IO_DATA_PATH_WIDTH_8	0x00
#define IO_DATA_PATH_WIDTH_16	0x08
#define IO_DATA_PATH_WIDTH_AUTO	0x10

/* IO memory */
#define WIN_MEMORY_TYPE_CM	0x00 /* default */
#define WIN_MEMORY_TYPE_AM	0x20 /* MAP_ATTRIB */
#define WIN_DATA_WIDTH_8	0x00 /* default */
#define WIN_DATA_WIDTH_16	0x02 /* MAP_16BIT */
#define WIN_ENABLE		0x01 /* MAP_ACTIVE */
#define WIN_USE_WAIT		0x40 /* MAP_USE_WAIT */

#define WIN_FLAGS_MAP		0x63 /* MAP_ATTRIB | MAP_16BIT | MAP_ACTIVE |
					MAP_USE_WAIT */
#define WIN_FLAGS_REQ		0x1c /* mapping to socket->win[i]:
					0x04 -> 0
					0x08 -> 1
					0x0c -> 2
					0x10 -> 3 */

/* config_reg{ister}s present for this PCMCIA device */
#define PRESENT_OPTION		0x001
#define PRESENT_STATUS		0x002
#define PRESENT_PIN_REPLACE	0x004
#define PRESENT_COPY		0x008
#define PRESENT_EXT_STATUS	0x010
#define PRESENT_IOBASE_0	0x020
#define PRESENT_IOBASE_1	0x040
#define PRESENT_IOBASE_2	0x080
#define PRESENT_IOBASE_3	0x100
#define PRESENT_IOSIZE		0x200

/* flags to be passed to pcmcia_enable_device() */
#define CONF_ENABLE_IRQ         0x0001
#define CONF_ENABLE_SPKR        0x0002
#define CONF_ENABLE_PULSE_IRQ   0x0004
#define CONF_ENABLE_ESR         0x0008
#define CONF_ENABLE_IOCARD	0x0010 /* auto-enabled if IO resources or IRQ
					* (CONF_ENABLE_IRQ) in use */
#define CONF_ENABLE_ZVCARD	0x0020

/* flags used by pcmcia_loop_config() autoconfiguration */
#define CONF_AUTO_CHECK_VCC	0x0100 /* check for matching Vcc? */
#define CONF_AUTO_SET_VPP	0x0200 /* set Vpp? */
#define CONF_AUTO_AUDIO		0x0400 /* enable audio line? */
#define CONF_AUTO_SET_IO	0x0800 /* set ->resource[0,1] */
#define CONF_AUTO_SET_IOMEM	0x1000 /* set ->resource[2] */

#endif /* __KERNEL__ */

#endif /* _LINUX_DS_H */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* ds.h -- 16-bit PCMCIA core support
	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
a5835786	13	* (C) 2003 - 2008 Dominik Brodowski
1da177e4 LT	14	*/
	15
	16	#ifndef _LINUX_DS_H
	17	#define _LINUX_DS_H
	18
8e2f3b70 DB	19	#ifdef __KERNEL__
	20	#include <linux/mod_devicetable.h>
	21	#endif
	22
1ad275e3	23	#include <pcmcia/device_id.h>
1da177e4	24
1da177e4 LT	25	#ifdef __KERNEL__
1da177e4 LT	26	#include <linux/device.h>
1ac71e5a	27	#include <linux/interrupt.h>
e2d40963	28	#include <pcmcia/ss.h>
60063497	29	#include <linux/atomic.h>
1da177e4	30
1ac71e5a	31
a5835786 DB	32	/*
	33	* PCMCIA device drivers (16-bit cards only; 32-bit cards require CardBus
	34	* a.k.a. PCI drivers
	35	*/
1da177e4	36	struct pcmcia_socket;
a5835786	37	struct pcmcia_device;
dbb22f0d	38	struct config_t;
91284224	39	struct net_device;
1da177e4	40
a5835786 DB	41	/* dynamic device IDs for PCMCIA device drivers. See
	42	* Documentation/pcmcia/driver.txt for details.
	43	*/
6179b556	44	struct pcmcia_dynids {
3f565232	45	struct mutex lock;
6179b556 BW	46	struct list_head list;
	47	};
	48
1da177e4	49	struct pcmcia_driver {
2e9b981a DB	50	const char *name;
2e9b981a DB	51
f8cfa618	52	int (probe) (struct pcmcia_device dev);
cc3b4866 DB	53	void (remove) (struct pcmcia_device dev);
cc3b4866 DB	54
98e4c28b DB	55	int (suspend) (struct pcmcia_device dev);
	56	int (resume) (struct pcmcia_device dev);
	57
1da177e4	58	struct module *owner;
e9fb13bf	59	const struct pcmcia_device_id *id_table;
1da177e4	60	struct device_driver drv;
6179b556	61	struct pcmcia_dynids dynids;
1da177e4 LT	62	};
	63
	64	/* driver registration */
	65	int pcmcia_register_driver(struct pcmcia_driver *driver);
	66	void pcmcia_unregister_driver(struct pcmcia_driver *driver);
	67
6ed7ffdd HS	68	/**
	69	* module_pcmcia_driver() - Helper macro for registering a pcmcia driver
	70	* @__pcmcia_driver: pcmcia_driver struct
	71	*
	72	* Helper macro for pcmcia drivers which do not do anything special in module
	73	* init/exit. This eliminates a lot of boilerplate. Each module may only use
	74	* this macro once, and calling it replaces module_init() and module_exit().
	75	*/
	76	#define module_pcmcia_driver(__pcmcia_driver) \
	77	module_driver(__pcmcia_driver, pcmcia_register_driver, \
	78	pcmcia_unregister_driver)
	79
0ca724d3 DB	80	/* for struct resource * array embedded in struct pcmcia_device */
	81	enum {
	82	PCMCIA_IOPORT_0,
	83	PCMCIA_IOPORT_1,
	84	PCMCIA_IOMEM_0,
	85	PCMCIA_IOMEM_1,
	86	PCMCIA_IOMEM_2,
	87	PCMCIA_IOMEM_3,
	88	PCMCIA_NUM_RESOURCES,
	89	};
	90
1da177e4 LT	91	struct pcmcia_device {
	92	/* the socket and the device_no [for multifunction devices]
	93	uniquely define a pcmcia_device */
	94	struct pcmcia_socket *socket;
	95
bd65a685 BG	96	char *devname;
bd65a685 BG	97
1da177e4 LT	98	u8 device_no;
	99
	100	/* the hardware "function" device; certain subdevices can
	101	* share one hardware "function" device. */
	102	u8 func;
9fea84f4	103	struct config_t *function_config;
1da177e4 LT	104
	105	struct list_head socket_device_list;
	106
6f0f38c4	107	/* device setup */
eb14120f	108	unsigned int irq;
0ca724d3	109	struct resource *resource[PCMCIA_NUM_RESOURCES];
00990e7c	110	resource_size_t card_addr; /* for the 1st IOMEM resource */
e8405f0f	111	unsigned int vpp;
6f0f38c4	112
1ac71e5a	113	unsigned int config_flags; /* CONF_ENABLE_ flags below */
7feabb64 DB	114	unsigned int config_base;
	115	unsigned int config_index;
	116	unsigned int config_regs; /* PRESENT_ flags below */
1ac71e5a	117	unsigned int io_lines; /* number of I/O lines */
90abdc3b	118
04de0816	119	/* Is the device suspended? */
e2d40963 DB	120	u16 suspended:1;
	121
	122	/* Flags whether io, irq, win configurations were
	123	* requested, and whether the configuration is "locked" */
	124	u16 _irq:1;
	125	u16 _io:1;
	126	u16 _win:4;
	127	u16 _locked:1;
1da177e4	128
e2d40963 DB	129	/* Flag whether a "fuzzy" func_id based match is
	130	* allowed. */
	131	u16 allow_func_id_match:1;
f6fbe01a	132
1da177e4	133	/* information about this device */
e2d40963 DB	134	u16 has_manf_id:1;
	135	u16 has_card_id:1;
	136	u16 has_func_id:1;
1ad275e3	137
04de0816	138	u16 reserved:4;
1da177e4 LT	139
	140	u8 func_id;
	141	u16 manf_id;
	142	u16 card_id;
	143
9fea84f4	144	char *prod_id[4];
1da177e4	145
43d9f7fd	146	u64 dma_mask;
0e0fad8f DB	147	struct device dev;
0e0fad8f DB	148
e2d40963 DB	149	/* data private to drivers */
e2d40963 DB	150	void *priv;
2ce4905e	151	unsigned int open;
1da177e4 LT	152	};
	153
	154	#define to_pcmcia_dev(n) container_of(n, struct pcmcia_device, dev)
	155	#define to_pcmcia_drv(n) container_of(n, struct pcmcia_driver, drv)
	156
a5835786	157
91284224 DB	158	/*
	159	* CIS access.
	160	*
	161	* Please use the following functions to access CIS tuples:
	162	* - pcmcia_get_tuple()
	163	* - pcmcia_loop_tuple()
	164	* - pcmcia_get_mac_from_cis()
	165	*
	166	* To parse a tuple_t, pcmcia_parse_tuple() exists. Its interface
	167	* might change in future.
272433e0	168	*/
272433e0	169
91284224 DB	170	/* get the very first CIS entry of type @code. Note that buf is pointer
	171	* to u8 buf; and that you need to kfree(buf) afterwards. /
	172	size_t pcmcia_get_tuple(struct pcmcia_device *p_dev, cisdata_t code,
	173	u8 **buf);
272433e0	174
91284224 DB	175	/* loop over CIS entries */
	176	int pcmcia_loop_tuple(struct pcmcia_device *p_dev, cisdata_t code,
	177	int (loop_tuple) (struct pcmcia_device p_dev,
	178	tuple_t *tuple,
	179	void *priv_data),
	180	void *priv_data);
272433e0	181
91284224 DB	182	/* get the MAC address from CISTPL_FUNCE */
	183	int pcmcia_get_mac_from_cis(struct pcmcia_device *p_dev,
	184	struct net_device *dev);
272433e0 DB	185
272433e0 DB	186
91284224 DB	187	/* parse a tuple_t */
	188	int pcmcia_parse_tuple(tuple_t tuple, cisparse_t parse);
	189
272433e0 DB	190	/* loop CIS entries for valid configuration */
	191	int pcmcia_loop_config(struct pcmcia_device *p_dev,
	192	int (conf_check) (struct pcmcia_device p_dev,
272433e0 DB	193	void *priv_data),
272433e0 DB	194	void *priv_data);
1da177e4	195
994917f8 DB	196	/* is the device still there? */
	197	struct pcmcia_device pcmcia_dev_present(struct pcmcia_device p_dev);
	198
	199	/* low-level interface reset */
	200	int pcmcia_reset_card(struct pcmcia_socket *skt);
	201
	202	/* CIS config */
1d5cc192 DB	203	int pcmcia_read_config_byte(struct pcmcia_device p_dev, off_t where, u8 val);
1d5cc192 DB	204	int pcmcia_write_config_byte(struct pcmcia_device *p_dev, off_t where, u8 val);
994917f8 DB	205
994917f8 DB	206	/* device configuration */
90abdc3b	207	int pcmcia_request_io(struct pcmcia_device *p_dev);
eb14120f	208
eb14120f DB	209	int __must_check pcmcia_request_irq(struct pcmcia_device *p_dev,
	210	irq_handler_t handler);
	211
1ac71e5a	212	int pcmcia_enable_device(struct pcmcia_device *p_dev);
994917f8	213
cdb13808 DB	214	int pcmcia_request_window(struct pcmcia_device p_dev, struct resource res,
	215	unsigned int speed);
	216	int pcmcia_release_window(struct pcmcia_device p_dev, struct resource res);
	217	int pcmcia_map_mem_page(struct pcmcia_device p_dev, struct resource res,
b5cb259e	218	unsigned int offset);
994917f8	219
fb49fa53 DB	220	int pcmcia_fixup_vpp(struct pcmcia_device *p_dev, unsigned char new_vpp);
	221	int pcmcia_fixup_iowidth(struct pcmcia_device *p_dev);
	222
994917f8 DB	223	void pcmcia_disable_device(struct pcmcia_device *p_dev);
994917f8 DB	224
90abdc3b DB	225	/* IO ports */
	226	#define IO_DATA_PATH_WIDTH 0x18
	227	#define IO_DATA_PATH_WIDTH_8 0x00
	228	#define IO_DATA_PATH_WIDTH_16 0x08
	229	#define IO_DATA_PATH_WIDTH_AUTO 0x10
	230
cdb13808 DB	231	/* IO memory */
	232	#define WIN_MEMORY_TYPE_CM 0x00 /* default */
	233	#define WIN_MEMORY_TYPE_AM 0x20 /* MAP_ATTRIB */
	234	#define WIN_DATA_WIDTH_8 0x00 /* default */
	235	#define WIN_DATA_WIDTH_16 0x02 /* MAP_16BIT */
	236	#define WIN_ENABLE 0x01 /* MAP_ACTIVE */
	237	#define WIN_USE_WAIT 0x40 /* MAP_USE_WAIT */
	238
	239	#define WIN_FLAGS_MAP 0x63 /* MAP_ATTRIB \| MAP_16BIT \| MAP_ACTIVE \|
	240	MAP_USE_WAIT */
	241	#define WIN_FLAGS_REQ 0x1c /* mapping to socket->win[i]:
	242	0x04 -> 0
	243	0x08 -> 1
	244	0x0c -> 2
	245	0x10 -> 3 */
	246
7feabb64 DB	247	/* config_reg{ister}s present for this PCMCIA device */
	248	#define PRESENT_OPTION 0x001
	249	#define PRESENT_STATUS 0x002
	250	#define PRESENT_PIN_REPLACE 0x004
	251	#define PRESENT_COPY 0x008
	252	#define PRESENT_EXT_STATUS 0x010
	253	#define PRESENT_IOBASE_0 0x020
	254	#define PRESENT_IOBASE_1 0x040
	255	#define PRESENT_IOBASE_2 0x080
	256	#define PRESENT_IOBASE_3 0x100
	257	#define PRESENT_IOSIZE 0x200
cdb13808	258
1ac71e5a	259	/* flags to be passed to pcmcia_enable_device() */
00990e7c DB	260	#define CONF_ENABLE_IRQ 0x0001
	261	#define CONF_ENABLE_SPKR 0x0002
	262	#define CONF_ENABLE_PULSE_IRQ 0x0004
	263	#define CONF_ENABLE_ESR 0x0008
ff10fca5 DB	264	#define CONF_ENABLE_IOCARD 0x0010 /* auto-enabled if IO resources or IRQ
ff10fca5 DB	265	* (CONF_ENABLE_IRQ) in use */
33619f0d	266	#define CONF_ENABLE_ZVCARD 0x0020
1ac71e5a	267
440eed43	268	/* flags used by pcmcia_loop_config() autoconfiguration */
00990e7c DB	269	#define CONF_AUTO_CHECK_VCC 0x0100 /* check for matching Vcc? */
	270	#define CONF_AUTO_SET_VPP 0x0200 /* set Vpp? */
	271	#define CONF_AUTO_AUDIO 0x0400 /* enable audio line? */
	272	#define CONF_AUTO_SET_IO 0x0800 /* set ->resource[0,1] */
	273	#define CONF_AUTO_SET_IOMEM 0x1000 /* set ->resource[2] */
440eed43	274
1da177e4	275	#endif /* __KERNEL__ */
a5835786	276
1da177e4	277	#endif /* _LINUX_DS_H */