2 * Copyright (c) 2016 The FreeBSD Foundation
5 * This software was developed by Andrew Turner under
6 * the sponsorship of the FreeBSD Foundation.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 #include <sys/cdefs.h>
33 __FBSDID("$FreeBSD$");
35 #include <sys/types.h>
36 #include <sys/systm.h>
38 #include <sys/kernel.h>
39 #include <sys/malloc.h>
40 #include <sys/module.h>
43 #include <machine/intr.h>
44 #include <machine/resource.h>
46 #include <contrib/dev/acpica/include/acpi.h>
47 #include <dev/acpica/acpivar.h>
49 #include "gic_v3_reg.h"
50 #include "gic_v3_var.h"
52 struct gic_v3_acpi_devinfo {
53 struct gic_v3_devinfo di_gic_dinfo;
54 struct resource_list di_rl;
57 static device_identify_t gic_v3_acpi_identify;
58 static device_probe_t gic_v3_acpi_probe;
59 static device_attach_t gic_v3_acpi_attach;
60 static bus_alloc_resource_t gic_v3_acpi_bus_alloc_res;
62 static void gic_v3_acpi_bus_attach(device_t);
64 static device_method_t gic_v3_acpi_methods[] = {
65 /* Device interface */
66 DEVMETHOD(device_identify, gic_v3_acpi_identify),
67 DEVMETHOD(device_probe, gic_v3_acpi_probe),
68 DEVMETHOD(device_attach, gic_v3_acpi_attach),
71 DEVMETHOD(bus_alloc_resource, gic_v3_acpi_bus_alloc_res),
72 DEVMETHOD(bus_activate_resource, bus_generic_activate_resource),
78 DEFINE_CLASS_1(gic, gic_v3_acpi_driver, gic_v3_acpi_methods,
79 sizeof(struct gic_v3_softc), gic_v3_driver);
81 static devclass_t gic_v3_acpi_devclass;
83 EARLY_DRIVER_MODULE(gic_v3, acpi, gic_v3_acpi_driver, gic_v3_acpi_devclass,
84 0, 0, BUS_PASS_INTERRUPT + BUS_PASS_ORDER_MIDDLE);
87 struct madt_table_data {
90 ACPI_MADT_GENERIC_DISTRIBUTOR *dist;
95 madt_handler(ACPI_SUBTABLE_HEADER *entry, void *arg)
97 struct madt_table_data *madt_data;
99 madt_data = (struct madt_table_data *)arg;
101 switch(entry->Type) {
102 case ACPI_MADT_TYPE_GENERIC_DISTRIBUTOR:
103 if (madt_data->dist != NULL) {
105 device_printf(madt_data->parent,
106 "gic: Already have a distributor table");
109 madt_data->dist = (ACPI_MADT_GENERIC_DISTRIBUTOR *)entry;
112 case ACPI_MADT_TYPE_GENERIC_REDISTRIBUTOR:
121 rdist_map(ACPI_SUBTABLE_HEADER *entry, void *arg)
123 ACPI_MADT_GENERIC_REDISTRIBUTOR *redist;
124 struct madt_table_data *madt_data;
126 madt_data = (struct madt_table_data *)arg;
128 switch(entry->Type) {
129 case ACPI_MADT_TYPE_GENERIC_REDISTRIBUTOR:
130 redist = (ACPI_MADT_GENERIC_REDISTRIBUTOR *)entry;
133 BUS_SET_RESOURCE(madt_data->parent, madt_data->dev,
134 SYS_RES_MEMORY, madt_data->count, redist->BaseAddress,
144 gic_v3_acpi_identify(driver_t *driver, device_t parent)
146 struct madt_table_data madt_data;
147 ACPI_TABLE_MADT *madt;
151 physaddr = acpi_find_table(ACPI_SIG_MADT);
155 madt = acpi_map_table(physaddr, ACPI_SIG_MADT);
157 device_printf(parent, "gic: Unable to map the MADT\n");
161 madt_data.parent = parent;
162 madt_data.dist = NULL;
165 acpi_walk_subtables(madt + 1, (char *)madt + madt->Header.Length,
166 madt_handler, &madt_data);
167 if (madt_data.dist == NULL) {
168 device_printf(parent,
169 "No gic interrupt or distributor table\n");
172 /* This is for the wrong GIC version */
173 if (madt_data.dist->Version != ACPI_MADT_GIC_VERSION_V3)
176 dev = BUS_ADD_CHILD(parent, BUS_PASS_INTERRUPT + BUS_PASS_ORDER_MIDDLE,
179 device_printf(parent, "add gic child failed\n");
183 /* Add the MADT data */
184 BUS_SET_RESOURCE(parent, dev, SYS_RES_MEMORY, 0,
185 madt_data.dist->BaseAddress, 128 * 1024);
188 acpi_walk_subtables(madt + 1, (char *)madt + madt->Header.Length,
189 rdist_map, &madt_data);
191 acpi_set_private(dev, (void *)(uintptr_t)madt_data.dist->Version);
194 acpi_unmap_table(madt);
198 gic_v3_acpi_probe(device_t dev)
201 switch((uintptr_t)acpi_get_private(dev)) {
202 case ACPI_MADT_GIC_VERSION_V3:
208 device_set_desc(dev, GIC_V3_DEVSTR);
209 return (BUS_PROBE_NOWILDCARD);
213 madt_count_redistrib(ACPI_SUBTABLE_HEADER *entry, void *arg)
215 struct gic_v3_softc *sc = arg;
217 if (entry->Type == ACPI_MADT_TYPE_GENERIC_REDISTRIBUTOR)
218 sc->gic_redists.nregions++;
222 gic_v3_acpi_count_regions(device_t dev)
224 struct gic_v3_softc *sc;
225 ACPI_TABLE_MADT *madt;
228 sc = device_get_softc(dev);
230 physaddr = acpi_find_table(ACPI_SIG_MADT);
234 madt = acpi_map_table(physaddr, ACPI_SIG_MADT);
236 device_printf(dev, "Unable to map the MADT\n");
240 acpi_walk_subtables(madt + 1, (char *)madt + madt->Header.Length,
241 madt_count_redistrib, sc);
242 acpi_unmap_table(madt);
244 return (sc->gic_redists.nregions > 0 ? 0 : ENXIO);
248 gic_v3_acpi_attach(device_t dev)
250 struct gic_v3_softc *sc;
253 sc = device_get_softc(dev);
255 sc->gic_bus = GIC_BUS_ACPI;
257 err = gic_v3_acpi_count_regions(dev);
261 err = gic_v3_attach(dev);
265 sc->gic_pic = intr_pic_register(dev, ACPI_INTR_XREF);
266 if (sc->gic_pic == NULL) {
267 device_printf(dev, "could not register PIC\n");
272 if (intr_pic_claim_root(dev, ACPI_INTR_XREF, arm_gic_v3_intr, sc,
273 GIC_LAST_SGI - GIC_FIRST_SGI + 1) != 0) {
279 * Try to register the ITS driver to this GIC. The GIC will act as
280 * a bus in that case. Failure here will not affect the main GIC
283 gic_v3_acpi_bus_attach(dev);
285 if (device_get_children(dev, &sc->gic_children, &sc->gic_nchildren) !=0)
286 sc->gic_nchildren = 0;
293 "Failed to attach. Error %d\n", err);
295 /* Failure so free resources */
302 gic_v3_add_children(ACPI_SUBTABLE_HEADER *entry, void *arg)
304 ACPI_MADT_GENERIC_TRANSLATOR *gict;
305 struct gic_v3_acpi_devinfo *di;
306 struct gic_v3_softc *sc;
309 if (entry->Type == ACPI_MADT_TYPE_GENERIC_TRANSLATOR) {
310 /* We have an ITS, add it as a child */
311 gict = (ACPI_MADT_GENERIC_TRANSLATOR *)entry;
313 sc = device_get_softc(dev);
315 child = device_add_child(dev, "its", -1);
319 di = malloc(sizeof(*di), M_GIC_V3, M_WAITOK | M_ZERO);
320 resource_list_init(&di->di_rl);
321 resource_list_add(&di->di_rl, SYS_RES_MEMORY, 0,
322 gict->BaseAddress, gict->BaseAddress + 128 * 1024 - 1,
324 di->di_gic_dinfo.gic_domain = -1;
326 device_set_ivars(child, di);
331 gic_v3_acpi_bus_attach(device_t dev)
333 ACPI_TABLE_MADT *madt;
336 physaddr = acpi_find_table(ACPI_SIG_MADT);
340 madt = acpi_map_table(physaddr, ACPI_SIG_MADT);
342 device_printf(dev, "Unable to map the MADT to add children\n");
346 acpi_walk_subtables(madt + 1, (char *)madt + madt->Header.Length,
347 gic_v3_add_children, dev);
349 acpi_unmap_table(madt);
351 bus_generic_attach(dev);
354 static struct resource *
355 gic_v3_acpi_bus_alloc_res(device_t bus, device_t child, int type, int *rid,
356 rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
358 struct gic_v3_acpi_devinfo *di;
359 struct resource_list_entry *rle;
361 /* We only allocate memory */
362 if (type != SYS_RES_MEMORY)
365 if (RMAN_IS_DEFAULT_RANGE(start, end)) {
366 if ((di = device_get_ivars(child)) == NULL)
369 /* Find defaults for this rid */
370 rle = resource_list_find(&di->di_rl, type, *rid);
379 return (bus_generic_alloc_resource(bus, child, type, rid, start, end,