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