[mirror_ubuntu-zesty-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 <pcmcia/ss.h>
#include <asm/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 {
	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;
	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);

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

	/* deprecated, will be cleaned up soon */
	config_req_t		conf;

	/* device setup */
	unsigned int		irq;
	struct resource		*resource[PCMCIA_NUM_RESOURCES];
	unsigned int		vpp;

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

	/* 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,
						 cistpl_cftable_entry_t *cf,
						 cistpl_cftable_entry_t *dflt,
						 unsigned int vcc,
						 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_exclusive_irq(struct pcmcia_device *p_dev,
				irq_handler_t handler);
static inline __must_check __deprecated int
pcmcia_request_exclusive_irq(struct pcmcia_device *p_dev,
				irq_handler_t handler)
{
	return __pcmcia_request_exclusive_irq(p_dev, handler);
}

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

int pcmcia_request_configuration(struct pcmcia_device *p_dev,
				 config_req_t *req);

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

/* convert flag found in cfgtable to data path width parameter */
static inline int pcmcia_io_cfg_data_width(unsigned int flags)
{
	if (!(flags & CISTPL_IO_8BIT))
		return IO_DATA_PATH_WIDTH_16;
	if (!(flags & CISTPL_IO_16BIT))
		return IO_DATA_PATH_WIDTH_8;
	return IO_DATA_PATH_WIDTH_AUTO;
}

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

#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>
e2d40963	27	#include <pcmcia/ss.h>
04de0816	28	#include <asm/atomic.h>
1da177e4	29
a5835786 DB	30	/*
	31	* PCMCIA device drivers (16-bit cards only; 32-bit cards require CardBus
	32	* a.k.a. PCI drivers
	33	*/
1da177e4	34	struct pcmcia_socket;
a5835786	35	struct pcmcia_device;
dbb22f0d	36	struct config_t;
91284224	37	struct net_device;
1da177e4	38
a5835786 DB	39	/* dynamic device IDs for PCMCIA device drivers. See
	40	* Documentation/pcmcia/driver.txt for details.
	41	*/
6179b556	42	struct pcmcia_dynids {
3f565232	43	struct mutex lock;
6179b556 BW	44	struct list_head list;
	45	};
	46
1da177e4	47	struct pcmcia_driver {
f8cfa618	48	int (probe) (struct pcmcia_device dev);
cc3b4866 DB	49	void (remove) (struct pcmcia_device dev);
cc3b4866 DB	50
98e4c28b DB	51	int (suspend) (struct pcmcia_device dev);
	52	int (resume) (struct pcmcia_device dev);
	53
1da177e4	54	struct module *owner;
1ad275e3	55	struct pcmcia_device_id *id_table;
1da177e4	56	struct device_driver drv;
6179b556	57	struct pcmcia_dynids dynids;
1da177e4 LT	58	};
	59
	60	/* driver registration */
	61	int pcmcia_register_driver(struct pcmcia_driver *driver);
	62	void pcmcia_unregister_driver(struct pcmcia_driver *driver);
	63
0ca724d3 DB	64	/* for struct resource * array embedded in struct pcmcia_device */
	65	enum {
	66	PCMCIA_IOPORT_0,
	67	PCMCIA_IOPORT_1,
	68	PCMCIA_IOMEM_0,
	69	PCMCIA_IOMEM_1,
	70	PCMCIA_IOMEM_2,
	71	PCMCIA_IOMEM_3,
	72	PCMCIA_NUM_RESOURCES,
	73	};
	74
1da177e4 LT	75	struct pcmcia_device {
	76	/* the socket and the device_no [for multifunction devices]
	77	uniquely define a pcmcia_device */
	78	struct pcmcia_socket *socket;
	79
bd65a685 BG	80	char *devname;
bd65a685 BG	81
1da177e4 LT	82	u8 device_no;
	83
	84	/* the hardware "function" device; certain subdevices can
	85	* share one hardware "function" device. */
	86	u8 func;
9fea84f4	87	struct config_t *function_config;
1da177e4 LT	88
	89	struct list_head socket_device_list;
	90
fd238232	91	/* deprecated, will be cleaned up soon */
fd238232	92	config_req_t conf;
fd238232	93
6f0f38c4	94	/* device setup */
eb14120f	95	unsigned int irq;
0ca724d3	96	struct resource *resource[PCMCIA_NUM_RESOURCES];
e8405f0f	97	unsigned int vpp;
6f0f38c4	98
90abdc3b	99	unsigned int io_lines; /* number of I/O lines */
7feabb64 DB	100	unsigned int config_base;
	101	unsigned int config_index;
	102	unsigned int config_regs; /* PRESENT_ flags below */
90abdc3b	103
04de0816	104	/* Is the device suspended? */
e2d40963 DB	105	u16 suspended:1;
	106
	107	/* Flags whether io, irq, win configurations were
	108	* requested, and whether the configuration is "locked" */
	109	u16 _irq:1;
	110	u16 _io:1;
	111	u16 _win:4;
	112	u16 _locked:1;
1da177e4	113
e2d40963 DB	114	/* Flag whether a "fuzzy" func_id based match is
	115	* allowed. */
	116	u16 allow_func_id_match:1;
f6fbe01a	117
1da177e4	118	/* information about this device */
e2d40963 DB	119	u16 has_manf_id:1;
	120	u16 has_card_id:1;
	121	u16 has_func_id:1;
1ad275e3	122
04de0816	123	u16 reserved:4;
1da177e4 LT	124
	125	u8 func_id;
	126	u16 manf_id;
	127	u16 card_id;
	128
9fea84f4	129	char *prod_id[4];
1da177e4	130
43d9f7fd	131	u64 dma_mask;
0e0fad8f DB	132	struct device dev;
0e0fad8f DB	133
e2d40963 DB	134	/* data private to drivers */
e2d40963 DB	135	void *priv;
2ce4905e	136	unsigned int open;
1da177e4 LT	137	};
	138
	139	#define to_pcmcia_dev(n) container_of(n, struct pcmcia_device, dev)
	140	#define to_pcmcia_drv(n) container_of(n, struct pcmcia_driver, drv)
	141
a5835786	142
91284224 DB	143	/*
	144	* CIS access.
	145	*
	146	* Please use the following functions to access CIS tuples:
	147	* - pcmcia_get_tuple()
	148	* - pcmcia_loop_tuple()
	149	* - pcmcia_get_mac_from_cis()
	150	*
	151	* To parse a tuple_t, pcmcia_parse_tuple() exists. Its interface
	152	* might change in future.
272433e0	153	*/
272433e0	154
91284224 DB	155	/* get the very first CIS entry of type @code. Note that buf is pointer
	156	* to u8 buf; and that you need to kfree(buf) afterwards. /
	157	size_t pcmcia_get_tuple(struct pcmcia_device *p_dev, cisdata_t code,
	158	u8 **buf);
272433e0	159
91284224 DB	160	/* loop over CIS entries */
	161	int pcmcia_loop_tuple(struct pcmcia_device *p_dev, cisdata_t code,
	162	int (loop_tuple) (struct pcmcia_device p_dev,
	163	tuple_t *tuple,
	164	void *priv_data),
	165	void *priv_data);
272433e0	166
91284224 DB	167	/* get the MAC address from CISTPL_FUNCE */
	168	int pcmcia_get_mac_from_cis(struct pcmcia_device *p_dev,
	169	struct net_device *dev);
272433e0 DB	170
272433e0 DB	171
91284224 DB	172	/* parse a tuple_t */
	173	int pcmcia_parse_tuple(tuple_t tuple, cisparse_t parse);
	174
272433e0 DB	175	/* loop CIS entries for valid configuration */
	176	int pcmcia_loop_config(struct pcmcia_device *p_dev,
	177	int (conf_check) (struct pcmcia_device p_dev,
	178	cistpl_cftable_entry_t *cf,
	179	cistpl_cftable_entry_t *dflt,
	180	unsigned int vcc,
	181	void *priv_data),
	182	void *priv_data);
1da177e4	183
994917f8 DB	184	/* is the device still there? */
	185	struct pcmcia_device pcmcia_dev_present(struct pcmcia_device p_dev);
	186
	187	/* low-level interface reset */
	188	int pcmcia_reset_card(struct pcmcia_socket *skt);
	189
	190	/* CIS config */
1d5cc192 DB	191	int pcmcia_read_config_byte(struct pcmcia_device p_dev, off_t where, u8 val);
1d5cc192 DB	192	int pcmcia_write_config_byte(struct pcmcia_device *p_dev, off_t where, u8 val);
994917f8 DB	193
994917f8 DB	194	/* device configuration */
90abdc3b	195	int pcmcia_request_io(struct pcmcia_device *p_dev);
eb14120f	196
b19a7275 DB	197	int __must_check
b19a7275 DB	198	__pcmcia_request_exclusive_irq(struct pcmcia_device *p_dev,
eb14120f	199	irq_handler_t handler);
b19a7275 DB	200	static inline __must_check __deprecated int
	201	pcmcia_request_exclusive_irq(struct pcmcia_device *p_dev,
	202	irq_handler_t handler)
	203	{
	204	return __pcmcia_request_exclusive_irq(p_dev, handler);
	205	}
	206
eb14120f DB	207	int __must_check pcmcia_request_irq(struct pcmcia_device *p_dev,
	208	irq_handler_t handler);
	209
994917f8 DB	210	int pcmcia_request_configuration(struct pcmcia_device *p_dev,
	211	config_req_t *req);
	212
cdb13808 DB	213	int pcmcia_request_window(struct pcmcia_device p_dev, struct resource res,
	214	unsigned int speed);
	215	int pcmcia_release_window(struct pcmcia_device p_dev, struct resource res);
	216	int pcmcia_map_mem_page(struct pcmcia_device p_dev, struct resource res,
b5cb259e	217	unsigned int offset);
994917f8	218
fb49fa53 DB	219	int pcmcia_fixup_vpp(struct pcmcia_device *p_dev, unsigned char new_vpp);
	220	int pcmcia_fixup_iowidth(struct pcmcia_device *p_dev);
	221
994917f8 DB	222	void pcmcia_disable_device(struct pcmcia_device *p_dev);
994917f8 DB	223
90abdc3b DB	224	/* IO ports */
	225	#define IO_DATA_PATH_WIDTH 0x18
	226	#define IO_DATA_PATH_WIDTH_8 0x00
	227	#define IO_DATA_PATH_WIDTH_16 0x08
	228	#define IO_DATA_PATH_WIDTH_AUTO 0x10
	229
	230	/* convert flag found in cfgtable to data path width parameter */
	231	static inline int pcmcia_io_cfg_data_width(unsigned int flags)
	232	{
	233	if (!(flags & CISTPL_IO_8BIT))
	234	return IO_DATA_PATH_WIDTH_16;
	235	if (!(flags & CISTPL_IO_16BIT))
	236	return IO_DATA_PATH_WIDTH_8;
	237	return IO_DATA_PATH_WIDTH_AUTO;
	238	}
	239
cdb13808 DB	240	/* IO memory */
	241	#define WIN_MEMORY_TYPE_CM 0x00 /* default */
	242	#define WIN_MEMORY_TYPE_AM 0x20 /* MAP_ATTRIB */
	243	#define WIN_DATA_WIDTH_8 0x00 /* default */
	244	#define WIN_DATA_WIDTH_16 0x02 /* MAP_16BIT */
	245	#define WIN_ENABLE 0x01 /* MAP_ACTIVE */
	246	#define WIN_USE_WAIT 0x40 /* MAP_USE_WAIT */
	247
	248	#define WIN_FLAGS_MAP 0x63 /* MAP_ATTRIB \| MAP_16BIT \| MAP_ACTIVE \|
	249	MAP_USE_WAIT */
	250	#define WIN_FLAGS_REQ 0x1c /* mapping to socket->win[i]:
	251	0x04 -> 0
	252	0x08 -> 1
	253	0x0c -> 2
	254	0x10 -> 3 */
	255
7feabb64 DB	256	/* config_reg{ister}s present for this PCMCIA device */
	257	#define PRESENT_OPTION 0x001
	258	#define PRESENT_STATUS 0x002
	259	#define PRESENT_PIN_REPLACE 0x004
	260	#define PRESENT_COPY 0x008
	261	#define PRESENT_EXT_STATUS 0x010
	262	#define PRESENT_IOBASE_0 0x020
	263	#define PRESENT_IOBASE_1 0x040
	264	#define PRESENT_IOBASE_2 0x080
	265	#define PRESENT_IOBASE_3 0x100
	266	#define PRESENT_IOSIZE 0x200
cdb13808	267
1da177e4	268	#endif /* __KERNEL__ */
a5835786	269
1da177e4	270	#endif /* _LINUX_DS_H */