1 /*- 2 * Copyright (c) 2003 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 = device_get_softc(cbdev); 103 104 sc->sc_dev = cbdev; 105 cardbus_device_create(sc); 106 return (0); 107 } 108 109 static int 110 cardbus_detach(device_t cbdev) 111 { 112 struct cardbus_softc *sc = device_get_softc(cbdev); 113 114 cardbus_detach_card(cbdev); 115 cardbus_device_destroy(sc); 116 return (0); 117 } 118 119 static int 120 cardbus_suspend(device_t self) 121 { 122 123 cardbus_detach_card(self); 124 return (0); 125 } 126 127 static int 128 cardbus_resume(device_t self) 129 { 130 131 return (0); 132 } 133 134 /************************************************************************/ 135 /* Attach/Detach card */ 136 /************************************************************************/ 137 138 static void 139 cardbus_device_setup_regs(pcicfgregs *cfg) 140 { 141 device_t dev = cfg->dev; 142 int i; 143 144 /* 145 * Some cards power up with garbage in their BARs. This 146 * code clears all that junk out. 147 */ 148 for (i = 0; i < PCI_MAX_BAR_0; i++) 149 pci_write_config(dev, PCIR_BAR(i), 0, 4); 150 151 cfg->intline = 152 pci_get_irq(device_get_parent(device_get_parent(dev))); 153 pci_write_config(dev, PCIR_INTLINE, cfg->intline, 1); 154 pci_write_config(dev, PCIR_CACHELNSZ, 0x08, 1); 155 pci_write_config(dev, PCIR_LATTIMER, 0xa8, 1); 156 pci_write_config(dev, PCIR_MINGNT, 0x14, 1); 157 pci_write_config(dev, PCIR_MAXLAT, 0x14, 1); 158 } 159 160 static int 161 cardbus_attach_card(device_t cbdev) 162 { 163 device_t brdev = device_get_parent(cbdev); 164 device_t child; 165 int cardattached = 0; 166 int bus, slot, func; 167 int cardbusfunchigh = 0; 168 169 cardbus_detach_card(cbdev); /* detach existing cards */ 170 POWER_ENABLE_SOCKET(brdev, cbdev); 171 bus = pcib_get_bus(cbdev); 172 slot = 0; 173 /* For each function, set it up and try to attach a driver to it */ 174 for (func = 0; func <= cardbusfunchigh; func++) { 175 struct cardbus_devinfo *dinfo; 176 177 dinfo = (struct cardbus_devinfo *) 178 pci_read_device(brdev, bus, slot, func, 179 sizeof(struct cardbus_devinfo)); 180 if (dinfo == NULL) 181 continue; 182 if (dinfo->pci.cfg.mfdev) 183 cardbusfunchigh = PCI_FUNCMAX; 184 185 child = device_add_child(cbdev, NULL, -1); 186 if (child == NULL) { 187 DEVPRINTF((cbdev, "Cannot add child!\n")); 188 pci_freecfg((struct pci_devinfo *)dinfo); 189 continue; 190 } 191 dinfo->pci.cfg.dev = child; 192 resource_list_init(&dinfo->pci.resources); 193 device_set_ivars(child, dinfo); 194 if (cardbus_do_cis(cbdev, child) != 0) 195 DEVPRINTF((cbdev, "Warning: Bogus CIS ignored\n")); 196 pci_cfg_save(dinfo->pci.cfg.dev, &dinfo->pci, 0); 197 pci_cfg_restore(dinfo->pci.cfg.dev, &dinfo->pci); 198 cardbus_device_setup_regs(&dinfo->pci.cfg); 199 pci_add_resources(cbdev, child, 1, dinfo->mprefetchable); 200 pci_print_verbose(&dinfo->pci); 201 if (device_probe_and_attach(child) == 0) 202 cardattached++; 203 else 204 pci_cfg_save(dinfo->pci.cfg.dev, &dinfo->pci, 1); 205 } 206 if (cardattached > 0) 207 return (0); 208 POWER_DISABLE_SOCKET(brdev, cbdev); 209 return (ENOENT); 210 } 211 212 static int 213 cardbus_detach_card(device_t cbdev) 214 { 215 int numdevs; 216 device_t *devlist; 217 int tmp; 218 int err = 0; 219 220 if (device_get_children(cbdev, &devlist, &numdevs) != 0) 221 return (ENOENT); 222 223 if (numdevs == 0) { 224 free(devlist, M_TEMP); 225 return (ENOENT); 226 } 227 228 for (tmp = 0; tmp < numdevs; tmp++) { 229 struct cardbus_devinfo *dinfo = device_get_ivars(devlist[tmp]); 230 int status = device_get_state(devlist[tmp]); 231 232 if (dinfo->pci.cfg.dev != devlist[tmp]) 233 device_printf(cbdev, "devinfo dev mismatch\n"); 234 if (status == DS_ATTACHED || status == DS_BUSY) 235 device_detach(devlist[tmp]); 236 cardbus_release_all_resources(cbdev, dinfo); 237 device_delete_child(cbdev, devlist[tmp]); 238 pci_freecfg((struct pci_devinfo *)dinfo); 239 } 240 POWER_DISABLE_SOCKET(device_get_parent(cbdev), cbdev); 241 free(devlist, M_TEMP); 242 return (err); 243 } 244 245 static void 246 cardbus_driver_added(device_t cbdev, driver_t *driver) 247 { 248 int numdevs; 249 device_t *devlist; 250 device_t dev; 251 int i; 252 struct cardbus_devinfo *dinfo; 253 254 DEVICE_IDENTIFY(driver, cbdev); 255 if (device_get_children(cbdev, &devlist, &numdevs) != 0) 256 return; 257 258 /* 259 * If there are no drivers attached, but there are children, 260 * then power the card up. 261 */ 262 for (i = 0; i < numdevs; i++) { 263 dev = devlist[i]; 264 if (device_get_state(dev) != DS_NOTPRESENT) 265 break; 266 } 267 if (i > 0 && i == numdevs) 268 POWER_ENABLE_SOCKET(device_get_parent(cbdev), cbdev); 269 for (i = 0; i < numdevs; i++) { 270 dev = devlist[i]; 271 if (device_get_state(dev) != DS_NOTPRESENT) 272 continue; 273 dinfo = device_get_ivars(dev); 274 pci_print_verbose(&dinfo->pci); 275 pci_cfg_restore(dinfo->pci.cfg.dev, &dinfo->pci); 276 if (device_probe_and_attach(dev) != 0) 277 pci_cfg_save(dev, &dinfo->pci, 1); 278 } 279 free(devlist, M_TEMP); 280 } 281 282 static void 283 cardbus_release_all_resources(device_t cbdev, struct cardbus_devinfo *dinfo) 284 { 285 struct resource_list_entry *rle; 286 287 /* Free all allocated resources */ 288 STAILQ_FOREACH(rle, &dinfo->pci.resources, link) { 289 if (rle->res) { 290 BUS_RELEASE_RESOURCE(device_get_parent(cbdev), 291 cbdev, rle->type, rle->rid, rle->res); 292 rle->res = NULL; 293 /* 294 * zero out config so the card won't acknowledge 295 * access to the space anymore. XXX doesn't handle 296 * 64-bit bars. 297 */ 298 pci_write_config(dinfo->pci.cfg.dev, rle->rid, 0, 4); 299 } 300 } 301 resource_list_free(&dinfo->pci.resources); 302 } 303 304 /************************************************************************/ 305 /* Other Bus Methods */ 306 /************************************************************************/ 307 308 static int 309 cardbus_read_ivar(device_t cbdev, device_t child, int which, uintptr_t *result) 310 { 311 struct cardbus_devinfo *dinfo; 312 pcicfgregs *cfg; 313 314 dinfo = device_get_ivars(child); 315 cfg = &dinfo->pci.cfg; 316 317 switch (which) { 318 case PCI_IVAR_ETHADDR: 319 /* 320 * The generic accessor doesn't deal with failure, so 321 * we set the return value, then return an error. 322 */ 323 if (dinfo->fepresent & (1 << PCCARD_TPLFE_TYPE_LAN_NID)) { 324 *((uint8_t **) result) = dinfo->funce.lan.nid; 325 break; 326 } 327 *((uint8_t **) result) = NULL; 328 return (EINVAL); 329 default: 330 return (pci_read_ivar(cbdev, child, which, result)); 331 } 332 return 0; 333 } 334 335 static int 336 cardbus_write_ivar(device_t cbdev, device_t child, int which, uintptr_t value) 337 { 338 return(pci_write_ivar(cbdev, child, which, value)); 339 } 340 341 static device_method_t cardbus_methods[] = { 342 /* Device interface */ 343 DEVMETHOD(device_probe, cardbus_probe), 344 DEVMETHOD(device_attach, cardbus_attach), 345 DEVMETHOD(device_detach, cardbus_detach), 346 DEVMETHOD(device_suspend, cardbus_suspend), 347 DEVMETHOD(device_resume, cardbus_resume), 348 349 /* Bus interface */ 350 DEVMETHOD(bus_read_ivar, cardbus_read_ivar), 351 DEVMETHOD(bus_write_ivar, cardbus_write_ivar), 352 DEVMETHOD(bus_driver_added, cardbus_driver_added), 353 354 /* Card Interface */ 355 DEVMETHOD(card_attach_card, cardbus_attach_card), 356 DEVMETHOD(card_detach_card, cardbus_detach_card), 357 358 {0,0} 359 }; 360 361 DEFINE_CLASS_1(cardbus, cardbus_driver, cardbus_methods, 362 sizeof(struct cardbus_softc), pci_driver); 363 364 static devclass_t cardbus_devclass; 365 366 DRIVER_MODULE(cardbus, cbb, cardbus_driver, cardbus_devclass, 0, 0); 367 MODULE_VERSION(cardbus, 1); 368