2 * Copyright (c) 2000 Takanori Watanabe <takawata@jp.kfreebsd.org>
3 * Copyright (c) 2000 Mitsuru IWASAKI <iwasaki@jp.kfreebsd.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.243.2.4.4.1 2009/04/15 03:14:26 kensmith Exp $
33 #include <sys/param.h>
34 #include <sys/kernel.h>
36 #include <sys/fcntl.h>
37 #include <sys/malloc.h>
38 #include <sys/module.h>
41 #include <sys/reboot.h>
42 #include <sys/sysctl.h>
43 #include <sys/ctype.h>
44 #include <sys/linker.h>
45 #include <sys/power.h>
47 #include <sys/device.h>
48 #include <sys/spinlock.h>
49 #include <sys/spinlock2.h>
53 #include <bus/isa/isavar.h>
54 #include <bus/isa/pnpvar.h>
57 #include <dev/acpica/acpivar.h>
58 #include <dev/acpica/acpiio.h>
59 #include <dev/acpica/acpiio_mcall.h>
65 #include <bus/pci/pci_cfgreg.h>
66 #include <bus/pci/pcivar.h>
67 #include <bus/pci/pci_private.h>
69 #include <vm/vm_param.h>
71 MALLOC_DEFINE(M_ACPIDEV, "acpidev", "ACPI devices");
73 /* Hooks for the ACPICA debugging infrastructure */
74 #define _COMPONENT ACPI_BUS
75 ACPI_MODULE_NAME("ACPI");
77 static d_open_t acpiopen;
78 static d_close_t acpiclose;
79 static d_ioctl_t acpiioctl;
81 static struct dev_ops acpi_ops = {
82 { "acpi", 0, D_MPSAFE },
88 struct acpi_interface {
93 /* Global mutex for locking access to the ACPI subsystem. */
94 struct lock acpi_lock;
95 struct lwkt_token acpi_token = LWKT_TOKEN_INITIALIZER(acpi_token);
97 /* Bitmap of device quirks. */
100 static int acpi_modevent(struct module *mod, int event, void *junk);
101 static void acpi_identify(driver_t *driver, device_t parent);
102 static int acpi_probe(device_t dev);
103 static int acpi_attach(device_t dev);
104 static int acpi_suspend(device_t dev);
105 static int acpi_resume(device_t dev);
106 static int acpi_shutdown(device_t dev);
107 static device_t acpi_add_child(device_t bus, device_t parent, int order, const char *name,
109 static int acpi_print_child(device_t bus, device_t child);
110 static void acpi_probe_nomatch(device_t bus, device_t child);
111 static void acpi_driver_added(device_t dev, driver_t *driver);
112 static int acpi_read_ivar(device_t dev, device_t child, int index,
114 static int acpi_write_ivar(device_t dev, device_t child, int index,
116 static struct resource_list *acpi_get_rlist(device_t dev, device_t child);
117 static int acpi_sysres_alloc(device_t dev);
118 static struct resource *acpi_alloc_resource(device_t bus, device_t child,
119 int type, int *rid, u_long start, u_long end,
120 u_long count, u_int flags, int cpuid);
121 static int acpi_release_resource(device_t bus, device_t child, int type,
122 int rid, struct resource *r);
123 static void acpi_delete_resource(device_t bus, device_t child, int type,
125 static uint32_t acpi_isa_get_logicalid(device_t dev);
126 static int acpi_isa_get_compatid(device_t dev, uint32_t *cids, int count);
127 static char *acpi_device_id_probe(device_t bus, device_t dev, char **ids);
128 static ACPI_STATUS acpi_device_eval_obj(device_t bus, device_t dev,
129 ACPI_STRING pathname, ACPI_OBJECT_LIST *parameters,
131 static int acpi_device_pwr_for_sleep(device_t bus, device_t dev,
133 static ACPI_STATUS acpi_device_scan_cb(ACPI_HANDLE h, UINT32 level,
134 void *context, void **retval);
135 static ACPI_STATUS acpi_device_scan_children(device_t bus, device_t dev,
136 int max_depth, acpi_scan_cb_t user_fn, void *arg);
137 static int acpi_set_powerstate_method(device_t bus, device_t child,
139 static int acpi_isa_pnp_probe(device_t bus, device_t child,
140 struct isa_pnp_id *ids);
141 static void acpi_probe_children(device_t bus);
142 static void acpi_probe_order(ACPI_HANDLE handle, int *order);
143 static void acpi_disable_not_present(device_t child);
144 static void acpi_reprobe_children(device_t bus, device_t *children,
146 static ACPI_STATUS acpi_probe_child(ACPI_HANDLE handle, UINT32 level,
147 void *context, void **status);
148 static ACPI_STATUS acpi_EnterSleepState(struct acpi_softc *sc, int state);
149 static void acpi_shutdown_final(void *arg, int howto);
150 static void acpi_enable_fixed_events(struct acpi_softc *sc);
151 static int acpi_wake_sleep_prep(ACPI_HANDLE handle, int sstate);
152 static int acpi_wake_run_prep(ACPI_HANDLE handle, int sstate);
153 static int acpi_wake_prep_walk(int sstate);
154 static int acpi_wake_sysctl_walk(device_t dev);
156 static int acpi_wake_set_sysctl(SYSCTL_HANDLER_ARGS);
158 static void acpi_system_eventhandler_sleep(void *arg, int state);
159 static void acpi_system_eventhandler_wakeup(void *arg, int state);
160 static int acpi_supported_sleep_state_sysctl(SYSCTL_HANDLER_ARGS);
161 static int acpi_sleep_state_sysctl(SYSCTL_HANDLER_ARGS);
162 static int acpi_debug_objects_sysctl(SYSCTL_HANDLER_ARGS);
163 static int acpi_pm_func(u_long cmd, void *arg, ...);
164 static int acpi_child_location_str_method(device_t acdev, device_t child,
165 char *buf, size_t buflen);
166 static int acpi_child_pnpinfo_str_method(device_t acdev, device_t child,
167 char *buf, size_t buflen);
168 static void acpi_enable_pcie(void);
169 static void acpi_reset_interfaces(device_t dev);
171 static device_method_t acpi_methods[] = {
172 /* Device interface */
173 DEVMETHOD(device_identify, acpi_identify),
174 DEVMETHOD(device_probe, acpi_probe),
175 DEVMETHOD(device_attach, acpi_attach),
176 DEVMETHOD(device_shutdown, acpi_shutdown),
177 DEVMETHOD(device_detach, bus_generic_detach),
178 DEVMETHOD(device_suspend, acpi_suspend),
179 DEVMETHOD(device_resume, acpi_resume),
182 DEVMETHOD(bus_add_child, acpi_add_child),
183 DEVMETHOD(bus_print_child, acpi_print_child),
184 DEVMETHOD(bus_probe_nomatch, acpi_probe_nomatch),
185 DEVMETHOD(bus_driver_added, acpi_driver_added),
186 DEVMETHOD(bus_read_ivar, acpi_read_ivar),
187 DEVMETHOD(bus_write_ivar, acpi_write_ivar),
188 DEVMETHOD(bus_get_resource_list, acpi_get_rlist),
189 DEVMETHOD(bus_set_resource, bus_generic_rl_set_resource),
190 DEVMETHOD(bus_get_resource, bus_generic_rl_get_resource),
191 DEVMETHOD(bus_alloc_resource, acpi_alloc_resource),
192 DEVMETHOD(bus_release_resource, acpi_release_resource),
193 DEVMETHOD(bus_delete_resource, acpi_delete_resource),
194 DEVMETHOD(bus_child_pnpinfo_str, acpi_child_pnpinfo_str_method),
195 DEVMETHOD(bus_child_location_str, acpi_child_location_str_method),
196 DEVMETHOD(bus_activate_resource, bus_generic_activate_resource),
197 DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource),
198 DEVMETHOD(bus_setup_intr, bus_generic_setup_intr),
199 DEVMETHOD(bus_teardown_intr, bus_generic_teardown_intr),
202 DEVMETHOD(acpi_id_probe, acpi_device_id_probe),
203 DEVMETHOD(acpi_evaluate_object, acpi_device_eval_obj),
204 DEVMETHOD(acpi_pwr_for_sleep, acpi_device_pwr_for_sleep),
205 DEVMETHOD(acpi_scan_children, acpi_device_scan_children),
208 DEVMETHOD(pci_set_powerstate, acpi_set_powerstate_method),
211 DEVMETHOD(isa_pnp_probe, acpi_isa_pnp_probe),
216 static driver_t acpi_driver = {
219 sizeof(struct acpi_softc),
220 .gpri = KOBJ_GPRI_ACPI+2
223 static devclass_t acpi_devclass;
224 DRIVER_MODULE(acpi, nexus, acpi_driver, acpi_devclass, acpi_modevent, NULL);
225 MODULE_VERSION(acpi, 1);
227 ACPI_SERIAL_DECL(acpi, "ACPI serializer");
229 /* Local pools for managing system resources for ACPI child devices. */
230 static struct rman acpi_rman_io, acpi_rman_mem;
232 #define ACPI_MINIMUM_AWAKETIME 5
234 static const char* sleep_state_names[] = {
235 "S0", "S1", "S2", "S3", "S4", "S5", "NONE"};
237 SYSCTL_NODE(_debug, OID_AUTO, acpi, CTLFLAG_RD, NULL, "ACPI debugging");
238 static char acpi_ca_version[12];
239 SYSCTL_STRING(_debug_acpi, OID_AUTO, acpi_ca_version, CTLFLAG_RD,
240 acpi_ca_version, 0, "Version of Intel ACPICA");
243 * Allow overriding _OSI methods.
245 static char acpi_install_interface[256];
246 TUNABLE_STR("hw.acpi.install_interface", acpi_install_interface,
247 sizeof(acpi_install_interface));
248 static char acpi_remove_interface[256];
249 TUNABLE_STR("hw.acpi.remove_interface", acpi_remove_interface,
250 sizeof(acpi_remove_interface));
253 * Use this tunable to disable the control method auto-serialization
254 * mechanism that was added in 20140214 and superseded the previous
255 * AcpiGbl_SerializeAllMethods global.
257 static int acpi_auto_serialize_methods = 1;
258 TUNABLE_INT("hw.acpi.auto_serialize_methods", &acpi_auto_serialize_methods);
260 /* Allow users to dump Debug objects without ACPI debugger. */
261 static int acpi_debug_objects;
262 TUNABLE_INT("debug.acpi.enable_debug_objects", &acpi_debug_objects);
263 SYSCTL_PROC(_debug_acpi, OID_AUTO, enable_debug_objects,
264 CTLFLAG_RW | CTLTYPE_INT, NULL, 0, acpi_debug_objects_sysctl, "I",
265 "Enable Debug objects.");
267 /* Allow ignoring the XSDT. */
268 static int acpi_ignore_xsdt;
269 TUNABLE_INT("debug.acpi.ignore_xsdt", &acpi_ignore_xsdt);
270 SYSCTL_INT(_debug_acpi, OID_AUTO, ignore_xsdt, CTLFLAG_RD,
271 &acpi_ignore_xsdt, 1, "Ignore the XSDT, forcing the use of the RSDT.");
273 /* Allow the interpreter to ignore common mistakes in BIOS. */
274 static int acpi_interpreter_slack = 1;
275 TUNABLE_INT("debug.acpi.interpreter_slack", &acpi_interpreter_slack);
276 SYSCTL_INT(_debug_acpi, OID_AUTO, interpreter_slack, CTLFLAG_RD,
277 &acpi_interpreter_slack, 1, "Turn on interpreter slack mode.");
279 /* Allow preferring 32-bit FADT register addresses over the 64-bit ones. */
280 static int acpi_fadt_addr32;
281 TUNABLE_INT("debug.acpi.fadt_addr32", &acpi_fadt_addr32);
282 SYSCTL_INT(_debug_acpi, OID_AUTO, fadt_addr32, CTLFLAG_RD,
283 &acpi_fadt_addr32, 1,
284 "Prefer 32-bit FADT register addresses over 64-bit ones.");
286 /* Prefer 32-bit FACS table addresses over the 64-bit ones. */
287 static int acpi_facs_addr32 = 1;
288 TUNABLE_INT("debug.acpi.facs_addr32", &acpi_facs_addr32);
289 SYSCTL_INT(_debug_acpi, OID_AUTO, facs_addr32, CTLFLAG_RD,
290 &acpi_facs_addr32, 1,
291 "Prefer 32-bit FACS table addresses over 64-bit ones.");
293 static int acpi_group_module_level_code;
294 TUNABLE_INT("debug.acpi.group_module_level_code", &acpi_group_module_level_code);
295 SYSCTL_INT(_debug_acpi, OID_AUTO, group_module_level_code, CTLFLAG_RD,
296 &acpi_group_module_level_code, 1,
297 "Group module-level code.");
299 /* Power devices off and on in suspend and resume. XXX Remove once tested. */
300 static int acpi_do_powerstate = 1;
301 TUNABLE_INT("debug.acpi.do_powerstate", &acpi_do_powerstate);
302 SYSCTL_INT(_debug_acpi, OID_AUTO, do_powerstate, CTLFLAG_RW,
303 &acpi_do_powerstate, 1, "Turn off devices when suspending.");
305 /* Allow users to override quirks. */
306 TUNABLE_INT("debug.acpi.quirks", &acpi_quirks);
308 /* Allow to call ACPI methods from userland. */
309 static int acpi_allow_mcall;
310 TUNABLE_INT("debug.acpi.allow_method_calls", &acpi_allow_mcall);
312 static int acpi_susp_bounce;
313 SYSCTL_INT(_debug_acpi, OID_AUTO, suspend_bounce, CTLFLAG_RW,
314 &acpi_susp_bounce, 0, "Don't actually suspend, just test devices.");
317 * ACPI can only be loaded as a module by the loader; activating it after
318 * system bootstrap time is not useful, and can be fatal to the system.
319 * It also cannot be unloaded, since the entire system bus heirarchy hangs
323 acpi_modevent(struct module *mod, int event, void *junk)
328 kprintf("The ACPI driver cannot be loaded after boot.\n");
333 if (!cold && power_pm_get_type() == POWER_PM_TYPE_ACPI)
343 * Perform early initialization.
348 static int started = 0;
352 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
354 /* Only run the startup code once. The MADT driver also calls this. */
356 return_VALUE (AE_OK);
359 /* Start up the ACPICA subsystem. */
360 status = AcpiInitializeSubsystem();
361 if (ACPI_FAILURE(status)) {
362 kprintf("ACPI: Subsystem initialization failed: %s\n",
363 AcpiFormatException(status));
364 return_VALUE (status);
368 * Pre-allocate space for RSDT/XSDT and DSDT tables and allow resizing
369 * if more tables exist.
371 if (ACPI_FAILURE(status = AcpiInitializeTables(NULL, 2, TRUE))) {
372 kprintf("ACPI: Table initialization failed: %s\n",
373 AcpiFormatException(status));
374 return_VALUE (status);
377 /* Set up any quirks we have for this system. */
378 if (acpi_quirks == ACPI_Q_OK)
379 acpi_table_quirks(&acpi_quirks);
381 /* If the user manually set the disabled hint to 0, force-enable ACPI. */
382 if (resource_int_value("acpi", 0, "disabled", &val) == 0 && val == 0)
383 acpi_quirks &= ~ACPI_Q_BROKEN;
384 if (acpi_quirks & ACPI_Q_BROKEN) {
385 kprintf("ACPI disabled by blacklist. Contact your BIOS vendor.\n");
389 return_VALUE (status);
393 * Detect ACPI, perform early initialisation
396 acpi_identify(driver_t *driver, device_t parent)
400 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
405 /* Check that we haven't been disabled with a hint. */
406 if (resource_disabled("acpi", 0))
409 /* Make sure we're not being doubly invoked. */
410 if (device_find_child(parent, "acpi", 0) != NULL)
413 ksnprintf(acpi_ca_version, sizeof(acpi_ca_version), "%x", ACPI_CA_VERSION);
415 /* Initialize root tables. */
416 if (ACPI_FAILURE(acpi_Startup())) {
417 kprintf("ACPI: Try disabling either ACPI or apic support.\n");
421 /* Attach the actual ACPI device. */
422 if ((child = BUS_ADD_CHILD(parent, parent, 10, "acpi", 0)) == NULL) {
423 device_printf(parent, "device_identify failed\n");
429 * Fetch some descriptive data from ACPI to put in our attach message.
432 acpi_probe(device_t dev)
434 ACPI_TABLE_RSDP *rsdp;
435 ACPI_TABLE_HEADER *rsdt;
436 ACPI_PHYSICAL_ADDRESS paddr;
437 char buf[ACPI_OEM_ID_SIZE + ACPI_OEM_TABLE_ID_SIZE + 2];
440 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
442 if (power_pm_get_type() != POWER_PM_TYPE_NONE &&
443 power_pm_get_type() != POWER_PM_TYPE_ACPI) {
444 device_printf(dev, "probe failed, other PM system enabled.\n");
445 return_VALUE (ENXIO);
448 if ((paddr = AcpiOsGetRootPointer()) == 0 ||
449 (rsdp = AcpiOsMapMemory(paddr, sizeof(ACPI_TABLE_RSDP))) == NULL)
450 return_VALUE (ENXIO);
451 if (acpi_ignore_xsdt == 0 &&
452 rsdp->Revision > 1 && rsdp->XsdtPhysicalAddress != 0)
453 paddr = (ACPI_PHYSICAL_ADDRESS)rsdp->XsdtPhysicalAddress;
455 paddr = (ACPI_PHYSICAL_ADDRESS)rsdp->RsdtPhysicalAddress;
456 AcpiOsUnmapMemory(rsdp, sizeof(ACPI_TABLE_RSDP));
458 if ((rsdt = AcpiOsMapMemory(paddr, sizeof(ACPI_TABLE_HEADER))) == NULL)
459 return_VALUE (ENXIO);
460 sbuf_new(&sb, buf, sizeof(buf), SBUF_FIXEDLEN);
461 sbuf_bcat(&sb, rsdt->OemId, ACPI_OEM_ID_SIZE);
464 sbuf_bcat(&sb, rsdt->OemTableId, ACPI_OEM_TABLE_ID_SIZE);
467 device_set_desc_copy(dev, sbuf_data(&sb));
469 AcpiOsUnmapMemory(rsdt, sizeof(ACPI_TABLE_HEADER));
475 acpi_attach(device_t dev)
477 struct acpi_softc *sc;
484 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
486 sc = device_get_softc(dev);
488 callout_init(&sc->susp_force_to);
490 if ((error = acpi_task_thread_init())) {
491 device_printf(dev, "Could not start task thread.\n");
497 /* Initialize resource manager. */
498 acpi_rman_io.rm_type = RMAN_ARRAY;
499 acpi_rman_io.rm_start = 0;
500 acpi_rman_io.rm_end = 0xffff;
501 acpi_rman_io.rm_descr = "ACPI I/O ports";
502 if (rman_init(&acpi_rman_io, -1) != 0)
503 panic("acpi rman_init IO ports failed");
504 acpi_rman_mem.rm_type = RMAN_ARRAY;
505 acpi_rman_mem.rm_start = 0;
506 acpi_rman_mem.rm_end = ~0ul;
507 acpi_rman_mem.rm_descr = "ACPI I/O memory addresses";
508 if (rman_init(&acpi_rman_mem, -1) != 0)
509 panic("acpi rman_init memory failed");
511 /* Initialise the ACPI mutex */
512 ACPI_LOCK_INIT(acpi, "acpi");
513 ACPI_SERIAL_INIT(acpi);
518 * Set the globals from our tunables. This is needed because ACPICA
519 * uses UINT8 for some values and we have no tunable_byte.
521 AcpiGbl_AutoSerializeMethods = acpi_auto_serialize_methods ? TRUE : FALSE;
522 AcpiGbl_DoNotUseXsdt = acpi_ignore_xsdt ? TRUE : FALSE;
523 AcpiGbl_EnableAmlDebugObject = acpi_debug_objects ? TRUE : FALSE;
524 AcpiGbl_EnableInterpreterSlack = acpi_interpreter_slack ? TRUE : FALSE;
525 AcpiGbl_ExecuteTablesAsMethods = acpi_group_module_level_code ?
527 AcpiGbl_Use32BitFadtAddresses = acpi_fadt_addr32 ? TRUE : FALSE;
528 AcpiGbl_Use32BitFacsAddresses = acpi_facs_addr32 ? TRUE : FALSE;
532 * Disable Debug Object output.
534 AcpiDbgLevel &= ~ACPI_LV_DEBUG_OBJECT;
537 /* Override OS interfaces if the user requested. */
538 acpi_reset_interfaces(dev);
540 /* Load ACPI name space. */
541 status = AcpiLoadTables();
542 if (ACPI_FAILURE(status)) {
543 device_printf(dev, "Could not load Namespace: %s\n",
544 AcpiFormatException(status));
548 /* Handle MCFG table if present. */
552 * Note that some systems (specifically, those with namespace evaluation
553 * issues that require the avoidance of parts of the namespace) must
554 * avoid running _INI and _STA on everything, as well as dodging the final
557 * For these devices, we set ACPI_NO_DEVICE_INIT and ACPI_NO_OBJECT_INIT).
559 * XXX We should arrange for the object init pass after we have attached
560 * all our child devices, but on many systems it works here.
562 flags = ACPI_FULL_INITIALIZATION;
563 if (ktestenv("debug.acpi.avoid"))
564 flags = ACPI_NO_DEVICE_INIT | ACPI_NO_OBJECT_INIT;
566 /* Bring the hardware and basic handlers online. */
567 if (ACPI_FAILURE(status = AcpiEnableSubsystem(flags))) {
568 device_printf(dev, "Could not enable ACPI: %s\n",
569 AcpiFormatException(status));
574 * Fix up the interrupt timer after enabling ACPI, so that the
575 * interrupt cputimer that choked by ACPI power management could
576 * be resurrected before probing various devices.
579 cputimer_intr_pmfixup();
582 * Call the ECDT probe function to provide EC functionality before
583 * the namespace has been evaluated.
585 * XXX This happens before the sysresource devices have been probed and
586 * attached so its resources come from nexus0. In practice, this isn't
587 * a problem but should be addressed eventually.
589 acpi_ec_ecdt_probe(dev);
591 /* Bring device objects and regions online. */
592 if (ACPI_FAILURE(status = AcpiInitializeObjects(flags))) {
593 device_printf(dev, "Could not initialize ACPI objects: %s\n",
594 AcpiFormatException(status));
599 * Setup our sysctl tree.
601 * XXX: This doesn't check to make sure that none of these fail.
603 sysctl_ctx_init(&sc->acpi_sysctl_ctx);
604 sc->acpi_sysctl_tree = SYSCTL_ADD_NODE(&sc->acpi_sysctl_ctx,
605 SYSCTL_STATIC_CHILDREN(_hw), OID_AUTO,
606 device_get_name(dev), CTLFLAG_RD, 0, "");
607 SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
608 OID_AUTO, "supported_sleep_state", CTLTYPE_STRING | CTLFLAG_RD,
609 0, 0, acpi_supported_sleep_state_sysctl, "A", "");
610 SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
611 OID_AUTO, "power_button_state", CTLTYPE_STRING | CTLFLAG_RW,
612 &sc->acpi_power_button_sx, 0, acpi_sleep_state_sysctl, "A", "");
613 SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
614 OID_AUTO, "sleep_button_state", CTLTYPE_STRING | CTLFLAG_RW,
615 &sc->acpi_sleep_button_sx, 0, acpi_sleep_state_sysctl, "A", "");
616 SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
617 OID_AUTO, "lid_switch_state", CTLTYPE_STRING | CTLFLAG_RW,
618 &sc->acpi_lid_switch_sx, 0, acpi_sleep_state_sysctl, "A", "");
619 SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
620 OID_AUTO, "standby_state", CTLTYPE_STRING | CTLFLAG_RW,
621 &sc->acpi_standby_sx, 0, acpi_sleep_state_sysctl, "A", "");
622 SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
623 OID_AUTO, "suspend_state", CTLTYPE_STRING | CTLFLAG_RW,
624 &sc->acpi_suspend_sx, 0, acpi_sleep_state_sysctl, "A", "");
625 SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
626 OID_AUTO, "sleep_delay", CTLFLAG_RW, &sc->acpi_sleep_delay, 0,
628 SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
629 OID_AUTO, "s4bios", CTLFLAG_RW, &sc->acpi_s4bios, 0, "S4BIOS mode");
630 SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
631 OID_AUTO, "verbose", CTLFLAG_RW, &sc->acpi_verbose, 0, "verbose mode");
632 SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
633 OID_AUTO, "disable_on_reboot", CTLFLAG_RW,
634 &sc->acpi_do_disable, 0, "Disable ACPI when rebooting/halting system");
635 SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
636 OID_AUTO, "handle_reboot", CTLFLAG_RW,
637 &sc->acpi_handle_reboot, 0, "Use ACPI Reset Register to reboot");
640 * Default to 1 second before sleeping to give some machines time to
643 sc->acpi_sleep_delay = 1;
645 sc->acpi_verbose = 1;
646 if ((env = kgetenv("hw.acpi.verbose")) != NULL) {
647 if (strcmp(env, "0") != 0)
648 sc->acpi_verbose = 1;
652 /* Only enable reboot by default if the FADT says it is available. */
653 if (AcpiGbl_FADT.Flags & ACPI_FADT_RESET_REGISTER)
654 sc->acpi_handle_reboot = 1;
656 /* Only enable S4BIOS by default if the FACS says it is available. */
657 if (AcpiGbl_FACS->Flags & ACPI_FACS_S4_BIOS_PRESENT)
661 * Dispatch the default sleep state to devices. The lid switch is set
662 * to NONE by default to avoid surprising users.
664 sc->acpi_power_button_sx = ACPI_STATE_S5;
665 sc->acpi_lid_switch_sx = ACPI_S_STATES_MAX + 1;
666 sc->acpi_standby_sx = ACPI_STATE_S1;
667 sc->acpi_suspend_sx = ACPI_STATE_S3;
669 /* Pick the first valid sleep state for the sleep button default. */
670 sc->acpi_sleep_button_sx = ACPI_S_STATES_MAX + 1;
671 for (state = ACPI_STATE_S1; state <= ACPI_STATE_S4; state++)
672 if (ACPI_SUCCESS(AcpiGetSleepTypeData(state, &TypeA, &TypeB))) {
673 sc->acpi_sleep_button_sx = state;
677 acpi_enable_fixed_events(sc);
680 * Scan the namespace and attach/initialise children.
683 /* Register our shutdown handler. */
684 EVENTHANDLER_REGISTER(shutdown_final, acpi_shutdown_final, sc,
688 * Register our acpi event handlers.
689 * XXX should be configurable eg. via userland policy manager.
691 EVENTHANDLER_REGISTER(acpi_sleep_event, acpi_system_eventhandler_sleep,
692 sc, ACPI_EVENT_PRI_LAST);
693 EVENTHANDLER_REGISTER(acpi_wakeup_event, acpi_system_eventhandler_wakeup,
694 sc, ACPI_EVENT_PRI_LAST);
696 /* Flag our initial states. */
697 sc->acpi_enabled = 1;
698 sc->acpi_sstate = ACPI_STATE_S0;
699 sc->acpi_sleep_disabled = 0;
700 /* Create the control device */
701 sc->acpi_dev_t = make_dev(&acpi_ops, 0, UID_ROOT, GID_WHEEL, 0644, "acpi");
702 sc->acpi_dev_t->si_drv1 = sc;
704 if ((error = acpi_machdep_init(dev)))
707 /* Register ACPI again to pass the correct argument of pm_func. */
708 power_pm_register(POWER_PM_TYPE_ACPI, acpi_pm_func, sc);
710 if (!acpi_disabled("bus"))
711 acpi_probe_children(dev);
713 /* Update all GPEs and enable runtime GPEs. */
714 status = AcpiUpdateAllGpes();
715 if (ACPI_FAILURE(status)) {
716 device_printf(dev, "Could not update all GPEs: %s\n",
717 AcpiFormatException(status));
720 /* Allow sleep request after a while. */
721 /* timeout(acpi_sleep_enable, sc, hz * ACPI_MINIMUM_AWAKETIME); */
728 cputimer_intr_pmfixup();
729 acpi_task_thread_schedule();
731 return_VALUE (error);
735 acpi_suspend(device_t dev)
737 device_t child, *devlist;
738 int error, i, numdevs, pstate;
740 /* First give child devices a chance to suspend. */
741 error = bus_generic_suspend(dev);
746 * Now, set them into the appropriate power state, usually D3. If the
747 * device has an _SxD method for the next sleep state, use that power
750 device_get_children(dev, &devlist, &numdevs);
751 for (i = 0; i < numdevs; i++) {
752 /* If the device is not attached, we've powered it down elsewhere. */
754 if (!device_is_attached(child))
758 * Default to D3 for all sleep states. The _SxD method is optional
759 * so set the powerstate even if it's absent.
761 pstate = PCI_POWERSTATE_D3;
762 error = acpi_device_pwr_for_sleep(device_get_parent(child),
764 if ((error == 0 || error == ESRCH) && acpi_do_powerstate)
765 pci_set_powerstate(child, pstate);
767 kfree(devlist, M_TEMP);
774 acpi_resume(device_t dev)
778 device_t child, *devlist;
781 * Put all devices in D0 before resuming them. Call _S0D on each one
782 * since some systems expect this.
784 device_get_children(dev, &devlist, &numdevs);
785 for (i = 0; i < numdevs; i++) {
787 handle = acpi_get_handle(child);
789 AcpiEvaluateObject(handle, "_S0D", NULL, NULL);
790 if (device_is_attached(child) && acpi_do_powerstate)
791 pci_set_powerstate(child, PCI_POWERSTATE_D0);
793 kfree(devlist, M_TEMP);
795 return (bus_generic_resume(dev));
799 acpi_shutdown(device_t dev)
801 /* Allow children to shutdown first. */
802 bus_generic_shutdown(dev);
805 * Enable any GPEs that are able to power-on the system (i.e., RTC).
806 * Also, disable any that are not valid for this state (most).
808 acpi_wake_prep_walk(ACPI_STATE_S5);
814 * Handle a new device being added
817 acpi_add_child(device_t bus, device_t parent, int order, const char *name, int unit)
819 struct acpi_device *ad;
822 if ((ad = kmalloc(sizeof(*ad), M_ACPIDEV, M_NOWAIT | M_ZERO)) == NULL)
825 resource_list_init(&ad->ad_rl);
826 child = device_add_child_ordered(parent, order, name, unit);
828 device_set_ivars(child, ad);
830 kfree(ad, M_ACPIDEV);
835 acpi_print_child(device_t bus, device_t child)
837 struct acpi_device *adev = device_get_ivars(child);
838 struct resource_list *rl = &adev->ad_rl;
841 retval += bus_print_child_header(bus, child);
842 retval += resource_list_print_type(rl, "port", SYS_RES_IOPORT, "%#lx");
843 retval += resource_list_print_type(rl, "iomem", SYS_RES_MEMORY, "%#lx");
844 retval += resource_list_print_type(rl, "irq", SYS_RES_IRQ, "%ld");
845 retval += resource_list_print_type(rl, "drq", SYS_RES_DRQ, "%ld");
846 if (device_get_flags(child))
847 retval += kprintf(" flags %#x", device_get_flags(child));
848 retval += bus_print_child_footer(bus, child);
854 * If this device is an ACPI child but no one claimed it, attempt
855 * to power it off. We'll power it back up when a driver is added.
857 * XXX Disabled for now since many necessary devices (like fdc and
858 * ATA) don't claim the devices we created for them but still expect
859 * them to be powered up.
862 acpi_probe_nomatch(device_t bus, device_t child)
865 /* pci_set_powerstate(child, PCI_POWERSTATE_D3); */
869 * If a new driver has a chance to probe a child, first power it up.
871 * XXX Disabled for now (see acpi_probe_nomatch for details).
874 acpi_driver_added(device_t dev, driver_t *driver)
876 device_t child, *devlist;
879 DEVICE_IDENTIFY(driver, dev);
880 device_get_children(dev, &devlist, &numdevs);
881 for (i = 0; i < numdevs; i++) {
883 if (device_get_state(child) == DS_NOTPRESENT) {
884 /* pci_set_powerstate(child, PCI_POWERSTATE_D0); */
885 if (device_probe_and_attach(child) != 0) {
886 ; /* pci_set_powerstate(child, PCI_POWERSTATE_D3); */
890 kfree(devlist, M_TEMP);
893 /* Location hint for devctl(8) */
895 acpi_child_location_str_method(device_t cbdev, device_t child, char *buf,
898 struct acpi_device *dinfo = device_get_ivars(child);
900 if (dinfo->ad_handle)
901 ksnprintf(buf, buflen, "handle=%s", acpi_name(dinfo->ad_handle));
903 ksnprintf(buf, buflen, "unknown");
907 /* PnP information for devctl(8) */
909 acpi_child_pnpinfo_str_method(device_t cbdev, device_t child, char *buf,
912 ACPI_DEVICE_INFO *adinfo;
913 struct acpi_device *dinfo = device_get_ivars(child);
915 if (ACPI_FAILURE(AcpiGetObjectInfo(dinfo->ad_handle, &adinfo))) {
916 ksnprintf(buf, buflen, "unknown");
918 ksnprintf(buf, buflen, "_HID=%s _UID=%s",
919 (adinfo->Valid & ACPI_VALID_HID) ?
920 adinfo->HardwareId.String : "none",
921 (adinfo->Valid & ACPI_VALID_UID) ?
922 adinfo->UniqueId.String : "0");
930 * Handle per-device ivars
933 acpi_read_ivar(device_t dev, device_t child, int index, uintptr_t *result)
935 struct acpi_device *ad;
937 if ((ad = device_get_ivars(child)) == NULL) {
938 device_printf(child, "device has no ivars\n");
942 /* ACPI and ISA compatibility ivars */
944 case ACPI_IVAR_HANDLE:
945 *(ACPI_HANDLE *)result = ad->ad_handle;
947 case ACPI_IVAR_MAGIC:
948 *result = ad->ad_magic;
950 case ACPI_IVAR_PRIVATE:
951 *(void **)result = ad->ad_private;
953 case ACPI_IVAR_FLAGS:
954 *(int *)result = ad->ad_flags;
956 case ACPI_IVAR_RECHECK:
957 *(int *)result = ad->ad_recheck;
959 case ISA_IVAR_VENDORID:
960 case ISA_IVAR_SERIAL:
961 case ISA_IVAR_COMPATID:
964 case ISA_IVAR_LOGICALID:
965 *(int *)result = acpi_isa_get_logicalid(child);
975 acpi_write_ivar(device_t dev, device_t child, int index, uintptr_t value)
977 struct acpi_device *ad;
979 if ((ad = device_get_ivars(child)) == NULL) {
980 device_printf(child, "device has no ivars\n");
985 case ACPI_IVAR_HANDLE:
986 ad->ad_handle = (ACPI_HANDLE)value;
988 case ACPI_IVAR_MAGIC:
989 ad->ad_magic = value;
991 case ACPI_IVAR_PRIVATE:
992 ad->ad_private = (void *)value;
994 case ACPI_IVAR_FLAGS:
995 ad->ad_flags = (int)value;
997 case ACPI_IVAR_RECHECK:
998 ad->ad_recheck = (int)value;
1001 panic("bad ivar write request (%d)", index);
1009 * Handle child resource allocation/removal
1011 static struct resource_list *
1012 acpi_get_rlist(device_t dev, device_t child)
1014 struct acpi_device *ad;
1016 ad = device_get_ivars(child);
1017 return (&ad->ad_rl);
1021 * Pre-allocate/manage all memory and IO resources. Since rman can't handle
1022 * duplicates, we merge any in the sysresource attach routine.
1025 acpi_sysres_alloc(device_t dev)
1027 struct resource *res;
1028 struct resource_list *rl;
1029 struct resource_list_entry *rle;
1031 char *sysres_ids[] = { "PNP0C01", "PNP0C02", NULL };
1035 * Probe/attach any sysresource devices. This would be unnecessary if we
1036 * had multi-pass probe/attach.
1038 if (device_get_children(dev, &children, &child_count) != 0)
1040 for (i = 0; i < child_count; i++) {
1041 if (ACPI_ID_PROBE(dev, children[i], sysres_ids) != NULL)
1042 device_probe_and_attach(children[i]);
1044 kfree(children, M_TEMP);
1046 rl = BUS_GET_RESOURCE_LIST(device_get_parent(dev), dev);
1049 SLIST_FOREACH(rle, rl, link) {
1050 if (rle->res != NULL) {
1051 device_printf(dev, "duplicate resource for %lx\n", rle->start);
1055 /* Only memory and IO resources are valid here. */
1056 switch (rle->type) {
1057 case SYS_RES_IOPORT:
1060 case SYS_RES_MEMORY:
1061 rm = &acpi_rman_mem;
1067 /* Pre-allocate resource and add to our rman pool. */
1068 res = BUS_ALLOC_RESOURCE(device_get_parent(dev), dev, rle->type,
1069 &rle->rid, rle->start, rle->start + rle->count - 1, rle->count,
1072 rman_manage_region(rm, rman_get_start(res), rman_get_end(res));
1075 device_printf(dev, "reservation of %lx, %lx (%d) failed\n",
1076 rle->start, rle->count, rle->type);
1081 static struct resource *
1082 acpi_alloc_resource(device_t bus, device_t child, int type, int *rid,
1083 u_long start, u_long end, u_long count, u_int flags, int cpuid)
1086 struct acpi_device *ad = device_get_ivars(child);
1087 struct resource_list *rl = &ad->ad_rl;
1088 struct resource_list_entry *rle;
1089 struct resource *res;
1094 /* We only handle memory and IO resources through rman. */
1096 case SYS_RES_IOPORT:
1099 case SYS_RES_MEMORY:
1100 rm = &acpi_rman_mem;
1106 ACPI_SERIAL_BEGIN(acpi);
1109 * If this is an allocation of the "default" range for a given RID, and
1110 * we know what the resources for this device are (i.e., they're on the
1111 * child's resource list), use those start/end values.
1113 if (bus == device_get_parent(child) && start == 0UL && end == ~0UL) {
1114 rle = resource_list_find(rl, type, *rid);
1124 * If this is an allocation of a specific range, see if we can satisfy
1125 * the request from our system resource regions. If we can't, pass the
1126 * request up to the parent.
1128 if (start + count - 1 == end && rm != NULL)
1129 res = rman_reserve_resource(rm, start, end, count, flags & ~RF_ACTIVE,
1132 res = BUS_ALLOC_RESOURCE(device_get_parent(bus), child, type, rid,
1133 start, end, count, flags, cpuid);
1135 rman_set_rid(res, *rid);
1137 /* If requested, activate the resource using the parent's method. */
1138 if (flags & RF_ACTIVE)
1139 if (bus_activate_resource(child, type, *rid, res) != 0) {
1140 rman_release_resource(res);
1146 if (res != NULL && device_get_parent(child) == bus)
1150 * Since bus_config_intr() takes immediate effect, we cannot
1151 * configure the interrupt associated with a device when we
1152 * parse the resources but have to defer it until a driver
1153 * actually allocates the interrupt via bus_alloc_resource().
1155 * NB: Lookup failure is fine, since the device may add its
1156 * own interrupt resources, e.g. MSI or MSI-X.
1159 acpi_lookup_irq_resource(child, *rid, res, &ares))) {
1160 acpi_config_intr(child, &ares);
1162 kprintf("irq resource not found\n");
1168 ACPI_SERIAL_END(acpi);
1173 acpi_release_resource(device_t bus, device_t child, int type, int rid,
1179 /* We only handle memory and IO resources through rman. */
1181 case SYS_RES_IOPORT:
1184 case SYS_RES_MEMORY:
1185 rm = &acpi_rman_mem;
1191 ACPI_SERIAL_BEGIN(acpi);
1194 * If this resource belongs to one of our internal managers,
1195 * deactivate it and release it to the local pool. If it doesn't,
1196 * pass this request up to the parent.
1198 if (rm != NULL && rman_is_region_manager(r, rm)) {
1199 if (rman_get_flags(r) & RF_ACTIVE) {
1200 ret = bus_deactivate_resource(child, type, rid, r);
1204 ret = rman_release_resource(r);
1206 ret = BUS_RELEASE_RESOURCE(device_get_parent(bus), child, type, rid, r);
1209 ACPI_SERIAL_END(acpi);
1214 acpi_delete_resource(device_t bus, device_t child, int type, int rid)
1216 struct resource_list *rl;
1218 rl = acpi_get_rlist(bus, child);
1219 resource_list_delete(rl, type, rid);
1222 /* Allocate an IO port or memory resource, given its GAS. */
1224 acpi_bus_alloc_gas(device_t dev, int *type, int *rid, ACPI_GENERIC_ADDRESS *gas,
1225 struct resource **res, u_int flags)
1227 int error, res_type;
1230 if (type == NULL || rid == NULL || gas == NULL || res == NULL)
1233 /* We only support memory and IO spaces. */
1234 switch (gas->SpaceId) {
1235 case ACPI_ADR_SPACE_SYSTEM_MEMORY:
1236 res_type = SYS_RES_MEMORY;
1238 case ACPI_ADR_SPACE_SYSTEM_IO:
1239 res_type = SYS_RES_IOPORT;
1242 return (EOPNOTSUPP);
1246 * If the register width is less than 8, assume the BIOS author means
1247 * it is a bit field and just allocate a byte.
1249 if (gas->BitWidth && gas->BitWidth < 8)
1252 /* Validate the address after we're sure we support the space. */
1253 if (gas->Address == 0 || gas->BitWidth == 0)
1256 bus_set_resource(dev, res_type, *rid, gas->Address,
1257 gas->BitWidth / 8, -1);
1258 *res = bus_alloc_resource_any(dev, res_type, rid, RF_ACTIVE | flags);
1263 bus_delete_resource(dev, res_type, *rid);
1269 acpi_eval_osc(device_t dev, ACPI_HANDLE handle, const char *uuidstr,
1270 int revision, uint32_t *buf, int count)
1272 ACPI_BUFFER retbuf = { ACPI_ALLOCATE_BUFFER, NULL };
1273 ACPI_OBJECT_LIST arglist;
1275 ACPI_OBJECT *retobj;
1279 uint8_t oscuuid[ACPI_UUID_LENGTH];
1282 if (parse_uuid(uuidstr, &uuid) != 0)
1284 le_uuid_enc(oscuuid, &uuid);
1286 arglist.Pointer = arg;
1288 arg[0].Type = ACPI_TYPE_BUFFER;
1289 arg[0].Buffer.Length = ACPI_UUID_LENGTH;
1290 arg[0].Buffer.Pointer = oscuuid; /* UUID */
1291 arg[1].Type = ACPI_TYPE_INTEGER;
1292 arg[1].Integer.Value = revision; /* revision */
1293 arg[2].Type = ACPI_TYPE_INTEGER;
1294 arg[2].Integer.Value = count; /* # of cap integers */
1295 arg[3].Type = ACPI_TYPE_BUFFER;
1296 arg[3].Buffer.Length = count * sizeof(uint32_t); /* capabilities buffer */
1297 arg[3].Buffer.Pointer = (uint8_t *)buf;
1299 status = AcpiEvaluateObject(handle, "_OSC", &arglist, &retbuf);
1300 if (ACPI_FAILURE(status))
1302 retobj = retbuf.Pointer;
1303 error = ((uint32_t *)retobj->Buffer.Pointer)[0] & ACPI_OSC_ERRMASK;
1307 if (error & ACPI_OSCERR_FAILURE)
1308 device_printf(dev, "_OSC unable to process request\n");
1309 if (error & ACPI_OSCERR_BADUUID)
1310 device_printf(dev, "_OSC unrecognized UUID (%s)\n", uuidstr);
1311 if (error & ACPI_OSCERR_BADREV)
1312 device_printf(dev, "_OSC unrecognized revision ID (%d)\n", revision);
1313 if (error & ACPI_OSCERR_CAPSMASKED) {
1314 if ((buf[0] & ACPI_OSC_QUERY_SUPPORT) == 0) {
1315 for (i = 1; i < count; i++) {
1317 "_OSC capabilities have been masked: buf[%d]:%#x\n",
1318 i, buf[i] & ~((uint32_t *)retobj->Buffer.Pointer)[i]);
1320 status = AE_SUPPORT;
1325 if (buf[0] & ACPI_OSC_QUERY_SUPPORT) {
1326 for (i = 0; i < count; i++)
1327 buf[i] = ((uint32_t *)retobj->Buffer.Pointer)[i];
1331 if (retbuf.Pointer != NULL)
1332 AcpiOsFree(retbuf.Pointer);
1336 /* Probe _HID and _CID for compatible ISA PNP ids. */
1338 acpi_isa_get_logicalid(device_t dev)
1340 ACPI_DEVICE_INFO *devinfo;
1344 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1349 /* Fetch and validate the HID. */
1350 if ((h = acpi_get_handle(dev)) == NULL ||
1351 ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo)))
1354 if ((devinfo->Valid & ACPI_VALID_HID) != 0)
1355 pnpid = PNP_EISAID(devinfo->HardwareId.String);
1359 AcpiOsFree(devinfo);
1360 return_VALUE (pnpid);
1364 acpi_isa_get_compatid(device_t dev, uint32_t *cids, int count)
1366 ACPI_DEVICE_INFO *devinfo;
1371 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1377 /* Fetch and validate the CID */
1378 if ((h = acpi_get_handle(dev)) == NULL ||
1379 ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo)) ||
1380 (devinfo->Valid & ACPI_VALID_CID) == 0)
1383 if (devinfo->CompatibleIdList.Count < count)
1384 count = devinfo->CompatibleIdList.Count;
1385 for (i = 0; i < count; i++) {
1386 if (strncmp(devinfo->CompatibleIdList.Ids[i].String, "PNP", 3) != 0)
1388 *pnpid++ = PNP_EISAID(devinfo->CompatibleIdList.Ids[i].String);
1394 AcpiOsFree(devinfo);
1395 return_VALUE (valid);
1399 acpi_device_id_probe(device_t bus, device_t dev, char **ids)
1404 h = acpi_get_handle(dev);
1405 if (ids == NULL || h == NULL || acpi_get_type(dev) != ACPI_TYPE_DEVICE)
1408 /* Try to match one of the array of IDs with a HID or CID. */
1409 for (i = 0; ids[i] != NULL; i++) {
1410 if (acpi_MatchHid(h, ids[i]))
1417 acpi_device_eval_obj(device_t bus, device_t dev, ACPI_STRING pathname,
1418 ACPI_OBJECT_LIST *parameters, ACPI_BUFFER *ret)
1423 h = ACPI_ROOT_OBJECT;
1424 else if ((h = acpi_get_handle(dev)) == NULL)
1425 return (AE_BAD_PARAMETER);
1426 return (AcpiEvaluateObject(h, pathname, parameters, ret));
1430 acpi_device_pwr_for_sleep(device_t bus, device_t dev, int *dstate)
1432 struct acpi_softc *sc;
1438 sc = device_get_softc(bus);
1439 handle = acpi_get_handle(dev);
1442 * XXX If we find these devices, don't try to power them down.
1443 * The serial and IRDA ports on my T23 hang the system when
1444 * set to D3 and it appears that such legacy devices may
1445 * need special handling in their drivers.
1447 if (handle == NULL ||
1448 acpi_MatchHid(handle, "PNP0500") ||
1449 acpi_MatchHid(handle, "PNP0501") ||
1450 acpi_MatchHid(handle, "PNP0502") ||
1451 acpi_MatchHid(handle, "PNP0510") ||
1452 acpi_MatchHid(handle, "PNP0511"))
1456 * Override next state with the value from _SxD, if present. If no
1457 * dstate argument was provided, don't fetch the return value.
1459 ksnprintf(sxd, sizeof(sxd), "_S%dD", sc->acpi_sstate);
1461 status = acpi_GetInteger(handle, sxd, dstate);
1463 status = AcpiEvaluateObject(handle, sxd, NULL, NULL);
1480 /* Callback arg for our implementation of walking the namespace. */
1481 struct acpi_device_scan_ctx {
1482 acpi_scan_cb_t user_fn;
1488 acpi_device_scan_cb(ACPI_HANDLE h, UINT32 level, void *arg, void **retval)
1490 struct acpi_device_scan_ctx *ctx;
1491 device_t dev, old_dev;
1493 ACPI_OBJECT_TYPE type;
1496 * Skip this device if we think we'll have trouble with it or it is
1497 * the parent where the scan began.
1499 ctx = (struct acpi_device_scan_ctx *)arg;
1500 if (acpi_avoid(h) || h == ctx->parent)
1503 /* If this is not a valid device type (e.g., a method), skip it. */
1504 if (ACPI_FAILURE(AcpiGetType(h, &type)))
1506 if (type != ACPI_TYPE_DEVICE && type != ACPI_TYPE_PROCESSOR &&
1507 type != ACPI_TYPE_THERMAL && type != ACPI_TYPE_POWER)
1511 * Call the user function with the current device. If it is unchanged
1512 * afterwards, return. Otherwise, we update the handle to the new dev.
1514 old_dev = acpi_get_device(h);
1516 status = ctx->user_fn(h, &dev, level, ctx->arg);
1517 if (ACPI_FAILURE(status) || old_dev == dev)
1520 /* Remove the old child and its connection to the handle. */
1521 if (old_dev != NULL) {
1522 device_delete_child(device_get_parent(old_dev), old_dev);
1523 AcpiDetachData(h, acpi_fake_objhandler);
1526 /* Recreate the handle association if the user created a device. */
1528 AcpiAttachData(h, acpi_fake_objhandler, dev);
1534 acpi_device_scan_children(device_t bus, device_t dev, int max_depth,
1535 acpi_scan_cb_t user_fn, void *arg)
1538 struct acpi_device_scan_ctx ctx;
1540 if (acpi_disabled("children"))
1544 h = ACPI_ROOT_OBJECT;
1545 else if ((h = acpi_get_handle(dev)) == NULL)
1546 return (AE_BAD_PARAMETER);
1547 ctx.user_fn = user_fn;
1550 return (AcpiWalkNamespace(ACPI_TYPE_ANY, h, max_depth,
1551 acpi_device_scan_cb, NULL, &ctx, NULL));
1555 * Even though ACPI devices are not PCI, we use the PCI approach for setting
1556 * device power states since it's close enough to ACPI.
1559 acpi_set_powerstate_method(device_t bus, device_t child, int state)
1566 h = acpi_get_handle(child);
1567 if (state < ACPI_STATE_D0 || state > ACPI_STATE_D3)
1572 /* Ignore errors if the power methods aren't present. */
1573 status = acpi_pwr_switch_consumer(h, state);
1574 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND
1575 && status != AE_BAD_PARAMETER)
1576 device_printf(bus, "failed to set ACPI power state D%d on %s: %s\n",
1577 state, acpi_name(h), AcpiFormatException(status));
1583 acpi_isa_pnp_probe(device_t bus, device_t child, struct isa_pnp_id *ids)
1585 int result, cid_count, i;
1586 uint32_t lid, cids[8];
1588 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1591 * ISA-style drivers attached to ACPI may persist and
1592 * probe manually if we return ENOENT. We never want
1593 * that to happen, so don't ever return it.
1597 /* Scan the supplied IDs for a match */
1598 lid = acpi_isa_get_logicalid(child);
1599 cid_count = acpi_isa_get_compatid(child, cids, 8);
1600 while (ids && ids->ip_id) {
1601 if (lid == ids->ip_id) {
1605 for (i = 0; i < cid_count; i++) {
1606 if (cids[i] == ids->ip_id) {
1615 if (result == 0 && ids->ip_desc)
1616 device_set_desc(child, ids->ip_desc);
1618 return_VALUE (result);
1622 * Look for a MCFG table. If it is present, use the settings for
1623 * domain (segment) 0 to setup PCI config space access via the memory
1627 acpi_enable_pcie(void)
1629 ACPI_TABLE_HEADER *hdr;
1630 ACPI_MCFG_ALLOCATION *alloc, *end;
1633 status = AcpiGetTable(ACPI_SIG_MCFG, 1, &hdr);
1634 if (ACPI_FAILURE(status))
1637 end = (ACPI_MCFG_ALLOCATION *)((char *)hdr + hdr->Length);
1638 alloc = (ACPI_MCFG_ALLOCATION *)((ACPI_TABLE_MCFG *)hdr + 1);
1639 while (alloc < end) {
1640 if (alloc->PciSegment == 0) {
1641 pcie_cfgregopen(alloc->Address, alloc->StartBusNumber,
1642 alloc->EndBusNumber);
1650 * Scan all of the ACPI namespace and attach child devices.
1652 * We should only expect to find devices in the \_PR, \_TZ, \_SI, and
1653 * \_SB scopes, and \_PR and \_TZ became obsolete in the ACPI 2.0 spec.
1654 * However, in violation of the spec, some systems place their PCI link
1655 * devices in \, so we have to walk the whole namespace. We check the
1656 * type of namespace nodes, so this should be ok.
1659 acpi_probe_children(device_t bus)
1664 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1667 * Scan the namespace and insert placeholders for all the devices that
1668 * we find. We also probe/attach any early devices.
1670 * Note that we use AcpiWalkNamespace rather than AcpiGetDevices because
1671 * we want to create nodes for all devices, not just those that are
1672 * currently present. (This assumes that we don't want to create/remove
1673 * devices as they appear, which might be smarter.)
1675 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "namespace scan\n"));
1676 AcpiWalkNamespace(ACPI_TYPE_ANY, ACPI_ROOT_OBJECT, 100,
1677 acpi_probe_child, NULL, bus, NULL);
1678 /* This gets us all the children that we added from the ACPI namespace. */
1679 device_get_children(bus, &children, &cnt);
1681 /* Pre-allocate resources for our rman from any sysresource devices. */
1682 acpi_sysres_alloc(bus);
1683 /* Create any static children by calling device identify methods. */
1684 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "device identify routines\n"));
1685 bus_generic_probe(bus);
1687 /* Probe/attach all children, created staticly and from the namespace. */
1688 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "first bus_generic_attach\n"));
1689 bus_generic_attach_gpri(bus, KOBJ_GPRI_ACPI+2);
1690 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "second bus_generic_attach\n"));
1691 bus_generic_attach_gpri(bus, KOBJ_GPRI_ACPI+1);
1692 /* Re-check device presence for previously disabled devices. */
1693 acpi_reprobe_children(bus, children, cnt);
1694 kfree(children, M_TEMP);
1695 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "third bus_generic_attach\n"));
1696 bus_generic_attach_gpri(bus, KOBJ_GPRI_ACPI);
1697 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "fourth bus_generic_attach\n"));
1698 bus_generic_attach_gpri(bus, KOBJ_GPRI_ACPI);
1701 * Some of these children may have attached others as part of their attach
1702 * process (eg. the root PCI bus driver), so rescan.
1704 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "fifth bus_generic_attach\n"));
1705 bus_generic_attach(bus);
1707 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "sixth bus_generic_attach\n"));
1708 bus_generic_attach(bus);
1710 /* Attach wake sysctls. */
1711 acpi_wake_sysctl_walk(bus);
1713 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "done attaching children\n"));
1718 * Determine the probe order for a given device.
1721 acpi_probe_order(ACPI_HANDLE handle, int *order)
1723 ACPI_OBJECT_TYPE type;
1726 * 1. I/O port and memory system resource holders
1727 * 2. Embedded controllers (to handle early accesses)
1728 * 3. PCI Link Devices
1731 AcpiGetType(handle, &type);
1732 if (acpi_MatchHid(handle, "PNP0C01") || acpi_MatchHid(handle, "PNP0C02"))
1734 else if (acpi_MatchHid(handle, "PNP0C09"))
1736 else if (acpi_MatchHid(handle, "PNP0C0F"))
1738 else if (type == ACPI_TYPE_PROCESSOR)
1743 * Flag a device as disabled, because it isn't present according to the
1744 * _STA method. We set the recheck instance-variable, to make sure that we
1745 * recheck the device presence at a later point.
1748 acpi_disable_not_present(device_t child)
1750 device_disable(child);
1751 acpi_set_recheck(child, 1);
1755 * This rechecks the device presence for all the devices which were disabled
1756 * using acpi_disable_not_present().
1759 acpi_reprobe_children(device_t bus, device_t *children, int cnt)
1763 for (i = 0; i < cnt; i++) {
1764 device_t dev = children[i];
1766 if (device_is_enabled(dev))
1769 if (acpi_get_recheck(dev)) {
1770 if (acpi_DeviceIsPresent(dev)) {
1771 acpi_set_recheck(dev, 0);
1774 * Currently we parse the resources for every
1775 * device at the first time, when we see
1776 * that it is present.
1778 acpi_parse_resources(dev, acpi_get_handle(dev),
1779 &acpi_res_parse_set, NULL);
1786 * Evaluate a child device and determine whether we might attach a device to
1790 acpi_probe_child(ACPI_HANDLE handle, UINT32 level, void *context, void **status)
1792 struct acpi_prw_data prw;
1793 ACPI_OBJECT_TYPE type;
1795 device_t bus, child;
1799 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1801 if (acpi_disabled("children"))
1802 return_ACPI_STATUS (AE_OK);
1804 /* Skip this device if we think we'll have trouble with it. */
1805 if (acpi_avoid(handle))
1806 return_ACPI_STATUS (AE_OK);
1808 bus = (device_t)context;
1809 if (ACPI_SUCCESS(AcpiGetType(handle, &type))) {
1810 handle_str = acpi_name(handle);
1812 case ACPI_TYPE_DEVICE:
1814 * Since we scan from \, be sure to skip system scope objects.
1815 * \_SB_ and \_TZ_ are defined in ACPICA as devices to work around
1816 * BIOS bugs. For example, \_SB_ is to allow \_SB_._INI to be run
1817 * during the intialization and \_TZ_ is to support Notify() on it.
1819 if (strcmp(handle_str, "\\_SB_") == 0 ||
1820 strcmp(handle_str, "\\_TZ_") == 0)
1823 if (acpi_parse_prw(handle, &prw) == 0)
1824 AcpiSetupGpeForWake(handle, prw.gpe_handle, prw.gpe_bit);
1827 case ACPI_TYPE_PROCESSOR:
1828 case ACPI_TYPE_THERMAL:
1829 case ACPI_TYPE_POWER:
1831 * Create a placeholder device for this node. Sort the
1832 * placeholder so that the probe/attach passes will run
1833 * breadth-first. Orders less than ACPI_DEV_BASE_ORDER
1834 * are reserved for special objects (i.e., system
1835 * resources). CPU devices have a very high order to
1836 * ensure they are probed after other devices.
1838 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "scanning '%s'\n", handle_str));
1839 order = level * 10 + 100;
1840 acpi_probe_order(handle, &order);
1841 child = BUS_ADD_CHILD(bus, bus, order, NULL, -1);
1845 /* Associate the handle with the device_t and vice versa. */
1846 acpi_set_handle(child, handle);
1847 AcpiAttachData(handle, acpi_fake_objhandler, child);
1850 * Check that the device is present. If it's not present,
1851 * leave it disabled (so that we have a device_t attached to
1852 * the handle, but we don't probe it).
1854 * XXX PCI link devices sometimes report "present" but not
1855 * "functional" (i.e. if disabled). Go ahead and probe them
1856 * anyway since we may enable them later.
1858 if (type == ACPI_TYPE_DEVICE && !acpi_DeviceIsPresent(child)) {
1859 /* Never disable PCI link devices. */
1860 if (acpi_MatchHid(handle, "PNP0C0F"))
1863 * Docking stations should remain enabled since the system
1864 * may be undocked at boot.
1866 if (ACPI_SUCCESS(AcpiGetHandle(handle, "_DCK", &h)))
1869 acpi_disable_not_present(child);
1874 * Get the device's resource settings and attach them.
1875 * Note that if the device has _PRS but no _CRS, we need
1876 * to decide when it's appropriate to try to configure the
1877 * device. Ignore the return value here; it's OK for the
1878 * device not to have any resources.
1880 acpi_parse_resources(child, handle, &acpi_res_parse_set, NULL);
1885 return_ACPI_STATUS (AE_OK);
1889 * AcpiAttachData() requires an object handler but never uses it. This is a
1890 * placeholder object handler so we can store a device_t in an ACPI_HANDLE.
1893 acpi_fake_objhandler(ACPI_HANDLE h, void *data)
1898 acpi_shutdown_final(void *arg, int howto)
1900 struct acpi_softc *sc;
1904 * XXX Shutdown code should only run on the BSP (cpuid 0).
1905 * Some chipsets do not power off the system correctly if called from
1909 if ((howto & RB_POWEROFF) != 0) {
1910 status = AcpiEnterSleepStatePrep(ACPI_STATE_S5);
1911 if (ACPI_FAILURE(status)) {
1912 device_printf(sc->acpi_dev, "AcpiEnterSleepStatePrep failed - %s\n",
1913 AcpiFormatException(status));
1916 device_printf(sc->acpi_dev, "Powering system off\n");
1917 ACPI_DISABLE_IRQS();
1918 status = AcpiEnterSleepState(ACPI_STATE_S5);
1919 if (ACPI_FAILURE(status)) {
1920 device_printf(sc->acpi_dev, "power-off failed - %s\n",
1921 AcpiFormatException(status));
1924 device_printf(sc->acpi_dev, "power-off failed - timeout\n");
1926 } else if ((howto & RB_HALT) == 0 && sc->acpi_handle_reboot) {
1927 /* Reboot using the reset register. */
1928 status = AcpiReset();
1929 if (ACPI_FAILURE(status)) {
1930 if (status != AE_NOT_EXIST)
1931 device_printf(sc->acpi_dev, "reset failed - %s\n",
1932 AcpiFormatException(status));
1935 device_printf(sc->acpi_dev, "reset failed - timeout\n");
1937 } else if (sc->acpi_do_disable && panicstr == NULL) {
1939 * Only disable ACPI if the user requested. On some systems, writing
1940 * the disable value to SMI_CMD hangs the system.
1942 device_printf(sc->acpi_dev, "Shutting down\n");
1948 acpi_enable_fixed_events(struct acpi_softc *sc)
1950 static int first_time = 1;
1952 /* Enable and clear fixed events and install handlers. */
1953 if ((AcpiGbl_FADT.Flags & ACPI_FADT_POWER_BUTTON) == 0) {
1954 AcpiClearEvent(ACPI_EVENT_POWER_BUTTON);
1955 AcpiInstallFixedEventHandler(ACPI_EVENT_POWER_BUTTON,
1956 acpi_event_power_button_sleep, sc);
1958 device_printf(sc->acpi_dev, "Power Button (fixed)\n");
1960 if ((AcpiGbl_FADT.Flags & ACPI_FADT_SLEEP_BUTTON) == 0) {
1961 AcpiClearEvent(ACPI_EVENT_SLEEP_BUTTON);
1962 AcpiInstallFixedEventHandler(ACPI_EVENT_SLEEP_BUTTON,
1963 acpi_event_sleep_button_sleep, sc);
1965 device_printf(sc->acpi_dev, "Sleep Button (fixed)\n");
1972 * Returns true if the device is actually present and should
1973 * be attached to. This requires the present, enabled, UI-visible
1974 * and diagnostics-passed bits to be set.
1977 acpi_DeviceIsPresent(device_t dev)
1983 h = acpi_get_handle(dev);
1986 status = acpi_GetInteger(h, "_STA", &s);
1988 /* If no _STA method, must be present */
1989 if (ACPI_FAILURE(status))
1990 return (status == AE_NOT_FOUND ? TRUE : FALSE);
1992 return (ACPI_DEVICE_PRESENT(s) ? TRUE : FALSE);
1996 * Returns true if the battery is actually present and inserted.
1999 acpi_BatteryIsPresent(device_t dev)
2005 h = acpi_get_handle(dev);
2008 status = acpi_GetInteger(h, "_STA", &s);
2010 /* If no _STA method, must be present */
2011 if (ACPI_FAILURE(status))
2012 return (status == AE_NOT_FOUND ? TRUE : FALSE);
2014 return (ACPI_BATTERY_PRESENT(s) ? TRUE : FALSE);
2018 * Match a HID string against a handle
2021 acpi_MatchHid(ACPI_HANDLE h, const char *hid)
2023 ACPI_DEVICE_INFO *devinfo;
2027 if (hid == NULL || h == NULL ||
2028 ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo)))
2031 if ((devinfo->Valid & ACPI_VALID_HID) != 0 &&
2032 strcmp(hid, devinfo->HardwareId.String) == 0)
2034 else if ((devinfo->Valid & ACPI_VALID_CID) != 0) {
2035 for (i = 0; i < devinfo->CompatibleIdList.Count; i++) {
2036 if (strcmp(hid, devinfo->CompatibleIdList.Ids[i].String) == 0) {
2043 AcpiOsFree(devinfo);
2048 * Match a UID string against a handle
2051 acpi_MatchUid(ACPI_HANDLE h, const char *uid)
2053 ACPI_DEVICE_INFO *devinfo;
2057 if (uid == NULL || h == NULL ||
2058 ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo)))
2061 if ((devinfo->Valid & ACPI_VALID_UID) != 0 &&
2062 strcmp(uid, devinfo->UniqueId.String) == 0)
2065 AcpiOsFree(devinfo);
2070 * Return the handle of a named object within our scope, ie. that of (parent)
2071 * or one if its parents.
2074 acpi_GetHandleInScope(ACPI_HANDLE parent, char *path, ACPI_HANDLE *result)
2079 /* Walk back up the tree to the root */
2081 status = AcpiGetHandle(parent, path, &r);
2082 if (ACPI_SUCCESS(status)) {
2086 /* XXX Return error here? */
2087 if (status != AE_NOT_FOUND)
2089 if (ACPI_FAILURE(AcpiGetParent(parent, &r)))
2090 return (AE_NOT_FOUND);
2096 * Allocate a buffer with a preset data size.
2099 acpi_AllocBuffer(int size)
2103 if ((buf = kmalloc(size + sizeof(*buf), M_ACPIDEV, M_NOWAIT)) == NULL)
2106 buf->Pointer = (void *)(buf + 1);
2111 acpi_SetInteger(ACPI_HANDLE handle, char *path, UINT32 number)
2114 ACPI_OBJECT_LIST args;
2116 arg1.Type = ACPI_TYPE_INTEGER;
2117 arg1.Integer.Value = number;
2119 args.Pointer = &arg1;
2121 return (AcpiEvaluateObject(handle, path, &args, NULL));
2125 * Evaluate a path that should return an integer.
2128 acpi_GetInteger(ACPI_HANDLE handle, char *path, UINT32 *number)
2135 handle = ACPI_ROOT_OBJECT;
2138 * Assume that what we've been pointed at is an Integer object, or
2139 * a method that will return an Integer.
2141 buf.Pointer = ¶m;
2142 buf.Length = sizeof(param);
2143 status = AcpiEvaluateObject(handle, path, NULL, &buf);
2144 if (ACPI_SUCCESS(status)) {
2145 if (param.Type == ACPI_TYPE_INTEGER)
2146 *number = param.Integer.Value;
2152 * In some applications, a method that's expected to return an Integer
2153 * may instead return a Buffer (probably to simplify some internal
2154 * arithmetic). We'll try to fetch whatever it is, and if it's a Buffer,
2155 * convert it into an Integer as best we can.
2159 if (status == AE_BUFFER_OVERFLOW) {
2160 if ((buf.Pointer = AcpiOsAllocate(buf.Length)) == NULL) {
2161 status = AE_NO_MEMORY;
2163 status = AcpiEvaluateObject(handle, path, NULL, &buf);
2164 if (ACPI_SUCCESS(status))
2165 status = acpi_ConvertBufferToInteger(&buf, number);
2166 AcpiOsFree(buf.Pointer);
2173 acpi_ConvertBufferToInteger(ACPI_BUFFER *bufp, UINT32 *number)
2179 p = (ACPI_OBJECT *)bufp->Pointer;
2180 if (p->Type == ACPI_TYPE_INTEGER) {
2181 *number = p->Integer.Value;
2184 if (p->Type != ACPI_TYPE_BUFFER)
2186 if (p->Buffer.Length > sizeof(int))
2187 return (AE_BAD_DATA);
2190 val = p->Buffer.Pointer;
2191 for (i = 0; i < p->Buffer.Length; i++)
2192 *number += val[i] << (i * 8);
2197 * Iterate over the elements of an a package object, calling the supplied
2198 * function for each element.
2200 * XXX possible enhancement might be to abort traversal on error.
2203 acpi_ForeachPackageObject(ACPI_OBJECT *pkg,
2204 void (*func)(ACPI_OBJECT *comp, void *arg), void *arg)
2209 if (pkg == NULL || pkg->Type != ACPI_TYPE_PACKAGE)
2210 return (AE_BAD_PARAMETER);
2212 /* Iterate over components */
2214 comp = pkg->Package.Elements;
2215 for (; i < pkg->Package.Count; i++, comp++)
2222 * Find the (index)th resource object in a set.
2225 acpi_FindIndexedResource(ACPI_BUFFER *buf, int index, ACPI_RESOURCE **resp)
2230 rp = (ACPI_RESOURCE *)buf->Pointer;
2234 if (rp > (ACPI_RESOURCE *)((uint8_t *)buf->Pointer + buf->Length))
2235 return (AE_BAD_PARAMETER);
2237 /* Check for terminator */
2238 if (rp->Type == ACPI_RESOURCE_TYPE_END_TAG || rp->Length == 0)
2239 return (AE_NOT_FOUND);
2240 rp = ACPI_NEXT_RESOURCE(rp);
2249 * Append an ACPI_RESOURCE to an ACPI_BUFFER.
2251 * Given a pointer to an ACPI_RESOURCE structure, expand the ACPI_BUFFER
2252 * provided to contain it. If the ACPI_BUFFER is empty, allocate a sensible
2253 * backing block. If the ACPI_RESOURCE is NULL, return an empty set of
2256 #define ACPI_INITIAL_RESOURCE_BUFFER_SIZE 512
2259 acpi_AppendBufferResource(ACPI_BUFFER *buf, ACPI_RESOURCE *res)
2264 /* Initialise the buffer if necessary. */
2265 if (buf->Pointer == NULL) {
2266 buf->Length = ACPI_INITIAL_RESOURCE_BUFFER_SIZE;
2267 if ((buf->Pointer = AcpiOsAllocate(buf->Length)) == NULL)
2268 return (AE_NO_MEMORY);
2269 rp = (ACPI_RESOURCE *)buf->Pointer;
2270 rp->Type = ACPI_RESOURCE_TYPE_END_TAG;
2271 rp->Length = ACPI_RS_SIZE_MIN;
2277 * Scan the current buffer looking for the terminator.
2278 * This will either find the terminator or hit the end
2279 * of the buffer and return an error.
2281 rp = (ACPI_RESOURCE *)buf->Pointer;
2283 /* Range check, don't go outside the buffer */
2284 if (rp >= (ACPI_RESOURCE *)((uint8_t *)buf->Pointer + buf->Length))
2285 return (AE_BAD_PARAMETER);
2286 if (rp->Type == ACPI_RESOURCE_TYPE_END_TAG || rp->Length == 0)
2288 rp = ACPI_NEXT_RESOURCE(rp);
2292 * Check the size of the buffer and expand if required.
2295 * size of existing resources before terminator +
2296 * size of new resource and header +
2297 * size of terminator.
2299 * Note that this loop should really only run once, unless
2300 * for some reason we are stuffing a *really* huge resource.
2302 while ((((uint8_t *)rp - (uint8_t *)buf->Pointer) +
2303 res->Length + ACPI_RS_SIZE_NO_DATA +
2304 ACPI_RS_SIZE_MIN) >= buf->Length) {
2305 if ((newp = AcpiOsAllocate(buf->Length * 2)) == NULL)
2306 return (AE_NO_MEMORY);
2307 bcopy(buf->Pointer, newp, buf->Length);
2308 rp = (ACPI_RESOURCE *)((uint8_t *)newp +
2309 ((uint8_t *)rp - (uint8_t *)buf->Pointer));
2310 AcpiOsFree(buf->Pointer);
2311 buf->Pointer = newp;
2312 buf->Length += buf->Length;
2315 /* Insert the new resource. */
2316 bcopy(res, rp, res->Length + ACPI_RS_SIZE_NO_DATA);
2318 /* And add the terminator. */
2319 rp = ACPI_NEXT_RESOURCE(rp);
2320 rp->Type = ACPI_RESOURCE_TYPE_END_TAG;
2321 rp->Length = ACPI_RS_SIZE_MIN;
2327 * Set interrupt model.
2330 acpi_SetIntrModel(int model)
2333 return (acpi_SetInteger(ACPI_ROOT_OBJECT, "_PIC", model));
2337 * DEPRECATED. This interface has serious deficiencies and will be
2340 * Immediately enter the sleep state. In the old model, acpiconf(8) ran
2341 * rc.suspend and rc.resume so we don't have to notify devd(8) to do this.
2344 acpi_SetSleepState(struct acpi_softc *sc, int state)
2349 device_printf(sc->acpi_dev,
2350 "warning: acpi_SetSleepState() deprecated, need to update your software\n");
2353 return (acpi_EnterSleepState(sc, state));
2357 acpi_sleep_force(void *arg)
2359 struct acpi_softc *sc;
2362 device_printf(sc->acpi_dev,
2363 "suspend request timed out, forcing sleep now\n");
2364 if (ACPI_FAILURE(acpi_EnterSleepState(sc, sc->acpi_next_sstate)))
2365 device_printf(sc->acpi_dev, "force sleep state S%d failed\n",
2366 sc->acpi_next_sstate);
2370 * Request that the system enter the given suspend state. All /dev/apm
2371 * devices and devd(8) will be notified. Userland then has a chance to
2372 * save state and acknowledge the request. The system sleeps once all
2376 acpi_ReqSleepState(struct acpi_softc *sc, int state)
2379 struct apm_clone_data *clone;
2382 if (state < ACPI_STATE_S1 || state > ACPI_STATE_S5)
2385 /* S5 (soft-off) should be entered directly with no waiting. */
2386 if (state == ACPI_STATE_S5) {
2387 if (ACPI_SUCCESS(acpi_EnterSleepState(sc, state)))
2393 /* This platform does not support acpi suspend/resume. */
2394 return (EOPNOTSUPP);
2396 /* If a suspend request is already in progress, just return. */
2398 if (sc->acpi_next_sstate != 0) {
2403 /* Record the pending state and notify all apm devices. */
2404 sc->acpi_next_sstate = state;
2406 STAILQ_FOREACH(clone, &sc->apm_cdevs, entries) {
2407 clone->notify_status = APM_EV_NONE;
2408 if ((clone->flags & ACPI_EVF_DEVD) == 0) {
2409 KNOTE(&clone->sel_read.si_note, 0);
2414 /* If devd(8) is not running, immediately enter the sleep state. */
2415 if (devctl_process_running() == FALSE) {
2417 if (ACPI_SUCCESS(acpi_EnterSleepState(sc, sc->acpi_next_sstate))) {
2424 /* Now notify devd(8) also. */
2425 acpi_UserNotify("Suspend", ACPI_ROOT_OBJECT, state);
2428 * Set a timeout to fire if userland doesn't ack the suspend request
2429 * in time. This way we still eventually go to sleep if we were
2430 * overheating or running low on battery, even if userland is hung.
2431 * We cancel this timeout once all userland acks are in or the
2432 * suspend request is aborted.
2434 callout_reset(&sc->susp_force_to, 10 * hz, acpi_sleep_force, sc);
2441 * Acknowledge (or reject) a pending sleep state. The caller has
2442 * prepared for suspend and is now ready for it to proceed. If the
2443 * error argument is non-zero, it indicates suspend should be cancelled
2444 * and gives an errno value describing why. Once all votes are in,
2445 * we suspend the system.
2448 acpi_AckSleepState(struct apm_clone_data *clone, int error)
2450 struct acpi_softc *sc;
2453 /* This platform does not support acpi suspend/resume. */
2454 return (EOPNOTSUPP);
2456 /* If no pending sleep state, return an error. */
2458 sc = clone->acpi_sc;
2459 if (sc->acpi_next_sstate == 0) {
2464 /* Caller wants to abort suspend process. */
2466 sc->acpi_next_sstate = 0;
2467 callout_stop(&sc->susp_force_to);
2468 device_printf(sc->acpi_dev,
2469 "listener on %s cancelled the pending suspend\n",
2470 devtoname(clone->cdev));
2476 * Mark this device as acking the suspend request. Then, walk through
2477 * all devices, seeing if they agree yet. We only count devices that
2478 * are writable since read-only devices couldn't ack the request.
2480 clone->notify_status = APM_EV_ACKED;
2482 STAILQ_FOREACH(clone, &sc->apm_cdevs, entries) {
2483 if ((clone->flags & ACPI_EVF_WRITE) != 0 &&
2484 clone->notify_status != APM_EV_ACKED) {
2490 /* If all devices have voted "yes", we will suspend now. */
2492 callout_stop(&sc->susp_force_to);
2496 if (ACPI_FAILURE(acpi_EnterSleepState(sc, sc->acpi_next_sstate)))
2504 acpi_sleep_enable(void *arg)
2506 ((struct acpi_softc *)arg)->acpi_sleep_disabled = 0;
2509 enum acpi_sleep_state {
2512 ACPI_SS_DEV_SUSPEND,
2518 * Enter the desired system sleep state.
2520 * Currently we support S1-S5 but S4 is only S4BIOS
2523 acpi_EnterSleepState(struct acpi_softc *sc, int state)
2528 enum acpi_sleep_state slp_state;
2530 ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, state);
2532 /* Re-entry once we're suspending is not allowed. */
2535 if (sc->acpi_sleep_disabled) {
2537 device_printf(sc->acpi_dev,
2538 "suspend request ignored (not ready yet)\n");
2541 sc->acpi_sleep_disabled = 1;
2545 * Be sure to hold Giant across DEVICE_SUSPEND/RESUME since non-MPSAFE
2546 * drivers need this.
2550 slp_state = ACPI_SS_NONE;
2556 status = AcpiGetSleepTypeData(state, &TypeA, &TypeB);
2557 if (status == AE_NOT_FOUND) {
2558 device_printf(sc->acpi_dev,
2559 "Sleep state S%d not supported by BIOS\n", state);
2561 } else if (ACPI_FAILURE(status)) {
2562 device_printf(sc->acpi_dev, "AcpiGetSleepTypeData failed - %s\n",
2563 AcpiFormatException(status));
2567 sc->acpi_sstate = state;
2569 /* Enable any GPEs as appropriate and requested by the user. */
2570 acpi_wake_prep_walk(state);
2571 slp_state = ACPI_SS_GPE_SET;
2574 * Inform all devices that we are going to sleep. If at least one
2575 * device fails, DEVICE_SUSPEND() automatically resumes the tree.
2577 * XXX Note that a better two-pass approach with a 'veto' pass
2578 * followed by a "real thing" pass would be better, but the current
2579 * bus interface does not provide for this.
2581 if (DEVICE_SUSPEND(root_bus) != 0) {
2582 device_printf(sc->acpi_dev, "device_suspend failed\n");
2585 slp_state = ACPI_SS_DEV_SUSPEND;
2587 /* If testing device suspend only, back out of everything here. */
2588 if (acpi_susp_bounce)
2591 status = AcpiEnterSleepStatePrep(state);
2592 if (ACPI_FAILURE(status)) {
2593 device_printf(sc->acpi_dev, "AcpiEnterSleepStatePrep failed - %s\n",
2594 AcpiFormatException(status));
2597 slp_state = ACPI_SS_SLP_PREP;
2599 if (sc->acpi_sleep_delay > 0)
2600 DELAY(sc->acpi_sleep_delay * 1000000);
2602 if (state != ACPI_STATE_S1) {
2603 acpi_sleep_machdep(sc, state);
2605 /* Re-enable ACPI hardware on wakeup from sleep state 4. */
2606 if (state == ACPI_STATE_S4)
2609 ACPI_DISABLE_IRQS();
2610 status = AcpiEnterSleepState(state);
2611 if (ACPI_FAILURE(status)) {
2612 device_printf(sc->acpi_dev, "AcpiEnterSleepState failed - %s\n",
2613 AcpiFormatException(status));
2617 slp_state = ACPI_SS_SLEPT;
2621 * Shut down cleanly and power off. This will call us back through the
2622 * shutdown handlers.
2624 shutdown_nice(RB_POWEROFF);
2628 status = AE_BAD_PARAMETER;
2633 * Back out state according to how far along we got in the suspend
2634 * process. This handles both the error and success cases.
2636 sc->acpi_next_sstate = 0;
2637 if (slp_state >= ACPI_SS_GPE_SET) {
2638 acpi_wake_prep_walk(state);
2639 sc->acpi_sstate = ACPI_STATE_S0;
2641 if (slp_state >= ACPI_SS_SLP_PREP)
2642 AcpiLeaveSleepState(state);
2643 if (slp_state >= ACPI_SS_DEV_SUSPEND)
2644 DEVICE_RESUME(root_bus);
2645 if (slp_state >= ACPI_SS_SLEPT)
2646 acpi_enable_fixed_events(sc);
2648 /* Allow another sleep request after a while. */
2649 /* XXX: needs timeout */
2650 if (state != ACPI_STATE_S5)
2651 acpi_sleep_enable(sc);
2653 /* Run /etc/rc.resume after we are back. */
2654 acpi_UserNotify("Resume", ACPI_ROOT_OBJECT, state);
2658 return_ACPI_STATUS (status);
2661 /* Enable or disable the device's GPE. */
2663 acpi_wake_set_enable(device_t dev, int enable)
2665 struct acpi_prw_data prw;
2669 /* Make sure the device supports waking the system and get the GPE. */
2670 if (acpi_parse_prw(acpi_get_handle(dev), &prw) != 0)
2673 flags = acpi_get_flags(dev);
2675 status = AcpiSetGpeWakeMask(prw.gpe_handle, prw.gpe_bit,
2677 if (ACPI_FAILURE(status)) {
2678 device_printf(dev, "enable wake failed\n");
2681 acpi_set_flags(dev, flags | ACPI_FLAG_WAKE_ENABLED);
2683 status = AcpiSetGpeWakeMask(prw.gpe_handle, prw.gpe_bit,
2685 if (ACPI_FAILURE(status)) {
2686 device_printf(dev, "disable wake failed\n");
2689 acpi_set_flags(dev, flags & ~ACPI_FLAG_WAKE_ENABLED);
2696 acpi_wake_sleep_prep(ACPI_HANDLE handle, int sstate)
2698 struct acpi_prw_data prw;
2701 /* Check that this is a wake-capable device and get its GPE. */
2702 if (acpi_parse_prw(handle, &prw) != 0)
2704 dev = acpi_get_device(handle);
2707 * The destination sleep state must be less than (i.e., higher power)
2708 * or equal to the value specified by _PRW. If this GPE cannot be
2709 * enabled for the next sleep state, then disable it. If it can and
2710 * the user requested it be enabled, turn on any required power resources
2713 if (sstate > prw.lowest_wake) {
2714 AcpiSetGpeWakeMask(prw.gpe_handle, prw.gpe_bit, ACPI_GPE_DISABLE);
2716 device_printf(dev, "wake_prep disabled wake for %s (S%d)\n",
2717 acpi_name(handle), sstate);
2718 } else if (dev && (acpi_get_flags(dev) & ACPI_FLAG_WAKE_ENABLED) != 0) {
2719 acpi_pwr_wake_enable(handle, 1);
2720 acpi_SetInteger(handle, "_PSW", 1);
2722 device_printf(dev, "wake_prep enabled for %s (S%d)\n",
2723 acpi_name(handle), sstate);
2730 acpi_wake_run_prep(ACPI_HANDLE handle, int sstate)
2732 struct acpi_prw_data prw;
2736 * Check that this is a wake-capable device and get its GPE. Return
2737 * now if the user didn't enable this device for wake.
2739 if (acpi_parse_prw(handle, &prw) != 0)
2741 dev = acpi_get_device(handle);
2742 if (dev == NULL || (acpi_get_flags(dev) & ACPI_FLAG_WAKE_ENABLED) == 0)
2746 * If this GPE couldn't be enabled for the previous sleep state, it was
2747 * disabled before going to sleep so re-enable it. If it was enabled,
2748 * clear _PSW and turn off any power resources it used.
2750 if (sstate > prw.lowest_wake) {
2751 AcpiSetGpeWakeMask(prw.gpe_handle, prw.gpe_bit, ACPI_GPE_ENABLE);
2753 device_printf(dev, "run_prep re-enabled %s\n", acpi_name(handle));
2755 acpi_SetInteger(handle, "_PSW", 0);
2756 acpi_pwr_wake_enable(handle, 0);
2758 device_printf(dev, "run_prep cleaned up for %s\n",
2766 acpi_wake_prep(ACPI_HANDLE handle, UINT32 level, void *context, void **status)
2770 /* If suspending, run the sleep prep function, otherwise wake. */
2771 sstate = *(int *)context;
2772 if (AcpiGbl_SystemAwakeAndRunning)
2773 acpi_wake_sleep_prep(handle, sstate);
2775 acpi_wake_run_prep(handle, sstate);
2779 /* Walk the tree rooted at acpi0 to prep devices for suspend/resume. */
2781 acpi_wake_prep_walk(int sstate)
2783 ACPI_HANDLE sb_handle;
2785 if (ACPI_SUCCESS(AcpiGetHandle(ACPI_ROOT_OBJECT, "\\_SB_", &sb_handle))) {
2786 AcpiWalkNamespace(ACPI_TYPE_DEVICE, sb_handle, 100,
2787 acpi_wake_prep, NULL, &sstate, NULL);
2792 /* Walk the tree rooted at acpi0 to attach per-device wake sysctls. */
2794 acpi_wake_sysctl_walk(device_t dev)
2797 int error, i, numdevs;
2802 error = device_get_children(dev, &devlist, &numdevs);
2803 if (error != 0 || numdevs == 0) {
2805 kfree(devlist, M_TEMP);
2808 for (i = 0; i < numdevs; i++) {
2810 acpi_wake_sysctl_walk(child);
2811 if (!device_is_attached(child))
2813 status = AcpiEvaluateObject(acpi_get_handle(child), "_PRW", NULL, NULL);
2814 if (ACPI_SUCCESS(status)) {
2815 SYSCTL_ADD_PROC(device_get_sysctl_ctx(child),
2816 SYSCTL_CHILDREN(device_get_sysctl_tree(child)), OID_AUTO,
2817 "wake", CTLTYPE_INT | CTLFLAG_RW, child, 0,
2818 acpi_wake_set_sysctl, "I", "Device set to wake the system");
2821 kfree(devlist, M_TEMP);
2828 /* Enable or disable wake from userland. */
2830 acpi_wake_set_sysctl(SYSCTL_HANDLER_ARGS)
2835 dev = (device_t)arg1;
2836 enable = (acpi_get_flags(dev) & ACPI_FLAG_WAKE_ENABLED) ? 1 : 0;
2838 error = sysctl_handle_int(oidp, &enable, 0, req);
2839 if (error != 0 || req->newptr == NULL)
2841 if (enable != 0 && enable != 1)
2844 return (acpi_wake_set_enable(dev, enable));
2848 /* Parse a device's _PRW into a structure. */
2850 acpi_parse_prw(ACPI_HANDLE h, struct acpi_prw_data *prw)
2853 ACPI_BUFFER prw_buffer;
2854 ACPI_OBJECT *res, *res2;
2855 int error, i, power_count;
2857 if (h == NULL || prw == NULL)
2861 * The _PRW object (7.2.9) is only required for devices that have the
2862 * ability to wake the system from a sleeping state.
2865 prw_buffer.Pointer = NULL;
2866 prw_buffer.Length = ACPI_ALLOCATE_BUFFER;
2867 status = AcpiEvaluateObject(h, "_PRW", NULL, &prw_buffer);
2868 if (ACPI_FAILURE(status))
2870 res = (ACPI_OBJECT *)prw_buffer.Pointer;
2873 if (!ACPI_PKG_VALID(res, 2))
2877 * Element 1 of the _PRW object:
2878 * The lowest power system sleeping state that can be entered while still
2879 * providing wake functionality. The sleeping state being entered must
2880 * be less than (i.e., higher power) or equal to this value.
2882 if (acpi_PkgInt32(res, 1, &prw->lowest_wake) != 0)
2886 * Element 0 of the _PRW object:
2888 switch (res->Package.Elements[0].Type) {
2889 case ACPI_TYPE_INTEGER:
2891 * If the data type of this package element is numeric, then this
2892 * _PRW package element is the bit index in the GPEx_EN, in the
2893 * GPE blocks described in the FADT, of the enable bit that is
2894 * enabled for the wake event.
2896 prw->gpe_handle = NULL;
2897 prw->gpe_bit = res->Package.Elements[0].Integer.Value;
2900 case ACPI_TYPE_PACKAGE:
2902 * If the data type of this package element is a package, then this
2903 * _PRW package element is itself a package containing two
2904 * elements. The first is an object reference to the GPE Block
2905 * device that contains the GPE that will be triggered by the wake
2906 * event. The second element is numeric and it contains the bit
2907 * index in the GPEx_EN, in the GPE Block referenced by the
2908 * first element in the package, of the enable bit that is enabled for
2911 * For example, if this field is a package then it is of the form:
2912 * Package() {\_SB.PCI0.ISA.GPE, 2}
2914 res2 = &res->Package.Elements[0];
2915 if (!ACPI_PKG_VALID(res2, 2))
2917 prw->gpe_handle = acpi_GetReference(NULL, &res2->Package.Elements[0]);
2918 if (prw->gpe_handle == NULL)
2920 if (acpi_PkgInt32(res2, 1, &prw->gpe_bit) != 0)
2928 /* Elements 2 to N of the _PRW object are power resources. */
2929 power_count = res->Package.Count - 2;
2930 if (power_count > ACPI_PRW_MAX_POWERRES) {
2931 kprintf("ACPI device %s has too many power resources\n", acpi_name(h));
2934 prw->power_res_count = power_count;
2935 for (i = 0; i < power_count; i++)
2936 prw->power_res[i] = res->Package.Elements[i];
2939 if (prw_buffer.Pointer != NULL)
2940 AcpiOsFree(prw_buffer.Pointer);
2945 * ACPI Event Handlers
2948 /* System Event Handlers (registered by EVENTHANDLER_REGISTER) */
2951 acpi_system_eventhandler_sleep(void *arg, int state)
2953 struct acpi_softc *sc;
2956 ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, state);
2960 /* Check if button action is disabled. */
2961 if (state == ACPI_S_STATES_MAX + 1)
2964 /* Request that the system prepare to enter the given suspend state. */
2965 ret = acpi_ReqSleepState((struct acpi_softc *)arg, state);
2967 device_printf(sc->acpi_dev,
2968 "request to enter state S%d failed (err %d)\n", state, ret);
2974 acpi_system_eventhandler_wakeup(void *arg, int state)
2977 ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, state);
2979 /* Currently, nothing to do for wakeup. */
2985 * ACPICA Event Handlers (FixedEvent, also called from button notify handler)
2988 acpi_event_power_button_sleep(void *context)
2990 struct acpi_softc *sc = (struct acpi_softc *)context;
2992 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
2994 EVENTHANDLER_INVOKE(acpi_sleep_event, sc->acpi_power_button_sx);
2996 return_VALUE (ACPI_INTERRUPT_HANDLED);
3000 acpi_event_power_button_wake(void *context)
3002 struct acpi_softc *sc = (struct acpi_softc *)context;
3004 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
3006 EVENTHANDLER_INVOKE(acpi_wakeup_event, sc->acpi_power_button_sx);
3008 return_VALUE (ACPI_INTERRUPT_HANDLED);
3012 acpi_event_sleep_button_sleep(void *context)
3014 struct acpi_softc *sc = (struct acpi_softc *)context;
3016 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
3018 EVENTHANDLER_INVOKE(acpi_sleep_event, sc->acpi_sleep_button_sx);
3020 return_VALUE (ACPI_INTERRUPT_HANDLED);
3024 acpi_event_sleep_button_wake(void *context)
3026 struct acpi_softc *sc = (struct acpi_softc *)context;
3028 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
3030 EVENTHANDLER_INVOKE(acpi_wakeup_event, sc->acpi_sleep_button_sx);
3032 return_VALUE (ACPI_INTERRUPT_HANDLED);
3036 * XXX This static buffer is suboptimal. There is no locking so only
3037 * use this for single-threaded callers.
3040 acpi_name(ACPI_HANDLE handle)
3043 static char data[256];
3045 buf.Length = sizeof(data);
3048 if (handle && ACPI_SUCCESS(AcpiGetName(handle, ACPI_FULL_PATHNAME, &buf)))
3050 return ("(unknown)");
3054 * Debugging/bug-avoidance. Avoid trying to fetch info on various
3055 * parts of the namespace.
3058 acpi_avoid(ACPI_HANDLE handle)
3060 char *cp, *env, *np;
3063 np = acpi_name(handle);
3066 if ((env = kgetenv("debug.acpi.avoid")) == NULL)
3069 /* Scan the avoid list checking for a match */
3072 while (*cp != 0 && isspace(*cp))
3077 while (cp[len] != 0 && !isspace(cp[len]))
3079 if (!strncmp(cp, np, len)) {
3091 * Debugging/bug-avoidance. Disable ACPI subsystem components.
3094 acpi_disabled(char *subsys)
3099 if ((env = kgetenv("debug.acpi.disabled")) == NULL)
3101 if (strcmp(env, "all") == 0) {
3106 /* Scan the disable list, checking for a match. */
3109 while (*cp != '\0' && isspace(*cp))
3114 while (cp[len] != '\0' && !isspace(cp[len]))
3116 if (strncmp(cp, subsys, len) == 0) {
3128 * Debugging/bug-avoidance. Enable ACPI subsystem components. Most
3129 * components are enabled by default. The ones that are not have to be
3130 * enabled via debug.acpi.enabled.
3133 acpi_enabled(char *subsys)
3138 if ((env = kgetenv("debug.acpi.enabled")) == NULL)
3140 if (strcmp(env, "all") == 0) {
3145 /* Scan the enable list, checking for a match. */
3148 while (*cp != '\0' && isspace(*cp))
3153 while (cp[len] != '\0' && !isspace(cp[len]))
3155 if (strncmp(cp, subsys, len) == 0) {
3167 * Control interface.
3169 * We multiplex ioctls for all participating ACPI devices here. Individual
3170 * drivers wanting to be accessible via /dev/acpi should use the
3171 * register/deregister interface to make their handlers visible.
3173 struct acpi_ioctl_hook
3175 TAILQ_ENTRY(acpi_ioctl_hook) link;
3181 static TAILQ_HEAD(,acpi_ioctl_hook) acpi_ioctl_hooks;
3182 static int acpi_ioctl_hooks_initted;
3185 acpi_register_ioctl(u_long cmd, acpi_ioctl_fn fn, void *arg)
3187 struct acpi_ioctl_hook *hp;
3189 if ((hp = kmalloc(sizeof(*hp), M_ACPIDEV, M_NOWAIT)) == NULL)
3196 if (acpi_ioctl_hooks_initted == 0) {
3197 TAILQ_INIT(&acpi_ioctl_hooks);
3198 acpi_ioctl_hooks_initted = 1;
3200 TAILQ_INSERT_TAIL(&acpi_ioctl_hooks, hp, link);
3207 acpi_deregister_ioctl(u_long cmd, acpi_ioctl_fn fn)
3209 struct acpi_ioctl_hook *hp;
3212 TAILQ_FOREACH(hp, &acpi_ioctl_hooks, link)
3213 if (hp->cmd == cmd && hp->fn == fn)
3217 TAILQ_REMOVE(&acpi_ioctl_hooks, hp, link);
3218 kfree(hp, M_ACPIDEV);
3224 acpiopen(struct dev_open_args *ap)
3230 acpiclose(struct dev_close_args *ap)
3236 acpiioctl(struct dev_ioctl_args *ap)
3238 struct acpi_softc *sc;
3239 struct acpi_ioctl_hook *hp;
3244 sc = ap->a_head.a_dev->si_drv1;
3247 * Scan the list of registered ioctls, looking for handlers.
3249 lwkt_gettoken(&acpi_token);
3251 if (acpi_ioctl_hooks_initted) {
3252 TAILQ_FOREACH(hp, &acpi_ioctl_hooks, link) {
3253 if (hp->cmd == ap->a_cmd)
3259 error = hp->fn(ap->a_cmd, ap->a_data, hp->arg);
3260 lwkt_reltoken(&acpi_token);
3265 * Core ioctls are not permitted for non-writable user.
3266 * Currently, other ioctls just fetch information.
3267 * Not changing system behavior.
3269 if ((ap->a_fflag & FWRITE) == 0) {
3270 lwkt_reltoken(&acpi_token);
3274 /* Core system ioctls. */
3275 switch (ap->a_cmd) {
3276 case ACPIIO_REQSLPSTATE:
3277 state = *(int *)ap->a_data;
3278 if (state != ACPI_STATE_S5)
3279 error = acpi_ReqSleepState(sc, state);
3281 device_printf(sc->acpi_dev,
3282 "power off via acpi ioctl not supported\n");
3286 case ACPIIO_ACKSLPSTATE:
3289 error = *(int *)ap->a_data;
3290 error = acpi_AckSleepState(sc->acpi_clone, error);
3293 case ACPIIO_SETSLPSTATE: /* DEPRECATED */
3295 state = *(int *)ap->a_data;
3296 if (state >= ACPI_STATE_S0 && state <= ACPI_S_STATES_MAX)
3297 if (ACPI_SUCCESS(acpi_SetSleepState(sc, state)))
3300 case ACPIIO_DO_MCALL:
3301 if (acpi_allow_mcall == 1) {
3302 struct acpi_mcall_ioctl_arg *params;
3303 ACPI_BUFFER result = { ACPI_ALLOCATE_BUFFER, NULL };
3304 ACPI_OBJECT *resobj;
3307 params = (struct acpi_mcall_ioctl_arg *)ap->a_data;
3308 params->retval = AcpiEvaluateObject(NULL, params->path,
3309 ¶ms->args, &result);
3310 if (ACPI_SUCCESS(params->retval) && result.Pointer != NULL &&
3311 params->result.Pointer != NULL) {
3312 params->result.Length = min(params->result.Length,
3314 copyout(result.Pointer, params->result.Pointer,
3315 params->result.Length);
3316 params->reslen = result.Length;
3317 if (result.Length >= sizeof(ACPI_OBJECT)) {
3318 resobj = (ACPI_OBJECT *)params->result.Pointer;
3319 switch (resobj->Type) {
3320 case ACPI_TYPE_STRING:
3321 resobj->String.Pointer = (char *)
3322 ((UINT8 *)(resobj->String.Pointer) -
3323 (UINT8 *)result.Pointer +
3326 case ACPI_TYPE_BUFFER:
3327 resobj->Buffer.Pointer -= (UINT8 *)result.Pointer -
3334 if (result.Pointer != NULL)
3335 AcpiOsFree(result.Pointer);
3337 device_printf(sc->acpi_dev,
3338 "debug.acpi.allow_method_calls must be set\n");
3346 lwkt_reltoken(&acpi_token);
3352 acpi_supported_sleep_state_sysctl(SYSCTL_HANDLER_ARGS)
3356 UINT8 state, TypeA, TypeB;
3358 sbuf_new(&sb, NULL, 32, SBUF_AUTOEXTEND);
3359 for (state = ACPI_STATE_S1; state < ACPI_S_STATES_MAX + 1; state++)
3360 if (ACPI_SUCCESS(AcpiGetSleepTypeData(state, &TypeA, &TypeB)))
3361 sbuf_printf(&sb, "S%d ", state);
3364 error = sysctl_handle_string(oidp, sbuf_data(&sb), sbuf_len(&sb), req);
3370 acpi_sleep_state_sysctl(SYSCTL_HANDLER_ARGS)
3372 char sleep_state[10];
3374 u_int new_state, old_state;
3376 old_state = *(u_int *)oidp->oid_arg1;
3377 if (old_state > ACPI_S_STATES_MAX + 1)
3378 strlcpy(sleep_state, "unknown", sizeof(sleep_state));
3380 strlcpy(sleep_state, sleep_state_names[old_state], sizeof(sleep_state));
3381 error = sysctl_handle_string(oidp, sleep_state, sizeof(sleep_state), req);
3382 if (error == 0 && req->newptr != NULL) {
3383 new_state = ACPI_STATE_S0;
3384 for (; new_state <= ACPI_S_STATES_MAX + 1; new_state++)
3385 if (strcmp(sleep_state, sleep_state_names[new_state]) == 0)
3387 if (new_state <= ACPI_S_STATES_MAX + 1) {
3388 if (new_state != old_state)
3389 *(u_int *)oidp->oid_arg1 = new_state;
3397 /* Inform devctl(4) when we receive a Notify. */
3399 acpi_UserNotify(const char *subsystem, ACPI_HANDLE h, uint8_t notify)
3401 char notify_buf[16];
3402 ACPI_BUFFER handle_buf;
3405 if (subsystem == NULL)
3408 handle_buf.Pointer = NULL;
3409 handle_buf.Length = ACPI_ALLOCATE_BUFFER;
3410 status = AcpiNsHandleToPathname(h, &handle_buf, FALSE);
3411 if (ACPI_FAILURE(status))
3413 ksnprintf(notify_buf, sizeof(notify_buf), "notify=0x%02x", notify);
3414 devctl_notify("ACPI", subsystem, handle_buf.Pointer, notify_buf);
3415 AcpiOsFree(handle_buf.Pointer);
3420 * Support for parsing debug options from the kernel environment.
3422 * Bits may be set in the AcpiDbgLayer and AcpiDbgLevel debug registers
3423 * by specifying the names of the bits in the debug.acpi.layer and
3424 * debug.acpi.level environment variables. Bits may be unset by
3425 * prefixing the bit name with !.
3433 static struct debugtag dbg_layer[] = {
3434 {"ACPI_UTILITIES", ACPI_UTILITIES},
3435 {"ACPI_HARDWARE", ACPI_HARDWARE},
3436 {"ACPI_EVENTS", ACPI_EVENTS},
3437 {"ACPI_TABLES", ACPI_TABLES},
3438 {"ACPI_NAMESPACE", ACPI_NAMESPACE},
3439 {"ACPI_PARSER", ACPI_PARSER},
3440 {"ACPI_DISPATCHER", ACPI_DISPATCHER},
3441 {"ACPI_EXECUTER", ACPI_EXECUTER},
3442 {"ACPI_RESOURCES", ACPI_RESOURCES},
3443 {"ACPI_CA_DEBUGGER", ACPI_CA_DEBUGGER},
3444 {"ACPI_OS_SERVICES", ACPI_OS_SERVICES},
3445 {"ACPI_CA_DISASSEMBLER", ACPI_CA_DISASSEMBLER},
3446 {"ACPI_ALL_COMPONENTS", ACPI_ALL_COMPONENTS},
3448 {"ACPI_AC_ADAPTER", ACPI_AC_ADAPTER},
3449 {"ACPI_BATTERY", ACPI_BATTERY},
3450 {"ACPI_BUS", ACPI_BUS},
3451 {"ACPI_BUTTON", ACPI_BUTTON},
3452 {"ACPI_EC", ACPI_EC},
3453 {"ACPI_FAN", ACPI_FAN},
3454 {"ACPI_POWERRES", ACPI_POWERRES},
3455 {"ACPI_PROCESSOR", ACPI_PROCESSOR},
3456 {"ACPI_THERMAL", ACPI_THERMAL},
3457 {"ACPI_TIMER", ACPI_TIMER},
3458 {"ACPI_ALL_DRIVERS", ACPI_ALL_DRIVERS},
3462 static struct debugtag dbg_level[] = {
3463 {"ACPI_LV_INIT", ACPI_LV_INIT},
3464 {"ACPI_LV_DEBUG_OBJECT", ACPI_LV_DEBUG_OBJECT},
3465 {"ACPI_LV_INFO", ACPI_LV_INFO},
3466 {"ACPI_LV_REPAIR", ACPI_LV_REPAIR},
3467 {"ACPI_LV_ALL_EXCEPTIONS", ACPI_LV_ALL_EXCEPTIONS},
3469 /* Trace verbosity level 1 [Standard Trace Level] */
3470 {"ACPI_LV_INIT_NAMES", ACPI_LV_INIT_NAMES},
3471 {"ACPI_LV_PARSE", ACPI_LV_PARSE},
3472 {"ACPI_LV_LOAD", ACPI_LV_LOAD},
3473 {"ACPI_LV_DISPATCH", ACPI_LV_DISPATCH},
3474 {"ACPI_LV_EXEC", ACPI_LV_EXEC},
3475 {"ACPI_LV_NAMES", ACPI_LV_NAMES},
3476 {"ACPI_LV_OPREGION", ACPI_LV_OPREGION},
3477 {"ACPI_LV_BFIELD", ACPI_LV_BFIELD},
3478 {"ACPI_LV_TABLES", ACPI_LV_TABLES},
3479 {"ACPI_LV_VALUES", ACPI_LV_VALUES},
3480 {"ACPI_LV_OBJECTS", ACPI_LV_OBJECTS},
3481 {"ACPI_LV_RESOURCES", ACPI_LV_RESOURCES},
3482 {"ACPI_LV_USER_REQUESTS", ACPI_LV_USER_REQUESTS},
3483 {"ACPI_LV_PACKAGE", ACPI_LV_PACKAGE},
3484 {"ACPI_LV_VERBOSITY1", ACPI_LV_VERBOSITY1},
3486 /* Trace verbosity level 2 [Function tracing and memory allocation] */
3487 {"ACPI_LV_ALLOCATIONS", ACPI_LV_ALLOCATIONS},
3488 {"ACPI_LV_FUNCTIONS", ACPI_LV_FUNCTIONS},
3489 {"ACPI_LV_OPTIMIZATIONS", ACPI_LV_OPTIMIZATIONS},
3490 {"ACPI_LV_VERBOSITY2", ACPI_LV_VERBOSITY2},
3491 {"ACPI_LV_ALL", ACPI_LV_ALL},
3493 /* Trace verbosity level 3 [Threading, I/O, and Interrupts] */
3494 {"ACPI_LV_MUTEX", ACPI_LV_MUTEX},
3495 {"ACPI_LV_THREADS", ACPI_LV_THREADS},
3496 {"ACPI_LV_IO", ACPI_LV_IO},
3497 {"ACPI_LV_INTERRUPTS", ACPI_LV_INTERRUPTS},
3498 {"ACPI_LV_VERBOSITY3", ACPI_LV_VERBOSITY3},
3500 /* Exceptionally verbose output -- also used in the global "DebugLevel" */
3501 {"ACPI_LV_AML_DISASSEMBLE", ACPI_LV_AML_DISASSEMBLE},
3502 {"ACPI_LV_VERBOSE_INFO", ACPI_LV_VERBOSE_INFO},
3503 {"ACPI_LV_FULL_TABLES", ACPI_LV_FULL_TABLES},
3504 {"ACPI_LV_EVENTS", ACPI_LV_EVENTS},
3505 {"ACPI_LV_VERBOSE", ACPI_LV_VERBOSE},
3510 acpi_parse_debug(char *cp, struct debugtag *tag, UINT32 *flag)
3522 while (*ep && !isspace(*ep))
3533 for (i = 0; tag[i].name != NULL; i++) {
3534 if (!strncmp(cp, tag[i].name, l)) {
3536 *flag |= tag[i].value;
3538 *flag &= ~tag[i].value;
3546 acpi_set_debugging(void *junk)
3548 char *layer, *level;
3555 layer = kgetenv("debug.acpi.layer");
3556 level = kgetenv("debug.acpi.level");
3557 if (layer == NULL && level == NULL)
3560 kprintf("ACPI set debug");
3561 if (layer != NULL) {
3562 if (strcmp("NONE", layer) != 0)
3563 kprintf(" layer '%s'", layer);
3564 acpi_parse_debug(layer, &dbg_layer[0], &AcpiDbgLayer);
3567 if (level != NULL) {
3568 if (strcmp("NONE", level) != 0)
3569 kprintf(" level '%s'", level);
3570 acpi_parse_debug(level, &dbg_level[0], &AcpiDbgLevel);
3576 SYSINIT(acpi_debugging, SI_BOOT1_TUNABLES, SI_ORDER_ANY, acpi_set_debugging,
3580 acpi_debug_sysctl(SYSCTL_HANDLER_ARGS)
3583 struct debugtag *tag;
3586 if (sbuf_new(&sb, NULL, 128, SBUF_AUTOEXTEND) == NULL)
3588 if (strcmp(oidp->oid_arg1, "debug.acpi.layer") == 0) {
3589 tag = &dbg_layer[0];
3590 dbg = &AcpiDbgLayer;
3592 tag = &dbg_level[0];
3593 dbg = &AcpiDbgLevel;
3596 /* Get old values if this is a get request. */
3597 ACPI_SERIAL_BEGIN(acpi);
3599 sbuf_cpy(&sb, "NONE");
3600 } else if (req->newptr == NULL) {
3601 for (; tag->name != NULL; tag++) {
3602 if ((*dbg & tag->value) == tag->value)
3603 sbuf_printf(&sb, "%s ", tag->name);
3609 /* Copy out the old values to the user. */
3610 error = SYSCTL_OUT(req, sbuf_data(&sb), sbuf_len(&sb));
3613 /* If the user is setting a string, parse it. */
3614 if (error == 0 && req->newptr != NULL) {
3616 ksetenv((char *)oidp->oid_arg1, (char *)req->newptr);
3617 acpi_set_debugging(NULL);
3619 ACPI_SERIAL_END(acpi);
3624 SYSCTL_PROC(_debug_acpi, OID_AUTO, layer, CTLFLAG_RW | CTLTYPE_STRING,
3625 "debug.acpi.layer", 0, acpi_debug_sysctl, "A", "");
3626 SYSCTL_PROC(_debug_acpi, OID_AUTO, level, CTLFLAG_RW | CTLTYPE_STRING,
3627 "debug.acpi.level", 0, acpi_debug_sysctl, "A", "");
3628 #endif /* ACPI_DEBUG */
3631 acpi_debug_objects_sysctl(SYSCTL_HANDLER_ARGS)
3636 old = acpi_debug_objects;
3637 error = sysctl_handle_int(oidp, &acpi_debug_objects, 0, req);
3638 if (error != 0 || req->newptr == NULL)
3640 if (old == acpi_debug_objects || (old && acpi_debug_objects))
3643 ACPI_SERIAL_BEGIN(acpi);
3644 AcpiGbl_EnableAmlDebugObject = acpi_debug_objects ? TRUE : FALSE;
3645 ACPI_SERIAL_END(acpi);
3652 acpi_parse_interfaces(char *str, struct acpi_interface *iface)
3659 while (isspace(*p) || *p == ',')
3664 p = kstrdup(p, M_TEMP);
3665 for (i = 0; i < len; i++)
3670 if (isspace(p[i]) || p[i] == '\0')
3673 i += strlen(p + i) + 1;
3680 iface->data = kmalloc(sizeof(*iface->data) * j, M_TEMP, M_WAITOK);
3684 if (isspace(p[i]) || p[i] == '\0')
3687 iface->data[j] = p + i;
3688 i += strlen(p + i) + 1;
3696 acpi_free_interfaces(struct acpi_interface *iface)
3698 kfree(iface->data[0], M_TEMP);
3699 kfree(iface->data, M_TEMP);
3703 acpi_reset_interfaces(device_t dev)
3705 struct acpi_interface list;
3709 if (acpi_parse_interfaces(acpi_install_interface, &list) > 0) {
3710 for (i = 0; i < list.num; i++) {
3711 status = AcpiInstallInterface(list.data[i]);
3712 if (ACPI_FAILURE(status))
3714 "failed to install _OSI(\"%s\"): %s\n",
3715 list.data[i], AcpiFormatException(status));
3716 else if (bootverbose)
3717 device_printf(dev, "installed _OSI(\"%s\")\n",
3720 acpi_free_interfaces(&list);
3722 if (acpi_parse_interfaces(acpi_remove_interface, &list) > 0) {
3723 for (i = 0; i < list.num; i++) {
3724 status = AcpiRemoveInterface(list.data[i]);
3725 if (ACPI_FAILURE(status))
3727 "failed to remove _OSI(\"%s\"): %s\n",
3728 list.data[i], AcpiFormatException(status));
3729 else if (bootverbose)
3730 device_printf(dev, "removed _OSI(\"%s\")\n",
3733 acpi_free_interfaces(&list);
3738 acpi_pm_func(u_long cmd, void *arg, ...)
3740 int state, acpi_state;
3742 struct acpi_softc *sc;
3747 case POWER_CMD_SUSPEND:
3748 sc = (struct acpi_softc *)arg;
3754 __va_start(ap, arg);
3755 state = __va_arg(ap, int);
3759 case POWER_SLEEP_STATE_STANDBY:
3760 acpi_state = sc->acpi_standby_sx;
3762 case POWER_SLEEP_STATE_SUSPEND:
3763 acpi_state = sc->acpi_suspend_sx;
3765 case POWER_SLEEP_STATE_HIBERNATE:
3766 acpi_state = ACPI_STATE_S4;
3773 if (ACPI_FAILURE(acpi_EnterSleepState(sc, acpi_state)))
3786 acpi_pm_register(void *arg)
3788 if (!cold || resource_disabled("acpi", 0))
3791 power_pm_register(POWER_PM_TYPE_ACPI, acpi_pm_func, NULL);
3794 SYSINIT(power, SI_BOOT2_KLD, SI_ORDER_ANY, acpi_pm_register, 0);