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