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 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>
52 #include <machine/bus.h>
54 #include <sys/interrupt.h>
56 #include <machine/machdep.h>
57 #include <machine/vmparam.h>
58 #include <machine/pcb.h>
62 #include <machine/resource.h>
63 #include <machine/intr.h>
66 #include <dev/ofw/ofw_bus_subr.h>
67 #include <dev/ofw/ofw_bus.h>
68 #include <dev/ofw/openfirm.h>
69 #include "ofw_bus_if.h"
72 #include <contrib/dev/acpica/include/acpi.h>
73 #include <dev/acpica/acpivar.h>
74 #include "acpi_bus_if.h"
78 extern struct bus_space memmap_bus;
80 static MALLOC_DEFINE(M_NEXUSDEV, "nexusdev", "Nexus device");
83 struct resource_list nx_resources;
86 #define DEVTONX(dev) ((struct nexus_device *)device_get_ivars(dev))
88 static struct rman mem_rman;
89 static struct rman irq_rman;
91 static int nexus_attach(device_t);
94 static device_probe_t nexus_fdt_probe;
95 static device_attach_t nexus_fdt_attach;
96 static bus_activate_resource_t nexus_fdt_activate_resource;
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_adjust_resource(device_t, device_t, int, struct resource *,
110 rman_res_t, rman_res_t);
111 static int nexus_map_resource(device_t, device_t, int, struct resource *,
112 struct resource_map_request *, struct resource_map *);
113 static int nexus_config_intr(device_t dev, int irq, enum intr_trigger trig,
114 enum intr_polarity pol);
115 static struct resource_list *nexus_get_reslist(device_t, device_t);
116 static int nexus_set_resource(device_t, device_t, int, int,
117 rman_res_t, rman_res_t);
118 static int nexus_deactivate_resource(device_t, device_t, int, int,
120 static int nexus_release_resource(device_t, device_t, int, int,
123 static int nexus_setup_intr(device_t dev, device_t child, struct resource *res,
124 int flags, driver_filter_t *filt, driver_intr_t *intr, void *arg, void **cookiep);
125 static int nexus_teardown_intr(device_t, device_t, struct resource *, void *);
126 static bus_space_tag_t nexus_get_bus_tag(device_t, device_t);
128 static int nexus_bind_intr(device_t, device_t, struct resource *, int);
132 static int nexus_ofw_map_intr(device_t dev, device_t child, phandle_t iparent,
133 int icells, pcell_t *intr);
136 static device_method_t nexus_methods[] = {
138 DEVMETHOD(bus_print_child, nexus_print_child),
139 DEVMETHOD(bus_add_child, nexus_add_child),
140 DEVMETHOD(bus_alloc_resource, nexus_alloc_resource),
141 DEVMETHOD(bus_activate_resource, nexus_activate_resource),
142 DEVMETHOD(bus_adjust_resource, nexus_adjust_resource),
143 DEVMETHOD(bus_map_resource, nexus_map_resource),
144 DEVMETHOD(bus_config_intr, nexus_config_intr),
145 DEVMETHOD(bus_get_resource_list, nexus_get_reslist),
146 DEVMETHOD(bus_set_resource, nexus_set_resource),
147 DEVMETHOD(bus_deactivate_resource, nexus_deactivate_resource),
148 DEVMETHOD(bus_release_resource, nexus_release_resource),
149 DEVMETHOD(bus_setup_intr, nexus_setup_intr),
150 DEVMETHOD(bus_teardown_intr, nexus_teardown_intr),
151 DEVMETHOD(bus_get_bus_tag, nexus_get_bus_tag),
153 DEVMETHOD(bus_bind_intr, nexus_bind_intr),
158 static driver_t nexus_driver = {
165 nexus_attach(device_t dev)
168 mem_rman.rm_start = 0;
169 mem_rman.rm_end = BUS_SPACE_MAXADDR;
170 mem_rman.rm_type = RMAN_ARRAY;
171 mem_rman.rm_descr = "I/O memory addresses";
172 if (rman_init(&mem_rman) ||
173 rman_manage_region(&mem_rman, 0, BUS_SPACE_MAXADDR))
174 panic("nexus_attach mem_rman");
175 irq_rman.rm_start = 0;
176 irq_rman.rm_end = ~0;
177 irq_rman.rm_type = RMAN_ARRAY;
178 irq_rman.rm_descr = "Interrupts";
179 if (rman_init(&irq_rman) || rman_manage_region(&irq_rman, 0, ~0))
180 panic("nexus_attach irq_rman");
182 bus_generic_probe(dev);
183 bus_generic_attach(dev);
189 nexus_print_child(device_t bus, device_t child)
193 retval += bus_print_child_header(bus, child);
194 retval += printf("\n");
200 nexus_add_child(device_t bus, u_int order, const char *name, int unit)
203 struct nexus_device *ndev;
205 ndev = malloc(sizeof(struct nexus_device), M_NEXUSDEV, M_NOWAIT|M_ZERO);
208 resource_list_init(&ndev->nx_resources);
210 child = device_add_child_ordered(bus, order, name, unit);
212 /* should we free this in nexus_child_detached? */
213 device_set_ivars(child, ndev);
219 * Allocate a resource on behalf of child. NB: child is usually going to be a
220 * child of one of our descendants, not a direct child of nexus0.
221 * (Exceptions include footbridge.)
223 static struct resource *
224 nexus_alloc_resource(device_t bus, device_t child, int type, int *rid,
225 rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
227 struct nexus_device *ndev = DEVTONX(child);
229 struct resource_list_entry *rle;
231 int needactivate = flags & RF_ACTIVE;
234 * If this is an allocation of the "default" range for a given
235 * RID, and we know what the resources for this device are
236 * (ie. they aren't maintained by a child bus), then work out
237 * the start/end values.
239 if (RMAN_IS_DEFAULT_RANGE(start, end) && (count == 1)) {
240 if (device_get_parent(child) != bus || ndev == NULL)
242 rle = resource_list_find(&ndev->nx_resources, type, *rid);
264 rv = rman_reserve_resource(rm, start, end, count, flags, child);
268 rman_set_rid(rv, *rid);
269 rman_set_bushandle(rv, rman_get_start(rv));
272 if (bus_activate_resource(child, type, *rid, rv)) {
273 rman_release_resource(rv);
282 nexus_adjust_resource(device_t bus __unused, device_t child __unused, int type,
283 struct resource *r, rman_res_t start, rman_res_t end)
297 if (rman_is_region_manager(r, rm) == 0)
299 return (rman_adjust_resource(r, start, end));
303 nexus_release_resource(device_t bus, device_t child, int type, int rid,
304 struct resource *res)
308 if (rman_get_flags(res) & RF_ACTIVE) {
309 error = bus_deactivate_resource(child, type, rid, res);
313 return (rman_release_resource(res));
317 nexus_config_intr(device_t dev, int irq, enum intr_trigger trig,
318 enum intr_polarity pol)
322 * On arm64 (due to INTRNG), ACPI interrupt configuration is
323 * done in nexus_acpi_map_intr().
329 nexus_setup_intr(device_t dev, device_t child, struct resource *res, int flags,
330 driver_filter_t *filt, driver_intr_t *intr, void *arg, void **cookiep)
334 if ((rman_get_flags(res) & RF_SHAREABLE) == 0)
337 /* We depend here on rman_activate_resource() being idempotent. */
338 error = rman_activate_resource(res);
342 error = intr_setup_irq(child, res, filt, intr, arg, flags, cookiep);
348 nexus_teardown_intr(device_t dev, device_t child, struct resource *r, void *ih)
351 return (intr_teardown_irq(child, r, ih));
356 nexus_bind_intr(device_t dev, device_t child, struct resource *irq, int cpu)
359 return (intr_bind_irq(child, irq, cpu));
363 static bus_space_tag_t
364 nexus_get_bus_tag(device_t bus __unused, device_t child __unused)
371 nexus_activate_resource_flags(device_t bus, device_t child, int type, int rid,
372 struct resource *r, int flags)
374 struct resource_map_request args;
375 struct resource_map map;
378 if ((err = rman_activate_resource(r)) != 0)
382 * If this is a memory resource, map it into the kernel.
387 if ((rman_get_flags(r) & RF_UNMAPPED) == 0) {
388 resource_init_map_request(&args);
389 if ((flags & BUS_SPACE_MAP_NONPOSTED) != 0)
390 args.memattr = VM_MEMATTR_DEVICE_NP;
391 err = nexus_map_resource(bus, child, type, r, &args,
394 rman_deactivate_resource(r);
398 rman_set_mapping(r, &map);
402 err = intr_activate_irq(child, r);
404 rman_deactivate_resource(r);
412 nexus_activate_resource(device_t dev, device_t child, int type, int rid,
415 return (nexus_activate_resource_flags(dev, child, type, rid, r, 0));
418 static struct resource_list *
419 nexus_get_reslist(device_t dev, device_t child)
421 struct nexus_device *ndev = DEVTONX(child);
423 return (&ndev->nx_resources);
427 nexus_set_resource(device_t dev, device_t child, int type, int rid,
428 rman_res_t start, rman_res_t count)
430 struct nexus_device *ndev = DEVTONX(child);
431 struct resource_list *rl = &ndev->nx_resources;
433 /* XXX this should return a success/failure indicator */
434 resource_list_add(rl, type, rid, start, start + count - 1, count);
440 nexus_deactivate_resource(device_t bus, device_t child, int type, int rid,
444 bus_space_handle_t vaddr;
446 if (type == SYS_RES_MEMORY || type == SYS_RES_IOPORT) {
447 psize = (bus_size_t)rman_get_size(r);
448 vaddr = rman_get_bushandle(r);
451 bus_space_unmap(&memmap_bus, vaddr, psize);
452 rman_set_virtual(r, NULL);
453 rman_set_bushandle(r, 0);
455 } else if (type == SYS_RES_IRQ) {
456 intr_deactivate_irq(child, r);
459 return (rman_deactivate_resource(r));
463 nexus_map_resource(device_t bus, device_t child, int type, struct resource *r,
464 struct resource_map_request *argsp, struct resource_map *map)
466 struct resource_map_request args;
467 rman_res_t end, length, start;
469 /* Resources must be active to be mapped. */
470 if ((rman_get_flags(r) & RF_ACTIVE) == 0)
473 /* Mappings are only supported on I/O and memory resources. */
482 resource_init_map_request(&args);
484 bcopy(argsp, &args, imin(argsp->size, args.size));
485 start = rman_get_start(r) + args.offset;
486 if (args.length == 0)
487 length = rman_get_size(r);
489 length = args.length;
490 end = start + length - 1;
491 if (start > rman_get_end(r) || start < rman_get_start(r))
493 if (end > rman_get_end(r) || end < start)
496 map->r_vaddr = pmap_mapdev_attr(start, length, args.memattr);
497 map->r_bustag = &memmap_bus;
498 map->r_size = length;
501 * The handle is the virtual address.
503 map->r_bushandle = (bus_space_handle_t)map->r_vaddr;
508 static device_method_t nexus_fdt_methods[] = {
509 /* Device interface */
510 DEVMETHOD(device_probe, nexus_fdt_probe),
511 DEVMETHOD(device_attach, nexus_fdt_attach),
514 DEVMETHOD(bus_activate_resource, nexus_fdt_activate_resource),
517 DEVMETHOD(ofw_bus_map_intr, nexus_ofw_map_intr),
522 #define nexus_baseclasses nexus_fdt_baseclasses
523 DEFINE_CLASS_1(nexus, nexus_fdt_driver, nexus_fdt_methods, 1, nexus_driver);
524 #undef nexus_baseclasses
526 EARLY_DRIVER_MODULE(nexus_fdt, root, nexus_fdt_driver, 0, 0,
527 BUS_PASS_BUS + BUS_PASS_ORDER_FIRST);
530 nexus_fdt_probe(device_t dev)
533 if (arm64_bus_method != ARM64_BUS_FDT)
537 return (BUS_PROBE_DEFAULT);
541 nexus_fdt_attach(device_t dev)
544 nexus_add_child(dev, 10, "ofwbus", 0);
545 return (nexus_attach(dev));
549 nexus_fdt_activate_resource(device_t bus, device_t child, int type, int rid,
552 phandle_t node, parent;
560 * If the fdt parent has the nonposted-mmio property we
561 * need to use non-posted IO to access the device. When
562 * we find this property set the BUS_SPACE_MAP_NONPOSTED
563 * flag to be passed to bus_space_map.
565 node = ofw_bus_get_node(child);
567 parent = OF_parent(node);
569 OF_hasprop(parent, "nonposted-mmio")) {
570 flags |= BUS_SPACE_MAP_NONPOSTED;
578 return (nexus_activate_resource_flags(bus, child, type, rid, r, flags));
582 nexus_ofw_map_intr(device_t dev, device_t child, phandle_t iparent, int icells,
586 struct intr_map_data_fdt *fdt_data;
589 len = sizeof(*fdt_data) + icells * sizeof(pcell_t);
590 fdt_data = (struct intr_map_data_fdt *)intr_alloc_map_data(
591 INTR_MAP_DATA_FDT, len, M_WAITOK | M_ZERO);
592 fdt_data->iparent = iparent;
593 fdt_data->ncells = icells;
594 memcpy(fdt_data->cells, intr, icells * sizeof(pcell_t));
595 irq = intr_map_irq(NULL, iparent, (struct intr_map_data *)fdt_data);
601 static int nexus_acpi_map_intr(device_t dev, device_t child, u_int irq, int trig, int pol);
603 static device_method_t nexus_acpi_methods[] = {
604 /* Device interface */
605 DEVMETHOD(device_probe, nexus_acpi_probe),
606 DEVMETHOD(device_attach, nexus_acpi_attach),
609 DEVMETHOD(acpi_bus_map_intr, nexus_acpi_map_intr),
614 #define nexus_baseclasses nexus_acpi_baseclasses
615 DEFINE_CLASS_1(nexus, nexus_acpi_driver, nexus_acpi_methods, 1,
617 #undef nexus_baseclasses
619 EARLY_DRIVER_MODULE(nexus_acpi, root, nexus_acpi_driver, 0, 0,
620 BUS_PASS_BUS + BUS_PASS_ORDER_FIRST);
623 nexus_acpi_probe(device_t dev)
626 if (arm64_bus_method != ARM64_BUS_ACPI || acpi_identify() != 0)
630 return (BUS_PROBE_LOW_PRIORITY);
634 nexus_acpi_attach(device_t dev)
637 nexus_add_child(dev, 10, "acpi", 0);
638 return (nexus_attach(dev));
642 nexus_acpi_map_intr(device_t dev, device_t child, u_int irq, int trig, int pol)
644 struct intr_map_data_acpi *acpi_data;
647 len = sizeof(*acpi_data);
648 acpi_data = (struct intr_map_data_acpi *)intr_alloc_map_data(
649 INTR_MAP_DATA_ACPI, len, M_WAITOK | M_ZERO);
650 acpi_data->irq = irq;
651 acpi_data->pol = pol;
652 acpi_data->trig = trig;
655 * TODO: This will only handle a single interrupt controller.
656 * ACPI will map multiple controllers into a single virtual IRQ
657 * space. Each controller has a System Vector Base to hold the
658 * first irq it handles in this space. As such the correct way
659 * to handle interrupts with ACPI is to search through the
660 * controllers for the largest base value that is no larger than
663 irq = intr_map_irq(NULL, ACPI_INTR_XREF,
664 (struct intr_map_data *)acpi_data);