2 * Copyright (c) 2000 Michael Smith
3 * Copyright (c) 2000 BSDi
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 #include <sys/cdefs.h>
29 __FBSDID("$FreeBSD$");
32 #include <sys/param.h>
34 #include <sys/kernel.h>
35 #include <sys/limits.h>
36 #include <sys/malloc.h>
37 #include <sys/module.h>
39 #include <sys/sysctl.h>
41 #include <contrib/dev/acpica/include/acpi.h>
42 #include <contrib/dev/acpica/include/accommon.h>
44 #include <dev/acpica/acpivar.h>
46 #include <machine/pci_cfgreg.h>
47 #include <dev/pci/pcivar.h>
48 #include <dev/pci/pcib_private.h>
51 #include <dev/acpica/acpi_pcibvar.h>
53 /* Hooks for the ACPI CA debugging infrastructure. */
54 #define _COMPONENT ACPI_BUS
55 ACPI_MODULE_NAME("PCI_ACPI")
57 struct acpi_hpcib_softc {
59 ACPI_HANDLE ap_handle;
62 int ap_segment; /* PCI domain */
63 int ap_bus; /* bios-assigned bus number */
64 int ap_addr; /* device/func of PCI-Host bridge */
66 ACPI_BUFFER ap_prt; /* interrupt routing table */
68 struct pcib_host_resources ap_host_res;
72 static int acpi_pcib_acpi_probe(device_t bus);
73 static int acpi_pcib_acpi_attach(device_t bus);
74 static int acpi_pcib_read_ivar(device_t dev, device_t child,
75 int which, uintptr_t *result);
76 static int acpi_pcib_write_ivar(device_t dev, device_t child,
77 int which, uintptr_t value);
78 static uint32_t acpi_pcib_read_config(device_t dev, u_int bus,
79 u_int slot, u_int func, u_int reg, int bytes);
80 static void acpi_pcib_write_config(device_t dev, u_int bus,
81 u_int slot, u_int func, u_int reg, uint32_t data,
83 static int acpi_pcib_acpi_route_interrupt(device_t pcib,
84 device_t dev, int pin);
85 static int acpi_pcib_alloc_msi(device_t pcib, device_t dev,
86 int count, int maxcount, int *irqs);
87 static int acpi_pcib_map_msi(device_t pcib, device_t dev,
88 int irq, uint64_t *addr, uint32_t *data);
89 static int acpi_pcib_alloc_msix(device_t pcib, device_t dev,
91 static struct resource *acpi_pcib_acpi_alloc_resource(device_t dev,
92 device_t child, int type, int *rid,
93 u_long start, u_long end, u_long count,
96 static int acpi_pcib_acpi_adjust_resource(device_t dev,
97 device_t child, int type, struct resource *r,
98 u_long start, u_long end);
101 static device_method_t acpi_pcib_acpi_methods[] = {
102 /* Device interface */
103 DEVMETHOD(device_probe, acpi_pcib_acpi_probe),
104 DEVMETHOD(device_attach, acpi_pcib_acpi_attach),
105 DEVMETHOD(device_shutdown, bus_generic_shutdown),
106 DEVMETHOD(device_suspend, bus_generic_suspend),
107 DEVMETHOD(device_resume, bus_generic_resume),
110 DEVMETHOD(bus_read_ivar, acpi_pcib_read_ivar),
111 DEVMETHOD(bus_write_ivar, acpi_pcib_write_ivar),
112 DEVMETHOD(bus_alloc_resource, acpi_pcib_acpi_alloc_resource),
114 DEVMETHOD(bus_adjust_resource, acpi_pcib_acpi_adjust_resource),
116 DEVMETHOD(bus_adjust_resource, bus_generic_adjust_resource),
118 DEVMETHOD(bus_release_resource, bus_generic_release_resource),
119 DEVMETHOD(bus_activate_resource, bus_generic_activate_resource),
120 DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource),
121 DEVMETHOD(bus_setup_intr, bus_generic_setup_intr),
122 DEVMETHOD(bus_teardown_intr, bus_generic_teardown_intr),
125 DEVMETHOD(pcib_maxslots, pcib_maxslots),
126 DEVMETHOD(pcib_read_config, acpi_pcib_read_config),
127 DEVMETHOD(pcib_write_config, acpi_pcib_write_config),
128 DEVMETHOD(pcib_route_interrupt, acpi_pcib_acpi_route_interrupt),
129 DEVMETHOD(pcib_alloc_msi, acpi_pcib_alloc_msi),
130 DEVMETHOD(pcib_release_msi, pcib_release_msi),
131 DEVMETHOD(pcib_alloc_msix, acpi_pcib_alloc_msix),
132 DEVMETHOD(pcib_release_msix, pcib_release_msix),
133 DEVMETHOD(pcib_map_msi, acpi_pcib_map_msi),
134 DEVMETHOD(pcib_power_for_sleep, acpi_pcib_power_for_sleep),
139 static devclass_t pcib_devclass;
141 DEFINE_CLASS_0(pcib, acpi_pcib_acpi_driver, acpi_pcib_acpi_methods,
142 sizeof(struct acpi_hpcib_softc));
143 DRIVER_MODULE(acpi_pcib, acpi, acpi_pcib_acpi_driver, pcib_devclass, 0, 0);
144 MODULE_DEPEND(acpi_pcib, acpi, 1, 1, 1);
147 acpi_pcib_acpi_probe(device_t dev)
149 ACPI_DEVICE_INFO *devinfo;
153 if (acpi_disabled("pcib") || (h = acpi_get_handle(dev)) == NULL ||
154 ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo)))
156 root = (devinfo->Flags & ACPI_PCI_ROOT_BRIDGE) != 0;
158 if (!root || pci_cfgregopen() == 0)
161 device_set_desc(dev, "ACPI Host-PCI bridge");
167 acpi_pcib_producer_handler(ACPI_RESOURCE *res, void *context)
169 struct acpi_hpcib_softc *sc;
170 UINT64 length, min, max;
176 case ACPI_RESOURCE_TYPE_START_DEPENDENT:
177 case ACPI_RESOURCE_TYPE_END_DEPENDENT:
178 panic("host bridge has depenedent resources");
179 case ACPI_RESOURCE_TYPE_ADDRESS16:
180 case ACPI_RESOURCE_TYPE_ADDRESS32:
181 case ACPI_RESOURCE_TYPE_ADDRESS64:
182 case ACPI_RESOURCE_TYPE_EXTENDED_ADDRESS64:
183 if (res->Data.Address.ProducerConsumer != ACPI_PRODUCER)
186 case ACPI_RESOURCE_TYPE_ADDRESS16:
187 min = res->Data.Address16.Minimum;
188 max = res->Data.Address16.Maximum;
189 length = res->Data.Address16.AddressLength;
191 case ACPI_RESOURCE_TYPE_ADDRESS32:
192 min = res->Data.Address32.Minimum;
193 max = res->Data.Address32.Maximum;
194 length = res->Data.Address32.AddressLength;
196 case ACPI_RESOURCE_TYPE_ADDRESS64:
197 min = res->Data.Address64.Minimum;
198 max = res->Data.Address64.Maximum;
199 length = res->Data.Address64.AddressLength;
203 ACPI_RESOURCE_TYPE_EXTENDED_ADDRESS64,
204 ("should never happen"));
205 min = res->Data.ExtAddress64.Minimum;
206 max = res->Data.ExtAddress64.Maximum;
207 length = res->Data.ExtAddress64.AddressLength;
212 if (min + length - 1 != max &&
213 (res->Data.Address.MinAddressFixed != ACPI_ADDRESS_FIXED ||
214 res->Data.Address.MaxAddressFixed != ACPI_ADDRESS_FIXED))
217 switch (res->Data.Address.ResourceType) {
218 case ACPI_MEMORY_RANGE:
219 type = SYS_RES_MEMORY;
220 if (res->Type != ACPI_RESOURCE_TYPE_EXTENDED_ADDRESS64) {
221 if (res->Data.Address.Info.Mem.Caching ==
222 ACPI_PREFETCHABLE_MEMORY)
223 flags |= RF_PREFETCHABLE;
226 * XXX: Parse prefetch flag out of
232 type = SYS_RES_IOPORT;
235 case ACPI_BUS_NUMBER_RANGE:
243 if (min + length - 1 != max)
244 device_printf(sc->ap_dev,
245 "Length mismatch for %d range: %jx vs %jx\n", type,
246 (uintmax_t)max - min + 1, (uintmax_t)length);
248 if (min > ULONG_MAX) {
249 device_printf(sc->ap_dev,
250 "Ignoring %d range above 4GB (%#jx-%#jx)\n",
251 type, (uintmax_t)min, (uintmax_t)max);
254 if (max > ULONG_MAX) {
255 device_printf(sc->ap_dev,
256 "Truncating end of %d range above 4GB (%#jx-%#jx)\n",
257 type, (uintmax_t)min, (uintmax_t)max);
261 error = pcib_host_res_decodes(&sc->ap_host_res, type, min, max,
264 panic("Failed to manage %d range (%#jx-%#jx): %d",
265 type, (uintmax_t)min, (uintmax_t)max, error);
275 acpi_pcib_acpi_attach(device_t dev)
277 struct acpi_hpcib_softc *sc;
279 static int bus0_seen = 0;
280 u_int slot, func, busok;
283 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
285 sc = device_get_softc(dev);
287 sc->ap_handle = acpi_get_handle(dev);
290 * Don't attach if we're not really there.
292 if (!acpi_DeviceIsPresent(dev))
296 * Get our segment number by evaluating _SEG.
297 * It's OK for this to not exist.
299 status = acpi_GetInteger(sc->ap_handle, "_SEG", &sc->ap_segment);
300 if (ACPI_FAILURE(status)) {
301 if (status != AE_NOT_FOUND) {
302 device_printf(dev, "could not evaluate _SEG - %s\n",
303 AcpiFormatException(status));
304 return_VALUE (ENXIO);
306 /* If it's not found, assume 0. */
311 * Get the address (device and function) of the associated
312 * PCI-Host bridge device from _ADR. Assume we don't have one if
315 status = acpi_GetInteger(sc->ap_handle, "_ADR", &sc->ap_addr);
316 if (ACPI_FAILURE(status)) {
317 device_printf(dev, "could not evaluate _ADR - %s\n",
318 AcpiFormatException(status));
324 * Determine which address ranges this bridge decodes and setup
325 * resource managers for those ranges.
327 if (pcib_host_res_init(sc->ap_dev, &sc->ap_host_res) != 0)
328 panic("failed to init hostb resources");
329 if (!acpi_disabled("hostres")) {
330 status = AcpiWalkResources(sc->ap_handle, "_CRS",
331 acpi_pcib_producer_handler, sc);
332 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND)
333 device_printf(sc->ap_dev, "failed to parse resources: %s\n",
334 AcpiFormatException(status));
339 * Get our base bus number by evaluating _BBN.
340 * If this doesn't work, we assume we're bus number 0.
342 * XXX note that it may also not exist in the case where we are
343 * meant to use a private configuration space mechanism for this bus,
344 * so we should dig out our resources and check to see if we have
345 * anything like that. How do we do this?
346 * XXX If we have the requisite information, and if we don't think the
347 * default PCI configuration space handlers can deal with this bus,
348 * we should attach our own handler.
349 * XXX invoke _REG on this for the PCI config space address space?
350 * XXX It seems many BIOS's with multiple Host-PCI bridges do not set
351 * _BBN correctly. They set _BBN to zero for all bridges. Thus,
352 * if _BBN is zero and PCI bus 0 already exists, we try to read our
353 * bus number from the configuration registers at address _ADR.
354 * We only do this for domain/segment 0 in the hopes that this is
355 * only needed for old single-domain machines.
357 status = acpi_GetInteger(sc->ap_handle, "_BBN", &sc->ap_bus);
358 if (ACPI_FAILURE(status)) {
359 if (status != AE_NOT_FOUND) {
360 device_printf(dev, "could not evaluate _BBN - %s\n",
361 AcpiFormatException(status));
364 /* If it's not found, assume 0. */
370 * If this is segment 0, the bus is zero, and PCI bus 0 already
371 * exists, read the bus number via PCI config space.
374 if (sc->ap_segment == 0 && sc->ap_bus == 0 && bus0_seen) {
376 if (sc->ap_addr != -1) {
377 /* XXX: We assume bus 0. */
378 slot = ACPI_ADR_PCI_SLOT(sc->ap_addr);
379 func = ACPI_ADR_PCI_FUNC(sc->ap_addr);
381 device_printf(dev, "reading config registers from 0:%d:%d\n",
383 if (host_pcib_get_busno(pci_cfgregread, 0, slot, func, &busno) == 0)
384 device_printf(dev, "couldn't read bus number from cfg space\n");
393 * If nothing else worked, hope that ACPI at least lays out the
394 * host-PCI bridges in order and that as a result our unit number
395 * is actually our bus number. There are several reasons this
399 sc->ap_bus = device_get_unit(dev);
400 device_printf(dev, "trying bus number %d\n", sc->ap_bus);
403 /* If this is bus 0 on segment 0, note that it has been seen already. */
404 if (sc->ap_segment == 0 && sc->ap_bus == 0)
407 return (acpi_pcib_attach(dev, &sc->ap_prt, sc->ap_bus));
411 * Support for standard PCI bridge ivars.
414 acpi_pcib_read_ivar(device_t dev, device_t child, int which, uintptr_t *result)
416 struct acpi_hpcib_softc *sc = device_get_softc(dev);
419 case PCIB_IVAR_DOMAIN:
420 *result = sc->ap_segment;
423 *result = sc->ap_bus;
425 case ACPI_IVAR_HANDLE:
426 *result = (uintptr_t)sc->ap_handle;
428 case ACPI_IVAR_FLAGS:
429 *result = (uintptr_t)sc->ap_flags;
436 acpi_pcib_write_ivar(device_t dev, device_t child, int which, uintptr_t value)
438 struct acpi_hpcib_softc *sc = device_get_softc(dev);
441 case PCIB_IVAR_DOMAIN:
446 case ACPI_IVAR_HANDLE:
447 sc->ap_handle = (ACPI_HANDLE)value;
449 case ACPI_IVAR_FLAGS:
450 sc->ap_flags = (int)value;
457 acpi_pcib_read_config(device_t dev, u_int bus, u_int slot, u_int func,
458 u_int reg, int bytes)
460 return (pci_cfgregread(bus, slot, func, reg, bytes));
464 acpi_pcib_write_config(device_t dev, u_int bus, u_int slot, u_int func,
465 u_int reg, uint32_t data, int bytes)
467 pci_cfgregwrite(bus, slot, func, reg, data, bytes);
471 acpi_pcib_acpi_route_interrupt(device_t pcib, device_t dev, int pin)
473 struct acpi_hpcib_softc *sc = device_get_softc(pcib);
475 return (acpi_pcib_route_interrupt(pcib, dev, pin, &sc->ap_prt));
479 acpi_pcib_alloc_msi(device_t pcib, device_t dev, int count, int maxcount,
484 bus = device_get_parent(pcib);
485 return (PCIB_ALLOC_MSI(device_get_parent(bus), dev, count, maxcount,
490 acpi_pcib_alloc_msix(device_t pcib, device_t dev, int *irq)
494 bus = device_get_parent(pcib);
495 return (PCIB_ALLOC_MSIX(device_get_parent(bus), dev, irq));
499 acpi_pcib_map_msi(device_t pcib, device_t dev, int irq, uint64_t *addr,
502 struct acpi_hpcib_softc *sc;
506 bus = device_get_parent(pcib);
507 error = PCIB_MAP_MSI(device_get_parent(bus), dev, irq, addr, data);
511 sc = device_get_softc(dev);
512 if (sc->ap_addr == -1)
514 /* XXX: Assumes all bridges are on bus 0. */
515 hostb = pci_find_dbsf(sc->ap_segment, 0, ACPI_ADR_PCI_SLOT(sc->ap_addr),
516 ACPI_ADR_PCI_FUNC(sc->ap_addr));
518 pci_ht_map_msi(hostb, *addr);
523 acpi_pcib_acpi_alloc_resource(device_t dev, device_t child, int type, int *rid,
524 u_long start, u_long end, u_long count, u_int flags)
527 struct acpi_hpcib_softc *sc;
528 struct resource *res;
531 #if defined(__i386__) || defined(__amd64__)
532 start = hostb_alloc_start(type, start, end, count);
536 sc = device_get_softc(dev);
537 res = pcib_host_res_alloc(&sc->ap_host_res, child, type, rid, start, end,
541 * XXX: If this is a request for a specific range, assume it is
542 * correct and pass it up to the parent. What we probably want to
543 * do long-term is explicitly trust any firmware-configured
544 * resources during the initial bus scan on boot and then disable
547 if (res == NULL && start + count - 1 == end)
548 res = bus_generic_alloc_resource(dev, child, type, rid, start, end,
552 return (bus_generic_alloc_resource(dev, child, type, rid, start, end,
559 acpi_pcib_acpi_adjust_resource(device_t dev, device_t child, int type,
560 struct resource *r, u_long start, u_long end)
562 struct acpi_hpcib_softc *sc;
564 sc = device_get_softc(dev);
565 return (pcib_host_res_adjust(&sc->ap_host_res, child, type, r, start,