1 /*- 2 * Copyright (c) 2000 Takanori Watanabe <takawata@jp.freebsd.org> 3 * Copyright (c) 2000 Mitsuru IWASAKI <iwasaki@jp.freebsd.org> 4 * Copyright (c) 2000, 2001 Michael Smith 5 * Copyright (c) 2000 BSDi 6 * All rights reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following 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 AND CONTRIBUTORS ``AS IS'' AND 18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27 * SUCH DAMAGE. 28 */ 29 30 #include <sys/cdefs.h> 31 __FBSDID("$FreeBSD$"); 32 33 #include "opt_acpi.h" 34 35 #include <sys/param.h> 36 #include <sys/kernel.h> 37 #include <sys/proc.h> 38 #include <sys/fcntl.h> 39 #include <sys/malloc.h> 40 #include <sys/module.h> 41 #include <sys/bus.h> 42 #include <sys/conf.h> 43 #include <sys/ioccom.h> 44 #include <sys/reboot.h> 45 #include <sys/sysctl.h> 46 #include <sys/ctype.h> 47 #include <sys/linker.h> 48 #include <sys/power.h> 49 #include <sys/sbuf.h> 50 #include <sys/sched.h> 51 #include <sys/smp.h> 52 #include <sys/timetc.h> 53 54 #if defined(__i386__) || defined(__amd64__) 55 #include <machine/clock.h> 56 #include <machine/pci_cfgreg.h> 57 #endif 58 #include <machine/resource.h> 59 #include <machine/bus.h> 60 #include <sys/rman.h> 61 #include <isa/isavar.h> 62 #include <isa/pnpvar.h> 63 64 #include <contrib/dev/acpica/include/acpi.h> 65 #include <contrib/dev/acpica/include/accommon.h> 66 #include <contrib/dev/acpica/include/acnamesp.h> 67 68 #include <dev/acpica/acpivar.h> 69 #include <dev/acpica/acpiio.h> 70 71 #include <dev/pci/pcivar.h> 72 73 #include <vm/vm_param.h> 74 75 static MALLOC_DEFINE(M_ACPIDEV, "acpidev", "ACPI devices"); 76 77 /* Hooks for the ACPI CA debugging infrastructure */ 78 #define _COMPONENT ACPI_BUS 79 ACPI_MODULE_NAME("ACPI") 80 81 static d_open_t acpiopen; 82 static d_close_t acpiclose; 83 static d_ioctl_t acpiioctl; 84 85 static struct cdevsw acpi_cdevsw = { 86 .d_version = D_VERSION, 87 .d_open = acpiopen, 88 .d_close = acpiclose, 89 .d_ioctl = acpiioctl, 90 .d_name = "acpi", 91 }; 92 93 struct acpi_interface { 94 ACPI_STRING *data; 95 int num; 96 }; 97 98 static char *sysres_ids[] = { "PNP0C01", "PNP0C02", NULL }; 99 static char *pcilink_ids[] = { "PNP0C0F", NULL }; 100 101 /* Global mutex for locking access to the ACPI subsystem. */ 102 struct mtx acpi_mutex; 103 struct callout acpi_sleep_timer; 104 105 /* Bitmap of device quirks. */ 106 int acpi_quirks; 107 108 /* Supported sleep states. */ 109 static BOOLEAN acpi_sleep_states[ACPI_S_STATE_COUNT]; 110 111 static void acpi_lookup(void *arg, const char *name, device_t *dev); 112 static int acpi_modevent(struct module *mod, int event, void *junk); 113 static int acpi_probe(device_t dev); 114 static int acpi_attach(device_t dev); 115 static int acpi_suspend(device_t dev); 116 static int acpi_resume(device_t dev); 117 static int acpi_shutdown(device_t dev); 118 static device_t acpi_add_child(device_t bus, u_int order, const char *name, 119 int unit); 120 static int acpi_print_child(device_t bus, device_t child); 121 static void acpi_probe_nomatch(device_t bus, device_t child); 122 static void acpi_driver_added(device_t dev, driver_t *driver); 123 static int acpi_read_ivar(device_t dev, device_t child, int index, 124 uintptr_t *result); 125 static int acpi_write_ivar(device_t dev, device_t child, int index, 126 uintptr_t value); 127 static struct resource_list *acpi_get_rlist(device_t dev, device_t child); 128 static void acpi_reserve_resources(device_t dev); 129 static int acpi_sysres_alloc(device_t dev); 130 static int acpi_set_resource(device_t dev, device_t child, int type, 131 int rid, rman_res_t start, rman_res_t count); 132 static struct resource *acpi_alloc_resource(device_t bus, device_t child, 133 int type, int *rid, rman_res_t start, rman_res_t end, 134 rman_res_t count, u_int flags); 135 static int acpi_adjust_resource(device_t bus, device_t child, int type, 136 struct resource *r, rman_res_t start, rman_res_t end); 137 static int acpi_release_resource(device_t bus, device_t child, int type, 138 int rid, struct resource *r); 139 static void acpi_delete_resource(device_t bus, device_t child, int type, 140 int rid); 141 static uint32_t acpi_isa_get_logicalid(device_t dev); 142 static int acpi_isa_get_compatid(device_t dev, uint32_t *cids, int count); 143 static int acpi_device_id_probe(device_t bus, device_t dev, char **ids, char **match); 144 static ACPI_STATUS acpi_device_eval_obj(device_t bus, device_t dev, 145 ACPI_STRING pathname, ACPI_OBJECT_LIST *parameters, 146 ACPI_BUFFER *ret); 147 static ACPI_STATUS acpi_device_scan_cb(ACPI_HANDLE h, UINT32 level, 148 void *context, void **retval); 149 static ACPI_STATUS acpi_device_scan_children(device_t bus, device_t dev, 150 int max_depth, acpi_scan_cb_t user_fn, void *arg); 151 static int acpi_set_powerstate(device_t child, int state); 152 static int acpi_isa_pnp_probe(device_t bus, device_t child, 153 struct isa_pnp_id *ids); 154 static void acpi_probe_children(device_t bus); 155 static void acpi_probe_order(ACPI_HANDLE handle, int *order); 156 static ACPI_STATUS acpi_probe_child(ACPI_HANDLE handle, UINT32 level, 157 void *context, void **status); 158 static void acpi_sleep_enable(void *arg); 159 static ACPI_STATUS acpi_sleep_disable(struct acpi_softc *sc); 160 static ACPI_STATUS acpi_EnterSleepState(struct acpi_softc *sc, int state); 161 static void acpi_shutdown_final(void *arg, int howto); 162 static void acpi_enable_fixed_events(struct acpi_softc *sc); 163 static BOOLEAN acpi_has_hid(ACPI_HANDLE handle); 164 static void acpi_resync_clock(struct acpi_softc *sc); 165 static int acpi_wake_sleep_prep(ACPI_HANDLE handle, int sstate); 166 static int acpi_wake_run_prep(ACPI_HANDLE handle, int sstate); 167 static int acpi_wake_prep_walk(int sstate); 168 static int acpi_wake_sysctl_walk(device_t dev); 169 static int acpi_wake_set_sysctl(SYSCTL_HANDLER_ARGS); 170 static void acpi_system_eventhandler_sleep(void *arg, int state); 171 static void acpi_system_eventhandler_wakeup(void *arg, int state); 172 static int acpi_sname2sstate(const char *sname); 173 static const char *acpi_sstate2sname(int sstate); 174 static int acpi_supported_sleep_state_sysctl(SYSCTL_HANDLER_ARGS); 175 static int acpi_sleep_state_sysctl(SYSCTL_HANDLER_ARGS); 176 static int acpi_debug_objects_sysctl(SYSCTL_HANDLER_ARGS); 177 static int acpi_pm_func(u_long cmd, void *arg, ...); 178 static int acpi_child_location_str_method(device_t acdev, device_t child, 179 char *buf, size_t buflen); 180 static int acpi_child_pnpinfo_str_method(device_t acdev, device_t child, 181 char *buf, size_t buflen); 182 #if defined(__i386__) || defined(__amd64__) 183 static void acpi_enable_pcie(void); 184 #endif 185 static void acpi_hint_device_unit(device_t acdev, device_t child, 186 const char *name, int *unitp); 187 static void acpi_reset_interfaces(device_t dev); 188 189 static device_method_t acpi_methods[] = { 190 /* Device interface */ 191 DEVMETHOD(device_probe, acpi_probe), 192 DEVMETHOD(device_attach, acpi_attach), 193 DEVMETHOD(device_shutdown, acpi_shutdown), 194 DEVMETHOD(device_detach, bus_generic_detach), 195 DEVMETHOD(device_suspend, acpi_suspend), 196 DEVMETHOD(device_resume, acpi_resume), 197 198 /* Bus interface */ 199 DEVMETHOD(bus_add_child, acpi_add_child), 200 DEVMETHOD(bus_print_child, acpi_print_child), 201 DEVMETHOD(bus_probe_nomatch, acpi_probe_nomatch), 202 DEVMETHOD(bus_driver_added, acpi_driver_added), 203 DEVMETHOD(bus_read_ivar, acpi_read_ivar), 204 DEVMETHOD(bus_write_ivar, acpi_write_ivar), 205 DEVMETHOD(bus_get_resource_list, acpi_get_rlist), 206 DEVMETHOD(bus_set_resource, acpi_set_resource), 207 DEVMETHOD(bus_get_resource, bus_generic_rl_get_resource), 208 DEVMETHOD(bus_alloc_resource, acpi_alloc_resource), 209 DEVMETHOD(bus_adjust_resource, acpi_adjust_resource), 210 DEVMETHOD(bus_release_resource, acpi_release_resource), 211 DEVMETHOD(bus_delete_resource, acpi_delete_resource), 212 DEVMETHOD(bus_child_pnpinfo_str, acpi_child_pnpinfo_str_method), 213 DEVMETHOD(bus_child_location_str, acpi_child_location_str_method), 214 DEVMETHOD(bus_activate_resource, bus_generic_activate_resource), 215 DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource), 216 DEVMETHOD(bus_setup_intr, bus_generic_setup_intr), 217 DEVMETHOD(bus_teardown_intr, bus_generic_teardown_intr), 218 DEVMETHOD(bus_hint_device_unit, acpi_hint_device_unit), 219 DEVMETHOD(bus_get_cpus, acpi_get_cpus), 220 DEVMETHOD(bus_get_domain, acpi_get_domain), 221 222 /* ACPI bus */ 223 DEVMETHOD(acpi_id_probe, acpi_device_id_probe), 224 DEVMETHOD(acpi_evaluate_object, acpi_device_eval_obj), 225 DEVMETHOD(acpi_pwr_for_sleep, acpi_device_pwr_for_sleep), 226 DEVMETHOD(acpi_scan_children, acpi_device_scan_children), 227 228 /* ISA emulation */ 229 DEVMETHOD(isa_pnp_probe, acpi_isa_pnp_probe), 230 231 DEVMETHOD_END 232 }; 233 234 static driver_t acpi_driver = { 235 "acpi", 236 acpi_methods, 237 sizeof(struct acpi_softc), 238 }; 239 240 static devclass_t acpi_devclass; 241 DRIVER_MODULE(acpi, nexus, acpi_driver, acpi_devclass, acpi_modevent, 0); 242 MODULE_VERSION(acpi, 1); 243 244 ACPI_SERIAL_DECL(acpi, "ACPI root bus"); 245 246 /* Local pools for managing system resources for ACPI child devices. */ 247 static struct rman acpi_rman_io, acpi_rman_mem; 248 249 #define ACPI_MINIMUM_AWAKETIME 5 250 251 /* Holds the description of the acpi0 device. */ 252 static char acpi_desc[ACPI_OEM_ID_SIZE + ACPI_OEM_TABLE_ID_SIZE + 2]; 253 254 SYSCTL_NODE(_debug, OID_AUTO, acpi, CTLFLAG_RD, NULL, "ACPI debugging"); 255 static char acpi_ca_version[12]; 256 SYSCTL_STRING(_debug_acpi, OID_AUTO, acpi_ca_version, CTLFLAG_RD, 257 acpi_ca_version, 0, "Version of Intel ACPI-CA"); 258 259 /* 260 * Allow overriding _OSI methods. 261 */ 262 static char acpi_install_interface[256]; 263 TUNABLE_STR("hw.acpi.install_interface", acpi_install_interface, 264 sizeof(acpi_install_interface)); 265 static char acpi_remove_interface[256]; 266 TUNABLE_STR("hw.acpi.remove_interface", acpi_remove_interface, 267 sizeof(acpi_remove_interface)); 268 269 /* Allow users to dump Debug objects without ACPI debugger. */ 270 static int acpi_debug_objects; 271 TUNABLE_INT("debug.acpi.enable_debug_objects", &acpi_debug_objects); 272 SYSCTL_PROC(_debug_acpi, OID_AUTO, enable_debug_objects, 273 CTLFLAG_RW | CTLTYPE_INT, NULL, 0, acpi_debug_objects_sysctl, "I", 274 "Enable Debug objects"); 275 276 /* Allow the interpreter to ignore common mistakes in BIOS. */ 277 static int acpi_interpreter_slack = 1; 278 TUNABLE_INT("debug.acpi.interpreter_slack", &acpi_interpreter_slack); 279 SYSCTL_INT(_debug_acpi, OID_AUTO, interpreter_slack, CTLFLAG_RDTUN, 280 &acpi_interpreter_slack, 1, "Turn on interpreter slack mode."); 281 282 /* Ignore register widths set by FADT and use default widths instead. */ 283 static int acpi_ignore_reg_width = 1; 284 TUNABLE_INT("debug.acpi.default_register_width", &acpi_ignore_reg_width); 285 SYSCTL_INT(_debug_acpi, OID_AUTO, default_register_width, CTLFLAG_RDTUN, 286 &acpi_ignore_reg_width, 1, "Ignore register widths set by FADT"); 287 288 /* Allow users to override quirks. */ 289 TUNABLE_INT("debug.acpi.quirks", &acpi_quirks); 290 291 int acpi_susp_bounce; 292 SYSCTL_INT(_debug_acpi, OID_AUTO, suspend_bounce, CTLFLAG_RW, 293 &acpi_susp_bounce, 0, "Don't actually suspend, just test devices."); 294 295 /* 296 * ACPI can only be loaded as a module by the loader; activating it after 297 * system bootstrap time is not useful, and can be fatal to the system. 298 * It also cannot be unloaded, since the entire system bus hierarchy hangs 299 * off it. 300 */ 301 static int 302 acpi_modevent(struct module *mod, int event, void *junk) 303 { 304 switch (event) { 305 case MOD_LOAD: 306 if (!cold) { 307 printf("The ACPI driver cannot be loaded after boot.\n"); 308 return (EPERM); 309 } 310 break; 311 case MOD_UNLOAD: 312 if (!cold && power_pm_get_type() == POWER_PM_TYPE_ACPI) 313 return (EBUSY); 314 break; 315 default: 316 break; 317 } 318 return (0); 319 } 320 321 /* 322 * Perform early initialization. 323 */ 324 ACPI_STATUS 325 acpi_Startup(void) 326 { 327 static int started = 0; 328 ACPI_STATUS status; 329 int val; 330 331 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__); 332 333 /* Only run the startup code once. The MADT driver also calls this. */ 334 if (started) 335 return_VALUE (AE_OK); 336 started = 1; 337 338 /* 339 * Initialize the ACPICA subsystem. 340 */ 341 if (ACPI_FAILURE(status = AcpiInitializeSubsystem())) { 342 printf("ACPI: Could not initialize Subsystem: %s\n", 343 AcpiFormatException(status)); 344 return_VALUE (status); 345 } 346 347 /* 348 * Pre-allocate space for RSDT/XSDT and DSDT tables and allow resizing 349 * if more tables exist. 350 */ 351 if (ACPI_FAILURE(status = AcpiInitializeTables(NULL, 2, TRUE))) { 352 printf("ACPI: Table initialisation failed: %s\n", 353 AcpiFormatException(status)); 354 return_VALUE (status); 355 } 356 357 /* Set up any quirks we have for this system. */ 358 if (acpi_quirks == ACPI_Q_OK) 359 acpi_table_quirks(&acpi_quirks); 360 361 /* If the user manually set the disabled hint to 0, force-enable ACPI. */ 362 if (resource_int_value("acpi", 0, "disabled", &val) == 0 && val == 0) 363 acpi_quirks &= ~ACPI_Q_BROKEN; 364 if (acpi_quirks & ACPI_Q_BROKEN) { 365 printf("ACPI disabled by blacklist. Contact your BIOS vendor.\n"); 366 status = AE_SUPPORT; 367 } 368 369 return_VALUE (status); 370 } 371 372 /* 373 * Detect ACPI and perform early initialisation. 374 */ 375 int 376 acpi_identify(void) 377 { 378 ACPI_TABLE_RSDP *rsdp; 379 ACPI_TABLE_HEADER *rsdt; 380 ACPI_PHYSICAL_ADDRESS paddr; 381 struct sbuf sb; 382 383 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__); 384 385 if (!cold) 386 return (ENXIO); 387 388 /* Check that we haven't been disabled with a hint. */ 389 if (resource_disabled("acpi", 0)) 390 return (ENXIO); 391 392 /* Check for other PM systems. */ 393 if (power_pm_get_type() != POWER_PM_TYPE_NONE && 394 power_pm_get_type() != POWER_PM_TYPE_ACPI) { 395 printf("ACPI identify failed, other PM system enabled.\n"); 396 return (ENXIO); 397 } 398 399 /* Initialize root tables. */ 400 if (ACPI_FAILURE(acpi_Startup())) { 401 printf("ACPI: Try disabling either ACPI or apic support.\n"); 402 return (ENXIO); 403 } 404 405 if ((paddr = AcpiOsGetRootPointer()) == 0 || 406 (rsdp = AcpiOsMapMemory(paddr, sizeof(ACPI_TABLE_RSDP))) == NULL) 407 return (ENXIO); 408 if (rsdp->Revision > 1 && rsdp->XsdtPhysicalAddress != 0) 409 paddr = (ACPI_PHYSICAL_ADDRESS)rsdp->XsdtPhysicalAddress; 410 else 411 paddr = (ACPI_PHYSICAL_ADDRESS)rsdp->RsdtPhysicalAddress; 412 AcpiOsUnmapMemory(rsdp, sizeof(ACPI_TABLE_RSDP)); 413 414 if ((rsdt = AcpiOsMapMemory(paddr, sizeof(ACPI_TABLE_HEADER))) == NULL) 415 return (ENXIO); 416 sbuf_new(&sb, acpi_desc, sizeof(acpi_desc), SBUF_FIXEDLEN); 417 sbuf_bcat(&sb, rsdt->OemId, ACPI_OEM_ID_SIZE); 418 sbuf_trim(&sb); 419 sbuf_putc(&sb, ' '); 420 sbuf_bcat(&sb, rsdt->OemTableId, ACPI_OEM_TABLE_ID_SIZE); 421 sbuf_trim(&sb); 422 sbuf_finish(&sb); 423 sbuf_delete(&sb); 424 AcpiOsUnmapMemory(rsdt, sizeof(ACPI_TABLE_HEADER)); 425 426 snprintf(acpi_ca_version, sizeof(acpi_ca_version), "%x", ACPI_CA_VERSION); 427 428 return (0); 429 } 430 431 /* 432 * Fetch some descriptive data from ACPI to put in our attach message. 433 */ 434 static int 435 acpi_probe(device_t dev) 436 { 437 438 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__); 439 440 device_set_desc(dev, acpi_desc); 441 442 return_VALUE (BUS_PROBE_NOWILDCARD); 443 } 444 445 static int 446 acpi_attach(device_t dev) 447 { 448 struct acpi_softc *sc; 449 ACPI_STATUS status; 450 int error, state; 451 UINT32 flags; 452 UINT8 TypeA, TypeB; 453 char *env; 454 455 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__); 456 457 sc = device_get_softc(dev); 458 sc->acpi_dev = dev; 459 callout_init(&sc->susp_force_to, 1); 460 461 error = ENXIO; 462 463 /* Initialize resource manager. */ 464 acpi_rman_io.rm_type = RMAN_ARRAY; 465 acpi_rman_io.rm_start = 0; 466 acpi_rman_io.rm_end = 0xffff; 467 acpi_rman_io.rm_descr = "ACPI I/O ports"; 468 if (rman_init(&acpi_rman_io) != 0) 469 panic("acpi rman_init IO ports failed"); 470 acpi_rman_mem.rm_type = RMAN_ARRAY; 471 acpi_rman_mem.rm_descr = "ACPI I/O memory addresses"; 472 if (rman_init(&acpi_rman_mem) != 0) 473 panic("acpi rman_init memory failed"); 474 475 /* Initialise the ACPI mutex */ 476 mtx_init(&acpi_mutex, "ACPI global lock", NULL, MTX_DEF); 477 478 /* 479 * Set the globals from our tunables. This is needed because ACPI-CA 480 * uses UINT8 for some values and we have no tunable_byte. 481 */ 482 AcpiGbl_EnableInterpreterSlack = acpi_interpreter_slack ? TRUE : FALSE; 483 AcpiGbl_EnableAmlDebugObject = acpi_debug_objects ? TRUE : FALSE; 484 AcpiGbl_UseDefaultRegisterWidths = acpi_ignore_reg_width ? TRUE : FALSE; 485 486 #ifndef ACPI_DEBUG 487 /* 488 * Disable all debugging layers and levels. 489 */ 490 AcpiDbgLayer = 0; 491 AcpiDbgLevel = 0; 492 #endif 493 494 /* Override OS interfaces if the user requested. */ 495 acpi_reset_interfaces(dev); 496 497 /* Load ACPI name space. */ 498 status = AcpiLoadTables(); 499 if (ACPI_FAILURE(status)) { 500 device_printf(dev, "Could not load Namespace: %s\n", 501 AcpiFormatException(status)); 502 goto out; 503 } 504 505 #if defined(__i386__) || defined(__amd64__) 506 /* Handle MCFG table if present. */ 507 acpi_enable_pcie(); 508 #endif 509 510 /* 511 * Note that some systems (specifically, those with namespace evaluation 512 * issues that require the avoidance of parts of the namespace) must 513 * avoid running _INI and _STA on everything, as well as dodging the final 514 * object init pass. 515 * 516 * For these devices, we set ACPI_NO_DEVICE_INIT and ACPI_NO_OBJECT_INIT). 517 * 518 * XXX We should arrange for the object init pass after we have attached 519 * all our child devices, but on many systems it works here. 520 */ 521 flags = 0; 522 if (testenv("debug.acpi.avoid")) 523 flags = ACPI_NO_DEVICE_INIT | ACPI_NO_OBJECT_INIT; 524 525 /* Bring the hardware and basic handlers online. */ 526 if (ACPI_FAILURE(status = AcpiEnableSubsystem(flags))) { 527 device_printf(dev, "Could not enable ACPI: %s\n", 528 AcpiFormatException(status)); 529 goto out; 530 } 531 532 /* 533 * Call the ECDT probe function to provide EC functionality before 534 * the namespace has been evaluated. 535 * 536 * XXX This happens before the sysresource devices have been probed and 537 * attached so its resources come from nexus0. In practice, this isn't 538 * a problem but should be addressed eventually. 539 */ 540 acpi_ec_ecdt_probe(dev); 541 542 /* Bring device objects and regions online. */ 543 if (ACPI_FAILURE(status = AcpiInitializeObjects(flags))) { 544 device_printf(dev, "Could not initialize ACPI objects: %s\n", 545 AcpiFormatException(status)); 546 goto out; 547 } 548 549 /* 550 * Setup our sysctl tree. 551 * 552 * XXX: This doesn't check to make sure that none of these fail. 553 */ 554 sysctl_ctx_init(&sc->acpi_sysctl_ctx); 555 sc->acpi_sysctl_tree = SYSCTL_ADD_NODE(&sc->acpi_sysctl_ctx, 556 SYSCTL_STATIC_CHILDREN(_hw), OID_AUTO, 557 device_get_name(dev), CTLFLAG_RD, 0, ""); 558 SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree), 559 OID_AUTO, "supported_sleep_state", CTLTYPE_STRING | CTLFLAG_RD, 560 0, 0, acpi_supported_sleep_state_sysctl, "A", 561 "List supported ACPI sleep states."); 562 SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree), 563 OID_AUTO, "power_button_state", CTLTYPE_STRING | CTLFLAG_RW, 564 &sc->acpi_power_button_sx, 0, acpi_sleep_state_sysctl, "A", 565 "Power button ACPI sleep state."); 566 SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree), 567 OID_AUTO, "sleep_button_state", CTLTYPE_STRING | CTLFLAG_RW, 568 &sc->acpi_sleep_button_sx, 0, acpi_sleep_state_sysctl, "A", 569 "Sleep button ACPI sleep state."); 570 SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree), 571 OID_AUTO, "lid_switch_state", CTLTYPE_STRING | CTLFLAG_RW, 572 &sc->acpi_lid_switch_sx, 0, acpi_sleep_state_sysctl, "A", 573 "Lid ACPI sleep state. Set to S3 if you want to suspend your laptop when close the Lid."); 574 SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree), 575 OID_AUTO, "standby_state", CTLTYPE_STRING | CTLFLAG_RW, 576 &sc->acpi_standby_sx, 0, acpi_sleep_state_sysctl, "A", ""); 577 SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree), 578 OID_AUTO, "suspend_state", CTLTYPE_STRING | CTLFLAG_RW, 579 &sc->acpi_suspend_sx, 0, acpi_sleep_state_sysctl, "A", ""); 580 SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree), 581 OID_AUTO, "sleep_delay", CTLFLAG_RW, &sc->acpi_sleep_delay, 0, 582 "sleep delay in seconds"); 583 SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree), 584 OID_AUTO, "s4bios", CTLFLAG_RW, &sc->acpi_s4bios, 0, "S4BIOS mode"); 585 SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree), 586 OID_AUTO, "verbose", CTLFLAG_RW, &sc->acpi_verbose, 0, "verbose mode"); 587 SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree), 588 OID_AUTO, "disable_on_reboot", CTLFLAG_RW, 589 &sc->acpi_do_disable, 0, "Disable ACPI when rebooting/halting system"); 590 SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree), 591 OID_AUTO, "handle_reboot", CTLFLAG_RW, 592 &sc->acpi_handle_reboot, 0, "Use ACPI Reset Register to reboot"); 593 594 /* 595 * Default to 1 second before sleeping to give some machines time to 596 * stabilize. 597 */ 598 sc->acpi_sleep_delay = 1; 599 if (bootverbose) 600 sc->acpi_verbose = 1; 601 if ((env = kern_getenv("hw.acpi.verbose")) != NULL) { 602 if (strcmp(env, "0") != 0) 603 sc->acpi_verbose = 1; 604 freeenv(env); 605 } 606 607 /* Only enable reboot by default if the FADT says it is available. */ 608 if (AcpiGbl_FADT.Flags & ACPI_FADT_RESET_REGISTER) 609 sc->acpi_handle_reboot = 1; 610 611 #if !ACPI_REDUCED_HARDWARE 612 /* Only enable S4BIOS by default if the FACS says it is available. */ 613 if (AcpiGbl_FACS != NULL && AcpiGbl_FACS->Flags & ACPI_FACS_S4_BIOS_PRESENT) 614 sc->acpi_s4bios = 1; 615 #endif 616 617 /* Probe all supported sleep states. */ 618 acpi_sleep_states[ACPI_STATE_S0] = TRUE; 619 for (state = ACPI_STATE_S1; state < ACPI_S_STATE_COUNT; state++) 620 if (ACPI_SUCCESS(AcpiEvaluateObject(ACPI_ROOT_OBJECT, 621 __DECONST(char *, AcpiGbl_SleepStateNames[state]), NULL, NULL)) && 622 ACPI_SUCCESS(AcpiGetSleepTypeData(state, &TypeA, &TypeB))) 623 acpi_sleep_states[state] = TRUE; 624 625 /* 626 * Dispatch the default sleep state to devices. The lid switch is set 627 * to UNKNOWN by default to avoid surprising users. 628 */ 629 sc->acpi_power_button_sx = acpi_sleep_states[ACPI_STATE_S5] ? 630 ACPI_STATE_S5 : ACPI_STATE_UNKNOWN; 631 sc->acpi_lid_switch_sx = ACPI_STATE_UNKNOWN; 632 sc->acpi_standby_sx = acpi_sleep_states[ACPI_STATE_S1] ? 633 ACPI_STATE_S1 : ACPI_STATE_UNKNOWN; 634 sc->acpi_suspend_sx = acpi_sleep_states[ACPI_STATE_S3] ? 635 ACPI_STATE_S3 : ACPI_STATE_UNKNOWN; 636 637 /* Pick the first valid sleep state for the sleep button default. */ 638 sc->acpi_sleep_button_sx = ACPI_STATE_UNKNOWN; 639 for (state = ACPI_STATE_S1; state <= ACPI_STATE_S4; state++) 640 if (acpi_sleep_states[state]) { 641 sc->acpi_sleep_button_sx = state; 642 break; 643 } 644 645 acpi_enable_fixed_events(sc); 646 647 /* 648 * Scan the namespace and attach/initialise children. 649 */ 650 651 /* Register our shutdown handler. */ 652 EVENTHANDLER_REGISTER(shutdown_final, acpi_shutdown_final, sc, 653 SHUTDOWN_PRI_LAST); 654 655 /* 656 * Register our acpi event handlers. 657 * XXX should be configurable eg. via userland policy manager. 658 */ 659 EVENTHANDLER_REGISTER(acpi_sleep_event, acpi_system_eventhandler_sleep, 660 sc, ACPI_EVENT_PRI_LAST); 661 EVENTHANDLER_REGISTER(acpi_wakeup_event, acpi_system_eventhandler_wakeup, 662 sc, ACPI_EVENT_PRI_LAST); 663 664 /* Flag our initial states. */ 665 sc->acpi_enabled = TRUE; 666 sc->acpi_sstate = ACPI_STATE_S0; 667 sc->acpi_sleep_disabled = TRUE; 668 669 /* Create the control device */ 670 sc->acpi_dev_t = make_dev(&acpi_cdevsw, 0, UID_ROOT, GID_OPERATOR, 0664, 671 "acpi"); 672 sc->acpi_dev_t->si_drv1 = sc; 673 674 if ((error = acpi_machdep_init(dev))) 675 goto out; 676 677 /* Register ACPI again to pass the correct argument of pm_func. */ 678 power_pm_register(POWER_PM_TYPE_ACPI, acpi_pm_func, sc); 679 680 if (!acpi_disabled("bus")) { 681 EVENTHANDLER_REGISTER(dev_lookup, acpi_lookup, NULL, 1000); 682 acpi_probe_children(dev); 683 } 684 685 /* Update all GPEs and enable runtime GPEs. */ 686 status = AcpiUpdateAllGpes(); 687 if (ACPI_FAILURE(status)) 688 device_printf(dev, "Could not update all GPEs: %s\n", 689 AcpiFormatException(status)); 690 691 /* Allow sleep request after a while. */ 692 callout_init_mtx(&acpi_sleep_timer, &acpi_mutex, 0); 693 callout_reset(&acpi_sleep_timer, hz * ACPI_MINIMUM_AWAKETIME, 694 acpi_sleep_enable, sc); 695 696 error = 0; 697 698 out: 699 return_VALUE (error); 700 } 701 702 static void 703 acpi_set_power_children(device_t dev, int state) 704 { 705 device_t child; 706 device_t *devlist; 707 int dstate, i, numdevs; 708 709 if (device_get_children(dev, &devlist, &numdevs) != 0) 710 return; 711 712 /* 713 * Retrieve and set D-state for the sleep state if _SxD is present. 714 * Skip children who aren't attached since they are handled separately. 715 */ 716 for (i = 0; i < numdevs; i++) { 717 child = devlist[i]; 718 dstate = state; 719 if (device_is_attached(child) && 720 acpi_device_pwr_for_sleep(dev, child, &dstate) == 0) 721 acpi_set_powerstate(child, dstate); 722 } 723 free(devlist, M_TEMP); 724 } 725 726 static int 727 acpi_suspend(device_t dev) 728 { 729 int error; 730 731 GIANT_REQUIRED; 732 733 error = bus_generic_suspend(dev); 734 if (error == 0) 735 acpi_set_power_children(dev, ACPI_STATE_D3); 736 737 return (error); 738 } 739 740 static int 741 acpi_resume(device_t dev) 742 { 743 744 GIANT_REQUIRED; 745 746 acpi_set_power_children(dev, ACPI_STATE_D0); 747 748 return (bus_generic_resume(dev)); 749 } 750 751 static int 752 acpi_shutdown(device_t dev) 753 { 754 755 GIANT_REQUIRED; 756 757 /* Allow children to shutdown first. */ 758 bus_generic_shutdown(dev); 759 760 /* 761 * Enable any GPEs that are able to power-on the system (i.e., RTC). 762 * Also, disable any that are not valid for this state (most). 763 */ 764 acpi_wake_prep_walk(ACPI_STATE_S5); 765 766 return (0); 767 } 768 769 /* 770 * Handle a new device being added 771 */ 772 static device_t 773 acpi_add_child(device_t bus, u_int order, const char *name, int unit) 774 { 775 struct acpi_device *ad; 776 device_t child; 777 778 if ((ad = malloc(sizeof(*ad), M_ACPIDEV, M_NOWAIT | M_ZERO)) == NULL) 779 return (NULL); 780 781 resource_list_init(&ad->ad_rl); 782 783 child = device_add_child_ordered(bus, order, name, unit); 784 if (child != NULL) 785 device_set_ivars(child, ad); 786 else 787 free(ad, M_ACPIDEV); 788 return (child); 789 } 790 791 static int 792 acpi_print_child(device_t bus, device_t child) 793 { 794 struct acpi_device *adev = device_get_ivars(child); 795 struct resource_list *rl = &adev->ad_rl; 796 int retval = 0; 797 798 retval += bus_print_child_header(bus, child); 799 retval += resource_list_print_type(rl, "port", SYS_RES_IOPORT, "%#jx"); 800 retval += resource_list_print_type(rl, "iomem", SYS_RES_MEMORY, "%#jx"); 801 retval += resource_list_print_type(rl, "irq", SYS_RES_IRQ, "%jd"); 802 retval += resource_list_print_type(rl, "drq", SYS_RES_DRQ, "%jd"); 803 if (device_get_flags(child)) 804 retval += printf(" flags %#x", device_get_flags(child)); 805 retval += bus_print_child_domain(bus, child); 806 retval += bus_print_child_footer(bus, child); 807 808 return (retval); 809 } 810 811 /* 812 * If this device is an ACPI child but no one claimed it, attempt 813 * to power it off. We'll power it back up when a driver is added. 814 * 815 * XXX Disabled for now since many necessary devices (like fdc and 816 * ATA) don't claim the devices we created for them but still expect 817 * them to be powered up. 818 */ 819 static void 820 acpi_probe_nomatch(device_t bus, device_t child) 821 { 822 #ifdef ACPI_ENABLE_POWERDOWN_NODRIVER 823 acpi_set_powerstate(child, ACPI_STATE_D3); 824 #endif 825 } 826 827 /* 828 * If a new driver has a chance to probe a child, first power it up. 829 * 830 * XXX Disabled for now (see acpi_probe_nomatch for details). 831 */ 832 static void 833 acpi_driver_added(device_t dev, driver_t *driver) 834 { 835 device_t child, *devlist; 836 int i, numdevs; 837 838 DEVICE_IDENTIFY(driver, dev); 839 if (device_get_children(dev, &devlist, &numdevs)) 840 return; 841 for (i = 0; i < numdevs; i++) { 842 child = devlist[i]; 843 if (device_get_state(child) == DS_NOTPRESENT) { 844 #ifdef ACPI_ENABLE_POWERDOWN_NODRIVER 845 acpi_set_powerstate(child, ACPI_STATE_D0); 846 if (device_probe_and_attach(child) != 0) 847 acpi_set_powerstate(child, ACPI_STATE_D3); 848 #else 849 device_probe_and_attach(child); 850 #endif 851 } 852 } 853 free(devlist, M_TEMP); 854 } 855 856 /* Location hint for devctl(8) */ 857 static int 858 acpi_child_location_str_method(device_t cbdev, device_t child, char *buf, 859 size_t buflen) 860 { 861 struct acpi_device *dinfo = device_get_ivars(child); 862 char buf2[32]; 863 int pxm; 864 865 if (dinfo->ad_handle) { 866 snprintf(buf, buflen, "handle=%s", acpi_name(dinfo->ad_handle)); 867 if (ACPI_SUCCESS(acpi_GetInteger(dinfo->ad_handle, "_PXM", &pxm))) { 868 snprintf(buf2, 32, " _PXM=%d", pxm); 869 strlcat(buf, buf2, buflen); 870 } 871 } else { 872 snprintf(buf, buflen, "unknown"); 873 } 874 return (0); 875 } 876 877 /* PnP information for devctl(8) */ 878 static int 879 acpi_child_pnpinfo_str_method(device_t cbdev, device_t child, char *buf, 880 size_t buflen) 881 { 882 struct acpi_device *dinfo = device_get_ivars(child); 883 ACPI_DEVICE_INFO *adinfo; 884 885 if (ACPI_FAILURE(AcpiGetObjectInfo(dinfo->ad_handle, &adinfo))) { 886 snprintf(buf, buflen, "unknown"); 887 return (0); 888 } 889 890 snprintf(buf, buflen, "_HID=%s _UID=%lu", 891 (adinfo->Valid & ACPI_VALID_HID) ? 892 adinfo->HardwareId.String : "none", 893 (adinfo->Valid & ACPI_VALID_UID) ? 894 strtoul(adinfo->UniqueId.String, NULL, 10) : 0UL); 895 AcpiOsFree(adinfo); 896 897 return (0); 898 } 899 900 /* 901 * Handle per-device ivars 902 */ 903 static int 904 acpi_read_ivar(device_t dev, device_t child, int index, uintptr_t *result) 905 { 906 struct acpi_device *ad; 907 908 if ((ad = device_get_ivars(child)) == NULL) { 909 device_printf(child, "device has no ivars\n"); 910 return (ENOENT); 911 } 912 913 /* ACPI and ISA compatibility ivars */ 914 switch(index) { 915 case ACPI_IVAR_HANDLE: 916 *(ACPI_HANDLE *)result = ad->ad_handle; 917 break; 918 case ACPI_IVAR_PRIVATE: 919 *(void **)result = ad->ad_private; 920 break; 921 case ACPI_IVAR_FLAGS: 922 *(int *)result = ad->ad_flags; 923 break; 924 case ISA_IVAR_VENDORID: 925 case ISA_IVAR_SERIAL: 926 case ISA_IVAR_COMPATID: 927 *(int *)result = -1; 928 break; 929 case ISA_IVAR_LOGICALID: 930 *(int *)result = acpi_isa_get_logicalid(child); 931 break; 932 case PCI_IVAR_CLASS: 933 *(uint8_t*)result = (ad->ad_cls_class >> 16) & 0xff; 934 break; 935 case PCI_IVAR_SUBCLASS: 936 *(uint8_t*)result = (ad->ad_cls_class >> 8) & 0xff; 937 break; 938 case PCI_IVAR_PROGIF: 939 *(uint8_t*)result = (ad->ad_cls_class >> 0) & 0xff; 940 break; 941 default: 942 return (ENOENT); 943 } 944 945 return (0); 946 } 947 948 static int 949 acpi_write_ivar(device_t dev, device_t child, int index, uintptr_t value) 950 { 951 struct acpi_device *ad; 952 953 if ((ad = device_get_ivars(child)) == NULL) { 954 device_printf(child, "device has no ivars\n"); 955 return (ENOENT); 956 } 957 958 switch(index) { 959 case ACPI_IVAR_HANDLE: 960 ad->ad_handle = (ACPI_HANDLE)value; 961 break; 962 case ACPI_IVAR_PRIVATE: 963 ad->ad_private = (void *)value; 964 break; 965 case ACPI_IVAR_FLAGS: 966 ad->ad_flags = (int)value; 967 break; 968 default: 969 panic("bad ivar write request (%d)", index); 970 return (ENOENT); 971 } 972 973 return (0); 974 } 975 976 /* 977 * Handle child resource allocation/removal 978 */ 979 static struct resource_list * 980 acpi_get_rlist(device_t dev, device_t child) 981 { 982 struct acpi_device *ad; 983 984 ad = device_get_ivars(child); 985 return (&ad->ad_rl); 986 } 987 988 static int 989 acpi_match_resource_hint(device_t dev, int type, long value) 990 { 991 struct acpi_device *ad = device_get_ivars(dev); 992 struct resource_list *rl = &ad->ad_rl; 993 struct resource_list_entry *rle; 994 995 STAILQ_FOREACH(rle, rl, link) { 996 if (rle->type != type) 997 continue; 998 if (rle->start <= value && rle->end >= value) 999 return (1); 1000 } 1001 return (0); 1002 } 1003 1004 /* 1005 * Wire device unit numbers based on resource matches in hints. 1006 */ 1007 static void 1008 acpi_hint_device_unit(device_t acdev, device_t child, const char *name, 1009 int *unitp) 1010 { 1011 const char *s; 1012 long value; 1013 int line, matches, unit; 1014 1015 /* 1016 * Iterate over all the hints for the devices with the specified 1017 * name to see if one's resources are a subset of this device. 1018 */ 1019 line = 0; 1020 while (resource_find_dev(&line, name, &unit, "at", NULL) == 0) { 1021 /* Must have an "at" for acpi or isa. */ 1022 resource_string_value(name, unit, "at", &s); 1023 if (!(strcmp(s, "acpi0") == 0 || strcmp(s, "acpi") == 0 || 1024 strcmp(s, "isa0") == 0 || strcmp(s, "isa") == 0)) 1025 continue; 1026 1027 /* 1028 * Check for matching resources. We must have at least one match. 1029 * Since I/O and memory resources cannot be shared, if we get a 1030 * match on either of those, ignore any mismatches in IRQs or DRQs. 1031 * 1032 * XXX: We may want to revisit this to be more lenient and wire 1033 * as long as it gets one match. 1034 */ 1035 matches = 0; 1036 if (resource_long_value(name, unit, "port", &value) == 0) { 1037 /* 1038 * Floppy drive controllers are notorious for having a 1039 * wide variety of resources not all of which include the 1040 * first port that is specified by the hint (typically 1041 * 0x3f0) (see the comment above fdc_isa_alloc_resources() 1042 * in fdc_isa.c). However, they do all seem to include 1043 * port + 2 (e.g. 0x3f2) so for a floppy device, look for 1044 * 'value + 2' in the port resources instead of the hint 1045 * value. 1046 */ 1047 if (strcmp(name, "fdc") == 0) 1048 value += 2; 1049 if (acpi_match_resource_hint(child, SYS_RES_IOPORT, value)) 1050 matches++; 1051 else 1052 continue; 1053 } 1054 if (resource_long_value(name, unit, "maddr", &value) == 0) { 1055 if (acpi_match_resource_hint(child, SYS_RES_MEMORY, value)) 1056 matches++; 1057 else 1058 continue; 1059 } 1060 if (matches > 0) 1061 goto matched; 1062 if (resource_long_value(name, unit, "irq", &value) == 0) { 1063 if (acpi_match_resource_hint(child, SYS_RES_IRQ, value)) 1064 matches++; 1065 else 1066 continue; 1067 } 1068 if (resource_long_value(name, unit, "drq", &value) == 0) { 1069 if (acpi_match_resource_hint(child, SYS_RES_DRQ, value)) 1070 matches++; 1071 else 1072 continue; 1073 } 1074 1075 matched: 1076 if (matches > 0) { 1077 /* We have a winner! */ 1078 *unitp = unit; 1079 break; 1080 } 1081 } 1082 } 1083 1084 /* 1085 * Fetch the NUMA domain for a device by mapping the value returned by 1086 * _PXM to a NUMA domain. If the device does not have a _PXM method, 1087 * -2 is returned. If any other error occurs, -1 is returned. 1088 */ 1089 static int 1090 acpi_parse_pxm(device_t dev) 1091 { 1092 #ifdef NUMA 1093 #if defined(__i386__) || defined(__amd64__) 1094 ACPI_HANDLE handle; 1095 ACPI_STATUS status; 1096 int pxm; 1097 1098 handle = acpi_get_handle(dev); 1099 if (handle == NULL) 1100 return (-2); 1101 status = acpi_GetInteger(handle, "_PXM", &pxm); 1102 if (ACPI_SUCCESS(status)) 1103 return (acpi_map_pxm_to_vm_domainid(pxm)); 1104 if (status == AE_NOT_FOUND) 1105 return (-2); 1106 #endif 1107 #endif 1108 return (-1); 1109 } 1110 1111 int 1112 acpi_get_cpus(device_t dev, device_t child, enum cpu_sets op, size_t setsize, 1113 cpuset_t *cpuset) 1114 { 1115 int d, error; 1116 1117 d = acpi_parse_pxm(child); 1118 if (d < 0) 1119 return (bus_generic_get_cpus(dev, child, op, setsize, cpuset)); 1120 1121 switch (op) { 1122 case LOCAL_CPUS: 1123 if (setsize != sizeof(cpuset_t)) 1124 return (EINVAL); 1125 *cpuset = cpuset_domain[d]; 1126 return (0); 1127 case INTR_CPUS: 1128 error = bus_generic_get_cpus(dev, child, op, setsize, cpuset); 1129 if (error != 0) 1130 return (error); 1131 if (setsize != sizeof(cpuset_t)) 1132 return (EINVAL); 1133 CPU_AND(cpuset, &cpuset_domain[d]); 1134 return (0); 1135 default: 1136 return (bus_generic_get_cpus(dev, child, op, setsize, cpuset)); 1137 } 1138 } 1139 1140 /* 1141 * Fetch the NUMA domain for the given device 'dev'. 1142 * 1143 * If a device has a _PXM method, map that to a NUMA domain. 1144 * Otherwise, pass the request up to the parent. 1145 * If there's no matching domain or the domain cannot be 1146 * determined, return ENOENT. 1147 */ 1148 int 1149 acpi_get_domain(device_t dev, device_t child, int *domain) 1150 { 1151 int d; 1152 1153 d = acpi_parse_pxm(child); 1154 if (d >= 0) { 1155 *domain = d; 1156 return (0); 1157 } 1158 if (d == -1) 1159 return (ENOENT); 1160 1161 /* No _PXM node; go up a level */ 1162 return (bus_generic_get_domain(dev, child, domain)); 1163 } 1164 1165 /* 1166 * Pre-allocate/manage all memory and IO resources. Since rman can't handle 1167 * duplicates, we merge any in the sysresource attach routine. 1168 */ 1169 static int 1170 acpi_sysres_alloc(device_t dev) 1171 { 1172 struct resource *res; 1173 struct resource_list *rl; 1174 struct resource_list_entry *rle; 1175 struct rman *rm; 1176 device_t *children; 1177 int child_count, i; 1178 1179 /* 1180 * Probe/attach any sysresource devices. This would be unnecessary if we 1181 * had multi-pass probe/attach. 1182 */ 1183 if (device_get_children(dev, &children, &child_count) != 0) 1184 return (ENXIO); 1185 for (i = 0; i < child_count; i++) { 1186 if (ACPI_ID_PROBE(dev, children[i], sysres_ids, NULL) <= 0) 1187 device_probe_and_attach(children[i]); 1188 } 1189 free(children, M_TEMP); 1190 1191 rl = BUS_GET_RESOURCE_LIST(device_get_parent(dev), dev); 1192 STAILQ_FOREACH(rle, rl, link) { 1193 if (rle->res != NULL) { 1194 device_printf(dev, "duplicate resource for %jx\n", rle->start); 1195 continue; 1196 } 1197 1198 /* Only memory and IO resources are valid here. */ 1199 switch (rle->type) { 1200 case SYS_RES_IOPORT: 1201 rm = &acpi_rman_io; 1202 break; 1203 case SYS_RES_MEMORY: 1204 rm = &acpi_rman_mem; 1205 break; 1206 default: 1207 continue; 1208 } 1209 1210 /* Pre-allocate resource and add to our rman pool. */ 1211 res = BUS_ALLOC_RESOURCE(device_get_parent(dev), dev, rle->type, 1212 &rle->rid, rle->start, rle->start + rle->count - 1, rle->count, 0); 1213 if (res != NULL) { 1214 rman_manage_region(rm, rman_get_start(res), rman_get_end(res)); 1215 rle->res = res; 1216 } else if (bootverbose) 1217 device_printf(dev, "reservation of %jx, %jx (%d) failed\n", 1218 rle->start, rle->count, rle->type); 1219 } 1220 return (0); 1221 } 1222 1223 /* 1224 * Reserve declared resources for devices found during attach once system 1225 * resources have been allocated. 1226 */ 1227 static void 1228 acpi_reserve_resources(device_t dev) 1229 { 1230 struct resource_list_entry *rle; 1231 struct resource_list *rl; 1232 struct acpi_device *ad; 1233 struct acpi_softc *sc; 1234 device_t *children; 1235 int child_count, i; 1236 1237 sc = device_get_softc(dev); 1238 if (device_get_children(dev, &children, &child_count) != 0) 1239 return; 1240 for (i = 0; i < child_count; i++) { 1241 ad = device_get_ivars(children[i]); 1242 rl = &ad->ad_rl; 1243 1244 /* Don't reserve system resources. */ 1245 if (ACPI_ID_PROBE(dev, children[i], sysres_ids, NULL) <= 0) 1246 continue; 1247 1248 STAILQ_FOREACH(rle, rl, link) { 1249 /* 1250 * Don't reserve IRQ resources. There are many sticky things 1251 * to get right otherwise (e.g. IRQs for psm, atkbd, and HPET 1252 * when using legacy routing). 1253 */ 1254 if (rle->type == SYS_RES_IRQ) 1255 continue; 1256 1257 /* 1258 * Don't reserve the resource if it is already allocated. 1259 * The acpi_ec(4) driver can allocate its resources early 1260 * if ECDT is present. 1261 */ 1262 if (rle->res != NULL) 1263 continue; 1264 1265 /* 1266 * Try to reserve the resource from our parent. If this 1267 * fails because the resource is a system resource, just 1268 * let it be. The resource range is already reserved so 1269 * that other devices will not use it. If the driver 1270 * needs to allocate the resource, then 1271 * acpi_alloc_resource() will sub-alloc from the system 1272 * resource. 1273 */ 1274 resource_list_reserve(rl, dev, children[i], rle->type, &rle->rid, 1275 rle->start, rle->end, rle->count, 0); 1276 } 1277 } 1278 free(children, M_TEMP); 1279 sc->acpi_resources_reserved = 1; 1280 } 1281 1282 static int 1283 acpi_set_resource(device_t dev, device_t child, int type, int rid, 1284 rman_res_t start, rman_res_t count) 1285 { 1286 struct acpi_softc *sc = device_get_softc(dev); 1287 struct acpi_device *ad = device_get_ivars(child); 1288 struct resource_list *rl = &ad->ad_rl; 1289 #if defined(__i386__) || defined(__amd64__) 1290 ACPI_DEVICE_INFO *devinfo; 1291 #endif 1292 rman_res_t end; 1293 1294 /* Ignore IRQ resources for PCI link devices. */ 1295 if (type == SYS_RES_IRQ && 1296 ACPI_ID_PROBE(dev, child, pcilink_ids, NULL) <= 0) 1297 return (0); 1298 1299 /* 1300 * Ignore most resources for PCI root bridges. Some BIOSes 1301 * incorrectly enumerate the memory ranges they decode as plain 1302 * memory resources instead of as ResourceProducer ranges. Other 1303 * BIOSes incorrectly list system resource entries for I/O ranges 1304 * under the PCI bridge. Do allow the one known-correct case on 1305 * x86 of a PCI bridge claiming the I/O ports used for PCI config 1306 * access. 1307 */ 1308 #if defined(__i386__) || defined(__amd64__) 1309 if (type == SYS_RES_MEMORY || type == SYS_RES_IOPORT) { 1310 if (ACPI_SUCCESS(AcpiGetObjectInfo(ad->ad_handle, &devinfo))) { 1311 if ((devinfo->Flags & ACPI_PCI_ROOT_BRIDGE) != 0) { 1312 if (!(type == SYS_RES_IOPORT && start == CONF1_ADDR_PORT)) { 1313 AcpiOsFree(devinfo); 1314 return (0); 1315 } 1316 } 1317 AcpiOsFree(devinfo); 1318 } 1319 } 1320 #endif 1321 1322 /* If the resource is already allocated, fail. */ 1323 if (resource_list_busy(rl, type, rid)) 1324 return (EBUSY); 1325 1326 /* If the resource is already reserved, release it. */ 1327 if (resource_list_reserved(rl, type, rid)) 1328 resource_list_unreserve(rl, dev, child, type, rid); 1329 1330 /* Add the resource. */ 1331 end = (start + count - 1); 1332 resource_list_add(rl, type, rid, start, end, count); 1333 1334 /* Don't reserve resources until the system resources are allocated. */ 1335 if (!sc->acpi_resources_reserved) 1336 return (0); 1337 1338 /* Don't reserve system resources. */ 1339 if (ACPI_ID_PROBE(dev, child, sysres_ids, NULL) <= 0) 1340 return (0); 1341 1342 /* 1343 * Don't reserve IRQ resources. There are many sticky things to 1344 * get right otherwise (e.g. IRQs for psm, atkbd, and HPET when 1345 * using legacy routing). 1346 */ 1347 if (type == SYS_RES_IRQ) 1348 return (0); 1349 1350 /* 1351 * Reserve the resource. 1352 * 1353 * XXX: Ignores failure for now. Failure here is probably a 1354 * BIOS/firmware bug? 1355 */ 1356 resource_list_reserve(rl, dev, child, type, &rid, start, end, count, 0); 1357 return (0); 1358 } 1359 1360 static struct resource * 1361 acpi_alloc_resource(device_t bus, device_t child, int type, int *rid, 1362 rman_res_t start, rman_res_t end, rman_res_t count, u_int flags) 1363 { 1364 #ifndef INTRNG 1365 ACPI_RESOURCE ares; 1366 #endif 1367 struct acpi_device *ad; 1368 struct resource_list_entry *rle; 1369 struct resource_list *rl; 1370 struct resource *res; 1371 int isdefault = RMAN_IS_DEFAULT_RANGE(start, end); 1372 1373 /* 1374 * First attempt at allocating the resource. For direct children, 1375 * use resource_list_alloc() to handle reserved resources. For 1376 * other devices, pass the request up to our parent. 1377 */ 1378 if (bus == device_get_parent(child)) { 1379 ad = device_get_ivars(child); 1380 rl = &ad->ad_rl; 1381 1382 /* 1383 * Simulate the behavior of the ISA bus for direct children 1384 * devices. That is, if a non-default range is specified for 1385 * a resource that doesn't exist, use bus_set_resource() to 1386 * add the resource before allocating it. Note that these 1387 * resources will not be reserved. 1388 */ 1389 if (!isdefault && resource_list_find(rl, type, *rid) == NULL) 1390 resource_list_add(rl, type, *rid, start, end, count); 1391 res = resource_list_alloc(rl, bus, child, type, rid, start, end, count, 1392 flags); 1393 #ifndef INTRNG 1394 if (res != NULL && type == SYS_RES_IRQ) { 1395 /* 1396 * Since bus_config_intr() takes immediate effect, we cannot 1397 * configure the interrupt associated with a device when we 1398 * parse the resources but have to defer it until a driver 1399 * actually allocates the interrupt via bus_alloc_resource(). 1400 * 1401 * XXX: Should we handle the lookup failing? 1402 */ 1403 if (ACPI_SUCCESS(acpi_lookup_irq_resource(child, *rid, res, &ares))) 1404 acpi_config_intr(child, &ares); 1405 } 1406 #endif 1407 1408 /* 1409 * If this is an allocation of the "default" range for a given 1410 * RID, fetch the exact bounds for this resource from the 1411 * resource list entry to try to allocate the range from the 1412 * system resource regions. 1413 */ 1414 if (res == NULL && isdefault) { 1415 rle = resource_list_find(rl, type, *rid); 1416 if (rle != NULL) { 1417 start = rle->start; 1418 end = rle->end; 1419 count = rle->count; 1420 } 1421 } 1422 } else 1423 res = BUS_ALLOC_RESOURCE(device_get_parent(bus), child, type, rid, 1424 start, end, count, flags); 1425 1426 /* 1427 * If the first attempt failed and this is an allocation of a 1428 * specific range, try to satisfy the request via a suballocation 1429 * from our system resource regions. 1430 */ 1431 if (res == NULL && start + count - 1 == end) 1432 res = acpi_alloc_sysres(child, type, rid, start, end, count, flags); 1433 return (res); 1434 } 1435 1436 /* 1437 * Attempt to allocate a specific resource range from the system 1438 * resource ranges. Note that we only handle memory and I/O port 1439 * system resources. 1440 */ 1441 struct resource * 1442 acpi_alloc_sysres(device_t child, int type, int *rid, rman_res_t start, 1443 rman_res_t end, rman_res_t count, u_int flags) 1444 { 1445 struct rman *rm; 1446 struct resource *res; 1447 1448 switch (type) { 1449 case SYS_RES_IOPORT: 1450 rm = &acpi_rman_io; 1451 break; 1452 case SYS_RES_MEMORY: 1453 rm = &acpi_rman_mem; 1454 break; 1455 default: 1456 return (NULL); 1457 } 1458 1459 KASSERT(start + count - 1 == end, ("wildcard resource range")); 1460 res = rman_reserve_resource(rm, start, end, count, flags & ~RF_ACTIVE, 1461 child); 1462 if (res == NULL) 1463 return (NULL); 1464 1465 rman_set_rid(res, *rid); 1466 1467 /* If requested, activate the resource using the parent's method. */ 1468 if (flags & RF_ACTIVE) 1469 if (bus_activate_resource(child, type, *rid, res) != 0) { 1470 rman_release_resource(res); 1471 return (NULL); 1472 } 1473 1474 return (res); 1475 } 1476 1477 static int 1478 acpi_is_resource_managed(int type, struct resource *r) 1479 { 1480 1481 /* We only handle memory and IO resources through rman. */ 1482 switch (type) { 1483 case SYS_RES_IOPORT: 1484 return (rman_is_region_manager(r, &acpi_rman_io)); 1485 case SYS_RES_MEMORY: 1486 return (rman_is_region_manager(r, &acpi_rman_mem)); 1487 } 1488 return (0); 1489 } 1490 1491 static int 1492 acpi_adjust_resource(device_t bus, device_t child, int type, struct resource *r, 1493 rman_res_t start, rman_res_t end) 1494 { 1495 1496 if (acpi_is_resource_managed(type, r)) 1497 return (rman_adjust_resource(r, start, end)); 1498 return (bus_generic_adjust_resource(bus, child, type, r, start, end)); 1499 } 1500 1501 static int 1502 acpi_release_resource(device_t bus, device_t child, int type, int rid, 1503 struct resource *r) 1504 { 1505 int ret; 1506 1507 /* 1508 * If this resource belongs to one of our internal managers, 1509 * deactivate it and release it to the local pool. 1510 */ 1511 if (acpi_is_resource_managed(type, r)) { 1512 if (rman_get_flags(r) & RF_ACTIVE) { 1513 ret = bus_deactivate_resource(child, type, rid, r); 1514 if (ret != 0) 1515 return (ret); 1516 } 1517 return (rman_release_resource(r)); 1518 } 1519 1520 return (bus_generic_rl_release_resource(bus, child, type, rid, r)); 1521 } 1522 1523 static void 1524 acpi_delete_resource(device_t bus, device_t child, int type, int rid) 1525 { 1526 struct resource_list *rl; 1527 1528 rl = acpi_get_rlist(bus, child); 1529 if (resource_list_busy(rl, type, rid)) { 1530 device_printf(bus, "delete_resource: Resource still owned by child" 1531 " (type=%d, rid=%d)\n", type, rid); 1532 return; 1533 } 1534 resource_list_unreserve(rl, bus, child, type, rid); 1535 resource_list_delete(rl, type, rid); 1536 } 1537 1538 /* Allocate an IO port or memory resource, given its GAS. */ 1539 int 1540 acpi_bus_alloc_gas(device_t dev, int *type, int *rid, ACPI_GENERIC_ADDRESS *gas, 1541 struct resource **res, u_int flags) 1542 { 1543 int error, res_type; 1544 1545 error = ENOMEM; 1546 if (type == NULL || rid == NULL || gas == NULL || res == NULL) 1547 return (EINVAL); 1548 1549 /* We only support memory and IO spaces. */ 1550 switch (gas->SpaceId) { 1551 case ACPI_ADR_SPACE_SYSTEM_MEMORY: 1552 res_type = SYS_RES_MEMORY; 1553 break; 1554 case ACPI_ADR_SPACE_SYSTEM_IO: 1555 res_type = SYS_RES_IOPORT; 1556 break; 1557 default: 1558 return (EOPNOTSUPP); 1559 } 1560 1561 /* 1562 * If the register width is less than 8, assume the BIOS author means 1563 * it is a bit field and just allocate a byte. 1564 */ 1565 if (gas->BitWidth && gas->BitWidth < 8) 1566 gas->BitWidth = 8; 1567 1568 /* Validate the address after we're sure we support the space. */ 1569 if (gas->Address == 0 || gas->BitWidth == 0) 1570 return (EINVAL); 1571 1572 bus_set_resource(dev, res_type, *rid, gas->Address, 1573 gas->BitWidth / 8); 1574 *res = bus_alloc_resource_any(dev, res_type, rid, RF_ACTIVE | flags); 1575 if (*res != NULL) { 1576 *type = res_type; 1577 error = 0; 1578 } else 1579 bus_delete_resource(dev, res_type, *rid); 1580 1581 return (error); 1582 } 1583 1584 /* Probe _HID and _CID for compatible ISA PNP ids. */ 1585 static uint32_t 1586 acpi_isa_get_logicalid(device_t dev) 1587 { 1588 ACPI_DEVICE_INFO *devinfo; 1589 ACPI_HANDLE h; 1590 uint32_t pnpid; 1591 1592 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__); 1593 1594 /* Fetch and validate the HID. */ 1595 if ((h = acpi_get_handle(dev)) == NULL || 1596 ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo))) 1597 return_VALUE (0); 1598 1599 pnpid = (devinfo->Valid & ACPI_VALID_HID) != 0 && 1600 devinfo->HardwareId.Length >= ACPI_EISAID_STRING_SIZE ? 1601 PNP_EISAID(devinfo->HardwareId.String) : 0; 1602 AcpiOsFree(devinfo); 1603 1604 return_VALUE (pnpid); 1605 } 1606 1607 static int 1608 acpi_isa_get_compatid(device_t dev, uint32_t *cids, int count) 1609 { 1610 ACPI_DEVICE_INFO *devinfo; 1611 ACPI_PNP_DEVICE_ID *ids; 1612 ACPI_HANDLE h; 1613 uint32_t *pnpid; 1614 int i, valid; 1615 1616 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__); 1617 1618 pnpid = cids; 1619 1620 /* Fetch and validate the CID */ 1621 if ((h = acpi_get_handle(dev)) == NULL || 1622 ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo))) 1623 return_VALUE (0); 1624 1625 if ((devinfo->Valid & ACPI_VALID_CID) == 0) { 1626 AcpiOsFree(devinfo); 1627 return_VALUE (0); 1628 } 1629 1630 if (devinfo->CompatibleIdList.Count < count) 1631 count = devinfo->CompatibleIdList.Count; 1632 ids = devinfo->CompatibleIdList.Ids; 1633 for (i = 0, valid = 0; i < count; i++) 1634 if (ids[i].Length >= ACPI_EISAID_STRING_SIZE && 1635 strncmp(ids[i].String, "PNP", 3) == 0) { 1636 *pnpid++ = PNP_EISAID(ids[i].String); 1637 valid++; 1638 } 1639 AcpiOsFree(devinfo); 1640 1641 return_VALUE (valid); 1642 } 1643 1644 static int 1645 acpi_device_id_probe(device_t bus, device_t dev, char **ids, char **match) 1646 { 1647 ACPI_HANDLE h; 1648 ACPI_OBJECT_TYPE t; 1649 int rv; 1650 int i; 1651 1652 h = acpi_get_handle(dev); 1653 if (ids == NULL || h == NULL) 1654 return (ENXIO); 1655 t = acpi_get_type(dev); 1656 if (t != ACPI_TYPE_DEVICE && t != ACPI_TYPE_PROCESSOR) 1657 return (ENXIO); 1658 1659 /* Try to match one of the array of IDs with a HID or CID. */ 1660 for (i = 0; ids[i] != NULL; i++) { 1661 rv = acpi_MatchHid(h, ids[i]); 1662 if (rv == ACPI_MATCHHID_NOMATCH) 1663 continue; 1664 1665 if (match != NULL) { 1666 *match = ids[i]; 1667 } 1668 return ((rv == ACPI_MATCHHID_HID)? 1669 BUS_PROBE_DEFAULT : BUS_PROBE_LOW_PRIORITY); 1670 } 1671 return (ENXIO); 1672 } 1673 1674 static ACPI_STATUS 1675 acpi_device_eval_obj(device_t bus, device_t dev, ACPI_STRING pathname, 1676 ACPI_OBJECT_LIST *parameters, ACPI_BUFFER *ret) 1677 { 1678 ACPI_HANDLE h; 1679 1680 if (dev == NULL) 1681 h = ACPI_ROOT_OBJECT; 1682 else if ((h = acpi_get_handle(dev)) == NULL) 1683 return (AE_BAD_PARAMETER); 1684 return (AcpiEvaluateObject(h, pathname, parameters, ret)); 1685 } 1686 1687 int 1688 acpi_device_pwr_for_sleep(device_t bus, device_t dev, int *dstate) 1689 { 1690 struct acpi_softc *sc; 1691 ACPI_HANDLE handle; 1692 ACPI_STATUS status; 1693 char sxd[8]; 1694 1695 handle = acpi_get_handle(dev); 1696 1697 /* 1698 * XXX If we find these devices, don't try to power them down. 1699 * The serial and IRDA ports on my T23 hang the system when 1700 * set to D3 and it appears that such legacy devices may 1701 * need special handling in their drivers. 1702 */ 1703 if (dstate == NULL || handle == NULL || 1704 acpi_MatchHid(handle, "PNP0500") || 1705 acpi_MatchHid(handle, "PNP0501") || 1706 acpi_MatchHid(handle, "PNP0502") || 1707 acpi_MatchHid(handle, "PNP0510") || 1708 acpi_MatchHid(handle, "PNP0511")) 1709 return (ENXIO); 1710 1711 /* 1712 * Override next state with the value from _SxD, if present. 1713 * Note illegal _S0D is evaluated because some systems expect this. 1714 */ 1715 sc = device_get_softc(bus); 1716 snprintf(sxd, sizeof(sxd), "_S%dD", sc->acpi_sstate); 1717 status = acpi_GetInteger(handle, sxd, dstate); 1718 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) { 1719 device_printf(dev, "failed to get %s on %s: %s\n", sxd, 1720 acpi_name(handle), AcpiFormatException(status)); 1721 return (ENXIO); 1722 } 1723 1724 return (0); 1725 } 1726 1727 /* Callback arg for our implementation of walking the namespace. */ 1728 struct acpi_device_scan_ctx { 1729 acpi_scan_cb_t user_fn; 1730 void *arg; 1731 ACPI_HANDLE parent; 1732 }; 1733 1734 static ACPI_STATUS 1735 acpi_device_scan_cb(ACPI_HANDLE h, UINT32 level, void *arg, void **retval) 1736 { 1737 struct acpi_device_scan_ctx *ctx; 1738 device_t dev, old_dev; 1739 ACPI_STATUS status; 1740 ACPI_OBJECT_TYPE type; 1741 1742 /* 1743 * Skip this device if we think we'll have trouble with it or it is 1744 * the parent where the scan began. 1745 */ 1746 ctx = (struct acpi_device_scan_ctx *)arg; 1747 if (acpi_avoid(h) || h == ctx->parent) 1748 return (AE_OK); 1749 1750 /* If this is not a valid device type (e.g., a method), skip it. */ 1751 if (ACPI_FAILURE(AcpiGetType(h, &type))) 1752 return (AE_OK); 1753 if (type != ACPI_TYPE_DEVICE && type != ACPI_TYPE_PROCESSOR && 1754 type != ACPI_TYPE_THERMAL && type != ACPI_TYPE_POWER) 1755 return (AE_OK); 1756 1757 /* 1758 * Call the user function with the current device. If it is unchanged 1759 * afterwards, return. Otherwise, we update the handle to the new dev. 1760 */ 1761 old_dev = acpi_get_device(h); 1762 dev = old_dev; 1763 status = ctx->user_fn(h, &dev, level, ctx->arg); 1764 if (ACPI_FAILURE(status) || old_dev == dev) 1765 return (status); 1766 1767 /* Remove the old child and its connection to the handle. */ 1768 if (old_dev != NULL) { 1769 device_delete_child(device_get_parent(old_dev), old_dev); 1770 AcpiDetachData(h, acpi_fake_objhandler); 1771 } 1772 1773 /* Recreate the handle association if the user created a device. */ 1774 if (dev != NULL) 1775 AcpiAttachData(h, acpi_fake_objhandler, dev); 1776 1777 return (AE_OK); 1778 } 1779 1780 static ACPI_STATUS 1781 acpi_device_scan_children(device_t bus, device_t dev, int max_depth, 1782 acpi_scan_cb_t user_fn, void *arg) 1783 { 1784 ACPI_HANDLE h; 1785 struct acpi_device_scan_ctx ctx; 1786 1787 if (acpi_disabled("children")) 1788 return (AE_OK); 1789 1790 if (dev == NULL) 1791 h = ACPI_ROOT_OBJECT; 1792 else if ((h = acpi_get_handle(dev)) == NULL) 1793 return (AE_BAD_PARAMETER); 1794 ctx.user_fn = user_fn; 1795 ctx.arg = arg; 1796 ctx.parent = h; 1797 return (AcpiWalkNamespace(ACPI_TYPE_ANY, h, max_depth, 1798 acpi_device_scan_cb, NULL, &ctx, NULL)); 1799 } 1800 1801 /* 1802 * Even though ACPI devices are not PCI, we use the PCI approach for setting 1803 * device power states since it's close enough to ACPI. 1804 */ 1805 static int 1806 acpi_set_powerstate(device_t child, int state) 1807 { 1808 ACPI_HANDLE h; 1809 ACPI_STATUS status; 1810 1811 h = acpi_get_handle(child); 1812 if (state < ACPI_STATE_D0 || state > ACPI_D_STATES_MAX) 1813 return (EINVAL); 1814 if (h == NULL) 1815 return (0); 1816 1817 /* Ignore errors if the power methods aren't present. */ 1818 status = acpi_pwr_switch_consumer(h, state); 1819 if (ACPI_SUCCESS(status)) { 1820 if (bootverbose) 1821 device_printf(child, "set ACPI power state D%d on %s\n", 1822 state, acpi_name(h)); 1823 } else if (status != AE_NOT_FOUND) 1824 device_printf(child, 1825 "failed to set ACPI power state D%d on %s: %s\n", state, 1826 acpi_name(h), AcpiFormatException(status)); 1827 1828 return (0); 1829 } 1830 1831 static int 1832 acpi_isa_pnp_probe(device_t bus, device_t child, struct isa_pnp_id *ids) 1833 { 1834 int result, cid_count, i; 1835 uint32_t lid, cids[8]; 1836 1837 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__); 1838 1839 /* 1840 * ISA-style drivers attached to ACPI may persist and 1841 * probe manually if we return ENOENT. We never want 1842 * that to happen, so don't ever return it. 1843 */ 1844 result = ENXIO; 1845 1846 /* Scan the supplied IDs for a match */ 1847 lid = acpi_isa_get_logicalid(child); 1848 cid_count = acpi_isa_get_compatid(child, cids, 8); 1849 while (ids && ids->ip_id) { 1850 if (lid == ids->ip_id) { 1851 result = 0; 1852 goto out; 1853 } 1854 for (i = 0; i < cid_count; i++) { 1855 if (cids[i] == ids->ip_id) { 1856 result = 0; 1857 goto out; 1858 } 1859 } 1860 ids++; 1861 } 1862 1863 out: 1864 if (result == 0 && ids->ip_desc) 1865 device_set_desc(child, ids->ip_desc); 1866 1867 return_VALUE (result); 1868 } 1869 1870 #if defined(__i386__) || defined(__amd64__) 1871 /* 1872 * Look for a MCFG table. If it is present, use the settings for 1873 * domain (segment) 0 to setup PCI config space access via the memory 1874 * map. 1875 */ 1876 static void 1877 acpi_enable_pcie(void) 1878 { 1879 ACPI_TABLE_HEADER *hdr; 1880 ACPI_MCFG_ALLOCATION *alloc, *end; 1881 ACPI_STATUS status; 1882 1883 status = AcpiGetTable(ACPI_SIG_MCFG, 1, &hdr); 1884 if (ACPI_FAILURE(status)) 1885 return; 1886 1887 end = (ACPI_MCFG_ALLOCATION *)((char *)hdr + hdr->Length); 1888 alloc = (ACPI_MCFG_ALLOCATION *)((ACPI_TABLE_MCFG *)hdr + 1); 1889 while (alloc < end) { 1890 if (alloc->PciSegment == 0) { 1891 pcie_cfgregopen(alloc->Address, alloc->StartBusNumber, 1892 alloc->EndBusNumber); 1893 return; 1894 } 1895 alloc++; 1896 } 1897 } 1898 #elif defined(__aarch64__) 1899 static void 1900 acpi_enable_pcie(device_t child, int segment) 1901 { 1902 ACPI_TABLE_HEADER *hdr; 1903 ACPI_MCFG_ALLOCATION *alloc, *end; 1904 ACPI_STATUS status; 1905 1906 status = AcpiGetTable(ACPI_SIG_MCFG, 1, &hdr); 1907 if (ACPI_FAILURE(status)) 1908 return; 1909 1910 end = (ACPI_MCFG_ALLOCATION *)((char *)hdr + hdr->Length); 1911 alloc = (ACPI_MCFG_ALLOCATION *)((ACPI_TABLE_MCFG *)hdr + 1); 1912 while (alloc < end) { 1913 if (alloc->PciSegment == segment) { 1914 bus_set_resource(child, SYS_RES_MEMORY, 0, 1915 alloc->Address, 0x10000000); 1916 return; 1917 } 1918 alloc++; 1919 } 1920 } 1921 #endif 1922 1923 /* 1924 * Scan all of the ACPI namespace and attach child devices. 1925 * 1926 * We should only expect to find devices in the \_PR, \_TZ, \_SI, and 1927 * \_SB scopes, and \_PR and \_TZ became obsolete in the ACPI 2.0 spec. 1928 * However, in violation of the spec, some systems place their PCI link 1929 * devices in \, so we have to walk the whole namespace. We check the 1930 * type of namespace nodes, so this should be ok. 1931 */ 1932 static void 1933 acpi_probe_children(device_t bus) 1934 { 1935 1936 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__); 1937 1938 /* 1939 * Scan the namespace and insert placeholders for all the devices that 1940 * we find. We also probe/attach any early devices. 1941 * 1942 * Note that we use AcpiWalkNamespace rather than AcpiGetDevices because 1943 * we want to create nodes for all devices, not just those that are 1944 * currently present. (This assumes that we don't want to create/remove 1945 * devices as they appear, which might be smarter.) 1946 */ 1947 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "namespace scan\n")); 1948 AcpiWalkNamespace(ACPI_TYPE_ANY, ACPI_ROOT_OBJECT, 100, acpi_probe_child, 1949 NULL, bus, NULL); 1950 1951 /* Pre-allocate resources for our rman from any sysresource devices. */ 1952 acpi_sysres_alloc(bus); 1953 1954 /* Reserve resources already allocated to children. */ 1955 acpi_reserve_resources(bus); 1956 1957 /* Create any static children by calling device identify methods. */ 1958 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "device identify routines\n")); 1959 bus_generic_probe(bus); 1960 1961 /* Probe/attach all children, created statically and from the namespace. */ 1962 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "acpi bus_generic_attach\n")); 1963 bus_generic_attach(bus); 1964 1965 /* Attach wake sysctls. */ 1966 acpi_wake_sysctl_walk(bus); 1967 1968 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "done attaching children\n")); 1969 return_VOID; 1970 } 1971 1972 /* 1973 * Determine the probe order for a given device. 1974 */ 1975 static void 1976 acpi_probe_order(ACPI_HANDLE handle, int *order) 1977 { 1978 ACPI_OBJECT_TYPE type; 1979 1980 /* 1981 * 0. CPUs 1982 * 1. I/O port and memory system resource holders 1983 * 2. Clocks and timers (to handle early accesses) 1984 * 3. Embedded controllers (to handle early accesses) 1985 * 4. PCI Link Devices 1986 */ 1987 AcpiGetType(handle, &type); 1988 if (type == ACPI_TYPE_PROCESSOR) 1989 *order = 0; 1990 else if (acpi_MatchHid(handle, "PNP0C01") || 1991 acpi_MatchHid(handle, "PNP0C02")) 1992 *order = 1; 1993 else if (acpi_MatchHid(handle, "PNP0100") || 1994 acpi_MatchHid(handle, "PNP0103") || 1995 acpi_MatchHid(handle, "PNP0B00")) 1996 *order = 2; 1997 else if (acpi_MatchHid(handle, "PNP0C09")) 1998 *order = 3; 1999 else if (acpi_MatchHid(handle, "PNP0C0F")) 2000 *order = 4; 2001 } 2002 2003 /* 2004 * Evaluate a child device and determine whether we might attach a device to 2005 * it. 2006 */ 2007 static ACPI_STATUS 2008 acpi_probe_child(ACPI_HANDLE handle, UINT32 level, void *context, void **status) 2009 { 2010 ACPI_DEVICE_INFO *devinfo; 2011 struct acpi_device *ad; 2012 #ifdef __aarch64__ 2013 int segment; 2014 #endif 2015 struct acpi_prw_data prw; 2016 ACPI_OBJECT_TYPE type; 2017 ACPI_HANDLE h; 2018 device_t bus, child; 2019 char *handle_str; 2020 int order; 2021 2022 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__); 2023 2024 if (acpi_disabled("children")) 2025 return_ACPI_STATUS (AE_OK); 2026 2027 /* Skip this device if we think we'll have trouble with it. */ 2028 if (acpi_avoid(handle)) 2029 return_ACPI_STATUS (AE_OK); 2030 2031 bus = (device_t)context; 2032 if (ACPI_SUCCESS(AcpiGetType(handle, &type))) { 2033 handle_str = acpi_name(handle); 2034 switch (type) { 2035 case ACPI_TYPE_DEVICE: 2036 /* 2037 * Since we scan from \, be sure to skip system scope objects. 2038 * \_SB_ and \_TZ_ are defined in ACPICA as devices to work around 2039 * BIOS bugs. For example, \_SB_ is to allow \_SB_._INI to be run 2040 * during the initialization and \_TZ_ is to support Notify() on it. 2041 */ 2042 if (strcmp(handle_str, "\\_SB_") == 0 || 2043 strcmp(handle_str, "\\_TZ_") == 0) 2044 break; 2045 if (acpi_parse_prw(handle, &prw) == 0) 2046 AcpiSetupGpeForWake(handle, prw.gpe_handle, prw.gpe_bit); 2047 2048 /* 2049 * Ignore devices that do not have a _HID or _CID. They should 2050 * be discovered by other buses (e.g. the PCI bus driver). 2051 */ 2052 if (!acpi_has_hid(handle)) 2053 break; 2054 /* FALLTHROUGH */ 2055 case ACPI_TYPE_PROCESSOR: 2056 case ACPI_TYPE_THERMAL: 2057 case ACPI_TYPE_POWER: 2058 /* 2059 * Create a placeholder device for this node. Sort the 2060 * placeholder so that the probe/attach passes will run 2061 * breadth-first. Orders less than ACPI_DEV_BASE_ORDER 2062 * are reserved for special objects (i.e., system 2063 * resources). 2064 */ 2065 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "scanning '%s'\n", handle_str)); 2066 order = level * 10 + ACPI_DEV_BASE_ORDER; 2067 acpi_probe_order(handle, &order); 2068 child = BUS_ADD_CHILD(bus, order, NULL, -1); 2069 if (child == NULL) 2070 break; 2071 2072 /* Associate the handle with the device_t and vice versa. */ 2073 acpi_set_handle(child, handle); 2074 AcpiAttachData(handle, acpi_fake_objhandler, child); 2075 2076 /* 2077 * Check that the device is present. If it's not present, 2078 * leave it disabled (so that we have a device_t attached to 2079 * the handle, but we don't probe it). 2080 * 2081 * XXX PCI link devices sometimes report "present" but not 2082 * "functional" (i.e. if disabled). Go ahead and probe them 2083 * anyway since we may enable them later. 2084 */ 2085 if (type == ACPI_TYPE_DEVICE && !acpi_DeviceIsPresent(child)) { 2086 /* Never disable PCI link devices. */ 2087 if (acpi_MatchHid(handle, "PNP0C0F")) 2088 break; 2089 /* 2090 * Docking stations should remain enabled since the system 2091 * may be undocked at boot. 2092 */ 2093 if (ACPI_SUCCESS(AcpiGetHandle(handle, "_DCK", &h))) 2094 break; 2095 2096 device_disable(child); 2097 break; 2098 } 2099 2100 /* 2101 * Get the device's resource settings and attach them. 2102 * Note that if the device has _PRS but no _CRS, we need 2103 * to decide when it's appropriate to try to configure the 2104 * device. Ignore the return value here; it's OK for the 2105 * device not to have any resources. 2106 */ 2107 acpi_parse_resources(child, handle, &acpi_res_parse_set, NULL); 2108 2109 ad = device_get_ivars(child); 2110 ad->ad_cls_class = 0xffffff; 2111 if (ACPI_SUCCESS(AcpiGetObjectInfo(handle, &devinfo))) { 2112 if ((devinfo->Valid & ACPI_VALID_CLS) != 0 && 2113 devinfo->ClassCode.Length >= ACPI_PCICLS_STRING_SIZE) { 2114 ad->ad_cls_class = strtoul(devinfo->ClassCode.String, 2115 NULL, 16); 2116 } 2117 #ifdef __aarch64__ 2118 if ((devinfo->Flags & ACPI_PCI_ROOT_BRIDGE) != 0) { 2119 if (ACPI_SUCCESS(acpi_GetInteger(handle, "_SEG", &segment))) { 2120 acpi_enable_pcie(child, segment); 2121 } 2122 } 2123 #endif 2124 AcpiOsFree(devinfo); 2125 } 2126 break; 2127 } 2128 } 2129 2130 return_ACPI_STATUS (AE_OK); 2131 } 2132 2133 /* 2134 * AcpiAttachData() requires an object handler but never uses it. This is a 2135 * placeholder object handler so we can store a device_t in an ACPI_HANDLE. 2136 */ 2137 void 2138 acpi_fake_objhandler(ACPI_HANDLE h, void *data) 2139 { 2140 } 2141 2142 static void 2143 acpi_shutdown_final(void *arg, int howto) 2144 { 2145 struct acpi_softc *sc = (struct acpi_softc *)arg; 2146 register_t intr; 2147 ACPI_STATUS status; 2148 2149 /* 2150 * XXX Shutdown code should only run on the BSP (cpuid 0). 2151 * Some chipsets do not power off the system correctly if called from 2152 * an AP. 2153 */ 2154 if ((howto & RB_POWEROFF) != 0) { 2155 status = AcpiEnterSleepStatePrep(ACPI_STATE_S5); 2156 if (ACPI_FAILURE(status)) { 2157 device_printf(sc->acpi_dev, "AcpiEnterSleepStatePrep failed - %s\n", 2158 AcpiFormatException(status)); 2159 return; 2160 } 2161 device_printf(sc->acpi_dev, "Powering system off\n"); 2162 intr = intr_disable(); 2163 status = AcpiEnterSleepState(ACPI_STATE_S5); 2164 if (ACPI_FAILURE(status)) { 2165 intr_restore(intr); 2166 device_printf(sc->acpi_dev, "power-off failed - %s\n", 2167 AcpiFormatException(status)); 2168 } else { 2169 DELAY(1000000); 2170 intr_restore(intr); 2171 device_printf(sc->acpi_dev, "power-off failed - timeout\n"); 2172 } 2173 } else if ((howto & RB_HALT) == 0 && sc->acpi_handle_reboot) { 2174 /* Reboot using the reset register. */ 2175 status = AcpiReset(); 2176 if (ACPI_SUCCESS(status)) { 2177 DELAY(1000000); 2178 device_printf(sc->acpi_dev, "reset failed - timeout\n"); 2179 } else if (status != AE_NOT_EXIST) 2180 device_printf(sc->acpi_dev, "reset failed - %s\n", 2181 AcpiFormatException(status)); 2182 } else if (sc->acpi_do_disable && panicstr == NULL) { 2183 /* 2184 * Only disable ACPI if the user requested. On some systems, writing 2185 * the disable value to SMI_CMD hangs the system. 2186 */ 2187 device_printf(sc->acpi_dev, "Shutting down\n"); 2188 AcpiTerminate(); 2189 } 2190 } 2191 2192 static void 2193 acpi_enable_fixed_events(struct acpi_softc *sc) 2194 { 2195 static int first_time = 1; 2196 2197 /* Enable and clear fixed events and install handlers. */ 2198 if ((AcpiGbl_FADT.Flags & ACPI_FADT_POWER_BUTTON) == 0) { 2199 AcpiClearEvent(ACPI_EVENT_POWER_BUTTON); 2200 AcpiInstallFixedEventHandler(ACPI_EVENT_POWER_BUTTON, 2201 acpi_event_power_button_sleep, sc); 2202 if (first_time) 2203 device_printf(sc->acpi_dev, "Power Button (fixed)\n"); 2204 } 2205 if ((AcpiGbl_FADT.Flags & ACPI_FADT_SLEEP_BUTTON) == 0) { 2206 AcpiClearEvent(ACPI_EVENT_SLEEP_BUTTON); 2207 AcpiInstallFixedEventHandler(ACPI_EVENT_SLEEP_BUTTON, 2208 acpi_event_sleep_button_sleep, sc); 2209 if (first_time) 2210 device_printf(sc->acpi_dev, "Sleep Button (fixed)\n"); 2211 } 2212 2213 first_time = 0; 2214 } 2215 2216 /* 2217 * Returns true if the device is actually present and should 2218 * be attached to. This requires the present, enabled, UI-visible 2219 * and diagnostics-passed bits to be set. 2220 */ 2221 BOOLEAN 2222 acpi_DeviceIsPresent(device_t dev) 2223 { 2224 ACPI_HANDLE h; 2225 UINT32 s; 2226 ACPI_STATUS status; 2227 2228 h = acpi_get_handle(dev); 2229 if (h == NULL) 2230 return (FALSE); 2231 status = acpi_GetInteger(h, "_STA", &s); 2232 2233 /* 2234 * Certain Treadripper boards always returns 0 for FreeBSD because it 2235 * only returns non-zero for the OS string "Windows 2015". Otherwise it 2236 * will return zero. Force them to always be treated as present. 2237 * Beata versions were worse: they always returned 0. 2238 */ 2239 if (acpi_MatchHid(h, "AMDI0020") || acpi_MatchHid(h, "AMDI0010")) 2240 return (TRUE); 2241 2242 /* If no _STA method, must be present */ 2243 if (ACPI_FAILURE(status)) 2244 return (status == AE_NOT_FOUND ? TRUE : FALSE); 2245 2246 return (ACPI_DEVICE_PRESENT(s) ? TRUE : FALSE); 2247 } 2248 2249 /* 2250 * Returns true if the battery is actually present and inserted. 2251 */ 2252 BOOLEAN 2253 acpi_BatteryIsPresent(device_t dev) 2254 { 2255 ACPI_HANDLE h; 2256 UINT32 s; 2257 ACPI_STATUS status; 2258 2259 h = acpi_get_handle(dev); 2260 if (h == NULL) 2261 return (FALSE); 2262 status = acpi_GetInteger(h, "_STA", &s); 2263 2264 /* If no _STA method, must be present */ 2265 if (ACPI_FAILURE(status)) 2266 return (status == AE_NOT_FOUND ? TRUE : FALSE); 2267 2268 return (ACPI_BATTERY_PRESENT(s) ? TRUE : FALSE); 2269 } 2270 2271 /* 2272 * Returns true if a device has at least one valid device ID. 2273 */ 2274 static BOOLEAN 2275 acpi_has_hid(ACPI_HANDLE h) 2276 { 2277 ACPI_DEVICE_INFO *devinfo; 2278 BOOLEAN ret; 2279 2280 if (h == NULL || 2281 ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo))) 2282 return (FALSE); 2283 2284 ret = FALSE; 2285 if ((devinfo->Valid & ACPI_VALID_HID) != 0) 2286 ret = TRUE; 2287 else if ((devinfo->Valid & ACPI_VALID_CID) != 0) 2288 if (devinfo->CompatibleIdList.Count > 0) 2289 ret = TRUE; 2290 2291 AcpiOsFree(devinfo); 2292 return (ret); 2293 } 2294 2295 /* 2296 * Match a HID string against a handle 2297 * returns ACPI_MATCHHID_HID if _HID match 2298 * ACPI_MATCHHID_CID if _CID match and not _HID match. 2299 * ACPI_MATCHHID_NOMATCH=0 if no match. 2300 */ 2301 int 2302 acpi_MatchHid(ACPI_HANDLE h, const char *hid) 2303 { 2304 ACPI_DEVICE_INFO *devinfo; 2305 BOOLEAN ret; 2306 int i; 2307 2308 if (hid == NULL || h == NULL || 2309 ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo))) 2310 return (ACPI_MATCHHID_NOMATCH); 2311 2312 ret = FALSE; 2313 if ((devinfo->Valid & ACPI_VALID_HID) != 0 && 2314 strcmp(hid, devinfo->HardwareId.String) == 0) 2315 ret = ACPI_MATCHHID_HID; 2316 else if ((devinfo->Valid & ACPI_VALID_CID) != 0) 2317 for (i = 0; i < devinfo->CompatibleIdList.Count; i++) { 2318 if (strcmp(hid, devinfo->CompatibleIdList.Ids[i].String) == 0) { 2319 ret = ACPI_MATCHHID_CID; 2320 break; 2321 } 2322 } 2323 2324 AcpiOsFree(devinfo); 2325 return (ret); 2326 } 2327 2328 /* 2329 * Return the handle of a named object within our scope, ie. that of (parent) 2330 * or one if its parents. 2331 */ 2332 ACPI_STATUS 2333 acpi_GetHandleInScope(ACPI_HANDLE parent, char *path, ACPI_HANDLE *result) 2334 { 2335 ACPI_HANDLE r; 2336 ACPI_STATUS status; 2337 2338 /* Walk back up the tree to the root */ 2339 for (;;) { 2340 status = AcpiGetHandle(parent, path, &r); 2341 if (ACPI_SUCCESS(status)) { 2342 *result = r; 2343 return (AE_OK); 2344 } 2345 /* XXX Return error here? */ 2346 if (status != AE_NOT_FOUND) 2347 return (AE_OK); 2348 if (ACPI_FAILURE(AcpiGetParent(parent, &r))) 2349 return (AE_NOT_FOUND); 2350 parent = r; 2351 } 2352 } 2353 2354 /* 2355 * Allocate a buffer with a preset data size. 2356 */ 2357 ACPI_BUFFER * 2358 acpi_AllocBuffer(int size) 2359 { 2360 ACPI_BUFFER *buf; 2361 2362 if ((buf = malloc(size + sizeof(*buf), M_ACPIDEV, M_NOWAIT)) == NULL) 2363 return (NULL); 2364 buf->Length = size; 2365 buf->Pointer = (void *)(buf + 1); 2366 return (buf); 2367 } 2368 2369 ACPI_STATUS 2370 acpi_SetInteger(ACPI_HANDLE handle, char *path, UINT32 number) 2371 { 2372 ACPI_OBJECT arg1; 2373 ACPI_OBJECT_LIST args; 2374 2375 arg1.Type = ACPI_TYPE_INTEGER; 2376 arg1.Integer.Value = number; 2377 args.Count = 1; 2378 args.Pointer = &arg1; 2379 2380 return (AcpiEvaluateObject(handle, path, &args, NULL)); 2381 } 2382 2383 /* 2384 * Evaluate a path that should return an integer. 2385 */ 2386 ACPI_STATUS 2387 acpi_GetInteger(ACPI_HANDLE handle, char *path, UINT32 *number) 2388 { 2389 ACPI_STATUS status; 2390 ACPI_BUFFER buf; 2391 ACPI_OBJECT param; 2392 2393 if (handle == NULL) 2394 handle = ACPI_ROOT_OBJECT; 2395 2396 /* 2397 * Assume that what we've been pointed at is an Integer object, or 2398 * a method that will return an Integer. 2399 */ 2400 buf.Pointer = ¶m; 2401 buf.Length = sizeof(param); 2402 status = AcpiEvaluateObject(handle, path, NULL, &buf); 2403 if (ACPI_SUCCESS(status)) { 2404 if (param.Type == ACPI_TYPE_INTEGER) 2405 *number = param.Integer.Value; 2406 else 2407 status = AE_TYPE; 2408 } 2409 2410 /* 2411 * In some applications, a method that's expected to return an Integer 2412 * may instead return a Buffer (probably to simplify some internal 2413 * arithmetic). We'll try to fetch whatever it is, and if it's a Buffer, 2414 * convert it into an Integer as best we can. 2415 * 2416 * This is a hack. 2417 */ 2418 if (status == AE_BUFFER_OVERFLOW) { 2419 if ((buf.Pointer = AcpiOsAllocate(buf.Length)) == NULL) { 2420 status = AE_NO_MEMORY; 2421 } else { 2422 status = AcpiEvaluateObject(handle, path, NULL, &buf); 2423 if (ACPI_SUCCESS(status)) 2424 status = acpi_ConvertBufferToInteger(&buf, number); 2425 AcpiOsFree(buf.Pointer); 2426 } 2427 } 2428 return (status); 2429 } 2430 2431 ACPI_STATUS 2432 acpi_ConvertBufferToInteger(ACPI_BUFFER *bufp, UINT32 *number) 2433 { 2434 ACPI_OBJECT *p; 2435 UINT8 *val; 2436 int i; 2437 2438 p = (ACPI_OBJECT *)bufp->Pointer; 2439 if (p->Type == ACPI_TYPE_INTEGER) { 2440 *number = p->Integer.Value; 2441 return (AE_OK); 2442 } 2443 if (p->Type != ACPI_TYPE_BUFFER) 2444 return (AE_TYPE); 2445 if (p->Buffer.Length > sizeof(int)) 2446 return (AE_BAD_DATA); 2447 2448 *number = 0; 2449 val = p->Buffer.Pointer; 2450 for (i = 0; i < p->Buffer.Length; i++) 2451 *number += val[i] << (i * 8); 2452 return (AE_OK); 2453 } 2454 2455 /* 2456 * Iterate over the elements of an a package object, calling the supplied 2457 * function for each element. 2458 * 2459 * XXX possible enhancement might be to abort traversal on error. 2460 */ 2461 ACPI_STATUS 2462 acpi_ForeachPackageObject(ACPI_OBJECT *pkg, 2463 void (*func)(ACPI_OBJECT *comp, void *arg), void *arg) 2464 { 2465 ACPI_OBJECT *comp; 2466 int i; 2467 2468 if (pkg == NULL || pkg->Type != ACPI_TYPE_PACKAGE) 2469 return (AE_BAD_PARAMETER); 2470 2471 /* Iterate over components */ 2472 i = 0; 2473 comp = pkg->Package.Elements; 2474 for (; i < pkg->Package.Count; i++, comp++) 2475 func(comp, arg); 2476 2477 return (AE_OK); 2478 } 2479 2480 /* 2481 * Find the (index)th resource object in a set. 2482 */ 2483 ACPI_STATUS 2484 acpi_FindIndexedResource(ACPI_BUFFER *buf, int index, ACPI_RESOURCE **resp) 2485 { 2486 ACPI_RESOURCE *rp; 2487 int i; 2488 2489 rp = (ACPI_RESOURCE *)buf->Pointer; 2490 i = index; 2491 while (i-- > 0) { 2492 /* Range check */ 2493 if (rp > (ACPI_RESOURCE *)((u_int8_t *)buf->Pointer + buf->Length)) 2494 return (AE_BAD_PARAMETER); 2495 2496 /* Check for terminator */ 2497 if (rp->Type == ACPI_RESOURCE_TYPE_END_TAG || rp->Length == 0) 2498 return (AE_NOT_FOUND); 2499 rp = ACPI_NEXT_RESOURCE(rp); 2500 } 2501 if (resp != NULL) 2502 *resp = rp; 2503 2504 return (AE_OK); 2505 } 2506 2507 /* 2508 * Append an ACPI_RESOURCE to an ACPI_BUFFER. 2509 * 2510 * Given a pointer to an ACPI_RESOURCE structure, expand the ACPI_BUFFER 2511 * provided to contain it. If the ACPI_BUFFER is empty, allocate a sensible 2512 * backing block. If the ACPI_RESOURCE is NULL, return an empty set of 2513 * resources. 2514 */ 2515 #define ACPI_INITIAL_RESOURCE_BUFFER_SIZE 512 2516 2517 ACPI_STATUS 2518 acpi_AppendBufferResource(ACPI_BUFFER *buf, ACPI_RESOURCE *res) 2519 { 2520 ACPI_RESOURCE *rp; 2521 void *newp; 2522 2523 /* Initialise the buffer if necessary. */ 2524 if (buf->Pointer == NULL) { 2525 buf->Length = ACPI_INITIAL_RESOURCE_BUFFER_SIZE; 2526 if ((buf->Pointer = AcpiOsAllocate(buf->Length)) == NULL) 2527 return (AE_NO_MEMORY); 2528 rp = (ACPI_RESOURCE *)buf->Pointer; 2529 rp->Type = ACPI_RESOURCE_TYPE_END_TAG; 2530 rp->Length = ACPI_RS_SIZE_MIN; 2531 } 2532 if (res == NULL) 2533 return (AE_OK); 2534 2535 /* 2536 * Scan the current buffer looking for the terminator. 2537 * This will either find the terminator or hit the end 2538 * of the buffer and return an error. 2539 */ 2540 rp = (ACPI_RESOURCE *)buf->Pointer; 2541 for (;;) { 2542 /* Range check, don't go outside the buffer */ 2543 if (rp >= (ACPI_RESOURCE *)((u_int8_t *)buf->Pointer + buf->Length)) 2544 return (AE_BAD_PARAMETER); 2545 if (rp->Type == ACPI_RESOURCE_TYPE_END_TAG || rp->Length == 0) 2546 break; 2547 rp = ACPI_NEXT_RESOURCE(rp); 2548 } 2549 2550 /* 2551 * Check the size of the buffer and expand if required. 2552 * 2553 * Required size is: 2554 * size of existing resources before terminator + 2555 * size of new resource and header + 2556 * size of terminator. 2557 * 2558 * Note that this loop should really only run once, unless 2559 * for some reason we are stuffing a *really* huge resource. 2560 */ 2561 while ((((u_int8_t *)rp - (u_int8_t *)buf->Pointer) + 2562 res->Length + ACPI_RS_SIZE_NO_DATA + 2563 ACPI_RS_SIZE_MIN) >= buf->Length) { 2564 if ((newp = AcpiOsAllocate(buf->Length * 2)) == NULL) 2565 return (AE_NO_MEMORY); 2566 bcopy(buf->Pointer, newp, buf->Length); 2567 rp = (ACPI_RESOURCE *)((u_int8_t *)newp + 2568 ((u_int8_t *)rp - (u_int8_t *)buf->Pointer)); 2569 AcpiOsFree(buf->Pointer); 2570 buf->Pointer = newp; 2571 buf->Length += buf->Length; 2572 } 2573 2574 /* Insert the new resource. */ 2575 bcopy(res, rp, res->Length + ACPI_RS_SIZE_NO_DATA); 2576 2577 /* And add the terminator. */ 2578 rp = ACPI_NEXT_RESOURCE(rp); 2579 rp->Type = ACPI_RESOURCE_TYPE_END_TAG; 2580 rp->Length = ACPI_RS_SIZE_MIN; 2581 2582 return (AE_OK); 2583 } 2584 2585 UINT8 2586 acpi_DSMQuery(ACPI_HANDLE h, uint8_t *uuid, int revision) 2587 { 2588 /* 2589 * ACPI spec 9.1.1 defines this. 2590 * 2591 * "Arg2: Function Index Represents a specific function whose meaning is 2592 * specific to the UUID and Revision ID. Function indices should start 2593 * with 1. Function number zero is a query function (see the special 2594 * return code defined below)." 2595 */ 2596 ACPI_BUFFER buf; 2597 ACPI_OBJECT *obj; 2598 UINT8 ret = 0; 2599 2600 if (!ACPI_SUCCESS(acpi_EvaluateDSM(h, uuid, revision, 0, NULL, &buf))) { 2601 ACPI_INFO(("Failed to enumerate DSM functions\n")); 2602 return (0); 2603 } 2604 2605 obj = (ACPI_OBJECT *)buf.Pointer; 2606 KASSERT(obj, ("Object not allowed to be NULL\n")); 2607 2608 /* 2609 * From ACPI 6.2 spec 9.1.1: 2610 * If Function Index = 0, a Buffer containing a function index bitfield. 2611 * Otherwise, the return value and type depends on the UUID and revision 2612 * ID (see below). 2613 */ 2614 switch (obj->Type) { 2615 case ACPI_TYPE_BUFFER: 2616 ret = *(uint8_t *)obj->Buffer.Pointer; 2617 break; 2618 case ACPI_TYPE_INTEGER: 2619 ACPI_BIOS_WARNING((AE_INFO, 2620 "Possibly buggy BIOS with ACPI_TYPE_INTEGER for function enumeration\n")); 2621 ret = obj->Integer.Value & 0xFF; 2622 break; 2623 default: 2624 ACPI_WARNING((AE_INFO, "Unexpected return type %u\n", obj->Type)); 2625 }; 2626 2627 AcpiOsFree(obj); 2628 return ret; 2629 } 2630 2631 /* 2632 * DSM may return multiple types depending on the function. It is therefore 2633 * unsafe to use the typed evaluation. It is highly recommended that the caller 2634 * check the type of the returned object. 2635 */ 2636 ACPI_STATUS 2637 acpi_EvaluateDSM(ACPI_HANDLE handle, uint8_t *uuid, int revision, 2638 uint64_t function, union acpi_object *package, ACPI_BUFFER *out_buf) 2639 { 2640 ACPI_OBJECT arg[4]; 2641 ACPI_OBJECT_LIST arglist; 2642 ACPI_BUFFER buf; 2643 ACPI_STATUS status; 2644 2645 if (out_buf == NULL) 2646 return (AE_NO_MEMORY); 2647 2648 arg[0].Type = ACPI_TYPE_BUFFER; 2649 arg[0].Buffer.Length = ACPI_UUID_LENGTH; 2650 arg[0].Buffer.Pointer = uuid; 2651 arg[1].Type = ACPI_TYPE_INTEGER; 2652 arg[1].Integer.Value = revision; 2653 arg[2].Type = ACPI_TYPE_INTEGER; 2654 arg[2].Integer.Value = function; 2655 if (package) { 2656 arg[3] = *package; 2657 } else { 2658 arg[3].Type = ACPI_TYPE_PACKAGE; 2659 arg[3].Package.Count = 0; 2660 arg[3].Package.Elements = NULL; 2661 } 2662 2663 arglist.Pointer = arg; 2664 arglist.Count = 4; 2665 buf.Pointer = NULL; 2666 buf.Length = ACPI_ALLOCATE_BUFFER; 2667 status = AcpiEvaluateObject(handle, "_DSM", &arglist, &buf); 2668 if (ACPI_FAILURE(status)) 2669 return (status); 2670 2671 KASSERT(ACPI_SUCCESS(status), ("Unexpected status")); 2672 2673 *out_buf = buf; 2674 return (status); 2675 } 2676 2677 ACPI_STATUS 2678 acpi_EvaluateOSC(ACPI_HANDLE handle, uint8_t *uuid, int revision, int count, 2679 uint32_t *caps_in, uint32_t *caps_out, bool query) 2680 { 2681 ACPI_OBJECT arg[4], *ret; 2682 ACPI_OBJECT_LIST arglist; 2683 ACPI_BUFFER buf; 2684 ACPI_STATUS status; 2685 2686 arglist.Pointer = arg; 2687 arglist.Count = 4; 2688 arg[0].Type = ACPI_TYPE_BUFFER; 2689 arg[0].Buffer.Length = ACPI_UUID_LENGTH; 2690 arg[0].Buffer.Pointer = uuid; 2691 arg[1].Type = ACPI_TYPE_INTEGER; 2692 arg[1].Integer.Value = revision; 2693 arg[2].Type = ACPI_TYPE_INTEGER; 2694 arg[2].Integer.Value = count; 2695 arg[3].Type = ACPI_TYPE_BUFFER; 2696 arg[3].Buffer.Length = count * sizeof(*caps_in); 2697 arg[3].Buffer.Pointer = (uint8_t *)caps_in; 2698 caps_in[0] = query ? 1 : 0; 2699 buf.Pointer = NULL; 2700 buf.Length = ACPI_ALLOCATE_BUFFER; 2701 status = AcpiEvaluateObjectTyped(handle, "_OSC", &arglist, &buf, 2702 ACPI_TYPE_BUFFER); 2703 if (ACPI_FAILURE(status)) 2704 return (status); 2705 if (caps_out != NULL) { 2706 ret = buf.Pointer; 2707 if (ret->Buffer.Length != count * sizeof(*caps_out)) { 2708 AcpiOsFree(buf.Pointer); 2709 return (AE_BUFFER_OVERFLOW); 2710 } 2711 bcopy(ret->Buffer.Pointer, caps_out, ret->Buffer.Length); 2712 } 2713 AcpiOsFree(buf.Pointer); 2714 return (status); 2715 } 2716 2717 /* 2718 * Set interrupt model. 2719 */ 2720 ACPI_STATUS 2721 acpi_SetIntrModel(int model) 2722 { 2723 2724 return (acpi_SetInteger(ACPI_ROOT_OBJECT, "_PIC", model)); 2725 } 2726 2727 /* 2728 * Walk subtables of a table and call a callback routine for each 2729 * subtable. The caller should provide the first subtable and a 2730 * pointer to the end of the table. This can be used to walk tables 2731 * such as MADT and SRAT that use subtable entries. 2732 */ 2733 void 2734 acpi_walk_subtables(void *first, void *end, acpi_subtable_handler *handler, 2735 void *arg) 2736 { 2737 ACPI_SUBTABLE_HEADER *entry; 2738 2739 for (entry = first; (void *)entry < end; ) { 2740 /* Avoid an infinite loop if we hit a bogus entry. */ 2741 if (entry->Length < sizeof(ACPI_SUBTABLE_HEADER)) 2742 return; 2743 2744 handler(entry, arg); 2745 entry = ACPI_ADD_PTR(ACPI_SUBTABLE_HEADER, entry, entry->Length); 2746 } 2747 } 2748 2749 /* 2750 * DEPRECATED. This interface has serious deficiencies and will be 2751 * removed. 2752 * 2753 * Immediately enter the sleep state. In the old model, acpiconf(8) ran 2754 * rc.suspend and rc.resume so we don't have to notify devd(8) to do this. 2755 */ 2756 ACPI_STATUS 2757 acpi_SetSleepState(struct acpi_softc *sc, int state) 2758 { 2759 static int once; 2760 2761 if (!once) { 2762 device_printf(sc->acpi_dev, 2763 "warning: acpi_SetSleepState() deprecated, need to update your software\n"); 2764 once = 1; 2765 } 2766 return (acpi_EnterSleepState(sc, state)); 2767 } 2768 2769 #if defined(__amd64__) || defined(__i386__) 2770 static void 2771 acpi_sleep_force_task(void *context) 2772 { 2773 struct acpi_softc *sc = (struct acpi_softc *)context; 2774 2775 if (ACPI_FAILURE(acpi_EnterSleepState(sc, sc->acpi_next_sstate))) 2776 device_printf(sc->acpi_dev, "force sleep state S%d failed\n", 2777 sc->acpi_next_sstate); 2778 } 2779 2780 static void 2781 acpi_sleep_force(void *arg) 2782 { 2783 struct acpi_softc *sc = (struct acpi_softc *)arg; 2784 2785 device_printf(sc->acpi_dev, 2786 "suspend request timed out, forcing sleep now\n"); 2787 /* 2788 * XXX Suspending from callout causes freezes in DEVICE_SUSPEND(). 2789 * Suspend from acpi_task thread instead. 2790 */ 2791 if (ACPI_FAILURE(AcpiOsExecute(OSL_NOTIFY_HANDLER, 2792 acpi_sleep_force_task, sc))) 2793 device_printf(sc->acpi_dev, "AcpiOsExecute() for sleeping failed\n"); 2794 } 2795 #endif 2796 2797 /* 2798 * Request that the system enter the given suspend state. All /dev/apm 2799 * devices and devd(8) will be notified. Userland then has a chance to 2800 * save state and acknowledge the request. The system sleeps once all 2801 * acks are in. 2802 */ 2803 int 2804 acpi_ReqSleepState(struct acpi_softc *sc, int state) 2805 { 2806 #if defined(__amd64__) || defined(__i386__) 2807 struct apm_clone_data *clone; 2808 ACPI_STATUS status; 2809 2810 if (state < ACPI_STATE_S1 || state > ACPI_S_STATES_MAX) 2811 return (EINVAL); 2812 if (!acpi_sleep_states[state]) 2813 return (EOPNOTSUPP); 2814 2815 /* 2816 * If a reboot/shutdown/suspend request is already in progress or 2817 * suspend is blocked due to an upcoming shutdown, just return. 2818 */ 2819 if (rebooting || sc->acpi_next_sstate != 0 || suspend_blocked) { 2820 return (0); 2821 } 2822 2823 /* Wait until sleep is enabled. */ 2824 while (sc->acpi_sleep_disabled) { 2825 AcpiOsSleep(1000); 2826 } 2827 2828 ACPI_LOCK(acpi); 2829 2830 sc->acpi_next_sstate = state; 2831 2832 /* S5 (soft-off) should be entered directly with no waiting. */ 2833 if (state == ACPI_STATE_S5) { 2834 ACPI_UNLOCK(acpi); 2835 status = acpi_EnterSleepState(sc, state); 2836 return (ACPI_SUCCESS(status) ? 0 : ENXIO); 2837 } 2838 2839 /* Record the pending state and notify all apm devices. */ 2840 STAILQ_FOREACH(clone, &sc->apm_cdevs, entries) { 2841 clone->notify_status = APM_EV_NONE; 2842 if ((clone->flags & ACPI_EVF_DEVD) == 0) { 2843 selwakeuppri(&clone->sel_read, PZERO); 2844 KNOTE_LOCKED(&clone->sel_read.si_note, 0); 2845 } 2846 } 2847 2848 /* If devd(8) is not running, immediately enter the sleep state. */ 2849 if (!devctl_process_running()) { 2850 ACPI_UNLOCK(acpi); 2851 status = acpi_EnterSleepState(sc, state); 2852 return (ACPI_SUCCESS(status) ? 0 : ENXIO); 2853 } 2854 2855 /* 2856 * Set a timeout to fire if userland doesn't ack the suspend request 2857 * in time. This way we still eventually go to sleep if we were 2858 * overheating or running low on battery, even if userland is hung. 2859 * We cancel this timeout once all userland acks are in or the 2860 * suspend request is aborted. 2861 */ 2862 callout_reset(&sc->susp_force_to, 10 * hz, acpi_sleep_force, sc); 2863 ACPI_UNLOCK(acpi); 2864 2865 /* Now notify devd(8) also. */ 2866 acpi_UserNotify("Suspend", ACPI_ROOT_OBJECT, state); 2867 2868 return (0); 2869 #else 2870 /* This platform does not support acpi suspend/resume. */ 2871 return (EOPNOTSUPP); 2872 #endif 2873 } 2874 2875 /* 2876 * Acknowledge (or reject) a pending sleep state. The caller has 2877 * prepared for suspend and is now ready for it to proceed. If the 2878 * error argument is non-zero, it indicates suspend should be cancelled 2879 * and gives an errno value describing why. Once all votes are in, 2880 * we suspend the system. 2881 */ 2882 int 2883 acpi_AckSleepState(struct apm_clone_data *clone, int error) 2884 { 2885 #if defined(__amd64__) || defined(__i386__) 2886 struct acpi_softc *sc; 2887 int ret, sleeping; 2888 2889 /* If no pending sleep state, return an error. */ 2890 ACPI_LOCK(acpi); 2891 sc = clone->acpi_sc; 2892 if (sc->acpi_next_sstate == 0) { 2893 ACPI_UNLOCK(acpi); 2894 return (ENXIO); 2895 } 2896 2897 /* Caller wants to abort suspend process. */ 2898 if (error) { 2899 sc->acpi_next_sstate = 0; 2900 callout_stop(&sc->susp_force_to); 2901 device_printf(sc->acpi_dev, 2902 "listener on %s cancelled the pending suspend\n", 2903 devtoname(clone->cdev)); 2904 ACPI_UNLOCK(acpi); 2905 return (0); 2906 } 2907 2908 /* 2909 * Mark this device as acking the suspend request. Then, walk through 2910 * all devices, seeing if they agree yet. We only count devices that 2911 * are writable since read-only devices couldn't ack the request. 2912 */ 2913 sleeping = TRUE; 2914 clone->notify_status = APM_EV_ACKED; 2915 STAILQ_FOREACH(clone, &sc->apm_cdevs, entries) { 2916 if ((clone->flags & ACPI_EVF_WRITE) != 0 && 2917 clone->notify_status != APM_EV_ACKED) { 2918 sleeping = FALSE; 2919 break; 2920 } 2921 } 2922 2923 /* If all devices have voted "yes", we will suspend now. */ 2924 if (sleeping) 2925 callout_stop(&sc->susp_force_to); 2926 ACPI_UNLOCK(acpi); 2927 ret = 0; 2928 if (sleeping) { 2929 if (ACPI_FAILURE(acpi_EnterSleepState(sc, sc->acpi_next_sstate))) 2930 ret = ENODEV; 2931 } 2932 return (ret); 2933 #else 2934 /* This platform does not support acpi suspend/resume. */ 2935 return (EOPNOTSUPP); 2936 #endif 2937 } 2938 2939 static void 2940 acpi_sleep_enable(void *arg) 2941 { 2942 struct acpi_softc *sc = (struct acpi_softc *)arg; 2943 2944 ACPI_LOCK_ASSERT(acpi); 2945 2946 /* Reschedule if the system is not fully up and running. */ 2947 if (!AcpiGbl_SystemAwakeAndRunning) { 2948 callout_schedule(&acpi_sleep_timer, hz * ACPI_MINIMUM_AWAKETIME); 2949 return; 2950 } 2951 2952 sc->acpi_sleep_disabled = FALSE; 2953 } 2954 2955 static ACPI_STATUS 2956 acpi_sleep_disable(struct acpi_softc *sc) 2957 { 2958 ACPI_STATUS status; 2959 2960 /* Fail if the system is not fully up and running. */ 2961 if (!AcpiGbl_SystemAwakeAndRunning) 2962 return (AE_ERROR); 2963 2964 ACPI_LOCK(acpi); 2965 status = sc->acpi_sleep_disabled ? AE_ERROR : AE_OK; 2966 sc->acpi_sleep_disabled = TRUE; 2967 ACPI_UNLOCK(acpi); 2968 2969 return (status); 2970 } 2971 2972 enum acpi_sleep_state { 2973 ACPI_SS_NONE, 2974 ACPI_SS_GPE_SET, 2975 ACPI_SS_DEV_SUSPEND, 2976 ACPI_SS_SLP_PREP, 2977 ACPI_SS_SLEPT, 2978 }; 2979 2980 /* 2981 * Enter the desired system sleep state. 2982 * 2983 * Currently we support S1-S5 but S4 is only S4BIOS 2984 */ 2985 static ACPI_STATUS 2986 acpi_EnterSleepState(struct acpi_softc *sc, int state) 2987 { 2988 register_t intr; 2989 ACPI_STATUS status; 2990 ACPI_EVENT_STATUS power_button_status; 2991 enum acpi_sleep_state slp_state; 2992 int sleep_result; 2993 2994 ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, state); 2995 2996 if (state < ACPI_STATE_S1 || state > ACPI_S_STATES_MAX) 2997 return_ACPI_STATUS (AE_BAD_PARAMETER); 2998 if (!acpi_sleep_states[state]) { 2999 device_printf(sc->acpi_dev, "Sleep state S%d not supported by BIOS\n", 3000 state); 3001 return (AE_SUPPORT); 3002 } 3003 3004 /* Re-entry once we're suspending is not allowed. */ 3005 status = acpi_sleep_disable(sc); 3006 if (ACPI_FAILURE(status)) { 3007 device_printf(sc->acpi_dev, 3008 "suspend request ignored (not ready yet)\n"); 3009 return (status); 3010 } 3011 3012 if (state == ACPI_STATE_S5) { 3013 /* 3014 * Shut down cleanly and power off. This will call us back through the 3015 * shutdown handlers. 3016 */ 3017 shutdown_nice(RB_POWEROFF); 3018 return_ACPI_STATUS (AE_OK); 3019 } 3020 3021 EVENTHANDLER_INVOKE(power_suspend_early); 3022 stop_all_proc(); 3023 EVENTHANDLER_INVOKE(power_suspend); 3024 3025 #ifdef EARLY_AP_STARTUP 3026 MPASS(mp_ncpus == 1 || smp_started); 3027 thread_lock(curthread); 3028 sched_bind(curthread, 0); 3029 thread_unlock(curthread); 3030 #else 3031 if (smp_started) { 3032 thread_lock(curthread); 3033 sched_bind(curthread, 0); 3034 thread_unlock(curthread); 3035 } 3036 #endif 3037 3038 /* 3039 * Be sure to hold Giant across DEVICE_SUSPEND/RESUME since non-MPSAFE 3040 * drivers need this. 3041 */ 3042 mtx_lock(&Giant); 3043 3044 slp_state = ACPI_SS_NONE; 3045 3046 sc->acpi_sstate = state; 3047 3048 /* Enable any GPEs as appropriate and requested by the user. */ 3049 acpi_wake_prep_walk(state); 3050 slp_state = ACPI_SS_GPE_SET; 3051 3052 /* 3053 * Inform all devices that we are going to sleep. If at least one 3054 * device fails, DEVICE_SUSPEND() automatically resumes the tree. 3055 * 3056 * XXX Note that a better two-pass approach with a 'veto' pass 3057 * followed by a "real thing" pass would be better, but the current 3058 * bus interface does not provide for this. 3059 */ 3060 if (DEVICE_SUSPEND(root_bus) != 0) { 3061 device_printf(sc->acpi_dev, "device_suspend failed\n"); 3062 goto backout; 3063 } 3064 slp_state = ACPI_SS_DEV_SUSPEND; 3065 3066 status = AcpiEnterSleepStatePrep(state); 3067 if (ACPI_FAILURE(status)) { 3068 device_printf(sc->acpi_dev, "AcpiEnterSleepStatePrep failed - %s\n", 3069 AcpiFormatException(status)); 3070 goto backout; 3071 } 3072 slp_state = ACPI_SS_SLP_PREP; 3073 3074 if (sc->acpi_sleep_delay > 0) 3075 DELAY(sc->acpi_sleep_delay * 1000000); 3076 3077 suspendclock(); 3078 intr = intr_disable(); 3079 if (state != ACPI_STATE_S1) { 3080 sleep_result = acpi_sleep_machdep(sc, state); 3081 acpi_wakeup_machdep(sc, state, sleep_result, 0); 3082 3083 /* 3084 * XXX According to ACPI specification SCI_EN bit should be restored 3085 * by ACPI platform (BIOS, firmware) to its pre-sleep state. 3086 * Unfortunately some BIOSes fail to do that and that leads to 3087 * unexpected and serious consequences during wake up like a system 3088 * getting stuck in SMI handlers. 3089 * This hack is picked up from Linux, which claims that it follows 3090 * Windows behavior. 3091 */ 3092 if (sleep_result == 1 && state != ACPI_STATE_S4) 3093 AcpiWriteBitRegister(ACPI_BITREG_SCI_ENABLE, ACPI_ENABLE_EVENT); 3094 3095 if (sleep_result == 1 && state == ACPI_STATE_S3) { 3096 /* 3097 * Prevent mis-interpretation of the wakeup by power button 3098 * as a request for power off. 3099 * Ideally we should post an appropriate wakeup event, 3100 * perhaps using acpi_event_power_button_wake or alike. 3101 * 3102 * Clearing of power button status after wakeup is mandated 3103 * by ACPI specification in section "Fixed Power Button". 3104 * 3105 * XXX As of ACPICA 20121114 AcpiGetEventStatus provides 3106 * status as 0/1 corressponding to inactive/active despite 3107 * its type being ACPI_EVENT_STATUS. In other words, 3108 * we should not test for ACPI_EVENT_FLAG_SET for time being. 3109 */ 3110 if (ACPI_SUCCESS(AcpiGetEventStatus(ACPI_EVENT_POWER_BUTTON, 3111 &power_button_status)) && power_button_status != 0) { 3112 AcpiClearEvent(ACPI_EVENT_POWER_BUTTON); 3113 device_printf(sc->acpi_dev, 3114 "cleared fixed power button status\n"); 3115 } 3116 } 3117 3118 intr_restore(intr); 3119 3120 /* call acpi_wakeup_machdep() again with interrupt enabled */ 3121 acpi_wakeup_machdep(sc, state, sleep_result, 1); 3122 3123 AcpiLeaveSleepStatePrep(state); 3124 3125 if (sleep_result == -1) 3126 goto backout; 3127 3128 /* Re-enable ACPI hardware on wakeup from sleep state 4. */ 3129 if (state == ACPI_STATE_S4) 3130 AcpiEnable(); 3131 } else { 3132 status = AcpiEnterSleepState(state); 3133 intr_restore(intr); 3134 AcpiLeaveSleepStatePrep(state); 3135 if (ACPI_FAILURE(status)) { 3136 device_printf(sc->acpi_dev, "AcpiEnterSleepState failed - %s\n", 3137 AcpiFormatException(status)); 3138 goto backout; 3139 } 3140 } 3141 slp_state = ACPI_SS_SLEPT; 3142 3143 /* 3144 * Back out state according to how far along we got in the suspend 3145 * process. This handles both the error and success cases. 3146 */ 3147 backout: 3148 if (slp_state >= ACPI_SS_SLP_PREP) 3149 resumeclock(); 3150 if (slp_state >= ACPI_SS_GPE_SET) { 3151 acpi_wake_prep_walk(state); 3152 sc->acpi_sstate = ACPI_STATE_S0; 3153 } 3154 if (slp_state >= ACPI_SS_DEV_SUSPEND) 3155 DEVICE_RESUME(root_bus); 3156 if (slp_state >= ACPI_SS_SLP_PREP) 3157 AcpiLeaveSleepState(state); 3158 if (slp_state >= ACPI_SS_SLEPT) { 3159 #if defined(__i386__) || defined(__amd64__) 3160 /* NB: we are still using ACPI timecounter at this point. */ 3161 resume_TSC(); 3162 #endif 3163 acpi_resync_clock(sc); 3164 acpi_enable_fixed_events(sc); 3165 } 3166 sc->acpi_next_sstate = 0; 3167 3168 mtx_unlock(&Giant); 3169 3170 #ifdef EARLY_AP_STARTUP 3171 thread_lock(curthread); 3172 sched_unbind(curthread); 3173 thread_unlock(curthread); 3174 #else 3175 if (smp_started) { 3176 thread_lock(curthread); 3177 sched_unbind(curthread); 3178 thread_unlock(curthread); 3179 } 3180 #endif 3181 3182 resume_all_proc(); 3183 3184 EVENTHANDLER_INVOKE(power_resume); 3185 3186 /* Allow another sleep request after a while. */ 3187 callout_schedule(&acpi_sleep_timer, hz * ACPI_MINIMUM_AWAKETIME); 3188 3189 /* Run /etc/rc.resume after we are back. */ 3190 if (devctl_process_running()) 3191 acpi_UserNotify("Resume", ACPI_ROOT_OBJECT, state); 3192 3193 return_ACPI_STATUS (status); 3194 } 3195 3196 static void 3197 acpi_resync_clock(struct acpi_softc *sc) 3198 { 3199 3200 /* 3201 * Warm up timecounter again and reset system clock. 3202 */ 3203 (void)timecounter->tc_get_timecount(timecounter); 3204 (void)timecounter->tc_get_timecount(timecounter); 3205 inittodr(time_second + sc->acpi_sleep_delay); 3206 } 3207 3208 /* Enable or disable the device's wake GPE. */ 3209 int 3210 acpi_wake_set_enable(device_t dev, int enable) 3211 { 3212 struct acpi_prw_data prw; 3213 ACPI_STATUS status; 3214 int flags; 3215 3216 /* Make sure the device supports waking the system and get the GPE. */ 3217 if (acpi_parse_prw(acpi_get_handle(dev), &prw) != 0) 3218 return (ENXIO); 3219 3220 flags = acpi_get_flags(dev); 3221 if (enable) { 3222 status = AcpiSetGpeWakeMask(prw.gpe_handle, prw.gpe_bit, 3223 ACPI_GPE_ENABLE); 3224 if (ACPI_FAILURE(status)) { 3225 device_printf(dev, "enable wake failed\n"); 3226 return (ENXIO); 3227 } 3228 acpi_set_flags(dev, flags | ACPI_FLAG_WAKE_ENABLED); 3229 } else { 3230 status = AcpiSetGpeWakeMask(prw.gpe_handle, prw.gpe_bit, 3231 ACPI_GPE_DISABLE); 3232 if (ACPI_FAILURE(status)) { 3233 device_printf(dev, "disable wake failed\n"); 3234 return (ENXIO); 3235 } 3236 acpi_set_flags(dev, flags & ~ACPI_FLAG_WAKE_ENABLED); 3237 } 3238 3239 return (0); 3240 } 3241 3242 static int 3243 acpi_wake_sleep_prep(ACPI_HANDLE handle, int sstate) 3244 { 3245 struct acpi_prw_data prw; 3246 device_t dev; 3247 3248 /* Check that this is a wake-capable device and get its GPE. */ 3249 if (acpi_parse_prw(handle, &prw) != 0) 3250 return (ENXIO); 3251 dev = acpi_get_device(handle); 3252 3253 /* 3254 * The destination sleep state must be less than (i.e., higher power) 3255 * or equal to the value specified by _PRW. If this GPE cannot be 3256 * enabled for the next sleep state, then disable it. If it can and 3257 * the user requested it be enabled, turn on any required power resources 3258 * and set _PSW. 3259 */ 3260 if (sstate > prw.lowest_wake) { 3261 AcpiSetGpeWakeMask(prw.gpe_handle, prw.gpe_bit, ACPI_GPE_DISABLE); 3262 if (bootverbose) 3263 device_printf(dev, "wake_prep disabled wake for %s (S%d)\n", 3264 acpi_name(handle), sstate); 3265 } else if (dev && (acpi_get_flags(dev) & ACPI_FLAG_WAKE_ENABLED) != 0) { 3266 acpi_pwr_wake_enable(handle, 1); 3267 acpi_SetInteger(handle, "_PSW", 1); 3268 if (bootverbose) 3269 device_printf(dev, "wake_prep enabled for %s (S%d)\n", 3270 acpi_name(handle), sstate); 3271 } 3272 3273 return (0); 3274 } 3275 3276 static int 3277 acpi_wake_run_prep(ACPI_HANDLE handle, int sstate) 3278 { 3279 struct acpi_prw_data prw; 3280 device_t dev; 3281 3282 /* 3283 * Check that this is a wake-capable device and get its GPE. Return 3284 * now if the user didn't enable this device for wake. 3285 */ 3286 if (acpi_parse_prw(handle, &prw) != 0) 3287 return (ENXIO); 3288 dev = acpi_get_device(handle); 3289 if (dev == NULL || (acpi_get_flags(dev) & ACPI_FLAG_WAKE_ENABLED) == 0) 3290 return (0); 3291 3292 /* 3293 * If this GPE couldn't be enabled for the previous sleep state, it was 3294 * disabled before going to sleep so re-enable it. If it was enabled, 3295 * clear _PSW and turn off any power resources it used. 3296 */ 3297 if (sstate > prw.lowest_wake) { 3298 AcpiSetGpeWakeMask(prw.gpe_handle, prw.gpe_bit, ACPI_GPE_ENABLE); 3299 if (bootverbose) 3300 device_printf(dev, "run_prep re-enabled %s\n", acpi_name(handle)); 3301 } else { 3302 acpi_SetInteger(handle, "_PSW", 0); 3303 acpi_pwr_wake_enable(handle, 0); 3304 if (bootverbose) 3305 device_printf(dev, "run_prep cleaned up for %s\n", 3306 acpi_name(handle)); 3307 } 3308 3309 return (0); 3310 } 3311 3312 static ACPI_STATUS 3313 acpi_wake_prep(ACPI_HANDLE handle, UINT32 level, void *context, void **status) 3314 { 3315 int sstate; 3316 3317 /* If suspending, run the sleep prep function, otherwise wake. */ 3318 sstate = *(int *)context; 3319 if (AcpiGbl_SystemAwakeAndRunning) 3320 acpi_wake_sleep_prep(handle, sstate); 3321 else 3322 acpi_wake_run_prep(handle, sstate); 3323 return (AE_OK); 3324 } 3325 3326 /* Walk the tree rooted at acpi0 to prep devices for suspend/resume. */ 3327 static int 3328 acpi_wake_prep_walk(int sstate) 3329 { 3330 ACPI_HANDLE sb_handle; 3331 3332 if (ACPI_SUCCESS(AcpiGetHandle(ACPI_ROOT_OBJECT, "\\_SB_", &sb_handle))) 3333 AcpiWalkNamespace(ACPI_TYPE_DEVICE, sb_handle, 100, 3334 acpi_wake_prep, NULL, &sstate, NULL); 3335 return (0); 3336 } 3337 3338 /* Walk the tree rooted at acpi0 to attach per-device wake sysctls. */ 3339 static int 3340 acpi_wake_sysctl_walk(device_t dev) 3341 { 3342 int error, i, numdevs; 3343 device_t *devlist; 3344 device_t child; 3345 ACPI_STATUS status; 3346 3347 error = device_get_children(dev, &devlist, &numdevs); 3348 if (error != 0 || numdevs == 0) { 3349 if (numdevs == 0) 3350 free(devlist, M_TEMP); 3351 return (error); 3352 } 3353 for (i = 0; i < numdevs; i++) { 3354 child = devlist[i]; 3355 acpi_wake_sysctl_walk(child); 3356 if (!device_is_attached(child)) 3357 continue; 3358 status = AcpiEvaluateObject(acpi_get_handle(child), "_PRW", NULL, NULL); 3359 if (ACPI_SUCCESS(status)) { 3360 SYSCTL_ADD_PROC(device_get_sysctl_ctx(child), 3361 SYSCTL_CHILDREN(device_get_sysctl_tree(child)), OID_AUTO, 3362 "wake", CTLTYPE_INT | CTLFLAG_RW, child, 0, 3363 acpi_wake_set_sysctl, "I", "Device set to wake the system"); 3364 } 3365 } 3366 free(devlist, M_TEMP); 3367 3368 return (0); 3369 } 3370 3371 /* Enable or disable wake from userland. */ 3372 static int 3373 acpi_wake_set_sysctl(SYSCTL_HANDLER_ARGS) 3374 { 3375 int enable, error; 3376 device_t dev; 3377 3378 dev = (device_t)arg1; 3379 enable = (acpi_get_flags(dev) & ACPI_FLAG_WAKE_ENABLED) ? 1 : 0; 3380 3381 error = sysctl_handle_int(oidp, &enable, 0, req); 3382 if (error != 0 || req->newptr == NULL) 3383 return (error); 3384 if (enable != 0 && enable != 1) 3385 return (EINVAL); 3386 3387 return (acpi_wake_set_enable(dev, enable)); 3388 } 3389 3390 /* Parse a device's _PRW into a structure. */ 3391 int 3392 acpi_parse_prw(ACPI_HANDLE h, struct acpi_prw_data *prw) 3393 { 3394 ACPI_STATUS status; 3395 ACPI_BUFFER prw_buffer; 3396 ACPI_OBJECT *res, *res2; 3397 int error, i, power_count; 3398 3399 if (h == NULL || prw == NULL) 3400 return (EINVAL); 3401 3402 /* 3403 * The _PRW object (7.2.9) is only required for devices that have the 3404 * ability to wake the system from a sleeping state. 3405 */ 3406 error = EINVAL; 3407 prw_buffer.Pointer = NULL; 3408 prw_buffer.Length = ACPI_ALLOCATE_BUFFER; 3409 status = AcpiEvaluateObject(h, "_PRW", NULL, &prw_buffer); 3410 if (ACPI_FAILURE(status)) 3411 return (ENOENT); 3412 res = (ACPI_OBJECT *)prw_buffer.Pointer; 3413 if (res == NULL) 3414 return (ENOENT); 3415 if (!ACPI_PKG_VALID(res, 2)) 3416 goto out; 3417 3418 /* 3419 * Element 1 of the _PRW object: 3420 * The lowest power system sleeping state that can be entered while still 3421 * providing wake functionality. The sleeping state being entered must 3422 * be less than (i.e., higher power) or equal to this value. 3423 */ 3424 if (acpi_PkgInt32(res, 1, &prw->lowest_wake) != 0) 3425 goto out; 3426 3427 /* 3428 * Element 0 of the _PRW object: 3429 */ 3430 switch (res->Package.Elements[0].Type) { 3431 case ACPI_TYPE_INTEGER: 3432 /* 3433 * If the data type of this package element is numeric, then this 3434 * _PRW package element is the bit index in the GPEx_EN, in the 3435 * GPE blocks described in the FADT, of the enable bit that is 3436 * enabled for the wake event. 3437 */ 3438 prw->gpe_handle = NULL; 3439 prw->gpe_bit = res->Package.Elements[0].Integer.Value; 3440 error = 0; 3441 break; 3442 case ACPI_TYPE_PACKAGE: 3443 /* 3444 * If the data type of this package element is a package, then this 3445 * _PRW package element is itself a package containing two 3446 * elements. The first is an object reference to the GPE Block 3447 * device that contains the GPE that will be triggered by the wake 3448 * event. The second element is numeric and it contains the bit 3449 * index in the GPEx_EN, in the GPE Block referenced by the 3450 * first element in the package, of the enable bit that is enabled for 3451 * the wake event. 3452 * 3453 * For example, if this field is a package then it is of the form: 3454 * Package() {\_SB.PCI0.ISA.GPE, 2} 3455 */ 3456 res2 = &res->Package.Elements[0]; 3457 if (!ACPI_PKG_VALID(res2, 2)) 3458 goto out; 3459 prw->gpe_handle = acpi_GetReference(NULL, &res2->Package.Elements[0]); 3460 if (prw->gpe_handle == NULL) 3461 goto out; 3462 if (acpi_PkgInt32(res2, 1, &prw->gpe_bit) != 0) 3463 goto out; 3464 error = 0; 3465 break; 3466 default: 3467 goto out; 3468 } 3469 3470 /* Elements 2 to N of the _PRW object are power resources. */ 3471 power_count = res->Package.Count - 2; 3472 if (power_count > ACPI_PRW_MAX_POWERRES) { 3473 printf("ACPI device %s has too many power resources\n", acpi_name(h)); 3474 power_count = 0; 3475 } 3476 prw->power_res_count = power_count; 3477 for (i = 0; i < power_count; i++) 3478 prw->power_res[i] = res->Package.Elements[i]; 3479 3480 out: 3481 if (prw_buffer.Pointer != NULL) 3482 AcpiOsFree(prw_buffer.Pointer); 3483 return (error); 3484 } 3485 3486 /* 3487 * ACPI Event Handlers 3488 */ 3489 3490 /* System Event Handlers (registered by EVENTHANDLER_REGISTER) */ 3491 3492 static void 3493 acpi_system_eventhandler_sleep(void *arg, int state) 3494 { 3495 struct acpi_softc *sc = (struct acpi_softc *)arg; 3496 int ret; 3497 3498 ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, state); 3499 3500 /* Check if button action is disabled or unknown. */ 3501 if (state == ACPI_STATE_UNKNOWN) 3502 return; 3503 3504 /* Request that the system prepare to enter the given suspend state. */ 3505 ret = acpi_ReqSleepState(sc, state); 3506 if (ret != 0) 3507 device_printf(sc->acpi_dev, 3508 "request to enter state S%d failed (err %d)\n", state, ret); 3509 3510 return_VOID; 3511 } 3512 3513 static void 3514 acpi_system_eventhandler_wakeup(void *arg, int state) 3515 { 3516 3517 ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, state); 3518 3519 /* Currently, nothing to do for wakeup. */ 3520 3521 return_VOID; 3522 } 3523 3524 /* 3525 * ACPICA Event Handlers (FixedEvent, also called from button notify handler) 3526 */ 3527 static void 3528 acpi_invoke_sleep_eventhandler(void *context) 3529 { 3530 3531 EVENTHANDLER_INVOKE(acpi_sleep_event, *(int *)context); 3532 } 3533 3534 static void 3535 acpi_invoke_wake_eventhandler(void *context) 3536 { 3537 3538 EVENTHANDLER_INVOKE(acpi_wakeup_event, *(int *)context); 3539 } 3540 3541 UINT32 3542 acpi_event_power_button_sleep(void *context) 3543 { 3544 struct acpi_softc *sc = (struct acpi_softc *)context; 3545 3546 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__); 3547 3548 if (ACPI_FAILURE(AcpiOsExecute(OSL_NOTIFY_HANDLER, 3549 acpi_invoke_sleep_eventhandler, &sc->acpi_power_button_sx))) 3550 return_VALUE (ACPI_INTERRUPT_NOT_HANDLED); 3551 return_VALUE (ACPI_INTERRUPT_HANDLED); 3552 } 3553 3554 UINT32 3555 acpi_event_power_button_wake(void *context) 3556 { 3557 struct acpi_softc *sc = (struct acpi_softc *)context; 3558 3559 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__); 3560 3561 if (ACPI_FAILURE(AcpiOsExecute(OSL_NOTIFY_HANDLER, 3562 acpi_invoke_wake_eventhandler, &sc->acpi_power_button_sx))) 3563 return_VALUE (ACPI_INTERRUPT_NOT_HANDLED); 3564 return_VALUE (ACPI_INTERRUPT_HANDLED); 3565 } 3566 3567 UINT32 3568 acpi_event_sleep_button_sleep(void *context) 3569 { 3570 struct acpi_softc *sc = (struct acpi_softc *)context; 3571 3572 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__); 3573 3574 if (ACPI_FAILURE(AcpiOsExecute(OSL_NOTIFY_HANDLER, 3575 acpi_invoke_sleep_eventhandler, &sc->acpi_sleep_button_sx))) 3576 return_VALUE (ACPI_INTERRUPT_NOT_HANDLED); 3577 return_VALUE (ACPI_INTERRUPT_HANDLED); 3578 } 3579 3580 UINT32 3581 acpi_event_sleep_button_wake(void *context) 3582 { 3583 struct acpi_softc *sc = (struct acpi_softc *)context; 3584 3585 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__); 3586 3587 if (ACPI_FAILURE(AcpiOsExecute(OSL_NOTIFY_HANDLER, 3588 acpi_invoke_wake_eventhandler, &sc->acpi_sleep_button_sx))) 3589 return_VALUE (ACPI_INTERRUPT_NOT_HANDLED); 3590 return_VALUE (ACPI_INTERRUPT_HANDLED); 3591 } 3592 3593 /* 3594 * XXX This static buffer is suboptimal. There is no locking so only 3595 * use this for single-threaded callers. 3596 */ 3597 char * 3598 acpi_name(ACPI_HANDLE handle) 3599 { 3600 ACPI_BUFFER buf; 3601 static char data[256]; 3602 3603 buf.Length = sizeof(data); 3604 buf.Pointer = data; 3605 3606 if (handle && ACPI_SUCCESS(AcpiGetName(handle, ACPI_FULL_PATHNAME, &buf))) 3607 return (data); 3608 return ("(unknown)"); 3609 } 3610 3611 /* 3612 * Debugging/bug-avoidance. Avoid trying to fetch info on various 3613 * parts of the namespace. 3614 */ 3615 int 3616 acpi_avoid(ACPI_HANDLE handle) 3617 { 3618 char *cp, *env, *np; 3619 int len; 3620 3621 np = acpi_name(handle); 3622 if (*np == '\\') 3623 np++; 3624 if ((env = kern_getenv("debug.acpi.avoid")) == NULL) 3625 return (0); 3626 3627 /* Scan the avoid list checking for a match */ 3628 cp = env; 3629 for (;;) { 3630 while (*cp != 0 && isspace(*cp)) 3631 cp++; 3632 if (*cp == 0) 3633 break; 3634 len = 0; 3635 while (cp[len] != 0 && !isspace(cp[len])) 3636 len++; 3637 if (!strncmp(cp, np, len)) { 3638 freeenv(env); 3639 return(1); 3640 } 3641 cp += len; 3642 } 3643 freeenv(env); 3644 3645 return (0); 3646 } 3647 3648 /* 3649 * Debugging/bug-avoidance. Disable ACPI subsystem components. 3650 */ 3651 int 3652 acpi_disabled(char *subsys) 3653 { 3654 char *cp, *env; 3655 int len; 3656 3657 if ((env = kern_getenv("debug.acpi.disabled")) == NULL) 3658 return (0); 3659 if (strcmp(env, "all") == 0) { 3660 freeenv(env); 3661 return (1); 3662 } 3663 3664 /* Scan the disable list, checking for a match. */ 3665 cp = env; 3666 for (;;) { 3667 while (*cp != '\0' && isspace(*cp)) 3668 cp++; 3669 if (*cp == '\0') 3670 break; 3671 len = 0; 3672 while (cp[len] != '\0' && !isspace(cp[len])) 3673 len++; 3674 if (strncmp(cp, subsys, len) == 0) { 3675 freeenv(env); 3676 return (1); 3677 } 3678 cp += len; 3679 } 3680 freeenv(env); 3681 3682 return (0); 3683 } 3684 3685 static void 3686 acpi_lookup(void *arg, const char *name, device_t *dev) 3687 { 3688 ACPI_HANDLE handle; 3689 3690 if (*dev != NULL) 3691 return; 3692 3693 /* 3694 * Allow any handle name that is specified as an absolute path and 3695 * starts with '\'. We could restrict this to \_SB and friends, 3696 * but see acpi_probe_children() for notes on why we scan the entire 3697 * namespace for devices. 3698 * 3699 * XXX: The pathname argument to AcpiGetHandle() should be fixed to 3700 * be const. 3701 */ 3702 if (name[0] != '\\') 3703 return; 3704 if (ACPI_FAILURE(AcpiGetHandle(ACPI_ROOT_OBJECT, __DECONST(char *, name), 3705 &handle))) 3706 return; 3707 *dev = acpi_get_device(handle); 3708 } 3709 3710 /* 3711 * Control interface. 3712 * 3713 * We multiplex ioctls for all participating ACPI devices here. Individual 3714 * drivers wanting to be accessible via /dev/acpi should use the 3715 * register/deregister interface to make their handlers visible. 3716 */ 3717 struct acpi_ioctl_hook 3718 { 3719 TAILQ_ENTRY(acpi_ioctl_hook) link; 3720 u_long cmd; 3721 acpi_ioctl_fn fn; 3722 void *arg; 3723 }; 3724 3725 static TAILQ_HEAD(,acpi_ioctl_hook) acpi_ioctl_hooks; 3726 static int acpi_ioctl_hooks_initted; 3727 3728 int 3729 acpi_register_ioctl(u_long cmd, acpi_ioctl_fn fn, void *arg) 3730 { 3731 struct acpi_ioctl_hook *hp; 3732 3733 if ((hp = malloc(sizeof(*hp), M_ACPIDEV, M_NOWAIT)) == NULL) 3734 return (ENOMEM); 3735 hp->cmd = cmd; 3736 hp->fn = fn; 3737 hp->arg = arg; 3738 3739 ACPI_LOCK(acpi); 3740 if (acpi_ioctl_hooks_initted == 0) { 3741 TAILQ_INIT(&acpi_ioctl_hooks); 3742 acpi_ioctl_hooks_initted = 1; 3743 } 3744 TAILQ_INSERT_TAIL(&acpi_ioctl_hooks, hp, link); 3745 ACPI_UNLOCK(acpi); 3746 3747 return (0); 3748 } 3749 3750 void 3751 acpi_deregister_ioctl(u_long cmd, acpi_ioctl_fn fn) 3752 { 3753 struct acpi_ioctl_hook *hp; 3754 3755 ACPI_LOCK(acpi); 3756 TAILQ_FOREACH(hp, &acpi_ioctl_hooks, link) 3757 if (hp->cmd == cmd && hp->fn == fn) 3758 break; 3759 3760 if (hp != NULL) { 3761 TAILQ_REMOVE(&acpi_ioctl_hooks, hp, link); 3762 free(hp, M_ACPIDEV); 3763 } 3764 ACPI_UNLOCK(acpi); 3765 } 3766 3767 static int 3768 acpiopen(struct cdev *dev, int flag, int fmt, struct thread *td) 3769 { 3770 return (0); 3771 } 3772 3773 static int 3774 acpiclose(struct cdev *dev, int flag, int fmt, struct thread *td) 3775 { 3776 return (0); 3777 } 3778 3779 static int 3780 acpiioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag, struct thread *td) 3781 { 3782 struct acpi_softc *sc; 3783 struct acpi_ioctl_hook *hp; 3784 int error, state; 3785 3786 error = 0; 3787 hp = NULL; 3788 sc = dev->si_drv1; 3789 3790 /* 3791 * Scan the list of registered ioctls, looking for handlers. 3792 */ 3793 ACPI_LOCK(acpi); 3794 if (acpi_ioctl_hooks_initted) 3795 TAILQ_FOREACH(hp, &acpi_ioctl_hooks, link) { 3796 if (hp->cmd == cmd) 3797 break; 3798 } 3799 ACPI_UNLOCK(acpi); 3800 if (hp) 3801 return (hp->fn(cmd, addr, hp->arg)); 3802 3803 /* 3804 * Core ioctls are not permitted for non-writable user. 3805 * Currently, other ioctls just fetch information. 3806 * Not changing system behavior. 3807 */ 3808 if ((flag & FWRITE) == 0) 3809 return (EPERM); 3810 3811 /* Core system ioctls. */ 3812 switch (cmd) { 3813 case ACPIIO_REQSLPSTATE: 3814 state = *(int *)addr; 3815 if (state != ACPI_STATE_S5) 3816 return (acpi_ReqSleepState(sc, state)); 3817 device_printf(sc->acpi_dev, "power off via acpi ioctl not supported\n"); 3818 error = EOPNOTSUPP; 3819 break; 3820 case ACPIIO_ACKSLPSTATE: 3821 error = *(int *)addr; 3822 error = acpi_AckSleepState(sc->acpi_clone, error); 3823 break; 3824 case ACPIIO_SETSLPSTATE: /* DEPRECATED */ 3825 state = *(int *)addr; 3826 if (state < ACPI_STATE_S0 || state > ACPI_S_STATES_MAX) 3827 return (EINVAL); 3828 if (!acpi_sleep_states[state]) 3829 return (EOPNOTSUPP); 3830 if (ACPI_FAILURE(acpi_SetSleepState(sc, state))) 3831 error = ENXIO; 3832 break; 3833 default: 3834 error = ENXIO; 3835 break; 3836 } 3837 3838 return (error); 3839 } 3840 3841 static int 3842 acpi_sname2sstate(const char *sname) 3843 { 3844 int sstate; 3845 3846 if (toupper(sname[0]) == 'S') { 3847 sstate = sname[1] - '0'; 3848 if (sstate >= ACPI_STATE_S0 && sstate <= ACPI_STATE_S5 && 3849 sname[2] == '\0') 3850 return (sstate); 3851 } else if (strcasecmp(sname, "NONE") == 0) 3852 return (ACPI_STATE_UNKNOWN); 3853 return (-1); 3854 } 3855 3856 static const char * 3857 acpi_sstate2sname(int sstate) 3858 { 3859 static const char *snames[] = { "S0", "S1", "S2", "S3", "S4", "S5" }; 3860 3861 if (sstate >= ACPI_STATE_S0 && sstate <= ACPI_STATE_S5) 3862 return (snames[sstate]); 3863 else if (sstate == ACPI_STATE_UNKNOWN) 3864 return ("NONE"); 3865 return (NULL); 3866 } 3867 3868 static int 3869 acpi_supported_sleep_state_sysctl(SYSCTL_HANDLER_ARGS) 3870 { 3871 int error; 3872 struct sbuf sb; 3873 UINT8 state; 3874 3875 sbuf_new(&sb, NULL, 32, SBUF_AUTOEXTEND); 3876 for (state = ACPI_STATE_S1; state < ACPI_S_STATE_COUNT; state++) 3877 if (acpi_sleep_states[state]) 3878 sbuf_printf(&sb, "%s ", acpi_sstate2sname(state)); 3879 sbuf_trim(&sb); 3880 sbuf_finish(&sb); 3881 error = sysctl_handle_string(oidp, sbuf_data(&sb), sbuf_len(&sb), req); 3882 sbuf_delete(&sb); 3883 return (error); 3884 } 3885 3886 static int 3887 acpi_sleep_state_sysctl(SYSCTL_HANDLER_ARGS) 3888 { 3889 char sleep_state[10]; 3890 int error, new_state, old_state; 3891 3892 old_state = *(int *)oidp->oid_arg1; 3893 strlcpy(sleep_state, acpi_sstate2sname(old_state), sizeof(sleep_state)); 3894 error = sysctl_handle_string(oidp, sleep_state, sizeof(sleep_state), req); 3895 if (error == 0 && req->newptr != NULL) { 3896 new_state = acpi_sname2sstate(sleep_state); 3897 if (new_state < ACPI_STATE_S1) 3898 return (EINVAL); 3899 if (new_state < ACPI_S_STATE_COUNT && !acpi_sleep_states[new_state]) 3900 return (EOPNOTSUPP); 3901 if (new_state != old_state) 3902 *(int *)oidp->oid_arg1 = new_state; 3903 } 3904 return (error); 3905 } 3906 3907 /* Inform devctl(4) when we receive a Notify. */ 3908 void 3909 acpi_UserNotify(const char *subsystem, ACPI_HANDLE h, uint8_t notify) 3910 { 3911 char notify_buf[16]; 3912 ACPI_BUFFER handle_buf; 3913 ACPI_STATUS status; 3914 3915 if (subsystem == NULL) 3916 return; 3917 3918 handle_buf.Pointer = NULL; 3919 handle_buf.Length = ACPI_ALLOCATE_BUFFER; 3920 status = AcpiNsHandleToPathname(h, &handle_buf, FALSE); 3921 if (ACPI_FAILURE(status)) 3922 return; 3923 snprintf(notify_buf, sizeof(notify_buf), "notify=0x%02x", notify); 3924 devctl_notify("ACPI", subsystem, handle_buf.Pointer, notify_buf); 3925 AcpiOsFree(handle_buf.Pointer); 3926 } 3927 3928 #ifdef ACPI_DEBUG 3929 /* 3930 * Support for parsing debug options from the kernel environment. 3931 * 3932 * Bits may be set in the AcpiDbgLayer and AcpiDbgLevel debug registers 3933 * by specifying the names of the bits in the debug.acpi.layer and 3934 * debug.acpi.level environment variables. Bits may be unset by 3935 * prefixing the bit name with !. 3936 */ 3937 struct debugtag 3938 { 3939 char *name; 3940 UINT32 value; 3941 }; 3942 3943 static struct debugtag dbg_layer[] = { 3944 {"ACPI_UTILITIES", ACPI_UTILITIES}, 3945 {"ACPI_HARDWARE", ACPI_HARDWARE}, 3946 {"ACPI_EVENTS", ACPI_EVENTS}, 3947 {"ACPI_TABLES", ACPI_TABLES}, 3948 {"ACPI_NAMESPACE", ACPI_NAMESPACE}, 3949 {"ACPI_PARSER", ACPI_PARSER}, 3950 {"ACPI_DISPATCHER", ACPI_DISPATCHER}, 3951 {"ACPI_EXECUTER", ACPI_EXECUTER}, 3952 {"ACPI_RESOURCES", ACPI_RESOURCES}, 3953 {"ACPI_CA_DEBUGGER", ACPI_CA_DEBUGGER}, 3954 {"ACPI_OS_SERVICES", ACPI_OS_SERVICES}, 3955 {"ACPI_CA_DISASSEMBLER", ACPI_CA_DISASSEMBLER}, 3956 {"ACPI_ALL_COMPONENTS", ACPI_ALL_COMPONENTS}, 3957 3958 {"ACPI_AC_ADAPTER", ACPI_AC_ADAPTER}, 3959 {"ACPI_BATTERY", ACPI_BATTERY}, 3960 {"ACPI_BUS", ACPI_BUS}, 3961 {"ACPI_BUTTON", ACPI_BUTTON}, 3962 {"ACPI_EC", ACPI_EC}, 3963 {"ACPI_FAN", ACPI_FAN}, 3964 {"ACPI_POWERRES", ACPI_POWERRES}, 3965 {"ACPI_PROCESSOR", ACPI_PROCESSOR}, 3966 {"ACPI_THERMAL", ACPI_THERMAL}, 3967 {"ACPI_TIMER", ACPI_TIMER}, 3968 {"ACPI_ALL_DRIVERS", ACPI_ALL_DRIVERS}, 3969 {NULL, 0} 3970 }; 3971 3972 static struct debugtag dbg_level[] = { 3973 {"ACPI_LV_INIT", ACPI_LV_INIT}, 3974 {"ACPI_LV_DEBUG_OBJECT", ACPI_LV_DEBUG_OBJECT}, 3975 {"ACPI_LV_INFO", ACPI_LV_INFO}, 3976 {"ACPI_LV_REPAIR", ACPI_LV_REPAIR}, 3977 {"ACPI_LV_ALL_EXCEPTIONS", ACPI_LV_ALL_EXCEPTIONS}, 3978 3979 /* Trace verbosity level 1 [Standard Trace Level] */ 3980 {"ACPI_LV_INIT_NAMES", ACPI_LV_INIT_NAMES}, 3981 {"ACPI_LV_PARSE", ACPI_LV_PARSE}, 3982 {"ACPI_LV_LOAD", ACPI_LV_LOAD}, 3983 {"ACPI_LV_DISPATCH", ACPI_LV_DISPATCH}, 3984 {"ACPI_LV_EXEC", ACPI_LV_EXEC}, 3985 {"ACPI_LV_NAMES", ACPI_LV_NAMES}, 3986 {"ACPI_LV_OPREGION", ACPI_LV_OPREGION}, 3987 {"ACPI_LV_BFIELD", ACPI_LV_BFIELD}, 3988 {"ACPI_LV_TABLES", ACPI_LV_TABLES}, 3989 {"ACPI_LV_VALUES", ACPI_LV_VALUES}, 3990 {"ACPI_LV_OBJECTS", ACPI_LV_OBJECTS}, 3991 {"ACPI_LV_RESOURCES", ACPI_LV_RESOURCES}, 3992 {"ACPI_LV_USER_REQUESTS", ACPI_LV_USER_REQUESTS}, 3993 {"ACPI_LV_PACKAGE", ACPI_LV_PACKAGE}, 3994 {"ACPI_LV_VERBOSITY1", ACPI_LV_VERBOSITY1}, 3995 3996 /* Trace verbosity level 2 [Function tracing and memory allocation] */ 3997 {"ACPI_LV_ALLOCATIONS", ACPI_LV_ALLOCATIONS}, 3998 {"ACPI_LV_FUNCTIONS", ACPI_LV_FUNCTIONS}, 3999 {"ACPI_LV_OPTIMIZATIONS", ACPI_LV_OPTIMIZATIONS}, 4000 {"ACPI_LV_VERBOSITY2", ACPI_LV_VERBOSITY2}, 4001 {"ACPI_LV_ALL", ACPI_LV_ALL}, 4002 4003 /* Trace verbosity level 3 [Threading, I/O, and Interrupts] */ 4004 {"ACPI_LV_MUTEX", ACPI_LV_MUTEX}, 4005 {"ACPI_LV_THREADS", ACPI_LV_THREADS}, 4006 {"ACPI_LV_IO", ACPI_LV_IO}, 4007 {"ACPI_LV_INTERRUPTS", ACPI_LV_INTERRUPTS}, 4008 {"ACPI_LV_VERBOSITY3", ACPI_LV_VERBOSITY3}, 4009 4010 /* Exceptionally verbose output -- also used in the global "DebugLevel" */ 4011 {"ACPI_LV_AML_DISASSEMBLE", ACPI_LV_AML_DISASSEMBLE}, 4012 {"ACPI_LV_VERBOSE_INFO", ACPI_LV_VERBOSE_INFO}, 4013 {"ACPI_LV_FULL_TABLES", ACPI_LV_FULL_TABLES}, 4014 {"ACPI_LV_EVENTS", ACPI_LV_EVENTS}, 4015 {"ACPI_LV_VERBOSE", ACPI_LV_VERBOSE}, 4016 {NULL, 0} 4017 }; 4018 4019 static void 4020 acpi_parse_debug(char *cp, struct debugtag *tag, UINT32 *flag) 4021 { 4022 char *ep; 4023 int i, l; 4024 int set; 4025 4026 while (*cp) { 4027 if (isspace(*cp)) { 4028 cp++; 4029 continue; 4030 } 4031 ep = cp; 4032 while (*ep && !isspace(*ep)) 4033 ep++; 4034 if (*cp == '!') { 4035 set = 0; 4036 cp++; 4037 if (cp == ep) 4038 continue; 4039 } else { 4040 set = 1; 4041 } 4042 l = ep - cp; 4043 for (i = 0; tag[i].name != NULL; i++) { 4044 if (!strncmp(cp, tag[i].name, l)) { 4045 if (set) 4046 *flag |= tag[i].value; 4047 else 4048 *flag &= ~tag[i].value; 4049 } 4050 } 4051 cp = ep; 4052 } 4053 } 4054 4055 static void 4056 acpi_set_debugging(void *junk) 4057 { 4058 char *layer, *level; 4059 4060 if (cold) { 4061 AcpiDbgLayer = 0; 4062 AcpiDbgLevel = 0; 4063 } 4064 4065 layer = kern_getenv("debug.acpi.layer"); 4066 level = kern_getenv("debug.acpi.level"); 4067 if (layer == NULL && level == NULL) 4068 return; 4069 4070 printf("ACPI set debug"); 4071 if (layer != NULL) { 4072 if (strcmp("NONE", layer) != 0) 4073 printf(" layer '%s'", layer); 4074 acpi_parse_debug(layer, &dbg_layer[0], &AcpiDbgLayer); 4075 freeenv(layer); 4076 } 4077 if (level != NULL) { 4078 if (strcmp("NONE", level) != 0) 4079 printf(" level '%s'", level); 4080 acpi_parse_debug(level, &dbg_level[0], &AcpiDbgLevel); 4081 freeenv(level); 4082 } 4083 printf("\n"); 4084 } 4085 4086 SYSINIT(acpi_debugging, SI_SUB_TUNABLES, SI_ORDER_ANY, acpi_set_debugging, 4087 NULL); 4088 4089 static int 4090 acpi_debug_sysctl(SYSCTL_HANDLER_ARGS) 4091 { 4092 int error, *dbg; 4093 struct debugtag *tag; 4094 struct sbuf sb; 4095 char temp[128]; 4096 4097 if (sbuf_new(&sb, NULL, 128, SBUF_AUTOEXTEND) == NULL) 4098 return (ENOMEM); 4099 if (strcmp(oidp->oid_arg1, "debug.acpi.layer") == 0) { 4100 tag = &dbg_layer[0]; 4101 dbg = &AcpiDbgLayer; 4102 } else { 4103 tag = &dbg_level[0]; 4104 dbg = &AcpiDbgLevel; 4105 } 4106 4107 /* Get old values if this is a get request. */ 4108 ACPI_SERIAL_BEGIN(acpi); 4109 if (*dbg == 0) { 4110 sbuf_cpy(&sb, "NONE"); 4111 } else if (req->newptr == NULL) { 4112 for (; tag->name != NULL; tag++) { 4113 if ((*dbg & tag->value) == tag->value) 4114 sbuf_printf(&sb, "%s ", tag->name); 4115 } 4116 } 4117 sbuf_trim(&sb); 4118 sbuf_finish(&sb); 4119 strlcpy(temp, sbuf_data(&sb), sizeof(temp)); 4120 sbuf_delete(&sb); 4121 4122 error = sysctl_handle_string(oidp, temp, sizeof(temp), req); 4123 4124 /* Check for error or no change */ 4125 if (error == 0 && req->newptr != NULL) { 4126 *dbg = 0; 4127 kern_setenv((char *)oidp->oid_arg1, temp); 4128 acpi_set_debugging(NULL); 4129 } 4130 ACPI_SERIAL_END(acpi); 4131 4132 return (error); 4133 } 4134 4135 SYSCTL_PROC(_debug_acpi, OID_AUTO, layer, CTLFLAG_RW | CTLTYPE_STRING, 4136 "debug.acpi.layer", 0, acpi_debug_sysctl, "A", ""); 4137 SYSCTL_PROC(_debug_acpi, OID_AUTO, level, CTLFLAG_RW | CTLTYPE_STRING, 4138 "debug.acpi.level", 0, acpi_debug_sysctl, "A", ""); 4139 #endif /* ACPI_DEBUG */ 4140 4141 static int 4142 acpi_debug_objects_sysctl(SYSCTL_HANDLER_ARGS) 4143 { 4144 int error; 4145 int old; 4146 4147 old = acpi_debug_objects; 4148 error = sysctl_handle_int(oidp, &acpi_debug_objects, 0, req); 4149 if (error != 0 || req->newptr == NULL) 4150 return (error); 4151 if (old == acpi_debug_objects || (old && acpi_debug_objects)) 4152 return (0); 4153 4154 ACPI_SERIAL_BEGIN(acpi); 4155 AcpiGbl_EnableAmlDebugObject = acpi_debug_objects ? TRUE : FALSE; 4156 ACPI_SERIAL_END(acpi); 4157 4158 return (0); 4159 } 4160 4161 static int 4162 acpi_parse_interfaces(char *str, struct acpi_interface *iface) 4163 { 4164 char *p; 4165 size_t len; 4166 int i, j; 4167 4168 p = str; 4169 while (isspace(*p) || *p == ',') 4170 p++; 4171 len = strlen(p); 4172 if (len == 0) 4173 return (0); 4174 p = strdup(p, M_TEMP); 4175 for (i = 0; i < len; i++) 4176 if (p[i] == ',') 4177 p[i] = '\0'; 4178 i = j = 0; 4179 while (i < len) 4180 if (isspace(p[i]) || p[i] == '\0') 4181 i++; 4182 else { 4183 i += strlen(p + i) + 1; 4184 j++; 4185 } 4186 if (j == 0) { 4187 free(p, M_TEMP); 4188 return (0); 4189 } 4190 iface->data = malloc(sizeof(*iface->data) * j, M_TEMP, M_WAITOK); 4191 iface->num = j; 4192 i = j = 0; 4193 while (i < len) 4194 if (isspace(p[i]) || p[i] == '\0') 4195 i++; 4196 else { 4197 iface->data[j] = p + i; 4198 i += strlen(p + i) + 1; 4199 j++; 4200 } 4201 4202 return (j); 4203 } 4204 4205 static void 4206 acpi_free_interfaces(struct acpi_interface *iface) 4207 { 4208 4209 free(iface->data[0], M_TEMP); 4210 free(iface->data, M_TEMP); 4211 } 4212 4213 static void 4214 acpi_reset_interfaces(device_t dev) 4215 { 4216 struct acpi_interface list; 4217 ACPI_STATUS status; 4218 int i; 4219 4220 if (acpi_parse_interfaces(acpi_install_interface, &list) > 0) { 4221 for (i = 0; i < list.num; i++) { 4222 status = AcpiInstallInterface(list.data[i]); 4223 if (ACPI_FAILURE(status)) 4224 device_printf(dev, 4225 "failed to install _OSI(\"%s\"): %s\n", 4226 list.data[i], AcpiFormatException(status)); 4227 else if (bootverbose) 4228 device_printf(dev, "installed _OSI(\"%s\")\n", 4229 list.data[i]); 4230 } 4231 acpi_free_interfaces(&list); 4232 } 4233 if (acpi_parse_interfaces(acpi_remove_interface, &list) > 0) { 4234 for (i = 0; i < list.num; i++) { 4235 status = AcpiRemoveInterface(list.data[i]); 4236 if (ACPI_FAILURE(status)) 4237 device_printf(dev, 4238 "failed to remove _OSI(\"%s\"): %s\n", 4239 list.data[i], AcpiFormatException(status)); 4240 else if (bootverbose) 4241 device_printf(dev, "removed _OSI(\"%s\")\n", 4242 list.data[i]); 4243 } 4244 acpi_free_interfaces(&list); 4245 } 4246 } 4247 4248 static int 4249 acpi_pm_func(u_long cmd, void *arg, ...) 4250 { 4251 int state, acpi_state; 4252 int error; 4253 struct acpi_softc *sc; 4254 va_list ap; 4255 4256 error = 0; 4257 switch (cmd) { 4258 case POWER_CMD_SUSPEND: 4259 sc = (struct acpi_softc *)arg; 4260 if (sc == NULL) { 4261 error = EINVAL; 4262 goto out; 4263 } 4264 4265 va_start(ap, arg); 4266 state = va_arg(ap, int); 4267 va_end(ap); 4268 4269 switch (state) { 4270 case POWER_SLEEP_STATE_STANDBY: 4271 acpi_state = sc->acpi_standby_sx; 4272 break; 4273 case POWER_SLEEP_STATE_SUSPEND: 4274 acpi_state = sc->acpi_suspend_sx; 4275 break; 4276 case POWER_SLEEP_STATE_HIBERNATE: 4277 acpi_state = ACPI_STATE_S4; 4278 break; 4279 default: 4280 error = EINVAL; 4281 goto out; 4282 } 4283 4284 if (ACPI_FAILURE(acpi_EnterSleepState(sc, acpi_state))) 4285 error = ENXIO; 4286 break; 4287 default: 4288 error = EINVAL; 4289 goto out; 4290 } 4291 4292 out: 4293 return (error); 4294 } 4295 4296 static void 4297 acpi_pm_register(void *arg) 4298 { 4299 if (!cold || resource_disabled("acpi", 0)) 4300 return; 4301 4302 power_pm_register(POWER_PM_TYPE_ACPI, acpi_pm_func, NULL); 4303 } 4304 4305 SYSINIT(power, SI_SUB_KLD, SI_ORDER_ANY, acpi_pm_register, NULL); 4306