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 and I/O memory address space.
  38  */
  39 #include "opt_platform.h"
  40
  41 #include <sys/cdefs.h>
  42 __FBSDID("$FreeBSD$");
  43
  44 #include <sys/param.h>
  45 #include <sys/systm.h>
  46 #include <sys/bus.h>
  47 #include <sys/kernel.h>
  48 #include <sys/malloc.h>
  49 #include <sys/module.h>
  50 #include <sys/rman.h>
  51 #include <sys/interrupt.h>
  52
  53 #include <vm/vm.h>
  54 #include <vm/pmap.h>
  55
  56 #include <machine/bus.h>
  57 #include <machine/resource.h>
  58 #include <machine/intr.h>
  59
  60 #ifdef FDT
  61 #include <dev/ofw/ofw_bus_subr.h>
  62 #include <dev/ofw/openfirm.h>
  63 #include "ofw_bus_if.h"
  64 #endif
  65
  66 extern struct bus_space memmap_bus;
  67
  68 static MALLOC_DEFINE(M_NEXUSDEV, "nexusdev", "Nexus device");
  69
  70 struct nexus_device {
  71         struct resource_list    nx_resources;
  72 };
  73
  74 #define DEVTONX(dev)    ((struct nexus_device *)device_get_ivars(dev))
  75
  76 static struct rman mem_rman;
  77 static struct rman irq_rman;
  78
  79 static device_probe_t nexus_fdt_probe;
  80 static int nexus_attach(device_t);
  81
  82 static  int nexus_print_child(device_t, device_t);
  83 static  device_t nexus_add_child(device_t, u_int, const char *, int);
  84 static  struct resource *nexus_alloc_resource(device_t, device_t, int, int *,
  85     rman_res_t, rman_res_t, rman_res_t, u_int);
  86 static  int nexus_activate_resource(device_t, device_t, int, int,
  87     struct resource *);
  88 static  int nexus_map_resource(device_t, device_t, int, struct resource *,
  89     struct resource_map_request *, struct resource_map *);
  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,
  94     rman_res_t, rman_res_t);
  95 static  int nexus_deactivate_resource(device_t, device_t, int, int,
  96     struct resource *);
  97 static  int nexus_release_resource(device_t, device_t, int, int,
  98     struct resource *);
  99
 100 static int nexus_setup_intr(device_t dev, device_t child, struct resource *res,
 101     int flags, driver_filter_t *filt, driver_intr_t *intr, void *arg, void **cookiep);
 102 static int nexus_teardown_intr(device_t, device_t, struct resource *, void *);
 103 static bus_space_tag_t nexus_get_bus_tag(device_t, device_t);
 104
 105 static int nexus_ofw_map_intr(device_t dev, device_t child, phandle_t iparent,
 106     int icells, pcell_t *intr);
 107
 108 static device_method_t nexus_methods[] = {
 109         /* Device interface */
 110         DEVMETHOD(device_probe,         nexus_fdt_probe),
 111         DEVMETHOD(device_attach,        nexus_attach),
 112
 113         /* OFW interface */
 114         DEVMETHOD(ofw_bus_map_intr,     nexus_ofw_map_intr),
 115
 116         /* Bus interface */
 117         DEVMETHOD(bus_print_child,      nexus_print_child),
 118         DEVMETHOD(bus_add_child,        nexus_add_child),
 119         DEVMETHOD(bus_alloc_resource,   nexus_alloc_resource),
 120         DEVMETHOD(bus_activate_resource,        nexus_activate_resource),
 121         DEVMETHOD(bus_map_resource,     nexus_map_resource),
 122         DEVMETHOD(bus_config_intr,      nexus_config_intr),
 123         DEVMETHOD(bus_get_resource_list, nexus_get_reslist),
 124         DEVMETHOD(bus_set_resource,     nexus_set_resource),
 125         DEVMETHOD(bus_deactivate_resource,      nexus_deactivate_resource),
 126         DEVMETHOD(bus_release_resource, nexus_release_resource),
 127         DEVMETHOD(bus_setup_intr,       nexus_setup_intr),
 128         DEVMETHOD(bus_teardown_intr,    nexus_teardown_intr),
 129         DEVMETHOD(bus_get_bus_tag,      nexus_get_bus_tag),
 130         { 0, 0 }
 131 };
 132
 133 static driver_t nexus_fdt_driver = {
 134         "nexus",
 135         nexus_methods,
 136         1                       /* no softc */
 137 };
 138
 139 static int
 140 nexus_fdt_probe(device_t dev)
 141 {
 142
 143         device_quiet(dev);
 144         return (BUS_PROBE_DEFAULT);
 145 }
 146
 147 static int
 148 nexus_attach(device_t dev)
 149 {
 150
 151         mem_rman.rm_start = 0;
 152         mem_rman.rm_end = BUS_SPACE_MAXADDR;
 153         mem_rman.rm_type = RMAN_ARRAY;
 154         mem_rman.rm_descr = "I/O memory addresses";
 155         if (rman_init(&mem_rman) ||
 156             rman_manage_region(&mem_rman, 0, BUS_SPACE_MAXADDR))
 157                 panic("nexus_attach mem_rman");
 158         irq_rman.rm_start = 0;
 159         irq_rman.rm_end = ~0;
 160         irq_rman.rm_type = RMAN_ARRAY;
 161         irq_rman.rm_descr = "Interrupts";
 162         if (rman_init(&irq_rman) || rman_manage_region(&irq_rman, 0, ~0))
 163                 panic("nexus_attach irq_rman");
 164
 165         nexus_add_child(dev, 8, "timer", 0);
 166         nexus_add_child(dev, 9, "rcons", 0);
 167         nexus_add_child(dev, 10, "ofwbus", 0);
 168
 169         bus_generic_probe(dev);
 170         bus_generic_attach(dev);
 171
 172         return (0);
 173 }
 174
 175 static int
 176 nexus_print_child(device_t bus, device_t child)
 177 {
 178         int retval = 0;
 179
 180         retval += bus_print_child_header(bus, child);
 181         retval += printf("\n");
 182
 183         return (retval);
 184 }
 185
 186 static device_t
 187 nexus_add_child(device_t bus, u_int order, const char *name, int unit)
 188 {
 189         device_t child;
 190         struct nexus_device *ndev;
 191
 192         ndev = malloc(sizeof(struct nexus_device), M_NEXUSDEV, M_NOWAIT|M_ZERO);
 193         if (!ndev)
 194                 return (0);
 195         resource_list_init(&ndev->nx_resources);
 196
 197         child = device_add_child_ordered(bus, order, name, unit);
 198
 199         /* should we free this in nexus_child_detached? */
 200         device_set_ivars(child, ndev);
 201
 202         return (child);
 203 }
 204
 205 /*
 206  * Allocate a resource on behalf of child.  NB: child is usually going to be a
 207  * child of one of our descendants, not a direct child of nexus0.
 208  * (Exceptions include footbridge.)
 209  */
 210 static struct resource *
 211 nexus_alloc_resource(device_t bus, device_t child, int type, int *rid,
 212     rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
 213 {
 214         struct nexus_device *ndev = DEVTONX(child);
 215         struct resource *rv;
 216         struct resource_list_entry *rle;
 217         struct rman *rm;
 218         int needactivate = flags & RF_ACTIVE;
 219
 220         /*
 221          * If this is an allocation of the "default" range for a given
 222          * RID, and we know what the resources for this device are
 223          * (ie. they aren't maintained by a child bus), then work out
 224          * the start/end values.
 225          */
 226         if (RMAN_IS_DEFAULT_RANGE(start, end) && (count == 1)) {
 227                 if (device_get_parent(child) != bus || ndev == NULL)
 228                         return(NULL);
 229                 rle = resource_list_find(&ndev->nx_resources, type, *rid);
 230                 if (rle == NULL)
 231                         return(NULL);
 232                 start = rle->start;
 233                 end = rle->end;
 234                 count = rle->count;
 235         }
 236
 237         switch (type) {
 238         case SYS_RES_IRQ:
 239                 rm = &irq_rman;
 240                 break;
 241
 242         case SYS_RES_MEMORY:
 243         case SYS_RES_IOPORT:
 244                 rm = &mem_rman;
 245                 break;
 246
 247         default:
 248                 return (NULL);
 249         }
 250
 251         rv = rman_reserve_resource(rm, start, end, count, flags, child);
 252         if (rv == NULL)
 253                 return (NULL);
 254
 255         rman_set_rid(rv, *rid);
 256         rman_set_bushandle(rv, rman_get_start(rv));
 257
 258         if (needactivate) {
 259                 if (bus_activate_resource(child, type, *rid, rv)) {
 260                         rman_release_resource(rv);
 261                         return (NULL);
 262                 }
 263         }
 264
 265         return (rv);
 266 }
 267
 268 static int
 269 nexus_release_resource(device_t bus, device_t child, int type, int rid,
 270     struct resource *res)
 271 {
 272         int error;
 273
 274         if (rman_get_flags(res) & RF_ACTIVE) {
 275                 error = bus_deactivate_resource(child, type, rid, res);
 276                 if (error)
 277                         return (error);
 278         }
 279         return (rman_release_resource(res));
 280 }
 281
 282 static int
 283 nexus_config_intr(device_t dev, int irq, enum intr_trigger trig,
 284     enum intr_polarity pol)
 285 {
 286
 287         return (EOPNOTSUPP);
 288 }
 289
 290 static int
 291 nexus_setup_intr(device_t dev, device_t child, struct resource *res, int flags,
 292     driver_filter_t *filt, driver_intr_t *intr, void *arg, void **cookiep)
 293 {
 294         int error;
 295
 296         if ((rman_get_flags(res) & RF_SHAREABLE) == 0)
 297                 flags |= INTR_EXCL;
 298
 299         /* We depend here on rman_activate_resource() being idempotent. */
 300         error = rman_activate_resource(res);
 301         if (error)
 302                 return (error);
 303
 304         error = intr_setup_irq(child, res, filt, intr, arg, flags, cookiep);
 305
 306         return (error);
 307 }
 308
 309 static int
 310 nexus_teardown_intr(device_t dev, device_t child, struct resource *r, void *ih)
 311 {
 312
 313         return (intr_teardown_irq(child, r, ih));
 314 }
 315
 316 static bus_space_tag_t
 317 nexus_get_bus_tag(device_t bus __unused, device_t child __unused)
 318 {
 319
 320         return (&memmap_bus);
 321 }
 322
 323 static int
 324 nexus_activate_resource(device_t bus, device_t child, int type, int rid,
 325     struct resource *r)
 326 {
 327         struct resource_map map;
 328         int err;
 329
 330         if ((err = rman_activate_resource(r)) != 0)
 331                 return (err);
 332
 333         /*
 334          * If this is a memory resource, map it into the kernel.
 335          */
 336         switch (type) {
 337         case SYS_RES_IOPORT:
 338         case SYS_RES_MEMORY:
 339                 if ((rman_get_flags(r) & RF_UNMAPPED) == 0) {
 340                         err = nexus_map_resource(bus, child, type, r, NULL,
 341                             &map);
 342                         if (err != 0) {
 343                                 rman_deactivate_resource(r);
 344                                 return (err);
 345                         }
 346
 347                         rman_set_mapping(r, &map);
 348                 }
 349                 break;
 350         case SYS_RES_IRQ:
 351                 err = intr_activate_irq(child, r);
 352                 if (err != 0) {
 353                         rman_deactivate_resource(r);
 354                         return (err);
 355                 }
 356         }
 357         return (0);
 358 }
 359
 360 static struct resource_list *
 361 nexus_get_reslist(device_t dev, device_t child)
 362 {
 363         struct nexus_device *ndev = DEVTONX(child);
 364
 365         return (&ndev->nx_resources);
 366 }
 367
 368 static int
 369 nexus_set_resource(device_t dev, device_t child, int type, int rid,
 370     rman_res_t start, rman_res_t count)
 371 {
 372         struct nexus_device     *ndev = DEVTONX(child);
 373         struct resource_list    *rl = &ndev->nx_resources;
 374
 375         /* XXX this should return a success/failure indicator */
 376         resource_list_add(rl, type, rid, start, start + count - 1, count);
 377
 378         return(0);
 379 }
 380
 381 static int
 382 nexus_deactivate_resource(device_t bus, device_t child, int type, int rid,
 383     struct resource *r)
 384 {
 385         bus_size_t psize;
 386         bus_space_handle_t vaddr;
 387
 388         if (type == SYS_RES_MEMORY || type == SYS_RES_IOPORT) {
 389                 psize = (bus_size_t)rman_get_size(r);
 390                 vaddr = rman_get_bushandle(r);
 391
 392                 if (vaddr != 0) {
 393                         bus_space_unmap(&memmap_bus, vaddr, psize);
 394                         rman_set_virtual(r, NULL);
 395                         rman_set_bushandle(r, 0);
 396                 }
 397         } else if (type == SYS_RES_IRQ) {
 398                 intr_deactivate_irq(child, r);
 399         }
 400
 401         return (rman_deactivate_resource(r));
 402 }
 403
 404 static int
 405 nexus_map_resource(device_t bus, device_t child, int type, struct resource *r,
 406     struct resource_map_request *argsp, struct resource_map *map)
 407 {
 408         struct resource_map_request args;
 409         rman_res_t end, length, start;
 410
 411         /* Resources must be active to be mapped. */
 412         if ((rman_get_flags(r) & RF_ACTIVE) == 0)
 413                 return (ENXIO);
 414
 415         /* Mappings are only supported on I/O and memory resources. */
 416         switch (type) {
 417         case SYS_RES_IOPORT:
 418         case SYS_RES_MEMORY:
 419                 break;
 420         default:
 421                 return (EINVAL);
 422         }
 423
 424         resource_init_map_request(&args);
 425         if (argsp != NULL)
 426                 bcopy(argsp, &args, imin(argsp->size, args.size));
 427         start = rman_get_start(r) + args.offset;
 428         if (args.length == 0)
 429                 length = rman_get_size(r);
 430         else
 431                 length = args.length;
 432         end = start + length - 1;
 433         if (start > rman_get_end(r) || start < rman_get_start(r))
 434                 return (EINVAL);
 435         if (end > rman_get_end(r) || end < start)
 436                 return (EINVAL);
 437
 438         map->r_vaddr = pmap_mapdev(start, length);
 439         map->r_bustag = &memmap_bus;
 440         map->r_size = length;
 441
 442         /*
 443          * The handle is the virtual address.
 444          */
 445         map->r_bushandle = (bus_space_handle_t)map->r_vaddr;
 446         return (0);
 447 }
 448
 449 static devclass_t nexus_fdt_devclass;
 450
 451 EARLY_DRIVER_MODULE(nexus_fdt, root, nexus_fdt_driver, nexus_fdt_devclass,
 452     0, 0, BUS_PASS_BUS + BUS_PASS_ORDER_FIRST);
 453
 454 static int
 455 nexus_ofw_map_intr(device_t dev, device_t child, phandle_t iparent, int icells,
 456     pcell_t *intr)
 457 {
 458         struct intr_map_data_fdt *fdt_data;
 459         size_t len;
 460         u_int irq;
 461
 462         len = sizeof(*fdt_data) + icells * sizeof(pcell_t);
 463         fdt_data = (struct intr_map_data_fdt *)intr_alloc_map_data(
 464             INTR_MAP_DATA_FDT, len, M_WAITOK | M_ZERO);
 465         fdt_data->iparent = iparent;
 466         fdt_data->ncells = icells;
 467         memcpy(fdt_data->cells, intr, icells * sizeof(pcell_t));
 468         irq = intr_map_irq(NULL, iparent, (struct intr_map_data *)fdt_data);
 469
 470         return (irq);
 471 }