1 /*- 2 * Copyright (c) 2003-2008 M. Warner Losh. All Rights Reserved. 3 * Copyright (c) 2000,2001 Jonathan Chen. All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24 * SUCH DAMAGE. 25 */ 26 27 #include <sys/cdefs.h> 28 __FBSDID("$FreeBSD$"); 29 30 #include <sys/param.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 SYSCTL_NODE(_hw, OID_AUTO, cardbus, CTLFLAG_RD, 0, "CardBus parameters"); 58 59 int cardbus_debug = 0; 60 TUNABLE_INT("hw.cardbus.debug", &cardbus_debug); 61 SYSCTL_INT(_hw_cardbus, OID_AUTO, debug, CTLFLAG_RW, 62 &cardbus_debug, 0, 63 "CardBus debug"); 64 65 int cardbus_cis_debug = 0; 66 TUNABLE_INT("hw.cardbus.cis_debug", &cardbus_cis_debug); 67 SYSCTL_INT(_hw_cardbus, OID_AUTO, cis_debug, CTLFLAG_RW, 68 &cardbus_cis_debug, 0, 69 "CardBus CIS debug"); 70 71 #define DPRINTF(a) if (cardbus_debug) printf a 72 #define DEVPRINTF(x) if (cardbus_debug) device_printf x 73 74 static int cardbus_attach(device_t cbdev); 75 static int cardbus_attach_card(device_t cbdev); 76 static int cardbus_detach(device_t cbdev); 77 static int cardbus_detach_card(device_t cbdev); 78 static void cardbus_device_setup_regs(pcicfgregs *cfg); 79 static void cardbus_driver_added(device_t cbdev, driver_t *driver); 80 static int cardbus_probe(device_t cbdev); 81 static int cardbus_read_ivar(device_t cbdev, device_t child, int which, 82 uintptr_t *result); 83 static void cardbus_release_all_resources(device_t cbdev, 84 struct cardbus_devinfo *dinfo); 85 static int cardbus_write_ivar(device_t cbdev, device_t child, int which, 86 uintptr_t value); 87 88 /************************************************************************/ 89 /* Probe/Attach */ 90 /************************************************************************/ 91 92 static int 93 cardbus_probe(device_t cbdev) 94 { 95 device_set_desc(cbdev, "CardBus bus"); 96 return (0); 97 } 98 99 static int 100 cardbus_attach(device_t cbdev) 101 { 102 struct cardbus_softc *sc; 103 104 sc = device_get_softc(cbdev); 105 sc->sc_dev = cbdev; 106 return (0); 107 } 108 109 static int 110 cardbus_detach(device_t cbdev) 111 { 112 113 cardbus_detach_card(cbdev); 114 return (0); 115 } 116 117 static int 118 cardbus_suspend(device_t self) 119 { 120 121 cardbus_detach_card(self); 122 return (0); 123 } 124 125 static int 126 cardbus_resume(device_t self) 127 { 128 129 return (0); 130 } 131 132 /************************************************************************/ 133 /* Attach/Detach card */ 134 /************************************************************************/ 135 136 static void 137 cardbus_device_setup_regs(pcicfgregs *cfg) 138 { 139 device_t dev = cfg->dev; 140 int i; 141 142 /* 143 * Some cards power up with garbage in their BARs. This 144 * code clears all that junk out. 145 */ 146 for (i = 0; i < PCIR_MAX_BAR_0; i++) 147 pci_write_config(dev, PCIR_BAR(i), 0, 4); 148 149 cfg->intline = 150 pci_get_irq(device_get_parent(device_get_parent(dev))); 151 pci_write_config(dev, PCIR_INTLINE, cfg->intline, 1); 152 pci_write_config(dev, PCIR_CACHELNSZ, 0x08, 1); 153 pci_write_config(dev, PCIR_LATTIMER, 0xa8, 1); 154 pci_write_config(dev, PCIR_MINGNT, 0x14, 1); 155 pci_write_config(dev, PCIR_MAXLAT, 0x14, 1); 156 } 157 158 static int 159 cardbus_attach_card(device_t cbdev) 160 { 161 device_t brdev = device_get_parent(cbdev); 162 device_t child; 163 int bus, domain, slot, func; 164 int cardattached = 0; 165 int cardbusfunchigh = 0; 166 struct cardbus_softc *sc; 167 168 sc = device_get_softc(cbdev); 169 cardbus_detach_card(cbdev); /* detach existing cards */ 170 POWER_ENABLE_SOCKET(brdev, cbdev); 171 domain = pcib_get_domain(cbdev); 172 bus = pcib_get_bus(cbdev); 173 slot = 0; 174 /* For each function, set it up and try to attach a driver to it */ 175 for (func = 0; func <= cardbusfunchigh; func++) { 176 struct cardbus_devinfo *dinfo; 177 178 dinfo = (struct cardbus_devinfo *) 179 pci_read_device(brdev, domain, bus, slot, func, 180 sizeof(struct cardbus_devinfo)); 181 if (dinfo == NULL) 182 continue; 183 if (dinfo->pci.cfg.mfdev) 184 cardbusfunchigh = PCI_FUNCMAX; 185 186 child = device_add_child(cbdev, NULL, -1); 187 if (child == NULL) { 188 DEVPRINTF((cbdev, "Cannot add child!\n")); 189 pci_freecfg((struct pci_devinfo *)dinfo); 190 continue; 191 } 192 dinfo->pci.cfg.dev = child; 193 resource_list_init(&dinfo->pci.resources); 194 device_set_ivars(child, dinfo); 195 cardbus_device_create(sc, dinfo, cbdev, child); 196 if (cardbus_do_cis(cbdev, child) != 0) 197 DEVPRINTF((cbdev, "Warning: Bogus CIS ignored\n")); 198 pci_cfg_save(dinfo->pci.cfg.dev, &dinfo->pci, 0); 199 pci_cfg_restore(dinfo->pci.cfg.dev, &dinfo->pci); 200 cardbus_device_setup_regs(&dinfo->pci.cfg); 201 pci_add_resources(cbdev, child, 1, dinfo->mprefetchable); 202 pci_print_verbose(&dinfo->pci); 203 if (device_probe_and_attach(child) == 0) 204 cardattached++; 205 else 206 pci_cfg_save(dinfo->pci.cfg.dev, &dinfo->pci, 1); 207 } 208 if (cardattached > 0) 209 return (0); 210 /* POWER_DISABLE_SOCKET(brdev, cbdev); */ 211 return (ENOENT); 212 } 213 214 static int 215 cardbus_detach_card(device_t cbdev) 216 { 217 int numdevs; 218 device_t *devlist; 219 int tmp; 220 int err = 0; 221 222 if (device_get_children(cbdev, &devlist, &numdevs) != 0) 223 return (ENOENT); 224 225 if (numdevs == 0) { 226 free(devlist, M_TEMP); 227 return (ENOENT); 228 } 229 230 for (tmp = 0; tmp < numdevs; tmp++) { 231 struct cardbus_devinfo *dinfo = device_get_ivars(devlist[tmp]); 232 int status = device_get_state(devlist[tmp]); 233 234 if (dinfo->pci.cfg.dev != devlist[tmp]) 235 device_printf(cbdev, "devinfo dev mismatch\n"); 236 if (status == DS_ATTACHED || status == DS_BUSY) 237 device_detach(devlist[tmp]); 238 cardbus_release_all_resources(cbdev, dinfo); 239 cardbus_device_destroy(dinfo); 240 device_delete_child(cbdev, devlist[tmp]); 241 pci_freecfg((struct pci_devinfo *)dinfo); 242 } 243 POWER_DISABLE_SOCKET(device_get_parent(cbdev), cbdev); 244 free(devlist, M_TEMP); 245 return (err); 246 } 247 248 static void 249 cardbus_driver_added(device_t cbdev, driver_t *driver) 250 { 251 int numdevs; 252 device_t *devlist; 253 device_t dev; 254 int i; 255 struct cardbus_devinfo *dinfo; 256 257 DEVICE_IDENTIFY(driver, cbdev); 258 if (device_get_children(cbdev, &devlist, &numdevs) != 0) 259 return; 260 261 /* 262 * If there are no drivers attached, but there are children, 263 * then power the card up. 264 */ 265 for (i = 0; i < numdevs; i++) { 266 dev = devlist[i]; 267 if (device_get_state(dev) != DS_NOTPRESENT) 268 break; 269 } 270 if (i > 0 && i == numdevs) 271 POWER_ENABLE_SOCKET(device_get_parent(cbdev), cbdev); 272 /* XXX Should I wait for power to become good? */ 273 for (i = 0; i < numdevs; i++) { 274 dev = devlist[i]; 275 if (device_get_state(dev) != DS_NOTPRESENT) 276 continue; 277 dinfo = device_get_ivars(dev); 278 pci_print_verbose(&dinfo->pci); 279 pci_cfg_restore(dinfo->pci.cfg.dev, &dinfo->pci); 280 if (device_probe_and_attach(dev) != 0) 281 pci_cfg_save(dev, &dinfo->pci, 1); 282 } 283 free(devlist, M_TEMP); 284 } 285 286 static void 287 cardbus_release_all_resources(device_t cbdev, struct cardbus_devinfo *dinfo) 288 { 289 struct resource_list_entry *rle; 290 291 /* Free all allocated resources */ 292 STAILQ_FOREACH(rle, &dinfo->pci.resources, link) { 293 if (rle->res) { 294 BUS_RELEASE_RESOURCE(device_get_parent(cbdev), 295 cbdev, rle->type, rle->rid, rle->res); 296 rle->res = NULL; 297 /* 298 * zero out config so the card won't acknowledge 299 * access to the space anymore. XXX doesn't handle 300 * 64-bit bars. 301 */ 302 pci_write_config(dinfo->pci.cfg.dev, rle->rid, 0, 4); 303 } 304 } 305 resource_list_free(&dinfo->pci.resources); 306 } 307 308 /************************************************************************/ 309 /* Other Bus Methods */ 310 /************************************************************************/ 311 312 static int 313 cardbus_read_ivar(device_t cbdev, device_t child, int which, uintptr_t *result) 314 { 315 struct cardbus_devinfo *dinfo; 316 pcicfgregs *cfg; 317 318 dinfo = device_get_ivars(child); 319 cfg = &dinfo->pci.cfg; 320 321 switch (which) { 322 case PCI_IVAR_ETHADDR: 323 /* 324 * The generic accessor doesn't deal with failure, so 325 * we set the return value, then return an error. 326 */ 327 if (dinfo->fepresent & (1 << PCCARD_TPLFE_TYPE_LAN_NID)) { 328 *((uint8_t **) result) = dinfo->funce.lan.nid; 329 break; 330 } 331 *((uint8_t **) result) = NULL; 332 return (EINVAL); 333 default: 334 return (pci_read_ivar(cbdev, child, which, result)); 335 } 336 return 0; 337 } 338 339 static int 340 cardbus_write_ivar(device_t cbdev, device_t child, int which, uintptr_t value) 341 { 342 return(pci_write_ivar(cbdev, child, which, value)); 343 } 344 345 static device_method_t cardbus_methods[] = { 346 /* Device interface */ 347 DEVMETHOD(device_probe, cardbus_probe), 348 DEVMETHOD(device_attach, cardbus_attach), 349 DEVMETHOD(device_detach, cardbus_detach), 350 DEVMETHOD(device_suspend, cardbus_suspend), 351 DEVMETHOD(device_resume, cardbus_resume), 352 353 /* Bus interface */ 354 DEVMETHOD(bus_read_ivar, cardbus_read_ivar), 355 DEVMETHOD(bus_write_ivar, cardbus_write_ivar), 356 DEVMETHOD(bus_driver_added, cardbus_driver_added), 357 358 /* Card Interface */ 359 DEVMETHOD(card_attach_card, cardbus_attach_card), 360 DEVMETHOD(card_detach_card, cardbus_detach_card), 361 362 {0,0} 363 }; 364 365 DEFINE_CLASS_1(cardbus, cardbus_driver, cardbus_methods, 366 sizeof(struct cardbus_softc), pci_driver); 367 368 static devclass_t cardbus_devclass; 369 370 DRIVER_MODULE(cardbus, cbb, cardbus_driver, cardbus_devclass, 0, 0); 371 MODULE_VERSION(cardbus, 1); 372