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
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
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.
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
29 * $FreeBSD: src/sys/dev/acpica/acpi.c,v 1.118 2004/02/19 18:20:03 njl Exp $
30 * $DragonFly: src/sys/dev/acpica5/acpi.c,v 1.4 2004/05/19 22:52:40 dillon Exp $
34 #include <sys/param.h>
35 #include <sys/kernel.h>
37 #include <sys/fcntl.h>
38 #include <sys/malloc.h>
41 #include <sys/ioccom.h>
42 #include <sys/reboot.h>
43 #include <sys/sysctl.h>
44 #include <sys/ctype.h>
45 #include <sys/linker.h>
46 #include <sys/power.h>
49 #include <machine/clock.h>
50 #include <machine/resource.h>
51 #include <machine/bus.h>
53 #include <bus/isa/isavar.h>
56 #include <dev/acpica5/acpivar.h>
57 #include <dev/acpica5/acpiio.h>
60 MALLOC_DEFINE(M_ACPIDEV, "acpidev", "ACPI devices");
62 /* Hooks for the ACPI CA debugging infrastructure */
63 #define _COMPONENT ACPI_BUS
64 ACPI_MODULE_NAME("ACPI")
66 static d_open_t acpiopen;
67 static d_close_t acpiclose;
68 static d_ioctl_t acpiioctl;
70 #define CDEV_MAJOR 152
71 static struct cdevsw acpi_cdevsw = {
78 .old_close = acpiclose,
79 .old_ioctl = acpiioctl
82 static const char* sleep_state_names[] = {
83 "S0", "S1", "S2", "S3", "S4", "S5", "NONE"};
85 /* this has to be static, as the softc is gone when we need it */
86 static int acpi_off_state = ACPI_STATE_S5;
88 #if __FreeBSD_version >= 500000
89 struct mtx acpi_mutex;
92 static int acpi_modevent(struct module *mod, int event, void *junk);
93 static void acpi_identify(driver_t *driver, device_t parent);
94 static int acpi_probe(device_t dev);
95 static int acpi_attach(device_t dev);
96 static device_t acpi_add_child(device_t bus, int order, const char *name,
98 static int acpi_print_child(device_t bus, device_t child);
99 static int acpi_read_ivar(device_t dev, device_t child, int index,
101 static int acpi_write_ivar(device_t dev, device_t child, int index,
103 static int acpi_set_resource(device_t dev, device_t child, int type,
104 int rid, u_long start, u_long count);
105 static int acpi_get_resource(device_t dev, device_t child, int type,
106 int rid, u_long *startp, u_long *countp);
107 static struct resource *acpi_alloc_resource(device_t bus, device_t child,
108 int type, int *rid, u_long start, u_long end,
109 u_long count, u_int flags);
110 static int acpi_release_resource(device_t bus, device_t child, int type,
111 int rid, struct resource *r);
112 static uint32_t acpi_isa_get_logicalid(device_t dev);
113 static int acpi_isa_get_compatid(device_t dev, uint32_t *cids, int count);
114 static int acpi_isa_pnp_probe(device_t bus, device_t child,
115 struct isa_pnp_id *ids);
116 static void acpi_probe_children(device_t bus);
117 static ACPI_STATUS acpi_probe_child(ACPI_HANDLE handle, UINT32 level,
118 void *context, void **status);
119 static void acpi_shutdown_pre_sync(void *arg, int howto);
120 static void acpi_shutdown_final(void *arg, int howto);
121 static void acpi_enable_fixed_events(struct acpi_softc *sc);
122 static void acpi_system_eventhandler_sleep(void *arg, int state);
123 static void acpi_system_eventhandler_wakeup(void *arg, int state);
124 static int acpi_supported_sleep_state_sysctl(SYSCTL_HANDLER_ARGS);
125 static int acpi_sleep_state_sysctl(SYSCTL_HANDLER_ARGS);
126 static int acpi_pm_func(u_long cmd, void *arg, ...);
128 static device_method_t acpi_methods[] = {
129 /* Device interface */
130 DEVMETHOD(device_identify, acpi_identify),
131 DEVMETHOD(device_probe, acpi_probe),
132 DEVMETHOD(device_attach, acpi_attach),
133 DEVMETHOD(device_detach, bus_generic_detach),
134 DEVMETHOD(device_shutdown, bus_generic_shutdown),
135 DEVMETHOD(device_suspend, bus_generic_suspend),
136 DEVMETHOD(device_resume, bus_generic_resume),
139 DEVMETHOD(bus_add_child, acpi_add_child),
140 DEVMETHOD(bus_print_child, acpi_print_child),
141 DEVMETHOD(bus_read_ivar, acpi_read_ivar),
142 DEVMETHOD(bus_write_ivar, acpi_write_ivar),
143 DEVMETHOD(bus_set_resource, acpi_set_resource),
144 DEVMETHOD(bus_get_resource, acpi_get_resource),
145 DEVMETHOD(bus_alloc_resource, acpi_alloc_resource),
146 DEVMETHOD(bus_release_resource, acpi_release_resource),
147 DEVMETHOD(bus_driver_added, bus_generic_driver_added),
148 DEVMETHOD(bus_activate_resource, bus_generic_activate_resource),
149 DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource),
150 DEVMETHOD(bus_setup_intr, bus_generic_setup_intr),
151 DEVMETHOD(bus_teardown_intr, bus_generic_teardown_intr),
154 DEVMETHOD(isa_pnp_probe, acpi_isa_pnp_probe),
159 static driver_t acpi_driver = {
162 sizeof(struct acpi_softc),
165 static devclass_t acpi_devclass;
166 DRIVER_MODULE(acpi, nexus, acpi_driver, acpi_devclass, acpi_modevent, 0);
167 MODULE_VERSION(acpi, 100);
169 SYSCTL_NODE(_debug, OID_AUTO, acpi, CTLFLAG_RW, NULL, "ACPI debugging");
170 static char acpi_ca_version[12];
171 SYSCTL_STRING(_debug_acpi, OID_AUTO, acpi_ca_version, CTLFLAG_RD,
172 acpi_ca_version, 0, "Version of Intel ACPI-CA");
175 * ACPI can only be loaded as a module by the loader; activating it after
176 * system bootstrap time is not useful, and can be fatal to the system.
177 * It also cannot be unloaded, since the entire system bus heirarchy hangs
181 acpi_modevent(struct module *mod, int event, void *junk)
186 printf("The ACPI driver cannot be loaded after boot.\n");
191 if (!cold && power_pm_get_type() == POWER_PM_TYPE_ACPI)
201 * Perform early initialization.
209 static int error, started = 0;
211 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
217 #if __FreeBSD_version >= 500000
218 /* Initialise the ACPI mutex */
219 mtx_init(&acpi_mutex, "ACPI global lock", NULL, MTX_DEF);
222 /* Start up the ACPI CA subsystem. */
224 debugpoint = getenv("debug.acpi.debugger");
226 if (!strcmp(debugpoint, "init"))
227 acpi_EnterDebugger();
231 if (ACPI_FAILURE(error = AcpiInitializeSubsystem())) {
232 printf("ACPI: initialisation failed: %s\n", AcpiFormatException(error));
236 debugpoint = getenv("debug.acpi.debugger");
238 if (!strcmp(debugpoint, "tables"))
239 acpi_EnterDebugger();
244 if (ACPI_FAILURE(error = AcpiLoadTables())) {
245 printf("ACPI: table load failed: %s\n", AcpiFormatException(error));
252 * Detect ACPI, perform early initialisation
255 acpi_identify(driver_t *driver, device_t parent)
259 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
264 /* Check that we haven't been disabled with a hint. */
265 if (resource_disabled("acpi", 0))
268 snprintf(acpi_ca_version, sizeof(acpi_ca_version), "0x%x",
271 /* Make sure we're not being doubly invoked. */
272 if (device_find_child(parent, "acpi", 0) != NULL)
275 /* Initialize ACPI-CA. */
276 if (ACPI_FAILURE(acpi_Startup()))
279 /* Attach the actual ACPI device. */
280 if ((child = BUS_ADD_CHILD(parent, 0, "acpi", 0)) == NULL) {
281 device_printf(parent, "ACPI: could not attach\n");
287 * Fetch some descriptive data from ACPI to put in our attach message
290 acpi_probe(device_t dev)
292 ACPI_TABLE_HEADER th;
299 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
301 if (power_pm_get_type() != POWER_PM_TYPE_NONE &&
302 power_pm_get_type() != POWER_PM_TYPE_ACPI) {
304 device_printf(dev, "Other PM system enabled.\n");
310 if (ACPI_FAILURE(status = AcpiGetTableHeader(ACPI_TABLE_XSDT, 1, &th))) {
311 device_printf(dev, "couldn't get XSDT header: %s\n",
312 AcpiFormatException(status));
315 sbuf_new(&sb, buf, sizeof(buf), SBUF_FIXEDLEN);
316 sbuf_bcat(&sb, th.OemId, 6);
319 sbuf_bcat(&sb, th.OemTableId, 8);
322 device_set_desc_copy(dev, sbuf_data(&sb));
331 acpi_attach(device_t dev)
333 struct acpi_softc *sc;
343 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
345 sc = device_get_softc(dev);
346 bzero(sc, sizeof(*sc));
350 debugpoint = getenv("debug.acpi.debugger");
352 if (!strcmp(debugpoint, "spaces"))
353 acpi_EnterDebugger();
358 /* Install the default address space handlers. */
360 status = AcpiInstallAddressSpaceHandler(ACPI_ROOT_OBJECT,
361 ACPI_ADR_SPACE_SYSTEM_MEMORY, ACPI_DEFAULT_HANDLER, NULL, NULL);
362 if (ACPI_FAILURE(status)) {
363 device_printf(dev, "Could not initialise SystemMemory handler: %s\n",
364 AcpiFormatException(status));
367 status = AcpiInstallAddressSpaceHandler(ACPI_ROOT_OBJECT,
368 ACPI_ADR_SPACE_SYSTEM_IO, ACPI_DEFAULT_HANDLER, NULL, NULL);
369 if (ACPI_FAILURE(status)) {
370 device_printf(dev, "Could not initialise SystemIO handler: %s\n",
371 AcpiFormatException(status));
374 status = AcpiInstallAddressSpaceHandler(ACPI_ROOT_OBJECT,
375 ACPI_ADR_SPACE_PCI_CONFIG, ACPI_DEFAULT_HANDLER, NULL, NULL);
376 if (ACPI_FAILURE(status)) {
377 device_printf(dev, "could not initialise PciConfig handler: %s\n",
378 AcpiFormatException(status));
383 * Bring ACPI fully online.
385 * Note that some systems (specifically, those with namespace evaluation
386 * issues that require the avoidance of parts of the namespace) must
387 * avoid running _INI and _STA on everything, as well as dodging the final
390 * For these devices, we set ACPI_NO_DEVICE_INIT and ACPI_NO_OBJECT_INIT).
392 * XXX We should arrange for the object init pass after we have attached
393 * all our child devices, but on many systems it works here.
396 debugpoint = getenv("debug.acpi.debugger");
398 if (!strcmp(debugpoint, "enable"))
399 acpi_EnterDebugger();
404 if (testenv("debug.acpi.avoid"))
405 flags = ACPI_NO_DEVICE_INIT | ACPI_NO_OBJECT_INIT;
406 if (ACPI_FAILURE(status = AcpiEnableSubsystem(flags))) {
407 device_printf(dev, "Could not enable ACPI: %s\n",
408 AcpiFormatException(status));
413 * Call the ECDT probe function to provide EC functionality before
414 * the namespace has been evaluated.
416 acpi_ec_ecdt_probe(dev);
418 if (ACPI_FAILURE(status = AcpiInitializeObjects(flags))) {
419 device_printf(dev, "Could not initialize ACPI objects: %s\n",
420 AcpiFormatException(status));
425 * Setup our sysctl tree.
427 * XXX: This doesn't check to make sure that none of these fail.
429 sysctl_ctx_init(&sc->acpi_sysctl_ctx);
430 sc->acpi_sysctl_tree = SYSCTL_ADD_NODE(&sc->acpi_sysctl_ctx,
431 SYSCTL_STATIC_CHILDREN(_hw), OID_AUTO,
432 device_get_name(dev), CTLFLAG_RD, 0, "");
433 SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
434 OID_AUTO, "supported_sleep_state", CTLTYPE_STRING | CTLFLAG_RD,
435 0, 0, acpi_supported_sleep_state_sysctl, "A", "");
436 SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
437 OID_AUTO, "power_button_state", CTLTYPE_STRING | CTLFLAG_RW,
438 &sc->acpi_power_button_sx, 0, acpi_sleep_state_sysctl, "A", "");
439 SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
440 OID_AUTO, "sleep_button_state", CTLTYPE_STRING | CTLFLAG_RW,
441 &sc->acpi_sleep_button_sx, 0, acpi_sleep_state_sysctl, "A", "");
442 SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
443 OID_AUTO, "lid_switch_state", CTLTYPE_STRING | CTLFLAG_RW,
444 &sc->acpi_lid_switch_sx, 0, acpi_sleep_state_sysctl, "A", "");
445 SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
446 OID_AUTO, "standby_state", CTLTYPE_STRING | CTLFLAG_RW,
447 &sc->acpi_standby_sx, 0, acpi_sleep_state_sysctl, "A", "");
448 SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
449 OID_AUTO, "suspend_state", CTLTYPE_STRING | CTLFLAG_RW,
450 &sc->acpi_suspend_sx, 0, acpi_sleep_state_sysctl, "A", "");
451 SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
452 OID_AUTO, "sleep_delay", CTLFLAG_RD | CTLFLAG_RW,
453 &sc->acpi_sleep_delay, 0, "sleep delay");
454 SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
455 OID_AUTO, "s4bios", CTLFLAG_RD | CTLFLAG_RW,
456 &sc->acpi_s4bios, 0, "S4BIOS mode");
457 SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
458 OID_AUTO, "verbose", CTLFLAG_RD | CTLFLAG_RW,
459 &sc->acpi_verbose, 0, "verbose mode");
460 SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
461 OID_AUTO, "disable_on_poweroff", CTLFLAG_RD | CTLFLAG_RW,
462 &sc->acpi_disable_on_poweroff, 0, "ACPI subsystem disable on poweroff");
465 * Default to 5 seconds before sleeping to give some machines time to
468 sc->acpi_sleep_delay = 5;
469 sc->acpi_disable_on_poweroff = 1;
471 sc->acpi_verbose = 1;
472 if ((env = getenv("hw.acpi.verbose")) && strcmp(env, "0")) {
473 sc->acpi_verbose = 1;
477 /* Only enable S4BIOS by default if the FACS says it is available. */
478 if (AcpiGbl_FACS->S4Bios_f != 0)
482 * Dispatch the default sleep state to devices.
483 * TBD: should be configured from userland policy manager.
485 sc->acpi_power_button_sx = ACPI_POWER_BUTTON_DEFAULT_SX;
486 sc->acpi_sleep_button_sx = ACPI_SLEEP_BUTTON_DEFAULT_SX;
487 sc->acpi_lid_switch_sx = ACPI_LID_SWITCH_DEFAULT_SX;
488 sc->acpi_standby_sx = ACPI_STATE_S1;
489 sc->acpi_suspend_sx = ACPI_STATE_S3;
491 acpi_enable_fixed_events(sc);
494 * Scan the namespace and attach/initialise children.
497 debugpoint = getenv("debug.acpi.debugger");
499 if (!strcmp(debugpoint, "probe"))
500 acpi_EnterDebugger();
505 /* Register our shutdown handlers */
506 EVENTHANDLER_REGISTER(shutdown_pre_sync, acpi_shutdown_pre_sync, sc,
508 EVENTHANDLER_REGISTER(shutdown_final, acpi_shutdown_final, sc,
512 * Register our acpi event handlers.
513 * XXX should be configurable eg. via userland policy manager.
515 EVENTHANDLER_REGISTER(acpi_sleep_event, acpi_system_eventhandler_sleep,
516 sc, ACPI_EVENT_PRI_LAST);
517 EVENTHANDLER_REGISTER(acpi_wakeup_event, acpi_system_eventhandler_wakeup,
518 sc, ACPI_EVENT_PRI_LAST);
520 /* Flag our initial states. */
521 sc->acpi_enabled = 1;
522 sc->acpi_sstate = ACPI_STATE_S0;
523 sc->acpi_sleep_disabled = 0;
525 /* Create the control device */
526 cdevsw_add(&acpi_cdevsw, 0, 0);
527 sc->acpi_dev_t = make_dev(&acpi_cdevsw, 0, UID_ROOT, GID_WHEEL, 0644,
529 sc->acpi_dev_t->si_drv1 = sc;
532 debugpoint = getenv("debug.acpi.debugger");
534 if (strcmp(debugpoint, "running") == 0)
535 acpi_EnterDebugger();
540 #ifdef ACPI_USE_THREADS
541 if ((error = acpi_task_thread_init()))
545 if ((error = acpi_machdep_init(dev)))
548 /* Register ACPI again to pass the correct argument of pm_func. */
549 power_pm_register(POWER_PM_TYPE_ACPI, acpi_pm_func, sc);
551 if (!acpi_disabled("bus"))
552 acpi_probe_children(dev);
558 return_VALUE (error);
562 * Handle a new device being added
565 acpi_add_child(device_t bus, int order, const char *name, int unit)
567 struct acpi_device *ad;
570 ad = malloc(sizeof(*ad), M_ACPIDEV, M_INTWAIT | M_ZERO);
572 resource_list_init(&ad->ad_rl);
574 child = device_add_child_ordered(bus, order, name, unit);
576 device_set_ivars(child, ad);
581 acpi_print_child(device_t bus, device_t child)
583 struct acpi_device *adev = device_get_ivars(child);
584 struct resource_list *rl = &adev->ad_rl;
587 retval += bus_print_child_header(bus, child);
588 retval += resource_list_print_type(rl, "port", SYS_RES_IOPORT, "%#lx");
589 retval += resource_list_print_type(rl, "iomem", SYS_RES_MEMORY, "%#lx");
590 retval += resource_list_print_type(rl, "irq", SYS_RES_IRQ, "%ld");
591 retval += resource_list_print_type(rl, "drq", SYS_RES_DRQ, "%ld");
592 retval += bus_print_child_footer(bus, child);
599 * Handle per-device ivars
602 acpi_read_ivar(device_t dev, device_t child, int index, uintptr_t *result)
604 struct acpi_device *ad;
606 if ((ad = device_get_ivars(child)) == NULL) {
607 printf("device has no ivars\n");
611 /* ACPI and ISA compatibility ivars */
613 case ACPI_IVAR_HANDLE:
614 *(ACPI_HANDLE *)result = ad->ad_handle;
616 case ACPI_IVAR_MAGIC:
617 *(int *)result = ad->ad_magic;
619 case ACPI_IVAR_PRIVATE:
620 *(void **)result = ad->ad_private;
622 case ISA_IVAR_VENDORID:
623 case ISA_IVAR_SERIAL:
624 case ISA_IVAR_COMPATID:
627 case ISA_IVAR_LOGICALID:
628 *(int *)result = acpi_isa_get_logicalid(child);
638 acpi_write_ivar(device_t dev, device_t child, int index, uintptr_t value)
640 struct acpi_device *ad;
642 if ((ad = device_get_ivars(child)) == NULL) {
643 printf("device has no ivars\n");
648 case ACPI_IVAR_HANDLE:
649 ad->ad_handle = (ACPI_HANDLE)value;
651 case ACPI_IVAR_MAGIC:
652 ad->ad_magic = (int)value;
654 case ACPI_IVAR_PRIVATE:
655 ad->ad_private = (void *)value;
658 panic("bad ivar write request (%d)", index);
666 acpi_get_handle(device_t dev)
671 if (BUS_READ_IVAR(device_get_parent(dev), dev, ACPI_IVAR_HANDLE, &up))
678 acpi_set_handle(device_t dev, ACPI_HANDLE h)
683 return (BUS_WRITE_IVAR(device_get_parent(dev), dev, ACPI_IVAR_HANDLE, up));
687 acpi_get_magic(device_t dev)
692 if (BUS_READ_IVAR(device_get_parent(dev), dev, ACPI_IVAR_MAGIC, &up))
699 acpi_set_magic(device_t dev, int m)
704 return (BUS_WRITE_IVAR(device_get_parent(dev), dev, ACPI_IVAR_MAGIC, up));
708 acpi_get_private(device_t dev)
713 if (BUS_READ_IVAR(device_get_parent(dev), dev, ACPI_IVAR_PRIVATE, &up))
720 acpi_set_private(device_t dev, void *p)
725 return (BUS_WRITE_IVAR(device_get_parent(dev), dev, ACPI_IVAR_PRIVATE, up));
729 acpi_get_type(device_t dev)
734 if ((h = acpi_get_handle(dev)) == NULL)
735 return (ACPI_TYPE_NOT_FOUND);
736 if (AcpiGetType(h, &t) != AE_OK)
737 return (ACPI_TYPE_NOT_FOUND);
742 * Handle child resource allocation/removal
745 acpi_set_resource(device_t dev, device_t child, int type, int rid,
746 u_long start, u_long count)
748 struct acpi_device *ad = device_get_ivars(child);
749 struct resource_list *rl = &ad->ad_rl;
751 resource_list_add(rl, type, rid, start, start + count -1, count);
757 acpi_get_resource(device_t dev, device_t child, int type, int rid,
758 u_long *startp, u_long *countp)
760 struct acpi_device *ad = device_get_ivars(child);
761 struct resource_list *rl = &ad->ad_rl;
762 struct resource_list_entry *rle;
764 rle = resource_list_find(rl, type, rid);
769 *startp = rle->start;
771 *countp = rle->count;
776 static struct resource *
777 acpi_alloc_resource(device_t bus, device_t child, int type, int *rid,
778 u_long start, u_long end, u_long count, u_int flags)
780 struct acpi_device *ad = device_get_ivars(child);
781 struct resource_list *rl = &ad->ad_rl;
783 return (resource_list_alloc(rl, bus, child, type, rid, start, end, count,
788 acpi_release_resource(device_t bus, device_t child, int type, int rid, struct resource *r)
790 struct acpi_device *ad = device_get_ivars(child);
791 struct resource_list *rl = &ad->ad_rl;
793 return (resource_list_release(rl, bus, child, type, rid, r));
796 /* Allocate an IO port or memory resource, given its GAS. */
798 acpi_bus_alloc_gas(device_t dev, int *rid, ACPI_GENERIC_ADDRESS *gas)
802 if (gas == NULL || !ACPI_VALID_ADDRESS(gas->Address) ||
803 gas->RegisterBitWidth < 8)
806 switch (gas->AddressSpaceId) {
807 case ACPI_ADR_SPACE_SYSTEM_MEMORY:
808 type = SYS_RES_MEMORY;
810 case ACPI_ADR_SPACE_SYSTEM_IO:
811 type = SYS_RES_IOPORT;
817 bus_set_resource(dev, type, *rid, gas->Address, gas->RegisterBitWidth / 8);
818 return (bus_alloc_resource(dev, type, rid, 0, ~0, 1, RF_ACTIVE));
822 * Handle ISA-like devices probing for a PnP ID to match.
824 #define PNP_EISAID(s) \
825 ((((s[0] - '@') & 0x1f) << 2) \
826 | (((s[1] - '@') & 0x18) >> 3) \
827 | (((s[1] - '@') & 0x07) << 13) \
828 | (((s[2] - '@') & 0x1f) << 8) \
829 | (PNP_HEXTONUM(s[4]) << 16) \
830 | (PNP_HEXTONUM(s[3]) << 20) \
831 | (PNP_HEXTONUM(s[6]) << 24) \
832 | (PNP_HEXTONUM(s[5]) << 28))
835 acpi_isa_get_logicalid(device_t dev)
837 ACPI_DEVICE_INFO *devinfo;
844 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
848 buf.Length = ACPI_ALLOCATE_BUFFER;
852 /* Fetch and validate the HID. */
853 if ((h = acpi_get_handle(dev)) == NULL)
855 error = AcpiGetObjectInfo(h, &buf);
856 if (ACPI_FAILURE(error))
858 devinfo = (ACPI_DEVICE_INFO *)buf.Pointer;
860 if ((devinfo->Valid & ACPI_VALID_HID) != 0)
861 pnpid = PNP_EISAID(devinfo->HardwareId.Value);
864 if (buf.Pointer != NULL)
865 AcpiOsFree(buf.Pointer);
867 return_VALUE (pnpid);
871 acpi_isa_get_compatid(device_t dev, uint32_t *cids, int count)
873 ACPI_DEVICE_INFO *devinfo;
881 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
886 buf.Length = ACPI_ALLOCATE_BUFFER;
890 /* Fetch and validate the CID */
891 if ((h = acpi_get_handle(dev)) == NULL)
893 error = AcpiGetObjectInfo(h, &buf);
894 if (ACPI_FAILURE(error))
896 devinfo = (ACPI_DEVICE_INFO *)buf.Pointer;
897 if ((devinfo->Valid & ACPI_VALID_CID) == 0)
900 if (devinfo->CompatibilityId.Count < count)
901 count = devinfo->CompatibilityId.Count;
902 for (i = 0; i < count; i++) {
903 if (strncmp(devinfo->CompatibilityId.Id[i].Value, "PNP", 3) != 0)
905 *pnpid++ = PNP_EISAID(devinfo->CompatibilityId.Id[i].Value);
910 if (buf.Pointer != NULL)
911 AcpiOsFree(buf.Pointer);
913 return_VALUE (valid);
917 acpi_isa_pnp_probe(device_t bus, device_t child, struct isa_pnp_id *ids)
919 int result, cid_count, i;
920 uint32_t lid, cids[8];
922 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
925 * ISA-style drivers attached to ACPI may persist and
926 * probe manually if we return ENOENT. We never want
927 * that to happen, so don't ever return it.
931 /* Scan the supplied IDs for a match */
932 lid = acpi_isa_get_logicalid(child);
933 cid_count = acpi_isa_get_compatid(child, cids, 8);
934 while (ids && ids->ip_id) {
935 if (lid == ids->ip_id) {
939 for (i = 0; i < cid_count; i++) {
940 if (cids[i] == ids->ip_id) {
949 return_VALUE (result);
953 * Scan relevant portions of the ACPI namespace and attach child devices.
955 * Note that we only expect to find devices in the \_PR_, \_TZ_, \_SI_ and
956 * \_SB_ scopes, and \_PR_ and \_TZ_ become obsolete in the ACPI 2.0 spec.
959 acpi_probe_children(device_t bus)
963 static char *scopes[] = {"\\_PR_", "\\_TZ_", "\\_SI", "\\_SB_", NULL};
966 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
969 /* Create any static children by calling device identify methods. */
970 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "device identify routines\n"));
971 bus_generic_probe(bus);
974 * Scan the namespace and insert placeholders for all the devices that
977 * Note that we use AcpiWalkNamespace rather than AcpiGetDevices because
978 * we want to create nodes for all devices, not just those that are
979 * currently present. (This assumes that we don't want to create/remove
980 * devices as they appear, which might be smarter.)
982 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "namespace scan\n"));
983 for (i = 0; scopes[i] != NULL; i++) {
984 status = AcpiGetHandle(ACPI_ROOT_OBJECT, scopes[i], &parent);
985 if (ACPI_SUCCESS(status)) {
986 AcpiWalkNamespace(ACPI_TYPE_ANY, parent, 100, acpi_probe_child,
992 * Scan all of the child devices we have created and let them probe/attach.
994 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "first bus_generic_attach\n"));
995 bus_generic_attach(bus);
998 * Some of these children may have attached others as part of their attach
999 * process (eg. the root PCI bus driver), so rescan.
1001 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "second bus_generic_attach\n"));
1002 bus_generic_attach(bus);
1004 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "done attaching children\n"));
1009 * Evaluate a child device and determine whether we might attach a device to
1013 acpi_probe_child(ACPI_HANDLE handle, UINT32 level, void *context, void **status)
1015 ACPI_OBJECT_TYPE type;
1016 device_t child, bus = (device_t)context;
1018 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1020 /* Skip this device if we think we'll have trouble with it. */
1021 if (acpi_avoid(handle))
1022 return_ACPI_STATUS (AE_OK);
1024 if (ACPI_SUCCESS(AcpiGetType(handle, &type))) {
1026 case ACPI_TYPE_DEVICE:
1027 case ACPI_TYPE_PROCESSOR:
1028 case ACPI_TYPE_THERMAL:
1029 case ACPI_TYPE_POWER:
1030 if (acpi_disabled("children"))
1034 * Create a placeholder device for this node. Sort the placeholder
1035 * so that the probe/attach passes will run breadth-first.
1037 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "scanning '%s'\n",
1038 acpi_name(handle)));
1039 child = BUS_ADD_CHILD(bus, level * 10, NULL, -1);
1042 acpi_set_handle(child, handle);
1045 * Check that the device is present. If it's not present,
1046 * leave it disabled (so that we have a device_t attached to
1047 * the handle, but we don't probe it).
1049 if (type == ACPI_TYPE_DEVICE && !acpi_DeviceIsPresent(child)) {
1050 device_disable(child);
1055 * Get the device's resource settings and attach them.
1056 * Note that if the device has _PRS but no _CRS, we need
1057 * to decide when it's appropriate to try to configure the
1058 * device. Ignore the return value here; it's OK for the
1059 * device not to have any resources.
1061 acpi_parse_resources(child, handle, &acpi_res_parse_set);
1063 /* If we're debugging, probe/attach now rather than later */
1064 ACPI_DEBUG_EXEC(device_probe_and_attach(child));
1069 return_ACPI_STATUS (AE_OK);
1073 acpi_shutdown_pre_sync(void *arg, int howto)
1075 struct acpi_softc *sc = arg;
1080 * Disable all ACPI events before soft off, otherwise the system
1081 * will be turned on again on some laptops.
1083 * XXX this should probably be restricted to masking some events just
1084 * before powering down, since we may still need ACPI during the
1087 if (sc->acpi_disable_on_poweroff)
1092 acpi_shutdown_final(void *arg, int howto)
1098 if ((howto & RB_POWEROFF) != 0) {
1099 printf("Powering system off using ACPI\n");
1100 status = AcpiEnterSleepStatePrep(acpi_off_state);
1101 if (ACPI_FAILURE(status)) {
1102 printf("AcpiEnterSleepStatePrep failed - %s\n",
1103 AcpiFormatException(status));
1106 ACPI_DISABLE_IRQS();
1107 status = AcpiEnterSleepState(acpi_off_state);
1108 if (ACPI_FAILURE(status)) {
1109 printf("ACPI power-off failed - %s\n", AcpiFormatException(status));
1112 printf("ACPI power-off failed - timeout\n");
1115 printf("Shutting down ACPI\n");
1121 acpi_enable_fixed_events(struct acpi_softc *sc)
1123 static int first_time = 1;
1127 /* Enable and clear fixed events and install handlers. */
1128 if (AcpiGbl_FADT != NULL && AcpiGbl_FADT->PwrButton == 0) {
1129 AcpiClearEvent(ACPI_EVENT_POWER_BUTTON);
1130 AcpiInstallFixedEventHandler(ACPI_EVENT_POWER_BUTTON,
1131 acpi_event_power_button_sleep, sc);
1133 device_printf(sc->acpi_dev, "Power Button (fixed)\n");
1135 if (AcpiGbl_FADT != NULL && AcpiGbl_FADT->SleepButton == 0) {
1136 AcpiClearEvent(ACPI_EVENT_SLEEP_BUTTON);
1137 AcpiInstallFixedEventHandler(ACPI_EVENT_SLEEP_BUTTON,
1138 acpi_event_sleep_button_sleep, sc);
1140 device_printf(sc->acpi_dev, "Sleep Button (fixed)\n");
1147 * Returns true if the device is actually present and should
1148 * be attached to. This requires the present, enabled, UI-visible
1149 * and diagnostics-passed bits to be set.
1152 acpi_DeviceIsPresent(device_t dev)
1154 ACPI_DEVICE_INFO *devinfo;
1163 if ((h = acpi_get_handle(dev)) == NULL)
1166 buf.Length = ACPI_ALLOCATE_BUFFER;
1167 error = AcpiGetObjectInfo(h, &buf);
1168 if (ACPI_FAILURE(error))
1170 devinfo = (ACPI_DEVICE_INFO *)buf.Pointer;
1172 /* If no _STA method, must be present */
1173 if ((devinfo->Valid & ACPI_VALID_STA) == 0)
1176 /* Return true for 'present' and 'functioning' */
1177 if ((devinfo->CurrentStatus & 0x9) == 0x9)
1180 AcpiOsFree(buf.Pointer);
1185 * Returns true if the battery is actually present and inserted.
1188 acpi_BatteryIsPresent(device_t dev)
1190 ACPI_DEVICE_INFO *devinfo;
1199 if ((h = acpi_get_handle(dev)) == NULL)
1202 buf.Length = ACPI_ALLOCATE_BUFFER;
1203 error = AcpiGetObjectInfo(h, &buf);
1204 if (ACPI_FAILURE(error))
1206 devinfo = (ACPI_DEVICE_INFO *)buf.Pointer;
1208 /* If no _STA method, must be present */
1209 if ((devinfo->Valid & ACPI_VALID_STA) == 0)
1212 /* Return true for 'present' and 'functioning' */
1213 if ((devinfo->CurrentStatus & 0x19) == 0x19)
1216 AcpiOsFree(buf.Pointer);
1221 * Match a HID string against a device
1224 acpi_MatchHid(device_t dev, char *hid)
1226 ACPI_DEVICE_INFO *devinfo;
1237 if ((h = acpi_get_handle(dev)) == NULL)
1240 buf.Length = ACPI_ALLOCATE_BUFFER;
1241 error = AcpiGetObjectInfo(h, &buf);
1242 if (ACPI_FAILURE(error))
1244 devinfo = (ACPI_DEVICE_INFO *)buf.Pointer;
1246 if ((devinfo->Valid & ACPI_VALID_HID) != 0 &&
1247 strcmp(hid, devinfo->HardwareId.Value) == 0)
1249 else if ((devinfo->Valid & ACPI_VALID_CID) != 0) {
1250 for (i = 0; i < devinfo->CompatibilityId.Count; i++) {
1251 if (strcmp(hid, devinfo->CompatibilityId.Id[i].Value) == 0) {
1258 AcpiOsFree(buf.Pointer);
1263 * Return the handle of a named object within our scope, ie. that of (parent)
1264 * or one if its parents.
1267 acpi_GetHandleInScope(ACPI_HANDLE parent, char *path, ACPI_HANDLE *result)
1274 /* Walk back up the tree to the root */
1276 status = AcpiGetHandle(parent, path, &r);
1277 if (ACPI_SUCCESS(status)) {
1281 if (status != AE_NOT_FOUND)
1283 if (ACPI_FAILURE(AcpiGetParent(parent, &r)))
1284 return (AE_NOT_FOUND);
1290 * Allocate a buffer with a preset data size.
1293 acpi_AllocBuffer(int size)
1297 buf = malloc(size + sizeof(*buf), M_ACPIDEV, M_INTWAIT);
1299 buf->Pointer = (void *)(buf + 1);
1304 * Evaluate a path that should return an integer.
1307 acpi_EvaluateInteger(ACPI_HANDLE handle, char *path, int *number)
1316 handle = ACPI_ROOT_OBJECT;
1319 * Assume that what we've been pointed at is an Integer object, or
1320 * a method that will return an Integer.
1322 buf.Pointer = ¶m;
1323 buf.Length = sizeof(param);
1324 status = AcpiEvaluateObject(handle, path, NULL, &buf);
1325 if (ACPI_SUCCESS(status)) {
1326 if (param.Type == ACPI_TYPE_INTEGER)
1327 *number = param.Integer.Value;
1333 * In some applications, a method that's expected to return an Integer
1334 * may instead return a Buffer (probably to simplify some internal
1335 * arithmetic). We'll try to fetch whatever it is, and if it's a Buffer,
1336 * convert it into an Integer as best we can.
1340 if (status == AE_BUFFER_OVERFLOW) {
1341 if ((buf.Pointer = AcpiOsAllocate(buf.Length)) == NULL) {
1342 status = AE_NO_MEMORY;
1344 status = AcpiEvaluateObject(handle, path, NULL, &buf);
1345 if (ACPI_SUCCESS(status))
1346 status = acpi_ConvertBufferToInteger(&buf, number);
1347 AcpiOsFree(buf.Pointer);
1354 acpi_ConvertBufferToInteger(ACPI_BUFFER *bufp, int *number)
1359 p = (ACPI_OBJECT *)bufp->Pointer;
1360 if (p->Type == ACPI_TYPE_INTEGER) {
1361 *number = p->Integer.Value;
1364 if (p->Type != ACPI_TYPE_BUFFER)
1366 if (p->Buffer.Length > sizeof(int))
1367 return (AE_BAD_DATA);
1370 for (i = 0; i < p->Buffer.Length; i++)
1371 *number += (*(p->Buffer.Pointer + i) << (i * 8));
1376 * Iterate over the elements of an a package object, calling the supplied
1377 * function for each element.
1379 * XXX possible enhancement might be to abort traversal on error.
1382 acpi_ForeachPackageObject(ACPI_OBJECT *pkg,
1383 void (*func)(ACPI_OBJECT *comp, void *arg), void *arg)
1388 if (pkg == NULL || pkg->Type != ACPI_TYPE_PACKAGE)
1389 return (AE_BAD_PARAMETER);
1391 /* Iterate over components */
1393 comp = pkg->Package.Elements;
1394 for (; i < pkg->Package.Count; i++, comp++)
1401 * Find the (index)th resource object in a set.
1404 acpi_FindIndexedResource(ACPI_BUFFER *buf, int index, ACPI_RESOURCE **resp)
1409 rp = (ACPI_RESOURCE *)buf->Pointer;
1413 if (rp > (ACPI_RESOURCE *)((u_int8_t *)buf->Pointer + buf->Length))
1414 return (AE_BAD_PARAMETER);
1416 /* Check for terminator */
1417 if (rp->Id == ACPI_RSTYPE_END_TAG || rp->Length == 0)
1418 return (AE_NOT_FOUND);
1419 rp = ACPI_NEXT_RESOURCE(rp);
1428 * Append an ACPI_RESOURCE to an ACPI_BUFFER.
1430 * Given a pointer to an ACPI_RESOURCE structure, expand the ACPI_BUFFER
1431 * provided to contain it. If the ACPI_BUFFER is empty, allocate a sensible
1432 * backing block. If the ACPI_RESOURCE is NULL, return an empty set of
1435 #define ACPI_INITIAL_RESOURCE_BUFFER_SIZE 512
1438 acpi_AppendBufferResource(ACPI_BUFFER *buf, ACPI_RESOURCE *res)
1443 /* Initialise the buffer if necessary. */
1444 if (buf->Pointer == NULL) {
1445 buf->Length = ACPI_INITIAL_RESOURCE_BUFFER_SIZE;
1446 if ((buf->Pointer = AcpiOsAllocate(buf->Length)) == NULL)
1447 return (AE_NO_MEMORY);
1448 rp = (ACPI_RESOURCE *)buf->Pointer;
1449 rp->Id = ACPI_RSTYPE_END_TAG;
1456 * Scan the current buffer looking for the terminator.
1457 * This will either find the terminator or hit the end
1458 * of the buffer and return an error.
1460 rp = (ACPI_RESOURCE *)buf->Pointer;
1462 /* Range check, don't go outside the buffer */
1463 if (rp >= (ACPI_RESOURCE *)((u_int8_t *)buf->Pointer + buf->Length))
1464 return (AE_BAD_PARAMETER);
1465 if (rp->Id == ACPI_RSTYPE_END_TAG || rp->Length == 0)
1467 rp = ACPI_NEXT_RESOURCE(rp);
1471 * Check the size of the buffer and expand if required.
1474 * size of existing resources before terminator +
1475 * size of new resource and header +
1476 * size of terminator.
1478 * Note that this loop should really only run once, unless
1479 * for some reason we are stuffing a *really* huge resource.
1481 while ((((u_int8_t *)rp - (u_int8_t *)buf->Pointer) +
1482 res->Length + ACPI_RESOURCE_LENGTH_NO_DATA +
1483 ACPI_RESOURCE_LENGTH) >= buf->Length) {
1484 if ((newp = AcpiOsAllocate(buf->Length * 2)) == NULL)
1485 return (AE_NO_MEMORY);
1486 bcopy(buf->Pointer, newp, buf->Length);
1487 rp = (ACPI_RESOURCE *)((u_int8_t *)newp +
1488 ((u_int8_t *)rp - (u_int8_t *)buf->Pointer));
1489 AcpiOsFree(buf->Pointer);
1490 buf->Pointer = newp;
1491 buf->Length += buf->Length;
1494 /* Insert the new resource. */
1495 bcopy(res, rp, res->Length + ACPI_RESOURCE_LENGTH_NO_DATA);
1497 /* And add the terminator. */
1498 rp = ACPI_NEXT_RESOURCE(rp);
1499 rp->Id = ACPI_RSTYPE_END_TAG;
1506 * Set interrupt model.
1509 acpi_SetIntrModel(int model)
1511 ACPI_OBJECT_LIST ArgList;
1514 Arg.Type = ACPI_TYPE_INTEGER;
1515 Arg.Integer.Value = model;
1517 ArgList.Pointer = &Arg;
1518 return (AcpiEvaluateObject(ACPI_ROOT_OBJECT, "_PIC", &ArgList, NULL));
1521 #define ACPI_MINIMUM_AWAKETIME 5
1524 acpi_sleep_enable(void *arg)
1526 ((struct acpi_softc *)arg)->acpi_sleep_disabled = 0;
1530 * Set the system sleep state
1532 * Currently we support S1-S5 but S4 is only S4BIOS
1535 acpi_SetSleepState(struct acpi_softc *sc, int state)
1537 ACPI_STATUS status = AE_OK;
1541 ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, state);
1544 /* Avoid reentry if already attempting to suspend. */
1545 if (sc->acpi_sstate != ACPI_STATE_S0)
1546 return_ACPI_STATUS (AE_BAD_PARAMETER);
1548 /* We recently woke up so don't suspend again for a while. */
1549 if (sc->acpi_sleep_disabled)
1550 return_ACPI_STATUS (AE_OK);
1557 status = AcpiGetSleepTypeData((UINT8)state, &TypeA, &TypeB);
1558 if (status == AE_NOT_FOUND) {
1559 device_printf(sc->acpi_dev,
1560 "Sleep state S%d not supported by BIOS\n", state);
1562 } else if (ACPI_FAILURE(status)) {
1563 device_printf(sc->acpi_dev, "AcpiGetSleepTypeData failed - %s\n",
1564 AcpiFormatException(status));
1568 sc->acpi_sstate = state;
1569 sc->acpi_sleep_disabled = 1;
1571 /* Inform all devices that we are going to sleep. */
1572 if (DEVICE_SUSPEND(root_bus) != 0) {
1574 * Re-wake the system.
1576 * XXX note that a better two-pass approach with a 'veto' pass
1577 * followed by a "real thing" pass would be better, but the
1578 * current bus interface does not provide for this.
1580 DEVICE_RESUME(root_bus);
1581 return_ACPI_STATUS (AE_ERROR);
1584 status = AcpiEnterSleepStatePrep(state);
1585 if (ACPI_FAILURE(status)) {
1586 device_printf(sc->acpi_dev, "AcpiEnterSleepStatePrep failed - %s\n",
1587 AcpiFormatException(status));
1591 if (sc->acpi_sleep_delay > 0)
1592 DELAY(sc->acpi_sleep_delay * 1000000);
1594 if (state != ACPI_STATE_S1) {
1595 acpi_sleep_machdep(sc, state);
1597 /* AcpiEnterSleepState() may be incomplete, unlock if locked. */
1598 if (AcpiGbl_MutexInfo[ACPI_MTX_HARDWARE].OwnerId !=
1599 ACPI_MUTEX_NOT_ACQUIRED) {
1601 AcpiUtReleaseMutex(ACPI_MTX_HARDWARE);
1604 /* Re-enable ACPI hardware on wakeup from sleep state 4. */
1605 if (state == ACPI_STATE_S4)
1608 status = AcpiEnterSleepState((UINT8)state);
1609 if (ACPI_FAILURE(status)) {
1610 device_printf(sc->acpi_dev, "AcpiEnterSleepState failed - %s\n",
1611 AcpiFormatException(status));
1615 AcpiLeaveSleepState((UINT8)state);
1616 DEVICE_RESUME(root_bus);
1617 sc->acpi_sstate = ACPI_STATE_S0;
1618 acpi_enable_fixed_events(sc);
1622 * Shut down cleanly and power off. This will call us back through the
1623 * shutdown handlers.
1625 shutdown_nice(RB_POWEROFF);
1629 status = AE_BAD_PARAMETER;
1633 /* Disable a second sleep request for a short period */
1634 if (sc->acpi_sleep_disabled)
1635 timeout(acpi_sleep_enable, (caddr_t)sc, hz * ACPI_MINIMUM_AWAKETIME);
1637 return_ACPI_STATUS (status);
1641 * Enable/Disable ACPI
1644 acpi_Enable(struct acpi_softc *sc)
1649 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1652 flags = ACPI_NO_ADDRESS_SPACE_INIT | ACPI_NO_HARDWARE_INIT |
1653 ACPI_NO_DEVICE_INIT | ACPI_NO_OBJECT_INIT;
1654 if (!sc->acpi_enabled)
1655 status = AcpiEnableSubsystem(flags);
1659 if (status == AE_OK)
1660 sc->acpi_enabled = 1;
1662 return_ACPI_STATUS (status);
1666 acpi_Disable(struct acpi_softc *sc)
1670 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1673 if (sc->acpi_enabled)
1674 status = AcpiDisable();
1678 if (status == AE_OK)
1679 sc->acpi_enabled = 0;
1681 return_ACPI_STATUS (status);
1685 * ACPI Event Handlers
1688 /* System Event Handlers (registered by EVENTHANDLER_REGISTER) */
1691 acpi_system_eventhandler_sleep(void *arg, int state)
1694 ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, state);
1697 if (state >= ACPI_STATE_S0 && state <= ACPI_S_STATES_MAX)
1698 acpi_SetSleepState((struct acpi_softc *)arg, state);
1704 acpi_system_eventhandler_wakeup(void *arg, int state)
1707 ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, state);
1709 /* Well, what to do? :-) */
1718 * ACPICA Event Handlers (FixedEvent, also called from button notify handler)
1721 acpi_event_power_button_sleep(void *context)
1723 struct acpi_softc *sc = (struct acpi_softc *)context;
1725 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1727 EVENTHANDLER_INVOKE(acpi_sleep_event, sc->acpi_power_button_sx);
1729 return_VALUE (ACPI_INTERRUPT_HANDLED);
1733 acpi_event_power_button_wake(void *context)
1735 struct acpi_softc *sc = (struct acpi_softc *)context;
1737 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1739 EVENTHANDLER_INVOKE(acpi_wakeup_event, sc->acpi_power_button_sx);
1741 return_VALUE (ACPI_INTERRUPT_HANDLED);
1745 acpi_event_sleep_button_sleep(void *context)
1747 struct acpi_softc *sc = (struct acpi_softc *)context;
1749 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1751 EVENTHANDLER_INVOKE(acpi_sleep_event, sc->acpi_sleep_button_sx);
1753 return_VALUE (ACPI_INTERRUPT_HANDLED);
1757 acpi_event_sleep_button_wake(void *context)
1759 struct acpi_softc *sc = (struct acpi_softc *)context;
1761 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1763 EVENTHANDLER_INVOKE(acpi_wakeup_event, sc->acpi_sleep_button_sx);
1765 return_VALUE (ACPI_INTERRUPT_HANDLED);
1769 * XXX This is kinda ugly, and should not be here.
1771 struct acpi_staticbuf {
1777 acpi_name(ACPI_HANDLE handle)
1779 static struct acpi_staticbuf buf;
1783 buf.buffer.Length = 512;
1784 buf.buffer.Pointer = &buf.data[0];
1786 if (ACPI_SUCCESS(AcpiGetName(handle, ACPI_FULL_PATHNAME, &buf.buffer)))
1787 return (buf.buffer.Pointer);
1789 return ("(unknown path)");
1793 * Debugging/bug-avoidance. Avoid trying to fetch info on various
1794 * parts of the namespace.
1797 acpi_avoid(ACPI_HANDLE handle)
1799 char *cp, *env, *np;
1802 np = acpi_name(handle);
1805 if ((env = getenv("debug.acpi.avoid")) == NULL)
1808 /* Scan the avoid list checking for a match */
1811 while ((*cp != 0) && isspace(*cp))
1816 while ((cp[len] != 0) && !isspace(cp[len]))
1818 if (!strncmp(cp, np, len)) {
1830 * Debugging/bug-avoidance. Disable ACPI subsystem components.
1833 acpi_disabled(char *subsys)
1838 if ((env = getenv("debug.acpi.disable")) == NULL)
1840 if (!strcmp(env, "all")) {
1845 /* scan the disable list checking for a match */
1848 while ((*cp != 0) && isspace(*cp))
1853 while ((cp[len] != 0) && !isspace(cp[len]))
1855 if (!strncmp(cp, subsys, len)) {
1867 * Device wake capability enable/disable.
1870 acpi_device_enable_wake_capability(ACPI_HANDLE h, int enable)
1872 ACPI_OBJECT_LIST ArgList;
1876 * TBD: All Power Resources referenced by elements 2 through N
1877 * of the _PRW object are put into the ON state.
1881 ArgList.Pointer = &Arg;
1883 Arg.Type = ACPI_TYPE_INTEGER;
1884 Arg.Integer.Value = enable;
1886 (void)AcpiEvaluateObject(h, "_PSW", &ArgList, NULL);
1890 acpi_device_enable_wake_event(ACPI_HANDLE h)
1892 struct acpi_softc *sc;
1894 ACPI_BUFFER prw_buffer;
1897 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1899 sc = devclass_get_softc(acpi_devclass, 0);
1904 * _PRW object is only required for devices that have the ability
1905 * to wake the system from a system sleeping state.
1907 prw_buffer.Length = ACPI_ALLOCATE_BUFFER;
1908 status = AcpiEvaluateObject(h, "_PRW", NULL, &prw_buffer);
1909 if (ACPI_FAILURE(status))
1912 res = (ACPI_OBJECT *)prw_buffer.Pointer;
1916 if ((res->Type != ACPI_TYPE_PACKAGE) || (res->Package.Count < 2)) {
1921 * The element 1 of the _PRW object:
1922 * The lowest power system sleeping state that can be entered
1923 * while still providing wake functionality.
1924 * The sleeping state being entered must be greater or equal to
1925 * the power state declared in element 1 of the _PRW object.
1927 if (res->Package.Elements[1].Type != ACPI_TYPE_INTEGER)
1930 if (sc->acpi_sstate > res->Package.Elements[1].Integer.Value)
1934 * The element 0 of the _PRW object:
1936 switch(res->Package.Elements[0].Type) {
1937 case ACPI_TYPE_INTEGER:
1939 * If the data type of this package element is numeric, then this
1940 * _PRW package element is the bit index in the GPEx_EN, in the
1941 * GPE blocks described in the FADT, of the enable bit that is
1942 * enabled for the wake event.
1945 status = AcpiEnableGpe(NULL, res->Package.Elements[0].Integer.Value,
1946 ACPI_EVENT_WAKE_ENABLE);
1947 if (ACPI_FAILURE(status))
1948 printf("%s: EnableEvent Failed\n", __func__);
1950 case ACPI_TYPE_PACKAGE:
1954 * If the data type of this package element is a package, then this
1955 * _PRW package element is itself a package containing two
1956 * elements. The first is an object reference to the GPE Block
1957 * device that contains the GPE that will be triggered by the wake
1958 * event. The second element is numeric and it contains the bit
1959 * index in the GPEx_EN, in the GPE Block referenced by the
1960 * first element in the package, of the enable bit that is enabled for
1962 * For example, if this field is a package then it is of the form:
1963 * Package() {\_SB.PCI0.ISA.GPE, 2}
1971 if (prw_buffer.Pointer != NULL)
1972 AcpiOsFree(prw_buffer.Pointer);
1976 * Control interface.
1978 * We multiplex ioctls for all participating ACPI devices here. Individual
1979 * drivers wanting to be accessible via /dev/acpi should use the
1980 * register/deregister interface to make their handlers visible.
1982 struct acpi_ioctl_hook
1984 TAILQ_ENTRY(acpi_ioctl_hook) link;
1990 static TAILQ_HEAD(,acpi_ioctl_hook) acpi_ioctl_hooks;
1991 static int acpi_ioctl_hooks_initted;
1994 * Register an ioctl handler.
1997 acpi_register_ioctl(u_long cmd, acpi_ioctl_fn fn, void *arg)
1999 struct acpi_ioctl_hook *hp;
2001 hp = malloc(sizeof(*hp), M_ACPIDEV, M_INTWAIT);
2005 if (acpi_ioctl_hooks_initted == 0) {
2006 TAILQ_INIT(&acpi_ioctl_hooks);
2007 acpi_ioctl_hooks_initted = 1;
2009 TAILQ_INSERT_TAIL(&acpi_ioctl_hooks, hp, link);
2014 * Deregister an ioctl handler.
2017 acpi_deregister_ioctl(u_long cmd, acpi_ioctl_fn fn)
2019 struct acpi_ioctl_hook *hp;
2021 TAILQ_FOREACH(hp, &acpi_ioctl_hooks, link)
2022 if ((hp->cmd == cmd) && (hp->fn == fn))
2026 TAILQ_REMOVE(&acpi_ioctl_hooks, hp, link);
2027 free(hp, M_ACPIDEV);
2032 acpiopen(dev_t dev, int flag, int fmt, d_thread_t *td)
2038 acpiclose(dev_t dev, int flag, int fmt, d_thread_t *td)
2044 acpiioctl(dev_t dev, u_long cmd, caddr_t addr, int flag, d_thread_t *td)
2046 struct acpi_softc *sc;
2047 struct acpi_ioctl_hook *hp;
2048 int error, xerror, state;
2057 * Scan the list of registered ioctls, looking for handlers.
2059 if (acpi_ioctl_hooks_initted) {
2060 TAILQ_FOREACH(hp, &acpi_ioctl_hooks, link) {
2061 if (hp->cmd == cmd) {
2062 xerror = hp->fn(cmd, addr, hp->arg);
2071 * Core ioctls are not permitted for non-writable user.
2072 * Currently, other ioctls just fetch information.
2073 * Not changing system behavior.
2075 if((flag & FWRITE) == 0)
2078 /* Core system ioctls. */
2081 if (ACPI_FAILURE(acpi_Enable(sc)))
2084 case ACPIIO_DISABLE:
2085 if (ACPI_FAILURE(acpi_Disable(sc)))
2088 case ACPIIO_SETSLPSTATE:
2089 if (!sc->acpi_enabled) {
2093 state = *(int *)addr;
2094 if (state >= ACPI_STATE_S0 && state <= ACPI_S_STATES_MAX) {
2095 if (ACPI_FAILURE(acpi_SetSleepState(sc, state)))
2113 acpi_supported_sleep_state_sysctl(SYSCTL_HANDLER_ARGS)
2115 char sleep_state[4];
2118 UINT8 state, TypeA, TypeB;
2121 for (state = ACPI_STATE_S1; state < ACPI_S_STATES_MAX+1; state++) {
2122 if (ACPI_SUCCESS(AcpiGetSleepTypeData(state, &TypeA, &TypeB))) {
2123 sprintf(sleep_state, "S%d ", state);
2124 strcat(buf, sleep_state);
2127 error = sysctl_handle_string(oidp, buf, sizeof(buf), req);
2132 acpi_sleep_state_sysctl(SYSCTL_HANDLER_ARGS)
2134 char sleep_state[10];
2136 u_int new_state, old_state;
2138 old_state = *(u_int *)oidp->oid_arg1;
2139 if (old_state > ACPI_S_STATES_MAX+1) {
2140 strcpy(sleep_state, "unknown");
2142 bzero(sleep_state, sizeof(sleep_state));
2143 strncpy(sleep_state, sleep_state_names[old_state],
2144 sizeof(sleep_state_names[old_state]));
2146 error = sysctl_handle_string(oidp, sleep_state, sizeof(sleep_state), req);
2147 if (error == 0 && req->newptr != NULL) {
2148 new_state = ACPI_STATE_S0;
2149 for (; new_state <= ACPI_S_STATES_MAX + 1; new_state++) {
2150 if (strncmp(sleep_state, sleep_state_names[new_state],
2151 sizeof(sleep_state)) == 0)
2154 if (new_state <= ACPI_S_STATES_MAX + 1) {
2155 if (new_state != old_state)
2156 *(u_int *)oidp->oid_arg1 = new_state;
2165 /* Inform devctl(4) when we receive a Notify. */
2167 acpi_UserNotify(const char *subsystem, ACPI_HANDLE h, uint8_t notify)
2169 char notify_buf[16];
2170 ACPI_BUFFER handle_buf;
2173 if (subsystem == NULL)
2176 handle_buf.Pointer = NULL;
2177 handle_buf.Length = ACPI_ALLOCATE_BUFFER;
2178 status = AcpiNsHandleToPathname(h, &handle_buf);
2179 if (ACPI_FAILURE(status))
2181 snprintf(notify_buf, sizeof(notify_buf), "notify=0x%02x", notify);
2183 devctl_notify("ACPI", subsystem, handle_buf.Pointer, notify_buf);
2185 AcpiOsFree(handle_buf.Pointer);
2190 * Support for parsing debug options from the kernel environment.
2192 * Bits may be set in the AcpiDbgLayer and AcpiDbgLevel debug registers
2193 * by specifying the names of the bits in the debug.acpi.layer and
2194 * debug.acpi.level environment variables. Bits may be unset by
2195 * prefixing the bit name with !.
2203 static struct debugtag dbg_layer[] = {
2204 {"ACPI_UTILITIES", ACPI_UTILITIES},
2205 {"ACPI_HARDWARE", ACPI_HARDWARE},
2206 {"ACPI_EVENTS", ACPI_EVENTS},
2207 {"ACPI_TABLES", ACPI_TABLES},
2208 {"ACPI_NAMESPACE", ACPI_NAMESPACE},
2209 {"ACPI_PARSER", ACPI_PARSER},
2210 {"ACPI_DISPATCHER", ACPI_DISPATCHER},
2211 {"ACPI_EXECUTER", ACPI_EXECUTER},
2212 {"ACPI_RESOURCES", ACPI_RESOURCES},
2213 {"ACPI_CA_DEBUGGER", ACPI_CA_DEBUGGER},
2214 {"ACPI_OS_SERVICES", ACPI_OS_SERVICES},
2215 {"ACPI_CA_DISASSEMBLER", ACPI_CA_DISASSEMBLER},
2216 {"ACPI_ALL_COMPONENTS", ACPI_ALL_COMPONENTS},
2218 {"ACPI_BUS", ACPI_BUS},
2219 {"ACPI_SYSTEM", ACPI_SYSTEM},
2220 {"ACPI_POWER", ACPI_POWER},
2221 {"ACPI_EC", ACPI_EC},
2222 {"ACPI_AC_ADAPTER", ACPI_AC_ADAPTER},
2223 {"ACPI_BATTERY", ACPI_BATTERY},
2224 {"ACPI_BUTTON", ACPI_BUTTON},
2225 {"ACPI_PROCESSOR", ACPI_PROCESSOR},
2226 {"ACPI_THERMAL", ACPI_THERMAL},
2227 {"ACPI_FAN", ACPI_FAN},
2228 {"ACPI_ALL_DRIVERS", ACPI_ALL_DRIVERS},
2232 static struct debugtag dbg_level[] = {
2233 {"ACPI_LV_ERROR", ACPI_LV_ERROR},
2234 {"ACPI_LV_WARN", ACPI_LV_WARN},
2235 {"ACPI_LV_INIT", ACPI_LV_INIT},
2236 {"ACPI_LV_DEBUG_OBJECT", ACPI_LV_DEBUG_OBJECT},
2237 {"ACPI_LV_INFO", ACPI_LV_INFO},
2238 {"ACPI_LV_ALL_EXCEPTIONS", ACPI_LV_ALL_EXCEPTIONS},
2240 /* Trace verbosity level 1 [Standard Trace Level] */
2241 {"ACPI_LV_INIT_NAMES", ACPI_LV_INIT_NAMES},
2242 {"ACPI_LV_PARSE", ACPI_LV_PARSE},
2243 {"ACPI_LV_LOAD", ACPI_LV_LOAD},
2244 {"ACPI_LV_DISPATCH", ACPI_LV_DISPATCH},
2245 {"ACPI_LV_EXEC", ACPI_LV_EXEC},
2246 {"ACPI_LV_NAMES", ACPI_LV_NAMES},
2247 {"ACPI_LV_OPREGION", ACPI_LV_OPREGION},
2248 {"ACPI_LV_BFIELD", ACPI_LV_BFIELD},
2249 {"ACPI_LV_TABLES", ACPI_LV_TABLES},
2250 {"ACPI_LV_VALUES", ACPI_LV_VALUES},
2251 {"ACPI_LV_OBJECTS", ACPI_LV_OBJECTS},
2252 {"ACPI_LV_RESOURCES", ACPI_LV_RESOURCES},
2253 {"ACPI_LV_USER_REQUESTS", ACPI_LV_USER_REQUESTS},
2254 {"ACPI_LV_PACKAGE", ACPI_LV_PACKAGE},
2255 {"ACPI_LV_VERBOSITY1", ACPI_LV_VERBOSITY1},
2257 /* Trace verbosity level 2 [Function tracing and memory allocation] */
2258 {"ACPI_LV_ALLOCATIONS", ACPI_LV_ALLOCATIONS},
2259 {"ACPI_LV_FUNCTIONS", ACPI_LV_FUNCTIONS},
2260 {"ACPI_LV_OPTIMIZATIONS", ACPI_LV_OPTIMIZATIONS},
2261 {"ACPI_LV_VERBOSITY2", ACPI_LV_VERBOSITY2},
2262 {"ACPI_LV_ALL", ACPI_LV_ALL},
2264 /* Trace verbosity level 3 [Threading, I/O, and Interrupts] */
2265 {"ACPI_LV_MUTEX", ACPI_LV_MUTEX},
2266 {"ACPI_LV_THREADS", ACPI_LV_THREADS},
2267 {"ACPI_LV_IO", ACPI_LV_IO},
2268 {"ACPI_LV_INTERRUPTS", ACPI_LV_INTERRUPTS},
2269 {"ACPI_LV_VERBOSITY3", ACPI_LV_VERBOSITY3},
2271 /* Exceptionally verbose output -- also used in the global "DebugLevel" */
2272 {"ACPI_LV_AML_DISASSEMBLE", ACPI_LV_AML_DISASSEMBLE},
2273 {"ACPI_LV_VERBOSE_INFO", ACPI_LV_VERBOSE_INFO},
2274 {"ACPI_LV_FULL_TABLES", ACPI_LV_FULL_TABLES},
2275 {"ACPI_LV_EVENTS", ACPI_LV_EVENTS},
2276 {"ACPI_LV_VERBOSE", ACPI_LV_VERBOSE},
2281 acpi_parse_debug(char *cp, struct debugtag *tag, UINT32 *flag)
2293 while (*ep && !isspace(*ep))
2304 for (i = 0; tag[i].name != NULL; i++) {
2305 if (!strncmp(cp, tag[i].name, l)) {
2307 *flag |= tag[i].value;
2309 *flag &= ~tag[i].value;
2310 printf("ACPI_DEBUG: set '%s'\n", tag[i].name);
2318 acpi_set_debugging(void *junk)
2327 if ((cp = getenv("debug.acpi.layer")) != NULL) {
2328 acpi_parse_debug(cp, &dbg_layer[0], &AcpiDbgLayer);
2331 if ((cp = getenv("debug.acpi.level")) != NULL) {
2332 acpi_parse_debug(cp, &dbg_level[0], &AcpiDbgLevel);
2337 printf("ACPI debug layer 0x%x debug level 0x%x\n",
2338 AcpiDbgLayer, AcpiDbgLevel);
2341 SYSINIT(acpi_debugging, SI_SUB_TUNABLES, SI_ORDER_ANY, acpi_set_debugging,
2345 acpi_debug_sysctl(SYSCTL_HANDLER_ARGS)
2348 struct debugtag *tag;
2351 if (sbuf_new(&sb, NULL, 128, SBUF_AUTOEXTEND) == NULL)
2353 if (strcmp(oidp->oid_arg1, "debug.acpi.layer") == 0) {
2354 tag = &dbg_layer[0];
2355 dbg = &AcpiDbgLayer;
2357 tag = &dbg_level[0];
2358 dbg = &AcpiDbgLevel;
2361 /* Get old values if this is a get request. */
2363 sbuf_cpy(&sb, "NONE");
2364 } else if (req->newptr == NULL) {
2365 for (; tag->name != NULL; tag++) {
2366 if ((*dbg & tag->value) == tag->value)
2367 sbuf_printf(&sb, "%s ", tag->name);
2373 error = sysctl_handle_string(oidp, sbuf_data(&sb), sbuf_len(&sb), req);
2376 /* If the user is setting a string, parse it. */
2377 if (error == 0 && req->newptr != NULL) {
2379 setenv((char *)oidp->oid_arg1, (char *)req->newptr);
2380 acpi_set_debugging(NULL);
2385 SYSCTL_PROC(_debug_acpi, OID_AUTO, layer, CTLFLAG_RW | CTLTYPE_STRING,
2386 "debug.acpi.layer", 0, acpi_debug_sysctl, "A", "");
2387 SYSCTL_PROC(_debug_acpi, OID_AUTO, level, CTLFLAG_RW | CTLTYPE_STRING,
2388 "debug.acpi.level", 0, acpi_debug_sysctl, "A", "");
2392 acpi_pm_func(u_long cmd, void *arg, ...)
2394 int state, acpi_state;
2396 struct acpi_softc *sc;
2401 case POWER_CMD_SUSPEND:
2402 sc = (struct acpi_softc *)arg;
2409 state = va_arg(ap, int);
2413 case POWER_SLEEP_STATE_STANDBY:
2414 acpi_state = sc->acpi_standby_sx;
2416 case POWER_SLEEP_STATE_SUSPEND:
2417 acpi_state = sc->acpi_suspend_sx;
2419 case POWER_SLEEP_STATE_HIBERNATE:
2420 acpi_state = ACPI_STATE_S4;
2427 acpi_SetSleepState(sc, acpi_state);
2439 acpi_pm_register(void *arg)
2441 if (!cold || resource_disabled("acpi", 0))
2444 power_pm_register(POWER_PM_TYPE_ACPI, acpi_pm_func, NULL);
2447 SYSINIT(power, SI_SUB_KLD, SI_ORDER_ANY, acpi_pm_register, 0);