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