pcmcia: introduce autoconfiguration feature
[linux-2.6.git] / drivers / net / wireless / airo_cs.c
1 /*======================================================================
2
3     Aironet driver for 4500 and 4800 series cards
4
5     This code is released under both the GPL version 2 and BSD licenses.
6     Either license may be used.  The respective licenses are found at
7     the end of this file.
8
9     This code was developed by Benjamin Reed <breed@users.sourceforge.net>
10     including portions of which come from the Aironet PC4500
11     Developer's Reference Manual and used with permission.  Copyright
12     (C) 1999 Benjamin Reed.  All Rights Reserved.  Permission to use
13     code in the Developer's manual was granted for this driver by
14     Aironet.
15
16     In addition this module was derived from dummy_cs.
17     The initial developer of dummy_cs is David A. Hinds
18     <dahinds@users.sourceforge.net>.  Portions created by David A. Hinds
19     are Copyright (C) 1999 David A. Hinds.  All Rights Reserved.
20
21 ======================================================================*/
22
23 #ifdef __IN_PCMCIA_PACKAGE__
24 #include <pcmcia/k_compat.h>
25 #endif
26 #include <linux/init.h>
27 #include <linux/kernel.h>
28 #include <linux/module.h>
29 #include <linux/ptrace.h>
30 #include <linux/slab.h>
31 #include <linux/string.h>
32 #include <linux/timer.h>
33 #include <linux/netdevice.h>
34
35 #include <pcmcia/cistpl.h>
36 #include <pcmcia/cisreg.h>
37 #include <pcmcia/ds.h>
38
39 #include <linux/io.h>
40 #include <asm/system.h>
41
42 #include "airo.h"
43
44
45 /*====================================================================*/
46
47 MODULE_AUTHOR("Benjamin Reed");
48 MODULE_DESCRIPTION("Support for Cisco/Aironet 802.11 wireless ethernet "
49                    "cards.  This is the module that links the PCMCIA card "
50                    "with the airo module.");
51 MODULE_LICENSE("Dual BSD/GPL");
52 MODULE_SUPPORTED_DEVICE("Aironet 4500, 4800 and Cisco 340 PCMCIA cards");
53
54 /*====================================================================*/
55
56 /*
57    The event() function is this driver's Card Services event handler.
58    It will be called by Card Services when an appropriate card status
59    event is received.  The config() and release() entry points are
60    used to configure or release a socket, in response to card
61    insertion and ejection events.  They are invoked from the airo_cs
62    event handler.
63 */
64
65 static int airo_config(struct pcmcia_device *link);
66 static void airo_release(struct pcmcia_device *link);
67
68 /*
69    The attach() and detach() entry points are used to create and destroy
70    "instances" of the driver, where each instance represents everything
71    needed to manage one actual PCMCIA card.
72 */
73
74 static void airo_detach(struct pcmcia_device *p_dev);
75
76 typedef struct local_info_t {
77         struct net_device *eth_dev;
78 } local_info_t;
79
80 /*======================================================================
81
82   airo_attach() creates an "instance" of the driver, allocating
83   local data structures for one device.  The device is registered
84   with Card Services.
85
86   The dev_link structure is initialized, but we don't actually
87   configure the card at this point -- we wait until we receive a
88   card insertion event.
89
90   ======================================================================*/
91
92 static int airo_probe(struct pcmcia_device *p_dev)
93 {
94         local_info_t *local;
95
96         dev_dbg(&p_dev->dev, "airo_attach()\n");
97
98         /* Allocate space for private device-specific data */
99         local = kzalloc(sizeof(local_info_t), GFP_KERNEL);
100         if (!local) {
101                 printk(KERN_ERR "airo_cs: no memory for new device\n");
102                 return -ENOMEM;
103         }
104         p_dev->priv = local;
105
106         return airo_config(p_dev);
107 } /* airo_attach */
108
109 /*======================================================================
110
111   This deletes a driver "instance".  The device is de-registered
112   with Card Services.  If it has been released, all local data
113   structures are freed.  Otherwise, the structures will be freed
114   when the device is released.
115
116   ======================================================================*/
117
118 static void airo_detach(struct pcmcia_device *link)
119 {
120         dev_dbg(&link->dev, "airo_detach\n");
121
122         airo_release(link);
123
124         if (((local_info_t *)link->priv)->eth_dev) {
125                 stop_airo_card(((local_info_t *)link->priv)->eth_dev, 0);
126         }
127         ((local_info_t *)link->priv)->eth_dev = NULL;
128
129         kfree(link->priv);
130 } /* airo_detach */
131
132 /*======================================================================
133
134   airo_config() is scheduled to run after a CARD_INSERTION event
135   is received, to configure the PCMCIA socket, and to make the
136   device available to the system.
137
138   ======================================================================*/
139
140 static int airo_cs_config_check(struct pcmcia_device *p_dev,
141                                 cistpl_cftable_entry_t *cfg,
142                                 cistpl_cftable_entry_t *dflt,
143                                 void *priv_data)
144 {
145         if (cfg->index == 0)
146                 return -ENODEV;
147
148         /* IO window settings */
149         p_dev->resource[0]->end = p_dev->resource[1]->end = 0;
150         if ((cfg->io.nwin > 0) || (dflt->io.nwin > 0)) {
151                 cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &dflt->io;
152                 p_dev->resource[0]->flags &= ~IO_DATA_PATH_WIDTH;
153                 p_dev->resource[0]->flags |=
154                                         pcmcia_io_cfg_data_width(io->flags);
155                 p_dev->resource[0]->start = io->win[0].base;
156                 p_dev->resource[0]->end = io->win[0].len;
157                 if (io->nwin > 1) {
158                         p_dev->resource[1]->flags = p_dev->resource[0]->flags;
159                         p_dev->resource[1]->start = io->win[1].base;
160                         p_dev->resource[1]->end = io->win[1].len;
161                 }
162         }
163
164         /* This reserves IO space but doesn't actually enable it */
165         if (pcmcia_request_io(p_dev) != 0)
166                 return -ENODEV;
167
168         /* If we got this far, we're cool! */
169         return 0;
170 }
171
172
173 static int airo_config(struct pcmcia_device *link)
174 {
175         local_info_t *dev;
176         int ret;
177
178         dev = link->priv;
179
180         dev_dbg(&link->dev, "airo_config\n");
181
182         link->config_flags |= CONF_ENABLE_IRQ | CONF_AUTO_SET_VPP |
183                 CONF_AUTO_AUDIO;
184
185         /*
186          * In this loop, we scan the CIS for configuration table
187          * entries, each of which describes a valid card
188          * configuration, including voltage, IO window, memory window,
189          * and interrupt settings.
190          *
191          * We make no assumptions about the card to be configured: we
192          * use just the information available in the CIS.  In an ideal
193          * world, this would work for any PCMCIA card, but it requires
194          * a complete and accurate CIS.  In practice, a driver usually
195          * "knows" most of these things without consulting the CIS,
196          * and most client drivers will only use the CIS to fill in
197          * implementation-defined details.
198          */
199         ret = pcmcia_loop_config(link, airo_cs_config_check, NULL);
200         if (ret)
201                 goto failed;
202
203         if (!link->irq)
204                 goto failed;
205
206         /*
207           This actually configures the PCMCIA socket -- setting up
208           the I/O windows and the interrupt mapping, and putting the
209           card and host interface into "Memory and IO" mode.
210         */
211         ret = pcmcia_enable_device(link);
212         if (ret)
213                 goto failed;
214         ((local_info_t *)link->priv)->eth_dev =
215                 init_airo_card(link->irq,
216                                link->resource[0]->start, 1, &link->dev);
217         if (!((local_info_t *)link->priv)->eth_dev)
218                 goto failed;
219
220         /* Finally, report what we've done */
221         dev_info(&link->dev, "index 0x%02x: ",
222                link->config_index);
223         if (link->vpp)
224                 printk(", Vpp %d.%d", link->vpp/10, link->vpp%10);
225         printk(", irq %d", link->irq);
226         if (link->resource[0])
227                 printk(" & %pR", link->resource[0]);
228         if (link->resource[1])
229                 printk(" & %pR", link->resource[1]);
230         printk("\n");
231         return 0;
232
233  failed:
234         airo_release(link);
235         return -ENODEV;
236 } /* airo_config */
237
238 /*======================================================================
239
240   After a card is removed, airo_release() will unregister the
241   device, and release the PCMCIA configuration.  If the device is
242   still open, this will be postponed until it is closed.
243
244   ======================================================================*/
245
246 static void airo_release(struct pcmcia_device *link)
247 {
248         dev_dbg(&link->dev, "airo_release\n");
249         pcmcia_disable_device(link);
250 }
251
252 static int airo_suspend(struct pcmcia_device *link)
253 {
254         local_info_t *local = link->priv;
255
256         netif_device_detach(local->eth_dev);
257
258         return 0;
259 }
260
261 static int airo_resume(struct pcmcia_device *link)
262 {
263         local_info_t *local = link->priv;
264
265         if (link->open) {
266                 reset_airo_card(local->eth_dev);
267                 netif_device_attach(local->eth_dev);
268         }
269
270         return 0;
271 }
272
273 static struct pcmcia_device_id airo_ids[] = {
274         PCMCIA_DEVICE_MANF_CARD(0x015f, 0x000a),
275         PCMCIA_DEVICE_MANF_CARD(0x015f, 0x0005),
276         PCMCIA_DEVICE_MANF_CARD(0x015f, 0x0007),
277         PCMCIA_DEVICE_MANF_CARD(0x0105, 0x0007),
278         PCMCIA_DEVICE_NULL,
279 };
280 MODULE_DEVICE_TABLE(pcmcia, airo_ids);
281
282 static struct pcmcia_driver airo_driver = {
283         .owner          = THIS_MODULE,
284         .drv            = {
285                 .name   = "airo_cs",
286         },
287         .probe          = airo_probe,
288         .remove         = airo_detach,
289         .id_table       = airo_ids,
290         .suspend        = airo_suspend,
291         .resume         = airo_resume,
292 };
293
294 static int airo_cs_init(void)
295 {
296         return pcmcia_register_driver(&airo_driver);
297 }
298
299 static void airo_cs_cleanup(void)
300 {
301         pcmcia_unregister_driver(&airo_driver);
302 }
303
304 /*
305     This program is free software; you can redistribute it and/or
306     modify it under the terms of the GNU General Public License
307     as published by the Free Software Foundation; either version 2
308     of the License, or (at your option) any later version.
309
310     This program is distributed in the hope that it will be useful,
311     but WITHOUT ANY WARRANTY; without even the implied warranty of
312     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
313     GNU General Public License for more details.
314
315     In addition:
316
317     Redistribution and use in source and binary forms, with or without
318     modification, are permitted provided that the following conditions
319     are met:
320
321     1. Redistributions of source code must retain the above copyright
322        notice, this list of conditions and the following disclaimer.
323     2. Redistributions in binary form must reproduce the above copyright
324        notice, this list of conditions and the following disclaimer in the
325        documentation and/or other materials provided with the distribution.
326     3. The name of the author may not be used to endorse or promote
327        products derived from this software without specific prior written
328        permission.
329
330     THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
331     IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
332     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
333     ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
334     INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
335     (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
336     SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
337     HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
338     STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
339     IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
340     POSSIBILITY OF SUCH DAMAGE.
341 */
342
343 module_init(airo_cs_init);
344 module_exit(airo_cs_cleanup);