1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause 3 * 4 * Copyright (c) 2000,2001 Jonathan Chen. All rights reserved. 5 * Copyright (c) 2003-2008 M. Warner Losh <imp@FreeBSD.org> 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/param.h> 30 #include <sys/eventhandler.h> 31 #include <sys/systm.h> 32 #include <sys/malloc.h> 33 #include <sys/module.h> 34 #include <sys/kernel.h> 35 #include <sys/sysctl.h> 36 37 #include <sys/bus.h> 38 #include <machine/bus.h> 39 #include <sys/rman.h> 40 #include <machine/resource.h> 41 42 #include <sys/pciio.h> 43 #include <dev/pci/pcivar.h> 44 #include <dev/pci/pcireg.h> 45 #include <dev/pci/pci_private.h> 46 47 #include <dev/cardbus/cardbusreg.h> 48 #include <dev/cardbus/cardbusvar.h> 49 #include <dev/cardbus/cardbus_cis.h> 50 #include <dev/pccard/pccard_cis.h> 51 #include <dev/pccard/pccardvar.h> 52 53 #include "power_if.h" 54 #include "pcib_if.h" 55 56 /* sysctl vars */ 57 static SYSCTL_NODE(_hw, OID_AUTO, cardbus, CTLFLAG_RD | CTLFLAG_MPSAFE, 0, 58 "CardBus parameters"); 59 60 int cardbus_debug = 0; 61 SYSCTL_INT(_hw_cardbus, OID_AUTO, debug, CTLFLAG_RWTUN, 62 &cardbus_debug, 0, "CardBus debug"); 63 64 int cardbus_cis_debug = 0; 65 SYSCTL_INT(_hw_cardbus, OID_AUTO, cis_debug, CTLFLAG_RWTUN, 66 &cardbus_cis_debug, 0, "CardBus CIS debug"); 67 68 #define DPRINTF(a) if (cardbus_debug) printf a 69 #define DEVPRINTF(x) if (cardbus_debug) device_printf x 70 71 static int cardbus_attach(device_t cbdev); 72 static int cardbus_attach_card(device_t cbdev); 73 static int cardbus_detach(device_t cbdev); 74 static int cardbus_detach_card(device_t cbdev); 75 static void cardbus_device_setup_regs(pcicfgregs *cfg); 76 static void cardbus_driver_added(device_t cbdev, driver_t *driver); 77 static int cardbus_probe(device_t cbdev); 78 static int cardbus_read_ivar(device_t cbdev, device_t child, int which, 79 uintptr_t *result); 80 81 /************************************************************************/ 82 /* Probe/Attach */ 83 /************************************************************************/ 84 85 static int 86 cardbus_probe(device_t cbdev) 87 { 88 device_set_desc(cbdev, "CardBus bus"); 89 return (0); 90 } 91 92 static int 93 cardbus_attach(device_t cbdev) 94 { 95 struct cardbus_softc *sc; 96 #ifdef PCI_RES_BUS 97 int rid; 98 #endif 99 100 sc = device_get_softc(cbdev); 101 sc->sc_dev = cbdev; 102 #ifdef PCI_RES_BUS 103 rid = 0; 104 sc->sc_bus = bus_alloc_resource(cbdev, PCI_RES_BUS, &rid, 105 pcib_get_bus(cbdev), pcib_get_bus(cbdev), 1, 0); 106 if (sc->sc_bus == NULL) { 107 device_printf(cbdev, "failed to allocate bus number\n"); 108 return (ENXIO); 109 } 110 #else 111 device_printf(cbdev, "Your bus numbers may be AFU\n"); 112 #endif 113 return (0); 114 } 115 116 static int 117 cardbus_detach(device_t cbdev) 118 { 119 #ifdef PCI_RES_BUS 120 struct cardbus_softc *sc; 121 #endif 122 123 cardbus_detach_card(cbdev); 124 #ifdef PCI_RES_BUS 125 sc = device_get_softc(cbdev); 126 device_printf(cbdev, "Freeing up the allocatd bus\n"); 127 (void)bus_release_resource(cbdev, PCI_RES_BUS, 0, sc->sc_bus); 128 #endif 129 return (0); 130 } 131 132 static int 133 cardbus_suspend(device_t self) 134 { 135 136 cardbus_detach_card(self); 137 return (0); 138 } 139 140 static int 141 cardbus_resume(device_t self) 142 { 143 144 return (0); 145 } 146 147 /************************************************************************/ 148 /* Attach/Detach card */ 149 /************************************************************************/ 150 151 static void 152 cardbus_device_setup_regs(pcicfgregs *cfg) 153 { 154 device_t dev = cfg->dev; 155 int i; 156 157 /* 158 * Some cards power up with garbage in their BARs. This 159 * code clears all that junk out. 160 */ 161 for (i = 0; i < PCIR_MAX_BAR_0; i++) 162 pci_write_config(dev, PCIR_BAR(i), 0, 4); 163 164 cfg->intline = 165 pci_get_irq(device_get_parent(device_get_parent(dev))); 166 pci_write_config(dev, PCIR_INTLINE, cfg->intline, 1); 167 pci_write_config(dev, PCIR_CACHELNSZ, 0x08, 1); 168 pci_write_config(dev, PCIR_LATTIMER, 0xa8, 1); 169 pci_write_config(dev, PCIR_MINGNT, 0x14, 1); 170 pci_write_config(dev, PCIR_MAXLAT, 0x14, 1); 171 } 172 173 static struct pci_devinfo * 174 cardbus_alloc_devinfo(device_t dev) 175 { 176 struct cardbus_devinfo *dinfo; 177 178 dinfo = malloc(sizeof(*dinfo), M_DEVBUF, M_WAITOK | M_ZERO); 179 return (&dinfo->pci); 180 } 181 182 static int 183 cardbus_attach_card(device_t cbdev) 184 { 185 device_t brdev = device_get_parent(cbdev); 186 device_t child; 187 int bus, domain, slot, func; 188 int cardattached = 0; 189 int cardbusfunchigh = 0; 190 struct cardbus_softc *sc; 191 192 sc = device_get_softc(cbdev); 193 cardbus_detach_card(cbdev); /* detach existing cards */ 194 POWER_DISABLE_SOCKET(brdev, cbdev); /* Turn the socket off first */ 195 POWER_ENABLE_SOCKET(brdev, cbdev); 196 domain = pcib_get_domain(cbdev); 197 bus = pcib_get_bus(cbdev); 198 slot = 0; 199 bus_topo_lock(); 200 /* For each function, set it up and try to attach a driver to it */ 201 for (func = 0; func <= cardbusfunchigh; func++) { 202 struct cardbus_devinfo *dinfo; 203 204 dinfo = (struct cardbus_devinfo *) 205 pci_read_device(brdev, cbdev, domain, bus, slot, func); 206 if (dinfo == NULL) 207 continue; 208 if (dinfo->pci.cfg.mfdev) 209 cardbusfunchigh = PCI_FUNCMAX; 210 211 child = device_add_child(cbdev, NULL, -1); 212 if (child == NULL) { 213 DEVPRINTF((cbdev, "Cannot add child!\n")); 214 pci_freecfg((struct pci_devinfo *)dinfo); 215 continue; 216 } 217 dinfo->pci.cfg.dev = child; 218 resource_list_init(&dinfo->pci.resources); 219 device_set_ivars(child, dinfo); 220 cardbus_device_create(sc, dinfo, cbdev, child); 221 if (cardbus_do_cis(cbdev, child) != 0) 222 DEVPRINTF((cbdev, "Warning: Bogus CIS ignored\n")); 223 pci_cfg_save(dinfo->pci.cfg.dev, &dinfo->pci, 0); 224 pci_cfg_restore(dinfo->pci.cfg.dev, &dinfo->pci); 225 cardbus_device_setup_regs(&dinfo->pci.cfg); 226 pci_add_resources(cbdev, child, 1, dinfo->mprefetchable); 227 pci_print_verbose(&dinfo->pci); 228 if (device_probe_and_attach(child) == 0) 229 cardattached++; 230 else 231 pci_cfg_save(dinfo->pci.cfg.dev, &dinfo->pci, 1); 232 } 233 bus_topo_unlock(); 234 if (cardattached > 0) 235 return (0); 236 /* POWER_DISABLE_SOCKET(brdev, cbdev); */ 237 return (ENOENT); 238 } 239 240 static void 241 cardbus_child_deleted(device_t cbdev, device_t child) 242 { 243 struct cardbus_devinfo *dinfo = device_get_ivars(child); 244 245 if (dinfo->pci.cfg.dev != child) 246 device_printf(cbdev, "devinfo dev mismatch\n"); 247 cardbus_device_destroy(dinfo); 248 pci_child_deleted(cbdev, child); 249 } 250 251 static int 252 cardbus_detach_card(device_t cbdev) 253 { 254 int err = 0; 255 256 bus_topo_lock(); 257 err = bus_generic_detach(cbdev); 258 if (err == 0) 259 err = device_delete_children(cbdev); 260 bus_topo_unlock(); 261 if (err) 262 return (err); 263 264 POWER_DISABLE_SOCKET(device_get_parent(cbdev), cbdev); 265 return (err); 266 } 267 268 static void 269 cardbus_driver_added(device_t cbdev, driver_t *driver) 270 { 271 int numdevs; 272 device_t *devlist; 273 device_t dev; 274 int i; 275 struct cardbus_devinfo *dinfo; 276 277 DEVICE_IDENTIFY(driver, cbdev); 278 if (device_get_children(cbdev, &devlist, &numdevs) != 0) 279 return; 280 281 /* 282 * If there are no drivers attached, but there are children, 283 * then power the card up. 284 */ 285 for (i = 0; i < numdevs; i++) { 286 dev = devlist[i]; 287 if (device_get_state(dev) != DS_NOTPRESENT) 288 break; 289 } 290 if (i > 0 && i == numdevs) 291 POWER_ENABLE_SOCKET(device_get_parent(cbdev), cbdev); 292 for (i = 0; i < numdevs; i++) { 293 dev = devlist[i]; 294 if (device_get_state(dev) != DS_NOTPRESENT) 295 continue; 296 dinfo = device_get_ivars(dev); 297 pci_print_verbose(&dinfo->pci); 298 if (bootverbose) 299 printf("pci%d:%d:%d:%d: reprobing on driver added\n", 300 dinfo->pci.cfg.domain, dinfo->pci.cfg.bus, 301 dinfo->pci.cfg.slot, dinfo->pci.cfg.func); 302 pci_cfg_restore(dinfo->pci.cfg.dev, &dinfo->pci); 303 if (device_probe_and_attach(dev) != 0) 304 pci_cfg_save(dev, &dinfo->pci, 1); 305 } 306 free(devlist, M_TEMP); 307 } 308 309 /************************************************************************/ 310 /* Other Bus Methods */ 311 /************************************************************************/ 312 313 static int 314 cardbus_read_ivar(device_t cbdev, device_t child, int which, uintptr_t *result) 315 { 316 struct cardbus_devinfo *dinfo; 317 318 dinfo = device_get_ivars(child); 319 320 switch (which) { 321 case PCI_IVAR_ETHADDR: 322 /* 323 * The generic accessor doesn't deal with failure, so 324 * we set the return value, then return an error. 325 */ 326 if (dinfo->fepresent & (1 << PCCARD_TPLFE_TYPE_LAN_NID)) { 327 *((uint8_t **) result) = dinfo->funce.lan.nid; 328 break; 329 } 330 *((uint8_t **) result) = NULL; 331 return (EINVAL); 332 default: 333 return (pci_read_ivar(cbdev, child, which, result)); 334 } 335 return 0; 336 } 337 338 static device_method_t cardbus_methods[] = { 339 /* Device interface */ 340 DEVMETHOD(device_probe, cardbus_probe), 341 DEVMETHOD(device_attach, cardbus_attach), 342 DEVMETHOD(device_detach, cardbus_detach), 343 DEVMETHOD(device_suspend, cardbus_suspend), 344 DEVMETHOD(device_resume, cardbus_resume), 345 346 /* Bus interface */ 347 DEVMETHOD(bus_child_deleted, cardbus_child_deleted), 348 DEVMETHOD(bus_get_dma_tag, bus_generic_get_dma_tag), 349 DEVMETHOD(bus_read_ivar, cardbus_read_ivar), 350 DEVMETHOD(bus_driver_added, cardbus_driver_added), 351 DEVMETHOD(bus_rescan, bus_null_rescan), 352 353 /* Card Interface */ 354 DEVMETHOD(card_attach_card, cardbus_attach_card), 355 DEVMETHOD(card_detach_card, cardbus_detach_card), 356 357 /* PCI interface */ 358 DEVMETHOD(pci_alloc_devinfo, cardbus_alloc_devinfo), 359 {0,0} 360 }; 361 362 DEFINE_CLASS_1(cardbus, cardbus_driver, cardbus_methods, 363 sizeof(struct cardbus_softc), pci_driver); 364 365 DRIVER_MODULE(cardbus, cbb, cardbus_driver, 0, 0); 366 MODULE_VERSION(cardbus, 1); 367