2 * ds.h -- 16-bit PCMCIA core support
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.
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.
12 * (C) 1999 David A. Hinds
13 * (C) 2003 - 2008 Dominik Brodowski
20 #include <linux/mod_devicetable.h>
23 #include <pcmcia/device_id.h>
26 #include <linux/device.h>
27 #include <linux/interrupt.h>
28 #include <pcmcia/ss.h>
29 #include <asm/atomic.h>
33 * PCMCIA device drivers (16-bit cards only; 32-bit cards require CardBus
41 /* dynamic device IDs for PCMCIA device drivers. See
42 * Documentation/pcmcia/driver.txt for details.
44 struct pcmcia_dynids {
46 struct list_head list;
49 struct pcmcia_driver {
50 int (*probe) (struct pcmcia_device *dev);
51 void (*remove) (struct pcmcia_device *dev);
53 int (*suspend) (struct pcmcia_device *dev);
54 int (*resume) (struct pcmcia_device *dev);
57 struct pcmcia_device_id *id_table;
58 struct device_driver drv;
59 struct pcmcia_dynids dynids;
62 /* driver registration */
63 int pcmcia_register_driver(struct pcmcia_driver *driver);
64 void pcmcia_unregister_driver(struct pcmcia_driver *driver);
66 /* for struct resource * array embedded in struct pcmcia_device */
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;
86 /* the hardware "function" device; certain subdevices can
87 * share one hardware "function" device. */
89 struct config_t *function_config;
91 struct list_head socket_device_list;
95 struct resource *resource[PCMCIA_NUM_RESOURCES];
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 */
104 /* Is the device suspended? */
107 /* Flags whether io, irq, win configurations were
108 * requested, and whether the configuration is "locked" */
114 /* Flag whether a "fuzzy" func_id based match is
116 u16 allow_func_id_match:1;
118 /* information about this device */
134 /* data private to drivers */
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)
146 * Please use the following functions to access CIS tuples:
147 * - pcmcia_get_tuple()
148 * - pcmcia_loop_tuple()
149 * - pcmcia_get_mac_from_cis()
151 * To parse a tuple_t, pcmcia_parse_tuple() exists. Its interface
152 * might change in future.
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,
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,
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);
172 /* parse a tuple_t */
173 int pcmcia_parse_tuple(tuple_t *tuple, cisparse_t *parse);
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,
184 /* is the device still there? */
185 struct pcmcia_device *pcmcia_dev_present(struct pcmcia_device *p_dev);
187 /* low-level interface reset */
188 int pcmcia_reset_card(struct pcmcia_socket *skt);
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);
194 /* device configuration */
195 int pcmcia_request_io(struct pcmcia_device *p_dev);
198 __pcmcia_request_exclusive_irq(struct pcmcia_device *p_dev,
199 irq_handler_t handler);
200 static inline __must_check __deprecated int
201 pcmcia_request_exclusive_irq(struct pcmcia_device *p_dev,
202 irq_handler_t handler)
204 return __pcmcia_request_exclusive_irq(p_dev, handler);
207 int __must_check pcmcia_request_irq(struct pcmcia_device *p_dev,
208 irq_handler_t handler);
210 int pcmcia_enable_device(struct pcmcia_device *p_dev);
212 int pcmcia_request_window(struct pcmcia_device *p_dev, struct resource *res,
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,
216 unsigned int offset);
218 int pcmcia_fixup_vpp(struct pcmcia_device *p_dev, unsigned char new_vpp);
219 int pcmcia_fixup_iowidth(struct pcmcia_device *p_dev);
221 void pcmcia_disable_device(struct pcmcia_device *p_dev);
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
229 /* convert flag found in cfgtable to data path width parameter */
230 static inline int pcmcia_io_cfg_data_width(unsigned int flags)
232 if (!(flags & CISTPL_IO_8BIT))
233 return IO_DATA_PATH_WIDTH_16;
234 if (!(flags & CISTPL_IO_16BIT))
235 return IO_DATA_PATH_WIDTH_8;
236 return IO_DATA_PATH_WIDTH_AUTO;
240 #define WIN_MEMORY_TYPE_CM 0x00 /* default */
241 #define WIN_MEMORY_TYPE_AM 0x20 /* MAP_ATTRIB */
242 #define WIN_DATA_WIDTH_8 0x00 /* default */
243 #define WIN_DATA_WIDTH_16 0x02 /* MAP_16BIT */
244 #define WIN_ENABLE 0x01 /* MAP_ACTIVE */
245 #define WIN_USE_WAIT 0x40 /* MAP_USE_WAIT */
247 #define WIN_FLAGS_MAP 0x63 /* MAP_ATTRIB | MAP_16BIT | MAP_ACTIVE |
249 #define WIN_FLAGS_REQ 0x1c /* mapping to socket->win[i]:
255 /* config_reg{ister}s present for this PCMCIA device */
256 #define PRESENT_OPTION 0x001
257 #define PRESENT_STATUS 0x002
258 #define PRESENT_PIN_REPLACE 0x004
259 #define PRESENT_COPY 0x008
260 #define PRESENT_EXT_STATUS 0x010
261 #define PRESENT_IOBASE_0 0x020
262 #define PRESENT_IOBASE_1 0x040
263 #define PRESENT_IOBASE_2 0x080
264 #define PRESENT_IOBASE_3 0x100
265 #define PRESENT_IOSIZE 0x200
267 /* flags to be passed to pcmcia_enable_device() */
268 #define CONF_ENABLE_IRQ 0x01
269 #define CONF_ENABLE_SPKR 0x02
270 #define CONF_ENABLE_PULSE_IRQ 0x04
271 #define CONF_ENABLE_ESR 0x08
273 #endif /* __KERNEL__ */
275 #endif /* _LINUX_DS_H */