sys/arm/arm/gic_fdt.c

   1 /*-
   2  * Copyright (c) 2011,2016 The FreeBSD Foundation
   3  * All rights reserved.
   4  *
   5  * This software was developed by Andrew Turner under
   6  * sponsorship from the FreeBSD Foundation.
   7  *
   8  * Developed by Damjan Marion <damjan.marion@gmail.com>
   9  *
  10  * Based on OMAP4 GIC code by Ben Gray
  11  *
  12  * Redistribution and use in source and binary forms, with or without
  13  * modification, are permitted provided that the following conditions
  14  * are met:
  15  * 1. Redistributions of source code must retain the above copyright
  16  *    notice, this list of conditions and the following disclaimer.
  17  * 2. Redistributions in binary form must reproduce the above copyright
  18  *    notice, this list of conditions and the following disclaimer in the
  19  *    documentation and/or other materials provided with the distribution.
  20  * 3. The name of the company nor the name of the author may be used to
  21  *    endorse or promote products derived from this software without specific
  22  *    prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34  * SUCH DAMAGE.
  35  */
  36
  37 #include "opt_platform.h"
  38
  39 #include <sys/cdefs.h>
  40 __FBSDID("$FreeBSD$");
  41
  42 #include <sys/param.h>
  43 #include <sys/systm.h>
  44 #include <sys/bus.h>
  45 #include <sys/kernel.h>
  46 #include <sys/module.h>
  47
  48 #include <machine/intr.h>
  49
  50 #include <dev/ofw/openfirm.h>
  51 #include <dev/ofw/ofw_bus.h>
  52 #include <dev/ofw/ofw_bus_subr.h>
  53
  54 #include <arm/arm/gic.h>
  55 #include <arm/arm/gic_common.h>
  56
  57 struct arm_gic_devinfo {
  58         struct ofw_bus_devinfo  obdinfo;
  59         struct resource_list    rl;
  60 };
  61
  62 struct arm_gic_fdt_softc {
  63         struct arm_gic_softc    base;
  64         pcell_t                 addr_cells;
  65         pcell_t                 size_cells;
  66 };
  67
  68 static device_probe_t gic_fdt_probe;
  69 static device_attach_t gic_fdt_attach;
  70 static ofw_bus_get_devinfo_t gic_ofw_get_devinfo;
  71 static bus_get_resource_list_t gic_fdt_get_resource_list;
  72 static bool arm_gic_add_children(device_t);
  73
  74 static struct ofw_compat_data compat_data[] = {
  75         {"arm,gic",             true},  /* Non-standard, used in FreeBSD dts. */
  76         {"arm,gic-400",         true},
  77         {"arm,cortex-a15-gic",  true},
  78         {"arm,cortex-a9-gic",   true},
  79         {"arm,cortex-a7-gic",   true},
  80         {"arm,arm11mp-gic",     true},
  81         {"brcm,brahma-b15-gic", true},
  82         {"qcom,msm-qgic2",      true},
  83         {NULL,                  false}
  84 };
  85
  86 static device_method_t gic_fdt_methods[] = {
  87         /* Device interface */
  88         DEVMETHOD(device_probe,         gic_fdt_probe),
  89         DEVMETHOD(device_attach,        gic_fdt_attach),
  90
  91         /* Bus interface */
  92         DEVMETHOD(bus_get_resource_list,gic_fdt_get_resource_list),
  93
  94         /* ofw_bus interface */
  95         DEVMETHOD(ofw_bus_get_devinfo,  gic_ofw_get_devinfo),
  96         DEVMETHOD(ofw_bus_get_compat,   ofw_bus_gen_get_compat),
  97         DEVMETHOD(ofw_bus_get_model,    ofw_bus_gen_get_model),
  98         DEVMETHOD(ofw_bus_get_name,     ofw_bus_gen_get_name),
  99         DEVMETHOD(ofw_bus_get_node,     ofw_bus_gen_get_node),
 100         DEVMETHOD(ofw_bus_get_type,     ofw_bus_gen_get_type),
 101
 102         DEVMETHOD_END,
 103 };
 104
 105 DEFINE_CLASS_1(gic, gic_fdt_driver, gic_fdt_methods,
 106     sizeof(struct arm_gic_fdt_softc), arm_gic_driver);
 107
 108 EARLY_DRIVER_MODULE(gic, simplebus, gic_fdt_driver, 0, 0,
 109     BUS_PASS_INTERRUPT + BUS_PASS_ORDER_MIDDLE);
 110 EARLY_DRIVER_MODULE(gic, ofwbus, gic_fdt_driver, 0, 0,
 111     BUS_PASS_INTERRUPT + BUS_PASS_ORDER_MIDDLE);
 112
 113 static int
 114 gic_fdt_probe(device_t dev)
 115 {
 116
 117         if (!ofw_bus_status_okay(dev))
 118                 return (ENXIO);
 119
 120         if (!ofw_bus_search_compatible(dev, compat_data)->ocd_data)
 121                 return (ENXIO);
 122         device_set_desc(dev, "ARM Generic Interrupt Controller");
 123         return (BUS_PROBE_DEFAULT);
 124 }
 125
 126 static int
 127 gic_fdt_attach(device_t dev)
 128 {
 129         struct arm_gic_fdt_softc *sc = device_get_softc(dev);
 130         phandle_t pxref;
 131         intptr_t xref;
 132         int err;
 133
 134         sc->base.gic_bus = GIC_BUS_FDT;
 135
 136         err = arm_gic_attach(dev);
 137         if (err != 0)
 138                 return (err);
 139
 140         xref = OF_xref_from_node(ofw_bus_get_node(dev));
 141
 142         /*
 143          * Now, when everything is initialized, it's right time to
 144          * register interrupt controller to interrupt framefork.
 145          */
 146         if (intr_pic_register(dev, xref) == NULL) {
 147                 device_printf(dev, "could not register PIC\n");
 148                 goto cleanup;
 149         }
 150
 151         /*
 152          * Controller is root if:
 153          * - doesn't have interrupt parent
 154          * - his interrupt parent is this controller
 155          */
 156         pxref = ofw_bus_find_iparent(ofw_bus_get_node(dev));
 157         if (pxref == 0 || xref == pxref) {
 158                 if (intr_pic_claim_root(dev, xref, arm_gic_intr, sc,
 159                     GIC_LAST_SGI - GIC_FIRST_SGI + 1) != 0) {
 160                         device_printf(dev, "could not set PIC as a root\n");
 161                         intr_pic_deregister(dev, xref);
 162                         goto cleanup;
 163                 }
 164         } else {
 165                 if (sc->base.gic_res[2] == NULL) {
 166                         device_printf(dev,
 167                             "not root PIC must have defined interrupt\n");
 168                         intr_pic_deregister(dev, xref);
 169                         goto cleanup;
 170                 }
 171                 if (bus_setup_intr(dev, sc->base.gic_res[2], INTR_TYPE_CLK,
 172                     arm_gic_intr, NULL, sc, &sc->base.gic_intrhand)) {
 173                         device_printf(dev, "could not setup irq handler\n");
 174                         intr_pic_deregister(dev, xref);
 175                         goto cleanup;
 176                 }
 177         }
 178
 179         OF_device_register_xref(xref, dev);
 180
 181         /* If we have children probe and attach them */
 182         if (arm_gic_add_children(dev)) {
 183                 bus_generic_probe(dev);
 184                 return (bus_generic_attach(dev));
 185         }
 186
 187         return (0);
 188
 189 cleanup:
 190         arm_gic_detach(dev);
 191         return(ENXIO);
 192 }
 193
 194 static struct resource_list *
 195 gic_fdt_get_resource_list(device_t bus, device_t child)
 196 {
 197         struct arm_gic_devinfo *di;
 198
 199         di = device_get_ivars(child);
 200         KASSERT(di != NULL, ("gic_fdt_get_resource_list: No devinfo"));
 201
 202         return (&di->rl);
 203 }
 204
 205 static int
 206 arm_gic_fill_ranges(phandle_t node, struct arm_gic_fdt_softc *sc)
 207 {
 208         pcell_t host_cells;
 209         cell_t *base_ranges;
 210         ssize_t nbase_ranges;
 211         int i, j, k;
 212
 213         host_cells = 1;
 214         OF_getencprop(OF_parent(node), "#address-cells", &host_cells,
 215             sizeof(host_cells));
 216         sc->addr_cells = 2;
 217         OF_getencprop(node, "#address-cells", &sc->addr_cells,
 218             sizeof(sc->addr_cells));
 219         sc->size_cells = 2;
 220         OF_getencprop(node, "#size-cells", &sc->size_cells,
 221             sizeof(sc->size_cells));
 222
 223         nbase_ranges = OF_getproplen(node, "ranges");
 224         if (nbase_ranges < 0)
 225                 return (-1);
 226         sc->base.nranges = nbase_ranges / sizeof(cell_t) /
 227             (sc->addr_cells + host_cells + sc->size_cells);
 228         if (sc->base.nranges == 0)
 229                 return (0);
 230
 231         sc->base.ranges = malloc(sc->base.nranges * sizeof(sc->base.ranges[0]),
 232             M_DEVBUF, M_WAITOK);
 233         base_ranges = malloc(nbase_ranges, M_DEVBUF, M_WAITOK);
 234         OF_getencprop(node, "ranges", base_ranges, nbase_ranges);
 235
 236         for (i = 0, j = 0; i < sc->base.nranges; i++) {
 237                 sc->base.ranges[i].bus = 0;
 238                 for (k = 0; k < sc->addr_cells; k++) {
 239                         sc->base.ranges[i].bus <<= 32;
 240                         sc->base.ranges[i].bus |= base_ranges[j++];
 241                 }
 242                 sc->base.ranges[i].host = 0;
 243                 for (k = 0; k < host_cells; k++) {
 244                         sc->base.ranges[i].host <<= 32;
 245                         sc->base.ranges[i].host |= base_ranges[j++];
 246                 }
 247                 sc->base.ranges[i].size = 0;
 248                 for (k = 0; k < sc->size_cells; k++) {
 249                         sc->base.ranges[i].size <<= 32;
 250                         sc->base.ranges[i].size |= base_ranges[j++];
 251                 }
 252         }
 253
 254         free(base_ranges, M_DEVBUF);
 255         return (sc->base.nranges);
 256 }
 257
 258 static bool
 259 arm_gic_add_children(device_t dev)
 260 {
 261         struct arm_gic_fdt_softc *sc;
 262         struct arm_gic_devinfo *dinfo;
 263         phandle_t child, node;
 264         device_t cdev;
 265
 266         sc = device_get_softc(dev);
 267         node = ofw_bus_get_node(dev);
 268
 269         /* If we have no children don't probe for them */
 270         child = OF_child(node);
 271         if (child == 0)
 272                 return (false);
 273
 274         if (arm_gic_fill_ranges(node, sc) < 0) {
 275                 device_printf(dev, "Have a child, but no ranges\n");
 276                 return (false);
 277         }
 278
 279         for (; child != 0; child = OF_peer(child)) {
 280                 dinfo = malloc(sizeof(*dinfo), M_DEVBUF, M_WAITOK | M_ZERO);
 281
 282                 if (ofw_bus_gen_setup_devinfo(&dinfo->obdinfo, child) != 0) {
 283                         free(dinfo, M_DEVBUF);
 284                         continue;
 285                 }
 286
 287                 resource_list_init(&dinfo->rl);
 288                 ofw_bus_reg_to_rl(dev, child, sc->addr_cells,
 289                     sc->size_cells, &dinfo->rl);
 290
 291                 cdev = device_add_child(dev, NULL, -1);
 292                 if (cdev == NULL) {
 293                         device_printf(dev, "<%s>: device_add_child failed\n",
 294                             dinfo->obdinfo.obd_name);
 295                         resource_list_free(&dinfo->rl);
 296                         ofw_bus_gen_destroy_devinfo(&dinfo->obdinfo);
 297                         free(dinfo, M_DEVBUF);
 298                         continue;
 299                 }
 300                 device_set_ivars(cdev, dinfo);
 301         }
 302
 303         return (true);
 304 }
 305
 306 static const struct ofw_bus_devinfo *
 307 gic_ofw_get_devinfo(device_t bus __unused, device_t child)
 308 {
 309         struct arm_gic_devinfo *di;
 310
 311         di = device_get_ivars(child);
 312
 313         return (&di->obdinfo);
 314 }
 315
 316 static struct ofw_compat_data gicv2m_compat_data[] = {
 317         {"arm,gic-v2m-frame",   true},
 318         {NULL,                  false}
 319 };
 320
 321 static int
 322 arm_gicv2m_fdt_probe(device_t dev)
 323 {
 324
 325         if (!ofw_bus_status_okay(dev))
 326                 return (ENXIO);
 327
 328         if (!ofw_bus_search_compatible(dev, gicv2m_compat_data)->ocd_data)
 329                 return (ENXIO);
 330
 331         device_set_desc(dev, "ARM Generic Interrupt Controller MSI/MSIX");
 332         return (BUS_PROBE_DEFAULT);
 333 }
 334
 335 static int
 336 arm_gicv2m_fdt_attach(device_t dev)
 337 {
 338         struct arm_gicv2m_softc *sc;
 339
 340         sc = device_get_softc(dev);
 341         sc->sc_xref = OF_xref_from_node(ofw_bus_get_node(dev));
 342
 343         return (arm_gicv2m_attach(dev));
 344 }
 345
 346 static device_method_t arm_gicv2m_fdt_methods[] = {
 347         /* Device interface */
 348         DEVMETHOD(device_probe,         arm_gicv2m_fdt_probe),
 349         DEVMETHOD(device_attach,        arm_gicv2m_fdt_attach),
 350
 351         /* End */
 352         DEVMETHOD_END
 353 };
 354
 355 DEFINE_CLASS_1(gicv2m, arm_gicv2m_fdt_driver, arm_gicv2m_fdt_methods,
 356     sizeof(struct arm_gicv2m_softc), arm_gicv2m_driver);
 357
 358 EARLY_DRIVER_MODULE(gicv2m, gic, arm_gicv2m_fdt_driver, 0, 0,
 359     BUS_PASS_INTERRUPT + BUS_PASS_ORDER_MIDDLE);