sys/dev/netif/ath/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  * $FreeBSD: head/sys/dev/ath/if_ath_pci.c 192147 2009-05-15 17:02:11Z imp $
  30  * $DragonFly$
  31  */
  32
  33 #include <sys/cdefs.h>
  34
  35 /*
  36  * PCI/Cardbus front-end for the Atheros Wireless LAN controller driver.
  37  */
  38
  39 #include <sys/param.h>
  40 #include <sys/systm.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 #include <sys/bus.h>
  47 #include <sys/rman.h>
  48
  49 #include <sys/socket.h>
  50
  51 #include <net/if.h>
  52 #include <net/if_media.h>
  53 #include <net/if_arp.h>
  54
  55 #include <netproto/802_11/ieee80211_var.h>
  56
  57 #include <dev/netif/ath/ath/if_athvar.h>
  58
  59 #include <bus/pci/pcivar.h>
  60 #include <bus/pci/pcireg.h>
  61
  62 /*
  63  * PCI glue.
  64  */
  65
  66 struct ath_pci_softc {
  67         struct ath_softc        sc_sc;
  68         struct resource         *sc_sr;         /* memory resource */
  69         struct resource         *sc_irq;        /* irq resource */
  70         void                    *sc_ih;         /* interrupt handler */
  71 };
  72
  73 #define BS_BAR  0x10
  74 #define PCIR_RETRY_TIMEOUT      0x41
  75
  76 static int
  77 ath_pci_probe(device_t dev)
  78 {
  79         const char* devname;
  80
  81         devname = ath_hal_probe(pci_get_vendor(dev), pci_get_device(dev));
  82         if (devname != NULL) {
  83                 device_set_desc(dev, devname);
  84                 return BUS_PROBE_DEFAULT;
  85         }
  86         return ENXIO;
  87 }
  88
  89 static int
  90 ath_pci_attach(device_t dev)
  91 {
  92         struct ath_pci_softc *psc = device_get_softc(dev);
  93         struct ath_softc *sc = &psc->sc_sc;
  94         int error = ENXIO;
  95         int rid;
  96
  97         sc->sc_dev = dev;
  98
  99         /*
 100          * Enable bus mastering.
 101          */
 102         pci_enable_busmaster(dev);
 103
 104         /*
 105          * Disable retry timeout to keep PCI Tx retries from
 106          * interfering with C3 CPU state.
 107          */
 108         pci_write_config(dev, PCIR_RETRY_TIMEOUT, 0, 1);
 109
 110         /*
 111          * Setup memory-mapping of PCI registers.
 112          */
 113         rid = BS_BAR;
 114         psc->sc_sr = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid,
 115                                             RF_ACTIVE);
 116         if (psc->sc_sr == NULL) {
 117                 device_printf(dev, "cannot map register space\n");
 118                 goto bad;
 119         }
 120         /* XXX uintptr_t is a bandaid for ia64; to be fixed */
 121         sc->sc_st = (HAL_BUS_TAG)(uintptr_t) rman_get_bustag(psc->sc_sr);
 122         sc->sc_sh = (HAL_BUS_HANDLE) rman_get_bushandle(psc->sc_sr);
 123         /*
 124          * Mark device invalid so any interrupts (shared or otherwise)
 125          * that arrive before the HAL is setup are discarded.
 126          */
 127         sc->sc_invalid = 1;
 128
 129         /*
 130          * Arrange interrupt line.
 131          */
 132         rid = 0;
 133         psc->sc_irq = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid,
 134                                              RF_SHAREABLE|RF_ACTIVE);
 135         if (psc->sc_irq == NULL) {
 136                 device_printf(dev, "could not map interrupt\n");
 137                 goto bad1;
 138         }
 139         if (bus_setup_intr(dev, psc->sc_irq,
 140                            INTR_MPSAFE,
 141                            ath_intr, sc, &psc->sc_ih, NULL)) {
 142                 device_printf(dev, "could not establish interrupt\n");
 143                 goto bad2;
 144         }
 145
 146         /*
 147          * Setup DMA descriptor area.
 148          */
 149         if (bus_dma_tag_create(sc->sc_dmat,     /* parent */
 150                                1, 0,                    /* alignment, bounds */
 151                                BUS_SPACE_MAXADDR_32BIT, /* lowaddr */
 152                                BUS_SPACE_MAXADDR,       /* highaddr */
 153                                NULL, NULL,              /* filter, filterarg */
 154                                0x3ffff,                 /* maxsize XXX */
 155                                ATH_MAX_SCATTER,         /* nsegments */
 156                                0x3ffff,                 /* maxsegsize XXX */
 157                                BUS_DMA_ALLOCNOW,        /* flags */
 158                                &sc->sc_dmat)) {
 159                 device_printf(dev, "cannot allocate DMA tag\n");
 160                 goto bad3;
 161         }
 162
 163         ATH_LOCK_INIT(sc);
 164
 165         error = ath_attach(pci_get_device(dev), sc);
 166         if (error == 0)                                 /* success */
 167                 return 0;
 168
 169         ATH_LOCK_DESTROY(sc);
 170         bus_dma_tag_destroy(sc->sc_dmat);
 171 bad3:
 172         bus_teardown_intr(dev, psc->sc_irq, psc->sc_ih);
 173 bad2:
 174         bus_release_resource(dev, SYS_RES_IRQ, 0, psc->sc_irq);
 175 bad1:
 176         bus_release_resource(dev, SYS_RES_MEMORY, BS_BAR, psc->sc_sr);
 177 bad:
 178         return (error);
 179 }
 180
 181 static int
 182 ath_pci_detach(device_t dev)
 183 {
 184         struct ath_pci_softc *psc = device_get_softc(dev);
 185         struct ath_softc *sc = &psc->sc_sc;
 186
 187         /* check if device was removed */
 188         sc->sc_invalid = !bus_child_present(dev);
 189
 190         ath_detach(sc);
 191
 192         bus_generic_detach(dev);
 193         bus_teardown_intr(dev, psc->sc_irq, psc->sc_ih);
 194         bus_release_resource(dev, SYS_RES_IRQ, 0, psc->sc_irq);
 195
 196         bus_dma_tag_destroy(sc->sc_dmat);
 197         bus_release_resource(dev, SYS_RES_MEMORY, BS_BAR, psc->sc_sr);
 198
 199         ATH_LOCK_DESTROY(sc);
 200
 201         return (0);
 202 }
 203
 204 static int
 205 ath_pci_shutdown(device_t dev)
 206 {
 207         struct ath_pci_softc *psc = device_get_softc(dev);
 208
 209         ath_shutdown(&psc->sc_sc);
 210         return (0);
 211 }
 212
 213 static int
 214 ath_pci_suspend(device_t dev)
 215 {
 216         struct ath_pci_softc *psc = device_get_softc(dev);
 217
 218         ath_suspend(&psc->sc_sc);
 219
 220         return (0);
 221 }
 222
 223 static int
 224 ath_pci_resume(device_t dev)
 225 {
 226         struct ath_pci_softc *psc = device_get_softc(dev);
 227
 228         ath_resume(&psc->sc_sc);
 229
 230         return (0);
 231 }
 232
 233 static device_method_t ath_pci_methods[] = {
 234         /* Device interface */
 235         DEVMETHOD(device_probe,         ath_pci_probe),
 236         DEVMETHOD(device_attach,        ath_pci_attach),
 237         DEVMETHOD(device_detach,        ath_pci_detach),
 238         DEVMETHOD(device_shutdown,      ath_pci_shutdown),
 239         DEVMETHOD(device_suspend,       ath_pci_suspend),
 240         DEVMETHOD(device_resume,        ath_pci_resume),
 241
 242         { 0,0 }
 243 };
 244 static driver_t ath_pci_driver = {
 245         "ath",
 246         ath_pci_methods,
 247         sizeof (struct ath_pci_softc)
 248 };
 249 static  devclass_t ath_devclass;
 250 DRIVER_MODULE(ath, pci, ath_pci_driver, ath_devclass, 0, 0);
 251 MODULE_VERSION(ath, 1);
 252
 253 MODULE_DEPEND(ath, ath_hal, 1, 1, 1);   /* Atheros HAL */
 254 MODULE_DEPEND(ath, ath_rate, 1, 1, 1);  /* rate control algorithm */
 255 MODULE_DEPEND(ath, wlan, 1, 1, 1);      /* 802.11 media layer */