[mirror_ubuntu-bionic-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;

typedef struct resource *window_handle_t;

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

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

	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,
						 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, win_req_t *req,
			  window_handle_t *wh);
int pcmcia_release_window(struct pcmcia_device *p_dev, window_handle_t win);
int pcmcia_map_mem_page(struct pcmcia_device *p_dev, window_handle_t win,
			unsigned int offset);

int pcmcia_modify_configuration(struct pcmcia_device *p_dev, modconf_t *mod);
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;
}

#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
0ca724d3	39	typedef struct resource *window_handle_t;
ac8b4228	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 {
f8cfa618	50	int (probe) (struct pcmcia_device dev);
cc3b4866 DB	51	void (remove) (struct pcmcia_device dev);
cc3b4866 DB	52
98e4c28b DB	53	int (suspend) (struct pcmcia_device dev);
	54	int (resume) (struct pcmcia_device dev);
	55
1da177e4	56	struct module *owner;
1ad275e3	57	struct pcmcia_device_id *id_table;
1da177e4	58	struct device_driver drv;
6179b556	59	struct pcmcia_dynids dynids;
1da177e4 LT	60	};
	61
	62	/* driver registration */
	63	int pcmcia_register_driver(struct pcmcia_driver *driver);
	64	void pcmcia_unregister_driver(struct pcmcia_driver *driver);
	65
0ca724d3 DB	66	/* for struct resource * array embedded in struct pcmcia_device */
	67	enum {
	68	PCMCIA_IOPORT_0,
	69	PCMCIA_IOPORT_1,
	70	PCMCIA_IOMEM_0,
	71	PCMCIA_IOMEM_1,
	72	PCMCIA_IOMEM_2,
	73	PCMCIA_IOMEM_3,
	74	PCMCIA_NUM_RESOURCES,
	75	};
	76
1da177e4 LT	77	struct pcmcia_device {
	78	/* the socket and the device_no [for multifunction devices]
	79	uniquely define a pcmcia_device */
	80	struct pcmcia_socket *socket;
	81
bd65a685 BG	82	char *devname;
bd65a685 BG	83
1da177e4 LT	84	u8 device_no;
	85
	86	/* the hardware "function" device; certain subdevices can
	87	* share one hardware "function" device. */
	88	u8 func;
9fea84f4	89	struct config_t *function_config;
1da177e4 LT	90
	91	struct list_head socket_device_list;
	92
fd238232	93	/* deprecated, will be cleaned up soon */
fd238232 DB	94	config_req_t conf;
fd238232 DB	95	window_handle_t win;
fd238232	96
6f0f38c4	97	/* device setup */
eb14120f	98	unsigned int irq;
0ca724d3	99	struct resource *resource[PCMCIA_NUM_RESOURCES];
6f0f38c4	100
90abdc3b DB	101	unsigned int io_lines; /* number of I/O lines */
90abdc3b DB	102
04de0816	103	/* Is the device suspended? */
e2d40963 DB	104	u16 suspended:1;
	105
	106	/* Flags whether io, irq, win configurations were
	107	* requested, and whether the configuration is "locked" */
	108	u16 _irq:1;
	109	u16 _io:1;
	110	u16 _win:4;
	111	u16 _locked:1;
1da177e4	112
e2d40963 DB	113	/* Flag whether a "fuzzy" func_id based match is
	114	* allowed. */
	115	u16 allow_func_id_match:1;
f6fbe01a	116
1da177e4	117	/* information about this device */
e2d40963 DB	118	u16 has_manf_id:1;
	119	u16 has_card_id:1;
	120	u16 has_func_id:1;
1ad275e3	121
04de0816	122	u16 reserved:4;
1da177e4 LT	123
	124	u8 func_id;
	125	u16 manf_id;
	126	u16 card_id;
	127
9fea84f4	128	char *prod_id[4];
1da177e4	129
43d9f7fd	130	u64 dma_mask;
0e0fad8f DB	131	struct device dev;
0e0fad8f DB	132
e2d40963 DB	133	/* data private to drivers */
e2d40963 DB	134	void *priv;
2ce4905e	135	unsigned int open;
1da177e4 LT	136	};
	137
	138	#define to_pcmcia_dev(n) container_of(n, struct pcmcia_device, dev)
	139	#define to_pcmcia_drv(n) container_of(n, struct pcmcia_driver, drv)
	140
a5835786	141
91284224 DB	142	/*
	143	* CIS access.
	144	*
	145	* Please use the following functions to access CIS tuples:
	146	* - pcmcia_get_tuple()
	147	* - pcmcia_loop_tuple()
	148	* - pcmcia_get_mac_from_cis()
	149	*
	150	* To parse a tuple_t, pcmcia_parse_tuple() exists. Its interface
	151	* might change in future.
272433e0	152	*/
272433e0	153
91284224 DB	154	/* get the very first CIS entry of type @code. Note that buf is pointer
	155	* to u8 buf; and that you need to kfree(buf) afterwards. /
	156	size_t pcmcia_get_tuple(struct pcmcia_device *p_dev, cisdata_t code,
	157	u8 **buf);
272433e0	158
91284224 DB	159	/* loop over CIS entries */
	160	int pcmcia_loop_tuple(struct pcmcia_device *p_dev, cisdata_t code,
	161	int (loop_tuple) (struct pcmcia_device p_dev,
	162	tuple_t *tuple,
	163	void *priv_data),
	164	void *priv_data);
272433e0	165
91284224 DB	166	/* get the MAC address from CISTPL_FUNCE */
	167	int pcmcia_get_mac_from_cis(struct pcmcia_device *p_dev,
	168	struct net_device *dev);
272433e0 DB	169
272433e0 DB	170
91284224 DB	171	/* parse a tuple_t */
	172	int pcmcia_parse_tuple(tuple_t tuple, cisparse_t parse);
	173
272433e0 DB	174	/* loop CIS entries for valid configuration */
	175	int pcmcia_loop_config(struct pcmcia_device *p_dev,
	176	int (conf_check) (struct pcmcia_device p_dev,
	177	cistpl_cftable_entry_t *cf,
	178	cistpl_cftable_entry_t *dflt,
	179	unsigned int vcc,
	180	void *priv_data),
	181	void *priv_data);
1da177e4	182
994917f8 DB	183	/* is the device still there? */
	184	struct pcmcia_device pcmcia_dev_present(struct pcmcia_device p_dev);
	185
	186	/* low-level interface reset */
	187	int pcmcia_reset_card(struct pcmcia_socket *skt);
	188
	189	/* CIS config */
1d5cc192 DB	190	int pcmcia_read_config_byte(struct pcmcia_device p_dev, off_t where, u8 val);
1d5cc192 DB	191	int pcmcia_write_config_byte(struct pcmcia_device *p_dev, off_t where, u8 val);
994917f8 DB	192
994917f8 DB	193	/* device configuration */
90abdc3b	194	int pcmcia_request_io(struct pcmcia_device *p_dev);
eb14120f	195
b19a7275 DB	196	int __must_check
b19a7275 DB	197	__pcmcia_request_exclusive_irq(struct pcmcia_device *p_dev,
eb14120f	198	irq_handler_t handler);
b19a7275 DB	199	static inline __must_check __deprecated int
	200	pcmcia_request_exclusive_irq(struct pcmcia_device *p_dev,
	201	irq_handler_t handler)
	202	{
	203	return __pcmcia_request_exclusive_irq(p_dev, handler);
	204	}
	205
eb14120f DB	206	int __must_check pcmcia_request_irq(struct pcmcia_device *p_dev,
	207	irq_handler_t handler);
	208
994917f8 DB	209	int pcmcia_request_configuration(struct pcmcia_device *p_dev,
	210	config_req_t *req);
	211
6838b03f	212	int pcmcia_request_window(struct pcmcia_device p_dev, win_req_t req,
994917f8	213	window_handle_t *wh);
f5560da5	214	int pcmcia_release_window(struct pcmcia_device *p_dev, window_handle_t win);
868575d1	215	int pcmcia_map_mem_page(struct pcmcia_device *p_dev, window_handle_t win,
b5cb259e	216	unsigned int offset);
994917f8 DB	217
	218	int pcmcia_modify_configuration(struct pcmcia_device p_dev, modconf_t mod);
	219	void pcmcia_disable_device(struct pcmcia_device *p_dev);
	220
90abdc3b DB	221	/* IO ports */
	222	#define IO_DATA_PATH_WIDTH 0x18
	223	#define IO_DATA_PATH_WIDTH_8 0x00
	224	#define IO_DATA_PATH_WIDTH_16 0x08
	225	#define IO_DATA_PATH_WIDTH_AUTO 0x10
	226
	227	/* convert flag found in cfgtable to data path width parameter */
	228	static inline int pcmcia_io_cfg_data_width(unsigned int flags)
	229	{
	230	if (!(flags & CISTPL_IO_8BIT))
	231	return IO_DATA_PATH_WIDTH_16;
	232	if (!(flags & CISTPL_IO_16BIT))
	233	return IO_DATA_PATH_WIDTH_8;
	234	return IO_DATA_PATH_WIDTH_AUTO;
	235	}
	236
1da177e4	237	#endif /* __KERNEL__ */
a5835786	238
1da177e4	239	#endif /* _LINUX_DS_H */