nexus.c revision 185133
1201343Sjilles/*- 2201343Sjilles * Copyright 1998 Massachusetts Institute of Technology 3201343Sjilles * Copyright 2001 by Thomas Moestl <tmm@FreeBSD.org>. 4201343Sjilles * Copyright 2006 by Marius Strobl <marius@FreeBSD.org>. 5201343Sjilles * All rights reserved. 6201343Sjilles * 7201343Sjilles * Permission to use, copy, modify, and distribute this software and 8201343Sjilles * its documentation for any purpose and without fee is hereby 9201343Sjilles * granted, provided that both the above copyright notice and this 10201343Sjilles * permission notice appear in all copies, that both the above 11201343Sjilles * copyright notice and this permission notice appear in all 12201343Sjilles * supporting documentation, and that the name of M.I.T. not be used 13201343Sjilles * in advertising or publicity pertaining to distribution of the 14201343Sjilles * software without specific, written prior permission. M.I.T. makes 15201343Sjilles * no representations about the suitability of this software for any 16201343Sjilles * purpose. It is provided "as is" without express or implied 17201343Sjilles * warranty. 18201343Sjilles * 19201343Sjilles * THIS SOFTWARE IS PROVIDED BY M.I.T. ``AS IS''. M.I.T. DISCLAIMS 20201343Sjilles * ALL EXPRESS OR IMPLIED WARRANTIES WITH REGARD TO THIS SOFTWARE, 21201343Sjilles * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 22201343Sjilles * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT 23201343Sjilles * SHALL M.I.T. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 24201343Sjilles * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 25201343Sjilles * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF 26201343Sjilles * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 27218356Sjilles * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 28218356Sjilles * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 29218356Sjilles * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30218356Sjilles * SUCH DAMAGE. 31218356Sjilles * 32218356Sjilles * from: FreeBSD: src/sys/i386/i386/nexus.c,v 1.43 2001/02/09 33201343Sjilles */ 34201343Sjilles 35#include <sys/cdefs.h> 36__FBSDID("$FreeBSD: head/sys/sparc64/sparc64/nexus.c 185133 2008-11-20 18:44:09Z marius $"); 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 45#include <dev/ofw/ofw_bus.h> 46#include <dev/ofw/ofw_bus_subr.h> 47#include <dev/ofw/openfirm.h> 48 49#include <machine/bus.h> 50#include <machine/bus_common.h> 51#include <machine/intr_machdep.h> 52#include <machine/ofw_nexus.h> 53#include <machine/resource.h> 54#include <machine/ver.h> 55 56#include <sys/rman.h> 57 58/* 59 * The nexus (which is a pseudo-bus actually) iterates over the nodes that 60 * hang from the Open Firmware root node and adds them as devices to this bus 61 * (except some special nodes which are excluded) so that drivers can be 62 * attached to them. 63 * 64 * Additionally, interrupt setup/teardown and some resource management are 65 * done at this level. 66 * 67 * Maybe this code should get into dev/ofw to some extent, as some of it should 68 * work for all Open Firmware based machines... 69 */ 70 71struct nexus_devinfo { 72 struct ofw_bus_devinfo ndi_obdinfo; 73 struct resource_list ndi_rl; 74}; 75 76struct nexus_softc { 77 struct rman sc_intr_rman; 78 struct rman sc_mem_rman; 79}; 80 81static device_probe_t nexus_probe; 82static device_attach_t nexus_attach; 83static bus_print_child_t nexus_print_child; 84static bus_add_child_t nexus_add_child; 85static bus_probe_nomatch_t nexus_probe_nomatch; 86static bus_setup_intr_t nexus_setup_intr; 87static bus_teardown_intr_t nexus_teardown_intr; 88static bus_alloc_resource_t nexus_alloc_resource; 89static bus_activate_resource_t nexus_activate_resource; 90static bus_deactivate_resource_t nexus_deactivate_resource; 91static bus_release_resource_t nexus_release_resource; 92static bus_get_resource_list_t nexus_get_resource_list; 93static bus_get_dma_tag_t nexus_get_dma_tag; 94static ofw_bus_get_devinfo_t nexus_get_devinfo; 95 96#ifdef SMP 97static int nexus_bind_intr(device_t, device_t, struct resource *, int); 98#endif 99static int nexus_inlist(const char *, const char *const *); 100static struct nexus_devinfo * nexus_setup_dinfo(device_t, phandle_t); 101static void nexus_destroy_dinfo(struct nexus_devinfo *); 102static int nexus_print_res(struct nexus_devinfo *); 103 104static device_method_t nexus_methods[] = { 105 /* Device interface */ 106 DEVMETHOD(device_probe, nexus_probe), 107 DEVMETHOD(device_attach, nexus_attach), 108 DEVMETHOD(device_detach, bus_generic_detach), 109 DEVMETHOD(device_shutdown, bus_generic_shutdown), 110 DEVMETHOD(device_suspend, bus_generic_suspend), 111 DEVMETHOD(device_resume, bus_generic_resume), 112 113 /* Bus interface */ 114 DEVMETHOD(bus_print_child, nexus_print_child), 115 DEVMETHOD(bus_probe_nomatch, nexus_probe_nomatch), 116 DEVMETHOD(bus_read_ivar, bus_generic_read_ivar), 117 DEVMETHOD(bus_write_ivar, bus_generic_write_ivar), 118 DEVMETHOD(bus_add_child, nexus_add_child), 119 DEVMETHOD(bus_alloc_resource, nexus_alloc_resource), 120 DEVMETHOD(bus_activate_resource, nexus_activate_resource), 121 DEVMETHOD(bus_deactivate_resource, nexus_deactivate_resource), 122 DEVMETHOD(bus_release_resource, nexus_release_resource), 123 DEVMETHOD(bus_setup_intr, nexus_setup_intr), 124 DEVMETHOD(bus_teardown_intr, nexus_teardown_intr), 125#ifdef SMP 126 DEVMETHOD(bus_bind_intr, nexus_bind_intr), 127#endif 128 DEVMETHOD(bus_set_resource, bus_generic_rl_set_resource), 129 DEVMETHOD(bus_get_resource, bus_generic_rl_get_resource), 130 DEVMETHOD(bus_get_resource_list, nexus_get_resource_list), 131 DEVMETHOD(bus_get_dma_tag, nexus_get_dma_tag), 132 133 /* ofw_bus interface */ 134 DEVMETHOD(ofw_bus_get_devinfo, nexus_get_devinfo), 135 DEVMETHOD(ofw_bus_get_compat, ofw_bus_gen_get_compat), 136 DEVMETHOD(ofw_bus_get_model, ofw_bus_gen_get_model), 137 DEVMETHOD(ofw_bus_get_name, ofw_bus_gen_get_name), 138 DEVMETHOD(ofw_bus_get_node, ofw_bus_gen_get_node), 139 DEVMETHOD(ofw_bus_get_type, ofw_bus_gen_get_type), 140 141 { 0, 0 } 142}; 143 144static devclass_t nexus_devclass; 145 146DEFINE_CLASS_0(nexus, nexus_driver, nexus_methods, sizeof(struct nexus_softc)); 147DRIVER_MODULE(nexus, root, nexus_driver, nexus_devclass, 0, 0); 148 149static const char *const nexus_excl_name[] = { 150 "aliases", 151 "associations", 152 "chosen", 153 "counter-timer", /* No separate device; handled by psycho/sbus */ 154 "memory", 155 "openprom", 156 "options", 157 "packages", 158 "rsc", 159 "virtual-memory", 160 NULL 161}; 162 163static const char *const nexus_excl_type[] = { 164 "cpu", 165 NULL 166}; 167 168extern struct bus_space_tag nexus_bustag; 169extern struct bus_dma_tag nexus_dmatag; 170 171static int 172nexus_inlist(const char *name, const char *const *list) 173{ 174 int i; 175 176 if (name == NULL) 177 return (0); 178 for (i = 0; list[i] != NULL; i++) 179 if (strcmp(name, list[i]) == 0) 180 return (1); 181 return (0); 182} 183 184#define NEXUS_EXCLUDED(name, type) \ 185 (nexus_inlist((name), nexus_excl_name) || \ 186 ((type) != NULL && nexus_inlist((type), nexus_excl_type))) 187 188static int 189nexus_probe(device_t dev) 190{ 191 192 /* Nexus does always match. */ 193 device_set_desc(dev, "Open Firmware Nexus device"); 194 return (0); 195} 196 197static int 198nexus_attach(device_t dev) 199{ 200 struct nexus_devinfo *ndi; 201 struct nexus_softc *sc; 202 device_t cdev; 203 phandle_t node; 204 205 node = OF_peer(0); 206 if (node == -1) 207 panic("%s: OF_peer failed.", __func__); 208 209 sc = device_get_softc(dev); 210 sc->sc_intr_rman.rm_type = RMAN_ARRAY; 211 sc->sc_intr_rman.rm_descr = "Interrupts"; 212 sc->sc_mem_rman.rm_type = RMAN_ARRAY; 213 sc->sc_mem_rman.rm_descr = "Device Memory"; 214 if (rman_init(&sc->sc_intr_rman) != 0 || 215 rman_init(&sc->sc_mem_rman) != 0 || 216 rman_manage_region(&sc->sc_intr_rman, 0, IV_MAX - 1) != 0 || 217 rman_manage_region(&sc->sc_mem_rman, 0ULL, ~0ULL) != 0) 218 panic("%s: failed to set up rmans.", __func__); 219 220 /* 221 * Allow devices to identify. 222 */ 223 bus_generic_probe(dev); 224 225 /* 226 * Now walk the OFW tree and attach top-level devices. 227 */ 228 for (node = OF_child(node); node > 0; node = OF_peer(node)) { 229 if ((ndi = nexus_setup_dinfo(dev, node)) == NULL) 230 continue; 231 cdev = device_add_child(dev, NULL, -1); 232 if (cdev == NULL) { 233 device_printf(dev, "<%s>: device_add_child failed\n", 234 ndi->ndi_obdinfo.obd_name); 235 nexus_destroy_dinfo(ndi); 236 continue; 237 } 238 device_set_ivars(cdev, ndi); 239 } 240 return (bus_generic_attach(dev)); 241} 242 243static device_t 244nexus_add_child(device_t dev, int order, const char *name, int unit) 245{ 246 device_t cdev; 247 struct nexus_devinfo *ndi; 248 249 cdev = device_add_child_ordered(dev, order, name, unit); 250 if (cdev == NULL) 251 return (NULL); 252 253 ndi = malloc(sizeof(*ndi), M_DEVBUF, M_WAITOK | M_ZERO); 254 ndi->ndi_obdinfo.obd_node = -1; 255 ndi->ndi_obdinfo.obd_name = strdup(name, M_OFWPROP); 256 resource_list_init(&ndi->ndi_rl); 257 device_set_ivars(cdev, ndi); 258 259 return (cdev); 260} 261 262static int 263nexus_print_child(device_t dev, device_t child) 264{ 265 int rv; 266 267 rv = bus_print_child_header(dev, child); 268 rv += nexus_print_res(device_get_ivars(child)); 269 rv += bus_print_child_footer(dev, child); 270 return (rv); 271} 272 273static void 274nexus_probe_nomatch(device_t dev, device_t child) 275{ 276 const char *type; 277 278 device_printf(dev, "<%s>", ofw_bus_get_name(child)); 279 nexus_print_res(device_get_ivars(child)); 280 type = ofw_bus_get_type(child); 281 printf(" type %s (no driver attached)\n", 282 type != NULL ? type : "unknown"); 283} 284 285static int 286nexus_setup_intr(device_t dev, device_t child, struct resource *res, int flags, 287 driver_filter_t *filt, driver_intr_t *intr, void *arg, void **cookiep) 288{ 289 int error; 290 291 if (res == NULL) 292 panic("%s: NULL interrupt resource!", __func__); 293 294 if ((rman_get_flags(res) & RF_SHAREABLE) == 0) 295 flags |= INTR_EXCL; 296 297 /* We depend here on rman_activate_resource() being idempotent. */ 298 error = rman_activate_resource(res); 299 if (error) 300 return (error); 301 302 error = inthand_add(device_get_nameunit(child), rman_get_start(res), 303 filt, intr, arg, flags, cookiep); 304 305 /* 306 * XXX in case of the AFB/FFB interrupt and a Psycho, Sabre or U2S 307 * bridge enable the interrupt in the respective bridge. 308 */ 309 310 return (error); 311} 312 313static int 314nexus_teardown_intr(device_t dev, device_t child, struct resource *r, void *ih) 315{ 316 317 inthand_remove(rman_get_start(r), ih); 318 return (0); 319} 320 321#ifdef SMP 322static int 323nexus_bind_intr(device_t dev, device_t child, struct resource *r, int cpu) 324{ 325 326 return (intr_bind(rman_get_start(r), cpu)); 327} 328#endif 329 330static struct resource * 331nexus_alloc_resource(device_t bus, device_t child, int type, int *rid, 332 u_long start, u_long end, u_long count, u_int flags) 333{ 334 struct nexus_softc *sc; 335 struct rman *rm; 336 struct resource *rv; 337 struct resource_list_entry *rle; 338 int isdefault, needactivate, passthrough; 339 340 isdefault = (start == 0UL && end == ~0UL); 341 needactivate = flags & RF_ACTIVE; 342 passthrough = (device_get_parent(child) != bus); 343 sc = device_get_softc(bus); 344 rle = NULL; 345 346 if (!passthrough) { 347 rle = resource_list_find(BUS_GET_RESOURCE_LIST(bus, child), 348 type, *rid); 349 if (rle == NULL) 350 return (NULL); 351 if (rle->res != NULL) 352 panic("%s: resource entry is busy", __func__); 353 if (isdefault) { 354 start = rle->start; 355 count = ulmax(count, rle->count); 356 end = ulmax(rle->end, start + count - 1); 357 } 358 } 359 360 switch (type) { 361 case SYS_RES_IRQ: 362 rm = &sc->sc_intr_rman; 363 break; 364 case SYS_RES_MEMORY: 365 rm = &sc->sc_mem_rman; 366 break; 367 default: 368 return (NULL); 369 } 370 371 flags &= ~RF_ACTIVE; 372 rv = rman_reserve_resource(rm, start, end, count, flags, child); 373 if (rv == NULL) 374 return (NULL); 375 rman_set_rid(rv, *rid); 376 if (type == SYS_RES_MEMORY) { 377 rman_set_bustag(rv, &nexus_bustag); 378 rman_set_bushandle(rv, rman_get_start(rv)); 379 } 380 381 if (needactivate) { 382 if (bus_activate_resource(child, type, *rid, rv) != 0) { 383 rman_release_resource(rv); 384 return (NULL); 385 } 386 } 387 388 if (!passthrough) { 389 rle->res = rv; 390 rle->start = rman_get_start(rv); 391 rle->end = rman_get_end(rv); 392 rle->count = rle->end - rle->start + 1; 393 } 394 395 return (rv); 396} 397 398static int 399nexus_activate_resource(device_t bus, device_t child, int type, int rid, 400 struct resource *r) 401{ 402 403 /* Not much to be done yet... */ 404 return (rman_activate_resource(r)); 405} 406 407static int 408nexus_deactivate_resource(device_t bus, device_t child, int type, int rid, 409 struct resource *r) 410{ 411 412 /* Not much to be done yet... */ 413 return (rman_deactivate_resource(r)); 414} 415 416static int 417nexus_release_resource(device_t bus, device_t child, int type, int rid, 418 struct resource *r) 419{ 420 int error; 421 422 if (rman_get_flags(r) & RF_ACTIVE) { 423 error = bus_deactivate_resource(child, type, rid, r); 424 if (error) 425 return (error); 426 } 427 return (rman_release_resource(r)); 428} 429 430static struct resource_list * 431nexus_get_resource_list(device_t dev, device_t child) 432{ 433 struct nexus_devinfo *ndi; 434 435 ndi = device_get_ivars(child); 436 return (&ndi->ndi_rl); 437} 438 439static bus_dma_tag_t 440nexus_get_dma_tag(device_t bus, device_t child) 441{ 442 443 return (&nexus_dmatag); 444} 445 446static const struct ofw_bus_devinfo * 447nexus_get_devinfo(device_t dev, device_t child) 448{ 449 struct nexus_devinfo *ndi; 450 451 ndi = device_get_ivars(child); 452 return (&ndi->ndi_obdinfo); 453} 454 455static struct nexus_devinfo * 456nexus_setup_dinfo(device_t dev, phandle_t node) 457{ 458 struct nexus_devinfo *ndi; 459 struct nexus_regs *reg; 460 bus_addr_t phys; 461 bus_size_t size; 462 uint32_t ign; 463 uint32_t *intr; 464 int i; 465 int nintr; 466 int nreg; 467 468 ndi = malloc(sizeof(*ndi), M_DEVBUF, M_WAITOK | M_ZERO); 469 if (ofw_bus_gen_setup_devinfo(&ndi->ndi_obdinfo, node) != 0) { 470 free(ndi, M_DEVBUF); 471 return (NULL); 472 } 473 if (NEXUS_EXCLUDED(ndi->ndi_obdinfo.obd_name, 474 ndi->ndi_obdinfo.obd_type)) { 475 ofw_bus_gen_destroy_devinfo(&ndi->ndi_obdinfo); 476 free(ndi, M_DEVBUF); 477 return (NULL); 478 } 479 resource_list_init(&ndi->ndi_rl); 480 nreg = OF_getprop_alloc(node, "reg", sizeof(*reg), (void **)®); 481 if (nreg == -1) { 482 device_printf(dev, "<%s>: incomplete\n", 483 ndi->ndi_obdinfo.obd_name); 484 goto fail; 485 } 486 for (i = 0; i < nreg; i++) { 487 phys = NEXUS_REG_PHYS(®[i]); 488 size = NEXUS_REG_SIZE(®[i]); 489 resource_list_add(&ndi->ndi_rl, SYS_RES_MEMORY, i, phys, 490 phys + size - 1, size); 491 } 492 free(reg, M_OFWPROP); 493 494 nintr = OF_getprop_alloc(node, "interrupts", sizeof(*intr), 495 (void **)&intr); 496 if (nintr > 0) { 497 if (OF_getprop(node, cpu_impl < CPU_IMPL_ULTRASPARCIII ? 498 "upa-portid" : "portid", &ign, sizeof(ign)) <= 0) { 499 device_printf(dev, "<%s>: could not determine portid\n", 500 ndi->ndi_obdinfo.obd_name); 501 free(intr, M_OFWPROP); 502 goto fail; 503 } 504 505 /* XXX 7-bit MID on Starfire */ 506 ign = (ign << INTMAP_IGN_SHIFT) & INTMAP_IGN_MASK; 507 for (i = 0; i < nintr; i++) { 508 intr[i] |= ign; 509 resource_list_add(&ndi->ndi_rl, SYS_RES_IRQ, i, intr[i], 510 intr[i], 1); 511 } 512 free(intr, M_OFWPROP); 513 } 514 515 return (ndi); 516 517 fail: 518 nexus_destroy_dinfo(ndi); 519 return (NULL); 520} 521 522static void 523nexus_destroy_dinfo(struct nexus_devinfo *ndi) 524{ 525 526 resource_list_free(&ndi->ndi_rl); 527 ofw_bus_gen_destroy_devinfo(&ndi->ndi_obdinfo); 528 free(ndi, M_DEVBUF); 529} 530 531static int 532nexus_print_res(struct nexus_devinfo *ndi) 533{ 534 int rv; 535 536 rv = 0; 537 rv += resource_list_print_type(&ndi->ndi_rl, "mem", SYS_RES_MEMORY, 538 "%#lx"); 539 rv += resource_list_print_type(&ndi->ndi_rl, "irq", SYS_RES_IRQ, 540 "%ld"); 541 return (rv); 542} 543