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>.
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
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
32 * from: FreeBSD: src/sys/i386/i386/nexus.c,v 1.43 2001/02/09
35 #include <sys/cdefs.h>
36 __FBSDID("$FreeBSD$");
38 #include <sys/param.h>
39 #include <sys/systm.h>
41 #include <sys/kernel.h>
42 #include <sys/malloc.h>
43 #include <sys/module.h>
46 #include <dev/ofw/ofw_bus.h>
47 #include <dev/ofw/ofw_bus_subr.h>
48 #include <dev/ofw/openfirm.h>
50 #include <machine/bus.h>
51 #include <machine/bus_common.h>
52 #include <machine/intr_machdep.h>
53 #include <machine/nexusvar.h>
54 #include <machine/ofw_nexus.h>
55 #include <machine/resource.h>
56 #include <machine/ver.h>
61 * The nexus (which is a pseudo-bus actually) iterates over the nodes that
62 * hang from the Open Firmware root node and adds them as devices to this bus
63 * (except some special nodes which are excluded) so that drivers can be
66 * Additionally, interrupt setup/teardown and some resource management are
69 * Maybe this code should get into dev/ofw to some extent, as some of it should
70 * work for all Open Firmware based machines...
73 struct nexus_devinfo {
74 struct ofw_bus_devinfo ndi_obdinfo;
75 struct resource_list ndi_rl;
79 struct rman sc_intr_rman;
80 struct rman sc_mem_rman;
83 static device_probe_t nexus_probe;
84 static device_attach_t nexus_attach;
85 static bus_print_child_t nexus_print_child;
86 static bus_add_child_t nexus_add_child;
87 static bus_probe_nomatch_t nexus_probe_nomatch;
88 static bus_setup_intr_t nexus_setup_intr;
89 static bus_teardown_intr_t nexus_teardown_intr;
90 static bus_alloc_resource_t nexus_alloc_resource;
91 static bus_activate_resource_t nexus_activate_resource;
92 static bus_deactivate_resource_t nexus_deactivate_resource;
93 static bus_adjust_resource_t nexus_adjust_resource;
94 static bus_release_resource_t nexus_release_resource;
95 static bus_get_resource_list_t nexus_get_resource_list;
97 static bus_bind_intr_t nexus_bind_intr;
99 static bus_describe_intr_t nexus_describe_intr;
100 static bus_get_dma_tag_t nexus_get_dma_tag;
101 static ofw_bus_get_devinfo_t nexus_get_devinfo;
103 static int nexus_inlist(const char *, const char *const *);
104 static struct nexus_devinfo * nexus_setup_dinfo(device_t, phandle_t);
105 static void nexus_destroy_dinfo(struct nexus_devinfo *);
106 static int nexus_print_res(struct nexus_devinfo *);
108 static device_method_t nexus_methods[] = {
109 /* Device interface */
110 DEVMETHOD(device_probe, nexus_probe),
111 DEVMETHOD(device_attach, nexus_attach),
112 DEVMETHOD(device_detach, bus_generic_detach),
113 DEVMETHOD(device_shutdown, bus_generic_shutdown),
114 DEVMETHOD(device_suspend, bus_generic_suspend),
115 DEVMETHOD(device_resume, bus_generic_resume),
118 DEVMETHOD(bus_print_child, nexus_print_child),
119 DEVMETHOD(bus_probe_nomatch, nexus_probe_nomatch),
120 DEVMETHOD(bus_read_ivar, bus_generic_read_ivar),
121 DEVMETHOD(bus_write_ivar, bus_generic_write_ivar),
122 DEVMETHOD(bus_add_child, nexus_add_child),
123 DEVMETHOD(bus_alloc_resource, nexus_alloc_resource),
124 DEVMETHOD(bus_activate_resource, nexus_activate_resource),
125 DEVMETHOD(bus_deactivate_resource, nexus_deactivate_resource),
126 DEVMETHOD(bus_adjust_resource, nexus_adjust_resource),
127 DEVMETHOD(bus_release_resource, nexus_release_resource),
128 DEVMETHOD(bus_setup_intr, nexus_setup_intr),
129 DEVMETHOD(bus_teardown_intr, nexus_teardown_intr),
130 DEVMETHOD(bus_set_resource, bus_generic_rl_set_resource),
131 DEVMETHOD(bus_get_resource, bus_generic_rl_get_resource),
132 DEVMETHOD(bus_get_resource_list, nexus_get_resource_list),
134 DEVMETHOD(bus_bind_intr, nexus_bind_intr),
136 DEVMETHOD(bus_describe_intr, nexus_describe_intr),
137 DEVMETHOD(bus_get_dma_tag, nexus_get_dma_tag),
139 /* ofw_bus interface */
140 DEVMETHOD(ofw_bus_get_devinfo, nexus_get_devinfo),
141 DEVMETHOD(ofw_bus_get_compat, ofw_bus_gen_get_compat),
142 DEVMETHOD(ofw_bus_get_model, ofw_bus_gen_get_model),
143 DEVMETHOD(ofw_bus_get_name, ofw_bus_gen_get_name),
144 DEVMETHOD(ofw_bus_get_node, ofw_bus_gen_get_node),
145 DEVMETHOD(ofw_bus_get_type, ofw_bus_gen_get_type),
150 static devclass_t nexus_devclass;
152 DEFINE_CLASS_0(nexus, nexus_driver, nexus_methods, sizeof(struct nexus_softc));
153 EARLY_DRIVER_MODULE(nexus, root, nexus_driver, nexus_devclass, 0, 0,
155 MODULE_VERSION(nexus, 1);
157 static const char *const nexus_excl_name[] = {
163 "counter-timer", /* No separate device; handled by psycho/sbus */
177 static const char *const nexus_excl_type[] = {
183 extern struct bus_space_tag nexus_bustag;
184 extern struct bus_dma_tag nexus_dmatag;
187 nexus_inlist(const char *name, const char *const *list)
193 for (i = 0; list[i] != NULL; i++)
194 if (strcmp(name, list[i]) == 0)
199 #define NEXUS_EXCLUDED(name, type) \
200 (nexus_inlist((name), nexus_excl_name) || \
201 ((type) != NULL && nexus_inlist((type), nexus_excl_type)))
204 nexus_probe(device_t dev)
207 /* Nexus does always match. */
208 device_set_desc(dev, "Open Firmware Nexus device");
213 nexus_attach(device_t dev)
215 struct nexus_devinfo *ndi;
216 struct nexus_softc *sc;
220 if (strcmp(device_get_name(device_get_parent(dev)), "root") == 0) {
223 panic("%s: OF_peer failed.", __func__);
225 sc = device_get_softc(dev);
226 sc->sc_intr_rman.rm_type = RMAN_ARRAY;
227 sc->sc_intr_rman.rm_descr = "Interrupts";
228 sc->sc_mem_rman.rm_type = RMAN_ARRAY;
229 sc->sc_mem_rman.rm_descr = "Device Memory";
230 if (rman_init(&sc->sc_intr_rman) != 0 ||
231 rman_init(&sc->sc_mem_rman) != 0 ||
232 rman_manage_region(&sc->sc_intr_rman, 0,
234 rman_manage_region(&sc->sc_mem_rman, 0ULL, ~0ULL) != 0)
235 panic("%s: failed to set up rmans.", __func__);
237 node = ofw_bus_get_node(dev);
240 * Allow devices to identify.
242 bus_generic_probe(dev);
245 * Now walk the OFW tree and attach top-level devices.
247 for (node = OF_child(node); node > 0; node = OF_peer(node)) {
248 if ((ndi = nexus_setup_dinfo(dev, node)) == NULL)
250 cdev = device_add_child(dev, NULL, -1);
252 device_printf(dev, "<%s>: device_add_child failed\n",
253 ndi->ndi_obdinfo.obd_name);
254 nexus_destroy_dinfo(ndi);
257 device_set_ivars(cdev, ndi);
259 return (bus_generic_attach(dev));
263 nexus_add_child(device_t dev, u_int order, const char *name, int unit)
266 struct nexus_devinfo *ndi;
268 cdev = device_add_child_ordered(dev, order, name, unit);
272 ndi = malloc(sizeof(*ndi), M_DEVBUF, M_WAITOK | M_ZERO);
273 ndi->ndi_obdinfo.obd_node = -1;
274 ndi->ndi_obdinfo.obd_name = strdup(name, M_OFWPROP);
275 resource_list_init(&ndi->ndi_rl);
276 device_set_ivars(cdev, ndi);
282 nexus_print_child(device_t bus, device_t child)
286 rv = bus_print_child_header(bus, child);
287 rv += nexus_print_res(device_get_ivars(child));
288 rv += bus_print_child_footer(bus, child);
293 nexus_probe_nomatch(device_t bus, device_t child)
297 device_printf(bus, "<%s>", ofw_bus_get_name(child));
298 nexus_print_res(device_get_ivars(child));
299 type = ofw_bus_get_type(child);
300 printf(" type %s (no driver attached)\n",
301 type != NULL ? type : "unknown");
305 nexus_setup_intr(device_t bus __unused, device_t child, struct resource *r,
306 int flags, driver_filter_t *filt, driver_intr_t *intr, void *arg,
312 panic("%s: NULL interrupt resource!", __func__);
314 if ((rman_get_flags(r) & RF_SHAREABLE) == 0)
317 /* We depend here on rman_activate_resource() being idempotent. */
318 error = rman_activate_resource(r);
322 error = inthand_add(device_get_nameunit(child), rman_get_start(r),
323 filt, intr, arg, flags, cookiep);
326 * XXX in case of the AFB/FFB interrupt and a Psycho, Sabre or U2S
327 * bridge enable the interrupt in the respective bridge.
334 nexus_teardown_intr(device_t bus __unused, device_t child __unused,
335 struct resource *r, void *ih)
338 inthand_remove(rman_get_start(r), ih);
344 nexus_bind_intr(device_t bus __unused, device_t child __unused,
345 struct resource *r, int cpu)
348 return (intr_bind(rman_get_start(r), cpu));
353 nexus_describe_intr(device_t bus __unused, device_t child __unused,
354 struct resource *r, void *cookie, const char *descr)
357 return (intr_describe(rman_get_start(r), cookie, descr));
360 static struct resource *
361 nexus_alloc_resource(device_t bus, device_t child, int type, int *rid,
362 u_long start, u_long end, u_long count, u_int flags)
364 struct nexus_softc *sc;
367 struct resource_list_entry *rle;
369 int isdefault, passthrough;
371 isdefault = (start == 0UL && end == ~0UL);
372 passthrough = (device_get_parent(child) != bus);
374 while (strcmp(device_get_name(device_get_parent(nexus)), "root") != 0)
375 nexus = device_get_parent(nexus);
376 sc = device_get_softc(nexus);
380 rle = resource_list_find(BUS_GET_RESOURCE_LIST(bus, child),
384 if (rle->res != NULL)
385 panic("%s: resource entry is busy", __func__);
388 count = ulmax(count, rle->count);
389 end = ulmax(rle->end, start + count - 1);
395 rm = &sc->sc_intr_rman;
398 rm = &sc->sc_mem_rman;
404 rv = rman_reserve_resource(rm, start, end, count, flags & ~RF_ACTIVE,
408 rman_set_rid(rv, *rid);
410 if ((flags & RF_ACTIVE) != 0 && bus_activate_resource(child, type,
412 rman_release_resource(rv);
418 rle->start = rman_get_start(rv);
419 rle->end = rman_get_end(rv);
420 rle->count = rle->end - rle->start + 1;
427 nexus_activate_resource(device_t bus __unused, device_t child __unused,
428 int type, int rid __unused, struct resource *r)
431 if (type == SYS_RES_MEMORY) {
432 rman_set_bustag(r, &nexus_bustag);
433 rman_set_bushandle(r, rman_get_start(r));
435 return (rman_activate_resource(r));
439 nexus_deactivate_resource(device_t bus __unused, device_t child __unused,
440 int type __unused, int rid __unused, struct resource *r)
443 return (rman_deactivate_resource(r));
447 nexus_adjust_resource(device_t bus, device_t child __unused, int type,
448 struct resource *r, u_long start, u_long end)
450 struct nexus_softc *sc;
455 while (strcmp(device_get_name(device_get_parent(nexus)), "root") != 0)
456 nexus = device_get_parent(nexus);
457 sc = device_get_softc(nexus);
460 rm = &sc->sc_intr_rman;
463 rm = &sc->sc_mem_rman;
470 if (rman_is_region_manager(r, rm) == 0)
472 return (rman_adjust_resource(r, start, end));
476 nexus_release_resource(device_t bus __unused, device_t child, int type,
477 int rid, struct resource *r)
481 if ((rman_get_flags(r) & RF_ACTIVE) != 0) {
482 error = bus_deactivate_resource(child, type, rid, r);
486 return (rman_release_resource(r));
489 static struct resource_list *
490 nexus_get_resource_list(device_t bus __unused, device_t child)
492 struct nexus_devinfo *ndi;
494 ndi = device_get_ivars(child);
495 return (&ndi->ndi_rl);
499 nexus_get_dma_tag(device_t bus __unused, device_t child __unused)
502 return (&nexus_dmatag);
505 static const struct ofw_bus_devinfo *
506 nexus_get_devinfo(device_t bus __unused, device_t child)
508 struct nexus_devinfo *ndi;
510 ndi = device_get_ivars(child);
511 return (&ndi->ndi_obdinfo);
514 static struct nexus_devinfo *
515 nexus_setup_dinfo(device_t dev, phandle_t node)
517 struct nexus_devinfo *ndi;
518 struct nexus_regs *reg;
527 ndi = malloc(sizeof(*ndi), M_DEVBUF, M_WAITOK | M_ZERO);
528 if (ofw_bus_gen_setup_devinfo(&ndi->ndi_obdinfo, node) != 0) {
532 if (NEXUS_EXCLUDED(ndi->ndi_obdinfo.obd_name,
533 ndi->ndi_obdinfo.obd_type)) {
534 ofw_bus_gen_destroy_devinfo(&ndi->ndi_obdinfo);
538 resource_list_init(&ndi->ndi_rl);
539 nreg = OF_getprop_alloc(node, "reg", sizeof(*reg), (void **)®);
541 device_printf(dev, "<%s>: incomplete\n",
542 ndi->ndi_obdinfo.obd_name);
545 for (i = 0; i < nreg; i++) {
546 phys = NEXUS_REG_PHYS(®[i]);
547 size = NEXUS_REG_SIZE(®[i]);
548 /* Skip the dummy reg property of glue devices like ssm(4). */
550 resource_list_add(&ndi->ndi_rl, SYS_RES_MEMORY, i,
551 phys, phys + size - 1, size);
553 free(reg, M_OFWPROP);
555 nintr = OF_getprop_alloc(node, "interrupts", sizeof(*intr),
558 if (OF_getprop(node, PCPU_GET(impl) < CPU_IMPL_ULTRASPARCIII ?
559 "upa-portid" : "portid", &ign, sizeof(ign)) <= 0) {
560 device_printf(dev, "<%s>: could not determine portid\n",
561 ndi->ndi_obdinfo.obd_name);
562 free(intr, M_OFWPROP);
566 /* XXX 7-bit MID on Starfire */
567 ign = (ign << INTMAP_IGN_SHIFT) & INTMAP_IGN_MASK;
568 for (i = 0; i < nintr; i++) {
570 resource_list_add(&ndi->ndi_rl, SYS_RES_IRQ, i, intr[i],
573 free(intr, M_OFWPROP);
579 nexus_destroy_dinfo(ndi);
584 nexus_destroy_dinfo(struct nexus_devinfo *ndi)
587 resource_list_free(&ndi->ndi_rl);
588 ofw_bus_gen_destroy_devinfo(&ndi->ndi_obdinfo);
593 nexus_print_res(struct nexus_devinfo *ndi)
598 rv += resource_list_print_type(&ndi->ndi_rl, "mem", SYS_RES_MEMORY,
600 rv += resource_list_print_type(&ndi->ndi_rl, "irq", SYS_RES_IRQ,