[PATCH] pcmcia: add return value to _config() functions
[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 #include <linux/config.h>
33 #ifdef __IN_PCMCIA_PACKAGE__
34 #include <pcmcia/k_compat.h>
35 #endif
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>
45
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>
52
53 #include <asm/io.h>
54 #include <asm/system.h>
55 #include <linux/wireless.h>
56
57 #include "atmel.h"
58
59 /*
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.
65 */
66
67 #ifdef PCMCIA_DEBUG
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);
72 #else
73 #define DEBUG(n, args...)
74 #endif
75
76 /*====================================================================*/
77
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");
82
83 /*====================================================================*/
84
85 /*
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
91    event handler. 
92 */
93
94 static int atmel_config(struct pcmcia_device *link);
95 static void atmel_release(struct pcmcia_device *link);
96
97 /*
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.
101 */
102
103 static void atmel_detach(struct pcmcia_device *p_dev);
104
105 /*
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.
110 */
111
112 /*
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).
116
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.
120 */
121
122 /*
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.
131
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.
136 */
137    
138 typedef struct local_info_t {
139         dev_node_t      node;
140         struct net_device *eth_dev;
141 } local_info_t;
142
143 /*======================================================================
144   
145   atmel_attach() creates an "instance" of the driver, allocating
146   local data structures for one device.  The device is registered
147   with Card Services.
148   
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.
152   
153   ======================================================================*/
154
155 static int atmel_probe(struct pcmcia_device *p_dev)
156 {
157         local_info_t *local;
158
159         DEBUG(0, "atmel_attach()\n");
160
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;
165
166         /*
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.
172         */
173         p_dev->conf.Attributes = 0;
174         p_dev->conf.IntType = INT_MEMORY_AND_IO;
175
176         /* Allocate space for private device-specific data */
177         local = kzalloc(sizeof(local_info_t), GFP_KERNEL);
178         if (!local) {
179                 printk(KERN_ERR "atmel_cs: no memory for new device\n");
180                 return -ENOMEM;
181         }
182         p_dev->priv = local;
183
184         p_dev->state |= DEV_PRESENT | DEV_CONFIG_PENDING;
185         return atmel_config(p_dev);
186 } /* atmel_attach */
187
188 /*======================================================================
189   
190   This deletes a driver "instance".  The device is de-registered
191   with Card Services.  If it has been released, all local data
192   structures are freed.  Otherwise, the structures will be freed
193   when the device is released.
194   
195   ======================================================================*/
196
197 static void atmel_detach(struct pcmcia_device *link)
198 {
199         DEBUG(0, "atmel_detach(0x%p)\n", link);
200
201         if (link->state & DEV_CONFIG)
202                 atmel_release(link);
203
204         kfree(link->priv);
205 }
206
207 /*======================================================================
208   
209   atmel_config() is scheduled to run after a CARD_INSERTION event
210   is received, to configure the PCMCIA socket, and to make the
211   device available to the system.
212   
213   ======================================================================*/
214
215 #define CS_CHECK(fn, ret) \
216 do { last_fn = (fn); if ((last_ret = (ret)) != 0) goto cs_failed; } while (0)
217
218 /* Call-back function to interrogate PCMCIA-specific information
219    about the current existance of the card */
220 static int card_present(void *arg)
221
222         struct pcmcia_device *link = (struct pcmcia_device *)arg;
223         if (link->state & DEV_SUSPEND)
224                 return 0;
225         else if (link->state & DEV_PRESENT)
226                 return 1;
227         
228         return 0;
229 }
230
231 static int atmel_config(struct pcmcia_device *link)
232 {
233         tuple_t tuple;
234         cisparse_t parse;
235         local_info_t *dev;
236         int last_fn, last_ret;
237         u_char buf[64];
238         struct pcmcia_device_id *did;
239
240         dev = link->priv;
241         did = handle_to_dev(link).driver_data;
242
243         DEBUG(0, "atmel_config(0x%p)\n", link);
244         
245         tuple.Attributes = 0;
246         tuple.TupleData = buf;
247         tuple.TupleDataMax = sizeof(buf);
248         tuple.TupleOffset = 0;
249         
250         /*
251           This reads the card's CONFIG tuple to find its configuration
252           registers.
253         */
254         tuple.DesiredTuple = CISTPL_CONFIG;
255         CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(link, &tuple));
256         CS_CHECK(GetTupleData, pcmcia_get_tuple_data(link, &tuple));
257         CS_CHECK(ParseTuple, pcmcia_parse_tuple(link, &tuple, &parse));
258         link->conf.ConfigBase = parse.config.base;
259         link->conf.Present = parse.config.rmask[0];
260         
261         /* Configure card */
262         link->state |= DEV_CONFIG;
263         
264         /*
265           In this loop, we scan the CIS for configuration table entries,
266           each of which describes a valid card configuration, including
267           voltage, IO window, memory window, and interrupt settings.
268           
269           We make no assumptions about the card to be configured: we use
270           just the information available in the CIS.  In an ideal world,
271           this would work for any PCMCIA card, but it requires a complete
272           and accurate CIS.  In practice, a driver usually "knows" most of
273           these things without consulting the CIS, and most client drivers
274           will only use the CIS to fill in implementation-defined details.
275         */
276         tuple.DesiredTuple = CISTPL_CFTABLE_ENTRY;
277         CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(link, &tuple));
278         while (1) {
279                 cistpl_cftable_entry_t dflt = { 0 };
280                 cistpl_cftable_entry_t *cfg = &(parse.cftable_entry);
281                 if (pcmcia_get_tuple_data(link, &tuple) != 0 ||
282                                 pcmcia_parse_tuple(link, &tuple, &parse) != 0)
283                         goto next_entry;
284                 
285                 if (cfg->flags & CISTPL_CFTABLE_DEFAULT) dflt = *cfg;
286                 if (cfg->index == 0) goto next_entry;
287                 link->conf.ConfigIndex = cfg->index;
288                 
289                 /* Does this card need audio output? */
290                 if (cfg->flags & CISTPL_CFTABLE_AUDIO) {
291                         link->conf.Attributes |= CONF_ENABLE_SPKR;
292                         link->conf.Status = CCSR_AUDIO_ENA;
293                 }
294                 
295                 /* Use power settings for Vcc and Vpp if present */
296                 /*  Note that the CIS values need to be rescaled */
297                 if (cfg->vpp1.present & (1<<CISTPL_POWER_VNOM))
298                         link->conf.Vpp =
299                                 cfg->vpp1.param[CISTPL_POWER_VNOM]/10000;
300                 else if (dflt.vpp1.present & (1<<CISTPL_POWER_VNOM))
301                         link->conf.Vpp =
302                                 dflt.vpp1.param[CISTPL_POWER_VNOM]/10000;
303                 
304                 /* Do we need to allocate an interrupt? */
305                 if (cfg->irq.IRQInfo1 || dflt.irq.IRQInfo1)
306                         link->conf.Attributes |= CONF_ENABLE_IRQ;
307                 
308                 /* IO window settings */
309                 link->io.NumPorts1 = link->io.NumPorts2 = 0;
310                 if ((cfg->io.nwin > 0) || (dflt.io.nwin > 0)) {
311                         cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &dflt.io;
312                         link->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
313                         if (!(io->flags & CISTPL_IO_8BIT))
314                                 link->io.Attributes1 = IO_DATA_PATH_WIDTH_16;
315                         if (!(io->flags & CISTPL_IO_16BIT))
316                                 link->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
317                         link->io.BasePort1 = io->win[0].base;
318                         link->io.NumPorts1 = io->win[0].len;
319                         if (io->nwin > 1) {
320                                 link->io.Attributes2 = link->io.Attributes1;
321                                 link->io.BasePort2 = io->win[1].base;
322                                 link->io.NumPorts2 = io->win[1].len;
323                         }
324                 }
325                 
326                 /* This reserves IO space but doesn't actually enable it */
327                 if (pcmcia_request_io(link, &link->io) != 0)
328                         goto next_entry;
329
330                 /* If we got this far, we're cool! */
331                 break;
332                 
333         next_entry:
334                 CS_CHECK(GetNextTuple, pcmcia_get_next_tuple(link, &tuple));
335         }
336         
337         /*
338           Allocate an interrupt line.  Note that this does not assign a
339           handler to the interrupt, unless the 'Handler' member of the
340           irq structure is initialized.
341         */
342         if (link->conf.Attributes & CONF_ENABLE_IRQ)
343                 CS_CHECK(RequestIRQ, pcmcia_request_irq(link, &link->irq));
344         
345         /*
346           This actually configures the PCMCIA socket -- setting up
347           the I/O windows and the interrupt mapping, and putting the
348           card and host interface into "Memory and IO" mode.
349         */
350         CS_CHECK(RequestConfiguration, pcmcia_request_configuration(link, &link->conf));
351         
352         if (link->irq.AssignedIRQ == 0) {
353                 printk(KERN_ALERT 
354                        "atmel: cannot assign IRQ: check that CONFIG_ISA is set in kernel config.");
355                 goto cs_failed;
356         }
357        
358         ((local_info_t*)link->priv)->eth_dev = 
359                 init_atmel_card(link->irq.AssignedIRQ,
360                                 link->io.BasePort1,
361                                 did ? did->driver_info : ATMEL_FW_TYPE_NONE,
362                                 &handle_to_dev(link),
363                                 card_present, 
364                                 link);
365         if (!((local_info_t*)link->priv)->eth_dev) 
366                         goto cs_failed;
367         
368         
369         /*
370           At this point, the dev_node_t structure(s) need to be
371           initialized and arranged in a linked list at link->dev_node.
372         */
373         strcpy(dev->node.dev_name, ((local_info_t*)link->priv)->eth_dev->name );
374         dev->node.major = dev->node.minor = 0;
375         link->dev_node = &dev->node;
376                         
377         link->state &= ~DEV_CONFIG_PENDING;
378         return 0;
379         
380  cs_failed:
381         cs_error(link, last_fn, last_ret);
382         atmel_release(link);
383         return -ENODEV;
384 }
385
386 /*======================================================================
387   
388   After a card is removed, atmel_release() will unregister the
389   device, and release the PCMCIA configuration.  If the device is
390   still open, this will be postponed until it is closed.
391   
392   ======================================================================*/
393
394 static void atmel_release(struct pcmcia_device *link)
395 {
396         struct net_device *dev = ((local_info_t*)link->priv)->eth_dev;
397
398         DEBUG(0, "atmel_release(0x%p)\n", link);
399
400         if (dev)
401                 stop_atmel_card(dev);
402         ((local_info_t*)link->priv)->eth_dev = NULL;
403
404         pcmcia_disable_device(link);
405 }
406
407 static int atmel_suspend(struct pcmcia_device *link)
408 {
409         local_info_t *local = link->priv;
410
411         if (link->state & DEV_CONFIG)
412                 netif_device_detach(local->eth_dev);
413
414         return 0;
415 }
416
417 static int atmel_resume(struct pcmcia_device *link)
418 {
419         local_info_t *local = link->priv;
420
421         if (link->state & DEV_CONFIG) {
422                 atmel_open(local->eth_dev);
423                 netif_device_attach(local->eth_dev);
424         }
425
426         return 0;
427 }
428
429 /*====================================================================*/
430 /* We use the driver_info field to store the correct firmware type for a card. */
431
432 #define PCMCIA_DEVICE_MANF_CARD_INFO(manf, card, info) { \
433         .match_flags = PCMCIA_DEV_ID_MATCH_MANF_ID| \
434                         PCMCIA_DEV_ID_MATCH_CARD_ID, \
435         .manf_id = (manf), \
436         .card_id = (card), \
437         .driver_info = (kernel_ulong_t)(info), }
438
439 #define PCMCIA_DEVICE_PROD_ID12_INFO(v1, v2, vh1, vh2, info) { \
440         .match_flags = PCMCIA_DEV_ID_MATCH_PROD_ID1| \
441                         PCMCIA_DEV_ID_MATCH_PROD_ID2, \
442         .prod_id = { (v1), (v2), NULL, NULL }, \
443         .prod_id_hash = { (vh1), (vh2), 0, 0 }, \
444         .driver_info = (kernel_ulong_t)(info), }
445
446 static struct pcmcia_device_id atmel_ids[] = {
447         PCMCIA_DEVICE_MANF_CARD_INFO(0x0101, 0x0620, ATMEL_FW_TYPE_502_3COM),
448         PCMCIA_DEVICE_MANF_CARD_INFO(0x0101, 0x0696, ATMEL_FW_TYPE_502_3COM),
449         PCMCIA_DEVICE_MANF_CARD_INFO(0x01bf, 0x3302, ATMEL_FW_TYPE_502E),
450         PCMCIA_DEVICE_MANF_CARD_INFO(0xd601, 0x0007, ATMEL_FW_TYPE_502),
451         PCMCIA_DEVICE_PROD_ID12_INFO("11WAVE", "11WP611AL-E", 0x9eb2da1f, 0xc9a0d3f9, ATMEL_FW_TYPE_502E),
452         PCMCIA_DEVICE_PROD_ID12_INFO("ATMEL", "AT76C502AR", 0xabda4164, 0x41b37e1f, ATMEL_FW_TYPE_502),
453         PCMCIA_DEVICE_PROD_ID12_INFO("ATMEL", "AT76C502AR_D", 0xabda4164, 0x3675d704, ATMEL_FW_TYPE_502D),
454         PCMCIA_DEVICE_PROD_ID12_INFO("ATMEL", "AT76C502AR_E", 0xabda4164, 0x4172e792, ATMEL_FW_TYPE_502E),
455         PCMCIA_DEVICE_PROD_ID12_INFO("ATMEL", "AT76C504_R", 0xabda4164, 0x917f3d72, ATMEL_FW_TYPE_504_2958),
456         PCMCIA_DEVICE_PROD_ID12_INFO("ATMEL", "AT76C504", 0xabda4164, 0x5040670a, ATMEL_FW_TYPE_504),
457         PCMCIA_DEVICE_PROD_ID12_INFO("ATMEL", "AT76C504A", 0xabda4164, 0xe15ed87f, ATMEL_FW_TYPE_504A_2958),
458         PCMCIA_DEVICE_PROD_ID12_INFO("BT", "Voyager 1020 Laptop Adapter", 0xae49b86a, 0x1e957cd5, ATMEL_FW_TYPE_502),
459         PCMCIA_DEVICE_PROD_ID12_INFO("CNet", "CNWLC 11Mbps Wireless PC Card V-5", 0xbc477dde, 0x502fae6b, ATMEL_FW_TYPE_502E),
460         PCMCIA_DEVICE_PROD_ID12_INFO("IEEE 802.11b", "Wireless LAN PC Card", 0x5b878724, 0x122f1df6, ATMEL_FW_TYPE_502),
461         PCMCIA_DEVICE_PROD_ID12_INFO("IEEE 802.11b", "Wireless LAN Card S", 0x5b878724, 0x5fba533a, ATMEL_FW_TYPE_504_2958),
462         PCMCIA_DEVICE_PROD_ID12_INFO("OEM", "11Mbps Wireless LAN PC Card V-3", 0xfea54c90, 0x1c5b0f68, ATMEL_FW_TYPE_502),
463         PCMCIA_DEVICE_PROD_ID12_INFO("SMC", "2632W", 0xc4f8b18b, 0x30f38774, ATMEL_FW_TYPE_502D),
464         PCMCIA_DEVICE_PROD_ID12_INFO("SMC", "2632W-V2", 0xc4f8b18b, 0x172d1377, ATMEL_FW_TYPE_502),
465         PCMCIA_DEVICE_PROD_ID12_INFO("Wireless", "PC_CARD", 0xa407ecdd, 0x119f6314, ATMEL_FW_TYPE_502D),
466         PCMCIA_DEVICE_PROD_ID12_INFO("WLAN", "802.11b PC CARD", 0x575c516c, 0xb1f6dbc4, ATMEL_FW_TYPE_502D),
467         PCMCIA_DEVICE_PROD_ID12_INFO("LG", "LW2100N", 0xb474d43a, 0x6b1fec94, ATMEL_FW_TYPE_502E),
468         PCMCIA_DEVICE_NULL
469 };
470
471 MODULE_DEVICE_TABLE(pcmcia, atmel_ids);
472
473 static struct pcmcia_driver atmel_driver = {
474         .owner          = THIS_MODULE,
475         .drv            = {
476                 .name   = "atmel_cs",
477         },
478         .probe          = atmel_probe,
479         .remove         = atmel_detach,
480         .id_table       = atmel_ids,
481         .suspend        = atmel_suspend,
482         .resume         = atmel_resume,
483 };
484
485 static int atmel_cs_init(void)
486 {
487         return pcmcia_register_driver(&atmel_driver);
488 }
489
490 static void atmel_cs_cleanup(void)
491 {
492         pcmcia_unregister_driver(&atmel_driver);
493 }
494
495 /*
496     This program is free software; you can redistribute it and/or
497     modify it under the terms of the GNU General Public License
498     as published by the Free Software Foundation; either version 2
499     of the License, or (at your option) any later version.
500
501     This program is distributed in the hope that it will be useful,
502     but WITHOUT ANY WARRANTY; without even the implied warranty of
503     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
504     GNU General Public License for more details.
505
506     In addition:
507
508     Redistribution and use in source and binary forms, with or without
509     modification, are permitted provided that the following conditions
510     are met:
511
512     1. Redistributions of source code must retain the above copyright
513        notice, this list of conditions and the following disclaimer.
514     2. Redistributions in binary form must reproduce the above copyright
515        notice, this list of conditions and the following disclaimer in the
516        documentation and/or other materials provided with the distribution.
517     3. The name of the author may not be used to endorse or promote
518        products derived from this software without specific prior written
519        permission.
520
521     THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
522     IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
523     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
524     ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
525     INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
526     (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
527     SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
528     HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
529     STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
530     IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
531     POSSIBILITY OF SUCH DAMAGE.    
532 */
533
534 module_init(atmel_cs_init);
535 module_exit(atmel_cs_cleanup);