pcmcia: remove memreq_t
[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/device_id.h>
24
25 #ifdef __KERNEL__
26 #include <linux/device.h>
27 #include <pcmcia/ss.h>
28 #include <asm/atomic.h>
29
30 /*
31  * PCMCIA device drivers (16-bit cards only; 32-bit cards require CardBus
32  * a.k.a. PCI drivers
33  */
34 struct pcmcia_socket;
35 struct pcmcia_device;
36 struct config_t;
37 struct net_device;
38
39 typedef unsigned long window_handle_t;
40
41 /* dynamic device IDs for PCMCIA device drivers. See
42  * Documentation/pcmcia/driver.txt for details.
43 */
44 struct pcmcia_dynids {
45         struct mutex            lock;
46         struct list_head        list;
47 };
48
49 struct pcmcia_driver {
50         int (*probe)            (struct pcmcia_device *dev);
51         void (*remove)          (struct pcmcia_device *dev);
52
53         int (*suspend)          (struct pcmcia_device *dev);
54         int (*resume)           (struct pcmcia_device *dev);
55
56         struct module           *owner;
57         struct pcmcia_device_id *id_table;
58         struct device_driver    drv;
59         struct pcmcia_dynids    dynids;
60 };
61
62 /* driver registration */
63 int pcmcia_register_driver(struct pcmcia_driver *driver);
64 void pcmcia_unregister_driver(struct pcmcia_driver *driver);
65
66 struct pcmcia_device {
67         /* the socket and the device_no [for multifunction devices]
68            uniquely define a pcmcia_device */
69         struct pcmcia_socket    *socket;
70
71         char                    *devname;
72
73         u8                      device_no;
74
75         /* the hardware "function" device; certain subdevices can
76          * share one hardware "function" device. */
77         u8                      func;
78         struct config_t         *function_config;
79
80         struct list_head        socket_device_list;
81
82         /* deprecated, will be cleaned up soon */
83         config_req_t            conf;
84         window_handle_t         win;
85
86         /* device setup */
87         unsigned int            irq;
88         struct resource         *resource[MAX_IO_WIN];
89
90         unsigned int            io_lines; /* number of I/O lines */
91
92         /* Is the device suspended? */
93         u16                     suspended:1;
94
95         /* Flags whether io, irq, win configurations were
96          * requested, and whether the configuration is "locked" */
97         u16                     _irq:1;
98         u16                     _io:1;
99         u16                     _win:4;
100         u16                     _locked:1;
101
102         /* Flag whether a "fuzzy" func_id based match is
103          * allowed. */
104         u16                     allow_func_id_match:1;
105
106         /* information about this device */
107         u16                     has_manf_id:1;
108         u16                     has_card_id:1;
109         u16                     has_func_id:1;
110
111         u16                     reserved:4;
112
113         u8                      func_id;
114         u16                     manf_id;
115         u16                     card_id;
116
117         char                    *prod_id[4];
118
119         u64                     dma_mask;
120         struct device           dev;
121
122         /* data private to drivers */
123         void                    *priv;
124         unsigned int            open;
125 };
126
127 #define to_pcmcia_dev(n) container_of(n, struct pcmcia_device, dev)
128 #define to_pcmcia_drv(n) container_of(n, struct pcmcia_driver, drv)
129
130
131 /*
132  * CIS access.
133  *
134  * Please use the following functions to access CIS tuples:
135  * - pcmcia_get_tuple()
136  * - pcmcia_loop_tuple()
137  * - pcmcia_get_mac_from_cis()
138  *
139  * To parse a tuple_t, pcmcia_parse_tuple() exists. Its interface
140  * might change in future.
141  */
142
143 /* get the very first CIS entry of type @code. Note that buf is pointer
144  * to u8 *buf; and that you need to kfree(buf) afterwards. */
145 size_t pcmcia_get_tuple(struct pcmcia_device *p_dev, cisdata_t code,
146                         u8 **buf);
147
148 /* loop over CIS entries */
149 int pcmcia_loop_tuple(struct pcmcia_device *p_dev, cisdata_t code,
150                       int (*loop_tuple) (struct pcmcia_device *p_dev,
151                                          tuple_t *tuple,
152                                          void *priv_data),
153                       void *priv_data);
154
155 /* get the MAC address from CISTPL_FUNCE */
156 int pcmcia_get_mac_from_cis(struct pcmcia_device *p_dev,
157                             struct net_device *dev);
158
159
160 /* parse a tuple_t */
161 int pcmcia_parse_tuple(tuple_t *tuple, cisparse_t *parse);
162
163 /* loop CIS entries for valid configuration */
164 int pcmcia_loop_config(struct pcmcia_device *p_dev,
165                        int      (*conf_check)   (struct pcmcia_device *p_dev,
166                                                  cistpl_cftable_entry_t *cf,
167                                                  cistpl_cftable_entry_t *dflt,
168                                                  unsigned int vcc,
169                                                  void *priv_data),
170                        void *priv_data);
171
172 /* is the device still there? */
173 struct pcmcia_device *pcmcia_dev_present(struct pcmcia_device *p_dev);
174
175 /* low-level interface reset */
176 int pcmcia_reset_card(struct pcmcia_socket *skt);
177
178 /* CIS config */
179 int pcmcia_read_config_byte(struct pcmcia_device *p_dev, off_t where, u8 *val);
180 int pcmcia_write_config_byte(struct pcmcia_device *p_dev, off_t where, u8 val);
181
182 /* device configuration */
183 int pcmcia_request_io(struct pcmcia_device *p_dev);
184
185 int __must_check
186 __pcmcia_request_exclusive_irq(struct pcmcia_device *p_dev,
187                                 irq_handler_t handler);
188 static inline __must_check __deprecated int
189 pcmcia_request_exclusive_irq(struct pcmcia_device *p_dev,
190                                 irq_handler_t handler)
191 {
192         return __pcmcia_request_exclusive_irq(p_dev, handler);
193 }
194
195 int __must_check pcmcia_request_irq(struct pcmcia_device *p_dev,
196                                 irq_handler_t handler);
197
198 int pcmcia_request_configuration(struct pcmcia_device *p_dev,
199                                  config_req_t *req);
200
201 int pcmcia_request_window(struct pcmcia_device *p_dev, win_req_t *req,
202                           window_handle_t *wh);
203 int pcmcia_release_window(struct pcmcia_device *p_dev, window_handle_t win);
204 int pcmcia_map_mem_page(struct pcmcia_device *p_dev, window_handle_t win,
205                         unsigned int offset);
206
207 int pcmcia_modify_configuration(struct pcmcia_device *p_dev, modconf_t *mod);
208 void pcmcia_disable_device(struct pcmcia_device *p_dev);
209
210 /* IO ports */
211 #define IO_DATA_PATH_WIDTH      0x18
212 #define IO_DATA_PATH_WIDTH_8    0x00
213 #define IO_DATA_PATH_WIDTH_16   0x08
214 #define IO_DATA_PATH_WIDTH_AUTO 0x10
215
216 /* convert flag found in cfgtable to data path width parameter */
217 static inline int pcmcia_io_cfg_data_width(unsigned int flags)
218 {
219         if (!(flags & CISTPL_IO_8BIT))
220                 return IO_DATA_PATH_WIDTH_16;
221         if (!(flags & CISTPL_IO_16BIT))
222                 return IO_DATA_PATH_WIDTH_8;
223         return IO_DATA_PATH_WIDTH_AUTO;
224 }
225
226 #endif /* __KERNEL__ */
227
228 #endif /* _LINUX_DS_H */