sys/dev/mwl/if_mwl_pci.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2007-2009 Sam Leffler, Errno Consulting
   5  * Copyright (c) 2007-2009 Marvell Semiconductor, Inc.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer,
  13  *    without modification.
  14  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  15  *    similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any
  16  *    redistribution must be conditioned upon including a substantially
  17  *    similar Disclaimer requirement for further binary redistribution.
  18  *
  19  * NO WARRANTY
  20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22  * LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY
  23  * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
  24  * THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY,
  25  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
  28  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  30  * THE POSSIBILITY OF SUCH DAMAGES.
  31  */
  32
  33 #include <sys/cdefs.h>
  34 #ifdef __FreeBSD__
  35 __FBSDID("$FreeBSD$");
  36 #endif
  37
  38 /*
  39  * PCI front-end for the Marvell Wireless LAN controller driver.
  40  */
  41
  42 #include <sys/param.h>
  43 #include <sys/systm.h>
  44 #include <sys/module.h>
  45 #include <sys/kernel.h>
  46 #include <sys/lock.h>
  47 #include <sys/malloc.h>
  48 #include <sys/mbuf.h>
  49 #include <sys/mutex.h>
  50 #include <sys/errno.h>
  51
  52 #include <machine/bus.h>
  53 #include <machine/resource.h>
  54 #include <sys/bus.h>
  55 #include <sys/rman.h>
  56
  57 #include <sys/socket.h>
  58
  59 #include <net/ethernet.h>
  60 #include <net/if.h>
  61 #include <net/if_media.h>
  62 #include <net/if_arp.h>
  63 #include <net/route.h>
  64
  65 #include <net80211/ieee80211_var.h>
  66
  67 #include <dev/mwl/if_mwlvar.h>
  68
  69 #include <dev/pci/pcivar.h>
  70 #include <dev/pci/pcireg.h>
  71
  72 /*
  73  * PCI glue.
  74  */
  75
  76 struct mwl_pci_softc {
  77         struct mwl_softc        sc_sc;
  78         struct resource         *sc_sr0;        /* BAR0 memory resource */
  79         struct resource         *sc_sr1;        /* BAR1 memory resource */
  80         struct resource         *sc_irq;        /* irq resource */
  81         void                    *sc_ih;         /* interrupt handler */
  82 };
  83
  84 #define BS_BAR0 0x10
  85 #define BS_BAR1 0x14
  86
  87 struct mwl_pci_ident {
  88         uint16_t        vendor;
  89         uint16_t        device;
  90         const char      *name;
  91 };
  92
  93 static const struct mwl_pci_ident mwl_pci_ids[] = {
  94         { 0x11ab, 0x2a02, "Marvell 88W8363" },
  95         { 0x11ab, 0x2a03, "Marvell 88W8363" },
  96         { 0x11ab, 0x2a0a, "Marvell 88W8363" },
  97         { 0x11ab, 0x2a0b, "Marvell 88W8363" },
  98         { 0x11ab, 0x2a0c, "Marvell 88W8363" },
  99         { 0x11ab, 0x2a21, "Marvell 88W8363" },
 100         { 0x11ab, 0x2a24, "Marvell 88W8363" },
 101
 102         { 0, 0, NULL }
 103 };
 104
 105 const static struct mwl_pci_ident *
 106 mwl_pci_lookup(int vendor, int device)
 107 {
 108         const struct mwl_pci_ident *ident;
 109
 110         for (ident = mwl_pci_ids; ident->name != NULL; ident++)
 111                 if (vendor == ident->vendor && device == ident->device)
 112                         return ident;
 113         return NULL;
 114 }
 115
 116 static int
 117 mwl_pci_probe(device_t dev)
 118 {
 119         const struct mwl_pci_ident *ident;
 120
 121         ident = mwl_pci_lookup(pci_get_vendor(dev), pci_get_device(dev));
 122         if (ident != NULL) {
 123                 device_set_desc(dev, ident->name);
 124                 return BUS_PROBE_DEFAULT;
 125         }
 126         return ENXIO;
 127 }
 128
 129 static int
 130 mwl_pci_attach(device_t dev)
 131 {
 132         struct mwl_pci_softc *psc = device_get_softc(dev);
 133         struct mwl_softc *sc = &psc->sc_sc;
 134         int rid, error = ENXIO;
 135
 136         sc->sc_dev = dev;
 137
 138         pci_enable_busmaster(dev);
 139
 140         /*
 141          * Setup memory-mapping of PCI registers.
 142          */
 143         rid = BS_BAR0;
 144         psc->sc_sr0 = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid,
 145                                             RF_ACTIVE);
 146         if (psc->sc_sr0 == NULL) {
 147                 device_printf(dev, "cannot map BAR0 register space\n");
 148                 goto bad;
 149         }
 150         rid = BS_BAR1;
 151         psc->sc_sr1 = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid,
 152                                             RF_ACTIVE);
 153         if (psc->sc_sr1 == NULL) {
 154                 device_printf(dev, "cannot map BAR1 register space\n");
 155                 goto bad1;
 156         }
 157         sc->sc_invalid = 1;
 158
 159         /*
 160          * Arrange interrupt line.
 161          */
 162         rid = 0;
 163         psc->sc_irq = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid,
 164                                              RF_SHAREABLE|RF_ACTIVE);
 165         if (psc->sc_irq == NULL) {
 166                 device_printf(dev, "could not map interrupt\n");
 167                 goto bad2;
 168         }
 169         if (bus_setup_intr(dev, psc->sc_irq,
 170                            INTR_TYPE_NET | INTR_MPSAFE,
 171                            NULL, mwl_intr, sc, &psc->sc_ih)) {
 172                 device_printf(dev, "could not establish interrupt\n");
 173                 goto bad3;
 174         }
 175
 176         /*
 177          * Setup DMA descriptor area.
 178          */
 179         if (bus_dma_tag_create(bus_get_dma_tag(dev),    /* parent */
 180                                1, 0,                    /* alignment, bounds */
 181                                BUS_SPACE_MAXADDR_32BIT, /* lowaddr */
 182                                BUS_SPACE_MAXADDR,       /* highaddr */
 183                                NULL, NULL,              /* filter, filterarg */
 184                                BUS_SPACE_MAXSIZE,       /* maxsize */
 185                                MWL_TXDESC,              /* nsegments */
 186                                BUS_SPACE_MAXSIZE,       /* maxsegsize */
 187                                0,                       /* flags */
 188                                NULL,                    /* lockfunc */
 189                                NULL,                    /* lockarg */
 190                                &sc->sc_dmat)) {
 191                 device_printf(dev, "cannot allocate DMA tag\n");
 192                 goto bad4;
 193         }
 194
 195         /*
 196          * Finish off the attach.
 197          */
 198         MWL_LOCK_INIT(sc);
 199         sc->sc_io0t = rman_get_bustag(psc->sc_sr0);
 200         sc->sc_io0h = rman_get_bushandle(psc->sc_sr0);
 201         sc->sc_io1t = rman_get_bustag(psc->sc_sr1);
 202         sc->sc_io1h = rman_get_bushandle(psc->sc_sr1);
 203         if (mwl_attach(pci_get_device(dev), sc) == 0)
 204                 return (0);
 205
 206         MWL_LOCK_DESTROY(sc);
 207         bus_dma_tag_destroy(sc->sc_dmat);
 208 bad4:
 209         bus_teardown_intr(dev, psc->sc_irq, psc->sc_ih);
 210 bad3:
 211         bus_release_resource(dev, SYS_RES_IRQ, 0, psc->sc_irq);
 212 bad2:
 213         bus_release_resource(dev, SYS_RES_MEMORY, BS_BAR1, psc->sc_sr1);
 214 bad1:
 215         bus_release_resource(dev, SYS_RES_MEMORY, BS_BAR0, psc->sc_sr0);
 216 bad:
 217         return (error);
 218 }
 219
 220 static int
 221 mwl_pci_detach(device_t dev)
 222 {
 223         struct mwl_pci_softc *psc = device_get_softc(dev);
 224         struct mwl_softc *sc = &psc->sc_sc;
 225
 226         /* check if device was removed */
 227         sc->sc_invalid = !bus_child_present(dev);
 228
 229         mwl_detach(sc);
 230
 231         bus_generic_detach(dev);
 232         bus_teardown_intr(dev, psc->sc_irq, psc->sc_ih);
 233         bus_release_resource(dev, SYS_RES_IRQ, 0, psc->sc_irq);
 234
 235         bus_dma_tag_destroy(sc->sc_dmat);
 236         bus_release_resource(dev, SYS_RES_MEMORY, BS_BAR1, psc->sc_sr1);
 237         bus_release_resource(dev, SYS_RES_MEMORY, BS_BAR0, psc->sc_sr0);
 238
 239         MWL_LOCK_DESTROY(sc);
 240
 241         return (0);
 242 }
 243
 244 static int
 245 mwl_pci_shutdown(device_t dev)
 246 {
 247         struct mwl_pci_softc *psc = device_get_softc(dev);
 248
 249         mwl_shutdown(&psc->sc_sc);
 250         return (0);
 251 }
 252
 253 static int
 254 mwl_pci_suspend(device_t dev)
 255 {
 256         struct mwl_pci_softc *psc = device_get_softc(dev);
 257
 258         mwl_suspend(&psc->sc_sc);
 259
 260         return (0);
 261 }
 262
 263 static int
 264 mwl_pci_resume(device_t dev)
 265 {
 266         struct mwl_pci_softc *psc = device_get_softc(dev);
 267
 268         pci_enable_busmaster(dev);
 269
 270         mwl_resume(&psc->sc_sc);
 271
 272         return (0);
 273 }
 274
 275 static device_method_t mwl_pci_methods[] = {
 276         /* Device interface */
 277         DEVMETHOD(device_probe,         mwl_pci_probe),
 278         DEVMETHOD(device_attach,        mwl_pci_attach),
 279         DEVMETHOD(device_detach,        mwl_pci_detach),
 280         DEVMETHOD(device_shutdown,      mwl_pci_shutdown),
 281         DEVMETHOD(device_suspend,       mwl_pci_suspend),
 282         DEVMETHOD(device_resume,        mwl_pci_resume),
 283
 284         { 0,0 }
 285 };
 286 static driver_t mwl_pci_driver = {
 287         "mwl",
 288         mwl_pci_methods,
 289         sizeof (struct mwl_pci_softc)
 290 };
 291 static  devclass_t mwl_devclass;
 292 DRIVER_MODULE(mwl, pci, mwl_pci_driver, mwl_devclass, 0, 0);
 293 MODULE_VERSION(mwl, 1);
 294 MODULE_DEPEND(mwl, wlan, 1, 1, 1);              /* 802.11 media layer */
 295 MODULE_DEPEND(mwl, firmware, 1, 1, 1);