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