Commit | Line | Data |
---|---|---|
1da177e4 LT |
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 | |
a5835786 | 13 | * (C) 2003 - 2008 Dominik Brodowski |
1da177e4 LT |
14 | */ |
15 | ||
16 | #ifndef _LINUX_DS_H | |
17 | #define _LINUX_DS_H | |
18 | ||
8e2f3b70 DB |
19 | #ifdef __KERNEL__ |
20 | #include <linux/mod_devicetable.h> | |
21 | #endif | |
22 | ||
1ad275e3 | 23 | #include <pcmcia/device_id.h> |
1da177e4 | 24 | |
1da177e4 LT |
25 | #ifdef __KERNEL__ |
26 | #include <linux/device.h> | |
1ac71e5a | 27 | #include <linux/interrupt.h> |
e2d40963 | 28 | #include <pcmcia/ss.h> |
60063497 | 29 | #include <linux/atomic.h> |
1da177e4 | 30 | |
1ac71e5a | 31 | |
a5835786 DB |
32 | /* |
33 | * PCMCIA device drivers (16-bit cards only; 32-bit cards require CardBus | |
34 | * a.k.a. PCI drivers | |
35 | */ | |
1da177e4 | 36 | struct pcmcia_socket; |
a5835786 | 37 | struct pcmcia_device; |
dbb22f0d | 38 | struct config_t; |
91284224 | 39 | struct net_device; |
1da177e4 | 40 | |
a5835786 DB |
41 | /* dynamic device IDs for PCMCIA device drivers. See |
42 | * Documentation/pcmcia/driver.txt for details. | |
43 | */ | |
6179b556 | 44 | struct pcmcia_dynids { |
3f565232 | 45 | struct mutex lock; |
6179b556 BW |
46 | struct list_head list; |
47 | }; | |
48 | ||
1da177e4 | 49 | struct pcmcia_driver { |
2e9b981a DB |
50 | const char *name; |
51 | ||
f8cfa618 | 52 | int (*probe) (struct pcmcia_device *dev); |
cc3b4866 DB |
53 | void (*remove) (struct pcmcia_device *dev); |
54 | ||
98e4c28b DB |
55 | int (*suspend) (struct pcmcia_device *dev); |
56 | int (*resume) (struct pcmcia_device *dev); | |
57 | ||
1da177e4 | 58 | struct module *owner; |
e9fb13bf | 59 | const struct pcmcia_device_id *id_table; |
1da177e4 | 60 | struct device_driver drv; |
6179b556 | 61 | struct pcmcia_dynids dynids; |
1da177e4 LT |
62 | }; |
63 | ||
64 | /* driver registration */ | |
65 | int pcmcia_register_driver(struct pcmcia_driver *driver); | |
66 | void pcmcia_unregister_driver(struct pcmcia_driver *driver); | |
67 | ||
0ca724d3 DB |
68 | /* for struct resource * array embedded in struct pcmcia_device */ |
69 | enum { | |
70 | PCMCIA_IOPORT_0, | |
71 | PCMCIA_IOPORT_1, | |
72 | PCMCIA_IOMEM_0, | |
73 | PCMCIA_IOMEM_1, | |
74 | PCMCIA_IOMEM_2, | |
75 | PCMCIA_IOMEM_3, | |
76 | PCMCIA_NUM_RESOURCES, | |
77 | }; | |
78 | ||
1da177e4 LT |
79 | struct pcmcia_device { |
80 | /* the socket and the device_no [for multifunction devices] | |
81 | uniquely define a pcmcia_device */ | |
82 | struct pcmcia_socket *socket; | |
83 | ||
bd65a685 BG |
84 | char *devname; |
85 | ||
1da177e4 LT |
86 | u8 device_no; |
87 | ||
88 | /* the hardware "function" device; certain subdevices can | |
89 | * share one hardware "function" device. */ | |
90 | u8 func; | |
9fea84f4 | 91 | struct config_t *function_config; |
1da177e4 LT |
92 | |
93 | struct list_head socket_device_list; | |
94 | ||
6f0f38c4 | 95 | /* device setup */ |
eb14120f | 96 | unsigned int irq; |
0ca724d3 | 97 | struct resource *resource[PCMCIA_NUM_RESOURCES]; |
00990e7c | 98 | resource_size_t card_addr; /* for the 1st IOMEM resource */ |
e8405f0f | 99 | unsigned int vpp; |
6f0f38c4 | 100 | |
1ac71e5a | 101 | unsigned int config_flags; /* CONF_ENABLE_ flags below */ |
7feabb64 DB |
102 | unsigned int config_base; |
103 | unsigned int config_index; | |
104 | unsigned int config_regs; /* PRESENT_ flags below */ | |
1ac71e5a | 105 | unsigned int io_lines; /* number of I/O lines */ |
90abdc3b | 106 | |
04de0816 | 107 | /* Is the device suspended? */ |
e2d40963 DB |
108 | u16 suspended:1; |
109 | ||
110 | /* Flags whether io, irq, win configurations were | |
111 | * requested, and whether the configuration is "locked" */ | |
112 | u16 _irq:1; | |
113 | u16 _io:1; | |
114 | u16 _win:4; | |
115 | u16 _locked:1; | |
1da177e4 | 116 | |
e2d40963 DB |
117 | /* Flag whether a "fuzzy" func_id based match is |
118 | * allowed. */ | |
119 | u16 allow_func_id_match:1; | |
f6fbe01a | 120 | |
1da177e4 | 121 | /* information about this device */ |
e2d40963 DB |
122 | u16 has_manf_id:1; |
123 | u16 has_card_id:1; | |
124 | u16 has_func_id:1; | |
1ad275e3 | 125 | |
04de0816 | 126 | u16 reserved:4; |
1da177e4 LT |
127 | |
128 | u8 func_id; | |
129 | u16 manf_id; | |
130 | u16 card_id; | |
131 | ||
9fea84f4 | 132 | char *prod_id[4]; |
1da177e4 | 133 | |
43d9f7fd | 134 | u64 dma_mask; |
0e0fad8f DB |
135 | struct device dev; |
136 | ||
e2d40963 DB |
137 | /* data private to drivers */ |
138 | void *priv; | |
2ce4905e | 139 | unsigned int open; |
1da177e4 LT |
140 | }; |
141 | ||
142 | #define to_pcmcia_dev(n) container_of(n, struct pcmcia_device, dev) | |
143 | #define to_pcmcia_drv(n) container_of(n, struct pcmcia_driver, drv) | |
144 | ||
a5835786 | 145 | |
91284224 DB |
146 | /* |
147 | * CIS access. | |
148 | * | |
149 | * Please use the following functions to access CIS tuples: | |
150 | * - pcmcia_get_tuple() | |
151 | * - pcmcia_loop_tuple() | |
152 | * - pcmcia_get_mac_from_cis() | |
153 | * | |
154 | * To parse a tuple_t, pcmcia_parse_tuple() exists. Its interface | |
155 | * might change in future. | |
272433e0 | 156 | */ |
272433e0 | 157 | |
91284224 DB |
158 | /* get the very first CIS entry of type @code. Note that buf is pointer |
159 | * to u8 *buf; and that you need to kfree(buf) afterwards. */ | |
160 | size_t pcmcia_get_tuple(struct pcmcia_device *p_dev, cisdata_t code, | |
161 | u8 **buf); | |
272433e0 | 162 | |
91284224 DB |
163 | /* loop over CIS entries */ |
164 | int pcmcia_loop_tuple(struct pcmcia_device *p_dev, cisdata_t code, | |
165 | int (*loop_tuple) (struct pcmcia_device *p_dev, | |
166 | tuple_t *tuple, | |
167 | void *priv_data), | |
168 | void *priv_data); | |
272433e0 | 169 | |
91284224 DB |
170 | /* get the MAC address from CISTPL_FUNCE */ |
171 | int pcmcia_get_mac_from_cis(struct pcmcia_device *p_dev, | |
172 | struct net_device *dev); | |
272433e0 DB |
173 | |
174 | ||
91284224 DB |
175 | /* parse a tuple_t */ |
176 | int pcmcia_parse_tuple(tuple_t *tuple, cisparse_t *parse); | |
177 | ||
272433e0 DB |
178 | /* loop CIS entries for valid configuration */ |
179 | int pcmcia_loop_config(struct pcmcia_device *p_dev, | |
180 | int (*conf_check) (struct pcmcia_device *p_dev, | |
272433e0 DB |
181 | void *priv_data), |
182 | void *priv_data); | |
1da177e4 | 183 | |
994917f8 DB |
184 | /* is the device still there? */ |
185 | struct pcmcia_device *pcmcia_dev_present(struct pcmcia_device *p_dev); | |
186 | ||
187 | /* low-level interface reset */ | |
188 | int pcmcia_reset_card(struct pcmcia_socket *skt); | |
189 | ||
190 | /* CIS config */ | |
1d5cc192 DB |
191 | int pcmcia_read_config_byte(struct pcmcia_device *p_dev, off_t where, u8 *val); |
192 | int pcmcia_write_config_byte(struct pcmcia_device *p_dev, off_t where, u8 val); | |
994917f8 DB |
193 | |
194 | /* device configuration */ | |
90abdc3b | 195 | int pcmcia_request_io(struct pcmcia_device *p_dev); |
eb14120f | 196 | |
b19a7275 DB |
197 | int __must_check |
198 | __pcmcia_request_exclusive_irq(struct pcmcia_device *p_dev, | |
eb14120f | 199 | irq_handler_t handler); |
b19a7275 DB |
200 | static inline __must_check __deprecated int |
201 | pcmcia_request_exclusive_irq(struct pcmcia_device *p_dev, | |
202 | irq_handler_t handler) | |
203 | { | |
204 | return __pcmcia_request_exclusive_irq(p_dev, handler); | |
205 | } | |
206 | ||
eb14120f DB |
207 | int __must_check pcmcia_request_irq(struct pcmcia_device *p_dev, |
208 | irq_handler_t handler); | |
209 | ||
1ac71e5a | 210 | int pcmcia_enable_device(struct pcmcia_device *p_dev); |
994917f8 | 211 | |
cdb13808 DB |
212 | int pcmcia_request_window(struct pcmcia_device *p_dev, struct resource *res, |
213 | unsigned int speed); | |
214 | int pcmcia_release_window(struct pcmcia_device *p_dev, struct resource *res); | |
215 | int pcmcia_map_mem_page(struct pcmcia_device *p_dev, struct resource *res, | |
b5cb259e | 216 | unsigned int offset); |
994917f8 | 217 | |
fb49fa53 DB |
218 | int pcmcia_fixup_vpp(struct pcmcia_device *p_dev, unsigned char new_vpp); |
219 | int pcmcia_fixup_iowidth(struct pcmcia_device *p_dev); | |
220 | ||
994917f8 DB |
221 | void pcmcia_disable_device(struct pcmcia_device *p_dev); |
222 | ||
90abdc3b DB |
223 | /* IO ports */ |
224 | #define IO_DATA_PATH_WIDTH 0x18 | |
225 | #define IO_DATA_PATH_WIDTH_8 0x00 | |
226 | #define IO_DATA_PATH_WIDTH_16 0x08 | |
227 | #define IO_DATA_PATH_WIDTH_AUTO 0x10 | |
228 | ||
cdb13808 DB |
229 | /* IO memory */ |
230 | #define WIN_MEMORY_TYPE_CM 0x00 /* default */ | |
231 | #define WIN_MEMORY_TYPE_AM 0x20 /* MAP_ATTRIB */ | |
232 | #define WIN_DATA_WIDTH_8 0x00 /* default */ | |
233 | #define WIN_DATA_WIDTH_16 0x02 /* MAP_16BIT */ | |
234 | #define WIN_ENABLE 0x01 /* MAP_ACTIVE */ | |
235 | #define WIN_USE_WAIT 0x40 /* MAP_USE_WAIT */ | |
236 | ||
237 | #define WIN_FLAGS_MAP 0x63 /* MAP_ATTRIB | MAP_16BIT | MAP_ACTIVE | | |
238 | MAP_USE_WAIT */ | |
239 | #define WIN_FLAGS_REQ 0x1c /* mapping to socket->win[i]: | |
240 | 0x04 -> 0 | |
241 | 0x08 -> 1 | |
242 | 0x0c -> 2 | |
243 | 0x10 -> 3 */ | |
244 | ||
7feabb64 DB |
245 | /* config_reg{ister}s present for this PCMCIA device */ |
246 | #define PRESENT_OPTION 0x001 | |
247 | #define PRESENT_STATUS 0x002 | |
248 | #define PRESENT_PIN_REPLACE 0x004 | |
249 | #define PRESENT_COPY 0x008 | |
250 | #define PRESENT_EXT_STATUS 0x010 | |
251 | #define PRESENT_IOBASE_0 0x020 | |
252 | #define PRESENT_IOBASE_1 0x040 | |
253 | #define PRESENT_IOBASE_2 0x080 | |
254 | #define PRESENT_IOBASE_3 0x100 | |
255 | #define PRESENT_IOSIZE 0x200 | |
cdb13808 | 256 | |
1ac71e5a | 257 | /* flags to be passed to pcmcia_enable_device() */ |
00990e7c DB |
258 | #define CONF_ENABLE_IRQ 0x0001 |
259 | #define CONF_ENABLE_SPKR 0x0002 | |
260 | #define CONF_ENABLE_PULSE_IRQ 0x0004 | |
261 | #define CONF_ENABLE_ESR 0x0008 | |
ff10fca5 DB |
262 | #define CONF_ENABLE_IOCARD 0x0010 /* auto-enabled if IO resources or IRQ |
263 | * (CONF_ENABLE_IRQ) in use */ | |
33619f0d | 264 | #define CONF_ENABLE_ZVCARD 0x0020 |
1ac71e5a | 265 | |
440eed43 | 266 | /* flags used by pcmcia_loop_config() autoconfiguration */ |
00990e7c DB |
267 | #define CONF_AUTO_CHECK_VCC 0x0100 /* check for matching Vcc? */ |
268 | #define CONF_AUTO_SET_VPP 0x0200 /* set Vpp? */ | |
269 | #define CONF_AUTO_AUDIO 0x0400 /* enable audio line? */ | |
270 | #define CONF_AUTO_SET_IO 0x0800 /* set ->resource[0,1] */ | |
271 | #define CONF_AUTO_SET_IOMEM 0x1000 /* set ->resource[2] */ | |
440eed43 | 272 | |
1da177e4 | 273 | #endif /* __KERNEL__ */ |
a5835786 | 274 | |
1da177e4 | 275 | #endif /* _LINUX_DS_H */ |