nexus.c revision 200874
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: head/sys/sparc64/sparc64/nexus.c 200874 2009-12-22 21:02:46Z 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 DEVMETHOD(bus_set_resource, bus_generic_rl_set_resource), 126 DEVMETHOD(bus_get_resource, bus_generic_rl_get_resource), 127 DEVMETHOD(bus_get_resource_list, nexus_get_resource_list), 128#ifdef SMP 129 DEVMETHOD(bus_bind_intr, nexus_bind_intr), 130#endif 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 KOBJMETHOD_END 142}; 143 144static devclass_t nexus_devclass; 145 146DEFINE_CLASS_0(nexus, nexus_driver, nexus_methods, sizeof(struct nexus_softc)); 147EARLY_DRIVER_MODULE(nexus, root, nexus_driver, nexus_devclass, 0, 0, 148 BUS_PASS_BUS); 149MODULE_VERSION(nexus, 1); 150 151static const char *const nexus_excl_name[] = { 152 "aliases", 153 "associations", 154 "chosen", 155 "counter-timer", /* No separate device; handled by psycho/sbus */ 156 "memory", 157 "openprom", 158 "options", 159 "packages", 160 "rsc", 161 "virtual-memory", 162 NULL 163}; 164 165static const char *const nexus_excl_type[] = { 166 "cpu", 167 NULL 168}; 169 170extern struct bus_space_tag nexus_bustag; 171extern struct bus_dma_tag nexus_dmatag; 172 173static int 174nexus_inlist(const char *name, const char *const *list) 175{ 176 int i; 177 178 if (name == NULL) 179 return (0); 180 for (i = 0; list[i] != NULL; i++) 181 if (strcmp(name, list[i]) == 0) 182 return (1); 183 return (0); 184} 185 186#define NEXUS_EXCLUDED(name, type) \ 187 (nexus_inlist((name), nexus_excl_name) || \ 188 ((type) != NULL && nexus_inlist((type), nexus_excl_type))) 189 190static int 191nexus_probe(device_t dev) 192{ 193 194 /* Nexus does always match. */ 195 device_set_desc(dev, "Open Firmware Nexus device"); 196 return (0); 197} 198 199static int 200nexus_attach(device_t dev) 201{ 202 struct nexus_devinfo *ndi; 203 struct nexus_softc *sc; 204 device_t cdev; 205 phandle_t node; 206 207 node = OF_peer(0); 208 if (node == -1) 209 panic("%s: OF_peer failed.", __func__); 210 211 sc = device_get_softc(dev); 212 sc->sc_intr_rman.rm_type = RMAN_ARRAY; 213 sc->sc_intr_rman.rm_descr = "Interrupts"; 214 sc->sc_mem_rman.rm_type = RMAN_ARRAY; 215 sc->sc_mem_rman.rm_descr = "Device Memory"; 216 if (rman_init(&sc->sc_intr_rman) != 0 || 217 rman_init(&sc->sc_mem_rman) != 0 || 218 rman_manage_region(&sc->sc_intr_rman, 0, IV_MAX - 1) != 0 || 219 rman_manage_region(&sc->sc_mem_rman, 0ULL, ~0ULL) != 0) 220 panic("%s: failed to set up rmans.", __func__); 221 222 /* 223 * Allow devices to identify. 224 */ 225 bus_generic_probe(dev); 226 227 /* 228 * Now walk the OFW tree and attach top-level devices. 229 */ 230 for (node = OF_child(node); node > 0; node = OF_peer(node)) { 231 if ((ndi = nexus_setup_dinfo(dev, node)) == NULL) 232 continue; 233 cdev = device_add_child(dev, NULL, -1); 234 if (cdev == NULL) { 235 device_printf(dev, "<%s>: device_add_child failed\n", 236 ndi->ndi_obdinfo.obd_name); 237 nexus_destroy_dinfo(ndi); 238 continue; 239 } 240 device_set_ivars(cdev, ndi); 241 } 242 return (bus_generic_attach(dev)); 243} 244 245static device_t 246nexus_add_child(device_t dev, int order, const char *name, int unit) 247{ 248 device_t cdev; 249 struct nexus_devinfo *ndi; 250 251 cdev = device_add_child_ordered(dev, order, name, unit); 252 if (cdev == NULL) 253 return (NULL); 254 255 ndi = malloc(sizeof(*ndi), M_DEVBUF, M_WAITOK | M_ZERO); 256 ndi->ndi_obdinfo.obd_node = -1; 257 ndi->ndi_obdinfo.obd_name = strdup(name, M_OFWPROP); 258 resource_list_init(&ndi->ndi_rl); 259 device_set_ivars(cdev, ndi); 260 261 return (cdev); 262} 263 264static int 265nexus_print_child(device_t dev, device_t child) 266{ 267 int rv; 268 269 rv = bus_print_child_header(dev, child); 270 rv += nexus_print_res(device_get_ivars(child)); 271 rv += bus_print_child_footer(dev, child); 272 return (rv); 273} 274 275static void 276nexus_probe_nomatch(device_t dev, device_t child) 277{ 278 const char *type; 279 280 device_printf(dev, "<%s>", ofw_bus_get_name(child)); 281 nexus_print_res(device_get_ivars(child)); 282 type = ofw_bus_get_type(child); 283 printf(" type %s (no driver attached)\n", 284 type != NULL ? type : "unknown"); 285} 286 287static int 288nexus_setup_intr(device_t dev, device_t child, struct resource *res, int flags, 289 driver_filter_t *filt, driver_intr_t *intr, void *arg, void **cookiep) 290{ 291 int error; 292 293 if (res == NULL) 294 panic("%s: NULL interrupt resource!", __func__); 295 296 if ((rman_get_flags(res) & RF_SHAREABLE) == 0) 297 flags |= INTR_EXCL; 298 299 /* We depend here on rman_activate_resource() being idempotent. */ 300 error = rman_activate_resource(res); 301 if (error) 302 return (error); 303 304 error = inthand_add(device_get_nameunit(child), rman_get_start(res), 305 filt, intr, arg, flags, cookiep); 306 307 /* 308 * XXX in case of the AFB/FFB interrupt and a Psycho, Sabre or U2S 309 * bridge enable the interrupt in the respective bridge. 310 */ 311 312 return (error); 313} 314 315static int 316nexus_teardown_intr(device_t dev, device_t child, struct resource *r, void *ih) 317{ 318 319 inthand_remove(rman_get_start(r), ih); 320 return (0); 321} 322 323#ifdef SMP 324static int 325nexus_bind_intr(device_t dev, device_t child, struct resource *r, int cpu) 326{ 327 328 return (intr_bind(rman_get_start(r), cpu)); 329} 330#endif 331 332static struct resource * 333nexus_alloc_resource(device_t bus, device_t child, int type, int *rid, 334 u_long start, u_long end, u_long count, u_int flags) 335{ 336 struct nexus_softc *sc; 337 struct rman *rm; 338 struct resource *rv; 339 struct resource_list_entry *rle; 340 int isdefault, needactivate, passthrough; 341 342 isdefault = (start == 0UL && end == ~0UL); 343 needactivate = flags & RF_ACTIVE; 344 passthrough = (device_get_parent(child) != bus); 345 sc = device_get_softc(bus); 346 rle = NULL; 347 348 if (!passthrough) { 349 rle = resource_list_find(BUS_GET_RESOURCE_LIST(bus, child), 350 type, *rid); 351 if (rle == NULL) 352 return (NULL); 353 if (rle->res != NULL) 354 panic("%s: resource entry is busy", __func__); 355 if (isdefault) { 356 start = rle->start; 357 count = ulmax(count, rle->count); 358 end = ulmax(rle->end, start + count - 1); 359 } 360 } 361 362 switch (type) { 363 case SYS_RES_IRQ: 364 rm = &sc->sc_intr_rman; 365 break; 366 case SYS_RES_MEMORY: 367 rm = &sc->sc_mem_rman; 368 break; 369 default: 370 return (NULL); 371 } 372 373 flags &= ~RF_ACTIVE; 374 rv = rman_reserve_resource(rm, start, end, count, flags, child); 375 if (rv == NULL) 376 return (NULL); 377 rman_set_rid(rv, *rid); 378 if (type == SYS_RES_MEMORY) { 379 rman_set_bustag(rv, &nexus_bustag); 380 rman_set_bushandle(rv, rman_get_start(rv)); 381 } 382 383 if (needactivate) { 384 if (bus_activate_resource(child, type, *rid, rv) != 0) { 385 rman_release_resource(rv); 386 return (NULL); 387 } 388 } 389 390 if (!passthrough) { 391 rle->res = rv; 392 rle->start = rman_get_start(rv); 393 rle->end = rman_get_end(rv); 394 rle->count = rle->end - rle->start + 1; 395 } 396 397 return (rv); 398} 399 400static int 401nexus_activate_resource(device_t bus, device_t child, int type, int rid, 402 struct resource *r) 403{ 404 405 /* Not much to be done yet... */ 406 return (rman_activate_resource(r)); 407} 408 409static int 410nexus_deactivate_resource(device_t bus, device_t child, int type, int rid, 411 struct resource *r) 412{ 413 414 /* Not much to be done yet... */ 415 return (rman_deactivate_resource(r)); 416} 417 418static int 419nexus_release_resource(device_t bus, device_t child, int type, int rid, 420 struct resource *r) 421{ 422 int error; 423 424 if (rman_get_flags(r) & RF_ACTIVE) { 425 error = bus_deactivate_resource(child, type, rid, r); 426 if (error) 427 return (error); 428 } 429 return (rman_release_resource(r)); 430} 431 432static struct resource_list * 433nexus_get_resource_list(device_t dev, device_t child) 434{ 435 struct nexus_devinfo *ndi; 436 437 ndi = device_get_ivars(child); 438 return (&ndi->ndi_rl); 439} 440 441static bus_dma_tag_t 442nexus_get_dma_tag(device_t bus, device_t child) 443{ 444 445 return (&nexus_dmatag); 446} 447 448static const struct ofw_bus_devinfo * 449nexus_get_devinfo(device_t dev, device_t child) 450{ 451 struct nexus_devinfo *ndi; 452 453 ndi = device_get_ivars(child); 454 return (&ndi->ndi_obdinfo); 455} 456 457static struct nexus_devinfo * 458nexus_setup_dinfo(device_t dev, phandle_t node) 459{ 460 struct nexus_devinfo *ndi; 461 struct nexus_regs *reg; 462 bus_addr_t phys; 463 bus_size_t size; 464 uint32_t ign; 465 uint32_t *intr; 466 int i; 467 int nintr; 468 int nreg; 469 470 ndi = malloc(sizeof(*ndi), M_DEVBUF, M_WAITOK | M_ZERO); 471 if (ofw_bus_gen_setup_devinfo(&ndi->ndi_obdinfo, node) != 0) { 472 free(ndi, M_DEVBUF); 473 return (NULL); 474 } 475 if (NEXUS_EXCLUDED(ndi->ndi_obdinfo.obd_name, 476 ndi->ndi_obdinfo.obd_type)) { 477 ofw_bus_gen_destroy_devinfo(&ndi->ndi_obdinfo); 478 free(ndi, M_DEVBUF); 479 return (NULL); 480 } 481 resource_list_init(&ndi->ndi_rl); 482 nreg = OF_getprop_alloc(node, "reg", sizeof(*reg), (void **)®); 483 if (nreg == -1) { 484 device_printf(dev, "<%s>: incomplete\n", 485 ndi->ndi_obdinfo.obd_name); 486 goto fail; 487 } 488 for (i = 0; i < nreg; i++) { 489 phys = NEXUS_REG_PHYS(®[i]); 490 size = NEXUS_REG_SIZE(®[i]); 491 resource_list_add(&ndi->ndi_rl, SYS_RES_MEMORY, i, phys, 492 phys + size - 1, size); 493 } 494 free(reg, M_OFWPROP); 495 496 nintr = OF_getprop_alloc(node, "interrupts", sizeof(*intr), 497 (void **)&intr); 498 if (nintr > 0) { 499 if (OF_getprop(node, cpu_impl < CPU_IMPL_ULTRASPARCIII ? 500 "upa-portid" : "portid", &ign, sizeof(ign)) <= 0) { 501 device_printf(dev, "<%s>: could not determine portid\n", 502 ndi->ndi_obdinfo.obd_name); 503 free(intr, M_OFWPROP); 504 goto fail; 505 } 506 507 /* XXX 7-bit MID on Starfire */ 508 ign = (ign << INTMAP_IGN_SHIFT) & INTMAP_IGN_MASK; 509 for (i = 0; i < nintr; i++) { 510 intr[i] |= ign; 511 resource_list_add(&ndi->ndi_rl, SYS_RES_IRQ, i, intr[i], 512 intr[i], 1); 513 } 514 free(intr, M_OFWPROP); 515 } 516 517 return (ndi); 518 519 fail: 520 nexus_destroy_dinfo(ndi); 521 return (NULL); 522} 523 524static void 525nexus_destroy_dinfo(struct nexus_devinfo *ndi) 526{ 527 528 resource_list_free(&ndi->ndi_rl); 529 ofw_bus_gen_destroy_devinfo(&ndi->ndi_obdinfo); 530 free(ndi, M_DEVBUF); 531} 532 533static int 534nexus_print_res(struct nexus_devinfo *ndi) 535{ 536 int rv; 537 538 rv = 0; 539 rv += resource_list_print_type(&ndi->ndi_rl, "mem", SYS_RES_MEMORY, 540 "%#lx"); 541 rv += resource_list_print_type(&ndi->ndi_rl, "irq", SYS_RES_IRQ, 542 "%ld"); 543 return (rv); 544} 545