[deliverable/linux.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 - 2004	Dominik Brodowski
 */

#ifndef _LINUX_DS_H
#define _LINUX_DS_H

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

#include <pcmcia/bulkmem.h>
#include <pcmcia/cs_types.h>
#include <pcmcia/device_id.h>

typedef struct tuple_parse_t {
    tuple_t		tuple;
    cisdata_t		data[255];
    cisparse_t		parse;
} tuple_parse_t;

typedef struct win_info_t {
    window_handle_t	handle;
    win_req_t		window;
    memreq_t		map;
} win_info_t;
    
typedef struct bind_info_t {
    dev_info_t		dev_info;
    u_char		function;
    struct dev_link_t	*instance;
    char		name[DEV_NAME_LEN];
    u_short		major, minor;
    void		*next;
} bind_info_t;

typedef struct mtd_info_t {
    dev_info_t		dev_info;
    u_int		Attributes;
    u_int		CardOffset;
} mtd_info_t;

typedef union ds_ioctl_arg_t {
    adjust_t		adjust;
    config_info_t	config;
    tuple_t		tuple;
    tuple_parse_t	tuple_parse;
    client_req_t	client_req;
    cs_status_t		status;
    conf_reg_t		conf_reg;
    cisinfo_t		cisinfo;
    region_info_t	region;
    bind_info_t		bind_info;
    mtd_info_t		mtd_info;
    win_info_t		win_info;
    cisdump_t		cisdump;
} ds_ioctl_arg_t;

#define DS_ADJUST_RESOURCE_INFO		_IOWR('d', 2, adjust_t)
#define DS_GET_CONFIGURATION_INFO	_IOWR('d', 3, config_info_t)
#define DS_GET_FIRST_TUPLE		_IOWR('d', 4, tuple_t)
#define DS_GET_NEXT_TUPLE		_IOWR('d', 5, tuple_t)
#define DS_GET_TUPLE_DATA		_IOWR('d', 6, tuple_parse_t)
#define DS_PARSE_TUPLE			_IOWR('d', 7, tuple_parse_t)
#define DS_RESET_CARD			_IO  ('d', 8)
#define DS_GET_STATUS			_IOWR('d', 9, cs_status_t)
#define DS_ACCESS_CONFIGURATION_REGISTER _IOWR('d', 10, conf_reg_t)
#define DS_VALIDATE_CIS			_IOR ('d', 11, cisinfo_t)
#define DS_SUSPEND_CARD			_IO  ('d', 12)
#define DS_RESUME_CARD			_IO  ('d', 13)
#define DS_EJECT_CARD			_IO  ('d', 14)
#define DS_INSERT_CARD			_IO  ('d', 15)
#define DS_GET_FIRST_REGION		_IOWR('d', 16, region_info_t)
#define DS_GET_NEXT_REGION		_IOWR('d', 17, region_info_t)
#define DS_REPLACE_CIS			_IOWR('d', 18, cisdump_t)
#define DS_GET_FIRST_WINDOW		_IOR ('d', 19, win_info_t)
#define DS_GET_NEXT_WINDOW		_IOWR('d', 20, win_info_t)
#define DS_GET_MEM_PAGE			_IOWR('d', 21, win_info_t)

#define DS_BIND_REQUEST			_IOWR('d', 60, bind_info_t)
#define DS_GET_DEVICE_INFO		_IOWR('d', 61, bind_info_t) 
#define DS_GET_NEXT_DEVICE		_IOWR('d', 62, bind_info_t) 
#define DS_UNBIND_REQUEST		_IOW ('d', 63, bind_info_t)
#define DS_BIND_MTD			_IOWR('d', 64, mtd_info_t)

#ifdef __KERNEL__
#include <linux/device.h>

typedef struct dev_node_t {
    char		dev_name[DEV_NAME_LEN];
    u_short		major, minor;
    struct dev_node_t	*next;
} dev_node_t;

typedef struct dev_link_t {
    dev_node_t		*dev;
    u_int		state, open;
    client_handle_t	handle;
    io_req_t		io;
    irq_req_t		irq;
    config_req_t	conf;
    window_handle_t	win;
    void		*priv;
    struct dev_link_t	*next;
} dev_link_t;

/* Flags for device state */
#define DEV_PRESENT		0x01
#define DEV_CONFIG		0x02
#define DEV_STALE_CONFIG	0x04	/* release on close */
#define DEV_STALE_LINK		0x08	/* detach on release */
#define DEV_CONFIG_PENDING	0x10
#define DEV_RELEASE_PENDING	0x20
#define DEV_SUSPEND		0x40
#define DEV_BUSY		0x80

#define DEV_OK(l) \
    ((l) && ((l->state & ~DEV_BUSY) == (DEV_CONFIG|DEV_PRESENT)))


struct pcmcia_socket;
struct config_t;

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

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

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, a cleaned up version will be moved into this
	   struct soon */
	dev_link_t		*instance;
	u_int			state;

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

	u8			allow_func_id_match:1;
	u8			reserved:4;

	u8			func_id;
	u16			manf_id;
	u16			card_id;

	char *			prod_id[4];

	/* device driver wanted by cardmgr */
	struct pcmcia_driver *	cardmgr;

	struct device		dev;
};

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

#define handle_to_pdev(handle) (handle)
#define handle_to_dev(handle) (handle->dev)

#define dev_to_instance(dev) (dev->instance)

/* error reporting */
void cs_error(client_handle_t handle, int func, int ret);

#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
	13	* (C) 2003 - 2004 Dominik Brodowski
	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
1da177e4 LT	23	#include <pcmcia/bulkmem.h>
1da177e4 LT	24	#include <pcmcia/cs_types.h>
1ad275e3	25	#include <pcmcia/device_id.h>
1da177e4 LT	26
	27	typedef struct tuple_parse_t {
	28	tuple_t tuple;
	29	cisdata_t data[255];
	30	cisparse_t parse;
	31	} tuple_parse_t;
	32
	33	typedef struct win_info_t {
	34	window_handle_t handle;
	35	win_req_t window;
	36	memreq_t map;
	37	} win_info_t;
	38
	39	typedef struct bind_info_t {
	40	dev_info_t dev_info;
	41	u_char function;
	42	struct dev_link_t *instance;
	43	char name[DEV_NAME_LEN];
	44	u_short major, minor;
	45	void *next;
	46	} bind_info_t;
	47
	48	typedef struct mtd_info_t {
	49	dev_info_t dev_info;
	50	u_int Attributes;
	51	u_int CardOffset;
	52	} mtd_info_t;
	53
	54	typedef union ds_ioctl_arg_t {
1da177e4 LT	55	adjust_t adjust;
	56	config_info_t config;
	57	tuple_t tuple;
	58	tuple_parse_t tuple_parse;
	59	client_req_t client_req;
	60	cs_status_t status;
	61	conf_reg_t conf_reg;
	62	cisinfo_t cisinfo;
	63	region_info_t region;
	64	bind_info_t bind_info;
	65	mtd_info_t mtd_info;
	66	win_info_t win_info;
	67	cisdump_t cisdump;
	68	} ds_ioctl_arg_t;
	69
1da177e4 LT	70	#define DS_ADJUST_RESOURCE_INFO _IOWR('d', 2, adjust_t)
	71	#define DS_GET_CONFIGURATION_INFO _IOWR('d', 3, config_info_t)
	72	#define DS_GET_FIRST_TUPLE _IOWR('d', 4, tuple_t)
	73	#define DS_GET_NEXT_TUPLE _IOWR('d', 5, tuple_t)
	74	#define DS_GET_TUPLE_DATA _IOWR('d', 6, tuple_parse_t)
	75	#define DS_PARSE_TUPLE _IOWR('d', 7, tuple_parse_t)
	76	#define DS_RESET_CARD _IO ('d', 8)
	77	#define DS_GET_STATUS _IOWR('d', 9, cs_status_t)
	78	#define DS_ACCESS_CONFIGURATION_REGISTER _IOWR('d', 10, conf_reg_t)
	79	#define DS_VALIDATE_CIS _IOR ('d', 11, cisinfo_t)
	80	#define DS_SUSPEND_CARD _IO ('d', 12)
	81	#define DS_RESUME_CARD _IO ('d', 13)
	82	#define DS_EJECT_CARD _IO ('d', 14)
	83	#define DS_INSERT_CARD _IO ('d', 15)
	84	#define DS_GET_FIRST_REGION _IOWR('d', 16, region_info_t)
	85	#define DS_GET_NEXT_REGION _IOWR('d', 17, region_info_t)
	86	#define DS_REPLACE_CIS _IOWR('d', 18, cisdump_t)
	87	#define DS_GET_FIRST_WINDOW _IOR ('d', 19, win_info_t)
	88	#define DS_GET_NEXT_WINDOW _IOWR('d', 20, win_info_t)
	89	#define DS_GET_MEM_PAGE _IOWR('d', 21, win_info_t)
	90
	91	#define DS_BIND_REQUEST _IOWR('d', 60, bind_info_t)
	92	#define DS_GET_DEVICE_INFO _IOWR('d', 61, bind_info_t)
	93	#define DS_GET_NEXT_DEVICE _IOWR('d', 62, bind_info_t)
	94	#define DS_UNBIND_REQUEST _IOW ('d', 63, bind_info_t)
	95	#define DS_BIND_MTD _IOWR('d', 64, mtd_info_t)
	96
	97	#ifdef __KERNEL__
	98	#include <linux/device.h>
	99
	100	typedef struct dev_node_t {
	101	char dev_name[DEV_NAME_LEN];
	102	u_short major, minor;
	103	struct dev_node_t *next;
	104	} dev_node_t;
	105
	106	typedef struct dev_link_t {
	107	dev_node_t *dev;
	108	u_int state, open;
1da177e4 LT	109	client_handle_t handle;
	110	io_req_t io;
	111	irq_req_t irq;
	112	config_req_t conf;
	113	window_handle_t win;
	114	void *priv;
	115	struct dev_link_t *next;
	116	} dev_link_t;
	117
	118	/* Flags for device state */
	119	#define DEV_PRESENT 0x01
	120	#define DEV_CONFIG 0x02
	121	#define DEV_STALE_CONFIG 0x04 /* release on close */
	122	#define DEV_STALE_LINK 0x08 /* detach on release */
	123	#define DEV_CONFIG_PENDING 0x10
	124	#define DEV_RELEASE_PENDING 0x20
	125	#define DEV_SUSPEND 0x40
	126	#define DEV_BUSY 0x80
	127
	128	#define DEV_OK(l) \
	129	((l) && ((l->state & ~DEV_BUSY) == (DEV_CONFIG\|DEV_PRESENT)))
	130
	131
	132	struct pcmcia_socket;
dbb22f0d	133	struct config_t;
1da177e4	134
1da177e4	135	struct pcmcia_driver {
f8cfa618	136	int (probe) (struct pcmcia_device dev);
cc3b4866 DB	137	void (remove) (struct pcmcia_device dev);
cc3b4866 DB	138
98e4c28b DB	139	int (suspend) (struct pcmcia_device dev);
	140	int (resume) (struct pcmcia_device dev);
	141
1da177e4	142	struct module *owner;
1ad275e3	143	struct pcmcia_device_id *id_table;
1da177e4 LT	144	struct device_driver drv;
	145	};
	146
	147	/* driver registration */
	148	int pcmcia_register_driver(struct pcmcia_driver *driver);
	149	void pcmcia_unregister_driver(struct pcmcia_driver *driver);
	150
	151	struct pcmcia_device {
	152	/* the socket and the device_no [for multifunction devices]
	153	uniquely define a pcmcia_device */
	154	struct pcmcia_socket *socket;
	155
bd65a685 BG	156	char *devname;
bd65a685 BG	157
1da177e4 LT	158	u8 device_no;
	159
	160	/* the hardware "function" device; certain subdevices can
	161	* share one hardware "function" device. */
	162	u8 func;
dbb22f0d	163	struct config_t* function_config;
1da177e4 LT	164
	165	struct list_head socket_device_list;
	166
	167	/* deprecated, a cleaned up version will be moved into this
	168	struct soon */
	169	dev_link_t *instance;
e12a9a93	170	u_int state;
1da177e4 LT	171
	172	/* information about this device */
	173	u8 has_manf_id:1;
	174	u8 has_card_id:1;
	175	u8 has_func_id:1;
1ad275e3 DB	176
	177	u8 allow_func_id_match:1;
	178	u8 reserved:4;
1da177e4 LT	179
	180	u8 func_id;
	181	u16 manf_id;
	182	u16 card_id;
	183
	184	char * prod_id[4];
	185
	186	/* device driver wanted by cardmgr */
	187	struct pcmcia_driver * cardmgr;
	188
	189	struct device dev;
	190	};
	191
	192	#define to_pcmcia_dev(n) container_of(n, struct pcmcia_device, dev)
	193	#define to_pcmcia_drv(n) container_of(n, struct pcmcia_driver, drv)
	194
e12a9a93 DB	195	#define handle_to_pdev(handle) (handle)
e12a9a93 DB	196	#define handle_to_dev(handle) (handle->dev)
1da177e4	197
98e4c28b DB	198	#define dev_to_instance(dev) (dev->instance)
98e4c28b DB	199
1da177e4 LT	200	/* error reporting */
	201	void cs_error(client_handle_t handle, int func, int ret);
	202
	203	#endif /* __KERNEL__ */
	204	#endif /* _LINUX_DS_H */