sys/dev/ath/if_ath_pci.c

   1 /*-
   2  * Copyright (c) 2002-2008 Sam Leffler, Errno Consulting
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer,
  10  *    without modification.
  11  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  12  *    similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any
  13  *    redistribution must be conditioned upon including a substantially
  14  *    similar Disclaimer requirement for further binary redistribution.
  15  *
  16  * NO WARRANTY
  17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  18  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  19  * LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY
  20  * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
  21  * THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY,
  22  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
  25  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  26  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  27  * THE POSSIBILITY OF SUCH DAMAGES.
  28  */
  29
  30 #include <sys/cdefs.h>
  31 __FBSDID("$FreeBSD$");
  32
  33 /*
  34  * PCI/Cardbus front-end for the Atheros Wireless LAN controller driver.
  35  */
  36 #include "opt_ath.h"
  37
  38 #include <sys/param.h>
  39 #include <sys/systm.h>
  40 #include <sys/malloc.h>
  41 #include <sys/module.h>
  42 #include <sys/kernel.h>
  43 #include <sys/lock.h>
  44 #include <sys/mutex.h>
  45 #include <sys/errno.h>
  46
  47 #include <machine/bus.h>
  48 #include <machine/resource.h>
  49 #include <sys/bus.h>
  50 #include <sys/rman.h>
  51
  52 #include <sys/socket.h>
  53
  54 #include <net/if.h>
  55 #include <net/if_media.h>
  56 #include <net/if_arp.h>
  57 #include <net/ethernet.h>
  58
  59 #include <net80211/ieee80211_var.h>
  60
  61 #include <dev/ath/if_athvar.h>
  62
  63 #include <dev/pci/pcivar.h>
  64 #include <dev/pci/pcireg.h>
  65
  66 /* For EEPROM firmware */
  67 #ifdef  ATH_EEPROM_FIRMWARE
  68 #include <sys/linker.h>
  69 #include <sys/firmware.h>
  70 #endif  /* ATH_EEPROM_FIRMWARE */
  71
  72 /*
  73  * PCI glue.
  74  */
  75
  76 struct ath_pci_softc {
  77         struct ath_softc        sc_sc;
  78         struct resource         *sc_sr;         /* memory resource */
  79         struct resource         *sc_irq;        /* irq resource */
  80         void                    *sc_ih;         /* interrupt handler */
  81 };
  82
  83 #define BS_BAR  0x10
  84 #define PCIR_RETRY_TIMEOUT      0x41
  85 #define PCIR_CFG_PMCSR          0x48
  86
  87 #define DEFAULT_CACHESIZE       32
  88
  89 static void
  90 ath_pci_setup(device_t dev)
  91 {
  92         uint8_t cz;
  93
  94         /* XXX TODO: need to override the _system_ saved copies of this */
  95
  96         /*
  97          * If the cache line size is 0, force it to a reasonable
  98          * value.
  99          */
 100         cz = pci_read_config(dev, PCIR_CACHELNSZ, 1);
 101         if (cz == 0) {
 102                 pci_write_config(dev, PCIR_CACHELNSZ,
 103                     DEFAULT_CACHESIZE / 4, 1);
 104         }
 105
 106         /* Override the system latency timer */
 107         pci_write_config(dev, PCIR_LATTIMER, 0xa8, 1);
 108
 109         /* If a PCI NIC, force wakeup */
 110 #ifdef  ATH_PCI_WAKEUP_WAR
 111         /* XXX TODO: don't do this for non-PCI (ie, PCIe, Cardbus!) */
 112         if (1) {
 113                 uint16_t pmcsr;
 114                 pmcsr = pci_read_config(dev, PCIR_CFG_PMCSR, 2);
 115                 pmcsr |= 3;
 116                 pci_write_config(dev, PCIR_CFG_PMCSR, pmcsr, 2);
 117                 pmcsr &= ~3;
 118                 pci_write_config(dev, PCIR_CFG_PMCSR, pmcsr, 2);
 119         }
 120 #endif
 121
 122         /*
 123          * Disable retry timeout to keep PCI Tx retries from
 124          * interfering with C3 CPU state.
 125          */
 126         pci_write_config(dev, PCIR_RETRY_TIMEOUT, 0, 1);
 127 }
 128
 129 static int
 130 ath_pci_probe(device_t dev)
 131 {
 132         const char* devname;
 133
 134         devname = ath_hal_probe(pci_get_vendor(dev), pci_get_device(dev));
 135         if (devname != NULL) {
 136                 device_set_desc(dev, devname);
 137                 return BUS_PROBE_DEFAULT;
 138         }
 139         return ENXIO;
 140 }
 141
 142 static int
 143 ath_pci_attach(device_t dev)
 144 {
 145         struct ath_pci_softc *psc = device_get_softc(dev);
 146         struct ath_softc *sc = &psc->sc_sc;
 147         int error = ENXIO;
 148         int rid;
 149 #ifdef  ATH_EEPROM_FIRMWARE
 150         const struct firmware *fw = NULL;
 151         const char *buf;
 152 #endif
 153
 154         sc->sc_dev = dev;
 155
 156         /*
 157          * Enable bus mastering.
 158          */
 159         pci_enable_busmaster(dev);
 160
 161         /*
 162          * Setup other PCI bus configuration parameters.
 163          */
 164         ath_pci_setup(dev);
 165
 166         /*
 167          * Setup memory-mapping of PCI registers.
 168          */
 169         rid = BS_BAR;
 170         psc->sc_sr = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid,
 171                                             RF_ACTIVE);
 172         if (psc->sc_sr == NULL) {
 173                 device_printf(dev, "cannot map register space\n");
 174                 goto bad;
 175         }
 176         /* XXX uintptr_t is a bandaid for ia64; to be fixed */
 177         sc->sc_st = (HAL_BUS_TAG)(uintptr_t) rman_get_bustag(psc->sc_sr);
 178         sc->sc_sh = (HAL_BUS_HANDLE) rman_get_bushandle(psc->sc_sr);
 179         /*
 180          * Mark device invalid so any interrupts (shared or otherwise)
 181          * that arrive before the HAL is setup are discarded.
 182          */
 183         sc->sc_invalid = 1;
 184
 185         /*
 186          * Arrange interrupt line.
 187          */
 188         rid = 0;
 189         psc->sc_irq = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid,
 190                                              RF_SHAREABLE|RF_ACTIVE);
 191         if (psc->sc_irq == NULL) {
 192                 device_printf(dev, "could not map interrupt\n");
 193                 goto bad1;
 194         }
 195         if (bus_setup_intr(dev, psc->sc_irq,
 196                            INTR_TYPE_NET | INTR_MPSAFE,
 197                            NULL, ath_intr, sc, &psc->sc_ih)) {
 198                 device_printf(dev, "could not establish interrupt\n");
 199                 goto bad2;
 200         }
 201
 202         /*
 203          * Setup DMA descriptor area.
 204          */
 205         if (bus_dma_tag_create(bus_get_dma_tag(dev),    /* parent */
 206                                1, 0,                    /* alignment, bounds */
 207                                BUS_SPACE_MAXADDR_32BIT, /* lowaddr */
 208                                BUS_SPACE_MAXADDR,       /* highaddr */
 209                                NULL, NULL,              /* filter, filterarg */
 210                                0x3ffff,                 /* maxsize XXX */
 211                                ATH_MAX_SCATTER,         /* nsegments */
 212                                0x3ffff,                 /* maxsegsize XXX */
 213                                BUS_DMA_ALLOCNOW,        /* flags */
 214                                NULL,                    /* lockfunc */
 215                                NULL,                    /* lockarg */
 216                                &sc->sc_dmat)) {
 217                 device_printf(dev, "cannot allocate DMA tag\n");
 218                 goto bad3;
 219         }
 220
 221 #ifdef  ATH_EEPROM_FIRMWARE
 222         /*
 223          * If there's an EEPROM firmware image, load that in.
 224          */
 225         if (resource_string_value(device_get_name(dev), device_get_unit(dev),
 226             "eeprom_firmware", &buf) == 0) {
 227                 if (bootverbose)
 228                         device_printf(dev, "%s: looking up firmware @ '%s'\n",
 229                             __func__, buf);
 230
 231                 fw = firmware_get(buf);
 232                 if (fw == NULL) {
 233                         device_printf(dev, "%s: couldn't find firmware\n",
 234                             __func__);
 235                         goto bad3;
 236                 }
 237
 238                 device_printf(dev, "%s: EEPROM firmware @ %p\n",
 239                     __func__, fw->data);
 240                 sc->sc_eepromdata =
 241                     malloc(fw->datasize, M_TEMP, M_WAITOK | M_ZERO);
 242                 if (! sc->sc_eepromdata) {
 243                         device_printf(dev, "%s: can't malloc eepromdata\n",
 244                             __func__);
 245                         goto bad3;
 246                 }
 247                 memcpy(sc->sc_eepromdata, fw->data, fw->datasize);
 248                 firmware_put(fw, 0);
 249         }
 250 #endif /* ATH_EEPROM_FIRMWARE */
 251
 252         ATH_LOCK_INIT(sc);
 253         ATH_PCU_LOCK_INIT(sc);
 254         ATH_RX_LOCK_INIT(sc);
 255         ATH_TX_LOCK_INIT(sc);
 256         ATH_TX_IC_LOCK_INIT(sc);
 257         ATH_TXSTATUS_LOCK_INIT(sc);
 258
 259         error = ath_attach(pci_get_device(dev), sc);
 260         if (error == 0)                                 /* success */
 261                 return 0;
 262
 263         ATH_TXSTATUS_LOCK_DESTROY(sc);
 264         ATH_PCU_LOCK_DESTROY(sc);
 265         ATH_RX_LOCK_DESTROY(sc);
 266         ATH_TX_IC_LOCK_DESTROY(sc);
 267         ATH_TX_LOCK_DESTROY(sc);
 268         ATH_LOCK_DESTROY(sc);
 269         bus_dma_tag_destroy(sc->sc_dmat);
 270 bad3:
 271         bus_teardown_intr(dev, psc->sc_irq, psc->sc_ih);
 272 bad2:
 273         bus_release_resource(dev, SYS_RES_IRQ, 0, psc->sc_irq);
 274 bad1:
 275         bus_release_resource(dev, SYS_RES_MEMORY, BS_BAR, psc->sc_sr);
 276 bad:
 277         return (error);
 278 }
 279
 280 static int
 281 ath_pci_detach(device_t dev)
 282 {
 283         struct ath_pci_softc *psc = device_get_softc(dev);
 284         struct ath_softc *sc = &psc->sc_sc;
 285
 286         /* check if device was removed */
 287         sc->sc_invalid = !bus_child_present(dev);
 288
 289         /*
 290          * Do a config read to clear pre-existing pci error status.
 291          */
 292         (void) pci_read_config(dev, PCIR_COMMAND, 4);
 293
 294         ath_detach(sc);
 295
 296         bus_generic_detach(dev);
 297         bus_teardown_intr(dev, psc->sc_irq, psc->sc_ih);
 298         bus_release_resource(dev, SYS_RES_IRQ, 0, psc->sc_irq);
 299
 300         bus_dma_tag_destroy(sc->sc_dmat);
 301         bus_release_resource(dev, SYS_RES_MEMORY, BS_BAR, psc->sc_sr);
 302
 303         if (sc->sc_eepromdata)
 304                 free(sc->sc_eepromdata, M_TEMP);
 305
 306         ATH_TXSTATUS_LOCK_DESTROY(sc);
 307         ATH_PCU_LOCK_DESTROY(sc);
 308         ATH_RX_LOCK_DESTROY(sc);
 309         ATH_TX_IC_LOCK_DESTROY(sc);
 310         ATH_TX_LOCK_DESTROY(sc);
 311         ATH_LOCK_DESTROY(sc);
 312
 313         return (0);
 314 }
 315
 316 static int
 317 ath_pci_shutdown(device_t dev)
 318 {
 319         struct ath_pci_softc *psc = device_get_softc(dev);
 320
 321         ath_shutdown(&psc->sc_sc);
 322         return (0);
 323 }
 324
 325 static int
 326 ath_pci_suspend(device_t dev)
 327 {
 328         struct ath_pci_softc *psc = device_get_softc(dev);
 329
 330         ath_suspend(&psc->sc_sc);
 331
 332         return (0);
 333 }
 334
 335 static int
 336 ath_pci_resume(device_t dev)
 337 {
 338         struct ath_pci_softc *psc = device_get_softc(dev);
 339
 340         /*
 341          * Suspend/resume resets the PCI configuration space.
 342          */
 343         ath_pci_setup(dev);
 344
 345         ath_resume(&psc->sc_sc);
 346
 347         return (0);
 348 }
 349
 350 static device_method_t ath_pci_methods[] = {
 351         /* Device interface */
 352         DEVMETHOD(device_probe,         ath_pci_probe),
 353         DEVMETHOD(device_attach,        ath_pci_attach),
 354         DEVMETHOD(device_detach,        ath_pci_detach),
 355         DEVMETHOD(device_shutdown,      ath_pci_shutdown),
 356         DEVMETHOD(device_suspend,       ath_pci_suspend),
 357         DEVMETHOD(device_resume,        ath_pci_resume),
 358
 359         { 0,0 }
 360 };
 361 static driver_t ath_pci_driver = {
 362         "ath",
 363         ath_pci_methods,
 364         sizeof (struct ath_pci_softc)
 365 };
 366 static  devclass_t ath_devclass;
 367 DRIVER_MODULE(ath_pci, pci, ath_pci_driver, ath_devclass, 0, 0);
 368 MODULE_VERSION(ath_pci, 1);
 369 MODULE_DEPEND(ath_pci, wlan, 1, 1, 1);          /* 802.11 media layer */
 370 MODULE_DEPEND(ath_pci, if_ath, 1, 1, 1);        /* if_ath driver */