1 /*======================================================================
3 Aironet driver for 4500 and 4800 series cards
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
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
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
19 are Copyright (C) 1999 David A. Hinds. All Rights Reserved.
21 ======================================================================*/
23 #ifdef __IN_PCMCIA_PACKAGE__
24 #include <pcmcia/k_compat.h>
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>
35 #include <pcmcia/cs_types.h>
36 #include <pcmcia/cs.h>
37 #include <pcmcia/cistpl.h>
38 #include <pcmcia/cisreg.h>
39 #include <pcmcia/ds.h>
42 #include <asm/system.h>
47 /*====================================================================*/
49 MODULE_AUTHOR("Benjamin Reed");
50 MODULE_DESCRIPTION("Support for Cisco/Aironet 802.11 wireless ethernet "
51 "cards. This is the module that links the PCMCIA card "
52 "with the airo module.");
53 MODULE_LICENSE("Dual BSD/GPL");
54 MODULE_SUPPORTED_DEVICE("Aironet 4500, 4800 and Cisco 340 PCMCIA cards");
56 /*====================================================================*/
59 The event() function is this driver's Card Services event handler.
60 It will be called by Card Services when an appropriate card status
61 event is received. The config() and release() entry points are
62 used to configure or release a socket, in response to card
63 insertion and ejection events. They are invoked from the airo_cs
67 static int airo_config(struct pcmcia_device *link);
68 static void airo_release(struct pcmcia_device *link);
71 The attach() and detach() entry points are used to create and destroy
72 "instances" of the driver, where each instance represents everything
73 needed to manage one actual PCMCIA card.
76 static void airo_detach(struct pcmcia_device *p_dev);
79 You'll also need to prototype all the functions that will actually
80 be used to talk to your device. See 'pcmem_cs' for a good example
81 of a fully self-sufficient driver; the other drivers rely more or
82 less on other parts of the kernel.
86 A linked list of "instances" of the aironet device. Each actual
87 PCMCIA card corresponds to one device instance, and is described
88 by one struct pcmcia_device structure (defined in ds.h).
90 You may not want to use a linked list for this -- for example, the
91 memory card driver uses an array of struct pcmcia_device pointers,
92 where minor device numbers are used to derive the corresponding
97 A driver needs to provide a dev_node_t structure for each device
98 on a card. In some cases, there is only one device per card (for
99 example, ethernet cards, modems). In other cases, there may be
100 many actual or logical devices (SCSI adapters, memory cards with
101 multiple partitions). The dev_node_t structures need to be kept
102 in a linked list starting at the 'dev' field of a struct pcmcia_device
103 structure. We allocate them in the card's private data structure,
104 because they generally shouldn't be allocated dynamically.
106 In this case, we also provide a flag to indicate if a device is
107 "stopped" due to a power management event, or card ejection. The
108 device IO routines can use a flag like this to throttle IO to a
109 card that is not ready to accept it.
112 typedef struct local_info_t {
114 struct net_device *eth_dev;
117 /*======================================================================
119 airo_attach() creates an "instance" of the driver, allocating
120 local data structures for one device. The device is registered
123 The dev_link structure is initialized, but we don't actually
124 configure the card at this point -- we wait until we receive a
125 card insertion event.
127 ======================================================================*/
129 static int airo_probe(struct pcmcia_device *p_dev)
133 dev_dbg(&p_dev->dev, "airo_attach()\n");
135 /* Interrupt setup */
136 p_dev->irq.Attributes = IRQ_TYPE_DYNAMIC_SHARING;
137 p_dev->irq.Handler = NULL;
140 General socket configuration defaults can go here. In this
141 client, we assume very little, and rely on the CIS for almost
142 everything. In most clients, many details (i.e., number, sizes,
143 and attributes of IO windows) are fixed by the nature of the
144 device, and can be hard-wired here.
146 p_dev->conf.Attributes = 0;
147 p_dev->conf.IntType = INT_MEMORY_AND_IO;
149 /* Allocate space for private device-specific data */
150 local = kzalloc(sizeof(local_info_t), GFP_KERNEL);
152 printk(KERN_ERR "airo_cs: no memory for new device\n");
157 return airo_config(p_dev);
160 /*======================================================================
162 This deletes a driver "instance". The device is de-registered
163 with Card Services. If it has been released, all local data
164 structures are freed. Otherwise, the structures will be freed
165 when the device is released.
167 ======================================================================*/
169 static void airo_detach(struct pcmcia_device *link)
171 dev_dbg(&link->dev, "airo_detach\n");
175 if (((local_info_t *)link->priv)->eth_dev) {
176 stop_airo_card(((local_info_t *)link->priv)->eth_dev, 0);
178 ((local_info_t *)link->priv)->eth_dev = NULL;
183 /*======================================================================
185 airo_config() is scheduled to run after a CARD_INSERTION event
186 is received, to configure the PCMCIA socket, and to make the
187 device available to the system.
189 ======================================================================*/
191 static int airo_cs_config_check(struct pcmcia_device *p_dev,
192 cistpl_cftable_entry_t *cfg,
193 cistpl_cftable_entry_t *dflt,
197 win_req_t *req = priv_data;
202 /* Does this card need audio output? */
203 if (cfg->flags & CISTPL_CFTABLE_AUDIO) {
204 p_dev->conf.Attributes |= CONF_ENABLE_SPKR;
205 p_dev->conf.Status = CCSR_AUDIO_ENA;
208 /* Use power settings for Vcc and Vpp if present */
209 /* Note that the CIS values need to be rescaled */
210 if (cfg->vpp1.present & (1<<CISTPL_POWER_VNOM))
211 p_dev->conf.Vpp = cfg->vpp1.param[CISTPL_POWER_VNOM]/10000;
212 else if (dflt->vpp1.present & (1<<CISTPL_POWER_VNOM))
213 p_dev->conf.Vpp = dflt->vpp1.param[CISTPL_POWER_VNOM]/10000;
215 /* Do we need to allocate an interrupt? */
216 if (cfg->irq.IRQInfo1 || dflt->irq.IRQInfo1)
217 p_dev->conf.Attributes |= CONF_ENABLE_IRQ;
219 /* IO window settings */
220 p_dev->io.NumPorts1 = p_dev->io.NumPorts2 = 0;
221 if ((cfg->io.nwin > 0) || (dflt->io.nwin > 0)) {
222 cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &dflt->io;
223 p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
224 if (!(io->flags & CISTPL_IO_8BIT))
225 p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_16;
226 if (!(io->flags & CISTPL_IO_16BIT))
227 p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
228 p_dev->io.BasePort1 = io->win[0].base;
229 p_dev->io.NumPorts1 = io->win[0].len;
231 p_dev->io.Attributes2 = p_dev->io.Attributes1;
232 p_dev->io.BasePort2 = io->win[1].base;
233 p_dev->io.NumPorts2 = io->win[1].len;
237 /* This reserves IO space but doesn't actually enable it */
238 if (pcmcia_request_io(p_dev, &p_dev->io) != 0)
242 Now set up a common memory window, if needed. There is room
243 in the struct pcmcia_device structure for one memory window handle,
244 but if the base addresses need to be saved, or if multiple
245 windows are needed, the info should go in the private data
246 structure for this device.
248 Note that the memory window base is a physical address, and
249 needs to be mapped to virtual space with ioremap() before it
252 if ((cfg->mem.nwin > 0) || (dflt->mem.nwin > 0)) {
253 cistpl_mem_t *mem = (cfg->mem.nwin) ? &cfg->mem : &dflt->mem;
255 req->Attributes = WIN_DATA_WIDTH_16|WIN_MEMORY_TYPE_CM;
256 req->Base = mem->win[0].host_addr;
257 req->Size = mem->win[0].len;
258 req->AccessSpeed = 0;
259 if (pcmcia_request_window(p_dev, req, &p_dev->win) != 0)
262 map.CardOffset = mem->win[0].card_addr;
263 if (pcmcia_map_mem_page(p_dev, p_dev->win, &map) != 0)
266 /* If we got this far, we're cool! */
271 static int airo_config(struct pcmcia_device *link)
279 dev_dbg(&link->dev, "airo_config\n");
281 req = kzalloc(sizeof(win_req_t), GFP_KERNEL);
286 * In this loop, we scan the CIS for configuration table
287 * entries, each of which describes a valid card
288 * configuration, including voltage, IO window, memory window,
289 * and interrupt settings.
291 * We make no assumptions about the card to be configured: we
292 * use just the information available in the CIS. In an ideal
293 * world, this would work for any PCMCIA card, but it requires
294 * a complete and accurate CIS. In practice, a driver usually
295 * "knows" most of these things without consulting the CIS,
296 * and most client drivers will only use the CIS to fill in
297 * implementation-defined details.
299 ret = pcmcia_loop_config(link, airo_cs_config_check, req);
304 Allocate an interrupt line. Note that this does not assign a
305 handler to the interrupt, unless the 'Handler' member of the
306 irq structure is initialized.
308 if (link->conf.Attributes & CONF_ENABLE_IRQ) {
309 ret = pcmcia_request_irq(link, &link->irq);
315 This actually configures the PCMCIA socket -- setting up
316 the I/O windows and the interrupt mapping, and putting the
317 card and host interface into "Memory and IO" mode.
319 ret = pcmcia_request_configuration(link, &link->conf);
322 ((local_info_t *)link->priv)->eth_dev =
323 init_airo_card(link->irq.AssignedIRQ,
324 link->io.BasePort1, 1, &link->dev);
325 if (!((local_info_t *)link->priv)->eth_dev)
329 At this point, the dev_node_t structure(s) need to be
330 initialized and arranged in a linked list at link->dev_node.
332 strcpy(dev->node.dev_name, ((local_info_t *)link->priv)->eth_dev->name);
333 dev->node.major = dev->node.minor = 0;
334 link->dev_node = &dev->node;
336 /* Finally, report what we've done */
337 printk(KERN_INFO "%s: index 0x%02x: ",
338 dev->node.dev_name, link->conf.ConfigIndex);
340 printk(", Vpp %d.%d", link->conf.Vpp/10, link->conf.Vpp%10);
341 if (link->conf.Attributes & CONF_ENABLE_IRQ)
342 printk(", irq %d", link->irq.AssignedIRQ);
343 if (link->io.NumPorts1)
344 printk(", io 0x%04x-0x%04x", link->io.BasePort1,
345 link->io.BasePort1+link->io.NumPorts1-1);
346 if (link->io.NumPorts2)
347 printk(" & 0x%04x-0x%04x", link->io.BasePort2,
348 link->io.BasePort2+link->io.NumPorts2-1);
350 printk(", mem 0x%06lx-0x%06lx", req->Base,
351 req->Base+req->Size-1);
362 /*======================================================================
364 After a card is removed, airo_release() will unregister the
365 device, and release the PCMCIA configuration. If the device is
366 still open, this will be postponed until it is closed.
368 ======================================================================*/
370 static void airo_release(struct pcmcia_device *link)
372 dev_dbg(&link->dev, "airo_release\n");
373 pcmcia_disable_device(link);
376 static int airo_suspend(struct pcmcia_device *link)
378 local_info_t *local = link->priv;
380 netif_device_detach(local->eth_dev);
385 static int airo_resume(struct pcmcia_device *link)
387 local_info_t *local = link->priv;
390 reset_airo_card(local->eth_dev);
391 netif_device_attach(local->eth_dev);
397 static struct pcmcia_device_id airo_ids[] = {
398 PCMCIA_DEVICE_MANF_CARD(0x015f, 0x000a),
399 PCMCIA_DEVICE_MANF_CARD(0x015f, 0x0005),
400 PCMCIA_DEVICE_MANF_CARD(0x015f, 0x0007),
401 PCMCIA_DEVICE_MANF_CARD(0x0105, 0x0007),
404 MODULE_DEVICE_TABLE(pcmcia, airo_ids);
406 static struct pcmcia_driver airo_driver = {
407 .owner = THIS_MODULE,
412 .remove = airo_detach,
413 .id_table = airo_ids,
414 .suspend = airo_suspend,
415 .resume = airo_resume,
418 static int airo_cs_init(void)
420 return pcmcia_register_driver(&airo_driver);
423 static void airo_cs_cleanup(void)
425 pcmcia_unregister_driver(&airo_driver);
429 This program is free software; you can redistribute it and/or
430 modify it under the terms of the GNU General Public License
431 as published by the Free Software Foundation; either version 2
432 of the License, or (at your option) any later version.
434 This program is distributed in the hope that it will be useful,
435 but WITHOUT ANY WARRANTY; without even the implied warranty of
436 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
437 GNU General Public License for more details.
441 Redistribution and use in source and binary forms, with or without
442 modification, are permitted provided that the following conditions
445 1. Redistributions of source code must retain the above copyright
446 notice, this list of conditions and the following disclaimer.
447 2. Redistributions in binary form must reproduce the above copyright
448 notice, this list of conditions and the following disclaimer in the
449 documentation and/or other materials provided with the distribution.
450 3. The name of the author may not be used to endorse or promote
451 products derived from this software without specific prior written
454 THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
455 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
456 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
457 ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
458 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
459 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
460 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
461 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
462 STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
463 IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
464 POSSIBILITY OF SUCH DAMAGE.
467 module_init(airo_cs_init);
468 module_exit(airo_cs_cleanup);