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 #ifdef ARM_INTRNG
  89 #ifdef SMP
  90 static  int nexus_bind_intr(device_t, device_t, struct resource *, int);
  91 #endif
  92 #endif
  93 static int nexus_config_intr(device_t dev, int irq, enum intr_trigger trig,
  94     enum intr_polarity pol);
  95 #ifdef ARM_INTRNG
  96 static  int nexus_describe_intr(device_t dev, device_t child,
  97     struct resource *irq, void *cookie, const char *descr);
  98 #endif
  99 static  int nexus_deactivate_resource(device_t, device_t, int, int,
 100     struct resource *);
 101 static int nexus_release_resource(device_t, device_t, int, int,
 102     struct resource *);
 103
 104 static int nexus_setup_intr(device_t dev, device_t child, struct resource *res,
 105     int flags, driver_filter_t *filt, driver_intr_t *intr, void *arg, void **cookiep);
 106 static int nexus_teardown_intr(device_t, device_t, struct resource *, void *);
 107
 108 #ifdef FDT
 109 static int nexus_ofw_map_intr(device_t dev, device_t child, phandle_t iparent,
 110     int icells, pcell_t *intr);
 111 #endif
 112
 113 static device_method_t nexus_methods[] = {
 114         /* Device interface */
 115         DEVMETHOD(device_probe,         nexus_probe),
 116         DEVMETHOD(device_attach,        nexus_attach),
 117         /* Bus interface */
 118         DEVMETHOD(bus_print_child,      nexus_print_child),
 119         DEVMETHOD(bus_add_child,        nexus_add_child),
 120         DEVMETHOD(bus_alloc_resource,   nexus_alloc_resource),
 121         DEVMETHOD(bus_activate_resource,        nexus_activate_resource),
 122         DEVMETHOD(bus_config_intr,      nexus_config_intr),
 123         DEVMETHOD(bus_deactivate_resource,      nexus_deactivate_resource),
 124         DEVMETHOD(bus_release_resource, nexus_release_resource),
 125         DEVMETHOD(bus_setup_intr,       nexus_setup_intr),
 126         DEVMETHOD(bus_teardown_intr,    nexus_teardown_intr),
 127 #ifdef ARM_INTRNG
 128         DEVMETHOD(bus_describe_intr,    nexus_describe_intr),
 129 #ifdef SMP
 130         DEVMETHOD(bus_bind_intr,        nexus_bind_intr),
 131 #endif
 132 #endif
 133 #ifdef FDT
 134         DEVMETHOD(ofw_bus_map_intr,     nexus_ofw_map_intr),
 135 #endif
 136         { 0, 0 }
 137 };
 138
 139 static devclass_t nexus_devclass;
 140 static driver_t nexus_driver = {
 141         "nexus",
 142         nexus_methods,
 143         1                       /* no softc */
 144 };
 145 EARLY_DRIVER_MODULE(nexus, root, nexus_driver, nexus_devclass, 0, 0,
 146     BUS_PASS_BUS + BUS_PASS_ORDER_EARLY);
 147
 148 static int
 149 nexus_probe(device_t dev)
 150 {
 151
 152         device_quiet(dev);      /* suppress attach message for neatness */
 153
 154         return (BUS_PROBE_DEFAULT);
 155 }
 156
 157 static int
 158 nexus_attach(device_t dev)
 159 {
 160
 161         mem_rman.rm_start = 0;
 162         mem_rman.rm_end = ~0ul;
 163         mem_rman.rm_type = RMAN_ARRAY;
 164         mem_rman.rm_descr = "I/O memory addresses";
 165         if (rman_init(&mem_rman) || rman_manage_region(&mem_rman, 0, ~0))
 166                 panic("nexus_probe mem_rman");
 167
 168         /*
 169          * First, deal with the children we know about already
 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     u_long start, u_long end, u_long count, u_int flags)
 216 {
 217         struct resource *rv;
 218         struct rman *rm;
 219         int needactivate = flags & RF_ACTIVE;
 220
 221         flags &= ~RF_ACTIVE;
 222
 223         switch (type) {
 224         case SYS_RES_MEMORY:
 225         case SYS_RES_IOPORT:
 226                 rm = &mem_rman;
 227                 break;
 228
 229         default:
 230                 return (NULL);
 231         }
 232
 233         rv = rman_reserve_resource(rm, start, end, count, flags, child);
 234         if (rv == 0)
 235                 return (NULL);
 236
 237         rman_set_rid(rv, *rid);
 238
 239         if (needactivate) {
 240                 if (bus_activate_resource(child, type, *rid, rv)) {
 241                         rman_release_resource(rv);
 242                         return (0);
 243                 }
 244         }
 245
 246         return (rv);
 247 }
 248
 249 static int
 250 nexus_release_resource(device_t bus, device_t child, int type, int rid,
 251     struct resource *res)
 252 {
 253         int error;
 254
 255         if (rman_get_flags(res) & RF_ACTIVE) {
 256                 error = bus_deactivate_resource(child, type, rid, res);
 257                 if (error)
 258                         return (error);
 259         }
 260         return (rman_release_resource(res));
 261 }
 262
 263 static int
 264 nexus_config_intr(device_t dev, int irq, enum intr_trigger trig,
 265     enum intr_polarity pol)
 266 {
 267         int ret = ENODEV;
 268
 269 #ifdef ARM_INTRNG
 270         ret = arm_irq_config(irq, trig, pol);
 271 #else
 272         if (arm_config_irq)
 273                 ret = (*arm_config_irq)(irq, trig, pol);
 274 #endif
 275         return (ret);
 276 }
 277
 278 static int
 279 nexus_setup_intr(device_t dev, device_t child, struct resource *res, int flags,
 280     driver_filter_t *filt, driver_intr_t *intr, void *arg, void **cookiep)
 281 {
 282         int irq;
 283
 284         if ((rman_get_flags(res) & RF_SHAREABLE) == 0)
 285                 flags |= INTR_EXCL;
 286
 287         for (irq = rman_get_start(res); irq <= rman_get_end(res); irq++) {
 288 #ifdef ARM_INTRNG
 289                 arm_irq_add_handler(child, filt, intr, arg, irq, flags,
 290                     cookiep);
 291 #else
 292                 arm_setup_irqhandler(device_get_nameunit(child),
 293                     filt, intr, arg, irq, flags, cookiep);
 294                 arm_unmask_irq(irq);
 295 #endif
 296         }
 297         return (0);
 298 }
 299
 300 static int
 301 nexus_teardown_intr(device_t dev, device_t child, struct resource *r, void *ih)
 302 {
 303
 304 #ifdef ARM_INTRNG
 305         return (arm_irq_remove_handler(child, rman_get_start(r), ih));
 306 #else
 307         return (arm_remove_irqhandler(rman_get_start(r), ih));
 308 #endif
 309 }
 310
 311 #ifdef ARM_INTRNG
 312 static int
 313 nexus_describe_intr(device_t dev, device_t child, struct resource *irq,
 314     void *cookie, const char *descr)
 315 {
 316
 317         return (arm_irq_describe(rman_get_start(irq), cookie, descr));
 318 }
 319
 320 #ifdef SMP
 321 static int
 322 nexus_bind_intr(device_t dev, device_t child, struct resource *irq, int cpu)
 323 {
 324
 325         return (arm_irq_bind(rman_get_start(irq), cpu));
 326 }
 327 #endif
 328 #endif
 329
 330 static int
 331 nexus_activate_resource(device_t bus, device_t child, int type, int rid,
 332     struct resource *r)
 333 {
 334         int err;
 335         bus_addr_t paddr;
 336         bus_size_t psize;
 337         bus_space_handle_t vaddr;
 338
 339         if ((err = rman_activate_resource(r)) != 0)
 340                 return (err);
 341
 342         /*
 343          * If this is a memory resource, map it into the kernel.
 344          */
 345         if (type == SYS_RES_MEMORY || type == SYS_RES_IOPORT) {
 346                 paddr = (bus_addr_t)rman_get_start(r);
 347                 psize = (bus_size_t)rman_get_size(r);
 348 #ifdef FDT
 349                 err = bus_space_map(fdtbus_bs_tag, paddr, psize, 0, &vaddr);
 350                 if (err != 0) {
 351                         rman_deactivate_resource(r);
 352                         return (err);
 353                 }
 354                 rman_set_bustag(r, fdtbus_bs_tag);
 355 #else
 356                 vaddr = (bus_space_handle_t)pmap_mapdev((vm_offset_t)paddr,
 357                     (vm_size_t)psize);
 358                 if (vaddr == 0) {
 359                         rman_deactivate_resource(r);
 360                         return (ENOMEM);
 361                 }
 362                 rman_set_bustag(r, (void *)1);
 363 #endif
 364                 rman_set_virtual(r, (void *)vaddr);
 365                 rman_set_bushandle(r, vaddr);
 366         }
 367         return (0);
 368 }
 369
 370 static int
 371 nexus_deactivate_resource(device_t bus, device_t child, int type, int rid,
 372     struct resource *r)
 373 {
 374         bus_size_t psize;
 375         bus_space_handle_t vaddr;
 376
 377         psize = (bus_size_t)rman_get_size(r);
 378         vaddr = rman_get_bushandle(r);
 379
 380         if (vaddr != 0) {
 381 #ifdef FDT
 382                 bus_space_unmap(fdtbus_bs_tag, vaddr, psize);
 383 #else
 384                 pmap_unmapdev((vm_offset_t)vaddr, (vm_size_t)psize);
 385 #endif
 386                 rman_set_virtual(r, NULL);
 387                 rman_set_bushandle(r, 0);
 388         }
 389
 390         return (rman_deactivate_resource(r));
 391 }
 392
 393 #ifdef FDT
 394 static int
 395 nexus_ofw_map_intr(device_t dev, device_t child, phandle_t iparent, int icells,
 396     pcell_t *intr)
 397 {
 398
 399         return (arm_fdt_map_irq(iparent, intr, icells));
 400 }
 401 #endif