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 46#include <dev/ofw/ofw_bus.h> 47#include <dev/ofw/ofw_bus_subr.h> 48#include <dev/ofw/openfirm.h> 49 50#include <machine/bus.h> 51#include <machine/bus_common.h> 52#include <machine/intr_machdep.h> 53#include <machine/nexusvar.h> 54#include <machine/ofw_nexus.h> 55#include <machine/resource.h> 56#include <machine/ver.h> 57 58#include <sys/rman.h> 59 60/* 61 * The nexus (which is a pseudo-bus actually) iterates over the nodes that 62 * hang from the Open Firmware root node and adds them as devices to this bus 63 * (except some special nodes which are excluded) so that drivers can be 64 * attached to them. 65 * 66 * Additionally, interrupt setup/teardown and some resource management are 67 * done at this level. 68 * 69 * Maybe this code should get into dev/ofw to some extent, as some of it should 70 * work for all Open Firmware based machines... 71 */ 72 73struct nexus_devinfo { 74 struct ofw_bus_devinfo ndi_obdinfo; 75 struct resource_list ndi_rl; 76}; 77 78struct nexus_softc { 79 struct rman sc_intr_rman; 80 struct rman sc_mem_rman; 81}; 82 83static device_probe_t nexus_probe; 84static device_attach_t nexus_attach; 85static bus_print_child_t nexus_print_child; 86static bus_add_child_t nexus_add_child; 87static bus_probe_nomatch_t nexus_probe_nomatch; 88static bus_setup_intr_t nexus_setup_intr; 89static bus_teardown_intr_t nexus_teardown_intr; 90static bus_alloc_resource_t nexus_alloc_resource; 91static bus_activate_resource_t nexus_activate_resource; 92static bus_deactivate_resource_t nexus_deactivate_resource; 93static bus_adjust_resource_t nexus_adjust_resource; 94static bus_release_resource_t nexus_release_resource; 95static bus_get_resource_list_t nexus_get_resource_list; 96#ifdef SMP 97static bus_bind_intr_t nexus_bind_intr; 98#endif 99static bus_describe_intr_t nexus_describe_intr; 100static bus_get_dma_tag_t nexus_get_dma_tag; 101static ofw_bus_get_devinfo_t nexus_get_devinfo; 102 103static int nexus_inlist(const char *, const char *const *); 104static struct nexus_devinfo * nexus_setup_dinfo(device_t, phandle_t); 105static void nexus_destroy_dinfo(struct nexus_devinfo *); 106static int nexus_print_res(struct nexus_devinfo *); 107 108static device_method_t nexus_methods[] = { 109 /* Device interface */ 110 DEVMETHOD(device_probe, nexus_probe), 111 DEVMETHOD(device_attach, nexus_attach), 112 DEVMETHOD(device_detach, bus_generic_detach), 113 DEVMETHOD(device_shutdown, bus_generic_shutdown), 114 DEVMETHOD(device_suspend, bus_generic_suspend), 115 DEVMETHOD(device_resume, bus_generic_resume), 116 117 /* Bus interface */ 118 DEVMETHOD(bus_print_child, nexus_print_child), 119 DEVMETHOD(bus_probe_nomatch, nexus_probe_nomatch), 120 DEVMETHOD(bus_read_ivar, bus_generic_read_ivar), 121 DEVMETHOD(bus_write_ivar, bus_generic_write_ivar), 122 DEVMETHOD(bus_add_child, nexus_add_child), 123 DEVMETHOD(bus_alloc_resource, nexus_alloc_resource), 124 DEVMETHOD(bus_activate_resource, nexus_activate_resource), 125 DEVMETHOD(bus_deactivate_resource, nexus_deactivate_resource), 126 DEVMETHOD(bus_adjust_resource, nexus_adjust_resource), 127 DEVMETHOD(bus_release_resource, nexus_release_resource), 128 DEVMETHOD(bus_setup_intr, nexus_setup_intr), 129 DEVMETHOD(bus_teardown_intr, nexus_teardown_intr), 130 DEVMETHOD(bus_set_resource, bus_generic_rl_set_resource), 131 DEVMETHOD(bus_get_resource, bus_generic_rl_get_resource), 132 DEVMETHOD(bus_get_resource_list, nexus_get_resource_list), 133#ifdef SMP 134 DEVMETHOD(bus_bind_intr, nexus_bind_intr), 135#endif 136 DEVMETHOD(bus_describe_intr, nexus_describe_intr), 137 DEVMETHOD(bus_get_dma_tag, nexus_get_dma_tag), 138 139 /* ofw_bus interface */ 140 DEVMETHOD(ofw_bus_get_devinfo, nexus_get_devinfo), 141 DEVMETHOD(ofw_bus_get_compat, ofw_bus_gen_get_compat), 142 DEVMETHOD(ofw_bus_get_model, ofw_bus_gen_get_model), 143 DEVMETHOD(ofw_bus_get_name, ofw_bus_gen_get_name), 144 DEVMETHOD(ofw_bus_get_node, ofw_bus_gen_get_node), 145 DEVMETHOD(ofw_bus_get_type, ofw_bus_gen_get_type), 146 147 DEVMETHOD_END 148}; 149 150static devclass_t nexus_devclass; 151 152DEFINE_CLASS_0(nexus, nexus_driver, nexus_methods, sizeof(struct nexus_softc)); 153EARLY_DRIVER_MODULE(nexus, root, nexus_driver, nexus_devclass, 0, 0, 154 BUS_PASS_BUS); 155MODULE_VERSION(nexus, 1); 156 157static const char *const nexus_excl_name[] = { 158 "FJSV,system", 159 "aliases", 160 "associations", 161 "chosen", 162 "cmp", 163 "counter-timer", /* No separate device; handled by psycho/sbus */ 164 "failsafe", 165 "memory", 166 "openprom", 167 "options", 168 "packages", 169 "physical-memory", 170 "rsc", 171 "sgcn", 172 "todsg", 173 "virtual-memory", 174 NULL 175}; 176 177static const char *const nexus_excl_type[] = { 178 "core", 179 "cpu", 180 NULL 181}; 182 183extern struct bus_space_tag nexus_bustag; 184extern struct bus_dma_tag nexus_dmatag; 185 186static int 187nexus_inlist(const char *name, const char *const *list) 188{ 189 int i; 190 191 if (name == NULL) 192 return (0); 193 for (i = 0; list[i] != NULL; i++) 194 if (strcmp(name, list[i]) == 0) 195 return (1); 196 return (0); 197} 198 199#define NEXUS_EXCLUDED(name, type) \ 200 (nexus_inlist((name), nexus_excl_name) || \ 201 ((type) != NULL && nexus_inlist((type), nexus_excl_type))) 202 203static int 204nexus_probe(device_t dev) 205{ 206 207 /* Nexus does always match. */ 208 device_set_desc(dev, "Open Firmware Nexus device"); 209 return (0); 210} 211 212static int 213nexus_attach(device_t dev) 214{ 215 struct nexus_devinfo *ndi; 216 struct nexus_softc *sc; 217 device_t cdev; 218 phandle_t node; 219 220 if (strcmp(device_get_name(device_get_parent(dev)), "root") == 0) { 221 node = OF_peer(0); 222 if (node == -1) 223 panic("%s: OF_peer failed.", __func__); 224 225 sc = device_get_softc(dev); 226 sc->sc_intr_rman.rm_type = RMAN_ARRAY; 227 sc->sc_intr_rman.rm_descr = "Interrupts"; 228 sc->sc_mem_rman.rm_type = RMAN_ARRAY; 229 sc->sc_mem_rman.rm_descr = "Device Memory"; 230 if (rman_init(&sc->sc_intr_rman) != 0 || 231 rman_init(&sc->sc_mem_rman) != 0 || 232 rman_manage_region(&sc->sc_intr_rman, 0, 233 IV_MAX - 1) != 0 || 234 rman_manage_region(&sc->sc_mem_rman, 0ULL, ~0ULL) != 0) 235 panic("%s: failed to set up rmans.", __func__); 236 } else 237 node = ofw_bus_get_node(dev); 238 239 /* 240 * Allow devices to identify. 241 */ 242 bus_generic_probe(dev); 243 244 /* 245 * Now walk the OFW tree and attach top-level devices. 246 */ 247 for (node = OF_child(node); node > 0; node = OF_peer(node)) { 248 if ((ndi = nexus_setup_dinfo(dev, node)) == NULL) 249 continue; 250 cdev = device_add_child(dev, NULL, -1); 251 if (cdev == NULL) { 252 device_printf(dev, "<%s>: device_add_child failed\n", 253 ndi->ndi_obdinfo.obd_name); 254 nexus_destroy_dinfo(ndi); 255 continue; 256 } 257 device_set_ivars(cdev, ndi); 258 } 259 return (bus_generic_attach(dev)); 260} 261 262static device_t 263nexus_add_child(device_t dev, u_int order, const char *name, int unit) 264{ 265 device_t cdev; 266 struct nexus_devinfo *ndi; 267 268 cdev = device_add_child_ordered(dev, order, name, unit); 269 if (cdev == NULL) 270 return (NULL); 271 272 ndi = malloc(sizeof(*ndi), M_DEVBUF, M_WAITOK | M_ZERO); 273 ndi->ndi_obdinfo.obd_node = -1; 274 ndi->ndi_obdinfo.obd_name = strdup(name, M_OFWPROP); 275 resource_list_init(&ndi->ndi_rl); 276 device_set_ivars(cdev, ndi); 277 278 return (cdev); 279} 280 281static int 282nexus_print_child(device_t bus, device_t child) 283{ 284 int rv; 285 286 rv = bus_print_child_header(bus, child); 287 rv += nexus_print_res(device_get_ivars(child)); 288 rv += bus_print_child_footer(bus, child); 289 return (rv); 290} 291 292static void 293nexus_probe_nomatch(device_t bus, device_t child) 294{ 295 const char *type; 296 297 device_printf(bus, "<%s>", ofw_bus_get_name(child)); 298 nexus_print_res(device_get_ivars(child)); 299 type = ofw_bus_get_type(child); 300 printf(" type %s (no driver attached)\n", 301 type != NULL ? type : "unknown"); 302} 303 304static int 305nexus_setup_intr(device_t bus __unused, device_t child, struct resource *r, 306 int flags, driver_filter_t *filt, driver_intr_t *intr, void *arg, 307 void **cookiep) 308{ 309 int error; 310 311 if (r == NULL) 312 panic("%s: NULL interrupt resource!", __func__); 313 314 if ((rman_get_flags(r) & RF_SHAREABLE) == 0) 315 flags |= INTR_EXCL; 316 317 /* We depend here on rman_activate_resource() being idempotent. */ 318 error = rman_activate_resource(r); 319 if (error) 320 return (error); 321 322 error = inthand_add(device_get_nameunit(child), rman_get_start(r), 323 filt, intr, arg, flags, cookiep); 324 325 /* 326 * XXX in case of the AFB/FFB interrupt and a Psycho, Sabre or U2S 327 * bridge enable the interrupt in the respective bridge. 328 */ 329 330 return (error); 331} 332 333static int 334nexus_teardown_intr(device_t bus __unused, device_t child __unused, 335 struct resource *r, void *ih) 336{ 337 338 inthand_remove(rman_get_start(r), ih); 339 return (0); 340} 341 342#ifdef SMP 343static int 344nexus_bind_intr(device_t bus __unused, device_t child __unused, 345 struct resource *r, int cpu) 346{ 347 348 return (intr_bind(rman_get_start(r), cpu)); 349} 350#endif 351 352static int 353nexus_describe_intr(device_t bus __unused, device_t child __unused, 354 struct resource *r, void *cookie, const char *descr) 355{ 356 357 return (intr_describe(rman_get_start(r), cookie, descr)); 358} 359 360static struct resource * 361nexus_alloc_resource(device_t bus, device_t child, int type, int *rid, 362 u_long start, u_long end, u_long count, u_int flags) 363{ 364 struct nexus_softc *sc; 365 struct rman *rm; 366 struct resource *rv; 367 struct resource_list_entry *rle; 368 device_t nexus; 369 int isdefault, passthrough; 370 371 isdefault = (start == 0UL && end == ~0UL); 372 passthrough = (device_get_parent(child) != bus); 373 nexus = bus; 374 while (strcmp(device_get_name(device_get_parent(nexus)), "root") != 0) 375 nexus = device_get_parent(nexus); 376 sc = device_get_softc(nexus); 377 rle = NULL; 378 379 if (!passthrough) { 380 rle = resource_list_find(BUS_GET_RESOURCE_LIST(bus, child), 381 type, *rid); 382 if (rle == NULL) 383 return (NULL); 384 if (rle->res != NULL) 385 panic("%s: resource entry is busy", __func__); 386 if (isdefault) { 387 start = rle->start; 388 count = ulmax(count, rle->count); 389 end = ulmax(rle->end, start + count - 1); 390 } 391 } 392 393 switch (type) { 394 case SYS_RES_IRQ: 395 rm = &sc->sc_intr_rman; 396 break; 397 case SYS_RES_MEMORY: 398 rm = &sc->sc_mem_rman; 399 break; 400 default: 401 return (NULL); 402 } 403 404 rv = rman_reserve_resource(rm, start, end, count, flags & ~RF_ACTIVE, 405 child); 406 if (rv == NULL) 407 return (NULL); 408 rman_set_rid(rv, *rid); 409 410 if ((flags & RF_ACTIVE) != 0 && bus_activate_resource(child, type, 411 *rid, rv) != 0) { 412 rman_release_resource(rv); 413 return (NULL); 414 } 415 416 if (!passthrough) { 417 rle->res = rv; 418 rle->start = rman_get_start(rv); 419 rle->end = rman_get_end(rv); 420 rle->count = rle->end - rle->start + 1; 421 } 422 423 return (rv); 424} 425 426static int 427nexus_activate_resource(device_t bus __unused, device_t child __unused, 428 int type, int rid __unused, struct resource *r) 429{ 430 431 if (type == SYS_RES_MEMORY) { 432 rman_set_bustag(r, &nexus_bustag); 433 rman_set_bushandle(r, rman_get_start(r)); 434 } 435 return (rman_activate_resource(r)); 436} 437 438static int 439nexus_deactivate_resource(device_t bus __unused, device_t child __unused, 440 int type __unused, int rid __unused, struct resource *r) 441{ 442 443 return (rman_deactivate_resource(r)); 444} 445 446static int 447nexus_adjust_resource(device_t bus, device_t child __unused, int type, 448 struct resource *r, u_long start, u_long end) 449{ 450 struct nexus_softc *sc; 451 struct rman *rm; 452 device_t nexus; 453 454 nexus = bus; 455 while (strcmp(device_get_name(device_get_parent(nexus)), "root") != 0) 456 nexus = device_get_parent(nexus); 457 sc = device_get_softc(nexus); 458 switch (type) { 459 case SYS_RES_IRQ: 460 rm = &sc->sc_intr_rman; 461 break; 462 case SYS_RES_MEMORY: 463 rm = &sc->sc_mem_rman; 464 break; 465 default: 466 return (EINVAL); 467 } 468 if (rm == NULL) 469 return (ENXIO); 470 if (rman_is_region_manager(r, rm) == 0) 471 return (EINVAL); 472 return (rman_adjust_resource(r, start, end)); 473} 474 475static int 476nexus_release_resource(device_t bus __unused, device_t child, int type, 477 int rid, struct resource *r) 478{ 479 int error; 480 481 if ((rman_get_flags(r) & RF_ACTIVE) != 0) { 482 error = bus_deactivate_resource(child, type, rid, r); 483 if (error) 484 return (error); 485 } 486 return (rman_release_resource(r)); 487} 488 489static struct resource_list * 490nexus_get_resource_list(device_t bus __unused, device_t child) 491{ 492 struct nexus_devinfo *ndi; 493 494 ndi = device_get_ivars(child); 495 return (&ndi->ndi_rl); 496} 497 498static bus_dma_tag_t 499nexus_get_dma_tag(device_t bus __unused, device_t child __unused) 500{ 501 502 return (&nexus_dmatag); 503} 504 505static const struct ofw_bus_devinfo * 506nexus_get_devinfo(device_t bus __unused, device_t child) 507{ 508 struct nexus_devinfo *ndi; 509 510 ndi = device_get_ivars(child); 511 return (&ndi->ndi_obdinfo); 512} 513 514static struct nexus_devinfo * 515nexus_setup_dinfo(device_t dev, phandle_t node) 516{ 517 struct nexus_devinfo *ndi; 518 struct nexus_regs *reg; 519 bus_addr_t phys; 520 bus_size_t size; 521 uint32_t ign; 522 uint32_t *intr; 523 int i; 524 int nintr; 525 int nreg; 526 527 ndi = malloc(sizeof(*ndi), M_DEVBUF, M_WAITOK | M_ZERO); 528 if (ofw_bus_gen_setup_devinfo(&ndi->ndi_obdinfo, node) != 0) { 529 free(ndi, M_DEVBUF); 530 return (NULL); 531 } 532 if (NEXUS_EXCLUDED(ndi->ndi_obdinfo.obd_name, 533 ndi->ndi_obdinfo.obd_type)) { 534 ofw_bus_gen_destroy_devinfo(&ndi->ndi_obdinfo); 535 free(ndi, M_DEVBUF); 536 return (NULL); 537 } 538 resource_list_init(&ndi->ndi_rl); 539 nreg = OF_getprop_alloc(node, "reg", sizeof(*reg), (void **)®); 540 if (nreg == -1) { 541 device_printf(dev, "<%s>: incomplete\n", 542 ndi->ndi_obdinfo.obd_name); 543 goto fail; 544 } 545 for (i = 0; i < nreg; i++) { 546 phys = NEXUS_REG_PHYS(®[i]); 547 size = NEXUS_REG_SIZE(®[i]); 548 /* Skip the dummy reg property of glue devices like ssm(4). */ 549 if (size != 0) 550 resource_list_add(&ndi->ndi_rl, SYS_RES_MEMORY, i, 551 phys, phys + size - 1, size); 552 } 553 free(reg, M_OFWPROP); 554 555 nintr = OF_getprop_alloc(node, "interrupts", sizeof(*intr), 556 (void **)&intr); 557 if (nintr > 0) { 558 if (OF_getprop(node, PCPU_GET(impl) < CPU_IMPL_ULTRASPARCIII ? 559 "upa-portid" : "portid", &ign, sizeof(ign)) <= 0) { 560 device_printf(dev, "<%s>: could not determine portid\n", 561 ndi->ndi_obdinfo.obd_name); 562 free(intr, M_OFWPROP); 563 goto fail; 564 } 565 566 /* XXX 7-bit MID on Starfire */ 567 ign = (ign << INTMAP_IGN_SHIFT) & INTMAP_IGN_MASK; 568 for (i = 0; i < nintr; i++) { 569 intr[i] |= ign; 570 resource_list_add(&ndi->ndi_rl, SYS_RES_IRQ, i, intr[i], 571 intr[i], 1); 572 } 573 free(intr, M_OFWPROP); 574 } 575 576 return (ndi); 577 578 fail: 579 nexus_destroy_dinfo(ndi); 580 return (NULL); 581} 582 583static void 584nexus_destroy_dinfo(struct nexus_devinfo *ndi) 585{ 586 587 resource_list_free(&ndi->ndi_rl); 588 ofw_bus_gen_destroy_devinfo(&ndi->ndi_obdinfo); 589 free(ndi, M_DEVBUF); 590} 591 592static int 593nexus_print_res(struct nexus_devinfo *ndi) 594{ 595 int rv; 596 597 rv = 0; 598 rv += resource_list_print_type(&ndi->ndi_rl, "mem", SYS_RES_MEMORY, 599 "%#lx"); 600 rv += resource_list_print_type(&ndi->ndi_rl, "irq", SYS_RES_IRQ, 601 "%ld"); 602 return (rv); 603} 604