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