2 * Copyright 1998 Massachusetts Institute of Technology
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
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
32 * This code implements a `root nexus' for MIPS Architecture
33 * machines. The function of the root nexus is to serve as an
34 * attachment point for both processors and buses, and to manage
35 * resources which are common to all of them. In particular,
36 * this code implements the core resource managers for interrupt
37 * requests and memory address space.
40 #include <sys/cdefs.h>
41 __FBSDID("$FreeBSD$");
43 #include <sys/param.h>
44 #include <sys/systm.h>
46 #include <sys/kernel.h>
47 #include <sys/malloc.h>
48 #include <sys/module.h>
50 #include <sys/interrupt.h>
55 #include <machine/bus.h>
56 #include <machine/intr_machdep.h>
57 #include <machine/pmap.h>
58 #include <machine/resource.h>
59 #include <machine/vmparam.h>
61 #include "opt_platform.h"
65 #define dprintf printf
67 #define dprintf(x, arg...)
68 #endif /* NEXUS_DEBUG */
70 #define NUM_MIPS_IRQS 6
72 static MALLOC_DEFINE(M_NEXUSDEV, "nexusdev", "Nexus device");
75 struct resource_list nx_resources;
78 #define DEVTONX(dev) ((struct nexus_device *)device_get_ivars(dev))
80 static struct rman irq_rman;
81 static struct rman mem_rman;
83 static struct resource *
84 nexus_alloc_resource(device_t, device_t, int, int *, u_long,
85 u_long, u_long, u_int);
86 static device_t nexus_add_child(device_t, u_int, const char *, int);
87 static int nexus_attach(device_t);
88 static void nexus_delete_resource(device_t, device_t, int, int);
89 static struct resource_list *
90 nexus_get_reslist(device_t, device_t);
91 static int nexus_get_resource(device_t, device_t, int, int, u_long *,
93 static int nexus_print_child(device_t, device_t);
94 static int nexus_print_all_resources(device_t dev);
95 static int nexus_probe(device_t);
96 static int nexus_release_resource(device_t, device_t, int, int,
98 static int nexus_set_resource(device_t, device_t, int, int, u_long,
100 static int nexus_activate_resource(device_t, device_t, int, int,
102 static int nexus_deactivate_resource(device_t, device_t, int, int,
104 static void nexus_hinted_child(device_t, const char *, int);
105 static int nexus_setup_intr(device_t dev, device_t child,
106 struct resource *res, int flags, driver_filter_t *filt,
107 driver_intr_t *intr, void *arg, void **cookiep);
108 static int nexus_teardown_intr(device_t, device_t, struct resource *,
111 static device_method_t nexus_methods[] = {
112 /* Device interface */
113 DEVMETHOD(device_probe, nexus_probe),
114 DEVMETHOD(device_attach, nexus_attach),
117 DEVMETHOD(bus_add_child, nexus_add_child),
118 DEVMETHOD(bus_alloc_resource, nexus_alloc_resource),
119 DEVMETHOD(bus_delete_resource, nexus_delete_resource),
120 DEVMETHOD(bus_get_resource, nexus_get_resource),
121 DEVMETHOD(bus_get_resource_list, nexus_get_reslist),
122 DEVMETHOD(bus_print_child, nexus_print_child),
123 DEVMETHOD(bus_release_resource, nexus_release_resource),
124 DEVMETHOD(bus_set_resource, nexus_set_resource),
125 DEVMETHOD(bus_setup_intr, nexus_setup_intr),
126 DEVMETHOD(bus_teardown_intr, nexus_teardown_intr),
127 DEVMETHOD(bus_activate_resource,nexus_activate_resource),
128 DEVMETHOD(bus_deactivate_resource, nexus_deactivate_resource),
129 DEVMETHOD(bus_hinted_child, nexus_hinted_child),
134 static driver_t nexus_driver = {
139 static devclass_t nexus_devclass;
142 nexus_probe(device_t dev)
145 device_set_desc(dev, "MIPS32 root nexus");
147 irq_rman.rm_start = 0;
148 irq_rman.rm_end = NUM_MIPS_IRQS - 1;
149 irq_rman.rm_type = RMAN_ARRAY;
150 irq_rman.rm_descr = "Hardware IRQs";
151 if (rman_init(&irq_rman) != 0 ||
152 rman_manage_region(&irq_rman, 0, NUM_MIPS_IRQS - 1) != 0) {
153 panic("%s: irq_rman", __func__);
156 mem_rman.rm_start = 0;
157 mem_rman.rm_end = ~0ul;
158 mem_rman.rm_type = RMAN_ARRAY;
159 mem_rman.rm_descr = "Memory addresses";
160 if (rman_init(&mem_rman) != 0 ||
161 rman_manage_region(&mem_rman, 0, ~0) != 0) {
162 panic("%s: mem_rman", __func__);
169 nexus_attach(device_t dev)
172 bus_generic_probe(dev);
173 bus_enumerate_hinted_children(dev);
174 bus_generic_attach(dev);
180 nexus_print_child(device_t bus, device_t child)
184 retval += bus_print_child_header(bus, child);
185 retval += nexus_print_all_resources(child);
186 if (device_get_flags(child))
187 retval += printf(" flags %#x", device_get_flags(child));
188 retval += printf(" on %s\n", device_get_nameunit(bus));
194 nexus_print_all_resources(device_t dev)
196 struct nexus_device *ndev = DEVTONX(dev);
197 struct resource_list *rl = &ndev->nx_resources;
200 if (STAILQ_FIRST(rl))
201 retval += printf(" at");
203 retval += resource_list_print_type(rl, "mem", SYS_RES_MEMORY, "%#lx");
204 retval += resource_list_print_type(rl, "irq", SYS_RES_IRQ, "%ld");
210 nexus_add_child(device_t bus, u_int order, const char *name, int unit)
213 struct nexus_device *ndev;
215 ndev = malloc(sizeof(struct nexus_device), M_NEXUSDEV, M_NOWAIT|M_ZERO);
218 resource_list_init(&ndev->nx_resources);
220 child = device_add_child_ordered(bus, order, name, unit);
222 device_printf(bus, "failed to add child: %s%d\n", name, unit);
226 /* should we free this in nexus_child_detached? */
227 device_set_ivars(child, ndev);
233 * Allocate a resource on behalf of child. NB: child is usually going to be a
234 * child of one of our descendants, not a direct child of nexus0.
235 * (Exceptions include footbridge.)
237 static struct resource *
238 nexus_alloc_resource(device_t bus, device_t child, int type, int *rid,
239 u_long start, u_long end, u_long count, u_int flags)
241 struct nexus_device *ndev = DEVTONX(child);
243 struct resource_list_entry *rle;
245 int isdefault, needactivate, passthrough;
247 dprintf("%s: entry (%p, %p, %d, %p, %p, %p, %ld, %d)\n",
248 __func__, bus, child, type, rid, (void *)(intptr_t)start,
249 (void *)(intptr_t)end, count, flags);
250 dprintf("%s: requested rid is %d\n", __func__, *rid);
252 isdefault = (start == 0UL && end == ~0UL && count == 1);
253 needactivate = flags & RF_ACTIVE;
254 passthrough = (device_get_parent(child) != bus);
258 * If this is an allocation of the "default" range for a given RID,
259 * and we know what the resources for this device are (ie. they aren't
260 * maintained by a child bus), then work out the start/end values.
263 rle = resource_list_find(&ndev->nx_resources, type, *rid);
266 if (rle->res != NULL) {
267 panic("%s: resource entry is busy", __func__);
282 printf("%s: unknown resource type %d\n", __func__, type);
286 rv = rman_reserve_resource(rm, start, end, count, flags, child);
288 printf("%s: could not reserve resource for %s\n", __func__,
289 device_get_nameunit(child));
293 rman_set_rid(rv, *rid);
296 if (bus_activate_resource(child, type, *rid, rv)) {
297 printf("%s: could not activate resource\n", __func__);
298 rman_release_resource(rv);
306 static struct resource_list *
307 nexus_get_reslist(device_t dev, device_t child)
309 struct nexus_device *ndev = DEVTONX(child);
311 return (&ndev->nx_resources);
315 nexus_set_resource(device_t dev, device_t child, int type, int rid,
316 u_long start, u_long count)
318 struct nexus_device *ndev = DEVTONX(child);
319 struct resource_list *rl = &ndev->nx_resources;
320 struct resource_list_entry *rle;
322 dprintf("%s: entry (%p, %p, %d, %d, %p, %ld)\n",
323 __func__, dev, child, type, rid, (void *)(intptr_t)start, count);
325 rle = resource_list_add(rl, type, rid, start, start + count - 1,
334 nexus_get_resource(device_t dev, device_t child, int type, int rid,
335 u_long *startp, u_long *countp)
337 struct nexus_device *ndev = DEVTONX(child);
338 struct resource_list *rl = &ndev->nx_resources;
339 struct resource_list_entry *rle;
341 rle = resource_list_find(rl, type, rid);
345 *startp = rle->start;
347 *countp = rle->count;
352 nexus_delete_resource(device_t dev, device_t child, int type, int rid)
354 struct nexus_device *ndev = DEVTONX(child);
355 struct resource_list *rl = &ndev->nx_resources;
357 dprintf("%s: entry\n", __func__);
359 resource_list_delete(rl, type, rid);
363 nexus_release_resource(device_t bus, device_t child, int type, int rid,
366 dprintf("%s: entry\n", __func__);
368 if (rman_get_flags(r) & RF_ACTIVE) {
369 int error = bus_deactivate_resource(child, type, rid, r);
374 return (rman_release_resource(r));
378 nexus_activate_resource(device_t bus, device_t child, int type, int rid,
386 * If this is a memory resource, use pmap_mapdev to map it.
388 if (type == SYS_RES_MEMORY || type == SYS_RES_IOPORT) {
389 paddr = rman_get_start(r);
390 psize = rman_get_size(r);
391 vaddr = pmap_mapdev(paddr, psize);
393 rman_set_virtual(r, vaddr);
394 rman_set_bustag(r, mips_bus_space_generic);
395 rman_set_bushandle(r, (bus_space_handle_t)(uintptr_t)vaddr);
398 return (rman_activate_resource(r));
402 nexus_deactivate_resource(device_t bus, device_t child, int type, int rid,
407 if (type == SYS_RES_MEMORY) {
408 va = (vm_offset_t)rman_get_virtual(r);
409 pmap_unmapdev(va, rman_get_size(r));
412 return (rman_deactivate_resource(r));
416 nexus_setup_intr(device_t dev, device_t child, struct resource *res, int flags,
417 driver_filter_t *filt, driver_intr_t *intr, void *arg, void **cookiep)
423 irq = rman_get_start(res);
424 if (irq >= NUM_MIPS_IRQS) {
429 cpu_establish_hardintr(device_get_nameunit(child), filt, intr, arg,
430 irq, flags, cookiep);
436 nexus_teardown_intr(device_t dev, device_t child, struct resource *r, void *ih)
439 printf("Unimplemented %s at %s:%d\n", __func__, __FILE__, __LINE__);
444 nexus_hinted_child(device_t bus, const char *dname, int dunit)
454 if ((resource_int_value(dname, dunit, "order", &order)) != 0)
456 child = BUS_ADD_CHILD(bus, order, dname, dunit);
461 * Set hard-wired resources for hinted child using
465 if (resource_long_value(dname, dunit, "maddr", &maddr) == 0)
467 if (resource_int_value(dname, dunit, "msize", &msize) == 0)
470 /* check if all info for mem resource has been provided */
471 if ((mem_hints_count > 0) && (mem_hints_count < 2)) {
472 printf("Either maddr or msize hint is missing for %s%d\n",
475 else if (mem_hints_count) {
476 dprintf("%s: discovered hinted child %s at maddr %p(%d)\n",
477 __func__, device_get_nameunit(child),
478 (void *)(intptr_t)maddr, msize);
480 result = bus_set_resource(child, SYS_RES_MEMORY, 0, maddr,
484 "warning: bus_set_resource() failed\n");
488 if (resource_int_value(dname, dunit, "irq", &irq) == 0) {
489 result = bus_set_resource(child, SYS_RES_IRQ, 0, irq, 1);
492 "warning: bus_set_resource() failed\n");
496 DRIVER_MODULE(nexus, root, nexus_driver, nexus_devclass, 0, 0);