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 int atmel_config(struct pcmcia_device *link);
95 static void atmel_release(struct pcmcia_device *link);
98 The attach() and detach() entry points are used to create and destroy
99 "instances" of the driver, where each instance represents everything
100 needed to manage one actual PCMCIA card.
103 static void atmel_detach(struct pcmcia_device *p_dev);
106 You'll also need to prototype all the functions that will actually
107 be used to talk to your device. See 'pcmem_cs' for a good example
108 of a fully self-sufficient driver; the other drivers rely more or
109 less on other parts of the kernel.
113 A linked list of "instances" of the atmelnet device. Each actual
114 PCMCIA card corresponds to one device instance, and is described
115 by one struct pcmcia_device 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 struct pcmcia_device pointers, where minor
119 device numbers are used to derive the corresponding array index.
123 A driver needs to provide a dev_node_t structure for each device
124 on a card. In some cases, there is only one device per card (for
125 example, ethernet cards, modems). In other cases, there may be
126 many actual or logical devices (SCSI adapters, memory cards with
127 multiple partitions). The dev_node_t structures need to be kept
128 in a linked list starting at the 'dev' field of a struct pcmcia_device
129 structure. We allocate them in the card's private data structure,
130 because they generally shouldn't be allocated dynamically.
132 In this case, we also provide a flag to indicate if a device is
133 "stopped" due to a power management event, or card ejection. The
134 device IO routines can use a flag like this to throttle IO to a
135 card that is not ready to accept it.
138 typedef struct local_info_t {
140 struct net_device *eth_dev;
143 /*======================================================================
145 atmel_attach() creates an "instance" of the driver, allocating
146 local data structures for one device. The device is registered
149 The dev_link structure is initialized, but we don't actually
150 configure the card at this point -- we wait until we receive a
151 card insertion event.
153 ======================================================================*/
155 static int atmel_probe(struct pcmcia_device *p_dev)
159 DEBUG(0, "atmel_attach()\n");
161 /* Interrupt setup */
162 p_dev->irq.Attributes = IRQ_TYPE_EXCLUSIVE;
163 p_dev->irq.IRQInfo1 = IRQ_LEVEL_ID;
164 p_dev->irq.Handler = NULL;
167 General socket configuration defaults can go here. In this
168 client, we assume very little, and rely on the CIS for almost
169 everything. In most clients, many details (i.e., number, sizes,
170 and attributes of IO windows) are fixed by the nature of the
171 device, and can be hard-wired here.
173 p_dev->conf.Attributes = 0;
174 p_dev->conf.IntType = INT_MEMORY_AND_IO;
176 /* Allocate space for private device-specific data */
177 local = kzalloc(sizeof(local_info_t), GFP_KERNEL);
179 printk(KERN_ERR "atmel_cs: no memory for new device\n");
184 return atmel_config(p_dev);
187 /*======================================================================
189 This deletes a driver "instance". The device is de-registered
190 with Card Services. If it has been released, all local data
191 structures are freed. Otherwise, the structures will be freed
192 when the device is released.
194 ======================================================================*/
196 static void atmel_detach(struct pcmcia_device *link)
198 DEBUG(0, "atmel_detach(0x%p)\n", link);
205 /*======================================================================
207 atmel_config() is scheduled to run after a CARD_INSERTION event
208 is received, to configure the PCMCIA socket, and to make the
209 device available to the system.
211 ======================================================================*/
213 #define CS_CHECK(fn, ret) \
214 do { last_fn = (fn); if ((last_ret = (ret)) != 0) goto cs_failed; } while (0)
216 /* Call-back function to interrogate PCMCIA-specific information
217 about the current existance of the card */
218 static int card_present(void *arg)
220 struct pcmcia_device *link = (struct pcmcia_device *)arg;
223 else if (pcmcia_dev_present(link))
229 static int atmel_config(struct pcmcia_device *link)
234 int last_fn, last_ret;
236 struct pcmcia_device_id *did;
239 did = handle_to_dev(link).driver_data;
241 DEBUG(0, "atmel_config(0x%p)\n", link);
243 tuple.Attributes = 0;
244 tuple.TupleData = buf;
245 tuple.TupleDataMax = sizeof(buf);
246 tuple.TupleOffset = 0;
249 This reads the card's CONFIG tuple to find its configuration
252 tuple.DesiredTuple = CISTPL_CONFIG;
253 CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(link, &tuple));
254 CS_CHECK(GetTupleData, pcmcia_get_tuple_data(link, &tuple));
255 CS_CHECK(ParseTuple, pcmcia_parse_tuple(link, &tuple, &parse));
256 link->conf.ConfigBase = parse.config.base;
257 link->conf.Present = parse.config.rmask[0];
260 In this loop, we scan the CIS for configuration table entries,
261 each of which describes a valid card configuration, including
262 voltage, IO window, memory window, and interrupt settings.
264 We make no assumptions about the card to be configured: we use
265 just the information available in the CIS. In an ideal world,
266 this would work for any PCMCIA card, but it requires a complete
267 and accurate CIS. In practice, a driver usually "knows" most of
268 these things without consulting the CIS, and most client drivers
269 will only use the CIS to fill in implementation-defined details.
271 tuple.DesiredTuple = CISTPL_CFTABLE_ENTRY;
272 CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(link, &tuple));
274 cistpl_cftable_entry_t dflt = { 0 };
275 cistpl_cftable_entry_t *cfg = &(parse.cftable_entry);
276 if (pcmcia_get_tuple_data(link, &tuple) != 0 ||
277 pcmcia_parse_tuple(link, &tuple, &parse) != 0)
280 if (cfg->flags & CISTPL_CFTABLE_DEFAULT) dflt = *cfg;
281 if (cfg->index == 0) goto next_entry;
282 link->conf.ConfigIndex = cfg->index;
284 /* Does this card need audio output? */
285 if (cfg->flags & CISTPL_CFTABLE_AUDIO) {
286 link->conf.Attributes |= CONF_ENABLE_SPKR;
287 link->conf.Status = CCSR_AUDIO_ENA;
290 /* Use power settings for Vcc and Vpp if present */
291 /* Note that the CIS values need to be rescaled */
292 if (cfg->vpp1.present & (1<<CISTPL_POWER_VNOM))
294 cfg->vpp1.param[CISTPL_POWER_VNOM]/10000;
295 else if (dflt.vpp1.present & (1<<CISTPL_POWER_VNOM))
297 dflt.vpp1.param[CISTPL_POWER_VNOM]/10000;
299 /* Do we need to allocate an interrupt? */
300 if (cfg->irq.IRQInfo1 || dflt.irq.IRQInfo1)
301 link->conf.Attributes |= CONF_ENABLE_IRQ;
303 /* IO window settings */
304 link->io.NumPorts1 = link->io.NumPorts2 = 0;
305 if ((cfg->io.nwin > 0) || (dflt.io.nwin > 0)) {
306 cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &dflt.io;
307 link->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
308 if (!(io->flags & CISTPL_IO_8BIT))
309 link->io.Attributes1 = IO_DATA_PATH_WIDTH_16;
310 if (!(io->flags & CISTPL_IO_16BIT))
311 link->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
312 link->io.BasePort1 = io->win[0].base;
313 link->io.NumPorts1 = io->win[0].len;
315 link->io.Attributes2 = link->io.Attributes1;
316 link->io.BasePort2 = io->win[1].base;
317 link->io.NumPorts2 = io->win[1].len;
321 /* This reserves IO space but doesn't actually enable it */
322 if (pcmcia_request_io(link, &link->io) != 0)
325 /* If we got this far, we're cool! */
329 CS_CHECK(GetNextTuple, pcmcia_get_next_tuple(link, &tuple));
333 Allocate an interrupt line. Note that this does not assign a
334 handler to the interrupt, unless the 'Handler' member of the
335 irq structure is initialized.
337 if (link->conf.Attributes & CONF_ENABLE_IRQ)
338 CS_CHECK(RequestIRQ, pcmcia_request_irq(link, &link->irq));
341 This actually configures the PCMCIA socket -- setting up
342 the I/O windows and the interrupt mapping, and putting the
343 card and host interface into "Memory and IO" mode.
345 CS_CHECK(RequestConfiguration, pcmcia_request_configuration(link, &link->conf));
347 if (link->irq.AssignedIRQ == 0) {
349 "atmel: cannot assign IRQ: check that CONFIG_ISA is set in kernel config.");
353 ((local_info_t*)link->priv)->eth_dev =
354 init_atmel_card(link->irq.AssignedIRQ,
356 did ? did->driver_info : ATMEL_FW_TYPE_NONE,
357 &handle_to_dev(link),
360 if (!((local_info_t*)link->priv)->eth_dev)
365 At this point, the dev_node_t structure(s) need to be
366 initialized and arranged in a linked list at link->dev_node.
368 strcpy(dev->node.dev_name, ((local_info_t*)link->priv)->eth_dev->name );
369 dev->node.major = dev->node.minor = 0;
370 link->dev_node = &dev->node;
375 cs_error(link, last_fn, last_ret);
380 /*======================================================================
382 After a card is removed, atmel_release() will unregister the
383 device, and release the PCMCIA configuration. If the device is
384 still open, this will be postponed until it is closed.
386 ======================================================================*/
388 static void atmel_release(struct pcmcia_device *link)
390 struct net_device *dev = ((local_info_t*)link->priv)->eth_dev;
392 DEBUG(0, "atmel_release(0x%p)\n", link);
395 stop_atmel_card(dev);
396 ((local_info_t*)link->priv)->eth_dev = NULL;
398 pcmcia_disable_device(link);
401 static int atmel_suspend(struct pcmcia_device *link)
403 local_info_t *local = link->priv;
405 netif_device_detach(local->eth_dev);
410 static int atmel_resume(struct pcmcia_device *link)
412 local_info_t *local = link->priv;
414 atmel_open(local->eth_dev);
415 netif_device_attach(local->eth_dev);
420 /*====================================================================*/
421 /* We use the driver_info field to store the correct firmware type for a card. */
423 #define PCMCIA_DEVICE_MANF_CARD_INFO(manf, card, info) { \
424 .match_flags = PCMCIA_DEV_ID_MATCH_MANF_ID| \
425 PCMCIA_DEV_ID_MATCH_CARD_ID, \
428 .driver_info = (kernel_ulong_t)(info), }
430 #define PCMCIA_DEVICE_PROD_ID12_INFO(v1, v2, vh1, vh2, info) { \
431 .match_flags = PCMCIA_DEV_ID_MATCH_PROD_ID1| \
432 PCMCIA_DEV_ID_MATCH_PROD_ID2, \
433 .prod_id = { (v1), (v2), NULL, NULL }, \
434 .prod_id_hash = { (vh1), (vh2), 0, 0 }, \
435 .driver_info = (kernel_ulong_t)(info), }
437 static struct pcmcia_device_id atmel_ids[] = {
438 PCMCIA_DEVICE_MANF_CARD_INFO(0x0101, 0x0620, ATMEL_FW_TYPE_502_3COM),
439 PCMCIA_DEVICE_MANF_CARD_INFO(0x0101, 0x0696, ATMEL_FW_TYPE_502_3COM),
440 PCMCIA_DEVICE_MANF_CARD_INFO(0x01bf, 0x3302, ATMEL_FW_TYPE_502E),
441 PCMCIA_DEVICE_MANF_CARD_INFO(0xd601, 0x0007, ATMEL_FW_TYPE_502),
442 PCMCIA_DEVICE_PROD_ID12_INFO("11WAVE", "11WP611AL-E", 0x9eb2da1f, 0xc9a0d3f9, ATMEL_FW_TYPE_502E),
443 PCMCIA_DEVICE_PROD_ID12_INFO("ATMEL", "AT76C502AR", 0xabda4164, 0x41b37e1f, ATMEL_FW_TYPE_502),
444 PCMCIA_DEVICE_PROD_ID12_INFO("ATMEL", "AT76C502AR_D", 0xabda4164, 0x3675d704, ATMEL_FW_TYPE_502D),
445 PCMCIA_DEVICE_PROD_ID12_INFO("ATMEL", "AT76C502AR_E", 0xabda4164, 0x4172e792, ATMEL_FW_TYPE_502E),
446 PCMCIA_DEVICE_PROD_ID12_INFO("ATMEL", "AT76C504_R", 0xabda4164, 0x917f3d72, ATMEL_FW_TYPE_504_2958),
447 PCMCIA_DEVICE_PROD_ID12_INFO("ATMEL", "AT76C504", 0xabda4164, 0x5040670a, ATMEL_FW_TYPE_504),
448 PCMCIA_DEVICE_PROD_ID12_INFO("ATMEL", "AT76C504A", 0xabda4164, 0xe15ed87f, ATMEL_FW_TYPE_504A_2958),
449 PCMCIA_DEVICE_PROD_ID12_INFO("BT", "Voyager 1020 Laptop Adapter", 0xae49b86a, 0x1e957cd5, ATMEL_FW_TYPE_502),
450 PCMCIA_DEVICE_PROD_ID12_INFO("CNet", "CNWLC 11Mbps Wireless PC Card V-5", 0xbc477dde, 0x502fae6b, ATMEL_FW_TYPE_502E),
451 PCMCIA_DEVICE_PROD_ID12_INFO("IEEE 802.11b", "Wireless LAN PC Card", 0x5b878724, 0x122f1df6, ATMEL_FW_TYPE_502),
452 PCMCIA_DEVICE_PROD_ID12_INFO("IEEE 802.11b", "Wireless LAN Card S", 0x5b878724, 0x5fba533a, ATMEL_FW_TYPE_504_2958),
453 PCMCIA_DEVICE_PROD_ID12_INFO("OEM", "11Mbps Wireless LAN PC Card V-3", 0xfea54c90, 0x1c5b0f68, ATMEL_FW_TYPE_502),
454 PCMCIA_DEVICE_PROD_ID12_INFO("SMC", "2632W", 0xc4f8b18b, 0x30f38774, ATMEL_FW_TYPE_502D),
455 PCMCIA_DEVICE_PROD_ID12_INFO("SMC", "2632W-V2", 0xc4f8b18b, 0x172d1377, ATMEL_FW_TYPE_502),
456 PCMCIA_DEVICE_PROD_ID12_INFO("Wireless", "PC_CARD", 0xa407ecdd, 0x119f6314, ATMEL_FW_TYPE_502D),
457 PCMCIA_DEVICE_PROD_ID12_INFO("WLAN", "802.11b PC CARD", 0x575c516c, 0xb1f6dbc4, ATMEL_FW_TYPE_502D),
458 PCMCIA_DEVICE_PROD_ID12_INFO("LG", "LW2100N", 0xb474d43a, 0x6b1fec94, ATMEL_FW_TYPE_502E),
462 MODULE_DEVICE_TABLE(pcmcia, atmel_ids);
464 static struct pcmcia_driver atmel_driver = {
465 .owner = THIS_MODULE,
469 .probe = atmel_probe,
470 .remove = atmel_detach,
471 .id_table = atmel_ids,
472 .suspend = atmel_suspend,
473 .resume = atmel_resume,
476 static int atmel_cs_init(void)
478 return pcmcia_register_driver(&atmel_driver);
481 static void atmel_cs_cleanup(void)
483 pcmcia_unregister_driver(&atmel_driver);
487 This program is free software; you can redistribute it and/or
488 modify it under the terms of the GNU General Public License
489 as published by the Free Software Foundation; either version 2
490 of the License, or (at your option) any later version.
492 This program is distributed in the hope that it will be useful,
493 but WITHOUT ANY WARRANTY; without even the implied warranty of
494 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
495 GNU General Public License for more details.
499 Redistribution and use in source and binary forms, with or without
500 modification, are permitted provided that the following conditions
503 1. Redistributions of source code must retain the above copyright
504 notice, this list of conditions and the following disclaimer.
505 2. Redistributions in binary form must reproduce the above copyright
506 notice, this list of conditions and the following disclaimer in the
507 documentation and/or other materials provided with the distribution.
508 3. The name of the author may not be used to endorse or promote
509 products derived from this software without specific prior written
512 THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
513 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
514 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
515 ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
516 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
517 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
518 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
519 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
520 STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
521 IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
522 POSSIBILITY OF SUCH DAMAGE.
525 module_init(atmel_cs_init);
526 module_exit(atmel_cs_cleanup);