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>
45 #include <dev/ofw/ofw_bus.h>
46 #include <dev/ofw/ofw_bus_subr.h>
47 #include <dev/ofw/openfirm.h>
49 #include <machine/bus.h>
50 #include <machine/intr_machdep.h>
51 #include <machine/nexusvar.h>
52 #include <machine/ofw_nexus.h>
53 #include <machine/resource.h>
55 #include <machine/hypervisorvar.h>
56 #include <machine/hv_api.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;
76 struct rman ndi_intr_rman;
78 devhandle_t ndi_devhandle;
82 struct rman sc_mem_rman;
85 static device_probe_t nexus_probe;
86 static device_attach_t nexus_attach;
87 static bus_print_child_t nexus_print_child;
88 static bus_add_child_t nexus_add_child;
89 static bus_probe_nomatch_t nexus_probe_nomatch;
90 static bus_read_ivar_t nexus_read_ivar;
91 static bus_setup_intr_t nexus_setup_intr;
92 static bus_teardown_intr_t nexus_teardown_intr;
93 static bus_alloc_resource_t nexus_alloc_resource;
94 static bus_get_resource_list_t nexus_get_resource_list;
95 static bus_activate_resource_t nexus_activate_resource;
96 static bus_deactivate_resource_t nexus_deactivate_resource;
97 static bus_release_resource_t nexus_release_resource;
98 static ofw_bus_get_devinfo_t nexus_get_devinfo;
100 static int nexus_inlist(const char *, const char **);
101 static struct nexus_devinfo * nexus_setup_dinfo(device_t, phandle_t);
102 static void nexus_destroy_dinfo(struct nexus_devinfo *);
103 static int nexus_print_res(struct nexus_devinfo *);
105 static device_method_t nexus_methods[] = {
106 /* Device interface */
107 DEVMETHOD(device_probe, nexus_probe),
108 DEVMETHOD(device_attach, nexus_attach),
109 DEVMETHOD(device_detach, bus_generic_detach),
110 DEVMETHOD(device_shutdown, bus_generic_shutdown),
111 DEVMETHOD(device_suspend, bus_generic_suspend),
112 DEVMETHOD(device_resume, bus_generic_resume),
115 DEVMETHOD(bus_print_child, nexus_print_child),
116 DEVMETHOD(bus_probe_nomatch, nexus_probe_nomatch),
117 DEVMETHOD(bus_read_ivar, nexus_read_ivar),
118 DEVMETHOD(bus_write_ivar, bus_generic_write_ivar),
119 DEVMETHOD(bus_add_child, nexus_add_child),
120 DEVMETHOD(bus_alloc_resource, nexus_alloc_resource),
121 DEVMETHOD(bus_activate_resource, nexus_activate_resource),
122 DEVMETHOD(bus_deactivate_resource, nexus_deactivate_resource),
123 DEVMETHOD(bus_release_resource, nexus_release_resource),
124 DEVMETHOD(bus_setup_intr, nexus_setup_intr),
125 DEVMETHOD(bus_teardown_intr, nexus_teardown_intr),
126 DEVMETHOD(bus_get_resource, bus_generic_rl_get_resource),
127 DEVMETHOD(bus_get_resource_list, nexus_get_resource_list),
129 /* ofw_bus interface */
130 DEVMETHOD(ofw_bus_get_devinfo, nexus_get_devinfo),
131 DEVMETHOD(ofw_bus_get_compat, ofw_bus_gen_get_compat),
132 DEVMETHOD(ofw_bus_get_model, ofw_bus_gen_get_model),
133 DEVMETHOD(ofw_bus_get_name, ofw_bus_gen_get_name),
134 DEVMETHOD(ofw_bus_get_node, ofw_bus_gen_get_node),
135 DEVMETHOD(ofw_bus_get_type, ofw_bus_gen_get_type),
140 static devclass_t nexus_devclass;
142 DEFINE_CLASS_0(nexus, nexus_driver, nexus_methods, sizeof(struct nexus_softc));
143 DRIVER_MODULE(nexus, root, nexus_driver, nexus_devclass, 0, 0);
145 static const char *nexus_excl_name[] = {
149 "counter-timer", /* No separate device; handled by psycho/sbus */
159 static const char *nexus_excl_type[] = {
164 extern struct bus_space_tag nexus_bustag;
166 #define SUN4V_REG_SPEC2CFG_HDL(x) ((x >> 32) & ~(0xfull << 28))
169 nexus_inlist(const char *name, const char **list)
175 for (i = 0; list[i] != NULL; i++)
176 if (strcmp(name, list[i]) == 0)
181 #define NEXUS_EXCLUDED(name, type) \
182 (nexus_inlist((name), nexus_excl_name) || \
183 ((type) != NULL && nexus_inlist((type), nexus_excl_type)))
186 nexus_probe(device_t dev)
189 /* Nexus does always match. */
190 device_set_desc(dev, "Open Firmware Nexus device");
195 nexus_attach(device_t dev)
197 struct nexus_devinfo *ndi;
198 struct nexus_softc *sc;
204 panic("%s: OF_peer failed.", __func__);
206 sc = device_get_softc(dev);
207 sc->sc_mem_rman.rm_type = RMAN_ARRAY;
208 sc->sc_mem_rman.rm_descr = "Device Memory";
209 if (rman_init(&sc->sc_mem_rman) != 0 ||
210 rman_manage_region(&sc->sc_mem_rman, 0ULL, ~0ULL) != 0)
211 panic("%s: failed to set up rmans.", __func__);
214 * Allow devices to identify.
216 bus_generic_probe(dev);
219 * Now walk the OFW tree and attach top-level devices.
221 for (node = OF_child(node); node > 0; node = OF_peer(node)) {
222 if ((ndi = nexus_setup_dinfo(dev, node)) == NULL)
224 cdev = device_add_child(dev, NULL, -1);
226 device_printf(dev, "<%s>: device_add_child failed\n",
227 ndi->ndi_obdinfo.obd_name);
228 nexus_destroy_dinfo(ndi);
231 device_set_ivars(cdev, ndi);
233 return (bus_generic_attach(dev));
237 nexus_add_child(device_t dev, int order, const char *name, int unit)
240 struct nexus_devinfo *ndi;
242 cdev = device_add_child_ordered(dev, order, name, unit);
246 ndi = malloc(sizeof(*ndi), M_DEVBUF, M_WAITOK | M_ZERO);
247 ndi->ndi_obdinfo.obd_node = -1;
248 ndi->ndi_obdinfo.obd_name = strdup(name, M_OFWPROP);
249 resource_list_init(&ndi->ndi_rl);
250 ndi->ndi_intr_rman.rm_type = RMAN_ARRAY;
251 ndi->ndi_intr_rman.rm_descr = "Interrupts";
252 if (rman_init(&ndi->ndi_intr_rman) != 0 ||
253 rman_manage_region(&ndi->ndi_intr_rman, 0, IV_MAX - 1) != 0)
254 panic("%s: failed to set up rmans.", __func__);
256 device_set_ivars(cdev, ndi);
262 nexus_print_child(device_t dev, device_t child)
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);
273 nexus_probe_nomatch(device_t dev, device_t child)
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");
285 nexus_read_ivar(device_t dev, device_t child, int which, uintptr_t *result)
287 struct nexus_devinfo *ndi;
289 ndi = device_get_ivars(child);
292 case NEXUS_IVAR_DEVHANDLE:
293 *(uint64_t *)result = ndi->ndi_devhandle;
306 nexus_setup_intr(device_t dev, device_t child, struct resource *res, int flags,
307 driver_filter_t *filt, driver_intr_t *intr, void *arg, void **cookiep)
309 struct nexus_devinfo *ndi;
315 /* we need the devinfo from the immediate child */
317 while (device_get_parent(ichild) != dev)
318 ichild = device_get_parent(ichild);
320 ndi = device_get_ivars(ichild);
323 panic("%s: NULL interrupt resource!", __func__);
325 printf("dev=%s child=%s\n", ofw_bus_get_name(dev), ofw_bus_get_name(child));
327 ino = rman_get_start(res);
329 printf("child=%s reg=0x%lx ino=0x%lx\n", ofw_bus_get_name(child),
330 ndi->ndi_devhandle, ino);
333 if (hv_intr_devino_to_sysino(ndi->ndi_devhandle, (uint32_t)ino,
339 if ((rman_get_flags(res) & RF_SHAREABLE) == 0)
342 /* We depend here on rman_activate_resource() being idempotent. */
343 if ((error = rman_activate_resource(res)))
346 error = inthand_add(device_get_nameunit(child), ihdl,
347 filt, intr, arg, flags, cookiep);
350 if (hv_intr_settarget(ihdl, cpuid) != H_EOK) {
354 if (hv_intr_setstate(ihdl, HV_INTR_IDLE_STATE) != H_EOK) {
358 if (hv_intr_setenabled(ihdl, HV_INTR_ENABLED) != H_EOK) {
370 nexus_teardown_intr(device_t dev, device_t child, struct resource *r, void *ih)
373 inthand_remove(rman_get_start(r), ih);
380 nexus_setup_intr(device_t dev, device_t child, struct resource *res, int flags,
381 driver_intr_t *intr, void *arg, void **cookiep)
386 panic("%s: NULL interrupt resource!", __func__);
388 if ((rman_get_flags(res) & RF_SHAREABLE) == 0)
391 /* We depend here on rman_activate_resource() being idempotent. */
392 error = rman_activate_resource(res);
396 error = inthand_add(device_get_nameunit(child), rman_get_start(res),
397 intr, arg, flags, cookiep);
403 nexus_teardown_intr(device_t dev, device_t child, struct resource *r, void *ih)
406 inthand_remove(rman_get_start(r), ih);
412 static struct resource *
413 nexus_alloc_resource(device_t bus, device_t child, int type, int *rid,
414 u_long start, u_long end, u_long count, u_int flags)
416 struct nexus_softc *sc;
419 struct resource_list_entry *rle;
420 struct nexus_devinfo *ndi;
422 int isdefault, needactivate, passthrough;
424 isdefault = (start == 0UL && end == ~0UL);
425 needactivate = flags & RF_ACTIVE;
426 passthrough = (device_get_parent(child) != bus);
427 sc = device_get_softc(bus);
431 rle = resource_list_find(BUS_GET_RESOURCE_LIST(bus, child),
435 if (rle->res != NULL)
436 panic("%s: resource entry is busy", __func__);
439 count = ulmax(count, rle->count);
440 end = ulmax(rle->end, start + count - 1);
446 /* find the immediate subordinate */
448 while (device_get_parent(subord) != bus)
449 subord = device_get_parent(subord);
450 ndi = device_get_ivars(subord);
451 rm = &ndi->ndi_intr_rman;
454 rm = &sc->sc_mem_rman;
461 rv = rman_reserve_resource(rm, start, end, count, flags, child);
462 if (type == SYS_RES_IRQ && rv == NULL) {
463 printf("%s: start: %ld, end: %ld, flags: %#x\n", __func__,
468 if (type == SYS_RES_MEMORY) {
469 rman_set_bustag(rv, &nexus_bustag);
470 rman_set_bushandle(rv, rman_get_start(rv));
474 if (bus_activate_resource(child, type, *rid, rv) != 0) {
475 rman_release_resource(rv);
487 nexus_activate_resource(device_t bus, device_t child, int type, int rid,
491 /* Not much to be done yet... */
492 return (rman_activate_resource(r));
496 nexus_deactivate_resource(device_t bus, device_t child, int type, int rid,
500 /* Not much to be done yet... */
501 return (rman_deactivate_resource(r));
505 nexus_release_resource(device_t bus, device_t child, int type, int rid,
510 if (rman_get_flags(r) & RF_ACTIVE) {
511 error = bus_deactivate_resource(child, type, rid, r);
515 return (rman_release_resource(r));
518 static struct resource_list *
519 nexus_get_resource_list(device_t dev, device_t child)
521 struct nexus_devinfo *ndi;
523 ndi = device_get_ivars(child);
524 return (&ndi->ndi_rl);
527 static const struct ofw_bus_devinfo *
528 nexus_get_devinfo(device_t dev, device_t child)
530 struct nexus_devinfo *ndi;
532 ndi = device_get_ivars(child);
533 return (&ndi->ndi_obdinfo);
536 static struct nexus_devinfo *
537 nexus_setup_dinfo(device_t dev, phandle_t node)
539 struct nexus_devinfo *ndi;
540 struct nexus_regs *reg;
542 uint32_t naddrcell, nintrcell;
548 ndi = malloc(sizeof(*ndi), M_DEVBUF, M_WAITOK | M_ZERO);
549 if (ofw_bus_gen_setup_devinfo(&ndi->ndi_obdinfo, node) != 0) {
553 if (NEXUS_EXCLUDED(ndi->ndi_obdinfo.obd_name,
554 ndi->ndi_obdinfo.obd_type)) {
555 ofw_bus_gen_destroy_devinfo(&ndi->ndi_obdinfo);
559 resource_list_init(&ndi->ndi_rl);
560 nreg = OF_getprop_alloc(node, "reg", sizeof(*reg), (void **)®);
562 device_printf(dev, "<%s>: incomplete: %d\n",
563 ndi->ndi_obdinfo.obd_name, nreg);
564 nexus_destroy_dinfo(ndi);
567 phys = NEXUS_REG_PHYS(®[0]);
568 ndi->ndi_devhandle = SUN4V_REG_SPEC2CFG_HDL(phys);
569 free(reg, M_OFWPROP);
571 if (OF_getprop(node, "#address-cells", &naddrcell,
572 sizeof naddrcell) != sizeof naddrcell || OF_getprop(node,
573 "#interrupt-cells", &nintrcell, sizeof nintrcell) !=
574 sizeof nintrcell || nintrcell != 1)
575 panic("can't get cell sizes"); /* or invalid intr cell size */
577 nintr = OF_getprop_alloc(node, "interrupt-map", sizeof(*intr),
579 for (i = 0; i < nintr; rid++, i += naddrcell + nintrcell + 2) {
582 * addr,intr,phandle,parent's intr
584 rid = intr[i + naddrcell];
585 /* XXX - technically, we need to pull the parent's
586 * #interrupt-cells, but we'll assume it's 1 like we enforce
587 * nintercell to be above.
589 resource_list_add(&ndi->ndi_rl, SYS_RES_IRQ, rid,
590 intr[i + naddrcell + nintrcell + 1],
591 intr[i + naddrcell + nintrcell + 1], 1);
593 free(intr, M_OFWPROP);
595 ndi->ndi_intr_rman.rm_type = RMAN_ARRAY;
596 ndi->ndi_intr_rman.rm_descr = "Interrupts";
597 if (rman_init(&ndi->ndi_intr_rman) != 0 ||
598 rman_manage_region(&ndi->ndi_intr_rman, 0, IV_MAX - 1) != 0)
599 panic("%s: failed to set up rmans.", __func__);
605 nexus_destroy_dinfo(struct nexus_devinfo *ndi)
608 resource_list_free(&ndi->ndi_rl);
609 ofw_bus_gen_destroy_devinfo(&ndi->ndi_obdinfo);
614 nexus_print_res(struct nexus_devinfo *ndi)
619 rv += resource_list_print_type(&ndi->ndi_rl, "mem", SYS_RES_MEMORY,
621 rv += resource_list_print_type(&ndi->ndi_rl, "irq", SYS_RES_IRQ,