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, 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 <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 "opt_platform.h"
  64
  65 #ifdef FDT
  66 #include <dev/fdt/fdt_common.h>
  67 #include <machine/fdt.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
  81 static  int nexus_probe(device_t);
  82 static  int nexus_attach(device_t);
  83 static  int nexus_print_child(device_t, device_t);
  84 static  device_t nexus_add_child(device_t, u_int, const char *, int);
  85 static  struct resource *nexus_alloc_resource(device_t, device_t, int, int *,
  86     u_long, u_long, u_long, u_int);
  87 static  int nexus_activate_resource(device_t, device_t, int, int,
  88     struct resource *);
  89 static int nexus_config_intr(device_t dev, int irq, enum intr_trigger trig,
  90     enum intr_polarity pol);
  91 static  int nexus_deactivate_resource(device_t, device_t, int, int,
  92     struct resource *);
  93 static int nexus_release_resource(device_t, device_t, int, int,
  94     struct resource *);
  95
  96 static int nexus_setup_intr(device_t dev, device_t child, struct resource *res,
  97     int flags, driver_filter_t *filt, driver_intr_t *intr, void *arg, void **cookiep);
  98 static int nexus_teardown_intr(device_t, device_t, struct resource *, void *);
  99
 100 #ifdef FDT
 101 static int nexus_ofw_map_intr(device_t dev, device_t child, phandle_t iparent,
 102     int icells, pcell_t *intr);
 103 #endif
 104
 105 static device_method_t nexus_methods[] = {
 106         /* Device interface */
 107         DEVMETHOD(device_probe,         nexus_probe),
 108         DEVMETHOD(device_attach,        nexus_attach),
 109         /* Bus interface */
 110         DEVMETHOD(bus_print_child,      nexus_print_child),
 111         DEVMETHOD(bus_add_child,        nexus_add_child),
 112         DEVMETHOD(bus_alloc_resource,   nexus_alloc_resource),
 113         DEVMETHOD(bus_activate_resource,        nexus_activate_resource),
 114         DEVMETHOD(bus_config_intr,      nexus_config_intr),
 115         DEVMETHOD(bus_deactivate_resource,      nexus_deactivate_resource),
 116         DEVMETHOD(bus_release_resource, nexus_release_resource),
 117         DEVMETHOD(bus_setup_intr,       nexus_setup_intr),
 118         DEVMETHOD(bus_teardown_intr,    nexus_teardown_intr),
 119 #ifdef FDT
 120         DEVMETHOD(ofw_bus_map_intr,     nexus_ofw_map_intr),
 121 #endif
 122         { 0, 0 }
 123 };
 124
 125 static devclass_t nexus_devclass;
 126 static driver_t nexus_driver = {
 127         "nexus",
 128         nexus_methods,
 129         1                       /* no softc */
 130 };
 131 EARLY_DRIVER_MODULE(nexus, root, nexus_driver, nexus_devclass, 0, 0,
 132     BUS_PASS_BUS + BUS_PASS_ORDER_EARLY);
 133
 134 static int
 135 nexus_probe(device_t dev)
 136 {
 137
 138         device_quiet(dev);      /* suppress attach message for neatness */
 139
 140         return (BUS_PROBE_DEFAULT);
 141 }
 142
 143 static int
 144 nexus_attach(device_t dev)
 145 {
 146
 147         mem_rman.rm_start = 0;
 148         mem_rman.rm_end = ~0ul;
 149         mem_rman.rm_type = RMAN_ARRAY;
 150         mem_rman.rm_descr = "I/O memory addresses";
 151         if (rman_init(&mem_rman) || rman_manage_region(&mem_rman, 0, ~0))
 152                 panic("nexus_probe mem_rman");
 153
 154         /*
 155          * First, deal with the children we know about already
 156          */
 157         bus_generic_probe(dev);
 158         bus_generic_attach(dev);
 159
 160         return (0);
 161 }
 162
 163 static int
 164 nexus_print_child(device_t bus, device_t child)
 165 {
 166         int retval = 0;
 167
 168         retval += bus_print_child_header(bus, child);
 169         retval += printf("\n");
 170
 171         return (retval);
 172 }
 173
 174 static device_t
 175 nexus_add_child(device_t bus, u_int order, const char *name, int unit)
 176 {
 177         device_t child;
 178         struct nexus_device *ndev;
 179
 180         ndev = malloc(sizeof(struct nexus_device), M_NEXUSDEV, M_NOWAIT|M_ZERO);
 181         if (!ndev)
 182                 return (0);
 183         resource_list_init(&ndev->nx_resources);
 184
 185         child = device_add_child_ordered(bus, order, name, unit);
 186
 187         /* should we free this in nexus_child_detached? */
 188         device_set_ivars(child, ndev);
 189
 190         return (child);
 191 }
 192
 193
 194 /*
 195  * Allocate a resource on behalf of child.  NB: child is usually going to be a
 196  * child of one of our descendants, not a direct child of nexus0.
 197  * (Exceptions include footbridge.)
 198  */
 199 static struct resource *
 200 nexus_alloc_resource(device_t bus, device_t child, int type, int *rid,
 201     u_long start, u_long end, u_long count, u_int flags)
 202 {
 203         struct resource *rv;
 204         struct rman *rm;
 205         int needactivate = flags & RF_ACTIVE;
 206
 207         flags &= ~RF_ACTIVE;
 208
 209         switch (type) {
 210         case SYS_RES_MEMORY:
 211         case SYS_RES_IOPORT:
 212                 rm = &mem_rman;
 213                 break;
 214
 215         default:
 216                 return (NULL);
 217         }
 218
 219         rv = rman_reserve_resource(rm, start, end, count, flags, child);
 220         if (rv == 0)
 221                 return (NULL);
 222
 223         rman_set_rid(rv, *rid);
 224
 225         if (needactivate) {
 226                 if (bus_activate_resource(child, type, *rid, rv)) {
 227                         rman_release_resource(rv);
 228                         return (0);
 229                 }
 230         }
 231
 232         return (rv);
 233 }
 234
 235 static int
 236 nexus_release_resource(device_t bus, device_t child, int type, int rid,
 237     struct resource *res)
 238 {
 239         int error;
 240
 241         if (rman_get_flags(res) & RF_ACTIVE) {
 242                 error = bus_deactivate_resource(child, type, rid, res);
 243                 if (error)
 244                         return (error);
 245         }
 246         return (rman_release_resource(res));
 247 }
 248
 249 static int
 250 nexus_config_intr(device_t dev, int irq, enum intr_trigger trig,
 251     enum intr_polarity pol)
 252 {
 253         int ret = ENODEV;
 254
 255         if (arm_config_irq)
 256                 ret = (*arm_config_irq)(irq, trig, pol);
 257
 258         return (ret);
 259 }
 260
 261 static int
 262 nexus_setup_intr(device_t dev, device_t child, struct resource *res, int flags,
 263     driver_filter_t *filt, driver_intr_t *intr, void *arg, void **cookiep)
 264 {
 265         int irq;
 266
 267         if ((rman_get_flags(res) & RF_SHAREABLE) == 0)
 268                 flags |= INTR_EXCL;
 269
 270         for (irq = rman_get_start(res); irq <= rman_get_end(res); irq++) {
 271                 arm_setup_irqhandler(device_get_nameunit(child),
 272                     filt, intr, arg, irq, flags, cookiep);
 273                 arm_unmask_irq(irq);
 274         }
 275         return (0);
 276 }
 277
 278 static int
 279 nexus_teardown_intr(device_t dev, device_t child, struct resource *r, void *ih)
 280 {
 281
 282         return (arm_remove_irqhandler(rman_get_start(r), ih));
 283 }
 284
 285
 286 static int
 287 nexus_activate_resource(device_t bus, device_t child, int type, int rid,
 288     struct resource *r)
 289 {
 290         int err;
 291         bus_addr_t paddr;
 292         bus_size_t psize;
 293         bus_space_handle_t vaddr;
 294
 295         if ((err = rman_activate_resource(r)) != 0)
 296                 return (err);
 297
 298         /*
 299          * If this is a memory resource, map it into the kernel.
 300          */
 301         if (type == SYS_RES_MEMORY || type == SYS_RES_IOPORT) {
 302                 paddr = (bus_addr_t)rman_get_start(r);
 303                 psize = (bus_size_t)rman_get_size(r);
 304 #ifdef FDT
 305                 err = bus_space_map(fdtbus_bs_tag, paddr, psize, 0, &vaddr);
 306                 if (err != 0) {
 307                         rman_deactivate_resource(r);
 308                         return (err);
 309                 }
 310                 rman_set_bustag(r, fdtbus_bs_tag);
 311 #else
 312                 vaddr = (bus_space_handle_t)pmap_mapdev((vm_offset_t)paddr,
 313                     (vm_size_t)psize);
 314                 if (vaddr == 0) {
 315                         rman_deactivate_resource(r);
 316                         return (ENOMEM);
 317                 }
 318                 rman_set_bustag(r, (void *)1);
 319 #endif
 320                 rman_set_virtual(r, (void *)vaddr);
 321                 rman_set_bushandle(r, vaddr);
 322         }
 323         return (0);
 324 }
 325
 326 static int
 327 nexus_deactivate_resource(device_t bus, device_t child, int type, int rid,
 328     struct resource *r)
 329 {
 330         bus_size_t psize;
 331         bus_space_handle_t vaddr;
 332
 333         psize = (bus_size_t)rman_get_size(r);
 334         vaddr = rman_get_bushandle(r);
 335
 336         if (vaddr != 0) {
 337 #ifdef FDT
 338                 bus_space_unmap(fdtbus_bs_tag, vaddr, psize);
 339 #else
 340                 pmap_unmapdev((vm_offset_t)vaddr, (vm_size_t)psize);
 341 #endif
 342                 rman_set_virtual(r, NULL);
 343                 rman_set_bushandle(r, 0);
 344         }
 345
 346         return (rman_deactivate_resource(r));
 347 }
 348
 349 #ifdef FDT
 350 static int
 351 nexus_ofw_map_intr(device_t dev, device_t child, phandle_t iparent, int icells,
 352     pcell_t *intr)
 353 {
 354         fdt_pic_decode_t intr_decode;
 355         phandle_t intr_parent;
 356         int i, rv, interrupt, trig, pol;
 357
 358         intr_parent = OF_node_from_xref(iparent);
 359         for (i = 0; i < icells; i++)
 360                 intr[i] = cpu_to_fdt32(intr[i]);
 361
 362         for (i = 0; fdt_pic_table[i] != NULL; i++) {
 363                 intr_decode = fdt_pic_table[i];
 364                 rv = intr_decode(intr_parent, intr, &interrupt, &trig, &pol);
 365
 366                 if (rv == 0) {
 367                         /* This was recognized as our PIC and decoded. */
 368                         interrupt = FDT_MAP_IRQ(intr_parent, interrupt);
 369                         return (interrupt);
 370                 }
 371         }
 372
 373         /* Not in table, so guess */
 374         interrupt = FDT_MAP_IRQ(intr_parent, fdt32_to_cpu(intr[0]));
 375
 376         return (interrupt);
 377 }
 378 #endif