1 /* SPDX-License-Identifier: GPL-2.0-only */
3 * ds.h -- 16-bit PCMCIA core support
5 * The initial developer of the original code is David A. Hinds
6 * <dahinds@users.sourceforge.net>. Portions created by David A. Hinds
7 * are Copyright (C) 1999 David A. Hinds. All Rights Reserved.
9 * (C) 1999 David A. Hinds
10 * (C) 2003 - 2008 Dominik Brodowski
17 #include <linux/mod_devicetable.h>
20 #include <pcmcia/device_id.h>
23 #include <linux/device.h>
24 #include <linux/interrupt.h>
25 #include <pcmcia/ss.h>
26 #include <linux/atomic.h>
30 * PCMCIA device drivers (16-bit cards only; 32-bit cards require CardBus
38 /* dynamic device IDs for PCMCIA device drivers. See
39 * Documentation/pcmcia/driver.txt for details.
41 struct pcmcia_dynids
{
43 struct list_head list
;
46 struct pcmcia_driver
{
49 int (*probe
) (struct pcmcia_device
*dev
);
50 void (*remove
) (struct pcmcia_device
*dev
);
52 int (*suspend
) (struct pcmcia_device
*dev
);
53 int (*resume
) (struct pcmcia_device
*dev
);
56 const struct pcmcia_device_id
*id_table
;
57 struct device_driver drv
;
58 struct pcmcia_dynids dynids
;
61 /* driver registration */
62 int pcmcia_register_driver(struct pcmcia_driver
*driver
);
63 void pcmcia_unregister_driver(struct pcmcia_driver
*driver
);
66 * module_pcmcia_driver() - Helper macro for registering a pcmcia driver
67 * @__pcmcia_driver: pcmcia_driver struct
69 * Helper macro for pcmcia drivers which do not do anything special in module
70 * init/exit. This eliminates a lot of boilerplate. Each module may only use
71 * this macro once, and calling it replaces module_init() and module_exit().
73 #define module_pcmcia_driver(__pcmcia_driver) \
74 module_driver(__pcmcia_driver, pcmcia_register_driver, \
75 pcmcia_unregister_driver)
77 /* for struct resource * array embedded in struct pcmcia_device */
88 struct pcmcia_device
{
89 /* the socket and the device_no [for multifunction devices]
90 uniquely define a pcmcia_device */
91 struct pcmcia_socket
*socket
;
97 /* the hardware "function" device; certain subdevices can
98 * share one hardware "function" device. */
100 struct config_t
*function_config
;
102 struct list_head socket_device_list
;
106 struct resource
*resource
[PCMCIA_NUM_RESOURCES
];
107 resource_size_t card_addr
; /* for the 1st IOMEM resource */
110 unsigned int config_flags
; /* CONF_ENABLE_ flags below */
111 unsigned int config_base
;
112 unsigned int config_index
;
113 unsigned int config_regs
; /* PRESENT_ flags below */
114 unsigned int io_lines
; /* number of I/O lines */
116 /* Is the device suspended? */
119 /* Flags whether io, irq, win configurations were
120 * requested, and whether the configuration is "locked" */
126 /* Flag whether a "fuzzy" func_id based match is
128 u16 allow_func_id_match
:1;
130 /* information about this device */
146 /* data private to drivers */
151 #define to_pcmcia_dev(n) container_of(n, struct pcmcia_device, dev)
152 #define to_pcmcia_drv(n) container_of(n, struct pcmcia_driver, drv)
158 * Please use the following functions to access CIS tuples:
159 * - pcmcia_get_tuple()
160 * - pcmcia_loop_tuple()
161 * - pcmcia_get_mac_from_cis()
163 * To parse a tuple_t, pcmcia_parse_tuple() exists. Its interface
164 * might change in future.
167 /* get the very first CIS entry of type @code. Note that buf is pointer
168 * to u8 *buf; and that you need to kfree(buf) afterwards. */
169 size_t pcmcia_get_tuple(struct pcmcia_device
*p_dev
, cisdata_t code
,
172 /* loop over CIS entries */
173 int pcmcia_loop_tuple(struct pcmcia_device
*p_dev
, cisdata_t code
,
174 int (*loop_tuple
) (struct pcmcia_device
*p_dev
,
179 /* get the MAC address from CISTPL_FUNCE */
180 int pcmcia_get_mac_from_cis(struct pcmcia_device
*p_dev
,
181 struct net_device
*dev
);
184 /* parse a tuple_t */
185 int pcmcia_parse_tuple(tuple_t
*tuple
, cisparse_t
*parse
);
187 /* loop CIS entries for valid configuration */
188 int pcmcia_loop_config(struct pcmcia_device
*p_dev
,
189 int (*conf_check
) (struct pcmcia_device
*p_dev
,
193 /* is the device still there? */
194 struct pcmcia_device
*pcmcia_dev_present(struct pcmcia_device
*p_dev
);
196 /* low-level interface reset */
197 int pcmcia_reset_card(struct pcmcia_socket
*skt
);
200 int pcmcia_read_config_byte(struct pcmcia_device
*p_dev
, off_t where
, u8
*val
);
201 int pcmcia_write_config_byte(struct pcmcia_device
*p_dev
, off_t where
, u8 val
);
203 /* device configuration */
204 int pcmcia_request_io(struct pcmcia_device
*p_dev
);
206 int __must_check
pcmcia_request_irq(struct pcmcia_device
*p_dev
,
207 irq_handler_t handler
);
209 int pcmcia_enable_device(struct pcmcia_device
*p_dev
);
211 int pcmcia_request_window(struct pcmcia_device
*p_dev
, struct resource
*res
,
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
);
217 int pcmcia_fixup_vpp(struct pcmcia_device
*p_dev
, unsigned char new_vpp
);
218 int pcmcia_fixup_iowidth(struct pcmcia_device
*p_dev
);
220 void pcmcia_disable_device(struct pcmcia_device
*p_dev
);
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
229 #define WIN_MEMORY_TYPE_CM 0x00 /* default */
230 #define WIN_MEMORY_TYPE_AM 0x20 /* MAP_ATTRIB */
231 #define WIN_DATA_WIDTH_8 0x00 /* default */
232 #define WIN_DATA_WIDTH_16 0x02 /* MAP_16BIT */
233 #define WIN_ENABLE 0x01 /* MAP_ACTIVE */
234 #define WIN_USE_WAIT 0x40 /* MAP_USE_WAIT */
236 #define WIN_FLAGS_MAP 0x63 /* MAP_ATTRIB | MAP_16BIT | MAP_ACTIVE |
238 #define WIN_FLAGS_REQ 0x1c /* mapping to socket->win[i]:
244 /* config_reg{ister}s present for this PCMCIA device */
245 #define PRESENT_OPTION 0x001
246 #define PRESENT_STATUS 0x002
247 #define PRESENT_PIN_REPLACE 0x004
248 #define PRESENT_COPY 0x008
249 #define PRESENT_EXT_STATUS 0x010
250 #define PRESENT_IOBASE_0 0x020
251 #define PRESENT_IOBASE_1 0x040
252 #define PRESENT_IOBASE_2 0x080
253 #define PRESENT_IOBASE_3 0x100
254 #define PRESENT_IOSIZE 0x200
256 /* flags to be passed to pcmcia_enable_device() */
257 #define CONF_ENABLE_IRQ 0x0001
258 #define CONF_ENABLE_SPKR 0x0002
259 #define CONF_ENABLE_PULSE_IRQ 0x0004
260 #define CONF_ENABLE_ESR 0x0008
261 #define CONF_ENABLE_IOCARD 0x0010 /* auto-enabled if IO resources or IRQ
262 * (CONF_ENABLE_IRQ) in use */
263 #define CONF_ENABLE_ZVCARD 0x0020
265 /* flags used by pcmcia_loop_config() autoconfiguration */
266 #define CONF_AUTO_CHECK_VCC 0x0100 /* check for matching Vcc? */
267 #define CONF_AUTO_SET_VPP 0x0200 /* set Vpp? */
268 #define CONF_AUTO_AUDIO 0x0400 /* enable audio line? */
269 #define CONF_AUTO_SET_IO 0x0800 /* set ->resource[0,1] */
270 #define CONF_AUTO_SET_IOMEM 0x1000 /* set ->resource[2] */
272 #endif /* __KERNEL__ */
274 #endif /* _LINUX_DS_H */