drivers/net/wireless/orinoco_pci.c

   1 /* orinoco_pci.c
   2  *
   3  * Driver for Prism II devices that have a direct PCI interface
   4  * (i.e., not in a Pcmcia or PLX bridge)
   5  *
   6  * Specifically here we're talking about the Linksys WMP11
   7  *
   8  * Current maintainers (as of 29 September 2003) are:
   9  *      Pavel Roskin <proski AT gnu.org>
  10  * and  David Gibson <hermes AT gibson.dropbear.id.au>
  11  *
  12  * Some of this code is borrowed from orinoco_plx.c
  13  *      Copyright (C) 2001 Daniel Barlow <dan AT telent.net>
  14  * Some of this code is "inspired" by linux-wlan-ng-0.1.10, but nothing
  15  * has been copied from it. linux-wlan-ng-0.1.10 is originally :
  16  *      Copyright (C) 1999 AbsoluteValue Systems, Inc.  All Rights Reserved.
  17  * This file originally written by:
  18  *      Copyright (C) 2001 Jean Tourrilhes <jt AT hpl.hp.com>
  19  * And is now maintained by:
  20  *      (C) Copyright David Gibson, IBM Corp. 2002-2003.
  21  *
  22  * The contents of this file are subject to the Mozilla Public License
  23  * Version 1.1 (the "License"); you may not use this file except in
  24  * compliance with the License. You may obtain a copy of the License
  25  * at http://www.mozilla.org/MPL/
  26  *
  27  * Software distributed under the License is distributed on an "AS IS"
  28  * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
  29  * the License for the specific language governing rights and
  30  * limitations under the License.
  31  *
  32  * Alternatively, the contents of this file may be used under the
  33  * terms of the GNU General Public License version 2 (the "GPL"), in
  34  * which case the provisions of the GPL are applicable instead of the
  35  * above.  If you wish to allow the use of your version of this file
  36  * only under the terms of the GPL and not to allow others to use your
  37  * version of this file under the MPL, indicate your decision by
  38  * deleting the provisions above and replace them with the notice and
  39  * other provisions required by the GPL.  If you do not delete the
  40  * provisions above, a recipient may use your version of this file
  41  * under either the MPL or the GPL.
  42  */
  43
  44 /*
  45  * Theory of operation...
  46  * -------------------
  47  * Maybe you had a look in orinoco_plx. Well, this is totally different...
  48  *
  49  * The card contains only one PCI region, which contains all the usual
  50  * hermes registers.
  51  *
  52  * The driver will memory map this region in normal memory. Because
  53  * the hermes registers are mapped in normal memory and not in ISA I/O
  54  * post space, we can't use the usual inw/outw macros and we need to
  55  * use readw/writew.
  56  * This slight difference force us to compile our own version of
  57  * hermes.c with the register access macro changed. That's a bit
  58  * hackish but works fine.
  59  *
  60  * Note that the PCI region is pretty big (4K). That's much more than
  61  * the usual set of hermes register (0x0 -> 0x3E). I've got a strong
  62  * suspicion that the whole memory space of the adapter is in fact in
  63  * this region. Accessing directly the adapter memory instead of going
  64  * through the usual register would speed up significantely the
  65  * operations...
  66  *
  67  * Finally, the card looks like this :
  68 -----------------------
  69   Bus  0, device  14, function  0:
  70     Network controller: PCI device 1260:3873 (Harris Semiconductor) (rev 1).
  71       IRQ 11.
  72       Master Capable.  Latency=248.
  73       Prefetchable 32 bit memory at 0xffbcc000 [0xffbccfff].
  74 -----------------------
  75 00:0e.0 Network controller: Harris Semiconductor: Unknown device 3873 (rev 01)
  76         Subsystem: Unknown device 1737:3874
  77         Control: I/O+ Mem+ BusMaster+ SpecCycle- MemWINV- VGASnoop- ParErr- Stepping- SERR- FastB2B-
  78         Status: Cap+ 66Mhz- UDF- FastB2B+ ParErr- DEVSEL=medium >TAbort- <TAbort- <MAbort- >SERR- <PERR-
  79         Latency: 248 set, cache line size 08
  80         Interrupt: pin A routed to IRQ 11
  81         Region 0: Memory at ffbcc000 (32-bit, prefetchable) [size=4K]
  82         Capabilities: [dc] Power Management version 2
  83                 Flags: PMEClk- AuxPwr- DSI- D1+ D2+ PME+
  84                 Status: D0 PME-Enable- DSel=0 DScale=0 PME-
  85 -----------------------
  86  *
  87  * That's all..
  88  *
  89  * Jean II
  90  */
  91
  92 #define DRIVER_NAME "orinoco_pci"
  93 #define PFX DRIVER_NAME ": "
  94
  95 #include <linux/config.h>
  96
  97 #include <linux/module.h>
  98 #include <linux/kernel.h>
  99 #include <linux/init.h>
 100 #include <linux/sched.h>
 101 #include <linux/ptrace.h>
 102 #include <linux/slab.h>
 103 #include <linux/string.h>
 104 #include <linux/timer.h>
 105 #include <linux/ioport.h>
 106 #include <linux/netdevice.h>
 107 #include <linux/if_arp.h>
 108 #include <linux/etherdevice.h>
 109 #include <linux/list.h>
 110 #include <linux/pci.h>
 111 #include <linux/fcntl.h>
 112
 113 #include <asm/uaccess.h>
 114 #include <asm/io.h>
 115 #include <asm/system.h>
 116
 117 #include "hermes.h"
 118 #include "orinoco.h"
 119
 120 /* All the magic there is from wlan-ng */
 121 /* Magic offset of the reset register of the PCI card */
 122 #define HERMES_PCI_COR          (0x26)
 123 /* Magic bitmask to reset the card */
 124 #define HERMES_PCI_COR_MASK     (0x0080)
 125 /* Magic timeouts for doing the reset.
 126  * Those times are straight from wlan-ng, and it is claimed that they
 127  * are necessary. Alan will kill me. Take your time and grab a coffee. */
 128 #define HERMES_PCI_COR_ONT      (250)           /* ms */
 129 #define HERMES_PCI_COR_OFFT     (500)           /* ms */
 130 #define HERMES_PCI_COR_BUSYT    (500)           /* ms */
 131
 132 /*
 133  * Do a soft reset of the PCI card using the Configuration Option Register
 134  * We need this to get going...
 135  * This is the part of the code that is strongly inspired from wlan-ng
 136  *
 137  * Note : This code is done with irq enabled. This mean that many
 138  * interrupts will occur while we are there. This is why we use the
 139  * jiffies to regulate time instead of a straight mdelay(). Usually we
 140  * need only around 245 iteration of the loop to do 250 ms delay.
 141  *
 142  * Note bis : Don't try to access HERMES_CMD during the reset phase.
 143  * It just won't work !
 144  */
 145 static int
 146 orinoco_pci_cor_reset(struct orinoco_private *priv)
 147 {
 148         hermes_t *hw = &priv->hw;
 149         unsigned long   timeout;
 150         u16     reg;
 151
 152         /* Assert the reset until the card notice */
 153         hermes_write_regn(hw, PCI_COR, HERMES_PCI_COR_MASK);
 154         printk(KERN_NOTICE "Reset done");
 155         timeout = jiffies + (HERMES_PCI_COR_ONT * HZ / 1000);
 156         while(time_before(jiffies, timeout)) {
 157                 printk(".");
 158                 mdelay(1);
 159         }
 160         printk(";\n");
 161         //mdelay(HERMES_PCI_COR_ONT);
 162
 163         /* Give time for the card to recover from this hard effort */
 164         hermes_write_regn(hw, PCI_COR, 0x0000);
 165         printk(KERN_NOTICE "Clear Reset");
 166         timeout = jiffies + (HERMES_PCI_COR_OFFT * HZ / 1000);
 167         while(time_before(jiffies, timeout)) {
 168                 printk(".");
 169                 mdelay(1);
 170         }
 171         printk(";\n");
 172         //mdelay(HERMES_PCI_COR_OFFT);
 173
 174         /* The card is ready when it's no longer busy */
 175         timeout = jiffies + (HERMES_PCI_COR_BUSYT * HZ / 1000);
 176         reg = hermes_read_regn(hw, CMD);
 177         while (time_before(jiffies, timeout) && (reg & HERMES_CMD_BUSY)) {
 178                 mdelay(1);
 179                 reg = hermes_read_regn(hw, CMD);
 180         }
 181         /* Did we timeout ? */
 182         if(time_after_eq(jiffies, timeout)) {
 183                 printk(KERN_ERR PFX "Busy timeout\n");
 184                 return -ETIMEDOUT;
 185         }
 186         printk(KERN_NOTICE "pci_cor : reg = 0x%X - %lX - %lX\n", reg, timeout, jiffies);
 187
 188         return 0;
 189 }
 190
 191 /*
 192  * Initialise a card. Mostly similar to PLX code.
 193  */
 194 static int orinoco_pci_init_one(struct pci_dev *pdev,
 195                                 const struct pci_device_id *ent)
 196 {
 197         int err = 0;
 198         unsigned long pci_iorange;
 199         u16 *pci_ioaddr = NULL;
 200         unsigned long pci_iolen;
 201         struct orinoco_private *priv = NULL;
 202         struct net_device *dev = NULL;
 203
 204         err = pci_enable_device(pdev);
 205         if (err)
 206                 return -EIO;
 207
 208         /* Resource 0 is mapped to the hermes registers */
 209         pci_iorange = pci_resource_start(pdev, 0);
 210         pci_iolen = pci_resource_len(pdev, 0);
 211         pci_ioaddr = ioremap(pci_iorange, pci_iolen);
 212         if (! pci_iorange)
 213                 goto fail;
 214
 215         /* Allocate network device */
 216         dev = alloc_orinocodev(0, NULL);
 217         if (! dev) {
 218                 err = -ENOMEM;
 219                 goto fail;
 220         }
 221
 222         priv = netdev_priv(dev);
 223         dev->base_addr = (unsigned long) pci_ioaddr;
 224         dev->mem_start = pci_iorange;
 225         dev->mem_end = pci_iorange + pci_iolen - 1;
 226         SET_MODULE_OWNER(dev);
 227         SET_NETDEV_DEV(dev, &pdev->dev);
 228
 229         printk(KERN_DEBUG PFX
 230                "Detected Orinoco/Prism2 PCI device at %s, mem:0x%lX to 0x%lX -> 0x%p, irq:%d\n",
 231                pci_name(pdev), dev->mem_start, dev->mem_end, pci_ioaddr, pdev->irq);
 232
 233         hermes_struct_init(&priv->hw, dev->base_addr,
 234                            HERMES_MEM, HERMES_32BIT_REGSPACING);
 235         pci_set_drvdata(pdev, dev);
 236
 237         err = request_irq(pdev->irq, orinoco_interrupt, SA_SHIRQ,
 238                           dev->name, dev);
 239         if (err) {
 240                 printk(KERN_ERR PFX "Error allocating IRQ %d.\n",
 241                        pdev->irq);
 242                 err = -EBUSY;
 243                 goto fail;
 244         }
 245         dev->irq = pdev->irq;
 246
 247         /* Perform a COR reset to start the card */
 248         if(orinoco_pci_cor_reset(priv) != 0) {
 249                 printk(KERN_ERR "%s: Failed to start the card\n", dev->name);
 250                 err = -ETIMEDOUT;
 251                 goto fail;
 252         }
 253
 254         /* Override the normal firmware detection - the Prism 2.5 PCI
 255          * cards look like Lucent firmware but are actually Intersil */
 256         priv->firmware_type = FIRMWARE_TYPE_INTERSIL;
 257
 258         err = register_netdev(dev);
 259         if (err) {
 260                 printk(KERN_ERR "%s: Failed to register net device\n", dev->name);
 261                 goto fail;
 262         }
 263
 264         return 0;
 265
 266  fail:
 267         if (dev) {
 268                 if (dev->irq)
 269                         free_irq(dev->irq, dev);
 270
 271                 free_netdev(dev);
 272         }
 273
 274         if (pci_ioaddr)
 275                 iounmap(pci_ioaddr);
 276
 277         pci_disable_device(pdev);
 278
 279         return err;
 280 }
 281
 282 static void __devexit orinoco_pci_remove_one(struct pci_dev *pdev)
 283 {
 284         struct net_device *dev = pci_get_drvdata(pdev);
 285         struct orinoco_private *priv = netdev_priv(dev);
 286
 287         unregister_netdev(dev);
 288
 289         if (dev->irq)
 290                 free_irq(dev->irq, dev);
 291
 292         if (priv->hw.iobase)
 293                 iounmap((unsigned char *) priv->hw.iobase);
 294
 295         pci_set_drvdata(pdev, NULL);
 296         free_netdev(dev);
 297
 298         pci_disable_device(pdev);
 299 }
 300
 301 static int orinoco_pci_suspend(struct pci_dev *pdev, u32 state)
 302 {
 303         struct net_device *dev = pci_get_drvdata(pdev);
 304         struct orinoco_private *priv = netdev_priv(dev);
 305         unsigned long flags;
 306         int err;
 307
 308         printk(KERN_DEBUG "%s: Orinoco-PCI entering sleep mode (state=%d)\n",
 309                dev->name, state);
 310
 311         err = orinoco_lock(priv, &flags);
 312         if (err) {
 313                 printk(KERN_ERR "%s: hw_unavailable on orinoco_pci_suspend\n",
 314                        dev->name);
 315                 return err;
 316         }
 317
 318         err = __orinoco_down(dev);
 319         if (err)
 320                 printk(KERN_WARNING "%s: orinoco_pci_suspend(): Error %d downing interface\n",
 321                        dev->name, err);
 322
 323         netif_device_detach(dev);
 324
 325         priv->hw_unavailable++;
 326
 327         orinoco_unlock(priv, &flags);
 328
 329         return 0;
 330 }
 331
 332 static int orinoco_pci_resume(struct pci_dev *pdev)
 333 {
 334         struct net_device *dev = pci_get_drvdata(pdev);
 335         struct orinoco_private *priv = netdev_priv(dev);
 336         unsigned long flags;
 337         int err;
 338
 339         printk(KERN_DEBUG "%s: Orinoco-PCI waking up\n", dev->name);
 340
 341         err = orinoco_reinit_firmware(dev);
 342         if (err) {
 343                 printk(KERN_ERR "%s: Error %d re-initializing firmware on orinoco_pci_resume()\n",
 344                        dev->name, err);
 345                 return err;
 346         }
 347
 348         spin_lock_irqsave(&priv->lock, flags);
 349
 350         netif_device_attach(dev);
 351
 352         priv->hw_unavailable--;
 353
 354         if (priv->open && (! priv->hw_unavailable)) {
 355                 err = __orinoco_up(dev);
 356                 if (err)
 357                         printk(KERN_ERR "%s: Error %d restarting card on orinoco_pci_resume()\n",
 358                                dev->name, err);
 359         }
 360
 361         spin_unlock_irqrestore(&priv->lock, flags);
 362
 363         return 0;
 364 }
 365
 366 static struct pci_device_id orinoco_pci_pci_id_table[] = {
 367         /* Intersil Prism 3 */
 368         {0x1260, 0x3872, PCI_ANY_ID, PCI_ANY_ID,},
 369         /* Intersil Prism 2.5 */
 370         {0x1260, 0x3873, PCI_ANY_ID, PCI_ANY_ID,},
 371         {0,},
 372 };
 373
 374 MODULE_DEVICE_TABLE(pci, orinoco_pci_pci_id_table);
 375
 376 static struct pci_driver orinoco_pci_driver = {
 377         .name           = DRIVER_NAME,
 378         .id_table       = orinoco_pci_pci_id_table,
 379         .probe          = orinoco_pci_init_one,
 380         .remove         = __devexit_p(orinoco_pci_remove_one),
 381         .suspend        = orinoco_pci_suspend,
 382         .resume         = orinoco_pci_resume,
 383 };
 384
 385 static char version[] __initdata = DRIVER_NAME " " DRIVER_VERSION
 386         " (Pavel Roskin <proski@gnu.org>,"
 387         " David Gibson <hermes@gibson.dropbear.id.au> &"
 388         " Jean Tourrilhes <jt@hpl.hp.com>)";
 389 MODULE_AUTHOR("Pavel Roskin <proski@gnu.org> & David Gibson <hermes@gibson.dropbear.id.au>");
 390 MODULE_DESCRIPTION("Driver for wireless LAN cards using direct PCI interface");
 391 MODULE_LICENSE("Dual MPL/GPL");
 392
 393 static int __init orinoco_pci_init(void)
 394 {
 395         printk(KERN_DEBUG "%s\n", version);
 396         return pci_module_init(&orinoco_pci_driver);
 397 }
 398
 399 static void __exit orinoco_pci_exit(void)
 400 {
 401         pci_unregister_driver(&orinoco_pci_driver);
 402 }
 403
 404 module_init(orinoco_pci_init);
 405 module_exit(orinoco_pci_exit);
 406
 407 /*
 408  * Local variables:
 409  *  c-indent-level: 8
 410  *  c-basic-offset: 8
 411  *  tab-width: 8
 412  * End:
 413  */