sys/powerpc/psim/iobus.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright 2002 by Peter Grehan. All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  * 3. The name of the author may not be used to endorse or promote products
  15  *    derived from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  22  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  24  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  25  * 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  * $FreeBSD$
  30  */
  31
  32 /*
  33  *  PSIM 'iobus' local bus. Should be set up in the device tree like:
  34  *
  35  *     /iobus@0x80000000/name psim-iobus
  36  *
  37  *  Code borrowed from various nexus.c and uninorth.c :-)
  38  */
  39
  40 #include <sys/param.h>
  41 #include <sys/systm.h>
  42 #include <sys/kernel.h>
  43 #include <sys/malloc.h>
  44 #include <sys/module.h>
  45 #include <sys/bus.h>
  46 #include <machine/bus.h>
  47 #include <sys/rman.h>
  48
  49 #include <dev/ofw/ofw_bus.h>
  50 #include <dev/ofw/openfirm.h>
  51
  52 #include <machine/vmparam.h>
  53 #include <vm/vm.h>
  54 #include <vm/pmap.h>
  55
  56 #include <machine/resource.h>
  57
  58 #include <powerpc/psim/iobusvar.h>
  59
  60 struct iobus_softc {
  61         phandle_t     sc_node;
  62         vm_offset_t   sc_addr;
  63         vm_offset_t   sc_size;
  64         struct        rman sc_mem_rman;
  65 };
  66
  67 static MALLOC_DEFINE(M_IOBUS, "iobus", "iobus device information");
  68
  69 static int  iobus_probe(device_t);
  70 static int  iobus_attach(device_t);
  71 static int  iobus_print_child(device_t dev, device_t child);
  72 static void iobus_probe_nomatch(device_t, device_t);
  73 static int  iobus_read_ivar(device_t, device_t, int, uintptr_t *);
  74 static int  iobus_write_ivar(device_t, device_t, int, uintptr_t);
  75 static struct   resource *iobus_alloc_resource(device_t, device_t, int, int *,
  76                                                rman_res_t, rman_res_t, rman_res_t,
  77                                                u_int);
  78 static int  iobus_activate_resource(device_t, device_t, int, int,
  79                                     struct resource *);
  80 static int  iobus_deactivate_resource(device_t, device_t, int, int,
  81                                       struct resource *);
  82 static int  iobus_release_resource(device_t, device_t, int, int,
  83                                    struct resource *);
  84
  85 /*
  86  * Bus interface definition
  87  */
  88 static device_method_t iobus_methods[] = {
  89         /* Device interface */
  90         DEVMETHOD(device_probe,         iobus_probe),
  91         DEVMETHOD(device_attach,        iobus_attach),
  92         DEVMETHOD(device_detach,        bus_generic_detach),
  93         DEVMETHOD(device_shutdown,      bus_generic_shutdown),
  94         DEVMETHOD(device_suspend,       bus_generic_suspend),
  95         DEVMETHOD(device_resume,        bus_generic_resume),
  96
  97         /* Bus interface */
  98         DEVMETHOD(bus_print_child,      iobus_print_child),
  99         DEVMETHOD(bus_probe_nomatch,    iobus_probe_nomatch),
 100         DEVMETHOD(bus_read_ivar,        iobus_read_ivar),
 101         DEVMETHOD(bus_write_ivar,       iobus_write_ivar),
 102         DEVMETHOD(bus_setup_intr,       bus_generic_setup_intr),
 103         DEVMETHOD(bus_teardown_intr,    bus_generic_teardown_intr),
 104
 105         DEVMETHOD(bus_alloc_resource,   iobus_alloc_resource),
 106         DEVMETHOD(bus_release_resource, iobus_release_resource),
 107         DEVMETHOD(bus_activate_resource, iobus_activate_resource),
 108         DEVMETHOD(bus_deactivate_resource, iobus_deactivate_resource),
 109
 110         { 0, 0 }
 111 };
 112
 113 static driver_t iobus_driver = {
 114         "iobus",
 115         iobus_methods,
 116         sizeof(struct iobus_softc)
 117 };
 118
 119 devclass_t iobus_devclass;
 120
 121 DRIVER_MODULE(iobus, ofwbus, iobus_driver, iobus_devclass, 0, 0);
 122
 123 static int
 124 iobus_probe(device_t dev)
 125 {
 126         const char *type = ofw_bus_get_name(dev);
 127
 128         if (strcmp(type, "psim-iobus") != 0)
 129                 return (ENXIO);
 130
 131         device_set_desc(dev, "PSIM local bus");
 132         return (0);
 133 }
 134
 135 /*
 136  * Add interrupt/addr range to the dev's resource list if present
 137  */
 138 static void
 139 iobus_add_intr(phandle_t devnode, struct iobus_devinfo *dinfo)
 140 {
 141         u_int intr = -1;
 142
 143         if (OF_getprop(devnode, "interrupt", &intr, sizeof(intr)) != -1) {
 144                 resource_list_add(&dinfo->id_resources,
 145                                   SYS_RES_IRQ, 0, intr, intr, 1);
 146         }
 147         dinfo->id_interrupt = intr;
 148 }
 149
 150
 151 static void
 152 iobus_add_reg(phandle_t devnode, struct iobus_devinfo *dinfo,
 153               vm_offset_t iobus_off)
 154 {
 155         u_int size;
 156         int i;
 157
 158         size = OF_getprop(devnode, "reg", dinfo->id_reg,sizeof(dinfo->id_reg));
 159
 160         if (size != -1) {
 161                 dinfo->id_nregs = size / (sizeof(dinfo->id_reg[0]));
 162
 163                 for (i = 0; i < dinfo->id_nregs; i+= 3) {
 164                         /*
 165                          * Scale the absolute addresses back to iobus
 166                          * relative offsets. This is to better simulate
 167                          * macio
 168                          */
 169                         dinfo->id_reg[i+1] -= iobus_off;
 170
 171                         resource_list_add(&dinfo->id_resources,
 172                                           SYS_RES_MEMORY, 0,
 173                                           dinfo->id_reg[i+1],
 174                                           dinfo->id_reg[i+1] +
 175                                               dinfo->id_reg[i+2],
 176                                           dinfo->id_reg[i+2]);
 177                 }
 178         }
 179 }
 180
 181
 182 static int
 183 iobus_attach(device_t dev)
 184 {
 185         struct iobus_softc *sc;
 186         struct iobus_devinfo *dinfo;
 187         phandle_t  root;
 188         phandle_t  child;
 189         device_t   cdev;
 190         char *name;
 191         u_int reg[2];
 192         int size;
 193
 194         sc = device_get_softc(dev);
 195         sc->sc_node = ofw_bus_get_node(dev);
 196
 197         /*
 198          * Find the base addr/size of the iobus, and initialize the
 199          * resource manager
 200          */
 201         size = OF_getprop(sc->sc_node, "reg", reg, sizeof(reg));
 202         if (size == sizeof(reg)) {
 203                 sc->sc_addr = reg[0];
 204                 sc->sc_size = reg[1];
 205         } else {
 206                 return (ENXIO);
 207         }
 208
 209         sc->sc_mem_rman.rm_type = RMAN_ARRAY;
 210         sc->sc_mem_rman.rm_descr = "IOBus Device Memory";
 211         if (rman_init(&sc->sc_mem_rman) != 0) {
 212                 device_printf(dev,
 213                     "failed to init mem range resources\n");
 214                 return (ENXIO);
 215         }
 216         rman_manage_region(&sc->sc_mem_rman, 0, sc->sc_size);
 217
 218         /*
 219          * Iterate through the sub-devices
 220          */
 221         root = sc->sc_node;
 222
 223         for (child = OF_child(root); child != 0; child = OF_peer(child)) {
 224                 OF_getprop_alloc(child, "name", (void **)&name);
 225
 226                 cdev = device_add_child(dev, NULL, -1);
 227                 if (cdev != NULL) {
 228                         dinfo = malloc(sizeof(*dinfo), M_IOBUS, M_WAITOK);
 229                         memset(dinfo, 0, sizeof(*dinfo));
 230                         resource_list_init(&dinfo->id_resources);
 231                         dinfo->id_node = child;
 232                         dinfo->id_name = name;
 233                         iobus_add_intr(child, dinfo);
 234                         iobus_add_reg(child, dinfo, sc->sc_addr);
 235                         device_set_ivars(cdev, dinfo);
 236                 } else {
 237                         OF_prop_free(name);
 238                 }
 239         }
 240
 241         return (bus_generic_attach(dev));
 242 }
 243
 244
 245 static int
 246 iobus_print_child(device_t dev, device_t child)
 247 {
 248         struct iobus_devinfo *dinfo;
 249         struct resource_list *rl;
 250         int retval = 0;
 251
 252         dinfo = device_get_ivars(child);
 253         rl = &dinfo->id_resources;
 254
 255         retval += bus_print_child_header(dev, child);
 256
 257         retval += printf(" offset 0x%x", dinfo->id_reg[1]);
 258         retval += resource_list_print_type(rl, "irq", SYS_RES_IRQ, "%jd");
 259
 260         retval += bus_print_child_footer(dev, child);
 261
 262         return (retval);
 263 }
 264
 265
 266 static void
 267 iobus_probe_nomatch(device_t dev, device_t child)
 268 {
 269 }
 270
 271
 272 static int
 273 iobus_read_ivar(device_t dev, device_t child, int which, uintptr_t *result)
 274 {
 275         struct iobus_devinfo *dinfo;
 276
 277         if ((dinfo = device_get_ivars(child)) == NULL)
 278                 return (ENOENT);
 279
 280         switch (which) {
 281         case IOBUS_IVAR_NODE:
 282                 *result = dinfo->id_node;
 283                 break;
 284         case IOBUS_IVAR_NAME:
 285                 *result = (uintptr_t)dinfo->id_name;
 286                 break;
 287         case IOBUS_IVAR_NREGS:
 288                 *result = dinfo->id_nregs;
 289                 break;
 290         case IOBUS_IVAR_REGS:
 291                 *result = (uintptr_t)dinfo->id_reg;
 292                 break;
 293         default:
 294                 return (ENOENT);
 295         }
 296
 297         return (0);
 298 }
 299
 300
 301 static int
 302 iobus_write_ivar(device_t dev, device_t child, int which, uintptr_t value)
 303 {
 304         return (EINVAL);
 305 }
 306
 307
 308 static struct resource *
 309 iobus_alloc_resource(device_t bus, device_t child, int type, int *rid,
 310                      rman_res_t start, rman_res_t end, rman_res_t count,
 311                      u_int flags)
 312 {
 313         struct iobus_softc *sc;
 314         int  needactivate;
 315         struct  resource *rv;
 316         struct  rman *rm;
 317
 318         sc = device_get_softc(bus);
 319
 320         needactivate = flags & RF_ACTIVE;
 321         flags &= ~RF_ACTIVE;
 322
 323         switch (type) {
 324         case SYS_RES_MEMORY:
 325         case SYS_RES_IOPORT:
 326                 rm = &sc->sc_mem_rman;
 327                 break;
 328         case SYS_RES_IRQ:
 329                 return (bus_alloc_resource(bus, type, rid, start, end, count,
 330                     flags));
 331         default:
 332                 device_printf(bus, "unknown resource request from %s\n",
 333                     device_get_nameunit(child));
 334                 return (NULL);
 335         }
 336
 337         rv = rman_reserve_resource(rm, start, end, count, flags, child);
 338         if (rv == NULL) {
 339                 device_printf(bus, "failed to reserve resource for %s\n",
 340                               device_get_nameunit(child));
 341                 return (NULL);
 342         }
 343
 344         rman_set_rid(rv, *rid);
 345
 346         if (needactivate) {
 347                 if (bus_activate_resource(child, type, *rid, rv) != 0) {
 348                         device_printf(bus,
 349                                       "failed to activate resource for %s\n",
 350                                       device_get_nameunit(child));
 351                         rman_release_resource(rv);
 352                         return (NULL);
 353                 }
 354         }
 355
 356         return (rv);
 357 }
 358
 359
 360 static int
 361 iobus_release_resource(device_t bus, device_t child, int type, int rid,
 362                        struct resource *res)
 363 {
 364         if (rman_get_flags(res) & RF_ACTIVE) {
 365                 int error = bus_deactivate_resource(child, type, rid, res);
 366                 if (error)
 367                         return error;
 368         }
 369
 370         return (rman_release_resource(res));
 371 }
 372
 373
 374 static int
 375 iobus_activate_resource(device_t bus, device_t child, int type, int rid,
 376                            struct resource *res)
 377 {
 378         struct iobus_softc *sc;
 379         void    *p;
 380
 381         sc = device_get_softc(bus);
 382
 383         if (type == SYS_RES_IRQ)
 384                 return (bus_activate_resource(bus, type, rid, res));
 385
 386         if ((type == SYS_RES_MEMORY) || (type == SYS_RES_IOPORT)) {
 387                 p = pmap_mapdev((vm_offset_t)rman_get_start(res) + sc->sc_addr,
 388                                 (vm_size_t)rman_get_size(res));
 389                 if (p == NULL)
 390                         return (ENOMEM);
 391                 rman_set_virtual(res, p);
 392                 rman_set_bustag(res, &bs_le_tag);
 393                 rman_set_bushandle(res, (u_long)p);
 394         }
 395
 396         return (rman_activate_resource(res));
 397 }
 398
 399
 400 static int
 401 iobus_deactivate_resource(device_t bus, device_t child, int type, int rid,
 402                           struct resource *res)
 403 {
 404         /*
 405          * If this is a memory resource, unmap it.
 406          */
 407         if ((type == SYS_RES_MEMORY) || (type == SYS_RES_IOPORT)) {
 408                 u_int32_t psize;
 409
 410                 psize = rman_get_size(res);
 411                 pmap_unmapdev((vm_offset_t)rman_get_virtual(res), psize);
 412         }
 413
 414         return (rman_deactivate_resource(res));
 415 }