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