sys/riscv/riscv/nexus.c

   1 /*-
   2  * Copyright 1998 Massachusetts Institute of Technology
   3  *
   4  * Permission to use, copy, modify, and distribute this software and
   5  * its documentation for any purpose and without fee is hereby
   6  * granted, provided that both the above copyright notice and this
   7  * permission notice appear in all copies, that both the above
   8  * copyright notice and this permission notice appear in all
   9  * supporting documentation, and that the name of M.I.T. not be used
  10  * in advertising or publicity pertaining to distribution of the
  11  * software without specific, written prior permission.  M.I.T. makes
  12  * no representations about the suitability of this software for any
  13  * purpose.  It is provided "as is" without express or implied
  14  * warranty.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY M.I.T. ``AS IS''.  M.I.T. DISCLAIMS
  17  * ALL EXPRESS OR IMPLIED WARRANTIES WITH REGARD TO THIS SOFTWARE,
  18  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  19  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT
  20  * SHALL M.I.T. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  23  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  25  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  26  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  *
  29  */
  30
  31 /*
  32  * This code implements a `root nexus' for RISC-V Architecture
  33  * machines.  The function of the root nexus is to serve as an
  34  * attachment point for both processors and buses, and to manage
  35  * resources which are common to all of them.  In particular,
  36  * this code implements the core resource managers for interrupt
  37  * requests, DMA requests (which rightfully should be a part of the
  38  * ISA code but it's easier to do it here for now), I/O port addresses,
  39  * and I/O memory address space.
  40  */
  41
  42 #include <sys/cdefs.h>
  43 __FBSDID("$FreeBSD$");
  44
  45 #include <sys/param.h>
  46 #include <sys/systm.h>
  47 #include <sys/bus.h>
  48 #include <sys/kernel.h>
  49 #include <sys/malloc.h>
  50 #include <sys/module.h>
  51 #include <machine/bus.h>
  52 #include <sys/rman.h>
  53 #include <sys/interrupt.h>
  54
  55 #include <machine/vmparam.h>
  56 #include <machine/pcb.h>
  57 #include <vm/vm.h>
  58 #include <vm/pmap.h>
  59
  60 #include <machine/resource.h>
  61 #include <machine/intr.h>
  62
  63 #include "opt_platform.h"
  64
  65 #include <dev/fdt/fdt_common.h>
  66 #include "ofw_bus_if.h"
  67
  68 extern struct bus_space memmap_bus;
  69
  70 static MALLOC_DEFINE(M_NEXUSDEV, "nexusdev", "Nexus device");
  71
  72 struct nexus_device {
  73         struct resource_list    nx_resources;
  74 };
  75
  76 #define DEVTONX(dev)    ((struct nexus_device *)device_get_ivars(dev))
  77
  78 static struct rman mem_rman;
  79 static struct rman irq_rman;
  80
  81 static device_probe_t nexus_fdt_probe;
  82 static int nexus_attach(device_t);
  83
  84 static  int nexus_print_child(device_t, device_t);
  85 static  device_t nexus_add_child(device_t, u_int, const char *, int);
  86 static  struct resource *nexus_alloc_resource(device_t, device_t, int, int *,
  87     u_long, u_long, u_long, u_int);
  88 static  int nexus_activate_resource(device_t, device_t, int, int,
  89     struct resource *);
  90 static int nexus_config_intr(device_t dev, int irq, enum intr_trigger trig,
  91     enum intr_polarity pol);
  92 static struct resource_list *nexus_get_reslist(device_t, device_t);
  93 static  int nexus_set_resource(device_t, device_t, int, int, u_long, u_long);
  94 static  int nexus_deactivate_resource(device_t, device_t, int, int,
  95     struct resource *);
  96
  97 static int nexus_setup_intr(device_t dev, device_t child, struct resource *res,
  98     int flags, driver_filter_t *filt, driver_intr_t *intr, void *arg, void **cookiep);
  99 static int nexus_teardown_intr(device_t, device_t, struct resource *, void *);
 100
 101 static int nexus_ofw_map_intr(device_t dev, device_t child, phandle_t iparent,
 102     int icells, pcell_t *intr);
 103
 104 static device_method_t nexus_methods[] = {
 105         /* Device interface */
 106         DEVMETHOD(device_probe,         nexus_fdt_probe),
 107         DEVMETHOD(device_attach,        nexus_attach),
 108
 109         /* OFW interface */
 110         DEVMETHOD(ofw_bus_map_intr,     nexus_ofw_map_intr),
 111
 112         /* Bus interface */
 113         DEVMETHOD(bus_print_child,      nexus_print_child),
 114         DEVMETHOD(bus_add_child,        nexus_add_child),
 115         DEVMETHOD(bus_alloc_resource,   nexus_alloc_resource),
 116         DEVMETHOD(bus_activate_resource,        nexus_activate_resource),
 117         DEVMETHOD(bus_config_intr,      nexus_config_intr),
 118         DEVMETHOD(bus_get_resource_list, nexus_get_reslist),
 119         DEVMETHOD(bus_set_resource,     nexus_set_resource),
 120         DEVMETHOD(bus_deactivate_resource,      nexus_deactivate_resource),
 121         DEVMETHOD(bus_setup_intr,       nexus_setup_intr),
 122         DEVMETHOD(bus_teardown_intr,    nexus_teardown_intr),
 123
 124         { 0, 0 }
 125 };
 126
 127 static driver_t nexus_fdt_driver = {
 128         "nexus",
 129         nexus_methods,
 130         1                       /* no softc */
 131 };
 132
 133 static int
 134 nexus_fdt_probe(device_t dev)
 135 {
 136
 137         device_quiet(dev);
 138         return (BUS_PROBE_DEFAULT);
 139 }
 140
 141 static int
 142 nexus_attach(device_t dev)
 143 {
 144
 145         mem_rman.rm_start = 0;
 146         mem_rman.rm_end = BUS_SPACE_MAXADDR;
 147         mem_rman.rm_type = RMAN_ARRAY;
 148         mem_rman.rm_descr = "I/O memory addresses";
 149         if (rman_init(&mem_rman) ||
 150             rman_manage_region(&mem_rman, 0, BUS_SPACE_MAXADDR))
 151                 panic("nexus_attach mem_rman");
 152         irq_rman.rm_start = 0;
 153         irq_rman.rm_end = ~0;
 154         irq_rman.rm_type = RMAN_ARRAY;
 155         irq_rman.rm_descr = "Interrupts";
 156         if (rman_init(&irq_rman) || rman_manage_region(&irq_rman, 0, ~0))
 157                 panic("nexus_attach irq_rman");
 158
 159         nexus_add_child(dev, 8, "timer", 0);
 160         nexus_add_child(dev, 9, "rcons", 0);
 161         nexus_add_child(dev, 10, "ofwbus", 0);
 162
 163         bus_generic_probe(dev);
 164         bus_generic_attach(dev);
 165
 166         return (0);
 167 }
 168
 169 static int
 170 nexus_print_child(device_t bus, device_t child)
 171 {
 172         int retval = 0;
 173
 174         retval += bus_print_child_header(bus, child);
 175         retval += printf("\n");
 176
 177         return (retval);
 178 }
 179
 180 static device_t
 181 nexus_add_child(device_t bus, u_int order, const char *name, int unit)
 182 {
 183         device_t child;
 184         struct nexus_device *ndev;
 185
 186         ndev = malloc(sizeof(struct nexus_device), M_NEXUSDEV, M_NOWAIT|M_ZERO);
 187         if (!ndev)
 188                 return (0);
 189         resource_list_init(&ndev->nx_resources);
 190
 191         child = device_add_child_ordered(bus, order, name, unit);
 192
 193         /* should we free this in nexus_child_detached? */
 194         device_set_ivars(child, ndev);
 195
 196         return (child);
 197 }
 198
 199
 200 /*
 201  * Allocate a resource on behalf of child.  NB: child is usually going to be a
 202  * child of one of our descendants, not a direct child of nexus0.
 203  * (Exceptions include footbridge.)
 204  */
 205 static struct resource *
 206 nexus_alloc_resource(device_t bus, device_t child, int type, int *rid,
 207     u_long start, u_long end, u_long count, u_int flags)
 208 {
 209         struct nexus_device *ndev = DEVTONX(child);
 210         struct resource *rv;
 211         struct resource_list_entry *rle;
 212         struct rman *rm;
 213         int needactivate = flags & RF_ACTIVE;
 214
 215         /*
 216          * If this is an allocation of the "default" range for a given
 217          * RID, and we know what the resources for this device are
 218          * (ie. they aren't maintained by a child bus), then work out
 219          * the start/end values.
 220          */
 221         if (RMAN_IS_DEFAULT_RANGE(start, end) && (count == 1)) {
 222                 if (device_get_parent(child) != bus || ndev == NULL)
 223                         return(NULL);
 224                 rle = resource_list_find(&ndev->nx_resources, type, *rid);
 225                 if (rle == NULL)
 226                         return(NULL);
 227                 start = rle->start;
 228                 end = rle->end;
 229                 count = rle->count;
 230         }
 231
 232         switch (type) {
 233         case SYS_RES_IRQ:
 234                 rm = &irq_rman;
 235                 break;
 236
 237         case SYS_RES_MEMORY:
 238         case SYS_RES_IOPORT:
 239                 rm = &mem_rman;
 240                 break;
 241
 242         default:
 243                 return (NULL);
 244         }
 245
 246         rv = rman_reserve_resource(rm, start, end, count, flags, child);
 247         if (rv == NULL)
 248                 return (NULL);
 249
 250         rman_set_rid(rv, *rid);
 251         rman_set_bushandle(rv, rman_get_start(rv));
 252
 253         if (needactivate) {
 254                 if (bus_activate_resource(child, type, *rid, rv)) {
 255                         rman_release_resource(rv);
 256                         return (NULL);
 257                 }
 258         }
 259
 260         return (rv);
 261 }
 262
 263 static int
 264 nexus_config_intr(device_t dev, int irq, enum intr_trigger trig,
 265     enum intr_polarity pol)
 266 {
 267
 268         return (riscv_config_intr(irq, trig, pol));
 269 }
 270
 271 static int
 272 nexus_setup_intr(device_t dev, device_t child, struct resource *res, int flags,
 273     driver_filter_t *filt, driver_intr_t *intr, void *arg, void **cookiep)
 274 {
 275         int error;
 276
 277         if ((rman_get_flags(res) & RF_SHAREABLE) == 0)
 278                 flags |= INTR_EXCL;
 279
 280         /* We depend here on rman_activate_resource() being idempotent. */
 281         error = rman_activate_resource(res);
 282         if (error)
 283                 return (error);
 284
 285         error = riscv_setup_intr(device_get_nameunit(child), filt, intr,
 286             arg, rman_get_start(res), flags, cookiep);
 287
 288         return (error);
 289 }
 290
 291 static int
 292 nexus_teardown_intr(device_t dev, device_t child, struct resource *r, void *ih)
 293 {
 294
 295         return (riscv_teardown_intr(ih));
 296 }
 297
 298 static int
 299 nexus_activate_resource(device_t bus, device_t child, int type, int rid,
 300     struct resource *r)
 301 {
 302         int err;
 303         bus_addr_t paddr;
 304         bus_size_t psize;
 305         bus_space_handle_t vaddr;
 306
 307         if ((err = rman_activate_resource(r)) != 0)
 308                 return (err);
 309
 310         /*
 311          * If this is a memory resource, map it into the kernel.
 312          */
 313         if (type == SYS_RES_MEMORY || type == SYS_RES_IOPORT) {
 314                 paddr = (bus_addr_t)rman_get_start(r);
 315                 psize = (bus_size_t)rman_get_size(r);
 316                 err = bus_space_map(&memmap_bus, paddr, psize, 0, &vaddr);
 317                 if (err != 0) {
 318                         rman_deactivate_resource(r);
 319                         return (err);
 320                 }
 321                 rman_set_bustag(r, &memmap_bus);
 322                 rman_set_virtual(r, (void *)vaddr);
 323                 rman_set_bushandle(r, vaddr);
 324         }
 325         return (0);
 326 }
 327
 328 static struct resource_list *
 329 nexus_get_reslist(device_t dev, device_t child)
 330 {
 331         struct nexus_device *ndev = DEVTONX(child);
 332
 333         return (&ndev->nx_resources);
 334 }
 335
 336 static int
 337 nexus_set_resource(device_t dev, device_t child, int type, int rid,
 338     u_long start, u_long count)
 339 {
 340         struct nexus_device     *ndev = DEVTONX(child);
 341         struct resource_list    *rl = &ndev->nx_resources;
 342
 343         /* XXX this should return a success/failure indicator */
 344         resource_list_add(rl, type, rid, start, start + count - 1, count);
 345
 346         return(0);
 347 }
 348
 349
 350 static int
 351 nexus_deactivate_resource(device_t bus, device_t child, int type, int rid,
 352     struct resource *r)
 353 {
 354         bus_size_t psize;
 355         bus_space_handle_t vaddr;
 356
 357         psize = (bus_size_t)rman_get_size(r);
 358         vaddr = rman_get_bushandle(r);
 359
 360         if (vaddr != 0) {
 361                 bus_space_unmap(&memmap_bus, vaddr, psize);
 362                 rman_set_virtual(r, NULL);
 363                 rman_set_bushandle(r, 0);
 364         }
 365
 366         return (rman_deactivate_resource(r));
 367 }
 368
 369 static devclass_t nexus_fdt_devclass;
 370
 371 EARLY_DRIVER_MODULE(nexus_fdt, root, nexus_fdt_driver, nexus_fdt_devclass,
 372     0, 0, BUS_PASS_BUS + BUS_PASS_ORDER_FIRST);
 373
 374 static int
 375 nexus_ofw_map_intr(device_t dev, device_t child, phandle_t iparent, int icells,
 376     pcell_t *intr)
 377 {
 378         int irq;
 379
 380         if (icells == 3) {
 381                 irq = intr[1];
 382                 if (intr[0] == 0)
 383                         irq += 32; /* SPI */
 384                 else
 385                         irq += 16; /* PPI */
 386         } else
 387                 irq = intr[0];
 388
 389         return (irq);
 390 }