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