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 #include <linux/config.h>
24 #ifdef __IN_PCMCIA_PACKAGE__
25 #include <pcmcia/k_compat.h>
27 #include <linux/init.h>
28 #include <linux/kernel.h>
29 #include <linux/module.h>
30 #include <linux/ptrace.h>
31 #include <linux/slab.h>
32 #include <linux/string.h>
33 #include <linux/timer.h>
34 #include <linux/netdevice.h>
36 #include <pcmcia/cs_types.h>
37 #include <pcmcia/cs.h>
38 #include <pcmcia/cistpl.h>
39 #include <pcmcia/cisreg.h>
40 #include <pcmcia/ds.h>
43 #include <asm/system.h>
48 All the PCMCIA modules use PCMCIA_DEBUG to control debugging. If
49 you do not define PCMCIA_DEBUG at all, all the debug code will be
50 left out. If you compile with PCMCIA_DEBUG=0, the debug code will
51 be present but disabled -- but it can then be enabled for specific
52 modules at load time with a 'pc_debug=#' option to insmod.
55 static int pc_debug = PCMCIA_DEBUG;
56 module_param(pc_debug, int, 0);
57 static char *version = "$Revision: 1.2 $";
58 #define DEBUG(n, args...) if (pc_debug>(n)) printk(KERN_DEBUG args);
60 #define DEBUG(n, args...)
63 /*====================================================================*/
65 MODULE_AUTHOR("Benjamin Reed");
66 MODULE_DESCRIPTION("Support for Cisco/Aironet 802.11 wireless ethernet \
67 cards. This is the module that links the PCMCIA card \
68 with the airo module.");
69 MODULE_LICENSE("Dual BSD/GPL");
70 MODULE_SUPPORTED_DEVICE("Aironet 4500, 4800 and Cisco 340 PCMCIA cards");
72 /*====================================================================*/
75 The event() function is this driver's Card Services event handler.
76 It will be called by Card Services when an appropriate card status
77 event is received. The config() and release() entry points are
78 used to configure or release a socket, in response to card
79 insertion and ejection events. They are invoked from the airo_cs
83 static void airo_config(dev_link_t *link);
84 static void airo_release(dev_link_t *link);
85 static int airo_event(event_t event, int priority,
86 event_callback_args_t *args);
89 The attach() and detach() entry points are used to create and destroy
90 "instances" of the driver, where each instance represents everything
91 needed to manage one actual PCMCIA card.
94 static dev_link_t *airo_attach(void);
95 static void airo_detach(dev_link_t *);
98 You'll also need to prototype all the functions that will actually
99 be used to talk to your device. See 'pcmem_cs' for a good example
100 of a fully self-sufficient driver; the other drivers rely more or
101 less on other parts of the kernel.
105 The dev_info variable is the "key" that is used to match up this
106 device driver with appropriate cards, through the card configuration
110 static dev_info_t dev_info = "airo_cs";
113 A linked list of "instances" of the aironet device. Each actual
114 PCMCIA card corresponds to one device instance, and is described
115 by one dev_link_t structure (defined in ds.h).
117 You may not want to use a linked list for this -- for example, the
118 memory card driver uses an array of dev_link_t pointers, where minor
119 device numbers are used to derive the corresponding array index.
122 static dev_link_t *dev_list = NULL;
125 A dev_link_t structure has fields for most things that are needed
126 to keep track of a socket, but there will usually be some device
127 specific information that also needs to be kept track of. The
128 'priv' pointer in a dev_link_t structure can be used to point to
129 a device-specific private data structure, like this.
131 A driver needs to provide a dev_node_t structure for each device
132 on a card. In some cases, there is only one device per card (for
133 example, ethernet cards, modems). In other cases, there may be
134 many actual or logical devices (SCSI adapters, memory cards with
135 multiple partitions). The dev_node_t structures need to be kept
136 in a linked list starting at the 'dev' field of a dev_link_t
137 structure. We allocate them in the card's private data structure,
138 because they generally shouldn't be allocated dynamically.
140 In this case, we also provide a flag to indicate if a device is
141 "stopped" due to a power management event, or card ejection. The
142 device IO routines can use a flag like this to throttle IO to a
143 card that is not ready to accept it.
146 typedef struct local_info_t {
148 struct net_device *eth_dev;
151 /*======================================================================
153 airo_attach() creates an "instance" of the driver, allocating
154 local data structures for one device. The device is registered
157 The dev_link structure is initialized, but we don't actually
158 configure the card at this point -- we wait until we receive a
159 card insertion event.
161 ======================================================================*/
163 static dev_link_t *airo_attach(void)
165 client_reg_t client_reg;
170 DEBUG(0, "airo_attach()\n");
172 /* Initialize the dev_link_t structure */
173 link = kmalloc(sizeof(struct dev_link_t), GFP_KERNEL);
175 printk(KERN_ERR "airo_cs: no memory for new device\n");
178 memset(link, 0, sizeof(struct dev_link_t));
180 /* Interrupt setup */
181 link->irq.Attributes = IRQ_TYPE_EXCLUSIVE;
182 link->irq.IRQInfo1 = IRQ_LEVEL_ID;
183 link->irq.Handler = NULL;
186 General socket configuration defaults can go here. In this
187 client, we assume very little, and rely on the CIS for almost
188 everything. In most clients, many details (i.e., number, sizes,
189 and attributes of IO windows) are fixed by the nature of the
190 device, and can be hard-wired here.
192 link->conf.Attributes = 0;
194 link->conf.IntType = INT_MEMORY_AND_IO;
196 /* Allocate space for private device-specific data */
197 local = kmalloc(sizeof(local_info_t), GFP_KERNEL);
199 printk(KERN_ERR "airo_cs: no memory for new device\n");
203 memset(local, 0, sizeof(local_info_t));
206 /* Register with Card Services */
207 link->next = dev_list;
209 client_reg.dev_info = &dev_info;
210 client_reg.Version = 0x0210;
211 client_reg.event_callback_args.client_data = link;
212 ret = pcmcia_register_client(&link->handle, &client_reg);
214 cs_error(link->handle, RegisterClient, ret);
222 /*======================================================================
224 This deletes a driver "instance". The device is de-registered
225 with Card Services. If it has been released, all local data
226 structures are freed. Otherwise, the structures will be freed
227 when the device is released.
229 ======================================================================*/
231 static void airo_detach(dev_link_t *link)
235 DEBUG(0, "airo_detach(0x%p)\n", link);
237 /* Locate device structure */
238 for (linkp = &dev_list; *linkp; linkp = &(*linkp)->next)
239 if (*linkp == link) break;
243 if (link->state & DEV_CONFIG)
246 if ( ((local_info_t*)link->priv)->eth_dev ) {
247 stop_airo_card( ((local_info_t*)link->priv)->eth_dev, 0 );
249 ((local_info_t*)link->priv)->eth_dev = NULL;
251 /* Break the link with Card Services */
253 pcmcia_deregister_client(link->handle);
257 /* Unlink device structure, free pieces */
264 /*======================================================================
266 airo_config() is scheduled to run after a CARD_INSERTION event
267 is received, to configure the PCMCIA socket, and to make the
268 device available to the system.
270 ======================================================================*/
272 #define CS_CHECK(fn, ret) \
273 do { last_fn = (fn); if ((last_ret = (ret)) != 0) goto cs_failed; } while (0)
275 static void airo_config(dev_link_t *link)
277 client_handle_t handle;
281 int last_fn, last_ret;
286 handle = link->handle;
289 DEBUG(0, "airo_config(0x%p)\n", link);
292 This reads the card's CONFIG tuple to find its configuration
295 tuple.DesiredTuple = CISTPL_CONFIG;
296 tuple.Attributes = 0;
297 tuple.TupleData = buf;
298 tuple.TupleDataMax = sizeof(buf);
299 tuple.TupleOffset = 0;
300 CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(handle, &tuple));
301 CS_CHECK(GetTupleData, pcmcia_get_tuple_data(handle, &tuple));
302 CS_CHECK(ParseTuple, pcmcia_parse_tuple(handle, &tuple, &parse));
303 link->conf.ConfigBase = parse.config.base;
304 link->conf.Present = parse.config.rmask[0];
307 link->state |= DEV_CONFIG;
310 In this loop, we scan the CIS for configuration table entries,
311 each of which describes a valid card configuration, including
312 voltage, IO window, memory window, and interrupt settings.
314 We make no assumptions about the card to be configured: we use
315 just the information available in the CIS. In an ideal world,
316 this would work for any PCMCIA card, but it requires a complete
317 and accurate CIS. In practice, a driver usually "knows" most of
318 these things without consulting the CIS, and most client drivers
319 will only use the CIS to fill in implementation-defined details.
321 tuple.DesiredTuple = CISTPL_CFTABLE_ENTRY;
322 CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(handle, &tuple));
324 cistpl_cftable_entry_t dflt = { 0 };
325 cistpl_cftable_entry_t *cfg = &(parse.cftable_entry);
326 if (pcmcia_get_tuple_data(handle, &tuple) != 0 ||
327 pcmcia_parse_tuple(handle, &tuple, &parse) != 0)
330 if (cfg->flags & CISTPL_CFTABLE_DEFAULT) dflt = *cfg;
331 if (cfg->index == 0) goto next_entry;
332 link->conf.ConfigIndex = cfg->index;
334 /* Does this card need audio output? */
335 if (cfg->flags & CISTPL_CFTABLE_AUDIO) {
336 link->conf.Attributes |= CONF_ENABLE_SPKR;
337 link->conf.Status = CCSR_AUDIO_ENA;
340 /* Use power settings for Vcc and Vpp if present */
341 /* Note that the CIS values need to be rescaled */
342 if (cfg->vcc.present & (1<<CISTPL_POWER_VNOM))
343 link->conf.Vcc = cfg->vcc.param[CISTPL_POWER_VNOM]/10000;
344 else if (dflt.vcc.present & (1<<CISTPL_POWER_VNOM))
345 link->conf.Vcc = dflt.vcc.param[CISTPL_POWER_VNOM]/10000;
347 if (cfg->vpp1.present & (1<<CISTPL_POWER_VNOM))
348 link->conf.Vpp1 = link->conf.Vpp2 =
349 cfg->vpp1.param[CISTPL_POWER_VNOM]/10000;
350 else if (dflt.vpp1.present & (1<<CISTPL_POWER_VNOM))
351 link->conf.Vpp1 = link->conf.Vpp2 =
352 dflt.vpp1.param[CISTPL_POWER_VNOM]/10000;
354 /* Do we need to allocate an interrupt? */
355 if (cfg->irq.IRQInfo1 || dflt.irq.IRQInfo1)
356 link->conf.Attributes |= CONF_ENABLE_IRQ;
358 /* IO window settings */
359 link->io.NumPorts1 = link->io.NumPorts2 = 0;
360 if ((cfg->io.nwin > 0) || (dflt.io.nwin > 0)) {
361 cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &dflt.io;
362 link->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
363 if (!(io->flags & CISTPL_IO_8BIT))
364 link->io.Attributes1 = IO_DATA_PATH_WIDTH_16;
365 if (!(io->flags & CISTPL_IO_16BIT))
366 link->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
367 link->io.BasePort1 = io->win[0].base;
368 link->io.NumPorts1 = io->win[0].len;
370 link->io.Attributes2 = link->io.Attributes1;
371 link->io.BasePort2 = io->win[1].base;
372 link->io.NumPorts2 = io->win[1].len;
376 /* This reserves IO space but doesn't actually enable it */
377 if (pcmcia_request_io(link->handle, &link->io) != 0)
381 Now set up a common memory window, if needed. There is room
382 in the dev_link_t structure for one memory window handle,
383 but if the base addresses need to be saved, or if multiple
384 windows are needed, the info should go in the private data
385 structure for this device.
387 Note that the memory window base is a physical address, and
388 needs to be mapped to virtual space with ioremap() before it
391 if ((cfg->mem.nwin > 0) || (dflt.mem.nwin > 0)) {
393 (cfg->mem.nwin) ? &cfg->mem : &dflt.mem;
394 req.Attributes = WIN_DATA_WIDTH_16|WIN_MEMORY_TYPE_CM;
395 req.Base = mem->win[0].host_addr;
396 req.Size = mem->win[0].len;
398 if (pcmcia_request_window(&link->handle, &req, &link->win) != 0)
400 map.Page = 0; map.CardOffset = mem->win[0].card_addr;
401 if (pcmcia_map_mem_page(link->win, &map) != 0)
404 /* If we got this far, we're cool! */
408 CS_CHECK(GetNextTuple, pcmcia_get_next_tuple(handle, &tuple));
412 Allocate an interrupt line. Note that this does not assign a
413 handler to the interrupt, unless the 'Handler' member of the
414 irq structure is initialized.
416 if (link->conf.Attributes & CONF_ENABLE_IRQ)
417 CS_CHECK(RequestIRQ, pcmcia_request_irq(link->handle, &link->irq));
420 This actually configures the PCMCIA socket -- setting up
421 the I/O windows and the interrupt mapping, and putting the
422 card and host interface into "Memory and IO" mode.
424 CS_CHECK(RequestConfiguration, pcmcia_request_configuration(link->handle, &link->conf));
425 ((local_info_t*)link->priv)->eth_dev =
426 init_airo_card( link->irq.AssignedIRQ,
427 link->io.BasePort1, 1, &handle_to_dev(handle) );
428 if (!((local_info_t*)link->priv)->eth_dev) goto cs_failed;
431 At this point, the dev_node_t structure(s) need to be
432 initialized and arranged in a linked list at link->dev.
434 strcpy(dev->node.dev_name, ((local_info_t*)link->priv)->eth_dev->name );
435 dev->node.major = dev->node.minor = 0;
436 link->dev = &dev->node;
438 /* Finally, report what we've done */
439 printk(KERN_INFO "%s: index 0x%02x: Vcc %d.%d",
440 dev->node.dev_name, link->conf.ConfigIndex,
441 link->conf.Vcc/10, link->conf.Vcc%10);
443 printk(", Vpp %d.%d", link->conf.Vpp1/10, link->conf.Vpp1%10);
444 if (link->conf.Attributes & CONF_ENABLE_IRQ)
445 printk(", irq %d", link->irq.AssignedIRQ);
446 if (link->io.NumPorts1)
447 printk(", io 0x%04x-0x%04x", link->io.BasePort1,
448 link->io.BasePort1+link->io.NumPorts1-1);
449 if (link->io.NumPorts2)
450 printk(" & 0x%04x-0x%04x", link->io.BasePort2,
451 link->io.BasePort2+link->io.NumPorts2-1);
453 printk(", mem 0x%06lx-0x%06lx", req.Base,
454 req.Base+req.Size-1);
457 link->state &= ~DEV_CONFIG_PENDING;
461 cs_error(link->handle, last_fn, last_ret);
466 /*======================================================================
468 After a card is removed, airo_release() will unregister the
469 device, and release the PCMCIA configuration. If the device is
470 still open, this will be postponed until it is closed.
472 ======================================================================*/
474 static void airo_release(dev_link_t *link)
476 DEBUG(0, "airo_release(0x%p)\n", link);
478 /* Unlink the device chain */
482 In a normal driver, additional code may be needed to release
483 other kernel data structures associated with this device.
486 /* Don't bother checking to see if these succeed or not */
488 pcmcia_release_window(link->win);
489 pcmcia_release_configuration(link->handle);
490 if (link->io.NumPorts1)
491 pcmcia_release_io(link->handle, &link->io);
492 if (link->irq.AssignedIRQ)
493 pcmcia_release_irq(link->handle, &link->irq);
494 link->state &= ~DEV_CONFIG;
497 /*======================================================================
499 The card status event handler. Mostly, this schedules other
500 stuff to run after an event is received.
502 When a CARD_REMOVAL event is received, we immediately set a
503 private flag to block future accesses to this device. All the
504 functions that actually access the device should check this flag
505 to make sure the card is still present.
507 ======================================================================*/
509 static int airo_event(event_t event, int priority,
510 event_callback_args_t *args)
512 dev_link_t *link = args->client_data;
513 local_info_t *local = link->priv;
515 DEBUG(1, "airo_event(0x%06x)\n", event);
518 case CS_EVENT_CARD_REMOVAL:
519 link->state &= ~DEV_PRESENT;
520 if (link->state & DEV_CONFIG) {
521 netif_device_detach(local->eth_dev);
525 case CS_EVENT_CARD_INSERTION:
526 link->state |= DEV_PRESENT | DEV_CONFIG_PENDING;
529 case CS_EVENT_PM_SUSPEND:
530 link->state |= DEV_SUSPEND;
531 /* Fall through... */
532 case CS_EVENT_RESET_PHYSICAL:
533 if (link->state & DEV_CONFIG) {
534 netif_device_detach(local->eth_dev);
535 pcmcia_release_configuration(link->handle);
538 case CS_EVENT_PM_RESUME:
539 link->state &= ~DEV_SUSPEND;
540 /* Fall through... */
541 case CS_EVENT_CARD_RESET:
542 if (link->state & DEV_CONFIG) {
543 pcmcia_request_configuration(link->handle, &link->conf);
544 reset_airo_card(local->eth_dev);
545 netif_device_attach(local->eth_dev);
552 static struct pcmcia_device_id airo_ids[] = {
553 PCMCIA_DEVICE_MANF_CARD(0x015f, 0x000a),
554 PCMCIA_DEVICE_MANF_CARD(0x015f, 0x0005),
555 PCMCIA_DEVICE_MANF_CARD(0x015f, 0x0007),
556 PCMCIA_DEVICE_MANF_CARD(0x0105, 0x0007),
559 MODULE_DEVICE_TABLE(pcmcia, airo_ids);
561 static struct pcmcia_driver airo_driver = {
562 .owner = THIS_MODULE,
566 .attach = airo_attach,
568 .detach = airo_detach,
569 .id_table = airo_ids,
572 static int airo_cs_init(void)
574 return pcmcia_register_driver(&airo_driver);
577 static void airo_cs_cleanup(void)
579 pcmcia_unregister_driver(&airo_driver);
580 BUG_ON(dev_list != NULL);
584 This program is free software; you can redistribute it and/or
585 modify it under the terms of the GNU General Public License
586 as published by the Free Software Foundation; either version 2
587 of the License, or (at your option) any later version.
589 This program is distributed in the hope that it will be useful,
590 but WITHOUT ANY WARRANTY; without even the implied warranty of
591 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
592 GNU General Public License for more details.
596 Redistribution and use in source and binary forms, with or without
597 modification, are permitted provided that the following conditions
600 1. Redistributions of source code must retain the above copyright
601 notice, this list of conditions and the following disclaimer.
602 2. Redistributions in binary form must reproduce the above copyright
603 notice, this list of conditions and the following disclaimer in the
604 documentation and/or other materials provided with the distribution.
605 3. The name of the author may not be used to endorse or promote
606 products derived from this software without specific prior written
609 THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
610 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
611 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
612 ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
613 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
614 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
615 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
616 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
617 STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
618 IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
619 POSSIBILITY OF SUCH DAMAGE.
622 module_init(airo_cs_init);
623 module_exit(airo_cs_cleanup);