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/cs.h>
  36 #include <pcmcia/cistpl.h>
  37 #include <pcmcia/cisreg.h>
  38 #include <pcmcia/ds.h>
  39
  40 #include <linux/io.h>
  41 #include <asm/system.h>
  42
  43 #include "airo.h"
  44
  45
  46 /*====================================================================*/
  47
  48 MODULE_AUTHOR("Benjamin Reed");
  49 MODULE_DESCRIPTION("Support for Cisco/Aironet 802.11 wireless ethernet "
  50                    "cards.  This is the module that links the PCMCIA card "
  51                    "with the airo module.");
  52 MODULE_LICENSE("Dual BSD/GPL");
  53 MODULE_SUPPORTED_DEVICE("Aironet 4500, 4800 and Cisco 340 PCMCIA cards");
  54
  55 /*====================================================================*/
  56
  57 /*
  58    The event() function is this driver's Card Services event handler.
  59    It will be called by Card Services when an appropriate card status
  60    event is received.  The config() and release() entry points are
  61    used to configure or release a socket, in response to card
  62    insertion and ejection events.  They are invoked from the airo_cs
  63    event handler.
  64 */
  65
  66 static int airo_config(struct pcmcia_device *link);
  67 static void airo_release(struct pcmcia_device *link);
  68
  69 /*
  70    The attach() and detach() entry points are used to create and destroy
  71    "instances" of the driver, where each instance represents everything
  72    needed to manage one actual PCMCIA card.
  73 */
  74
  75 static void airo_detach(struct pcmcia_device *p_dev);
  76
  77 typedef struct local_info_t {
  78         struct net_device *eth_dev;
  79 } local_info_t;
  80
  81 /*======================================================================
  82
  83   airo_attach() creates an "instance" of the driver, allocating
  84   local data structures for one device.  The device is registered
  85   with Card Services.
  86
  87   The dev_link structure is initialized, but we don't actually
  88   configure the card at this point -- we wait until we receive a
  89   card insertion event.
  90
  91   ======================================================================*/
  92
  93 static int airo_probe(struct pcmcia_device *p_dev)
  94 {
  95         local_info_t *local;
  96
  97         dev_dbg(&p_dev->dev, "airo_attach()\n");
  98
  99         /*
 100           General socket configuration defaults can go here.  In this
 101           client, we assume very little, and rely on the CIS for almost
 102           everything.  In most clients, many details (i.e., number, sizes,
 103           and attributes of IO windows) are fixed by the nature of the
 104           device, and can be hard-wired here.
 105         */
 106         p_dev->conf.Attributes = 0;
 107         p_dev->conf.IntType = INT_MEMORY_AND_IO;
 108
 109         /* Allocate space for private device-specific data */
 110         local = kzalloc(sizeof(local_info_t), GFP_KERNEL);
 111         if (!local) {
 112                 printk(KERN_ERR "airo_cs: no memory for new device\n");
 113                 return -ENOMEM;
 114         }
 115         p_dev->priv = local;
 116
 117         return airo_config(p_dev);
 118 } /* airo_attach */
 119
 120 /*======================================================================
 121
 122   This deletes a driver "instance".  The device is de-registered
 123   with Card Services.  If it has been released, all local data
 124   structures are freed.  Otherwise, the structures will be freed
 125   when the device is released.
 126
 127   ======================================================================*/
 128
 129 static void airo_detach(struct pcmcia_device *link)
 130 {
 131         dev_dbg(&link->dev, "airo_detach\n");
 132
 133         airo_release(link);
 134
 135         if (((local_info_t *)link->priv)->eth_dev) {
 136                 stop_airo_card(((local_info_t *)link->priv)->eth_dev, 0);
 137         }
 138         ((local_info_t *)link->priv)->eth_dev = NULL;
 139
 140         kfree(link->priv);
 141 } /* airo_detach */
 142
 143 /*======================================================================
 144
 145   airo_config() is scheduled to run after a CARD_INSERTION event
 146   is received, to configure the PCMCIA socket, and to make the
 147   device available to the system.
 148
 149   ======================================================================*/
 150
 151 static int airo_cs_config_check(struct pcmcia_device *p_dev,
 152                                 cistpl_cftable_entry_t *cfg,
 153                                 cistpl_cftable_entry_t *dflt,
 154                                 unsigned int vcc,
 155                                 void *priv_data)
 156 {
 157         win_req_t *req = priv_data;
 158
 159         if (cfg->index == 0)
 160                 return -ENODEV;
 161
 162         /* Does this card need audio output? */
 163         if (cfg->flags & CISTPL_CFTABLE_AUDIO) {
 164                 p_dev->conf.Attributes |= CONF_ENABLE_SPKR;
 165                 p_dev->conf.Status = CCSR_AUDIO_ENA;
 166         }
 167
 168         /* Use power settings for Vcc and Vpp if present */
 169         /*  Note that the CIS values need to be rescaled */
 170         if (cfg->vpp1.present & (1<<CISTPL_POWER_VNOM))
 171                 p_dev->conf.Vpp = cfg->vpp1.param[CISTPL_POWER_VNOM]/10000;
 172         else if (dflt->vpp1.present & (1<<CISTPL_POWER_VNOM))
 173                 p_dev->conf.Vpp = dflt->vpp1.param[CISTPL_POWER_VNOM]/10000;
 174
 175         p_dev->conf.Attributes |= CONF_ENABLE_IRQ;
 176
 177         /* IO window settings */
 178         p_dev->resource[0]->end = p_dev->resource[1]->end = 0;
 179         if ((cfg->io.nwin > 0) || (dflt->io.nwin > 0)) {
 180                 cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &dflt->io;
 181                 p_dev->resource[0]->flags &= ~IO_DATA_PATH_WIDTH;
 182                 p_dev->resource[0]->flags |=
 183                                         pcmcia_io_cfg_data_width(io->flags);
 184                 p_dev->resource[0]->start = io->win[0].base;
 185                 p_dev->resource[0]->end = io->win[0].len;
 186                 if (io->nwin > 1) {
 187                         p_dev->resource[1]->flags = p_dev->resource[0]->flags;
 188                         p_dev->resource[1]->start = io->win[1].base;
 189                         p_dev->resource[1]->end = io->win[1].len;
 190                 }
 191         }
 192
 193         /* This reserves IO space but doesn't actually enable it */
 194         if (pcmcia_request_io(p_dev) != 0)
 195                 return -ENODEV;
 196
 197         /*
 198           Now set up a common memory window, if needed.  There is room
 199           in the struct pcmcia_device structure for one memory window handle,
 200           but if the base addresses need to be saved, or if multiple
 201           windows are needed, the info should go in the private data
 202           structure for this device.
 203
 204           Note that the memory window base is a physical address, and
 205           needs to be mapped to virtual space with ioremap() before it
 206           is used.
 207         */
 208         if ((cfg->mem.nwin > 0) || (dflt->mem.nwin > 0)) {
 209                 cistpl_mem_t *mem = (cfg->mem.nwin) ? &cfg->mem : &dflt->mem;
 210                 memreq_t map;
 211                 req->Attributes = WIN_DATA_WIDTH_16|WIN_MEMORY_TYPE_CM;
 212                 req->Base = mem->win[0].host_addr;
 213                 req->Size = mem->win[0].len;
 214                 req->AccessSpeed = 0;
 215                 if (pcmcia_request_window(p_dev, req, &p_dev->win) != 0)
 216                         return -ENODEV;
 217                 map.Page = 0;
 218                 map.CardOffset = mem->win[0].card_addr;
 219                 if (pcmcia_map_mem_page(p_dev, p_dev->win, &map) != 0)
 220                         return -ENODEV;
 221         }
 222         /* If we got this far, we're cool! */
 223         return 0;
 224 }
 225
 226
 227 static int airo_config(struct pcmcia_device *link)
 228 {
 229         local_info_t *dev;
 230         win_req_t *req;
 231         int ret;
 232
 233         dev = link->priv;
 234
 235         dev_dbg(&link->dev, "airo_config\n");
 236
 237         req = kzalloc(sizeof(win_req_t), GFP_KERNEL);
 238         if (!req)
 239                 return -ENOMEM;
 240
 241         /*
 242          * In this loop, we scan the CIS for configuration table
 243          * entries, each of which describes a valid card
 244          * configuration, including voltage, IO window, memory window,
 245          * and interrupt settings.
 246          *
 247          * We make no assumptions about the card to be configured: we
 248          * use just the information available in the CIS.  In an ideal
 249          * world, this would work for any PCMCIA card, but it requires
 250          * a complete and accurate CIS.  In practice, a driver usually
 251          * "knows" most of these things without consulting the CIS,
 252          * and most client drivers will only use the CIS to fill in
 253          * implementation-defined details.
 254          */
 255         ret = pcmcia_loop_config(link, airo_cs_config_check, req);
 256         if (ret)
 257                 goto failed;
 258
 259         if (!link->irq)
 260                 goto failed;
 261
 262         /*
 263           This actually configures the PCMCIA socket -- setting up
 264           the I/O windows and the interrupt mapping, and putting the
 265           card and host interface into "Memory and IO" mode.
 266         */
 267         ret = pcmcia_request_configuration(link, &link->conf);
 268         if (ret)
 269                 goto failed;
 270         ((local_info_t *)link->priv)->eth_dev =
 271                 init_airo_card(link->irq,
 272                                link->resource[0]->start, 1, &link->dev);
 273         if (!((local_info_t *)link->priv)->eth_dev)
 274                 goto failed;
 275
 276         /* Finally, report what we've done */
 277         dev_info(&link->dev, "index 0x%02x: ",
 278                link->conf.ConfigIndex);
 279         if (link->conf.Vpp)
 280                 printk(", Vpp %d.%d", link->conf.Vpp/10, link->conf.Vpp%10);
 281         printk(", irq %d", link->irq);
 282         if (link->resource[0])
 283                 printk(" & %pR", link->resource[0]);
 284         if (link->resource[1])
 285                 printk(" & %pR", link->resource[1]);
 286         if (link->win)
 287                 printk(", mem 0x%06lx-0x%06lx", req->Base,
 288                        req->Base+req->Size-1);
 289         printk("\n");
 290         kfree(req);
 291         return 0;
 292
 293  failed:
 294         airo_release(link);
 295         kfree(req);
 296         return -ENODEV;
 297 } /* airo_config */
 298
 299 /*======================================================================
 300
 301   After a card is removed, airo_release() will unregister the
 302   device, and release the PCMCIA configuration.  If the device is
 303   still open, this will be postponed until it is closed.
 304
 305   ======================================================================*/
 306
 307 static void airo_release(struct pcmcia_device *link)
 308 {
 309         dev_dbg(&link->dev, "airo_release\n");
 310         pcmcia_disable_device(link);
 311 }
 312
 313 static int airo_suspend(struct pcmcia_device *link)
 314 {
 315         local_info_t *local = link->priv;
 316
 317         netif_device_detach(local->eth_dev);
 318
 319         return 0;
 320 }
 321
 322 static int airo_resume(struct pcmcia_device *link)
 323 {
 324         local_info_t *local = link->priv;
 325
 326         if (link->open) {
 327                 reset_airo_card(local->eth_dev);
 328                 netif_device_attach(local->eth_dev);
 329         }
 330
 331         return 0;
 332 }
 333
 334 static struct pcmcia_device_id airo_ids[] = {
 335         PCMCIA_DEVICE_MANF_CARD(0x015f, 0x000a),
 336         PCMCIA_DEVICE_MANF_CARD(0x015f, 0x0005),
 337         PCMCIA_DEVICE_MANF_CARD(0x015f, 0x0007),
 338         PCMCIA_DEVICE_MANF_CARD(0x0105, 0x0007),
 339         PCMCIA_DEVICE_NULL,
 340 };
 341 MODULE_DEVICE_TABLE(pcmcia, airo_ids);
 342
 343 static struct pcmcia_driver airo_driver = {
 344         .owner          = THIS_MODULE,
 345         .drv            = {
 346                 .name   = "airo_cs",
 347         },
 348         .probe          = airo_probe,
 349         .remove         = airo_detach,
 350         .id_table       = airo_ids,
 351         .suspend        = airo_suspend,
 352         .resume         = airo_resume,
 353 };
 354
 355 static int airo_cs_init(void)
 356 {
 357         return pcmcia_register_driver(&airo_driver);
 358 }
 359
 360 static void airo_cs_cleanup(void)
 361 {
 362         pcmcia_unregister_driver(&airo_driver);
 363 }
 364
 365 /*
 366     This program is free software; you can redistribute it and/or
 367     modify it under the terms of the GNU General Public License
 368     as published by the Free Software Foundation; either version 2
 369     of the License, or (at your option) any later version.
 370
 371     This program is distributed in the hope that it will be useful,
 372     but WITHOUT ANY WARRANTY; without even the implied warranty of
 373     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 374     GNU General Public License for more details.
 375
 376     In addition:
 377
 378     Redistribution and use in source and binary forms, with or without
 379     modification, are permitted provided that the following conditions
 380     are met:
 381
 382     1. Redistributions of source code must retain the above copyright
 383        notice, this list of conditions and the following disclaimer.
 384     2. Redistributions in binary form must reproduce the above copyright
 385        notice, this list of conditions and the following disclaimer in the
 386        documentation and/or other materials provided with the distribution.
 387     3. The name of the author may not be used to endorse or promote
 388        products derived from this software without specific prior written
 389        permission.
 390
 391     THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 392     IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 393     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 394     ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
 395     INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 396     (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 397     SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 398     HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 399     STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
 400     IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 401     POSSIBILITY OF SUCH DAMAGE.
 402 */
 403
 404 module_init(airo_cs_init);
 405 module_exit(airo_cs_cleanup);