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