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 "opt_acpi.h" 33 34 #include <sys/param.h> 35 #include <sys/systm.h> 36 #include <sys/bus.h> 37 #include <sys/kernel.h> 38 #include <sys/malloc.h> 39 #include <sys/module.h> 40 41 #include <contrib/dev/acpica/include/acpi.h> 42 #include <contrib/dev/acpica/include/accommon.h> 43 44 #include <dev/acpica/acpivar.h> 45 46 #include <sys/pciio.h> 47 #include <dev/pci/pcireg.h> 48 #include <dev/pci/pcivar.h> 49 #include <dev/pci/pci_private.h> 50 51 #include "pcib_if.h" 52 #include "pci_if.h" 53 54 /* Hooks for the ACPI CA debugging infrastructure. */ 55 #define _COMPONENT ACPI_BUS 56 ACPI_MODULE_NAME("PCI") 57 58 struct acpi_pci_devinfo { 59 struct pci_devinfo ap_dinfo; 60 ACPI_HANDLE ap_handle; 61 int ap_flags; 62 }; 63 64 ACPI_SERIAL_DECL(pci_powerstate, "ACPI PCI power methods"); 65 66 /* Be sure that ACPI and PCI power states are equivalent. */ 67 CTASSERT(ACPI_STATE_D0 == PCI_POWERSTATE_D0); 68 CTASSERT(ACPI_STATE_D1 == PCI_POWERSTATE_D1); 69 CTASSERT(ACPI_STATE_D2 == PCI_POWERSTATE_D2); 70 CTASSERT(ACPI_STATE_D3 == PCI_POWERSTATE_D3); 71 72 static int acpi_pci_attach(device_t dev); 73 static int acpi_pci_child_location_str_method(device_t cbdev, 74 device_t child, char *buf, size_t buflen); 75 static int acpi_pci_probe(device_t dev); 76 static int acpi_pci_read_ivar(device_t dev, device_t child, int which, 77 uintptr_t *result); 78 static int acpi_pci_write_ivar(device_t dev, device_t child, int which, 79 uintptr_t value); 80 static ACPI_STATUS acpi_pci_save_handle(ACPI_HANDLE handle, UINT32 level, 81 void *context, void **status); 82 static int acpi_pci_set_powerstate_method(device_t dev, device_t child, 83 int state); 84 static void acpi_pci_update_device(ACPI_HANDLE handle, device_t pci_child); 85 static bus_dma_tag_t acpi_pci_get_dma_tag(device_t bus, device_t child); 86 87 static device_method_t acpi_pci_methods[] = { 88 /* Device interface */ 89 DEVMETHOD(device_probe, acpi_pci_probe), 90 DEVMETHOD(device_attach, acpi_pci_attach), 91 92 /* Bus interface */ 93 DEVMETHOD(bus_read_ivar, acpi_pci_read_ivar), 94 DEVMETHOD(bus_write_ivar, acpi_pci_write_ivar), 95 DEVMETHOD(bus_child_location_str, acpi_pci_child_location_str_method), 96 DEVMETHOD(bus_get_dma_tag, acpi_pci_get_dma_tag), 97 98 /* PCI interface */ 99 DEVMETHOD(pci_set_powerstate, acpi_pci_set_powerstate_method), 100 101 DEVMETHOD_END 102 }; 103 104 static devclass_t pci_devclass; 105 106 DEFINE_CLASS_1(pci, acpi_pci_driver, acpi_pci_methods, sizeof(struct pci_softc), 107 pci_driver); 108 DRIVER_MODULE(acpi_pci, pcib, acpi_pci_driver, pci_devclass, 0, 0); 109 MODULE_DEPEND(acpi_pci, acpi, 1, 1, 1); 110 MODULE_DEPEND(acpi_pci, pci, 1, 1, 1); 111 MODULE_VERSION(acpi_pci, 1); 112 113 static int 114 acpi_pci_read_ivar(device_t dev, device_t child, int which, uintptr_t *result) 115 { 116 struct acpi_pci_devinfo *dinfo; 117 118 dinfo = device_get_ivars(child); 119 switch (which) { 120 case ACPI_IVAR_HANDLE: 121 *result = (uintptr_t)dinfo->ap_handle; 122 return (0); 123 case ACPI_IVAR_FLAGS: 124 *result = (uintptr_t)dinfo->ap_flags; 125 return (0); 126 } 127 return (pci_read_ivar(dev, child, which, result)); 128 } 129 130 static int 131 acpi_pci_write_ivar(device_t dev, device_t child, int which, uintptr_t value) 132 { 133 struct acpi_pci_devinfo *dinfo; 134 135 dinfo = device_get_ivars(child); 136 switch (which) { 137 case ACPI_IVAR_HANDLE: 138 dinfo->ap_handle = (ACPI_HANDLE)value; 139 return (0); 140 case ACPI_IVAR_FLAGS: 141 dinfo->ap_flags = (int)value; 142 return (0); 143 } 144 return (pci_write_ivar(dev, child, which, value)); 145 } 146 147 static int 148 acpi_pci_child_location_str_method(device_t cbdev, device_t child, char *buf, 149 size_t buflen) 150 { 151 struct acpi_pci_devinfo *dinfo = device_get_ivars(child); 152 int pxm; 153 char buf2[32]; 154 155 pci_child_location_str_method(cbdev, child, buf, buflen); 156 157 if (dinfo->ap_handle) { 158 strlcat(buf, " handle=", buflen); 159 strlcat(buf, acpi_name(dinfo->ap_handle), buflen); 160 161 if (ACPI_SUCCESS(acpi_GetInteger(dinfo->ap_handle, "_PXM", &pxm))) { 162 snprintf(buf2, 32, " _PXM=%d", pxm); 163 strlcat(buf, buf2, buflen); 164 } 165 } 166 return (0); 167 } 168 169 /* 170 * PCI power manangement 171 */ 172 static int 173 acpi_pci_set_powerstate_method(device_t dev, device_t child, int state) 174 { 175 ACPI_HANDLE h; 176 ACPI_STATUS status; 177 int old_state, error; 178 179 error = 0; 180 if (state < ACPI_STATE_D0 || state > ACPI_STATE_D3) 181 return (EINVAL); 182 183 /* 184 * We set the state using PCI Power Management outside of setting 185 * the ACPI state. This means that when powering down a device, we 186 * first shut it down using PCI, and then using ACPI, which lets ACPI 187 * try to power down any Power Resources that are now no longer used. 188 * When powering up a device, we let ACPI set the state first so that 189 * it can enable any needed Power Resources before changing the PCI 190 * power state. 191 */ 192 ACPI_SERIAL_BEGIN(pci_powerstate); 193 old_state = pci_get_powerstate(child); 194 if (old_state < state && pci_do_power_suspend) { 195 error = pci_set_powerstate_method(dev, child, state); 196 if (error) 197 goto out; 198 } 199 h = acpi_get_handle(child); 200 status = acpi_pwr_switch_consumer(h, state); 201 if (ACPI_SUCCESS(status)) { 202 if (bootverbose) 203 device_printf(dev, "set ACPI power state D%d on %s\n", 204 state, acpi_name(h)); 205 } else if (status != AE_NOT_FOUND) 206 device_printf(dev, 207 "failed to set ACPI power state D%d on %s: %s\n", 208 state, acpi_name(h), AcpiFormatException(status)); 209 if (old_state > state && pci_do_power_resume) 210 error = pci_set_powerstate_method(dev, child, state); 211 212 out: 213 ACPI_SERIAL_END(pci_powerstate); 214 return (error); 215 } 216 217 static void 218 acpi_pci_update_device(ACPI_HANDLE handle, device_t pci_child) 219 { 220 ACPI_STATUS status; 221 device_t child; 222 223 /* 224 * Occasionally a PCI device may show up as an ACPI device 225 * with a _HID. (For example, the TabletPC TC1000 has a 226 * second PCI-ISA bridge that has a _HID for an 227 * acpi_sysresource device.) In that case, leave ACPI-CA's 228 * device data pointing at the ACPI-enumerated device. 229 */ 230 child = acpi_get_device(handle); 231 if (child != NULL) { 232 KASSERT(device_get_parent(child) == 233 devclass_get_device(devclass_find("acpi"), 0), 234 ("%s: child (%s)'s parent is not acpi0", __func__, 235 acpi_name(handle))); 236 return; 237 } 238 239 /* 240 * Update ACPI-CA to use the PCI enumerated device_t for this handle. 241 */ 242 status = AcpiAttachData(handle, acpi_fake_objhandler, pci_child); 243 if (ACPI_FAILURE(status)) 244 printf("WARNING: Unable to attach object data to %s - %s\n", 245 acpi_name(handle), AcpiFormatException(status)); 246 } 247 248 static ACPI_STATUS 249 acpi_pci_save_handle(ACPI_HANDLE handle, UINT32 level, void *context, 250 void **status) 251 { 252 struct acpi_pci_devinfo *dinfo; 253 device_t *devlist; 254 int devcount, i, func, slot; 255 UINT32 address; 256 257 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__); 258 259 if (ACPI_FAILURE(acpi_GetInteger(handle, "_ADR", &address))) 260 return_ACPI_STATUS (AE_OK); 261 slot = ACPI_ADR_PCI_SLOT(address); 262 func = ACPI_ADR_PCI_FUNC(address); 263 if (device_get_children((device_t)context, &devlist, &devcount) != 0) 264 return_ACPI_STATUS (AE_OK); 265 for (i = 0; i < devcount; i++) { 266 dinfo = device_get_ivars(devlist[i]); 267 if (dinfo->ap_dinfo.cfg.func == func && 268 dinfo->ap_dinfo.cfg.slot == slot) { 269 dinfo->ap_handle = handle; 270 acpi_pci_update_device(handle, devlist[i]); 271 break; 272 } 273 } 274 free(devlist, M_TEMP); 275 return_ACPI_STATUS (AE_OK); 276 } 277 278 static int 279 acpi_pci_probe(device_t dev) 280 { 281 282 if (acpi_get_handle(dev) == NULL) 283 return (ENXIO); 284 device_set_desc(dev, "ACPI PCI bus"); 285 return (BUS_PROBE_DEFAULT); 286 } 287 288 static int 289 acpi_pci_attach(device_t dev) 290 { 291 int busno, domain, error; 292 293 error = pci_attach_common(dev); 294 if (error) 295 return (error); 296 297 /* 298 * Since there can be multiple independantly numbered PCI 299 * busses on systems with multiple PCI domains, we can't use 300 * the unit number to decide which bus we are probing. We ask 301 * the parent pcib what our domain and bus numbers are. 302 */ 303 domain = pcib_get_domain(dev); 304 busno = pcib_get_bus(dev); 305 306 /* 307 * First, PCI devices are added as in the normal PCI bus driver. 308 * Afterwards, the ACPI namespace under the bridge driver is 309 * walked to save ACPI handles to all the devices that appear in 310 * the ACPI namespace as immediate descendants of the bridge. 311 * 312 * XXX: Sometimes PCI devices show up in the ACPI namespace that 313 * pci_add_children() doesn't find. We currently just ignore 314 * these devices. 315 */ 316 pci_add_children(dev, domain, busno, sizeof(struct acpi_pci_devinfo)); 317 AcpiWalkNamespace(ACPI_TYPE_DEVICE, acpi_get_handle(dev), 1, 318 acpi_pci_save_handle, NULL, dev, NULL); 319 320 return (bus_generic_attach(dev)); 321 } 322 323 #ifdef ACPI_DMAR 324 bus_dma_tag_t dmar_get_dma_tag(device_t dev, device_t child); 325 static bus_dma_tag_t 326 acpi_pci_get_dma_tag(device_t bus, device_t child) 327 { 328 bus_dma_tag_t tag; 329 330 if (device_get_parent(child) == bus) { 331 /* try dmar and return if it works */ 332 tag = dmar_get_dma_tag(bus, child); 333 } else 334 tag = NULL; 335 if (tag == NULL) 336 tag = pci_get_dma_tag(bus, child); 337 return (tag); 338 } 339 #else 340 static bus_dma_tag_t 341 acpi_pci_get_dma_tag(device_t bus, device_t child) 342 { 343 344 return (pci_get_dma_tag(bus, child)); 345 } 346 #endif 347