1193323Sed/*- 2193323Sed * Copyright (c) 1997, Stefan Esser <se@freebsd.org> 3193323Sed * Copyright (c) 2000, Michael Smith <msmith@freebsd.org> 4193323Sed * Copyright (c) 2000, BSDi 5193323Sed * All rights reserved. 6193323Sed * 7193323Sed * Redistribution and use in source and binary forms, with or without 8193323Sed * modification, are permitted provided that the following conditions 9193323Sed * are met: 10193323Sed * 1. Redistributions of source code must retain the above copyright 11193323Sed * notice unmodified, this list of conditions, and the following 12193323Sed * disclaimer. 13193323Sed * 2. Redistributions in binary form must reproduce the above copyright 14193323Sed * notice, this list of conditions and the following disclaimer in the 15193323Sed * documentation and/or other materials provided with the distribution. 16193323Sed * 17193323Sed * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 18193323Sed * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 19198090Srdivacky * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 20193323Sed * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 21193323Sed * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 22193323Sed * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 23193323Sed * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 24193323Sed * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 25193323Sed * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 26193323Sed * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 27193323Sed */ 28193323Sed 29198892Srdivacky#include <sys/cdefs.h> 30193323Sed__FBSDID("$FreeBSD: releng/11.0/sys/dev/acpica/acpi_pci.c 299286 2016-05-09 20:50:21Z jhb $"); 31193323Sed 32193323Sed#include "opt_acpi.h" 33193323Sed 34198090Srdivacky#include <sys/param.h> 35193323Sed#include <sys/systm.h> 36193323Sed#include <sys/bus.h> 37193323Sed#include <sys/kernel.h> 38193323Sed#include <sys/malloc.h> 39193323Sed#include <sys/module.h> 40193323Sed 41193323Sed#include <contrib/dev/acpica/include/acpi.h> 42193323Sed#include <contrib/dev/acpica/include/accommon.h> 43193323Sed 44193323Sed#include <dev/acpica/acpivar.h> 45193323Sed#include <dev/acpica/acpi_pcivar.h> 46193323Sed 47198892Srdivacky#include <sys/pciio.h> 48193323Sed#include <dev/pci/pcireg.h> 49193323Sed#include <dev/pci/pcivar.h> 50193323Sed#include <dev/pci/pci_private.h> 51193323Sed 52193323Sed#include "pcib_if.h" 53193323Sed#include "pci_if.h" 54198090Srdivacky 55193323Sed/* Hooks for the ACPI CA debugging infrastructure. */ 56193323Sed#define _COMPONENT ACPI_BUS 57198090SrdivackyACPI_MODULE_NAME("PCI") 58193323Sed 59193323Sedstruct acpi_pci_devinfo { 60193323Sed struct pci_devinfo ap_dinfo; 61193323Sed ACPI_HANDLE ap_handle; 62193323Sed int ap_flags; 63193323Sed}; 64193323Sed 65193323SedACPI_SERIAL_DECL(pci_powerstate, "ACPI PCI power methods"); 66193323Sed 67193323Sed/* Be sure that ACPI and PCI power states are equivalent. */ 68193323SedCTASSERT(ACPI_STATE_D0 == PCI_POWERSTATE_D0); 69193323SedCTASSERT(ACPI_STATE_D1 == PCI_POWERSTATE_D1); 70193323SedCTASSERT(ACPI_STATE_D2 == PCI_POWERSTATE_D2); 71193323SedCTASSERT(ACPI_STATE_D3 == PCI_POWERSTATE_D3); 72193323Sed 73193323Sedstatic struct pci_devinfo *acpi_pci_alloc_devinfo(device_t dev); 74193323Sedstatic void acpi_pci_child_deleted(device_t dev, device_t child); 75193323Sedstatic int acpi_pci_child_location_str_method(device_t cbdev, 76193323Sed device_t child, char *buf, size_t buflen); 77193323Sedstatic int acpi_pci_probe(device_t dev); 78193323Sedstatic int acpi_pci_read_ivar(device_t dev, device_t child, int which, 79193323Sed uintptr_t *result); 80193323Sedstatic int acpi_pci_write_ivar(device_t dev, device_t child, int which, 81193323Sed uintptr_t value); 82193323Sedstatic ACPI_STATUS acpi_pci_save_handle(ACPI_HANDLE handle, UINT32 level, 83193323Sed void *context, void **status); 84193323Sedstatic int acpi_pci_set_powerstate_method(device_t dev, device_t child, 85193323Sed int state); 86193323Sedstatic void acpi_pci_update_device(ACPI_HANDLE handle, device_t pci_child); 87193323Sedstatic bus_dma_tag_t acpi_pci_get_dma_tag(device_t bus, device_t child); 88193323Sed 89193323Sedstatic device_method_t acpi_pci_methods[] = { 90193323Sed /* Device interface */ 91193323Sed DEVMETHOD(device_probe, acpi_pci_probe), 92193323Sed 93193323Sed /* Bus interface */ 94193323Sed DEVMETHOD(bus_read_ivar, acpi_pci_read_ivar), 95193323Sed DEVMETHOD(bus_write_ivar, acpi_pci_write_ivar), 96193323Sed DEVMETHOD(bus_child_deleted, acpi_pci_child_deleted), 97193323Sed DEVMETHOD(bus_child_location_str, acpi_pci_child_location_str_method), 98193323Sed DEVMETHOD(bus_get_cpus, acpi_get_cpus), 99193323Sed DEVMETHOD(bus_get_dma_tag, acpi_pci_get_dma_tag), 100193323Sed DEVMETHOD(bus_get_domain, acpi_get_domain), 101193323Sed 102193323Sed /* PCI interface */ 103193323Sed DEVMETHOD(pci_alloc_devinfo, acpi_pci_alloc_devinfo), 104193323Sed DEVMETHOD(pci_child_added, acpi_pci_child_added), 105193323Sed DEVMETHOD(pci_set_powerstate, acpi_pci_set_powerstate_method), 106193323Sed 107193323Sed DEVMETHOD_END 108193323Sed}; 109193323Sed 110193323Sedstatic devclass_t pci_devclass; 111193323Sed 112193323SedDEFINE_CLASS_1(pci, acpi_pci_driver, acpi_pci_methods, sizeof(struct pci_softc), 113193323Sed pci_driver); 114193323SedDRIVER_MODULE(acpi_pci, pcib, acpi_pci_driver, pci_devclass, 0, 0); 115193323SedMODULE_DEPEND(acpi_pci, acpi, 1, 1, 1); 116193323SedMODULE_DEPEND(acpi_pci, pci, 1, 1, 1); 117193323SedMODULE_VERSION(acpi_pci, 1); 118193323Sed 119193323Sedstatic struct pci_devinfo * 120193323Sedacpi_pci_alloc_devinfo(device_t dev) 121193323Sed{ 122193323Sed struct acpi_pci_devinfo *dinfo; 123193323Sed 124193323Sed dinfo = malloc(sizeof(*dinfo), M_DEVBUF, M_WAITOK | M_ZERO); 125193323Sed return (&dinfo->ap_dinfo); 126193323Sed} 127193323Sed 128193323Sedstatic int 129193323Sedacpi_pci_read_ivar(device_t dev, device_t child, int which, uintptr_t *result) 130193323Sed{ 131193323Sed struct acpi_pci_devinfo *dinfo; 132193323Sed 133193323Sed dinfo = device_get_ivars(child); 134193323Sed switch (which) { 135193323Sed case ACPI_IVAR_HANDLE: 136193323Sed *result = (uintptr_t)dinfo->ap_handle; 137193323Sed return (0); 138193323Sed case ACPI_IVAR_FLAGS: 139193323Sed *result = (uintptr_t)dinfo->ap_flags; 140193323Sed return (0); 141193323Sed } 142193323Sed return (pci_read_ivar(dev, child, which, result)); 143193323Sed} 144193323Sed 145193323Sedstatic int 146193323Sedacpi_pci_write_ivar(device_t dev, device_t child, int which, uintptr_t value) 147193323Sed{ 148193323Sed struct acpi_pci_devinfo *dinfo; 149193323Sed 150193323Sed dinfo = device_get_ivars(child); 151193323Sed switch (which) { 152193323Sed case ACPI_IVAR_HANDLE: 153193323Sed dinfo->ap_handle = (ACPI_HANDLE)value; 154198892Srdivacky return (0); 155193323Sed case ACPI_IVAR_FLAGS: 156193323Sed dinfo->ap_flags = (int)value; 157198892Srdivacky return (0); 158198892Srdivacky } 159198892Srdivacky return (pci_write_ivar(dev, child, which, value)); 160198892Srdivacky} 161198892Srdivacky 162193323Sedstatic void 163198090Srdivackyacpi_pci_child_deleted(device_t dev, device_t child) 164198090Srdivacky{ 165198090Srdivacky struct acpi_pci_devinfo *dinfo = device_get_ivars(child); 166198090Srdivacky 167198892Srdivacky if (acpi_get_device(dinfo->ap_handle) == child) 168198090Srdivacky AcpiDetachData(dinfo->ap_handle, acpi_fake_objhandler); 169198090Srdivacky pci_child_deleted(dev, child); 170198090Srdivacky} 171198090Srdivacky 172193323Sedstatic int 173193323Sedacpi_pci_child_location_str_method(device_t cbdev, device_t child, char *buf, 174193323Sed size_t buflen) 175193323Sed{ 176193323Sed struct acpi_pci_devinfo *dinfo = device_get_ivars(child); 177193323Sed int pxm; 178193323Sed char buf2[32]; 179193323Sed 180193323Sed pci_child_location_str_method(cbdev, child, buf, buflen); 181193323Sed 182193323Sed if (dinfo->ap_handle) { 183193323Sed strlcat(buf, " handle=", buflen); 184193323Sed strlcat(buf, acpi_name(dinfo->ap_handle), buflen); 185193323Sed 186193323Sed if (ACPI_SUCCESS(acpi_GetInteger(dinfo->ap_handle, "_PXM", &pxm))) { 187193323Sed snprintf(buf2, 32, " _PXM=%d", pxm); 188193323Sed strlcat(buf, buf2, buflen); 189193323Sed } 190193323Sed } 191193323Sed return (0); 192193323Sed} 193193323Sed 194193323Sed/* 195193323Sed * PCI power manangement 196193323Sed */ 197193323Sedstatic int 198193323Sedacpi_pci_set_powerstate_method(device_t dev, device_t child, int state) 199193323Sed{ 200193323Sed ACPI_HANDLE h; 201193323Sed ACPI_STATUS status; 202193323Sed int old_state, error; 203193323Sed 204193323Sed error = 0; 205193323Sed if (state < ACPI_STATE_D0 || state > ACPI_STATE_D3) 206193323Sed return (EINVAL); 207193323Sed 208193323Sed /* 209193323Sed * We set the state using PCI Power Management outside of setting 210193323Sed * the ACPI state. This means that when powering down a device, we 211193323Sed * first shut it down using PCI, and then using ACPI, which lets ACPI 212193323Sed * try to power down any Power Resources that are now no longer used. 213193323Sed * When powering up a device, we let ACPI set the state first so that 214193323Sed * it can enable any needed Power Resources before changing the PCI 215193323Sed * power state. 216193323Sed */ 217193323Sed ACPI_SERIAL_BEGIN(pci_powerstate); 218193323Sed old_state = pci_get_powerstate(child); 219193323Sed if (old_state < state && pci_do_power_suspend) { 220193323Sed error = pci_set_powerstate_method(dev, child, state); 221193323Sed if (error) 222193323Sed goto out; 223193323Sed } 224193323Sed h = acpi_get_handle(child); 225193323Sed status = acpi_pwr_switch_consumer(h, state); 226193323Sed if (ACPI_SUCCESS(status)) { 227193323Sed if (bootverbose) 228193323Sed device_printf(dev, "set ACPI power state D%d on %s\n", 229193323Sed state, acpi_name(h)); 230193323Sed } else if (status != AE_NOT_FOUND) 231198090Srdivacky device_printf(dev, 232198090Srdivacky "failed to set ACPI power state D%d on %s: %s\n", 233198090Srdivacky state, acpi_name(h), AcpiFormatException(status)); 234198090Srdivacky if (old_state > state && pci_do_power_resume) 235198396Srdivacky error = pci_set_powerstate_method(dev, child, state); 236193323Sed 237193323Sedout: 238193323Sed ACPI_SERIAL_END(pci_powerstate); 239193323Sed return (error); 240193323Sed} 241193323Sed 242193323Sedstatic void 243193323Sedacpi_pci_update_device(ACPI_HANDLE handle, device_t pci_child) 244193323Sed{ 245193323Sed ACPI_STATUS status; 246193323Sed device_t child; 247193323Sed 248193323Sed /* 249193323Sed * Occasionally a PCI device may show up as an ACPI device 250193323Sed * with a _HID. (For example, the TabletPC TC1000 has a 251193323Sed * second PCI-ISA bridge that has a _HID for an 252193323Sed * acpi_sysresource device.) In that case, leave ACPI-CA's 253193323Sed * device data pointing at the ACPI-enumerated device. 254193323Sed */ 255193323Sed child = acpi_get_device(handle); 256193323Sed if (child != NULL) { 257193323Sed KASSERT(device_get_parent(child) == 258193323Sed devclass_get_device(devclass_find("acpi"), 0), 259193323Sed ("%s: child (%s)'s parent is not acpi0", __func__, 260193323Sed acpi_name(handle))); 261193323Sed return; 262193323Sed } 263193323Sed 264193323Sed /* 265193323Sed * Update ACPI-CA to use the PCI enumerated device_t for this handle. 266198090Srdivacky */ 267198090Srdivacky status = AcpiAttachData(handle, acpi_fake_objhandler, pci_child); 268198090Srdivacky if (ACPI_FAILURE(status)) 269198090Srdivacky printf("WARNING: Unable to attach object data to %s - %s\n", 270193323Sed acpi_name(handle), AcpiFormatException(status)); 271193323Sed} 272193323Sed 273193323Sedstatic ACPI_STATUS 274193323Sedacpi_pci_save_handle(ACPI_HANDLE handle, UINT32 level, void *context, 275193323Sed void **status) 276193323Sed{ 277193323Sed struct acpi_pci_devinfo *dinfo; 278193323Sed device_t child; 279198090Srdivacky int func, slot; 280193323Sed UINT32 address; 281193323Sed 282193323Sed ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__); 283193323Sed 284193323Sed child = context; 285193323Sed if (ACPI_FAILURE(acpi_GetInteger(handle, "_ADR", &address))) 286193323Sed return_ACPI_STATUS (AE_OK); 287193323Sed slot = ACPI_ADR_PCI_SLOT(address); 288193323Sed func = ACPI_ADR_PCI_FUNC(address); 289193323Sed dinfo = device_get_ivars(child); 290193323Sed if (dinfo->ap_dinfo.cfg.func == func && 291193323Sed dinfo->ap_dinfo.cfg.slot == slot) { 292193323Sed dinfo->ap_handle = handle; 293193323Sed acpi_pci_update_device(handle, child); 294198090Srdivacky return_ACPI_STATUS (AE_CTRL_TERMINATE); 295193323Sed } 296193323Sed return_ACPI_STATUS (AE_OK); 297193323Sed} 298193323Sed 299193323Sedvoid 300198090Srdivackyacpi_pci_child_added(device_t dev, device_t child) 301193323Sed{ 302198090Srdivacky 303193323Sed /* 304198090Srdivacky * PCI devices are added via the bus scan in the normal PCI 305198090Srdivacky * bus driver. As each device is added, the 306193323Sed * acpi_pci_child_added() callback walks the ACPI namespace 307193323Sed * under the bridge driver to save ACPI handles to all the 308198090Srdivacky * devices that appear in the ACPI namespace as immediate 309198090Srdivacky * descendants of the bridge. 310198090Srdivacky * 311193323Sed * XXX: Sometimes PCI devices show up in the ACPI namespace that 312193323Sed * pci_add_children() doesn't find. We currently just ignore 313193323Sed * these devices. 314193323Sed */ 315193323Sed AcpiWalkNamespace(ACPI_TYPE_DEVICE, acpi_get_handle(dev), 1, 316193323Sed acpi_pci_save_handle, NULL, child, NULL); 317193323Sed} 318193323Sed 319193323Sedstatic int 320198090Srdivackyacpi_pci_probe(device_t dev) 321193323Sed{ 322193323Sed 323193323Sed if (acpi_get_handle(dev) == NULL) 324198090Srdivacky return (ENXIO); 325198090Srdivacky device_set_desc(dev, "ACPI PCI bus"); 326193323Sed return (BUS_PROBE_DEFAULT); 327193323Sed} 328193323Sed 329198090Srdivacky#ifdef ACPI_DMAR 330193323Sedbus_dma_tag_t dmar_get_dma_tag(device_t dev, device_t child); 331193323Sedstatic bus_dma_tag_t 332193323Sedacpi_pci_get_dma_tag(device_t bus, device_t child) 333193323Sed{ 334193323Sed bus_dma_tag_t tag; 335193323Sed 336193323Sed if (device_get_parent(child) == bus) { 337193323Sed /* try dmar and return if it works */ 338193323Sed tag = dmar_get_dma_tag(bus, child); 339193323Sed } else 340193323Sed tag = NULL; 341193323Sed if (tag == NULL) 342193323Sed tag = pci_get_dma_tag(bus, child); 343193323Sed return (tag); 344193323Sed} 345193323Sed#else 346193323Sedstatic bus_dma_tag_t 347193323Sedacpi_pci_get_dma_tag(device_t bus, device_t child) 348193323Sed{ 349193323Sed 350193323Sed return (pci_get_dma_tag(bus, child)); 351193323Sed} 352193323Sed#endif 353193323Sed 354193323Sed