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 = kzalloc(sizeof(struct dev_link_t), GFP_KERNEL);
186 printk(KERN_ERR "atmel_cs: no memory for new device\n");
190 /* Interrupt setup */
191 link->irq.Attributes = IRQ_TYPE_EXCLUSIVE;
192 link->irq.IRQInfo1 = IRQ_LEVEL_ID;
193 link->irq.Handler = NULL;
196 General socket configuration defaults can go here. In this
197 client, we assume very little, and rely on the CIS for almost
198 everything. In most clients, many details (i.e., number, sizes,
199 and attributes of IO windows) are fixed by the nature of the
200 device, and can be hard-wired here.
202 link->conf.Attributes = 0;
204 link->conf.IntType = INT_MEMORY_AND_IO;
206 /* Allocate space for private device-specific data */
207 local = kzalloc(sizeof(local_info_t), GFP_KERNEL);
209 printk(KERN_ERR "atmel_cs: no memory for new device\n");
215 /* Register with Card Services */
216 link->next = dev_list;
218 client_reg.dev_info = &dev_info;
219 client_reg.Version = 0x0210;
220 client_reg.event_callback_args.client_data = link;
221 ret = pcmcia_register_client(&link->handle, &client_reg);
223 cs_error(link->handle, RegisterClient, ret);
231 /*======================================================================
233 This deletes a driver "instance". The device is de-registered
234 with Card Services. If it has been released, all local data
235 structures are freed. Otherwise, the structures will be freed
236 when the device is released.
238 ======================================================================*/
240 static void atmel_detach(dev_link_t *link)
244 DEBUG(0, "atmel_detach(0x%p)\n", link);
246 /* Locate device structure */
247 for (linkp = &dev_list; *linkp; linkp = &(*linkp)->next)
248 if (*linkp == link) break;
252 if (link->state & DEV_CONFIG)
255 /* Break the link with Card Services */
257 pcmcia_deregister_client(link->handle);
259 /* Unlink device structure, free pieces */
265 /*======================================================================
267 atmel_config() is scheduled to run after a CARD_INSERTION event
268 is received, to configure the PCMCIA socket, and to make the
269 device available to the system.
271 ======================================================================*/
273 #define CS_CHECK(fn, ret) \
274 do { last_fn = (fn); if ((last_ret = (ret)) != 0) goto cs_failed; } while (0)
276 /* Call-back function to interrogate PCMCIA-specific information
277 about the current existance of the card */
278 static int card_present(void *arg)
280 dev_link_t *link = (dev_link_t *)arg;
281 if (link->state & DEV_SUSPEND)
283 else if (link->state & DEV_PRESENT)
289 static void atmel_config(dev_link_t *link)
291 client_handle_t handle;
295 int last_fn, last_ret;
297 struct pcmcia_device_id *did;
299 handle = link->handle;
301 did = handle_to_dev(handle).driver_data;
303 DEBUG(0, "atmel_config(0x%p)\n", link);
305 tuple.Attributes = 0;
306 tuple.TupleData = buf;
307 tuple.TupleDataMax = sizeof(buf);
308 tuple.TupleOffset = 0;
311 This reads the card's CONFIG tuple to find its configuration
314 tuple.DesiredTuple = CISTPL_CONFIG;
315 CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(handle, &tuple));
316 CS_CHECK(GetTupleData, pcmcia_get_tuple_data(handle, &tuple));
317 CS_CHECK(ParseTuple, pcmcia_parse_tuple(handle, &tuple, &parse));
318 link->conf.ConfigBase = parse.config.base;
319 link->conf.Present = parse.config.rmask[0];
322 link->state |= DEV_CONFIG;
325 In this loop, we scan the CIS for configuration table entries,
326 each of which describes a valid card configuration, including
327 voltage, IO window, memory window, and interrupt settings.
329 We make no assumptions about the card to be configured: we use
330 just the information available in the CIS. In an ideal world,
331 this would work for any PCMCIA card, but it requires a complete
332 and accurate CIS. In practice, a driver usually "knows" most of
333 these things without consulting the CIS, and most client drivers
334 will only use the CIS to fill in implementation-defined details.
336 tuple.DesiredTuple = CISTPL_CFTABLE_ENTRY;
337 CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(handle, &tuple));
339 cistpl_cftable_entry_t dflt = { 0 };
340 cistpl_cftable_entry_t *cfg = &(parse.cftable_entry);
341 if (pcmcia_get_tuple_data(handle, &tuple) != 0 ||
342 pcmcia_parse_tuple(handle, &tuple, &parse) != 0)
345 if (cfg->flags & CISTPL_CFTABLE_DEFAULT) dflt = *cfg;
346 if (cfg->index == 0) goto next_entry;
347 link->conf.ConfigIndex = cfg->index;
349 /* Does this card need audio output? */
350 if (cfg->flags & CISTPL_CFTABLE_AUDIO) {
351 link->conf.Attributes |= CONF_ENABLE_SPKR;
352 link->conf.Status = CCSR_AUDIO_ENA;
355 /* Use power settings for Vcc and Vpp if present */
356 /* Note that the CIS values need to be rescaled */
357 if (cfg->vcc.present & (1<<CISTPL_POWER_VNOM))
358 link->conf.Vcc = cfg->vcc.param[CISTPL_POWER_VNOM]/10000;
359 else if (dflt.vcc.present & (1<<CISTPL_POWER_VNOM))
360 link->conf.Vcc = dflt.vcc.param[CISTPL_POWER_VNOM]/10000;
362 if (cfg->vpp1.present & (1<<CISTPL_POWER_VNOM))
363 link->conf.Vpp1 = link->conf.Vpp2 =
364 cfg->vpp1.param[CISTPL_POWER_VNOM]/10000;
365 else if (dflt.vpp1.present & (1<<CISTPL_POWER_VNOM))
366 link->conf.Vpp1 = link->conf.Vpp2 =
367 dflt.vpp1.param[CISTPL_POWER_VNOM]/10000;
369 /* Do we need to allocate an interrupt? */
370 if (cfg->irq.IRQInfo1 || dflt.irq.IRQInfo1)
371 link->conf.Attributes |= CONF_ENABLE_IRQ;
373 /* IO window settings */
374 link->io.NumPorts1 = link->io.NumPorts2 = 0;
375 if ((cfg->io.nwin > 0) || (dflt.io.nwin > 0)) {
376 cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &dflt.io;
377 link->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
378 if (!(io->flags & CISTPL_IO_8BIT))
379 link->io.Attributes1 = IO_DATA_PATH_WIDTH_16;
380 if (!(io->flags & CISTPL_IO_16BIT))
381 link->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
382 link->io.BasePort1 = io->win[0].base;
383 link->io.NumPorts1 = io->win[0].len;
385 link->io.Attributes2 = link->io.Attributes1;
386 link->io.BasePort2 = io->win[1].base;
387 link->io.NumPorts2 = io->win[1].len;
391 /* This reserves IO space but doesn't actually enable it */
392 if (pcmcia_request_io(link->handle, &link->io) != 0)
395 /* If we got this far, we're cool! */
399 CS_CHECK(GetNextTuple, pcmcia_get_next_tuple(handle, &tuple));
403 Allocate an interrupt line. Note that this does not assign a
404 handler to the interrupt, unless the 'Handler' member of the
405 irq structure is initialized.
407 if (link->conf.Attributes & CONF_ENABLE_IRQ)
408 CS_CHECK(RequestIRQ, pcmcia_request_irq(link->handle, &link->irq));
411 This actually configures the PCMCIA socket -- setting up
412 the I/O windows and the interrupt mapping, and putting the
413 card and host interface into "Memory and IO" mode.
415 CS_CHECK(RequestConfiguration, pcmcia_request_configuration(link->handle, &link->conf));
417 if (link->irq.AssignedIRQ == 0) {
419 "atmel: cannot assign IRQ: check that CONFIG_ISA is set in kernel config.");
423 ((local_info_t*)link->priv)->eth_dev =
424 init_atmel_card(link->irq.AssignedIRQ,
426 did ? did->driver_info : ATMEL_FW_TYPE_NONE,
427 &handle_to_dev(handle),
430 if (!((local_info_t*)link->priv)->eth_dev)
435 At this point, the dev_node_t structure(s) need to be
436 initialized and arranged in a linked list at link->dev.
438 strcpy(dev->node.dev_name, ((local_info_t*)link->priv)->eth_dev->name );
439 dev->node.major = dev->node.minor = 0;
440 link->dev = &dev->node;
442 link->state &= ~DEV_CONFIG_PENDING;
446 cs_error(link->handle, last_fn, last_ret);
450 /*======================================================================
452 After a card is removed, atmel_release() will unregister the
453 device, and release the PCMCIA configuration. If the device is
454 still open, this will be postponed until it is closed.
456 ======================================================================*/
458 static void atmel_release(dev_link_t *link)
460 struct net_device *dev = ((local_info_t*)link->priv)->eth_dev;
462 DEBUG(0, "atmel_release(0x%p)\n", link);
464 /* Unlink the device chain */
468 stop_atmel_card(dev);
469 ((local_info_t*)link->priv)->eth_dev = NULL;
471 /* Don't bother checking to see if these succeed or not */
472 pcmcia_release_configuration(link->handle);
473 if (link->io.NumPorts1)
474 pcmcia_release_io(link->handle, &link->io);
475 if (link->irq.AssignedIRQ)
476 pcmcia_release_irq(link->handle, &link->irq);
477 link->state &= ~DEV_CONFIG;
480 /*======================================================================
482 The card status event handler. Mostly, this schedules other
483 stuff to run after an event is received.
485 When a CARD_REMOVAL event is received, we immediately set a
486 private flag to block future accesses to this device. All the
487 functions that actually access the device should check this flag
488 to make sure the card is still present.
490 ======================================================================*/
492 static int atmel_event(event_t event, int priority,
493 event_callback_args_t *args)
495 dev_link_t *link = args->client_data;
496 local_info_t *local = link->priv;
498 DEBUG(1, "atmel_event(0x%06x)\n", event);
501 case CS_EVENT_CARD_REMOVAL:
502 link->state &= ~DEV_PRESENT;
503 if (link->state & DEV_CONFIG) {
504 netif_device_detach(local->eth_dev);
508 case CS_EVENT_CARD_INSERTION:
509 link->state |= DEV_PRESENT | DEV_CONFIG_PENDING;
512 case CS_EVENT_PM_SUSPEND:
513 link->state |= DEV_SUSPEND;
514 /* Fall through... */
515 case CS_EVENT_RESET_PHYSICAL:
516 if (link->state & DEV_CONFIG) {
517 netif_device_detach(local->eth_dev);
518 pcmcia_release_configuration(link->handle);
521 case CS_EVENT_PM_RESUME:
522 link->state &= ~DEV_SUSPEND;
523 /* Fall through... */
524 case CS_EVENT_CARD_RESET:
525 if (link->state & DEV_CONFIG) {
526 pcmcia_request_configuration(link->handle, &link->conf);
527 atmel_open(local->eth_dev);
528 netif_device_attach(local->eth_dev);
535 /*====================================================================*/
536 /* We use the driver_info field to store the correct firmware type for a card. */
538 #define PCMCIA_DEVICE_MANF_CARD_INFO(manf, card, info) { \
539 .match_flags = PCMCIA_DEV_ID_MATCH_MANF_ID| \
540 PCMCIA_DEV_ID_MATCH_CARD_ID, \
543 .driver_info = (kernel_ulong_t)(info), }
545 #define PCMCIA_DEVICE_PROD_ID12_INFO(v1, v2, vh1, vh2, info) { \
546 .match_flags = PCMCIA_DEV_ID_MATCH_PROD_ID1| \
547 PCMCIA_DEV_ID_MATCH_PROD_ID2, \
548 .prod_id = { (v1), (v2), NULL, NULL }, \
549 .prod_id_hash = { (vh1), (vh2), 0, 0 }, \
550 .driver_info = (kernel_ulong_t)(info), }
552 static struct pcmcia_device_id atmel_ids[] = {
553 PCMCIA_DEVICE_MANF_CARD_INFO(0x0101, 0x0620, ATMEL_FW_TYPE_502_3COM),
554 PCMCIA_DEVICE_MANF_CARD_INFO(0x0101, 0x0696, ATMEL_FW_TYPE_502_3COM),
555 PCMCIA_DEVICE_MANF_CARD_INFO(0x01bf, 0x3302, ATMEL_FW_TYPE_502E),
556 PCMCIA_DEVICE_MANF_CARD_INFO(0xd601, 0x0007, ATMEL_FW_TYPE_502),
557 PCMCIA_DEVICE_PROD_ID12_INFO("11WAVE", "11WP611AL-E", 0x9eb2da1f, 0xc9a0d3f9, ATMEL_FW_TYPE_502E),
558 PCMCIA_DEVICE_PROD_ID12_INFO("ATMEL", "AT76C502AR", 0xabda4164, 0x41b37e1f, ATMEL_FW_TYPE_502),
559 PCMCIA_DEVICE_PROD_ID12_INFO("ATMEL", "AT76C502AR_D", 0xabda4164, 0x3675d704, ATMEL_FW_TYPE_502D),
560 PCMCIA_DEVICE_PROD_ID12_INFO("ATMEL", "AT76C502AR_E", 0xabda4164, 0x4172e792, ATMEL_FW_TYPE_502E),
561 PCMCIA_DEVICE_PROD_ID12_INFO("ATMEL", "AT76C504_R", 0xabda4164, 0x917f3d72, ATMEL_FW_TYPE_504_2958),
562 PCMCIA_DEVICE_PROD_ID12_INFO("ATMEL", "AT76C504", 0xabda4164, 0x5040670a, ATMEL_FW_TYPE_504),
563 PCMCIA_DEVICE_PROD_ID12_INFO("ATMEL", "AT76C504A", 0xabda4164, 0xe15ed87f, ATMEL_FW_TYPE_504A_2958),
564 PCMCIA_DEVICE_PROD_ID12_INFO("BT", "Voyager 1020 Laptop Adapter", 0xae49b86a, 0x1e957cd5, ATMEL_FW_TYPE_502),
565 PCMCIA_DEVICE_PROD_ID12_INFO("CNet", "CNWLC 11Mbps Wireless PC Card V-5", 0xbc477dde, 0x502fae6b, ATMEL_FW_TYPE_502E),
566 PCMCIA_DEVICE_PROD_ID12_INFO("IEEE 802.11b", "Wireless LAN PC Card", 0x5b878724, 0x122f1df6, ATMEL_FW_TYPE_502),
567 PCMCIA_DEVICE_PROD_ID12_INFO("IEEE 802.11b", "Wireless LAN Card S", 0x5b878724, 0x5fba533a, ATMEL_FW_TYPE_504_2958),
568 PCMCIA_DEVICE_PROD_ID12_INFO("OEM", "11Mbps Wireless LAN PC Card V-3", 0xfea54c90, 0x1c5b0f68, ATMEL_FW_TYPE_502),
569 PCMCIA_DEVICE_PROD_ID12_INFO("SMC", "2632W", 0xc4f8b18b, 0x30f38774, ATMEL_FW_TYPE_502D),
570 PCMCIA_DEVICE_PROD_ID12_INFO("SMC", "2632W-V2", 0xc4f8b18b, 0x172d1377, ATMEL_FW_TYPE_502),
571 PCMCIA_DEVICE_PROD_ID12_INFO("Wireless", "PC_CARD", 0xa407ecdd, 0x119f6314, ATMEL_FW_TYPE_502D),
572 PCMCIA_DEVICE_PROD_ID12_INFO("WLAN", "802.11b PC CARD", 0x575c516c, 0xb1f6dbc4, ATMEL_FW_TYPE_502D),
573 PCMCIA_DEVICE_PROD_ID12_INFO("LG", "LW2100N", 0xb474d43a, 0x6b1fec94, ATMEL_FW_TYPE_502E),
577 MODULE_DEVICE_TABLE(pcmcia, atmel_ids);
579 static struct pcmcia_driver atmel_driver = {
580 .owner = THIS_MODULE,
584 .attach = atmel_attach,
585 .event = atmel_event,
586 .detach = atmel_detach,
587 .id_table = atmel_ids,
590 static int atmel_cs_init(void)
592 return pcmcia_register_driver(&atmel_driver);
595 static void atmel_cs_cleanup(void)
597 pcmcia_unregister_driver(&atmel_driver);
598 BUG_ON(dev_list != NULL);
602 This program is free software; you can redistribute it and/or
603 modify it under the terms of the GNU General Public License
604 as published by the Free Software Foundation; either version 2
605 of the License, or (at your option) any later version.
607 This program is distributed in the hope that it will be useful,
608 but WITHOUT ANY WARRANTY; without even the implied warranty of
609 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
610 GNU General Public License for more details.
614 Redistribution and use in source and binary forms, with or without
615 modification, are permitted provided that the following conditions
618 1. Redistributions of source code must retain the above copyright
619 notice, this list of conditions and the following disclaimer.
620 2. Redistributions in binary form must reproduce the above copyright
621 notice, this list of conditions and the following disclaimer in the
622 documentation and/or other materials provided with the distribution.
623 3. The name of the author may not be used to endorse or promote
624 products derived from this software without specific prior written
627 THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
628 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
629 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
630 ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
631 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
632 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
633 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
634 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
635 STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
636 IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
637 POSSIBILITY OF SUCH DAMAGE.
640 module_init(atmel_cs_init);
641 module_exit(atmel_cs_cleanup);