blob: 77682f27772b9887c2be29c661114e6501c3ea0a [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*======================================================================
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
John Daiker05c9a4c2009-03-06 07:09:41 -080019 are Copyright (C) 1999 David A. Hinds. All Rights Reserved.
20
Linus Torvalds1da177e2005-04-16 15:20:36 -070021======================================================================*/
22
Linus Torvalds1da177e2005-04-16 15:20:36 -070023#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
Linus Torvalds1da177e2005-04-16 15:20:36 -070035#include <pcmcia/cistpl.h>
36#include <pcmcia/cisreg.h>
37#include <pcmcia/ds.h>
38
John Daiker05c9a4c2009-03-06 07:09:41 -080039#include <linux/io.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070040#include <asm/system.h>
41
Adrian Bunkd3808762005-11-05 17:42:27 +010042#include "airo.h"
43
Linus Torvalds1da177e2005-04-16 15:20:36 -070044
45/*====================================================================*/
46
47MODULE_AUTHOR("Benjamin Reed");
John Daiker05c9a4c2009-03-06 07:09:41 -080048MODULE_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.");
Linus Torvalds1da177e2005-04-16 15:20:36 -070051MODULE_LICENSE("Dual BSD/GPL");
52MODULE_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
John Daiker05c9a4c2009-03-06 07:09:41 -080062 event handler.
Linus Torvalds1da177e2005-04-16 15:20:36 -070063*/
64
Dominik Brodowski15b99ac2006-03-31 17:26:06 +020065static int airo_config(struct pcmcia_device *link);
Dominik Brodowskifba395e2006-03-31 17:21:06 +020066static void airo_release(struct pcmcia_device *link);
Linus Torvalds1da177e2005-04-16 15:20:36 -070067
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
Dominik Brodowskicc3b4862005-11-14 21:23:14 +010074static void airo_detach(struct pcmcia_device *p_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -070075
Linus Torvalds1da177e2005-04-16 15:20:36 -070076typedef struct local_info_t {
Linus Torvalds1da177e2005-04-16 15:20:36 -070077 struct net_device *eth_dev;
78} local_info_t;
79
80/*======================================================================
John Daiker05c9a4c2009-03-06 07:09:41 -080081
Linus Torvalds1da177e2005-04-16 15:20:36 -070082 airo_attach() creates an "instance" of the driver, allocating
83 local data structures for one device. The device is registered
84 with Card Services.
John Daiker05c9a4c2009-03-06 07:09:41 -080085
Linus Torvalds1da177e2005-04-16 15:20:36 -070086 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.
John Daiker05c9a4c2009-03-06 07:09:41 -080089
Linus Torvalds1da177e2005-04-16 15:20:36 -070090 ======================================================================*/
91
Dominik Brodowski15b99ac2006-03-31 17:26:06 +020092static int airo_probe(struct pcmcia_device *p_dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -070093{
Linus Torvalds1da177e2005-04-16 15:20:36 -070094 local_info_t *local;
Dominik Brodowskif8cfa612005-11-14 21:25:51 +010095
Dominik Brodowski2caff1472009-10-24 15:53:36 +020096 dev_dbg(&p_dev->dev, "airo_attach()\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -070097
Linus Torvalds1da177e2005-04-16 15:20:36 -070098 /* Allocate space for private device-specific data */
Panagiotis Issarisb69a3aa2005-11-08 00:03:15 +010099 local = kzalloc(sizeof(local_info_t), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100 if (!local) {
101 printk(KERN_ERR "airo_cs: no memory for new device\n");
Dominik Brodowskif8cfa612005-11-14 21:25:51 +0100102 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103 }
Dominik Brodowskifd238232006-03-05 10:45:09 +0100104 p_dev->priv = local;
Dominik Brodowskif8cfa612005-11-14 21:25:51 +0100105
Dominik Brodowski15b99ac2006-03-31 17:26:06 +0200106 return airo_config(p_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107} /* airo_attach */
108
109/*======================================================================
John Daiker05c9a4c2009-03-06 07:09:41 -0800110
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111 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.
John Daiker05c9a4c2009-03-06 07:09:41 -0800115
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116 ======================================================================*/
117
Dominik Brodowskifba395e2006-03-31 17:21:06 +0200118static void airo_detach(struct pcmcia_device *link)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119{
Dominik Brodowski2caff1472009-10-24 15:53:36 +0200120 dev_dbg(&link->dev, "airo_detach\n");
Dominik Brodowskib4635812005-11-14 21:25:35 +0100121
Dominik Brodowskie2d40962006-03-02 00:09:29 +0100122 airo_release(link);
Dominik Brodowskib4635812005-11-14 21:25:35 +0100123
John Daiker05c9a4c2009-03-06 07:09:41 -0800124 if (((local_info_t *)link->priv)->eth_dev) {
125 stop_airo_card(((local_info_t *)link->priv)->eth_dev, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126 }
John Daiker05c9a4c2009-03-06 07:09:41 -0800127 ((local_info_t *)link->priv)->eth_dev = NULL;
Dominik Brodowskicc3b4862005-11-14 21:23:14 +0100128
Jesper Juhlb4558ea2005-10-28 16:53:13 -0400129 kfree(link->priv);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130} /* airo_detach */
131
132/*======================================================================
John Daiker05c9a4c2009-03-06 07:09:41 -0800133
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134 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.
John Daiker05c9a4c2009-03-06 07:09:41 -0800137
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138 ======================================================================*/
139
Dominik Brodowski00990e72010-07-30 13:13:46 +0200140static int airo_cs_config_check(struct pcmcia_device *p_dev, void *priv_data)
Dominik Brodowskib54bf942008-08-02 14:28:43 +0200141{
Dominik Brodowski00990e72010-07-30 13:13:46 +0200142 if (p_dev->config_index == 0)
143 return -EINVAL;
Dominik Brodowskib54bf942008-08-02 14:28:43 +0200144
Dominik Brodowski00990e72010-07-30 13:13:46 +0200145 return pcmcia_request_io(p_dev);
Dominik Brodowskib54bf942008-08-02 14:28:43 +0200146}
147
148
Dominik Brodowski15b99ac2006-03-31 17:26:06 +0200149static int airo_config(struct pcmcia_device *link)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151 local_info_t *dev;
Dominik Brodowski2caff1472009-10-24 15:53:36 +0200152 int ret;
Dominik Brodowskifba395e2006-03-31 17:21:06 +0200153
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154 dev = link->priv;
155
Dominik Brodowski2caff1472009-10-24 15:53:36 +0200156 dev_dbg(&link->dev, "airo_config\n");
Dominik Brodowskie2d40962006-03-02 00:09:29 +0100157
Dominik Brodowski440eed42010-07-30 09:51:52 +0200158 link->config_flags |= CONF_ENABLE_IRQ | CONF_AUTO_SET_VPP |
Dominik Brodowski00990e72010-07-30 13:13:46 +0200159 CONF_AUTO_AUDIO | CONF_AUTO_SET_IO;
Dominik Brodowski440eed42010-07-30 09:51:52 +0200160
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161 /*
Dominik Brodowskib54bf942008-08-02 14:28:43 +0200162 * In this loop, we scan the CIS for configuration table
163 * entries, each of which describes a valid card
164 * configuration, including voltage, IO window, memory window,
165 * and interrupt settings.
166 *
167 * We make no assumptions about the card to be configured: we
168 * use just the information available in the CIS. In an ideal
169 * world, this would work for any PCMCIA card, but it requires
170 * a complete and accurate CIS. In practice, a driver usually
171 * "knows" most of these things without consulting the CIS,
172 * and most client drivers will only use the CIS to fill in
173 * implementation-defined details.
174 */
Dominik Brodowski0f52e862010-07-28 09:32:02 +0200175 ret = pcmcia_loop_config(link, airo_cs_config_check, NULL);
Dominik Brodowski2caff1472009-10-24 15:53:36 +0200176 if (ret)
Dominik Brodowskib54bf942008-08-02 14:28:43 +0200177 goto failed;
178
Dominik Brodowskieb141202010-03-07 12:21:16 +0100179 if (!link->irq)
180 goto failed;
John Daiker05c9a4c2009-03-06 07:09:41 -0800181
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182 /*
183 This actually configures the PCMCIA socket -- setting up
184 the I/O windows and the interrupt mapping, and putting the
185 card and host interface into "Memory and IO" mode.
186 */
Dominik Brodowski1ac71e52010-07-29 19:27:09 +0200187 ret = pcmcia_enable_device(link);
Dominik Brodowski2caff1472009-10-24 15:53:36 +0200188 if (ret)
189 goto failed;
John Daiker05c9a4c2009-03-06 07:09:41 -0800190 ((local_info_t *)link->priv)->eth_dev =
Dominik Brodowskieb141202010-03-07 12:21:16 +0100191 init_airo_card(link->irq,
Dominik Brodowski9a017a92010-07-24 15:58:54 +0200192 link->resource[0]->start, 1, &link->dev);
John Daiker05c9a4c2009-03-06 07:09:41 -0800193 if (!((local_info_t *)link->priv)->eth_dev)
Dominik Brodowski2caff1472009-10-24 15:53:36 +0200194 goto failed;
John Daiker05c9a4c2009-03-06 07:09:41 -0800195
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196 /* Finally, report what we've done */
Dominik Brodowskided6a1a2010-03-20 19:35:12 +0100197 dev_info(&link->dev, "index 0x%02x: ",
Dominik Brodowski7feabb62010-07-29 18:35:47 +0200198 link->config_index);
Dominik Brodowskie8405f02010-07-29 15:50:55 +0200199 if (link->vpp)
200 printk(", Vpp %d.%d", link->vpp/10, link->vpp%10);
Dominik Brodowskieb141202010-03-07 12:21:16 +0100201 printk(", irq %d", link->irq);
Dominik Brodowski9a017a92010-07-24 15:58:54 +0200202 if (link->resource[0])
203 printk(" & %pR", link->resource[0]);
204 if (link->resource[1])
205 printk(" & %pR", link->resource[1]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206 printk("\n");
Dominik Brodowski15b99ac2006-03-31 17:26:06 +0200207 return 0;
208
Dominik Brodowskib54bf942008-08-02 14:28:43 +0200209 failed:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210 airo_release(link);
Dominik Brodowski15b99ac2006-03-31 17:26:06 +0200211 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212} /* airo_config */
213
214/*======================================================================
John Daiker05c9a4c2009-03-06 07:09:41 -0800215
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216 After a card is removed, airo_release() will unregister the
217 device, and release the PCMCIA configuration. If the device is
218 still open, this will be postponed until it is closed.
John Daiker05c9a4c2009-03-06 07:09:41 -0800219
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220 ======================================================================*/
221
Dominik Brodowskifba395e2006-03-31 17:21:06 +0200222static void airo_release(struct pcmcia_device *link)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223{
Dominik Brodowski2caff1472009-10-24 15:53:36 +0200224 dev_dbg(&link->dev, "airo_release\n");
Dominik Brodowskifba395e2006-03-31 17:21:06 +0200225 pcmcia_disable_device(link);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226}
227
Dominik Brodowskifba395e2006-03-31 17:21:06 +0200228static int airo_suspend(struct pcmcia_device *link)
Dominik Brodowski98e4c282005-11-14 21:21:18 +0100229{
Dominik Brodowski98e4c282005-11-14 21:21:18 +0100230 local_info_t *local = link->priv;
231
Dominik Brodowskie2d40962006-03-02 00:09:29 +0100232 netif_device_detach(local->eth_dev);
Dominik Brodowski98e4c282005-11-14 21:21:18 +0100233
234 return 0;
235}
236
Dominik Brodowskifba395e2006-03-31 17:21:06 +0200237static int airo_resume(struct pcmcia_device *link)
Dominik Brodowski98e4c282005-11-14 21:21:18 +0100238{
Dominik Brodowski98e4c282005-11-14 21:21:18 +0100239 local_info_t *local = link->priv;
240
Dominik Brodowskie2d40962006-03-02 00:09:29 +0100241 if (link->open) {
Dominik Brodowski98e4c282005-11-14 21:21:18 +0100242 reset_airo_card(local->eth_dev);
243 netif_device_attach(local->eth_dev);
244 }
245
246 return 0;
247}
248
Dominik Brodowski7018d062005-06-27 16:28:20 -0700249static struct pcmcia_device_id airo_ids[] = {
250 PCMCIA_DEVICE_MANF_CARD(0x015f, 0x000a),
251 PCMCIA_DEVICE_MANF_CARD(0x015f, 0x0005),
252 PCMCIA_DEVICE_MANF_CARD(0x015f, 0x0007),
253 PCMCIA_DEVICE_MANF_CARD(0x0105, 0x0007),
254 PCMCIA_DEVICE_NULL,
255};
256MODULE_DEVICE_TABLE(pcmcia, airo_ids);
257
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258static struct pcmcia_driver airo_driver = {
259 .owner = THIS_MODULE,
260 .drv = {
261 .name = "airo_cs",
262 },
Dominik Brodowski15b99ac2006-03-31 17:26:06 +0200263 .probe = airo_probe,
Dominik Brodowskicc3b4862005-11-14 21:23:14 +0100264 .remove = airo_detach,
Dominik Brodowski7018d062005-06-27 16:28:20 -0700265 .id_table = airo_ids,
Dominik Brodowski98e4c282005-11-14 21:21:18 +0100266 .suspend = airo_suspend,
267 .resume = airo_resume,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268};
269
270static int airo_cs_init(void)
271{
272 return pcmcia_register_driver(&airo_driver);
273}
274
275static void airo_cs_cleanup(void)
276{
277 pcmcia_unregister_driver(&airo_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278}
279
280/*
281 This program is free software; you can redistribute it and/or
282 modify it under the terms of the GNU General Public License
283 as published by the Free Software Foundation; either version 2
284 of the License, or (at your option) any later version.
285
286 This program is distributed in the hope that it will be useful,
287 but WITHOUT ANY WARRANTY; without even the implied warranty of
288 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
289 GNU General Public License for more details.
290
291 In addition:
292
293 Redistribution and use in source and binary forms, with or without
294 modification, are permitted provided that the following conditions
295 are met:
296
297 1. Redistributions of source code must retain the above copyright
298 notice, this list of conditions and the following disclaimer.
299 2. Redistributions in binary form must reproduce the above copyright
300 notice, this list of conditions and the following disclaimer in the
301 documentation and/or other materials provided with the distribution.
302 3. The name of the author may not be used to endorse or promote
303 products derived from this software without specific prior written
304 permission.
305
306 THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
307 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
308 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
309 ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
310 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
311 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
312 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
313 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
314 STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
315 IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
John Daiker05c9a4c2009-03-06 07:09:41 -0800316 POSSIBILITY OF SUCH DAMAGE.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317*/
318
319module_init(airo_cs_init);
320module_exit(airo_cs_cleanup);