2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
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>
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice unmodified, this list of conditions, and the following
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.
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.
32 #include <sys/cdefs.h>
33 __FBSDID("$FreeBSD$");
35 #include <sys/param.h>
37 #include <sys/kernel.h>
38 #include <sys/libkern.h>
39 #include <sys/module.h>
40 #include <sys/pciio.h>
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>
47 #include <machine/bus.h>
48 #include <machine/intr_machdep.h>
49 #include <machine/resource.h>
51 #include <dev/pci/pcireg.h>
52 #include <dev/pci/pcivar.h>
53 #include <dev/pci/pci_private.h>
55 #include "ofw_pcibus.h"
59 typedef uint32_t ofw_pci_intr_t;
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);
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);
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),
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),
85 DEVMETHOD(pci_alloc_devinfo, ofw_pcibus_alloc_devinfo),
86 DEVMETHOD(pci_assign_interrupt, ofw_pcibus_assign_interrupt),
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),
99 static devclass_t pci_devclass;
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);
107 static int ofw_devices_only = 0;
108 TUNABLE_INT("hw.pci.ofw_devices_only", &ofw_devices_only);
111 ofw_pcibus_probe(device_t dev)
114 if (ofw_bus_get_node(dev) == -1)
116 device_set_desc(dev, "OFW PCI bus");
118 return (BUS_PROBE_DEFAULT);
122 ofw_pcibus_attach(device_t dev)
127 error = pci_attach_common(dev);
130 domain = pcib_get_domain(dev);
131 busno = pcib_get_bus(dev);
134 * Attach those children represented in the device tree.
137 ofw_pcibus_enum_devtree(dev, domain, busno);
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.
146 if (!ofw_devices_only)
147 ofw_pcibus_enum_bus(dev, domain, busno);
149 return (bus_generic_attach(dev));
153 ofw_pcibus_alloc_devinfo(device_t dev)
155 struct ofw_pcibus_devinfo *dinfo;
157 dinfo = malloc(sizeof(*dinfo), M_DEVBUF, M_WAITOK | M_ZERO);
158 return (&dinfo->opd_dinfo);
162 ofw_pcibus_enum_devtree(device_t dev, u_int domain, u_int busno)
165 struct ofw_pci_register pcir;
166 struct ofw_pcibus_devinfo *dinfo;
167 phandle_t node, child;
171 pcib = device_get_parent(dev);
172 node = ofw_bus_get_node(dev);
174 for (child = OF_child(node); child != 0; child = OF_peer(child)) {
175 if (OF_getencprop(child, "reg", (pcell_t *)&pcir,
178 slot = OFW_PCI_PHYS_HI_DEVICE(pcir.phys_hi);
179 func = OFW_PCI_PHYS_HI_FUNCTION(pcir.phys_hi);
181 /* Some OFW device trees contain dupes. */
182 if (pci_find_dbsf(domain, busno, slot, func) != NULL)
186 * The preset in the intline register is usually bogus. Reset
187 * it such that the PCI code will reroute the interrupt if
191 intline = PCI_INVALID_IRQ;
192 if (OF_getproplen(child, "interrupts") > 0)
194 PCIB_WRITE_CONFIG(pcib, busno, slot, func, PCIR_INTLINE,
198 * Now set up the PCI and OFW bus layer devinfo and add it
202 dinfo = (struct ofw_pcibus_devinfo *)pci_read_device(pcib, dev,
203 domain, busno, slot, func);
206 if (ofw_bus_gen_setup_devinfo(&dinfo->opd_obdinfo, child) !=
208 pci_freecfg((struct pci_devinfo *)dinfo);
211 dinfo->opd_dma_tag = NULL;
212 pci_add_child(dev, (struct pci_devinfo *)dinfo);
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
220 if (dinfo->opd_dinfo.cfg.intpin == 0)
221 ofw_bus_intr_to_rl(dev, child,
222 &dinfo->opd_dinfo.resources, NULL);
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.
235 ofw_pcibus_enum_bus(device_t dev, u_int domain, u_int busno)
238 struct ofw_pcibus_devinfo *dinfo;
240 int s, f, pcifunchigh;
243 pcib = device_get_parent(dev);
245 maxslots = PCIB_MAXSLOTS(pcib);
246 for (s = 0; s <= maxslots; s++) {
250 hdrtype = PCIB_READ_CONFIG(pcib, busno, s, f, PCIR_HDRTYPE, 1);
251 if ((hdrtype & PCIM_HDRTYPE) > PCI_MAXHDRTYPE)
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)
260 dinfo = (struct ofw_pcibus_devinfo *)pci_read_device(
261 pcib, dev, domain, busno, s, f);
265 dinfo->opd_dma_tag = NULL;
266 dinfo->opd_obdinfo.obd_node = -1;
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;
274 * For non OFW-devices, don't believe 0
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);
283 pci_add_child(dev, (struct pci_devinfo *)dinfo);
289 ofw_pcibus_child_deleted(device_t dev, device_t child)
291 struct ofw_pcibus_devinfo *dinfo;
293 dinfo = device_get_ivars(dev);
294 ofw_bus_gen_destroy_devinfo(&dinfo->opd_obdinfo);
295 pci_child_deleted(dev, child);
299 ofw_pcibus_child_pnpinfo_str_method(device_t cbdev, device_t child, char *buf,
302 pci_child_pnpinfo_str_method(cbdev, child, buf, buflen);
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);
313 ofw_pcibus_assign_interrupt(device_t dev, device_t child)
315 ofw_pci_intr_t intr[2];
316 phandle_t node, iparent;
319 node = ofw_bus_get_node(child);
322 /* Non-firmware enumerated child, use standard routing */
324 intr[0] = pci_get_intpin(child);
325 return (PCIB_ROUTE_INTERRUPT(device_get_parent(dev), child,
330 * Try to determine the node's interrupt parent so we know which
335 if (OF_getencprop(node, "interrupt-parent", &iparent,
336 sizeof(iparent)) < 0)
340 OF_getencprop(OF_node_from_xref(iparent), "#interrupt-cells",
341 &icells, sizeof(icells));
344 * Any AAPL,interrupts property gets priority and is
345 * fully specified (i.e. does not need routing)
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));
353 isz = OF_getencprop(node, "interrupts", intr, sizeof(intr));
354 if (isz == sizeof(intr[0])*icells) {
356 intr[0] = ofw_bus_map_intr(dev, iparent, icells, intr);
358 /* No property: our best guess is the intpin. */
359 intr[0] = pci_get_intpin(child);
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
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.
372 return (PCIB_ROUTE_INTERRUPT(device_get_parent(dev), child, intr[0]));
375 static const struct ofw_bus_devinfo *
376 ofw_pcibus_get_devinfo(device_t bus, device_t dev)
378 struct ofw_pcibus_devinfo *dinfo;
380 dinfo = device_get_ivars(dev);
381 return (&dinfo->opd_obdinfo);