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