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/vmparam.h>
  59 #include <machine/pcb.h>
  60 #include <vm/vm.h>
  61 #include <vm/pmap.h>
  62
  63 #include <machine/resource.h>
  64 #include <machine/intr.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 static bus_space_tag_t nexus_get_bus_tag(device_t, device_t);
 117 #ifdef SMP
 118 static int nexus_bind_intr(device_t, device_t, struct resource *, int);
 119 #endif
 120
 121 #ifdef FDT
 122 static int nexus_ofw_map_intr(device_t dev, device_t child, phandle_t iparent,
 123     int icells, pcell_t *intr);
 124 #endif
 125
 126 static device_method_t nexus_methods[] = {
 127         /* Bus interface */
 128         DEVMETHOD(bus_print_child,      nexus_print_child),
 129         DEVMETHOD(bus_add_child,        nexus_add_child),
 130         DEVMETHOD(bus_alloc_resource,   nexus_alloc_resource),
 131         DEVMETHOD(bus_activate_resource,        nexus_activate_resource),
 132         DEVMETHOD(bus_config_intr,      nexus_config_intr),
 133         DEVMETHOD(bus_get_resource_list, nexus_get_reslist),
 134         DEVMETHOD(bus_set_resource,     nexus_set_resource),
 135         DEVMETHOD(bus_deactivate_resource,      nexus_deactivate_resource),
 136         DEVMETHOD(bus_setup_intr,       nexus_setup_intr),
 137         DEVMETHOD(bus_teardown_intr,    nexus_teardown_intr),
 138         DEVMETHOD(bus_get_bus_tag,      nexus_get_bus_tag),
 139 #ifdef SMP
 140         DEVMETHOD(bus_bind_intr,        nexus_bind_intr),
 141 #endif
 142         { 0, 0 }
 143 };
 144
 145 static driver_t nexus_driver = {
 146         "nexus",
 147         nexus_methods,
 148         1                       /* no softc */
 149 };
 150
 151 static int
 152 nexus_attach(device_t dev)
 153 {
 154
 155         mem_rman.rm_start = 0;
 156         mem_rman.rm_end = BUS_SPACE_MAXADDR;
 157         mem_rman.rm_type = RMAN_ARRAY;
 158         mem_rman.rm_descr = "I/O memory addresses";
 159         if (rman_init(&mem_rman) ||
 160             rman_manage_region(&mem_rman, 0, BUS_SPACE_MAXADDR))
 161                 panic("nexus_attach mem_rman");
 162         irq_rman.rm_start = 0;
 163         irq_rman.rm_end = ~0;
 164         irq_rman.rm_type = RMAN_ARRAY;
 165         irq_rman.rm_descr = "Interrupts";
 166         if (rman_init(&irq_rman) || rman_manage_region(&irq_rman, 0, ~0))
 167                 panic("nexus_attach irq_rman");
 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 /*
 207  * Allocate a resource on behalf of child.  NB: child is usually going to be a
 208  * child of one of our descendants, not a direct child of nexus0.
 209  * (Exceptions include footbridge.)
 210  */
 211 static struct resource *
 212 nexus_alloc_resource(device_t bus, device_t child, int type, int *rid,
 213     rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
 214 {
 215         struct nexus_device *ndev = DEVTONX(child);
 216         struct resource *rv;
 217         struct resource_list_entry *rle;
 218         struct rman *rm;
 219         int needactivate = flags & RF_ACTIVE;
 220
 221         /*
 222          * If this is an allocation of the "default" range for a given
 223          * RID, and we know what the resources for this device are
 224          * (ie. they aren't maintained by a child bus), then work out
 225          * the start/end values.
 226          */
 227         if (RMAN_IS_DEFAULT_RANGE(start, end) && (count == 1)) {
 228                 if (device_get_parent(child) != bus || ndev == NULL)
 229                         return(NULL);
 230                 rle = resource_list_find(&ndev->nx_resources, type, *rid);
 231                 if (rle == NULL)
 232                         return(NULL);
 233                 start = rle->start;
 234                 end = rle->end;
 235                 count = rle->count;
 236         }
 237
 238         switch (type) {
 239         case SYS_RES_IRQ:
 240                 rm = &irq_rman;
 241                 break;
 242
 243         case SYS_RES_MEMORY:
 244         case SYS_RES_IOPORT:
 245                 rm = &mem_rman;
 246                 break;
 247
 248         default:
 249                 return (NULL);
 250         }
 251
 252         rv = rman_reserve_resource(rm, start, end, count, flags, child);
 253         if (rv == NULL)
 254                 return (NULL);
 255
 256         rman_set_rid(rv, *rid);
 257         rman_set_bushandle(rv, rman_get_start(rv));
 258
 259         if (needactivate) {
 260                 if (bus_activate_resource(child, type, *rid, rv)) {
 261                         rman_release_resource(rv);
 262                         return (NULL);
 263                 }
 264         }
 265
 266         return (rv);
 267 }
 268
 269 static int
 270 nexus_config_intr(device_t dev, int irq, enum intr_trigger trig,
 271     enum intr_polarity pol)
 272 {
 273
 274         return (intr_irq_config(irq, trig, pol));
 275 }
 276
 277 static int
 278 nexus_setup_intr(device_t dev, device_t child, struct resource *res, int flags,
 279     driver_filter_t *filt, driver_intr_t *intr, void *arg, void **cookiep)
 280 {
 281         int error;
 282
 283         if ((rman_get_flags(res) & RF_SHAREABLE) == 0)
 284                 flags |= INTR_EXCL;
 285
 286         /* We depend here on rman_activate_resource() being idempotent. */
 287         error = rman_activate_resource(res);
 288         if (error)
 289                 return (error);
 290
 291         error = arm_setup_intr(device_get_nameunit(child), filt, intr,
 292             arg, rman_get_start(res), flags, cookiep);
 293
 294         return (error);
 295 }
 296
 297 static int
 298 nexus_teardown_intr(device_t dev, device_t child, struct resource *r, void *ih)
 299 {
 300
 301         return (intr_irq_remove_handler(child, rman_get_start(r), ih));
 302 }
 303
 304 #ifdef SMP
 305 static int
 306 nexus_bind_intr(device_t dev, device_t child, struct resource *irq, int cpu)
 307 {
 308
 309         return (intr_irq_bind(rman_get_start(irq), cpu));
 310 }
 311 #endif
 312
 313 static bus_space_tag_t
 314 nexus_get_bus_tag(device_t bus __unused, device_t child __unused)
 315 {
 316
 317         return(&memmap_bus);
 318 }
 319
 320 static int
 321 nexus_activate_resource(device_t bus, device_t child, int type, int rid,
 322     struct resource *r)
 323 {
 324         int err;
 325         bus_addr_t paddr;
 326         bus_size_t psize;
 327         bus_space_handle_t vaddr;
 328
 329         if ((err = rman_activate_resource(r)) != 0)
 330                 return (err);
 331
 332         /*
 333          * If this is a memory resource, map it into the kernel.
 334          */
 335         if (type == SYS_RES_MEMORY || type == SYS_RES_IOPORT) {
 336                 paddr = (bus_addr_t)rman_get_start(r);
 337                 psize = (bus_size_t)rman_get_size(r);
 338                 err = bus_space_map(&memmap_bus, paddr, psize, 0, &vaddr);
 339                 if (err != 0) {
 340                         rman_deactivate_resource(r);
 341                         return (err);
 342                 }
 343                 rman_set_bustag(r, &memmap_bus);
 344                 rman_set_virtual(r, (void *)vaddr);
 345                 rman_set_bushandle(r, vaddr);
 346         }
 347         return (0);
 348 }
 349
 350 static struct resource_list *
 351 nexus_get_reslist(device_t dev, device_t child)
 352 {
 353         struct nexus_device *ndev = DEVTONX(child);
 354
 355         return (&ndev->nx_resources);
 356 }
 357
 358 static int
 359 nexus_set_resource(device_t dev, device_t child, int type, int rid,
 360     rman_res_t start, rman_res_t count)
 361 {
 362         struct nexus_device     *ndev = DEVTONX(child);
 363         struct resource_list    *rl = &ndev->nx_resources;
 364
 365         /* XXX this should return a success/failure indicator */
 366         resource_list_add(rl, type, rid, start, start + count - 1, count);
 367
 368         return(0);
 369 }
 370
 371
 372 static int
 373 nexus_deactivate_resource(device_t bus, device_t child, int type, int rid,
 374     struct resource *r)
 375 {
 376         bus_size_t psize;
 377         bus_space_handle_t vaddr;
 378
 379         psize = (bus_size_t)rman_get_size(r);
 380         vaddr = rman_get_bushandle(r);
 381
 382         if (vaddr != 0) {
 383                 bus_space_unmap(&memmap_bus, vaddr, psize);
 384                 rman_set_virtual(r, NULL);
 385                 rman_set_bushandle(r, 0);
 386         }
 387
 388         return (rman_deactivate_resource(r));
 389 }
 390
 391 #ifdef FDT
 392 static device_method_t nexus_fdt_methods[] = {
 393         /* Device interface */
 394         DEVMETHOD(device_probe,         nexus_fdt_probe),
 395         DEVMETHOD(device_attach,        nexus_fdt_attach),
 396
 397         /* OFW interface */
 398         DEVMETHOD(ofw_bus_map_intr,     nexus_ofw_map_intr),
 399 };
 400
 401 #define nexus_baseclasses nexus_fdt_baseclasses
 402 DEFINE_CLASS_1(nexus, nexus_fdt_driver, nexus_fdt_methods, 1, nexus_driver);
 403 #undef nexus_baseclasses
 404 static devclass_t nexus_fdt_devclass;
 405
 406 EARLY_DRIVER_MODULE(nexus_fdt, root, nexus_fdt_driver, nexus_fdt_devclass,
 407     0, 0, BUS_PASS_BUS + BUS_PASS_ORDER_FIRST);
 408
 409 static int
 410 nexus_fdt_probe(device_t dev)
 411 {
 412
 413         if (OF_peer(0) == 0)
 414                 return (ENXIO);
 415
 416         device_quiet(dev);
 417         return (BUS_PROBE_DEFAULT);
 418 }
 419
 420 static int
 421 nexus_fdt_attach(device_t dev)
 422 {
 423
 424         nexus_add_child(dev, 10, "ofwbus", 0);
 425         return (nexus_attach(dev));
 426 }
 427
 428 static int
 429 nexus_ofw_map_intr(device_t dev, device_t child, phandle_t iparent, int icells,
 430     pcell_t *intr)
 431 {
 432         int irq;
 433
 434         if (icells == 3) {
 435                 irq = intr[1];
 436                 if (intr[0] == 0)
 437                         irq += 32; /* SPI */
 438                 else
 439                         irq += 16; /* PPI */
 440         } else
 441                 irq = intr[0];
 442
 443         return (irq);
 444 }
 445 #endif
 446
 447 #ifdef DEV_ACPI
 448 static device_method_t nexus_acpi_methods[] = {
 449         /* Device interface */
 450         DEVMETHOD(device_probe,         nexus_acpi_probe),
 451         DEVMETHOD(device_attach,        nexus_acpi_attach),
 452 };
 453
 454 #define nexus_baseclasses nexus_acpi_baseclasses
 455 DEFINE_CLASS_1(nexus, nexus_acpi_driver, nexus_acpi_methods, 1,
 456     nexus_driver);
 457 #undef nexus_baseclasses
 458 static devclass_t nexus_acpi_devclass;
 459
 460 EARLY_DRIVER_MODULE(nexus_acpi, root, nexus_acpi_driver, nexus_acpi_devclass,
 461     0, 0, BUS_PASS_BUS + BUS_PASS_ORDER_FIRST);
 462
 463 static int
 464 nexus_acpi_probe(device_t dev)
 465 {
 466
 467         if (acpi_identify() != 0)
 468                 return (ENXIO);
 469
 470         device_quiet(dev);
 471         return (BUS_PROBE_LOW_PRIORITY);
 472 }
 473
 474 static int
 475 nexus_acpi_attach(device_t dev)
 476 {
 477
 478         nexus_add_child(dev, 10, "acpi", 0);
 479         return (nexus_attach(dev));
 480 }
 481 #endif