sys/arm64/arm64/gic_v3_fdt.c

   1 /*-
   2  * Copyright (c) 2015 The FreeBSD Foundation
   3  *
   4  * This software was developed by Semihalf under
   5  * the sponsorship of the FreeBSD Foundation.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  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.
  15  *
  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
  26  * SUCH DAMAGE.
  27  */
  28
  29 #include <sys/cdefs.h>
  30 #include <sys/param.h>
  31 #include <sys/systm.h>
  32 #include <sys/bitstring.h>
  33 #include <sys/bus.h>
  34 #include <sys/kernel.h>
  35 #include <sys/module.h>
  36 #include <sys/rman.h>
  37
  38 #include <machine/intr.h>
  39 #include <machine/resource.h>
  40
  41 #include <dev/ofw/openfirm.h>
  42 #include <dev/ofw/ofw_bus.h>
  43 #include <dev/ofw/ofw_bus_subr.h>
  44
  45 #include <arm/arm/gic_common.h>
  46 #include "gic_v3_reg.h"
  47 #include "gic_v3_var.h"
  48
  49 /*
  50  * FDT glue.
  51  */
  52 static int gic_v3_fdt_probe(device_t);
  53 static int gic_v3_fdt_attach(device_t);
  54
  55 static const struct ofw_bus_devinfo *gic_v3_ofw_get_devinfo(device_t, device_t);
  56 static bus_get_resource_list_t gic_v3_fdt_get_resource_list;
  57
  58 static device_method_t gic_v3_fdt_methods[] = {
  59         /* Device interface */
  60         DEVMETHOD(device_probe,         gic_v3_fdt_probe),
  61         DEVMETHOD(device_attach,        gic_v3_fdt_attach),
  62
  63         /* Bus interface */
  64         DEVMETHOD(bus_get_resource_list,        gic_v3_fdt_get_resource_list),
  65         DEVMETHOD(bus_get_device_path,  ofw_bus_gen_get_device_path),
  66
  67         /* ofw_bus interface */
  68         DEVMETHOD(ofw_bus_get_devinfo,  gic_v3_ofw_get_devinfo),
  69         DEVMETHOD(ofw_bus_get_compat,   ofw_bus_gen_get_compat),
  70         DEVMETHOD(ofw_bus_get_model,    ofw_bus_gen_get_model),
  71         DEVMETHOD(ofw_bus_get_name,     ofw_bus_gen_get_name),
  72         DEVMETHOD(ofw_bus_get_node,     ofw_bus_gen_get_node),
  73         DEVMETHOD(ofw_bus_get_type,     ofw_bus_gen_get_type),
  74
  75         /* End */
  76         DEVMETHOD_END
  77 };
  78
  79 DEFINE_CLASS_1(gic, gic_v3_fdt_driver, gic_v3_fdt_methods,
  80     sizeof(struct gic_v3_softc), gic_v3_driver);
  81
  82 EARLY_DRIVER_MODULE(gic_v3, simplebus, gic_v3_fdt_driver, 0, 0,
  83     BUS_PASS_INTERRUPT + BUS_PASS_ORDER_MIDDLE);
  84 EARLY_DRIVER_MODULE(gic_v3, ofwbus, gic_v3_fdt_driver, 0, 0,
  85     BUS_PASS_INTERRUPT + BUS_PASS_ORDER_MIDDLE);
  86
  87 /*
  88  * Helper functions declarations.
  89  */
  90 static int gic_v3_ofw_bus_attach(device_t);
  91
  92 /*
  93  * Device interface.
  94  */
  95 static int
  96 gic_v3_fdt_probe(device_t dev)
  97 {
  98
  99         if (!ofw_bus_status_okay(dev))
 100                 return (ENXIO);
 101
 102         if (!ofw_bus_is_compatible(dev, "arm,gic-v3"))
 103                 return (ENXIO);
 104
 105         device_set_desc(dev, GIC_V3_DEVSTR);
 106         return (BUS_PROBE_DEFAULT);
 107 }
 108
 109 static int
 110 gic_v3_fdt_attach(device_t dev)
 111 {
 112         struct gic_v3_softc *sc;
 113         pcell_t redist_regions;
 114         intptr_t xref;
 115         int err;
 116         uint32_t *mbi_ranges;
 117         ssize_t ret;
 118
 119         sc = device_get_softc(dev);
 120         sc->dev = dev;
 121         sc->gic_bus = GIC_BUS_FDT;
 122
 123         /*
 124          * Recover number of the Re-Distributor regions.
 125          */
 126         if (OF_getencprop(ofw_bus_get_node(dev), "#redistributor-regions",
 127             &redist_regions, sizeof(redist_regions)) <= 0)
 128                 sc->gic_redists.nregions = 1;
 129         else
 130                 sc->gic_redists.nregions = redist_regions;
 131
 132         /* Add Message Based Interrupts using SPIs. */
 133         ret = OF_getencprop_alloc_multi(ofw_bus_get_node(dev), "mbi-ranges",
 134             sizeof(*mbi_ranges), (void **)&mbi_ranges);
 135         if (ret > 0) {
 136                 if (ret % 2 == 0) {
 137                         /* Limit to a single range for now. */
 138                         sc->gic_mbi_start = mbi_ranges[0];
 139                         sc->gic_mbi_end = mbi_ranges[0] + mbi_ranges[1];
 140                 } else {
 141                         if (bootverbose)
 142                                 device_printf(dev, "Malformed mbi-ranges property\n");
 143                 }
 144                 free(mbi_ranges, M_OFWPROP);
 145         }
 146
 147         err = gic_v3_attach(dev);
 148         if (err != 0)
 149                 goto error;
 150
 151         xref = OF_xref_from_node(ofw_bus_get_node(dev));
 152         sc->gic_pic = intr_pic_register(dev, xref);
 153         if (sc->gic_pic == NULL) {
 154                 device_printf(dev, "could not register PIC\n");
 155                 err = ENXIO;
 156                 goto error;
 157         }
 158
 159         if (sc->gic_mbi_start > 0)
 160                 intr_msi_register(dev, xref);
 161
 162         /* Register xref */
 163         OF_device_register_xref(xref, dev);
 164
 165         if (intr_pic_claim_root(dev, xref, arm_gic_v3_intr, sc,
 166             GIC_LAST_SGI - GIC_FIRST_SGI + 1) != 0) {
 167                 err = ENXIO;
 168                 goto error;
 169         }
 170
 171         /*
 172          * Try to register ITS to this GIC.
 173          * GIC will act as a bus in that case.
 174          * Failure here will not affect main GIC functionality.
 175          */
 176         if (gic_v3_ofw_bus_attach(dev) != 0) {
 177                 if (bootverbose) {
 178                         device_printf(dev,
 179                             "Failed to attach ITS to this GIC\n");
 180                 }
 181         }
 182
 183         if (device_get_children(dev, &sc->gic_children, &sc->gic_nchildren) != 0)
 184                 sc->gic_nchildren = 0;
 185
 186         return (err);
 187
 188 error:
 189         if (bootverbose) {
 190                 device_printf(dev,
 191                     "Failed to attach. Error %d\n", err);
 192         }
 193         /* Failure so free resources */
 194         gic_v3_detach(dev);
 195
 196         return (err);
 197 }
 198
 199 /* OFW bus interface */
 200 struct gic_v3_ofw_devinfo {
 201         struct gic_v3_devinfo   di_gic_dinfo;
 202         struct ofw_bus_devinfo  di_dinfo;
 203         struct resource_list    di_rl;
 204 };
 205
 206 static const struct ofw_bus_devinfo *
 207 gic_v3_ofw_get_devinfo(device_t bus __unused, device_t child)
 208 {
 209         struct gic_v3_ofw_devinfo *di;
 210
 211         di = device_get_ivars(child);
 212         if (di->di_gic_dinfo.is_vgic)
 213                 return (NULL);
 214         return (&di->di_dinfo);
 215 }
 216
 217 /* Helper functions */
 218 static int
 219 gic_v3_ofw_fill_ranges(phandle_t parent, struct gic_v3_softc *sc,
 220     pcell_t *addr_cellsp, pcell_t *size_cellsp)
 221 {
 222         pcell_t addr_cells, host_cells, size_cells;
 223         cell_t *base_ranges;
 224         ssize_t nbase_ranges;
 225         int i, j, k;
 226
 227         host_cells = 1;
 228         OF_getencprop(OF_parent(parent), "#address-cells", &host_cells,
 229             sizeof(host_cells));
 230         addr_cells = 2;
 231         OF_getencprop(parent, "#address-cells", &addr_cells,
 232             sizeof(addr_cells));
 233         size_cells = 2;
 234         OF_getencprop(parent, "#size-cells", &size_cells,
 235             sizeof(size_cells));
 236
 237         *addr_cellsp = addr_cells;
 238         *size_cellsp = size_cells;
 239
 240         nbase_ranges = OF_getproplen(parent, "ranges");
 241         if (nbase_ranges < 0)
 242                 return (EINVAL);
 243
 244         sc->nranges = nbase_ranges / sizeof(cell_t) /
 245             (addr_cells + host_cells + size_cells);
 246         if (sc->nranges == 0)
 247                 return (0);
 248
 249         sc->ranges = malloc(sc->nranges * sizeof(sc->ranges[0]), M_GIC_V3,
 250             M_WAITOK);
 251         base_ranges = malloc(nbase_ranges, M_DEVBUF, M_WAITOK);
 252         OF_getencprop(parent, "ranges", base_ranges, nbase_ranges);
 253
 254         for (i = 0, j = 0; i < sc->nranges; i++) {
 255                 sc->ranges[i].bus = 0;
 256                 for (k = 0; k < addr_cells; k++) {
 257                         sc->ranges[i].bus <<= 32;
 258                         sc->ranges[i].bus |= base_ranges[j++];
 259                 }
 260                 sc->ranges[i].host = 0;
 261                 for (k = 0; k < host_cells; k++) {
 262                         sc->ranges[i].host <<= 32;
 263                         sc->ranges[i].host |= base_ranges[j++];
 264                 }
 265                 sc->ranges[i].size = 0;
 266                 for (k = 0; k < size_cells; k++) {
 267                         sc->ranges[i].size <<= 32;
 268                         sc->ranges[i].size |= base_ranges[j++];
 269                 }
 270         }
 271
 272         free(base_ranges, M_DEVBUF);
 273         return (0);
 274 }
 275
 276 /*
 277  * Bus capability support for GICv3.
 278  * Collects and configures device informations and finally
 279  * adds ITS device as a child of GICv3 in Newbus hierarchy.
 280  */
 281 static int
 282 gic_v3_ofw_bus_attach(device_t dev)
 283 {
 284         struct gic_v3_ofw_devinfo *di;
 285         struct gic_v3_softc *sc;
 286         device_t child;
 287         phandle_t parent, node;
 288         pcell_t addr_cells, size_cells;
 289         int rv;
 290
 291         sc = device_get_softc(dev);
 292         parent = ofw_bus_get_node(dev);
 293         if (parent > 0) {
 294                 rv = gic_v3_ofw_fill_ranges(parent, sc, &addr_cells,
 295                     &size_cells);
 296                 if (rv != 0)
 297                         return (rv);
 298
 299                 /* Iterate through all GIC subordinates */
 300                 for (node = OF_child(parent); node > 0; node = OF_peer(node)) {
 301                         /*
 302                          * Ignore children that lack a compatible property.
 303                          * Some of them may be for configuration, for example
 304                          * ppi-partitions.
 305                          */
 306                         if (!OF_hasprop(node, "compatible"))
 307                                 continue;
 308
 309                         /* Allocate and populate devinfo. */
 310                         di = malloc(sizeof(*di), M_GIC_V3, M_WAITOK | M_ZERO);
 311
 312                         /* Read the numa node, or -1 if there is none */
 313                         if (OF_getencprop(node, "numa-node-id",
 314                             &di->di_gic_dinfo.gic_domain,
 315                             sizeof(di->di_gic_dinfo.gic_domain)) <= 0) {
 316                                 di->di_gic_dinfo.gic_domain = -1;
 317                         }
 318
 319                         if (ofw_bus_gen_setup_devinfo(&di->di_dinfo, node)) {
 320                                 if (bootverbose) {
 321                                         device_printf(dev,
 322                                             "Could not set up devinfo for ITS\n");
 323                                 }
 324                                 free(di, M_GIC_V3);
 325                                 continue;
 326                         }
 327
 328                         /* Initialize and populate resource list. */
 329                         resource_list_init(&di->di_rl);
 330                         ofw_bus_reg_to_rl(dev, node, addr_cells, size_cells,
 331                             &di->di_rl);
 332
 333                         /* Should not have any interrupts, so don't add any */
 334
 335                         /* Add newbus device for this FDT node */
 336                         child = device_add_child(dev, NULL, -1);
 337                         if (!child) {
 338                                 if (bootverbose) {
 339                                         device_printf(dev,
 340                                             "Could not add child: %s\n",
 341                                             di->di_dinfo.obd_name);
 342                                 }
 343                                 resource_list_free(&di->di_rl);
 344                                 ofw_bus_gen_destroy_devinfo(&di->di_dinfo);
 345                                 free(di, M_GIC_V3);
 346                                 continue;
 347                         }
 348
 349                         sc->gic_nchildren++;
 350                         device_set_ivars(child, di);
 351                 }
 352         }
 353
 354         /*
 355          * If there is a vgic maintanance interrupt add a virtual gic
 356          * child so we can use this in the vmm module for bhyve.
 357          */
 358         if (OF_hasprop(parent, "interrupts")) {
 359                 child = device_add_child(dev, "vgic", -1);
 360                 if (child == NULL) {
 361                         device_printf(dev, "Could not add vgic child\n");
 362                 } else {
 363                         di = malloc(sizeof(*di), M_GIC_V3, M_WAITOK | M_ZERO);
 364                         resource_list_init(&di->di_rl);
 365                         di->di_gic_dinfo.gic_domain = -1;
 366                         di->di_gic_dinfo.is_vgic = 1;
 367                         device_set_ivars(child, di);
 368                         sc->gic_nchildren++;
 369                 }
 370         }
 371
 372         return (bus_generic_attach(dev));
 373 }
 374
 375 static struct resource_list *
 376 gic_v3_fdt_get_resource_list(device_t bus, device_t child)
 377 {
 378         struct gic_v3_ofw_devinfo *di;
 379
 380         di = device_get_ivars(child);
 381         KASSERT(di != NULL, ("%s: No devinfo", __func__));
 382
 383         return (&di->di_rl);
 384 }