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>
62 #define dprintf printf
64 #define dprintf(x, arg...)
65 #endif /* NEXUS_DEBUG */
67 static MALLOC_DEFINE(M_NEXUSDEV, "nexusdev", "Nexus device");
70 struct resource_list nx_resources;
73 #define DEVTONX(dev) ((struct nexus_device *)device_get_ivars(dev))
74 #define NUM_MIPS_IRQS 6
75 #define MIPS_MEM_RID 0x20
77 static struct rman irq_rman;
78 static struct rman mem_rman;
82 * XXX: TODO: Implement bus space barrier functions.
83 * Currently tag and handle are set when memory resources
86 struct bus_space_tag nexus_bustag = {
88 NULL, /* parent bus tag */
89 NEXUS_BUS_SPACE, /* type */
90 nexus_bus_barrier, /* bus_space_barrier */
94 static struct resource *
95 nexus_alloc_resource(device_t, device_t, int, int *, u_long,
96 u_long, u_long, u_int);
97 static int nexus_activate_resource(device_t, device_t, int, int,
99 static device_t nexus_add_child(device_t, int, const char *, int);
100 static int nexus_attach(device_t);
101 static int nexus_deactivate_resource(device_t, device_t, int, int,
103 static void nexus_delete_resource(device_t, device_t, int, int);
104 static struct resource_list *
105 nexus_get_reslist(device_t, device_t);
106 static int nexus_get_resource(device_t, device_t, int, int, u_long *,
108 static void nexus_hinted_child(device_t, const char *, int);
109 static int nexus_print_child(device_t, device_t);
110 static int nexus_print_all_resources(device_t dev);
111 static int nexus_probe(device_t);
112 static int nexus_release_resource(device_t, device_t, int, int,
114 static int nexus_set_resource(device_t, device_t, int, int, u_long,
116 static int nexus_setup_intr(device_t dev, device_t child,
117 struct resource *res, int flags, driver_filter_t *filt,
118 driver_intr_t *intr, void *arg, void **cookiep);
119 static int nexus_teardown_intr(device_t, device_t, struct resource *,
122 static device_method_t nexus_methods[] = {
123 /* Device interface */
124 DEVMETHOD(device_probe, nexus_probe),
125 DEVMETHOD(device_attach, nexus_attach),
128 DEVMETHOD(bus_add_child, nexus_add_child),
129 DEVMETHOD(bus_activate_resource,nexus_activate_resource),
130 DEVMETHOD(bus_alloc_resource, nexus_alloc_resource),
131 DEVMETHOD(bus_deactivate_resource, nexus_deactivate_resource),
132 DEVMETHOD(bus_delete_resource, nexus_delete_resource),
133 DEVMETHOD(bus_get_resource, nexus_get_resource),
134 DEVMETHOD(bus_get_resource_list, nexus_get_reslist),
135 DEVMETHOD(bus_hinted_child, nexus_hinted_child),
136 DEVMETHOD(bus_print_child, nexus_print_child),
137 DEVMETHOD(bus_release_resource, nexus_release_resource),
138 DEVMETHOD(bus_set_resource, nexus_set_resource),
139 DEVMETHOD(bus_setup_intr, nexus_setup_intr),
140 DEVMETHOD(bus_teardown_intr, nexus_teardown_intr),
145 static driver_t nexus_driver = {
150 static devclass_t nexus_devclass;
153 nexus_probe(device_t dev)
156 device_set_desc(dev, "MIPS32 root nexus");
158 irq_rman.rm_start = 0;
159 irq_rman.rm_end = NUM_MIPS_IRQS - 1;
160 irq_rman.rm_type = RMAN_ARRAY;
161 irq_rman.rm_descr = "Hardware IRQs";
162 if (rman_init(&irq_rman) != 0 ||
163 rman_manage_region(&irq_rman, 0, NUM_MIPS_IRQS - 1) != 0) {
164 panic("%s: irq_rman", __func__);
167 mem_rman.rm_start = 0;
168 mem_rman.rm_end = ~0u;
169 mem_rman.rm_type = RMAN_ARRAY;
170 mem_rman.rm_descr = "Memory addresses";
171 if (rman_init(&mem_rman) != 0 ||
172 rman_manage_region(&mem_rman, 0, ~0) != 0) {
173 panic("%s: mem_rman", __func__);
180 nexus_setup_intr(device_t dev, device_t child, struct resource *res, int flags,
181 driver_filter_t *filt, driver_intr_t *intr, void *arg, void **cookiep)
185 register_t sr = intr_disable();
186 irq = rman_get_start(res);
187 if (irq >= NUM_MIPS_IRQS)
190 cpu_establish_hardintr(device_get_nameunit(child), filt, intr, arg,
191 irq, flags, cookiep);
197 nexus_teardown_intr(device_t dev, device_t child, struct resource *r, void *ih)
200 printf("Unimplemented %s at %s:%d\n", __func__, __FILE__, __LINE__);
205 nexus_attach(device_t dev)
208 bus_generic_probe(dev);
209 bus_enumerate_hinted_children(dev);
210 bus_generic_attach(dev);
216 nexus_print_child(device_t bus, device_t child)
220 retval += bus_print_child_header(bus, child);
221 retval += nexus_print_all_resources(child);
222 if (device_get_flags(child))
223 retval += printf(" flags %#x", device_get_flags(child));
224 retval += printf(" on %s\n", device_get_nameunit(bus));
230 nexus_print_all_resources(device_t dev)
232 struct nexus_device *ndev = DEVTONX(dev);
233 struct resource_list *rl = &ndev->nx_resources;
236 if (STAILQ_FIRST(rl))
237 retval += printf(" at");
239 retval += resource_list_print_type(rl, "mem", SYS_RES_MEMORY, "%#lx");
240 retval += resource_list_print_type(rl, "irq", SYS_RES_IRQ, "%ld");
246 nexus_hinted_child(device_t bus, const char *dname, int dunit)
253 child = BUS_ADD_CHILD(bus, 0, dname, dunit);
256 * Set hard-wired resources for hinted child using
259 resource_long_value(dname, dunit, "maddr", &maddr);
260 resource_int_value(dname, dunit, "msize", &msize);
262 dprintf("%s: discovered hinted child %s at maddr %p(%d)\n",
263 __func__, device_get_nameunit(child),
264 (void *)(intptr_t)maddr, msize);
266 result = bus_set_resource(child, SYS_RES_MEMORY, MIPS_MEM_RID,
269 device_printf(bus, "warning: bus_set_resource() failed\n");
274 nexus_add_child(device_t bus, int order, const char *name, int unit)
277 struct nexus_device *ndev;
279 ndev = malloc(sizeof(struct nexus_device), M_NEXUSDEV, M_NOWAIT|M_ZERO);
282 resource_list_init(&ndev->nx_resources);
284 child = device_add_child_ordered(bus, order, name, unit);
286 /* should we free this in nexus_child_detached? */
287 device_set_ivars(child, ndev);
293 * Allocate a resource on behalf of child. NB: child is usually going to be a
294 * child of one of our descendants, not a direct child of nexus0.
295 * (Exceptions include footbridge.)
297 static struct resource *
298 nexus_alloc_resource(device_t bus, device_t child, int type, int *rid,
299 u_long start, u_long end, u_long count, u_int flags)
301 struct nexus_device *ndev = DEVTONX(child);
303 struct resource_list_entry *rle;
305 int isdefault, needactivate, passthrough;
307 dprintf("%s: entry (%p, %p, %d, %p, %p, %p, %ld, %d)\n",
308 __func__, bus, child, type, rid, (void *)(intptr_t)start,
309 (void *)(intptr_t)end, count, flags);
310 dprintf("%s: requested rid is %d\n", __func__, *rid);
312 isdefault = (start == 0UL && end == ~0UL && count == 1);
313 needactivate = flags & RF_ACTIVE;
314 passthrough = (device_get_parent(child) != bus);
318 * If this is an allocation of the "default" range for a given RID,
319 * and we know what the resources for this device are (ie. they aren't
320 * maintained by a child bus), then work out the start/end values.
323 rle = resource_list_find(&ndev->nx_resources, type, *rid);
326 if (rle->res != NULL) {
327 panic("%s: resource entry is busy", __func__);
342 printf("%s: unknown resource type %d\n", __func__, type);
346 rv = rman_reserve_resource(rm, start, end, count, flags, child);
348 printf("%s: could not reserve resource\n", __func__);
352 rman_set_rid(rv, *rid);
355 if (bus_activate_resource(child, type, *rid, rv)) {
356 printf("%s: could not activate resource\n", __func__);
357 rman_release_resource(rv);
366 nexus_activate_resource(device_t bus, device_t child, int type, int rid,
373 * If this is a memory resource, track the direct mapping
374 * in the uncached MIPS KSEG1 segment.
376 if ((type == SYS_RES_MEMORY) || (type == SYS_RES_IOPORT)) {
382 paddr = rman_get_start(r);
383 psize = rman_get_size(r);
384 poffs = paddr - trunc_page(paddr);
385 vaddr = (caddr_t) pmap_mapdev(paddr-poffs, psize+poffs) + poffs;
387 rman_set_virtual(r, vaddr);
388 rman_set_bustag(r, MIPS_BUS_SPACE_MEM);
390 temp = 0x0000000000000000;
391 temp |= (uint32_t)vaddr;
392 rman_set_bushandle(r, (bus_space_handle_t)temp);
394 rman_set_bushandle(r, (bus_space_handle_t)vaddr);
398 return (rman_activate_resource(r));
401 static struct resource_list *
402 nexus_get_reslist(device_t dev, device_t child)
404 struct nexus_device *ndev = DEVTONX(child);
406 return (&ndev->nx_resources);
410 nexus_set_resource(device_t dev, device_t child, int type, int rid,
411 u_long start, u_long count)
413 struct nexus_device *ndev = DEVTONX(child);
414 struct resource_list *rl = &ndev->nx_resources;
415 struct resource_list_entry *rle;
417 dprintf("%s: entry (%p, %p, %d, %d, %p, %ld)\n",
418 __func__, dev, child, type, rid, (void *)(intptr_t)start, count);
420 rle = resource_list_add(rl, type, rid, start, start + count - 1,
429 nexus_get_resource(device_t dev, device_t child, int type, int rid,
430 u_long *startp, u_long *countp)
432 struct nexus_device *ndev = DEVTONX(child);
433 struct resource_list *rl = &ndev->nx_resources;
434 struct resource_list_entry *rle;
436 rle = resource_list_find(rl, type, rid);
440 *startp = rle->start;
442 *countp = rle->count;
447 nexus_delete_resource(device_t dev, device_t child, int type, int rid)
449 struct nexus_device *ndev = DEVTONX(child);
450 struct resource_list *rl = &ndev->nx_resources;
452 dprintf("%s: entry\n", __func__);
454 resource_list_delete(rl, type, rid);
458 nexus_release_resource(device_t bus, device_t child, int type, int rid,
461 dprintf("%s: entry\n", __func__);
463 if (rman_get_flags(r) & RF_ACTIVE) {
464 int error = bus_deactivate_resource(child, type, rid, r);
469 return (rman_release_resource(r));
473 nexus_deactivate_resource(device_t bus, device_t child, int type, int rid,
477 return (rman_deactivate_resource(r));
480 DRIVER_MODULE(nexus, root, nexus_driver, nexus_devclass, 0, 0);