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.
43 #include "opt_platform.h"
45 #include <sys/cdefs.h>
46 __FBSDID("$FreeBSD$");
48 #include <sys/param.h>
49 #include <sys/systm.h>
51 #include <sys/kernel.h>
52 #include <sys/malloc.h>
53 #include <sys/module.h>
54 #include <machine/bus.h>
56 #include <sys/interrupt.h>
58 #include <machine/machdep.h>
59 #include <machine/vmparam.h>
60 #include <machine/pcb.h>
64 #include <machine/resource.h>
65 #include <machine/intr.h>
68 #include <dev/ofw/ofw_bus_subr.h>
69 #include <dev/ofw/openfirm.h>
70 #include "ofw_bus_if.h"
73 #include <contrib/dev/acpica/include/acpi.h>
74 #include <dev/acpica/acpivar.h>
75 #include "acpi_bus_if.h"
79 extern struct bus_space memmap_bus;
81 static MALLOC_DEFINE(M_NEXUSDEV, "nexusdev", "Nexus device");
84 struct resource_list nx_resources;
87 #define DEVTONX(dev) ((struct nexus_device *)device_get_ivars(dev))
89 static struct rman mem_rman;
90 static struct rman irq_rman;
92 static int nexus_attach(device_t);
95 static device_probe_t nexus_fdt_probe;
96 static device_attach_t nexus_fdt_attach;
99 static device_probe_t nexus_acpi_probe;
100 static device_attach_t nexus_acpi_attach;
103 static int nexus_print_child(device_t, device_t);
104 static device_t nexus_add_child(device_t, u_int, const char *, int);
105 static struct resource *nexus_alloc_resource(device_t, device_t, int, int *,
106 rman_res_t, rman_res_t, rman_res_t, u_int);
107 static int nexus_activate_resource(device_t, device_t, int, int,
109 static int nexus_config_intr(device_t dev, int irq, enum intr_trigger trig,
110 enum intr_polarity pol);
111 static struct resource_list *nexus_get_reslist(device_t, device_t);
112 static int nexus_set_resource(device_t, device_t, int, int,
113 rman_res_t, rman_res_t);
114 static int nexus_deactivate_resource(device_t, device_t, int, int,
116 static int nexus_release_resource(device_t, device_t, int, int,
119 static int nexus_setup_intr(device_t dev, device_t child, struct resource *res,
120 int flags, driver_filter_t *filt, driver_intr_t *intr, void *arg, void **cookiep);
121 static int nexus_teardown_intr(device_t, device_t, struct resource *, void *);
122 static bus_space_tag_t nexus_get_bus_tag(device_t, device_t);
124 static int nexus_bind_intr(device_t, device_t, struct resource *, int);
128 static int nexus_ofw_map_intr(device_t dev, device_t child, phandle_t iparent,
129 int icells, pcell_t *intr);
132 static device_method_t nexus_methods[] = {
134 DEVMETHOD(bus_print_child, nexus_print_child),
135 DEVMETHOD(bus_add_child, nexus_add_child),
136 DEVMETHOD(bus_alloc_resource, nexus_alloc_resource),
137 DEVMETHOD(bus_activate_resource, nexus_activate_resource),
138 DEVMETHOD(bus_config_intr, nexus_config_intr),
139 DEVMETHOD(bus_get_resource_list, nexus_get_reslist),
140 DEVMETHOD(bus_set_resource, nexus_set_resource),
141 DEVMETHOD(bus_deactivate_resource, nexus_deactivate_resource),
142 DEVMETHOD(bus_release_resource, nexus_release_resource),
143 DEVMETHOD(bus_setup_intr, nexus_setup_intr),
144 DEVMETHOD(bus_teardown_intr, nexus_teardown_intr),
145 DEVMETHOD(bus_get_bus_tag, nexus_get_bus_tag),
147 DEVMETHOD(bus_bind_intr, nexus_bind_intr),
152 static driver_t nexus_driver = {
159 nexus_attach(device_t dev)
162 mem_rman.rm_start = 0;
163 mem_rman.rm_end = BUS_SPACE_MAXADDR;
164 mem_rman.rm_type = RMAN_ARRAY;
165 mem_rman.rm_descr = "I/O memory addresses";
166 if (rman_init(&mem_rman) ||
167 rman_manage_region(&mem_rman, 0, BUS_SPACE_MAXADDR))
168 panic("nexus_attach mem_rman");
169 irq_rman.rm_start = 0;
170 irq_rman.rm_end = ~0;
171 irq_rman.rm_type = RMAN_ARRAY;
172 irq_rman.rm_descr = "Interrupts";
173 if (rman_init(&irq_rman) || rman_manage_region(&irq_rman, 0, ~0))
174 panic("nexus_attach irq_rman");
176 bus_generic_probe(dev);
177 bus_generic_attach(dev);
183 nexus_print_child(device_t bus, device_t child)
187 retval += bus_print_child_header(bus, child);
188 retval += printf("\n");
194 nexus_add_child(device_t bus, u_int order, const char *name, int unit)
197 struct nexus_device *ndev;
199 ndev = malloc(sizeof(struct nexus_device), M_NEXUSDEV, M_NOWAIT|M_ZERO);
202 resource_list_init(&ndev->nx_resources);
204 child = device_add_child_ordered(bus, order, name, unit);
206 /* should we free this in nexus_child_detached? */
207 device_set_ivars(child, ndev);
214 * Allocate a resource on behalf of child. NB: child is usually going to be a
215 * child of one of our descendants, not a direct child of nexus0.
216 * (Exceptions include footbridge.)
218 static struct resource *
219 nexus_alloc_resource(device_t bus, device_t child, int type, int *rid,
220 rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
222 struct nexus_device *ndev = DEVTONX(child);
224 struct resource_list_entry *rle;
226 int needactivate = flags & RF_ACTIVE;
229 * If this is an allocation of the "default" range for a given
230 * RID, and we know what the resources for this device are
231 * (ie. they aren't maintained by a child bus), then work out
232 * the start/end values.
234 if (RMAN_IS_DEFAULT_RANGE(start, end) && (count == 1)) {
235 if (device_get_parent(child) != bus || ndev == NULL)
237 rle = resource_list_find(&ndev->nx_resources, type, *rid);
259 rv = rman_reserve_resource(rm, start, end, count, flags, child);
263 rman_set_rid(rv, *rid);
264 rman_set_bushandle(rv, rman_get_start(rv));
267 if (bus_activate_resource(child, type, *rid, rv)) {
268 rman_release_resource(rv);
277 nexus_release_resource(device_t bus, device_t child, int type, int rid,
278 struct resource *res)
282 if (rman_get_flags(res) & RF_ACTIVE) {
283 error = bus_deactivate_resource(child, type, rid, res);
287 return (rman_release_resource(res));
291 nexus_config_intr(device_t dev, int irq, enum intr_trigger trig,
292 enum intr_polarity pol)
296 * On arm64 (due to INTRNG), ACPI interrupt configuration is
297 * done in nexus_acpi_map_intr().
303 nexus_setup_intr(device_t dev, device_t child, struct resource *res, int flags,
304 driver_filter_t *filt, driver_intr_t *intr, void *arg, void **cookiep)
308 if ((rman_get_flags(res) & RF_SHAREABLE) == 0)
311 /* We depend here on rman_activate_resource() being idempotent. */
312 error = rman_activate_resource(res);
316 error = intr_setup_irq(child, res, filt, intr, arg, flags, cookiep);
322 nexus_teardown_intr(device_t dev, device_t child, struct resource *r, void *ih)
325 return (intr_teardown_irq(child, r, ih));
330 nexus_bind_intr(device_t dev, device_t child, struct resource *irq, int cpu)
333 return (intr_bind_irq(child, irq, cpu));
337 static bus_space_tag_t
338 nexus_get_bus_tag(device_t bus __unused, device_t child __unused)
345 nexus_activate_resource(device_t bus, device_t child, int type, int rid,
351 bus_space_handle_t vaddr;
353 if ((err = rman_activate_resource(r)) != 0)
357 * If this is a memory resource, map it into the kernel.
359 if (type == SYS_RES_MEMORY || type == SYS_RES_IOPORT) {
360 paddr = (bus_addr_t)rman_get_start(r);
361 psize = (bus_size_t)rman_get_size(r);
362 err = bus_space_map(&memmap_bus, paddr, psize, 0, &vaddr);
364 rman_deactivate_resource(r);
367 rman_set_bustag(r, &memmap_bus);
368 rman_set_virtual(r, (void *)vaddr);
369 rman_set_bushandle(r, vaddr);
370 } else if (type == SYS_RES_IRQ) {
371 err = intr_activate_irq(child, r);
373 rman_deactivate_resource(r);
380 static struct resource_list *
381 nexus_get_reslist(device_t dev, device_t child)
383 struct nexus_device *ndev = DEVTONX(child);
385 return (&ndev->nx_resources);
389 nexus_set_resource(device_t dev, device_t child, int type, int rid,
390 rman_res_t start, rman_res_t count)
392 struct nexus_device *ndev = DEVTONX(child);
393 struct resource_list *rl = &ndev->nx_resources;
395 /* XXX this should return a success/failure indicator */
396 resource_list_add(rl, type, rid, start, start + count - 1, count);
403 nexus_deactivate_resource(device_t bus, device_t child, int type, int rid,
407 bus_space_handle_t vaddr;
409 if (type == SYS_RES_MEMORY || type == SYS_RES_IOPORT) {
410 psize = (bus_size_t)rman_get_size(r);
411 vaddr = rman_get_bushandle(r);
414 bus_space_unmap(&memmap_bus, vaddr, psize);
415 rman_set_virtual(r, NULL);
416 rman_set_bushandle(r, 0);
418 } else if (type == SYS_RES_IRQ) {
419 intr_deactivate_irq(child, r);
422 return (rman_deactivate_resource(r));
426 static device_method_t nexus_fdt_methods[] = {
427 /* Device interface */
428 DEVMETHOD(device_probe, nexus_fdt_probe),
429 DEVMETHOD(device_attach, nexus_fdt_attach),
432 DEVMETHOD(ofw_bus_map_intr, nexus_ofw_map_intr),
437 #define nexus_baseclasses nexus_fdt_baseclasses
438 DEFINE_CLASS_1(nexus, nexus_fdt_driver, nexus_fdt_methods, 1, nexus_driver);
439 #undef nexus_baseclasses
440 static devclass_t nexus_fdt_devclass;
442 EARLY_DRIVER_MODULE(nexus_fdt, root, nexus_fdt_driver, nexus_fdt_devclass,
443 0, 0, BUS_PASS_BUS + BUS_PASS_ORDER_FIRST);
446 nexus_fdt_probe(device_t dev)
449 if (arm64_bus_method != ARM64_BUS_FDT)
453 return (BUS_PROBE_DEFAULT);
457 nexus_fdt_attach(device_t dev)
460 nexus_add_child(dev, 10, "ofwbus", 0);
461 return (nexus_attach(dev));
465 nexus_ofw_map_intr(device_t dev, device_t child, phandle_t iparent, int icells,
469 struct intr_map_data_fdt *fdt_data;
472 len = sizeof(*fdt_data) + icells * sizeof(pcell_t);
473 fdt_data = (struct intr_map_data_fdt *)intr_alloc_map_data(
474 INTR_MAP_DATA_FDT, len, M_WAITOK | M_ZERO);
475 fdt_data->iparent = iparent;
476 fdt_data->ncells = icells;
477 memcpy(fdt_data->cells, intr, icells * sizeof(pcell_t));
478 irq = intr_map_irq(NULL, iparent, (struct intr_map_data *)fdt_data);
484 static int nexus_acpi_map_intr(device_t dev, device_t child, u_int irq, int trig, int pol);
486 static device_method_t nexus_acpi_methods[] = {
487 /* Device interface */
488 DEVMETHOD(device_probe, nexus_acpi_probe),
489 DEVMETHOD(device_attach, nexus_acpi_attach),
492 DEVMETHOD(acpi_bus_map_intr, nexus_acpi_map_intr),
497 #define nexus_baseclasses nexus_acpi_baseclasses
498 DEFINE_CLASS_1(nexus, nexus_acpi_driver, nexus_acpi_methods, 1,
500 #undef nexus_baseclasses
501 static devclass_t nexus_acpi_devclass;
503 EARLY_DRIVER_MODULE(nexus_acpi, root, nexus_acpi_driver, nexus_acpi_devclass,
504 0, 0, BUS_PASS_BUS + BUS_PASS_ORDER_FIRST);
507 nexus_acpi_probe(device_t dev)
510 if (arm64_bus_method != ARM64_BUS_ACPI || acpi_identify() != 0)
514 return (BUS_PROBE_LOW_PRIORITY);
518 nexus_acpi_attach(device_t dev)
521 nexus_add_child(dev, 10, "acpi", 0);
522 return (nexus_attach(dev));
526 nexus_acpi_map_intr(device_t dev, device_t child, u_int irq, int trig, int pol)
528 struct intr_map_data_acpi *acpi_data;
531 len = sizeof(*acpi_data);
532 acpi_data = (struct intr_map_data_acpi *)intr_alloc_map_data(
533 INTR_MAP_DATA_ACPI, len, M_WAITOK | M_ZERO);
534 acpi_data->irq = irq;
535 acpi_data->pol = pol;
536 acpi_data->trig = trig;
539 * TODO: This will only handle a single interrupt controller.
540 * ACPI will map multiple controllers into a single virtual IRQ
541 * space. Each controller has a System Vector Base to hold the
542 * first irq it handles in this space. As such the correct way
543 * to handle interrupts with ACPI is to search through the
544 * controllers for the largest base value that is no larger than
547 irq = intr_map_irq(NULL, ACPI_INTR_XREF,
548 (struct intr_map_data *)acpi_data);