1 /*- 2 * Copyright 1998 Massachusetts Institute of Technology 3 * Copyright 2001 by Thomas Moestl <tmm@FreeBSD.org>. 4 * Copyright 2006 by Marius Strobl <marius@FreeBSD.org>. 5 * All rights reserved. 6 * 7 * Permission to use, copy, modify, and distribute this software and 8 * its documentation for any purpose and without fee is hereby 9 * granted, provided that both the above copyright notice and this 10 * permission notice appear in all copies, that both the above 11 * copyright notice and this permission notice appear in all 12 * supporting documentation, and that the name of M.I.T. not be used 13 * in advertising or publicity pertaining to distribution of the 14 * software without specific, written prior permission. M.I.T. makes 15 * no representations about the suitability of this software for any 16 * purpose. It is provided "as is" without express or implied 17 * warranty. 18 * 19 * THIS SOFTWARE IS PROVIDED BY M.I.T. ``AS IS''. M.I.T. DISCLAIMS 20 * ALL EXPRESS OR IMPLIED WARRANTIES WITH REGARD TO THIS SOFTWARE, 21 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 22 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT 23 * SHALL M.I.T. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 24 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 25 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF 26 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 27 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 28 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 29 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30 * SUCH DAMAGE. 31 * 32 * from: FreeBSD: src/sys/i386/i386/nexus.c,v 1.43 2001/02/09 33 */ 34 35 #include <sys/cdefs.h> 36 __FBSDID("$FreeBSD$"); 37 38 #include <sys/param.h> 39 #include <sys/systm.h> 40 #include <sys/bus.h> 41 #include <sys/kernel.h> 42 #include <sys/malloc.h> 43 #include <sys/module.h> 44 #include <sys/pcpu.h> 45 #include <sys/rman.h> 46 47 #include <vm/vm.h> 48 #include <vm/pmap.h> 49 50 #include <dev/ofw/ofw_bus.h> 51 #include <dev/ofw/ofw_bus_subr.h> 52 #include <dev/ofw/openfirm.h> 53 54 #include <machine/bus.h> 55 #include <machine/resource.h> 56 57 /* 58 * The ofwbus (which is a pseudo-bus actually) iterates over the nodes that 59 * hang from the Open Firmware root node and adds them as devices to this bus 60 * (except some special nodes which are excluded) so that drivers can be 61 * attached to them. 62 * 63 */ 64 65 struct ofwbus_devinfo { 66 struct ofw_bus_devinfo ndi_obdinfo; 67 struct resource_list ndi_rl; 68 }; 69 70 struct ofwbus_softc { 71 uint32_t acells, scells; 72 struct rman sc_intr_rman; 73 struct rman sc_mem_rman; 74 }; 75 76 static device_identify_t ofwbus_identify; 77 static device_probe_t ofwbus_probe; 78 static device_attach_t ofwbus_attach; 79 static bus_print_child_t ofwbus_print_child; 80 static bus_add_child_t ofwbus_add_child; 81 static bus_probe_nomatch_t ofwbus_probe_nomatch; 82 static bus_alloc_resource_t ofwbus_alloc_resource; 83 static bus_adjust_resource_t ofwbus_adjust_resource; 84 static bus_release_resource_t ofwbus_release_resource; 85 static bus_get_resource_list_t ofwbus_get_resource_list; 86 static ofw_bus_get_devinfo_t ofwbus_get_devinfo; 87 88 static int ofwbus_inlist(const char *, const char *const *); 89 static struct ofwbus_devinfo * ofwbus_setup_dinfo(device_t, phandle_t); 90 static void ofwbus_destroy_dinfo(struct ofwbus_devinfo *); 91 static int ofwbus_print_res(struct ofwbus_devinfo *); 92 93 static device_method_t ofwbus_methods[] = { 94 /* Device interface */ 95 DEVMETHOD(device_identify, ofwbus_identify), 96 DEVMETHOD(device_probe, ofwbus_probe), 97 DEVMETHOD(device_attach, ofwbus_attach), 98 DEVMETHOD(device_detach, bus_generic_detach), 99 DEVMETHOD(device_shutdown, bus_generic_shutdown), 100 DEVMETHOD(device_suspend, bus_generic_suspend), 101 DEVMETHOD(device_resume, bus_generic_resume), 102 103 /* Bus interface */ 104 DEVMETHOD(bus_print_child, ofwbus_print_child), 105 DEVMETHOD(bus_probe_nomatch, ofwbus_probe_nomatch), 106 DEVMETHOD(bus_read_ivar, bus_generic_read_ivar), 107 DEVMETHOD(bus_write_ivar, bus_generic_write_ivar), 108 DEVMETHOD(bus_add_child, ofwbus_add_child), 109 DEVMETHOD(bus_child_pnpinfo_str, ofw_bus_gen_child_pnpinfo_str), 110 DEVMETHOD(bus_alloc_resource, ofwbus_alloc_resource), 111 DEVMETHOD(bus_adjust_resource, ofwbus_adjust_resource), 112 DEVMETHOD(bus_release_resource, ofwbus_release_resource), 113 DEVMETHOD(bus_set_resource, bus_generic_rl_set_resource), 114 DEVMETHOD(bus_get_resource, bus_generic_rl_get_resource), 115 DEVMETHOD(bus_get_resource_list, ofwbus_get_resource_list), 116 DEVMETHOD(bus_activate_resource, bus_generic_activate_resource), 117 DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource), 118 DEVMETHOD(bus_config_intr, bus_generic_config_intr), 119 DEVMETHOD(bus_setup_intr, bus_generic_setup_intr), 120 DEVMETHOD(bus_teardown_intr, bus_generic_teardown_intr), 121 122 /* ofw_bus interface */ 123 DEVMETHOD(ofw_bus_get_devinfo, ofwbus_get_devinfo), 124 DEVMETHOD(ofw_bus_get_compat, ofw_bus_gen_get_compat), 125 DEVMETHOD(ofw_bus_get_model, ofw_bus_gen_get_model), 126 DEVMETHOD(ofw_bus_get_name, ofw_bus_gen_get_name), 127 DEVMETHOD(ofw_bus_get_node, ofw_bus_gen_get_node), 128 DEVMETHOD(ofw_bus_get_type, ofw_bus_gen_get_type), 129 130 DEVMETHOD_END 131 }; 132 133 static driver_t ofwbus_driver = { 134 "ofwbus", 135 ofwbus_methods, 136 sizeof(struct ofwbus_softc) 137 }; 138 static devclass_t ofwbus_devclass; 139 EARLY_DRIVER_MODULE(ofwbus, nexus, ofwbus_driver, ofwbus_devclass, 0, 0, 140 BUS_PASS_BUS + BUS_PASS_ORDER_MIDDLE); 141 MODULE_VERSION(ofwbus, 1); 142 143 static const char *const ofwbus_excl_name[] = { 144 "FJSV,system", 145 "aliases", 146 "associations", 147 "chosen", 148 "cmp", 149 "counter-timer", /* No separate device; handled by psycho/sbus */ 150 "failsafe", 151 "memory", 152 "openprom", 153 "options", 154 "packages", 155 "physical-memory", 156 "rsc", 157 "sgcn", 158 "todsg", 159 "virtual-memory", 160 NULL 161 }; 162 163 static const char *const ofwbus_excl_type[] = { 164 "core", 165 "cpu", 166 NULL 167 }; 168 169 static int 170 ofwbus_inlist(const char *name, const char *const *list) 171 { 172 int i; 173 174 if (name == NULL) 175 return (0); 176 for (i = 0; list[i] != NULL; i++) 177 if (strcmp(name, list[i]) == 0) 178 return (1); 179 return (0); 180 } 181 182 #define OFWBUS_EXCLUDED(name, type) \ 183 (ofwbus_inlist((name), ofwbus_excl_name) || \ 184 ((type) != NULL && ofwbus_inlist((type), ofwbus_excl_type))) 185 186 static void 187 ofwbus_identify(driver_t *driver, device_t parent) 188 { 189 190 /* Check if Open Firmware has been instantiated */ 191 if (OF_peer(0) == 0) 192 return; 193 194 if (device_find_child(parent, "ofwbus", -1) == NULL) 195 BUS_ADD_CHILD(parent, 0, "ofwbus", -1); 196 } 197 198 static int 199 ofwbus_probe(device_t dev) 200 { 201 202 device_set_desc(dev, "Open Firmware Device Tree"); 203 return (BUS_PROBE_NOWILDCARD); 204 } 205 206 static int 207 ofwbus_attach(device_t dev) 208 { 209 struct ofwbus_devinfo *ndi; 210 struct ofwbus_softc *sc; 211 device_t cdev; 212 phandle_t node; 213 214 sc = device_get_softc(dev); 215 216 node = OF_peer(0); 217 218 /* 219 * If no Open Firmware, bail early 220 */ 221 if (node == -1) 222 return (ENXIO); 223 224 sc->sc_intr_rman.rm_type = RMAN_ARRAY; 225 sc->sc_intr_rman.rm_descr = "Interrupts"; 226 sc->sc_mem_rman.rm_type = RMAN_ARRAY; 227 sc->sc_mem_rman.rm_descr = "Device Memory"; 228 if (rman_init(&sc->sc_intr_rman) != 0 || 229 rman_init(&sc->sc_mem_rman) != 0 || 230 rman_manage_region(&sc->sc_intr_rman, 0, ~0) != 0 || 231 rman_manage_region(&sc->sc_mem_rman, 0, BUS_SPACE_MAXADDR) != 0) 232 panic("%s: failed to set up rmans.", __func__); 233 234 /* 235 * Allow devices to identify. 236 */ 237 bus_generic_probe(dev); 238 239 /* 240 * Some important numbers 241 */ 242 sc->acells = 2; 243 OF_getencprop(node, "#address-cells", &sc->acells, sizeof(sc->acells)); 244 sc->scells = 1; 245 OF_getencprop(node, "#size-cells", &sc->scells, sizeof(sc->scells)); 246 247 /* 248 * Now walk the OFW tree and attach top-level devices. 249 */ 250 for (node = OF_child(node); node > 0; node = OF_peer(node)) { 251 if ((ndi = ofwbus_setup_dinfo(dev, node)) == NULL) 252 continue; 253 cdev = device_add_child(dev, NULL, -1); 254 if (cdev == NULL) { 255 device_printf(dev, "<%s>: device_add_child failed\n", 256 ndi->ndi_obdinfo.obd_name); 257 ofwbus_destroy_dinfo(ndi); 258 continue; 259 } 260 device_set_ivars(cdev, ndi); 261 } 262 return (bus_generic_attach(dev)); 263 } 264 265 static device_t 266 ofwbus_add_child(device_t dev, u_int order, const char *name, int unit) 267 { 268 device_t cdev; 269 struct ofwbus_devinfo *ndi; 270 271 cdev = device_add_child_ordered(dev, order, name, unit); 272 if (cdev == NULL) 273 return (NULL); 274 275 ndi = malloc(sizeof(*ndi), M_DEVBUF, M_WAITOK | M_ZERO); 276 ndi->ndi_obdinfo.obd_node = -1; 277 resource_list_init(&ndi->ndi_rl); 278 device_set_ivars(cdev, ndi); 279 280 return (cdev); 281 } 282 283 static int 284 ofwbus_print_child(device_t bus, device_t child) 285 { 286 int rv; 287 288 rv = bus_print_child_header(bus, child); 289 rv += ofwbus_print_res(device_get_ivars(child)); 290 rv += bus_print_child_footer(bus, child); 291 return (rv); 292 } 293 294 static void 295 ofwbus_probe_nomatch(device_t bus, device_t child) 296 { 297 const char *name, *type; 298 299 if (!bootverbose) 300 return; 301 302 name = ofw_bus_get_name(child); 303 type = ofw_bus_get_type(child); 304 305 device_printf(bus, "<%s>", 306 name != NULL ? name : "unknown"); 307 ofwbus_print_res(device_get_ivars(child)); 308 printf(" type %s (no driver attached)\n", 309 type != NULL ? type : "unknown"); 310 } 311 312 static struct resource * 313 ofwbus_alloc_resource(device_t bus, device_t child, int type, int *rid, 314 u_long start, u_long end, u_long count, u_int flags) 315 { 316 struct ofwbus_softc *sc; 317 struct rman *rm; 318 struct resource *rv; 319 struct resource_list_entry *rle; 320 int isdefault, passthrough; 321 322 isdefault = (start == 0UL && end == ~0UL); 323 passthrough = (device_get_parent(child) != bus); 324 sc = device_get_softc(bus); 325 rle = NULL; 326 327 if (!passthrough && isdefault) { 328 rle = resource_list_find(BUS_GET_RESOURCE_LIST(bus, child), 329 type, *rid); 330 if (rle == NULL) 331 return (NULL); 332 if (rle->res != NULL) 333 panic("%s: resource entry is busy", __func__); 334 start = rle->start; 335 count = ulmax(count, rle->count); 336 end = ulmax(rle->end, start + count - 1); 337 } 338 339 switch (type) { 340 case SYS_RES_IRQ: 341 rm = &sc->sc_intr_rman; 342 break; 343 case SYS_RES_MEMORY: 344 rm = &sc->sc_mem_rman; 345 break; 346 default: 347 return (NULL); 348 } 349 350 rv = rman_reserve_resource(rm, start, end, count, flags & ~RF_ACTIVE, 351 child); 352 if (rv == NULL) 353 return (NULL); 354 rman_set_rid(rv, *rid); 355 356 if ((flags & RF_ACTIVE) != 0 && bus_activate_resource(child, type, 357 *rid, rv) != 0) { 358 rman_release_resource(rv); 359 return (NULL); 360 } 361 362 if (!passthrough && rle != NULL) { 363 rle->res = rv; 364 rle->start = rman_get_start(rv); 365 rle->end = rman_get_end(rv); 366 rle->count = rle->end - rle->start + 1; 367 } 368 369 return (rv); 370 } 371 372 static int 373 ofwbus_adjust_resource(device_t bus, device_t child __unused, int type, 374 struct resource *r, u_long start, u_long end) 375 { 376 struct ofwbus_softc *sc; 377 struct rman *rm; 378 device_t ofwbus; 379 380 ofwbus = bus; 381 while (strcmp(device_get_name(device_get_parent(ofwbus)), "root") != 0) 382 ofwbus = device_get_parent(ofwbus); 383 sc = device_get_softc(ofwbus); 384 switch (type) { 385 case SYS_RES_IRQ: 386 rm = &sc->sc_intr_rman; 387 break; 388 case SYS_RES_MEMORY: 389 rm = &sc->sc_mem_rman; 390 break; 391 default: 392 return (EINVAL); 393 } 394 if (rm == NULL) 395 return (ENXIO); 396 if (rman_is_region_manager(r, rm) == 0) 397 return (EINVAL); 398 return (rman_adjust_resource(r, start, end)); 399 } 400 401 static int 402 ofwbus_release_resource(device_t bus, device_t child, int type, 403 int rid, struct resource *r) 404 { 405 struct resource_list_entry *rle; 406 int error; 407 408 /* Clean resource list entry */ 409 rle = resource_list_find(BUS_GET_RESOURCE_LIST(bus, child), type, rid); 410 if (rle != NULL) 411 rle->res = NULL; 412 413 if ((rman_get_flags(r) & RF_ACTIVE) != 0) { 414 error = bus_deactivate_resource(child, type, rid, r); 415 if (error) 416 return (error); 417 } 418 return (rman_release_resource(r)); 419 } 420 421 static struct resource_list * 422 ofwbus_get_resource_list(device_t bus __unused, device_t child) 423 { 424 struct ofwbus_devinfo *ndi; 425 426 ndi = device_get_ivars(child); 427 return (&ndi->ndi_rl); 428 } 429 430 static const struct ofw_bus_devinfo * 431 ofwbus_get_devinfo(device_t bus __unused, device_t child) 432 { 433 struct ofwbus_devinfo *ndi; 434 435 ndi = device_get_ivars(child); 436 return (&ndi->ndi_obdinfo); 437 } 438 439 static struct ofwbus_devinfo * 440 ofwbus_setup_dinfo(device_t dev, phandle_t node) 441 { 442 struct ofwbus_softc *sc; 443 struct ofwbus_devinfo *ndi; 444 const char *nodename; 445 uint32_t *reg; 446 uint64_t phys, size; 447 int i, j, rid; 448 int nreg; 449 450 sc = device_get_softc(dev); 451 452 ndi = malloc(sizeof(*ndi), M_DEVBUF, M_WAITOK | M_ZERO); 453 if (ofw_bus_gen_setup_devinfo(&ndi->ndi_obdinfo, node) != 0) { 454 free(ndi, M_DEVBUF); 455 return (NULL); 456 } 457 nodename = ndi->ndi_obdinfo.obd_name; 458 if (OFWBUS_EXCLUDED(nodename, ndi->ndi_obdinfo.obd_type)) { 459 ofw_bus_gen_destroy_devinfo(&ndi->ndi_obdinfo); 460 free(ndi, M_DEVBUF); 461 return (NULL); 462 } 463 464 resource_list_init(&ndi->ndi_rl); 465 nreg = OF_getencprop_alloc(node, "reg", sizeof(*reg), (void **)®); 466 if (nreg == -1) 467 nreg = 0; 468 if (nreg % (sc->acells + sc->scells) != 0) { 469 if (bootverbose) 470 device_printf(dev, "Malformed reg property on <%s>\n", 471 nodename); 472 nreg = 0; 473 } 474 475 for (i = 0, rid = 0; i < nreg; i += sc->acells + sc->scells, rid++) { 476 phys = size = 0; 477 for (j = 0; j < sc->acells; j++) { 478 phys <<= 32; 479 phys |= reg[i + j]; 480 } 481 for (j = 0; j < sc->scells; j++) { 482 size <<= 32; 483 size |= reg[i + sc->acells + j]; 484 } 485 /* Skip the dummy reg property of glue devices like ssm(4). */ 486 if (size != 0) 487 resource_list_add(&ndi->ndi_rl, SYS_RES_MEMORY, rid, 488 phys, phys + size - 1, size); 489 } 490 free(reg, M_OFWPROP); 491 492 ofw_bus_intr_to_rl(dev, node, &ndi->ndi_rl); 493 494 return (ndi); 495 } 496 497 static void 498 ofwbus_destroy_dinfo(struct ofwbus_devinfo *ndi) 499 { 500 501 resource_list_free(&ndi->ndi_rl); 502 ofw_bus_gen_destroy_devinfo(&ndi->ndi_obdinfo); 503 free(ndi, M_DEVBUF); 504 } 505 506 static int 507 ofwbus_print_res(struct ofwbus_devinfo *ndi) 508 { 509 int rv; 510 511 rv = 0; 512 rv += resource_list_print_type(&ndi->ndi_rl, "mem", SYS_RES_MEMORY, 513 "%#lx"); 514 rv += resource_list_print_type(&ndi->ndi_rl, "irq", SYS_RES_IRQ, 515 "%ld"); 516 return (rv); 517 } 518 519