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 and I/O memory address space.
  38  */
  39
  40 #include "opt_acpi.h"
  41 #include "opt_platform.h"
  42
  43 #include <sys/cdefs.h>
  44 __FBSDID("$FreeBSD$");
  45
  46 #include <sys/param.h>
  47 #include <sys/systm.h>
  48 #include <sys/bus.h>
  49 #include <sys/kernel.h>
  50 #include <sys/malloc.h>
  51 #include <sys/module.h>
  52 #include <machine/bus.h>
  53 #include <sys/rman.h>
  54 #include <sys/interrupt.h>
  55
  56 #include <machine/machdep.h>
  57 #include <machine/vmparam.h>
  58 #include <machine/pcb.h>
  59 #include <vm/vm.h>
  60 #include <vm/pmap.h>
  61
  62 #include <machine/resource.h>
  63 #include <machine/intr.h>
  64
  65 #ifdef FDT
  66 #include <dev/ofw/ofw_bus_subr.h>
  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 #include "acpi_bus_if.h"
  74 #include "pcib_if.h"
  75 #endif
  76
  77 extern struct bus_space memmap_bus;
  78
  79 static MALLOC_DEFINE(M_NEXUSDEV, "nexusdev", "Nexus device");
  80
  81 struct nexus_device {
  82         struct resource_list    nx_resources;
  83 };
  84
  85 #define DEVTONX(dev)    ((struct nexus_device *)device_get_ivars(dev))
  86
  87 static struct rman mem_rman;
  88 static struct rman irq_rman;
  89
  90 static  int nexus_attach(device_t);
  91
  92 #ifdef FDT
  93 static device_probe_t   nexus_fdt_probe;
  94 static device_attach_t  nexus_fdt_attach;
  95 #endif
  96 #ifdef DEV_ACPI
  97 static device_probe_t   nexus_acpi_probe;
  98 static device_attach_t  nexus_acpi_attach;
  99 #endif
 100
 101 static  int nexus_print_child(device_t, device_t);
 102 static  device_t nexus_add_child(device_t, u_int, const char *, int);
 103 static  struct resource *nexus_alloc_resource(device_t, device_t, int, int *,
 104     rman_res_t, rman_res_t, rman_res_t, u_int);
 105 static  int nexus_activate_resource(device_t, device_t, int, int,
 106     struct resource *);
 107 static  int nexus_adjust_resource(device_t, device_t, int, struct resource *,
 108     rman_res_t, rman_res_t);
 109 static  int nexus_map_resource(device_t, device_t, int, struct resource *,
 110     struct resource_map_request *, struct resource_map *);
 111 static int nexus_config_intr(device_t dev, int irq, enum intr_trigger trig,
 112     enum intr_polarity pol);
 113 static struct resource_list *nexus_get_reslist(device_t, device_t);
 114 static  int nexus_set_resource(device_t, device_t, int, int,
 115     rman_res_t, rman_res_t);
 116 static  int nexus_deactivate_resource(device_t, device_t, int, int,
 117     struct resource *);
 118 static int nexus_release_resource(device_t, device_t, int, int,
 119     struct resource *);
 120
 121 static int nexus_setup_intr(device_t dev, device_t child, struct resource *res,
 122     int flags, driver_filter_t *filt, driver_intr_t *intr, void *arg, void **cookiep);
 123 static int nexus_teardown_intr(device_t, device_t, struct resource *, void *);
 124 static bus_space_tag_t nexus_get_bus_tag(device_t, device_t);
 125 #ifdef SMP
 126 static int nexus_bind_intr(device_t, device_t, struct resource *, int);
 127 #endif
 128
 129 #ifdef FDT
 130 static int nexus_ofw_map_intr(device_t dev, device_t child, phandle_t iparent,
 131     int icells, pcell_t *intr);
 132 #endif
 133
 134 static device_method_t nexus_methods[] = {
 135         /* Bus interface */
 136         DEVMETHOD(bus_print_child,      nexus_print_child),
 137         DEVMETHOD(bus_add_child,        nexus_add_child),
 138         DEVMETHOD(bus_alloc_resource,   nexus_alloc_resource),
 139         DEVMETHOD(bus_activate_resource,        nexus_activate_resource),
 140         DEVMETHOD(bus_adjust_resource,  nexus_adjust_resource),
 141         DEVMETHOD(bus_map_resource,     nexus_map_resource),
 142         DEVMETHOD(bus_config_intr,      nexus_config_intr),
 143         DEVMETHOD(bus_get_resource_list, nexus_get_reslist),
 144         DEVMETHOD(bus_set_resource,     nexus_set_resource),
 145         DEVMETHOD(bus_deactivate_resource,      nexus_deactivate_resource),
 146         DEVMETHOD(bus_release_resource, nexus_release_resource),
 147         DEVMETHOD(bus_setup_intr,       nexus_setup_intr),
 148         DEVMETHOD(bus_teardown_intr,    nexus_teardown_intr),
 149         DEVMETHOD(bus_get_bus_tag,      nexus_get_bus_tag),
 150 #ifdef SMP
 151         DEVMETHOD(bus_bind_intr,        nexus_bind_intr),
 152 #endif
 153         { 0, 0 }
 154 };
 155
 156 static driver_t nexus_driver = {
 157         "nexus",
 158         nexus_methods,
 159         1                       /* no softc */
 160 };
 161
 162 static int
 163 nexus_attach(device_t dev)
 164 {
 165
 166         mem_rman.rm_start = 0;
 167         mem_rman.rm_end = BUS_SPACE_MAXADDR;
 168         mem_rman.rm_type = RMAN_ARRAY;
 169         mem_rman.rm_descr = "I/O memory addresses";
 170         if (rman_init(&mem_rman) ||
 171             rman_manage_region(&mem_rman, 0, BUS_SPACE_MAXADDR))
 172                 panic("nexus_attach mem_rman");
 173         irq_rman.rm_start = 0;
 174         irq_rman.rm_end = ~0;
 175         irq_rman.rm_type = RMAN_ARRAY;
 176         irq_rman.rm_descr = "Interrupts";
 177         if (rman_init(&irq_rman) || rman_manage_region(&irq_rman, 0, ~0))
 178                 panic("nexus_attach irq_rman");
 179
 180         bus_generic_probe(dev);
 181         bus_generic_attach(dev);
 182
 183         return (0);
 184 }
 185
 186 static int
 187 nexus_print_child(device_t bus, device_t child)
 188 {
 189         int retval = 0;
 190
 191         retval += bus_print_child_header(bus, child);
 192         retval += printf("\n");
 193
 194         return (retval);
 195 }
 196
 197 static device_t
 198 nexus_add_child(device_t bus, u_int order, const char *name, int unit)
 199 {
 200         device_t child;
 201         struct nexus_device *ndev;
 202
 203         ndev = malloc(sizeof(struct nexus_device), M_NEXUSDEV, M_NOWAIT|M_ZERO);
 204         if (!ndev)
 205                 return (0);
 206         resource_list_init(&ndev->nx_resources);
 207
 208         child = device_add_child_ordered(bus, order, name, unit);
 209
 210         /* should we free this in nexus_child_detached? */
 211         device_set_ivars(child, ndev);
 212
 213         return (child);
 214 }
 215
 216 /*
 217  * Allocate a resource on behalf of child.  NB: child is usually going to be a
 218  * child of one of our descendants, not a direct child of nexus0.
 219  * (Exceptions include footbridge.)
 220  */
 221 static struct resource *
 222 nexus_alloc_resource(device_t bus, device_t child, int type, int *rid,
 223     rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
 224 {
 225         struct nexus_device *ndev = DEVTONX(child);
 226         struct resource *rv;
 227         struct resource_list_entry *rle;
 228         struct rman *rm;
 229         int needactivate = flags & RF_ACTIVE;
 230
 231         /*
 232          * If this is an allocation of the "default" range for a given
 233          * RID, and we know what the resources for this device are
 234          * (ie. they aren't maintained by a child bus), then work out
 235          * the start/end values.
 236          */
 237         if (RMAN_IS_DEFAULT_RANGE(start, end) && (count == 1)) {
 238                 if (device_get_parent(child) != bus || ndev == NULL)
 239                         return(NULL);
 240                 rle = resource_list_find(&ndev->nx_resources, type, *rid);
 241                 if (rle == NULL)
 242                         return(NULL);
 243                 start = rle->start;
 244                 end = rle->end;
 245                 count = rle->count;
 246         }
 247
 248         switch (type) {
 249         case SYS_RES_IRQ:
 250                 rm = &irq_rman;
 251                 break;
 252
 253         case SYS_RES_MEMORY:
 254         case SYS_RES_IOPORT:
 255                 rm = &mem_rman;
 256                 break;
 257
 258         default:
 259                 return (NULL);
 260         }
 261
 262         rv = rman_reserve_resource(rm, start, end, count, flags, child);
 263         if (rv == NULL)
 264                 return (NULL);
 265
 266         rman_set_rid(rv, *rid);
 267         rman_set_bushandle(rv, rman_get_start(rv));
 268
 269         if (needactivate) {
 270                 if (bus_activate_resource(child, type, *rid, rv)) {
 271                         rman_release_resource(rv);
 272                         return (NULL);
 273                 }
 274         }
 275
 276         return (rv);
 277 }
 278
 279 static int
 280 nexus_adjust_resource(device_t bus __unused, device_t child __unused, int type,
 281     struct resource *r, rman_res_t start, rman_res_t end)
 282 {
 283         struct rman *rm;
 284
 285         switch (type) {
 286         case SYS_RES_IRQ:
 287                 rm = &irq_rman;
 288                 break;
 289         case SYS_RES_MEMORY:
 290                 rm = &mem_rman;
 291                 break;
 292         default:
 293                 return (EINVAL);
 294         }
 295         if (rman_is_region_manager(r, rm) == 0)
 296                 return (EINVAL);
 297         return (rman_adjust_resource(r, start, end));
 298 }
 299
 300 static int
 301 nexus_release_resource(device_t bus, device_t child, int type, int rid,
 302     struct resource *res)
 303 {
 304         int error;
 305
 306         if (rman_get_flags(res) & RF_ACTIVE) {
 307                 error = bus_deactivate_resource(child, type, rid, res);
 308                 if (error)
 309                         return (error);
 310         }
 311         return (rman_release_resource(res));
 312 }
 313
 314 static int
 315 nexus_config_intr(device_t dev, int irq, enum intr_trigger trig,
 316     enum intr_polarity pol)
 317 {
 318
 319         /*
 320          * On arm64 (due to INTRNG), ACPI interrupt configuration is
 321          * done in nexus_acpi_map_intr().
 322          */
 323         return (0);
 324 }
 325
 326 static int
 327 nexus_setup_intr(device_t dev, device_t child, struct resource *res, int flags,
 328     driver_filter_t *filt, driver_intr_t *intr, void *arg, void **cookiep)
 329 {
 330         int error;
 331
 332         if ((rman_get_flags(res) & RF_SHAREABLE) == 0)
 333                 flags |= INTR_EXCL;
 334
 335         /* We depend here on rman_activate_resource() being idempotent. */
 336         error = rman_activate_resource(res);
 337         if (error)
 338                 return (error);
 339
 340         error = intr_setup_irq(child, res, filt, intr, arg, flags, cookiep);
 341
 342         return (error);
 343 }
 344
 345 static int
 346 nexus_teardown_intr(device_t dev, device_t child, struct resource *r, void *ih)
 347 {
 348
 349         return (intr_teardown_irq(child, r, ih));
 350 }
 351
 352 #ifdef SMP
 353 static int
 354 nexus_bind_intr(device_t dev, device_t child, struct resource *irq, int cpu)
 355 {
 356
 357         return (intr_bind_irq(child, irq, cpu));
 358 }
 359 #endif
 360
 361 static bus_space_tag_t
 362 nexus_get_bus_tag(device_t bus __unused, device_t child __unused)
 363 {
 364
 365         return(&memmap_bus);
 366 }
 367
 368 static int
 369 nexus_activate_resource(device_t bus, device_t child, int type, int rid,
 370     struct resource *r)
 371 {
 372         struct resource_map map;
 373         int err;
 374
 375         if ((err = rman_activate_resource(r)) != 0)
 376                 return (err);
 377
 378         /*
 379          * If this is a memory resource, map it into the kernel.
 380          */
 381         switch (type) {
 382         case SYS_RES_IOPORT:
 383         case SYS_RES_MEMORY:
 384                 if ((rman_get_flags(r) & RF_UNMAPPED) == 0) {
 385                         err = nexus_map_resource(bus, child, type, r, NULL,
 386                             &map);
 387                         if (err != 0) {
 388                                 rman_deactivate_resource(r);
 389                                 return (err);
 390                         }
 391
 392                         rman_set_mapping(r, &map);
 393                 }
 394                 break;
 395         case SYS_RES_IRQ:
 396                 err = intr_activate_irq(child, r);
 397                 if (err != 0) {
 398                         rman_deactivate_resource(r);
 399                         return (err);
 400                 }
 401         }
 402         return (0);
 403 }
 404
 405 static struct resource_list *
 406 nexus_get_reslist(device_t dev, device_t child)
 407 {
 408         struct nexus_device *ndev = DEVTONX(child);
 409
 410         return (&ndev->nx_resources);
 411 }
 412
 413 static int
 414 nexus_set_resource(device_t dev, device_t child, int type, int rid,
 415     rman_res_t start, rman_res_t count)
 416 {
 417         struct nexus_device     *ndev = DEVTONX(child);
 418         struct resource_list    *rl = &ndev->nx_resources;
 419
 420         /* XXX this should return a success/failure indicator */
 421         resource_list_add(rl, type, rid, start, start + count - 1, count);
 422
 423         return(0);
 424 }
 425
 426 static int
 427 nexus_deactivate_resource(device_t bus, device_t child, int type, int rid,
 428     struct resource *r)
 429 {
 430         bus_size_t psize;
 431         bus_space_handle_t vaddr;
 432
 433         if (type == SYS_RES_MEMORY || type == SYS_RES_IOPORT) {
 434                 psize = (bus_size_t)rman_get_size(r);
 435                 vaddr = rman_get_bushandle(r);
 436
 437                 if (vaddr != 0) {
 438                         bus_space_unmap(&memmap_bus, vaddr, psize);
 439                         rman_set_virtual(r, NULL);
 440                         rman_set_bushandle(r, 0);
 441                 }
 442         } else if (type == SYS_RES_IRQ) {
 443                 intr_deactivate_irq(child, r);
 444         }
 445
 446         return (rman_deactivate_resource(r));
 447 }
 448
 449 static int
 450 nexus_map_resource(device_t bus, device_t child, int type, struct resource *r,
 451     struct resource_map_request *argsp, struct resource_map *map)
 452 {
 453         struct resource_map_request args;
 454         rman_res_t end, length, start;
 455
 456         /* Resources must be active to be mapped. */
 457         if ((rman_get_flags(r) & RF_ACTIVE) == 0)
 458                 return (ENXIO);
 459
 460         /* Mappings are only supported on I/O and memory resources. */
 461         switch (type) {
 462         case SYS_RES_IOPORT:
 463         case SYS_RES_MEMORY:
 464                 break;
 465         default:
 466                 return (EINVAL);
 467         }
 468
 469         resource_init_map_request(&args);
 470         if (argsp != NULL)
 471                 bcopy(argsp, &args, imin(argsp->size, args.size));
 472         start = rman_get_start(r) + args.offset;
 473         if (args.length == 0)
 474                 length = rman_get_size(r);
 475         else
 476                 length = args.length;
 477         end = start + length - 1;
 478         if (start > rman_get_end(r) || start < rman_get_start(r))
 479                 return (EINVAL);
 480         if (end > rman_get_end(r) || end < start)
 481                 return (EINVAL);
 482
 483         map->r_vaddr = pmap_mapdev_attr(start, length, args.memattr);
 484         map->r_bustag = &memmap_bus;
 485         map->r_size = length;
 486
 487         /*
 488          * The handle is the virtual address.
 489          */
 490         map->r_bushandle = (bus_space_handle_t)map->r_vaddr;
 491         return (0);
 492 }
 493
 494 #ifdef FDT
 495 static device_method_t nexus_fdt_methods[] = {
 496         /* Device interface */
 497         DEVMETHOD(device_probe,         nexus_fdt_probe),
 498         DEVMETHOD(device_attach,        nexus_fdt_attach),
 499
 500         /* OFW interface */
 501         DEVMETHOD(ofw_bus_map_intr,     nexus_ofw_map_intr),
 502
 503         DEVMETHOD_END,
 504 };
 505
 506 #define nexus_baseclasses nexus_fdt_baseclasses
 507 DEFINE_CLASS_1(nexus, nexus_fdt_driver, nexus_fdt_methods, 1, nexus_driver);
 508 #undef nexus_baseclasses
 509
 510 EARLY_DRIVER_MODULE(nexus_fdt, root, nexus_fdt_driver, 0, 0,
 511     BUS_PASS_BUS + BUS_PASS_ORDER_FIRST);
 512
 513 static int
 514 nexus_fdt_probe(device_t dev)
 515 {
 516
 517         if (arm64_bus_method != ARM64_BUS_FDT)
 518                 return (ENXIO);
 519
 520         device_quiet(dev);
 521         return (BUS_PROBE_DEFAULT);
 522 }
 523
 524 static int
 525 nexus_fdt_attach(device_t dev)
 526 {
 527
 528         nexus_add_child(dev, 10, "ofwbus", 0);
 529         return (nexus_attach(dev));
 530 }
 531
 532 static int
 533 nexus_ofw_map_intr(device_t dev, device_t child, phandle_t iparent, int icells,
 534     pcell_t *intr)
 535 {
 536         u_int irq;
 537         struct intr_map_data_fdt *fdt_data;
 538         size_t len;
 539
 540         len = sizeof(*fdt_data) + icells * sizeof(pcell_t);
 541         fdt_data = (struct intr_map_data_fdt *)intr_alloc_map_data(
 542             INTR_MAP_DATA_FDT, len, M_WAITOK | M_ZERO);
 543         fdt_data->iparent = iparent;
 544         fdt_data->ncells = icells;
 545         memcpy(fdt_data->cells, intr, icells * sizeof(pcell_t));
 546         irq = intr_map_irq(NULL, iparent, (struct intr_map_data *)fdt_data);
 547         return (irq);
 548 }
 549 #endif
 550
 551 #ifdef DEV_ACPI
 552 static int nexus_acpi_map_intr(device_t dev, device_t child, u_int irq, int trig, int pol);
 553
 554 static device_method_t nexus_acpi_methods[] = {
 555         /* Device interface */
 556         DEVMETHOD(device_probe,         nexus_acpi_probe),
 557         DEVMETHOD(device_attach,        nexus_acpi_attach),
 558
 559         /* ACPI interface */
 560         DEVMETHOD(acpi_bus_map_intr,    nexus_acpi_map_intr),
 561
 562         DEVMETHOD_END,
 563 };
 564
 565 #define nexus_baseclasses nexus_acpi_baseclasses
 566 DEFINE_CLASS_1(nexus, nexus_acpi_driver, nexus_acpi_methods, 1,
 567     nexus_driver);
 568 #undef nexus_baseclasses
 569
 570 EARLY_DRIVER_MODULE(nexus_acpi, root, nexus_acpi_driver, 0, 0,
 571     BUS_PASS_BUS + BUS_PASS_ORDER_FIRST);
 572
 573 static int
 574 nexus_acpi_probe(device_t dev)
 575 {
 576
 577         if (arm64_bus_method != ARM64_BUS_ACPI || acpi_identify() != 0)
 578                 return (ENXIO);
 579
 580         device_quiet(dev);
 581         return (BUS_PROBE_LOW_PRIORITY);
 582 }
 583
 584 static int
 585 nexus_acpi_attach(device_t dev)
 586 {
 587
 588         nexus_add_child(dev, 10, "acpi", 0);
 589         return (nexus_attach(dev));
 590 }
 591
 592 static int
 593 nexus_acpi_map_intr(device_t dev, device_t child, u_int irq, int trig, int pol)
 594 {
 595         struct intr_map_data_acpi *acpi_data;
 596         size_t len;
 597
 598         len = sizeof(*acpi_data);
 599         acpi_data = (struct intr_map_data_acpi *)intr_alloc_map_data(
 600             INTR_MAP_DATA_ACPI, len, M_WAITOK | M_ZERO);
 601         acpi_data->irq = irq;
 602         acpi_data->pol = pol;
 603         acpi_data->trig = trig;
 604
 605         /*
 606          * TODO: This will only handle a single interrupt controller.
 607          * ACPI will map multiple controllers into a single virtual IRQ
 608          * space. Each controller has a System Vector Base to hold the
 609          * first irq it handles in this space. As such the correct way
 610          * to handle interrupts with ACPI is to search through the
 611          * controllers for the largest base value that is no larger than
 612          * the IRQ value.
 613          */
 614         irq = intr_map_irq(NULL, ACPI_INTR_XREF,
 615             (struct intr_map_data *)acpi_data);
 616         return (irq);
 617 }
 618 #endif