sys/arm64/arm64/gic_v3_fdt.c

   1 /*-
   2  * Copyright (c) 2015 The FreeBSD Foundation
   3  * All rights reserved.
   4  *
   5  * This software was developed by Semihalf under
   6  * the sponsorship of the FreeBSD Foundation.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  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.
  16  *
  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
  27  * SUCH DAMAGE.
  28  */
  29
  30 #include <sys/cdefs.h>
  31 __FBSDID("$FreeBSD$");
  32
  33 #include <sys/param.h>
  34 #include <sys/systm.h>
  35 #include <sys/bus.h>
  36 #include <sys/kernel.h>
  37 #include <sys/module.h>
  38 #include <sys/rman.h>
  39
  40 #include <machine/resource.h>
  41
  42 #include <dev/ofw/openfirm.h>
  43 #include <dev/ofw/ofw_bus.h>
  44 #include <dev/ofw/ofw_bus_subr.h>
  45
  46 #include "pic_if.h"
  47
  48 #include "gic_v3_reg.h"
  49 #include "gic_v3_var.h"
  50
  51 /*
  52  * FDT glue.
  53  */
  54 static int gic_v3_fdt_probe(device_t);
  55 static int gic_v3_fdt_attach(device_t);
  56
  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
  61 static device_method_t gic_v3_fdt_methods[] = {
  62         /* Device interface */
  63         DEVMETHOD(device_probe,         gic_v3_fdt_probe),
  64         DEVMETHOD(device_attach,        gic_v3_fdt_attach),
  65
  66         /* Bus interface */
  67         DEVMETHOD(bus_alloc_resource,           gic_v3_ofw_bus_alloc_res),
  68         DEVMETHOD(bus_activate_resource,        bus_generic_activate_resource),
  69
  70         /* ofw_bus interface */
  71         DEVMETHOD(ofw_bus_get_devinfo,  gic_v3_ofw_get_devinfo),
  72         DEVMETHOD(ofw_bus_get_compat,   ofw_bus_gen_get_compat),
  73         DEVMETHOD(ofw_bus_get_model,    ofw_bus_gen_get_model),
  74         DEVMETHOD(ofw_bus_get_name,     ofw_bus_gen_get_name),
  75         DEVMETHOD(ofw_bus_get_node,     ofw_bus_gen_get_node),
  76         DEVMETHOD(ofw_bus_get_type,     ofw_bus_gen_get_type),
  77
  78         /* End */
  79         DEVMETHOD_END
  80 };
  81
  82 DEFINE_CLASS_1(gic, gic_v3_fdt_driver, gic_v3_fdt_methods,
  83     sizeof(struct gic_v3_softc), gic_v3_driver);
  84
  85 static devclass_t gic_v3_fdt_devclass;
  86
  87 EARLY_DRIVER_MODULE(gic_v3, simplebus, gic_v3_fdt_driver, gic_v3_fdt_devclass,
  88     0, 0, BUS_PASS_INTERRUPT + BUS_PASS_ORDER_MIDDLE);
  89 EARLY_DRIVER_MODULE(gic_v3, ofwbus, gic_v3_fdt_driver, gic_v3_fdt_devclass,
  90     0, 0, BUS_PASS_INTERRUPT + BUS_PASS_ORDER_MIDDLE);
  91
  92 /*
  93  * Helper functions declarations.
  94  */
  95 static int gic_v3_ofw_bus_attach(device_t);
  96
  97 /*
  98  * Device interface.
  99  */
 100 static int
 101 gic_v3_fdt_probe(device_t dev)
 102 {
 103
 104         if (!ofw_bus_status_okay(dev))
 105                 return (ENXIO);
 106
 107         if (!ofw_bus_is_compatible(dev, "arm,gic-v3"))
 108                 return (ENXIO);
 109
 110         device_set_desc(dev, GIC_V3_DEVSTR);
 111         return (BUS_PROBE_DEFAULT);
 112 }
 113
 114 static int
 115 gic_v3_fdt_attach(device_t dev)
 116 {
 117         struct gic_v3_softc *sc;
 118         pcell_t redist_regions;
 119         int err;
 120
 121         sc = device_get_softc(dev);
 122         sc->dev = dev;
 123
 124         /*
 125          * Recover number of the Re-Distributor regions.
 126          */
 127         if (OF_getencprop(ofw_bus_get_node(dev), "#redistributor-regions",
 128             &redist_regions, sizeof(redist_regions)) <= 0)
 129                 sc->gic_redists.nregions = 1;
 130         else
 131                 sc->gic_redists.nregions = redist_regions;
 132
 133         err = gic_v3_attach(dev);
 134         if (err)
 135                 goto error;
 136         /*
 137          * Try to register ITS to this GIC.
 138          * GIC will act as a bus in that case.
 139          * Failure here will not affect main GIC functionality.
 140          */
 141         if (gic_v3_ofw_bus_attach(dev) != 0) {
 142                 if (bootverbose) {
 143                         device_printf(dev,
 144                             "Failed to attach ITS to this GIC\n");
 145                 }
 146         }
 147
 148         return (err);
 149
 150 error:
 151         if (bootverbose) {
 152                 device_printf(dev,
 153                     "Failed to attach. Error %d\n", err);
 154         }
 155         /* Failure so free resources */
 156         gic_v3_detach(dev);
 157
 158         return (err);
 159 }
 160
 161 /* OFW bus interface */
 162 struct gic_v3_ofw_devinfo {
 163         struct ofw_bus_devinfo  di_dinfo;
 164         struct resource_list    di_rl;
 165 };
 166
 167 static const struct ofw_bus_devinfo *
 168 gic_v3_ofw_get_devinfo(device_t bus __unused, device_t child)
 169 {
 170         struct gic_v3_ofw_devinfo *di;
 171
 172         di = device_get_ivars(child);
 173         return (&di->di_dinfo);
 174 }
 175
 176 static struct resource *
 177 gic_v3_ofw_bus_alloc_res(device_t bus, device_t child, int type, int *rid,
 178     rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
 179 {
 180         struct gic_v3_ofw_devinfo *di;
 181         struct resource_list_entry *rle;
 182         int ranges_len;
 183
 184         if (RMAN_IS_DEFAULT_RANGE(start, end)) {
 185                 if ((di = device_get_ivars(child)) == NULL)
 186                         return (NULL);
 187                 if (type != SYS_RES_MEMORY)
 188                         return (NULL);
 189
 190                 /* Find defaults for this rid */
 191                 rle = resource_list_find(&di->di_rl, type, *rid);
 192                 if (rle == NULL)
 193                         return (NULL);
 194
 195                 start = rle->start;
 196                 end = rle->end;
 197                 count = rle->count;
 198         }
 199         /*
 200          * XXX: No ranges remap!
 201          *      Absolute address is expected.
 202          */
 203         if (ofw_bus_has_prop(bus, "ranges")) {
 204                 ranges_len = OF_getproplen(ofw_bus_get_node(bus), "ranges");
 205                 if (ranges_len != 0) {
 206                         if (bootverbose) {
 207                                 device_printf(child,
 208                                     "Ranges remap not supported\n");
 209                         }
 210                         return (NULL);
 211                 }
 212         }
 213         return (bus_generic_alloc_resource(bus, child, type, rid, start, end,
 214             count, flags));
 215 }
 216
 217 /* Helper functions */
 218
 219 /*
 220  * Bus capability support for GICv3.
 221  * Collects and configures device informations and finally
 222  * adds ITS device as a child of GICv3 in Newbus hierarchy.
 223  */
 224 static int
 225 gic_v3_ofw_bus_attach(device_t dev)
 226 {
 227         struct gic_v3_ofw_devinfo *di;
 228         device_t child;
 229         phandle_t parent, node;
 230         pcell_t addr_cells, size_cells;
 231
 232         parent = ofw_bus_get_node(dev);
 233         if (parent > 0) {
 234                 addr_cells = 2;
 235                 OF_getencprop(parent, "#address-cells", &addr_cells,
 236                     sizeof(addr_cells));
 237                 size_cells = 2;
 238                 OF_getencprop(parent, "#size-cells", &size_cells,
 239                     sizeof(size_cells));
 240                 /* Iterate through all GIC subordinates */
 241                 for (node = OF_child(parent); node > 0; node = OF_peer(node)) {
 242                         /* Allocate and populate devinfo. */
 243                         di = malloc(sizeof(*di), M_GIC_V3, M_WAITOK | M_ZERO);
 244                         if (ofw_bus_gen_setup_devinfo(&di->di_dinfo, node)) {
 245                                 if (bootverbose) {
 246                                         device_printf(dev,
 247                                             "Could not set up devinfo for ITS\n");
 248                                 }
 249                                 free(di, M_GIC_V3);
 250                                 continue;
 251                         }
 252
 253                         /* Initialize and populate resource list. */
 254                         resource_list_init(&di->di_rl);
 255                         ofw_bus_reg_to_rl(dev, node, addr_cells, size_cells,
 256                             &di->di_rl);
 257
 258                         /* Should not have any interrupts, so don't add any */
 259
 260                         /* Add newbus device for this FDT node */
 261                         child = device_add_child(dev, NULL, -1);
 262                         if (!child) {
 263                                 if (bootverbose) {
 264                                         device_printf(dev,
 265                                             "Could not add child: %s\n",
 266                                             di->di_dinfo.obd_name);
 267                                 }
 268                                 resource_list_free(&di->di_rl);
 269                                 ofw_bus_gen_destroy_devinfo(&di->di_dinfo);
 270                                 free(di, M_GIC_V3);
 271                                 continue;
 272                         }
 273
 274                         device_set_ivars(child, di);
 275                 }
 276         }
 277
 278         return (bus_generic_attach(dev));
 279 }
 280
 281 static int gic_v3_its_fdt_probe(device_t dev);
 282
 283 static device_method_t gic_v3_its_fdt_methods[] = {
 284         /* Device interface */
 285         DEVMETHOD(device_probe,         gic_v3_its_fdt_probe),
 286
 287         /* End */
 288         DEVMETHOD_END
 289 };
 290
 291 DEFINE_CLASS_1(its, gic_v3_its_fdt_driver, gic_v3_its_fdt_methods,
 292     sizeof(struct gic_v3_its_softc), gic_v3_its_driver);
 293
 294 static devclass_t gic_v3_its_fdt_devclass;
 295
 296 EARLY_DRIVER_MODULE(its, gic, gic_v3_its_fdt_driver,
 297     gic_v3_its_fdt_devclass, 0, 0, BUS_PASS_INTERRUPT + BUS_PASS_ORDER_MIDDLE);
 298
 299 static int
 300 gic_v3_its_fdt_probe(device_t dev)
 301 {
 302
 303         if (!ofw_bus_status_okay(dev))
 304                 return (ENXIO);
 305
 306         if (!ofw_bus_is_compatible(dev, GIC_V3_ITS_COMPSTR))
 307                 return (ENXIO);
 308
 309         device_set_desc(dev, GIC_V3_ITS_DEVSTR);
 310         return (BUS_PROBE_DEFAULT);
 311 }