pcmcia: dev_node removal (core)
[linux-2.6.git] / include / pcmcia / ds.h
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 - 2008      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/cs_types.h>
24 #include <pcmcia/device_id.h>
25
26 #ifdef __KERNEL__
27 #include <linux/device.h>
28 #include <pcmcia/ss.h>
29 #include <asm/atomic.h>
30
31 /*
32  * PCMCIA device drivers (16-bit cards only; 32-bit cards require CardBus
33  * a.k.a. PCI drivers
34  */
35 struct pcmcia_socket;
36 struct pcmcia_device;
37 struct config_t;
38 struct net_device;
39
40 /* dynamic device IDs for PCMCIA device drivers. See
41  * Documentation/pcmcia/driver.txt for details.
42 */
43 struct pcmcia_dynids {
44         struct mutex            lock;
45         struct list_head        list;
46 };
47
48 struct pcmcia_driver {
49         int (*probe)            (struct pcmcia_device *dev);
50         void (*remove)          (struct pcmcia_device *dev);
51
52         int (*suspend)          (struct pcmcia_device *dev);
53         int (*resume)           (struct pcmcia_device *dev);
54
55         struct module           *owner;
56         struct pcmcia_device_id *id_table;
57         struct device_driver    drv;
58         struct pcmcia_dynids    dynids;
59 };
60
61 /* driver registration */
62 int pcmcia_register_driver(struct pcmcia_driver *driver);
63 void pcmcia_unregister_driver(struct pcmcia_driver *driver);
64
65 struct pcmcia_device {
66         /* the socket and the device_no [for multifunction devices]
67            uniquely define a pcmcia_device */
68         struct pcmcia_socket    *socket;
69
70         char                    *devname;
71
72         u8                      device_no;
73
74         /* the hardware "function" device; certain subdevices can
75          * share one hardware "function" device. */
76         u8                      func;
77         struct config_t         *function_config;
78
79         struct list_head        socket_device_list;
80
81         /* deprecated, will be cleaned up soon */
82         u_int                   open;
83         io_req_t                io;
84         config_req_t            conf;
85         window_handle_t         win;
86
87         /* device setup */
88         unsigned int            irq;
89
90         /* Is the device suspended? */
91         u16                     suspended:1;
92
93         /* Flags whether io, irq, win configurations were
94          * requested, and whether the configuration is "locked" */
95         u16                     _irq:1;
96         u16                     _io:1;
97         u16                     _win:4;
98         u16                     _locked:1;
99
100         /* Flag whether a "fuzzy" func_id based match is
101          * allowed. */
102         u16                     allow_func_id_match:1;
103
104         /* information about this device */
105         u16                     has_manf_id:1;
106         u16                     has_card_id:1;
107         u16                     has_func_id:1;
108
109         u16                     reserved:4;
110
111         u8                      func_id;
112         u16                     manf_id;
113         u16                     card_id;
114
115         char                    *prod_id[4];
116
117         u64                     dma_mask;
118         struct device           dev;
119
120 #ifdef CONFIG_PCMCIA_IOCTL
121         /* device driver wanted by cardmgr */
122         struct pcmcia_driver    *cardmgr;
123 #endif
124
125         /* data private to drivers */
126         void                    *priv;
127 };
128
129 #define to_pcmcia_dev(n) container_of(n, struct pcmcia_device, dev)
130 #define to_pcmcia_drv(n) container_of(n, struct pcmcia_driver, drv)
131
132
133 /*
134  * CIS access.
135  *
136  * Please use the following functions to access CIS tuples:
137  * - pcmcia_get_tuple()
138  * - pcmcia_loop_tuple()
139  * - pcmcia_get_mac_from_cis()
140  *
141  * To parse a tuple_t, pcmcia_parse_tuple() exists. Its interface
142  * might change in future.
143  */
144
145 /* get the very first CIS entry of type @code. Note that buf is pointer
146  * to u8 *buf; and that you need to kfree(buf) afterwards. */
147 size_t pcmcia_get_tuple(struct pcmcia_device *p_dev, cisdata_t code,
148                         u8 **buf);
149
150 /* loop over CIS entries */
151 int pcmcia_loop_tuple(struct pcmcia_device *p_dev, cisdata_t code,
152                       int (*loop_tuple) (struct pcmcia_device *p_dev,
153                                          tuple_t *tuple,
154                                          void *priv_data),
155                       void *priv_data);
156
157 /* get the MAC address from CISTPL_FUNCE */
158 int pcmcia_get_mac_from_cis(struct pcmcia_device *p_dev,
159                             struct net_device *dev);
160
161
162 /* parse a tuple_t */
163 int pcmcia_parse_tuple(tuple_t *tuple, cisparse_t *parse);
164
165 /* loop CIS entries for valid configuration */
166 int pcmcia_loop_config(struct pcmcia_device *p_dev,
167                        int      (*conf_check)   (struct pcmcia_device *p_dev,
168                                                  cistpl_cftable_entry_t *cf,
169                                                  cistpl_cftable_entry_t *dflt,
170                                                  unsigned int vcc,
171                                                  void *priv_data),
172                        void *priv_data);
173
174 /* is the device still there? */
175 struct pcmcia_device *pcmcia_dev_present(struct pcmcia_device *p_dev);
176
177 /* low-level interface reset */
178 int pcmcia_reset_card(struct pcmcia_socket *skt);
179
180 /* CIS config */
181 int pcmcia_access_configuration_register(struct pcmcia_device *p_dev,
182                                          conf_reg_t *reg);
183
184 /* device configuration */
185 int pcmcia_request_io(struct pcmcia_device *p_dev, io_req_t *req);
186
187 int __must_check __deprecated
188 pcmcia_request_exclusive_irq(struct pcmcia_device *p_dev,
189                                 irq_handler_t handler);
190 int __must_check pcmcia_request_irq(struct pcmcia_device *p_dev,
191                                 irq_handler_t handler);
192
193 int pcmcia_request_configuration(struct pcmcia_device *p_dev,
194                                  config_req_t *req);
195
196 int pcmcia_request_window(struct pcmcia_device *p_dev, win_req_t *req,
197                           window_handle_t *wh);
198 int pcmcia_release_window(struct pcmcia_device *p_dev, window_handle_t win);
199 int pcmcia_map_mem_page(struct pcmcia_device *p_dev, window_handle_t win,
200                         memreq_t *req);
201
202 int pcmcia_modify_configuration(struct pcmcia_device *p_dev, modconf_t *mod);
203 void pcmcia_disable_device(struct pcmcia_device *p_dev);
204
205 #endif /* __KERNEL__ */
206
207
208
209 /* Below, there are only definitions which are used by
210  * - the PCMCIA ioctl
211  * - deprecated PCMCIA userspace tools only
212  *
213  * here be dragons ... here be dragons ... here be dragons ... here be drag
214  */
215
216 #if defined(CONFIG_PCMCIA_IOCTL) || !defined(__KERNEL__)
217
218 #if defined(__arm__) || defined(__mips__) || defined(__avr32__) || \
219         defined(__bfin__)
220 /* This (ioaddr_t) is exposed to userspace & hence cannot be changed. */
221 typedef u_int   ioaddr_t;
222 #else
223 typedef u_short ioaddr_t;
224 #endif
225
226 /* for AdjustResourceInfo */
227 typedef struct adjust_t {
228         u_int                   Action;
229         u_int                   Resource;
230         u_int                   Attributes;
231         union {
232                 struct memory {
233                         u_long          Base;
234                         u_long          Size;
235                 } memory;
236                 struct io {
237                         ioaddr_t        BasePort;
238                         ioaddr_t        NumPorts;
239                         u_int           IOAddrLines;
240                 } io;
241                 struct irq {
242                         u_int           IRQ;
243                 } irq;
244         } resource;
245 } adjust_t;
246
247 /* Action field */
248 #define REMOVE_MANAGED_RESOURCE         1
249 #define ADD_MANAGED_RESOURCE            2
250 #define GET_FIRST_MANAGED_RESOURCE      3
251 #define GET_NEXT_MANAGED_RESOURCE       4
252 /* Resource field */
253 #define RES_MEMORY_RANGE                1
254 #define RES_IO_RANGE                    2
255 #define RES_IRQ                         3
256 /* Attribute field */
257 #define RES_IRQ_TYPE                    0x03
258 #define RES_IRQ_TYPE_EXCLUSIVE          0
259 #define RES_IRQ_TYPE_TIME               1
260 #define RES_IRQ_TYPE_DYNAMIC            2
261 #define RES_IRQ_CSC                     0x04
262 #define RES_SHARED                      0x08
263 #define RES_RESERVED                    0x10
264 #define RES_ALLOCATED                   0x20
265 #define RES_REMOVED                     0x40
266
267
268 typedef struct tuple_parse_t {
269         tuple_t                 tuple;
270         cisdata_t               data[255];
271         cisparse_t              parse;
272 } tuple_parse_t;
273
274 typedef struct win_info_t {
275         window_handle_t         handle;
276         win_req_t               window;
277         memreq_t                map;
278 } win_info_t;
279
280 typedef struct bind_info_t {
281         dev_info_t              dev_info;
282         u_char                  function;
283         struct pcmcia_device    *instance;
284         char                    name[DEV_NAME_LEN];
285         u_short                 major, minor;
286         void                    *next;
287 } bind_info_t;
288
289 typedef struct mtd_info_t {
290         dev_info_t              dev_info;
291         u_int                   Attributes;
292         u_int                   CardOffset;
293 } mtd_info_t;
294
295 typedef struct region_info_t {
296         u_int                   Attributes;
297         u_int                   CardOffset;
298         u_int                   RegionSize;
299         u_int                   AccessSpeed;
300         u_int                   BlockSize;
301         u_int                   PartMultiple;
302         u_char                  JedecMfr, JedecInfo;
303         memory_handle_t         next;
304 } region_info_t;
305
306 #define REGION_TYPE             0x0001
307 #define REGION_TYPE_CM          0x0000
308 #define REGION_TYPE_AM          0x0001
309 #define REGION_PREFETCH         0x0008
310 #define REGION_CACHEABLE        0x0010
311 #define REGION_BAR_MASK         0xe000
312 #define REGION_BAR_SHIFT        13
313
314 /* For ReplaceCIS */
315 typedef struct cisdump_t {
316         u_int                   Length;
317         cisdata_t               Data[CISTPL_MAX_CIS_SIZE];
318 } cisdump_t;
319
320 /* for GetConfigurationInfo */
321 typedef struct config_info_t {
322         u_char                  Function;
323         u_int                   Attributes;
324         u_int                   Vcc, Vpp1, Vpp2;
325         u_int                   IntType;
326         u_int                   ConfigBase;
327         u_char                  Status, Pin, Copy, Option, ExtStatus;
328         u_int                   Present;
329         u_int                   CardValues;
330         u_int                   AssignedIRQ;
331         u_int                   IRQAttributes;
332         ioaddr_t                BasePort1;
333         ioaddr_t                NumPorts1;
334         u_int                   Attributes1;
335         ioaddr_t                BasePort2;
336         ioaddr_t                NumPorts2;
337         u_int                   Attributes2;
338         u_int                   IOAddrLines;
339 } config_info_t;
340
341 /* For ValidateCIS */
342 typedef struct cisinfo_t {
343         u_int                   Chains;
344 } cisinfo_t;
345
346 typedef struct cs_status_t {
347         u_char                  Function;
348         event_t                 CardState;
349         event_t                 SocketState;
350 } cs_status_t;
351
352 typedef union ds_ioctl_arg_t {
353         adjust_t                adjust;
354         config_info_t           config;
355         tuple_t                 tuple;
356         tuple_parse_t           tuple_parse;
357         client_req_t            client_req;
358         cs_status_t             status;
359         conf_reg_t              conf_reg;
360         cisinfo_t               cisinfo;
361         region_info_t           region;
362         bind_info_t             bind_info;
363         mtd_info_t              mtd_info;
364         win_info_t              win_info;
365         cisdump_t               cisdump;
366 } ds_ioctl_arg_t;
367
368 #define DS_ADJUST_RESOURCE_INFO                 _IOWR('d',  2, adjust_t)
369 #define DS_GET_CONFIGURATION_INFO               _IOWR('d',  3, config_info_t)
370 #define DS_GET_FIRST_TUPLE                      _IOWR('d',  4, tuple_t)
371 #define DS_GET_NEXT_TUPLE                       _IOWR('d',  5, tuple_t)
372 #define DS_GET_TUPLE_DATA                       _IOWR('d',  6, tuple_parse_t)
373 #define DS_PARSE_TUPLE                          _IOWR('d',  7, tuple_parse_t)
374 #define DS_RESET_CARD                           _IO  ('d',  8)
375 #define DS_GET_STATUS                           _IOWR('d',  9, cs_status_t)
376 #define DS_ACCESS_CONFIGURATION_REGISTER        _IOWR('d', 10, conf_reg_t)
377 #define DS_VALIDATE_CIS                         _IOR ('d', 11, cisinfo_t)
378 #define DS_SUSPEND_CARD                         _IO  ('d', 12)
379 #define DS_RESUME_CARD                          _IO  ('d', 13)
380 #define DS_EJECT_CARD                           _IO  ('d', 14)
381 #define DS_INSERT_CARD                          _IO  ('d', 15)
382 #define DS_GET_FIRST_REGION                     _IOWR('d', 16, region_info_t)
383 #define DS_GET_NEXT_REGION                      _IOWR('d', 17, region_info_t)
384 #define DS_REPLACE_CIS                          _IOWR('d', 18, cisdump_t)
385 #define DS_GET_FIRST_WINDOW                     _IOR ('d', 19, win_info_t)
386 #define DS_GET_NEXT_WINDOW                      _IOWR('d', 20, win_info_t)
387 #define DS_GET_MEM_PAGE                         _IOWR('d', 21, win_info_t)
388
389 #define DS_BIND_REQUEST                         _IOWR('d', 60, bind_info_t)
390 #define DS_GET_DEVICE_INFO                      _IOWR('d', 61, bind_info_t)
391 #define DS_GET_NEXT_DEVICE                      _IOWR('d', 62, bind_info_t)
392 #define DS_UNBIND_REQUEST                       _IOW ('d', 63, bind_info_t)
393 #define DS_BIND_MTD                             _IOWR('d', 64, mtd_info_t)
394
395
396 /* used in userspace only */
397 #define CS_IN_USE                       0x1e
398
399 #define INFO_MASTER_CLIENT      0x01
400 #define INFO_IO_CLIENT          0x02
401 #define INFO_MTD_CLIENT         0x04
402 #define INFO_MEM_CLIENT         0x08
403 #define MAX_NUM_CLIENTS         3
404
405 #define INFO_CARD_SHARE         0x10
406 #define INFO_CARD_EXCL          0x20
407
408
409 #endif /* !defined(__KERNEL__) || defined(CONFIG_PCMCIA_IOCTL) */
410
411 #endif /* _LINUX_DS_H */