xref: /openbmc/linux/include/pcmcia/ds.h (revision 1ad275e3e7d253d44f03868e85977c908e334fed)
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 #include <pcmcia/bulkmem.h>
20 #include <pcmcia/cs_types.h>
21 #include <pcmcia/device_id.h>
22 #include <linux/mod_devicetable.h>
23 
24 typedef struct tuple_parse_t {
25     tuple_t		tuple;
26     cisdata_t		data[255];
27     cisparse_t		parse;
28 } tuple_parse_t;
29 
30 typedef struct win_info_t {
31     window_handle_t	handle;
32     win_req_t		window;
33     memreq_t		map;
34 } win_info_t;
35 
36 typedef struct bind_info_t {
37     dev_info_t		dev_info;
38     u_char		function;
39     struct dev_link_t	*instance;
40     char		name[DEV_NAME_LEN];
41     u_short		major, minor;
42     void		*next;
43 } bind_info_t;
44 
45 typedef struct mtd_info_t {
46     dev_info_t		dev_info;
47     u_int		Attributes;
48     u_int		CardOffset;
49 } mtd_info_t;
50 
51 typedef union ds_ioctl_arg_t {
52     servinfo_t		servinfo;
53     adjust_t		adjust;
54     config_info_t	config;
55     tuple_t		tuple;
56     tuple_parse_t	tuple_parse;
57     client_req_t	client_req;
58     cs_status_t		status;
59     conf_reg_t		conf_reg;
60     cisinfo_t		cisinfo;
61     region_info_t	region;
62     bind_info_t		bind_info;
63     mtd_info_t		mtd_info;
64     win_info_t		win_info;
65     cisdump_t		cisdump;
66 } ds_ioctl_arg_t;
67 
68 #define DS_GET_CARD_SERVICES_INFO	_IOR ('d', 1, servinfo_t)
69 #define DS_ADJUST_RESOURCE_INFO		_IOWR('d', 2, adjust_t)
70 #define DS_GET_CONFIGURATION_INFO	_IOWR('d', 3, config_info_t)
71 #define DS_GET_FIRST_TUPLE		_IOWR('d', 4, tuple_t)
72 #define DS_GET_NEXT_TUPLE		_IOWR('d', 5, tuple_t)
73 #define DS_GET_TUPLE_DATA		_IOWR('d', 6, tuple_parse_t)
74 #define DS_PARSE_TUPLE			_IOWR('d', 7, tuple_parse_t)
75 #define DS_RESET_CARD			_IO  ('d', 8)
76 #define DS_GET_STATUS			_IOWR('d', 9, cs_status_t)
77 #define DS_ACCESS_CONFIGURATION_REGISTER _IOWR('d', 10, conf_reg_t)
78 #define DS_VALIDATE_CIS			_IOR ('d', 11, cisinfo_t)
79 #define DS_SUSPEND_CARD			_IO  ('d', 12)
80 #define DS_RESUME_CARD			_IO  ('d', 13)
81 #define DS_EJECT_CARD			_IO  ('d', 14)
82 #define DS_INSERT_CARD			_IO  ('d', 15)
83 #define DS_GET_FIRST_REGION		_IOWR('d', 16, region_info_t)
84 #define DS_GET_NEXT_REGION		_IOWR('d', 17, region_info_t)
85 #define DS_REPLACE_CIS			_IOWR('d', 18, cisdump_t)
86 #define DS_GET_FIRST_WINDOW		_IOR ('d', 19, win_info_t)
87 #define DS_GET_NEXT_WINDOW		_IOWR('d', 20, win_info_t)
88 #define DS_GET_MEM_PAGE			_IOWR('d', 21, win_info_t)
89 
90 #define DS_BIND_REQUEST			_IOWR('d', 60, bind_info_t)
91 #define DS_GET_DEVICE_INFO		_IOWR('d', 61, bind_info_t)
92 #define DS_GET_NEXT_DEVICE		_IOWR('d', 62, bind_info_t)
93 #define DS_UNBIND_REQUEST		_IOW ('d', 63, bind_info_t)
94 #define DS_BIND_MTD			_IOWR('d', 64, mtd_info_t)
95 
96 #ifdef __KERNEL__
97 #include <linux/device.h>
98 
99 typedef struct dev_node_t {
100     char		dev_name[DEV_NAME_LEN];
101     u_short		major, minor;
102     struct dev_node_t	*next;
103 } dev_node_t;
104 
105 typedef struct dev_link_t {
106     dev_node_t		*dev;
107     u_int		state, open;
108     wait_queue_head_t	pending;
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;
133 
134 extern struct bus_type pcmcia_bus_type;
135 
136 struct pcmcia_driver {
137 	dev_link_t		*(*attach)(void);
138 	void			(*detach)(dev_link_t *);
139 	struct module		*owner;
140 	struct pcmcia_device_id	*id_table;
141 	struct device_driver	drv;
142 };
143 
144 /* driver registration */
145 int pcmcia_register_driver(struct pcmcia_driver *driver);
146 void pcmcia_unregister_driver(struct pcmcia_driver *driver);
147 
148 struct pcmcia_device {
149 	/* the socket and the device_no [for multifunction devices]
150 	   uniquely define a pcmcia_device */
151 	struct pcmcia_socket	*socket;
152 
153 	u8			device_no;
154 
155 	/* the hardware "function" device; certain subdevices can
156 	 * share one hardware "function" device. */
157 	u8			func;
158 
159 	struct list_head	socket_device_list;
160 
161 	/* deprecated, a cleaned up version will be moved into this
162 	   struct soon */
163 	dev_link_t		*instance;
164 	struct client_t {
165 		u_short			client_magic;
166 		struct pcmcia_socket	*Socket;
167 		u_char			Function;
168 		u_int			state;
169 		event_t			EventMask;
170 		int (*event_handler)	(event_t event, int priority,
171 					 event_callback_args_t *);
172 		event_callback_args_t 	event_callback_args;
173 	}			client;
174 
175 	/* information about this device */
176 	u8			has_manf_id:1;
177 	u8			has_card_id:1;
178 	u8			has_func_id:1;
179 
180 	u8			allow_func_id_match:1;
181 	u8			reserved:4;
182 
183 	u8			func_id;
184 	u16			manf_id;
185 	u16			card_id;
186 
187 	char *			prod_id[4];
188 
189 	/* device driver wanted by cardmgr */
190 	struct pcmcia_driver *	cardmgr;
191 
192 	struct device		dev;
193 };
194 
195 #define to_pcmcia_dev(n) container_of(n, struct pcmcia_device, dev)
196 #define to_pcmcia_drv(n) container_of(n, struct pcmcia_driver, drv)
197 
198 #define handle_to_pdev(handle) container_of(handle, struct pcmcia_device, client);
199 #define handle_to_dev(handle) ((container_of(handle, struct pcmcia_device, client))->dev)
200 
201 /* error reporting */
202 void cs_error(client_handle_t handle, int func, int ret);
203 
204 #endif /* __KERNEL__ */
205 #endif /* _LINUX_DS_H */
206