sys/arm/arm/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_platform.h"
  41
  42 #include <sys/cdefs.h>
  43 __FBSDID("$FreeBSD$");
  44
  45 #include <sys/param.h>
  46 #include <sys/systm.h>
  47 #include <sys/bus.h>
  48 #include <sys/kernel.h>
  49 #include <sys/malloc.h>
  50 #include <sys/module.h>
  51 #include <machine/bus.h>
  52 #include <sys/rman.h>
  53 #include <sys/interrupt.h>
  54
  55 #include <machine/vmparam.h>
  56 #include <machine/pcb.h>
  57 #include <vm/vm.h>
  58 #include <vm/pmap.h>
  59
  60 #include <machine/resource.h>
  61 #include <machine/intr.h>
  62
  63 #include <arm/arm/nexusvar.h>
  64
  65 #ifdef FDT
  66 #include <machine/fdt.h>
  67 #include <dev/ofw/ofw_bus_subr.h>
  68 #include "ofw_bus_if.h"
  69 #endif
  70
  71 static MALLOC_DEFINE(M_NEXUSDEV, "nexusdev", "Nexus device");
  72
  73 struct nexus_device {
  74         struct resource_list    nx_resources;
  75 };
  76
  77 #define DEVTONX(dev)    ((struct nexus_device *)device_get_ivars(dev))
  78
  79 static struct rman mem_rman;
  80 static struct rman irq_rman;
  81
  82 static  int nexus_probe(device_t);
  83 static  int nexus_attach(device_t);
  84 static  int nexus_print_child(device_t, device_t);
  85 static  device_t nexus_add_child(device_t, u_int, const char *, int);
  86 static  struct resource *nexus_alloc_resource(device_t, device_t, int, int *,
  87     rman_res_t, rman_res_t, rman_res_t, u_int);
  88 static  int nexus_activate_resource(device_t, device_t, int, int,
  89     struct resource *);
  90 static  int nexus_adjust_resource(device_t, device_t, int, struct resource *,
  91     rman_res_t, rman_res_t);
  92 static bus_space_tag_t nexus_get_bus_tag(device_t, device_t);
  93 static bus_dma_tag_t nexus_get_dma_tag(device_t dev, device_t child);
  94 #ifdef SMP
  95 static  int nexus_bind_intr(device_t, device_t, struct resource *, int);
  96 #endif
  97 static int nexus_config_intr(device_t dev, int irq, enum intr_trigger trig,
  98     enum intr_polarity pol);
  99 static  int nexus_describe_intr(device_t dev, device_t child,
 100     struct resource *irq, void *cookie, const char *descr);
 101 static  int nexus_deactivate_resource(device_t, device_t, int, int,
 102     struct resource *);
 103 static int nexus_release_resource(device_t, device_t, int, int,
 104     struct resource *);
 105
 106 static int nexus_setup_intr(device_t dev, device_t child, struct resource *res,
 107     int flags, driver_filter_t *filt, driver_intr_t *intr, void *arg, void **cookiep);
 108 static int nexus_teardown_intr(device_t, device_t, struct resource *, void *);
 109
 110 #ifdef FDT
 111 static int nexus_ofw_map_intr(device_t dev, device_t child, phandle_t iparent,
 112     int icells, pcell_t *intr);
 113 #endif
 114
 115 /*
 116  * Normally NULL (which results in defaults which are handled in
 117  * busdma_machdep), platform init code can use nexus_set_dma_tag() to set this
 118  * to a tag that will be inherited by all busses and devices on the platform.
 119  */
 120 static bus_dma_tag_t nexus_dma_tag;
 121
 122 static device_method_t nexus_methods[] = {
 123         /* Device interface */
 124         DEVMETHOD(device_probe,         nexus_probe),
 125         DEVMETHOD(device_attach,        nexus_attach),
 126         /* Bus interface */
 127         DEVMETHOD(bus_print_child,      nexus_print_child),
 128         DEVMETHOD(bus_add_child,        nexus_add_child),
 129         DEVMETHOD(bus_alloc_resource,   nexus_alloc_resource),
 130         DEVMETHOD(bus_activate_resource,        nexus_activate_resource),
 131         DEVMETHOD(bus_adjust_resource,  nexus_adjust_resource),
 132         DEVMETHOD(bus_config_intr,      nexus_config_intr),
 133         DEVMETHOD(bus_deactivate_resource,      nexus_deactivate_resource),
 134         DEVMETHOD(bus_release_resource, nexus_release_resource),
 135         DEVMETHOD(bus_setup_intr,       nexus_setup_intr),
 136         DEVMETHOD(bus_teardown_intr,    nexus_teardown_intr),
 137         DEVMETHOD(bus_get_bus_tag,      nexus_get_bus_tag),
 138         DEVMETHOD(bus_get_dma_tag,      nexus_get_dma_tag),
 139         DEVMETHOD(bus_describe_intr,    nexus_describe_intr),
 140 #ifdef SMP
 141         DEVMETHOD(bus_bind_intr,        nexus_bind_intr),
 142 #endif
 143 #ifdef FDT
 144         DEVMETHOD(ofw_bus_map_intr,     nexus_ofw_map_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 EARLY_DRIVER_MODULE(nexus, root, nexus_driver, 0, 0,
 156     BUS_PASS_BUS + BUS_PASS_ORDER_EARLY);
 157
 158 static int
 159 nexus_probe(device_t dev)
 160 {
 161
 162         device_quiet(dev);      /* suppress attach message for neatness */
 163
 164         return (BUS_PROBE_DEFAULT);
 165 }
 166
 167 static int
 168 nexus_attach(device_t dev)
 169 {
 170
 171         mem_rman.rm_start = 0;
 172         mem_rman.rm_end = BUS_SPACE_MAXADDR;
 173         mem_rman.rm_type = RMAN_ARRAY;
 174         mem_rman.rm_descr = "I/O memory addresses";
 175         if (rman_init(&mem_rman) ||
 176             rman_manage_region(&mem_rman, 0, BUS_SPACE_MAXADDR))
 177                 panic("nexus_probe mem_rman");
 178         irq_rman.rm_start = 0;
 179         irq_rman.rm_end = ~0;
 180         irq_rman.rm_type = RMAN_ARRAY;
 181         irq_rman.rm_descr = "Interrupts";
 182         if (rman_init(&irq_rman) || rman_manage_region(&irq_rman, 0, ~0))
 183                 panic("nexus_attach irq_rman");
 184
 185         /* First, add ofwbus0. */
 186         device_add_child(dev, "ofwbus", 0);
 187
 188         /*
 189          * Next, deal with the children we know about already.
 190          */
 191         bus_generic_probe(dev);
 192         bus_generic_attach(dev);
 193
 194         return (0);
 195 }
 196
 197 static int
 198 nexus_print_child(device_t bus, device_t child)
 199 {
 200         int retval = 0;
 201
 202         retval += bus_print_child_header(bus, child);
 203         retval += printf("\n");
 204
 205         return (retval);
 206 }
 207
 208 static device_t
 209 nexus_add_child(device_t bus, u_int order, const char *name, int unit)
 210 {
 211         device_t child;
 212         struct nexus_device *ndev;
 213
 214         ndev = malloc(sizeof(struct nexus_device), M_NEXUSDEV, M_NOWAIT|M_ZERO);
 215         if (!ndev)
 216                 return (0);
 217         resource_list_init(&ndev->nx_resources);
 218
 219         child = device_add_child_ordered(bus, order, name, unit);
 220
 221         /* should we free this in nexus_child_detached? */
 222         device_set_ivars(child, ndev);
 223
 224         return (child);
 225 }
 226
 227 /*
 228  * Allocate a resource on behalf of child.  NB: child is usually going to be a
 229  * child of one of our descendants, not a direct child of nexus0.
 230  * (Exceptions include footbridge.)
 231  */
 232 static struct resource *
 233 nexus_alloc_resource(device_t bus, device_t child, int type, int *rid,
 234     rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
 235 {
 236         struct resource *rv;
 237         struct rman *rm;
 238         int needactivate = flags & RF_ACTIVE;
 239
 240         flags &= ~RF_ACTIVE;
 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
 262         if (needactivate) {
 263                 if (bus_activate_resource(child, type, *rid, rv)) {
 264                         rman_release_resource(rv);
 265                         return (0);
 266                 }
 267         }
 268
 269         return (rv);
 270 }
 271
 272 static int
 273 nexus_adjust_resource(device_t bus __unused, device_t child __unused, int type,
 274     struct resource *r, rman_res_t start, rman_res_t end)
 275 {
 276         struct rman *rm;
 277
 278         switch (type) {
 279         case SYS_RES_IRQ:
 280                 rm = &irq_rman;
 281                 break;
 282         case SYS_RES_MEMORY:
 283                 rm = &mem_rman;
 284                 break;
 285         default:
 286                 return (EINVAL);
 287         }
 288         if (rman_is_region_manager(r, rm) == 0)
 289                 return (EINVAL);
 290         return (rman_adjust_resource(r, start, end));
 291 }
 292
 293 static int
 294 nexus_release_resource(device_t bus, device_t child, int type, int rid,
 295     struct resource *res)
 296 {
 297         int error;
 298
 299         if (rman_get_flags(res) & RF_ACTIVE) {
 300                 error = bus_deactivate_resource(child, type, rid, res);
 301                 if (error)
 302                         return (error);
 303         }
 304         return (rman_release_resource(res));
 305 }
 306
 307 static bus_space_tag_t
 308 nexus_get_bus_tag(device_t bus __unused, device_t child __unused)
 309 {
 310
 311 #ifdef FDT
 312                 return(fdtbus_bs_tag);
 313 #else
 314                 return((void *)1);
 315 #endif
 316 }
 317
 318 static bus_dma_tag_t
 319 nexus_get_dma_tag(device_t dev, device_t child)
 320 {
 321
 322         return nexus_dma_tag;
 323 }
 324
 325 void
 326 nexus_set_dma_tag(bus_dma_tag_t tag)
 327 {
 328
 329         nexus_dma_tag = tag;
 330 }
 331
 332 static int
 333 nexus_config_intr(device_t dev, int irq, enum intr_trigger trig,
 334     enum intr_polarity pol)
 335 {
 336         int ret = ENODEV;
 337
 338         device_printf(dev, "bus_config_intr is obsolete and not supported!\n");
 339         ret = EOPNOTSUPP;
 340         return (ret);
 341 }
 342
 343 static int
 344 nexus_setup_intr(device_t dev, device_t child, struct resource *res, int flags,
 345     driver_filter_t *filt, driver_intr_t *intr, void *arg, void **cookiep)
 346 {
 347
 348         if ((rman_get_flags(res) & RF_SHAREABLE) == 0)
 349                 flags |= INTR_EXCL;
 350
 351         return(intr_setup_irq(child, res, filt, intr, arg, flags, cookiep));
 352 }
 353
 354 static int
 355 nexus_teardown_intr(device_t dev, device_t child, struct resource *r, void *ih)
 356 {
 357
 358         return (intr_teardown_irq(child, r, ih));
 359 }
 360
 361 static int
 362 nexus_describe_intr(device_t dev, device_t child, struct resource *irq,
 363     void *cookie, const char *descr)
 364 {
 365
 366         return (intr_describe_irq(child, irq, cookie, descr));
 367 }
 368
 369 #ifdef SMP
 370 static int
 371 nexus_bind_intr(device_t dev, device_t child, struct resource *irq, int cpu)
 372 {
 373
 374         return (intr_bind_irq(child, irq, cpu));
 375 }
 376 #endif
 377
 378 static int
 379 nexus_activate_resource(device_t bus, device_t child, int type, int rid,
 380     struct resource *r)
 381 {
 382         int err;
 383         bus_addr_t paddr;
 384         bus_size_t psize;
 385         bus_space_handle_t vaddr;
 386
 387         if ((err = rman_activate_resource(r)) != 0)
 388                 return (err);
 389
 390         /*
 391          * If this is a memory resource, map it into the kernel.
 392          */
 393         if (type == SYS_RES_MEMORY || type == SYS_RES_IOPORT) {
 394                 paddr = (bus_addr_t)rman_get_start(r);
 395                 psize = (bus_size_t)rman_get_size(r);
 396 #ifdef FDT
 397                 err = bus_space_map(fdtbus_bs_tag, paddr, psize, 0, &vaddr);
 398                 if (err != 0) {
 399                         rman_deactivate_resource(r);
 400                         return (err);
 401                 }
 402                 rman_set_bustag(r, fdtbus_bs_tag);
 403 #else
 404                 vaddr = (bus_space_handle_t)pmap_mapdev((vm_paddr_t)paddr,
 405                     (vm_size_t)psize);
 406                 if (vaddr == 0) {
 407                         rman_deactivate_resource(r);
 408                         return (ENOMEM);
 409                 }
 410                 rman_set_bustag(r, (void *)1);
 411 #endif
 412                 rman_set_virtual(r, (void *)vaddr);
 413                 rman_set_bushandle(r, vaddr);
 414                 return (0);
 415         } else if (type == SYS_RES_IRQ) {
 416                 err = intr_activate_irq(child, r);
 417                 if (err != 0) {
 418                         rman_deactivate_resource(r);
 419                         return (err);
 420                 }
 421         }
 422         return (0);
 423 }
 424
 425 static int
 426 nexus_deactivate_resource(device_t bus, device_t child, int type, int rid,
 427     struct resource *r)
 428 {
 429         bus_size_t psize;
 430         bus_space_handle_t vaddr;
 431
 432         if (type == SYS_RES_MEMORY || type == SYS_RES_IOPORT) {
 433                 psize = (bus_size_t)rman_get_size(r);
 434                 vaddr = rman_get_bushandle(r);
 435
 436                 if (vaddr != 0) {
 437 #ifdef FDT
 438                         bus_space_unmap(fdtbus_bs_tag, vaddr, psize);
 439 #else
 440                         pmap_unmapdev((void *)vaddr, (vm_size_t)psize);
 441 #endif
 442                         rman_set_virtual(r, NULL);
 443                         rman_set_bushandle(r, 0);
 444                 }
 445         } else if (type == SYS_RES_IRQ) {
 446                 intr_deactivate_irq(child, r);
 447         }
 448
 449         return (rman_deactivate_resource(r));
 450 }
 451
 452 #ifdef FDT
 453 static int
 454 nexus_ofw_map_intr(device_t dev, device_t child, phandle_t iparent, int icells,
 455     pcell_t *intr)
 456 {
 457         u_int irq;
 458         struct intr_map_data_fdt *fdt_data;
 459         size_t len;
 460
 461         len = sizeof(*fdt_data) + icells * sizeof(pcell_t);
 462         fdt_data = (struct intr_map_data_fdt *)intr_alloc_map_data(
 463             INTR_MAP_DATA_FDT, len, M_WAITOK | M_ZERO);
 464         fdt_data->iparent = iparent;
 465         fdt_data->ncells = icells;
 466         memcpy(fdt_data->cells, intr, icells * sizeof(pcell_t));
 467         irq = intr_map_irq(NULL, iparent, (struct intr_map_data *)fdt_data);
 468         return (irq);
 469 }
 470 #endif /* FDT */