sys/sparc64/pci/ofw_pcibus.c

   1 /*-
   2  * Copyright (c) 1997, Stefan Esser <se@freebsd.org>
   3  * Copyright (c) 2000, Michael Smith <msmith@freebsd.org>
   4  * Copyright (c) 2000, BSDi
   5  * Copyright (c) 2003, Thomas Moestl <tmm@FreeBSD.org>
   6  * Copyright (c) 2005 - 2009 Marius Strobl <marius@FreeBSD.org>
   7  * All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice unmodified, this list of conditions, and the following
  14  *    disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  20  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  21  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  22  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  23  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  24  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  28  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #include <sys/cdefs.h>
  32 __FBSDID("$FreeBSD$");
  33
  34 #include "opt_ofw_pci.h"
  35
  36 #include <sys/param.h>
  37 #include <sys/bus.h>
  38 #include <sys/kernel.h>
  39 #include <sys/libkern.h>
  40 #include <sys/module.h>
  41 #include <sys/pciio.h>
  42
  43 #include <dev/ofw/ofw_bus.h>
  44 #include <dev/ofw/ofw_pci.h>
  45 #include <dev/ofw/openfirm.h>
  46
  47 #include <machine/bus.h>
  48 #ifndef SUN4V
  49 #include <machine/bus_common.h>
  50 #include <machine/iommureg.h>
  51 #endif
  52 #include <machine/resource.h>
  53
  54 #include <dev/pci/pcireg.h>
  55 #include <dev/pci/pcivar.h>
  56 #include <dev/pci/pci_private.h>
  57
  58 #include <sparc64/pci/ofw_pci.h>
  59
  60 #include "pcib_if.h"
  61 #include "pci_if.h"
  62
  63 /* Helper functions */
  64 static void ofw_pcibus_setup_device(device_t bridge, uint32_t clock,
  65     u_int busno, u_int slot, u_int func);
  66
  67 /* Methods */
  68 static bus_child_pnpinfo_str_t ofw_pcibus_pnpinfo_str;
  69 static device_attach_t ofw_pcibus_attach;
  70 static device_probe_t ofw_pcibus_probe;
  71 static ofw_bus_get_devinfo_t ofw_pcibus_get_devinfo;
  72 static pci_assign_interrupt_t ofw_pcibus_assign_interrupt;
  73
  74 static device_method_t ofw_pcibus_methods[] = {
  75         /* Device interface */
  76         DEVMETHOD(device_probe,         ofw_pcibus_probe),
  77         DEVMETHOD(device_attach,        ofw_pcibus_attach),
  78
  79         /* Bus interface */
  80         DEVMETHOD(bus_child_pnpinfo_str, ofw_pcibus_pnpinfo_str),
  81
  82         /* PCI interface */
  83         DEVMETHOD(pci_assign_interrupt, ofw_pcibus_assign_interrupt),
  84
  85         /* ofw_bus interface */
  86         DEVMETHOD(ofw_bus_get_devinfo,  ofw_pcibus_get_devinfo),
  87         DEVMETHOD(ofw_bus_get_compat,   ofw_bus_gen_get_compat),
  88         DEVMETHOD(ofw_bus_get_model,    ofw_bus_gen_get_model),
  89         DEVMETHOD(ofw_bus_get_name,     ofw_bus_gen_get_name),
  90         DEVMETHOD(ofw_bus_get_node,     ofw_bus_gen_get_node),
  91         DEVMETHOD(ofw_bus_get_type,     ofw_bus_gen_get_type),
  92
  93         DEVMETHOD_END
  94 };
  95
  96 struct ofw_pcibus_devinfo {
  97         struct pci_devinfo      opd_dinfo;
  98         struct ofw_bus_devinfo  opd_obdinfo;
  99 };
 100
 101 static devclass_t pci_devclass;
 102
 103 DEFINE_CLASS_1(pci, ofw_pcibus_driver, ofw_pcibus_methods,
 104     sizeof(struct pci_softc), pci_driver);
 105 EARLY_DRIVER_MODULE(ofw_pcibus, pcib, ofw_pcibus_driver, pci_devclass, 0, 0,
 106     BUS_PASS_BUS);
 107 MODULE_VERSION(ofw_pcibus, 1);
 108 MODULE_DEPEND(ofw_pcibus, pci, 1, 1, 1);
 109
 110 static int
 111 ofw_pcibus_probe(device_t dev)
 112 {
 113
 114         if (ofw_bus_get_node(dev) == -1)
 115                 return (ENXIO);
 116         device_set_desc(dev, "OFW PCI bus");
 117
 118         return (0);
 119 }
 120
 121 /*
 122  * Perform miscellaneous setups the firmware usually does not do for us.
 123  */
 124 static void
 125 ofw_pcibus_setup_device(device_t bridge, uint32_t clock, u_int busno,
 126     u_int slot, u_int func)
 127 {
 128 #define CS_READ(n, w)                                                   \
 129         PCIB_READ_CONFIG(bridge, busno, slot, func, (n), (w))
 130 #define CS_WRITE(n, v, w)                                               \
 131         PCIB_WRITE_CONFIG(bridge, busno, slot, func, (n), (v), (w))
 132
 133 #ifndef SUN4V
 134         uint32_t reg;
 135
 136         /*
 137          * Initialize the latency timer register for busmaster devices to
 138          * work properly.  This is another task which the firmware doesn't
 139          * always perform.  The Min_Gnt register can be used to compute its
 140          * recommended value: it contains the desired latency in units of
 141          * 1/4 us assuming a clock rate of 33MHz.  To calculate the correct
 142          * latency timer value, the clock frequency of the bus (defaulting
 143          * to 33MHz) should be used and no wait states assumed.
 144          * For bridges, we additionally set up the bridge control and the
 145          * secondary latency registers.
 146          */
 147         if ((CS_READ(PCIR_HDRTYPE, 1) & PCIM_HDRTYPE) ==
 148             PCIM_HDRTYPE_BRIDGE) {
 149                 reg = CS_READ(PCIR_BRIDGECTL_1, 1);
 150                 reg |= PCIB_BCR_MASTER_ABORT_MODE | PCIB_BCR_SERR_ENABLE |
 151                     PCIB_BCR_PERR_ENABLE;
 152 #ifdef OFW_PCI_DEBUG
 153                 device_printf(bridge,
 154                     "bridge %d/%d/%d: control 0x%x -> 0x%x\n",
 155                     busno, slot, func, CS_READ(PCIR_BRIDGECTL_1, 1), reg);
 156 #endif /* OFW_PCI_DEBUG */
 157                 CS_WRITE(PCIR_BRIDGECTL_1, reg, 1);
 158
 159                 reg = OFW_PCI_LATENCY;
 160 #ifdef OFW_PCI_DEBUG
 161                 device_printf(bridge,
 162                     "bridge %d/%d/%d: latency timer %d -> %d\n",
 163                     busno, slot, func, CS_READ(PCIR_SECLAT_1, 1), reg);
 164 #endif /* OFW_PCI_DEBUG */
 165                 CS_WRITE(PCIR_SECLAT_1, reg, 1);
 166         } else {
 167                 reg = CS_READ(PCIR_MINGNT, 1);
 168                 if ((int)reg > 0) {
 169                         switch (clock) {
 170                         case 33000000:
 171                                 reg *= 8;
 172                                 break;
 173                         case 66000000:
 174                                 reg *= 4;
 175                                 break;
 176                         }
 177                         reg = min(reg, 255);
 178                 } else
 179                         reg = OFW_PCI_LATENCY;
 180         }
 181 #ifdef OFW_PCI_DEBUG
 182         device_printf(bridge, "device %d/%d/%d: latency timer %d -> %d\n",
 183             busno, slot, func, CS_READ(PCIR_LATTIMER, 1), reg);
 184 #endif /* OFW_PCI_DEBUG */
 185         CS_WRITE(PCIR_LATTIMER, reg, 1);
 186
 187         /*
 188          * Compute a value to write into the cache line size register.
 189          * The role of the streaming cache is unclear in write invalidate
 190          * transfers, so it is made sure that it's line size is always
 191          * reached.  Generally, the cache line size is fixed at 64 bytes
 192          * by Fireplane/Safari, JBus and UPA.
 193          */
 194         CS_WRITE(PCIR_CACHELNSZ, STRBUF_LINESZ / sizeof(uint32_t), 1);
 195 #endif
 196
 197         /*
 198          * Ensure that ALi M5229 report the actual content of PCIR_PROGIF
 199          * and that IDE I/O is force enabled.  The former is done in order
 200          * to have unique behavior across revisions as some default to
 201          * hiding bits 4-6 for compliance with PCI 2.3.  The latter is done
 202          * as at least revision 0xc8 requires the PCIM_CMD_PORTEN bypass
 203          * to be always enabled as otherwise even enabling PCIM_CMD_PORTEN
 204          * results in an instant data access trap on Fire-based machines.
 205          * Thus these quirks have to be handled before pci(4) adds the maps.
 206          * Note that for older revisions bit 0 of register 0x50 enables the
 207          * internal IDE function instead of force enabling IDE I/O.
 208          */
 209         if ((CS_READ(PCIR_VENDOR, 2) == 0x10b9 &&
 210             CS_READ(PCIR_DEVICE, 2) == 0x5229))
 211                 CS_WRITE(0x50, CS_READ(0x50, 1) | 0x3, 1);
 212
 213         /*
 214          * The preset in the intline register is usually wrong.  Reset
 215          * it to 255, so that the PCI code will reroute the interrupt if
 216          * needed.
 217          */
 218         CS_WRITE(PCIR_INTLINE, PCI_INVALID_IRQ, 1);
 219
 220 #undef CS_READ
 221 #undef CS_WRITE
 222 }
 223
 224 static int
 225 ofw_pcibus_attach(device_t dev)
 226 {
 227         device_t pcib;
 228         struct ofw_pci_register pcir;
 229         struct ofw_pcibus_devinfo *dinfo;
 230         phandle_t node, child;
 231         uint32_t clock;
 232         u_int busno, domain, func, slot;
 233         int error;
 234
 235         error = pci_attach_common(dev);
 236         if (error)
 237                 return (error);
 238         pcib = device_get_parent(dev);
 239         domain = pcib_get_domain(dev);
 240         busno = pcib_get_bus(dev);
 241         node = ofw_bus_get_node(dev);
 242
 243         /*
 244          * Add the PCI side of the host-PCI bridge itself to the bus.
 245          * Note that we exclude the host-PCIe bridges here as these
 246          * have no configuration space implemented themselves.
 247          */
 248         if (strcmp(device_get_name(device_get_parent(pcib)), "nexus") == 0 &&
 249             ofw_bus_get_type(pcib) != NULL &&
 250             strcmp(ofw_bus_get_type(pcib), OFW_TYPE_PCIE) != 0 &&
 251             (dinfo = (struct ofw_pcibus_devinfo *)pci_read_device(pcib,
 252             domain, busno, 0, 0, sizeof(*dinfo))) != NULL) {
 253                 if (ofw_bus_gen_setup_devinfo(&dinfo->opd_obdinfo, node) != 0)
 254                         pci_freecfg((struct pci_devinfo *)dinfo);
 255                 else
 256                         pci_add_child(dev, (struct pci_devinfo *)dinfo);
 257         }
 258
 259         if (OF_getprop(ofw_bus_get_node(pcib), "clock-frequency", &clock,
 260             sizeof(clock)) == -1)
 261                 clock = 33000000;
 262         for (child = OF_child(node); child != 0; child = OF_peer(child)) {
 263                 if (OF_getprop(child, "reg", &pcir, sizeof(pcir)) == -1)
 264                         continue;
 265                 slot = OFW_PCI_PHYS_HI_DEVICE(pcir.phys_hi);
 266                 func = OFW_PCI_PHYS_HI_FUNCTION(pcir.phys_hi);
 267                 /* Some OFW device trees contain dupes. */
 268                 if (pci_find_dbsf(domain, busno, slot, func) != NULL)
 269                         continue;
 270                 ofw_pcibus_setup_device(pcib, clock, busno, slot, func);
 271                 dinfo = (struct ofw_pcibus_devinfo *)pci_read_device(pcib,
 272                     domain, busno, slot, func, sizeof(*dinfo));
 273                 if (dinfo == NULL)
 274                         continue;
 275                 if (ofw_bus_gen_setup_devinfo(&dinfo->opd_obdinfo, child) !=
 276                     0) {
 277                         pci_freecfg((struct pci_devinfo *)dinfo);
 278                         continue;
 279                 }
 280                 pci_add_child(dev, (struct pci_devinfo *)dinfo);
 281                 OFW_PCI_SETUP_DEVICE(pcib, dinfo->opd_dinfo.cfg.dev);
 282         }
 283
 284         return (bus_generic_attach(dev));
 285 }
 286
 287 static int
 288 ofw_pcibus_assign_interrupt(device_t dev, device_t child)
 289 {
 290         ofw_pci_intr_t intr;
 291         int isz;
 292
 293         isz = OF_getprop(ofw_bus_get_node(child), "interrupts", &intr,
 294             sizeof(intr));
 295         if (isz != sizeof(intr)) {
 296                 /* No property; our best guess is the intpin. */
 297                 intr = pci_get_intpin(child);
 298 #ifndef SUN4V
 299         } else if (intr >= 255) {
 300                 /*
 301                  * A fully specified interrupt (including IGN), as present on
 302                  * SPARCengine Ultra AX and E450.  Extract the INO and return
 303                  * it.
 304                  */
 305                 return (INTINO(intr));
 306 #endif
 307         }
 308         /*
 309          * If we got intr from a property, it may or may not be an intpin.
 310          * For on-board devices, it frequently is not, and is completely out
 311          * of the valid intpin range.  For PCI slots, it hopefully is,
 312          * otherwise we will have trouble interfacing with non-OFW buses
 313          * such as cardbus.
 314          * Since we cannot tell which it is without violating layering, we
 315          * will always use the route_interrupt method, and treat exceptions
 316          * on the level they become apparent.
 317          */
 318         return (PCIB_ROUTE_INTERRUPT(device_get_parent(dev), child, intr));
 319 }
 320
 321 static const struct ofw_bus_devinfo *
 322 ofw_pcibus_get_devinfo(device_t bus, device_t dev)
 323 {
 324         struct ofw_pcibus_devinfo *dinfo;
 325
 326         dinfo = device_get_ivars(dev);
 327         return (&dinfo->opd_obdinfo);
 328 }
 329
 330 static int
 331 ofw_pcibus_pnpinfo_str(device_t dev, device_t child, char *buf,
 332     size_t buflen)
 333 {
 334
 335         pci_child_pnpinfo_str_method(dev, child, buf, buflen);
 336         if (ofw_bus_get_node(child) != -1)  {
 337                 strlcat(buf, " ", buflen); /* Separate info. */
 338                 ofw_bus_gen_child_pnpinfo_str(dev, child, buf, buflen);
 339         }
 340
 341         return (0);
 342 }