linux 2.6.16.38 w/ vs2.0.3-rc1
[linux-2.6.git] / drivers / net / wireless / orinoco_plx.c
index 7f006f6..210e737 100644 (file)
@@ -3,7 +3,7 @@
  * Driver for Prism II devices which would usually be driven by orinoco_cs,
  * but are connected to the PCI bus by a PLX9052.
  *
- * Current maintainers are:
+ * Current maintainers (as of 29 September 2003) are:
  *     Pavel Roskin <proski AT gnu.org>
  * and David Gibson <hermes AT gibson.dropbear.id.au>
  *
  * other provisions required by the GPL.  If you do not delete the
  * provisions above, a recipient may use your version of this file
  * under either the MPL or the GPL.
+
+ * Caution: this is experimental and probably buggy.  For success and
+ * failure reports for different cards and adaptors, see
+ * orinoco_plx_pci_id_table near the end of the file.  If you have a
+ * card we don't have the PCI id for, and looks like it should work,
+ * drop me mail with the id and "it works"/"it doesn't work".
+ *
+ * Note: if everything gets detected fine but it doesn't actually send
+ * or receive packets, your first port of call should probably be to
+ * try newer firmware in the card.  Especially if you're doing Ad-Hoc
+ * modes.
+ *
+ * The actual driving is done by orinoco.c, this is just resource
+ * allocation stuff.  The explanation below is courtesy of Ryan Niemi
+ * on the linux-wlan-ng list at
+ * http://archives.neohapsis.com/archives/dev/linux-wlan/2001-q1/0026.html
  *
- * Here's the general details on how the PLX9052 adapter works:
+ * The PLX9052-based cards (WL11000 and several others) are a
+ * different beast than the usual PCMCIA-based PRISM2 configuration
+ * expected by wlan-ng.  Here's the general details on how the WL11000
+ * PCI adapter works:
  *
  * - Two PCI I/O address spaces, one 0x80 long which contains the
  * PLX9052 registers, and one that's 0x40 long mapped to the PCMCIA
  * slot I/O address space.
  *
- * - One PCI memory address space, mapped to the PCMCIA attribute space
+ * - One PCI memory address space, mapped to the PCMCIA memory space
  * (containing the CIS).
  *
- * Using the later, you can read through the CIS data to make sure the
- * card is compatible with the driver. Keep in mind that the PCMCIA
+ * After identifying the I/O and memory space, you can read through
+ * the memory space to confirm the CIS's device ID or manufacturer ID
+ * to make sure it's the expected card.  qKeep in mind that the PCMCIA
  * spec specifies the CIS as the lower 8 bits of each word read from
  * the CIS, so to read the bytes of the CIS, read every other byte
  * (0,2,4,...). Passing that test, you need to enable the I/O address
@@ -51,7 +71,7 @@
  * within the PCI memory space. Write 0x41 to the COR register to
  * enable I/O mode and to select level triggered interrupts. To
  * confirm you actually succeeded, read the COR register back and make
- * sure it actually got set to 0x41, in case you have an unexpected
+ * sure it actually got set to 0x41, incase you have an unexpected
  * card inserted.
  *
  * Following that, you can treat the second PCI I/O address space (the
  * that, I've hot-swapped a number of times during debugging and
  * driver development for various reasons (stuck WAIT# line after the
  * radio card's firmware locks up).
+ *
+ * Hope this is enough info for someone to add PLX9052 support to the
+ * wlan-ng card. In the case of the WL11000, the PCI ID's are
+ * 0x1639/0x0200, with matching subsystem ID's. Other PLX9052-based
+ * manufacturers other than Eumitcom (or on cards other than the
+ * WL11000) may have different PCI ID's.
+ *
+ * If anyone needs any more specific info, let me know. I haven't had
+ * time to implement support myself yet, and with the way things are
+ * going, might not have time for a while..
  */
 
 #define DRIVER_NAME "orinoco_plx"
 #define PFX DRIVER_NAME ": "
 
+#include <linux/config.h>
 #include <linux/module.h>
 #include <linux/kernel.h>
 #include <linux/init.h>
 #include <pcmcia/cisreg.h>
 
 #include "orinoco.h"
-#include "orinoco_pci.h"
 
 #define COR_OFFSET     (0x3e0) /* COR attribute offset of Prism2 PC card */
 #define COR_VALUE      (COR_LEVEL_REQ | COR_FUNC_ENA) /* Enable PC card with interrupt in level trigger */
 #define PLX_INTCSR             0x4c /* Interrupt Control & Status Register */
 #define PLX_INTCSR_INTEN       (1<<6) /* Interrupt Enable bit */
 
+static const u8 cis_magic[] = {
+       0x01, 0x03, 0x00, 0x00, 0xff, 0x17, 0x04, 0x67
+};
+
+/* Orinoco PLX specific data */
+struct orinoco_plx_card {
+       void __iomem *attr_mem;
+};
+
 /*
  * Do a soft reset of the card using the Configuration Option Register
  */
 static int orinoco_plx_cor_reset(struct orinoco_private *priv)
 {
        hermes_t *hw = &priv->hw;
-       struct orinoco_pci_card *card = priv->card;
+       struct orinoco_plx_card *card = priv->card;
+       u8 __iomem *attr_mem = card->attr_mem;
        unsigned long timeout;
        u16 reg;
 
-       iowrite8(COR_VALUE | COR_RESET, card->attr_io + COR_OFFSET);
+       writeb(COR_VALUE | COR_RESET, attr_mem + COR_OFFSET);
        mdelay(1);
 
-       iowrite8(COR_VALUE, card->attr_io + COR_OFFSET);
+       writeb(COR_VALUE, attr_mem + COR_OFFSET);
        mdelay(1);
 
        /* Just in case, wait more until the card is no longer busy */
@@ -128,7 +168,7 @@ static int orinoco_plx_cor_reset(struct orinoco_private *priv)
                reg = hermes_read_regn(hw, CMD);
        }
 
-       /* Still busy? */
+       /* Did we timeout ? */
        if (reg & HERMES_CMD_BUSY) {
                printk(KERN_ERR PFX "Busy timeout\n");
                return -ETIMEDOUT;
@@ -137,55 +177,20 @@ static int orinoco_plx_cor_reset(struct orinoco_private *priv)
        return 0;
 }
 
-static int orinoco_plx_hw_init(struct orinoco_pci_card *card)
-{
-       int i;
-       u32 csr_reg;
-       static const u8 cis_magic[] = {
-               0x01, 0x03, 0x00, 0x00, 0xff, 0x17, 0x04, 0x67
-       };
-
-       printk(KERN_DEBUG PFX "CIS: ");
-       for (i = 0; i < 16; i++) {
-               printk("%02X:", ioread8(card->attr_io + (i << 1)));
-       }
-       printk("\n");
-
-       /* Verify whether a supported PC card is present */
-       /* FIXME: we probably need to be smarted about this */
-       for (i = 0; i < sizeof(cis_magic); i++) {
-               if (cis_magic[i] != ioread8(card->attr_io + (i << 1))) {
-                       printk(KERN_ERR PFX "The CIS value of Prism2 PC "
-                              "card is unexpected\n");
-                       return -ENODEV;
-               }
-       }
-
-       /* bjoern: We need to tell the card to enable interrupts, in
-          case the serial eprom didn't do this already.  See the
-          PLX9052 data book, p8-1 and 8-24 for reference. */
-       csr_reg = ioread32(card->bridge_io + PLX_INTCSR);
-       if (!(csr_reg & PLX_INTCSR_INTEN)) {
-               csr_reg |= PLX_INTCSR_INTEN;
-               iowrite32(csr_reg, card->bridge_io + PLX_INTCSR);
-               csr_reg = ioread32(card->bridge_io + PLX_INTCSR);
-               if (!(csr_reg & PLX_INTCSR_INTEN)) {
-                       printk(KERN_ERR PFX "Cannot enable interrupts\n");
-                       return -EIO;
-               }
-       }
-
-       return 0;
-}
 
 static int orinoco_plx_init_one(struct pci_dev *pdev,
                                const struct pci_device_id *ent)
 {
-       int err;
-       struct orinoco_private *priv;
-       struct orinoco_pci_card *card;
-       struct net_device *dev;
-       void __iomem *hermes_io, *attr_io, *bridge_io;
+       int err = 0;
+       u8 __iomem *attr_mem = NULL;
+       u32 csr_reg, plx_addr;
+       struct orinoco_private *priv = NULL;
+       struct orinoco_plx_card *card;
+       unsigned long pccard_ioaddr = 0;
+       unsigned long pccard_iolen = 0;
+       struct net_device *dev = NULL;
+       void __iomem *mem;
+       int i;
 
        err = pci_enable_device(pdev);
        if (err) {
@@ -194,30 +199,30 @@ static int orinoco_plx_init_one(struct pci_dev *pdev,
        }
 
        err = pci_request_regions(pdev, DRIVER_NAME);
-       if (err) {
+       if (err != 0) {
                printk(KERN_ERR PFX "Cannot obtain PCI resources\n");
                goto fail_resources;
        }
 
-       bridge_io = pci_iomap(pdev, 1, 0);
-       if (!bridge_io) {
-               printk(KERN_ERR PFX "Cannot map bridge registers\n");
-               err = -EIO;
-               goto fail_map_bridge;
-       }
+       /* Resource 1 is mapped to PLX-specific registers */
+       plx_addr = pci_resource_start(pdev, 1);
 
-       attr_io = pci_iomap(pdev, 2, 0);
-       if (!attr_io) {
-               printk(KERN_ERR PFX "Cannot map PCMCIA attributes\n");
-               err = -EIO;
+       /* Resource 2 is mapped to the PCMCIA attribute memory */
+       attr_mem = ioremap(pci_resource_start(pdev, 2),
+                          pci_resource_len(pdev, 2));
+       if (!attr_mem) {
+               printk(KERN_ERR PFX "Cannot remap PCMCIA space\n");
                goto fail_map_attr;
        }
 
-       hermes_io = pci_iomap(pdev, 3, 0);
-       if (!hermes_io) {
-               printk(KERN_ERR PFX "Cannot map chipset registers\n");
-               err = -EIO;
-               goto fail_map_hermes;
+       /* Resource 3 is mapped to the PCMCIA I/O address space */
+       pccard_ioaddr = pci_resource_start(pdev, 3);
+       pccard_iolen = pci_resource_len(pdev, 3);
+
+       mem = pci_iomap(pdev, 3, 0);
+       if (!mem) {
+               err = -ENOMEM;
+               goto fail_map_io;
        }
 
        /* Allocate network device */
@@ -230,25 +235,38 @@ static int orinoco_plx_init_one(struct pci_dev *pdev,
 
        priv = netdev_priv(dev);
        card = priv->card;
-       card->bridge_io = bridge_io;
-       card->attr_io = attr_io;
+       card->attr_mem = attr_mem;
+       dev->base_addr = pccard_ioaddr;
        SET_MODULE_OWNER(dev);
        SET_NETDEV_DEV(dev, &pdev->dev);
 
-       hermes_struct_init(&priv->hw, hermes_io, HERMES_16BIT_REGSPACING);
+       hermes_struct_init(&priv->hw, mem, HERMES_16BIT_REGSPACING);
 
-       err = request_irq(pdev->irq, orinoco_interrupt, IRQF_SHARED,
+       printk(KERN_DEBUG PFX "Detected Orinoco/Prism2 PLX device "
+              "at %s irq:%d, io addr:0x%lx\n", pci_name(pdev), pdev->irq,
+              pccard_ioaddr);
+
+       err = request_irq(pdev->irq, orinoco_interrupt, SA_SHIRQ,
                          dev->name, dev);
        if (err) {
                printk(KERN_ERR PFX "Cannot allocate IRQ %d\n", pdev->irq);
                err = -EBUSY;
                goto fail_irq;
        }
+       dev->irq = pdev->irq;
 
-       err = orinoco_plx_hw_init(card);
-       if (err) {
-               printk(KERN_ERR PFX "Hardware initialization failed\n");
-               goto fail;
+       /* bjoern: We need to tell the card to enable interrupts, in
+          case the serial eprom didn't do this already.  See the
+          PLX9052 data book, p8-1 and 8-24 for reference. */
+       csr_reg = inl(plx_addr + PLX_INTCSR);
+       if (!(csr_reg & PLX_INTCSR_INTEN)) {
+               csr_reg |= PLX_INTCSR_INTEN;
+               outl(csr_reg, plx_addr + PLX_INTCSR);
+               csr_reg = inl(plx_addr + PLX_INTCSR);
+               if (!(csr_reg & PLX_INTCSR_INTEN)) {
+                       printk(KERN_ERR PFX "Cannot enable interrupts\n");
+                       goto fail;
+               }
        }
 
        err = orinoco_plx_cor_reset(priv);
@@ -257,6 +275,23 @@ static int orinoco_plx_init_one(struct pci_dev *pdev,
                goto fail;
        }
 
+       printk(KERN_DEBUG PFX "CIS: ");
+       for (i = 0; i < 16; i++) {
+               printk("%02X:", readb(attr_mem + 2*i));
+       }
+       printk("\n");
+
+       /* Verify whether a supported PC card is present */
+       /* FIXME: we probably need to be smarted about this */
+       for (i = 0; i < sizeof(cis_magic); i++) {
+               if (cis_magic[i] != readb(attr_mem +2*i)) {
+                       printk(KERN_ERR PFX "The CIS value of Prism2 PC "
+                              "card is unexpected\n");
+                       err = -EIO;
+                       goto fail;
+               }
+       }
+
        err = register_netdev(dev);
        if (err) {
                printk(KERN_ERR PFX "Cannot register network device\n");
@@ -264,8 +299,6 @@ static int orinoco_plx_init_one(struct pci_dev *pdev,
        }
 
        pci_set_drvdata(pdev, dev);
-       printk(KERN_DEBUG "%s: " DRIVER_NAME " at %s\n", dev->name,
-              pci_name(pdev));
 
        return 0;
 
@@ -277,15 +310,12 @@ static int orinoco_plx_init_one(struct pci_dev *pdev,
        free_orinocodev(dev);
 
  fail_alloc:
-       pci_iounmap(pdev, hermes_io);
+       pci_iounmap(pdev, mem);
 
- fail_map_hermes:
-       pci_iounmap(pdev, attr_io);
+ fail_map_io:
+       iounmap(attr_mem);
 
  fail_map_attr:
-       pci_iounmap(pdev, bridge_io);
-
- fail_map_bridge:
        pci_release_regions(pdev);
 
  fail_resources:
@@ -298,20 +328,23 @@ static void __devexit orinoco_plx_remove_one(struct pci_dev *pdev)
 {
        struct net_device *dev = pci_get_drvdata(pdev);
        struct orinoco_private *priv = netdev_priv(dev);
-       struct orinoco_pci_card *card = priv->card;
+       struct orinoco_plx_card *card = priv->card;
+       u8 __iomem *attr_mem = card->attr_mem;
+
+       BUG_ON(! dev);
 
        unregister_netdev(dev);
-       free_irq(pdev->irq, dev);
+       free_irq(dev->irq, dev);
        pci_set_drvdata(pdev, NULL);
        free_orinocodev(dev);
        pci_iounmap(pdev, priv->hw.iobase);
-       pci_iounmap(pdev, card->attr_io);
-       pci_iounmap(pdev, card->bridge_io);
+       iounmap(attr_mem);
        pci_release_regions(pdev);
        pci_disable_device(pdev);
 }
 
-static struct pci_device_id orinoco_plx_id_table[] = {
+
+static struct pci_device_id orinoco_plx_pci_id_table[] = {
        {0x111a, 0x1023, PCI_ANY_ID, PCI_ANY_ID,},      /* Siemens SpeedStream SS1023 */
        {0x1385, 0x4100, PCI_ANY_ID, PCI_ANY_ID,},      /* Netgear MA301 */
        {0x15e8, 0x0130, PCI_ANY_ID, PCI_ANY_ID,},      /* Correga  - does this work? */
@@ -329,15 +362,13 @@ static struct pci_device_id orinoco_plx_id_table[] = {
        {0,},
 };
 
-MODULE_DEVICE_TABLE(pci, orinoco_plx_id_table);
+MODULE_DEVICE_TABLE(pci, orinoco_plx_pci_id_table);
 
 static struct pci_driver orinoco_plx_driver = {
        .name           = DRIVER_NAME,
-       .id_table       = orinoco_plx_id_table,
+       .id_table       = orinoco_plx_pci_id_table,
        .probe          = orinoco_plx_init_one,
        .remove         = __devexit_p(orinoco_plx_remove_one),
-       .suspend        = orinoco_pci_suspend,
-       .resume         = orinoco_pci_resume,
 };
 
 static char version[] __initdata = DRIVER_NAME " " DRIVER_VERSION
@@ -357,6 +388,7 @@ static int __init orinoco_plx_init(void)
 static void __exit orinoco_plx_exit(void)
 {
        pci_unregister_driver(&orinoco_plx_driver);
+       ssleep(1);
 }
 
 module_init(orinoco_plx_init);