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");
145 General socket configuration defaults can go here. In this
146 client, we assume very little, and rely on the CIS for almost
147 everything. In most clients, many details (i.e., number, sizes,
148 and attributes of IO windows) are fixed by the nature of the
149 device, and can be hard-wired here.
151 p_dev->conf.Attributes = 0;
152 p_dev->conf.IntType = INT_MEMORY_AND_IO;
154 /* Allocate space for private device-specific data */
155 local = kzalloc(sizeof(local_info_t), GFP_KERNEL);
157 printk(KERN_ERR "atmel_cs: no memory for new device\n");
162 return atmel_config(p_dev);
165 /*======================================================================
167 This deletes a driver "instance". The device is de-registered
168 with Card Services. If it has been released, all local data
169 structures are freed. Otherwise, the structures will be freed
170 when the device is released.
172 ======================================================================*/
174 static void atmel_detach(struct pcmcia_device *link)
176 dev_dbg(&link->dev, "atmel_detach\n");
183 /*======================================================================
185 atmel_config() is scheduled to run after a CARD_INSERTION event
186 is received, to configure the PCMCIA socket, and to make the
187 device available to the system.
189 ======================================================================*/
191 /* Call-back function to interrogate PCMCIA-specific information
192 about the current existance of the card */
193 static int card_present(void *arg)
195 struct pcmcia_device *link = (struct pcmcia_device *)arg;
197 if (pcmcia_dev_present(link))
203 static int atmel_config_check(struct pcmcia_device *p_dev,
204 cistpl_cftable_entry_t *cfg,
205 cistpl_cftable_entry_t *dflt,
212 /* Does this card need audio output? */
213 if (cfg->flags & CISTPL_CFTABLE_AUDIO) {
214 p_dev->conf.Attributes |= CONF_ENABLE_SPKR;
215 p_dev->conf.Status = CCSR_AUDIO_ENA;
218 /* Use power settings for Vcc and Vpp if present */
219 /* Note that the CIS values need to be rescaled */
220 if (cfg->vpp1.present & (1<<CISTPL_POWER_VNOM))
221 p_dev->conf.Vpp = cfg->vpp1.param[CISTPL_POWER_VNOM]/10000;
222 else if (dflt->vpp1.present & (1<<CISTPL_POWER_VNOM))
223 p_dev->conf.Vpp = dflt->vpp1.param[CISTPL_POWER_VNOM]/10000;
225 p_dev->conf.Attributes |= CONF_ENABLE_IRQ;
227 /* IO window settings */
228 p_dev->io.NumPorts1 = p_dev->io.NumPorts2 = 0;
229 if ((cfg->io.nwin > 0) || (dflt->io.nwin > 0)) {
230 cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &dflt->io;
231 p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
232 if (!(io->flags & CISTPL_IO_8BIT))
233 p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_16;
234 if (!(io->flags & CISTPL_IO_16BIT))
235 p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
236 p_dev->io.BasePort1 = io->win[0].base;
237 p_dev->io.NumPorts1 = io->win[0].len;
239 p_dev->io.Attributes2 = p_dev->io.Attributes1;
240 p_dev->io.BasePort2 = io->win[1].base;
241 p_dev->io.NumPorts2 = io->win[1].len;
245 /* This reserves IO space but doesn't actually enable it */
246 return pcmcia_request_io(p_dev, &p_dev->io);
249 static int atmel_config(struct pcmcia_device *link)
253 struct pcmcia_device_id *did;
256 did = dev_get_drvdata(&link->dev);
258 dev_dbg(&link->dev, "atmel_config\n");
261 In this loop, we scan the CIS for configuration table entries,
262 each of which describes a valid card configuration, including
263 voltage, IO window, memory window, and interrupt settings.
265 We make no assumptions about the card to be configured: we use
266 just the information available in the CIS. In an ideal world,
267 this would work for any PCMCIA card, but it requires a complete
268 and accurate CIS. In practice, a driver usually "knows" most of
269 these things without consulting the CIS, and most client drivers
270 will only use the CIS to fill in implementation-defined details.
272 if (pcmcia_loop_config(link, atmel_config_check, NULL))
276 dev_err(&link->dev, "atmel: cannot assign IRQ: check that CONFIG_ISA is set in kernel config.");
281 This actually configures the PCMCIA socket -- setting up
282 the I/O windows and the interrupt mapping, and putting the
283 card and host interface into "Memory and IO" mode.
285 ret = pcmcia_request_configuration(link, &link->conf);
289 ((local_info_t*)link->priv)->eth_dev =
290 init_atmel_card(link->irq,
292 did ? did->driver_info : ATMEL_FW_TYPE_NONE,
296 if (!((local_info_t*)link->priv)->eth_dev)
301 At this point, the dev_node_t structure(s) need to be
302 initialized and arranged in a linked list at link->dev_node.
304 strcpy(dev->node.dev_name, ((local_info_t*)link->priv)->eth_dev->name );
305 dev->node.major = dev->node.minor = 0;
306 link->dev_node = &dev->node;
315 /*======================================================================
317 After a card is removed, atmel_release() will unregister the
318 device, and release the PCMCIA configuration. If the device is
319 still open, this will be postponed until it is closed.
321 ======================================================================*/
323 static void atmel_release(struct pcmcia_device *link)
325 struct net_device *dev = ((local_info_t*)link->priv)->eth_dev;
327 dev_dbg(&link->dev, "atmel_release\n");
330 stop_atmel_card(dev);
331 ((local_info_t*)link->priv)->eth_dev = NULL;
333 pcmcia_disable_device(link);
336 static int atmel_suspend(struct pcmcia_device *link)
338 local_info_t *local = link->priv;
340 netif_device_detach(local->eth_dev);
345 static int atmel_resume(struct pcmcia_device *link)
347 local_info_t *local = link->priv;
349 atmel_open(local->eth_dev);
350 netif_device_attach(local->eth_dev);
355 /*====================================================================*/
356 /* We use the driver_info field to store the correct firmware type for a card. */
358 #define PCMCIA_DEVICE_MANF_CARD_INFO(manf, card, info) { \
359 .match_flags = PCMCIA_DEV_ID_MATCH_MANF_ID| \
360 PCMCIA_DEV_ID_MATCH_CARD_ID, \
363 .driver_info = (kernel_ulong_t)(info), }
365 #define PCMCIA_DEVICE_PROD_ID12_INFO(v1, v2, vh1, vh2, info) { \
366 .match_flags = PCMCIA_DEV_ID_MATCH_PROD_ID1| \
367 PCMCIA_DEV_ID_MATCH_PROD_ID2, \
368 .prod_id = { (v1), (v2), NULL, NULL }, \
369 .prod_id_hash = { (vh1), (vh2), 0, 0 }, \
370 .driver_info = (kernel_ulong_t)(info), }
372 static struct pcmcia_device_id atmel_ids[] = {
373 PCMCIA_DEVICE_MANF_CARD_INFO(0x0101, 0x0620, ATMEL_FW_TYPE_502_3COM),
374 PCMCIA_DEVICE_MANF_CARD_INFO(0x0101, 0x0696, ATMEL_FW_TYPE_502_3COM),
375 PCMCIA_DEVICE_MANF_CARD_INFO(0x01bf, 0x3302, ATMEL_FW_TYPE_502E),
376 PCMCIA_DEVICE_MANF_CARD_INFO(0xd601, 0x0007, ATMEL_FW_TYPE_502),
377 PCMCIA_DEVICE_PROD_ID12_INFO("11WAVE", "11WP611AL-E", 0x9eb2da1f, 0xc9a0d3f9, ATMEL_FW_TYPE_502E),
378 PCMCIA_DEVICE_PROD_ID12_INFO("ATMEL", "AT76C502AR", 0xabda4164, 0x41b37e1f, ATMEL_FW_TYPE_502),
379 PCMCIA_DEVICE_PROD_ID12_INFO("ATMEL", "AT76C502AR_D", 0xabda4164, 0x3675d704, ATMEL_FW_TYPE_502D),
380 PCMCIA_DEVICE_PROD_ID12_INFO("ATMEL", "AT76C502AR_E", 0xabda4164, 0x4172e792, ATMEL_FW_TYPE_502E),
381 PCMCIA_DEVICE_PROD_ID12_INFO("ATMEL", "AT76C504_R", 0xabda4164, 0x917f3d72, ATMEL_FW_TYPE_504_2958),
382 PCMCIA_DEVICE_PROD_ID12_INFO("ATMEL", "AT76C504", 0xabda4164, 0x5040670a, ATMEL_FW_TYPE_504),
383 PCMCIA_DEVICE_PROD_ID12_INFO("ATMEL", "AT76C504A", 0xabda4164, 0xe15ed87f, ATMEL_FW_TYPE_504A_2958),
384 PCMCIA_DEVICE_PROD_ID12_INFO("BT", "Voyager 1020 Laptop Adapter", 0xae49b86a, 0x1e957cd5, ATMEL_FW_TYPE_502),
385 PCMCIA_DEVICE_PROD_ID12_INFO("CNet", "CNWLC 11Mbps Wireless PC Card V-5", 0xbc477dde, 0x502fae6b, ATMEL_FW_TYPE_502E),
386 PCMCIA_DEVICE_PROD_ID12_INFO("IEEE 802.11b", "Wireless LAN PC Card", 0x5b878724, 0x122f1df6, ATMEL_FW_TYPE_502),
387 PCMCIA_DEVICE_PROD_ID12_INFO("IEEE 802.11b", "Wireless LAN Card S", 0x5b878724, 0x5fba533a, ATMEL_FW_TYPE_504_2958),
388 PCMCIA_DEVICE_PROD_ID12_INFO("OEM", "11Mbps Wireless LAN PC Card V-3", 0xfea54c90, 0x1c5b0f68, ATMEL_FW_TYPE_502),
389 PCMCIA_DEVICE_PROD_ID12_INFO("SMC", "2632W", 0xc4f8b18b, 0x30f38774, ATMEL_FW_TYPE_502D),
390 PCMCIA_DEVICE_PROD_ID12_INFO("SMC", "2632W-V2", 0xc4f8b18b, 0x172d1377, ATMEL_FW_TYPE_502),
391 PCMCIA_DEVICE_PROD_ID12_INFO("Wireless", "PC_CARD", 0xa407ecdd, 0x119f6314, ATMEL_FW_TYPE_502D),
392 PCMCIA_DEVICE_PROD_ID12_INFO("WLAN", "802.11b PC CARD", 0x575c516c, 0xb1f6dbc4, ATMEL_FW_TYPE_502D),
393 PCMCIA_DEVICE_PROD_ID12_INFO("LG", "LW2100N", 0xb474d43a, 0x6b1fec94, ATMEL_FW_TYPE_502E),
397 MODULE_DEVICE_TABLE(pcmcia, atmel_ids);
399 static struct pcmcia_driver atmel_driver = {
400 .owner = THIS_MODULE,
404 .probe = atmel_probe,
405 .remove = atmel_detach,
406 .id_table = atmel_ids,
407 .suspend = atmel_suspend,
408 .resume = atmel_resume,
411 static int atmel_cs_init(void)
413 return pcmcia_register_driver(&atmel_driver);
416 static void atmel_cs_cleanup(void)
418 pcmcia_unregister_driver(&atmel_driver);
422 This program is free software; you can redistribute it and/or
423 modify it under the terms of the GNU General Public License
424 as published by the Free Software Foundation; either version 2
425 of the License, or (at your option) any later version.
427 This program is distributed in the hope that it will be useful,
428 but WITHOUT ANY WARRANTY; without even the implied warranty of
429 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
430 GNU General Public License for more details.
434 Redistribution and use in source and binary forms, with or without
435 modification, are permitted provided that the following conditions
438 1. Redistributions of source code must retain the above copyright
439 notice, this list of conditions and the following disclaimer.
440 2. Redistributions in binary form must reproduce the above copyright
441 notice, this list of conditions and the following disclaimer in the
442 documentation and/or other materials provided with the distribution.
443 3. The name of the author may not be used to endorse or promote
444 products derived from this software without specific prior written
447 THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
448 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
449 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
450 ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
451 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
452 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
453 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
454 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
455 STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
456 IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
457 POSSIBILITY OF SUCH DAMAGE.
460 module_init(atmel_cs_init);
461 module_exit(atmel_cs_cleanup);