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 RISC-V 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, DMA requests (which rightfully should be a part of the
38 * ISA code but it's easier to do it here for now), I/O port addresses,
39 * and I/O memory address space.
42 #include <sys/cdefs.h>
43 __FBSDID("$FreeBSD$");
45 #include <sys/param.h>
46 #include <sys/systm.h>
48 #include <sys/kernel.h>
49 #include <sys/malloc.h>
50 #include <sys/module.h>
51 #include <machine/bus.h>
53 #include <sys/interrupt.h>
55 #include <machine/vmparam.h>
56 #include <machine/pcb.h>
60 #include <machine/resource.h>
61 #include <machine/intr.h>
63 #include "opt_platform.h"
65 #include <dev/fdt/fdt_common.h>
66 #include "ofw_bus_if.h"
68 extern struct bus_space memmap_bus;
70 static MALLOC_DEFINE(M_NEXUSDEV, "nexusdev", "Nexus device");
73 struct resource_list nx_resources;
76 #define DEVTONX(dev) ((struct nexus_device *)device_get_ivars(dev))
78 static struct rman mem_rman;
79 static struct rman irq_rman;
81 static device_probe_t nexus_fdt_probe;
82 static int nexus_attach(device_t);
84 static int nexus_print_child(device_t, device_t);
85 static device_t nexus_add_child(device_t, u_int, const char *, int);
86 static struct resource *nexus_alloc_resource(device_t, device_t, int, int *,
87 u_long, u_long, u_long, u_int);
88 static int nexus_activate_resource(device_t, device_t, int, int,
90 static int nexus_config_intr(device_t dev, int irq, enum intr_trigger trig,
91 enum intr_polarity pol);
92 static struct resource_list *nexus_get_reslist(device_t, device_t);
93 static int nexus_set_resource(device_t, device_t, int, int, u_long, u_long);
94 static int nexus_deactivate_resource(device_t, device_t, int, int,
97 static int nexus_setup_intr(device_t dev, device_t child, struct resource *res,
98 int flags, driver_filter_t *filt, driver_intr_t *intr, void *arg, void **cookiep);
99 static int nexus_teardown_intr(device_t, device_t, struct resource *, void *);
101 static int nexus_ofw_map_intr(device_t dev, device_t child, phandle_t iparent,
102 int icells, pcell_t *intr);
104 static device_method_t nexus_methods[] = {
105 /* Device interface */
106 DEVMETHOD(device_probe, nexus_fdt_probe),
107 DEVMETHOD(device_attach, nexus_attach),
110 DEVMETHOD(ofw_bus_map_intr, nexus_ofw_map_intr),
113 DEVMETHOD(bus_print_child, nexus_print_child),
114 DEVMETHOD(bus_add_child, nexus_add_child),
115 DEVMETHOD(bus_alloc_resource, nexus_alloc_resource),
116 DEVMETHOD(bus_activate_resource, nexus_activate_resource),
117 DEVMETHOD(bus_config_intr, nexus_config_intr),
118 DEVMETHOD(bus_get_resource_list, nexus_get_reslist),
119 DEVMETHOD(bus_set_resource, nexus_set_resource),
120 DEVMETHOD(bus_deactivate_resource, nexus_deactivate_resource),
121 DEVMETHOD(bus_setup_intr, nexus_setup_intr),
122 DEVMETHOD(bus_teardown_intr, nexus_teardown_intr),
127 static driver_t nexus_fdt_driver = {
134 nexus_fdt_probe(device_t dev)
138 return (BUS_PROBE_DEFAULT);
142 nexus_attach(device_t dev)
145 mem_rman.rm_start = 0;
146 mem_rman.rm_end = BUS_SPACE_MAXADDR;
147 mem_rman.rm_type = RMAN_ARRAY;
148 mem_rman.rm_descr = "I/O memory addresses";
149 if (rman_init(&mem_rman) ||
150 rman_manage_region(&mem_rman, 0, BUS_SPACE_MAXADDR))
151 panic("nexus_attach mem_rman");
152 irq_rman.rm_start = 0;
153 irq_rman.rm_end = ~0;
154 irq_rman.rm_type = RMAN_ARRAY;
155 irq_rman.rm_descr = "Interrupts";
156 if (rman_init(&irq_rman) || rman_manage_region(&irq_rman, 0, ~0))
157 panic("nexus_attach irq_rman");
159 nexus_add_child(dev, 10, "ofwbus", 0);
161 bus_generic_probe(dev);
162 bus_generic_attach(dev);
168 nexus_print_child(device_t bus, device_t child)
172 retval += bus_print_child_header(bus, child);
173 retval += printf("\n");
179 nexus_add_child(device_t bus, u_int order, const char *name, int unit)
182 struct nexus_device *ndev;
184 ndev = malloc(sizeof(struct nexus_device), M_NEXUSDEV, M_NOWAIT|M_ZERO);
187 resource_list_init(&ndev->nx_resources);
189 child = device_add_child_ordered(bus, order, name, unit);
191 /* should we free this in nexus_child_detached? */
192 device_set_ivars(child, ndev);
199 * Allocate a resource on behalf of child. NB: child is usually going to be a
200 * child of one of our descendants, not a direct child of nexus0.
201 * (Exceptions include footbridge.)
203 static struct resource *
204 nexus_alloc_resource(device_t bus, device_t child, int type, int *rid,
205 u_long start, u_long end, u_long count, u_int flags)
207 struct nexus_device *ndev = DEVTONX(child);
209 struct resource_list_entry *rle;
211 int needactivate = flags & RF_ACTIVE;
214 * If this is an allocation of the "default" range for a given
215 * RID, and we know what the resources for this device are
216 * (ie. they aren't maintained by a child bus), then work out
217 * the start/end values.
219 if (RMAN_IS_DEFAULT_RANGE(start, end) && (count == 1)) {
220 if (device_get_parent(child) != bus || ndev == NULL)
222 rle = resource_list_find(&ndev->nx_resources, type, *rid);
244 rv = rman_reserve_resource(rm, start, end, count, flags, child);
248 rman_set_rid(rv, *rid);
249 rman_set_bushandle(rv, rman_get_start(rv));
252 if (bus_activate_resource(child, type, *rid, rv)) {
253 rman_release_resource(rv);
262 nexus_config_intr(device_t dev, int irq, enum intr_trigger trig,
263 enum intr_polarity pol)
266 return (riscv_config_intr(irq, trig, pol));
270 nexus_setup_intr(device_t dev, device_t child, struct resource *res, int flags,
271 driver_filter_t *filt, driver_intr_t *intr, void *arg, void **cookiep)
275 if ((rman_get_flags(res) & RF_SHAREABLE) == 0)
278 /* We depend here on rman_activate_resource() being idempotent. */
279 error = rman_activate_resource(res);
283 error = riscv_setup_intr(device_get_nameunit(child), filt, intr,
284 arg, rman_get_start(res), flags, cookiep);
290 nexus_teardown_intr(device_t dev, device_t child, struct resource *r, void *ih)
293 return (riscv_teardown_intr(ih));
297 nexus_activate_resource(device_t bus, device_t child, int type, int rid,
303 bus_space_handle_t vaddr;
305 if ((err = rman_activate_resource(r)) != 0)
309 * If this is a memory resource, map it into the kernel.
311 if (type == SYS_RES_MEMORY || type == SYS_RES_IOPORT) {
312 paddr = (bus_addr_t)rman_get_start(r);
313 psize = (bus_size_t)rman_get_size(r);
314 err = bus_space_map(&memmap_bus, paddr, psize, 0, &vaddr);
316 rman_deactivate_resource(r);
319 rman_set_bustag(r, &memmap_bus);
320 rman_set_virtual(r, (void *)vaddr);
321 rman_set_bushandle(r, vaddr);
326 static struct resource_list *
327 nexus_get_reslist(device_t dev, device_t child)
329 struct nexus_device *ndev = DEVTONX(child);
331 return (&ndev->nx_resources);
335 nexus_set_resource(device_t dev, device_t child, int type, int rid,
336 u_long start, u_long count)
338 struct nexus_device *ndev = DEVTONX(child);
339 struct resource_list *rl = &ndev->nx_resources;
341 /* XXX this should return a success/failure indicator */
342 resource_list_add(rl, type, rid, start, start + count - 1, count);
349 nexus_deactivate_resource(device_t bus, device_t child, int type, int rid,
353 bus_space_handle_t vaddr;
355 psize = (bus_size_t)rman_get_size(r);
356 vaddr = rman_get_bushandle(r);
359 bus_space_unmap(&memmap_bus, vaddr, psize);
360 rman_set_virtual(r, NULL);
361 rman_set_bushandle(r, 0);
364 return (rman_deactivate_resource(r));
367 static devclass_t nexus_fdt_devclass;
369 EARLY_DRIVER_MODULE(nexus_fdt, root, nexus_fdt_driver, nexus_fdt_devclass,
370 0, 0, BUS_PASS_BUS + BUS_PASS_ORDER_FIRST);
373 nexus_ofw_map_intr(device_t dev, device_t child, phandle_t iparent, int icells,