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