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 #ifdef __IN_PCMCIA_PACKAGE__
33 #include <pcmcia/k_compat.h>
35 #include <linux/init.h>
36 #include <linux/kernel.h>
37 #include <linux/module.h>
38 #include <linux/ptrace.h>
39 #include <linux/slab.h>
40 #include <linux/string.h>
41 #include <linux/netdevice.h>
42 #include <linux/moduleparam.h>
43 #include <linux/device.h>
45 #include <pcmcia/cs_types.h>
46 #include <pcmcia/cs.h>
47 #include <pcmcia/cistpl.h>
48 #include <pcmcia/cisreg.h>
49 #include <pcmcia/ds.h>
50 #include <pcmcia/ciscode.h>
53 #include <asm/system.h>
54 #include <linux/wireless.h>
59 /*====================================================================*/
61 MODULE_AUTHOR("Simon Kelley");
62 MODULE_DESCRIPTION("Support for Atmel at76c50x 802.11 wireless ethernet cards.");
63 MODULE_LICENSE("GPL");
64 MODULE_SUPPORTED_DEVICE("Atmel at76c50x PCMCIA cards");
66 /*====================================================================*/
69 The event() function is this driver's Card Services event handler.
70 It will be called by Card Services when an appropriate card status
71 event is received. The config() and release() entry points are
72 used to configure or release a socket, in response to card
73 insertion and ejection events. They are invoked from the atmel_cs
77 static int atmel_config(struct pcmcia_device *link);
78 static void atmel_release(struct pcmcia_device *link);
81 The attach() and detach() entry points are used to create and destroy
82 "instances" of the driver, where each instance represents everything
83 needed to manage one actual PCMCIA card.
86 static void atmel_detach(struct pcmcia_device *p_dev);
89 You'll also need to prototype all the functions that will actually
90 be used to talk to your device. See 'pcmem_cs' for a good example
91 of a fully self-sufficient driver; the other drivers rely more or
92 less on other parts of the kernel.
96 A linked list of "instances" of the atmelnet device. Each actual
97 PCMCIA card corresponds to one device instance, and is described
98 by one struct pcmcia_device structure (defined in ds.h).
100 You may not want to use a linked list for this -- for example, the
101 memory card driver uses an array of struct pcmcia_device pointers, where minor
102 device numbers are used to derive the corresponding array index.
106 A driver needs to provide a dev_node_t structure for each device
107 on a card. In some cases, there is only one device per card (for
108 example, ethernet cards, modems). In other cases, there may be
109 many actual or logical devices (SCSI adapters, memory cards with
110 multiple partitions). The dev_node_t structures need to be kept
111 in a linked list starting at the 'dev' field of a struct pcmcia_device
112 structure. We allocate them in the card's private data structure,
113 because they generally shouldn't be allocated dynamically.
115 In this case, we also provide a flag to indicate if a device is
116 "stopped" due to a power management event, or card ejection. The
117 device IO routines can use a flag like this to throttle IO to a
118 card that is not ready to accept it.
121 typedef struct local_info_t {
123 struct net_device *eth_dev;
126 /*======================================================================
128 atmel_attach() creates an "instance" of the driver, allocating
129 local data structures for one device. The device is registered
132 The dev_link structure is initialized, but we don't actually
133 configure the card at this point -- we wait until we receive a
134 card insertion event.
136 ======================================================================*/
138 static int atmel_probe(struct pcmcia_device *p_dev)
142 dev_dbg(&p_dev->dev, "atmel_attach()\n");
144 /* Interrupt setup */
145 p_dev->irq.Attributes = IRQ_TYPE_DYNAMIC_SHARING;
146 p_dev->irq.IRQInfo1 = IRQ_LEVEL_ID;
147 p_dev->irq.Handler = NULL;
150 General socket configuration defaults can go here. In this
151 client, we assume very little, and rely on the CIS for almost
152 everything. In most clients, many details (i.e., number, sizes,
153 and attributes of IO windows) are fixed by the nature of the
154 device, and can be hard-wired here.
156 p_dev->conf.Attributes = 0;
157 p_dev->conf.IntType = INT_MEMORY_AND_IO;
159 /* Allocate space for private device-specific data */
160 local = kzalloc(sizeof(local_info_t), GFP_KERNEL);
162 printk(KERN_ERR "atmel_cs: no memory for new device\n");
167 return atmel_config(p_dev);
170 /*======================================================================
172 This deletes a driver "instance". The device is de-registered
173 with Card Services. If it has been released, all local data
174 structures are freed. Otherwise, the structures will be freed
175 when the device is released.
177 ======================================================================*/
179 static void atmel_detach(struct pcmcia_device *link)
181 dev_dbg(&link->dev, "atmel_detach\n");
188 /*======================================================================
190 atmel_config() is scheduled to run after a CARD_INSERTION event
191 is received, to configure the PCMCIA socket, and to make the
192 device available to the system.
194 ======================================================================*/
196 /* Call-back function to interrogate PCMCIA-specific information
197 about the current existance of the card */
198 static int card_present(void *arg)
200 struct pcmcia_device *link = (struct pcmcia_device *)arg;
202 if (pcmcia_dev_present(link))
208 static int atmel_config_check(struct pcmcia_device *p_dev,
209 cistpl_cftable_entry_t *cfg,
210 cistpl_cftable_entry_t *dflt,
217 /* Does this card need audio output? */
218 if (cfg->flags & CISTPL_CFTABLE_AUDIO) {
219 p_dev->conf.Attributes |= CONF_ENABLE_SPKR;
220 p_dev->conf.Status = CCSR_AUDIO_ENA;
223 /* Use power settings for Vcc and Vpp if present */
224 /* Note that the CIS values need to be rescaled */
225 if (cfg->vpp1.present & (1<<CISTPL_POWER_VNOM))
226 p_dev->conf.Vpp = cfg->vpp1.param[CISTPL_POWER_VNOM]/10000;
227 else if (dflt->vpp1.present & (1<<CISTPL_POWER_VNOM))
228 p_dev->conf.Vpp = dflt->vpp1.param[CISTPL_POWER_VNOM]/10000;
230 /* Do we need to allocate an interrupt? */
231 if (cfg->irq.IRQInfo1 || dflt->irq.IRQInfo1)
232 p_dev->conf.Attributes |= CONF_ENABLE_IRQ;
234 /* IO window settings */
235 p_dev->io.NumPorts1 = p_dev->io.NumPorts2 = 0;
236 if ((cfg->io.nwin > 0) || (dflt->io.nwin > 0)) {
237 cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &dflt->io;
238 p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
239 if (!(io->flags & CISTPL_IO_8BIT))
240 p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_16;
241 if (!(io->flags & CISTPL_IO_16BIT))
242 p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
243 p_dev->io.BasePort1 = io->win[0].base;
244 p_dev->io.NumPorts1 = io->win[0].len;
246 p_dev->io.Attributes2 = p_dev->io.Attributes1;
247 p_dev->io.BasePort2 = io->win[1].base;
248 p_dev->io.NumPorts2 = io->win[1].len;
252 /* This reserves IO space but doesn't actually enable it */
253 return pcmcia_request_io(p_dev, &p_dev->io);
256 static int atmel_config(struct pcmcia_device *link)
260 struct pcmcia_device_id *did;
263 did = dev_get_drvdata(&handle_to_dev(link));
265 dev_dbg(&link->dev, "atmel_config\n");
268 In this loop, we scan the CIS for configuration table entries,
269 each of which describes a valid card configuration, including
270 voltage, IO window, memory window, and interrupt settings.
272 We make no assumptions about the card to be configured: we use
273 just the information available in the CIS. In an ideal world,
274 this would work for any PCMCIA card, but it requires a complete
275 and accurate CIS. In practice, a driver usually "knows" most of
276 these things without consulting the CIS, and most client drivers
277 will only use the CIS to fill in implementation-defined details.
279 if (pcmcia_loop_config(link, atmel_config_check, NULL))
283 Allocate an interrupt line. Note that this does not assign a
284 handler to the interrupt, unless the 'Handler' member of the
285 irq structure is initialized.
287 if (link->conf.Attributes & CONF_ENABLE_IRQ) {
288 ret = pcmcia_request_irq(link, &link->irq);
294 This actually configures the PCMCIA socket -- setting up
295 the I/O windows and the interrupt mapping, and putting the
296 card and host interface into "Memory and IO" mode.
298 ret = pcmcia_request_configuration(link, &link->conf);
302 if (link->irq.AssignedIRQ == 0) {
304 "atmel: cannot assign IRQ: check that CONFIG_ISA is set in kernel config.");
308 ((local_info_t*)link->priv)->eth_dev =
309 init_atmel_card(link->irq.AssignedIRQ,
311 did ? did->driver_info : ATMEL_FW_TYPE_NONE,
312 &handle_to_dev(link),
315 if (!((local_info_t*)link->priv)->eth_dev)
320 At this point, the dev_node_t structure(s) need to be
321 initialized and arranged in a linked list at link->dev_node.
323 strcpy(dev->node.dev_name, ((local_info_t*)link->priv)->eth_dev->name );
324 dev->node.major = dev->node.minor = 0;
325 link->dev_node = &dev->node;
334 /*======================================================================
336 After a card is removed, atmel_release() will unregister the
337 device, and release the PCMCIA configuration. If the device is
338 still open, this will be postponed until it is closed.
340 ======================================================================*/
342 static void atmel_release(struct pcmcia_device *link)
344 struct net_device *dev = ((local_info_t*)link->priv)->eth_dev;
346 dev_dbg(&link->dev, "atmel_release\n");
349 stop_atmel_card(dev);
350 ((local_info_t*)link->priv)->eth_dev = NULL;
352 pcmcia_disable_device(link);
355 static int atmel_suspend(struct pcmcia_device *link)
357 local_info_t *local = link->priv;
359 netif_device_detach(local->eth_dev);
364 static int atmel_resume(struct pcmcia_device *link)
366 local_info_t *local = link->priv;
368 atmel_open(local->eth_dev);
369 netif_device_attach(local->eth_dev);
374 /*====================================================================*/
375 /* We use the driver_info field to store the correct firmware type for a card. */
377 #define PCMCIA_DEVICE_MANF_CARD_INFO(manf, card, info) { \
378 .match_flags = PCMCIA_DEV_ID_MATCH_MANF_ID| \
379 PCMCIA_DEV_ID_MATCH_CARD_ID, \
382 .driver_info = (kernel_ulong_t)(info), }
384 #define PCMCIA_DEVICE_PROD_ID12_INFO(v1, v2, vh1, vh2, info) { \
385 .match_flags = PCMCIA_DEV_ID_MATCH_PROD_ID1| \
386 PCMCIA_DEV_ID_MATCH_PROD_ID2, \
387 .prod_id = { (v1), (v2), NULL, NULL }, \
388 .prod_id_hash = { (vh1), (vh2), 0, 0 }, \
389 .driver_info = (kernel_ulong_t)(info), }
391 static struct pcmcia_device_id atmel_ids[] = {
392 PCMCIA_DEVICE_MANF_CARD_INFO(0x0101, 0x0620, ATMEL_FW_TYPE_502_3COM),
393 PCMCIA_DEVICE_MANF_CARD_INFO(0x0101, 0x0696, ATMEL_FW_TYPE_502_3COM),
394 PCMCIA_DEVICE_MANF_CARD_INFO(0x01bf, 0x3302, ATMEL_FW_TYPE_502E),
395 PCMCIA_DEVICE_MANF_CARD_INFO(0xd601, 0x0007, ATMEL_FW_TYPE_502),
396 PCMCIA_DEVICE_PROD_ID12_INFO("11WAVE", "11WP611AL-E", 0x9eb2da1f, 0xc9a0d3f9, ATMEL_FW_TYPE_502E),
397 PCMCIA_DEVICE_PROD_ID12_INFO("ATMEL", "AT76C502AR", 0xabda4164, 0x41b37e1f, ATMEL_FW_TYPE_502),
398 PCMCIA_DEVICE_PROD_ID12_INFO("ATMEL", "AT76C502AR_D", 0xabda4164, 0x3675d704, ATMEL_FW_TYPE_502D),
399 PCMCIA_DEVICE_PROD_ID12_INFO("ATMEL", "AT76C502AR_E", 0xabda4164, 0x4172e792, ATMEL_FW_TYPE_502E),
400 PCMCIA_DEVICE_PROD_ID12_INFO("ATMEL", "AT76C504_R", 0xabda4164, 0x917f3d72, ATMEL_FW_TYPE_504_2958),
401 PCMCIA_DEVICE_PROD_ID12_INFO("ATMEL", "AT76C504", 0xabda4164, 0x5040670a, ATMEL_FW_TYPE_504),
402 PCMCIA_DEVICE_PROD_ID12_INFO("ATMEL", "AT76C504A", 0xabda4164, 0xe15ed87f, ATMEL_FW_TYPE_504A_2958),
403 PCMCIA_DEVICE_PROD_ID12_INFO("BT", "Voyager 1020 Laptop Adapter", 0xae49b86a, 0x1e957cd5, ATMEL_FW_TYPE_502),
404 PCMCIA_DEVICE_PROD_ID12_INFO("CNet", "CNWLC 11Mbps Wireless PC Card V-5", 0xbc477dde, 0x502fae6b, ATMEL_FW_TYPE_502E),
405 PCMCIA_DEVICE_PROD_ID12_INFO("IEEE 802.11b", "Wireless LAN PC Card", 0x5b878724, 0x122f1df6, ATMEL_FW_TYPE_502),
406 PCMCIA_DEVICE_PROD_ID12_INFO("IEEE 802.11b", "Wireless LAN Card S", 0x5b878724, 0x5fba533a, ATMEL_FW_TYPE_504_2958),
407 PCMCIA_DEVICE_PROD_ID12_INFO("OEM", "11Mbps Wireless LAN PC Card V-3", 0xfea54c90, 0x1c5b0f68, ATMEL_FW_TYPE_502),
408 PCMCIA_DEVICE_PROD_ID12_INFO("SMC", "2632W", 0xc4f8b18b, 0x30f38774, ATMEL_FW_TYPE_502D),
409 PCMCIA_DEVICE_PROD_ID12_INFO("SMC", "2632W-V2", 0xc4f8b18b, 0x172d1377, ATMEL_FW_TYPE_502),
410 PCMCIA_DEVICE_PROD_ID12_INFO("Wireless", "PC_CARD", 0xa407ecdd, 0x119f6314, ATMEL_FW_TYPE_502D),
411 PCMCIA_DEVICE_PROD_ID12_INFO("WLAN", "802.11b PC CARD", 0x575c516c, 0xb1f6dbc4, ATMEL_FW_TYPE_502D),
412 PCMCIA_DEVICE_PROD_ID12_INFO("LG", "LW2100N", 0xb474d43a, 0x6b1fec94, ATMEL_FW_TYPE_502E),
416 MODULE_DEVICE_TABLE(pcmcia, atmel_ids);
418 static struct pcmcia_driver atmel_driver = {
419 .owner = THIS_MODULE,
423 .probe = atmel_probe,
424 .remove = atmel_detach,
425 .id_table = atmel_ids,
426 .suspend = atmel_suspend,
427 .resume = atmel_resume,
430 static int atmel_cs_init(void)
432 return pcmcia_register_driver(&atmel_driver);
435 static void atmel_cs_cleanup(void)
437 pcmcia_unregister_driver(&atmel_driver);
441 This program is free software; you can redistribute it and/or
442 modify it under the terms of the GNU General Public License
443 as published by the Free Software Foundation; either version 2
444 of the License, or (at your option) any later version.
446 This program is distributed in the hope that it will be useful,
447 but WITHOUT ANY WARRANTY; without even the implied warranty of
448 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
449 GNU General Public License for more details.
453 Redistribution and use in source and binary forms, with or without
454 modification, are permitted provided that the following conditions
457 1. Redistributions of source code must retain the above copyright
458 notice, this list of conditions and the following disclaimer.
459 2. Redistributions in binary form must reproduce the above copyright
460 notice, this list of conditions and the following disclaimer in the
461 documentation and/or other materials provided with the distribution.
462 3. The name of the author may not be used to endorse or promote
463 products derived from this software without specific prior written
466 THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
467 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
468 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
469 ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
470 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
471 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
472 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
473 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
474 STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
475 IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
476 POSSIBILITY OF SUCH DAMAGE.
479 module_init(atmel_cs_init);
480 module_exit(atmel_cs_cleanup);