sys/dev/ath/if_ath_ahb.c

   1 /*-
   2  * Copyright (c) 2002-2008 Sam Leffler, Errno Consulting
   3  * Copyright (c) 2010-2011 Adrian Chadd, Xenion Pty Ltd
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer,
  11  *    without modification.
  12  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  13  *    similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any
  14  *    redistribution must be conditioned upon including a substantially
  15  *    similar Disclaimer requirement for further binary redistribution.
  16  *
  17  * NO WARRANTY
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY
  21  * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
  22  * THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY,
  23  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
  26  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  28  * THE POSSIBILITY OF SUCH DAMAGES.
  29  */
  30
  31 #include <sys/cdefs.h>
  32 __FBSDID("$FreeBSD$");
  33
  34 /*
  35  * AHB bus front-end for the Atheros Wireless LAN controller driver.
  36  */
  37
  38 #include "opt_ath.h"
  39
  40 #include <sys/param.h>
  41 #include <sys/systm.h>
  42 #include <sys/malloc.h>
  43 #include <sys/module.h>
  44 #include <sys/kernel.h>
  45 #include <sys/lock.h>
  46 #include <sys/mutex.h>
  47 #include <sys/errno.h>
  48
  49 #include <machine/bus.h>
  50 #include <machine/resource.h>
  51 #include <sys/bus.h>
  52 #include <sys/rman.h>
  53
  54 #include <sys/socket.h>
  55
  56 #include <net/if.h>
  57 #include <net/if_media.h>
  58 #include <net/if_arp.h>
  59 #include <net/ethernet.h>
  60
  61 #include <net80211/ieee80211_var.h>
  62
  63 #include <dev/ath/if_athvar.h>
  64
  65 #include <mips/atheros/ar71xxreg.h>
  66 #include <mips/atheros/ar91xxreg.h>
  67 #include <mips/atheros/ar71xx_cpudef.h>
  68
  69 /*
  70  * bus glue.
  71  */
  72
  73 /* number of 16 bit words */
  74 #define ATH_EEPROM_DATA_SIZE    2048
  75
  76 struct ath_ahb_softc {
  77         struct ath_softc        sc_sc;
  78         struct resource         *sc_sr;         /* memory resource */
  79         struct resource         *sc_irq;        /* irq resource */
  80         struct resource         *sc_eeprom;     /* eeprom location */
  81         void                    *sc_ih;         /* interrupt handler */
  82 };
  83
  84 #define VENDOR_ATHEROS  0x168c
  85 #define AR9130_DEVID    0x000b
  86
  87 static int
  88 ath_ahb_probe(device_t dev)
  89 {
  90         int vendor_id, device_id;
  91         const char* devname;
  92
  93         /*
  94          * Check if a device/vendor ID is provided in hints.
  95          */
  96         if (resource_int_value(device_get_name(dev), device_get_unit(dev),
  97             "vendor_id", &vendor_id) != 0) {
  98                 vendor_id = VENDOR_ATHEROS;
  99         }
 100
 101         if (resource_int_value(device_get_name(dev), device_get_unit(dev),
 102             "device_id", &device_id) != 0) {
 103                 device_id = AR9130_DEVID;
 104         }
 105
 106         device_printf(dev, "Vendor=0x%04x, Device=0x%04x\n",
 107             vendor_id & 0xffff,
 108             device_id & 0xffff);
 109
 110         /* Attempt to probe */
 111         devname = ath_hal_probe(vendor_id, device_id);
 112
 113         if (devname != NULL) {
 114                 device_set_desc(dev, devname);
 115                 return BUS_PROBE_DEFAULT;
 116         }
 117         return ENXIO;
 118 }
 119
 120 static int
 121 ath_ahb_attach(device_t dev)
 122 {
 123         struct ath_ahb_softc *psc = device_get_softc(dev);
 124         struct ath_softc *sc = &psc->sc_sc;
 125         int error = ENXIO;
 126         int rid;
 127         long eepromaddr;
 128         int eepromsize;
 129         uint8_t *p;
 130         int device_id, vendor_id;
 131
 132         sc->sc_dev = dev;
 133
 134         rid = 0;
 135         psc->sc_sr = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid, RF_ACTIVE);
 136         if (psc->sc_sr == NULL) {
 137                 device_printf(dev, "cannot map register space\n");
 138                 goto bad;
 139         }
 140
 141         if (resource_long_value(device_get_name(dev), device_get_unit(dev),
 142             "eepromaddr", &eepromaddr) != 0) {
 143                 device_printf(dev, "cannot fetch 'eepromaddr' from hints\n");
 144                 goto bad0;
 145         }
 146
 147         /*
 148          * The default EEPROM size is 2048 * 16 bit words.
 149          * Later EEPROM/OTP/flash regions may be quite a bit bigger.
 150          */
 151         if (resource_int_value(device_get_name(dev), device_get_unit(dev),
 152             "eepromsize", &eepromsize) != 0) {
 153                 eepromsize = ATH_EEPROM_DATA_SIZE * 2;
 154         }
 155
 156
 157         rid = 0;
 158         device_printf(sc->sc_dev, "eeprom @ %p (%d bytes)\n",
 159             (void *) eepromaddr, eepromsize);
 160         psc->sc_eeprom = bus_alloc_resource(dev, SYS_RES_MEMORY, &rid, (uintptr_t) eepromaddr,
 161           (uintptr_t) eepromaddr + (uintptr_t) (eepromsize - 1), 0, RF_ACTIVE);
 162         if (psc->sc_eeprom == NULL) {
 163                 device_printf(dev, "cannot map eeprom space\n");
 164                 goto bad0;
 165         }
 166
 167         sc->sc_st = (HAL_BUS_TAG) rman_get_bustag(psc->sc_sr);
 168         sc->sc_sh = (HAL_BUS_HANDLE) rman_get_bushandle(psc->sc_sr);
 169         /*
 170          * Mark device invalid so any interrupts (shared or otherwise)
 171          * that arrive before the HAL is setup are discarded.
 172          */
 173         sc->sc_invalid = 1;
 174
 175         /* Copy the EEPROM data out */
 176         sc->sc_eepromdata = malloc(eepromsize, M_TEMP, M_NOWAIT | M_ZERO);
 177         if (sc->sc_eepromdata == NULL) {
 178                 device_printf(dev, "cannot allocate memory for eeprom data\n");
 179                 goto bad1;
 180         }
 181         device_printf(sc->sc_dev, "eeprom data @ %p\n", (void *) rman_get_bushandle(psc->sc_eeprom));
 182         /* XXX why doesn't this work? -adrian */
 183 #if 0
 184         bus_space_read_multi_1(
 185             rman_get_bustag(psc->sc_eeprom),
 186             rman_get_bushandle(psc->sc_eeprom),
 187             0, (u_int8_t *) sc->sc_eepromdata, eepromsize);
 188 #endif
 189         p = (void *) rman_get_bushandle(psc->sc_eeprom);
 190         memcpy(sc->sc_eepromdata, p, eepromsize);
 191
 192         /*
 193          * Arrange interrupt line.
 194          */
 195         rid = 0;
 196         psc->sc_irq = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, RF_SHAREABLE|RF_ACTIVE);
 197         if (psc->sc_irq == NULL) {
 198                 device_printf(dev, "could not map interrupt\n");
 199                 goto bad1;
 200         }
 201         if (bus_setup_intr(dev, psc->sc_irq,
 202                            INTR_TYPE_NET | INTR_MPSAFE,
 203                            NULL, ath_intr, sc, &psc->sc_ih)) {
 204                 device_printf(dev, "could not establish interrupt\n");
 205                 goto bad2;
 206         }
 207
 208         /*
 209          * Setup DMA descriptor area.
 210          */
 211         if (bus_dma_tag_create(bus_get_dma_tag(dev),    /* parent */
 212                                1, 0,                    /* alignment, bounds */
 213                                BUS_SPACE_MAXADDR_32BIT, /* lowaddr */
 214                                BUS_SPACE_MAXADDR,       /* highaddr */
 215                                NULL, NULL,              /* filter, filterarg */
 216                                0x3ffff,                 /* maxsize XXX */
 217                                ATH_MAX_SCATTER,         /* nsegments */
 218                                0x3ffff,                 /* maxsegsize XXX */
 219                                BUS_DMA_ALLOCNOW,        /* flags */
 220                                NULL,                    /* lockfunc */
 221                                NULL,                    /* lockarg */
 222                                &sc->sc_dmat)) {
 223                 device_printf(dev, "cannot allocate DMA tag\n");
 224                 goto bad3;
 225         }
 226
 227         /*
 228          * Check if a device/vendor ID is provided in hints.
 229          */
 230         if (resource_int_value(device_get_name(dev), device_get_unit(dev),
 231             "vendor_id", &vendor_id) != 0) {
 232                 vendor_id = VENDOR_ATHEROS;
 233         }
 234
 235         if (resource_int_value(device_get_name(dev), device_get_unit(dev),
 236             "device_id", &device_id) != 0) {
 237                 device_id = AR9130_DEVID;
 238         }
 239
 240         ATH_LOCK_INIT(sc);
 241         ATH_PCU_LOCK_INIT(sc);
 242         ATH_RX_LOCK_INIT(sc);
 243         ATH_TX_LOCK_INIT(sc);
 244         ATH_TX_IC_LOCK_INIT(sc);
 245         ATH_TXSTATUS_LOCK_INIT(sc);
 246
 247         error = ath_attach(device_id, sc);
 248         if (error == 0)                                 /* success */
 249                 return 0;
 250
 251         ATH_TXSTATUS_LOCK_DESTROY(sc);
 252         ATH_RX_LOCK_DESTROY(sc);
 253         ATH_TX_LOCK_DESTROY(sc);
 254         ATH_TX_IC_LOCK_DESTROY(sc);
 255         ATH_PCU_LOCK_DESTROY(sc);
 256         ATH_LOCK_DESTROY(sc);
 257         bus_dma_tag_destroy(sc->sc_dmat);
 258 bad3:
 259         bus_teardown_intr(dev, psc->sc_irq, psc->sc_ih);
 260 bad2:
 261         bus_release_resource(dev, SYS_RES_IRQ, 0, psc->sc_irq);
 262 bad1:
 263         bus_release_resource(dev, SYS_RES_MEMORY, 0, psc->sc_eeprom);
 264 bad0:
 265         bus_release_resource(dev, SYS_RES_MEMORY, 0, psc->sc_sr);
 266 bad:
 267         /* XXX?! */
 268         if (sc->sc_eepromdata)
 269                 free(sc->sc_eepromdata, M_TEMP);
 270         return (error);
 271 }
 272
 273 static int
 274 ath_ahb_detach(device_t dev)
 275 {
 276         struct ath_ahb_softc *psc = device_get_softc(dev);
 277         struct ath_softc *sc = &psc->sc_sc;
 278
 279         /* check if device was removed */
 280         sc->sc_invalid = !bus_child_present(dev);
 281
 282         ath_detach(sc);
 283
 284         bus_generic_detach(dev);
 285         bus_teardown_intr(dev, psc->sc_irq, psc->sc_ih);
 286         bus_release_resource(dev, SYS_RES_IRQ, 0, psc->sc_irq);
 287
 288         bus_dma_tag_destroy(sc->sc_dmat);
 289         bus_release_resource(dev, SYS_RES_MEMORY, 0, psc->sc_sr);
 290         bus_release_resource(dev, SYS_RES_MEMORY, 0, psc->sc_eeprom);
 291         /* XXX?! */
 292         if (sc->sc_eepromdata)
 293                 free(sc->sc_eepromdata, M_TEMP);
 294
 295         ATH_TXSTATUS_LOCK_DESTROY(sc);
 296         ATH_RX_LOCK_DESTROY(sc);
 297         ATH_TX_LOCK_DESTROY(sc);
 298         ATH_TX_IC_LOCK_DESTROY(sc);
 299         ATH_PCU_LOCK_DESTROY(sc);
 300         ATH_LOCK_DESTROY(sc);
 301
 302         return (0);
 303 }
 304
 305 static int
 306 ath_ahb_shutdown(device_t dev)
 307 {
 308         struct ath_ahb_softc *psc = device_get_softc(dev);
 309
 310         ath_shutdown(&psc->sc_sc);
 311         return (0);
 312 }
 313
 314 static int
 315 ath_ahb_suspend(device_t dev)
 316 {
 317         struct ath_ahb_softc *psc = device_get_softc(dev);
 318
 319         ath_suspend(&psc->sc_sc);
 320
 321         return (0);
 322 }
 323
 324 static int
 325 ath_ahb_resume(device_t dev)
 326 {
 327         struct ath_ahb_softc *psc = device_get_softc(dev);
 328
 329         ath_resume(&psc->sc_sc);
 330
 331         return (0);
 332 }
 333
 334 static device_method_t ath_ahb_methods[] = {
 335         /* Device interface */
 336         DEVMETHOD(device_probe,         ath_ahb_probe),
 337         DEVMETHOD(device_attach,        ath_ahb_attach),
 338         DEVMETHOD(device_detach,        ath_ahb_detach),
 339         DEVMETHOD(device_shutdown,      ath_ahb_shutdown),
 340         DEVMETHOD(device_suspend,       ath_ahb_suspend),
 341         DEVMETHOD(device_resume,        ath_ahb_resume),
 342
 343         { 0,0 }
 344 };
 345 static driver_t ath_ahb_driver = {
 346         "ath",
 347         ath_ahb_methods,
 348         sizeof (struct ath_ahb_softc)
 349 };
 350 static  devclass_t ath_devclass;
 351 DRIVER_MODULE(ath, nexus, ath_ahb_driver, ath_devclass, 0, 0);
 352 MODULE_VERSION(ath, 1);
 353 MODULE_DEPEND(ath, wlan, 1, 1, 1);              /* 802.11 media layer */
 354 MODULE_DEPEND(ath, if_ath, 1, 1, 1);            /* if_ath driver */