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