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         { 0, 0 }
 110 };
 111
 112 static driver_t iobus_driver = {
 113         "iobus",
 114         iobus_methods,
 115         sizeof(struct iobus_softc)
 116 };
 117
 118 DRIVER_MODULE(iobus, ofwbus, iobus_driver, 0, 0);
 119
 120 static int
 121 iobus_probe(device_t dev)
 122 {
 123         const char *type = ofw_bus_get_name(dev);
 124
 125         if (strcmp(type, "psim-iobus") != 0)
 126                 return (ENXIO);
 127
 128         device_set_desc(dev, "PSIM local bus");
 129         return (0);
 130 }
 131
 132 /*
 133  * Add interrupt/addr range to the dev's resource list if present
 134  */
 135 static void
 136 iobus_add_intr(phandle_t devnode, struct iobus_devinfo *dinfo)
 137 {
 138         u_int intr = -1;
 139
 140         if (OF_getprop(devnode, "interrupt", &intr, sizeof(intr)) != -1) {
 141                 resource_list_add(&dinfo->id_resources,
 142                                   SYS_RES_IRQ, 0, intr, intr, 1);
 143         }
 144         dinfo->id_interrupt = intr;
 145 }
 146
 147 static void
 148 iobus_add_reg(phandle_t devnode, struct iobus_devinfo *dinfo,
 149               vm_offset_t iobus_off)
 150 {
 151         u_int size;
 152         int i;
 153
 154         size = OF_getprop(devnode, "reg", dinfo->id_reg,sizeof(dinfo->id_reg));
 155
 156         if (size != -1) {
 157                 dinfo->id_nregs = size / (sizeof(dinfo->id_reg[0]));
 158
 159                 for (i = 0; i < dinfo->id_nregs; i+= 3) {
 160                         /*
 161                          * Scale the absolute addresses back to iobus
 162                          * relative offsets. This is to better simulate
 163                          * macio
 164                          */
 165                         dinfo->id_reg[i+1] -= iobus_off;
 166
 167                         resource_list_add(&dinfo->id_resources,
 168                                           SYS_RES_MEMORY, 0,
 169                                           dinfo->id_reg[i+1],
 170                                           dinfo->id_reg[i+1] +
 171                                               dinfo->id_reg[i+2],
 172                                           dinfo->id_reg[i+2]);
 173                 }
 174         }
 175 }
 176
 177 static int
 178 iobus_attach(device_t dev)
 179 {
 180         struct iobus_softc *sc;
 181         struct iobus_devinfo *dinfo;
 182         phandle_t  root;
 183         phandle_t  child;
 184         device_t   cdev;
 185         char *name;
 186         u_int reg[2];
 187         int size;
 188
 189         sc = device_get_softc(dev);
 190         sc->sc_node = ofw_bus_get_node(dev);
 191
 192         /*
 193          * Find the base addr/size of the iobus, and initialize the
 194          * resource manager
 195          */
 196         size = OF_getprop(sc->sc_node, "reg", reg, sizeof(reg));
 197         if (size == sizeof(reg)) {
 198                 sc->sc_addr = reg[0];
 199                 sc->sc_size = reg[1];
 200         } else {
 201                 return (ENXIO);
 202         }
 203
 204         sc->sc_mem_rman.rm_type = RMAN_ARRAY;
 205         sc->sc_mem_rman.rm_descr = "IOBus Device Memory";
 206         if (rman_init(&sc->sc_mem_rman) != 0) {
 207                 device_printf(dev,
 208                     "failed to init mem range resources\n");
 209                 return (ENXIO);
 210         }
 211         rman_manage_region(&sc->sc_mem_rman, 0, sc->sc_size);
 212
 213         /*
 214          * Iterate through the sub-devices
 215          */
 216         root = sc->sc_node;
 217
 218         for (child = OF_child(root); child != 0; child = OF_peer(child)) {
 219                 OF_getprop_alloc(child, "name", (void **)&name);
 220
 221                 cdev = device_add_child(dev, NULL, -1);
 222                 if (cdev != NULL) {
 223                         dinfo = malloc(sizeof(*dinfo), M_IOBUS, M_WAITOK);
 224                         memset(dinfo, 0, sizeof(*dinfo));
 225                         resource_list_init(&dinfo->id_resources);
 226                         dinfo->id_node = child;
 227                         dinfo->id_name = name;
 228                         iobus_add_intr(child, dinfo);
 229                         iobus_add_reg(child, dinfo, sc->sc_addr);
 230                         device_set_ivars(cdev, dinfo);
 231                 } else {
 232                         OF_prop_free(name);
 233                 }
 234         }
 235
 236         return (bus_generic_attach(dev));
 237 }
 238
 239 static int
 240 iobus_print_child(device_t dev, device_t child)
 241 {
 242         struct iobus_devinfo *dinfo;
 243         struct resource_list *rl;
 244         int retval = 0;
 245
 246         dinfo = device_get_ivars(child);
 247         rl = &dinfo->id_resources;
 248
 249         retval += bus_print_child_header(dev, child);
 250
 251         retval += printf(" offset 0x%x", dinfo->id_reg[1]);
 252         retval += resource_list_print_type(rl, "irq", SYS_RES_IRQ, "%jd");
 253
 254         retval += bus_print_child_footer(dev, child);
 255
 256         return (retval);
 257 }
 258
 259 static void
 260 iobus_probe_nomatch(device_t dev, device_t child)
 261 {
 262 }
 263
 264 static int
 265 iobus_read_ivar(device_t dev, device_t child, int which, uintptr_t *result)
 266 {
 267         struct iobus_devinfo *dinfo;
 268
 269         if ((dinfo = device_get_ivars(child)) == NULL)
 270                 return (ENOENT);
 271
 272         switch (which) {
 273         case IOBUS_IVAR_NODE:
 274                 *result = dinfo->id_node;
 275                 break;
 276         case IOBUS_IVAR_NAME:
 277                 *result = (uintptr_t)dinfo->id_name;
 278                 break;
 279         case IOBUS_IVAR_NREGS:
 280                 *result = dinfo->id_nregs;
 281                 break;
 282         case IOBUS_IVAR_REGS:
 283                 *result = (uintptr_t)dinfo->id_reg;
 284                 break;
 285         default:
 286                 return (ENOENT);
 287         }
 288
 289         return (0);
 290 }
 291
 292 static int
 293 iobus_write_ivar(device_t dev, device_t child, int which, uintptr_t value)
 294 {
 295         return (EINVAL);
 296 }
 297
 298 static struct resource *
 299 iobus_alloc_resource(device_t bus, device_t child, int type, int *rid,
 300                      rman_res_t start, rman_res_t end, rman_res_t count,
 301                      u_int flags)
 302 {
 303         struct iobus_softc *sc;
 304         int  needactivate;
 305         struct  resource *rv;
 306         struct  rman *rm;
 307
 308         sc = device_get_softc(bus);
 309
 310         needactivate = flags & RF_ACTIVE;
 311         flags &= ~RF_ACTIVE;
 312
 313         switch (type) {
 314         case SYS_RES_MEMORY:
 315         case SYS_RES_IOPORT:
 316                 rm = &sc->sc_mem_rman;
 317                 break;
 318         case SYS_RES_IRQ:
 319                 return (bus_alloc_resource(bus, type, rid, start, end, count,
 320                     flags));
 321         default:
 322                 device_printf(bus, "unknown resource request from %s\n",
 323                     device_get_nameunit(child));
 324                 return (NULL);
 325         }
 326
 327         rv = rman_reserve_resource(rm, start, end, count, flags, child);
 328         if (rv == NULL) {
 329                 device_printf(bus, "failed to reserve resource for %s\n",
 330                               device_get_nameunit(child));
 331                 return (NULL);
 332         }
 333
 334         rman_set_rid(rv, *rid);
 335
 336         if (needactivate) {
 337                 if (bus_activate_resource(child, type, *rid, rv) != 0) {
 338                         device_printf(bus,
 339                                       "failed to activate resource for %s\n",
 340                                       device_get_nameunit(child));
 341                         rman_release_resource(rv);
 342                         return (NULL);
 343                 }
 344         }
 345
 346         return (rv);
 347 }
 348
 349 static int
 350 iobus_release_resource(device_t bus, device_t child, int type, int rid,
 351                        struct resource *res)
 352 {
 353         if (rman_get_flags(res) & RF_ACTIVE) {
 354                 int error = bus_deactivate_resource(child, type, rid, res);
 355                 if (error)
 356                         return error;
 357         }
 358
 359         return (rman_release_resource(res));
 360 }
 361
 362 static int
 363 iobus_activate_resource(device_t bus, device_t child, int type, int rid,
 364                            struct resource *res)
 365 {
 366         struct iobus_softc *sc;
 367         void    *p;
 368
 369         sc = device_get_softc(bus);
 370
 371         if (type == SYS_RES_IRQ)
 372                 return (bus_activate_resource(bus, type, rid, res));
 373
 374         if ((type == SYS_RES_MEMORY) || (type == SYS_RES_IOPORT)) {
 375                 p = pmap_mapdev((vm_paddr_t)rman_get_start(res) + sc->sc_addr,
 376                                 (vm_size_t)rman_get_size(res));
 377                 if (p == NULL)
 378                         return (ENOMEM);
 379                 rman_set_virtual(res, p);
 380                 rman_set_bustag(res, &bs_le_tag);
 381                 rman_set_bushandle(res, (u_long)p);
 382         }
 383
 384         return (rman_activate_resource(res));
 385 }
 386
 387 static int
 388 iobus_deactivate_resource(device_t bus, device_t child, int type, int rid,
 389                           struct resource *res)
 390 {
 391         /*
 392          * If this is a memory resource, unmap it.
 393          */
 394         if ((type == SYS_RES_MEMORY) || (type == SYS_RES_IOPORT)) {
 395                 u_int32_t psize;
 396
 397                 psize = rman_get_size(res);
 398                 pmap_unmapdev(rman_get_virtual(res), psize);
 399         }
 400
 401         return (rman_deactivate_resource(res));
 402 }