1 /*** -*- linux-c -*- **********************************************************
3 Driver for Atmel at76c502 at76c504 and at76c506 wireless cards.
5 Copyright 2000-2001 ATMEL Corporation.
6 Copyright 2003 Simon Kelley.
8 This code was developed from version 2.1.1 of the Atmel drivers,
9 released by Atmel corp. under the GPL in December 2002. It also
10 includes code from the Linux aironet drivers (C) Benjamin Reed,
11 and the Linux PCMCIA package, (C) David Hinds.
13 For all queries about this code, please contact the current author,
14 Simon Kelley <simon@thekelleys.org.uk> and not Atmel Corporation.
16 This program is free software; you can redistribute it and/or modify
17 it under the terms of the GNU General Public License as published by
18 the Free Software Foundation; either version 2 of the License, or
19 (at your option) any later version.
21 This software is distributed in the hope that it will be useful,
22 but WITHOUT ANY WARRANTY; without even the implied warranty of
23 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 GNU General Public License for more details.
26 You should have received a copy of the GNU General Public License
27 along with Atmel wireless lan drivers; if not, write to the Free Software
28 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
30 ******************************************************************************/
32 #include <linux/config.h>
33 #ifdef __IN_PCMCIA_PACKAGE__
34 #include <pcmcia/k_compat.h>
36 #include <linux/init.h>
37 #include <linux/kernel.h>
38 #include <linux/module.h>
39 #include <linux/ptrace.h>
40 #include <linux/slab.h>
41 #include <linux/string.h>
42 #include <linux/netdevice.h>
43 #include <linux/moduleparam.h>
44 #include <linux/device.h>
46 #include <pcmcia/cs_types.h>
47 #include <pcmcia/cs.h>
48 #include <pcmcia/cistpl.h>
49 #include <pcmcia/cisreg.h>
50 #include <pcmcia/ds.h>
51 #include <pcmcia/ciscode.h>
54 #include <asm/system.h>
55 #include <linux/wireless.h>
60 All the PCMCIA modules use PCMCIA_DEBUG to control debugging. If
61 you do not define PCMCIA_DEBUG at all, all the debug code will be
62 left out. If you compile with PCMCIA_DEBUG=0, the debug code will
63 be present but disabled -- but it can then be enabled for specific
64 modules at load time with a 'pc_debug=#' option to insmod.
68 static int pc_debug = PCMCIA_DEBUG;
69 module_param(pc_debug, int, 0);
70 static char *version = "$Revision: 1.2 $";
71 #define DEBUG(n, args...) if (pc_debug>(n)) printk(KERN_DEBUG args);
73 #define DEBUG(n, args...)
76 /*====================================================================*/
78 MODULE_AUTHOR("Simon Kelley");
79 MODULE_DESCRIPTION("Support for Atmel at76c50x 802.11 wireless ethernet cards.");
80 MODULE_LICENSE("GPL");
81 MODULE_SUPPORTED_DEVICE("Atmel at76c50x PCMCIA cards");
83 /*====================================================================*/
86 The event() function is this driver's Card Services event handler.
87 It will be called by Card Services when an appropriate card status
88 event is received. The config() and release() entry points are
89 used to configure or release a socket, in response to card
90 insertion and ejection events. They are invoked from the atmel_cs
94 static void atmel_config(dev_link_t *link);
95 static void atmel_release(dev_link_t *link);
96 static int atmel_event(event_t event, int priority,
97 event_callback_args_t *args);
100 The attach() and detach() entry points are used to create and destroy
101 "instances" of the driver, where each instance represents everything
102 needed to manage one actual PCMCIA card.
105 static dev_link_t *atmel_attach(void);
106 static void atmel_detach(dev_link_t *);
109 You'll also need to prototype all the functions that will actually
110 be used to talk to your device. See 'pcmem_cs' for a good example
111 of a fully self-sufficient driver; the other drivers rely more or
112 less on other parts of the kernel.
116 The dev_info variable is the "key" that is used to match up this
117 device driver with appropriate cards, through the card configuration
121 static dev_info_t dev_info = "atmel_cs";
124 A linked list of "instances" of the atmelnet device. Each actual
125 PCMCIA card corresponds to one device instance, and is described
126 by one dev_link_t structure (defined in ds.h).
128 You may not want to use a linked list for this -- for example, the
129 memory card driver uses an array of dev_link_t pointers, where minor
130 device numbers are used to derive the corresponding array index.
133 static dev_link_t *dev_list = NULL;
136 A dev_link_t structure has fields for most things that are needed
137 to keep track of a socket, but there will usually be some device
138 specific information that also needs to be kept track of. The
139 'priv' pointer in a dev_link_t structure can be used to point to
140 a device-specific private data structure, like this.
142 A driver needs to provide a dev_node_t structure for each device
143 on a card. In some cases, there is only one device per card (for
144 example, ethernet cards, modems). In other cases, there may be
145 many actual or logical devices (SCSI adapters, memory cards with
146 multiple partitions). The dev_node_t structures need to be kept
147 in a linked list starting at the 'dev' field of a dev_link_t
148 structure. We allocate them in the card's private data structure,
149 because they generally shouldn't be allocated dynamically.
151 In this case, we also provide a flag to indicate if a device is
152 "stopped" due to a power management event, or card ejection. The
153 device IO routines can use a flag like this to throttle IO to a
154 card that is not ready to accept it.
157 typedef struct local_info_t {
159 struct net_device *eth_dev;
162 /*======================================================================
164 atmel_attach() creates an "instance" of the driver, allocating
165 local data structures for one device. The device is registered
168 The dev_link structure is initialized, but we don't actually
169 configure the card at this point -- we wait until we receive a
170 card insertion event.
172 ======================================================================*/
174 static dev_link_t *atmel_attach(void)
176 client_reg_t client_reg;
181 DEBUG(0, "atmel_attach()\n");
183 /* Initialize the dev_link_t structure */
184 link = kmalloc(sizeof(struct dev_link_t), GFP_KERNEL);
186 printk(KERN_ERR "atmel_cs: no memory for new device\n");
189 memset(link, 0, sizeof(struct dev_link_t));
191 /* Interrupt setup */
192 link->irq.Attributes = IRQ_TYPE_EXCLUSIVE;
193 link->irq.IRQInfo1 = IRQ_LEVEL_ID;
194 link->irq.Handler = NULL;
197 General socket configuration defaults can go here. In this
198 client, we assume very little, and rely on the CIS for almost
199 everything. In most clients, many details (i.e., number, sizes,
200 and attributes of IO windows) are fixed by the nature of the
201 device, and can be hard-wired here.
203 link->conf.Attributes = 0;
205 link->conf.IntType = INT_MEMORY_AND_IO;
207 /* Allocate space for private device-specific data */
208 local = kmalloc(sizeof(local_info_t), GFP_KERNEL);
210 printk(KERN_ERR "atmel_cs: no memory for new device\n");
214 memset(local, 0, sizeof(local_info_t));
217 /* Register with Card Services */
218 link->next = dev_list;
220 client_reg.dev_info = &dev_info;
221 client_reg.Version = 0x0210;
222 client_reg.event_callback_args.client_data = link;
223 ret = pcmcia_register_client(&link->handle, &client_reg);
225 cs_error(link->handle, RegisterClient, ret);
233 /*======================================================================
235 This deletes a driver "instance". The device is de-registered
236 with Card Services. If it has been released, all local data
237 structures are freed. Otherwise, the structures will be freed
238 when the device is released.
240 ======================================================================*/
242 static void atmel_detach(dev_link_t *link)
246 DEBUG(0, "atmel_detach(0x%p)\n", link);
248 /* Locate device structure */
249 for (linkp = &dev_list; *linkp; linkp = &(*linkp)->next)
250 if (*linkp == link) break;
254 if (link->state & DEV_CONFIG)
257 /* Break the link with Card Services */
259 pcmcia_deregister_client(link->handle);
261 /* Unlink device structure, free pieces */
268 /*======================================================================
270 atmel_config() is scheduled to run after a CARD_INSERTION event
271 is received, to configure the PCMCIA socket, and to make the
272 device available to the system.
274 ======================================================================*/
276 #define CS_CHECK(fn, ret) \
277 do { last_fn = (fn); if ((last_ret = (ret)) != 0) goto cs_failed; } while (0)
279 /* Call-back function to interrogate PCMCIA-specific information
280 about the current existance of the card */
281 static int card_present(void *arg)
283 dev_link_t *link = (dev_link_t *)arg;
284 if (link->state & DEV_SUSPEND)
286 else if (link->state & DEV_PRESENT)
292 static void atmel_config(dev_link_t *link)
294 client_handle_t handle;
298 int last_fn, last_ret;
300 struct pcmcia_device_id *did;
302 handle = link->handle;
304 did = handle_to_dev(handle).driver_data;
306 DEBUG(0, "atmel_config(0x%p)\n", link);
308 tuple.Attributes = 0;
309 tuple.TupleData = buf;
310 tuple.TupleDataMax = sizeof(buf);
311 tuple.TupleOffset = 0;
314 This reads the card's CONFIG tuple to find its configuration
317 tuple.DesiredTuple = CISTPL_CONFIG;
318 CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(handle, &tuple));
319 CS_CHECK(GetTupleData, pcmcia_get_tuple_data(handle, &tuple));
320 CS_CHECK(ParseTuple, pcmcia_parse_tuple(handle, &tuple, &parse));
321 link->conf.ConfigBase = parse.config.base;
322 link->conf.Present = parse.config.rmask[0];
325 link->state |= DEV_CONFIG;
328 In this loop, we scan the CIS for configuration table entries,
329 each of which describes a valid card configuration, including
330 voltage, IO window, memory window, and interrupt settings.
332 We make no assumptions about the card to be configured: we use
333 just the information available in the CIS. In an ideal world,
334 this would work for any PCMCIA card, but it requires a complete
335 and accurate CIS. In practice, a driver usually "knows" most of
336 these things without consulting the CIS, and most client drivers
337 will only use the CIS to fill in implementation-defined details.
339 tuple.DesiredTuple = CISTPL_CFTABLE_ENTRY;
340 CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(handle, &tuple));
342 cistpl_cftable_entry_t dflt = { 0 };
343 cistpl_cftable_entry_t *cfg = &(parse.cftable_entry);
344 if (pcmcia_get_tuple_data(handle, &tuple) != 0 ||
345 pcmcia_parse_tuple(handle, &tuple, &parse) != 0)
348 if (cfg->flags & CISTPL_CFTABLE_DEFAULT) dflt = *cfg;
349 if (cfg->index == 0) goto next_entry;
350 link->conf.ConfigIndex = cfg->index;
352 /* Does this card need audio output? */
353 if (cfg->flags & CISTPL_CFTABLE_AUDIO) {
354 link->conf.Attributes |= CONF_ENABLE_SPKR;
355 link->conf.Status = CCSR_AUDIO_ENA;
358 /* Use power settings for Vcc and Vpp if present */
359 /* Note that the CIS values need to be rescaled */
360 if (cfg->vcc.present & (1<<CISTPL_POWER_VNOM))
361 link->conf.Vcc = cfg->vcc.param[CISTPL_POWER_VNOM]/10000;
362 else if (dflt.vcc.present & (1<<CISTPL_POWER_VNOM))
363 link->conf.Vcc = dflt.vcc.param[CISTPL_POWER_VNOM]/10000;
365 if (cfg->vpp1.present & (1<<CISTPL_POWER_VNOM))
366 link->conf.Vpp1 = link->conf.Vpp2 =
367 cfg->vpp1.param[CISTPL_POWER_VNOM]/10000;
368 else if (dflt.vpp1.present & (1<<CISTPL_POWER_VNOM))
369 link->conf.Vpp1 = link->conf.Vpp2 =
370 dflt.vpp1.param[CISTPL_POWER_VNOM]/10000;
372 /* Do we need to allocate an interrupt? */
373 if (cfg->irq.IRQInfo1 || dflt.irq.IRQInfo1)
374 link->conf.Attributes |= CONF_ENABLE_IRQ;
376 /* IO window settings */
377 link->io.NumPorts1 = link->io.NumPorts2 = 0;
378 if ((cfg->io.nwin > 0) || (dflt.io.nwin > 0)) {
379 cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &dflt.io;
380 link->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
381 if (!(io->flags & CISTPL_IO_8BIT))
382 link->io.Attributes1 = IO_DATA_PATH_WIDTH_16;
383 if (!(io->flags & CISTPL_IO_16BIT))
384 link->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
385 link->io.BasePort1 = io->win[0].base;
386 link->io.NumPorts1 = io->win[0].len;
388 link->io.Attributes2 = link->io.Attributes1;
389 link->io.BasePort2 = io->win[1].base;
390 link->io.NumPorts2 = io->win[1].len;
394 /* This reserves IO space but doesn't actually enable it */
395 if (pcmcia_request_io(link->handle, &link->io) != 0)
398 /* If we got this far, we're cool! */
402 CS_CHECK(GetNextTuple, pcmcia_get_next_tuple(handle, &tuple));
406 Allocate an interrupt line. Note that this does not assign a
407 handler to the interrupt, unless the 'Handler' member of the
408 irq structure is initialized.
410 if (link->conf.Attributes & CONF_ENABLE_IRQ)
411 CS_CHECK(RequestIRQ, pcmcia_request_irq(link->handle, &link->irq));
414 This actually configures the PCMCIA socket -- setting up
415 the I/O windows and the interrupt mapping, and putting the
416 card and host interface into "Memory and IO" mode.
418 CS_CHECK(RequestConfiguration, pcmcia_request_configuration(link->handle, &link->conf));
420 if (link->irq.AssignedIRQ == 0) {
422 "atmel: cannot assign IRQ: check that CONFIG_ISA is set in kernel config.");
426 ((local_info_t*)link->priv)->eth_dev =
427 init_atmel_card(link->irq.AssignedIRQ,
429 did ? did->driver_info : ATMEL_FW_TYPE_NONE,
430 &handle_to_dev(handle),
433 if (!((local_info_t*)link->priv)->eth_dev)
438 At this point, the dev_node_t structure(s) need to be
439 initialized and arranged in a linked list at link->dev.
441 strcpy(dev->node.dev_name, ((local_info_t*)link->priv)->eth_dev->name );
442 dev->node.major = dev->node.minor = 0;
443 link->dev = &dev->node;
445 link->state &= ~DEV_CONFIG_PENDING;
449 cs_error(link->handle, last_fn, last_ret);
453 /*======================================================================
455 After a card is removed, atmel_release() will unregister the
456 device, and release the PCMCIA configuration. If the device is
457 still open, this will be postponed until it is closed.
459 ======================================================================*/
461 static void atmel_release(dev_link_t *link)
463 struct net_device *dev = ((local_info_t*)link->priv)->eth_dev;
465 DEBUG(0, "atmel_release(0x%p)\n", link);
467 /* Unlink the device chain */
471 stop_atmel_card(dev);
472 ((local_info_t*)link->priv)->eth_dev = NULL;
474 /* Don't bother checking to see if these succeed or not */
475 pcmcia_release_configuration(link->handle);
476 if (link->io.NumPorts1)
477 pcmcia_release_io(link->handle, &link->io);
478 if (link->irq.AssignedIRQ)
479 pcmcia_release_irq(link->handle, &link->irq);
480 link->state &= ~DEV_CONFIG;
483 /*======================================================================
485 The card status event handler. Mostly, this schedules other
486 stuff to run after an event is received.
488 When a CARD_REMOVAL event is received, we immediately set a
489 private flag to block future accesses to this device. All the
490 functions that actually access the device should check this flag
491 to make sure the card is still present.
493 ======================================================================*/
495 static int atmel_event(event_t event, int priority,
496 event_callback_args_t *args)
498 dev_link_t *link = args->client_data;
499 local_info_t *local = link->priv;
501 DEBUG(1, "atmel_event(0x%06x)\n", event);
504 case CS_EVENT_CARD_REMOVAL:
505 link->state &= ~DEV_PRESENT;
506 if (link->state & DEV_CONFIG) {
507 netif_device_detach(local->eth_dev);
511 case CS_EVENT_CARD_INSERTION:
512 link->state |= DEV_PRESENT | DEV_CONFIG_PENDING;
515 case CS_EVENT_PM_SUSPEND:
516 link->state |= DEV_SUSPEND;
517 /* Fall through... */
518 case CS_EVENT_RESET_PHYSICAL:
519 if (link->state & DEV_CONFIG) {
520 netif_device_detach(local->eth_dev);
521 pcmcia_release_configuration(link->handle);
524 case CS_EVENT_PM_RESUME:
525 link->state &= ~DEV_SUSPEND;
526 /* Fall through... */
527 case CS_EVENT_CARD_RESET:
528 if (link->state & DEV_CONFIG) {
529 pcmcia_request_configuration(link->handle, &link->conf);
530 atmel_open(local->eth_dev);
531 netif_device_attach(local->eth_dev);
538 /*====================================================================*/
539 /* We use the driver_info field to store the correct firmware type for a card. */
541 #define PCMCIA_DEVICE_MANF_CARD_INFO(manf, card, info) { \
542 .match_flags = PCMCIA_DEV_ID_MATCH_MANF_ID| \
543 PCMCIA_DEV_ID_MATCH_CARD_ID, \
546 .driver_info = (kernel_ulong_t)(info), }
548 #define PCMCIA_DEVICE_PROD_ID12_INFO(v1, v2, vh1, vh2, info) { \
549 .match_flags = PCMCIA_DEV_ID_MATCH_PROD_ID1| \
550 PCMCIA_DEV_ID_MATCH_PROD_ID2, \
551 .prod_id = { (v1), (v2), NULL, NULL }, \
552 .prod_id_hash = { (vh1), (vh2), 0, 0 }, \
553 .driver_info = (kernel_ulong_t)(info), }
555 static struct pcmcia_device_id atmel_ids[] = {
556 PCMCIA_DEVICE_MANF_CARD_INFO(0x0101, 0x0620, ATMEL_FW_TYPE_502_3COM),
557 PCMCIA_DEVICE_MANF_CARD_INFO(0x0101, 0x0696, ATMEL_FW_TYPE_502_3COM),
558 PCMCIA_DEVICE_MANF_CARD_INFO(0x01bf, 0x3302, ATMEL_FW_TYPE_502E),
559 PCMCIA_DEVICE_MANF_CARD_INFO(0xd601, 0x0007, ATMEL_FW_TYPE_502),
560 PCMCIA_DEVICE_PROD_ID12_INFO("11WAVE", "11WP611AL-E", 0x9eb2da1f, 0xc9a0d3f9, ATMEL_FW_TYPE_502E),
561 PCMCIA_DEVICE_PROD_ID12_INFO("ATMEL", "AT76C502AR", 0xabda4164, 0x41b37e1f, ATMEL_FW_TYPE_502),
562 PCMCIA_DEVICE_PROD_ID12_INFO("ATMEL", "AT76C502AR_D", 0xabda4164, 0x3675d704, ATMEL_FW_TYPE_502D),
563 PCMCIA_DEVICE_PROD_ID12_INFO("ATMEL", "AT76C502AR_E", 0xabda4164, 0x4172e792, ATMEL_FW_TYPE_502E),
564 PCMCIA_DEVICE_PROD_ID12_INFO("ATMEL", "AT76C504_R", 0xabda4164, 0x917f3d72, ATMEL_FW_TYPE_504_2958),
565 PCMCIA_DEVICE_PROD_ID12_INFO("ATMEL", "AT76C504", 0xabda4164, 0x5040670a, ATMEL_FW_TYPE_504),
566 PCMCIA_DEVICE_PROD_ID12_INFO("ATMEL", "AT76C504A", 0xabda4164, 0xe15ed87f, ATMEL_FW_TYPE_504A_2958),
567 PCMCIA_DEVICE_PROD_ID12_INFO("BT", "Voyager 1020 Laptop Adapter", 0xae49b86a, 0x1e957cd5, ATMEL_FW_TYPE_502),
568 PCMCIA_DEVICE_PROD_ID12_INFO("CNet", "CNWLC 11Mbps Wireless PC Card V-5", 0xbc477dde, 0x502fae6b, ATMEL_FW_TYPE_502E),
569 PCMCIA_DEVICE_PROD_ID12_INFO("IEEE 802.11b", "Wireless LAN PC Card", 0x5b878724, 0x122f1df6, ATMEL_FW_TYPE_502),
570 PCMCIA_DEVICE_PROD_ID12_INFO("IEEE 802.11b", "Wireless LAN Card S", 0x5b878724, 0x5fba533a, ATMEL_FW_TYPE_504_2958),
571 PCMCIA_DEVICE_PROD_ID12_INFO("OEM", "11Mbps Wireless LAN PC Card V-3", 0xfea54c90, 0x1c5b0f68, ATMEL_FW_TYPE_502),
572 PCMCIA_DEVICE_PROD_ID12_INFO("SMC", "2632W", 0xc4f8b18b, 0x30f38774, ATMEL_FW_TYPE_502D),
573 PCMCIA_DEVICE_PROD_ID12_INFO("SMC", "2632W-V2", 0xc4f8b18b, 0x172d1377, ATMEL_FW_TYPE_502),
574 PCMCIA_DEVICE_PROD_ID12_INFO("Wireless", "PC_CARD", 0xa407ecdd, 0x119f6314, ATMEL_FW_TYPE_502D),
575 PCMCIA_DEVICE_PROD_ID12_INFO("WLAN", "802.11b PC CARD", 0x575c516c, 0xb1f6dbc4, ATMEL_FW_TYPE_502D),
576 PCMCIA_DEVICE_PROD_ID12_INFO("LG", "LW2100N", 0xb474d43a, 0x6b1fec94, ATMEL_FW_TYPE_502E),
580 MODULE_DEVICE_TABLE(pcmcia, atmel_ids);
582 static struct pcmcia_driver atmel_driver = {
583 .owner = THIS_MODULE,
587 .attach = atmel_attach,
588 .event = atmel_event,
589 .detach = atmel_detach,
590 .id_table = atmel_ids,
593 static int atmel_cs_init(void)
595 return pcmcia_register_driver(&atmel_driver);
598 static void atmel_cs_cleanup(void)
600 pcmcia_unregister_driver(&atmel_driver);
601 BUG_ON(dev_list != NULL);
605 This program is free software; you can redistribute it and/or
606 modify it under the terms of the GNU General Public License
607 as published by the Free Software Foundation; either version 2
608 of the License, or (at your option) any later version.
610 This program is distributed in the hope that it will be useful,
611 but WITHOUT ANY WARRANTY; without even the implied warranty of
612 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
613 GNU General Public License for more details.
617 Redistribution and use in source and binary forms, with or without
618 modification, are permitted provided that the following conditions
621 1. Redistributions of source code must retain the above copyright
622 notice, this list of conditions and the following disclaimer.
623 2. Redistributions in binary form must reproduce the above copyright
624 notice, this list of conditions and the following disclaimer in the
625 documentation and/or other materials provided with the distribution.
626 3. The name of the author may not be used to endorse or promote
627 products derived from this software without specific prior written
630 THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
631 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
632 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
633 ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
634 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
635 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
636 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
637 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
638 STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
639 IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
640 POSSIBILITY OF SUCH DAMAGE.
643 module_init(atmel_cs_init);
644 module_exit(atmel_cs_cleanup);