1 /*- 2 * Copyright (c) 1997, Stefan Esser <se@freebsd.org> 3 * Copyright (c) 2000, Michael Smith <msmith@freebsd.org> 4 * Copyright (c) 2000, BSDi 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice unmodified, this list of conditions, and the following 12 * disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 27 */ 28 29 #include <sys/cdefs.h> 30 __FBSDID("$FreeBSD$"); 31 32 #include <sys/param.h> 33 #include <sys/systm.h> 34 #include <sys/bus.h> 35 #include <sys/kernel.h> 36 #include <sys/malloc.h> 37 #include <sys/module.h> 38 39 #include <contrib/dev/acpica/include/acpi.h> 40 #include <contrib/dev/acpica/include/accommon.h> 41 42 #include <dev/acpica/acpivar.h> 43 44 #include <sys/pciio.h> 45 #include <dev/pci/pcireg.h> 46 #include <dev/pci/pcivar.h> 47 #include <dev/pci/pci_private.h> 48 49 #include "pcib_if.h" 50 #include "pci_if.h" 51 52 /* Hooks for the ACPI CA debugging infrastructure. */ 53 #define _COMPONENT ACPI_BUS 54 ACPI_MODULE_NAME("PCI") 55 56 struct acpi_pci_devinfo { 57 struct pci_devinfo ap_dinfo; 58 ACPI_HANDLE ap_handle; 59 int ap_flags; 60 }; 61 62 ACPI_SERIAL_DECL(pci_powerstate, "ACPI PCI power methods"); 63 64 /* Be sure that ACPI and PCI power states are equivalent. */ 65 CTASSERT(ACPI_STATE_D0 == PCI_POWERSTATE_D0); 66 CTASSERT(ACPI_STATE_D1 == PCI_POWERSTATE_D1); 67 CTASSERT(ACPI_STATE_D2 == PCI_POWERSTATE_D2); 68 CTASSERT(ACPI_STATE_D3 == PCI_POWERSTATE_D3); 69 70 static int acpi_pci_attach(device_t dev); 71 static int acpi_pci_child_location_str_method(device_t cbdev, 72 device_t child, char *buf, size_t buflen); 73 static int acpi_pci_probe(device_t dev); 74 static int acpi_pci_read_ivar(device_t dev, device_t child, int which, 75 uintptr_t *result); 76 static int acpi_pci_write_ivar(device_t dev, device_t child, int which, 77 uintptr_t value); 78 static ACPI_STATUS acpi_pci_save_handle(ACPI_HANDLE handle, UINT32 level, 79 void *context, void **status); 80 static int acpi_pci_set_powerstate_method(device_t dev, device_t child, 81 int state); 82 static void acpi_pci_update_device(ACPI_HANDLE handle, device_t pci_child); 83 84 static device_method_t acpi_pci_methods[] = { 85 /* Device interface */ 86 DEVMETHOD(device_probe, acpi_pci_probe), 87 DEVMETHOD(device_attach, acpi_pci_attach), 88 89 /* Bus interface */ 90 DEVMETHOD(bus_read_ivar, acpi_pci_read_ivar), 91 DEVMETHOD(bus_write_ivar, acpi_pci_write_ivar), 92 DEVMETHOD(bus_child_location_str, acpi_pci_child_location_str_method), 93 94 /* PCI interface */ 95 DEVMETHOD(pci_set_powerstate, acpi_pci_set_powerstate_method), 96 97 DEVMETHOD_END 98 }; 99 100 static devclass_t pci_devclass; 101 102 DEFINE_CLASS_1(pci, acpi_pci_driver, acpi_pci_methods, sizeof(struct pci_softc), 103 pci_driver); 104 DRIVER_MODULE(acpi_pci, pcib, acpi_pci_driver, pci_devclass, 0, 0); 105 MODULE_DEPEND(acpi_pci, acpi, 1, 1, 1); 106 MODULE_DEPEND(acpi_pci, pci, 1, 1, 1); 107 MODULE_VERSION(acpi_pci, 1); 108 109 static int 110 acpi_pci_read_ivar(device_t dev, device_t child, int which, uintptr_t *result) 111 { 112 struct acpi_pci_devinfo *dinfo; 113 114 dinfo = device_get_ivars(child); 115 switch (which) { 116 case ACPI_IVAR_HANDLE: 117 *result = (uintptr_t)dinfo->ap_handle; 118 return (0); 119 case ACPI_IVAR_FLAGS: 120 *result = (uintptr_t)dinfo->ap_flags; 121 return (0); 122 } 123 return (pci_read_ivar(dev, child, which, result)); 124 } 125 126 static int 127 acpi_pci_write_ivar(device_t dev, device_t child, int which, uintptr_t value) 128 { 129 struct acpi_pci_devinfo *dinfo; 130 131 dinfo = device_get_ivars(child); 132 switch (which) { 133 case ACPI_IVAR_HANDLE: 134 dinfo->ap_handle = (ACPI_HANDLE)value; 135 return (0); 136 case ACPI_IVAR_FLAGS: 137 dinfo->ap_flags = (int)value; 138 return (0); 139 } 140 return (pci_write_ivar(dev, child, which, value)); 141 } 142 143 static int 144 acpi_pci_child_location_str_method(device_t cbdev, device_t child, char *buf, 145 size_t buflen) 146 { 147 struct acpi_pci_devinfo *dinfo = device_get_ivars(child); 148 149 pci_child_location_str_method(cbdev, child, buf, buflen); 150 151 if (dinfo->ap_handle) { 152 strlcat(buf, " handle=", buflen); 153 strlcat(buf, acpi_name(dinfo->ap_handle), buflen); 154 } 155 return (0); 156 } 157 158 /* 159 * PCI power manangement 160 */ 161 static int 162 acpi_pci_set_powerstate_method(device_t dev, device_t child, int state) 163 { 164 ACPI_HANDLE h; 165 ACPI_STATUS status; 166 int old_state, error; 167 168 error = 0; 169 if (state < ACPI_STATE_D0 || state > ACPI_STATE_D3) 170 return (EINVAL); 171 172 /* 173 * We set the state using PCI Power Management outside of setting 174 * the ACPI state. This means that when powering down a device, we 175 * first shut it down using PCI, and then using ACPI, which lets ACPI 176 * try to power down any Power Resources that are now no longer used. 177 * When powering up a device, we let ACPI set the state first so that 178 * it can enable any needed Power Resources before changing the PCI 179 * power state. 180 */ 181 ACPI_SERIAL_BEGIN(pci_powerstate); 182 old_state = pci_get_powerstate(child); 183 if (old_state < state && pci_do_power_suspend) { 184 error = pci_set_powerstate_method(dev, child, state); 185 if (error) 186 goto out; 187 } 188 h = acpi_get_handle(child); 189 status = acpi_pwr_switch_consumer(h, state); 190 if (ACPI_SUCCESS(status)) { 191 if (bootverbose) 192 device_printf(dev, "set ACPI power state D%d on %s\n", 193 state, acpi_name(h)); 194 } else if (status != AE_NOT_FOUND) 195 device_printf(dev, 196 "failed to set ACPI power state D%d on %s: %s\n", 197 state, acpi_name(h), AcpiFormatException(status)); 198 if (old_state > state && pci_do_power_resume) 199 error = pci_set_powerstate_method(dev, child, state); 200 201 out: 202 ACPI_SERIAL_END(pci_powerstate); 203 return (error); 204 } 205 206 static void 207 acpi_pci_update_device(ACPI_HANDLE handle, device_t pci_child) 208 { 209 ACPI_STATUS status; 210 device_t child; 211 212 /* 213 * Occasionally a PCI device may show up as an ACPI device 214 * with a _HID. (For example, the TabletPC TC1000 has a 215 * second PCI-ISA bridge that has a _HID for an 216 * acpi_sysresource device.) In that case, leave ACPI-CA's 217 * device data pointing at the ACPI-enumerated device. 218 */ 219 child = acpi_get_device(handle); 220 if (child != NULL) { 221 KASSERT(device_get_parent(child) == 222 devclass_get_device(devclass_find("acpi"), 0), 223 ("%s: child (%s)'s parent is not acpi0", __func__, 224 acpi_name(handle))); 225 return; 226 } 227 228 /* 229 * Update ACPI-CA to use the PCI enumerated device_t for this handle. 230 */ 231 status = AcpiAttachData(handle, acpi_fake_objhandler, pci_child); 232 if (ACPI_FAILURE(status)) 233 printf("WARNING: Unable to attach object data to %s - %s\n", 234 acpi_name(handle), AcpiFormatException(status)); 235 } 236 237 static ACPI_STATUS 238 acpi_pci_save_handle(ACPI_HANDLE handle, UINT32 level, void *context, 239 void **status) 240 { 241 struct acpi_pci_devinfo *dinfo; 242 device_t *devlist; 243 int devcount, i, func, slot; 244 UINT32 address; 245 246 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__); 247 248 if (ACPI_FAILURE(acpi_GetInteger(handle, "_ADR", &address))) 249 return_ACPI_STATUS (AE_OK); 250 slot = ACPI_ADR_PCI_SLOT(address); 251 func = ACPI_ADR_PCI_FUNC(address); 252 if (device_get_children((device_t)context, &devlist, &devcount) != 0) 253 return_ACPI_STATUS (AE_OK); 254 for (i = 0; i < devcount; i++) { 255 dinfo = device_get_ivars(devlist[i]); 256 if (dinfo->ap_dinfo.cfg.func == func && 257 dinfo->ap_dinfo.cfg.slot == slot) { 258 dinfo->ap_handle = handle; 259 acpi_pci_update_device(handle, devlist[i]); 260 break; 261 } 262 } 263 free(devlist, M_TEMP); 264 return_ACPI_STATUS (AE_OK); 265 } 266 267 static int 268 acpi_pci_probe(device_t dev) 269 { 270 271 if (acpi_get_handle(dev) == NULL) 272 return (ENXIO); 273 device_set_desc(dev, "ACPI PCI bus"); 274 return (0); 275 } 276 277 static int 278 acpi_pci_attach(device_t dev) 279 { 280 int busno, domain, error; 281 282 error = pci_attach_common(dev); 283 if (error) 284 return (error); 285 286 /* 287 * Since there can be multiple independantly numbered PCI 288 * busses on systems with multiple PCI domains, we can't use 289 * the unit number to decide which bus we are probing. We ask 290 * the parent pcib what our domain and bus numbers are. 291 */ 292 domain = pcib_get_domain(dev); 293 busno = pcib_get_bus(dev); 294 295 /* 296 * First, PCI devices are added as in the normal PCI bus driver. 297 * Afterwards, the ACPI namespace under the bridge driver is 298 * walked to save ACPI handles to all the devices that appear in 299 * the ACPI namespace as immediate descendants of the bridge. 300 * 301 * XXX: Sometimes PCI devices show up in the ACPI namespace that 302 * pci_add_children() doesn't find. We currently just ignore 303 * these devices. 304 */ 305 pci_add_children(dev, domain, busno, sizeof(struct acpi_pci_devinfo)); 306 AcpiWalkNamespace(ACPI_TYPE_DEVICE, acpi_get_handle(dev), 1, 307 acpi_pci_save_handle, NULL, dev, NULL); 308 309 return (bus_generic_attach(dev)); 310 } 311