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 ACPI_STATUS acpi_probe_child(ACPI_HANDLE handle, UINT32 level,
144 void *context, void **status);
145 static ACPI_STATUS acpi_EnterSleepState(struct acpi_softc *sc, int state);
146 static void acpi_shutdown_final(void *arg, int howto);
147 static void acpi_enable_fixed_events(struct acpi_softc *sc);
148 static int acpi_wake_sleep_prep(ACPI_HANDLE handle, int sstate);
149 static int acpi_wake_run_prep(ACPI_HANDLE handle, int sstate);
150 static int acpi_wake_prep_walk(int sstate);
151 static int acpi_wake_sysctl_walk(device_t dev);
153 static int acpi_wake_set_sysctl(SYSCTL_HANDLER_ARGS);
155 static void acpi_system_eventhandler_sleep(void *arg, int state);
156 static void acpi_system_eventhandler_wakeup(void *arg, int state);
157 static int acpi_supported_sleep_state_sysctl(SYSCTL_HANDLER_ARGS);
158 static int acpi_sleep_state_sysctl(SYSCTL_HANDLER_ARGS);
159 static int acpi_debug_objects_sysctl(SYSCTL_HANDLER_ARGS);
160 static int acpi_pm_func(u_long cmd, void *arg, ...);
161 static int acpi_child_location_str_method(device_t acdev, device_t child,
162 char *buf, size_t buflen);
163 static int acpi_child_pnpinfo_str_method(device_t acdev, device_t child,
164 char *buf, size_t buflen);
165 static void acpi_enable_pcie(void);
166 static void acpi_reset_interfaces(device_t dev);
168 static device_method_t acpi_methods[] = {
169 /* Device interface */
170 DEVMETHOD(device_identify, acpi_identify),
171 DEVMETHOD(device_probe, acpi_probe),
172 DEVMETHOD(device_attach, acpi_attach),
173 DEVMETHOD(device_shutdown, acpi_shutdown),
174 DEVMETHOD(device_detach, bus_generic_detach),
175 DEVMETHOD(device_suspend, acpi_suspend),
176 DEVMETHOD(device_resume, acpi_resume),
179 DEVMETHOD(bus_add_child, acpi_add_child),
180 DEVMETHOD(bus_print_child, acpi_print_child),
181 DEVMETHOD(bus_probe_nomatch, acpi_probe_nomatch),
182 DEVMETHOD(bus_driver_added, acpi_driver_added),
183 DEVMETHOD(bus_read_ivar, acpi_read_ivar),
184 DEVMETHOD(bus_write_ivar, acpi_write_ivar),
185 DEVMETHOD(bus_get_resource_list, acpi_get_rlist),
186 DEVMETHOD(bus_set_resource, bus_generic_rl_set_resource),
187 DEVMETHOD(bus_get_resource, bus_generic_rl_get_resource),
188 DEVMETHOD(bus_alloc_resource, acpi_alloc_resource),
189 DEVMETHOD(bus_release_resource, acpi_release_resource),
190 DEVMETHOD(bus_delete_resource, acpi_delete_resource),
191 DEVMETHOD(bus_child_pnpinfo_str, acpi_child_pnpinfo_str_method),
192 DEVMETHOD(bus_child_location_str, acpi_child_location_str_method),
193 DEVMETHOD(bus_activate_resource, bus_generic_activate_resource),
194 DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource),
195 DEVMETHOD(bus_setup_intr, bus_generic_setup_intr),
196 DEVMETHOD(bus_teardown_intr, bus_generic_teardown_intr),
199 DEVMETHOD(acpi_id_probe, acpi_device_id_probe),
200 DEVMETHOD(acpi_evaluate_object, acpi_device_eval_obj),
201 DEVMETHOD(acpi_pwr_for_sleep, acpi_device_pwr_for_sleep),
202 DEVMETHOD(acpi_scan_children, acpi_device_scan_children),
205 DEVMETHOD(pci_set_powerstate, acpi_set_powerstate_method),
208 DEVMETHOD(isa_pnp_probe, acpi_isa_pnp_probe),
213 static driver_t acpi_driver = {
216 sizeof(struct acpi_softc),
217 .gpri = KOBJ_GPRI_ACPI+2
220 static devclass_t acpi_devclass;
221 DRIVER_MODULE(acpi, nexus, acpi_driver, acpi_devclass, acpi_modevent, NULL);
222 MODULE_VERSION(acpi, 1);
224 ACPI_SERIAL_DECL(acpi, "ACPI serializer");
226 /* Local pools for managing system resources for ACPI child devices. */
227 static struct rman acpi_rman_io, acpi_rman_mem;
229 #define ACPI_MINIMUM_AWAKETIME 5
231 static const char* sleep_state_names[] = {
232 "S0", "S1", "S2", "S3", "S4", "S5", "NONE"};
234 SYSCTL_NODE(_debug, OID_AUTO, acpi, CTLFLAG_RD, NULL, "ACPI debugging");
235 static char acpi_ca_version[12];
236 SYSCTL_STRING(_debug_acpi, OID_AUTO, acpi_ca_version, CTLFLAG_RD,
237 acpi_ca_version, 0, "Version of Intel ACPICA");
240 * Allow overriding _OSI methods.
242 static char acpi_install_interface[256];
243 TUNABLE_STR("hw.acpi.install_interface", acpi_install_interface,
244 sizeof(acpi_install_interface));
245 static char acpi_remove_interface[256];
246 TUNABLE_STR("hw.acpi.remove_interface", acpi_remove_interface,
247 sizeof(acpi_remove_interface));
250 * Use this tunable to disable the control method auto-serialization
251 * mechanism that was added in 20140214 and superseded the previous
252 * AcpiGbl_SerializeAllMethods global.
254 static int acpi_auto_serialize_methods = 1;
255 TUNABLE_INT("hw.acpi.auto_serialize_methods", &acpi_auto_serialize_methods);
257 /* Allow users to dump Debug objects without ACPI debugger. */
258 static int acpi_debug_objects;
259 TUNABLE_INT("debug.acpi.enable_debug_objects", &acpi_debug_objects);
260 SYSCTL_PROC(_debug_acpi, OID_AUTO, enable_debug_objects,
261 CTLFLAG_RW | CTLTYPE_INT, NULL, 0, acpi_debug_objects_sysctl, "I",
262 "Enable Debug objects.");
264 /* Allow ignoring the XSDT. */
265 static int acpi_ignore_xsdt;
266 TUNABLE_INT("debug.acpi.ignore_xsdt", &acpi_ignore_xsdt);
267 SYSCTL_INT(_debug_acpi, OID_AUTO, ignore_xsdt, CTLFLAG_RD,
268 &acpi_ignore_xsdt, 1, "Ignore the XSDT, forcing the use of the RSDT.");
270 /* Allow the interpreter to ignore common mistakes in BIOS. */
271 static int acpi_interpreter_slack = 1;
272 TUNABLE_INT("debug.acpi.interpreter_slack", &acpi_interpreter_slack);
273 SYSCTL_INT(_debug_acpi, OID_AUTO, interpreter_slack, CTLFLAG_RD,
274 &acpi_interpreter_slack, 1, "Turn on interpreter slack mode.");
276 /* Allow preferring 32-bit FADT register addresses over the 64-bit ones. */
277 static int acpi_fadt_addr32;
278 TUNABLE_INT("debug.acpi.fadt_addr32", &acpi_fadt_addr32);
279 SYSCTL_INT(_debug_acpi, OID_AUTO, fadt_addr32, CTLFLAG_RD,
280 &acpi_fadt_addr32, 1,
281 "Prefer 32-bit FADT register addresses over 64-bit ones.");
283 /* Prefer 32-bit FACS table addresses over the 64-bit ones. */
284 static int acpi_facs_addr32 = 1;
285 TUNABLE_INT("debug.acpi.facs_addr32", &acpi_facs_addr32);
286 SYSCTL_INT(_debug_acpi, OID_AUTO, facs_addr32, CTLFLAG_RD,
287 &acpi_facs_addr32, 1,
288 "Prefer 32-bit FACS table addresses over 64-bit ones.");
290 static int acpi_group_module_level_code;
291 TUNABLE_INT("debug.acpi.group_module_level_code", &acpi_group_module_level_code);
292 SYSCTL_INT(_debug_acpi, OID_AUTO, group_module_level_code, CTLFLAG_RD,
293 &acpi_group_module_level_code, 1,
294 "Group module-level code.");
296 /* Power devices off and on in suspend and resume. XXX Remove once tested. */
297 static int acpi_do_powerstate = 1;
298 TUNABLE_INT("debug.acpi.do_powerstate", &acpi_do_powerstate);
299 SYSCTL_INT(_debug_acpi, OID_AUTO, do_powerstate, CTLFLAG_RW,
300 &acpi_do_powerstate, 1, "Turn off devices when suspending.");
302 /* Allow users to override quirks. */
303 TUNABLE_INT("debug.acpi.quirks", &acpi_quirks);
305 /* Allow to call ACPI methods from userland. */
306 static int acpi_allow_mcall;
307 TUNABLE_INT("debug.acpi.allow_method_calls", &acpi_allow_mcall);
309 static int acpi_susp_bounce;
310 SYSCTL_INT(_debug_acpi, OID_AUTO, suspend_bounce, CTLFLAG_RW,
311 &acpi_susp_bounce, 0, "Don't actually suspend, just test devices.");
314 * ACPI can only be loaded as a module by the loader; activating it after
315 * system bootstrap time is not useful, and can be fatal to the system.
316 * It also cannot be unloaded, since the entire system bus heirarchy hangs
320 acpi_modevent(struct module *mod, int event, void *junk)
325 kprintf("The ACPI driver cannot be loaded after boot.\n");
330 if (!cold && power_pm_get_type() == POWER_PM_TYPE_ACPI)
340 * Perform early initialization.
345 static int started = 0;
349 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
351 /* Only run the startup code once. The MADT driver also calls this. */
353 return_VALUE (AE_OK);
356 /* Start up the ACPICA subsystem. */
357 status = AcpiInitializeSubsystem();
358 if (ACPI_FAILURE(status)) {
359 kprintf("ACPI: Subsystem initialization failed: %s\n",
360 AcpiFormatException(status));
361 return_VALUE (status);
365 * Pre-allocate space for RSDT/XSDT and DSDT tables and allow resizing
366 * if more tables exist.
368 if (ACPI_FAILURE(status = AcpiInitializeTables(NULL, 2, TRUE))) {
369 kprintf("ACPI: Table initialization failed: %s\n",
370 AcpiFormatException(status));
371 return_VALUE (status);
374 /* Set up any quirks we have for this system. */
375 if (acpi_quirks == ACPI_Q_OK)
376 acpi_table_quirks(&acpi_quirks);
378 /* If the user manually set the disabled hint to 0, force-enable ACPI. */
379 if (resource_int_value("acpi", 0, "disabled", &val) == 0 && val == 0)
380 acpi_quirks &= ~ACPI_Q_BROKEN;
381 if (acpi_quirks & ACPI_Q_BROKEN) {
382 kprintf("ACPI disabled by blacklist. Contact your BIOS vendor.\n");
386 return_VALUE (status);
390 * Detect ACPI, perform early initialisation
393 acpi_identify(driver_t *driver, device_t parent)
397 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
402 /* Check that we haven't been disabled with a hint. */
403 if (resource_disabled("acpi", 0))
406 /* Make sure we're not being doubly invoked. */
407 if (device_find_child(parent, "acpi", 0) != NULL)
410 ksnprintf(acpi_ca_version, sizeof(acpi_ca_version), "%x", ACPI_CA_VERSION);
412 /* Initialize root tables. */
413 if (ACPI_FAILURE(acpi_Startup())) {
414 kprintf("ACPI: Try disabling either ACPI or apic support.\n");
418 /* Attach the actual ACPI device. */
419 if ((child = BUS_ADD_CHILD(parent, parent, 10, "acpi", 0)) == NULL) {
420 device_printf(parent, "device_identify failed\n");
426 * Fetch some descriptive data from ACPI to put in our attach message.
429 acpi_probe(device_t dev)
431 ACPI_TABLE_RSDP *rsdp;
432 ACPI_TABLE_HEADER *rsdt;
433 ACPI_PHYSICAL_ADDRESS paddr;
434 char buf[ACPI_OEM_ID_SIZE + ACPI_OEM_TABLE_ID_SIZE + 2];
437 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
439 if (power_pm_get_type() != POWER_PM_TYPE_NONE &&
440 power_pm_get_type() != POWER_PM_TYPE_ACPI) {
441 device_printf(dev, "probe failed, other PM system enabled.\n");
442 return_VALUE (ENXIO);
445 if ((paddr = AcpiOsGetRootPointer()) == 0 ||
446 (rsdp = AcpiOsMapMemory(paddr, sizeof(ACPI_TABLE_RSDP))) == NULL)
447 return_VALUE (ENXIO);
448 if (acpi_ignore_xsdt == 0 &&
449 rsdp->Revision > 1 && rsdp->XsdtPhysicalAddress != 0)
450 paddr = (ACPI_PHYSICAL_ADDRESS)rsdp->XsdtPhysicalAddress;
452 paddr = (ACPI_PHYSICAL_ADDRESS)rsdp->RsdtPhysicalAddress;
453 AcpiOsUnmapMemory(rsdp, sizeof(ACPI_TABLE_RSDP));
455 if ((rsdt = AcpiOsMapMemory(paddr, sizeof(ACPI_TABLE_HEADER))) == NULL)
456 return_VALUE (ENXIO);
457 sbuf_new(&sb, buf, sizeof(buf), SBUF_FIXEDLEN);
458 sbuf_bcat(&sb, rsdt->OemId, ACPI_OEM_ID_SIZE);
461 sbuf_bcat(&sb, rsdt->OemTableId, ACPI_OEM_TABLE_ID_SIZE);
464 device_set_desc_copy(dev, sbuf_data(&sb));
466 AcpiOsUnmapMemory(rsdt, sizeof(ACPI_TABLE_HEADER));
472 acpi_attach(device_t dev)
474 struct acpi_softc *sc;
481 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
483 sc = device_get_softc(dev);
485 callout_init(&sc->susp_force_to);
487 if ((error = acpi_task_thread_init())) {
488 device_printf(dev, "Could not start task thread.\n");
494 /* Initialize resource manager. */
495 acpi_rman_io.rm_type = RMAN_ARRAY;
496 acpi_rman_io.rm_start = 0;
497 acpi_rman_io.rm_end = 0xffff;
498 acpi_rman_io.rm_descr = "ACPI I/O ports";
499 if (rman_init(&acpi_rman_io, -1) != 0)
500 panic("acpi rman_init IO ports failed");
501 acpi_rman_mem.rm_type = RMAN_ARRAY;
502 acpi_rman_mem.rm_start = 0;
503 acpi_rman_mem.rm_end = ~0ul;
504 acpi_rman_mem.rm_descr = "ACPI I/O memory addresses";
505 if (rman_init(&acpi_rman_mem, -1) != 0)
506 panic("acpi rman_init memory failed");
508 /* Initialise the ACPI mutex */
509 ACPI_LOCK_INIT(acpi, "acpi");
510 ACPI_SERIAL_INIT(acpi);
515 * Set the globals from our tunables. This is needed because ACPICA
516 * uses UINT8 for some values and we have no tunable_byte.
518 AcpiGbl_AutoSerializeMethods = acpi_auto_serialize_methods ? TRUE : FALSE;
519 AcpiGbl_DoNotUseXsdt = acpi_ignore_xsdt ? TRUE : FALSE;
520 AcpiGbl_EnableAmlDebugObject = acpi_debug_objects ? TRUE : FALSE;
521 AcpiGbl_EnableInterpreterSlack = acpi_interpreter_slack ? TRUE : FALSE;
522 AcpiGbl_GroupModuleLevelCode = acpi_group_module_level_code ? TRUE : FALSE;
523 AcpiGbl_Use32BitFadtAddresses = acpi_fadt_addr32 ? TRUE : FALSE;
524 AcpiGbl_Use32BitFacsAddresses = acpi_facs_addr32 ? TRUE : FALSE;
528 * Disable Debug Object output.
530 AcpiDbgLevel &= ~ACPI_LV_DEBUG_OBJECT;
533 /* Override OS interfaces if the user requested. */
534 acpi_reset_interfaces(dev);
536 /* Load ACPI name space. */
537 status = AcpiLoadTables();
538 if (ACPI_FAILURE(status)) {
539 device_printf(dev, "Could not load Namespace: %s\n",
540 AcpiFormatException(status));
544 /* Handle MCFG table if present. */
548 * Note that some systems (specifically, those with namespace evaluation
549 * issues that require the avoidance of parts of the namespace) must
550 * avoid running _INI and _STA on everything, as well as dodging the final
553 * For these devices, we set ACPI_NO_DEVICE_INIT and ACPI_NO_OBJECT_INIT).
555 * XXX We should arrange for the object init pass after we have attached
556 * all our child devices, but on many systems it works here.
558 flags = ACPI_FULL_INITIALIZATION;
559 if (ktestenv("debug.acpi.avoid"))
560 flags = ACPI_NO_DEVICE_INIT | ACPI_NO_OBJECT_INIT;
562 /* Bring the hardware and basic handlers online. */
563 if (ACPI_FAILURE(status = AcpiEnableSubsystem(flags))) {
564 device_printf(dev, "Could not enable ACPI: %s\n",
565 AcpiFormatException(status));
570 * Fix up the interrupt timer after enabling ACPI, so that the
571 * interrupt cputimer that choked by ACPI power management could
572 * be resurrected before probing various devices.
575 cputimer_intr_pmfixup();
578 * Call the ECDT probe function to provide EC functionality before
579 * the namespace has been evaluated.
581 * XXX This happens before the sysresource devices have been probed and
582 * attached so its resources come from nexus0. In practice, this isn't
583 * a problem but should be addressed eventually.
585 acpi_ec_ecdt_probe(dev);
587 /* Bring device objects and regions online. */
588 if (ACPI_FAILURE(status = AcpiInitializeObjects(flags))) {
589 device_printf(dev, "Could not initialize ACPI objects: %s\n",
590 AcpiFormatException(status));
595 * Setup our sysctl tree.
597 * XXX: This doesn't check to make sure that none of these fail.
599 sysctl_ctx_init(&sc->acpi_sysctl_ctx);
600 sc->acpi_sysctl_tree = SYSCTL_ADD_NODE(&sc->acpi_sysctl_ctx,
601 SYSCTL_STATIC_CHILDREN(_hw), OID_AUTO,
602 device_get_name(dev), CTLFLAG_RD, 0, "");
603 SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
604 OID_AUTO, "supported_sleep_state", CTLTYPE_STRING | CTLFLAG_RD,
605 0, 0, acpi_supported_sleep_state_sysctl, "A", "");
606 SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
607 OID_AUTO, "power_button_state", CTLTYPE_STRING | CTLFLAG_RW,
608 &sc->acpi_power_button_sx, 0, acpi_sleep_state_sysctl, "A", "");
609 SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
610 OID_AUTO, "sleep_button_state", CTLTYPE_STRING | CTLFLAG_RW,
611 &sc->acpi_sleep_button_sx, 0, acpi_sleep_state_sysctl, "A", "");
612 SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
613 OID_AUTO, "lid_switch_state", CTLTYPE_STRING | CTLFLAG_RW,
614 &sc->acpi_lid_switch_sx, 0, acpi_sleep_state_sysctl, "A", "");
615 SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
616 OID_AUTO, "standby_state", CTLTYPE_STRING | CTLFLAG_RW,
617 &sc->acpi_standby_sx, 0, acpi_sleep_state_sysctl, "A", "");
618 SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
619 OID_AUTO, "suspend_state", CTLTYPE_STRING | CTLFLAG_RW,
620 &sc->acpi_suspend_sx, 0, acpi_sleep_state_sysctl, "A", "");
621 SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
622 OID_AUTO, "sleep_delay", CTLFLAG_RW, &sc->acpi_sleep_delay, 0,
624 SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
625 OID_AUTO, "s4bios", CTLFLAG_RW, &sc->acpi_s4bios, 0, "S4BIOS mode");
626 SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
627 OID_AUTO, "verbose", CTLFLAG_RW, &sc->acpi_verbose, 0, "verbose mode");
628 SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
629 OID_AUTO, "disable_on_reboot", CTLFLAG_RW,
630 &sc->acpi_do_disable, 0, "Disable ACPI when rebooting/halting system");
631 SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
632 OID_AUTO, "handle_reboot", CTLFLAG_RW,
633 &sc->acpi_handle_reboot, 0, "Use ACPI Reset Register to reboot");
636 * Default to 1 second before sleeping to give some machines time to
639 sc->acpi_sleep_delay = 1;
641 sc->acpi_verbose = 1;
642 if ((env = kgetenv("hw.acpi.verbose")) != NULL) {
643 if (strcmp(env, "0") != 0)
644 sc->acpi_verbose = 1;
648 /* Only enable reboot by default if the FADT says it is available. */
649 if (AcpiGbl_FADT.Flags & ACPI_FADT_RESET_REGISTER)
650 sc->acpi_handle_reboot = 1;
652 /* Only enable S4BIOS by default if the FACS says it is available. */
653 if (AcpiGbl_FACS->Flags & ACPI_FACS_S4_BIOS_PRESENT)
657 * Dispatch the default sleep state to devices. The lid switch is set
658 * to NONE by default to avoid surprising users.
660 sc->acpi_power_button_sx = ACPI_STATE_S5;
661 sc->acpi_lid_switch_sx = ACPI_S_STATES_MAX + 1;
662 sc->acpi_standby_sx = ACPI_STATE_S1;
663 sc->acpi_suspend_sx = ACPI_STATE_S3;
665 /* Pick the first valid sleep state for the sleep button default. */
666 sc->acpi_sleep_button_sx = ACPI_S_STATES_MAX + 1;
667 for (state = ACPI_STATE_S1; state <= ACPI_STATE_S4; state++)
668 if (ACPI_SUCCESS(AcpiGetSleepTypeData(state, &TypeA, &TypeB))) {
669 sc->acpi_sleep_button_sx = state;
673 acpi_enable_fixed_events(sc);
676 * Scan the namespace and attach/initialise children.
679 /* Register our shutdown handler. */
680 EVENTHANDLER_REGISTER(shutdown_final, acpi_shutdown_final, sc,
684 * Register our acpi event handlers.
685 * XXX should be configurable eg. via userland policy manager.
687 EVENTHANDLER_REGISTER(acpi_sleep_event, acpi_system_eventhandler_sleep,
688 sc, ACPI_EVENT_PRI_LAST);
689 EVENTHANDLER_REGISTER(acpi_wakeup_event, acpi_system_eventhandler_wakeup,
690 sc, ACPI_EVENT_PRI_LAST);
692 /* Flag our initial states. */
693 sc->acpi_enabled = 1;
694 sc->acpi_sstate = ACPI_STATE_S0;
695 sc->acpi_sleep_disabled = 0;
696 /* Create the control device */
697 sc->acpi_dev_t = make_dev(&acpi_ops, 0, UID_ROOT, GID_WHEEL, 0644, "acpi");
698 sc->acpi_dev_t->si_drv1 = sc;
700 if ((error = acpi_machdep_init(dev)))
703 /* Register ACPI again to pass the correct argument of pm_func. */
704 power_pm_register(POWER_PM_TYPE_ACPI, acpi_pm_func, sc);
706 if (!acpi_disabled("bus"))
707 acpi_probe_children(dev);
709 /* Update all GPEs and enable runtime GPEs. */
710 status = AcpiUpdateAllGpes();
711 if (ACPI_FAILURE(status)) {
712 device_printf(dev, "Could not update all GPEs: %s\n",
713 AcpiFormatException(status));
716 /* Allow sleep request after a while. */
717 /* timeout(acpi_sleep_enable, sc, hz * ACPI_MINIMUM_AWAKETIME); */
724 cputimer_intr_pmfixup();
725 acpi_task_thread_schedule();
727 return_VALUE (error);
731 acpi_suspend(device_t dev)
733 device_t child, *devlist;
734 int error, i, numdevs, pstate;
736 /* First give child devices a chance to suspend. */
737 error = bus_generic_suspend(dev);
742 * Now, set them into the appropriate power state, usually D3. If the
743 * device has an _SxD method for the next sleep state, use that power
746 device_get_children(dev, &devlist, &numdevs);
747 for (i = 0; i < numdevs; i++) {
748 /* If the device is not attached, we've powered it down elsewhere. */
750 if (!device_is_attached(child))
754 * Default to D3 for all sleep states. The _SxD method is optional
755 * so set the powerstate even if it's absent.
757 pstate = PCI_POWERSTATE_D3;
758 error = acpi_device_pwr_for_sleep(device_get_parent(child),
760 if ((error == 0 || error == ESRCH) && acpi_do_powerstate)
761 pci_set_powerstate(child, pstate);
763 kfree(devlist, M_TEMP);
770 acpi_resume(device_t dev)
774 device_t child, *devlist;
777 * Put all devices in D0 before resuming them. Call _S0D on each one
778 * since some systems expect this.
780 device_get_children(dev, &devlist, &numdevs);
781 for (i = 0; i < numdevs; i++) {
783 handle = acpi_get_handle(child);
785 AcpiEvaluateObject(handle, "_S0D", NULL, NULL);
786 if (device_is_attached(child) && acpi_do_powerstate)
787 pci_set_powerstate(child, PCI_POWERSTATE_D0);
789 kfree(devlist, M_TEMP);
791 return (bus_generic_resume(dev));
795 acpi_shutdown(device_t dev)
797 /* Allow children to shutdown first. */
798 bus_generic_shutdown(dev);
801 * Enable any GPEs that are able to power-on the system (i.e., RTC).
802 * Also, disable any that are not valid for this state (most).
804 acpi_wake_prep_walk(ACPI_STATE_S5);
810 * Handle a new device being added
813 acpi_add_child(device_t bus, device_t parent, int order, const char *name, int unit)
815 struct acpi_device *ad;
818 if ((ad = kmalloc(sizeof(*ad), M_ACPIDEV, M_NOWAIT | M_ZERO)) == NULL)
821 resource_list_init(&ad->ad_rl);
822 child = device_add_child_ordered(parent, order, name, unit);
824 device_set_ivars(child, ad);
826 kfree(ad, M_ACPIDEV);
831 acpi_print_child(device_t bus, device_t child)
833 struct acpi_device *adev = device_get_ivars(child);
834 struct resource_list *rl = &adev->ad_rl;
837 retval += bus_print_child_header(bus, child);
838 retval += resource_list_print_type(rl, "port", SYS_RES_IOPORT, "%#lx");
839 retval += resource_list_print_type(rl, "iomem", SYS_RES_MEMORY, "%#lx");
840 retval += resource_list_print_type(rl, "irq", SYS_RES_IRQ, "%ld");
841 retval += resource_list_print_type(rl, "drq", SYS_RES_DRQ, "%ld");
842 if (device_get_flags(child))
843 retval += kprintf(" flags %#x", device_get_flags(child));
844 retval += bus_print_child_footer(bus, child);
850 * If this device is an ACPI child but no one claimed it, attempt
851 * to power it off. We'll power it back up when a driver is added.
853 * XXX Disabled for now since many necessary devices (like fdc and
854 * ATA) don't claim the devices we created for them but still expect
855 * them to be powered up.
858 acpi_probe_nomatch(device_t bus, device_t child)
861 /* pci_set_powerstate(child, PCI_POWERSTATE_D3); */
865 * If a new driver has a chance to probe a child, first power it up.
867 * XXX Disabled for now (see acpi_probe_nomatch for details).
870 acpi_driver_added(device_t dev, driver_t *driver)
872 device_t child, *devlist;
875 DEVICE_IDENTIFY(driver, dev);
876 device_get_children(dev, &devlist, &numdevs);
877 for (i = 0; i < numdevs; i++) {
879 if (device_get_state(child) == DS_NOTPRESENT) {
880 /* pci_set_powerstate(child, PCI_POWERSTATE_D0); */
881 if (device_probe_and_attach(child) != 0)
882 ; /* pci_set_powerstate(child, PCI_POWERSTATE_D3); */
885 kfree(devlist, M_TEMP);
888 /* Location hint for devctl(8) */
890 acpi_child_location_str_method(device_t cbdev, device_t child, char *buf,
893 struct acpi_device *dinfo = device_get_ivars(child);
895 if (dinfo->ad_handle)
896 ksnprintf(buf, buflen, "handle=%s", acpi_name(dinfo->ad_handle));
898 ksnprintf(buf, buflen, "unknown");
902 /* PnP information for devctl(8) */
904 acpi_child_pnpinfo_str_method(device_t cbdev, device_t child, char *buf,
907 ACPI_DEVICE_INFO *adinfo;
908 struct acpi_device *dinfo = device_get_ivars(child);
910 if (ACPI_FAILURE(AcpiGetObjectInfo(dinfo->ad_handle, &adinfo))) {
911 ksnprintf(buf, buflen, "unknown");
913 ksnprintf(buf, buflen, "_HID=%s _UID=%s",
914 (adinfo->Valid & ACPI_VALID_HID) ?
915 adinfo->HardwareId.String : "none",
916 (adinfo->Valid & ACPI_VALID_UID) ?
917 adinfo->UniqueId.String : "0");
925 * Handle per-device ivars
928 acpi_read_ivar(device_t dev, device_t child, int index, uintptr_t *result)
930 struct acpi_device *ad;
932 if ((ad = device_get_ivars(child)) == NULL) {
933 device_printf(child, "device has no ivars\n");
937 /* ACPI and ISA compatibility ivars */
939 case ACPI_IVAR_HANDLE:
940 *(ACPI_HANDLE *)result = ad->ad_handle;
942 case ACPI_IVAR_MAGIC:
943 *result = ad->ad_magic;
945 case ACPI_IVAR_PRIVATE:
946 *(void **)result = ad->ad_private;
948 case ACPI_IVAR_FLAGS:
949 *(int *)result = ad->ad_flags;
951 case ISA_IVAR_VENDORID:
952 case ISA_IVAR_SERIAL:
953 case ISA_IVAR_COMPATID:
956 case ISA_IVAR_LOGICALID:
957 *(int *)result = acpi_isa_get_logicalid(child);
967 acpi_write_ivar(device_t dev, device_t child, int index, uintptr_t value)
969 struct acpi_device *ad;
971 if ((ad = device_get_ivars(child)) == NULL) {
972 device_printf(child, "device has no ivars\n");
977 case ACPI_IVAR_HANDLE:
978 ad->ad_handle = (ACPI_HANDLE)value;
980 case ACPI_IVAR_MAGIC:
981 ad->ad_magic = value;
983 case ACPI_IVAR_PRIVATE:
984 ad->ad_private = (void *)value;
986 case ACPI_IVAR_FLAGS:
987 ad->ad_flags = (int)value;
990 panic("bad ivar write request (%d)", index);
998 * Handle child resource allocation/removal
1000 static struct resource_list *
1001 acpi_get_rlist(device_t dev, device_t child)
1003 struct acpi_device *ad;
1005 ad = device_get_ivars(child);
1006 return (&ad->ad_rl);
1010 * Pre-allocate/manage all memory and IO resources. Since rman can't handle
1011 * duplicates, we merge any in the sysresource attach routine.
1014 acpi_sysres_alloc(device_t dev)
1016 struct resource *res;
1017 struct resource_list *rl;
1018 struct resource_list_entry *rle;
1020 char *sysres_ids[] = { "PNP0C01", "PNP0C02", NULL };
1024 * Probe/attach any sysresource devices. This would be unnecessary if we
1025 * had multi-pass probe/attach.
1027 if (device_get_children(dev, &children, &child_count) != 0)
1029 for (i = 0; i < child_count; i++) {
1030 if (ACPI_ID_PROBE(dev, children[i], sysres_ids) != NULL)
1031 device_probe_and_attach(children[i]);
1033 kfree(children, M_TEMP);
1035 rl = BUS_GET_RESOURCE_LIST(device_get_parent(dev), dev);
1038 SLIST_FOREACH(rle, rl, link) {
1039 if (rle->res != NULL) {
1040 device_printf(dev, "duplicate resource for %lx\n", rle->start);
1044 /* Only memory and IO resources are valid here. */
1045 switch (rle->type) {
1046 case SYS_RES_IOPORT:
1049 case SYS_RES_MEMORY:
1050 rm = &acpi_rman_mem;
1056 /* Pre-allocate resource and add to our rman pool. */
1057 res = BUS_ALLOC_RESOURCE(device_get_parent(dev), dev, rle->type,
1058 &rle->rid, rle->start, rle->start + rle->count - 1, rle->count,
1061 rman_manage_region(rm, rman_get_start(res), rman_get_end(res));
1064 device_printf(dev, "reservation of %lx, %lx (%d) failed\n",
1065 rle->start, rle->count, rle->type);
1070 static struct resource *
1071 acpi_alloc_resource(device_t bus, device_t child, int type, int *rid,
1072 u_long start, u_long end, u_long count, u_int flags, int cpuid)
1075 struct acpi_device *ad = device_get_ivars(child);
1076 struct resource_list *rl = &ad->ad_rl;
1077 struct resource_list_entry *rle;
1078 struct resource *res;
1083 /* We only handle memory and IO resources through rman. */
1085 case SYS_RES_IOPORT:
1088 case SYS_RES_MEMORY:
1089 rm = &acpi_rman_mem;
1095 ACPI_SERIAL_BEGIN(acpi);
1098 * If this is an allocation of the "default" range for a given RID, and
1099 * we know what the resources for this device are (i.e., they're on the
1100 * child's resource list), use those start/end values.
1102 if (bus == device_get_parent(child) && start == 0UL && end == ~0UL) {
1103 rle = resource_list_find(rl, type, *rid);
1113 * If this is an allocation of a specific range, see if we can satisfy
1114 * the request from our system resource regions. If we can't, pass the
1115 * request up to the parent.
1117 if (start + count - 1 == end && rm != NULL)
1118 res = rman_reserve_resource(rm, start, end, count, flags & ~RF_ACTIVE,
1121 res = BUS_ALLOC_RESOURCE(device_get_parent(bus), child, type, rid,
1122 start, end, count, flags, cpuid);
1124 rman_set_rid(res, *rid);
1126 /* If requested, activate the resource using the parent's method. */
1127 if (flags & RF_ACTIVE)
1128 if (bus_activate_resource(child, type, *rid, res) != 0) {
1129 rman_release_resource(res);
1135 if (res != NULL && device_get_parent(child) == bus)
1139 * Since bus_config_intr() takes immediate effect, we cannot
1140 * configure the interrupt associated with a device when we
1141 * parse the resources but have to defer it until a driver
1142 * actually allocates the interrupt via bus_alloc_resource().
1144 * NB: Lookup failure is fine, since the device may add its
1145 * own interrupt resources, e.g. MSI or MSI-X.
1148 acpi_lookup_irq_resource(child, *rid, res, &ares))) {
1149 acpi_config_intr(child, &ares);
1151 kprintf("irq resource not found\n");
1157 ACPI_SERIAL_END(acpi);
1162 acpi_release_resource(device_t bus, device_t child, int type, int rid,
1168 /* We only handle memory and IO resources through rman. */
1170 case SYS_RES_IOPORT:
1173 case SYS_RES_MEMORY:
1174 rm = &acpi_rman_mem;
1180 ACPI_SERIAL_BEGIN(acpi);
1183 * If this resource belongs to one of our internal managers,
1184 * deactivate it and release it to the local pool. If it doesn't,
1185 * pass this request up to the parent.
1187 if (rm != NULL && rman_is_region_manager(r, rm)) {
1188 if (rman_get_flags(r) & RF_ACTIVE) {
1189 ret = bus_deactivate_resource(child, type, rid, r);
1193 ret = rman_release_resource(r);
1195 ret = BUS_RELEASE_RESOURCE(device_get_parent(bus), child, type, rid, r);
1198 ACPI_SERIAL_END(acpi);
1203 acpi_delete_resource(device_t bus, device_t child, int type, int rid)
1205 struct resource_list *rl;
1207 rl = acpi_get_rlist(bus, child);
1208 resource_list_delete(rl, type, rid);
1211 /* Allocate an IO port or memory resource, given its GAS. */
1213 acpi_bus_alloc_gas(device_t dev, int *type, int *rid, ACPI_GENERIC_ADDRESS *gas,
1214 struct resource **res, u_int flags)
1216 int error, res_type;
1219 if (type == NULL || rid == NULL || gas == NULL || res == NULL)
1222 /* We only support memory and IO spaces. */
1223 switch (gas->SpaceId) {
1224 case ACPI_ADR_SPACE_SYSTEM_MEMORY:
1225 res_type = SYS_RES_MEMORY;
1227 case ACPI_ADR_SPACE_SYSTEM_IO:
1228 res_type = SYS_RES_IOPORT;
1231 return (EOPNOTSUPP);
1235 * If the register width is less than 8, assume the BIOS author means
1236 * it is a bit field and just allocate a byte.
1238 if (gas->BitWidth && gas->BitWidth < 8)
1241 /* Validate the address after we're sure we support the space. */
1242 if (gas->Address == 0 || gas->BitWidth == 0)
1245 bus_set_resource(dev, res_type, *rid, gas->Address,
1246 gas->BitWidth / 8, -1);
1247 *res = bus_alloc_resource_any(dev, res_type, rid, RF_ACTIVE | flags);
1252 bus_delete_resource(dev, res_type, *rid);
1258 acpi_eval_osc(device_t dev, ACPI_HANDLE handle, const char *uuidstr,
1259 int revision, uint32_t *buf, int count)
1261 ACPI_BUFFER retbuf = { ACPI_ALLOCATE_BUFFER, NULL };
1262 ACPI_OBJECT_LIST arglist;
1264 ACPI_OBJECT *retobj;
1268 uint8_t oscuuid[ACPI_UUID_LENGTH];
1271 if (parse_uuid(uuidstr, &uuid) != 0)
1273 le_uuid_enc(oscuuid, &uuid);
1275 arglist.Pointer = arg;
1277 arg[0].Type = ACPI_TYPE_BUFFER;
1278 arg[0].Buffer.Length = ACPI_UUID_LENGTH;
1279 arg[0].Buffer.Pointer = oscuuid; /* UUID */
1280 arg[1].Type = ACPI_TYPE_INTEGER;
1281 arg[1].Integer.Value = revision; /* revision */
1282 arg[2].Type = ACPI_TYPE_INTEGER;
1283 arg[2].Integer.Value = count; /* # of cap integers */
1284 arg[3].Type = ACPI_TYPE_BUFFER;
1285 arg[3].Buffer.Length = count * sizeof(uint32_t); /* capabilities buffer */
1286 arg[3].Buffer.Pointer = (uint8_t *)buf;
1288 status = AcpiEvaluateObject(handle, "_OSC", &arglist, &retbuf);
1289 if (ACPI_FAILURE(status))
1291 retobj = retbuf.Pointer;
1292 error = ((uint32_t *)retobj->Buffer.Pointer)[0] & ACPI_OSCERR_MASK;
1296 if (error & ACPI_OSCERR_OSCFAIL)
1297 device_printf(dev, "_OSC unable to process request\n");
1298 if (error & ACPI_OSCERR_UUID)
1299 device_printf(dev, "_OSC unrecognized UUID (%s)\n", uuidstr);
1300 if (error & ACPI_OSCERR_REVISION)
1301 device_printf(dev, "_OSC unrecognized revision ID (%d)\n", revision);
1302 if (error & ACPI_OSCERR_CAPSMASKED) {
1303 if ((buf[0] & ACPI_OSC_QUERY_SUPPORT) == 0) {
1304 for (i = 1; i < count; i++) {
1306 "_OSC capabilities have been masked: buf[%d]:%#x\n",
1307 i, buf[i] & ~((uint32_t *)retobj->Buffer.Pointer)[i]);
1309 status = AE_SUPPORT;
1316 if (retbuf.Pointer != NULL)
1317 AcpiOsFree(retbuf.Pointer);
1321 /* Probe _HID and _CID for compatible ISA PNP ids. */
1323 acpi_isa_get_logicalid(device_t dev)
1325 ACPI_DEVICE_INFO *devinfo;
1329 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1334 /* Fetch and validate the HID. */
1335 if ((h = acpi_get_handle(dev)) == NULL ||
1336 ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo)))
1339 if ((devinfo->Valid & ACPI_VALID_HID) != 0)
1340 pnpid = PNP_EISAID(devinfo->HardwareId.String);
1344 AcpiOsFree(devinfo);
1345 return_VALUE (pnpid);
1349 acpi_isa_get_compatid(device_t dev, uint32_t *cids, int count)
1351 ACPI_DEVICE_INFO *devinfo;
1356 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1362 /* Fetch and validate the CID */
1363 if ((h = acpi_get_handle(dev)) == NULL ||
1364 ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo)) ||
1365 (devinfo->Valid & ACPI_VALID_CID) == 0)
1368 if (devinfo->CompatibleIdList.Count < count)
1369 count = devinfo->CompatibleIdList.Count;
1370 for (i = 0; i < count; i++) {
1371 if (strncmp(devinfo->CompatibleIdList.Ids[i].String, "PNP", 3) != 0)
1373 *pnpid++ = PNP_EISAID(devinfo->CompatibleIdList.Ids[i].String);
1379 AcpiOsFree(devinfo);
1380 return_VALUE (valid);
1384 acpi_device_id_probe(device_t bus, device_t dev, char **ids)
1389 h = acpi_get_handle(dev);
1390 if (ids == NULL || h == NULL || acpi_get_type(dev) != ACPI_TYPE_DEVICE)
1393 /* Try to match one of the array of IDs with a HID or CID. */
1394 for (i = 0; ids[i] != NULL; i++) {
1395 if (acpi_MatchHid(h, ids[i]))
1402 acpi_device_eval_obj(device_t bus, device_t dev, ACPI_STRING pathname,
1403 ACPI_OBJECT_LIST *parameters, ACPI_BUFFER *ret)
1408 h = ACPI_ROOT_OBJECT;
1409 else if ((h = acpi_get_handle(dev)) == NULL)
1410 return (AE_BAD_PARAMETER);
1411 return (AcpiEvaluateObject(h, pathname, parameters, ret));
1415 acpi_device_pwr_for_sleep(device_t bus, device_t dev, int *dstate)
1417 struct acpi_softc *sc;
1423 sc = device_get_softc(bus);
1424 handle = acpi_get_handle(dev);
1427 * XXX If we find these devices, don't try to power them down.
1428 * The serial and IRDA ports on my T23 hang the system when
1429 * set to D3 and it appears that such legacy devices may
1430 * need special handling in their drivers.
1432 if (handle == NULL ||
1433 acpi_MatchHid(handle, "PNP0500") ||
1434 acpi_MatchHid(handle, "PNP0501") ||
1435 acpi_MatchHid(handle, "PNP0502") ||
1436 acpi_MatchHid(handle, "PNP0510") ||
1437 acpi_MatchHid(handle, "PNP0511"))
1441 * Override next state with the value from _SxD, if present. If no
1442 * dstate argument was provided, don't fetch the return value.
1444 ksnprintf(sxd, sizeof(sxd), "_S%dD", sc->acpi_sstate);
1446 status = acpi_GetInteger(handle, sxd, dstate);
1448 status = AcpiEvaluateObject(handle, sxd, NULL, NULL);
1465 /* Callback arg for our implementation of walking the namespace. */
1466 struct acpi_device_scan_ctx {
1467 acpi_scan_cb_t user_fn;
1473 acpi_device_scan_cb(ACPI_HANDLE h, UINT32 level, void *arg, void **retval)
1475 struct acpi_device_scan_ctx *ctx;
1476 device_t dev, old_dev;
1478 ACPI_OBJECT_TYPE type;
1481 * Skip this device if we think we'll have trouble with it or it is
1482 * the parent where the scan began.
1484 ctx = (struct acpi_device_scan_ctx *)arg;
1485 if (acpi_avoid(h) || h == ctx->parent)
1488 /* If this is not a valid device type (e.g., a method), skip it. */
1489 if (ACPI_FAILURE(AcpiGetType(h, &type)))
1491 if (type != ACPI_TYPE_DEVICE && type != ACPI_TYPE_PROCESSOR &&
1492 type != ACPI_TYPE_THERMAL && type != ACPI_TYPE_POWER)
1496 * Call the user function with the current device. If it is unchanged
1497 * afterwards, return. Otherwise, we update the handle to the new dev.
1499 old_dev = acpi_get_device(h);
1501 status = ctx->user_fn(h, &dev, level, ctx->arg);
1502 if (ACPI_FAILURE(status) || old_dev == dev)
1505 /* Remove the old child and its connection to the handle. */
1506 if (old_dev != NULL) {
1507 device_delete_child(device_get_parent(old_dev), old_dev);
1508 AcpiDetachData(h, acpi_fake_objhandler);
1511 /* Recreate the handle association if the user created a device. */
1513 AcpiAttachData(h, acpi_fake_objhandler, dev);
1519 acpi_device_scan_children(device_t bus, device_t dev, int max_depth,
1520 acpi_scan_cb_t user_fn, void *arg)
1523 struct acpi_device_scan_ctx ctx;
1525 if (acpi_disabled("children"))
1529 h = ACPI_ROOT_OBJECT;
1530 else if ((h = acpi_get_handle(dev)) == NULL)
1531 return (AE_BAD_PARAMETER);
1532 ctx.user_fn = user_fn;
1535 return (AcpiWalkNamespace(ACPI_TYPE_ANY, h, max_depth,
1536 acpi_device_scan_cb, NULL, &ctx, NULL));
1540 * Even though ACPI devices are not PCI, we use the PCI approach for setting
1541 * device power states since it's close enough to ACPI.
1544 acpi_set_powerstate_method(device_t bus, device_t child, int state)
1551 h = acpi_get_handle(child);
1552 if (state < ACPI_STATE_D0 || state > ACPI_STATE_D3)
1557 /* Ignore errors if the power methods aren't present. */
1558 status = acpi_pwr_switch_consumer(h, state);
1559 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND
1560 && status != AE_BAD_PARAMETER)
1561 device_printf(bus, "failed to set ACPI power state D%d on %s: %s\n",
1562 state, acpi_name(h), AcpiFormatException(status));
1568 acpi_isa_pnp_probe(device_t bus, device_t child, struct isa_pnp_id *ids)
1570 int result, cid_count, i;
1571 uint32_t lid, cids[8];
1573 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1576 * ISA-style drivers attached to ACPI may persist and
1577 * probe manually if we return ENOENT. We never want
1578 * that to happen, so don't ever return it.
1582 /* Scan the supplied IDs for a match */
1583 lid = acpi_isa_get_logicalid(child);
1584 cid_count = acpi_isa_get_compatid(child, cids, 8);
1585 while (ids && ids->ip_id) {
1586 if (lid == ids->ip_id) {
1590 for (i = 0; i < cid_count; i++) {
1591 if (cids[i] == ids->ip_id) {
1600 if (result == 0 && ids->ip_desc)
1601 device_set_desc(child, ids->ip_desc);
1603 return_VALUE (result);
1607 * Look for a MCFG table. If it is present, use the settings for
1608 * domain (segment) 0 to setup PCI config space access via the memory
1612 acpi_enable_pcie(void)
1614 ACPI_TABLE_HEADER *hdr;
1615 ACPI_MCFG_ALLOCATION *alloc, *end;
1618 status = AcpiGetTable(ACPI_SIG_MCFG, 1, &hdr);
1619 if (ACPI_FAILURE(status))
1622 end = (ACPI_MCFG_ALLOCATION *)((char *)hdr + hdr->Length);
1623 alloc = (ACPI_MCFG_ALLOCATION *)((ACPI_TABLE_MCFG *)hdr + 1);
1624 while (alloc < end) {
1625 if (alloc->PciSegment == 0) {
1626 pcie_cfgregopen(alloc->Address, alloc->StartBusNumber,
1627 alloc->EndBusNumber);
1635 * Scan all of the ACPI namespace and attach child devices.
1637 * We should only expect to find devices in the \_PR, \_TZ, \_SI, and
1638 * \_SB scopes, and \_PR and \_TZ became obsolete in the ACPI 2.0 spec.
1639 * However, in violation of the spec, some systems place their PCI link
1640 * devices in \, so we have to walk the whole namespace. We check the
1641 * type of namespace nodes, so this should be ok.
1644 acpi_probe_children(device_t bus)
1647 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1650 * Scan the namespace and insert placeholders for all the devices that
1651 * we find. We also probe/attach any early devices.
1653 * Note that we use AcpiWalkNamespace rather than AcpiGetDevices because
1654 * we want to create nodes for all devices, not just those that are
1655 * currently present. (This assumes that we don't want to create/remove
1656 * devices as they appear, which might be smarter.)
1658 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "namespace scan\n"));
1659 AcpiWalkNamespace(ACPI_TYPE_ANY, ACPI_ROOT_OBJECT, 100,
1660 acpi_probe_child, NULL, bus, NULL);
1662 /* Pre-allocate resources for our rman from any sysresource devices. */
1663 acpi_sysres_alloc(bus);
1664 /* Create any static children by calling device identify methods. */
1665 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "device identify routines\n"));
1666 bus_generic_probe(bus);
1668 /* Probe/attach all children, created staticly and from the namespace. */
1669 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "first bus_generic_attach\n"));
1670 bus_generic_attach_gpri(bus, KOBJ_GPRI_ACPI+2);
1671 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "second bus_generic_attach\n"));
1672 bus_generic_attach_gpri(bus, KOBJ_GPRI_ACPI+1);
1673 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "third bus_generic_attach\n"));
1674 bus_generic_attach_gpri(bus, KOBJ_GPRI_ACPI);
1675 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "fourth bus_generic_attach\n"));
1676 bus_generic_attach_gpri(bus, KOBJ_GPRI_ACPI);
1679 * Some of these children may have attached others as part of their attach
1680 * process (eg. the root PCI bus driver), so rescan.
1682 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "fifth bus_generic_attach\n"));
1683 bus_generic_attach(bus);
1685 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "sixth bus_generic_attach\n"));
1686 bus_generic_attach(bus);
1688 /* Attach wake sysctls. */
1689 acpi_wake_sysctl_walk(bus);
1691 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "done attaching children\n"));
1696 * Determine the probe order for a given device.
1699 acpi_probe_order(ACPI_HANDLE handle, int *order)
1701 ACPI_OBJECT_TYPE type;
1704 * 1. I/O port and memory system resource holders
1705 * 2. Embedded controllers (to handle early accesses)
1706 * 3. PCI Link Devices
1709 AcpiGetType(handle, &type);
1710 if (acpi_MatchHid(handle, "PNP0C01") || acpi_MatchHid(handle, "PNP0C02"))
1712 else if (acpi_MatchHid(handle, "PNP0C09"))
1714 else if (acpi_MatchHid(handle, "PNP0C0F"))
1716 else if (type == ACPI_TYPE_PROCESSOR)
1721 * Evaluate a child device and determine whether we might attach a device to
1725 acpi_probe_child(ACPI_HANDLE handle, UINT32 level, void *context, void **status)
1727 struct acpi_prw_data prw;
1728 ACPI_OBJECT_TYPE type;
1730 device_t bus, child;
1734 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1736 if (acpi_disabled("children"))
1737 return_ACPI_STATUS (AE_OK);
1739 /* Skip this device if we think we'll have trouble with it. */
1740 if (acpi_avoid(handle))
1741 return_ACPI_STATUS (AE_OK);
1743 bus = (device_t)context;
1744 if (ACPI_SUCCESS(AcpiGetType(handle, &type))) {
1745 handle_str = acpi_name(handle);
1747 case ACPI_TYPE_DEVICE:
1749 * Since we scan from \, be sure to skip system scope objects.
1750 * \_SB_ and \_TZ_ are defined in ACPICA as devices to work around
1751 * BIOS bugs. For example, \_SB_ is to allow \_SB_._INI to be run
1752 * during the intialization and \_TZ_ is to support Notify() on it.
1754 if (strcmp(handle_str, "\\_SB_") == 0 ||
1755 strcmp(handle_str, "\\_TZ_") == 0)
1758 if (acpi_parse_prw(handle, &prw) == 0)
1759 AcpiSetupGpeForWake(handle, prw.gpe_handle, prw.gpe_bit);
1762 case ACPI_TYPE_PROCESSOR:
1763 case ACPI_TYPE_THERMAL:
1764 case ACPI_TYPE_POWER:
1766 * Create a placeholder device for this node. Sort the
1767 * placeholder so that the probe/attach passes will run
1768 * breadth-first. Orders less than ACPI_DEV_BASE_ORDER
1769 * are reserved for special objects (i.e., system
1770 * resources). CPU devices have a very high order to
1771 * ensure they are probed after other devices.
1773 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "scanning '%s'\n", handle_str));
1774 order = level * 10 + 100;
1775 acpi_probe_order(handle, &order);
1776 child = BUS_ADD_CHILD(bus, bus, order, NULL, -1);
1780 /* Associate the handle with the device_t and vice versa. */
1781 acpi_set_handle(child, handle);
1782 AcpiAttachData(handle, acpi_fake_objhandler, child);
1785 * Check that the device is present. If it's not present,
1786 * leave it disabled (so that we have a device_t attached to
1787 * the handle, but we don't probe it).
1789 * XXX PCI link devices sometimes report "present" but not
1790 * "functional" (i.e. if disabled). Go ahead and probe them
1791 * anyway since we may enable them later.
1793 if (type == ACPI_TYPE_DEVICE && !acpi_DeviceIsPresent(child)) {
1794 /* Never disable PCI link devices. */
1795 if (acpi_MatchHid(handle, "PNP0C0F"))
1798 * Docking stations should remain enabled since the system
1799 * may be undocked at boot.
1801 if (ACPI_SUCCESS(AcpiGetHandle(handle, "_DCK", &h)))
1804 device_disable(child);
1809 * Get the device's resource settings and attach them.
1810 * Note that if the device has _PRS but no _CRS, we need
1811 * to decide when it's appropriate to try to configure the
1812 * device. Ignore the return value here; it's OK for the
1813 * device not to have any resources.
1815 acpi_parse_resources(child, handle, &acpi_res_parse_set, NULL);
1820 return_ACPI_STATUS (AE_OK);
1824 * AcpiAttachData() requires an object handler but never uses it. This is a
1825 * placeholder object handler so we can store a device_t in an ACPI_HANDLE.
1828 acpi_fake_objhandler(ACPI_HANDLE h, void *data)
1833 acpi_shutdown_final(void *arg, int howto)
1835 struct acpi_softc *sc;
1839 * XXX Shutdown code should only run on the BSP (cpuid 0).
1840 * Some chipsets do not power off the system correctly if called from
1844 if ((howto & RB_POWEROFF) != 0) {
1845 status = AcpiEnterSleepStatePrep(ACPI_STATE_S5);
1846 if (ACPI_FAILURE(status)) {
1847 device_printf(sc->acpi_dev, "AcpiEnterSleepStatePrep failed - %s\n",
1848 AcpiFormatException(status));
1851 device_printf(sc->acpi_dev, "Powering system off\n");
1852 ACPI_DISABLE_IRQS();
1853 status = AcpiEnterSleepState(ACPI_STATE_S5);
1854 if (ACPI_FAILURE(status)) {
1855 device_printf(sc->acpi_dev, "power-off failed - %s\n",
1856 AcpiFormatException(status));
1859 device_printf(sc->acpi_dev, "power-off failed - timeout\n");
1861 } else if ((howto & RB_HALT) == 0 && sc->acpi_handle_reboot) {
1862 /* Reboot using the reset register. */
1863 status = AcpiReset();
1864 if (ACPI_FAILURE(status)) {
1865 if (status != AE_NOT_EXIST)
1866 device_printf(sc->acpi_dev, "reset failed - %s\n",
1867 AcpiFormatException(status));
1870 device_printf(sc->acpi_dev, "reset failed - timeout\n");
1872 } else if (sc->acpi_do_disable && panicstr == NULL) {
1874 * Only disable ACPI if the user requested. On some systems, writing
1875 * the disable value to SMI_CMD hangs the system.
1877 device_printf(sc->acpi_dev, "Shutting down\n");
1883 acpi_enable_fixed_events(struct acpi_softc *sc)
1885 static int first_time = 1;
1887 /* Enable and clear fixed events and install handlers. */
1888 if ((AcpiGbl_FADT.Flags & ACPI_FADT_POWER_BUTTON) == 0) {
1889 AcpiClearEvent(ACPI_EVENT_POWER_BUTTON);
1890 AcpiInstallFixedEventHandler(ACPI_EVENT_POWER_BUTTON,
1891 acpi_event_power_button_sleep, sc);
1893 device_printf(sc->acpi_dev, "Power Button (fixed)\n");
1895 if ((AcpiGbl_FADT.Flags & ACPI_FADT_SLEEP_BUTTON) == 0) {
1896 AcpiClearEvent(ACPI_EVENT_SLEEP_BUTTON);
1897 AcpiInstallFixedEventHandler(ACPI_EVENT_SLEEP_BUTTON,
1898 acpi_event_sleep_button_sleep, sc);
1900 device_printf(sc->acpi_dev, "Sleep Button (fixed)\n");
1907 * Returns true if the device is actually present and should
1908 * be attached to. This requires the present, enabled, UI-visible
1909 * and diagnostics-passed bits to be set.
1912 acpi_DeviceIsPresent(device_t dev)
1914 ACPI_DEVICE_INFO *devinfo;
1919 if ((h = acpi_get_handle(dev)) == NULL ||
1920 ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo)))
1923 /* If no _STA method, must be present */
1924 if ((devinfo->Valid & ACPI_VALID_STA) == 0)
1927 /* Return true for 'present' and 'functioning' */
1928 if (ACPI_DEVICE_PRESENT(devinfo->CurrentStatus))
1931 AcpiOsFree(devinfo);
1936 * Returns true if the battery is actually present and inserted.
1939 acpi_BatteryIsPresent(device_t dev)
1941 ACPI_DEVICE_INFO *devinfo;
1946 if ((h = acpi_get_handle(dev)) == NULL ||
1947 ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo)))
1950 /* If no _STA method, must be present */
1951 if ((devinfo->Valid & ACPI_VALID_STA) == 0)
1954 /* Return true for 'present', 'battery present', and 'functioning' */
1955 if (ACPI_BATTERY_PRESENT(devinfo->CurrentStatus))
1958 AcpiOsFree(devinfo);
1963 * Match a HID string against a handle
1966 acpi_MatchHid(ACPI_HANDLE h, const char *hid)
1968 ACPI_DEVICE_INFO *devinfo;
1972 if (hid == NULL || h == NULL ||
1973 ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo)))
1976 if ((devinfo->Valid & ACPI_VALID_HID) != 0 &&
1977 strcmp(hid, devinfo->HardwareId.String) == 0)
1979 else if ((devinfo->Valid & ACPI_VALID_CID) != 0) {
1980 for (i = 0; i < devinfo->CompatibleIdList.Count; i++) {
1981 if (strcmp(hid, devinfo->CompatibleIdList.Ids[i].String) == 0) {
1988 AcpiOsFree(devinfo);
1993 * Match a UID string against a handle
1996 acpi_MatchUid(ACPI_HANDLE h, const char *uid)
1998 ACPI_DEVICE_INFO *devinfo;
2002 if (uid == NULL || h == NULL ||
2003 ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo)))
2006 if ((devinfo->Valid & ACPI_VALID_UID) != 0 &&
2007 strcmp(uid, devinfo->UniqueId.String) == 0)
2010 AcpiOsFree(devinfo);
2015 * Return the handle of a named object within our scope, ie. that of (parent)
2016 * or one if its parents.
2019 acpi_GetHandleInScope(ACPI_HANDLE parent, char *path, ACPI_HANDLE *result)
2024 /* Walk back up the tree to the root */
2026 status = AcpiGetHandle(parent, path, &r);
2027 if (ACPI_SUCCESS(status)) {
2031 /* XXX Return error here? */
2032 if (status != AE_NOT_FOUND)
2034 if (ACPI_FAILURE(AcpiGetParent(parent, &r)))
2035 return (AE_NOT_FOUND);
2041 * Allocate a buffer with a preset data size.
2044 acpi_AllocBuffer(int size)
2048 if ((buf = kmalloc(size + sizeof(*buf), M_ACPIDEV, M_NOWAIT)) == NULL)
2051 buf->Pointer = (void *)(buf + 1);
2056 acpi_SetInteger(ACPI_HANDLE handle, char *path, UINT32 number)
2059 ACPI_OBJECT_LIST args;
2061 arg1.Type = ACPI_TYPE_INTEGER;
2062 arg1.Integer.Value = number;
2064 args.Pointer = &arg1;
2066 return (AcpiEvaluateObject(handle, path, &args, NULL));
2070 * Evaluate a path that should return an integer.
2073 acpi_GetInteger(ACPI_HANDLE handle, char *path, UINT32 *number)
2080 handle = ACPI_ROOT_OBJECT;
2083 * Assume that what we've been pointed at is an Integer object, or
2084 * a method that will return an Integer.
2086 buf.Pointer = ¶m;
2087 buf.Length = sizeof(param);
2088 status = AcpiEvaluateObject(handle, path, NULL, &buf);
2089 if (ACPI_SUCCESS(status)) {
2090 if (param.Type == ACPI_TYPE_INTEGER)
2091 *number = param.Integer.Value;
2097 * In some applications, a method that's expected to return an Integer
2098 * may instead return a Buffer (probably to simplify some internal
2099 * arithmetic). We'll try to fetch whatever it is, and if it's a Buffer,
2100 * convert it into an Integer as best we can.
2104 if (status == AE_BUFFER_OVERFLOW) {
2105 if ((buf.Pointer = AcpiOsAllocate(buf.Length)) == NULL) {
2106 status = AE_NO_MEMORY;
2108 status = AcpiEvaluateObject(handle, path, NULL, &buf);
2109 if (ACPI_SUCCESS(status))
2110 status = acpi_ConvertBufferToInteger(&buf, number);
2111 AcpiOsFree(buf.Pointer);
2118 acpi_ConvertBufferToInteger(ACPI_BUFFER *bufp, UINT32 *number)
2124 p = (ACPI_OBJECT *)bufp->Pointer;
2125 if (p->Type == ACPI_TYPE_INTEGER) {
2126 *number = p->Integer.Value;
2129 if (p->Type != ACPI_TYPE_BUFFER)
2131 if (p->Buffer.Length > sizeof(int))
2132 return (AE_BAD_DATA);
2135 val = p->Buffer.Pointer;
2136 for (i = 0; i < p->Buffer.Length; i++)
2137 *number += val[i] << (i * 8);
2142 * Iterate over the elements of an a package object, calling the supplied
2143 * function for each element.
2145 * XXX possible enhancement might be to abort traversal on error.
2148 acpi_ForeachPackageObject(ACPI_OBJECT *pkg,
2149 void (*func)(ACPI_OBJECT *comp, void *arg), void *arg)
2154 if (pkg == NULL || pkg->Type != ACPI_TYPE_PACKAGE)
2155 return (AE_BAD_PARAMETER);
2157 /* Iterate over components */
2159 comp = pkg->Package.Elements;
2160 for (; i < pkg->Package.Count; i++, comp++)
2167 * Find the (index)th resource object in a set.
2170 acpi_FindIndexedResource(ACPI_BUFFER *buf, int index, ACPI_RESOURCE **resp)
2175 rp = (ACPI_RESOURCE *)buf->Pointer;
2179 if (rp > (ACPI_RESOURCE *)((uint8_t *)buf->Pointer + buf->Length))
2180 return (AE_BAD_PARAMETER);
2182 /* Check for terminator */
2183 if (rp->Type == ACPI_RESOURCE_TYPE_END_TAG || rp->Length == 0)
2184 return (AE_NOT_FOUND);
2185 rp = ACPI_NEXT_RESOURCE(rp);
2194 * Append an ACPI_RESOURCE to an ACPI_BUFFER.
2196 * Given a pointer to an ACPI_RESOURCE structure, expand the ACPI_BUFFER
2197 * provided to contain it. If the ACPI_BUFFER is empty, allocate a sensible
2198 * backing block. If the ACPI_RESOURCE is NULL, return an empty set of
2201 #define ACPI_INITIAL_RESOURCE_BUFFER_SIZE 512
2204 acpi_AppendBufferResource(ACPI_BUFFER *buf, ACPI_RESOURCE *res)
2209 /* Initialise the buffer if necessary. */
2210 if (buf->Pointer == NULL) {
2211 buf->Length = ACPI_INITIAL_RESOURCE_BUFFER_SIZE;
2212 if ((buf->Pointer = AcpiOsAllocate(buf->Length)) == NULL)
2213 return (AE_NO_MEMORY);
2214 rp = (ACPI_RESOURCE *)buf->Pointer;
2215 rp->Type = ACPI_RESOURCE_TYPE_END_TAG;
2216 rp->Length = ACPI_RS_SIZE_MIN;
2222 * Scan the current buffer looking for the terminator.
2223 * This will either find the terminator or hit the end
2224 * of the buffer and return an error.
2226 rp = (ACPI_RESOURCE *)buf->Pointer;
2228 /* Range check, don't go outside the buffer */
2229 if (rp >= (ACPI_RESOURCE *)((uint8_t *)buf->Pointer + buf->Length))
2230 return (AE_BAD_PARAMETER);
2231 if (rp->Type == ACPI_RESOURCE_TYPE_END_TAG || rp->Length == 0)
2233 rp = ACPI_NEXT_RESOURCE(rp);
2237 * Check the size of the buffer and expand if required.
2240 * size of existing resources before terminator +
2241 * size of new resource and header +
2242 * size of terminator.
2244 * Note that this loop should really only run once, unless
2245 * for some reason we are stuffing a *really* huge resource.
2247 while ((((uint8_t *)rp - (uint8_t *)buf->Pointer) +
2248 res->Length + ACPI_RS_SIZE_NO_DATA +
2249 ACPI_RS_SIZE_MIN) >= buf->Length) {
2250 if ((newp = AcpiOsAllocate(buf->Length * 2)) == NULL)
2251 return (AE_NO_MEMORY);
2252 bcopy(buf->Pointer, newp, buf->Length);
2253 rp = (ACPI_RESOURCE *)((uint8_t *)newp +
2254 ((uint8_t *)rp - (uint8_t *)buf->Pointer));
2255 AcpiOsFree(buf->Pointer);
2256 buf->Pointer = newp;
2257 buf->Length += buf->Length;
2260 /* Insert the new resource. */
2261 bcopy(res, rp, res->Length + ACPI_RS_SIZE_NO_DATA);
2263 /* And add the terminator. */
2264 rp = ACPI_NEXT_RESOURCE(rp);
2265 rp->Type = ACPI_RESOURCE_TYPE_END_TAG;
2266 rp->Length = ACPI_RS_SIZE_MIN;
2272 * Set interrupt model.
2275 acpi_SetIntrModel(int model)
2278 return (acpi_SetInteger(ACPI_ROOT_OBJECT, "_PIC", model));
2282 * DEPRECATED. This interface has serious deficiencies and will be
2285 * Immediately enter the sleep state. In the old model, acpiconf(8) ran
2286 * rc.suspend and rc.resume so we don't have to notify devd(8) to do this.
2289 acpi_SetSleepState(struct acpi_softc *sc, int state)
2294 device_printf(sc->acpi_dev,
2295 "warning: acpi_SetSleepState() deprecated, need to update your software\n");
2298 return (acpi_EnterSleepState(sc, state));
2302 acpi_sleep_force(void *arg)
2304 struct acpi_softc *sc;
2307 device_printf(sc->acpi_dev,
2308 "suspend request timed out, forcing sleep now\n");
2309 if (ACPI_FAILURE(acpi_EnterSleepState(sc, sc->acpi_next_sstate)))
2310 device_printf(sc->acpi_dev, "force sleep state S%d failed\n",
2311 sc->acpi_next_sstate);
2315 * Request that the system enter the given suspend state. All /dev/apm
2316 * devices and devd(8) will be notified. Userland then has a chance to
2317 * save state and acknowledge the request. The system sleeps once all
2321 acpi_ReqSleepState(struct acpi_softc *sc, int state)
2324 struct apm_clone_data *clone;
2327 if (state < ACPI_STATE_S1 || state > ACPI_STATE_S5)
2330 /* S5 (soft-off) should be entered directly with no waiting. */
2331 if (state == ACPI_STATE_S5) {
2332 if (ACPI_SUCCESS(acpi_EnterSleepState(sc, state)))
2338 /* This platform does not support acpi suspend/resume. */
2339 return (EOPNOTSUPP);
2341 /* If a suspend request is already in progress, just return. */
2343 if (sc->acpi_next_sstate != 0) {
2348 /* Record the pending state and notify all apm devices. */
2349 sc->acpi_next_sstate = state;
2351 STAILQ_FOREACH(clone, &sc->apm_cdevs, entries) {
2352 clone->notify_status = APM_EV_NONE;
2353 if ((clone->flags & ACPI_EVF_DEVD) == 0) {
2354 KNOTE(&clone->sel_read.si_note, 0);
2359 /* If devd(8) is not running, immediately enter the sleep state. */
2360 if (devctl_process_running() == FALSE) {
2362 if (ACPI_SUCCESS(acpi_EnterSleepState(sc, sc->acpi_next_sstate))) {
2369 /* Now notify devd(8) also. */
2370 acpi_UserNotify("Suspend", ACPI_ROOT_OBJECT, state);
2373 * Set a timeout to fire if userland doesn't ack the suspend request
2374 * in time. This way we still eventually go to sleep if we were
2375 * overheating or running low on battery, even if userland is hung.
2376 * We cancel this timeout once all userland acks are in or the
2377 * suspend request is aborted.
2379 callout_reset(&sc->susp_force_to, 10 * hz, acpi_sleep_force, sc);
2386 * Acknowledge (or reject) a pending sleep state. The caller has
2387 * prepared for suspend and is now ready for it to proceed. If the
2388 * error argument is non-zero, it indicates suspend should be cancelled
2389 * and gives an errno value describing why. Once all votes are in,
2390 * we suspend the system.
2393 acpi_AckSleepState(struct apm_clone_data *clone, int error)
2395 struct acpi_softc *sc;
2398 /* This platform does not support acpi suspend/resume. */
2399 return (EOPNOTSUPP);
2401 /* If no pending sleep state, return an error. */
2403 sc = clone->acpi_sc;
2404 if (sc->acpi_next_sstate == 0) {
2409 /* Caller wants to abort suspend process. */
2411 sc->acpi_next_sstate = 0;
2412 callout_stop(&sc->susp_force_to);
2413 device_printf(sc->acpi_dev,
2414 "listener on %s cancelled the pending suspend\n",
2415 devtoname(clone->cdev));
2421 * Mark this device as acking the suspend request. Then, walk through
2422 * all devices, seeing if they agree yet. We only count devices that
2423 * are writable since read-only devices couldn't ack the request.
2425 clone->notify_status = APM_EV_ACKED;
2427 STAILQ_FOREACH(clone, &sc->apm_cdevs, entries) {
2428 if ((clone->flags & ACPI_EVF_WRITE) != 0 &&
2429 clone->notify_status != APM_EV_ACKED) {
2435 /* If all devices have voted "yes", we will suspend now. */
2437 callout_stop(&sc->susp_force_to);
2441 if (ACPI_FAILURE(acpi_EnterSleepState(sc, sc->acpi_next_sstate)))
2449 acpi_sleep_enable(void *arg)
2451 ((struct acpi_softc *)arg)->acpi_sleep_disabled = 0;
2454 enum acpi_sleep_state {
2457 ACPI_SS_DEV_SUSPEND,
2463 * Enter the desired system sleep state.
2465 * Currently we support S1-S5 but S4 is only S4BIOS
2468 acpi_EnterSleepState(struct acpi_softc *sc, int state)
2473 enum acpi_sleep_state slp_state;
2475 ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, state);
2477 /* Re-entry once we're suspending is not allowed. */
2480 if (sc->acpi_sleep_disabled) {
2482 device_printf(sc->acpi_dev,
2483 "suspend request ignored (not ready yet)\n");
2486 sc->acpi_sleep_disabled = 1;
2490 * Be sure to hold Giant across DEVICE_SUSPEND/RESUME since non-MPSAFE
2491 * drivers need this.
2495 slp_state = ACPI_SS_NONE;
2501 status = AcpiGetSleepTypeData(state, &TypeA, &TypeB);
2502 if (status == AE_NOT_FOUND) {
2503 device_printf(sc->acpi_dev,
2504 "Sleep state S%d not supported by BIOS\n", state);
2506 } else if (ACPI_FAILURE(status)) {
2507 device_printf(sc->acpi_dev, "AcpiGetSleepTypeData failed - %s\n",
2508 AcpiFormatException(status));
2512 sc->acpi_sstate = state;
2514 /* Enable any GPEs as appropriate and requested by the user. */
2515 acpi_wake_prep_walk(state);
2516 slp_state = ACPI_SS_GPE_SET;
2519 * Inform all devices that we are going to sleep. If at least one
2520 * device fails, DEVICE_SUSPEND() automatically resumes the tree.
2522 * XXX Note that a better two-pass approach with a 'veto' pass
2523 * followed by a "real thing" pass would be better, but the current
2524 * bus interface does not provide for this.
2526 if (DEVICE_SUSPEND(root_bus) != 0) {
2527 device_printf(sc->acpi_dev, "device_suspend failed\n");
2530 slp_state = ACPI_SS_DEV_SUSPEND;
2532 /* If testing device suspend only, back out of everything here. */
2533 if (acpi_susp_bounce)
2536 status = AcpiEnterSleepStatePrep(state);
2537 if (ACPI_FAILURE(status)) {
2538 device_printf(sc->acpi_dev, "AcpiEnterSleepStatePrep failed - %s\n",
2539 AcpiFormatException(status));
2542 slp_state = ACPI_SS_SLP_PREP;
2544 if (sc->acpi_sleep_delay > 0)
2545 DELAY(sc->acpi_sleep_delay * 1000000);
2547 if (state != ACPI_STATE_S1) {
2548 acpi_sleep_machdep(sc, state);
2550 /* Re-enable ACPI hardware on wakeup from sleep state 4. */
2551 if (state == ACPI_STATE_S4)
2554 ACPI_DISABLE_IRQS();
2555 status = AcpiEnterSleepState(state);
2556 if (ACPI_FAILURE(status)) {
2557 device_printf(sc->acpi_dev, "AcpiEnterSleepState failed - %s\n",
2558 AcpiFormatException(status));
2562 slp_state = ACPI_SS_SLEPT;
2566 * Shut down cleanly and power off. This will call us back through the
2567 * shutdown handlers.
2569 shutdown_nice(RB_POWEROFF);
2573 status = AE_BAD_PARAMETER;
2578 * Back out state according to how far along we got in the suspend
2579 * process. This handles both the error and success cases.
2581 sc->acpi_next_sstate = 0;
2582 if (slp_state >= ACPI_SS_GPE_SET) {
2583 acpi_wake_prep_walk(state);
2584 sc->acpi_sstate = ACPI_STATE_S0;
2586 if (slp_state >= ACPI_SS_SLP_PREP)
2587 AcpiLeaveSleepState(state);
2588 if (slp_state >= ACPI_SS_DEV_SUSPEND)
2589 DEVICE_RESUME(root_bus);
2590 if (slp_state >= ACPI_SS_SLEPT)
2591 acpi_enable_fixed_events(sc);
2593 /* Allow another sleep request after a while. */
2594 /* XXX: needs timeout */
2595 if (state != ACPI_STATE_S5)
2596 acpi_sleep_enable(sc);
2598 /* Run /etc/rc.resume after we are back. */
2599 acpi_UserNotify("Resume", ACPI_ROOT_OBJECT, state);
2603 return_ACPI_STATUS (status);
2606 /* Enable or disable the device's GPE. */
2608 acpi_wake_set_enable(device_t dev, int enable)
2610 struct acpi_prw_data prw;
2614 /* Make sure the device supports waking the system and get the GPE. */
2615 if (acpi_parse_prw(acpi_get_handle(dev), &prw) != 0)
2618 flags = acpi_get_flags(dev);
2620 status = AcpiSetGpeWakeMask(prw.gpe_handle, prw.gpe_bit,
2622 if (ACPI_FAILURE(status)) {
2623 device_printf(dev, "enable wake failed\n");
2626 acpi_set_flags(dev, flags | ACPI_FLAG_WAKE_ENABLED);
2628 status = AcpiSetGpeWakeMask(prw.gpe_handle, prw.gpe_bit,
2630 if (ACPI_FAILURE(status)) {
2631 device_printf(dev, "disable wake failed\n");
2634 acpi_set_flags(dev, flags & ~ACPI_FLAG_WAKE_ENABLED);
2641 acpi_wake_sleep_prep(ACPI_HANDLE handle, int sstate)
2643 struct acpi_prw_data prw;
2646 /* Check that this is a wake-capable device and get its GPE. */
2647 if (acpi_parse_prw(handle, &prw) != 0)
2649 dev = acpi_get_device(handle);
2652 * The destination sleep state must be less than (i.e., higher power)
2653 * or equal to the value specified by _PRW. If this GPE cannot be
2654 * enabled for the next sleep state, then disable it. If it can and
2655 * the user requested it be enabled, turn on any required power resources
2658 if (sstate > prw.lowest_wake) {
2659 AcpiSetGpeWakeMask(prw.gpe_handle, prw.gpe_bit, ACPI_GPE_DISABLE);
2661 device_printf(dev, "wake_prep disabled wake for %s (S%d)\n",
2662 acpi_name(handle), sstate);
2663 } else if (dev && (acpi_get_flags(dev) & ACPI_FLAG_WAKE_ENABLED) != 0) {
2664 acpi_pwr_wake_enable(handle, 1);
2665 acpi_SetInteger(handle, "_PSW", 1);
2667 device_printf(dev, "wake_prep enabled for %s (S%d)\n",
2668 acpi_name(handle), sstate);
2675 acpi_wake_run_prep(ACPI_HANDLE handle, int sstate)
2677 struct acpi_prw_data prw;
2681 * Check that this is a wake-capable device and get its GPE. Return
2682 * now if the user didn't enable this device for wake.
2684 if (acpi_parse_prw(handle, &prw) != 0)
2686 dev = acpi_get_device(handle);
2687 if (dev == NULL || (acpi_get_flags(dev) & ACPI_FLAG_WAKE_ENABLED) == 0)
2691 * If this GPE couldn't be enabled for the previous sleep state, it was
2692 * disabled before going to sleep so re-enable it. If it was enabled,
2693 * clear _PSW and turn off any power resources it used.
2695 if (sstate > prw.lowest_wake) {
2696 AcpiSetGpeWakeMask(prw.gpe_handle, prw.gpe_bit, ACPI_GPE_ENABLE);
2698 device_printf(dev, "run_prep re-enabled %s\n", acpi_name(handle));
2700 acpi_SetInteger(handle, "_PSW", 0);
2701 acpi_pwr_wake_enable(handle, 0);
2703 device_printf(dev, "run_prep cleaned up for %s\n",
2711 acpi_wake_prep(ACPI_HANDLE handle, UINT32 level, void *context, void **status)
2715 /* If suspending, run the sleep prep function, otherwise wake. */
2716 sstate = *(int *)context;
2717 if (AcpiGbl_SystemAwakeAndRunning)
2718 acpi_wake_sleep_prep(handle, sstate);
2720 acpi_wake_run_prep(handle, sstate);
2724 /* Walk the tree rooted at acpi0 to prep devices for suspend/resume. */
2726 acpi_wake_prep_walk(int sstate)
2728 ACPI_HANDLE sb_handle;
2730 if (ACPI_SUCCESS(AcpiGetHandle(ACPI_ROOT_OBJECT, "\\_SB_", &sb_handle))) {
2731 AcpiWalkNamespace(ACPI_TYPE_DEVICE, sb_handle, 100,
2732 acpi_wake_prep, NULL, &sstate, NULL);
2737 /* Walk the tree rooted at acpi0 to attach per-device wake sysctls. */
2739 acpi_wake_sysctl_walk(device_t dev)
2742 int error, i, numdevs;
2747 error = device_get_children(dev, &devlist, &numdevs);
2748 if (error != 0 || numdevs == 0) {
2750 kfree(devlist, M_TEMP);
2753 for (i = 0; i < numdevs; i++) {
2755 acpi_wake_sysctl_walk(child);
2756 if (!device_is_attached(child))
2758 status = AcpiEvaluateObject(acpi_get_handle(child), "_PRW", NULL, NULL);
2759 if (ACPI_SUCCESS(status)) {
2760 SYSCTL_ADD_PROC(device_get_sysctl_ctx(child),
2761 SYSCTL_CHILDREN(device_get_sysctl_tree(child)), OID_AUTO,
2762 "wake", CTLTYPE_INT | CTLFLAG_RW, child, 0,
2763 acpi_wake_set_sysctl, "I", "Device set to wake the system");
2766 kfree(devlist, M_TEMP);
2773 /* Enable or disable wake from userland. */
2775 acpi_wake_set_sysctl(SYSCTL_HANDLER_ARGS)
2780 dev = (device_t)arg1;
2781 enable = (acpi_get_flags(dev) & ACPI_FLAG_WAKE_ENABLED) ? 1 : 0;
2783 error = sysctl_handle_int(oidp, &enable, 0, req);
2784 if (error != 0 || req->newptr == NULL)
2786 if (enable != 0 && enable != 1)
2789 return (acpi_wake_set_enable(dev, enable));
2793 /* Parse a device's _PRW into a structure. */
2795 acpi_parse_prw(ACPI_HANDLE h, struct acpi_prw_data *prw)
2798 ACPI_BUFFER prw_buffer;
2799 ACPI_OBJECT *res, *res2;
2800 int error, i, power_count;
2802 if (h == NULL || prw == NULL)
2806 * The _PRW object (7.2.9) is only required for devices that have the
2807 * ability to wake the system from a sleeping state.
2810 prw_buffer.Pointer = NULL;
2811 prw_buffer.Length = ACPI_ALLOCATE_BUFFER;
2812 status = AcpiEvaluateObject(h, "_PRW", NULL, &prw_buffer);
2813 if (ACPI_FAILURE(status))
2815 res = (ACPI_OBJECT *)prw_buffer.Pointer;
2818 if (!ACPI_PKG_VALID(res, 2))
2822 * Element 1 of the _PRW object:
2823 * The lowest power system sleeping state that can be entered while still
2824 * providing wake functionality. The sleeping state being entered must
2825 * be less than (i.e., higher power) or equal to this value.
2827 if (acpi_PkgInt32(res, 1, &prw->lowest_wake) != 0)
2831 * Element 0 of the _PRW object:
2833 switch (res->Package.Elements[0].Type) {
2834 case ACPI_TYPE_INTEGER:
2836 * If the data type of this package element is numeric, then this
2837 * _PRW package element is the bit index in the GPEx_EN, in the
2838 * GPE blocks described in the FADT, of the enable bit that is
2839 * enabled for the wake event.
2841 prw->gpe_handle = NULL;
2842 prw->gpe_bit = res->Package.Elements[0].Integer.Value;
2845 case ACPI_TYPE_PACKAGE:
2847 * If the data type of this package element is a package, then this
2848 * _PRW package element is itself a package containing two
2849 * elements. The first is an object reference to the GPE Block
2850 * device that contains the GPE that will be triggered by the wake
2851 * event. The second element is numeric and it contains the bit
2852 * index in the GPEx_EN, in the GPE Block referenced by the
2853 * first element in the package, of the enable bit that is enabled for
2856 * For example, if this field is a package then it is of the form:
2857 * Package() {\_SB.PCI0.ISA.GPE, 2}
2859 res2 = &res->Package.Elements[0];
2860 if (!ACPI_PKG_VALID(res2, 2))
2862 prw->gpe_handle = acpi_GetReference(NULL, &res2->Package.Elements[0]);
2863 if (prw->gpe_handle == NULL)
2865 if (acpi_PkgInt32(res2, 1, &prw->gpe_bit) != 0)
2873 /* Elements 2 to N of the _PRW object are power resources. */
2874 power_count = res->Package.Count - 2;
2875 if (power_count > ACPI_PRW_MAX_POWERRES) {
2876 kprintf("ACPI device %s has too many power resources\n", acpi_name(h));
2879 prw->power_res_count = power_count;
2880 for (i = 0; i < power_count; i++)
2881 prw->power_res[i] = res->Package.Elements[i];
2884 if (prw_buffer.Pointer != NULL)
2885 AcpiOsFree(prw_buffer.Pointer);
2890 * ACPI Event Handlers
2893 /* System Event Handlers (registered by EVENTHANDLER_REGISTER) */
2896 acpi_system_eventhandler_sleep(void *arg, int state)
2898 struct acpi_softc *sc;
2901 ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, state);
2905 /* Check if button action is disabled. */
2906 if (state == ACPI_S_STATES_MAX + 1)
2909 /* Request that the system prepare to enter the given suspend state. */
2910 ret = acpi_ReqSleepState((struct acpi_softc *)arg, state);
2912 device_printf(sc->acpi_dev,
2913 "request to enter state S%d failed (err %d)\n", state, ret);
2919 acpi_system_eventhandler_wakeup(void *arg, int state)
2922 ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, state);
2924 /* Currently, nothing to do for wakeup. */
2930 * ACPICA Event Handlers (FixedEvent, also called from button notify handler)
2933 acpi_event_power_button_sleep(void *context)
2935 struct acpi_softc *sc = (struct acpi_softc *)context;
2937 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
2939 EVENTHANDLER_INVOKE(acpi_sleep_event, sc->acpi_power_button_sx);
2941 return_VALUE (ACPI_INTERRUPT_HANDLED);
2945 acpi_event_power_button_wake(void *context)
2947 struct acpi_softc *sc = (struct acpi_softc *)context;
2949 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
2951 EVENTHANDLER_INVOKE(acpi_wakeup_event, sc->acpi_power_button_sx);
2953 return_VALUE (ACPI_INTERRUPT_HANDLED);
2957 acpi_event_sleep_button_sleep(void *context)
2959 struct acpi_softc *sc = (struct acpi_softc *)context;
2961 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
2963 EVENTHANDLER_INVOKE(acpi_sleep_event, sc->acpi_sleep_button_sx);
2965 return_VALUE (ACPI_INTERRUPT_HANDLED);
2969 acpi_event_sleep_button_wake(void *context)
2971 struct acpi_softc *sc = (struct acpi_softc *)context;
2973 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
2975 EVENTHANDLER_INVOKE(acpi_wakeup_event, sc->acpi_sleep_button_sx);
2977 return_VALUE (ACPI_INTERRUPT_HANDLED);
2981 * XXX This static buffer is suboptimal. There is no locking so only
2982 * use this for single-threaded callers.
2985 acpi_name(ACPI_HANDLE handle)
2988 static char data[256];
2990 buf.Length = sizeof(data);
2993 if (handle && ACPI_SUCCESS(AcpiGetName(handle, ACPI_FULL_PATHNAME, &buf)))
2995 return ("(unknown)");
2999 * Debugging/bug-avoidance. Avoid trying to fetch info on various
3000 * parts of the namespace.
3003 acpi_avoid(ACPI_HANDLE handle)
3005 char *cp, *env, *np;
3008 np = acpi_name(handle);
3011 if ((env = kgetenv("debug.acpi.avoid")) == NULL)
3014 /* Scan the avoid list checking for a match */
3017 while (*cp != 0 && isspace(*cp))
3022 while (cp[len] != 0 && !isspace(cp[len]))
3024 if (!strncmp(cp, np, len)) {
3036 * Debugging/bug-avoidance. Disable ACPI subsystem components.
3039 acpi_disabled(char *subsys)
3044 if ((env = kgetenv("debug.acpi.disabled")) == NULL)
3046 if (strcmp(env, "all") == 0) {
3051 /* Scan the disable list, checking for a match. */
3054 while (*cp != '\0' && isspace(*cp))
3059 while (cp[len] != '\0' && !isspace(cp[len]))
3061 if (strncmp(cp, subsys, len) == 0) {
3073 * Debugging/bug-avoidance. Enable ACPI subsystem components. Most
3074 * components are enabled by default. The ones that are not have to be
3075 * enabled via debug.acpi.enabled.
3078 acpi_enabled(char *subsys)
3083 if ((env = kgetenv("debug.acpi.enabled")) == NULL)
3085 if (strcmp(env, "all") == 0) {
3090 /* Scan the enable list, checking for a match. */
3093 while (*cp != '\0' && isspace(*cp))
3098 while (cp[len] != '\0' && !isspace(cp[len]))
3100 if (strncmp(cp, subsys, len) == 0) {
3112 * Control interface.
3114 * We multiplex ioctls for all participating ACPI devices here. Individual
3115 * drivers wanting to be accessible via /dev/acpi should use the
3116 * register/deregister interface to make their handlers visible.
3118 struct acpi_ioctl_hook
3120 TAILQ_ENTRY(acpi_ioctl_hook) link;
3126 static TAILQ_HEAD(,acpi_ioctl_hook) acpi_ioctl_hooks;
3127 static int acpi_ioctl_hooks_initted;
3130 acpi_register_ioctl(u_long cmd, acpi_ioctl_fn fn, void *arg)
3132 struct acpi_ioctl_hook *hp;
3134 if ((hp = kmalloc(sizeof(*hp), M_ACPIDEV, M_NOWAIT)) == NULL)
3141 if (acpi_ioctl_hooks_initted == 0) {
3142 TAILQ_INIT(&acpi_ioctl_hooks);
3143 acpi_ioctl_hooks_initted = 1;
3145 TAILQ_INSERT_TAIL(&acpi_ioctl_hooks, hp, link);
3152 acpi_deregister_ioctl(u_long cmd, acpi_ioctl_fn fn)
3154 struct acpi_ioctl_hook *hp;
3157 TAILQ_FOREACH(hp, &acpi_ioctl_hooks, link)
3158 if (hp->cmd == cmd && hp->fn == fn)
3162 TAILQ_REMOVE(&acpi_ioctl_hooks, hp, link);
3163 kfree(hp, M_ACPIDEV);
3169 acpiopen(struct dev_open_args *ap)
3175 acpiclose(struct dev_close_args *ap)
3181 acpiioctl(struct dev_ioctl_args *ap)
3183 struct acpi_softc *sc;
3184 struct acpi_ioctl_hook *hp;
3189 sc = ap->a_head.a_dev->si_drv1;
3192 * Scan the list of registered ioctls, looking for handlers.
3194 lwkt_gettoken(&acpi_token);
3196 if (acpi_ioctl_hooks_initted) {
3197 TAILQ_FOREACH(hp, &acpi_ioctl_hooks, link) {
3198 if (hp->cmd == ap->a_cmd)
3204 error = hp->fn(ap->a_cmd, ap->a_data, hp->arg);
3205 lwkt_reltoken(&acpi_token);
3210 * Core ioctls are not permitted for non-writable user.
3211 * Currently, other ioctls just fetch information.
3212 * Not changing system behavior.
3214 if ((ap->a_fflag & FWRITE) == 0) {
3215 lwkt_reltoken(&acpi_token);
3219 /* Core system ioctls. */
3220 switch (ap->a_cmd) {
3221 case ACPIIO_REQSLPSTATE:
3222 state = *(int *)ap->a_data;
3223 if (state != ACPI_STATE_S5)
3224 error = acpi_ReqSleepState(sc, state);
3226 device_printf(sc->acpi_dev,
3227 "power off via acpi ioctl not supported\n");
3231 case ACPIIO_ACKSLPSTATE:
3234 error = *(int *)ap->a_data;
3235 error = acpi_AckSleepState(sc->acpi_clone, error);
3238 case ACPIIO_SETSLPSTATE: /* DEPRECATED */
3240 state = *(int *)ap->a_data;
3241 if (state >= ACPI_STATE_S0 && state <= ACPI_S_STATES_MAX)
3242 if (ACPI_SUCCESS(acpi_SetSleepState(sc, state)))
3245 case ACPIIO_DO_MCALL:
3246 if (acpi_allow_mcall == 1) {
3247 struct acpi_mcall_ioctl_arg *params;
3248 ACPI_BUFFER result = { ACPI_ALLOCATE_BUFFER, NULL };
3249 ACPI_OBJECT *resobj;
3252 params = (struct acpi_mcall_ioctl_arg *)ap->a_data;
3253 params->retval = AcpiEvaluateObject(NULL, params->path,
3254 ¶ms->args, &result);
3255 if (ACPI_SUCCESS(params->retval) && result.Pointer != NULL &&
3256 params->result.Pointer != NULL) {
3257 params->result.Length = min(params->result.Length,
3259 copyout(result.Pointer, params->result.Pointer,
3260 params->result.Length);
3261 params->reslen = result.Length;
3262 if (result.Length >= sizeof(ACPI_OBJECT)) {
3263 resobj = (ACPI_OBJECT *)params->result.Pointer;
3264 switch (resobj->Type) {
3265 case ACPI_TYPE_STRING:
3266 resobj->String.Pointer = (char *)
3267 ((UINT8 *)(resobj->String.Pointer) -
3268 (UINT8 *)result.Pointer +
3271 case ACPI_TYPE_BUFFER:
3272 resobj->Buffer.Pointer -= (UINT8 *)result.Pointer -
3279 if (result.Pointer != NULL)
3280 AcpiOsFree(result.Pointer);
3282 device_printf(sc->acpi_dev,
3283 "debug.acpi.allow_method_calls must be set\n");
3291 lwkt_reltoken(&acpi_token);
3297 acpi_supported_sleep_state_sysctl(SYSCTL_HANDLER_ARGS)
3301 UINT8 state, TypeA, TypeB;
3303 sbuf_new(&sb, NULL, 32, SBUF_AUTOEXTEND);
3304 for (state = ACPI_STATE_S1; state < ACPI_S_STATES_MAX + 1; state++)
3305 if (ACPI_SUCCESS(AcpiGetSleepTypeData(state, &TypeA, &TypeB)))
3306 sbuf_printf(&sb, "S%d ", state);
3309 error = sysctl_handle_string(oidp, sbuf_data(&sb), sbuf_len(&sb), req);
3315 acpi_sleep_state_sysctl(SYSCTL_HANDLER_ARGS)
3317 char sleep_state[10];
3319 u_int new_state, old_state;
3321 old_state = *(u_int *)oidp->oid_arg1;
3322 if (old_state > ACPI_S_STATES_MAX + 1)
3323 strlcpy(sleep_state, "unknown", sizeof(sleep_state));
3325 strlcpy(sleep_state, sleep_state_names[old_state], sizeof(sleep_state));
3326 error = sysctl_handle_string(oidp, sleep_state, sizeof(sleep_state), req);
3327 if (error == 0 && req->newptr != NULL) {
3328 new_state = ACPI_STATE_S0;
3329 for (; new_state <= ACPI_S_STATES_MAX + 1; new_state++)
3330 if (strcmp(sleep_state, sleep_state_names[new_state]) == 0)
3332 if (new_state <= ACPI_S_STATES_MAX + 1) {
3333 if (new_state != old_state)
3334 *(u_int *)oidp->oid_arg1 = new_state;
3342 /* Inform devctl(4) when we receive a Notify. */
3344 acpi_UserNotify(const char *subsystem, ACPI_HANDLE h, uint8_t notify)
3346 char notify_buf[16];
3347 ACPI_BUFFER handle_buf;
3350 if (subsystem == NULL)
3353 handle_buf.Pointer = NULL;
3354 handle_buf.Length = ACPI_ALLOCATE_BUFFER;
3355 status = AcpiNsHandleToPathname(h, &handle_buf, FALSE);
3356 if (ACPI_FAILURE(status))
3358 ksnprintf(notify_buf, sizeof(notify_buf), "notify=0x%02x", notify);
3359 devctl_notify("ACPI", subsystem, handle_buf.Pointer, notify_buf);
3360 AcpiOsFree(handle_buf.Pointer);
3365 * Support for parsing debug options from the kernel environment.
3367 * Bits may be set in the AcpiDbgLayer and AcpiDbgLevel debug registers
3368 * by specifying the names of the bits in the debug.acpi.layer and
3369 * debug.acpi.level environment variables. Bits may be unset by
3370 * prefixing the bit name with !.
3378 static struct debugtag dbg_layer[] = {
3379 {"ACPI_UTILITIES", ACPI_UTILITIES},
3380 {"ACPI_HARDWARE", ACPI_HARDWARE},
3381 {"ACPI_EVENTS", ACPI_EVENTS},
3382 {"ACPI_TABLES", ACPI_TABLES},
3383 {"ACPI_NAMESPACE", ACPI_NAMESPACE},
3384 {"ACPI_PARSER", ACPI_PARSER},
3385 {"ACPI_DISPATCHER", ACPI_DISPATCHER},
3386 {"ACPI_EXECUTER", ACPI_EXECUTER},
3387 {"ACPI_RESOURCES", ACPI_RESOURCES},
3388 {"ACPI_CA_DEBUGGER", ACPI_CA_DEBUGGER},
3389 {"ACPI_OS_SERVICES", ACPI_OS_SERVICES},
3390 {"ACPI_CA_DISASSEMBLER", ACPI_CA_DISASSEMBLER},
3391 {"ACPI_ALL_COMPONENTS", ACPI_ALL_COMPONENTS},
3393 {"ACPI_AC_ADAPTER", ACPI_AC_ADAPTER},
3394 {"ACPI_BATTERY", ACPI_BATTERY},
3395 {"ACPI_BUS", ACPI_BUS},
3396 {"ACPI_BUTTON", ACPI_BUTTON},
3397 {"ACPI_EC", ACPI_EC},
3398 {"ACPI_FAN", ACPI_FAN},
3399 {"ACPI_POWERRES", ACPI_POWERRES},
3400 {"ACPI_PROCESSOR", ACPI_PROCESSOR},
3401 {"ACPI_THERMAL", ACPI_THERMAL},
3402 {"ACPI_TIMER", ACPI_TIMER},
3403 {"ACPI_ALL_DRIVERS", ACPI_ALL_DRIVERS},
3407 static struct debugtag dbg_level[] = {
3408 {"ACPI_LV_INIT", ACPI_LV_INIT},
3409 {"ACPI_LV_DEBUG_OBJECT", ACPI_LV_DEBUG_OBJECT},
3410 {"ACPI_LV_INFO", ACPI_LV_INFO},
3411 {"ACPI_LV_REPAIR", ACPI_LV_REPAIR},
3412 {"ACPI_LV_ALL_EXCEPTIONS", ACPI_LV_ALL_EXCEPTIONS},
3414 /* Trace verbosity level 1 [Standard Trace Level] */
3415 {"ACPI_LV_INIT_NAMES", ACPI_LV_INIT_NAMES},
3416 {"ACPI_LV_PARSE", ACPI_LV_PARSE},
3417 {"ACPI_LV_LOAD", ACPI_LV_LOAD},
3418 {"ACPI_LV_DISPATCH", ACPI_LV_DISPATCH},
3419 {"ACPI_LV_EXEC", ACPI_LV_EXEC},
3420 {"ACPI_LV_NAMES", ACPI_LV_NAMES},
3421 {"ACPI_LV_OPREGION", ACPI_LV_OPREGION},
3422 {"ACPI_LV_BFIELD", ACPI_LV_BFIELD},
3423 {"ACPI_LV_TABLES", ACPI_LV_TABLES},
3424 {"ACPI_LV_VALUES", ACPI_LV_VALUES},
3425 {"ACPI_LV_OBJECTS", ACPI_LV_OBJECTS},
3426 {"ACPI_LV_RESOURCES", ACPI_LV_RESOURCES},
3427 {"ACPI_LV_USER_REQUESTS", ACPI_LV_USER_REQUESTS},
3428 {"ACPI_LV_PACKAGE", ACPI_LV_PACKAGE},
3429 {"ACPI_LV_VERBOSITY1", ACPI_LV_VERBOSITY1},
3431 /* Trace verbosity level 2 [Function tracing and memory allocation] */
3432 {"ACPI_LV_ALLOCATIONS", ACPI_LV_ALLOCATIONS},
3433 {"ACPI_LV_FUNCTIONS", ACPI_LV_FUNCTIONS},
3434 {"ACPI_LV_OPTIMIZATIONS", ACPI_LV_OPTIMIZATIONS},
3435 {"ACPI_LV_VERBOSITY2", ACPI_LV_VERBOSITY2},
3436 {"ACPI_LV_ALL", ACPI_LV_ALL},
3438 /* Trace verbosity level 3 [Threading, I/O, and Interrupts] */
3439 {"ACPI_LV_MUTEX", ACPI_LV_MUTEX},
3440 {"ACPI_LV_THREADS", ACPI_LV_THREADS},
3441 {"ACPI_LV_IO", ACPI_LV_IO},
3442 {"ACPI_LV_INTERRUPTS", ACPI_LV_INTERRUPTS},
3443 {"ACPI_LV_VERBOSITY3", ACPI_LV_VERBOSITY3},
3445 /* Exceptionally verbose output -- also used in the global "DebugLevel" */
3446 {"ACPI_LV_AML_DISASSEMBLE", ACPI_LV_AML_DISASSEMBLE},
3447 {"ACPI_LV_VERBOSE_INFO", ACPI_LV_VERBOSE_INFO},
3448 {"ACPI_LV_FULL_TABLES", ACPI_LV_FULL_TABLES},
3449 {"ACPI_LV_EVENTS", ACPI_LV_EVENTS},
3450 {"ACPI_LV_VERBOSE", ACPI_LV_VERBOSE},
3455 acpi_parse_debug(char *cp, struct debugtag *tag, UINT32 *flag)
3467 while (*ep && !isspace(*ep))
3478 for (i = 0; tag[i].name != NULL; i++) {
3479 if (!strncmp(cp, tag[i].name, l)) {
3481 *flag |= tag[i].value;
3483 *flag &= ~tag[i].value;
3491 acpi_set_debugging(void *junk)
3493 char *layer, *level;
3500 layer = kgetenv("debug.acpi.layer");
3501 level = kgetenv("debug.acpi.level");
3502 if (layer == NULL && level == NULL)
3505 kprintf("ACPI set debug");
3506 if (layer != NULL) {
3507 if (strcmp("NONE", layer) != 0)
3508 kprintf(" layer '%s'", layer);
3509 acpi_parse_debug(layer, &dbg_layer[0], &AcpiDbgLayer);
3512 if (level != NULL) {
3513 if (strcmp("NONE", level) != 0)
3514 kprintf(" level '%s'", level);
3515 acpi_parse_debug(level, &dbg_level[0], &AcpiDbgLevel);
3521 SYSINIT(acpi_debugging, SI_BOOT1_TUNABLES, SI_ORDER_ANY, acpi_set_debugging,
3525 acpi_debug_sysctl(SYSCTL_HANDLER_ARGS)
3528 struct debugtag *tag;
3531 if (sbuf_new(&sb, NULL, 128, SBUF_AUTOEXTEND) == NULL)
3533 if (strcmp(oidp->oid_arg1, "debug.acpi.layer") == 0) {
3534 tag = &dbg_layer[0];
3535 dbg = &AcpiDbgLayer;
3537 tag = &dbg_level[0];
3538 dbg = &AcpiDbgLevel;
3541 /* Get old values if this is a get request. */
3542 ACPI_SERIAL_BEGIN(acpi);
3544 sbuf_cpy(&sb, "NONE");
3545 } else if (req->newptr == NULL) {
3546 for (; tag->name != NULL; tag++) {
3547 if ((*dbg & tag->value) == tag->value)
3548 sbuf_printf(&sb, "%s ", tag->name);
3554 /* Copy out the old values to the user. */
3555 error = SYSCTL_OUT(req, sbuf_data(&sb), sbuf_len(&sb));
3558 /* If the user is setting a string, parse it. */
3559 if (error == 0 && req->newptr != NULL) {
3561 ksetenv((char *)oidp->oid_arg1, (char *)req->newptr);
3562 acpi_set_debugging(NULL);
3564 ACPI_SERIAL_END(acpi);
3569 SYSCTL_PROC(_debug_acpi, OID_AUTO, layer, CTLFLAG_RW | CTLTYPE_STRING,
3570 "debug.acpi.layer", 0, acpi_debug_sysctl, "A", "");
3571 SYSCTL_PROC(_debug_acpi, OID_AUTO, level, CTLFLAG_RW | CTLTYPE_STRING,
3572 "debug.acpi.level", 0, acpi_debug_sysctl, "A", "");
3573 #endif /* ACPI_DEBUG */
3576 acpi_debug_objects_sysctl(SYSCTL_HANDLER_ARGS)
3581 old = acpi_debug_objects;
3582 error = sysctl_handle_int(oidp, &acpi_debug_objects, 0, req);
3583 if (error != 0 || req->newptr == NULL)
3585 if (old == acpi_debug_objects || (old && acpi_debug_objects))
3588 ACPI_SERIAL_BEGIN(acpi);
3589 AcpiGbl_EnableAmlDebugObject = acpi_debug_objects ? TRUE : FALSE;
3590 ACPI_SERIAL_END(acpi);
3597 acpi_parse_interfaces(char *str, struct acpi_interface *iface)
3604 while (isspace(*p) || *p == ',')
3609 p = kstrdup(p, M_TEMP);
3610 for (i = 0; i < len; i++)
3615 if (isspace(p[i]) || p[i] == '\0')
3618 i += strlen(p + i) + 1;
3625 iface->data = kmalloc(sizeof(*iface->data) * j, M_TEMP, M_WAITOK);
3629 if (isspace(p[i]) || p[i] == '\0')
3632 iface->data[j] = p + i;
3633 i += strlen(p + i) + 1;
3641 acpi_free_interfaces(struct acpi_interface *iface)
3643 kfree(iface->data[0], M_TEMP);
3644 kfree(iface->data, M_TEMP);
3648 acpi_reset_interfaces(device_t dev)
3650 struct acpi_interface list;
3654 if (acpi_parse_interfaces(acpi_install_interface, &list) > 0) {
3655 for (i = 0; i < list.num; i++) {
3656 status = AcpiInstallInterface(list.data[i]);
3657 if (ACPI_FAILURE(status))
3659 "failed to install _OSI(\"%s\"): %s\n",
3660 list.data[i], AcpiFormatException(status));
3661 else if (bootverbose)
3662 device_printf(dev, "installed _OSI(\"%s\")\n",
3665 acpi_free_interfaces(&list);
3667 if (acpi_parse_interfaces(acpi_remove_interface, &list) > 0) {
3668 for (i = 0; i < list.num; i++) {
3669 status = AcpiRemoveInterface(list.data[i]);
3670 if (ACPI_FAILURE(status))
3672 "failed to remove _OSI(\"%s\"): %s\n",
3673 list.data[i], AcpiFormatException(status));
3674 else if (bootverbose)
3675 device_printf(dev, "removed _OSI(\"%s\")\n",
3678 acpi_free_interfaces(&list);
3683 acpi_pm_func(u_long cmd, void *arg, ...)
3685 int state, acpi_state;
3687 struct acpi_softc *sc;
3692 case POWER_CMD_SUSPEND:
3693 sc = (struct acpi_softc *)arg;
3699 __va_start(ap, arg);
3700 state = __va_arg(ap, int);
3704 case POWER_SLEEP_STATE_STANDBY:
3705 acpi_state = sc->acpi_standby_sx;
3707 case POWER_SLEEP_STATE_SUSPEND:
3708 acpi_state = sc->acpi_suspend_sx;
3710 case POWER_SLEEP_STATE_HIBERNATE:
3711 acpi_state = ACPI_STATE_S4;
3718 if (ACPI_FAILURE(acpi_EnterSleepState(sc, acpi_state)))
3731 acpi_pm_register(void *arg)
3733 if (!cold || resource_disabled("acpi", 0))
3736 power_pm_register(POWER_PM_TYPE_ACPI, acpi_pm_func, NULL);
3739 SYSINIT(power, SI_BOOT2_KLD, SI_ORDER_ANY, acpi_pm_register, 0);