Merge git://git.kernel.org/pub/scm/linux/kernel/git/brodo/pcmcia-2.6
[linux-2.6.git] / drivers / net / wireless / atmel_cs.c
1 /*** -*- linux-c -*- **********************************************************
2
3      Driver for Atmel at76c502 at76c504 and at76c506 wireless cards.
4
5         Copyright 2000-2001 ATMEL Corporation.
6         Copyright 2003 Simon Kelley.
7
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.
12
13     For all queries about this code, please contact the current author,
14     Simon Kelley <simon@thekelleys.org.uk> and not Atmel Corporation.
15
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.
20
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.
25
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
29
30 ******************************************************************************/
31
32 #ifdef __IN_PCMCIA_PACKAGE__
33 #include <pcmcia/k_compat.h>
34 #endif
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>
44
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>
51
52 #include <asm/io.h>
53 #include <asm/system.h>
54 #include <linux/wireless.h>
55
56 #include "atmel.h"
57
58 /*
59    All the PCMCIA modules use PCMCIA_DEBUG to control debugging.  If
60    you do not define PCMCIA_DEBUG at all, all the debug code will be
61    left out.  If you compile with PCMCIA_DEBUG=0, the debug code will
62    be present but disabled -- but it can then be enabled for specific
63    modules at load time with a 'pc_debug=#' option to insmod.
64 */
65
66 #ifdef PCMCIA_DEBUG
67 static int pc_debug = PCMCIA_DEBUG;
68 module_param(pc_debug, int, 0);
69 static char *version = "$Revision: 1.2 $";
70 #define DEBUG(n, args...) if (pc_debug>(n)) printk(KERN_DEBUG args);
71 #else
72 #define DEBUG(n, args...)
73 #endif
74
75 /*====================================================================*/
76
77 MODULE_AUTHOR("Simon Kelley");
78 MODULE_DESCRIPTION("Support for Atmel at76c50x 802.11 wireless ethernet cards.");
79 MODULE_LICENSE("GPL");
80 MODULE_SUPPORTED_DEVICE("Atmel at76c50x PCMCIA cards");
81
82 /*====================================================================*/
83
84 /*
85    The event() function is this driver's Card Services event handler.
86    It will be called by Card Services when an appropriate card status
87    event is received.  The config() and release() entry points are
88    used to configure or release a socket, in response to card
89    insertion and ejection events.  They are invoked from the atmel_cs
90    event handler.
91 */
92
93 static int atmel_config(struct pcmcia_device *link);
94 static void atmel_release(struct pcmcia_device *link);
95
96 /*
97    The attach() and detach() entry points are used to create and destroy
98    "instances" of the driver, where each instance represents everything
99    needed to manage one actual PCMCIA card.
100 */
101
102 static void atmel_detach(struct pcmcia_device *p_dev);
103
104 /*
105    You'll also need to prototype all the functions that will actually
106    be used to talk to your device.  See 'pcmem_cs' for a good example
107    of a fully self-sufficient driver; the other drivers rely more or
108    less on other parts of the kernel.
109 */
110
111 /*
112    A linked list of "instances" of the  atmelnet device.  Each actual
113    PCMCIA card corresponds to one device instance, and is described
114    by one struct pcmcia_device structure (defined in ds.h).
115
116    You may not want to use a linked list for this -- for example, the
117    memory card driver uses an array of struct pcmcia_device pointers, where minor
118    device numbers are used to derive the corresponding array index.
119 */
120
121 /*
122    A driver needs to provide a dev_node_t structure for each device
123    on a card.  In some cases, there is only one device per card (for
124    example, ethernet cards, modems).  In other cases, there may be
125    many actual or logical devices (SCSI adapters, memory cards with
126    multiple partitions).  The dev_node_t structures need to be kept
127    in a linked list starting at the 'dev' field of a struct pcmcia_device
128    structure.  We allocate them in the card's private data structure,
129    because they generally shouldn't be allocated dynamically.
130
131    In this case, we also provide a flag to indicate if a device is
132    "stopped" due to a power management event, or card ejection.  The
133    device IO routines can use a flag like this to throttle IO to a
134    card that is not ready to accept it.
135 */
136
137 typedef struct local_info_t {
138         dev_node_t      node;
139         struct net_device *eth_dev;
140 } local_info_t;
141
142 /*======================================================================
143
144   atmel_attach() creates an "instance" of the driver, allocating
145   local data structures for one device.  The device is registered
146   with Card Services.
147
148   The dev_link structure is initialized, but we don't actually
149   configure the card at this point -- we wait until we receive a
150   card insertion event.
151
152   ======================================================================*/
153
154 static int atmel_probe(struct pcmcia_device *p_dev)
155 {
156         local_info_t *local;
157
158         DEBUG(0, "atmel_attach()\n");
159
160         /* Interrupt setup */
161         p_dev->irq.Attributes = IRQ_TYPE_DYNAMIC_SHARING;
162         p_dev->irq.IRQInfo1 = IRQ_LEVEL_ID;
163         p_dev->irq.Handler = NULL;
164
165         /*
166           General socket configuration defaults can go here.  In this
167           client, we assume very little, and rely on the CIS for almost
168           everything.  In most clients, many details (i.e., number, sizes,
169           and attributes of IO windows) are fixed by the nature of the
170           device, and can be hard-wired here.
171         */
172         p_dev->conf.Attributes = 0;
173         p_dev->conf.IntType = INT_MEMORY_AND_IO;
174
175         /* Allocate space for private device-specific data */
176         local = kzalloc(sizeof(local_info_t), GFP_KERNEL);
177         if (!local) {
178                 printk(KERN_ERR "atmel_cs: no memory for new device\n");
179                 return -ENOMEM;
180         }
181         p_dev->priv = local;
182
183         return atmel_config(p_dev);
184 } /* atmel_attach */
185
186 /*======================================================================
187
188   This deletes a driver "instance".  The device is de-registered
189   with Card Services.  If it has been released, all local data
190   structures are freed.  Otherwise, the structures will be freed
191   when the device is released.
192
193   ======================================================================*/
194
195 static void atmel_detach(struct pcmcia_device *link)
196 {
197         DEBUG(0, "atmel_detach(0x%p)\n", link);
198
199         atmel_release(link);
200
201         kfree(link->priv);
202 }
203
204 /*======================================================================
205
206   atmel_config() is scheduled to run after a CARD_INSERTION event
207   is received, to configure the PCMCIA socket, and to make the
208   device available to the system.
209
210   ======================================================================*/
211
212 #define CS_CHECK(fn, ret) \
213 do { last_fn = (fn); if ((last_ret = (ret)) != 0) goto cs_failed; } while (0)
214
215 /* Call-back function to interrogate PCMCIA-specific information
216    about the current existance of the card */
217 static int card_present(void *arg)
218 {
219         struct pcmcia_device *link = (struct pcmcia_device *)arg;
220
221         if (pcmcia_dev_present(link))
222                 return 1;
223
224         return 0;
225 }
226
227 static int atmel_config_check(struct pcmcia_device *p_dev,
228                               cistpl_cftable_entry_t *cfg,
229                               cistpl_cftable_entry_t *dflt,
230                               unsigned int vcc,
231                               void *priv_data)
232 {
233         if (cfg->index == 0)
234                 return -ENODEV;
235
236         /* Does this card need audio output? */
237         if (cfg->flags & CISTPL_CFTABLE_AUDIO) {
238                 p_dev->conf.Attributes |= CONF_ENABLE_SPKR;
239                 p_dev->conf.Status = CCSR_AUDIO_ENA;
240         }
241
242         /* Use power settings for Vcc and Vpp if present */
243         /*  Note that the CIS values need to be rescaled */
244         if (cfg->vpp1.present & (1<<CISTPL_POWER_VNOM))
245                 p_dev->conf.Vpp = cfg->vpp1.param[CISTPL_POWER_VNOM]/10000;
246         else if (dflt->vpp1.present & (1<<CISTPL_POWER_VNOM))
247                 p_dev->conf.Vpp = dflt->vpp1.param[CISTPL_POWER_VNOM]/10000;
248
249         /* Do we need to allocate an interrupt? */
250         if (cfg->irq.IRQInfo1 || dflt->irq.IRQInfo1)
251                 p_dev->conf.Attributes |= CONF_ENABLE_IRQ;
252
253         /* IO window settings */
254         p_dev->io.NumPorts1 = p_dev->io.NumPorts2 = 0;
255         if ((cfg->io.nwin > 0) || (dflt->io.nwin > 0)) {
256                 cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &dflt->io;
257                 p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
258                 if (!(io->flags & CISTPL_IO_8BIT))
259                         p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_16;
260                 if (!(io->flags & CISTPL_IO_16BIT))
261                         p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
262                 p_dev->io.BasePort1 = io->win[0].base;
263                 p_dev->io.NumPorts1 = io->win[0].len;
264                 if (io->nwin > 1) {
265                         p_dev->io.Attributes2 = p_dev->io.Attributes1;
266                         p_dev->io.BasePort2 = io->win[1].base;
267                         p_dev->io.NumPorts2 = io->win[1].len;
268                 }
269         }
270
271         /* This reserves IO space but doesn't actually enable it */
272         return pcmcia_request_io(p_dev, &p_dev->io);
273 }
274
275 static int atmel_config(struct pcmcia_device *link)
276 {
277         local_info_t *dev;
278         int last_fn, last_ret;
279         struct pcmcia_device_id *did;
280
281         dev = link->priv;
282         did = handle_to_dev(link).driver_data;
283
284         DEBUG(0, "atmel_config(0x%p)\n", link);
285
286         /*
287           In this loop, we scan the CIS for configuration table entries,
288           each of which describes a valid card configuration, including
289           voltage, IO window, memory window, and interrupt settings.
290
291           We make no assumptions about the card to be configured: we use
292           just the information available in the CIS.  In an ideal world,
293           this would work for any PCMCIA card, but it requires a complete
294           and accurate CIS.  In practice, a driver usually "knows" most of
295           these things without consulting the CIS, and most client drivers
296           will only use the CIS to fill in implementation-defined details.
297         */
298         if (pcmcia_loop_config(link, atmel_config_check, NULL))
299                 goto failed;
300
301         /*
302           Allocate an interrupt line.  Note that this does not assign a
303           handler to the interrupt, unless the 'Handler' member of the
304           irq structure is initialized.
305         */
306         if (link->conf.Attributes & CONF_ENABLE_IRQ)
307                 CS_CHECK(RequestIRQ, pcmcia_request_irq(link, &link->irq));
308
309         /*
310           This actually configures the PCMCIA socket -- setting up
311           the I/O windows and the interrupt mapping, and putting the
312           card and host interface into "Memory and IO" mode.
313         */
314         CS_CHECK(RequestConfiguration, pcmcia_request_configuration(link, &link->conf));
315
316         if (link->irq.AssignedIRQ == 0) {
317                 printk(KERN_ALERT
318                        "atmel: cannot assign IRQ: check that CONFIG_ISA is set in kernel config.");
319                 goto cs_failed;
320         }
321
322         ((local_info_t*)link->priv)->eth_dev =
323                 init_atmel_card(link->irq.AssignedIRQ,
324                                 link->io.BasePort1,
325                                 did ? did->driver_info : ATMEL_FW_TYPE_NONE,
326                                 &handle_to_dev(link),
327                                 card_present,
328                                 link);
329         if (!((local_info_t*)link->priv)->eth_dev)
330                         goto cs_failed;
331
332
333         /*
334           At this point, the dev_node_t structure(s) need to be
335           initialized and arranged in a linked list at link->dev_node.
336         */
337         strcpy(dev->node.dev_name, ((local_info_t*)link->priv)->eth_dev->name );
338         dev->node.major = dev->node.minor = 0;
339         link->dev_node = &dev->node;
340
341         return 0;
342
343  cs_failed:
344         cs_error(link, last_fn, last_ret);
345  failed:
346         atmel_release(link);
347         return -ENODEV;
348 }
349
350 /*======================================================================
351
352   After a card is removed, atmel_release() will unregister the
353   device, and release the PCMCIA configuration.  If the device is
354   still open, this will be postponed until it is closed.
355
356   ======================================================================*/
357
358 static void atmel_release(struct pcmcia_device *link)
359 {
360         struct net_device *dev = ((local_info_t*)link->priv)->eth_dev;
361
362         DEBUG(0, "atmel_release(0x%p)\n", link);
363
364         if (dev)
365                 stop_atmel_card(dev);
366         ((local_info_t*)link->priv)->eth_dev = NULL;
367
368         pcmcia_disable_device(link);
369 }
370
371 static int atmel_suspend(struct pcmcia_device *link)
372 {
373         local_info_t *local = link->priv;
374
375         netif_device_detach(local->eth_dev);
376
377         return 0;
378 }
379
380 static int atmel_resume(struct pcmcia_device *link)
381 {
382         local_info_t *local = link->priv;
383
384         atmel_open(local->eth_dev);
385         netif_device_attach(local->eth_dev);
386
387         return 0;
388 }
389
390 /*====================================================================*/
391 /* We use the driver_info field to store the correct firmware type for a card. */
392
393 #define PCMCIA_DEVICE_MANF_CARD_INFO(manf, card, info) { \
394         .match_flags = PCMCIA_DEV_ID_MATCH_MANF_ID| \
395                         PCMCIA_DEV_ID_MATCH_CARD_ID, \
396         .manf_id = (manf), \
397         .card_id = (card), \
398         .driver_info = (kernel_ulong_t)(info), }
399
400 #define PCMCIA_DEVICE_PROD_ID12_INFO(v1, v2, vh1, vh2, info) { \
401         .match_flags = PCMCIA_DEV_ID_MATCH_PROD_ID1| \
402                         PCMCIA_DEV_ID_MATCH_PROD_ID2, \
403         .prod_id = { (v1), (v2), NULL, NULL }, \
404         .prod_id_hash = { (vh1), (vh2), 0, 0 }, \
405         .driver_info = (kernel_ulong_t)(info), }
406
407 static struct pcmcia_device_id atmel_ids[] = {
408         PCMCIA_DEVICE_MANF_CARD_INFO(0x0101, 0x0620, ATMEL_FW_TYPE_502_3COM),
409         PCMCIA_DEVICE_MANF_CARD_INFO(0x0101, 0x0696, ATMEL_FW_TYPE_502_3COM),
410         PCMCIA_DEVICE_MANF_CARD_INFO(0x01bf, 0x3302, ATMEL_FW_TYPE_502E),
411         PCMCIA_DEVICE_MANF_CARD_INFO(0xd601, 0x0007, ATMEL_FW_TYPE_502),
412         PCMCIA_DEVICE_PROD_ID12_INFO("11WAVE", "11WP611AL-E", 0x9eb2da1f, 0xc9a0d3f9, ATMEL_FW_TYPE_502E),
413         PCMCIA_DEVICE_PROD_ID12_INFO("ATMEL", "AT76C502AR", 0xabda4164, 0x41b37e1f, ATMEL_FW_TYPE_502),
414         PCMCIA_DEVICE_PROD_ID12_INFO("ATMEL", "AT76C502AR_D", 0xabda4164, 0x3675d704, ATMEL_FW_TYPE_502D),
415         PCMCIA_DEVICE_PROD_ID12_INFO("ATMEL", "AT76C502AR_E", 0xabda4164, 0x4172e792, ATMEL_FW_TYPE_502E),
416         PCMCIA_DEVICE_PROD_ID12_INFO("ATMEL", "AT76C504_R", 0xabda4164, 0x917f3d72, ATMEL_FW_TYPE_504_2958),
417         PCMCIA_DEVICE_PROD_ID12_INFO("ATMEL", "AT76C504", 0xabda4164, 0x5040670a, ATMEL_FW_TYPE_504),
418         PCMCIA_DEVICE_PROD_ID12_INFO("ATMEL", "AT76C504A", 0xabda4164, 0xe15ed87f, ATMEL_FW_TYPE_504A_2958),
419         PCMCIA_DEVICE_PROD_ID12_INFO("BT", "Voyager 1020 Laptop Adapter", 0xae49b86a, 0x1e957cd5, ATMEL_FW_TYPE_502),
420         PCMCIA_DEVICE_PROD_ID12_INFO("CNet", "CNWLC 11Mbps Wireless PC Card V-5", 0xbc477dde, 0x502fae6b, ATMEL_FW_TYPE_502E),
421         PCMCIA_DEVICE_PROD_ID12_INFO("IEEE 802.11b", "Wireless LAN PC Card", 0x5b878724, 0x122f1df6, ATMEL_FW_TYPE_502),
422         PCMCIA_DEVICE_PROD_ID12_INFO("IEEE 802.11b", "Wireless LAN Card S", 0x5b878724, 0x5fba533a, ATMEL_FW_TYPE_504_2958),
423         PCMCIA_DEVICE_PROD_ID12_INFO("OEM", "11Mbps Wireless LAN PC Card V-3", 0xfea54c90, 0x1c5b0f68, ATMEL_FW_TYPE_502),
424         PCMCIA_DEVICE_PROD_ID12_INFO("SMC", "2632W", 0xc4f8b18b, 0x30f38774, ATMEL_FW_TYPE_502D),
425         PCMCIA_DEVICE_PROD_ID12_INFO("SMC", "2632W-V2", 0xc4f8b18b, 0x172d1377, ATMEL_FW_TYPE_502),
426         PCMCIA_DEVICE_PROD_ID12_INFO("Wireless", "PC_CARD", 0xa407ecdd, 0x119f6314, ATMEL_FW_TYPE_502D),
427         PCMCIA_DEVICE_PROD_ID12_INFO("WLAN", "802.11b PC CARD", 0x575c516c, 0xb1f6dbc4, ATMEL_FW_TYPE_502D),
428         PCMCIA_DEVICE_PROD_ID12_INFO("LG", "LW2100N", 0xb474d43a, 0x6b1fec94, ATMEL_FW_TYPE_502E),
429         PCMCIA_DEVICE_NULL
430 };
431
432 MODULE_DEVICE_TABLE(pcmcia, atmel_ids);
433
434 static struct pcmcia_driver atmel_driver = {
435         .owner          = THIS_MODULE,
436         .drv            = {
437                 .name   = "atmel_cs",
438         },
439         .probe          = atmel_probe,
440         .remove         = atmel_detach,
441         .id_table       = atmel_ids,
442         .suspend        = atmel_suspend,
443         .resume         = atmel_resume,
444 };
445
446 static int atmel_cs_init(void)
447 {
448         return pcmcia_register_driver(&atmel_driver);
449 }
450
451 static void atmel_cs_cleanup(void)
452 {
453         pcmcia_unregister_driver(&atmel_driver);
454 }
455
456 /*
457     This program is free software; you can redistribute it and/or
458     modify it under the terms of the GNU General Public License
459     as published by the Free Software Foundation; either version 2
460     of the License, or (at your option) any later version.
461
462     This program is distributed in the hope that it will be useful,
463     but WITHOUT ANY WARRANTY; without even the implied warranty of
464     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
465     GNU General Public License for more details.
466
467     In addition:
468
469     Redistribution and use in source and binary forms, with or without
470     modification, are permitted provided that the following conditions
471     are met:
472
473     1. Redistributions of source code must retain the above copyright
474        notice, this list of conditions and the following disclaimer.
475     2. Redistributions in binary form must reproduce the above copyright
476        notice, this list of conditions and the following disclaimer in the
477        documentation and/or other materials provided with the distribution.
478     3. The name of the author may not be used to endorse or promote
479        products derived from this software without specific prior written
480        permission.
481
482     THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
483     IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
484     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
485     ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
486     INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
487     (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
488     SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
489     HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
490     STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
491     IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
492     POSSIBILITY OF SUCH DAMAGE.
493 */
494
495 module_init(atmel_cs_init);
496 module_exit(atmel_cs_cleanup);