xref: /openbmc/linux/include/pcmcia/ds.h (revision d5cb9783536a41df9f9cba5b0a1d78047ed787f7)
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 
19 #ifdef __KERNEL__
20 #include <linux/mod_devicetable.h>
21 #endif
22 
23 #include <pcmcia/bulkmem.h>
24 #include <pcmcia/cs_types.h>
25 #include <pcmcia/device_id.h>
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 {
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 
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;
109     wait_queue_head_t	pending;
110     client_handle_t	handle;
111     io_req_t		io;
112     irq_req_t		irq;
113     config_req_t	conf;
114     window_handle_t	win;
115     void		*priv;
116     struct dev_link_t	*next;
117 } dev_link_t;
118 
119 /* Flags for device state */
120 #define DEV_PRESENT		0x01
121 #define DEV_CONFIG		0x02
122 #define DEV_STALE_CONFIG	0x04	/* release on close */
123 #define DEV_STALE_LINK		0x08	/* detach on release */
124 #define DEV_CONFIG_PENDING	0x10
125 #define DEV_RELEASE_PENDING	0x20
126 #define DEV_SUSPEND		0x40
127 #define DEV_BUSY		0x80
128 
129 #define DEV_OK(l) \
130     ((l) && ((l->state & ~DEV_BUSY) == (DEV_CONFIG|DEV_PRESENT)))
131 
132 
133 struct pcmcia_socket;
134 
135 struct pcmcia_driver {
136 	dev_link_t		*(*attach)(void);
137 	int (*event)		(event_t event, int priority,
138 				 event_callback_args_t *);
139 	void			(*detach)(dev_link_t *);
140 	struct module		*owner;
141 	struct pcmcia_device_id	*id_table;
142 	struct device_driver	drv;
143 };
144 
145 /* driver registration */
146 int pcmcia_register_driver(struct pcmcia_driver *driver);
147 void pcmcia_unregister_driver(struct pcmcia_driver *driver);
148 
149 struct pcmcia_device {
150 	/* the socket and the device_no [for multifunction devices]
151 	   uniquely define a pcmcia_device */
152 	struct pcmcia_socket	*socket;
153 
154 	char			*devname;
155 
156 	u8			device_no;
157 
158 	/* the hardware "function" device; certain subdevices can
159 	 * share one hardware "function" device. */
160 	u8			func;
161 
162 	struct list_head	socket_device_list;
163 
164 	/* deprecated, a cleaned up version will be moved into this
165 	   struct soon */
166 	dev_link_t		*instance;
167 	event_callback_args_t 	event_callback_args;
168 	u_int			state;
169 
170 	/* information about this device */
171 	u8			has_manf_id:1;
172 	u8			has_card_id:1;
173 	u8			has_func_id:1;
174 
175 	u8			allow_func_id_match:1;
176 	u8			reserved:4;
177 
178 	u8			func_id;
179 	u16			manf_id;
180 	u16			card_id;
181 
182 	char *			prod_id[4];
183 
184 	/* device driver wanted by cardmgr */
185 	struct pcmcia_driver *	cardmgr;
186 
187 	struct device		dev;
188 };
189 
190 #define to_pcmcia_dev(n) container_of(n, struct pcmcia_device, dev)
191 #define to_pcmcia_drv(n) container_of(n, struct pcmcia_driver, drv)
192 
193 #define handle_to_pdev(handle) (handle)
194 #define handle_to_dev(handle) (handle->dev)
195 
196 /* error reporting */
197 void cs_error(client_handle_t handle, int func, int ret);
198 
199 #endif /* __KERNEL__ */
200 #endif /* _LINUX_DS_H */
201