sys/dev/fdt/simplebus.c

   1 /*-
   2  * Copyright (c) 2009-2010 The FreeBSD Foundation
   3  * All rights reserved.
   4  *
   5  * This software was developed by Semihalf under sponsorship from
   6  * 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 "opt_platform.h"
  34 #include <sys/param.h>
  35 #include <sys/systm.h>
  36 #include <sys/ktr.h>
  37 #include <sys/kernel.h>
  38 #include <sys/module.h>
  39 #include <sys/bus.h>
  40 #include <sys/rman.h>
  41 #include <sys/malloc.h>
  42
  43 #include <machine/fdt.h>
  44
  45 #include <dev/ofw/ofw_bus.h>
  46 #include <dev/ofw/ofw_bus_subr.h>
  47 #include <dev/ofw/openfirm.h>
  48
  49 #include "fdt_common.h"
  50 #include "ofw_bus_if.h"
  51
  52 #ifdef DEBUG
  53 #define debugf(fmt, args...) do { printf("%s(): ", __func__);   \
  54     printf(fmt,##args); } while (0)
  55 #else
  56 #define debugf(fmt, args...)
  57 #endif
  58
  59 static MALLOC_DEFINE(M_SIMPLEBUS, "simplebus", "simplebus devices information");
  60
  61 struct simplebus_softc {
  62         int     sc_addr_cells;
  63         int     sc_size_cells;
  64 };
  65
  66 struct simplebus_devinfo {
  67         struct ofw_bus_devinfo  di_ofw;
  68         struct resource_list    di_res;
  69
  70         /* Interrupts sense-level info for this device */
  71         struct fdt_sense_level  di_intr_sl[DI_MAX_INTR_NUM];
  72 };
  73
  74 /*
  75  * Prototypes.
  76  */
  77 static int simplebus_probe(device_t);
  78 static int simplebus_attach(device_t);
  79
  80 static int simplebus_print_child(device_t, device_t);
  81 static int simplebus_setup_intr(device_t, device_t, struct resource *, int,
  82     driver_filter_t *, driver_intr_t *, void *, void **);
  83
  84 static struct resource *simplebus_alloc_resource(device_t, device_t, int,
  85     int *, u_long, u_long, u_long, u_int);
  86 static struct resource_list *simplebus_get_resource_list(device_t, device_t);
  87
  88 static ofw_bus_get_devinfo_t simplebus_get_devinfo;
  89
  90 /*
  91  * Bus interface definition.
  92  */
  93 static device_method_t simplebus_methods[] = {
  94         /* Device interface */
  95         DEVMETHOD(device_probe,         simplebus_probe),
  96         DEVMETHOD(device_attach,        simplebus_attach),
  97         DEVMETHOD(device_detach,        bus_generic_detach),
  98         DEVMETHOD(device_shutdown,      bus_generic_shutdown),
  99         DEVMETHOD(device_suspend,       bus_generic_suspend),
 100         DEVMETHOD(device_resume,        bus_generic_resume),
 101
 102         /* Bus interface */
 103         DEVMETHOD(bus_print_child,      simplebus_print_child),
 104         DEVMETHOD(bus_alloc_resource,   simplebus_alloc_resource),
 105         DEVMETHOD(bus_release_resource, bus_generic_release_resource),
 106         DEVMETHOD(bus_activate_resource, bus_generic_activate_resource),
 107         DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource),
 108         DEVMETHOD(bus_setup_intr,       simplebus_setup_intr),
 109         DEVMETHOD(bus_teardown_intr,    bus_generic_teardown_intr),
 110         DEVMETHOD(bus_get_resource_list, simplebus_get_resource_list),
 111
 112         /* OFW bus interface */
 113         DEVMETHOD(ofw_bus_get_devinfo,  simplebus_get_devinfo),
 114         DEVMETHOD(ofw_bus_get_compat,   ofw_bus_gen_get_compat),
 115         DEVMETHOD(ofw_bus_get_model,    ofw_bus_gen_get_model),
 116         DEVMETHOD(ofw_bus_get_name,     ofw_bus_gen_get_name),
 117         DEVMETHOD(ofw_bus_get_node,     ofw_bus_gen_get_node),
 118         DEVMETHOD(ofw_bus_get_type,     ofw_bus_gen_get_type),
 119
 120         { 0, 0 }
 121 };
 122
 123 static driver_t simplebus_driver = {
 124         "simplebus",
 125         simplebus_methods,
 126         sizeof(struct simplebus_softc)
 127 };
 128
 129 devclass_t simplebus_devclass;
 130
 131 DRIVER_MODULE(simplebus, fdtbus, simplebus_driver, simplebus_devclass, 0, 0);
 132 DRIVER_MODULE(simplebus, simplebus, simplebus_driver, simplebus_devclass, 0,
 133     0);
 134
 135 static int
 136 simplebus_probe(device_t dev)
 137 {
 138
 139         if (!ofw_bus_is_compatible(dev, "simple-bus"))
 140                 return (ENXIO);
 141
 142         device_set_desc(dev, "Flattened device tree simple bus");
 143
 144         return (BUS_PROBE_GENERIC);
 145 }
 146
 147 static int
 148 simplebus_attach(device_t dev)
 149 {
 150         device_t dev_child;
 151         struct simplebus_devinfo *di;
 152         struct simplebus_softc *sc;
 153         phandle_t dt_node, dt_child;
 154
 155         sc = device_get_softc(dev);
 156
 157         /*
 158          * Walk simple-bus and add direct subordinates as our children.
 159          */
 160         dt_node = ofw_bus_get_node(dev);
 161         for (dt_child = OF_child(dt_node); dt_child != 0;
 162             dt_child = OF_peer(dt_child)) {
 163
 164                 /* Check and process 'status' property. */
 165                 if (!(fdt_is_enabled(dt_child)))
 166                         continue;
 167
 168                 if (!(fdt_pm_is_enabled(dt_child)))
 169                         continue;
 170
 171                 di = malloc(sizeof(*di), M_SIMPLEBUS, M_WAITOK | M_ZERO);
 172
 173                 if (ofw_bus_gen_setup_devinfo(&di->di_ofw, dt_child) != 0) {
 174                         free(di, M_SIMPLEBUS);
 175                         device_printf(dev, "could not set up devinfo\n");
 176                         continue;
 177                 }
 178
 179                 resource_list_init(&di->di_res);
 180                 if (fdt_reg_to_rl(dt_child, &di->di_res)) {
 181                         device_printf(dev,
 182                             "%s: could not process 'reg' "
 183                             "property\n", di->di_ofw.obd_name);
 184                         ofw_bus_gen_destroy_devinfo(&di->di_ofw);
 185                         free(di, M_SIMPLEBUS);
 186                         continue;
 187                 }
 188
 189                 if (fdt_intr_to_rl(dt_child, &di->di_res, di->di_intr_sl)) {
 190                         device_printf(dev, "%s: could not process "
 191                             "'interrupts' property\n", di->di_ofw.obd_name);
 192                         resource_list_free(&di->di_res);
 193                         ofw_bus_gen_destroy_devinfo(&di->di_ofw);
 194                         free(di, M_SIMPLEBUS);
 195                         continue;
 196                 }
 197
 198                 /* Add newbus device for this FDT node */
 199                 dev_child = device_add_child(dev, NULL, -1);
 200                 if (dev_child == NULL) {
 201                         device_printf(dev, "could not add child: %s\n",
 202                             di->di_ofw.obd_name);
 203                         resource_list_free(&di->di_res);
 204                         ofw_bus_gen_destroy_devinfo(&di->di_ofw);
 205                         free(di, M_SIMPLEBUS);
 206                         continue;
 207                 }
 208 #ifdef DEBUG
 209                 device_printf(dev, "added child: %s\n\n", di->di_ofw.obd_name);
 210 #endif
 211                 device_set_ivars(dev_child, di);
 212         }
 213
 214         return (bus_generic_attach(dev));
 215 }
 216
 217 static int
 218 simplebus_print_child(device_t dev, device_t child)
 219 {
 220         struct simplebus_devinfo *di;
 221         struct resource_list *rl;
 222         int rv;
 223
 224         di = device_get_ivars(child);
 225         rl = &di->di_res;
 226
 227         rv = 0;
 228         rv += bus_print_child_header(dev, child);
 229         rv += resource_list_print_type(rl, "mem", SYS_RES_MEMORY, "%#lx");
 230         rv += resource_list_print_type(rl, "irq", SYS_RES_IRQ, "%ld");
 231         rv += bus_print_child_footer(dev, child);
 232
 233         return (rv);
 234 }
 235
 236 static struct resource *
 237 simplebus_alloc_resource(device_t bus, device_t child, int type, int *rid,
 238     u_long start, u_long end, u_long count, u_int flags)
 239 {
 240         struct simplebus_devinfo *di;
 241         struct resource_list_entry *rle;
 242
 243         /*
 244          * Request for the default allocation with a given rid: use resource
 245          * list stored in the local device info.
 246          */
 247         if ((start == 0UL) && (end == ~0UL)) {
 248                 if ((di = device_get_ivars(child)) == NULL)
 249                         return (NULL);
 250
 251                 if (type == SYS_RES_IOPORT)
 252                         type = SYS_RES_MEMORY;
 253
 254                 rle = resource_list_find(&di->di_res, type, *rid);
 255                 if (rle == NULL) {
 256                         if (bootverbose)
 257                                 device_printf(bus, "no default resources for "
 258                                     "rid = %d, type = %d\n", *rid, type);
 259                         return (NULL);
 260                 }
 261                 start = rle->start;
 262                 end = rle->end;
 263                 count = rle->count;
 264         }
 265
 266         return (bus_generic_alloc_resource(bus, child, type, rid, start, end,
 267             count, flags));
 268 }
 269
 270 static struct resource_list *
 271 simplebus_get_resource_list(device_t bus, device_t child)
 272 {
 273         struct simplebus_devinfo *di;
 274
 275         di = device_get_ivars(child);
 276         return (&di->di_res);
 277 }
 278
 279 static int
 280 simplebus_setup_intr(device_t bus, device_t child, struct resource *res,
 281     int flags, driver_filter_t *filter, driver_intr_t *ihand, void *arg,
 282     void **cookiep)
 283 {
 284         struct simplebus_devinfo *di;
 285         enum intr_trigger trig;
 286         enum intr_polarity pol;
 287         int error, rid;
 288
 289         di = device_get_ivars(child);
 290         if (di == NULL)
 291                 return (ENXIO);
 292
 293         if (res == NULL)
 294                 return (EINVAL);
 295
 296         rid = rman_get_rid(res);
 297         if (rid >= DI_MAX_INTR_NUM)
 298                 return (ENOENT);
 299
 300         trig = di->di_intr_sl[rid].trig;
 301         pol = di->di_intr_sl[rid].pol;
 302         if (trig != INTR_TRIGGER_CONFORM || pol != INTR_POLARITY_CONFORM) {
 303                 error = bus_generic_config_intr(bus, rman_get_start(res),
 304                     trig, pol);
 305                 if (error)
 306                         return (error);
 307         }
 308
 309         error = bus_generic_setup_intr(bus, child, res, flags, filter, ihand,
 310             arg, cookiep);
 311         return (error);
 312 }
 313
 314 static const struct ofw_bus_devinfo *
 315 simplebus_get_devinfo(device_t bus, device_t child)
 316 {
 317         struct simplebus_devinfo *di;
 318
 319         di = device_get_ivars(child);
 320         return (&di->di_ofw);
 321 }