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->io.NumPorts1 = p_dev->io.NumPorts2 = 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->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
 182                 if (!(io->flags & CISTPL_IO_8BIT))
 183                         p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_16;
 184                 if (!(io->flags & CISTPL_IO_16BIT))
 185                         p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
 186                 p_dev->io.BasePort1 = io->win[0].base;
 187                 p_dev->io.NumPorts1 = io->win[0].len;
 188                 if (io->nwin > 1) {
 189                         p_dev->io.Attributes2 = p_dev->io.Attributes1;
 190                         p_dev->io.BasePort2 = io->win[1].base;
 191                         p_dev->io.NumPorts2 = io->win[1].len;
 192                 }
 193         }
 194
 195         /* This reserves IO space but doesn't actually enable it */
 196         if (pcmcia_request_io(p_dev, &p_dev->io) != 0)
 197                 return -ENODEV;
 198
 199         /*
 200           Now set up a common memory window, if needed.  There is room
 201           in the struct pcmcia_device structure for one memory window handle,
 202           but if the base addresses need to be saved, or if multiple
 203           windows are needed, the info should go in the private data
 204           structure for this device.
 205
 206           Note that the memory window base is a physical address, and
 207           needs to be mapped to virtual space with ioremap() before it
 208           is used.
 209         */
 210         if ((cfg->mem.nwin > 0) || (dflt->mem.nwin > 0)) {
 211                 cistpl_mem_t *mem = (cfg->mem.nwin) ? &cfg->mem : &dflt->mem;
 212                 memreq_t map;
 213                 req->Attributes = WIN_DATA_WIDTH_16|WIN_MEMORY_TYPE_CM;
 214                 req->Base = mem->win[0].host_addr;
 215                 req->Size = mem->win[0].len;
 216                 req->AccessSpeed = 0;
 217                 if (pcmcia_request_window(p_dev, req, &p_dev->win) != 0)
 218                         return -ENODEV;
 219                 map.Page = 0;
 220                 map.CardOffset = mem->win[0].card_addr;
 221                 if (pcmcia_map_mem_page(p_dev, p_dev->win, &map) != 0)
 222                         return -ENODEV;
 223         }
 224         /* If we got this far, we're cool! */
 225         return 0;
 226 }
 227
 228
 229 static int airo_config(struct pcmcia_device *link)
 230 {
 231         local_info_t *dev;
 232         win_req_t *req;
 233         int ret;
 234
 235         dev = link->priv;
 236
 237         dev_dbg(&link->dev, "airo_config\n");
 238
 239         req = kzalloc(sizeof(win_req_t), GFP_KERNEL);
 240         if (!req)
 241                 return -ENOMEM;
 242
 243         /*
 244          * In this loop, we scan the CIS for configuration table
 245          * entries, each of which describes a valid card
 246          * configuration, including voltage, IO window, memory window,
 247          * and interrupt settings.
 248          *
 249          * We make no assumptions about the card to be configured: we
 250          * use just the information available in the CIS.  In an ideal
 251          * world, this would work for any PCMCIA card, but it requires
 252          * a complete and accurate CIS.  In practice, a driver usually
 253          * "knows" most of these things without consulting the CIS,
 254          * and most client drivers will only use the CIS to fill in
 255          * implementation-defined details.
 256          */
 257         ret = pcmcia_loop_config(link, airo_cs_config_check, req);
 258         if (ret)
 259                 goto failed;
 260
 261         if (!link->irq)
 262                 goto failed;
 263
 264         /*
 265           This actually configures the PCMCIA socket -- setting up
 266           the I/O windows and the interrupt mapping, and putting the
 267           card and host interface into "Memory and IO" mode.
 268         */
 269         ret = pcmcia_request_configuration(link, &link->conf);
 270         if (ret)
 271                 goto failed;
 272         ((local_info_t *)link->priv)->eth_dev =
 273                 init_airo_card(link->irq,
 274                                link->resource[0]->start, 1, &link->dev);
 275         if (!((local_info_t *)link->priv)->eth_dev)
 276                 goto failed;
 277
 278         /* Finally, report what we've done */
 279         dev_info(&link->dev, "index 0x%02x: ",
 280                link->conf.ConfigIndex);
 281         if (link->conf.Vpp)
 282                 printk(", Vpp %d.%d", link->conf.Vpp/10, link->conf.Vpp%10);
 283         printk(", irq %d", link->irq);
 284         if (link->resource[0])
 285                 printk(" & %pR", link->resource[0]);
 286         if (link->resource[1])
 287                 printk(" & %pR", link->resource[1]);
 288         if (link->win)
 289                 printk(", mem 0x%06lx-0x%06lx", req->Base,
 290                        req->Base+req->Size-1);
 291         printk("\n");
 292         kfree(req);
 293         return 0;
 294
 295  failed:
 296         airo_release(link);
 297         kfree(req);
 298         return -ENODEV;
 299 } /* airo_config */
 300
 301 /*======================================================================
 302
 303   After a card is removed, airo_release() will unregister the
 304   device, and release the PCMCIA configuration.  If the device is
 305   still open, this will be postponed until it is closed.
 306
 307   ======================================================================*/
 308
 309 static void airo_release(struct pcmcia_device *link)
 310 {
 311         dev_dbg(&link->dev, "airo_release\n");
 312         pcmcia_disable_device(link);
 313 }
 314
 315 static int airo_suspend(struct pcmcia_device *link)
 316 {
 317         local_info_t *local = link->priv;
 318
 319         netif_device_detach(local->eth_dev);
 320
 321         return 0;
 322 }
 323
 324 static int airo_resume(struct pcmcia_device *link)
 325 {
 326         local_info_t *local = link->priv;
 327
 328         if (link->open) {
 329                 reset_airo_card(local->eth_dev);
 330                 netif_device_attach(local->eth_dev);
 331         }
 332
 333         return 0;
 334 }
 335
 336 static struct pcmcia_device_id airo_ids[] = {
 337         PCMCIA_DEVICE_MANF_CARD(0x015f, 0x000a),
 338         PCMCIA_DEVICE_MANF_CARD(0x015f, 0x0005),
 339         PCMCIA_DEVICE_MANF_CARD(0x015f, 0x0007),
 340         PCMCIA_DEVICE_MANF_CARD(0x0105, 0x0007),
 341         PCMCIA_DEVICE_NULL,
 342 };
 343 MODULE_DEVICE_TABLE(pcmcia, airo_ids);
 344
 345 static struct pcmcia_driver airo_driver = {
 346         .owner          = THIS_MODULE,
 347         .drv            = {
 348                 .name   = "airo_cs",
 349         },
 350         .probe          = airo_probe,
 351         .remove         = airo_detach,
 352         .id_table       = airo_ids,
 353         .suspend        = airo_suspend,
 354         .resume         = airo_resume,
 355 };
 356
 357 static int airo_cs_init(void)
 358 {
 359         return pcmcia_register_driver(&airo_driver);
 360 }
 361
 362 static void airo_cs_cleanup(void)
 363 {
 364         pcmcia_unregister_driver(&airo_driver);
 365 }
 366
 367 /*
 368     This program is free software; you can redistribute it and/or
 369     modify it under the terms of the GNU General Public License
 370     as published by the Free Software Foundation; either version 2
 371     of the License, or (at your option) any later version.
 372
 373     This program is distributed in the hope that it will be useful,
 374     but WITHOUT ANY WARRANTY; without even the implied warranty of
 375     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 376     GNU General Public License for more details.
 377
 378     In addition:
 379
 380     Redistribution and use in source and binary forms, with or without
 381     modification, are permitted provided that the following conditions
 382     are met:
 383
 384     1. Redistributions of source code must retain the above copyright
 385        notice, this list of conditions and the following disclaimer.
 386     2. Redistributions in binary form must reproduce the above copyright
 387        notice, this list of conditions and the following disclaimer in the
 388        documentation and/or other materials provided with the distribution.
 389     3. The name of the author may not be used to endorse or promote
 390        products derived from this software without specific prior written
 391        permission.
 392
 393     THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 394     IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 395     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 396     ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
 397     INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 398     (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 399     SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 400     HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 401     STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
 402     IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 403     POSSIBILITY OF SUCH DAMAGE.
 404 */
 405
 406 module_init(airo_cs_init);
 407 module_exit(airo_cs_cleanup);