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 Arm 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 "opt_platform.h"
44 #include <sys/cdefs.h>
45 __FBSDID("$FreeBSD$");
47 #include <sys/param.h>
48 #include <sys/systm.h>
50 #include <sys/kernel.h>
51 #include <sys/malloc.h>
52 #include <sys/module.h>
53 #include <machine/bus.h>
55 #include <sys/interrupt.h>
57 #include <machine/vmparam.h>
58 #include <machine/pcb.h>
62 #include <machine/resource.h>
63 #include <machine/intr.h>
65 #include <arm/arm/nexusvar.h>
68 #include <machine/fdt.h>
69 #include <dev/ofw/ofw_bus_subr.h>
70 #include "ofw_bus_if.h"
73 static MALLOC_DEFINE(M_NEXUSDEV, "nexusdev", "Nexus device");
76 struct resource_list nx_resources;
79 #define DEVTONX(dev) ((struct nexus_device *)device_get_ivars(dev))
81 static struct rman mem_rman;
83 static int nexus_probe(device_t);
84 static int nexus_attach(device_t);
85 static int nexus_print_child(device_t, device_t);
86 static device_t nexus_add_child(device_t, u_int, const char *, int);
87 static struct resource *nexus_alloc_resource(device_t, device_t, int, int *,
88 rman_res_t, rman_res_t, rman_res_t, u_int);
89 static int nexus_activate_resource(device_t, device_t, int, int,
91 static bus_space_tag_t nexus_get_bus_tag(device_t, device_t);
92 static bus_dma_tag_t nexus_get_dma_tag(device_t dev, device_t child);
94 static int nexus_bind_intr(device_t, device_t, struct resource *, int);
96 static int nexus_config_intr(device_t dev, int irq, enum intr_trigger trig,
97 enum intr_polarity pol);
98 static int nexus_describe_intr(device_t dev, device_t child,
99 struct resource *irq, void *cookie, const char *descr);
100 static int nexus_deactivate_resource(device_t, device_t, int, int,
102 static int nexus_release_resource(device_t, device_t, int, int,
105 static int nexus_setup_intr(device_t dev, device_t child, struct resource *res,
106 int flags, driver_filter_t *filt, driver_intr_t *intr, void *arg, void **cookiep);
107 static int nexus_teardown_intr(device_t, device_t, struct resource *, void *);
110 static int nexus_ofw_map_intr(device_t dev, device_t child, phandle_t iparent,
111 int icells, pcell_t *intr);
115 * Normally NULL (which results in defaults which are handled in
116 * busdma_machdep), platform init code can use nexus_set_dma_tag() to set this
117 * to a tag that will be inherited by all busses and devices on the platform.
119 static bus_dma_tag_t nexus_dma_tag;
121 static device_method_t nexus_methods[] = {
122 /* Device interface */
123 DEVMETHOD(device_probe, nexus_probe),
124 DEVMETHOD(device_attach, nexus_attach),
126 DEVMETHOD(bus_print_child, nexus_print_child),
127 DEVMETHOD(bus_add_child, nexus_add_child),
128 DEVMETHOD(bus_alloc_resource, nexus_alloc_resource),
129 DEVMETHOD(bus_activate_resource, nexus_activate_resource),
130 DEVMETHOD(bus_config_intr, nexus_config_intr),
131 DEVMETHOD(bus_deactivate_resource, nexus_deactivate_resource),
132 DEVMETHOD(bus_release_resource, nexus_release_resource),
133 DEVMETHOD(bus_setup_intr, nexus_setup_intr),
134 DEVMETHOD(bus_teardown_intr, nexus_teardown_intr),
135 DEVMETHOD(bus_get_bus_tag, nexus_get_bus_tag),
136 DEVMETHOD(bus_get_dma_tag, nexus_get_dma_tag),
137 DEVMETHOD(bus_describe_intr, nexus_describe_intr),
139 DEVMETHOD(bus_bind_intr, nexus_bind_intr),
142 DEVMETHOD(ofw_bus_map_intr, nexus_ofw_map_intr),
147 static devclass_t nexus_devclass;
148 static driver_t nexus_driver = {
153 EARLY_DRIVER_MODULE(nexus, root, nexus_driver, nexus_devclass, 0, 0,
154 BUS_PASS_BUS + BUS_PASS_ORDER_EARLY);
157 nexus_probe(device_t dev)
160 device_quiet(dev); /* suppress attach message for neatness */
162 return (BUS_PROBE_DEFAULT);
166 nexus_attach(device_t dev)
169 mem_rman.rm_start = 0;
170 mem_rman.rm_end = BUS_SPACE_MAXADDR;
171 mem_rman.rm_type = RMAN_ARRAY;
172 mem_rman.rm_descr = "I/O memory addresses";
173 if (rman_init(&mem_rman) ||
174 rman_manage_region(&mem_rman, 0, BUS_SPACE_MAXADDR))
175 panic("nexus_probe mem_rman");
178 * First, deal with the children we know about already
180 bus_generic_probe(dev);
181 bus_generic_attach(dev);
187 nexus_print_child(device_t bus, device_t child)
191 retval += bus_print_child_header(bus, child);
192 retval += printf("\n");
198 nexus_add_child(device_t bus, u_int order, const char *name, int unit)
201 struct nexus_device *ndev;
203 ndev = malloc(sizeof(struct nexus_device), M_NEXUSDEV, M_NOWAIT|M_ZERO);
206 resource_list_init(&ndev->nx_resources);
208 child = device_add_child_ordered(bus, order, name, unit);
210 /* should we free this in nexus_child_detached? */
211 device_set_ivars(child, ndev);
217 * Allocate a resource on behalf of child. NB: child is usually going to be a
218 * child of one of our descendants, not a direct child of nexus0.
219 * (Exceptions include footbridge.)
221 static struct resource *
222 nexus_alloc_resource(device_t bus, device_t child, int type, int *rid,
223 rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
227 int needactivate = flags & RF_ACTIVE;
241 rv = rman_reserve_resource(rm, start, end, count, flags, child);
245 rman_set_rid(rv, *rid);
248 if (bus_activate_resource(child, type, *rid, rv)) {
249 rman_release_resource(rv);
258 nexus_release_resource(device_t bus, device_t child, int type, int rid,
259 struct resource *res)
263 if (rman_get_flags(res) & RF_ACTIVE) {
264 error = bus_deactivate_resource(child, type, rid, res);
268 return (rman_release_resource(res));
271 static bus_space_tag_t
272 nexus_get_bus_tag(device_t bus __unused, device_t child __unused)
276 return(fdtbus_bs_tag);
283 nexus_get_dma_tag(device_t dev, device_t child)
286 return nexus_dma_tag;
290 nexus_set_dma_tag(bus_dma_tag_t tag)
297 nexus_config_intr(device_t dev, int irq, enum intr_trigger trig,
298 enum intr_polarity pol)
302 device_printf(dev, "bus_config_intr is obsolete and not supported!\n");
308 nexus_setup_intr(device_t dev, device_t child, struct resource *res, int flags,
309 driver_filter_t *filt, driver_intr_t *intr, void *arg, void **cookiep)
312 if ((rman_get_flags(res) & RF_SHAREABLE) == 0)
315 return(intr_setup_irq(child, res, filt, intr, arg, flags, cookiep));
319 nexus_teardown_intr(device_t dev, device_t child, struct resource *r, void *ih)
322 return (intr_teardown_irq(child, r, ih));
326 nexus_describe_intr(device_t dev, device_t child, struct resource *irq,
327 void *cookie, const char *descr)
330 return (intr_describe_irq(child, irq, cookie, descr));
335 nexus_bind_intr(device_t dev, device_t child, struct resource *irq, int cpu)
338 return (intr_bind_irq(child, irq, cpu));
343 nexus_activate_resource(device_t bus, device_t child, int type, int rid,
349 bus_space_handle_t vaddr;
351 if ((err = rman_activate_resource(r)) != 0)
355 * If this is a memory resource, map it into the kernel.
357 if (type == SYS_RES_MEMORY || type == SYS_RES_IOPORT) {
358 paddr = (bus_addr_t)rman_get_start(r);
359 psize = (bus_size_t)rman_get_size(r);
361 err = bus_space_map(fdtbus_bs_tag, paddr, psize, 0, &vaddr);
363 rman_deactivate_resource(r);
366 rman_set_bustag(r, fdtbus_bs_tag);
368 vaddr = (bus_space_handle_t)pmap_mapdev((vm_offset_t)paddr,
371 rman_deactivate_resource(r);
374 rman_set_bustag(r, (void *)1);
376 rman_set_virtual(r, (void *)vaddr);
377 rman_set_bushandle(r, vaddr);
379 } else if (type == SYS_RES_IRQ) {
380 err = intr_activate_irq(child, r);
382 rman_deactivate_resource(r);
390 nexus_deactivate_resource(device_t bus, device_t child, int type, int rid,
394 bus_space_handle_t vaddr;
396 if (type == SYS_RES_MEMORY || type == SYS_RES_IOPORT) {
397 psize = (bus_size_t)rman_get_size(r);
398 vaddr = rman_get_bushandle(r);
402 bus_space_unmap(fdtbus_bs_tag, vaddr, psize);
404 pmap_unmapdev((vm_offset_t)vaddr, (vm_size_t)psize);
406 rman_set_virtual(r, NULL);
407 rman_set_bushandle(r, 0);
409 } else if (type == SYS_RES_IRQ) {
410 intr_deactivate_irq(child, r);
413 return (rman_deactivate_resource(r));
418 nexus_ofw_map_intr(device_t dev, device_t child, phandle_t iparent, int icells,
422 struct intr_map_data_fdt *fdt_data;
425 len = sizeof(*fdt_data) + icells * sizeof(pcell_t);
426 fdt_data = (struct intr_map_data_fdt *)intr_alloc_map_data(
427 INTR_MAP_DATA_FDT, len, M_WAITOK | M_ZERO);
428 fdt_data->iparent = iparent;
429 fdt_data->ncells = icells;
430 memcpy(fdt_data->cells, intr, icells * sizeof(pcell_t));
431 irq = intr_map_irq(NULL, iparent, (struct intr_map_data *)fdt_data);