sys/sparc64/sparc64/upa.c

   1 /*-
   2  * Copyright (c) 2006 Marius Strobl <marius@FreeBSD.org>
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  */
  26
  27 #include <sys/cdefs.h>
  28 __FBSDID("$FreeBSD$");
  29
  30 #include <sys/param.h>
  31 #include <sys/systm.h>
  32 #include <sys/bus.h>
  33 #include <sys/kernel.h>
  34 #include <sys/module.h>
  35 #include <sys/pcpu.h>
  36 #include <sys/resource.h>
  37 #include <sys/rman.h>
  38
  39 #include <dev/ofw/ofw_bus.h>
  40 #include <dev/ofw/ofw_bus_subr.h>
  41 #include <dev/ofw/openfirm.h>
  42
  43 #include <machine/bus.h>
  44 #include <machine/bus_common.h>
  45 #include <machine/resource.h>
  46
  47 #define UPA_NREG        3
  48
  49 #define UPA_CFG         0
  50 #define UPA_IMR1        1
  51 #define UPA_IMR2        2
  52
  53 /* UPA_CFG bank */
  54 #define UPA_CFG_UPA0                    0x00    /* UPA0 config register */
  55 #define UPA_CFG_UPA1                    0x08    /* UPA1 config register */
  56 #define UPA_CFG_IF                      0x10    /* interface config register */
  57 #define  UPA_CFG_IF_RST                 0x00
  58 #define  UPA_CFG_IF_POK_RST             0x02
  59 #define  UPA_CFG_IF_POK                 0x03
  60 #define UPA_CFG_ESTAR                   0x18    /* Estar config register */
  61 #define  UPA_CFG_ESTAR_SPEED_FULL       0x01
  62 #define  UPA_CFG_ESTAR_SPEED_1_2        0x02
  63 #define  UPA_CFG_ESTAR_SPEED_1_64       0x40
  64
  65 #define UPA_INO_BASE                    0x2a
  66
  67 struct upa_regs {
  68         uint64_t        phys;
  69         uint64_t        size;
  70 };
  71
  72 struct upa_ranges {
  73         uint64_t        child;
  74         uint64_t        parent;
  75         uint64_t        size;
  76 };
  77
  78 struct upa_devinfo {
  79         struct ofw_bus_devinfo  udi_obdinfo;
  80         struct resource_list    udi_rl;
  81 };
  82
  83 struct upa_softc {
  84         struct resource         *sc_res[UPA_NREG];
  85         bus_space_tag_t         sc_bt[UPA_NREG];
  86         bus_space_handle_t      sc_bh[UPA_NREG];
  87
  88         uint32_t                sc_ign;
  89
  90         int                     sc_nrange;
  91         struct upa_ranges       *sc_ranges;
  92 };
  93
  94 #define UPA_READ(sc, reg, off) \
  95         bus_space_read_8((sc)->sc_bt[(reg)], (sc)->sc_bh[(reg)], (off))
  96 #define UPA_WRITE(sc, reg, off, val) \
  97         bus_space_write_8((sc)->sc_bt[(reg)], (sc)->sc_bh[(reg)], (off), (val))
  98
  99 static device_probe_t upa_probe;
 100 static device_attach_t upa_attach;
 101 static bus_alloc_resource_t upa_alloc_resource;
 102 static bus_setup_intr_t upa_setup_intr;
 103 static bus_print_child_t upa_print_child;
 104 static bus_probe_nomatch_t upa_probe_nomatch;
 105 static bus_get_resource_list_t upa_get_resource_list;
 106 static ofw_bus_get_devinfo_t upa_get_devinfo;
 107
 108 static struct upa_devinfo *upa_setup_dinfo(device_t, struct upa_softc *,
 109     phandle_t, uint32_t);
 110 static void upa_destroy_dinfo(struct upa_devinfo *);
 111 static int upa_print_res(struct upa_devinfo *);
 112
 113 static device_method_t upa_methods[] = {
 114         /* Device interface */
 115         DEVMETHOD(device_probe,         upa_probe),
 116         DEVMETHOD(device_attach,        upa_attach),
 117         DEVMETHOD(device_shutdown,      bus_generic_shutdown),
 118         DEVMETHOD(device_suspend,       bus_generic_suspend),
 119         DEVMETHOD(device_resume,        bus_generic_resume),
 120
 121         /* Bus interface */
 122         DEVMETHOD(bus_print_child,      upa_print_child),
 123         DEVMETHOD(bus_probe_nomatch,    upa_probe_nomatch),
 124         DEVMETHOD(bus_read_ivar,        bus_generic_read_ivar),
 125         DEVMETHOD(bus_write_ivar,       bus_generic_write_ivar),
 126         DEVMETHOD(bus_alloc_resource,   upa_alloc_resource),
 127         DEVMETHOD(bus_activate_resource, bus_generic_activate_resource),
 128         DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource),
 129         DEVMETHOD(bus_release_resource, bus_generic_rl_release_resource),
 130         DEVMETHOD(bus_setup_intr,       upa_setup_intr),
 131         DEVMETHOD(bus_teardown_intr,    bus_generic_teardown_intr),
 132         DEVMETHOD(bus_get_resource,     bus_generic_rl_get_resource),
 133         DEVMETHOD(bus_get_resource_list, upa_get_resource_list),
 134
 135         /* ofw_bus interface */
 136         DEVMETHOD(ofw_bus_get_devinfo,  upa_get_devinfo),
 137         DEVMETHOD(ofw_bus_get_compat,   ofw_bus_gen_get_compat),
 138         DEVMETHOD(ofw_bus_get_model,    ofw_bus_gen_get_model),
 139         DEVMETHOD(ofw_bus_get_name,     ofw_bus_gen_get_name),
 140         DEVMETHOD(ofw_bus_get_node,     ofw_bus_gen_get_node),
 141         DEVMETHOD(ofw_bus_get_type,     ofw_bus_gen_get_type),
 142
 143         { NULL, NULL }
 144 };
 145
 146 static devclass_t upa_devclass;
 147
 148 DEFINE_CLASS_0(upa, upa_driver, upa_methods, sizeof(struct upa_softc));
 149 DRIVER_MODULE(upa, nexus, upa_driver, upa_devclass, 0, 0);
 150
 151 static int
 152 upa_probe(device_t dev)
 153 {
 154         const char* compat;
 155
 156         compat = ofw_bus_get_compat(dev);
 157         if (compat != NULL && strcmp(ofw_bus_get_name(dev), "upa") == 0 &&
 158             strcmp(compat, "upa64s") == 0) {
 159                 device_set_desc(dev, "UPA bridge");
 160                 return (BUS_PROBE_DEFAULT);
 161         }
 162         return (ENXIO);
 163 }
 164
 165 static int
 166 upa_attach(device_t dev)
 167 {
 168         struct upa_devinfo *udi;
 169         struct upa_softc *sc;
 170         phandle_t child, node;
 171         device_t cdev;
 172         uint32_t portid;
 173         int i, rid;
 174 #if 1
 175         device_t *children, schizo = NULL;
 176         int j, nchildren;
 177 #endif
 178
 179         sc = device_get_softc(dev);
 180         node = ofw_bus_get_node(dev);
 181         for (i = UPA_CFG; i <= UPA_IMR2; i++) {
 182                 rid = i;
 183                 /* UPA_IMR1 is shared with the Schizo PCI bus B CSR bank. */
 184 #if 0
 185                 sc->sc_res[i] = bus_alloc_resource_any(dev, SYS_RES_MEMORY,
 186                     &rid, (i == UPA_IMR1 ? RF_SHAREABLE : 0) | RF_ACTIVE);
 187                 if (sc->sc_res[i] == NULL) {
 188                         device_printf(dev,
 189                             "could not allocate resource %d\n", i);
 190                         goto fail;
 191                 }
 192                 sc->sc_bt[i] = rman_get_bustag(sc->sc_res[i]);
 193                 sc->sc_bh[i] = rman_get_bushandle(sc->sc_res[i]);
 194 #else
 195                 /*
 196                  * Workaround for the fact that rman(9) only allows to
 197                  * share resources of the same size.
 198                  */
 199                 if (i == UPA_IMR1) {
 200                         if (device_get_children(device_get_parent(dev),
 201                             &children, &nchildren) != 0) {
 202                                 device_printf(dev, "could not get children\n");
 203                                 goto fail;
 204                         }
 205                         for (j = 0; j < nchildren; j++) {
 206                                 if (ofw_bus_get_type(children[i]) != NULL &&
 207                                     strcmp(ofw_bus_get_type(children[i]),
 208                                     "pci") == 0 &&
 209                                     ofw_bus_get_compat(children[i]) != NULL &&
 210                                     strcmp(ofw_bus_get_compat(children[i]),
 211                                     "pci108e,8001") == 0 &&
 212                                     ((bus_get_resource_start(children[i],
 213                                     SYS_RES_MEMORY, 0) >> 20) & 1) == 1) {
 214                                         schizo = children[i];
 215                                         break;
 216                                 }
 217                         }
 218                         free(children, M_TEMP);
 219                         if (schizo == NULL) {
 220                                 device_printf(dev, "could not find Schizo\n");
 221                                 goto fail;
 222                         }
 223                         rid = 0;
 224                         sc->sc_res[i] = bus_alloc_resource_any(schizo,
 225                             SYS_RES_MEMORY, &rid, RF_SHAREABLE | RF_ACTIVE);
 226                         if (sc->sc_res[i] == NULL) {
 227                                 device_printf(dev,
 228                                     "could not allocate resource %d\n", i);
 229                                 goto fail;
 230                         }
 231                 } else
 232                         sc->sc_res[i] = bus_alloc_resource_any(dev,
 233                             SYS_RES_MEMORY, &rid, RF_ACTIVE);
 234                 if (sc->sc_res[i] == NULL) {
 235                         device_printf(dev,
 236                             "could not allocate resource %d\n", i);
 237                         goto fail;
 238                 }
 239                 sc->sc_bt[i] = rman_get_bustag(sc->sc_res[i]);
 240                 sc->sc_bh[i] = rman_get_bushandle(sc->sc_res[i]);
 241                 if (i == UPA_IMR1)
 242                         bus_space_subregion(sc->sc_bt[i], sc->sc_bh[i],
 243                             bus_get_resource_start(dev, SYS_RES_MEMORY,
 244                             UPA_IMR1), bus_get_resource_count(dev,
 245                             SYS_RES_MEMORY, UPA_IMR1), &sc->sc_bh[i]);
 246 #endif
 247         }
 248
 249         if (OF_getprop(node, "portid", &portid, sizeof(portid)) == -1) {
 250                 device_printf(dev, "could not determine portid\n");
 251                 goto fail;
 252         }
 253         sc->sc_ign = (portid << INTMAP_IGN_SHIFT) & INTMAP_IGN_MASK;
 254
 255         sc->sc_nrange = OF_getprop_alloc(node, "ranges", sizeof(*sc->sc_ranges),
 256             (void **)&sc->sc_ranges);
 257         if (sc->sc_nrange == -1) {
 258                 device_printf(dev, "could not determine ranges\n");
 259                 goto fail;
 260         }
 261
 262         /* Make sure the power level is appropriate for normal operation. */
 263         if (UPA_READ(sc, UPA_CFG, UPA_CFG_IF) != UPA_CFG_IF_POK) {
 264                 if (bootverbose)
 265                         device_printf(dev, "applying power\n");
 266                 UPA_WRITE(sc, UPA_CFG, UPA_CFG_ESTAR, UPA_CFG_ESTAR_SPEED_1_2);
 267                 UPA_WRITE(sc, UPA_CFG, UPA_CFG_ESTAR, UPA_CFG_ESTAR_SPEED_FULL);
 268                 (void)UPA_READ(sc, UPA_CFG, UPA_CFG_ESTAR);
 269                 UPA_WRITE(sc, UPA_CFG, UPA_CFG_IF, UPA_CFG_IF_POK_RST);
 270                 (void)UPA_READ(sc, UPA_CFG, UPA_CFG_IF);
 271                 DELAY(20000);
 272                 UPA_WRITE(sc, UPA_CFG, UPA_CFG_IF, UPA_CFG_IF_POK);
 273                 (void)UPA_READ(sc, UPA_CFG, UPA_CFG_IF);
 274         }
 275
 276         for (child = OF_child(node); child != 0; child = OF_peer(child)) {
 277                 /*
 278                  * The `upa-portid' properties of the children are used as
 279                  * index for the interrupt mapping registers. Thus we also
 280                  * use it as device unit number in order to save on a unit
 281                  * member in the devinfo struct.
 282                  * The `upa-portid' properties are also used to make up the
 283                  * INOs of the children as the values contained in their
 284                  * `interrupts' properties are bogus.
 285                  */
 286                 if (OF_getprop(child, "upa-portid", &portid,
 287                     sizeof(portid)) == -1) {
 288                         device_printf(dev,
 289                             "could not determine upa-portid of child 0x%lx\n",
 290                             (unsigned long)child);
 291                         continue;
 292                 }
 293                 if (portid > 1) {
 294                         device_printf(dev,
 295                             "upa-portid %d of child 0x%lx invalid\n", portid,
 296                             (unsigned long)child);
 297                         continue;
 298                 }
 299                 if ((udi = upa_setup_dinfo(dev, sc, child, portid)) == NULL)
 300                         continue;
 301                 if ((cdev = device_add_child(dev, NULL, portid)) == NULL) {
 302                         device_printf(dev, "<%s>: device_add_child failed\n",
 303                             udi->udi_obdinfo.obd_name);
 304                         upa_destroy_dinfo(udi);
 305                         continue;
 306                 }
 307                 device_set_ivars(cdev, udi);
 308         }
 309
 310         return (bus_generic_attach(dev));
 311
 312  fail:
 313         for (i = UPA_CFG; i <= UPA_IMR2 && sc->sc_res[i] != NULL; i++)
 314 #if 0
 315                 bus_release_resource(dev, SYS_RES_MEMORY,
 316                     rman_get_rid(sc->sc_res[i]), sc->sc_res[i]);
 317 #else
 318                 bus_release_resource(i == UPA_IMR1 ? schizo : dev,
 319                     SYS_RES_MEMORY, rman_get_rid(sc->sc_res[i]),
 320                     sc->sc_res[i]);
 321 #endif
 322         return (ENXIO);
 323 }
 324
 325 static int
 326 upa_print_child(device_t dev, device_t child)
 327 {
 328         int rv;
 329
 330         rv = bus_print_child_header(dev, child);
 331         rv += upa_print_res(device_get_ivars(child));
 332         rv += bus_print_child_footer(dev, child);
 333         return (rv);
 334 }
 335
 336 static void
 337 upa_probe_nomatch(device_t dev, device_t child)
 338 {
 339         const char *type;
 340
 341         device_printf(dev, "<%s>", ofw_bus_get_name(child));
 342         upa_print_res(device_get_ivars(child));
 343         type = ofw_bus_get_type(child);
 344         printf(" type %s (no driver attached)\n",
 345             type != NULL ? type : "unknown");
 346 }
 347
 348 static struct resource *
 349 upa_alloc_resource(device_t dev, device_t child, int type, int *rid,
 350     u_long start, u_long end, u_long count, u_int flags)
 351 {
 352         struct resource_list *rl;
 353         struct resource_list_entry *rle;
 354         struct upa_softc *sc;
 355         struct resource *rv;
 356         bus_addr_t cend, cstart;
 357         int i, isdefault, passthrough;
 358
 359         isdefault = (start == 0UL && end == ~0UL);
 360         passthrough = (device_get_parent(child) != dev);
 361         sc = device_get_softc(dev);
 362         rl = BUS_GET_RESOURCE_LIST(dev, child);
 363         rle = NULL;
 364         switch (type) {
 365         case SYS_RES_IRQ:
 366                 return (resource_list_alloc(rl, dev, child, type, rid, start,
 367                     end, count, flags));
 368         case SYS_RES_MEMORY:
 369                 if (!passthrough) {
 370                         rle = resource_list_find(rl, type, *rid);
 371                         if (rle == NULL)
 372                                 return (NULL);
 373                         if (rle->res != NULL)
 374                                 panic("%s: resource entry is busy", __func__);
 375                         if (isdefault) {
 376                                 start = rle->start;
 377                                 count = ulmax(count, rle->count);
 378                                 end = ulmax(rle->end, start + count - 1);
 379                         }
 380                 }
 381                 for (i = 0; i < sc->sc_nrange; i++) {
 382                         cstart = sc->sc_ranges[i].child;
 383                         cend = cstart + sc->sc_ranges[i].size - 1;
 384                         if (start < cstart || start > cend)
 385                                 continue;
 386                         if (end < cstart || end > cend)
 387                                 return (NULL);
 388                         start += sc->sc_ranges[i].parent - cstart;
 389                         end += sc->sc_ranges[i].parent - cstart;
 390                         rv = bus_generic_alloc_resource(dev, child, type, rid,
 391                             start, end, count, flags);
 392                         if (!passthrough)
 393                                 rle->res = rv;
 394                         return (rv);
 395                 }
 396                 /* FALLTHROUGH */
 397         default:
 398                 return (NULL);
 399         }
 400 }
 401
 402 static int
 403 upa_setup_intr(device_t dev, device_t child, struct resource *ires, int flags,
 404     driver_filter_t *filt, driver_intr_t *func, void *arg, void **cookiep)
 405 {
 406         struct upa_softc *sc;
 407         uint64_t intrmap;
 408         u_int imr;
 409         int error;
 410
 411         sc = device_get_softc(dev);
 412         imr = device_get_unit(child) == 0 ? UPA_IMR1 : UPA_IMR2;
 413         intrmap = UPA_READ(sc, imr, 0x0);
 414         if (INTVEC(intrmap) != INTVEC(rman_get_start(ires))) {
 415                 device_printf(dev,
 416                     "invalid interrupt vector (0x%x != 0x%x)\n",
 417                     (unsigned int)INTVEC(intrmap),
 418                     (unsigned int)INTVEC(rman_get_start(ires)));
 419                 return (EINVAL);
 420         }
 421
 422         /*
 423          * The interrupts are pulse type and therefore automatically
 424          * cleared. Thus we don't need to use a stub/wrapper like we
 425          * do with the other sun4u host-to-<foo> bridges.
 426          */
 427
 428         UPA_WRITE(sc, imr, 0x0, intrmap & ~INTMAP_V);
 429         (void)UPA_READ(sc, imr, 0x0);
 430         error = bus_generic_setup_intr(dev, child, ires, flags, filt,
 431             func, arg, cookiep);
 432         if (error != 0)
 433                 return (error);
 434         UPA_WRITE(sc, imr, 0x0, INTMAP_ENABLE(intrmap, PCPU_GET(mid)));
 435         (void)UPA_READ(sc, imr, 0x0);
 436
 437         return (0);
 438 }
 439
 440 static struct resource_list *
 441 upa_get_resource_list(device_t dev, device_t child)
 442 {
 443         struct upa_devinfo *udi;
 444
 445         udi = device_get_ivars(child);
 446         return (&udi->udi_rl);
 447 }
 448
 449 static const struct ofw_bus_devinfo *
 450 upa_get_devinfo(device_t dev, device_t child)
 451 {
 452         struct upa_devinfo *udi;
 453
 454         udi = device_get_ivars(child);
 455         return (&udi->udi_obdinfo);
 456 }
 457
 458 static struct upa_devinfo *
 459 upa_setup_dinfo(device_t dev, struct upa_softc *sc, phandle_t node,
 460     uint32_t portid)
 461 {
 462         struct upa_devinfo *udi;
 463         struct upa_regs *reg;
 464         uint32_t intr;
 465         int i, nreg;
 466
 467         udi = malloc(sizeof(*udi), M_DEVBUF, M_WAITOK | M_ZERO);
 468         if (ofw_bus_gen_setup_devinfo(&udi->udi_obdinfo, node) != 0) {
 469                 free(udi, M_DEVBUF);
 470                 return (NULL);
 471         }
 472         resource_list_init(&udi->udi_rl);
 473
 474         nreg = OF_getprop_alloc(node, "reg", sizeof(*reg), (void **)&reg);
 475         if (nreg == -1) {
 476                 device_printf(dev, "<%s>: incomplete\n",
 477                     udi->udi_obdinfo.obd_name);
 478                 goto fail;
 479         }
 480         for (i = 0; i < nreg; i++)
 481                 resource_list_add(&udi->udi_rl, SYS_RES_MEMORY, i, reg[i].phys,
 482                     reg[i].phys + reg[i].size - 1, reg[i].size);
 483         free(reg, M_OFWPROP);
 484
 485         intr = (UPA_INO_BASE + portid) | sc->sc_ign;
 486         resource_list_add(&udi->udi_rl, SYS_RES_IRQ, 0, intr, intr, 1);
 487
 488         return (udi);
 489
 490  fail:
 491         upa_destroy_dinfo(udi);
 492         return (NULL);
 493 }
 494
 495 static void
 496 upa_destroy_dinfo(struct upa_devinfo *dinfo)
 497 {
 498
 499         resource_list_free(&dinfo->udi_rl);
 500         ofw_bus_gen_destroy_devinfo(&dinfo->udi_obdinfo);
 501         free(dinfo, M_DEVBUF);
 502 }
 503
 504 static int
 505 upa_print_res(struct upa_devinfo *udi)
 506 {
 507         int rv;
 508
 509         rv = 0;
 510         rv += resource_list_print_type(&udi->udi_rl, "mem", SYS_RES_MEMORY,
 511             "%#lx");
 512         rv += resource_list_print_type(&udi->udi_rl, "irq", SYS_RES_IRQ,
 513             "%ld");
 514         return (rv);
 515 }