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