Commit | Line | Data |
---|---|---|
d2912cb1 | 1 | /* SPDX-License-Identifier: GPL-2.0-only */ |
1da177e4 LT |
2 | /* |
3 | * ds.h -- 16-bit PCMCIA core support | |
4 | * | |
1da177e4 LT |
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. | |
8 | * | |
9 | * (C) 1999 David A. Hinds | |
a5835786 | 10 | * (C) 2003 - 2008 Dominik Brodowski |
1da177e4 LT |
11 | */ |
12 | ||
13 | #ifndef _LINUX_DS_H | |
14 | #define _LINUX_DS_H | |
15 | ||
8e2f3b70 DB |
16 | #ifdef __KERNEL__ |
17 | #include <linux/mod_devicetable.h> | |
18 | #endif | |
19 | ||
1ad275e3 | 20 | #include <pcmcia/device_id.h> |
1da177e4 | 21 | |
1da177e4 LT |
22 | #ifdef __KERNEL__ |
23 | #include <linux/device.h> | |
1ac71e5a | 24 | #include <linux/interrupt.h> |
e2d40963 | 25 | #include <pcmcia/ss.h> |
60063497 | 26 | #include <linux/atomic.h> |
1da177e4 | 27 | |
1ac71e5a | 28 | |
a5835786 DB |
29 | /* |
30 | * PCMCIA device drivers (16-bit cards only; 32-bit cards require CardBus | |
31 | * a.k.a. PCI drivers | |
32 | */ | |
1da177e4 | 33 | struct pcmcia_socket; |
a5835786 | 34 | struct pcmcia_device; |
dbb22f0d | 35 | struct config_t; |
91284224 | 36 | struct net_device; |
1da177e4 | 37 | |
a5835786 | 38 | /* dynamic device IDs for PCMCIA device drivers. See |
3bdab16c | 39 | * Documentation/pcmcia/driver.rst for details. |
a5835786 | 40 | */ |
6179b556 | 41 | struct pcmcia_dynids { |
3f565232 | 42 | struct mutex lock; |
6179b556 BW |
43 | struct list_head list; |
44 | }; | |
45 | ||
1da177e4 | 46 | struct pcmcia_driver { |
2e9b981a DB |
47 | const char *name; |
48 | ||
f8cfa618 | 49 | int (*probe) (struct pcmcia_device *dev); |
cc3b4866 DB |
50 | void (*remove) (struct pcmcia_device *dev); |
51 | ||
98e4c28b DB |
52 | int (*suspend) (struct pcmcia_device *dev); |
53 | int (*resume) (struct pcmcia_device *dev); | |
54 | ||
1da177e4 | 55 | struct module *owner; |
e9fb13bf | 56 | const struct pcmcia_device_id *id_table; |
1da177e4 | 57 | struct device_driver drv; |
6179b556 | 58 | struct pcmcia_dynids dynids; |
1da177e4 LT |
59 | }; |
60 | ||
61 | /* driver registration */ | |
62 | int pcmcia_register_driver(struct pcmcia_driver *driver); | |
63 | void pcmcia_unregister_driver(struct pcmcia_driver *driver); | |
64 | ||
6ed7ffdd HS |
65 | /** |
66 | * module_pcmcia_driver() - Helper macro for registering a pcmcia driver | |
67 | * @__pcmcia_driver: pcmcia_driver struct | |
68 | * | |
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(). | |
72 | */ | |
73 | #define module_pcmcia_driver(__pcmcia_driver) \ | |
74 | module_driver(__pcmcia_driver, pcmcia_register_driver, \ | |
75 | pcmcia_unregister_driver) | |
76 | ||
0ca724d3 DB |
77 | /* for struct resource * array embedded in struct pcmcia_device */ |
78 | enum { | |
79 | PCMCIA_IOPORT_0, | |
80 | PCMCIA_IOPORT_1, | |
81 | PCMCIA_IOMEM_0, | |
82 | PCMCIA_IOMEM_1, | |
83 | PCMCIA_IOMEM_2, | |
84 | PCMCIA_IOMEM_3, | |
85 | PCMCIA_NUM_RESOURCES, | |
86 | }; | |
87 | ||
1da177e4 LT |
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; | |
92 | ||
bd65a685 BG |
93 | char *devname; |
94 | ||
1da177e4 LT |
95 | u8 device_no; |
96 | ||
97 | /* the hardware "function" device; certain subdevices can | |
98 | * share one hardware "function" device. */ | |
99 | u8 func; | |
9fea84f4 | 100 | struct config_t *function_config; |
1da177e4 LT |
101 | |
102 | struct list_head socket_device_list; | |
103 | ||
6f0f38c4 | 104 | /* device setup */ |
eb14120f | 105 | unsigned int irq; |
0ca724d3 | 106 | struct resource *resource[PCMCIA_NUM_RESOURCES]; |
00990e7c | 107 | resource_size_t card_addr; /* for the 1st IOMEM resource */ |
e8405f0f | 108 | unsigned int vpp; |
6f0f38c4 | 109 | |
1ac71e5a | 110 | unsigned int config_flags; /* CONF_ENABLE_ flags below */ |
7feabb64 DB |
111 | unsigned int config_base; |
112 | unsigned int config_index; | |
113 | unsigned int config_regs; /* PRESENT_ flags below */ | |
1ac71e5a | 114 | unsigned int io_lines; /* number of I/O lines */ |
90abdc3b | 115 | |
04de0816 | 116 | /* Is the device suspended? */ |
e2d40963 DB |
117 | u16 suspended:1; |
118 | ||
119 | /* Flags whether io, irq, win configurations were | |
120 | * requested, and whether the configuration is "locked" */ | |
121 | u16 _irq:1; | |
122 | u16 _io:1; | |
123 | u16 _win:4; | |
124 | u16 _locked:1; | |
1da177e4 | 125 | |
e2d40963 DB |
126 | /* Flag whether a "fuzzy" func_id based match is |
127 | * allowed. */ | |
128 | u16 allow_func_id_match:1; | |
f6fbe01a | 129 | |
1da177e4 | 130 | /* information about this device */ |
e2d40963 DB |
131 | u16 has_manf_id:1; |
132 | u16 has_card_id:1; | |
133 | u16 has_func_id:1; | |
1ad275e3 | 134 | |
04de0816 | 135 | u16 reserved:4; |
1da177e4 LT |
136 | |
137 | u8 func_id; | |
138 | u16 manf_id; | |
139 | u16 card_id; | |
140 | ||
9fea84f4 | 141 | char *prod_id[4]; |
1da177e4 | 142 | |
43d9f7fd | 143 | u64 dma_mask; |
0e0fad8f DB |
144 | struct device dev; |
145 | ||
e2d40963 DB |
146 | /* data private to drivers */ |
147 | void *priv; | |
2ce4905e | 148 | unsigned int open; |
1da177e4 LT |
149 | }; |
150 | ||
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) | |
153 | ||
a5835786 | 154 | |
91284224 DB |
155 | /* |
156 | * CIS access. | |
157 | * | |
158 | * Please use the following functions to access CIS tuples: | |
159 | * - pcmcia_get_tuple() | |
160 | * - pcmcia_loop_tuple() | |
161 | * - pcmcia_get_mac_from_cis() | |
162 | * | |
163 | * To parse a tuple_t, pcmcia_parse_tuple() exists. Its interface | |
164 | * might change in future. | |
272433e0 | 165 | */ |
272433e0 | 166 | |
91284224 DB |
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, | |
170 | u8 **buf); | |
272433e0 | 171 | |
91284224 DB |
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, | |
175 | tuple_t *tuple, | |
176 | void *priv_data), | |
177 | void *priv_data); | |
272433e0 | 178 | |
91284224 DB |
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); | |
272433e0 DB |
182 | |
183 | ||
91284224 DB |
184 | /* parse a tuple_t */ |
185 | int pcmcia_parse_tuple(tuple_t *tuple, cisparse_t *parse); | |
186 | ||
272433e0 DB |
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, | |
272433e0 DB |
190 | void *priv_data), |
191 | void *priv_data); | |
1da177e4 | 192 | |
994917f8 DB |
193 | /* is the device still there? */ |
194 | struct pcmcia_device *pcmcia_dev_present(struct pcmcia_device *p_dev); | |
195 | ||
196 | /* low-level interface reset */ | |
197 | int pcmcia_reset_card(struct pcmcia_socket *skt); | |
198 | ||
199 | /* CIS config */ | |
1d5cc192 DB |
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); | |
994917f8 DB |
202 | |
203 | /* device configuration */ | |
90abdc3b | 204 | int pcmcia_request_io(struct pcmcia_device *p_dev); |
eb14120f | 205 | |
eb14120f DB |
206 | int __must_check pcmcia_request_irq(struct pcmcia_device *p_dev, |
207 | irq_handler_t handler); | |
208 | ||
1ac71e5a | 209 | int pcmcia_enable_device(struct pcmcia_device *p_dev); |
994917f8 | 210 | |
cdb13808 DB |
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, | |
b5cb259e | 215 | unsigned int offset); |
994917f8 | 216 | |
fb49fa53 DB |
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 | ||
994917f8 DB |
220 | void pcmcia_disable_device(struct pcmcia_device *p_dev); |
221 | ||
90abdc3b DB |
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 | ||
cdb13808 DB |
228 | /* IO memory */ |
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 */ | |
235 | ||
236 | #define WIN_FLAGS_MAP 0x63 /* MAP_ATTRIB | MAP_16BIT | MAP_ACTIVE | | |
237 | MAP_USE_WAIT */ | |
238 | #define WIN_FLAGS_REQ 0x1c /* mapping to socket->win[i]: | |
239 | 0x04 -> 0 | |
240 | 0x08 -> 1 | |
241 | 0x0c -> 2 | |
242 | 0x10 -> 3 */ | |
243 | ||
7feabb64 DB |
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 | |
cdb13808 | 255 | |
1ac71e5a | 256 | /* flags to be passed to pcmcia_enable_device() */ |
00990e7c DB |
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 | |
ff10fca5 DB |
261 | #define CONF_ENABLE_IOCARD 0x0010 /* auto-enabled if IO resources or IRQ |
262 | * (CONF_ENABLE_IRQ) in use */ | |
33619f0d | 263 | #define CONF_ENABLE_ZVCARD 0x0020 |
1ac71e5a | 264 | |
440eed43 | 265 | /* flags used by pcmcia_loop_config() autoconfiguration */ |
00990e7c DB |
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] */ | |
440eed43 | 271 | |
1da177e4 | 272 | #endif /* __KERNEL__ */ |
a5835786 | 273 | |
1da177e4 | 274 | #endif /* _LINUX_DS_H */ |