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, void *priv_data)
 141 {
 142         if (p_dev->config_index == 0)
 143                 return -EINVAL;
 144
 145         return pcmcia_request_io(p_dev);
 146 }
 147
 148
 149 static int airo_config(struct pcmcia_device *link)
 150 {
 151         local_info_t *dev;
 152         int ret;
 153
 154         dev = link->priv;
 155
 156         dev_dbg(&link->dev, "airo_config\n");
 157
 158         link->config_flags |= CONF_ENABLE_IRQ | CONF_AUTO_SET_VPP |
 159                 CONF_AUTO_AUDIO | CONF_AUTO_SET_IO;
 160
 161         /*
 162          * 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          */
 175         ret = pcmcia_loop_config(link, airo_cs_config_check, NULL);
 176         if (ret)
 177                 goto failed;
 178
 179         if (!link->irq)
 180                 goto failed;
 181
 182         /*
 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         */
 187         ret = pcmcia_enable_device(link);
 188         if (ret)
 189                 goto failed;
 190         ((local_info_t *)link->priv)->eth_dev =
 191                 init_airo_card(link->irq,
 192                                link->resource[0]->start, 1, &link->dev);
 193         if (!((local_info_t *)link->priv)->eth_dev)
 194                 goto failed;
 195
 196         return 0;
 197
 198  failed:
 199         airo_release(link);
 200         return -ENODEV;
 201 } /* airo_config */
 202
 203 /*======================================================================
 204
 205   After a card is removed, airo_release() will unregister the
 206   device, and release the PCMCIA configuration.  If the device is
 207   still open, this will be postponed until it is closed.
 208
 209   ======================================================================*/
 210
 211 static void airo_release(struct pcmcia_device *link)
 212 {
 213         dev_dbg(&link->dev, "airo_release\n");
 214         pcmcia_disable_device(link);
 215 }
 216
 217 static int airo_suspend(struct pcmcia_device *link)
 218 {
 219         local_info_t *local = link->priv;
 220
 221         netif_device_detach(local->eth_dev);
 222
 223         return 0;
 224 }
 225
 226 static int airo_resume(struct pcmcia_device *link)
 227 {
 228         local_info_t *local = link->priv;
 229
 230         if (link->open) {
 231                 reset_airo_card(local->eth_dev);
 232                 netif_device_attach(local->eth_dev);
 233         }
 234
 235         return 0;
 236 }
 237
 238 static struct pcmcia_device_id airo_ids[] = {
 239         PCMCIA_DEVICE_MANF_CARD(0x015f, 0x000a),
 240         PCMCIA_DEVICE_MANF_CARD(0x015f, 0x0005),
 241         PCMCIA_DEVICE_MANF_CARD(0x015f, 0x0007),
 242         PCMCIA_DEVICE_MANF_CARD(0x0105, 0x0007),
 243         PCMCIA_DEVICE_NULL,
 244 };
 245 MODULE_DEVICE_TABLE(pcmcia, airo_ids);
 246
 247 static struct pcmcia_driver airo_driver = {
 248         .owner          = THIS_MODULE,
 249         .name           = "airo_cs",
 250         .probe          = airo_probe,
 251         .remove         = airo_detach,
 252         .id_table       = airo_ids,
 253         .suspend        = airo_suspend,
 254         .resume         = airo_resume,
 255 };
 256
 257 static int airo_cs_init(void)
 258 {
 259         return pcmcia_register_driver(&airo_driver);
 260 }
 261
 262 static void airo_cs_cleanup(void)
 263 {
 264         pcmcia_unregister_driver(&airo_driver);
 265 }
 266
 267 /*
 268     This program is free software; you can redistribute it and/or
 269     modify it under the terms of the GNU General Public License
 270     as published by the Free Software Foundation; either version 2
 271     of the License, or (at your option) any later version.
 272
 273     This program is distributed in the hope that it will be useful,
 274     but WITHOUT ANY WARRANTY; without even the implied warranty of
 275     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 276     GNU General Public License for more details.
 277
 278     In addition:
 279
 280     Redistribution and use in source and binary forms, with or without
 281     modification, are permitted provided that the following conditions
 282     are met:
 283
 284     1. Redistributions of source code must retain the above copyright
 285        notice, this list of conditions and the following disclaimer.
 286     2. Redistributions in binary form must reproduce the above copyright
 287        notice, this list of conditions and the following disclaimer in the
 288        documentation and/or other materials provided with the distribution.
 289     3. The name of the author may not be used to endorse or promote
 290        products derived from this software without specific prior written
 291        permission.
 292
 293     THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 294     IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 295     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 296     ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
 297     INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 298     (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 299     SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 300     HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 301     STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
 302     IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 303     POSSIBILITY OF SUCH DAMAGE.
 304 */
 305
 306 module_init(airo_cs_init);
 307 module_exit(airo_cs_cleanup);