1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3 * 4 * Copyright (c) 2015-2016 Landon Fuller <landonf@FreeBSD.org> 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 */ 28 29 #include <sys/cdefs.h> 30 __FBSDID("$FreeBSD$"); 31 32 #include "opt_bwn.h" 33 #include "opt_wlan.h" 34 35 #include <sys/param.h> 36 #include <sys/kernel.h> 37 #include <sys/bus.h> 38 #include <sys/module.h> 39 40 #include <dev/pci/pcireg.h> 41 #include <dev/pci/pcivar.h> 42 43 #include <dev/bhnd/bhndb/bhndb_pcivar.h> 44 #include <dev/bhnd/bhndb/bhndb_hwdata.h> 45 #include <dev/bhnd/bhndb/bhndb_pci_hwdata.h> 46 47 #include <dev/bhnd/bhnd_ids.h> 48 49 #include "bhndb_bus_if.h" 50 51 #include "if_bwn_pcivar.h" 52 53 /* If non-zero, enable attachment of BWN_QUIRK_UNTESTED devices */ 54 static int attach_untested = 0; 55 TUNABLE_INT("hw.bwn_pci.attach_untested", &attach_untested); 56 57 /* If non-zero, probe at a higher priority than the stable if_bwn driver. */ 58 static int prefer_new_driver = 1; 59 TUNABLE_INT("hw.bwn_pci.preferred", &prefer_new_driver); 60 61 /* SIBA Devices */ 62 static const struct bwn_pci_device siba_devices[] = { 63 BWN_BCM_DEV(BCM4306_D11A, "BCM4306 802.11a", 64 BWN_QUIRK_WLAN_DUALCORE|BWN_QUIRK_SOFTMODEM_UNPOPULATED), 65 BWN_BCM_DEV(BCM4306_D11G, "BCM4306 802.11b/g", 66 BWN_QUIRK_SOFTMODEM_UNPOPULATED), 67 BWN_BCM_DEV(BCM4306_D11G_ID2, "BCM4306 802.11b/g", 68 BWN_QUIRK_SOFTMODEM_UNPOPULATED), 69 BWN_BCM_DEV(BCM4306_D11DUAL, "BCM4306 802.11a/b/g", 70 BWN_QUIRK_SOFTMODEM_UNPOPULATED), 71 BWN_BCM_DEV(BCM4307, "BCM4307 802.11b", 0), 72 73 BWN_BCM_DEV(BCM4311_D11G, "BCM4311 802.11b/g", 0), 74 BWN_BCM_DEV(BCM4311_D11DUAL, "BCM4311 802.11a/b/g", 0), 75 BWN_BCM_DEV(BCM4311_D11A, "BCM4311 802.11a", 76 BWN_QUIRK_UNTESTED|BWN_QUIRK_WLAN_DUALCORE), 77 78 BWN_BCM_DEV(BCM4318_D11G, "BCM4318 802.11b/g", 0), 79 BWN_BCM_DEV(BCM4318_D11DUAL, "BCM4318 802.11a/b/g", 0), 80 BWN_BCM_DEV(BCM4318_D11A, "BCM4318 802.11a", 81 BWN_QUIRK_UNTESTED|BWN_QUIRK_WLAN_DUALCORE), 82 83 BWN_BCM_DEV(BCM4321_D11N, "BCM4321 802.11n Dual-Band", 84 BWN_QUIRK_USBH_UNPOPULATED), 85 BWN_BCM_DEV(BCM4321_D11N2G, "BCM4321 802.11n 2GHz", 86 BWN_QUIRK_USBH_UNPOPULATED), 87 BWN_BCM_DEV(BCM4321_D11N5G, "BCM4321 802.11n 5GHz", 88 BWN_QUIRK_UNTESTED|BWN_QUIRK_USBH_UNPOPULATED), 89 90 BWN_BCM_DEV(BCM4322_D11N, "BCM4322 802.11n Dual-Band", 0), 91 BWN_BCM_DEV(BCM4322_D11N2G, "BCM4322 802.11n 2GHz", 92 BWN_QUIRK_UNTESTED), 93 BWN_BCM_DEV(BCM4322_D11N5G, "BCM4322 802.11n 5GHz", 94 BWN_QUIRK_UNTESTED), 95 96 BWN_BCM_DEV(BCM4328_D11G, "BCM4328/4312 802.11g", 0), 97 98 { 0, 0, NULL, 0 } 99 }; 100 101 /** BCMA Devices */ 102 static const struct bwn_pci_device bcma_devices[] = { 103 BWN_BCM_DEV(BCM4331_D11N, "BCM4331 802.11n Dual-Band", 0), 104 BWN_BCM_DEV(BCM4331_D11N2G, "BCM4331 802.11n 2GHz", 0), 105 BWN_BCM_DEV(BCM4331_D11N5G, "BCM4331 802.11n 5GHz", 0), 106 BWN_BCM_DEV(BCM43224_D11N, "BCM43224 802.11n Dual-Band", 0), 107 BWN_BCM_DEV(BCM43224_D11N_ID_VEN1, "BCM43224 802.11n Dual-Band",0), 108 BWN_BCM_DEV(BCM43225_D11N2G, "BCM43225 802.11n 2GHz", 0), 109 110 { 0, 0, NULL, 0} 111 }; 112 113 /** Device configuration table */ 114 static const struct bwn_pci_devcfg bwn_pci_devcfgs[] = { 115 /* SIBA devices */ 116 { 117 .bridge_hwcfg = &bhndb_pci_siba_generic_hwcfg, 118 .bridge_hwtable = bhndb_pci_generic_hw_table, 119 .bridge_hwprio = bhndb_siba_priority_table, 120 .devices = siba_devices 121 }, 122 /* BCMA devices */ 123 { 124 .bridge_hwcfg = &bhndb_pci_bcma_generic_hwcfg, 125 .bridge_hwtable = bhndb_pci_generic_hw_table, 126 .bridge_hwprio = bhndb_bcma_priority_table, 127 .devices = bcma_devices 128 }, 129 { NULL, NULL, NULL } 130 }; 131 132 /** Search the device configuration table for an entry matching @p dev. */ 133 static int 134 bwn_pci_find_devcfg(device_t dev, const struct bwn_pci_devcfg **cfg, 135 const struct bwn_pci_device **device) 136 { 137 const struct bwn_pci_devcfg *dvc; 138 const struct bwn_pci_device *dv; 139 140 for (dvc = bwn_pci_devcfgs; dvc->devices != NULL; dvc++) { 141 for (dv = dvc->devices; dv->device != 0; dv++) { 142 if (pci_get_vendor(dev) == dv->vendor && 143 pci_get_device(dev) == dv->device) 144 { 145 if (cfg != NULL) 146 *cfg = dvc; 147 148 if (device != NULL) 149 *device = dv; 150 151 return (0); 152 } 153 } 154 } 155 156 return (ENOENT); 157 } 158 159 static int 160 bwn_pci_probe(device_t dev) 161 { 162 const struct bwn_pci_device *ident; 163 164 if (bwn_pci_find_devcfg(dev, NULL, &ident)) 165 return (ENXIO); 166 167 /* Skip untested devices */ 168 if (ident->quirks & BWN_QUIRK_UNTESTED && !attach_untested) 169 return (ENXIO); 170 171 device_set_desc(dev, ident->desc); 172 173 /* Until this driver is complete, require explicit opt-in before 174 * superceding if_bwn/siba_bwn. */ 175 if (prefer_new_driver) 176 return (BUS_PROBE_DEFAULT+1); 177 else 178 return (BUS_PROBE_LOW_PRIORITY); 179 180 // return (BUS_PROBE_DEFAULT); 181 } 182 183 static int 184 bwn_pci_attach(device_t dev) 185 { 186 struct bwn_pci_softc *sc; 187 const struct bwn_pci_device *ident; 188 int error; 189 190 sc = device_get_softc(dev); 191 sc->dev = dev; 192 193 /* Find our hardware config */ 194 if (bwn_pci_find_devcfg(dev, &sc->devcfg, &ident)) 195 return (ENXIO); 196 197 /* Save quirk flags */ 198 sc->quirks = ident->quirks; 199 200 /* Attach bridge device */ 201 if ((error = bhndb_attach_bridge(dev, &sc->bhndb_dev, -1))) 202 return (ENXIO); 203 204 /* Success */ 205 return (0); 206 } 207 208 static int 209 bwn_pci_detach(device_t dev) 210 { 211 int error; 212 213 if ((error = bus_generic_detach(dev))) 214 return (error); 215 216 return (device_delete_children(dev)); 217 } 218 219 static void 220 bwn_pci_probe_nomatch(device_t dev, device_t child) 221 { 222 const char *name; 223 224 name = device_get_name(child); 225 if (name == NULL) 226 name = "unknown device"; 227 228 device_printf(dev, "<%s> (no driver attached)\n", name); 229 } 230 231 static const struct bhndb_hwcfg * 232 bwn_pci_get_generic_hwcfg(device_t dev, device_t child) 233 { 234 struct bwn_pci_softc *sc = device_get_softc(dev); 235 return (sc->devcfg->bridge_hwcfg); 236 } 237 238 static const struct bhndb_hw * 239 bwn_pci_get_bhndb_hwtable(device_t dev, device_t child) 240 { 241 struct bwn_pci_softc *sc = device_get_softc(dev); 242 return (sc->devcfg->bridge_hwtable); 243 } 244 245 static const struct bhndb_hw_priority * 246 bwn_pci_get_bhndb_hwprio(device_t dev, device_t child) 247 { 248 struct bwn_pci_softc *sc = device_get_softc(dev); 249 return (sc->devcfg->bridge_hwprio); 250 } 251 252 static bool 253 bwn_pci_is_core_disabled(device_t dev, device_t child, 254 struct bhnd_core_info *core) 255 { 256 struct bwn_pci_softc *sc; 257 258 sc = device_get_softc(dev); 259 260 switch (bhnd_core_class(core)) { 261 case BHND_DEVCLASS_WLAN: 262 if (core->unit > 0 && !(sc->quirks & BWN_QUIRK_WLAN_DUALCORE)) 263 return (true); 264 265 return (false); 266 267 case BHND_DEVCLASS_ENET: 268 case BHND_DEVCLASS_ENET_MAC: 269 case BHND_DEVCLASS_ENET_PHY: 270 return ((sc->quirks & BWN_QUIRK_ENET_HW_UNPOPULATED) != 0); 271 272 case BHND_DEVCLASS_USB_HOST: 273 return ((sc->quirks & BWN_QUIRK_USBH_UNPOPULATED) != 0); 274 275 case BHND_DEVCLASS_SOFTMODEM: 276 return ((sc->quirks & BWN_QUIRK_SOFTMODEM_UNPOPULATED) != 0); 277 278 default: 279 return (false); 280 } 281 } 282 283 static device_method_t bwn_pci_methods[] = { 284 /* Device interface */ 285 DEVMETHOD(device_probe, bwn_pci_probe), 286 DEVMETHOD(device_attach, bwn_pci_attach), 287 DEVMETHOD(device_detach, bwn_pci_detach), 288 DEVMETHOD(device_shutdown, bus_generic_shutdown), 289 DEVMETHOD(device_suspend, bus_generic_suspend), 290 DEVMETHOD(device_resume, bus_generic_resume), 291 292 /* Bus interface */ 293 DEVMETHOD(bus_probe_nomatch, bwn_pci_probe_nomatch), 294 295 /* BHNDB_BUS Interface */ 296 DEVMETHOD(bhndb_bus_get_generic_hwcfg, bwn_pci_get_generic_hwcfg), 297 DEVMETHOD(bhndb_bus_get_hardware_table, bwn_pci_get_bhndb_hwtable), 298 DEVMETHOD(bhndb_bus_get_hardware_prio, bwn_pci_get_bhndb_hwprio), 299 DEVMETHOD(bhndb_bus_is_core_disabled, bwn_pci_is_core_disabled), 300 301 DEVMETHOD_END 302 }; 303 304 static devclass_t bwn_pci_devclass; 305 306 DEFINE_CLASS_0(bwn_pci, bwn_pci_driver, bwn_pci_methods, 307 sizeof(struct bwn_pci_softc)); 308 DRIVER_MODULE_ORDERED(bwn_pci, pci, bwn_pci_driver, bwn_pci_devclass, NULL, 309 NULL, SI_ORDER_ANY); 310 DRIVER_MODULE(bhndb, bwn_pci, bhndb_pci_driver, bhndb_devclass, NULL, NULL); 311 312 MODULE_DEPEND(bwn_pci, bhnd, 1, 1, 1); 313 MODULE_DEPEND(bwn_pci, bhndb, 1, 1, 1); 314 MODULE_DEPEND(bwn_pci, bhndb_pci, 1, 1, 1); 315 MODULE_DEPEND(bwn_pci, bcma_bhndb, 1, 1, 1); 316 MODULE_DEPEND(bwn_pci, siba_bhndb, 1, 1, 1); 317 MODULE_VERSION(bwn_pci, 1); 318