if_malo_pci.c revision 267992
1177595Sweongyo/*- 2177595Sweongyo * Copyright (c) 2007 Marvell Semiconductor, Inc. 3177595Sweongyo * Copyright (c) 2007 Sam Leffler, Errno Consulting 4177595Sweongyo * Copyright (c) 2008 Weongyo Jeong <weongyo@freebsd.org> 5177595Sweongyo * All rights reserved. 6177595Sweongyo * 7177595Sweongyo * Redistribution and use in source and binary forms, with or without 8177595Sweongyo * modification, are permitted provided that the following conditions 9177595Sweongyo * are met: 10177595Sweongyo * 1. Redistributions of source code must retain the above copyright 11177595Sweongyo * notice, this list of conditions and the following disclaimer, 12177595Sweongyo * without modification. 13177595Sweongyo * 2. Redistributions in binary form must reproduce at minimum a disclaimer 14177595Sweongyo * similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any 15177595Sweongyo * redistribution must be conditioned upon including a substantially 16177595Sweongyo * similar Disclaimer requirement for further binary redistribution. 17177595Sweongyo * 18177595Sweongyo * NO WARRANTY 19177595Sweongyo * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 20177595Sweongyo * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 21177595Sweongyo * LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY 22177595Sweongyo * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL 23177595Sweongyo * THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, 24177595Sweongyo * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 25177595Sweongyo * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 26177595Sweongyo * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER 27177595Sweongyo * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 28177595Sweongyo * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 29177595Sweongyo * THE POSSIBILITY OF SUCH DAMAGES. 30177595Sweongyo */ 31177595Sweongyo 32177595Sweongyo#include <sys/cdefs.h> 33177595Sweongyo#ifdef __FreeBSD__ 34177595Sweongyo__FBSDID("$FreeBSD: head/sys/dev/malo/if_malo_pci.c 267992 2014-06-28 03:56:17Z hselasky $"); 35177595Sweongyo#endif 36177595Sweongyo 37177595Sweongyo/* 38177595Sweongyo * PCI front-end for the Marvell 88W8335 Wireless LAN controller driver. 39177595Sweongyo */ 40177595Sweongyo 41177595Sweongyo#include <sys/param.h> 42177595Sweongyo#include <sys/kernel.h> 43257176Sglebius#include <sys/malloc.h> 44177595Sweongyo#include <sys/module.h> 45177595Sweongyo#include <sys/socket.h> 46177595Sweongyo#include <sys/sysctl.h> 47177595Sweongyo 48177595Sweongyo#include <machine/bus.h> 49177595Sweongyo#include <sys/bus.h> 50177595Sweongyo#include <sys/rman.h> 51177595Sweongyo 52177595Sweongyo#include <net/if.h> 53257176Sglebius#include <net/if_var.h> 54177595Sweongyo#include <net/if_media.h> 55257241Sglebius#include <net/ethernet.h> 56177595Sweongyo 57177595Sweongyo#include <net80211/ieee80211_var.h> 58177595Sweongyo 59177595Sweongyo#include <dev/malo/if_malo.h> 60177595Sweongyo 61177595Sweongyo#include <dev/pci/pcivar.h> 62177595Sweongyo#include <dev/pci/pcireg.h> 63177595Sweongyo 64177595Sweongyo/* 65177595Sweongyo * PCI glue. 66177595Sweongyo */ 67177595Sweongyo 68177595Sweongyo#define MALO_RESOURCE_MAX 2 69177595Sweongyo#define MALO_MSI_MESSAGES 1 70177595Sweongyo 71177595Sweongyostruct malo_pci_softc { 72177595Sweongyo struct malo_softc malo_sc; 73177595Sweongyo struct resource_spec *malo_mem_spec; 74177595Sweongyo struct resource *malo_res_mem[MALO_RESOURCE_MAX]; 75177595Sweongyo struct resource_spec *malo_irq_spec; 76177595Sweongyo struct resource *malo_res_irq[MALO_MSI_MESSAGES]; 77177595Sweongyo void *malo_intrhand[MALO_MSI_MESSAGES]; 78177595Sweongyo int malo_msi; 79177595Sweongyo}; 80177595Sweongyo 81177595Sweongyo/* 82177595Sweongyo * Tunable variables. 83177595Sweongyo */ 84177595SweongyoSYSCTL_DECL(_hw_malo); 85227309Sedstatic SYSCTL_NODE(_hw_malo, OID_AUTO, pci, CTLFLAG_RD, 0, 86177595Sweongyo "Marvell 88W8335 driver PCI parameters"); 87177595Sweongyo 88177595Sweongyostatic int msi_disable = 0; /* MSI disabled */ 89267992ShselaskySYSCTL_INT(_hw_malo_pci, OID_AUTO, msi_disable, CTLFLAG_RWTUN, &msi_disable, 90177595Sweongyo 0, "MSI disabled"); 91177595Sweongyo 92177595Sweongyo/* 93177595Sweongyo * Devices supported by this driver. 94177595Sweongyo */ 95177595Sweongyo#define VENDORID_MARVELL 0X11AB 96177595Sweongyo#define DEVICEID_MRVL_88W8310 0X1FA7 97177595Sweongyo#define DEVICEID_MRVL_88W8335R1 0X1FAA 98177595Sweongyo#define DEVICEID_MRVL_88W8335R2 0X1FAB 99177595Sweongyo 100177595Sweongyostatic struct malo_product { 101177595Sweongyo uint16_t mp_vendorid; 102177595Sweongyo uint16_t mp_deviceid; 103177595Sweongyo const char *mp_name; 104177595Sweongyo} malo_products[] = { 105177595Sweongyo { VENDORID_MARVELL, DEVICEID_MRVL_88W8310, 106177595Sweongyo "Marvell Libertas 88W8310 802.11g Wireless Adapter" }, 107177595Sweongyo { VENDORID_MARVELL, DEVICEID_MRVL_88W8335R1, 108177595Sweongyo "Marvell Libertas 88W8335 802.11g Wireless Adapter" }, 109177595Sweongyo { VENDORID_MARVELL, DEVICEID_MRVL_88W8335R2, 110177595Sweongyo "Marvell Libertas 88W8335 802.11g Wireless Adapter" } 111177595Sweongyo}; 112177595Sweongyo 113177595Sweongyostatic struct resource_spec malo_res_spec_mem[] = { 114177595Sweongyo { SYS_RES_MEMORY, PCIR_BAR(0), RF_ACTIVE }, 115177595Sweongyo { SYS_RES_MEMORY, PCIR_BAR(1), RF_ACTIVE }, 116177595Sweongyo { -1, 0, 0 } 117177595Sweongyo}; 118177595Sweongyo 119177595Sweongyostatic struct resource_spec malo_res_spec_legacy[] = { 120177595Sweongyo { SYS_RES_IRQ, 0, RF_ACTIVE | RF_SHAREABLE }, 121177595Sweongyo { -1, 0, 0 } 122177595Sweongyo}; 123177595Sweongyo 124177595Sweongyostatic struct resource_spec malo_res_spec_msi[] = { 125177595Sweongyo { SYS_RES_IRQ, 1, RF_ACTIVE }, 126177595Sweongyo { -1, 0, 0 } 127177595Sweongyo}; 128177595Sweongyo 129177595Sweongyostatic int malo_pci_detach(device_t); 130177595Sweongyo 131177595Sweongyostatic int 132177595Sweongyomalo_pci_probe(device_t dev) 133177595Sweongyo{ 134177595Sweongyo#define N(a) (sizeof(a) / sizeof((a)[0])) 135177595Sweongyo struct malo_product *mp; 136177595Sweongyo uint16_t vendor, devid; 137177595Sweongyo int i; 138177595Sweongyo 139177595Sweongyo vendor = pci_get_vendor(dev); 140177595Sweongyo devid = pci_get_device(dev); 141177595Sweongyo mp = malo_products; 142177595Sweongyo 143177595Sweongyo for (i = 0; i < N(malo_products); i++, mp++) { 144177595Sweongyo if (vendor == mp->mp_vendorid && devid == mp->mp_deviceid) { 145177595Sweongyo device_set_desc(dev, mp->mp_name); 146177595Sweongyo return (BUS_PROBE_DEFAULT); 147177595Sweongyo } 148177595Sweongyo } 149177595Sweongyo 150177595Sweongyo return (ENXIO); 151177595Sweongyo#undef N 152177595Sweongyo} 153177595Sweongyo 154177595Sweongyostatic int 155177595Sweongyomalo_pci_attach(device_t dev) 156177595Sweongyo{ 157177595Sweongyo int error = ENXIO, i, msic, reg; 158177595Sweongyo struct malo_pci_softc *psc = device_get_softc(dev); 159177595Sweongyo struct malo_softc *sc = &psc->malo_sc; 160177595Sweongyo 161177595Sweongyo sc->malo_dev = dev; 162177595Sweongyo 163216518Stijl pci_enable_busmaster(dev); 164177595Sweongyo 165177595Sweongyo /* 166177595Sweongyo * Setup memory-mapping of PCI registers. 167177595Sweongyo */ 168177595Sweongyo psc->malo_mem_spec = malo_res_spec_mem; 169177595Sweongyo error = bus_alloc_resources(dev, psc->malo_mem_spec, psc->malo_res_mem); 170177595Sweongyo if (error) { 171177595Sweongyo device_printf(dev, "couldn't allocate memory resources\n"); 172177595Sweongyo return (ENXIO); 173177595Sweongyo } 174177595Sweongyo 175177595Sweongyo /* 176177595Sweongyo * Arrange and allocate interrupt line. 177177595Sweongyo */ 178177595Sweongyo sc->malo_invalid = 1; 179177595Sweongyo 180219902Sjhb if (pci_find_cap(dev, PCIY_EXPRESS, ®) == 0) { 181177595Sweongyo msic = pci_msi_count(dev); 182177595Sweongyo if (bootverbose) 183177595Sweongyo device_printf(dev, "MSI count : %d\n", msic); 184177595Sweongyo } else 185177595Sweongyo msic = 0; 186177595Sweongyo 187177595Sweongyo psc->malo_irq_spec = malo_res_spec_legacy; 188177595Sweongyo if (msic == MALO_MSI_MESSAGES && msi_disable == 0) { 189177595Sweongyo if (pci_alloc_msi(dev, &msic) == 0) { 190177595Sweongyo if (msic == MALO_MSI_MESSAGES) { 191177595Sweongyo device_printf(dev, "Using %d MSI messages\n", 192177595Sweongyo msic); 193177595Sweongyo psc->malo_irq_spec = malo_res_spec_msi; 194177595Sweongyo psc->malo_msi = 1; 195177595Sweongyo } else 196177595Sweongyo pci_release_msi(dev); 197177595Sweongyo } 198177595Sweongyo } 199177595Sweongyo 200177595Sweongyo error = bus_alloc_resources(dev, psc->malo_irq_spec, psc->malo_res_irq); 201177595Sweongyo if (error) { 202177595Sweongyo device_printf(dev, "couldn't allocate IRQ resources\n"); 203177595Sweongyo goto bad; 204177595Sweongyo } 205177595Sweongyo 206177595Sweongyo if (psc->malo_msi == 0) 207177595Sweongyo error = bus_setup_intr(dev, psc->malo_res_irq[0], 208177595Sweongyo INTR_TYPE_NET | INTR_MPSAFE, malo_intr, NULL, sc, 209177595Sweongyo &psc->malo_intrhand[0]); 210177595Sweongyo else { 211177595Sweongyo for (i = 0; i < MALO_MSI_MESSAGES; i++) { 212177595Sweongyo error = bus_setup_intr(dev, psc->malo_res_irq[i], 213177595Sweongyo INTR_TYPE_NET | INTR_MPSAFE, malo_intr, NULL, sc, 214177595Sweongyo &psc->malo_intrhand[i]); 215177595Sweongyo if (error != 0) 216177595Sweongyo break; 217177595Sweongyo } 218177595Sweongyo } 219177595Sweongyo 220177595Sweongyo /* 221177595Sweongyo * Setup DMA descriptor area. 222177595Sweongyo */ 223177595Sweongyo if (bus_dma_tag_create(bus_get_dma_tag(dev), /* parent */ 224177595Sweongyo 1, 0, /* alignment, bounds */ 225177595Sweongyo BUS_SPACE_MAXADDR_32BIT, /* lowaddr */ 226177595Sweongyo BUS_SPACE_MAXADDR, /* highaddr */ 227177595Sweongyo NULL, NULL, /* filter, filterarg */ 228177595Sweongyo BUS_SPACE_MAXADDR, /* maxsize */ 229177595Sweongyo 0, /* nsegments */ 230177595Sweongyo BUS_SPACE_MAXADDR, /* maxsegsize */ 231190590Sweongyo 0, /* flags */ 232177595Sweongyo NULL, /* lockfunc */ 233177595Sweongyo NULL, /* lockarg */ 234177595Sweongyo &sc->malo_dmat)) { 235177595Sweongyo device_printf(dev, "cannot allocate DMA tag\n"); 236177595Sweongyo goto bad1; 237177595Sweongyo } 238177595Sweongyo 239177595Sweongyo sc->malo_io0t = rman_get_bustag(psc->malo_res_mem[0]); 240177595Sweongyo sc->malo_io0h = rman_get_bushandle(psc->malo_res_mem[0]); 241177595Sweongyo sc->malo_io1t = rman_get_bustag(psc->malo_res_mem[1]); 242177595Sweongyo sc->malo_io1h = rman_get_bushandle(psc->malo_res_mem[1]); 243177595Sweongyo 244177595Sweongyo error = malo_attach(pci_get_device(dev), sc); 245177595Sweongyo 246190544Sweongyo if (error != 0) 247190544Sweongyo goto bad2; 248177595Sweongyo 249177595Sweongyo return (error); 250190544Sweongyo 251190544Sweongyobad2: 252190544Sweongyo bus_dma_tag_destroy(sc->malo_dmat); 253177595Sweongyobad1: 254177595Sweongyo if (psc->malo_msi == 0) 255177595Sweongyo bus_teardown_intr(dev, psc->malo_res_irq[0], 256177595Sweongyo psc->malo_intrhand[0]); 257177595Sweongyo else { 258177595Sweongyo for (i = 0; i < MALO_MSI_MESSAGES; i++) 259177595Sweongyo bus_teardown_intr(dev, psc->malo_res_irq[i], 260177595Sweongyo psc->malo_intrhand[i]); 261177595Sweongyo } 262190544Sweongyo bus_release_resources(dev, psc->malo_irq_spec, psc->malo_res_irq); 263177595Sweongyobad: 264177595Sweongyo if (psc->malo_msi != 0) 265177595Sweongyo pci_release_msi(dev); 266190544Sweongyo bus_release_resources(dev, psc->malo_mem_spec, psc->malo_res_mem); 267177595Sweongyo 268177595Sweongyo return (error); 269177595Sweongyo} 270177595Sweongyo 271177595Sweongyostatic int 272177595Sweongyomalo_pci_detach(device_t dev) 273177595Sweongyo{ 274177595Sweongyo int i; 275177595Sweongyo struct malo_pci_softc *psc = device_get_softc(dev); 276177595Sweongyo struct malo_softc *sc = &psc->malo_sc; 277177595Sweongyo 278177595Sweongyo /* check if device was removed */ 279177595Sweongyo sc->malo_invalid = !bus_child_present(dev); 280177595Sweongyo 281177595Sweongyo malo_detach(sc); 282177595Sweongyo 283177595Sweongyo bus_generic_detach(dev); 284177595Sweongyo 285177595Sweongyo if (psc->malo_msi == 0) 286177595Sweongyo bus_teardown_intr(dev, psc->malo_res_irq[0], 287177595Sweongyo psc->malo_intrhand[0]); 288177595Sweongyo else { 289177595Sweongyo for (i = 0; i < MALO_MSI_MESSAGES; i++) 290177595Sweongyo bus_teardown_intr(dev, psc->malo_res_irq[i], 291177595Sweongyo psc->malo_intrhand[i]); 292177595Sweongyo 293177595Sweongyo pci_release_msi(dev); 294177595Sweongyo } 295177595Sweongyo 296177595Sweongyo bus_release_resources(dev, psc->malo_irq_spec, psc->malo_res_irq); 297177595Sweongyo bus_dma_tag_destroy(sc->malo_dmat); 298177595Sweongyo bus_release_resources(dev, psc->malo_mem_spec, psc->malo_res_mem); 299177595Sweongyo 300177595Sweongyo return (0); 301177595Sweongyo} 302177595Sweongyo 303177595Sweongyostatic int 304177595Sweongyomalo_pci_shutdown(device_t dev) 305177595Sweongyo{ 306177595Sweongyo struct malo_pci_softc *psc = device_get_softc(dev); 307177595Sweongyo 308177595Sweongyo malo_shutdown(&psc->malo_sc); 309177595Sweongyo 310177595Sweongyo return (0); 311177595Sweongyo} 312177595Sweongyo 313177595Sweongyostatic int 314177595Sweongyomalo_pci_suspend(device_t dev) 315177595Sweongyo{ 316177595Sweongyo struct malo_pci_softc *psc = device_get_softc(dev); 317177595Sweongyo 318177595Sweongyo malo_suspend(&psc->malo_sc); 319177595Sweongyo 320177595Sweongyo return (0); 321177595Sweongyo} 322177595Sweongyo 323177595Sweongyostatic int 324177595Sweongyomalo_pci_resume(device_t dev) 325177595Sweongyo{ 326177595Sweongyo struct malo_pci_softc *psc = device_get_softc(dev); 327177595Sweongyo 328177595Sweongyo malo_resume(&psc->malo_sc); 329177595Sweongyo 330177595Sweongyo return (0); 331177595Sweongyo} 332177595Sweongyo 333177595Sweongyostatic device_method_t malo_pci_methods[] = { 334177595Sweongyo /* Device interface */ 335177595Sweongyo DEVMETHOD(device_probe, malo_pci_probe), 336177595Sweongyo DEVMETHOD(device_attach, malo_pci_attach), 337177595Sweongyo DEVMETHOD(device_detach, malo_pci_detach), 338177595Sweongyo DEVMETHOD(device_shutdown, malo_pci_shutdown), 339177595Sweongyo DEVMETHOD(device_suspend, malo_pci_suspend), 340177595Sweongyo DEVMETHOD(device_resume, malo_pci_resume), 341177595Sweongyo { 0,0 } 342177595Sweongyo}; 343177595Sweongyo 344177595Sweongyostatic driver_t malo_pci_driver = { 345177595Sweongyo "malo", 346177595Sweongyo malo_pci_methods, 347177595Sweongyo sizeof(struct malo_pci_softc) 348177595Sweongyo}; 349177595Sweongyo 350177595Sweongyostatic devclass_t malo_devclass; 351192147SimpDRIVER_MODULE(malo, pci, malo_pci_driver, malo_devclass, 0, 0); 352192147SimpMODULE_VERSION(malo, 1); 353192147SimpMODULE_DEPEND(malo, wlan, 1, 1, 1); /* 802.11 media layer */ 354212410SbschmidtMODULE_DEPEND(malo, firmware, 1, 1, 1); 355