sys/sparc64/sparc64/nexus.c

   1 /*-
   2  * Copyright 1998 Massachusetts Institute of Technology
   3  * Copyright 2001 by Thomas Moestl <tmm@FreeBSD.org>.
   4  * Copyright 2006 by Marius Strobl <marius@FreeBSD.org>.
   5  * All rights reserved.
   6  *
   7  * Permission to use, copy, modify, and distribute this software and
   8  * its documentation for any purpose and without fee is hereby
   9  * granted, provided that both the above copyright notice and this
  10  * permission notice appear in all copies, that both the above
  11  * copyright notice and this permission notice appear in all
  12  * supporting documentation, and that the name of M.I.T. not be used
  13  * in advertising or publicity pertaining to distribution of the
  14  * software without specific, written prior permission.  M.I.T. makes
  15  * no representations about the suitability of this software for any
  16  * purpose.  It is provided "as is" without express or implied
  17  * warranty.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY M.I.T. ``AS IS''.  M.I.T. DISCLAIMS
  20  * ALL EXPRESS OR IMPLIED WARRANTIES WITH REGARD TO THIS SOFTWARE,
  21  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  22  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT
  23  * SHALL M.I.T. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  26  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  27  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  28  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  29  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30  * SUCH DAMAGE.
  31  *
  32  *      from: FreeBSD: src/sys/i386/i386/nexus.c,v 1.43 2001/02/09
  33  */
  34
  35 #include <sys/cdefs.h>
  36 __FBSDID("$FreeBSD$");
  37
  38 #include <sys/param.h>
  39 #include <sys/systm.h>
  40 #include <sys/bus.h>
  41 #include <sys/kernel.h>
  42 #include <sys/malloc.h>
  43 #include <sys/module.h>
  44 #include <sys/pcpu.h>
  45
  46 #include <dev/ofw/ofw_bus.h>
  47 #include <dev/ofw/ofw_bus_subr.h>
  48 #include <dev/ofw/openfirm.h>
  49
  50 #include <machine/bus.h>
  51 #include <machine/bus_common.h>
  52 #include <machine/intr_machdep.h>
  53 #include <machine/nexusvar.h>
  54 #include <machine/ofw_nexus.h>
  55 #include <machine/resource.h>
  56 #include <machine/ver.h>
  57
  58 #include <sys/rman.h>
  59
  60 /*
  61  * The nexus (which is a pseudo-bus actually) iterates over the nodes that
  62  * hang from the Open Firmware root node and adds them as devices to this bus
  63  * (except some special nodes which are excluded) so that drivers can be
  64  * attached to them.
  65  *
  66  * Additionally, interrupt setup/teardown and some resource management are
  67  * done at this level.
  68  *
  69  * Maybe this code should get into dev/ofw to some extent, as some of it should
  70  * work for all Open Firmware based machines...
  71  */
  72
  73 struct nexus_devinfo {
  74         struct ofw_bus_devinfo  ndi_obdinfo;
  75         struct resource_list    ndi_rl;
  76 };
  77
  78 struct nexus_softc {
  79         struct rman     sc_intr_rman;
  80         struct rman     sc_mem_rman;
  81 };
  82
  83 static device_probe_t nexus_probe;
  84 static device_attach_t nexus_attach;
  85 static bus_print_child_t nexus_print_child;
  86 static bus_add_child_t nexus_add_child;
  87 static bus_probe_nomatch_t nexus_probe_nomatch;
  88 static bus_setup_intr_t nexus_setup_intr;
  89 static bus_teardown_intr_t nexus_teardown_intr;
  90 static bus_alloc_resource_t nexus_alloc_resource;
  91 static bus_activate_resource_t nexus_activate_resource;
  92 static bus_deactivate_resource_t nexus_deactivate_resource;
  93 static bus_release_resource_t nexus_release_resource;
  94 static bus_get_resource_list_t nexus_get_resource_list;
  95 #ifdef SMP
  96 static bus_bind_intr_t nexus_bind_intr;
  97 #endif
  98 static bus_describe_intr_t nexus_describe_intr;
  99 static bus_get_dma_tag_t nexus_get_dma_tag;
 100 static ofw_bus_get_devinfo_t nexus_get_devinfo;
 101
 102 static int nexus_inlist(const char *, const char *const *);
 103 static struct nexus_devinfo * nexus_setup_dinfo(device_t, phandle_t);
 104 static void nexus_destroy_dinfo(struct nexus_devinfo *);
 105 static int nexus_print_res(struct nexus_devinfo *);
 106
 107 static device_method_t nexus_methods[] = {
 108         /* Device interface */
 109         DEVMETHOD(device_probe,         nexus_probe),
 110         DEVMETHOD(device_attach,        nexus_attach),
 111         DEVMETHOD(device_detach,        bus_generic_detach),
 112         DEVMETHOD(device_shutdown,      bus_generic_shutdown),
 113         DEVMETHOD(device_suspend,       bus_generic_suspend),
 114         DEVMETHOD(device_resume,        bus_generic_resume),
 115
 116         /* Bus interface */
 117         DEVMETHOD(bus_print_child,      nexus_print_child),
 118         DEVMETHOD(bus_probe_nomatch,    nexus_probe_nomatch),
 119         DEVMETHOD(bus_read_ivar,        bus_generic_read_ivar),
 120         DEVMETHOD(bus_write_ivar,       bus_generic_write_ivar),
 121         DEVMETHOD(bus_add_child,        nexus_add_child),
 122         DEVMETHOD(bus_alloc_resource,   nexus_alloc_resource),
 123         DEVMETHOD(bus_activate_resource,        nexus_activate_resource),
 124         DEVMETHOD(bus_deactivate_resource,      nexus_deactivate_resource),
 125         DEVMETHOD(bus_release_resource, nexus_release_resource),
 126         DEVMETHOD(bus_setup_intr,       nexus_setup_intr),
 127         DEVMETHOD(bus_teardown_intr,    nexus_teardown_intr),
 128         DEVMETHOD(bus_set_resource,     bus_generic_rl_set_resource),
 129         DEVMETHOD(bus_get_resource,     bus_generic_rl_get_resource),
 130         DEVMETHOD(bus_get_resource_list, nexus_get_resource_list),
 131 #ifdef SMP
 132         DEVMETHOD(bus_bind_intr,        nexus_bind_intr),
 133 #endif
 134         DEVMETHOD(bus_describe_intr,    nexus_describe_intr),
 135         DEVMETHOD(bus_get_dma_tag,      nexus_get_dma_tag),
 136
 137         /* ofw_bus interface */
 138         DEVMETHOD(ofw_bus_get_devinfo,  nexus_get_devinfo),
 139         DEVMETHOD(ofw_bus_get_compat,   ofw_bus_gen_get_compat),
 140         DEVMETHOD(ofw_bus_get_model,    ofw_bus_gen_get_model),
 141         DEVMETHOD(ofw_bus_get_name,     ofw_bus_gen_get_name),
 142         DEVMETHOD(ofw_bus_get_node,     ofw_bus_gen_get_node),
 143         DEVMETHOD(ofw_bus_get_type,     ofw_bus_gen_get_type),
 144
 145         KOBJMETHOD_END
 146 };
 147
 148 static devclass_t nexus_devclass;
 149
 150 DEFINE_CLASS_0(nexus, nexus_driver, nexus_methods, sizeof(struct nexus_softc));
 151 EARLY_DRIVER_MODULE(nexus, root, nexus_driver, nexus_devclass, 0, 0,
 152     BUS_PASS_BUS);
 153 MODULE_VERSION(nexus, 1);
 154
 155 static const char *const nexus_excl_name[] = {
 156         "FJSV,system",
 157         "aliases",
 158         "associations",
 159         "chosen",
 160         "cmp",
 161         "counter-timer",        /* No separate device; handled by psycho/sbus */
 162         "failsafe",
 163         "memory",
 164         "openprom",
 165         "options",
 166         "packages",
 167         "physical-memory",
 168         "rsc",
 169         "sgcn",
 170         "todsg",
 171         "virtual-memory",
 172         NULL
 173 };
 174
 175 static const char *const nexus_excl_type[] = {
 176         "core",
 177         "cpu",
 178         NULL
 179 };
 180
 181 extern struct bus_space_tag nexus_bustag;
 182 extern struct bus_dma_tag nexus_dmatag;
 183
 184 static int
 185 nexus_inlist(const char *name, const char *const *list)
 186 {
 187         int i;
 188
 189         if (name == NULL)
 190                 return (0);
 191         for (i = 0; list[i] != NULL; i++)
 192                 if (strcmp(name, list[i]) == 0)
 193                         return (1);
 194         return (0);
 195 }
 196
 197 #define NEXUS_EXCLUDED(name, type)                                      \
 198         (nexus_inlist((name), nexus_excl_name) ||                       \
 199         ((type) != NULL && nexus_inlist((type), nexus_excl_type)))
 200
 201 static int
 202 nexus_probe(device_t dev)
 203 {
 204
 205         /* Nexus does always match. */
 206         device_set_desc(dev, "Open Firmware Nexus device");
 207         return (0);
 208 }
 209
 210 static int
 211 nexus_attach(device_t dev)
 212 {
 213         struct nexus_devinfo *ndi;
 214         struct nexus_softc *sc;
 215         device_t cdev;
 216         phandle_t node;
 217
 218         if (strcmp(device_get_name(device_get_parent(dev)), "root") == 0) {
 219                 node = OF_peer(0);
 220                 if (node == -1)
 221                         panic("%s: OF_peer failed.", __func__);
 222
 223                 sc = device_get_softc(dev);
 224                 sc->sc_intr_rman.rm_type = RMAN_ARRAY;
 225                 sc->sc_intr_rman.rm_descr = "Interrupts";
 226                 sc->sc_mem_rman.rm_type = RMAN_ARRAY;
 227                 sc->sc_mem_rman.rm_descr = "Device Memory";
 228                 if (rman_init(&sc->sc_intr_rman) != 0 ||
 229                     rman_init(&sc->sc_mem_rman) != 0 ||
 230                     rman_manage_region(&sc->sc_intr_rman, 0,
 231                     IV_MAX - 1) != 0 ||
 232                     rman_manage_region(&sc->sc_mem_rman, 0ULL, ~0ULL) != 0)
 233                         panic("%s: failed to set up rmans.", __func__);
 234         } else
 235                 node = ofw_bus_get_node(dev);
 236
 237         /*
 238          * Allow devices to identify.
 239          */
 240         bus_generic_probe(dev);
 241
 242         /*
 243          * Now walk the OFW tree and attach top-level devices.
 244          */
 245         for (node = OF_child(node); node > 0; node = OF_peer(node)) {
 246                 if ((ndi = nexus_setup_dinfo(dev, node)) == NULL)
 247                         continue;
 248                 cdev = device_add_child(dev, NULL, -1);
 249                 if (cdev == NULL) {
 250                         device_printf(dev, "<%s>: device_add_child failed\n",
 251                             ndi->ndi_obdinfo.obd_name);
 252                         nexus_destroy_dinfo(ndi);
 253                         continue;
 254                 }
 255                 device_set_ivars(cdev, ndi);
 256         }
 257         return (bus_generic_attach(dev));
 258 }
 259
 260 static device_t
 261 nexus_add_child(device_t dev, int order, const char *name, int unit)
 262 {
 263         device_t cdev;
 264         struct nexus_devinfo *ndi;
 265
 266         cdev = device_add_child_ordered(dev, order, name, unit);
 267         if (cdev == NULL)
 268                 return (NULL);
 269
 270         ndi = malloc(sizeof(*ndi), M_DEVBUF, M_WAITOK | M_ZERO);
 271         ndi->ndi_obdinfo.obd_node = -1;
 272         ndi->ndi_obdinfo.obd_name = strdup(name, M_OFWPROP);
 273         resource_list_init(&ndi->ndi_rl);
 274         device_set_ivars(cdev, ndi);
 275
 276         return (cdev);
 277 }
 278
 279 static int
 280 nexus_print_child(device_t dev, device_t child)
 281 {
 282         int rv;
 283
 284         rv = bus_print_child_header(dev, child);
 285         rv += nexus_print_res(device_get_ivars(child));
 286         rv += bus_print_child_footer(dev, child);
 287         return (rv);
 288 }
 289
 290 static void
 291 nexus_probe_nomatch(device_t dev, device_t child)
 292 {
 293         const char *type;
 294
 295         device_printf(dev, "<%s>", ofw_bus_get_name(child));
 296         nexus_print_res(device_get_ivars(child));
 297         type = ofw_bus_get_type(child);
 298         printf(" type %s (no driver attached)\n",
 299             type != NULL ? type : "unknown");
 300 }
 301
 302 static int
 303 nexus_setup_intr(device_t dev, device_t child, struct resource *res, int flags,
 304     driver_filter_t *filt, driver_intr_t *intr, void *arg, void **cookiep)
 305 {
 306         int error;
 307
 308         if (res == NULL)
 309                 panic("%s: NULL interrupt resource!", __func__);
 310
 311         if ((rman_get_flags(res) & RF_SHAREABLE) == 0)
 312                 flags |= INTR_EXCL;
 313
 314         /* We depend here on rman_activate_resource() being idempotent. */
 315         error = rman_activate_resource(res);
 316         if (error)
 317                 return (error);
 318
 319         error = inthand_add(device_get_nameunit(child), rman_get_start(res),
 320             filt, intr, arg, flags, cookiep);
 321
 322         /*
 323          * XXX in case of the AFB/FFB interrupt and a Psycho, Sabre or U2S
 324          * bridge enable the interrupt in the respective bridge.
 325          */
 326
 327         return (error);
 328 }
 329
 330 static int
 331 nexus_teardown_intr(device_t dev, device_t child, struct resource *r, void *ih)
 332 {
 333
 334         inthand_remove(rman_get_start(r), ih);
 335         return (0);
 336 }
 337
 338 #ifdef SMP
 339 static int
 340 nexus_bind_intr(device_t dev, device_t child, struct resource *r, int cpu)
 341 {
 342
 343         return (intr_bind(rman_get_start(r), cpu));
 344 }
 345 #endif
 346
 347 static int
 348 nexus_describe_intr(device_t dev, device_t child, struct resource *r,
 349     void *cookie, const char *descr)
 350 {
 351
 352         return (intr_describe(rman_get_start(r), cookie, descr));
 353 }
 354
 355 static struct resource *
 356 nexus_alloc_resource(device_t bus, device_t child, int type, int *rid,
 357     u_long start, u_long end, u_long count, u_int flags)
 358 {
 359         struct nexus_softc *sc;
 360         struct rman *rm;
 361         struct resource *rv;
 362         struct resource_list_entry *rle;
 363         device_t nexus;
 364         int isdefault, needactivate, passthrough;
 365
 366         isdefault = (start == 0UL && end == ~0UL);
 367         needactivate = flags & RF_ACTIVE;
 368         passthrough = (device_get_parent(child) != bus);
 369         nexus = bus;
 370         while (strcmp(device_get_name(device_get_parent(nexus)), "root") != 0)
 371                 nexus = device_get_parent(nexus);
 372         sc = device_get_softc(nexus);
 373         rle = NULL;
 374
 375         if (!passthrough) {
 376                 rle = resource_list_find(BUS_GET_RESOURCE_LIST(bus, child),
 377                     type, *rid);
 378                 if (rle == NULL)
 379                         return (NULL);
 380                 if (rle->res != NULL)
 381                         panic("%s: resource entry is busy", __func__);
 382                 if (isdefault) {
 383                         start = rle->start;
 384                         count = ulmax(count, rle->count);
 385                         end = ulmax(rle->end, start + count - 1);
 386                 }
 387         }
 388
 389         switch (type) {
 390         case SYS_RES_IRQ:
 391                 rm = &sc->sc_intr_rman;
 392                 break;
 393         case SYS_RES_MEMORY:
 394                 rm = &sc->sc_mem_rman;
 395                 break;
 396         default:
 397                 return (NULL);
 398         }
 399
 400         flags &= ~RF_ACTIVE;
 401         rv = rman_reserve_resource(rm, start, end, count, flags, child);
 402         if (rv == NULL)
 403                 return (NULL);
 404         rman_set_rid(rv, *rid);
 405         if (type == SYS_RES_MEMORY) {
 406                 rman_set_bustag(rv, &nexus_bustag);
 407                 rman_set_bushandle(rv, rman_get_start(rv));
 408         }
 409
 410         if (needactivate) {
 411                 if (bus_activate_resource(child, type, *rid, rv) != 0) {
 412                         rman_release_resource(rv);
 413                         return (NULL);
 414                 }
 415         }
 416
 417         if (!passthrough) {
 418                 rle->res = rv;
 419                 rle->start = rman_get_start(rv);
 420                 rle->end = rman_get_end(rv);
 421                 rle->count = rle->end - rle->start + 1;
 422         }
 423
 424         return (rv);
 425 }
 426
 427 static int
 428 nexus_activate_resource(device_t bus, device_t child, int type, int rid,
 429     struct resource *r)
 430 {
 431
 432         /* Not much to be done yet... */
 433         return (rman_activate_resource(r));
 434 }
 435
 436 static int
 437 nexus_deactivate_resource(device_t bus, device_t child, int type, int rid,
 438     struct resource *r)
 439 {
 440
 441         /* Not much to be done yet... */
 442         return (rman_deactivate_resource(r));
 443 }
 444
 445 static int
 446 nexus_release_resource(device_t bus, device_t child, int type, int rid,
 447     struct resource *r)
 448 {
 449         int error;
 450
 451         if (rman_get_flags(r) & RF_ACTIVE) {
 452                 error = bus_deactivate_resource(child, type, rid, r);
 453                 if (error)
 454                         return (error);
 455         }
 456         return (rman_release_resource(r));
 457 }
 458
 459 static struct resource_list *
 460 nexus_get_resource_list(device_t dev, device_t child)
 461 {
 462         struct nexus_devinfo *ndi;
 463
 464         ndi = device_get_ivars(child);
 465         return (&ndi->ndi_rl);
 466 }
 467
 468 static bus_dma_tag_t
 469 nexus_get_dma_tag(device_t bus, device_t child)
 470 {
 471
 472         return (&nexus_dmatag);
 473 }
 474
 475 static const struct ofw_bus_devinfo *
 476 nexus_get_devinfo(device_t dev, device_t child)
 477 {
 478         struct nexus_devinfo *ndi;
 479
 480         ndi = device_get_ivars(child);
 481         return (&ndi->ndi_obdinfo);
 482 }
 483
 484 static struct nexus_devinfo *
 485 nexus_setup_dinfo(device_t dev, phandle_t node)
 486 {
 487         struct nexus_devinfo *ndi;
 488         struct nexus_regs *reg;
 489         bus_addr_t phys;
 490         bus_size_t size;
 491         uint32_t ign;
 492         uint32_t *intr;
 493         int i;
 494         int nintr;
 495         int nreg;
 496
 497         ndi = malloc(sizeof(*ndi), M_DEVBUF, M_WAITOK | M_ZERO);
 498         if (ofw_bus_gen_setup_devinfo(&ndi->ndi_obdinfo, node) != 0) {
 499                 free(ndi, M_DEVBUF);
 500                 return (NULL);
 501         }
 502         if (NEXUS_EXCLUDED(ndi->ndi_obdinfo.obd_name,
 503             ndi->ndi_obdinfo.obd_type)) {
 504                 ofw_bus_gen_destroy_devinfo(&ndi->ndi_obdinfo);
 505                 free(ndi, M_DEVBUF);
 506                 return (NULL);
 507         }
 508         resource_list_init(&ndi->ndi_rl);
 509         nreg = OF_getprop_alloc(node, "reg", sizeof(*reg), (void **)&reg);
 510         if (nreg == -1) {
 511                 device_printf(dev, "<%s>: incomplete\n",
 512                     ndi->ndi_obdinfo.obd_name);
 513                 goto fail;
 514         }
 515         for (i = 0; i < nreg; i++) {
 516                 phys = NEXUS_REG_PHYS(&reg[i]);
 517                 size = NEXUS_REG_SIZE(&reg[i]);
 518                 /* Skip the dummy reg property of glue devices like ssm(4). */
 519                 if (size != 0)
 520                         resource_list_add(&ndi->ndi_rl, SYS_RES_MEMORY, i,
 521                             phys, phys + size - 1, size);
 522         }
 523         free(reg, M_OFWPROP);
 524
 525         nintr = OF_getprop_alloc(node, "interrupts",  sizeof(*intr),
 526             (void **)&intr);
 527         if (nintr > 0) {
 528                 if (OF_getprop(node, PCPU_GET(impl) < CPU_IMPL_ULTRASPARCIII ?
 529                     "upa-portid" : "portid", &ign, sizeof(ign)) <= 0) {
 530                         device_printf(dev, "<%s>: could not determine portid\n",
 531                             ndi->ndi_obdinfo.obd_name);
 532                         free(intr, M_OFWPROP);
 533                         goto fail;
 534                 }
 535
 536                 /* XXX 7-bit MID on Starfire */
 537                 ign = (ign << INTMAP_IGN_SHIFT) & INTMAP_IGN_MASK;
 538                 for (i = 0; i < nintr; i++) {
 539                         intr[i] |= ign;
 540                         resource_list_add(&ndi->ndi_rl, SYS_RES_IRQ, i, intr[i],
 541                             intr[i], 1);
 542                 }
 543                 free(intr, M_OFWPROP);
 544         }
 545
 546         return (ndi);
 547
 548  fail:
 549         nexus_destroy_dinfo(ndi);
 550         return (NULL);
 551 }
 552
 553 static void
 554 nexus_destroy_dinfo(struct nexus_devinfo *ndi)
 555 {
 556
 557         resource_list_free(&ndi->ndi_rl);
 558         ofw_bus_gen_destroy_devinfo(&ndi->ndi_obdinfo);
 559         free(ndi, M_DEVBUF);
 560 }
 561
 562 static int
 563 nexus_print_res(struct nexus_devinfo *ndi)
 564 {
 565         int rv;
 566
 567         rv = 0;
 568         rv += resource_list_print_type(&ndi->ndi_rl, "mem", SYS_RES_MEMORY,
 569             "%#lx");
 570         rv += resource_list_print_type(&ndi->ndi_rl, "irq", SYS_RES_IRQ,
 571             "%ld");
 572         return (rv);
 573 }