sys/dev/fdt/simplebus.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2013 Nathan Whitehorn
   5  * All rights reserved.
   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 __FBSDID("$FreeBSD$");
  31 #include <sys/param.h>
  32 #include <sys/systm.h>
  33 #include <sys/module.h>
  34 #include <sys/bus.h>
  35 #include <sys/conf.h>
  36 #include <sys/kernel.h>
  37 #include <sys/rman.h>
  38
  39 #include <dev/ofw/openfirm.h>
  40 #include <dev/ofw/ofw_bus.h>
  41 #include <dev/ofw/ofw_bus_subr.h>
  42
  43 #include <dev/fdt/simplebus.h>
  44
  45 /*
  46  * Bus interface.
  47  */
  48 static int              simplebus_probe(device_t dev);
  49 static struct resource *simplebus_alloc_resource(device_t, device_t, int,
  50     int *, rman_res_t, rman_res_t, rman_res_t, u_int);
  51 static void             simplebus_probe_nomatch(device_t bus, device_t child);
  52 static int              simplebus_print_child(device_t bus, device_t child);
  53 static device_t         simplebus_add_child(device_t dev, u_int order,
  54     const char *name, int unit);
  55 static struct resource_list *simplebus_get_resource_list(device_t bus,
  56     device_t child);
  57
  58 static ssize_t          simplebus_get_property(device_t bus, device_t child,
  59     const char *propname, void *propvalue, size_t size);
  60 /*
  61  * ofw_bus interface
  62  */
  63 static const struct ofw_bus_devinfo *simplebus_get_devinfo(device_t bus,
  64     device_t child);
  65
  66 /*
  67  * Driver methods.
  68  */
  69 static device_method_t  simplebus_methods[] = {
  70         /* Device interface */
  71         DEVMETHOD(device_probe,         simplebus_probe),
  72         DEVMETHOD(device_attach,        simplebus_attach),
  73         DEVMETHOD(device_detach,        simplebus_detach),
  74         DEVMETHOD(device_shutdown,      bus_generic_shutdown),
  75         DEVMETHOD(device_suspend,       bus_generic_suspend),
  76         DEVMETHOD(device_resume,        bus_generic_resume),
  77
  78         /* Bus interface */
  79         DEVMETHOD(bus_add_child,        simplebus_add_child),
  80         DEVMETHOD(bus_print_child,      simplebus_print_child),
  81         DEVMETHOD(bus_probe_nomatch,    simplebus_probe_nomatch),
  82         DEVMETHOD(bus_read_ivar,        bus_generic_read_ivar),
  83         DEVMETHOD(bus_write_ivar,       bus_generic_write_ivar),
  84         DEVMETHOD(bus_setup_intr,       bus_generic_setup_intr),
  85         DEVMETHOD(bus_teardown_intr,    bus_generic_teardown_intr),
  86         DEVMETHOD(bus_alloc_resource,   simplebus_alloc_resource),
  87         DEVMETHOD(bus_release_resource, bus_generic_release_resource),
  88         DEVMETHOD(bus_activate_resource, bus_generic_activate_resource),
  89         DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource),
  90         DEVMETHOD(bus_adjust_resource,  bus_generic_adjust_resource),
  91         DEVMETHOD(bus_set_resource,     bus_generic_rl_set_resource),
  92         DEVMETHOD(bus_get_resource,     bus_generic_rl_get_resource),
  93         DEVMETHOD(bus_child_pnpinfo,    ofw_bus_gen_child_pnpinfo),
  94         DEVMETHOD(bus_get_resource_list, simplebus_get_resource_list),
  95         DEVMETHOD(bus_get_property,     simplebus_get_property),
  96
  97         /* ofw_bus interface */
  98         DEVMETHOD(ofw_bus_get_devinfo,  simplebus_get_devinfo),
  99         DEVMETHOD(ofw_bus_get_compat,   ofw_bus_gen_get_compat),
 100         DEVMETHOD(ofw_bus_get_model,    ofw_bus_gen_get_model),
 101         DEVMETHOD(ofw_bus_get_name,     ofw_bus_gen_get_name),
 102         DEVMETHOD(ofw_bus_get_node,     ofw_bus_gen_get_node),
 103         DEVMETHOD(ofw_bus_get_type,     ofw_bus_gen_get_type),
 104
 105         DEVMETHOD_END
 106 };
 107
 108 DEFINE_CLASS_0(simplebus, simplebus_driver, simplebus_methods,
 109     sizeof(struct simplebus_softc));
 110
 111 static devclass_t simplebus_devclass;
 112 EARLY_DRIVER_MODULE(simplebus, ofwbus, simplebus_driver, simplebus_devclass,
 113     0, 0, BUS_PASS_BUS);
 114 EARLY_DRIVER_MODULE(simplebus, simplebus, simplebus_driver, simplebus_devclass,
 115     0, 0, BUS_PASS_BUS + BUS_PASS_ORDER_MIDDLE);
 116
 117 static int
 118 simplebus_probe(device_t dev)
 119 {
 120
 121         if (!ofw_bus_status_okay(dev))
 122                 return (ENXIO);
 123         /*
 124          * XXX We should attach only to pure' compatible = "simple-bus"',
 125          * without any other compatible string.
 126          * For now, filter only know cases:
 127          * "syscon", "simple-bus"; is handled by fdt/syscon driver
 128          * "simple-mfd", "simple-bus"; is handled by fdt/simple-mfd driver
 129          */
 130         if (ofw_bus_is_compatible(dev, "syscon") ||
 131             ofw_bus_is_compatible(dev, "simple-mfd"))
 132                 return (ENXIO);
 133
 134         /*
 135          * FDT data puts a "simple-bus" compatible string on many things that
 136          * have children but aren't really buses in our world.  Without a
 137          * ranges property we will fail to attach, so just fail to probe too.
 138          */
 139         if (!(ofw_bus_is_compatible(dev, "simple-bus") &&
 140             ofw_bus_has_prop(dev, "ranges")) &&
 141             (ofw_bus_get_type(dev) == NULL || strcmp(ofw_bus_get_type(dev),
 142              "soc") != 0))
 143                 return (ENXIO);
 144
 145         device_set_desc(dev, "Flattened device tree simple bus");
 146
 147         return (BUS_PROBE_GENERIC);
 148 }
 149
 150 int
 151 simplebus_attach_impl(device_t dev)
 152 {
 153         struct          simplebus_softc *sc;
 154         phandle_t       node;
 155
 156         sc = device_get_softc(dev);
 157         simplebus_init(dev, 0);
 158         if ((sc->flags & SB_FLAG_NO_RANGES) == 0 &&
 159             simplebus_fill_ranges(sc->node, sc) < 0) {
 160                 device_printf(dev, "could not get ranges\n");
 161                 return (ENXIO);
 162         }
 163
 164         /*
 165          * In principle, simplebus could have an interrupt map, but ignore that
 166          * for now
 167          */
 168
 169         for (node = OF_child(sc->node); node > 0; node = OF_peer(node))
 170                 simplebus_add_device(dev, node, 0, NULL, -1, NULL);
 171
 172         return (0);
 173 }
 174
 175 int
 176 simplebus_attach(device_t dev)
 177 {
 178         int     rv;
 179
 180         rv = simplebus_attach_impl(dev);
 181         if (rv != 0)
 182                 return (rv);
 183
 184         return (bus_generic_attach(dev));
 185 }
 186
 187 int
 188 simplebus_detach(device_t dev)
 189 {
 190         struct          simplebus_softc *sc;
 191
 192         sc = device_get_softc(dev);
 193         if (sc->ranges != NULL)
 194                 free(sc->ranges, M_DEVBUF);
 195
 196         return (bus_generic_detach(dev));
 197 }
 198
 199 void
 200 simplebus_init(device_t dev, phandle_t node)
 201 {
 202         struct simplebus_softc *sc;
 203
 204         sc = device_get_softc(dev);
 205         if (node == 0)
 206                 node = ofw_bus_get_node(dev);
 207         sc->dev = dev;
 208         sc->node = node;
 209
 210         /*
 211          * Some important numbers
 212          */
 213         sc->acells = 2;
 214         OF_getencprop(node, "#address-cells", &sc->acells, sizeof(sc->acells));
 215         sc->scells = 1;
 216         OF_getencprop(node, "#size-cells", &sc->scells, sizeof(sc->scells));
 217 }
 218
 219 int
 220 simplebus_fill_ranges(phandle_t node, struct simplebus_softc *sc)
 221 {
 222         int host_address_cells;
 223         cell_t *base_ranges;
 224         ssize_t nbase_ranges;
 225         int err;
 226         int i, j, k;
 227
 228         err = OF_searchencprop(OF_parent(node), "#address-cells",
 229             &host_address_cells, sizeof(host_address_cells));
 230         if (err <= 0)
 231                 return (-1);
 232
 233         nbase_ranges = OF_getproplen(node, "ranges");
 234         if (nbase_ranges < 0)
 235                 return (-1);
 236         sc->nranges = nbase_ranges / sizeof(cell_t) /
 237             (sc->acells + host_address_cells + sc->scells);
 238         if (sc->nranges == 0)
 239                 return (0);
 240
 241         sc->ranges = malloc(sc->nranges * sizeof(sc->ranges[0]),
 242             M_DEVBUF, M_WAITOK);
 243         base_ranges = malloc(nbase_ranges, M_DEVBUF, M_WAITOK);
 244         OF_getencprop(node, "ranges", base_ranges, nbase_ranges);
 245
 246         for (i = 0, j = 0; i < sc->nranges; i++) {
 247                 sc->ranges[i].bus = 0;
 248                 for (k = 0; k < sc->acells; k++) {
 249                         sc->ranges[i].bus <<= 32;
 250                         sc->ranges[i].bus |= base_ranges[j++];
 251                 }
 252                 sc->ranges[i].host = 0;
 253                 for (k = 0; k < host_address_cells; k++) {
 254                         sc->ranges[i].host <<= 32;
 255                         sc->ranges[i].host |= base_ranges[j++];
 256                 }
 257                 sc->ranges[i].size = 0;
 258                 for (k = 0; k < sc->scells; k++) {
 259                         sc->ranges[i].size <<= 32;
 260                         sc->ranges[i].size |= base_ranges[j++];
 261                 }
 262         }
 263
 264         free(base_ranges, M_DEVBUF);
 265         return (sc->nranges);
 266 }
 267
 268 struct simplebus_devinfo *
 269 simplebus_setup_dinfo(device_t dev, phandle_t node,
 270     struct simplebus_devinfo *di)
 271 {
 272         struct simplebus_softc *sc;
 273         struct simplebus_devinfo *ndi;
 274
 275         sc = device_get_softc(dev);
 276         if (di == NULL)
 277                 ndi = malloc(sizeof(*ndi), M_DEVBUF, M_WAITOK | M_ZERO);
 278         else
 279                 ndi = di;
 280         if (ofw_bus_gen_setup_devinfo(&ndi->obdinfo, node) != 0) {
 281                 if (di == NULL)
 282                         free(ndi, M_DEVBUF);
 283                 return (NULL);
 284         }
 285
 286         resource_list_init(&ndi->rl);
 287         ofw_bus_reg_to_rl(dev, node, sc->acells, sc->scells, &ndi->rl);
 288         ofw_bus_intr_to_rl(dev, node, &ndi->rl, NULL);
 289
 290         return (ndi);
 291 }
 292
 293 device_t
 294 simplebus_add_device(device_t dev, phandle_t node, u_int order,
 295     const char *name, int unit, struct simplebus_devinfo *di)
 296 {
 297         struct simplebus_devinfo *ndi;
 298         device_t cdev;
 299
 300         if ((ndi = simplebus_setup_dinfo(dev, node, di)) == NULL)
 301                 return (NULL);
 302         cdev = device_add_child_ordered(dev, order, name, unit);
 303         if (cdev == NULL) {
 304                 device_printf(dev, "<%s>: device_add_child failed\n",
 305                     ndi->obdinfo.obd_name);
 306                 resource_list_free(&ndi->rl);
 307                 ofw_bus_gen_destroy_devinfo(&ndi->obdinfo);
 308                 if (di == NULL)
 309                         free(ndi, M_DEVBUF);
 310                 return (NULL);
 311         }
 312         device_set_ivars(cdev, ndi);
 313
 314         return(cdev);
 315 }
 316
 317 static device_t
 318 simplebus_add_child(device_t dev, u_int order, const char *name, int unit)
 319 {
 320         device_t cdev;
 321         struct simplebus_devinfo *ndi;
 322
 323         cdev = device_add_child_ordered(dev, order, name, unit);
 324         if (cdev == NULL)
 325                 return (NULL);
 326
 327         ndi = malloc(sizeof(*ndi), M_DEVBUF, M_WAITOK | M_ZERO);
 328         ndi->obdinfo.obd_node = -1;
 329         resource_list_init(&ndi->rl);
 330         device_set_ivars(cdev, ndi);
 331
 332         return (cdev);
 333 }
 334
 335 static const struct ofw_bus_devinfo *
 336 simplebus_get_devinfo(device_t bus __unused, device_t child)
 337 {
 338         struct simplebus_devinfo *ndi;
 339
 340         ndi = device_get_ivars(child);
 341         if (ndi == NULL)
 342                 return (NULL);
 343         return (&ndi->obdinfo);
 344 }
 345
 346 static struct resource_list *
 347 simplebus_get_resource_list(device_t bus __unused, device_t child)
 348 {
 349         struct simplebus_devinfo *ndi;
 350
 351         ndi = device_get_ivars(child);
 352         if (ndi == NULL)
 353                 return (NULL);
 354         return (&ndi->rl);
 355 }
 356
 357 static ssize_t
 358 simplebus_get_property(device_t bus, device_t child, const char *propname,
 359     void *propvalue, size_t size)
 360 {
 361         phandle_t node = ofw_bus_get_node(child);
 362
 363         if (propvalue == NULL || size == 0)
 364                 return (OF_getproplen(node, propname));
 365
 366         return (OF_getencprop(node, propname, propvalue, size));
 367 }
 368
 369 static struct resource *
 370 simplebus_alloc_resource(device_t bus, device_t child, int type, int *rid,
 371     rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
 372 {
 373         struct simplebus_softc *sc;
 374         struct simplebus_devinfo *di;
 375         struct resource_list_entry *rle;
 376         int j;
 377
 378         sc = device_get_softc(bus);
 379
 380         /*
 381          * Request for the default allocation with a given rid: use resource
 382          * list stored in the local device info.
 383          */
 384         if (RMAN_IS_DEFAULT_RANGE(start, end)) {
 385                 if ((di = device_get_ivars(child)) == NULL)
 386                         return (NULL);
 387
 388                 if (type == SYS_RES_IOPORT)
 389                         type = SYS_RES_MEMORY;
 390
 391                 rle = resource_list_find(&di->rl, type, *rid);
 392                 if (rle == NULL) {
 393                         if (bootverbose)
 394                                 device_printf(bus, "no default resources for "
 395                                     "rid = %d, type = %d\n", *rid, type);
 396                         return (NULL);
 397                 }
 398                 start = rle->start;
 399                 end = rle->end;
 400                 count = rle->count;
 401         }
 402
 403         if (type == SYS_RES_MEMORY) {
 404                 /* Remap through ranges property */
 405                 for (j = 0; j < sc->nranges; j++) {
 406                         if (start >= sc->ranges[j].bus && end <
 407                             sc->ranges[j].bus + sc->ranges[j].size) {
 408                                 start -= sc->ranges[j].bus;
 409                                 start += sc->ranges[j].host;
 410                                 end -= sc->ranges[j].bus;
 411                                 end += sc->ranges[j].host;
 412                                 break;
 413                         }
 414                 }
 415                 if (j == sc->nranges && sc->nranges != 0) {
 416                         if (bootverbose)
 417                                 device_printf(bus, "Could not map resource "
 418                                     "%#jx-%#jx\n", start, end);
 419
 420                         return (NULL);
 421                 }
 422         }
 423
 424         return (bus_generic_alloc_resource(bus, child, type, rid, start, end,
 425             count, flags));
 426 }
 427
 428 static int
 429 simplebus_print_res(struct simplebus_devinfo *di)
 430 {
 431         int rv;
 432
 433         if (di == NULL)
 434                 return (0);
 435         rv = 0;
 436         rv += resource_list_print_type(&di->rl, "mem", SYS_RES_MEMORY, "%#jx");
 437         rv += resource_list_print_type(&di->rl, "irq", SYS_RES_IRQ, "%jd");
 438         return (rv);
 439 }
 440
 441 static void
 442 simplebus_probe_nomatch(device_t bus, device_t child)
 443 {
 444         const char *name, *type, *compat;
 445
 446         if (!bootverbose)
 447                 return;
 448
 449         compat = ofw_bus_get_compat(child);
 450         if (compat == NULL)
 451                 return;
 452         name = ofw_bus_get_name(child);
 453         type = ofw_bus_get_type(child);
 454
 455         device_printf(bus, "<%s>", name != NULL ? name : "unknown");
 456         simplebus_print_res(device_get_ivars(child));
 457         if (!ofw_bus_status_okay(child))
 458                 printf(" disabled");
 459         if (type)
 460                 printf(" type %s", type);
 461         printf(" compat %s (no driver attached)\n", compat);
 462 }
 463
 464 static int
 465 simplebus_print_child(device_t bus, device_t child)
 466 {
 467         int rv;
 468
 469         rv = bus_print_child_header(bus, child);
 470         rv += simplebus_print_res(device_get_ivars(child));
 471         if (!ofw_bus_status_okay(child))
 472                 rv += printf(" disabled");
 473         rv += bus_print_child_footer(bus, child);
 474         return (rv);
 475 }