Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /*====================================================================== |
2 | ||
3 | Aironet driver for 4500 and 4800 series cards | |
4 | ||
5 | This code is released under both the GPL version 2 and BSD licenses. | |
6 | Either license may be used. The respective licenses are found at | |
7 | the end of this file. | |
8 | ||
9 | This code was developed by Benjamin Reed <breed@users.sourceforge.net> | |
10 | including portions of which come from the Aironet PC4500 | |
11 | Developer's Reference Manual and used with permission. Copyright | |
12 | (C) 1999 Benjamin Reed. All Rights Reserved. Permission to use | |
13 | code in the Developer's manual was granted for this driver by | |
14 | Aironet. | |
15 | ||
16 | In addition this module was derived from dummy_cs. | |
17 | The initial developer of dummy_cs is David A. Hinds | |
18 | <dahinds@users.sourceforge.net>. Portions created by David A. Hinds | |
05c9a4cf JD |
19 | are Copyright (C) 1999 David A. Hinds. All Rights Reserved. |
20 | ||
1da177e4 LT |
21 | ======================================================================*/ |
22 | ||
1da177e4 LT |
23 | #ifdef __IN_PCMCIA_PACKAGE__ |
24 | #include <pcmcia/k_compat.h> | |
25 | #endif | |
26 | #include <linux/init.h> | |
27 | #include <linux/kernel.h> | |
28 | #include <linux/module.h> | |
29 | #include <linux/ptrace.h> | |
30 | #include <linux/slab.h> | |
31 | #include <linux/string.h> | |
32 | #include <linux/timer.h> | |
33 | #include <linux/netdevice.h> | |
34 | ||
1da177e4 LT |
35 | #include <pcmcia/cs.h> |
36 | #include <pcmcia/cistpl.h> | |
37 | #include <pcmcia/cisreg.h> | |
38 | #include <pcmcia/ds.h> | |
39 | ||
05c9a4cf | 40 | #include <linux/io.h> |
1da177e4 LT |
41 | #include <asm/system.h> |
42 | ||
d3808760 AB |
43 | #include "airo.h" |
44 | ||
1da177e4 LT |
45 | |
46 | /*====================================================================*/ | |
47 | ||
48 | MODULE_AUTHOR("Benjamin Reed"); | |
05c9a4cf JD |
49 | MODULE_DESCRIPTION("Support for Cisco/Aironet 802.11 wireless ethernet " |
50 | "cards. This is the module that links the PCMCIA card " | |
51 | "with the airo module."); | |
1da177e4 LT |
52 | MODULE_LICENSE("Dual BSD/GPL"); |
53 | MODULE_SUPPORTED_DEVICE("Aironet 4500, 4800 and Cisco 340 PCMCIA cards"); | |
54 | ||
55 | /*====================================================================*/ | |
56 | ||
57 | /* | |
58 | The event() function is this driver's Card Services event handler. | |
59 | It will be called by Card Services when an appropriate card status | |
60 | event is received. The config() and release() entry points are | |
61 | used to configure or release a socket, in response to card | |
62 | insertion and ejection events. They are invoked from the airo_cs | |
05c9a4cf | 63 | event handler. |
1da177e4 LT |
64 | */ |
65 | ||
15b99ac1 | 66 | static int airo_config(struct pcmcia_device *link); |
fba395ee | 67 | static void airo_release(struct pcmcia_device *link); |
1da177e4 LT |
68 | |
69 | /* | |
70 | The attach() and detach() entry points are used to create and destroy | |
71 | "instances" of the driver, where each instance represents everything | |
72 | needed to manage one actual PCMCIA card. | |
73 | */ | |
74 | ||
cc3b4866 | 75 | static void airo_detach(struct pcmcia_device *p_dev); |
1da177e4 | 76 | |
1da177e4 | 77 | typedef struct local_info_t { |
1da177e4 LT |
78 | struct net_device *eth_dev; |
79 | } local_info_t; | |
80 | ||
81 | /*====================================================================== | |
05c9a4cf | 82 | |
1da177e4 LT |
83 | airo_attach() creates an "instance" of the driver, allocating |
84 | local data structures for one device. The device is registered | |
85 | with Card Services. | |
05c9a4cf | 86 | |
1da177e4 LT |
87 | The dev_link structure is initialized, but we don't actually |
88 | configure the card at this point -- we wait until we receive a | |
89 | card insertion event. | |
05c9a4cf | 90 | |
1da177e4 LT |
91 | ======================================================================*/ |
92 | ||
15b99ac1 | 93 | static int airo_probe(struct pcmcia_device *p_dev) |
1da177e4 | 94 | { |
1da177e4 | 95 | local_info_t *local; |
f8cfa618 | 96 | |
2caff147 | 97 | dev_dbg(&p_dev->dev, "airo_attach()\n"); |
1da177e4 | 98 | |
1da177e4 LT |
99 | /* |
100 | General socket configuration defaults can go here. In this | |
101 | client, we assume very little, and rely on the CIS for almost | |
102 | everything. In most clients, many details (i.e., number, sizes, | |
103 | and attributes of IO windows) are fixed by the nature of the | |
104 | device, and can be hard-wired here. | |
105 | */ | |
fd238232 DB |
106 | p_dev->conf.Attributes = 0; |
107 | p_dev->conf.IntType = INT_MEMORY_AND_IO; | |
05c9a4cf | 108 | |
1da177e4 | 109 | /* Allocate space for private device-specific data */ |
b69a3aa8 | 110 | local = kzalloc(sizeof(local_info_t), GFP_KERNEL); |
1da177e4 LT |
111 | if (!local) { |
112 | printk(KERN_ERR "airo_cs: no memory for new device\n"); | |
f8cfa618 | 113 | return -ENOMEM; |
1da177e4 | 114 | } |
fd238232 | 115 | p_dev->priv = local; |
f8cfa618 | 116 | |
15b99ac1 | 117 | return airo_config(p_dev); |
1da177e4 LT |
118 | } /* airo_attach */ |
119 | ||
120 | /*====================================================================== | |
05c9a4cf | 121 | |
1da177e4 LT |
122 | This deletes a driver "instance". The device is de-registered |
123 | with Card Services. If it has been released, all local data | |
124 | structures are freed. Otherwise, the structures will be freed | |
125 | when the device is released. | |
05c9a4cf | 126 | |
1da177e4 LT |
127 | ======================================================================*/ |
128 | ||
fba395ee | 129 | static void airo_detach(struct pcmcia_device *link) |
1da177e4 | 130 | { |
2caff147 | 131 | dev_dbg(&link->dev, "airo_detach\n"); |
b4635811 | 132 | |
e2d40963 | 133 | airo_release(link); |
b4635811 | 134 | |
05c9a4cf JD |
135 | if (((local_info_t *)link->priv)->eth_dev) { |
136 | stop_airo_card(((local_info_t *)link->priv)->eth_dev, 0); | |
1da177e4 | 137 | } |
05c9a4cf | 138 | ((local_info_t *)link->priv)->eth_dev = NULL; |
cc3b4866 | 139 | |
b4558ea9 | 140 | kfree(link->priv); |
1da177e4 LT |
141 | } /* airo_detach */ |
142 | ||
143 | /*====================================================================== | |
05c9a4cf | 144 | |
1da177e4 LT |
145 | airo_config() is scheduled to run after a CARD_INSERTION event |
146 | is received, to configure the PCMCIA socket, and to make the | |
147 | device available to the system. | |
05c9a4cf | 148 | |
1da177e4 LT |
149 | ======================================================================*/ |
150 | ||
b54bf94b DB |
151 | static int airo_cs_config_check(struct pcmcia_device *p_dev, |
152 | cistpl_cftable_entry_t *cfg, | |
8e2fc39d | 153 | cistpl_cftable_entry_t *dflt, |
ad913c11 | 154 | unsigned int vcc, |
b54bf94b DB |
155 | void *priv_data) |
156 | { | |
8e2fc39d | 157 | win_req_t *req = priv_data; |
b54bf94b DB |
158 | |
159 | if (cfg->index == 0) | |
160 | return -ENODEV; | |
161 | ||
b54bf94b DB |
162 | /* Does this card need audio output? */ |
163 | if (cfg->flags & CISTPL_CFTABLE_AUDIO) { | |
164 | p_dev->conf.Attributes |= CONF_ENABLE_SPKR; | |
165 | p_dev->conf.Status = CCSR_AUDIO_ENA; | |
166 | } | |
167 | ||
168 | /* Use power settings for Vcc and Vpp if present */ | |
169 | /* Note that the CIS values need to be rescaled */ | |
170 | if (cfg->vpp1.present & (1<<CISTPL_POWER_VNOM)) | |
171 | p_dev->conf.Vpp = cfg->vpp1.param[CISTPL_POWER_VNOM]/10000; | |
8e2fc39d DB |
172 | else if (dflt->vpp1.present & (1<<CISTPL_POWER_VNOM)) |
173 | p_dev->conf.Vpp = dflt->vpp1.param[CISTPL_POWER_VNOM]/10000; | |
b54bf94b | 174 | |
eb14120f | 175 | p_dev->conf.Attributes |= CONF_ENABLE_IRQ; |
b54bf94b DB |
176 | |
177 | /* IO window settings */ | |
178 | p_dev->io.NumPorts1 = p_dev->io.NumPorts2 = 0; | |
8e2fc39d DB |
179 | if ((cfg->io.nwin > 0) || (dflt->io.nwin > 0)) { |
180 | cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &dflt->io; | |
b54bf94b DB |
181 | p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO; |
182 | if (!(io->flags & CISTPL_IO_8BIT)) | |
183 | p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_16; | |
184 | if (!(io->flags & CISTPL_IO_16BIT)) | |
185 | p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_8; | |
186 | p_dev->io.BasePort1 = io->win[0].base; | |
187 | p_dev->io.NumPorts1 = io->win[0].len; | |
188 | if (io->nwin > 1) { | |
189 | p_dev->io.Attributes2 = p_dev->io.Attributes1; | |
190 | p_dev->io.BasePort2 = io->win[1].base; | |
191 | p_dev->io.NumPorts2 = io->win[1].len; | |
192 | } | |
193 | } | |
194 | ||
195 | /* This reserves IO space but doesn't actually enable it */ | |
196 | if (pcmcia_request_io(p_dev, &p_dev->io) != 0) | |
197 | return -ENODEV; | |
198 | ||
199 | /* | |
200 | Now set up a common memory window, if needed. There is room | |
201 | in the struct pcmcia_device structure for one memory window handle, | |
202 | but if the base addresses need to be saved, or if multiple | |
203 | windows are needed, the info should go in the private data | |
204 | structure for this device. | |
205 | ||
206 | Note that the memory window base is a physical address, and | |
207 | needs to be mapped to virtual space with ioremap() before it | |
208 | is used. | |
209 | */ | |
8e2fc39d DB |
210 | if ((cfg->mem.nwin > 0) || (dflt->mem.nwin > 0)) { |
211 | cistpl_mem_t *mem = (cfg->mem.nwin) ? &cfg->mem : &dflt->mem; | |
b54bf94b | 212 | memreq_t map; |
8e2fc39d DB |
213 | req->Attributes = WIN_DATA_WIDTH_16|WIN_MEMORY_TYPE_CM; |
214 | req->Base = mem->win[0].host_addr; | |
215 | req->Size = mem->win[0].len; | |
216 | req->AccessSpeed = 0; | |
6838b03f | 217 | if (pcmcia_request_window(p_dev, req, &p_dev->win) != 0) |
b54bf94b DB |
218 | return -ENODEV; |
219 | map.Page = 0; | |
220 | map.CardOffset = mem->win[0].card_addr; | |
868575d1 | 221 | if (pcmcia_map_mem_page(p_dev, p_dev->win, &map) != 0) |
b54bf94b DB |
222 | return -ENODEV; |
223 | } | |
224 | /* If we got this far, we're cool! */ | |
225 | return 0; | |
226 | } | |
227 | ||
228 | ||
15b99ac1 | 229 | static int airo_config(struct pcmcia_device *link) |
1da177e4 | 230 | { |
1da177e4 | 231 | local_info_t *dev; |
8e2fc39d | 232 | win_req_t *req; |
2caff147 | 233 | int ret; |
fba395ee | 234 | |
1da177e4 LT |
235 | dev = link->priv; |
236 | ||
2caff147 | 237 | dev_dbg(&link->dev, "airo_config\n"); |
e2d40963 | 238 | |
8e2fc39d DB |
239 | req = kzalloc(sizeof(win_req_t), GFP_KERNEL); |
240 | if (!req) | |
b54bf94b DB |
241 | return -ENOMEM; |
242 | ||
1da177e4 | 243 | /* |
b54bf94b DB |
244 | * In this loop, we scan the CIS for configuration table |
245 | * entries, each of which describes a valid card | |
246 | * configuration, including voltage, IO window, memory window, | |
247 | * and interrupt settings. | |
248 | * | |
249 | * We make no assumptions about the card to be configured: we | |
250 | * use just the information available in the CIS. In an ideal | |
251 | * world, this would work for any PCMCIA card, but it requires | |
252 | * a complete and accurate CIS. In practice, a driver usually | |
253 | * "knows" most of these things without consulting the CIS, | |
254 | * and most client drivers will only use the CIS to fill in | |
255 | * implementation-defined details. | |
256 | */ | |
2caff147 DB |
257 | ret = pcmcia_loop_config(link, airo_cs_config_check, req); |
258 | if (ret) | |
b54bf94b DB |
259 | goto failed; |
260 | ||
eb14120f DB |
261 | if (!link->irq) |
262 | goto failed; | |
05c9a4cf | 263 | |
1da177e4 LT |
264 | /* |
265 | This actually configures the PCMCIA socket -- setting up | |
266 | the I/O windows and the interrupt mapping, and putting the | |
267 | card and host interface into "Memory and IO" mode. | |
268 | */ | |
2caff147 DB |
269 | ret = pcmcia_request_configuration(link, &link->conf); |
270 | if (ret) | |
271 | goto failed; | |
05c9a4cf | 272 | ((local_info_t *)link->priv)->eth_dev = |
eb14120f | 273 | init_airo_card(link->irq, |
dd2e5a15 | 274 | link->io.BasePort1, 1, &link->dev); |
05c9a4cf | 275 | if (!((local_info_t *)link->priv)->eth_dev) |
2caff147 | 276 | goto failed; |
05c9a4cf | 277 | |
1da177e4 | 278 | /* Finally, report what we've done */ |
ded6a1a3 DB |
279 | dev_info(&link->dev, "index 0x%02x: ", |
280 | link->conf.ConfigIndex); | |
70294b46 DB |
281 | if (link->conf.Vpp) |
282 | printk(", Vpp %d.%d", link->conf.Vpp/10, link->conf.Vpp%10); | |
eb14120f | 283 | printk(", irq %d", link->irq); |
1da177e4 LT |
284 | if (link->io.NumPorts1) |
285 | printk(", io 0x%04x-0x%04x", link->io.BasePort1, | |
286 | link->io.BasePort1+link->io.NumPorts1-1); | |
287 | if (link->io.NumPorts2) | |
288 | printk(" & 0x%04x-0x%04x", link->io.BasePort2, | |
289 | link->io.BasePort2+link->io.NumPorts2-1); | |
290 | if (link->win) | |
8e2fc39d DB |
291 | printk(", mem 0x%06lx-0x%06lx", req->Base, |
292 | req->Base+req->Size-1); | |
1da177e4 | 293 | printk("\n"); |
8e2fc39d | 294 | kfree(req); |
15b99ac1 DB |
295 | return 0; |
296 | ||
b54bf94b | 297 | failed: |
1da177e4 | 298 | airo_release(link); |
8e2fc39d | 299 | kfree(req); |
15b99ac1 | 300 | return -ENODEV; |
1da177e4 LT |
301 | } /* airo_config */ |
302 | ||
303 | /*====================================================================== | |
05c9a4cf | 304 | |
1da177e4 LT |
305 | After a card is removed, airo_release() will unregister the |
306 | device, and release the PCMCIA configuration. If the device is | |
307 | still open, this will be postponed until it is closed. | |
05c9a4cf | 308 | |
1da177e4 LT |
309 | ======================================================================*/ |
310 | ||
fba395ee | 311 | static void airo_release(struct pcmcia_device *link) |
1da177e4 | 312 | { |
2caff147 | 313 | dev_dbg(&link->dev, "airo_release\n"); |
fba395ee | 314 | pcmcia_disable_device(link); |
1da177e4 LT |
315 | } |
316 | ||
fba395ee | 317 | static int airo_suspend(struct pcmcia_device *link) |
98e4c28b | 318 | { |
98e4c28b DB |
319 | local_info_t *local = link->priv; |
320 | ||
e2d40963 | 321 | netif_device_detach(local->eth_dev); |
98e4c28b DB |
322 | |
323 | return 0; | |
324 | } | |
325 | ||
fba395ee | 326 | static int airo_resume(struct pcmcia_device *link) |
98e4c28b | 327 | { |
98e4c28b DB |
328 | local_info_t *local = link->priv; |
329 | ||
e2d40963 | 330 | if (link->open) { |
98e4c28b DB |
331 | reset_airo_card(local->eth_dev); |
332 | netif_device_attach(local->eth_dev); | |
333 | } | |
334 | ||
335 | return 0; | |
336 | } | |
337 | ||
7018d06d DB |
338 | static struct pcmcia_device_id airo_ids[] = { |
339 | PCMCIA_DEVICE_MANF_CARD(0x015f, 0x000a), | |
340 | PCMCIA_DEVICE_MANF_CARD(0x015f, 0x0005), | |
341 | PCMCIA_DEVICE_MANF_CARD(0x015f, 0x0007), | |
342 | PCMCIA_DEVICE_MANF_CARD(0x0105, 0x0007), | |
343 | PCMCIA_DEVICE_NULL, | |
344 | }; | |
345 | MODULE_DEVICE_TABLE(pcmcia, airo_ids); | |
346 | ||
1da177e4 LT |
347 | static struct pcmcia_driver airo_driver = { |
348 | .owner = THIS_MODULE, | |
349 | .drv = { | |
350 | .name = "airo_cs", | |
351 | }, | |
15b99ac1 | 352 | .probe = airo_probe, |
cc3b4866 | 353 | .remove = airo_detach, |
7018d06d | 354 | .id_table = airo_ids, |
98e4c28b DB |
355 | .suspend = airo_suspend, |
356 | .resume = airo_resume, | |
1da177e4 LT |
357 | }; |
358 | ||
359 | static int airo_cs_init(void) | |
360 | { | |
361 | return pcmcia_register_driver(&airo_driver); | |
362 | } | |
363 | ||
364 | static void airo_cs_cleanup(void) | |
365 | { | |
366 | pcmcia_unregister_driver(&airo_driver); | |
1da177e4 LT |
367 | } |
368 | ||
369 | /* | |
370 | This program is free software; you can redistribute it and/or | |
371 | modify it under the terms of the GNU General Public License | |
372 | as published by the Free Software Foundation; either version 2 | |
373 | of the License, or (at your option) any later version. | |
374 | ||
375 | This program is distributed in the hope that it will be useful, | |
376 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
377 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
378 | GNU General Public License for more details. | |
379 | ||
380 | In addition: | |
381 | ||
382 | Redistribution and use in source and binary forms, with or without | |
383 | modification, are permitted provided that the following conditions | |
384 | are met: | |
385 | ||
386 | 1. Redistributions of source code must retain the above copyright | |
387 | notice, this list of conditions and the following disclaimer. | |
388 | 2. Redistributions in binary form must reproduce the above copyright | |
389 | notice, this list of conditions and the following disclaimer in the | |
390 | documentation and/or other materials provided with the distribution. | |
391 | 3. The name of the author may not be used to endorse or promote | |
392 | products derived from this software without specific prior written | |
393 | permission. | |
394 | ||
395 | THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR | |
396 | IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED | |
397 | WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | |
398 | ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, | |
399 | INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES | |
400 | (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR | |
401 | SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |
402 | HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, | |
403 | STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING | |
404 | IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE | |
05c9a4cf | 405 | POSSIBILITY OF SUCH DAMAGE. |
1da177e4 LT |
406 | */ |
407 | ||
408 | module_init(airo_cs_init); | |
409 | module_exit(airo_cs_cleanup); |