SAFE public projects git trees. - safe/jmp/linux-2.6/blob - drivers/net/wireless/orinoco/spectrum_cs.c

   1 /*
   2  * Driver for 802.11b cards using RAM-loadable Symbol firmware, such as
   3  * Symbol Wireless Networker LA4137, CompactFlash cards by Socket
   4  * Communications and Intel PRO/Wireless 2011B.
   5  *
   6  * The driver implements Symbol firmware download.  The rest is handled
   7  * in hermes.c and main.c.
   8  *
   9  * Utilities for downloading the Symbol firmware are available at
  10  * http://sourceforge.net/projects/orinoco/
  11  *
  12  * Copyright (C) 2002-2005 Pavel Roskin <proski@gnu.org>
  13  * Portions based on orinoco_cs.c:
  14  *      Copyright (C) David Gibson, Linuxcare Australia
  15  * Portions based on Spectrum24tDnld.c from original spectrum24 driver:
  16  *      Copyright (C) Symbol Technologies.
  17  *
  18  * See copyright notice in file main.c.
  19  */
  20
  21 #define DRIVER_NAME "spectrum_cs"
  22 #define PFX DRIVER_NAME ": "
  23
  24 #include <linux/module.h>
  25 #include <linux/kernel.h>
  26 #include <linux/init.h>
  27 #include <linux/delay.h>
  28 #include <pcmcia/cs_types.h>
  29 #include <pcmcia/cs.h>
  30 #include <pcmcia/cistpl.h>
  31 #include <pcmcia/cisreg.h>
  32 #include <pcmcia/ds.h>
  33
  34 #include "orinoco.h"
  35
  36 /********************************************************************/
  37 /* Module stuff                                                     */
  38 /********************************************************************/
  39
  40 MODULE_AUTHOR("Pavel Roskin <proski@gnu.org>");
  41 MODULE_DESCRIPTION("Driver for Symbol Spectrum24 Trilogy cards with firmware downloader");
  42 MODULE_LICENSE("Dual MPL/GPL");
  43
  44 /* Module parameters */
  45
  46 /* Some D-Link cards have buggy CIS. They do work at 5v properly, but
  47  * don't have any CIS entry for it. This workaround it... */
  48 static int ignore_cis_vcc; /* = 0 */
  49 module_param(ignore_cis_vcc, int, 0);
  50 MODULE_PARM_DESC(ignore_cis_vcc, "Allow voltage mismatch between card and socket");
  51
  52 /********************************************************************/
  53 /* Data structures                                                  */
  54 /********************************************************************/
  55
  56 /* PCMCIA specific device information (goes in the card field of
  57  * struct orinoco_private */
  58 struct orinoco_pccard {
  59         struct pcmcia_device    *p_dev;
  60         dev_node_t node;
  61 };
  62
  63 /********************************************************************/
  64 /* Function prototypes                                              */
  65 /********************************************************************/
  66
  67 static int spectrum_cs_config(struct pcmcia_device *link);
  68 static void spectrum_cs_release(struct pcmcia_device *link);
  69
  70 /* Constants for the CISREG_CCSR register */
  71 #define HCR_RUN         0x07    /* run firmware after reset */
  72 #define HCR_IDLE        0x0E    /* don't run firmware after reset */
  73 #define HCR_MEM16       0x10    /* memory width bit, should be preserved */
  74
  75
  76 /*
  77  * Reset the card using configuration registers COR and CCSR.
  78  * If IDLE is 1, stop the firmware, so that it can be safely rewritten.
  79  */
  80 static int
  81 spectrum_reset(struct pcmcia_device *link, int idle)
  82 {
  83         int ret;
  84         conf_reg_t reg;
  85         u_int save_cor;
  86
  87         /* Doing it if hardware is gone is guaranteed crash */
  88         if (!pcmcia_dev_present(link))
  89                 return -ENODEV;
  90
  91         /* Save original COR value */
  92         reg.Function = 0;
  93         reg.Action = CS_READ;
  94         reg.Offset = CISREG_COR;
  95         ret = pcmcia_access_configuration_register(link, &reg);
  96         if (ret)
  97                 goto failed;
  98         save_cor = reg.Value;
  99
 100         /* Soft-Reset card */
 101         reg.Action = CS_WRITE;
 102         reg.Offset = CISREG_COR;
 103         reg.Value = (save_cor | COR_SOFT_RESET);
 104         ret = pcmcia_access_configuration_register(link, &reg);
 105         if (ret)
 106                 goto failed;
 107         udelay(1000);
 108
 109         /* Read CCSR */
 110         reg.Action = CS_READ;
 111         reg.Offset = CISREG_CCSR;
 112         ret = pcmcia_access_configuration_register(link, &reg);
 113         if (ret)
 114                 goto failed;
 115
 116         /*
 117          * Start or stop the firmware.  Memory width bit should be
 118          * preserved from the value we've just read.
 119          */
 120         reg.Action = CS_WRITE;
 121         reg.Offset = CISREG_CCSR;
 122         reg.Value = (idle ? HCR_IDLE : HCR_RUN) | (reg.Value & HCR_MEM16);
 123         ret = pcmcia_access_configuration_register(link, &reg);
 124         if (ret)
 125                 goto failed;
 126         udelay(1000);
 127
 128         /* Restore original COR configuration index */
 129         reg.Action = CS_WRITE;
 130         reg.Offset = CISREG_COR;
 131         reg.Value = (save_cor & ~COR_SOFT_RESET);
 132         ret = pcmcia_access_configuration_register(link, &reg);
 133         if (ret)
 134                 goto failed;
 135         udelay(1000);
 136         return 0;
 137
 138 failed:
 139         return -ENODEV;
 140 }
 141
 142 /********************************************************************/
 143 /* Device methods                                                   */
 144 /********************************************************************/
 145
 146 static int
 147 spectrum_cs_hard_reset(struct orinoco_private *priv)
 148 {
 149         struct orinoco_pccard *card = priv->card;
 150         struct pcmcia_device *link = card->p_dev;
 151
 152         /* Soft reset using COR and HCR */
 153         spectrum_reset(link, 0);
 154
 155         return 0;
 156 }
 157
 158 static int
 159 spectrum_cs_stop_firmware(struct orinoco_private *priv, int idle)
 160 {
 161         struct orinoco_pccard *card = priv->card;
 162         struct pcmcia_device *link = card->p_dev;
 163
 164         return spectrum_reset(link, idle);
 165 }
 166
 167 /********************************************************************/
 168 /* PCMCIA stuff                                                     */
 169 /********************************************************************/
 170
 171 /*
 172  * This creates an "instance" of the driver, allocating local data
 173  * structures for one device.  The device is registered with Card
 174  * Services.
 175  *
 176  * The dev_link structure is initialized, but we don't actually
 177  * configure the card at this point -- we wait until we receive a card
 178  * insertion event.  */
 179 static int
 180 spectrum_cs_probe(struct pcmcia_device *link)
 181 {
 182         struct orinoco_private *priv;
 183         struct orinoco_pccard *card;
 184
 185         priv = alloc_orinocodev(sizeof(*card), &handle_to_dev(link),
 186                                 spectrum_cs_hard_reset,
 187                                 spectrum_cs_stop_firmware);
 188         if (!priv)
 189                 return -ENOMEM;
 190         card = priv->card;
 191
 192         /* Link both structures together */
 193         card->p_dev = link;
 194         link->priv = priv;
 195
 196         /* Interrupt setup */
 197         link->irq.Attributes = IRQ_TYPE_DYNAMIC_SHARING | IRQ_HANDLE_PRESENT;
 198         link->irq.IRQInfo1 = IRQ_LEVEL_ID;
 199         link->irq.Handler = orinoco_interrupt;
 200         link->irq.Instance = priv;
 201
 202         /* General socket configuration defaults can go here.  In this
 203          * client, we assume very little, and rely on the CIS for
 204          * almost everything.  In most clients, many details (i.e.,
 205          * number, sizes, and attributes of IO windows) are fixed by
 206          * the nature of the device, and can be hard-wired here. */
 207         link->conf.Attributes = 0;
 208         link->conf.IntType = INT_MEMORY_AND_IO;
 209
 210         return spectrum_cs_config(link);
 211 }                               /* spectrum_cs_attach */
 212
 213 /*
 214  * This deletes a driver "instance".  The device is de-registered with
 215  * Card Services.  If it has been released, all local data structures
 216  * are freed.  Otherwise, the structures will be freed when the device
 217  * is released.
 218  */
 219 static void spectrum_cs_detach(struct pcmcia_device *link)
 220 {
 221         struct orinoco_private *priv = link->priv;
 222
 223         if (link->dev_node)
 224                 orinoco_if_del(priv);
 225
 226         spectrum_cs_release(link);
 227
 228         free_orinocodev(priv);
 229 }                               /* spectrum_cs_detach */
 230
 231 /*
 232  * spectrum_cs_config() is scheduled to run after a CARD_INSERTION
 233  * event is received, to configure the PCMCIA socket, and to make the
 234  * device available to the system.
 235  */
 236
 237 static int spectrum_cs_config_check(struct pcmcia_device *p_dev,
 238                                     cistpl_cftable_entry_t *cfg,
 239                                     cistpl_cftable_entry_t *dflt,
 240                                     unsigned int vcc,
 241                                     void *priv_data)
 242 {
 243         if (cfg->index == 0)
 244                 goto next_entry;
 245
 246         /* Use power settings for Vcc and Vpp if present */
 247         /* Note that the CIS values need to be rescaled */
 248         if (cfg->vcc.present & (1 << CISTPL_POWER_VNOM)) {
 249                 if (vcc != cfg->vcc.param[CISTPL_POWER_VNOM] / 10000) {
 250                         DEBUG(2, "%s: Vcc mismatch (vcc = %d, CIS = %d)\n",
 251                               __func__, vcc,
 252                               cfg->vcc.param[CISTPL_POWER_VNOM] / 10000);
 253                         if (!ignore_cis_vcc)
 254                                 goto next_entry;
 255                 }
 256         } else if (dflt->vcc.present & (1 << CISTPL_POWER_VNOM)) {
 257                 if (vcc != dflt->vcc.param[CISTPL_POWER_VNOM] / 10000) {
 258                         DEBUG(2, "%s: Vcc mismatch (vcc = %d, CIS = %d)\n",
 259                               __func__, vcc,
 260                               dflt->vcc.param[CISTPL_POWER_VNOM] / 10000);
 261                         if (!ignore_cis_vcc)
 262                                 goto next_entry;
 263                 }
 264         }
 265
 266         if (cfg->vpp1.present & (1 << CISTPL_POWER_VNOM))
 267                 p_dev->conf.Vpp =
 268                         cfg->vpp1.param[CISTPL_POWER_VNOM] / 10000;
 269         else if (dflt->vpp1.present & (1 << CISTPL_POWER_VNOM))
 270                 p_dev->conf.Vpp =
 271                         dflt->vpp1.param[CISTPL_POWER_VNOM] / 10000;
 272
 273         /* Do we need to allocate an interrupt? */
 274         p_dev->conf.Attributes |= CONF_ENABLE_IRQ;
 275
 276         /* IO window settings */
 277         p_dev->io.NumPorts1 = p_dev->io.NumPorts2 = 0;
 278         if ((cfg->io.nwin > 0) || (dflt->io.nwin > 0)) {
 279                 cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &dflt->io;
 280                 p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
 281                 if (!(io->flags & CISTPL_IO_8BIT))
 282                         p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_16;
 283                 if (!(io->flags & CISTPL_IO_16BIT))
 284                         p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
 285                 p_dev->io.IOAddrLines = io->flags & CISTPL_IO_LINES_MASK;
 286                 p_dev->io.BasePort1 = io->win[0].base;
 287                 p_dev->io.NumPorts1 = io->win[0].len;
 288                 if (io->nwin > 1) {
 289                         p_dev->io.Attributes2 = p_dev->io.Attributes1;
 290                         p_dev->io.BasePort2 = io->win[1].base;
 291                         p_dev->io.NumPorts2 = io->win[1].len;
 292                 }
 293
 294                 /* This reserves IO space but doesn't actually enable it */
 295                 if (pcmcia_request_io(p_dev, &p_dev->io) != 0)
 296                         goto next_entry;
 297         }
 298         return 0;
 299
 300 next_entry:
 301         pcmcia_disable_device(p_dev);
 302         return -ENODEV;
 303 };
 304
 305 static int
 306 spectrum_cs_config(struct pcmcia_device *link)
 307 {
 308         struct orinoco_private *priv = link->priv;
 309         struct orinoco_pccard *card = priv->card;
 310         hermes_t *hw = &priv->hw;
 311         int ret;
 312         void __iomem *mem;
 313
 314         /*
 315          * In this loop, we scan the CIS for configuration table
 316          * entries, each of which describes a valid card
 317          * configuration, including voltage, IO window, memory window,
 318          * and interrupt settings.
 319          *
 320          * We make no assumptions about the card to be configured: we
 321          * use just the information available in the CIS.  In an ideal
 322          * world, this would work for any PCMCIA card, but it requires
 323          * a complete and accurate CIS.  In practice, a driver usually
 324          * "knows" most of these things without consulting the CIS,
 325          * and most client drivers will only use the CIS to fill in
 326          * implementation-defined details.
 327          */
 328         ret = pcmcia_loop_config(link, spectrum_cs_config_check, NULL);
 329         if (ret) {
 330                 if (!ignore_cis_vcc)
 331                         printk(KERN_ERR PFX "GetNextTuple(): No matching "
 332                                "CIS configuration.  Maybe you need the "
 333                                "ignore_cis_vcc=1 parameter.\n");
 334                 goto failed;
 335         }
 336
 337         /*
 338          * Allocate an interrupt line.  Note that this does not assign
 339          * a handler to the interrupt, unless the 'Handler' member of
 340          * the irq structure is initialized.
 341          */
 342         ret = pcmcia_request_irq(link, &link->irq);
 343         if (ret)
 344                 goto failed;
 345
 346         /* We initialize the hermes structure before completing PCMCIA
 347          * configuration just in case the interrupt handler gets
 348          * called. */
 349         mem = ioport_map(link->io.BasePort1, link->io.NumPorts1);
 350         if (!mem)
 351                 goto failed;
 352
 353         hermes_struct_init(hw, mem, HERMES_16BIT_REGSPACING);
 354
 355         /*
 356          * This actually configures the PCMCIA socket -- setting up
 357          * the I/O windows and the interrupt mapping, and putting the
 358          * card and host interface into "Memory and IO" mode.
 359          */
 360         ret = pcmcia_request_configuration(link, &link->conf);
 361         if (ret)
 362                 goto failed;
 363
 364         /* Ok, we have the configuration, prepare to register the netdev */
 365         card->node.major = card->node.minor = 0;
 366
 367         /* Reset card */
 368         if (spectrum_cs_hard_reset(priv) != 0)
 369                 goto failed;
 370
 371         /* Initialise the main driver */
 372         if (orinoco_init(priv) != 0) {
 373                 printk(KERN_ERR PFX "orinoco_init() failed\n");
 374                 goto failed;
 375         }
 376
 377         /* Register an interface with the stack */
 378         if (orinoco_if_add(priv, link->io.BasePort1,
 379                            link->irq.AssignedIRQ) != 0) {
 380                 printk(KERN_ERR PFX "orinoco_if_add() failed\n");
 381                 goto failed;
 382         }
 383
 384         /* At this point, the dev_node_t structure(s) needs to be
 385          * initialized and arranged in a linked list at link->dev_node. */
 386         strcpy(card->node.dev_name, priv->ndev->name);
 387         link->dev_node = &card->node; /* link->dev_node being non-NULL is also
 388                                        * used to indicate that the
 389                                        * net_device has been registered */
 390         return 0;
 391
 392  failed:
 393         spectrum_cs_release(link);
 394         return -ENODEV;
 395 }                               /* spectrum_cs_config */
 396
 397 /*
 398  * After a card is removed, spectrum_cs_release() will unregister the
 399  * device, and release the PCMCIA configuration.  If the device is
 400  * still open, this will be postponed until it is closed.
 401  */
 402 static void
 403 spectrum_cs_release(struct pcmcia_device *link)
 404 {
 405         struct orinoco_private *priv = link->priv;
 406         unsigned long flags;
 407
 408         /* We're committed to taking the device away now, so mark the
 409          * hardware as unavailable */
 410         spin_lock_irqsave(&priv->lock, flags);
 411         priv->hw_unavailable++;
 412         spin_unlock_irqrestore(&priv->lock, flags);
 413
 414         pcmcia_disable_device(link);
 415         if (priv->hw.iobase)
 416                 ioport_unmap(priv->hw.iobase);
 417 }                               /* spectrum_cs_release */
 418
 419
 420 static int
 421 spectrum_cs_suspend(struct pcmcia_device *link)
 422 {
 423         struct orinoco_private *priv = link->priv;
 424         int err = 0;
 425
 426         /* Mark the device as stopped, to block IO until later */
 427         orinoco_down(priv);
 428
 429         return err;
 430 }
 431
 432 static int
 433 spectrum_cs_resume(struct pcmcia_device *link)
 434 {
 435         struct orinoco_private *priv = link->priv;
 436         int err = orinoco_up(priv);
 437
 438         return err;
 439 }
 440
 441
 442 /********************************************************************/
 443 /* Module initialization                                            */
 444 /********************************************************************/
 445
 446 /* Can't be declared "const" or the whole __initdata section will
 447  * become const */
 448 static char version[] __initdata = DRIVER_NAME " " DRIVER_VERSION
 449         " (Pavel Roskin <proski@gnu.org>,"
 450         " David Gibson <hermes@gibson.dropbear.id.au>, et al)";
 451
 452 static struct pcmcia_device_id spectrum_cs_ids[] = {
 453         PCMCIA_DEVICE_MANF_CARD(0x026c, 0x0001), /* Symbol Spectrum24 LA4137 */
 454         PCMCIA_DEVICE_MANF_CARD(0x0104, 0x0001), /* Socket Communications CF */
 455         PCMCIA_DEVICE_PROD_ID12("Intel", "PRO/Wireless LAN PC Card", 0x816cc815, 0x6fbf459a), /* 2011B, not 2011 */
 456         PCMCIA_DEVICE_NULL,
 457 };
 458 MODULE_DEVICE_TABLE(pcmcia, spectrum_cs_ids);
 459
 460 static struct pcmcia_driver orinoco_driver = {
 461         .owner          = THIS_MODULE,
 462         .drv            = {
 463                 .name   = DRIVER_NAME,
 464         },
 465         .probe          = spectrum_cs_probe,
 466         .remove         = spectrum_cs_detach,
 467         .suspend        = spectrum_cs_suspend,
 468         .resume         = spectrum_cs_resume,
 469         .id_table       = spectrum_cs_ids,
 470 };
 471
 472 static int __init
 473 init_spectrum_cs(void)
 474 {
 475         printk(KERN_DEBUG "%s\n", version);
 476
 477         return pcmcia_register_driver(&orinoco_driver);
 478 }
 479
 480 static void __exit
 481 exit_spectrum_cs(void)
 482 {
 483         pcmcia_unregister_driver(&orinoco_driver);
 484 }
 485
 486 module_init(init_spectrum_cs);
 487 module_exit(exit_spectrum_cs);