sys/powerpc/ofw/ofw_pcibus.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 1997, Stefan Esser <se@freebsd.org>
   5  * Copyright (c) 2000, Michael Smith <msmith@freebsd.org>
   6  * Copyright (c) 2000, BSDi
   7  * Copyright (c) 2003, Thomas Moestl <tmm@FreeBSD.org>
   8  * All rights reserved.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice unmodified, this list of conditions, and the following
  15  *    disclaimer.
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in the
  18  *    documentation and/or other materials provided with the distribution.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  21  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  22  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  23  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  24  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  25  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  29  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30  */
  31
  32 #include <sys/cdefs.h>
  33 __FBSDID("$FreeBSD$");
  34
  35 #include <sys/param.h>
  36 #include <sys/bus.h>
  37 #include <sys/kernel.h>
  38 #include <sys/libkern.h>
  39 #include <sys/module.h>
  40 #include <sys/pciio.h>
  41
  42 #include <dev/ofw/ofw_bus.h>
  43 #include <dev/ofw/ofw_bus_subr.h>
  44 #include <dev/ofw/ofw_pci.h>
  45 #include <dev/ofw/openfirm.h>
  46
  47 #include <machine/bus.h>
  48 #include <machine/intr_machdep.h>
  49 #include <machine/resource.h>
  50
  51 #include <dev/pci/pcireg.h>
  52 #include <dev/pci/pcivar.h>
  53 #include <dev/pci/pci_private.h>
  54
  55 #include "ofw_pcibus.h"
  56 #include "pcib_if.h"
  57 #include "pci_if.h"
  58
  59 typedef uint32_t ofw_pci_intr_t;
  60
  61 /* Methods */
  62 static device_probe_t ofw_pcibus_probe;
  63 static device_attach_t ofw_pcibus_attach;
  64 static pci_alloc_devinfo_t ofw_pcibus_alloc_devinfo;
  65 static pci_assign_interrupt_t ofw_pcibus_assign_interrupt;
  66 static ofw_bus_get_devinfo_t ofw_pcibus_get_devinfo;
  67 static bus_child_deleted_t ofw_pcibus_child_deleted;
  68 static int ofw_pcibus_child_pnpinfo_str_method(device_t cbdev, device_t child,
  69     char *buf, size_t buflen);
  70
  71 static void ofw_pcibus_enum_devtree(device_t dev, u_int domain, u_int busno);
  72 static void ofw_pcibus_enum_bus(device_t dev, u_int domain, u_int busno);
  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_deleted,    ofw_pcibus_child_deleted),
  81         DEVMETHOD(bus_child_pnpinfo_str, ofw_pcibus_child_pnpinfo_str_method),
  82         DEVMETHOD(bus_rescan,           bus_null_rescan),
  83
  84         /* PCI interface */
  85         DEVMETHOD(pci_alloc_devinfo,    ofw_pcibus_alloc_devinfo),
  86         DEVMETHOD(pci_assign_interrupt, ofw_pcibus_assign_interrupt),
  87
  88         /* ofw_bus interface */
  89         DEVMETHOD(ofw_bus_get_devinfo,  ofw_pcibus_get_devinfo),
  90         DEVMETHOD(ofw_bus_get_compat,   ofw_bus_gen_get_compat),
  91         DEVMETHOD(ofw_bus_get_model,    ofw_bus_gen_get_model),
  92         DEVMETHOD(ofw_bus_get_name,     ofw_bus_gen_get_name),
  93         DEVMETHOD(ofw_bus_get_node,     ofw_bus_gen_get_node),
  94         DEVMETHOD(ofw_bus_get_type,     ofw_bus_gen_get_type),
  95
  96         DEVMETHOD_END
  97 };
  98
  99 static devclass_t pci_devclass;
 100
 101 DEFINE_CLASS_1(pci, ofw_pcibus_driver, ofw_pcibus_methods,
 102     sizeof(struct pci_softc), pci_driver);
 103 DRIVER_MODULE(ofw_pcibus, pcib, ofw_pcibus_driver, pci_devclass, 0, 0);
 104 MODULE_VERSION(ofw_pcibus, 1);
 105 MODULE_DEPEND(ofw_pcibus, pci, 1, 1, 1);
 106
 107 static int ofw_devices_only = 0;
 108 TUNABLE_INT("hw.pci.ofw_devices_only", &ofw_devices_only);
 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 (BUS_PROBE_DEFAULT);
 119 }
 120
 121 static int
 122 ofw_pcibus_attach(device_t dev)
 123 {
 124         u_int busno, domain;
 125         int error;
 126
 127         error = pci_attach_common(dev);
 128         if (error)
 129                 return (error);
 130         domain = pcib_get_domain(dev);
 131         busno = pcib_get_bus(dev);
 132
 133         /*
 134          * Attach those children represented in the device tree.
 135          */
 136
 137         ofw_pcibus_enum_devtree(dev, domain, busno);
 138
 139         /*
 140          * We now attach any laggard devices. FDT, for instance, allows
 141          * the device tree to enumerate only some PCI devices. Apple's
 142          * OF device tree on some Grackle-based hardware can also miss
 143          * functions on multi-function cards.
 144          */
 145
 146         if (!ofw_devices_only)
 147                 ofw_pcibus_enum_bus(dev, domain, busno);
 148
 149         return (bus_generic_attach(dev));
 150 }
 151
 152 struct pci_devinfo *
 153 ofw_pcibus_alloc_devinfo(device_t dev)
 154 {
 155         struct ofw_pcibus_devinfo *dinfo;
 156
 157         dinfo = malloc(sizeof(*dinfo), M_DEVBUF, M_WAITOK | M_ZERO);
 158         return (&dinfo->opd_dinfo);
 159 }
 160
 161 static void
 162 ofw_pcibus_enum_devtree(device_t dev, u_int domain, u_int busno)
 163 {
 164         device_t pcib;
 165         struct ofw_pci_register pcir;
 166         struct ofw_pcibus_devinfo *dinfo;
 167         phandle_t node, child;
 168         u_int func, slot;
 169         int intline;
 170
 171         pcib = device_get_parent(dev);
 172         node = ofw_bus_get_node(dev);
 173
 174         for (child = OF_child(node); child != 0; child = OF_peer(child)) {
 175                 if (OF_getencprop(child, "reg", (pcell_t *)&pcir,
 176                     sizeof(pcir)) == -1)
 177                         continue;
 178                 slot = OFW_PCI_PHYS_HI_DEVICE(pcir.phys_hi);
 179                 func = OFW_PCI_PHYS_HI_FUNCTION(pcir.phys_hi);
 180
 181                 /* Some OFW device trees contain dupes. */
 182                 if (pci_find_dbsf(domain, busno, slot, func) != NULL)
 183                         continue;
 184
 185                 /*
 186                  * The preset in the intline register is usually bogus.  Reset
 187                  * it such that the PCI code will reroute the interrupt if
 188                  * needed.
 189                  */
 190
 191                 intline = PCI_INVALID_IRQ;
 192                 if (OF_getproplen(child, "interrupts") > 0)
 193                         intline = 0;
 194                 PCIB_WRITE_CONFIG(pcib, busno, slot, func, PCIR_INTLINE,
 195                     intline, 1);
 196
 197                 /*
 198                  * Now set up the PCI and OFW bus layer devinfo and add it
 199                  * to the PCI bus.
 200                  */
 201
 202                 dinfo = (struct ofw_pcibus_devinfo *)pci_read_device(pcib, dev,
 203                     domain, busno, slot, func);
 204                 if (dinfo == NULL)
 205                         continue;
 206                 if (ofw_bus_gen_setup_devinfo(&dinfo->opd_obdinfo, child) !=
 207                     0) {
 208                         pci_freecfg((struct pci_devinfo *)dinfo);
 209                         continue;
 210                 }
 211                 dinfo->opd_dma_tag = NULL;
 212                 pci_add_child(dev, (struct pci_devinfo *)dinfo);
 213
 214                 /*
 215                  * Some devices don't have an intpin set, but do have
 216                  * interrupts. These are fully specified, and set in the
 217                  * interrupts property, so add that value to the device's
 218                  * resource list.
 219                  */
 220                 if (dinfo->opd_dinfo.cfg.intpin == 0)
 221                         ofw_bus_intr_to_rl(dev, child,
 222                                 &dinfo->opd_dinfo.resources, NULL);
 223         }
 224 }
 225
 226 /*
 227  * The following is an almost exact clone of pci_add_children(), with the
 228  * addition that it (a) will not add children that have already been added,
 229  * and (b) will set up the OFW devinfo to point to invalid values. This is
 230  * to handle non-enumerated PCI children as exist in FDT and on the second
 231  * function of the Rage 128 in my Blue & White G3.
 232  */
 233
 234 static void
 235 ofw_pcibus_enum_bus(device_t dev, u_int domain, u_int busno)
 236 {
 237         device_t pcib;
 238         struct ofw_pcibus_devinfo *dinfo;
 239         int maxslots;
 240         int s, f, pcifunchigh;
 241         uint8_t hdrtype;
 242
 243         pcib = device_get_parent(dev);
 244
 245         maxslots = PCIB_MAXSLOTS(pcib);
 246         for (s = 0; s <= maxslots; s++) {
 247                 pcifunchigh = 0;
 248                 f = 0;
 249                 DELAY(1);
 250                 hdrtype = PCIB_READ_CONFIG(pcib, busno, s, f, PCIR_HDRTYPE, 1);
 251                 if ((hdrtype & PCIM_HDRTYPE) > PCI_MAXHDRTYPE)
 252                         continue;
 253                 if (hdrtype & PCIM_MFDEV)
 254                         pcifunchigh = PCI_FUNCMAX;
 255                 for (f = 0; f <= pcifunchigh; f++) {
 256                         /* Filter devices we have already added */
 257                         if (pci_find_dbsf(domain, busno, s, f) != NULL)
 258                                 continue;
 259
 260                         dinfo = (struct ofw_pcibus_devinfo *)pci_read_device(
 261                             pcib, dev, domain, busno, s, f);
 262                         if (dinfo == NULL)
 263                                 continue;
 264
 265                         dinfo->opd_dma_tag = NULL;
 266                         dinfo->opd_obdinfo.obd_node = -1;
 267
 268                         dinfo->opd_obdinfo.obd_name = NULL;
 269                         dinfo->opd_obdinfo.obd_compat = NULL;
 270                         dinfo->opd_obdinfo.obd_type = NULL;
 271                         dinfo->opd_obdinfo.obd_model = NULL;
 272
 273                         /*
 274                          * For non OFW-devices, don't believe 0
 275                          * for an interrupt.
 276                          */
 277                         if (dinfo->opd_dinfo.cfg.intline == 0) {
 278                                 dinfo->opd_dinfo.cfg.intline = PCI_INVALID_IRQ;
 279                                 PCIB_WRITE_CONFIG(pcib, busno, s, f,
 280                                     PCIR_INTLINE, PCI_INVALID_IRQ, 1);
 281                         }
 282
 283                         pci_add_child(dev, (struct pci_devinfo *)dinfo);
 284                 }
 285         }
 286 }
 287
 288 static void
 289 ofw_pcibus_child_deleted(device_t dev, device_t child)
 290 {
 291         struct ofw_pcibus_devinfo *dinfo;
 292
 293         dinfo = device_get_ivars(dev);
 294         ofw_bus_gen_destroy_devinfo(&dinfo->opd_obdinfo);
 295         pci_child_deleted(dev, child);
 296 }
 297
 298 static int
 299 ofw_pcibus_child_pnpinfo_str_method(device_t cbdev, device_t child, char *buf,
 300     size_t buflen)
 301 {
 302         pci_child_pnpinfo_str_method(cbdev, child, buf, buflen);
 303
 304         if (ofw_bus_get_node(child) != -1)  {
 305                 strlcat(buf, " ", buflen); /* Separate info */
 306                 ofw_bus_gen_child_pnpinfo_str(cbdev, child, buf, buflen);
 307         }
 308
 309         return (0);
 310 }
 311
 312 static int
 313 ofw_pcibus_assign_interrupt(device_t dev, device_t child)
 314 {
 315         ofw_pci_intr_t intr[2];
 316         phandle_t node, iparent;
 317         int isz, icells;
 318
 319         node = ofw_bus_get_node(child);
 320
 321         if (node == -1) {
 322                 /* Non-firmware enumerated child, use standard routing */
 323
 324                 intr[0] = pci_get_intpin(child);
 325                 return (PCIB_ROUTE_INTERRUPT(device_get_parent(dev), child,
 326                     intr[0]));
 327         }
 328
 329         /*
 330          * Try to determine the node's interrupt parent so we know which
 331          * PIC to use.
 332          */
 333
 334         iparent = -1;
 335         if (OF_getencprop(node, "interrupt-parent", &iparent,
 336             sizeof(iparent)) < 0)
 337                 iparent = -1;
 338         icells = 1;
 339         if (iparent != -1)
 340                 OF_getencprop(OF_node_from_xref(iparent), "#interrupt-cells",
 341                     &icells, sizeof(icells));
 342
 343         /*
 344          * Any AAPL,interrupts property gets priority and is
 345          * fully specified (i.e. does not need routing)
 346          */
 347
 348         isz = OF_getencprop(node, "AAPL,interrupts", intr, sizeof(intr));
 349         if (isz == sizeof(intr[0])*icells)
 350                 return ((iparent == -1) ? intr[0] : ofw_bus_map_intr(dev,
 351                     iparent, icells, intr));
 352
 353         isz = OF_getencprop(node, "interrupts", intr, sizeof(intr));
 354         if (isz == sizeof(intr[0])*icells) {
 355                 if (iparent != -1)
 356                         intr[0] = ofw_bus_map_intr(dev, iparent, icells, intr);
 357         } else {
 358                 /* No property: our best guess is the intpin. */
 359                 intr[0] = pci_get_intpin(child);
 360         }
 361
 362         /*
 363          * If we got intr from a property, it may or may not be an intpin.
 364          * For on-board devices, it frequently is not, and is completely out
 365          * of the valid intpin range.  For PCI slots, it hopefully is,
 366          * otherwise we will have trouble interfacing with non-OFW buses
 367          * such as cardbus.
 368          * Since we cannot tell which it is without violating layering, we
 369          * will always use the route_interrupt method, and treat exceptions
 370          * on the level they become apparent.
 371          */
 372         return (PCIB_ROUTE_INTERRUPT(device_get_parent(dev), child, intr[0]));
 373 }
 374
 375 static const struct ofw_bus_devinfo *
 376 ofw_pcibus_get_devinfo(device_t bus, device_t dev)
 377 {
 378         struct ofw_pcibus_devinfo *dinfo;
 379
 380         dinfo = device_get_ivars(dev);
 381         return (&dinfo->opd_obdinfo);
 382 }
 383