ofwbus.c revision 174599
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 171805 2007-08-11 19:25:32Z marcel $ 56 */ 57#include "opt_psim.h" 58 59#include <sys/param.h> 60#include <sys/systm.h> 61#include <sys/module.h> 62#include <sys/bus.h> 63#include <sys/cons.h> 64#include <sys/kernel.h> 65#include <sys/malloc.h> 66 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/nexusvar.h> 73#include <machine/resource.h> 74 75#include <sys/rman.h> 76 77#include "ofw_bus_if.h" 78#include "pic_if.h" 79 80/* 81 * The nexus (which is a pseudo-bus actually) iterates over the nodes that 82 * exist in Open Firmware and adds them as devices to this bus so that drivers 83 * can be attached to them. 84 * 85 * Maybe this code should get into dev/ofw to some extent, as some of it should 86 * work for all Open Firmware based machines... 87 */ 88 89static MALLOC_DEFINE(M_NEXUS, "nexus", "nexus device information"); 90 91struct nexus_devinfo { 92 phandle_t ndi_node; 93 /* Some common properties. */ 94 const char *ndi_name; 95 const char *ndi_device_type; 96 const char *ndi_compatible; 97}; 98 99struct nexus_softc { 100 struct rman sc_rman; 101}; 102 103/* 104 * Device interface 105 */ 106static int nexus_probe(device_t); 107static void nexus_probe_nomatch(device_t, device_t); 108 109/* 110 * Bus interface 111 */ 112static device_t nexus_add_child(device_t, int, const char *, int); 113static int nexus_read_ivar(device_t, device_t, int, uintptr_t *); 114static int nexus_write_ivar(device_t, device_t, int, uintptr_t); 115static int nexus_setup_intr(device_t, device_t, struct resource *, int, 116 driver_filter_t *, driver_intr_t *, void *, void **); 117static int nexus_teardown_intr(device_t, device_t, struct resource *, 118 void *); 119static struct resource *nexus_alloc_resource(device_t, device_t, int, int *, 120 u_long, u_long, u_long, u_int); 121static int nexus_activate_resource(device_t, device_t, int, int, 122 struct resource *); 123static int nexus_deactivate_resource(device_t, device_t, int, int, 124 struct resource *); 125static int nexus_release_resource(device_t, device_t, int, int, 126 struct resource *); 127 128static phandle_t nexus_ofw_get_node(device_t, device_t); 129static const char *nexus_ofw_get_name(device_t, device_t); 130static const char *nexus_ofw_get_type(device_t, device_t); 131static const char *nexus_ofw_get_compat(device_t, device_t); 132 133/* 134 * Local routines 135 */ 136static device_t nexus_device_from_node(device_t, phandle_t); 137 138static device_method_t nexus_methods[] = { 139 /* Device interface */ 140 DEVMETHOD(device_probe, nexus_probe), 141 DEVMETHOD(device_attach, bus_generic_attach), 142 DEVMETHOD(device_detach, bus_generic_detach), 143 DEVMETHOD(device_shutdown, bus_generic_shutdown), 144 DEVMETHOD(device_suspend, bus_generic_suspend), 145 DEVMETHOD(device_resume, bus_generic_resume), 146 147 /* Bus interface. Resource management is business of the children... */ 148 DEVMETHOD(bus_add_child, nexus_add_child), 149 DEVMETHOD(bus_print_child, bus_generic_print_child), 150 DEVMETHOD(bus_probe_nomatch, nexus_probe_nomatch), 151 DEVMETHOD(bus_read_ivar, nexus_read_ivar), 152 DEVMETHOD(bus_write_ivar, nexus_write_ivar), 153 DEVMETHOD(bus_setup_intr, nexus_setup_intr), 154 DEVMETHOD(bus_teardown_intr, nexus_teardown_intr), 155 DEVMETHOD(bus_alloc_resource, nexus_alloc_resource), 156 DEVMETHOD(bus_activate_resource, nexus_activate_resource), 157 DEVMETHOD(bus_deactivate_resource, nexus_deactivate_resource), 158 DEVMETHOD(bus_release_resource, nexus_release_resource), 159 160 /* OFW bus interface */ 161 DEVMETHOD(ofw_bus_get_node, nexus_ofw_get_node), 162 DEVMETHOD(ofw_bus_get_name, nexus_ofw_get_name), 163 DEVMETHOD(ofw_bus_get_type, nexus_ofw_get_type), 164 DEVMETHOD(ofw_bus_get_compat, nexus_ofw_get_compat), 165 166 { 0, 0 } 167}; 168 169static driver_t nexus_driver = { 170 "nexus", 171 nexus_methods, 172 sizeof(struct nexus_softc), 173}; 174 175static devclass_t nexus_devclass; 176 177DRIVER_MODULE(nexus, root, nexus_driver, nexus_devclass, 0, 0); 178 179static int 180nexus_probe(device_t dev) 181{ 182 phandle_t root; 183 phandle_t child; 184 struct nexus_softc *sc; 185 u_long start, end; 186 187 if ((root = OF_peer(0)) == -1) 188 panic("nexus_probe: OF_peer failed."); 189 190 sc = device_get_softc(dev); 191 192 start = 0; 193 end = INTR_VECTORS - 1; 194 195 sc->sc_rman.rm_start = start; 196 sc->sc_rman.rm_end = end; 197 sc->sc_rman.rm_type = RMAN_ARRAY; 198 sc->sc_rman.rm_descr = "Interrupt request lines"; 199 if (rman_init(&sc->sc_rman) || 200 rman_manage_region(&sc->sc_rman, start, end)) 201 panic("nexus_probe IRQ rman"); 202 203 /* 204 * Allow devices to identify 205 */ 206 bus_generic_probe(dev); 207 208 /* 209 * Now walk the OFW tree to locate top-level devices 210 */ 211 for (child = OF_child(root); child != 0; child = OF_peer(child)) { 212 if (child == -1) 213 panic("nexus_probe(): OF_child failed."); 214 (void)nexus_device_from_node(dev, child); 215 216 } 217 device_set_desc(dev, "Open Firmware Nexus device"); 218 return (0); 219} 220 221static void 222nexus_probe_nomatch(device_t dev, device_t child) 223{ 224 char *name, *type; 225 226 if (BUS_READ_IVAR(dev, child, NEXUS_IVAR_NAME, 227 (uintptr_t *)&name) != 0 || 228 BUS_READ_IVAR(dev, child, NEXUS_IVAR_DEVICE_TYPE, 229 (uintptr_t *)&type) != 0) 230 return; 231 232 if (type == NULL) 233 type = "(unknown)"; 234 235 if (bootverbose) 236 device_printf(dev, "<%s>, type %s (no driver attached)\n", 237 name, type); 238} 239 240static device_t 241nexus_add_child(device_t dev, int order, const char *name, int unit) 242{ 243 device_t child; 244 struct nexus_devinfo *dinfo; 245 246 child = device_add_child_ordered(dev, order, name, unit); 247 if (child == NULL) 248 return (NULL); 249 250 dinfo = malloc(sizeof(struct nexus_devinfo), M_NEXUS, M_NOWAIT|M_ZERO); 251 if (dinfo == NULL) 252 return (NULL); 253 254 dinfo->ndi_node = -1; 255 dinfo->ndi_name = name; 256 device_set_ivars(child, dinfo); 257 258 return (child); 259} 260 261 262static int 263nexus_read_ivar(device_t dev, device_t child, int which, uintptr_t *result) 264{ 265 struct nexus_devinfo *dinfo; 266 267 if ((dinfo = device_get_ivars(child)) == 0) 268 return (ENOENT); 269 switch (which) { 270 case NEXUS_IVAR_NODE: 271 *result = dinfo->ndi_node; 272 break; 273 case NEXUS_IVAR_NAME: 274 *result = (uintptr_t)dinfo->ndi_name; 275 break; 276 case NEXUS_IVAR_DEVICE_TYPE: 277 *result = (uintptr_t)dinfo->ndi_device_type; 278 break; 279 case NEXUS_IVAR_COMPATIBLE: 280 *result = (uintptr_t)dinfo->ndi_compatible; 281 break; 282 default: 283 return (ENOENT); 284 } 285 return 0; 286} 287 288static int 289nexus_write_ivar(device_t dev, device_t child, int which, uintptr_t value) 290{ 291 struct nexus_devinfo *dinfo; 292 293 if ((dinfo = device_get_ivars(child)) == 0) 294 return (ENOENT); 295 296 switch (which) { 297 case NEXUS_IVAR_NAME: 298 return (EINVAL); 299 300 /* Identified devices may want to set these */ 301 case NEXUS_IVAR_NODE: 302 dinfo->ndi_node = (phandle_t)value; 303 break; 304 305 case NEXUS_IVAR_DEVICE_TYPE: 306 dinfo->ndi_device_type = (char *)value; 307 break; 308 309 default: 310 return (ENOENT); 311 } 312 return 0; 313} 314 315static int 316nexus_setup_intr(device_t dev, device_t child, struct resource *res, int flags, 317 driver_filter_t *filter, driver_intr_t *ihand, void *arg, void **cookiep) 318{ 319 driver_t *driver; 320 int error; 321 322 /* somebody tried to setup an irq that failed to allocate! */ 323 if (res == NULL) 324 panic("nexus_setup_intr: NULL irq resource!"); 325 326 *cookiep = 0; 327 if ((rman_get_flags(res) & RF_SHAREABLE) == 0) 328 flags |= INTR_EXCL; 329 330 driver = device_get_driver(child); 331 332 /* 333 * We depend here on rman_activate_resource() being idempotent. 334 */ 335 error = rman_activate_resource(res); 336 if (error) 337 return (error); 338 339 error = powerpc_setup_intr(device_get_nameunit(child), 340 rman_get_start(res), filter, ihand, arg, flags, cookiep); 341 342 return (error); 343} 344 345static int 346nexus_teardown_intr(device_t dev, device_t child, struct resource *res, 347 void *cookie) 348{ 349 350 return (powerpc_teardown_intr(cookie)); 351} 352 353/* 354 * Allocate resources at the behest of a child. This only handles interrupts, 355 * since I/O resources are handled by child busses. 356 */ 357static struct resource * 358nexus_alloc_resource(device_t bus, device_t child, int type, int *rid, 359 u_long start, u_long end, u_long count, u_int flags) 360{ 361 struct nexus_softc *sc; 362 struct resource *rv; 363 364 if (type != SYS_RES_IRQ) { 365 device_printf(bus, "unknown resource request from %s\n", 366 device_get_nameunit(child)); 367 return (NULL); 368 } 369 370 if (count == 0 || start + count - 1 != end) { 371 device_printf(bus, "invalid IRQ allocation from %s\n", 372 device_get_nameunit(child)); 373 return (NULL); 374 } 375 376 sc = device_get_softc(bus); 377 378 rv = rman_reserve_resource(&sc->sc_rman, start, end, count, 379 flags, child); 380 if (rv == NULL) { 381 device_printf(bus, "IRQ allocation failed for %s\n", 382 device_get_nameunit(child)); 383 } else 384 rman_set_rid(rv, *rid); 385 386 return (rv); 387} 388 389static int 390nexus_activate_resource(device_t bus, device_t child, int type, int rid, 391 struct resource *res) 392{ 393 394 /* Not much to be done yet... */ 395 return (rman_activate_resource(res)); 396} 397 398static int 399nexus_deactivate_resource(device_t bus, device_t child, int type, int rid, 400 struct resource *res) 401{ 402 403 /* Not much to be done yet... */ 404 return (rman_deactivate_resource(res)); 405} 406 407static int 408nexus_release_resource(device_t bus, device_t child, int type, int rid, 409 struct resource *res) 410{ 411 412 if (type != SYS_RES_IRQ) { 413 device_printf(bus, "unknown resource request from %s\n", 414 device_get_nameunit(child)); 415 return (EINVAL); 416 } 417 418 return (rman_release_resource(res)); 419} 420 421static device_t 422nexus_device_from_node(device_t parent, phandle_t node) 423{ 424 device_t cdev; 425 struct nexus_devinfo *dinfo; 426 char *name, *type, *compatible; 427 428 OF_getprop_alloc(node, "name", 1, (void **)&name); 429 OF_getprop_alloc(node, "device_type", 1, (void **)&type); 430 OF_getprop_alloc(node, "compatible", 1, (void **)&compatible); 431 cdev = device_add_child(parent, NULL, -1); 432 if (cdev != NULL) { 433 dinfo = malloc(sizeof(*dinfo), M_NEXUS, M_WAITOK); 434 dinfo->ndi_node = node; 435 dinfo->ndi_name = name; 436 dinfo->ndi_device_type = type; 437 dinfo->ndi_compatible = compatible; 438 device_set_ivars(cdev, dinfo); 439 } else 440 free(name, M_OFWPROP); 441 442 return (cdev); 443} 444 445static const char * 446nexus_ofw_get_name(device_t bus, device_t dev) 447{ 448 struct nexus_devinfo *dinfo; 449 450 if ((dinfo = device_get_ivars(dev)) == NULL) 451 return (NULL); 452 453 return (dinfo->ndi_name); 454} 455 456static phandle_t 457nexus_ofw_get_node(device_t bus, device_t dev) 458{ 459 struct nexus_devinfo *dinfo; 460 461 if ((dinfo = device_get_ivars(dev)) == NULL) 462 return (0); 463 464 return (dinfo->ndi_node); 465} 466 467static const char * 468nexus_ofw_get_type(device_t bus, device_t dev) 469{ 470 struct nexus_devinfo *dinfo; 471 472 if ((dinfo = device_get_ivars(dev)) == NULL) 473 return (NULL); 474 475 return (dinfo->ndi_device_type); 476} 477 478static const char * 479nexus_ofw_get_compat(device_t bus, device_t dev) 480{ 481 struct nexus_devinfo *dinfo; 482 483 if ((dinfo = device_get_ivars(dev)) == NULL) 484 return (NULL); 485 486 return (dinfo->ndi_compatible); 487} 488