1098ca2bdSWarner Losh /*- 228bf1fadSJohn Baldwin * Copyright (c) 1997, Stefan Esser <se@freebsd.org> 328bf1fadSJohn Baldwin * Copyright (c) 2000, Michael Smith <msmith@freebsd.org> 428bf1fadSJohn Baldwin * Copyright (c) 2000, BSDi 528bf1fadSJohn Baldwin * All rights reserved. 628bf1fadSJohn Baldwin * 728bf1fadSJohn Baldwin * Redistribution and use in source and binary forms, with or without 828bf1fadSJohn Baldwin * modification, are permitted provided that the following conditions 928bf1fadSJohn Baldwin * are met: 1028bf1fadSJohn Baldwin * 1. Redistributions of source code must retain the above copyright 1128bf1fadSJohn Baldwin * notice unmodified, this list of conditions, and the following 1228bf1fadSJohn Baldwin * disclaimer. 1328bf1fadSJohn Baldwin * 2. Redistributions in binary form must reproduce the above copyright 1428bf1fadSJohn Baldwin * notice, this list of conditions and the following disclaimer in the 1528bf1fadSJohn Baldwin * documentation and/or other materials provided with the distribution. 1628bf1fadSJohn Baldwin * 1728bf1fadSJohn Baldwin * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 1828bf1fadSJohn Baldwin * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 1928bf1fadSJohn Baldwin * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 2028bf1fadSJohn Baldwin * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 2128bf1fadSJohn Baldwin * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 2228bf1fadSJohn Baldwin * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 2328bf1fadSJohn Baldwin * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 2428bf1fadSJohn Baldwin * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 2528bf1fadSJohn Baldwin * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 2628bf1fadSJohn Baldwin * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 2728bf1fadSJohn Baldwin */ 2828bf1fadSJohn Baldwin 29aad970f1SDavid E. O'Brien #include <sys/cdefs.h> 30aad970f1SDavid E. O'Brien __FBSDID("$FreeBSD$"); 31aad970f1SDavid E. O'Brien 3228bf1fadSJohn Baldwin #include <sys/param.h> 3328bf1fadSJohn Baldwin #include <sys/systm.h> 3428bf1fadSJohn Baldwin #include <sys/bus.h> 3528bf1fadSJohn Baldwin #include <sys/kernel.h> 3628bf1fadSJohn Baldwin #include <sys/malloc.h> 3728bf1fadSJohn Baldwin #include <sys/module.h> 3828bf1fadSJohn Baldwin 39129d3046SJung-uk Kim #include <contrib/dev/acpica/include/acpi.h> 40129d3046SJung-uk Kim #include <contrib/dev/acpica/include/accommon.h> 41129d3046SJung-uk Kim 4228bf1fadSJohn Baldwin #include <dev/acpica/acpivar.h> 4328bf1fadSJohn Baldwin 4428bf1fadSJohn Baldwin #include <sys/pciio.h> 4528bf1fadSJohn Baldwin #include <dev/pci/pcireg.h> 4628bf1fadSJohn Baldwin #include <dev/pci/pcivar.h> 4728bf1fadSJohn Baldwin #include <dev/pci/pci_private.h> 4828bf1fadSJohn Baldwin 4928bf1fadSJohn Baldwin #include "pcib_if.h" 5028bf1fadSJohn Baldwin #include "pci_if.h" 5128bf1fadSJohn Baldwin 525acd0218SNate Lawson /* Hooks for the ACPI CA debugging infrastructure. */ 5328bf1fadSJohn Baldwin #define _COMPONENT ACPI_BUS 5428bf1fadSJohn Baldwin ACPI_MODULE_NAME("PCI") 5528bf1fadSJohn Baldwin 5628bf1fadSJohn Baldwin struct acpi_pci_devinfo { 5728bf1fadSJohn Baldwin struct pci_devinfo ap_dinfo; 5828bf1fadSJohn Baldwin ACPI_HANDLE ap_handle; 59d4b9ff91SNate Lawson int ap_flags; 6028bf1fadSJohn Baldwin }; 6128bf1fadSJohn Baldwin 62f4e6d08dSNate Lawson ACPI_SERIAL_DECL(pci_powerstate, "ACPI PCI power methods"); 63f4e6d08dSNate Lawson 64a811035eSNate Lawson /* Be sure that ACPI and PCI power states are equivalent. */ 65a811035eSNate Lawson CTASSERT(ACPI_STATE_D0 == PCI_POWERSTATE_D0); 66a811035eSNate Lawson CTASSERT(ACPI_STATE_D1 == PCI_POWERSTATE_D1); 67a811035eSNate Lawson CTASSERT(ACPI_STATE_D2 == PCI_POWERSTATE_D2); 68a811035eSNate Lawson CTASSERT(ACPI_STATE_D3 == PCI_POWERSTATE_D3); 69a811035eSNate Lawson 7028bf1fadSJohn Baldwin static int acpi_pci_attach(device_t dev); 71cd284d7aSTakanori Watanabe static int acpi_pci_child_location_str_method(device_t cbdev, 72cd284d7aSTakanori Watanabe device_t child, char *buf, size_t buflen); 7381bb99d2SJohn Baldwin static int acpi_pci_probe(device_t dev); 7481bb99d2SJohn Baldwin static int acpi_pci_read_ivar(device_t dev, device_t child, int which, 7581bb99d2SJohn Baldwin uintptr_t *result); 76d4b9ff91SNate Lawson static int acpi_pci_write_ivar(device_t dev, device_t child, int which, 77d4b9ff91SNate Lawson uintptr_t value); 7828bf1fadSJohn Baldwin static ACPI_STATUS acpi_pci_save_handle(ACPI_HANDLE handle, UINT32 level, 7928bf1fadSJohn Baldwin void *context, void **status); 8081bb99d2SJohn Baldwin static int acpi_pci_set_powerstate_method(device_t dev, device_t child, 8181bb99d2SJohn Baldwin int state); 8281bb99d2SJohn Baldwin static void acpi_pci_update_device(ACPI_HANDLE handle, device_t pci_child); 8328bf1fadSJohn Baldwin 8428bf1fadSJohn Baldwin static device_method_t acpi_pci_methods[] = { 8528bf1fadSJohn Baldwin /* Device interface */ 8628bf1fadSJohn Baldwin DEVMETHOD(device_probe, acpi_pci_probe), 8728bf1fadSJohn Baldwin DEVMETHOD(device_attach, acpi_pci_attach), 8828bf1fadSJohn Baldwin 8928bf1fadSJohn Baldwin /* Bus interface */ 9028bf1fadSJohn Baldwin DEVMETHOD(bus_read_ivar, acpi_pci_read_ivar), 91d4b9ff91SNate Lawson DEVMETHOD(bus_write_ivar, acpi_pci_write_ivar), 92cd284d7aSTakanori Watanabe DEVMETHOD(bus_child_location_str, acpi_pci_child_location_str_method), 9328bf1fadSJohn Baldwin 9428bf1fadSJohn Baldwin /* PCI interface */ 955233e9ffSJohn Baldwin DEVMETHOD(pci_set_powerstate, acpi_pci_set_powerstate_method), 9628bf1fadSJohn Baldwin 9728bf1fadSJohn Baldwin { 0, 0 } 9828bf1fadSJohn Baldwin }; 9928bf1fadSJohn Baldwin 10014450110SJohn Baldwin static devclass_t pci_devclass; 10128bf1fadSJohn Baldwin 102*1b1596a3SJohn Baldwin DEFINE_CLASS_1(pci, acpi_pci_driver, acpi_pci_methods, sizeof(struct pci_softc), 103*1b1596a3SJohn Baldwin pci_driver); 10428bf1fadSJohn Baldwin DRIVER_MODULE(acpi_pci, pcib, acpi_pci_driver, pci_devclass, 0, 0); 10564278df5SNate Lawson MODULE_DEPEND(acpi_pci, acpi, 1, 1, 1); 10628bf1fadSJohn Baldwin MODULE_DEPEND(acpi_pci, pci, 1, 1, 1); 10764278df5SNate Lawson MODULE_VERSION(acpi_pci, 1); 10828bf1fadSJohn Baldwin 10928bf1fadSJohn Baldwin static int 11028bf1fadSJohn Baldwin acpi_pci_read_ivar(device_t dev, device_t child, int which, uintptr_t *result) 11128bf1fadSJohn Baldwin { 11228bf1fadSJohn Baldwin struct acpi_pci_devinfo *dinfo; 11328bf1fadSJohn Baldwin 114d4b9ff91SNate Lawson dinfo = device_get_ivars(child); 11528bf1fadSJohn Baldwin switch (which) { 11628bf1fadSJohn Baldwin case ACPI_IVAR_HANDLE: 11728bf1fadSJohn Baldwin *result = (uintptr_t)dinfo->ap_handle; 11828bf1fadSJohn Baldwin return (0); 119d4b9ff91SNate Lawson case ACPI_IVAR_FLAGS: 120d4b9ff91SNate Lawson *result = (uintptr_t)dinfo->ap_flags; 121d4b9ff91SNate Lawson return (0); 12228bf1fadSJohn Baldwin } 12328bf1fadSJohn Baldwin return (pci_read_ivar(dev, child, which, result)); 12428bf1fadSJohn Baldwin } 12528bf1fadSJohn Baldwin 126cd284d7aSTakanori Watanabe static int 127d4b9ff91SNate Lawson acpi_pci_write_ivar(device_t dev, device_t child, int which, uintptr_t value) 128d4b9ff91SNate Lawson { 129d4b9ff91SNate Lawson struct acpi_pci_devinfo *dinfo; 130d4b9ff91SNate Lawson 131d4b9ff91SNate Lawson dinfo = device_get_ivars(child); 132d4b9ff91SNate Lawson switch (which) { 133d4b9ff91SNate Lawson case ACPI_IVAR_HANDLE: 134d4b9ff91SNate Lawson dinfo->ap_handle = (ACPI_HANDLE)value; 135d4b9ff91SNate Lawson return (0); 136d4b9ff91SNate Lawson case ACPI_IVAR_FLAGS: 137d4b9ff91SNate Lawson dinfo->ap_flags = (int)value; 138d4b9ff91SNate Lawson return (0); 139d4b9ff91SNate Lawson } 140d4b9ff91SNate Lawson return (pci_write_ivar(dev, child, which, value)); 141d4b9ff91SNate Lawson } 142d4b9ff91SNate Lawson 143d4b9ff91SNate Lawson static int 144cd284d7aSTakanori Watanabe acpi_pci_child_location_str_method(device_t cbdev, device_t child, char *buf, 145cd284d7aSTakanori Watanabe size_t buflen) 146cd284d7aSTakanori Watanabe { 147cd284d7aSTakanori Watanabe struct acpi_pci_devinfo *dinfo = device_get_ivars(child); 14863600cc3SNate Lawson 149cd284d7aSTakanori Watanabe pci_child_location_str_method(cbdev, child, buf, buflen); 150cd284d7aSTakanori Watanabe 151cd284d7aSTakanori Watanabe if (dinfo->ap_handle) { 1528c4c207dSTakanori Watanabe strlcat(buf, " handle=", buflen); 153cd284d7aSTakanori Watanabe strlcat(buf, acpi_name(dinfo->ap_handle), buflen); 154cd284d7aSTakanori Watanabe } 155cd284d7aSTakanori Watanabe return (0); 156cd284d7aSTakanori Watanabe } 157cd284d7aSTakanori Watanabe 15828bf1fadSJohn Baldwin /* 15928bf1fadSJohn Baldwin * PCI power manangement 16028bf1fadSJohn Baldwin */ 16128bf1fadSJohn Baldwin static int 16228bf1fadSJohn Baldwin acpi_pci_set_powerstate_method(device_t dev, device_t child, int state) 16328bf1fadSJohn Baldwin { 164916dc0e2SNate Lawson ACPI_HANDLE h; 1655233e9ffSJohn Baldwin ACPI_STATUS status; 166a811035eSNate Lawson int old_state, error; 1675233e9ffSJohn Baldwin 168f4e6d08dSNate Lawson error = 0; 169a811035eSNate Lawson if (state < ACPI_STATE_D0 || state > ACPI_STATE_D3) 1705233e9ffSJohn Baldwin return (EINVAL); 17128bf1fadSJohn Baldwin 1725233e9ffSJohn Baldwin /* 1735233e9ffSJohn Baldwin * We set the state using PCI Power Management outside of setting 1745233e9ffSJohn Baldwin * the ACPI state. This means that when powering down a device, we 1755233e9ffSJohn Baldwin * first shut it down using PCI, and then using ACPI, which lets ACPI 1765233e9ffSJohn Baldwin * try to power down any Power Resources that are now no longer used. 1775233e9ffSJohn Baldwin * When powering up a device, we let ACPI set the state first so that 1785233e9ffSJohn Baldwin * it can enable any needed Power Resources before changing the PCI 1795233e9ffSJohn Baldwin * power state. 1805233e9ffSJohn Baldwin */ 181f4e6d08dSNate Lawson ACPI_SERIAL_BEGIN(pci_powerstate); 1825233e9ffSJohn Baldwin old_state = pci_get_powerstate(child); 183f3e0b109SJung-uk Kim if (old_state < state && pci_do_power_suspend) { 1845233e9ffSJohn Baldwin error = pci_set_powerstate_method(dev, child, state); 1855233e9ffSJohn Baldwin if (error) 186f4e6d08dSNate Lawson goto out; 18728bf1fadSJohn Baldwin } 1881f36889fSNate Lawson h = acpi_get_handle(child); 189a811035eSNate Lawson status = acpi_pwr_switch_consumer(h, state); 190a7a3177fSJung-uk Kim if (ACPI_SUCCESS(status)) { 191a7a3177fSJung-uk Kim if (bootverbose) 192a7a3177fSJung-uk Kim device_printf(dev, "set ACPI power state D%d on %s\n", 193a7a3177fSJung-uk Kim state, acpi_name(h)); 194a7a3177fSJung-uk Kim } else if (status != AE_NOT_FOUND) 1955233e9ffSJohn Baldwin device_printf(dev, 196a7a3177fSJung-uk Kim "failed to set ACPI power state D%d on %s: %s\n", 197a811035eSNate Lawson state, acpi_name(h), AcpiFormatException(status)); 198edc0cb7dSJung-uk Kim if (old_state > state && pci_do_power_resume) 199f4e6d08dSNate Lawson error = pci_set_powerstate_method(dev, child, state); 200f4e6d08dSNate Lawson 201f4e6d08dSNate Lawson out: 202f4e6d08dSNate Lawson ACPI_SERIAL_END(pci_powerstate); 203f4e6d08dSNate Lawson return (error); 2045233e9ffSJohn Baldwin } 20528bf1fadSJohn Baldwin 20681bb99d2SJohn Baldwin static void 20781bb99d2SJohn Baldwin acpi_pci_update_device(ACPI_HANDLE handle, device_t pci_child) 20881bb99d2SJohn Baldwin { 20981bb99d2SJohn Baldwin ACPI_STATUS status; 21081bb99d2SJohn Baldwin device_t child; 21181bb99d2SJohn Baldwin 21281bb99d2SJohn Baldwin /* 213183c8af3SJohn Baldwin * Occasionally a PCI device may show up as an ACPI device 214183c8af3SJohn Baldwin * with a _HID. (For example, the TabletPC TC1000 has a 215183c8af3SJohn Baldwin * second PCI-ISA bridge that has a _HID for an 216183c8af3SJohn Baldwin * acpi_sysresource device.) In that case, leave ACPI-CA's 217183c8af3SJohn Baldwin * device data pointing at the ACPI-enumerated device. 21881bb99d2SJohn Baldwin */ 21981bb99d2SJohn Baldwin child = acpi_get_device(handle); 22081bb99d2SJohn Baldwin if (child != NULL) { 22181bb99d2SJohn Baldwin KASSERT(device_get_parent(child) == 22281bb99d2SJohn Baldwin devclass_get_device(devclass_find("acpi"), 0), 22381bb99d2SJohn Baldwin ("%s: child (%s)'s parent is not acpi0", __func__, 22481bb99d2SJohn Baldwin acpi_name(handle))); 225183c8af3SJohn Baldwin return; 22681bb99d2SJohn Baldwin } 22781bb99d2SJohn Baldwin 22881bb99d2SJohn Baldwin /* 22981bb99d2SJohn Baldwin * Update ACPI-CA to use the PCI enumerated device_t for this handle. 23081bb99d2SJohn Baldwin */ 23130d577a0SNate Lawson status = AcpiAttachData(handle, acpi_fake_objhandler, pci_child); 23281bb99d2SJohn Baldwin if (ACPI_FAILURE(status)) 23381bb99d2SJohn Baldwin printf("WARNING: Unable to attach object data to %s - %s\n", 23481bb99d2SJohn Baldwin acpi_name(handle), AcpiFormatException(status)); 23581bb99d2SJohn Baldwin } 23681bb99d2SJohn Baldwin 23728bf1fadSJohn Baldwin static ACPI_STATUS 23828bf1fadSJohn Baldwin acpi_pci_save_handle(ACPI_HANDLE handle, UINT32 level, void *context, 23928bf1fadSJohn Baldwin void **status) 24028bf1fadSJohn Baldwin { 24128bf1fadSJohn Baldwin struct acpi_pci_devinfo *dinfo; 24228bf1fadSJohn Baldwin device_t *devlist; 24328bf1fadSJohn Baldwin int devcount, i, func, slot; 24428bf1fadSJohn Baldwin UINT32 address; 24528bf1fadSJohn Baldwin 24628bf1fadSJohn Baldwin ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__); 24728bf1fadSJohn Baldwin 248c310653eSNate Lawson if (ACPI_FAILURE(acpi_GetInteger(handle, "_ADR", &address))) 24928bf1fadSJohn Baldwin return_ACPI_STATUS (AE_OK); 250e0a93586SJohn Baldwin slot = ACPI_ADR_PCI_SLOT(address); 251e0a93586SJohn Baldwin func = ACPI_ADR_PCI_FUNC(address); 25228bf1fadSJohn Baldwin if (device_get_children((device_t)context, &devlist, &devcount) != 0) 25328bf1fadSJohn Baldwin return_ACPI_STATUS (AE_OK); 25428bf1fadSJohn Baldwin for (i = 0; i < devcount; i++) { 25528bf1fadSJohn Baldwin dinfo = device_get_ivars(devlist[i]); 25628bf1fadSJohn Baldwin if (dinfo->ap_dinfo.cfg.func == func && 25728bf1fadSJohn Baldwin dinfo->ap_dinfo.cfg.slot == slot) { 25828bf1fadSJohn Baldwin dinfo->ap_handle = handle; 25981bb99d2SJohn Baldwin acpi_pci_update_device(handle, devlist[i]); 26030d577a0SNate Lawson break; 26128bf1fadSJohn Baldwin } 26228bf1fadSJohn Baldwin } 26328bf1fadSJohn Baldwin free(devlist, M_TEMP); 26428bf1fadSJohn Baldwin return_ACPI_STATUS (AE_OK); 26528bf1fadSJohn Baldwin } 26628bf1fadSJohn Baldwin 26728bf1fadSJohn Baldwin static int 26828bf1fadSJohn Baldwin acpi_pci_probe(device_t dev) 26928bf1fadSJohn Baldwin { 27028bf1fadSJohn Baldwin 27128bf1fadSJohn Baldwin if (acpi_get_handle(dev) == NULL) 27228bf1fadSJohn Baldwin return (ENXIO); 2735acd0218SNate Lawson device_set_desc(dev, "ACPI PCI bus"); 27428bf1fadSJohn Baldwin return (0); 27528bf1fadSJohn Baldwin } 27628bf1fadSJohn Baldwin 27728bf1fadSJohn Baldwin static int 27828bf1fadSJohn Baldwin acpi_pci_attach(device_t dev) 27928bf1fadSJohn Baldwin { 280*1b1596a3SJohn Baldwin int busno, domain, error; 281*1b1596a3SJohn Baldwin 282*1b1596a3SJohn Baldwin error = pci_attach_common(dev); 283*1b1596a3SJohn Baldwin if (error) 284*1b1596a3SJohn Baldwin return (error); 28528bf1fadSJohn Baldwin 28628bf1fadSJohn Baldwin /* 28728bf1fadSJohn Baldwin * Since there can be multiple independantly numbered PCI 28870bc2d3fSJohn Baldwin * busses on systems with multiple PCI domains, we can't use 28970bc2d3fSJohn Baldwin * the unit number to decide which bus we are probing. We ask 29055aaf894SMarius Strobl * the parent pcib what our domain and bus numbers are. 29128bf1fadSJohn Baldwin */ 29255aaf894SMarius Strobl domain = pcib_get_domain(dev); 29328bf1fadSJohn Baldwin busno = pcib_get_bus(dev); 29428bf1fadSJohn Baldwin 29528bf1fadSJohn Baldwin /* 29628bf1fadSJohn Baldwin * First, PCI devices are added as in the normal PCI bus driver. 29728bf1fadSJohn Baldwin * Afterwards, the ACPI namespace under the bridge driver is 29828bf1fadSJohn Baldwin * walked to save ACPI handles to all the devices that appear in 29928bf1fadSJohn Baldwin * the ACPI namespace as immediate descendants of the bridge. 30028bf1fadSJohn Baldwin * 30128bf1fadSJohn Baldwin * XXX: Sometimes PCI devices show up in the ACPI namespace that 30228bf1fadSJohn Baldwin * pci_add_children() doesn't find. We currently just ignore 30328bf1fadSJohn Baldwin * these devices. 30428bf1fadSJohn Baldwin */ 30555aaf894SMarius Strobl pci_add_children(dev, domain, busno, sizeof(struct acpi_pci_devinfo)); 3065acd0218SNate Lawson AcpiWalkNamespace(ACPI_TYPE_DEVICE, acpi_get_handle(dev), 1, 3072272d050SJung-uk Kim acpi_pci_save_handle, NULL, dev, NULL); 30828bf1fadSJohn Baldwin 30928bf1fadSJohn Baldwin return (bus_generic_attach(dev)); 31028bf1fadSJohn Baldwin } 311