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