2 * Copyright (c) 2015 The FreeBSD Foundation
4 * This software was developed by Semihalf under
5 * the sponsorship of the FreeBSD Foundation.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
32 #include <sys/param.h>
33 #include <sys/systm.h>
34 #include <sys/bitstring.h>
36 #include <sys/kernel.h>
37 #include <sys/module.h>
40 #include <machine/intr.h>
41 #include <machine/resource.h>
43 #include <dev/ofw/openfirm.h>
44 #include <dev/ofw/ofw_bus.h>
45 #include <dev/ofw/ofw_bus_subr.h>
47 #include <arm/arm/gic_common.h>
48 #include "gic_v3_reg.h"
49 #include "gic_v3_var.h"
54 static int gic_v3_fdt_probe(device_t);
55 static int gic_v3_fdt_attach(device_t);
57 static struct resource *gic_v3_ofw_bus_alloc_res(device_t, device_t, int, int *,
58 rman_res_t, rman_res_t, rman_res_t, u_int);
59 static const struct ofw_bus_devinfo *gic_v3_ofw_get_devinfo(device_t, device_t);
60 static bus_get_resource_list_t gic_v3_fdt_get_resource_list;
62 static device_method_t gic_v3_fdt_methods[] = {
63 /* Device interface */
64 DEVMETHOD(device_probe, gic_v3_fdt_probe),
65 DEVMETHOD(device_attach, gic_v3_fdt_attach),
68 DEVMETHOD(bus_alloc_resource, gic_v3_ofw_bus_alloc_res),
69 DEVMETHOD(bus_activate_resource, bus_generic_activate_resource),
70 DEVMETHOD(bus_get_resource_list, gic_v3_fdt_get_resource_list),
72 /* ofw_bus interface */
73 DEVMETHOD(ofw_bus_get_devinfo, gic_v3_ofw_get_devinfo),
74 DEVMETHOD(ofw_bus_get_compat, ofw_bus_gen_get_compat),
75 DEVMETHOD(ofw_bus_get_model, ofw_bus_gen_get_model),
76 DEVMETHOD(ofw_bus_get_name, ofw_bus_gen_get_name),
77 DEVMETHOD(ofw_bus_get_node, ofw_bus_gen_get_node),
78 DEVMETHOD(ofw_bus_get_type, ofw_bus_gen_get_type),
84 DEFINE_CLASS_1(gic, gic_v3_fdt_driver, gic_v3_fdt_methods,
85 sizeof(struct gic_v3_softc), gic_v3_driver);
87 static devclass_t gic_v3_fdt_devclass;
89 EARLY_DRIVER_MODULE(gic_v3, simplebus, gic_v3_fdt_driver, gic_v3_fdt_devclass,
90 0, 0, BUS_PASS_INTERRUPT + BUS_PASS_ORDER_MIDDLE);
91 EARLY_DRIVER_MODULE(gic_v3, ofwbus, gic_v3_fdt_driver, gic_v3_fdt_devclass,
92 0, 0, BUS_PASS_INTERRUPT + BUS_PASS_ORDER_MIDDLE);
95 * Helper functions declarations.
97 static int gic_v3_ofw_bus_attach(device_t);
103 gic_v3_fdt_probe(device_t dev)
106 if (!ofw_bus_status_okay(dev))
109 if (!ofw_bus_is_compatible(dev, "arm,gic-v3"))
112 device_set_desc(dev, GIC_V3_DEVSTR);
113 return (BUS_PROBE_DEFAULT);
117 gic_v3_fdt_attach(device_t dev)
119 struct gic_v3_softc *sc;
120 pcell_t redist_regions;
123 uint32_t *mbi_ranges;
126 sc = device_get_softc(dev);
128 sc->gic_bus = GIC_BUS_FDT;
131 * Recover number of the Re-Distributor regions.
133 if (OF_getencprop(ofw_bus_get_node(dev), "#redistributor-regions",
134 &redist_regions, sizeof(redist_regions)) <= 0)
135 sc->gic_redists.nregions = 1;
137 sc->gic_redists.nregions = redist_regions;
139 /* Add Message Based Interrupts using SPIs. */
140 ret = OF_getencprop_alloc_multi(ofw_bus_get_node(dev), "mbi-ranges",
141 sizeof(*mbi_ranges), (void **)&mbi_ranges);
144 /* Limit to a single range for now. */
145 sc->gic_mbi_start = mbi_ranges[0];
146 sc->gic_mbi_end = mbi_ranges[0] + mbi_ranges[1] - 1;
149 device_printf(dev, "Malformed mbi-ranges property\n");
151 free(mbi_ranges, M_OFWPROP);
154 err = gic_v3_attach(dev);
158 xref = OF_xref_from_node(ofw_bus_get_node(dev));
159 sc->gic_pic = intr_pic_register(dev, xref);
160 if (sc->gic_pic == NULL) {
161 device_printf(dev, "could not register PIC\n");
166 if (sc->gic_mbi_start > 0)
167 intr_msi_register(dev, xref);
170 OF_device_register_xref(xref, dev);
172 if (intr_pic_claim_root(dev, xref, arm_gic_v3_intr, sc,
173 GIC_LAST_SGI - GIC_FIRST_SGI + 1) != 0) {
179 * Try to register ITS to this GIC.
180 * GIC will act as a bus in that case.
181 * Failure here will not affect main GIC functionality.
183 if (gic_v3_ofw_bus_attach(dev) != 0) {
186 "Failed to attach ITS to this GIC\n");
190 if (device_get_children(dev, &sc->gic_children, &sc->gic_nchildren) != 0)
191 sc->gic_nchildren = 0;
198 "Failed to attach. Error %d\n", err);
200 /* Failure so free resources */
206 /* OFW bus interface */
207 struct gic_v3_ofw_devinfo {
208 struct gic_v3_devinfo di_gic_dinfo;
209 struct ofw_bus_devinfo di_dinfo;
210 struct resource_list di_rl;
213 static const struct ofw_bus_devinfo *
214 gic_v3_ofw_get_devinfo(device_t bus __unused, device_t child)
216 struct gic_v3_ofw_devinfo *di;
218 di = device_get_ivars(child);
219 return (&di->di_dinfo);
222 static struct resource *
223 gic_v3_ofw_bus_alloc_res(device_t bus, device_t child, int type, int *rid,
224 rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
226 struct resource_list_entry *rle;
227 struct resource_list *rl;
230 /* We only allocate memory */
231 if (type != SYS_RES_MEMORY)
234 if (RMAN_IS_DEFAULT_RANGE(start, end)) {
235 rl = BUS_GET_RESOURCE_LIST(bus, child);
239 /* Find defaults for this rid */
240 rle = resource_list_find(rl, type, *rid);
249 * XXX: No ranges remap!
250 * Absolute address is expected.
252 if (ofw_bus_has_prop(bus, "ranges")) {
253 ranges_len = OF_getproplen(ofw_bus_get_node(bus), "ranges");
254 if (ranges_len != 0) {
257 "Ranges remap not supported\n");
262 return (bus_generic_alloc_resource(bus, child, type, rid, start, end,
266 /* Helper functions */
269 * Bus capability support for GICv3.
270 * Collects and configures device informations and finally
271 * adds ITS device as a child of GICv3 in Newbus hierarchy.
274 gic_v3_ofw_bus_attach(device_t dev)
276 struct gic_v3_ofw_devinfo *di;
277 struct gic_v3_softc *sc;
279 phandle_t parent, node;
280 pcell_t addr_cells, size_cells;
282 sc = device_get_softc(dev);
283 parent = ofw_bus_get_node(dev);
286 OF_getencprop(parent, "#address-cells", &addr_cells,
289 OF_getencprop(parent, "#size-cells", &size_cells,
291 /* Iterate through all GIC subordinates */
292 for (node = OF_child(parent); node > 0; node = OF_peer(node)) {
294 * Ignore children that lack a compatible property.
295 * Some of them may be for configuration, for example
298 if (!OF_hasprop(node, "compatible"))
301 /* Allocate and populate devinfo. */
302 di = malloc(sizeof(*di), M_GIC_V3, M_WAITOK | M_ZERO);
304 /* Read the numa node, or -1 if there is none */
305 if (OF_getencprop(node, "numa-node-id",
306 &di->di_gic_dinfo.gic_domain,
307 sizeof(di->di_gic_dinfo.gic_domain)) <= 0) {
308 di->di_gic_dinfo.gic_domain = -1;
311 if (ofw_bus_gen_setup_devinfo(&di->di_dinfo, node)) {
314 "Could not set up devinfo for ITS\n");
320 /* Initialize and populate resource list. */
321 resource_list_init(&di->di_rl);
322 ofw_bus_reg_to_rl(dev, node, addr_cells, size_cells,
325 /* Should not have any interrupts, so don't add any */
327 /* Add newbus device for this FDT node */
328 child = device_add_child(dev, NULL, -1);
332 "Could not add child: %s\n",
333 di->di_dinfo.obd_name);
335 resource_list_free(&di->di_rl);
336 ofw_bus_gen_destroy_devinfo(&di->di_dinfo);
342 device_set_ivars(child, di);
346 return (bus_generic_attach(dev));
349 static struct resource_list *
350 gic_v3_fdt_get_resource_list(device_t bus, device_t child)
352 struct gic_v3_ofw_devinfo *di;
354 di = device_get_ivars(child);
355 KASSERT(di != NULL, ("%s: No devinfo", __func__));