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.
41 #include "opt_platform.h"
43 #include <sys/cdefs.h>
44 __FBSDID("$FreeBSD$");
46 #include <sys/param.h>
47 #include <sys/systm.h>
49 #include <sys/kernel.h>
50 #include <sys/malloc.h>
51 #include <sys/module.h>
53 #include <sys/interrupt.h>
55 #include <machine/bus.h>
56 #include <machine/resource.h>
57 #include <machine/intr.h>
60 #include <dev/ofw/ofw_bus_subr.h>
61 #include <dev/ofw/openfirm.h>
62 #include "ofw_bus_if.h"
65 extern struct bus_space memmap_bus;
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))
75 static struct rman mem_rman;
76 static struct rman irq_rman;
78 static device_probe_t nexus_fdt_probe;
79 static int nexus_attach(device_t);
81 static int nexus_print_child(device_t, device_t);
82 static device_t nexus_add_child(device_t, u_int, const char *, int);
83 static struct resource *nexus_alloc_resource(device_t, device_t, int, int *,
84 u_long, u_long, u_long, u_int);
85 static int nexus_activate_resource(device_t, device_t, int, int,
87 static int nexus_config_intr(device_t dev, int irq, enum intr_trigger trig,
88 enum intr_polarity pol);
89 static struct resource_list *nexus_get_reslist(device_t, device_t);
90 static int nexus_set_resource(device_t, device_t, int, int, u_long, u_long);
91 static int nexus_deactivate_resource(device_t, device_t, int, int,
94 static int nexus_setup_intr(device_t dev, device_t child, struct resource *res,
95 int flags, driver_filter_t *filt, driver_intr_t *intr, void *arg, void **cookiep);
96 static int nexus_teardown_intr(device_t, device_t, struct resource *, void *);
98 static int nexus_ofw_map_intr(device_t dev, device_t child, phandle_t iparent,
99 int icells, pcell_t *intr);
101 static device_method_t nexus_methods[] = {
102 /* Device interface */
103 DEVMETHOD(device_probe, nexus_fdt_probe),
104 DEVMETHOD(device_attach, nexus_attach),
107 DEVMETHOD(ofw_bus_map_intr, nexus_ofw_map_intr),
110 DEVMETHOD(bus_print_child, nexus_print_child),
111 DEVMETHOD(bus_add_child, nexus_add_child),
112 DEVMETHOD(bus_alloc_resource, nexus_alloc_resource),
113 DEVMETHOD(bus_activate_resource, nexus_activate_resource),
114 DEVMETHOD(bus_config_intr, nexus_config_intr),
115 DEVMETHOD(bus_get_resource_list, nexus_get_reslist),
116 DEVMETHOD(bus_set_resource, nexus_set_resource),
117 DEVMETHOD(bus_deactivate_resource, nexus_deactivate_resource),
118 DEVMETHOD(bus_setup_intr, nexus_setup_intr),
119 DEVMETHOD(bus_teardown_intr, nexus_teardown_intr),
124 static driver_t nexus_fdt_driver = {
131 nexus_fdt_probe(device_t dev)
135 return (BUS_PROBE_DEFAULT);
139 nexus_attach(device_t dev)
142 mem_rman.rm_start = 0;
143 mem_rman.rm_end = BUS_SPACE_MAXADDR;
144 mem_rman.rm_type = RMAN_ARRAY;
145 mem_rman.rm_descr = "I/O memory addresses";
146 if (rman_init(&mem_rman) ||
147 rman_manage_region(&mem_rman, 0, BUS_SPACE_MAXADDR))
148 panic("nexus_attach mem_rman");
149 irq_rman.rm_start = 0;
150 irq_rman.rm_end = ~0;
151 irq_rman.rm_type = RMAN_ARRAY;
152 irq_rman.rm_descr = "Interrupts";
153 if (rman_init(&irq_rman) || rman_manage_region(&irq_rman, 0, ~0))
154 panic("nexus_attach irq_rman");
156 nexus_add_child(dev, 8, "timer", 0);
157 nexus_add_child(dev, 9, "rcons", 0);
158 nexus_add_child(dev, 10, "ofwbus", 0);
160 bus_generic_probe(dev);
161 bus_generic_attach(dev);
167 nexus_print_child(device_t bus, device_t child)
171 retval += bus_print_child_header(bus, child);
172 retval += printf("\n");
178 nexus_add_child(device_t bus, u_int order, const char *name, int unit)
181 struct nexus_device *ndev;
183 ndev = malloc(sizeof(struct nexus_device), M_NEXUSDEV, M_NOWAIT|M_ZERO);
186 resource_list_init(&ndev->nx_resources);
188 child = device_add_child_ordered(bus, order, name, unit);
190 /* should we free this in nexus_child_detached? */
191 device_set_ivars(child, ndev);
198 * Allocate a resource on behalf of child. NB: child is usually going to be a
199 * child of one of our descendants, not a direct child of nexus0.
200 * (Exceptions include footbridge.)
202 static struct resource *
203 nexus_alloc_resource(device_t bus, device_t child, int type, int *rid,
204 u_long start, u_long end, u_long count, u_int flags)
206 struct nexus_device *ndev = DEVTONX(child);
208 struct resource_list_entry *rle;
210 int needactivate = flags & RF_ACTIVE;
213 * If this is an allocation of the "default" range for a given
214 * RID, and we know what the resources for this device are
215 * (ie. they aren't maintained by a child bus), then work out
216 * the start/end values.
218 if (RMAN_IS_DEFAULT_RANGE(start, end) && (count == 1)) {
219 if (device_get_parent(child) != bus || ndev == NULL)
221 rle = resource_list_find(&ndev->nx_resources, type, *rid);
243 rv = rman_reserve_resource(rm, start, end, count, flags, child);
247 rman_set_rid(rv, *rid);
248 rman_set_bushandle(rv, rman_get_start(rv));
251 if (bus_activate_resource(child, type, *rid, rv)) {
252 rman_release_resource(rv);
261 nexus_config_intr(device_t dev, int irq, enum intr_trigger trig,
262 enum intr_polarity pol)
269 nexus_setup_intr(device_t dev, device_t child, struct resource *res, int flags,
270 driver_filter_t *filt, driver_intr_t *intr, void *arg, void **cookiep)
274 if ((rman_get_flags(res) & RF_SHAREABLE) == 0)
277 /* We depend here on rman_activate_resource() being idempotent. */
278 error = rman_activate_resource(res);
282 error = intr_setup_irq(child, res, filt, intr, arg, flags, cookiep);
288 nexus_teardown_intr(device_t dev, device_t child, struct resource *r, void *ih)
291 return (intr_teardown_irq(child, r, ih));
295 nexus_activate_resource(device_t bus, device_t child, int type, int rid,
301 bus_space_handle_t vaddr;
303 if ((err = rman_activate_resource(r)) != 0)
307 * If this is a memory resource, map it into the kernel.
309 if (type == SYS_RES_MEMORY || type == SYS_RES_IOPORT) {
310 paddr = (bus_addr_t)rman_get_start(r);
311 psize = (bus_size_t)rman_get_size(r);
312 err = bus_space_map(&memmap_bus, paddr, psize, 0, &vaddr);
314 rman_deactivate_resource(r);
317 rman_set_bustag(r, &memmap_bus);
318 rman_set_virtual(r, (void *)vaddr);
319 rman_set_bushandle(r, vaddr);
320 } else if (type == SYS_RES_IRQ) {
321 err = intr_activate_irq(child, r);
323 rman_deactivate_resource(r);
331 static struct resource_list *
332 nexus_get_reslist(device_t dev, device_t child)
334 struct nexus_device *ndev = DEVTONX(child);
336 return (&ndev->nx_resources);
340 nexus_set_resource(device_t dev, device_t child, int type, int rid,
341 u_long start, u_long count)
343 struct nexus_device *ndev = DEVTONX(child);
344 struct resource_list *rl = &ndev->nx_resources;
346 /* XXX this should return a success/failure indicator */
347 resource_list_add(rl, type, rid, start, start + count - 1, count);
354 nexus_deactivate_resource(device_t bus, device_t child, int type, int rid,
358 bus_space_handle_t vaddr;
360 psize = (bus_size_t)rman_get_size(r);
361 vaddr = rman_get_bushandle(r);
364 bus_space_unmap(&memmap_bus, vaddr, psize);
365 rman_set_virtual(r, NULL);
366 rman_set_bushandle(r, 0);
369 return (rman_deactivate_resource(r));
372 static devclass_t nexus_fdt_devclass;
374 EARLY_DRIVER_MODULE(nexus_fdt, root, nexus_fdt_driver, nexus_fdt_devclass,
375 0, 0, BUS_PASS_BUS + BUS_PASS_ORDER_FIRST);
378 nexus_ofw_map_intr(device_t dev, device_t child, phandle_t iparent, int icells,
381 struct intr_map_data_fdt *fdt_data;
385 len = sizeof(*fdt_data) + icells * sizeof(pcell_t);
386 fdt_data = (struct intr_map_data_fdt *)intr_alloc_map_data(
387 INTR_MAP_DATA_FDT, len, M_WAITOK | M_ZERO);
388 fdt_data->iparent = iparent;
389 fdt_data->ncells = icells;
390 memcpy(fdt_data->cells, intr, icells * sizeof(pcell_t));
391 irq = intr_map_irq(NULL, iparent, (struct intr_map_data *)fdt_data);