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