ofwbus.c revision 212239
1/*- 2 * Copyright 1998 Massachusetts Institute of Technology 3 * 4 * Permission to use, copy, modify, and distribute this software and 5 * its documentation for any purpose and without fee is hereby 6 * granted, provided that both the above copyright notice and this 7 * permission notice appear in all copies, that both the above 8 * copyright notice and this permission notice appear in all 9 * supporting documentation, and that the name of M.I.T. not be used 10 * in advertising or publicity pertaining to distribution of the 11 * software without specific, written prior permission. M.I.T. makes 12 * no representations about the suitability of this software for any 13 * purpose. It is provided "as is" without express or implied 14 * warranty. 15 * 16 * THIS SOFTWARE IS PROVIDED BY M.I.T. ``AS IS''. M.I.T. DISCLAIMS 17 * ALL EXPRESS OR IMPLIED WARRANTIES WITH REGARD TO THIS SOFTWARE, 18 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 19 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT 20 * SHALL M.I.T. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF 23 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 24 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 25 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 26 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27 * SUCH DAMAGE. 28 */ 29/*- 30 * Copyright 2001 by Thomas Moestl <tmm@FreeBSD.org>. All rights reserved. 31 * 32 * Redistribution and use in source and binary forms, with or without 33 * modification, are permitted provided that the following conditions 34 * are met: 35 * 1. Redistributions of source code must retain the above copyright 36 * notice, this list of conditions and the following disclaimer. 37 * 2. Redistributions in binary form must reproduce the above copyright 38 * notice, this list of conditions and the following disclaimer in the 39 * documentation and/or other materials provided with the distribution. 40 * 41 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 42 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 43 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 44 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 45 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 46 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 47 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 49 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 50 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 51 * SUCH DAMAGE. 52 * 53 * from: FreeBSD: src/sys/i386/i386/nexus.c,v 1.43 2001/02/09 54 * 55 * $FreeBSD: head/sys/powerpc/aim/nexus.c 212239 2010-09-05 19:57:24Z mav $ 56 */ 57 58#include <sys/param.h> 59#include <sys/systm.h> 60#include <sys/module.h> 61#include <sys/bus.h> 62#include <sys/cons.h> 63#include <sys/kernel.h> 64#include <sys/malloc.h> 65 66#include <dev/ofw/ofw_bus_subr.h> 67#include <dev/ofw/openfirm.h> 68 69#include <machine/bus.h> 70#include <machine/frame.h> 71#include <machine/intr_machdep.h> 72#include <machine/resource.h> 73 74#include <sys/rman.h> 75 76#include "ofw_bus_if.h" 77#include "pic_if.h" 78 79/* 80 * The nexus (which is a pseudo-bus actually) iterates over the nodes that 81 * exist in Open Firmware and adds them as devices to this bus so that drivers 82 * can be attached to them. 83 * 84 * Maybe this code should get into dev/ofw to some extent, as some of it should 85 * work for all Open Firmware based machines... 86 */ 87 88static MALLOC_DEFINE(M_NEXUS, "nexus", "nexus device information"); 89 90enum nexus_ivars { 91 NEXUS_IVAR_NODE, 92 NEXUS_IVAR_NAME, 93 NEXUS_IVAR_DEVICE_TYPE, 94 NEXUS_IVAR_COMPATIBLE, 95}; 96 97struct nexus_devinfo { 98 phandle_t ndi_node; 99 /* Some common properties. */ 100 const char *ndi_name; 101 const char *ndi_device_type; 102 const char *ndi_compatible; 103}; 104 105struct nexus_softc { 106 struct rman sc_rman; 107}; 108 109/* 110 * Device interface 111 */ 112static int nexus_probe(device_t); 113static int nexus_attach(device_t); 114 115/* 116 * Bus interface 117 */ 118static device_t nexus_add_child(device_t, int, const char *, int); 119static void nexus_probe_nomatch(device_t, device_t); 120static int nexus_read_ivar(device_t, device_t, int, uintptr_t *); 121static int nexus_write_ivar(device_t, device_t, int, uintptr_t); 122#ifdef SMP 123static int nexus_bind_intr(device_t dev, device_t child, 124 struct resource *irq, int cpu); 125#endif 126static int nexus_config_intr(device_t dev, int irq, enum intr_trigger trig, 127 enum intr_polarity pol); 128static int nexus_setup_intr(device_t, device_t, struct resource *, int, 129 driver_filter_t *, driver_intr_t *, void *, void **); 130static int nexus_teardown_intr(device_t, device_t, struct resource *, 131 void *); 132static struct resource *nexus_alloc_resource(device_t, device_t, int, int *, 133 u_long, u_long, u_long, u_int); 134static int nexus_activate_resource(device_t, device_t, int, int, 135 struct resource *); 136static int nexus_deactivate_resource(device_t, device_t, int, int, 137 struct resource *); 138static int nexus_release_resource(device_t, device_t, int, int, 139 struct resource *); 140 141/* 142 * OFW bus interface. 143 */ 144static phandle_t nexus_ofw_get_node(device_t, device_t); 145static const char *nexus_ofw_get_name(device_t, device_t); 146static const char *nexus_ofw_get_type(device_t, device_t); 147static const char *nexus_ofw_get_compat(device_t, device_t); 148 149/* 150 * Local routines 151 */ 152static device_t nexus_device_from_node(device_t, phandle_t); 153 154static device_method_t nexus_methods[] = { 155 /* Device interface */ 156 DEVMETHOD(device_probe, nexus_probe), 157 DEVMETHOD(device_attach, nexus_attach), 158 DEVMETHOD(device_detach, bus_generic_detach), 159 DEVMETHOD(device_shutdown, bus_generic_shutdown), 160 DEVMETHOD(device_suspend, bus_generic_suspend), 161 DEVMETHOD(device_resume, bus_generic_resume), 162 163 /* Bus interface. Resource management is business of the children... */ 164 DEVMETHOD(bus_add_child, nexus_add_child), 165 DEVMETHOD(bus_print_child, bus_generic_print_child), 166 DEVMETHOD(bus_child_pnpinfo_str, ofw_bus_gen_child_pnpinfo_str), 167 DEVMETHOD(bus_probe_nomatch, nexus_probe_nomatch), 168 DEVMETHOD(bus_read_ivar, nexus_read_ivar), 169 DEVMETHOD(bus_write_ivar, nexus_write_ivar), 170 DEVMETHOD(bus_setup_intr, nexus_setup_intr), 171 DEVMETHOD(bus_teardown_intr, nexus_teardown_intr), 172#ifdef SMP 173 DEVMETHOD(bus_bind_intr, nexus_bind_intr), 174#endif 175 DEVMETHOD(bus_config_intr, nexus_config_intr), 176 DEVMETHOD(bus_alloc_resource, nexus_alloc_resource), 177 DEVMETHOD(bus_activate_resource, nexus_activate_resource), 178 DEVMETHOD(bus_deactivate_resource, nexus_deactivate_resource), 179 DEVMETHOD(bus_release_resource, nexus_release_resource), 180 181 /* OFW bus interface */ 182 DEVMETHOD(ofw_bus_get_node, nexus_ofw_get_node), 183 DEVMETHOD(ofw_bus_get_name, nexus_ofw_get_name), 184 DEVMETHOD(ofw_bus_get_type, nexus_ofw_get_type), 185 DEVMETHOD(ofw_bus_get_compat, nexus_ofw_get_compat), 186 187 { 0, 0 } 188}; 189 190static driver_t nexus_driver = { 191 "nexus", 192 nexus_methods, 193 sizeof(struct nexus_softc), 194}; 195 196static devclass_t nexus_devclass; 197 198DRIVER_MODULE(nexus, root, nexus_driver, nexus_devclass, 0, 0); 199 200static int 201nexus_probe(device_t dev) 202{ 203 bus_generic_probe(dev); 204 device_set_desc(dev, "Open Firmware Nexus device"); 205 return (0); 206} 207 208static int 209nexus_attach(device_t dev) 210{ 211 phandle_t root; 212 phandle_t child; 213 struct nexus_softc *sc; 214 u_long start, end; 215 216 if ((root = OF_peer(0)) == -1) 217 panic("nexus_probe: OF_peer failed."); 218 219 sc = device_get_softc(dev); 220 221 start = 0; 222 end = MAX_PICS*INTR_VECTORS - 1; 223 224 sc->sc_rman.rm_start = start; 225 sc->sc_rman.rm_end = end; 226 sc->sc_rman.rm_type = RMAN_ARRAY; 227 sc->sc_rman.rm_descr = "Interrupt request lines"; 228 if (rman_init(&sc->sc_rman) || 229 rman_manage_region(&sc->sc_rman, start, end)) 230 panic("nexus_probe IRQ rman"); 231 232 /* 233 * Now walk the OFW tree to locate top-level devices 234 */ 235 for (child = OF_child(root); child != 0; child = OF_peer(child)) { 236 if (child == -1) 237 panic("nexus_probe(): OF_child failed."); 238 (void)nexus_device_from_node(dev, child); 239 240 } 241 242 return (bus_generic_attach(dev)); 243} 244 245static void 246nexus_probe_nomatch(device_t dev, device_t child) 247{ 248 char *name, *type; 249 250 if (BUS_READ_IVAR(dev, child, NEXUS_IVAR_NAME, 251 (uintptr_t *)&name) != 0 || 252 BUS_READ_IVAR(dev, child, NEXUS_IVAR_DEVICE_TYPE, 253 (uintptr_t *)&type) != 0) 254 return; 255 256 if (type == NULL) 257 type = "(unknown)"; 258 259 if (bootverbose) 260 device_printf(dev, "<%s>, type %s (no driver attached)\n", 261 name, type); 262} 263 264static device_t 265nexus_add_child(device_t dev, int order, const char *name, int unit) 266{ 267 device_t child; 268 struct nexus_devinfo *dinfo; 269 270 child = device_add_child_ordered(dev, order, name, unit); 271 if (child == NULL) 272 return (NULL); 273 274 dinfo = malloc(sizeof(struct nexus_devinfo), M_NEXUS, M_NOWAIT|M_ZERO); 275 if (dinfo == NULL) 276 return (NULL); 277 278 dinfo->ndi_node = -1; 279 dinfo->ndi_name = name; 280 device_set_ivars(child, dinfo); 281 282 return (child); 283} 284 285 286static int 287nexus_read_ivar(device_t dev, device_t child, int which, uintptr_t *result) 288{ 289 struct nexus_devinfo *dinfo; 290 291 if ((dinfo = device_get_ivars(child)) == 0) 292 return (ENOENT); 293 switch (which) { 294 case NEXUS_IVAR_NODE: 295 *result = dinfo->ndi_node; 296 break; 297 case NEXUS_IVAR_NAME: 298 *result = (uintptr_t)dinfo->ndi_name; 299 break; 300 case NEXUS_IVAR_DEVICE_TYPE: 301 *result = (uintptr_t)dinfo->ndi_device_type; 302 break; 303 case NEXUS_IVAR_COMPATIBLE: 304 *result = (uintptr_t)dinfo->ndi_compatible; 305 break; 306 default: 307 return (ENOENT); 308 } 309 return 0; 310} 311 312static int 313nexus_write_ivar(device_t dev, device_t child, int which, uintptr_t value) 314{ 315 struct nexus_devinfo *dinfo; 316 317 if ((dinfo = device_get_ivars(child)) == 0) 318 return (ENOENT); 319 320 switch (which) { 321 case NEXUS_IVAR_NAME: 322 return (EINVAL); 323 324 /* Identified devices may want to set these */ 325 case NEXUS_IVAR_NODE: 326 dinfo->ndi_node = (phandle_t)value; 327 break; 328 329 case NEXUS_IVAR_DEVICE_TYPE: 330 dinfo->ndi_device_type = (char *)value; 331 break; 332 333 default: 334 return (ENOENT); 335 } 336 return 0; 337} 338 339static int 340nexus_setup_intr(device_t dev, device_t child, struct resource *res, int flags, 341 driver_filter_t *filter, driver_intr_t *ihand, void *arg, void **cookiep) 342{ 343 driver_t *driver; 344 int error; 345 346 /* somebody tried to setup an irq that failed to allocate! */ 347 if (res == NULL) 348 panic("nexus_setup_intr: NULL irq resource!"); 349 350 *cookiep = 0; 351 if ((rman_get_flags(res) & RF_SHAREABLE) == 0) 352 flags |= INTR_EXCL; 353 354 driver = device_get_driver(child); 355 356 /* 357 * We depend here on rman_activate_resource() being idempotent. 358 */ 359 error = rman_activate_resource(res); 360 if (error) 361 return (error); 362 363 error = powerpc_setup_intr(device_get_nameunit(child), 364 rman_get_start(res), filter, ihand, arg, flags, cookiep); 365 366 return (error); 367} 368 369static int 370nexus_teardown_intr(device_t dev, device_t child, struct resource *res, 371 void *cookie) 372{ 373 374 return (powerpc_teardown_intr(cookie)); 375} 376 377#ifdef SMP 378static int 379nexus_bind_intr(device_t dev, device_t child, struct resource *irq, int cpu) 380{ 381 382 return (powerpc_bind_intr(rman_get_start(irq), cpu)); 383} 384#endif 385 386static int 387nexus_config_intr(device_t dev, int irq, enum intr_trigger trig, 388 enum intr_polarity pol) 389{ 390 391 return (powerpc_config_intr(irq, trig, pol)); 392} 393 394/* 395 * Allocate resources at the behest of a child. This only handles interrupts, 396 * since I/O resources are handled by child busses. 397 */ 398static struct resource * 399nexus_alloc_resource(device_t bus, device_t child, int type, int *rid, 400 u_long start, u_long end, u_long count, u_int flags) 401{ 402 struct nexus_softc *sc; 403 struct resource *rv; 404 405 if (type != SYS_RES_IRQ) { 406 device_printf(bus, "unknown resource request from %s\n", 407 device_get_nameunit(child)); 408 return (NULL); 409 } 410 411 if (count == 0 || start + count - 1 != end) { 412 device_printf(bus, "invalid IRQ allocation from %s\n", 413 device_get_nameunit(child)); 414 return (NULL); 415 } 416 417 sc = device_get_softc(bus); 418 419 rv = rman_reserve_resource(&sc->sc_rman, start, end, count, 420 flags, child); 421 if (rv == NULL) { 422 device_printf(bus, "IRQ allocation failed for %s\n", 423 device_get_nameunit(child)); 424 } else 425 rman_set_rid(rv, *rid); 426 427 return (rv); 428} 429 430static int 431nexus_activate_resource(device_t bus, device_t child, int type, int rid, 432 struct resource *res) 433{ 434 435 /* Not much to be done yet... */ 436 return (rman_activate_resource(res)); 437} 438 439static int 440nexus_deactivate_resource(device_t bus, device_t child, int type, int rid, 441 struct resource *res) 442{ 443 444 /* Not much to be done yet... */ 445 return (rman_deactivate_resource(res)); 446} 447 448static int 449nexus_release_resource(device_t bus, device_t child, int type, int rid, 450 struct resource *res) 451{ 452 453 if (type != SYS_RES_IRQ) { 454 device_printf(bus, "unknown resource request from %s\n", 455 device_get_nameunit(child)); 456 return (EINVAL); 457 } 458 459 return (rman_release_resource(res)); 460} 461 462static device_t 463nexus_device_from_node(device_t parent, phandle_t node) 464{ 465 device_t cdev; 466 struct nexus_devinfo *dinfo; 467 char *name, *type, *compatible; 468 469 OF_getprop_alloc(node, "name", 1, (void **)&name); 470 OF_getprop_alloc(node, "device_type", 1, (void **)&type); 471 OF_getprop_alloc(node, "compatible", 1, (void **)&compatible); 472 cdev = device_add_child(parent, NULL, -1); 473 if (cdev != NULL) { 474 dinfo = malloc(sizeof(*dinfo), M_NEXUS, M_WAITOK); 475 dinfo->ndi_node = node; 476 dinfo->ndi_name = name; 477 dinfo->ndi_device_type = type; 478 dinfo->ndi_compatible = compatible; 479 device_set_ivars(cdev, dinfo); 480 } else 481 free(name, M_OFWPROP); 482 483 return (cdev); 484} 485 486static const char * 487nexus_ofw_get_name(device_t bus, device_t dev) 488{ 489 struct nexus_devinfo *dinfo; 490 491 if ((dinfo = device_get_ivars(dev)) == NULL) 492 return (NULL); 493 494 return (dinfo->ndi_name); 495} 496 497static phandle_t 498nexus_ofw_get_node(device_t bus, device_t dev) 499{ 500 struct nexus_devinfo *dinfo; 501 502 if ((dinfo = device_get_ivars(dev)) == NULL) 503 return (0); 504 505 return (dinfo->ndi_node); 506} 507 508static const char * 509nexus_ofw_get_type(device_t bus, device_t dev) 510{ 511 struct nexus_devinfo *dinfo; 512 513 if ((dinfo = device_get_ivars(dev)) == NULL) 514 return (NULL); 515 516 return (dinfo->ndi_device_type); 517} 518 519static const char * 520nexus_ofw_get_compat(device_t bus, device_t dev) 521{ 522 struct nexus_devinfo *dinfo; 523 524 if ((dinfo = device_get_ivars(dev)) == NULL) 525 return (NULL); 526 527 return (dinfo->ndi_compatible); 528} 529 530