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 153 pci_child_location_str_method(cbdev, child, buf, buflen); 154 155 if (dinfo->ap_handle) { 156 strlcat(buf, " handle=", buflen); 157 strlcat(buf, acpi_name(dinfo->ap_handle), buflen); 158 } 159 return (0); 160 } 161 162 /* 163 * PCI power manangement 164 */ 165 static int 166 acpi_pci_set_powerstate_method(device_t dev, device_t child, int state) 167 { 168 ACPI_HANDLE h; 169 ACPI_STATUS status; 170 int old_state, error; 171 172 error = 0; 173 if (state < ACPI_STATE_D0 || state > ACPI_STATE_D3) 174 return (EINVAL); 175 176 /* 177 * We set the state using PCI Power Management outside of setting 178 * the ACPI state. This means that when powering down a device, we 179 * first shut it down using PCI, and then using ACPI, which lets ACPI 180 * try to power down any Power Resources that are now no longer used. 181 * When powering up a device, we let ACPI set the state first so that 182 * it can enable any needed Power Resources before changing the PCI 183 * power state. 184 */ 185 ACPI_SERIAL_BEGIN(pci_powerstate); 186 old_state = pci_get_powerstate(child); 187 if (old_state < state && pci_do_power_suspend) { 188 error = pci_set_powerstate_method(dev, child, state); 189 if (error) 190 goto out; 191 } 192 h = acpi_get_handle(child); 193 status = acpi_pwr_switch_consumer(h, state); 194 if (ACPI_SUCCESS(status)) { 195 if (bootverbose) 196 device_printf(dev, "set ACPI power state D%d on %s\n", 197 state, acpi_name(h)); 198 } else if (status != AE_NOT_FOUND) 199 device_printf(dev, 200 "failed to set ACPI power state D%d on %s: %s\n", 201 state, acpi_name(h), AcpiFormatException(status)); 202 if (old_state > state && pci_do_power_resume) 203 error = pci_set_powerstate_method(dev, child, state); 204 205 out: 206 ACPI_SERIAL_END(pci_powerstate); 207 return (error); 208 } 209 210 static void 211 acpi_pci_update_device(ACPI_HANDLE handle, device_t pci_child) 212 { 213 ACPI_STATUS status; 214 device_t child; 215 216 /* 217 * Occasionally a PCI device may show up as an ACPI device 218 * with a _HID. (For example, the TabletPC TC1000 has a 219 * second PCI-ISA bridge that has a _HID for an 220 * acpi_sysresource device.) In that case, leave ACPI-CA's 221 * device data pointing at the ACPI-enumerated device. 222 */ 223 child = acpi_get_device(handle); 224 if (child != NULL) { 225 KASSERT(device_get_parent(child) == 226 devclass_get_device(devclass_find("acpi"), 0), 227 ("%s: child (%s)'s parent is not acpi0", __func__, 228 acpi_name(handle))); 229 return; 230 } 231 232 /* 233 * Update ACPI-CA to use the PCI enumerated device_t for this handle. 234 */ 235 status = AcpiAttachData(handle, acpi_fake_objhandler, pci_child); 236 if (ACPI_FAILURE(status)) 237 printf("WARNING: Unable to attach object data to %s - %s\n", 238 acpi_name(handle), AcpiFormatException(status)); 239 } 240 241 static ACPI_STATUS 242 acpi_pci_save_handle(ACPI_HANDLE handle, UINT32 level, void *context, 243 void **status) 244 { 245 struct acpi_pci_devinfo *dinfo; 246 device_t *devlist; 247 int devcount, i, func, slot; 248 UINT32 address; 249 250 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__); 251 252 if (ACPI_FAILURE(acpi_GetInteger(handle, "_ADR", &address))) 253 return_ACPI_STATUS (AE_OK); 254 slot = ACPI_ADR_PCI_SLOT(address); 255 func = ACPI_ADR_PCI_FUNC(address); 256 if (device_get_children((device_t)context, &devlist, &devcount) != 0) 257 return_ACPI_STATUS (AE_OK); 258 for (i = 0; i < devcount; i++) { 259 dinfo = device_get_ivars(devlist[i]); 260 if (dinfo->ap_dinfo.cfg.func == func && 261 dinfo->ap_dinfo.cfg.slot == slot) { 262 dinfo->ap_handle = handle; 263 acpi_pci_update_device(handle, devlist[i]); 264 break; 265 } 266 } 267 free(devlist, M_TEMP); 268 return_ACPI_STATUS (AE_OK); 269 } 270 271 static int 272 acpi_pci_probe(device_t dev) 273 { 274 275 if (acpi_get_handle(dev) == NULL) 276 return (ENXIO); 277 device_set_desc(dev, "ACPI PCI bus"); 278 return (0); 279 } 280 281 static int 282 acpi_pci_attach(device_t dev) 283 { 284 int busno, domain, error; 285 286 error = pci_attach_common(dev); 287 if (error) 288 return (error); 289 290 /* 291 * Since there can be multiple independantly numbered PCI 292 * busses on systems with multiple PCI domains, we can't use 293 * the unit number to decide which bus we are probing. We ask 294 * the parent pcib what our domain and bus numbers are. 295 */ 296 domain = pcib_get_domain(dev); 297 busno = pcib_get_bus(dev); 298 299 /* 300 * First, PCI devices are added as in the normal PCI bus driver. 301 * Afterwards, the ACPI namespace under the bridge driver is 302 * walked to save ACPI handles to all the devices that appear in 303 * the ACPI namespace as immediate descendants of the bridge. 304 * 305 * XXX: Sometimes PCI devices show up in the ACPI namespace that 306 * pci_add_children() doesn't find. We currently just ignore 307 * these devices. 308 */ 309 pci_add_children(dev, domain, busno, sizeof(struct acpi_pci_devinfo)); 310 AcpiWalkNamespace(ACPI_TYPE_DEVICE, acpi_get_handle(dev), 1, 311 acpi_pci_save_handle, NULL, dev, NULL); 312 313 return (bus_generic_attach(dev)); 314 } 315 316 #ifdef ACPI_DMAR 317 bus_dma_tag_t dmar_get_dma_tag(device_t dev, device_t child); 318 static bus_dma_tag_t 319 acpi_pci_get_dma_tag(device_t bus, device_t child) 320 { 321 bus_dma_tag_t tag; 322 323 if (device_get_parent(child) == bus) { 324 /* try dmar and return if it works */ 325 tag = dmar_get_dma_tag(bus, child); 326 } else 327 tag = NULL; 328 if (tag == NULL) 329 tag = pci_get_dma_tag(bus, child); 330 return (tag); 331 } 332 #else 333 static bus_dma_tag_t 334 acpi_pci_get_dma_tag(device_t bus, device_t child) 335 { 336 337 return (pci_get_dma_tag(bus, child)); 338 } 339 #endif 340