pcmcia: introduce autoconfiguration feature
[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 <linux/interrupt.h>
28 #include <pcmcia/ss.h>
29 #include <asm/atomic.h>
30
31
32 /*
33  * PCMCIA device drivers (16-bit cards only; 32-bit cards require CardBus
34  * a.k.a. PCI drivers
35  */
36 struct pcmcia_socket;
37 struct pcmcia_device;
38 struct config_t;
39 struct net_device;
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 /* for struct resource * array embedded in struct pcmcia_device */
67 enum {
68         PCMCIA_IOPORT_0,
69         PCMCIA_IOPORT_1,
70         PCMCIA_IOMEM_0,
71         PCMCIA_IOMEM_1,
72         PCMCIA_IOMEM_2,
73         PCMCIA_IOMEM_3,
74         PCMCIA_NUM_RESOURCES,
75 };
76
77 struct pcmcia_device {
78         /* the socket and the device_no [for multifunction devices]
79            uniquely define a pcmcia_device */
80         struct pcmcia_socket    *socket;
81
82         char                    *devname;
83
84         u8                      device_no;
85
86         /* the hardware "function" device; certain subdevices can
87          * share one hardware "function" device. */
88         u8                      func;
89         struct config_t         *function_config;
90
91         struct list_head        socket_device_list;
92
93         /* device setup */
94         unsigned int            irq;
95         struct resource         *resource[PCMCIA_NUM_RESOURCES];
96         unsigned int            vpp;
97
98         unsigned int            config_flags;   /* CONF_ENABLE_ flags below */
99         unsigned int            config_base;
100         unsigned int            config_index;
101         unsigned int            config_regs;    /* PRESENT_ flags below */
102         unsigned int            io_lines;       /* number of I/O lines */
103
104         /* Is the device suspended? */
105         u16                     suspended:1;
106
107         /* Flags whether io, irq, win configurations were
108          * requested, and whether the configuration is "locked" */
109         u16                     _irq:1;
110         u16                     _io:1;
111         u16                     _win:4;
112         u16                     _locked:1;
113
114         /* Flag whether a "fuzzy" func_id based match is
115          * allowed. */
116         u16                     allow_func_id_match:1;
117
118         /* information about this device */
119         u16                     has_manf_id:1;
120         u16                     has_card_id:1;
121         u16                     has_func_id:1;
122
123         u16                     reserved:4;
124
125         u8                      func_id;
126         u16                     manf_id;
127         u16                     card_id;
128
129         char                    *prod_id[4];
130
131         u64                     dma_mask;
132         struct device           dev;
133
134         /* data private to drivers */
135         void                    *priv;
136         unsigned int            open;
137 };
138
139 #define to_pcmcia_dev(n) container_of(n, struct pcmcia_device, dev)
140 #define to_pcmcia_drv(n) container_of(n, struct pcmcia_driver, drv)
141
142
143 /*
144  * CIS access.
145  *
146  * Please use the following functions to access CIS tuples:
147  * - pcmcia_get_tuple()
148  * - pcmcia_loop_tuple()
149  * - pcmcia_get_mac_from_cis()
150  *
151  * To parse a tuple_t, pcmcia_parse_tuple() exists. Its interface
152  * might change in future.
153  */
154
155 /* get the very first CIS entry of type @code. Note that buf is pointer
156  * to u8 *buf; and that you need to kfree(buf) afterwards. */
157 size_t pcmcia_get_tuple(struct pcmcia_device *p_dev, cisdata_t code,
158                         u8 **buf);
159
160 /* loop over CIS entries */
161 int pcmcia_loop_tuple(struct pcmcia_device *p_dev, cisdata_t code,
162                       int (*loop_tuple) (struct pcmcia_device *p_dev,
163                                          tuple_t *tuple,
164                                          void *priv_data),
165                       void *priv_data);
166
167 /* get the MAC address from CISTPL_FUNCE */
168 int pcmcia_get_mac_from_cis(struct pcmcia_device *p_dev,
169                             struct net_device *dev);
170
171
172 /* parse a tuple_t */
173 int pcmcia_parse_tuple(tuple_t *tuple, cisparse_t *parse);
174
175 /* loop CIS entries for valid configuration */
176 int pcmcia_loop_config(struct pcmcia_device *p_dev,
177                        int      (*conf_check)   (struct pcmcia_device *p_dev,
178                                                  cistpl_cftable_entry_t *cf,
179                                                  cistpl_cftable_entry_t *dflt,
180                                                  void *priv_data),
181                        void *priv_data);
182
183 /* is the device still there? */
184 struct pcmcia_device *pcmcia_dev_present(struct pcmcia_device *p_dev);
185
186 /* low-level interface reset */
187 int pcmcia_reset_card(struct pcmcia_socket *skt);
188
189 /* CIS config */
190 int pcmcia_read_config_byte(struct pcmcia_device *p_dev, off_t where, u8 *val);
191 int pcmcia_write_config_byte(struct pcmcia_device *p_dev, off_t where, u8 val);
192
193 /* device configuration */
194 int pcmcia_request_io(struct pcmcia_device *p_dev);
195
196 int __must_check
197 __pcmcia_request_exclusive_irq(struct pcmcia_device *p_dev,
198                                 irq_handler_t handler);
199 static inline __must_check __deprecated int
200 pcmcia_request_exclusive_irq(struct pcmcia_device *p_dev,
201                                 irq_handler_t handler)
202 {
203         return __pcmcia_request_exclusive_irq(p_dev, handler);
204 }
205
206 int __must_check pcmcia_request_irq(struct pcmcia_device *p_dev,
207                                 irq_handler_t handler);
208
209 int pcmcia_enable_device(struct pcmcia_device *p_dev);
210
211 int pcmcia_request_window(struct pcmcia_device *p_dev, struct resource *res,
212                         unsigned int speed);
213 int pcmcia_release_window(struct pcmcia_device *p_dev, struct resource *res);
214 int pcmcia_map_mem_page(struct pcmcia_device *p_dev, struct resource *res,
215                         unsigned int offset);
216
217 int pcmcia_fixup_vpp(struct pcmcia_device *p_dev, unsigned char new_vpp);
218 int pcmcia_fixup_iowidth(struct pcmcia_device *p_dev);
219
220 void pcmcia_disable_device(struct pcmcia_device *p_dev);
221
222 /* IO ports */
223 #define IO_DATA_PATH_WIDTH      0x18
224 #define IO_DATA_PATH_WIDTH_8    0x00
225 #define IO_DATA_PATH_WIDTH_16   0x08
226 #define IO_DATA_PATH_WIDTH_AUTO 0x10
227
228 /* convert flag found in cfgtable to data path width parameter */
229 static inline int pcmcia_io_cfg_data_width(unsigned int flags)
230 {
231         if (!(flags & CISTPL_IO_8BIT))
232                 return IO_DATA_PATH_WIDTH_16;
233         if (!(flags & CISTPL_IO_16BIT))
234                 return IO_DATA_PATH_WIDTH_8;
235         return IO_DATA_PATH_WIDTH_AUTO;
236 }
237
238 /* IO memory */
239 #define WIN_MEMORY_TYPE_CM      0x00 /* default */
240 #define WIN_MEMORY_TYPE_AM      0x20 /* MAP_ATTRIB */
241 #define WIN_DATA_WIDTH_8        0x00 /* default */
242 #define WIN_DATA_WIDTH_16       0x02 /* MAP_16BIT */
243 #define WIN_ENABLE              0x01 /* MAP_ACTIVE */
244 #define WIN_USE_WAIT            0x40 /* MAP_USE_WAIT */
245
246 #define WIN_FLAGS_MAP           0x63 /* MAP_ATTRIB | MAP_16BIT | MAP_ACTIVE |
247                                         MAP_USE_WAIT */
248 #define WIN_FLAGS_REQ           0x1c /* mapping to socket->win[i]:
249                                         0x04 -> 0
250                                         0x08 -> 1
251                                         0x0c -> 2
252                                         0x10 -> 3 */
253
254 /* config_reg{ister}s present for this PCMCIA device */
255 #define PRESENT_OPTION          0x001
256 #define PRESENT_STATUS          0x002
257 #define PRESENT_PIN_REPLACE     0x004
258 #define PRESENT_COPY            0x008
259 #define PRESENT_EXT_STATUS      0x010
260 #define PRESENT_IOBASE_0        0x020
261 #define PRESENT_IOBASE_1        0x040
262 #define PRESENT_IOBASE_2        0x080
263 #define PRESENT_IOBASE_3        0x100
264 #define PRESENT_IOSIZE          0x200
265
266 /* flags to be passed to pcmcia_enable_device() */
267 #define CONF_ENABLE_IRQ         0x01
268 #define CONF_ENABLE_SPKR        0x02
269 #define CONF_ENABLE_PULSE_IRQ   0x04
270 #define CONF_ENABLE_ESR         0x08
271
272 /* flags used by pcmcia_loop_config() autoconfiguration */
273 #define CONF_AUTO_CHECK_VCC     0x10 /* check for matching Vcc? */
274 #define CONF_AUTO_SET_VPP       0x20 /* set Vpp? */
275 #define CONF_AUTO_AUDIO         0x40 /* enable audio line? */
276
277
278 #endif /* __KERNEL__ */
279
280 #endif /* _LINUX_DS_H */