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         /* Interrupt setup */
 136         p_dev->irq.Attributes = IRQ_TYPE_DYNAMIC_SHARING;
 137         p_dev->irq.IRQInfo1 = IRQ_LEVEL_ID;
 138         p_dev->irq.Handler = NULL;
 139
 140         /*
 141           General socket configuration defaults can go here.  In this
 142           client, we assume very little, and rely on the CIS for almost
 143           everything.  In most clients, many details (i.e., number, sizes,
 144           and attributes of IO windows) are fixed by the nature of the
 145           device, and can be hard-wired here.
 146         */
 147         p_dev->conf.Attributes = 0;
 148         p_dev->conf.IntType = INT_MEMORY_AND_IO;
 149
 150         /* Allocate space for private device-specific data */
 151         local = kzalloc(sizeof(local_info_t), GFP_KERNEL);
 152         if (!local) {
 153                 printk(KERN_ERR "airo_cs: no memory for new device\n");
 154                 return -ENOMEM;
 155         }
 156         p_dev->priv = local;
 157
 158         return airo_config(p_dev);
 159 } /* airo_attach */
 160
 161 /*======================================================================
 162
 163   This deletes a driver "instance".  The device is de-registered
 164   with Card Services.  If it has been released, all local data
 165   structures are freed.  Otherwise, the structures will be freed
 166   when the device is released.
 167
 168   ======================================================================*/
 169
 170 static void airo_detach(struct pcmcia_device *link)
 171 {
 172         dev_dbg(&link->dev, "airo_detach\n");
 173
 174         airo_release(link);
 175
 176         if (((local_info_t *)link->priv)->eth_dev) {
 177                 stop_airo_card(((local_info_t *)link->priv)->eth_dev, 0);
 178         }
 179         ((local_info_t *)link->priv)->eth_dev = NULL;
 180
 181         kfree(link->priv);
 182 } /* airo_detach */
 183
 184 /*======================================================================
 185
 186   airo_config() is scheduled to run after a CARD_INSERTION event
 187   is received, to configure the PCMCIA socket, and to make the
 188   device available to the system.
 189
 190   ======================================================================*/
 191
 192 static int airo_cs_config_check(struct pcmcia_device *p_dev,
 193                                 cistpl_cftable_entry_t *cfg,
 194                                 cistpl_cftable_entry_t *dflt,
 195                                 unsigned int vcc,
 196                                 void *priv_data)
 197 {
 198         win_req_t *req = priv_data;
 199
 200         if (cfg->index == 0)
 201                 return -ENODEV;
 202
 203         /* Does this card need audio output? */
 204         if (cfg->flags & CISTPL_CFTABLE_AUDIO) {
 205                 p_dev->conf.Attributes |= CONF_ENABLE_SPKR;
 206                 p_dev->conf.Status = CCSR_AUDIO_ENA;
 207         }
 208
 209         /* Use power settings for Vcc and Vpp if present */
 210         /*  Note that the CIS values need to be rescaled */
 211         if (cfg->vpp1.present & (1<<CISTPL_POWER_VNOM))
 212                 p_dev->conf.Vpp = cfg->vpp1.param[CISTPL_POWER_VNOM]/10000;
 213         else if (dflt->vpp1.present & (1<<CISTPL_POWER_VNOM))
 214                 p_dev->conf.Vpp = dflt->vpp1.param[CISTPL_POWER_VNOM]/10000;
 215
 216         /* Do we need to allocate an interrupt? */
 217         if (cfg->irq.IRQInfo1 || dflt->irq.IRQInfo1)
 218                 p_dev->conf.Attributes |= CONF_ENABLE_IRQ;
 219
 220         /* IO window settings */
 221         p_dev->io.NumPorts1 = p_dev->io.NumPorts2 = 0;
 222         if ((cfg->io.nwin > 0) || (dflt->io.nwin > 0)) {
 223                 cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &dflt->io;
 224                 p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
 225                 if (!(io->flags & CISTPL_IO_8BIT))
 226                         p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_16;
 227                 if (!(io->flags & CISTPL_IO_16BIT))
 228                         p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
 229                 p_dev->io.BasePort1 = io->win[0].base;
 230                 p_dev->io.NumPorts1 = io->win[0].len;
 231                 if (io->nwin > 1) {
 232                         p_dev->io.Attributes2 = p_dev->io.Attributes1;
 233                         p_dev->io.BasePort2 = io->win[1].base;
 234                         p_dev->io.NumPorts2 = io->win[1].len;
 235                 }
 236         }
 237
 238         /* This reserves IO space but doesn't actually enable it */
 239         if (pcmcia_request_io(p_dev, &p_dev->io) != 0)
 240                 return -ENODEV;
 241
 242         /*
 243           Now set up a common memory window, if needed.  There is room
 244           in the struct pcmcia_device structure for one memory window handle,
 245           but if the base addresses need to be saved, or if multiple
 246           windows are needed, the info should go in the private data
 247           structure for this device.
 248
 249           Note that the memory window base is a physical address, and
 250           needs to be mapped to virtual space with ioremap() before it
 251           is used.
 252         */
 253         if ((cfg->mem.nwin > 0) || (dflt->mem.nwin > 0)) {
 254                 cistpl_mem_t *mem = (cfg->mem.nwin) ? &cfg->mem : &dflt->mem;
 255                 memreq_t map;
 256                 req->Attributes = WIN_DATA_WIDTH_16|WIN_MEMORY_TYPE_CM;
 257                 req->Base = mem->win[0].host_addr;
 258                 req->Size = mem->win[0].len;
 259                 req->AccessSpeed = 0;
 260                 if (pcmcia_request_window(p_dev, req, &p_dev->win) != 0)
 261                         return -ENODEV;
 262                 map.Page = 0;
 263                 map.CardOffset = mem->win[0].card_addr;
 264                 if (pcmcia_map_mem_page(p_dev, p_dev->win, &map) != 0)
 265                         return -ENODEV;
 266         }
 267         /* If we got this far, we're cool! */
 268         return 0;
 269 }
 270
 271
 272 static int airo_config(struct pcmcia_device *link)
 273 {
 274         local_info_t *dev;
 275         win_req_t *req;
 276         int ret;
 277
 278         dev = link->priv;
 279
 280         dev_dbg(&link->dev, "airo_config\n");
 281
 282         req = kzalloc(sizeof(win_req_t), GFP_KERNEL);
 283         if (!req)
 284                 return -ENOMEM;
 285
 286         /*
 287          * In this loop, we scan the CIS for configuration table
 288          * entries, each of which describes a valid card
 289          * configuration, including voltage, IO window, memory window,
 290          * and interrupt settings.
 291          *
 292          * We make no assumptions about the card to be configured: we
 293          * use just the information available in the CIS.  In an ideal
 294          * world, this would work for any PCMCIA card, but it requires
 295          * a complete and accurate CIS.  In practice, a driver usually
 296          * "knows" most of these things without consulting the CIS,
 297          * and most client drivers will only use the CIS to fill in
 298          * implementation-defined details.
 299          */
 300         ret = pcmcia_loop_config(link, airo_cs_config_check, req);
 301         if (ret)
 302                 goto failed;
 303
 304         /*
 305           Allocate an interrupt line.  Note that this does not assign a
 306           handler to the interrupt, unless the 'Handler' member of the
 307           irq structure is initialized.
 308         */
 309         if (link->conf.Attributes & CONF_ENABLE_IRQ) {
 310                 ret = pcmcia_request_irq(link, &link->irq);
 311                 if (ret)
 312                         goto failed;
 313         }
 314
 315         /*
 316           This actually configures the PCMCIA socket -- setting up
 317           the I/O windows and the interrupt mapping, and putting the
 318           card and host interface into "Memory and IO" mode.
 319         */
 320         ret = pcmcia_request_configuration(link, &link->conf);
 321         if (ret)
 322                 goto failed;
 323         ((local_info_t *)link->priv)->eth_dev =
 324                 init_airo_card(link->irq.AssignedIRQ,
 325                                link->io.BasePort1, 1, &link->dev);
 326         if (!((local_info_t *)link->priv)->eth_dev)
 327                 goto failed;
 328
 329         /*
 330           At this point, the dev_node_t structure(s) need to be
 331           initialized and arranged in a linked list at link->dev_node.
 332         */
 333         strcpy(dev->node.dev_name, ((local_info_t *)link->priv)->eth_dev->name);
 334         dev->node.major = dev->node.minor = 0;
 335         link->dev_node = &dev->node;
 336
 337         /* Finally, report what we've done */
 338         printk(KERN_INFO "%s: index 0x%02x: ",
 339                dev->node.dev_name, link->conf.ConfigIndex);
 340         if (link->conf.Vpp)
 341                 printk(", Vpp %d.%d", link->conf.Vpp/10, link->conf.Vpp%10);
 342         if (link->conf.Attributes & CONF_ENABLE_IRQ)
 343                 printk(", irq %d", link->irq.AssignedIRQ);
 344         if (link->io.NumPorts1)
 345                 printk(", io 0x%04x-0x%04x", link->io.BasePort1,
 346                        link->io.BasePort1+link->io.NumPorts1-1);
 347         if (link->io.NumPorts2)
 348                 printk(" & 0x%04x-0x%04x", link->io.BasePort2,
 349                        link->io.BasePort2+link->io.NumPorts2-1);
 350         if (link->win)
 351                 printk(", mem 0x%06lx-0x%06lx", req->Base,
 352                        req->Base+req->Size-1);
 353         printk("\n");
 354         kfree(req);
 355         return 0;
 356
 357  failed:
 358         airo_release(link);
 359         kfree(req);
 360         return -ENODEV;
 361 } /* airo_config */
 362
 363 /*======================================================================
 364
 365   After a card is removed, airo_release() will unregister the
 366   device, and release the PCMCIA configuration.  If the device is
 367   still open, this will be postponed until it is closed.
 368
 369   ======================================================================*/
 370
 371 static void airo_release(struct pcmcia_device *link)
 372 {
 373         dev_dbg(&link->dev, "airo_release\n");
 374         pcmcia_disable_device(link);
 375 }
 376
 377 static int airo_suspend(struct pcmcia_device *link)
 378 {
 379         local_info_t *local = link->priv;
 380
 381         netif_device_detach(local->eth_dev);
 382
 383         return 0;
 384 }
 385
 386 static int airo_resume(struct pcmcia_device *link)
 387 {
 388         local_info_t *local = link->priv;
 389
 390         if (link->open) {
 391                 reset_airo_card(local->eth_dev);
 392                 netif_device_attach(local->eth_dev);
 393         }
 394
 395         return 0;
 396 }
 397
 398 static struct pcmcia_device_id airo_ids[] = {
 399         PCMCIA_DEVICE_MANF_CARD(0x015f, 0x000a),
 400         PCMCIA_DEVICE_MANF_CARD(0x015f, 0x0005),
 401         PCMCIA_DEVICE_MANF_CARD(0x015f, 0x0007),
 402         PCMCIA_DEVICE_MANF_CARD(0x0105, 0x0007),
 403         PCMCIA_DEVICE_NULL,
 404 };
 405 MODULE_DEVICE_TABLE(pcmcia, airo_ids);
 406
 407 static struct pcmcia_driver airo_driver = {
 408         .owner          = THIS_MODULE,
 409         .drv            = {
 410                 .name   = "airo_cs",
 411         },
 412         .probe          = airo_probe,
 413         .remove         = airo_detach,
 414         .id_table       = airo_ids,
 415         .suspend        = airo_suspend,
 416         .resume         = airo_resume,
 417 };
 418
 419 static int airo_cs_init(void)
 420 {
 421         return pcmcia_register_driver(&airo_driver);
 422 }
 423
 424 static void airo_cs_cleanup(void)
 425 {
 426         pcmcia_unregister_driver(&airo_driver);
 427 }
 428
 429 /*
 430     This program is free software; you can redistribute it and/or
 431     modify it under the terms of the GNU General Public License
 432     as published by the Free Software Foundation; either version 2
 433     of the License, or (at your option) any later version.
 434
 435     This program is distributed in the hope that it will be useful,
 436     but WITHOUT ANY WARRANTY; without even the implied warranty of
 437     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 438     GNU General Public License for more details.
 439
 440     In addition:
 441
 442     Redistribution and use in source and binary forms, with or without
 443     modification, are permitted provided that the following conditions
 444     are met:
 445
 446     1. Redistributions of source code must retain the above copyright
 447        notice, this list of conditions and the following disclaimer.
 448     2. Redistributions in binary form must reproduce the above copyright
 449        notice, this list of conditions and the following disclaimer in the
 450        documentation and/or other materials provided with the distribution.
 451     3. The name of the author may not be used to endorse or promote
 452        products derived from this software without specific prior written
 453        permission.
 454
 455     THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 456     IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 457     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 458     ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
 459     INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 460     (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 461     SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 462     HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 463     STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
 464     IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 465     POSSIBILITY OF SUCH DAMAGE.
 466 */
 467
 468 module_init(airo_cs_init);
 469 module_exit(airo_cs_cleanup);