2 * Copyright (c) 2000 Takanori Watanabe <takawata@jp.freebsd.org>
3 * Copyright (c) 2000 Mitsuru IWASAKI <iwasaki@jp.freebsd.org>
4 * Copyright (c) 2000, 2001 Michael Smith
5 * Copyright (c) 2000 BSDi
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
35 #include <sys/param.h>
36 #include <sys/eventhandler.h>
37 #include <sys/kernel.h>
39 #include <sys/fcntl.h>
40 #include <sys/malloc.h>
41 #include <sys/module.h>
44 #include <sys/ioccom.h>
45 #include <sys/reboot.h>
46 #include <sys/sysctl.h>
47 #include <sys/ctype.h>
48 #include <sys/linker.h>
49 #include <sys/power.h>
51 #include <sys/sched.h>
53 #include <sys/timetc.h>
55 #if defined(__i386__) || defined(__amd64__)
56 #include <machine/clock.h>
57 #include <machine/pci_cfgreg.h>
59 #include <machine/resource.h>
60 #include <machine/bus.h>
62 #include <isa/isavar.h>
63 #include <isa/pnpvar.h>
65 #include <contrib/dev/acpica/include/acpi.h>
66 #include <contrib/dev/acpica/include/accommon.h>
67 #include <contrib/dev/acpica/include/acnamesp.h>
69 #include <dev/acpica/acpivar.h>
70 #include <dev/acpica/acpiio.h>
72 #include <dev/pci/pcivar.h>
74 #include <vm/vm_param.h>
76 static MALLOC_DEFINE(M_ACPIDEV, "acpidev", "ACPI devices");
78 /* Hooks for the ACPI CA debugging infrastructure */
79 #define _COMPONENT ACPI_BUS
80 ACPI_MODULE_NAME("ACPI")
82 static d_open_t acpiopen;
83 static d_close_t acpiclose;
84 static d_ioctl_t acpiioctl;
86 static struct cdevsw acpi_cdevsw = {
87 .d_version = D_VERSION,
94 struct acpi_interface {
99 static char *sysres_ids[] = { "PNP0C01", "PNP0C02", NULL };
100 static char *pcilink_ids[] = { "PNP0C0F", NULL };
102 /* Global mutex for locking access to the ACPI subsystem. */
103 struct mtx acpi_mutex;
104 struct callout acpi_sleep_timer;
106 /* Bitmap of device quirks. */
109 /* Supported sleep states. */
110 static BOOLEAN acpi_sleep_states[ACPI_S_STATE_COUNT];
112 static void acpi_lookup(void *arg, const char *name, device_t *dev);
113 static int acpi_modevent(struct module *mod, int event, void *junk);
114 static int acpi_probe(device_t dev);
115 static int acpi_attach(device_t dev);
116 static int acpi_suspend(device_t dev);
117 static int acpi_resume(device_t dev);
118 static int acpi_shutdown(device_t dev);
119 static device_t acpi_add_child(device_t bus, u_int order, const char *name,
121 static int acpi_print_child(device_t bus, device_t child);
122 static void acpi_probe_nomatch(device_t bus, device_t child);
123 static void acpi_driver_added(device_t dev, driver_t *driver);
124 static void acpi_child_deleted(device_t dev, device_t child);
125 static int acpi_read_ivar(device_t dev, device_t child, int index,
127 static int acpi_write_ivar(device_t dev, device_t child, int index,
129 static struct resource_list *acpi_get_rlist(device_t dev, device_t child);
130 static void acpi_reserve_resources(device_t dev);
131 static int acpi_sysres_alloc(device_t dev);
132 static int acpi_set_resource(device_t dev, device_t child, int type,
133 int rid, rman_res_t start, rman_res_t count);
134 static struct resource *acpi_alloc_resource(device_t bus, device_t child,
135 int type, int *rid, rman_res_t start, rman_res_t end,
136 rman_res_t count, u_int flags);
137 static int acpi_adjust_resource(device_t bus, device_t child, int type,
138 struct resource *r, rman_res_t start, rman_res_t end);
139 static int acpi_release_resource(device_t bus, device_t child, int type,
140 int rid, struct resource *r);
141 static void acpi_delete_resource(device_t bus, device_t child, int type,
143 static uint32_t acpi_isa_get_logicalid(device_t dev);
144 static int acpi_isa_get_compatid(device_t dev, uint32_t *cids, int count);
145 static int acpi_device_id_probe(device_t bus, device_t dev, char **ids, char **match);
146 static ACPI_STATUS acpi_device_eval_obj(device_t bus, device_t dev,
147 ACPI_STRING pathname, ACPI_OBJECT_LIST *parameters,
149 static ACPI_STATUS acpi_device_scan_cb(ACPI_HANDLE h, UINT32 level,
150 void *context, void **retval);
151 static ACPI_STATUS acpi_device_scan_children(device_t bus, device_t dev,
152 int max_depth, acpi_scan_cb_t user_fn, void *arg);
153 static int acpi_isa_pnp_probe(device_t bus, device_t child,
154 struct isa_pnp_id *ids);
155 static void acpi_platform_osc(device_t dev);
156 static void acpi_probe_children(device_t bus);
157 static void acpi_probe_order(ACPI_HANDLE handle, int *order);
158 static ACPI_STATUS acpi_probe_child(ACPI_HANDLE handle, UINT32 level,
159 void *context, void **status);
160 static void acpi_sleep_enable(void *arg);
161 static ACPI_STATUS acpi_sleep_disable(struct acpi_softc *sc);
162 static ACPI_STATUS acpi_EnterSleepState(struct acpi_softc *sc, int state);
163 static void acpi_shutdown_final(void *arg, int howto);
164 static void acpi_enable_fixed_events(struct acpi_softc *sc);
165 static void acpi_resync_clock(struct acpi_softc *sc);
166 static int acpi_wake_sleep_prep(ACPI_HANDLE handle, int sstate);
167 static int acpi_wake_run_prep(ACPI_HANDLE handle, int sstate);
168 static int acpi_wake_prep_walk(int sstate);
169 static int acpi_wake_sysctl_walk(device_t dev);
170 static int acpi_wake_set_sysctl(SYSCTL_HANDLER_ARGS);
171 static void acpi_system_eventhandler_sleep(void *arg, int state);
172 static void acpi_system_eventhandler_wakeup(void *arg, int state);
173 static int acpi_sname2sstate(const char *sname);
174 static const char *acpi_sstate2sname(int sstate);
175 static int acpi_supported_sleep_state_sysctl(SYSCTL_HANDLER_ARGS);
176 static int acpi_sleep_state_sysctl(SYSCTL_HANDLER_ARGS);
177 static int acpi_debug_objects_sysctl(SYSCTL_HANDLER_ARGS);
178 static int acpi_pm_func(u_long cmd, void *arg, ...);
179 static int acpi_child_location_str_method(device_t acdev, device_t child,
180 char *buf, size_t buflen);
181 static int acpi_child_pnpinfo_str_method(device_t acdev, device_t child,
182 char *buf, size_t buflen);
183 static void acpi_enable_pcie(void);
184 static void acpi_hint_device_unit(device_t acdev, device_t child,
185 const char *name, int *unitp);
186 static void acpi_reset_interfaces(device_t dev);
188 static device_method_t acpi_methods[] = {
189 /* Device interface */
190 DEVMETHOD(device_probe, acpi_probe),
191 DEVMETHOD(device_attach, acpi_attach),
192 DEVMETHOD(device_shutdown, acpi_shutdown),
193 DEVMETHOD(device_detach, bus_generic_detach),
194 DEVMETHOD(device_suspend, acpi_suspend),
195 DEVMETHOD(device_resume, acpi_resume),
198 DEVMETHOD(bus_add_child, acpi_add_child),
199 DEVMETHOD(bus_print_child, acpi_print_child),
200 DEVMETHOD(bus_probe_nomatch, acpi_probe_nomatch),
201 DEVMETHOD(bus_driver_added, acpi_driver_added),
202 DEVMETHOD(bus_child_deleted, acpi_child_deleted),
203 DEVMETHOD(bus_read_ivar, acpi_read_ivar),
204 DEVMETHOD(bus_write_ivar, acpi_write_ivar),
205 DEVMETHOD(bus_get_resource_list, acpi_get_rlist),
206 DEVMETHOD(bus_set_resource, acpi_set_resource),
207 DEVMETHOD(bus_get_resource, bus_generic_rl_get_resource),
208 DEVMETHOD(bus_alloc_resource, acpi_alloc_resource),
209 DEVMETHOD(bus_adjust_resource, acpi_adjust_resource),
210 DEVMETHOD(bus_release_resource, acpi_release_resource),
211 DEVMETHOD(bus_delete_resource, acpi_delete_resource),
212 DEVMETHOD(bus_child_pnpinfo_str, acpi_child_pnpinfo_str_method),
213 DEVMETHOD(bus_child_location_str, acpi_child_location_str_method),
214 DEVMETHOD(bus_activate_resource, bus_generic_activate_resource),
215 DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource),
216 DEVMETHOD(bus_setup_intr, bus_generic_setup_intr),
217 DEVMETHOD(bus_teardown_intr, bus_generic_teardown_intr),
218 DEVMETHOD(bus_hint_device_unit, acpi_hint_device_unit),
219 DEVMETHOD(bus_get_cpus, acpi_get_cpus),
220 DEVMETHOD(bus_get_domain, acpi_get_domain),
223 DEVMETHOD(acpi_id_probe, acpi_device_id_probe),
224 DEVMETHOD(acpi_evaluate_object, acpi_device_eval_obj),
225 DEVMETHOD(acpi_pwr_for_sleep, acpi_device_pwr_for_sleep),
226 DEVMETHOD(acpi_scan_children, acpi_device_scan_children),
229 DEVMETHOD(isa_pnp_probe, acpi_isa_pnp_probe),
234 static driver_t acpi_driver = {
237 sizeof(struct acpi_softc),
240 static devclass_t acpi_devclass;
241 EARLY_DRIVER_MODULE(acpi, nexus, acpi_driver, acpi_devclass, acpi_modevent, 0,
242 BUS_PASS_BUS + BUS_PASS_ORDER_MIDDLE);
243 MODULE_VERSION(acpi, 1);
245 ACPI_SERIAL_DECL(acpi, "ACPI root bus");
247 /* Local pools for managing system resources for ACPI child devices. */
248 static struct rman acpi_rman_io, acpi_rman_mem;
250 #define ACPI_MINIMUM_AWAKETIME 5
252 /* Holds the description of the acpi0 device. */
253 static char acpi_desc[ACPI_OEM_ID_SIZE + ACPI_OEM_TABLE_ID_SIZE + 2];
255 SYSCTL_NODE(_debug, OID_AUTO, acpi, CTLFLAG_RD | CTLFLAG_MPSAFE, NULL,
257 static char acpi_ca_version[12];
258 SYSCTL_STRING(_debug_acpi, OID_AUTO, acpi_ca_version, CTLFLAG_RD,
259 acpi_ca_version, 0, "Version of Intel ACPI-CA");
262 * Allow overriding _OSI methods.
264 static char acpi_install_interface[256];
265 TUNABLE_STR("hw.acpi.install_interface", acpi_install_interface,
266 sizeof(acpi_install_interface));
267 static char acpi_remove_interface[256];
268 TUNABLE_STR("hw.acpi.remove_interface", acpi_remove_interface,
269 sizeof(acpi_remove_interface));
271 /* Allow users to dump Debug objects without ACPI debugger. */
272 static int acpi_debug_objects;
273 TUNABLE_INT("debug.acpi.enable_debug_objects", &acpi_debug_objects);
274 SYSCTL_PROC(_debug_acpi, OID_AUTO, enable_debug_objects,
275 CTLFLAG_RW | CTLTYPE_INT | CTLFLAG_NEEDGIANT, NULL, 0,
276 acpi_debug_objects_sysctl, "I",
277 "Enable Debug objects");
279 /* Allow the interpreter to ignore common mistakes in BIOS. */
280 static int acpi_interpreter_slack = 1;
281 TUNABLE_INT("debug.acpi.interpreter_slack", &acpi_interpreter_slack);
282 SYSCTL_INT(_debug_acpi, OID_AUTO, interpreter_slack, CTLFLAG_RDTUN,
283 &acpi_interpreter_slack, 1, "Turn on interpreter slack mode.");
285 /* Ignore register widths set by FADT and use default widths instead. */
286 static int acpi_ignore_reg_width = 1;
287 TUNABLE_INT("debug.acpi.default_register_width", &acpi_ignore_reg_width);
288 SYSCTL_INT(_debug_acpi, OID_AUTO, default_register_width, CTLFLAG_RDTUN,
289 &acpi_ignore_reg_width, 1, "Ignore register widths set by FADT");
291 /* Allow users to override quirks. */
292 TUNABLE_INT("debug.acpi.quirks", &acpi_quirks);
294 int acpi_susp_bounce;
295 SYSCTL_INT(_debug_acpi, OID_AUTO, suspend_bounce, CTLFLAG_RW,
296 &acpi_susp_bounce, 0, "Don't actually suspend, just test devices.");
299 * ACPI can only be loaded as a module by the loader; activating it after
300 * system bootstrap time is not useful, and can be fatal to the system.
301 * It also cannot be unloaded, since the entire system bus hierarchy hangs
305 acpi_modevent(struct module *mod, int event, void *junk)
310 printf("The ACPI driver cannot be loaded after boot.\n");
315 if (!cold && power_pm_get_type() == POWER_PM_TYPE_ACPI)
325 * Perform early initialization.
330 static int started = 0;
334 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
336 /* Only run the startup code once. The MADT driver also calls this. */
338 return_VALUE (AE_OK);
342 * Initialize the ACPICA subsystem.
344 if (ACPI_FAILURE(status = AcpiInitializeSubsystem())) {
345 printf("ACPI: Could not initialize Subsystem: %s\n",
346 AcpiFormatException(status));
347 return_VALUE (status);
351 * Pre-allocate space for RSDT/XSDT and DSDT tables and allow resizing
352 * if more tables exist.
354 if (ACPI_FAILURE(status = AcpiInitializeTables(NULL, 2, TRUE))) {
355 printf("ACPI: Table initialisation failed: %s\n",
356 AcpiFormatException(status));
357 return_VALUE (status);
360 /* Set up any quirks we have for this system. */
361 if (acpi_quirks == ACPI_Q_OK)
362 acpi_table_quirks(&acpi_quirks);
364 /* If the user manually set the disabled hint to 0, force-enable ACPI. */
365 if (resource_int_value("acpi", 0, "disabled", &val) == 0 && val == 0)
366 acpi_quirks &= ~ACPI_Q_BROKEN;
367 if (acpi_quirks & ACPI_Q_BROKEN) {
368 printf("ACPI disabled by blacklist. Contact your BIOS vendor.\n");
372 return_VALUE (status);
376 * Detect ACPI and perform early initialisation.
381 ACPI_TABLE_RSDP *rsdp;
382 ACPI_TABLE_HEADER *rsdt;
383 ACPI_PHYSICAL_ADDRESS paddr;
386 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
391 /* Check that we haven't been disabled with a hint. */
392 if (resource_disabled("acpi", 0))
395 /* Check for other PM systems. */
396 if (power_pm_get_type() != POWER_PM_TYPE_NONE &&
397 power_pm_get_type() != POWER_PM_TYPE_ACPI) {
398 printf("ACPI identify failed, other PM system enabled.\n");
402 /* Initialize root tables. */
403 if (ACPI_FAILURE(acpi_Startup())) {
404 printf("ACPI: Try disabling either ACPI or apic support.\n");
408 if ((paddr = AcpiOsGetRootPointer()) == 0 ||
409 (rsdp = AcpiOsMapMemory(paddr, sizeof(ACPI_TABLE_RSDP))) == NULL)
411 if (rsdp->Revision > 1 && rsdp->XsdtPhysicalAddress != 0)
412 paddr = (ACPI_PHYSICAL_ADDRESS)rsdp->XsdtPhysicalAddress;
414 paddr = (ACPI_PHYSICAL_ADDRESS)rsdp->RsdtPhysicalAddress;
415 AcpiOsUnmapMemory(rsdp, sizeof(ACPI_TABLE_RSDP));
417 if ((rsdt = AcpiOsMapMemory(paddr, sizeof(ACPI_TABLE_HEADER))) == NULL)
419 sbuf_new(&sb, acpi_desc, sizeof(acpi_desc), SBUF_FIXEDLEN);
420 sbuf_bcat(&sb, rsdt->OemId, ACPI_OEM_ID_SIZE);
423 sbuf_bcat(&sb, rsdt->OemTableId, ACPI_OEM_TABLE_ID_SIZE);
427 AcpiOsUnmapMemory(rsdt, sizeof(ACPI_TABLE_HEADER));
429 snprintf(acpi_ca_version, sizeof(acpi_ca_version), "%x", ACPI_CA_VERSION);
435 * Fetch some descriptive data from ACPI to put in our attach message.
438 acpi_probe(device_t dev)
441 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
443 device_set_desc(dev, acpi_desc);
445 return_VALUE (BUS_PROBE_NOWILDCARD);
449 acpi_attach(device_t dev)
451 struct acpi_softc *sc;
458 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
460 sc = device_get_softc(dev);
462 callout_init(&sc->susp_force_to, 1);
466 /* Initialize resource manager. */
467 acpi_rman_io.rm_type = RMAN_ARRAY;
468 acpi_rman_io.rm_start = 0;
469 acpi_rman_io.rm_end = 0xffff;
470 acpi_rman_io.rm_descr = "ACPI I/O ports";
471 if (rman_init(&acpi_rman_io) != 0)
472 panic("acpi rman_init IO ports failed");
473 acpi_rman_mem.rm_type = RMAN_ARRAY;
474 acpi_rman_mem.rm_descr = "ACPI I/O memory addresses";
475 if (rman_init(&acpi_rman_mem) != 0)
476 panic("acpi rman_init memory failed");
478 /* Initialise the ACPI mutex */
479 mtx_init(&acpi_mutex, "ACPI global lock", NULL, MTX_DEF);
482 * Set the globals from our tunables. This is needed because ACPI-CA
483 * uses UINT8 for some values and we have no tunable_byte.
485 AcpiGbl_EnableInterpreterSlack = acpi_interpreter_slack ? TRUE : FALSE;
486 AcpiGbl_EnableAmlDebugObject = acpi_debug_objects ? TRUE : FALSE;
487 AcpiGbl_UseDefaultRegisterWidths = acpi_ignore_reg_width ? TRUE : FALSE;
491 * Disable all debugging layers and levels.
497 /* Override OS interfaces if the user requested. */
498 acpi_reset_interfaces(dev);
500 /* Load ACPI name space. */
501 status = AcpiLoadTables();
502 if (ACPI_FAILURE(status)) {
503 device_printf(dev, "Could not load Namespace: %s\n",
504 AcpiFormatException(status));
508 /* Handle MCFG table if present. */
512 * Note that some systems (specifically, those with namespace evaluation
513 * issues that require the avoidance of parts of the namespace) must
514 * avoid running _INI and _STA on everything, as well as dodging the final
517 * For these devices, we set ACPI_NO_DEVICE_INIT and ACPI_NO_OBJECT_INIT).
519 * XXX We should arrange for the object init pass after we have attached
520 * all our child devices, but on many systems it works here.
523 if (testenv("debug.acpi.avoid"))
524 flags = ACPI_NO_DEVICE_INIT | ACPI_NO_OBJECT_INIT;
526 /* Bring the hardware and basic handlers online. */
527 if (ACPI_FAILURE(status = AcpiEnableSubsystem(flags))) {
528 device_printf(dev, "Could not enable ACPI: %s\n",
529 AcpiFormatException(status));
534 * Call the ECDT probe function to provide EC functionality before
535 * the namespace has been evaluated.
537 * XXX This happens before the sysresource devices have been probed and
538 * attached so its resources come from nexus0. In practice, this isn't
539 * a problem but should be addressed eventually.
541 acpi_ec_ecdt_probe(dev);
543 /* Bring device objects and regions online. */
544 if (ACPI_FAILURE(status = AcpiInitializeObjects(flags))) {
545 device_printf(dev, "Could not initialize ACPI objects: %s\n",
546 AcpiFormatException(status));
551 * Setup our sysctl tree.
553 * XXX: This doesn't check to make sure that none of these fail.
555 sysctl_ctx_init(&sc->acpi_sysctl_ctx);
556 sc->acpi_sysctl_tree = SYSCTL_ADD_NODE(&sc->acpi_sysctl_ctx,
557 SYSCTL_STATIC_CHILDREN(_hw), OID_AUTO, device_get_name(dev),
558 CTLFLAG_RD | CTLFLAG_MPSAFE, 0, "");
559 SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
560 OID_AUTO, "supported_sleep_state",
561 CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_NEEDGIANT,
562 0, 0, acpi_supported_sleep_state_sysctl, "A",
563 "List supported ACPI sleep states.");
564 SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
565 OID_AUTO, "power_button_state",
566 CTLTYPE_STRING | CTLFLAG_RW | CTLFLAG_NEEDGIANT,
567 &sc->acpi_power_button_sx, 0, acpi_sleep_state_sysctl, "A",
568 "Power button ACPI sleep state.");
569 SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
570 OID_AUTO, "sleep_button_state",
571 CTLTYPE_STRING | CTLFLAG_RW | CTLFLAG_NEEDGIANT,
572 &sc->acpi_sleep_button_sx, 0, acpi_sleep_state_sysctl, "A",
573 "Sleep button ACPI sleep state.");
574 SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
575 OID_AUTO, "lid_switch_state",
576 CTLTYPE_STRING | CTLFLAG_RW | CTLFLAG_NEEDGIANT,
577 &sc->acpi_lid_switch_sx, 0, acpi_sleep_state_sysctl, "A",
578 "Lid ACPI sleep state. Set to S3 if you want to suspend your laptop when close the Lid.");
579 SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
580 OID_AUTO, "standby_state",
581 CTLTYPE_STRING | CTLFLAG_RW | CTLFLAG_NEEDGIANT,
582 &sc->acpi_standby_sx, 0, acpi_sleep_state_sysctl, "A", "");
583 SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
584 OID_AUTO, "suspend_state",
585 CTLTYPE_STRING | CTLFLAG_RW | CTLFLAG_NEEDGIANT,
586 &sc->acpi_suspend_sx, 0, acpi_sleep_state_sysctl, "A", "");
587 SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
588 OID_AUTO, "sleep_delay", CTLFLAG_RW, &sc->acpi_sleep_delay, 0,
589 "sleep delay in seconds");
590 SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
591 OID_AUTO, "s4bios", CTLFLAG_RW, &sc->acpi_s4bios, 0, "S4BIOS mode");
592 SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
593 OID_AUTO, "verbose", CTLFLAG_RW, &sc->acpi_verbose, 0, "verbose mode");
594 SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
595 OID_AUTO, "disable_on_reboot", CTLFLAG_RW,
596 &sc->acpi_do_disable, 0, "Disable ACPI when rebooting/halting system");
597 SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
598 OID_AUTO, "handle_reboot", CTLFLAG_RW,
599 &sc->acpi_handle_reboot, 0, "Use ACPI Reset Register to reboot");
602 * Default to 1 second before sleeping to give some machines time to
605 sc->acpi_sleep_delay = 1;
607 sc->acpi_verbose = 1;
608 if ((env = kern_getenv("hw.acpi.verbose")) != NULL) {
609 if (strcmp(env, "0") != 0)
610 sc->acpi_verbose = 1;
614 /* Only enable reboot by default if the FADT says it is available. */
615 if (AcpiGbl_FADT.Flags & ACPI_FADT_RESET_REGISTER)
616 sc->acpi_handle_reboot = 1;
618 #if !ACPI_REDUCED_HARDWARE
619 /* Only enable S4BIOS by default if the FACS says it is available. */
620 if (AcpiGbl_FACS != NULL && AcpiGbl_FACS->Flags & ACPI_FACS_S4_BIOS_PRESENT)
624 /* Probe all supported sleep states. */
625 acpi_sleep_states[ACPI_STATE_S0] = TRUE;
626 for (state = ACPI_STATE_S1; state < ACPI_S_STATE_COUNT; state++)
627 if (ACPI_SUCCESS(AcpiEvaluateObject(ACPI_ROOT_OBJECT,
628 __DECONST(char *, AcpiGbl_SleepStateNames[state]), NULL, NULL)) &&
629 ACPI_SUCCESS(AcpiGetSleepTypeData(state, &TypeA, &TypeB)))
630 acpi_sleep_states[state] = TRUE;
633 * Dispatch the default sleep state to devices. The lid switch is set
634 * to UNKNOWN by default to avoid surprising users.
636 sc->acpi_power_button_sx = acpi_sleep_states[ACPI_STATE_S5] ?
637 ACPI_STATE_S5 : ACPI_STATE_UNKNOWN;
638 sc->acpi_lid_switch_sx = ACPI_STATE_UNKNOWN;
639 sc->acpi_standby_sx = acpi_sleep_states[ACPI_STATE_S1] ?
640 ACPI_STATE_S1 : ACPI_STATE_UNKNOWN;
641 sc->acpi_suspend_sx = acpi_sleep_states[ACPI_STATE_S3] ?
642 ACPI_STATE_S3 : ACPI_STATE_UNKNOWN;
644 /* Pick the first valid sleep state for the sleep button default. */
645 sc->acpi_sleep_button_sx = ACPI_STATE_UNKNOWN;
646 for (state = ACPI_STATE_S1; state <= ACPI_STATE_S4; state++)
647 if (acpi_sleep_states[state]) {
648 sc->acpi_sleep_button_sx = state;
652 acpi_enable_fixed_events(sc);
655 * Scan the namespace and attach/initialise children.
658 /* Register our shutdown handler. */
659 EVENTHANDLER_REGISTER(shutdown_final, acpi_shutdown_final, sc,
663 * Register our acpi event handlers.
664 * XXX should be configurable eg. via userland policy manager.
666 EVENTHANDLER_REGISTER(acpi_sleep_event, acpi_system_eventhandler_sleep,
667 sc, ACPI_EVENT_PRI_LAST);
668 EVENTHANDLER_REGISTER(acpi_wakeup_event, acpi_system_eventhandler_wakeup,
669 sc, ACPI_EVENT_PRI_LAST);
671 /* Flag our initial states. */
672 sc->acpi_enabled = TRUE;
673 sc->acpi_sstate = ACPI_STATE_S0;
674 sc->acpi_sleep_disabled = TRUE;
676 /* Create the control device */
677 sc->acpi_dev_t = make_dev(&acpi_cdevsw, 0, UID_ROOT, GID_OPERATOR, 0664,
679 sc->acpi_dev_t->si_drv1 = sc;
681 if ((error = acpi_machdep_init(dev)))
684 /* Register ACPI again to pass the correct argument of pm_func. */
685 power_pm_register(POWER_PM_TYPE_ACPI, acpi_pm_func, sc);
687 acpi_platform_osc(dev);
689 if (!acpi_disabled("bus")) {
690 EVENTHANDLER_REGISTER(dev_lookup, acpi_lookup, NULL, 1000);
691 acpi_probe_children(dev);
694 /* Update all GPEs and enable runtime GPEs. */
695 status = AcpiUpdateAllGpes();
696 if (ACPI_FAILURE(status))
697 device_printf(dev, "Could not update all GPEs: %s\n",
698 AcpiFormatException(status));
700 /* Allow sleep request after a while. */
701 callout_init_mtx(&acpi_sleep_timer, &acpi_mutex, 0);
702 callout_reset(&acpi_sleep_timer, hz * ACPI_MINIMUM_AWAKETIME,
703 acpi_sleep_enable, sc);
708 return_VALUE (error);
712 acpi_set_power_children(device_t dev, int state)
716 int dstate, i, numdevs;
718 if (device_get_children(dev, &devlist, &numdevs) != 0)
722 * Retrieve and set D-state for the sleep state if _SxD is present.
723 * Skip children who aren't attached since they are handled separately.
725 for (i = 0; i < numdevs; i++) {
728 if (device_is_attached(child) &&
729 acpi_device_pwr_for_sleep(dev, child, &dstate) == 0)
730 acpi_set_powerstate(child, dstate);
732 free(devlist, M_TEMP);
736 acpi_suspend(device_t dev)
742 error = bus_generic_suspend(dev);
744 acpi_set_power_children(dev, ACPI_STATE_D3);
750 acpi_resume(device_t dev)
755 acpi_set_power_children(dev, ACPI_STATE_D0);
757 return (bus_generic_resume(dev));
761 acpi_shutdown(device_t dev)
766 /* Allow children to shutdown first. */
767 bus_generic_shutdown(dev);
770 * Enable any GPEs that are able to power-on the system (i.e., RTC).
771 * Also, disable any that are not valid for this state (most).
773 acpi_wake_prep_walk(ACPI_STATE_S5);
779 * Handle a new device being added
782 acpi_add_child(device_t bus, u_int order, const char *name, int unit)
784 struct acpi_device *ad;
787 if ((ad = malloc(sizeof(*ad), M_ACPIDEV, M_NOWAIT | M_ZERO)) == NULL)
790 resource_list_init(&ad->ad_rl);
792 child = device_add_child_ordered(bus, order, name, unit);
794 device_set_ivars(child, ad);
801 acpi_print_child(device_t bus, device_t child)
803 struct acpi_device *adev = device_get_ivars(child);
804 struct resource_list *rl = &adev->ad_rl;
807 retval += bus_print_child_header(bus, child);
808 retval += resource_list_print_type(rl, "port", SYS_RES_IOPORT, "%#jx");
809 retval += resource_list_print_type(rl, "iomem", SYS_RES_MEMORY, "%#jx");
810 retval += resource_list_print_type(rl, "irq", SYS_RES_IRQ, "%jd");
811 retval += resource_list_print_type(rl, "drq", SYS_RES_DRQ, "%jd");
812 if (device_get_flags(child))
813 retval += printf(" flags %#x", device_get_flags(child));
814 retval += bus_print_child_domain(bus, child);
815 retval += bus_print_child_footer(bus, child);
821 * If this device is an ACPI child but no one claimed it, attempt
822 * to power it off. We'll power it back up when a driver is added.
824 * XXX Disabled for now since many necessary devices (like fdc and
825 * ATA) don't claim the devices we created for them but still expect
826 * them to be powered up.
829 acpi_probe_nomatch(device_t bus, device_t child)
831 #ifdef ACPI_ENABLE_POWERDOWN_NODRIVER
832 acpi_set_powerstate(child, ACPI_STATE_D3);
837 * If a new driver has a chance to probe a child, first power it up.
839 * XXX Disabled for now (see acpi_probe_nomatch for details).
842 acpi_driver_added(device_t dev, driver_t *driver)
844 device_t child, *devlist;
847 DEVICE_IDENTIFY(driver, dev);
848 if (device_get_children(dev, &devlist, &numdevs))
850 for (i = 0; i < numdevs; i++) {
852 if (device_get_state(child) == DS_NOTPRESENT) {
853 #ifdef ACPI_ENABLE_POWERDOWN_NODRIVER
854 acpi_set_powerstate(child, ACPI_STATE_D0);
855 if (device_probe_and_attach(child) != 0)
856 acpi_set_powerstate(child, ACPI_STATE_D3);
858 device_probe_and_attach(child);
862 free(devlist, M_TEMP);
865 /* Location hint for devctl(8) */
867 acpi_child_location_str_method(device_t cbdev, device_t child, char *buf,
870 struct acpi_device *dinfo = device_get_ivars(child);
874 if (dinfo->ad_handle) {
875 snprintf(buf, buflen, "handle=%s", acpi_name(dinfo->ad_handle));
876 if (ACPI_SUCCESS(acpi_GetInteger(dinfo->ad_handle, "_PXM", &pxm))) {
877 snprintf(buf2, 32, " _PXM=%d", pxm);
878 strlcat(buf, buf2, buflen);
881 snprintf(buf, buflen, "");
886 /* PnP information for devctl(8) */
888 acpi_pnpinfo_str(ACPI_HANDLE handle, char *buf, size_t buflen)
890 ACPI_DEVICE_INFO *adinfo;
892 if (ACPI_FAILURE(AcpiGetObjectInfo(handle, &adinfo))) {
893 snprintf(buf, buflen, "unknown");
897 snprintf(buf, buflen, "_HID=%s _UID=%lu _CID=%s",
898 (adinfo->Valid & ACPI_VALID_HID) ?
899 adinfo->HardwareId.String : "none",
900 (adinfo->Valid & ACPI_VALID_UID) ?
901 strtoul(adinfo->UniqueId.String, NULL, 10) : 0UL,
902 ((adinfo->Valid & ACPI_VALID_CID) &&
903 adinfo->CompatibleIdList.Count > 0) ?
904 adinfo->CompatibleIdList.Ids[0].String : "none");
911 acpi_child_pnpinfo_str_method(device_t cbdev, device_t child, char *buf,
914 struct acpi_device *dinfo = device_get_ivars(child);
916 return (acpi_pnpinfo_str(dinfo->ad_handle, buf, buflen));
920 * Handle device deletion.
923 acpi_child_deleted(device_t dev, device_t child)
925 struct acpi_device *dinfo = device_get_ivars(child);
927 if (acpi_get_device(dinfo->ad_handle) == child)
928 AcpiDetachData(dinfo->ad_handle, acpi_fake_objhandler);
932 * Handle per-device ivars
935 acpi_read_ivar(device_t dev, device_t child, int index, uintptr_t *result)
937 struct acpi_device *ad;
939 if ((ad = device_get_ivars(child)) == NULL) {
940 device_printf(child, "device has no ivars\n");
944 /* ACPI and ISA compatibility ivars */
946 case ACPI_IVAR_HANDLE:
947 *(ACPI_HANDLE *)result = ad->ad_handle;
949 case ACPI_IVAR_PRIVATE:
950 *(void **)result = ad->ad_private;
952 case ACPI_IVAR_FLAGS:
953 *(int *)result = ad->ad_flags;
955 case ISA_IVAR_VENDORID:
956 case ISA_IVAR_SERIAL:
957 case ISA_IVAR_COMPATID:
960 case ISA_IVAR_LOGICALID:
961 *(int *)result = acpi_isa_get_logicalid(child);
964 *(uint8_t*)result = (ad->ad_cls_class >> 16) & 0xff;
966 case PCI_IVAR_SUBCLASS:
967 *(uint8_t*)result = (ad->ad_cls_class >> 8) & 0xff;
969 case PCI_IVAR_PROGIF:
970 *(uint8_t*)result = (ad->ad_cls_class >> 0) & 0xff;
980 acpi_write_ivar(device_t dev, device_t child, int index, uintptr_t value)
982 struct acpi_device *ad;
984 if ((ad = device_get_ivars(child)) == NULL) {
985 device_printf(child, "device has no ivars\n");
990 case ACPI_IVAR_HANDLE:
991 ad->ad_handle = (ACPI_HANDLE)value;
993 case ACPI_IVAR_PRIVATE:
994 ad->ad_private = (void *)value;
996 case ACPI_IVAR_FLAGS:
997 ad->ad_flags = (int)value;
1000 panic("bad ivar write request (%d)", index);
1008 * Handle child resource allocation/removal
1010 static struct resource_list *
1011 acpi_get_rlist(device_t dev, device_t child)
1013 struct acpi_device *ad;
1015 ad = device_get_ivars(child);
1016 return (&ad->ad_rl);
1020 acpi_match_resource_hint(device_t dev, int type, long value)
1022 struct acpi_device *ad = device_get_ivars(dev);
1023 struct resource_list *rl = &ad->ad_rl;
1024 struct resource_list_entry *rle;
1026 STAILQ_FOREACH(rle, rl, link) {
1027 if (rle->type != type)
1029 if (rle->start <= value && rle->end >= value)
1036 * Wire device unit numbers based on resource matches in hints.
1039 acpi_hint_device_unit(device_t acdev, device_t child, const char *name,
1044 int line, matches, unit;
1047 * Iterate over all the hints for the devices with the specified
1048 * name to see if one's resources are a subset of this device.
1051 while (resource_find_dev(&line, name, &unit, "at", NULL) == 0) {
1052 /* Must have an "at" for acpi or isa. */
1053 resource_string_value(name, unit, "at", &s);
1054 if (!(strcmp(s, "acpi0") == 0 || strcmp(s, "acpi") == 0 ||
1055 strcmp(s, "isa0") == 0 || strcmp(s, "isa") == 0))
1059 * Check for matching resources. We must have at least one match.
1060 * Since I/O and memory resources cannot be shared, if we get a
1061 * match on either of those, ignore any mismatches in IRQs or DRQs.
1063 * XXX: We may want to revisit this to be more lenient and wire
1064 * as long as it gets one match.
1067 if (resource_long_value(name, unit, "port", &value) == 0) {
1069 * Floppy drive controllers are notorious for having a
1070 * wide variety of resources not all of which include the
1071 * first port that is specified by the hint (typically
1072 * 0x3f0) (see the comment above fdc_isa_alloc_resources()
1073 * in fdc_isa.c). However, they do all seem to include
1074 * port + 2 (e.g. 0x3f2) so for a floppy device, look for
1075 * 'value + 2' in the port resources instead of the hint
1078 if (strcmp(name, "fdc") == 0)
1080 if (acpi_match_resource_hint(child, SYS_RES_IOPORT, value))
1085 if (resource_long_value(name, unit, "maddr", &value) == 0) {
1086 if (acpi_match_resource_hint(child, SYS_RES_MEMORY, value))
1093 if (resource_long_value(name, unit, "irq", &value) == 0) {
1094 if (acpi_match_resource_hint(child, SYS_RES_IRQ, value))
1099 if (resource_long_value(name, unit, "drq", &value) == 0) {
1100 if (acpi_match_resource_hint(child, SYS_RES_DRQ, value))
1108 /* We have a winner! */
1116 * Fetch the NUMA domain for a device by mapping the value returned by
1117 * _PXM to a NUMA domain. If the device does not have a _PXM method,
1118 * -2 is returned. If any other error occurs, -1 is returned.
1121 acpi_parse_pxm(device_t dev)
1124 #if defined(__i386__) || defined(__amd64__)
1129 handle = acpi_get_handle(dev);
1132 status = acpi_GetInteger(handle, "_PXM", &pxm);
1133 if (ACPI_SUCCESS(status))
1134 return (acpi_map_pxm_to_vm_domainid(pxm));
1135 if (status == AE_NOT_FOUND)
1143 acpi_get_cpus(device_t dev, device_t child, enum cpu_sets op, size_t setsize,
1148 d = acpi_parse_pxm(child);
1150 return (bus_generic_get_cpus(dev, child, op, setsize, cpuset));
1154 if (setsize != sizeof(cpuset_t))
1156 *cpuset = cpuset_domain[d];
1159 error = bus_generic_get_cpus(dev, child, op, setsize, cpuset);
1162 if (setsize != sizeof(cpuset_t))
1164 CPU_AND(cpuset, &cpuset_domain[d]);
1167 return (bus_generic_get_cpus(dev, child, op, setsize, cpuset));
1172 * Fetch the NUMA domain for the given device 'dev'.
1174 * If a device has a _PXM method, map that to a NUMA domain.
1175 * Otherwise, pass the request up to the parent.
1176 * If there's no matching domain or the domain cannot be
1177 * determined, return ENOENT.
1180 acpi_get_domain(device_t dev, device_t child, int *domain)
1184 d = acpi_parse_pxm(child);
1192 /* No _PXM node; go up a level */
1193 return (bus_generic_get_domain(dev, child, domain));
1197 * Pre-allocate/manage all memory and IO resources. Since rman can't handle
1198 * duplicates, we merge any in the sysresource attach routine.
1201 acpi_sysres_alloc(device_t dev)
1203 struct resource *res;
1204 struct resource_list *rl;
1205 struct resource_list_entry *rle;
1211 * Probe/attach any sysresource devices. This would be unnecessary if we
1212 * had multi-pass probe/attach.
1214 if (device_get_children(dev, &children, &child_count) != 0)
1216 for (i = 0; i < child_count; i++) {
1217 if (ACPI_ID_PROBE(dev, children[i], sysres_ids, NULL) <= 0)
1218 device_probe_and_attach(children[i]);
1220 free(children, M_TEMP);
1222 rl = BUS_GET_RESOURCE_LIST(device_get_parent(dev), dev);
1223 STAILQ_FOREACH(rle, rl, link) {
1224 if (rle->res != NULL) {
1225 device_printf(dev, "duplicate resource for %jx\n", rle->start);
1229 /* Only memory and IO resources are valid here. */
1230 switch (rle->type) {
1231 case SYS_RES_IOPORT:
1234 case SYS_RES_MEMORY:
1235 rm = &acpi_rman_mem;
1241 /* Pre-allocate resource and add to our rman pool. */
1242 res = BUS_ALLOC_RESOURCE(device_get_parent(dev), dev, rle->type,
1243 &rle->rid, rle->start, rle->start + rle->count - 1, rle->count, 0);
1245 rman_manage_region(rm, rman_get_start(res), rman_get_end(res));
1247 } else if (bootverbose)
1248 device_printf(dev, "reservation of %jx, %jx (%d) failed\n",
1249 rle->start, rle->count, rle->type);
1255 * Reserve declared resources for devices found during attach once system
1256 * resources have been allocated.
1259 acpi_reserve_resources(device_t dev)
1261 struct resource_list_entry *rle;
1262 struct resource_list *rl;
1263 struct acpi_device *ad;
1264 struct acpi_softc *sc;
1268 sc = device_get_softc(dev);
1269 if (device_get_children(dev, &children, &child_count) != 0)
1271 for (i = 0; i < child_count; i++) {
1272 ad = device_get_ivars(children[i]);
1275 /* Don't reserve system resources. */
1276 if (ACPI_ID_PROBE(dev, children[i], sysres_ids, NULL) <= 0)
1279 STAILQ_FOREACH(rle, rl, link) {
1281 * Don't reserve IRQ resources. There are many sticky things
1282 * to get right otherwise (e.g. IRQs for psm, atkbd, and HPET
1283 * when using legacy routing).
1285 if (rle->type == SYS_RES_IRQ)
1289 * Don't reserve the resource if it is already allocated.
1290 * The acpi_ec(4) driver can allocate its resources early
1291 * if ECDT is present.
1293 if (rle->res != NULL)
1297 * Try to reserve the resource from our parent. If this
1298 * fails because the resource is a system resource, just
1299 * let it be. The resource range is already reserved so
1300 * that other devices will not use it. If the driver
1301 * needs to allocate the resource, then
1302 * acpi_alloc_resource() will sub-alloc from the system
1305 resource_list_reserve(rl, dev, children[i], rle->type, &rle->rid,
1306 rle->start, rle->end, rle->count, 0);
1309 free(children, M_TEMP);
1310 sc->acpi_resources_reserved = 1;
1314 acpi_set_resource(device_t dev, device_t child, int type, int rid,
1315 rman_res_t start, rman_res_t count)
1317 struct acpi_softc *sc = device_get_softc(dev);
1318 struct acpi_device *ad = device_get_ivars(child);
1319 struct resource_list *rl = &ad->ad_rl;
1320 ACPI_DEVICE_INFO *devinfo;
1324 /* Ignore IRQ resources for PCI link devices. */
1325 if (type == SYS_RES_IRQ &&
1326 ACPI_ID_PROBE(dev, child, pcilink_ids, NULL) <= 0)
1330 * Ignore most resources for PCI root bridges. Some BIOSes
1331 * incorrectly enumerate the memory ranges they decode as plain
1332 * memory resources instead of as ResourceProducer ranges. Other
1333 * BIOSes incorrectly list system resource entries for I/O ranges
1334 * under the PCI bridge. Do allow the one known-correct case on
1335 * x86 of a PCI bridge claiming the I/O ports used for PCI config
1338 if (type == SYS_RES_MEMORY || type == SYS_RES_IOPORT) {
1339 if (ACPI_SUCCESS(AcpiGetObjectInfo(ad->ad_handle, &devinfo))) {
1340 if ((devinfo->Flags & ACPI_PCI_ROOT_BRIDGE) != 0) {
1341 #if defined(__i386__) || defined(__amd64__)
1342 allow = (type == SYS_RES_IOPORT && start == CONF1_ADDR_PORT);
1347 AcpiOsFree(devinfo);
1351 AcpiOsFree(devinfo);
1356 /* map with default for now */
1357 if (type == SYS_RES_IRQ)
1358 start = (rman_res_t)acpi_map_intr(child, (u_int)start,
1359 acpi_get_handle(child));
1362 /* If the resource is already allocated, fail. */
1363 if (resource_list_busy(rl, type, rid))
1366 /* If the resource is already reserved, release it. */
1367 if (resource_list_reserved(rl, type, rid))
1368 resource_list_unreserve(rl, dev, child, type, rid);
1370 /* Add the resource. */
1371 end = (start + count - 1);
1372 resource_list_add(rl, type, rid, start, end, count);
1374 /* Don't reserve resources until the system resources are allocated. */
1375 if (!sc->acpi_resources_reserved)
1378 /* Don't reserve system resources. */
1379 if (ACPI_ID_PROBE(dev, child, sysres_ids, NULL) <= 0)
1383 * Don't reserve IRQ resources. There are many sticky things to
1384 * get right otherwise (e.g. IRQs for psm, atkbd, and HPET when
1385 * using legacy routing).
1387 if (type == SYS_RES_IRQ)
1391 * Don't reserve resources for CPU devices. Some of these
1392 * resources need to be allocated as shareable, but reservations
1393 * are always non-shareable.
1395 if (device_get_devclass(child) == devclass_find("cpu"))
1399 * Reserve the resource.
1401 * XXX: Ignores failure for now. Failure here is probably a
1402 * BIOS/firmware bug?
1404 resource_list_reserve(rl, dev, child, type, &rid, start, end, count, 0);
1408 static struct resource *
1409 acpi_alloc_resource(device_t bus, device_t child, int type, int *rid,
1410 rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
1415 struct acpi_device *ad;
1416 struct resource_list_entry *rle;
1417 struct resource_list *rl;
1418 struct resource *res;
1419 int isdefault = RMAN_IS_DEFAULT_RANGE(start, end);
1422 * First attempt at allocating the resource. For direct children,
1423 * use resource_list_alloc() to handle reserved resources. For
1424 * other devices, pass the request up to our parent.
1426 if (bus == device_get_parent(child)) {
1427 ad = device_get_ivars(child);
1431 * Simulate the behavior of the ISA bus for direct children
1432 * devices. That is, if a non-default range is specified for
1433 * a resource that doesn't exist, use bus_set_resource() to
1434 * add the resource before allocating it. Note that these
1435 * resources will not be reserved.
1437 if (!isdefault && resource_list_find(rl, type, *rid) == NULL)
1438 resource_list_add(rl, type, *rid, start, end, count);
1439 res = resource_list_alloc(rl, bus, child, type, rid, start, end, count,
1442 if (res != NULL && type == SYS_RES_IRQ) {
1444 * Since bus_config_intr() takes immediate effect, we cannot
1445 * configure the interrupt associated with a device when we
1446 * parse the resources but have to defer it until a driver
1447 * actually allocates the interrupt via bus_alloc_resource().
1449 * XXX: Should we handle the lookup failing?
1451 if (ACPI_SUCCESS(acpi_lookup_irq_resource(child, *rid, res, &ares)))
1452 acpi_config_intr(child, &ares);
1457 * If this is an allocation of the "default" range for a given
1458 * RID, fetch the exact bounds for this resource from the
1459 * resource list entry to try to allocate the range from the
1460 * system resource regions.
1462 if (res == NULL && isdefault) {
1463 rle = resource_list_find(rl, type, *rid);
1471 res = BUS_ALLOC_RESOURCE(device_get_parent(bus), child, type, rid,
1472 start, end, count, flags);
1475 * If the first attempt failed and this is an allocation of a
1476 * specific range, try to satisfy the request via a suballocation
1477 * from our system resource regions.
1479 if (res == NULL && start + count - 1 == end)
1480 res = acpi_alloc_sysres(child, type, rid, start, end, count, flags);
1485 * Attempt to allocate a specific resource range from the system
1486 * resource ranges. Note that we only handle memory and I/O port
1490 acpi_alloc_sysres(device_t child, int type, int *rid, rman_res_t start,
1491 rman_res_t end, rman_res_t count, u_int flags)
1494 struct resource *res;
1497 case SYS_RES_IOPORT:
1500 case SYS_RES_MEMORY:
1501 rm = &acpi_rman_mem;
1507 KASSERT(start + count - 1 == end, ("wildcard resource range"));
1508 res = rman_reserve_resource(rm, start, end, count, flags & ~RF_ACTIVE,
1513 rman_set_rid(res, *rid);
1515 /* If requested, activate the resource using the parent's method. */
1516 if (flags & RF_ACTIVE)
1517 if (bus_activate_resource(child, type, *rid, res) != 0) {
1518 rman_release_resource(res);
1526 acpi_is_resource_managed(int type, struct resource *r)
1529 /* We only handle memory and IO resources through rman. */
1531 case SYS_RES_IOPORT:
1532 return (rman_is_region_manager(r, &acpi_rman_io));
1533 case SYS_RES_MEMORY:
1534 return (rman_is_region_manager(r, &acpi_rman_mem));
1540 acpi_adjust_resource(device_t bus, device_t child, int type, struct resource *r,
1541 rman_res_t start, rman_res_t end)
1544 if (acpi_is_resource_managed(type, r))
1545 return (rman_adjust_resource(r, start, end));
1546 return (bus_generic_adjust_resource(bus, child, type, r, start, end));
1550 acpi_release_resource(device_t bus, device_t child, int type, int rid,
1556 * If this resource belongs to one of our internal managers,
1557 * deactivate it and release it to the local pool.
1559 if (acpi_is_resource_managed(type, r)) {
1560 if (rman_get_flags(r) & RF_ACTIVE) {
1561 ret = bus_deactivate_resource(child, type, rid, r);
1565 return (rman_release_resource(r));
1568 return (bus_generic_rl_release_resource(bus, child, type, rid, r));
1572 acpi_delete_resource(device_t bus, device_t child, int type, int rid)
1574 struct resource_list *rl;
1576 rl = acpi_get_rlist(bus, child);
1577 if (resource_list_busy(rl, type, rid)) {
1578 device_printf(bus, "delete_resource: Resource still owned by child"
1579 " (type=%d, rid=%d)\n", type, rid);
1582 resource_list_unreserve(rl, bus, child, type, rid);
1583 resource_list_delete(rl, type, rid);
1586 /* Allocate an IO port or memory resource, given its GAS. */
1588 acpi_bus_alloc_gas(device_t dev, int *type, int *rid, ACPI_GENERIC_ADDRESS *gas,
1589 struct resource **res, u_int flags)
1591 int error, res_type;
1594 if (type == NULL || rid == NULL || gas == NULL || res == NULL)
1597 /* We only support memory and IO spaces. */
1598 switch (gas->SpaceId) {
1599 case ACPI_ADR_SPACE_SYSTEM_MEMORY:
1600 res_type = SYS_RES_MEMORY;
1602 case ACPI_ADR_SPACE_SYSTEM_IO:
1603 res_type = SYS_RES_IOPORT;
1606 return (EOPNOTSUPP);
1610 * If the register width is less than 8, assume the BIOS author means
1611 * it is a bit field and just allocate a byte.
1613 if (gas->BitWidth && gas->BitWidth < 8)
1616 /* Validate the address after we're sure we support the space. */
1617 if (gas->Address == 0 || gas->BitWidth == 0)
1620 bus_set_resource(dev, res_type, *rid, gas->Address,
1622 *res = bus_alloc_resource_any(dev, res_type, rid, RF_ACTIVE | flags);
1627 bus_delete_resource(dev, res_type, *rid);
1632 /* Probe _HID and _CID for compatible ISA PNP ids. */
1634 acpi_isa_get_logicalid(device_t dev)
1636 ACPI_DEVICE_INFO *devinfo;
1640 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1642 /* Fetch and validate the HID. */
1643 if ((h = acpi_get_handle(dev)) == NULL ||
1644 ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo)))
1647 pnpid = (devinfo->Valid & ACPI_VALID_HID) != 0 &&
1648 devinfo->HardwareId.Length >= ACPI_EISAID_STRING_SIZE ?
1649 PNP_EISAID(devinfo->HardwareId.String) : 0;
1650 AcpiOsFree(devinfo);
1652 return_VALUE (pnpid);
1656 acpi_isa_get_compatid(device_t dev, uint32_t *cids, int count)
1658 ACPI_DEVICE_INFO *devinfo;
1659 ACPI_PNP_DEVICE_ID *ids;
1664 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1668 /* Fetch and validate the CID */
1669 if ((h = acpi_get_handle(dev)) == NULL ||
1670 ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo)))
1673 if ((devinfo->Valid & ACPI_VALID_CID) == 0) {
1674 AcpiOsFree(devinfo);
1678 if (devinfo->CompatibleIdList.Count < count)
1679 count = devinfo->CompatibleIdList.Count;
1680 ids = devinfo->CompatibleIdList.Ids;
1681 for (i = 0, valid = 0; i < count; i++)
1682 if (ids[i].Length >= ACPI_EISAID_STRING_SIZE &&
1683 strncmp(ids[i].String, "PNP", 3) == 0) {
1684 *pnpid++ = PNP_EISAID(ids[i].String);
1687 AcpiOsFree(devinfo);
1689 return_VALUE (valid);
1693 acpi_device_id_probe(device_t bus, device_t dev, char **ids, char **match)
1700 h = acpi_get_handle(dev);
1701 if (ids == NULL || h == NULL)
1703 t = acpi_get_type(dev);
1704 if (t != ACPI_TYPE_DEVICE && t != ACPI_TYPE_PROCESSOR)
1707 /* Try to match one of the array of IDs with a HID or CID. */
1708 for (i = 0; ids[i] != NULL; i++) {
1709 rv = acpi_MatchHid(h, ids[i]);
1710 if (rv == ACPI_MATCHHID_NOMATCH)
1713 if (match != NULL) {
1716 return ((rv == ACPI_MATCHHID_HID)?
1717 BUS_PROBE_DEFAULT : BUS_PROBE_LOW_PRIORITY);
1723 acpi_device_eval_obj(device_t bus, device_t dev, ACPI_STRING pathname,
1724 ACPI_OBJECT_LIST *parameters, ACPI_BUFFER *ret)
1729 h = ACPI_ROOT_OBJECT;
1730 else if ((h = acpi_get_handle(dev)) == NULL)
1731 return (AE_BAD_PARAMETER);
1732 return (AcpiEvaluateObject(h, pathname, parameters, ret));
1736 acpi_device_pwr_for_sleep(device_t bus, device_t dev, int *dstate)
1738 struct acpi_softc *sc;
1743 handle = acpi_get_handle(dev);
1746 * XXX If we find these devices, don't try to power them down.
1747 * The serial and IRDA ports on my T23 hang the system when
1748 * set to D3 and it appears that such legacy devices may
1749 * need special handling in their drivers.
1751 if (dstate == NULL || handle == NULL ||
1752 acpi_MatchHid(handle, "PNP0500") ||
1753 acpi_MatchHid(handle, "PNP0501") ||
1754 acpi_MatchHid(handle, "PNP0502") ||
1755 acpi_MatchHid(handle, "PNP0510") ||
1756 acpi_MatchHid(handle, "PNP0511"))
1760 * Override next state with the value from _SxD, if present.
1761 * Note illegal _S0D is evaluated because some systems expect this.
1763 sc = device_get_softc(bus);
1764 snprintf(sxd, sizeof(sxd), "_S%dD", sc->acpi_sstate);
1765 status = acpi_GetInteger(handle, sxd, dstate);
1766 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
1767 device_printf(dev, "failed to get %s on %s: %s\n", sxd,
1768 acpi_name(handle), AcpiFormatException(status));
1775 /* Callback arg for our implementation of walking the namespace. */
1776 struct acpi_device_scan_ctx {
1777 acpi_scan_cb_t user_fn;
1783 acpi_device_scan_cb(ACPI_HANDLE h, UINT32 level, void *arg, void **retval)
1785 struct acpi_device_scan_ctx *ctx;
1786 device_t dev, old_dev;
1788 ACPI_OBJECT_TYPE type;
1791 * Skip this device if we think we'll have trouble with it or it is
1792 * the parent where the scan began.
1794 ctx = (struct acpi_device_scan_ctx *)arg;
1795 if (acpi_avoid(h) || h == ctx->parent)
1798 /* If this is not a valid device type (e.g., a method), skip it. */
1799 if (ACPI_FAILURE(AcpiGetType(h, &type)))
1801 if (type != ACPI_TYPE_DEVICE && type != ACPI_TYPE_PROCESSOR &&
1802 type != ACPI_TYPE_THERMAL && type != ACPI_TYPE_POWER)
1806 * Call the user function with the current device. If it is unchanged
1807 * afterwards, return. Otherwise, we update the handle to the new dev.
1809 old_dev = acpi_get_device(h);
1811 status = ctx->user_fn(h, &dev, level, ctx->arg);
1812 if (ACPI_FAILURE(status) || old_dev == dev)
1815 /* Remove the old child and its connection to the handle. */
1816 if (old_dev != NULL)
1817 device_delete_child(device_get_parent(old_dev), old_dev);
1819 /* Recreate the handle association if the user created a device. */
1821 AcpiAttachData(h, acpi_fake_objhandler, dev);
1827 acpi_device_scan_children(device_t bus, device_t dev, int max_depth,
1828 acpi_scan_cb_t user_fn, void *arg)
1831 struct acpi_device_scan_ctx ctx;
1833 if (acpi_disabled("children"))
1837 h = ACPI_ROOT_OBJECT;
1838 else if ((h = acpi_get_handle(dev)) == NULL)
1839 return (AE_BAD_PARAMETER);
1840 ctx.user_fn = user_fn;
1843 return (AcpiWalkNamespace(ACPI_TYPE_ANY, h, max_depth,
1844 acpi_device_scan_cb, NULL, &ctx, NULL));
1848 * Even though ACPI devices are not PCI, we use the PCI approach for setting
1849 * device power states since it's close enough to ACPI.
1852 acpi_set_powerstate(device_t child, int state)
1857 h = acpi_get_handle(child);
1858 if (state < ACPI_STATE_D0 || state > ACPI_D_STATES_MAX)
1863 /* Ignore errors if the power methods aren't present. */
1864 status = acpi_pwr_switch_consumer(h, state);
1865 if (ACPI_SUCCESS(status)) {
1867 device_printf(child, "set ACPI power state D%d on %s\n",
1868 state, acpi_name(h));
1869 } else if (status != AE_NOT_FOUND)
1870 device_printf(child,
1871 "failed to set ACPI power state D%d on %s: %s\n", state,
1872 acpi_name(h), AcpiFormatException(status));
1878 acpi_isa_pnp_probe(device_t bus, device_t child, struct isa_pnp_id *ids)
1880 int result, cid_count, i;
1881 uint32_t lid, cids[8];
1883 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1886 * ISA-style drivers attached to ACPI may persist and
1887 * probe manually if we return ENOENT. We never want
1888 * that to happen, so don't ever return it.
1892 /* Scan the supplied IDs for a match */
1893 lid = acpi_isa_get_logicalid(child);
1894 cid_count = acpi_isa_get_compatid(child, cids, 8);
1895 while (ids && ids->ip_id) {
1896 if (lid == ids->ip_id) {
1900 for (i = 0; i < cid_count; i++) {
1901 if (cids[i] == ids->ip_id) {
1910 if (result == 0 && ids->ip_desc)
1911 device_set_desc(child, ids->ip_desc);
1913 return_VALUE (result);
1917 * Look for a MCFG table. If it is present, use the settings for
1918 * domain (segment) 0 to setup PCI config space access via the memory
1921 * On non-x86 architectures (arm64 for now), this will be done from the
1922 * PCI host bridge driver.
1925 acpi_enable_pcie(void)
1927 #if defined(__i386__) || defined(__amd64__)
1928 ACPI_TABLE_HEADER *hdr;
1929 ACPI_MCFG_ALLOCATION *alloc, *end;
1932 status = AcpiGetTable(ACPI_SIG_MCFG, 1, &hdr);
1933 if (ACPI_FAILURE(status))
1936 end = (ACPI_MCFG_ALLOCATION *)((char *)hdr + hdr->Length);
1937 alloc = (ACPI_MCFG_ALLOCATION *)((ACPI_TABLE_MCFG *)hdr + 1);
1938 while (alloc < end) {
1939 if (alloc->PciSegment == 0) {
1940 pcie_cfgregopen(alloc->Address, alloc->StartBusNumber,
1941 alloc->EndBusNumber);
1950 acpi_platform_osc(device_t dev)
1952 ACPI_HANDLE sb_handle;
1954 uint32_t cap_set[2];
1956 /* 0811B06E-4A27-44F9-8D60-3CBBC22E7B48 */
1957 static uint8_t acpi_platform_uuid[ACPI_UUID_LENGTH] = {
1958 0x6e, 0xb0, 0x11, 0x08, 0x27, 0x4a, 0xf9, 0x44,
1959 0x8d, 0x60, 0x3c, 0xbb, 0xc2, 0x2e, 0x7b, 0x48
1962 if (ACPI_FAILURE(AcpiGetHandle(ACPI_ROOT_OBJECT, "\\_SB_", &sb_handle)))
1965 cap_set[1] = 0x10; /* APEI Support */
1966 status = acpi_EvaluateOSC(sb_handle, acpi_platform_uuid, 1,
1967 nitems(cap_set), cap_set, cap_set, false);
1968 if (ACPI_FAILURE(status)) {
1969 if (status == AE_NOT_FOUND)
1971 device_printf(dev, "_OSC failed: %s\n",
1972 AcpiFormatException(status));
1978 * Scan all of the ACPI namespace and attach child devices.
1980 * We should only expect to find devices in the \_PR, \_TZ, \_SI, and
1981 * \_SB scopes, and \_PR and \_TZ became obsolete in the ACPI 2.0 spec.
1982 * However, in violation of the spec, some systems place their PCI link
1983 * devices in \, so we have to walk the whole namespace. We check the
1984 * type of namespace nodes, so this should be ok.
1987 acpi_probe_children(device_t bus)
1990 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1993 * Scan the namespace and insert placeholders for all the devices that
1994 * we find. We also probe/attach any early devices.
1996 * Note that we use AcpiWalkNamespace rather than AcpiGetDevices because
1997 * we want to create nodes for all devices, not just those that are
1998 * currently present. (This assumes that we don't want to create/remove
1999 * devices as they appear, which might be smarter.)
2001 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "namespace scan\n"));
2002 AcpiWalkNamespace(ACPI_TYPE_ANY, ACPI_ROOT_OBJECT, 100, acpi_probe_child,
2005 /* Pre-allocate resources for our rman from any sysresource devices. */
2006 acpi_sysres_alloc(bus);
2008 /* Reserve resources already allocated to children. */
2009 acpi_reserve_resources(bus);
2011 /* Create any static children by calling device identify methods. */
2012 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "device identify routines\n"));
2013 bus_generic_probe(bus);
2015 /* Probe/attach all children, created statically and from the namespace. */
2016 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "acpi bus_generic_attach\n"));
2017 bus_generic_attach(bus);
2019 /* Attach wake sysctls. */
2020 acpi_wake_sysctl_walk(bus);
2022 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "done attaching children\n"));
2027 * Determine the probe order for a given device.
2030 acpi_probe_order(ACPI_HANDLE handle, int *order)
2032 ACPI_OBJECT_TYPE type;
2036 * 1. I/O port and memory system resource holders
2037 * 2. Clocks and timers (to handle early accesses)
2038 * 3. Embedded controllers (to handle early accesses)
2039 * 4. PCI Link Devices
2041 AcpiGetType(handle, &type);
2042 if (type == ACPI_TYPE_PROCESSOR)
2044 else if (acpi_MatchHid(handle, "PNP0C01") ||
2045 acpi_MatchHid(handle, "PNP0C02"))
2047 else if (acpi_MatchHid(handle, "PNP0100") ||
2048 acpi_MatchHid(handle, "PNP0103") ||
2049 acpi_MatchHid(handle, "PNP0B00"))
2051 else if (acpi_MatchHid(handle, "PNP0C09"))
2053 else if (acpi_MatchHid(handle, "PNP0C0F"))
2058 * Evaluate a child device and determine whether we might attach a device to
2062 acpi_probe_child(ACPI_HANDLE handle, UINT32 level, void *context, void **status)
2064 ACPI_DEVICE_INFO *devinfo;
2065 struct acpi_device *ad;
2066 struct acpi_prw_data prw;
2067 ACPI_OBJECT_TYPE type;
2069 device_t bus, child;
2073 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
2075 if (acpi_disabled("children"))
2076 return_ACPI_STATUS (AE_OK);
2078 /* Skip this device if we think we'll have trouble with it. */
2079 if (acpi_avoid(handle))
2080 return_ACPI_STATUS (AE_OK);
2082 bus = (device_t)context;
2083 if (ACPI_SUCCESS(AcpiGetType(handle, &type))) {
2084 handle_str = acpi_name(handle);
2086 case ACPI_TYPE_DEVICE:
2088 * Since we scan from \, be sure to skip system scope objects.
2089 * \_SB_ and \_TZ_ are defined in ACPICA as devices to work around
2090 * BIOS bugs. For example, \_SB_ is to allow \_SB_._INI to be run
2091 * during the initialization and \_TZ_ is to support Notify() on it.
2093 if (strcmp(handle_str, "\\_SB_") == 0 ||
2094 strcmp(handle_str, "\\_TZ_") == 0)
2096 if (acpi_parse_prw(handle, &prw) == 0)
2097 AcpiSetupGpeForWake(handle, prw.gpe_handle, prw.gpe_bit);
2100 * Ignore devices that do not have a _HID or _CID. They should
2101 * be discovered by other buses (e.g. the PCI bus driver).
2103 if (!acpi_has_hid(handle))
2106 case ACPI_TYPE_PROCESSOR:
2107 case ACPI_TYPE_THERMAL:
2108 case ACPI_TYPE_POWER:
2110 * Create a placeholder device for this node. Sort the
2111 * placeholder so that the probe/attach passes will run
2112 * breadth-first. Orders less than ACPI_DEV_BASE_ORDER
2113 * are reserved for special objects (i.e., system
2116 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "scanning '%s'\n", handle_str));
2117 order = level * 10 + ACPI_DEV_BASE_ORDER;
2118 acpi_probe_order(handle, &order);
2119 child = BUS_ADD_CHILD(bus, order, NULL, -1);
2123 /* Associate the handle with the device_t and vice versa. */
2124 acpi_set_handle(child, handle);
2125 AcpiAttachData(handle, acpi_fake_objhandler, child);
2128 * Check that the device is present. If it's not present,
2129 * leave it disabled (so that we have a device_t attached to
2130 * the handle, but we don't probe it).
2132 * XXX PCI link devices sometimes report "present" but not
2133 * "functional" (i.e. if disabled). Go ahead and probe them
2134 * anyway since we may enable them later.
2136 if (type == ACPI_TYPE_DEVICE && !acpi_DeviceIsPresent(child)) {
2137 /* Never disable PCI link devices. */
2138 if (acpi_MatchHid(handle, "PNP0C0F"))
2141 * Docking stations should remain enabled since the system
2142 * may be undocked at boot.
2144 if (ACPI_SUCCESS(AcpiGetHandle(handle, "_DCK", &h)))
2147 device_disable(child);
2152 * Get the device's resource settings and attach them.
2153 * Note that if the device has _PRS but no _CRS, we need
2154 * to decide when it's appropriate to try to configure the
2155 * device. Ignore the return value here; it's OK for the
2156 * device not to have any resources.
2158 acpi_parse_resources(child, handle, &acpi_res_parse_set, NULL);
2160 ad = device_get_ivars(child);
2161 ad->ad_cls_class = 0xffffff;
2162 if (ACPI_SUCCESS(AcpiGetObjectInfo(handle, &devinfo))) {
2163 if ((devinfo->Valid & ACPI_VALID_CLS) != 0 &&
2164 devinfo->ClassCode.Length >= ACPI_PCICLS_STRING_SIZE) {
2165 ad->ad_cls_class = strtoul(devinfo->ClassCode.String,
2168 AcpiOsFree(devinfo);
2174 return_ACPI_STATUS (AE_OK);
2178 * AcpiAttachData() requires an object handler but never uses it. This is a
2179 * placeholder object handler so we can store a device_t in an ACPI_HANDLE.
2182 acpi_fake_objhandler(ACPI_HANDLE h, void *data)
2187 acpi_shutdown_final(void *arg, int howto)
2189 struct acpi_softc *sc = (struct acpi_softc *)arg;
2194 * XXX Shutdown code should only run on the BSP (cpuid 0).
2195 * Some chipsets do not power off the system correctly if called from
2198 if ((howto & RB_POWEROFF) != 0) {
2199 status = AcpiEnterSleepStatePrep(ACPI_STATE_S5);
2200 if (ACPI_FAILURE(status)) {
2201 device_printf(sc->acpi_dev, "AcpiEnterSleepStatePrep failed - %s\n",
2202 AcpiFormatException(status));
2205 device_printf(sc->acpi_dev, "Powering system off\n");
2206 intr = intr_disable();
2207 status = AcpiEnterSleepState(ACPI_STATE_S5);
2208 if (ACPI_FAILURE(status)) {
2210 device_printf(sc->acpi_dev, "power-off failed - %s\n",
2211 AcpiFormatException(status));
2215 device_printf(sc->acpi_dev, "power-off failed - timeout\n");
2217 } else if ((howto & RB_HALT) == 0 && sc->acpi_handle_reboot) {
2218 /* Reboot using the reset register. */
2219 status = AcpiReset();
2220 if (ACPI_SUCCESS(status)) {
2222 device_printf(sc->acpi_dev, "reset failed - timeout\n");
2223 } else if (status != AE_NOT_EXIST)
2224 device_printf(sc->acpi_dev, "reset failed - %s\n",
2225 AcpiFormatException(status));
2226 } else if (sc->acpi_do_disable && !KERNEL_PANICKED()) {
2228 * Only disable ACPI if the user requested. On some systems, writing
2229 * the disable value to SMI_CMD hangs the system.
2231 device_printf(sc->acpi_dev, "Shutting down\n");
2237 acpi_enable_fixed_events(struct acpi_softc *sc)
2239 static int first_time = 1;
2241 /* Enable and clear fixed events and install handlers. */
2242 if ((AcpiGbl_FADT.Flags & ACPI_FADT_POWER_BUTTON) == 0) {
2243 AcpiClearEvent(ACPI_EVENT_POWER_BUTTON);
2244 AcpiInstallFixedEventHandler(ACPI_EVENT_POWER_BUTTON,
2245 acpi_event_power_button_sleep, sc);
2247 device_printf(sc->acpi_dev, "Power Button (fixed)\n");
2249 if ((AcpiGbl_FADT.Flags & ACPI_FADT_SLEEP_BUTTON) == 0) {
2250 AcpiClearEvent(ACPI_EVENT_SLEEP_BUTTON);
2251 AcpiInstallFixedEventHandler(ACPI_EVENT_SLEEP_BUTTON,
2252 acpi_event_sleep_button_sleep, sc);
2254 device_printf(sc->acpi_dev, "Sleep Button (fixed)\n");
2261 * Returns true if the device is actually present and should
2262 * be attached to. This requires the present, enabled, UI-visible
2263 * and diagnostics-passed bits to be set.
2266 acpi_DeviceIsPresent(device_t dev)
2272 h = acpi_get_handle(dev);
2276 * Certain Treadripper boards always returns 0 for FreeBSD because it
2277 * only returns non-zero for the OS string "Windows 2015". Otherwise it
2278 * will return zero. Force them to always be treated as present.
2279 * Beata versions were worse: they always returned 0.
2281 if (acpi_MatchHid(h, "AMDI0020") || acpi_MatchHid(h, "AMDI0010"))
2284 status = acpi_GetInteger(h, "_STA", &s);
2287 * If no _STA method or if it failed, then assume that
2288 * the device is present.
2290 if (ACPI_FAILURE(status))
2293 return (ACPI_DEVICE_PRESENT(s) ? TRUE : FALSE);
2297 * Returns true if the battery is actually present and inserted.
2300 acpi_BatteryIsPresent(device_t dev)
2306 h = acpi_get_handle(dev);
2309 status = acpi_GetInteger(h, "_STA", &s);
2312 * If no _STA method or if it failed, then assume that
2313 * the device is present.
2315 if (ACPI_FAILURE(status))
2318 return (ACPI_BATTERY_PRESENT(s) ? TRUE : FALSE);
2322 * Returns true if a device has at least one valid device ID.
2325 acpi_has_hid(ACPI_HANDLE h)
2327 ACPI_DEVICE_INFO *devinfo;
2331 ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo)))
2335 if ((devinfo->Valid & ACPI_VALID_HID) != 0)
2337 else if ((devinfo->Valid & ACPI_VALID_CID) != 0)
2338 if (devinfo->CompatibleIdList.Count > 0)
2341 AcpiOsFree(devinfo);
2346 * Match a HID string against a handle
2347 * returns ACPI_MATCHHID_HID if _HID match
2348 * ACPI_MATCHHID_CID if _CID match and not _HID match.
2349 * ACPI_MATCHHID_NOMATCH=0 if no match.
2352 acpi_MatchHid(ACPI_HANDLE h, const char *hid)
2354 ACPI_DEVICE_INFO *devinfo;
2358 if (hid == NULL || h == NULL ||
2359 ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo)))
2360 return (ACPI_MATCHHID_NOMATCH);
2362 ret = ACPI_MATCHHID_NOMATCH;
2363 if ((devinfo->Valid & ACPI_VALID_HID) != 0 &&
2364 strcmp(hid, devinfo->HardwareId.String) == 0)
2365 ret = ACPI_MATCHHID_HID;
2366 else if ((devinfo->Valid & ACPI_VALID_CID) != 0)
2367 for (i = 0; i < devinfo->CompatibleIdList.Count; i++) {
2368 if (strcmp(hid, devinfo->CompatibleIdList.Ids[i].String) == 0) {
2369 ret = ACPI_MATCHHID_CID;
2374 AcpiOsFree(devinfo);
2379 * Return the handle of a named object within our scope, ie. that of (parent)
2380 * or one if its parents.
2383 acpi_GetHandleInScope(ACPI_HANDLE parent, char *path, ACPI_HANDLE *result)
2388 /* Walk back up the tree to the root */
2390 status = AcpiGetHandle(parent, path, &r);
2391 if (ACPI_SUCCESS(status)) {
2395 /* XXX Return error here? */
2396 if (status != AE_NOT_FOUND)
2398 if (ACPI_FAILURE(AcpiGetParent(parent, &r)))
2399 return (AE_NOT_FOUND);
2405 * Allocate a buffer with a preset data size.
2408 acpi_AllocBuffer(int size)
2412 if ((buf = malloc(size + sizeof(*buf), M_ACPIDEV, M_NOWAIT)) == NULL)
2415 buf->Pointer = (void *)(buf + 1);
2420 acpi_SetInteger(ACPI_HANDLE handle, char *path, UINT32 number)
2423 ACPI_OBJECT_LIST args;
2425 arg1.Type = ACPI_TYPE_INTEGER;
2426 arg1.Integer.Value = number;
2428 args.Pointer = &arg1;
2430 return (AcpiEvaluateObject(handle, path, &args, NULL));
2434 * Evaluate a path that should return an integer.
2437 acpi_GetInteger(ACPI_HANDLE handle, char *path, UINT32 *number)
2444 handle = ACPI_ROOT_OBJECT;
2447 * Assume that what we've been pointed at is an Integer object, or
2448 * a method that will return an Integer.
2450 buf.Pointer = ¶m;
2451 buf.Length = sizeof(param);
2452 status = AcpiEvaluateObject(handle, path, NULL, &buf);
2453 if (ACPI_SUCCESS(status)) {
2454 if (param.Type == ACPI_TYPE_INTEGER)
2455 *number = param.Integer.Value;
2461 * In some applications, a method that's expected to return an Integer
2462 * may instead return a Buffer (probably to simplify some internal
2463 * arithmetic). We'll try to fetch whatever it is, and if it's a Buffer,
2464 * convert it into an Integer as best we can.
2468 if (status == AE_BUFFER_OVERFLOW) {
2469 if ((buf.Pointer = AcpiOsAllocate(buf.Length)) == NULL) {
2470 status = AE_NO_MEMORY;
2472 status = AcpiEvaluateObject(handle, path, NULL, &buf);
2473 if (ACPI_SUCCESS(status))
2474 status = acpi_ConvertBufferToInteger(&buf, number);
2475 AcpiOsFree(buf.Pointer);
2482 acpi_ConvertBufferToInteger(ACPI_BUFFER *bufp, UINT32 *number)
2488 p = (ACPI_OBJECT *)bufp->Pointer;
2489 if (p->Type == ACPI_TYPE_INTEGER) {
2490 *number = p->Integer.Value;
2493 if (p->Type != ACPI_TYPE_BUFFER)
2495 if (p->Buffer.Length > sizeof(int))
2496 return (AE_BAD_DATA);
2499 val = p->Buffer.Pointer;
2500 for (i = 0; i < p->Buffer.Length; i++)
2501 *number += val[i] << (i * 8);
2506 * Iterate over the elements of an a package object, calling the supplied
2507 * function for each element.
2509 * XXX possible enhancement might be to abort traversal on error.
2512 acpi_ForeachPackageObject(ACPI_OBJECT *pkg,
2513 void (*func)(ACPI_OBJECT *comp, void *arg), void *arg)
2518 if (pkg == NULL || pkg->Type != ACPI_TYPE_PACKAGE)
2519 return (AE_BAD_PARAMETER);
2521 /* Iterate over components */
2523 comp = pkg->Package.Elements;
2524 for (; i < pkg->Package.Count; i++, comp++)
2531 * Find the (index)th resource object in a set.
2534 acpi_FindIndexedResource(ACPI_BUFFER *buf, int index, ACPI_RESOURCE **resp)
2539 rp = (ACPI_RESOURCE *)buf->Pointer;
2543 if (rp > (ACPI_RESOURCE *)((u_int8_t *)buf->Pointer + buf->Length))
2544 return (AE_BAD_PARAMETER);
2546 /* Check for terminator */
2547 if (rp->Type == ACPI_RESOURCE_TYPE_END_TAG || rp->Length == 0)
2548 return (AE_NOT_FOUND);
2549 rp = ACPI_NEXT_RESOURCE(rp);
2558 * Append an ACPI_RESOURCE to an ACPI_BUFFER.
2560 * Given a pointer to an ACPI_RESOURCE structure, expand the ACPI_BUFFER
2561 * provided to contain it. If the ACPI_BUFFER is empty, allocate a sensible
2562 * backing block. If the ACPI_RESOURCE is NULL, return an empty set of
2565 #define ACPI_INITIAL_RESOURCE_BUFFER_SIZE 512
2568 acpi_AppendBufferResource(ACPI_BUFFER *buf, ACPI_RESOURCE *res)
2573 /* Initialise the buffer if necessary. */
2574 if (buf->Pointer == NULL) {
2575 buf->Length = ACPI_INITIAL_RESOURCE_BUFFER_SIZE;
2576 if ((buf->Pointer = AcpiOsAllocate(buf->Length)) == NULL)
2577 return (AE_NO_MEMORY);
2578 rp = (ACPI_RESOURCE *)buf->Pointer;
2579 rp->Type = ACPI_RESOURCE_TYPE_END_TAG;
2580 rp->Length = ACPI_RS_SIZE_MIN;
2586 * Scan the current buffer looking for the terminator.
2587 * This will either find the terminator or hit the end
2588 * of the buffer and return an error.
2590 rp = (ACPI_RESOURCE *)buf->Pointer;
2592 /* Range check, don't go outside the buffer */
2593 if (rp >= (ACPI_RESOURCE *)((u_int8_t *)buf->Pointer + buf->Length))
2594 return (AE_BAD_PARAMETER);
2595 if (rp->Type == ACPI_RESOURCE_TYPE_END_TAG || rp->Length == 0)
2597 rp = ACPI_NEXT_RESOURCE(rp);
2601 * Check the size of the buffer and expand if required.
2604 * size of existing resources before terminator +
2605 * size of new resource and header +
2606 * size of terminator.
2608 * Note that this loop should really only run once, unless
2609 * for some reason we are stuffing a *really* huge resource.
2611 while ((((u_int8_t *)rp - (u_int8_t *)buf->Pointer) +
2612 res->Length + ACPI_RS_SIZE_NO_DATA +
2613 ACPI_RS_SIZE_MIN) >= buf->Length) {
2614 if ((newp = AcpiOsAllocate(buf->Length * 2)) == NULL)
2615 return (AE_NO_MEMORY);
2616 bcopy(buf->Pointer, newp, buf->Length);
2617 rp = (ACPI_RESOURCE *)((u_int8_t *)newp +
2618 ((u_int8_t *)rp - (u_int8_t *)buf->Pointer));
2619 AcpiOsFree(buf->Pointer);
2620 buf->Pointer = newp;
2621 buf->Length += buf->Length;
2624 /* Insert the new resource. */
2625 bcopy(res, rp, res->Length + ACPI_RS_SIZE_NO_DATA);
2627 /* And add the terminator. */
2628 rp = ACPI_NEXT_RESOURCE(rp);
2629 rp->Type = ACPI_RESOURCE_TYPE_END_TAG;
2630 rp->Length = ACPI_RS_SIZE_MIN;
2636 acpi_DSMQuery(ACPI_HANDLE h, uint8_t *uuid, int revision)
2639 * ACPI spec 9.1.1 defines this.
2641 * "Arg2: Function Index Represents a specific function whose meaning is
2642 * specific to the UUID and Revision ID. Function indices should start
2643 * with 1. Function number zero is a query function (see the special
2644 * return code defined below)."
2650 if (!ACPI_SUCCESS(acpi_EvaluateDSM(h, uuid, revision, 0, NULL, &buf))) {
2651 ACPI_INFO(("Failed to enumerate DSM functions\n"));
2655 obj = (ACPI_OBJECT *)buf.Pointer;
2656 KASSERT(obj, ("Object not allowed to be NULL\n"));
2659 * From ACPI 6.2 spec 9.1.1:
2660 * If Function Index = 0, a Buffer containing a function index bitfield.
2661 * Otherwise, the return value and type depends on the UUID and revision
2664 switch (obj->Type) {
2665 case ACPI_TYPE_BUFFER:
2666 ret = *(uint8_t *)obj->Buffer.Pointer;
2668 case ACPI_TYPE_INTEGER:
2669 ACPI_BIOS_WARNING((AE_INFO,
2670 "Possibly buggy BIOS with ACPI_TYPE_INTEGER for function enumeration\n"));
2671 ret = obj->Integer.Value & 0xFF;
2674 ACPI_WARNING((AE_INFO, "Unexpected return type %u\n", obj->Type));
2682 * DSM may return multiple types depending on the function. It is therefore
2683 * unsafe to use the typed evaluation. It is highly recommended that the caller
2684 * check the type of the returned object.
2687 acpi_EvaluateDSM(ACPI_HANDLE handle, uint8_t *uuid, int revision,
2688 uint64_t function, union acpi_object *package, ACPI_BUFFER *out_buf)
2691 ACPI_OBJECT_LIST arglist;
2695 if (out_buf == NULL)
2696 return (AE_NO_MEMORY);
2698 arg[0].Type = ACPI_TYPE_BUFFER;
2699 arg[0].Buffer.Length = ACPI_UUID_LENGTH;
2700 arg[0].Buffer.Pointer = uuid;
2701 arg[1].Type = ACPI_TYPE_INTEGER;
2702 arg[1].Integer.Value = revision;
2703 arg[2].Type = ACPI_TYPE_INTEGER;
2704 arg[2].Integer.Value = function;
2708 arg[3].Type = ACPI_TYPE_PACKAGE;
2709 arg[3].Package.Count = 0;
2710 arg[3].Package.Elements = NULL;
2713 arglist.Pointer = arg;
2716 buf.Length = ACPI_ALLOCATE_BUFFER;
2717 status = AcpiEvaluateObject(handle, "_DSM", &arglist, &buf);
2718 if (ACPI_FAILURE(status))
2721 KASSERT(ACPI_SUCCESS(status), ("Unexpected status"));
2728 acpi_EvaluateOSC(ACPI_HANDLE handle, uint8_t *uuid, int revision, int count,
2729 uint32_t *caps_in, uint32_t *caps_out, bool query)
2731 ACPI_OBJECT arg[4], *ret;
2732 ACPI_OBJECT_LIST arglist;
2736 arglist.Pointer = arg;
2738 arg[0].Type = ACPI_TYPE_BUFFER;
2739 arg[0].Buffer.Length = ACPI_UUID_LENGTH;
2740 arg[0].Buffer.Pointer = uuid;
2741 arg[1].Type = ACPI_TYPE_INTEGER;
2742 arg[1].Integer.Value = revision;
2743 arg[2].Type = ACPI_TYPE_INTEGER;
2744 arg[2].Integer.Value = count;
2745 arg[3].Type = ACPI_TYPE_BUFFER;
2746 arg[3].Buffer.Length = count * sizeof(*caps_in);
2747 arg[3].Buffer.Pointer = (uint8_t *)caps_in;
2748 caps_in[0] = query ? 1 : 0;
2750 buf.Length = ACPI_ALLOCATE_BUFFER;
2751 status = AcpiEvaluateObjectTyped(handle, "_OSC", &arglist, &buf,
2753 if (ACPI_FAILURE(status))
2755 if (caps_out != NULL) {
2757 if (ret->Buffer.Length != count * sizeof(*caps_out)) {
2758 AcpiOsFree(buf.Pointer);
2759 return (AE_BUFFER_OVERFLOW);
2761 bcopy(ret->Buffer.Pointer, caps_out, ret->Buffer.Length);
2763 AcpiOsFree(buf.Pointer);
2768 * Set interrupt model.
2771 acpi_SetIntrModel(int model)
2774 return (acpi_SetInteger(ACPI_ROOT_OBJECT, "_PIC", model));
2778 * Walk subtables of a table and call a callback routine for each
2779 * subtable. The caller should provide the first subtable and a
2780 * pointer to the end of the table. This can be used to walk tables
2781 * such as MADT and SRAT that use subtable entries.
2784 acpi_walk_subtables(void *first, void *end, acpi_subtable_handler *handler,
2787 ACPI_SUBTABLE_HEADER *entry;
2789 for (entry = first; (void *)entry < end; ) {
2790 /* Avoid an infinite loop if we hit a bogus entry. */
2791 if (entry->Length < sizeof(ACPI_SUBTABLE_HEADER))
2794 handler(entry, arg);
2795 entry = ACPI_ADD_PTR(ACPI_SUBTABLE_HEADER, entry, entry->Length);
2800 * DEPRECATED. This interface has serious deficiencies and will be
2803 * Immediately enter the sleep state. In the old model, acpiconf(8) ran
2804 * rc.suspend and rc.resume so we don't have to notify devd(8) to do this.
2807 acpi_SetSleepState(struct acpi_softc *sc, int state)
2812 device_printf(sc->acpi_dev,
2813 "warning: acpi_SetSleepState() deprecated, need to update your software\n");
2816 return (acpi_EnterSleepState(sc, state));
2819 #if defined(__amd64__) || defined(__i386__)
2821 acpi_sleep_force_task(void *context)
2823 struct acpi_softc *sc = (struct acpi_softc *)context;
2825 if (ACPI_FAILURE(acpi_EnterSleepState(sc, sc->acpi_next_sstate)))
2826 device_printf(sc->acpi_dev, "force sleep state S%d failed\n",
2827 sc->acpi_next_sstate);
2831 acpi_sleep_force(void *arg)
2833 struct acpi_softc *sc = (struct acpi_softc *)arg;
2835 device_printf(sc->acpi_dev,
2836 "suspend request timed out, forcing sleep now\n");
2838 * XXX Suspending from callout causes freezes in DEVICE_SUSPEND().
2839 * Suspend from acpi_task thread instead.
2841 if (ACPI_FAILURE(AcpiOsExecute(OSL_NOTIFY_HANDLER,
2842 acpi_sleep_force_task, sc)))
2843 device_printf(sc->acpi_dev, "AcpiOsExecute() for sleeping failed\n");
2848 * Request that the system enter the given suspend state. All /dev/apm
2849 * devices and devd(8) will be notified. Userland then has a chance to
2850 * save state and acknowledge the request. The system sleeps once all
2854 acpi_ReqSleepState(struct acpi_softc *sc, int state)
2856 #if defined(__amd64__) || defined(__i386__)
2857 struct apm_clone_data *clone;
2860 if (state < ACPI_STATE_S1 || state > ACPI_S_STATES_MAX)
2862 if (!acpi_sleep_states[state])
2863 return (EOPNOTSUPP);
2866 * If a reboot/shutdown/suspend request is already in progress or
2867 * suspend is blocked due to an upcoming shutdown, just return.
2869 if (rebooting || sc->acpi_next_sstate != 0 || suspend_blocked) {
2873 /* Wait until sleep is enabled. */
2874 while (sc->acpi_sleep_disabled) {
2880 sc->acpi_next_sstate = state;
2882 /* S5 (soft-off) should be entered directly with no waiting. */
2883 if (state == ACPI_STATE_S5) {
2885 status = acpi_EnterSleepState(sc, state);
2886 return (ACPI_SUCCESS(status) ? 0 : ENXIO);
2889 /* Record the pending state and notify all apm devices. */
2890 STAILQ_FOREACH(clone, &sc->apm_cdevs, entries) {
2891 clone->notify_status = APM_EV_NONE;
2892 if ((clone->flags & ACPI_EVF_DEVD) == 0) {
2893 selwakeuppri(&clone->sel_read, PZERO);
2894 KNOTE_LOCKED(&clone->sel_read.si_note, 0);
2898 /* If devd(8) is not running, immediately enter the sleep state. */
2899 if (!devctl_process_running()) {
2901 status = acpi_EnterSleepState(sc, state);
2902 return (ACPI_SUCCESS(status) ? 0 : ENXIO);
2906 * Set a timeout to fire if userland doesn't ack the suspend request
2907 * in time. This way we still eventually go to sleep if we were
2908 * overheating or running low on battery, even if userland is hung.
2909 * We cancel this timeout once all userland acks are in or the
2910 * suspend request is aborted.
2912 callout_reset(&sc->susp_force_to, 10 * hz, acpi_sleep_force, sc);
2915 /* Now notify devd(8) also. */
2916 acpi_UserNotify("Suspend", ACPI_ROOT_OBJECT, state);
2920 /* This platform does not support acpi suspend/resume. */
2921 return (EOPNOTSUPP);
2926 * Acknowledge (or reject) a pending sleep state. The caller has
2927 * prepared for suspend and is now ready for it to proceed. If the
2928 * error argument is non-zero, it indicates suspend should be cancelled
2929 * and gives an errno value describing why. Once all votes are in,
2930 * we suspend the system.
2933 acpi_AckSleepState(struct apm_clone_data *clone, int error)
2935 #if defined(__amd64__) || defined(__i386__)
2936 struct acpi_softc *sc;
2939 /* If no pending sleep state, return an error. */
2941 sc = clone->acpi_sc;
2942 if (sc->acpi_next_sstate == 0) {
2947 /* Caller wants to abort suspend process. */
2949 sc->acpi_next_sstate = 0;
2950 callout_stop(&sc->susp_force_to);
2951 device_printf(sc->acpi_dev,
2952 "listener on %s cancelled the pending suspend\n",
2953 devtoname(clone->cdev));
2959 * Mark this device as acking the suspend request. Then, walk through
2960 * all devices, seeing if they agree yet. We only count devices that
2961 * are writable since read-only devices couldn't ack the request.
2964 clone->notify_status = APM_EV_ACKED;
2965 STAILQ_FOREACH(clone, &sc->apm_cdevs, entries) {
2966 if ((clone->flags & ACPI_EVF_WRITE) != 0 &&
2967 clone->notify_status != APM_EV_ACKED) {
2973 /* If all devices have voted "yes", we will suspend now. */
2975 callout_stop(&sc->susp_force_to);
2979 if (ACPI_FAILURE(acpi_EnterSleepState(sc, sc->acpi_next_sstate)))
2984 /* This platform does not support acpi suspend/resume. */
2985 return (EOPNOTSUPP);
2990 acpi_sleep_enable(void *arg)
2992 struct acpi_softc *sc = (struct acpi_softc *)arg;
2994 ACPI_LOCK_ASSERT(acpi);
2996 /* Reschedule if the system is not fully up and running. */
2997 if (!AcpiGbl_SystemAwakeAndRunning) {
2998 callout_schedule(&acpi_sleep_timer, hz * ACPI_MINIMUM_AWAKETIME);
3002 sc->acpi_sleep_disabled = FALSE;
3006 acpi_sleep_disable(struct acpi_softc *sc)
3010 /* Fail if the system is not fully up and running. */
3011 if (!AcpiGbl_SystemAwakeAndRunning)
3015 status = sc->acpi_sleep_disabled ? AE_ERROR : AE_OK;
3016 sc->acpi_sleep_disabled = TRUE;
3022 enum acpi_sleep_state {
3025 ACPI_SS_DEV_SUSPEND,
3031 * Enter the desired system sleep state.
3033 * Currently we support S1-S5 but S4 is only S4BIOS
3036 acpi_EnterSleepState(struct acpi_softc *sc, int state)
3040 ACPI_EVENT_STATUS power_button_status;
3041 enum acpi_sleep_state slp_state;
3044 ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, state);
3046 if (state < ACPI_STATE_S1 || state > ACPI_S_STATES_MAX)
3047 return_ACPI_STATUS (AE_BAD_PARAMETER);
3048 if (!acpi_sleep_states[state]) {
3049 device_printf(sc->acpi_dev, "Sleep state S%d not supported by BIOS\n",
3051 return (AE_SUPPORT);
3054 /* Re-entry once we're suspending is not allowed. */
3055 status = acpi_sleep_disable(sc);
3056 if (ACPI_FAILURE(status)) {
3057 device_printf(sc->acpi_dev,
3058 "suspend request ignored (not ready yet)\n");
3062 if (state == ACPI_STATE_S5) {
3064 * Shut down cleanly and power off. This will call us back through the
3065 * shutdown handlers.
3067 shutdown_nice(RB_POWEROFF);
3068 return_ACPI_STATUS (AE_OK);
3071 EVENTHANDLER_INVOKE(power_suspend_early);
3073 EVENTHANDLER_INVOKE(power_suspend);
3075 #ifdef EARLY_AP_STARTUP
3076 MPASS(mp_ncpus == 1 || smp_started);
3077 thread_lock(curthread);
3078 sched_bind(curthread, 0);
3079 thread_unlock(curthread);
3082 thread_lock(curthread);
3083 sched_bind(curthread, 0);
3084 thread_unlock(curthread);
3089 * Be sure to hold Giant across DEVICE_SUSPEND/RESUME since non-MPSAFE
3090 * drivers need this.
3094 slp_state = ACPI_SS_NONE;
3096 sc->acpi_sstate = state;
3098 /* Enable any GPEs as appropriate and requested by the user. */
3099 acpi_wake_prep_walk(state);
3100 slp_state = ACPI_SS_GPE_SET;
3103 * Inform all devices that we are going to sleep. If at least one
3104 * device fails, DEVICE_SUSPEND() automatically resumes the tree.
3106 * XXX Note that a better two-pass approach with a 'veto' pass
3107 * followed by a "real thing" pass would be better, but the current
3108 * bus interface does not provide for this.
3110 if (DEVICE_SUSPEND(root_bus) != 0) {
3111 device_printf(sc->acpi_dev, "device_suspend failed\n");
3114 slp_state = ACPI_SS_DEV_SUSPEND;
3116 status = AcpiEnterSleepStatePrep(state);
3117 if (ACPI_FAILURE(status)) {
3118 device_printf(sc->acpi_dev, "AcpiEnterSleepStatePrep failed - %s\n",
3119 AcpiFormatException(status));
3122 slp_state = ACPI_SS_SLP_PREP;
3124 if (sc->acpi_sleep_delay > 0)
3125 DELAY(sc->acpi_sleep_delay * 1000000);
3128 intr = intr_disable();
3129 if (state != ACPI_STATE_S1) {
3130 sleep_result = acpi_sleep_machdep(sc, state);
3131 acpi_wakeup_machdep(sc, state, sleep_result, 0);
3134 * XXX According to ACPI specification SCI_EN bit should be restored
3135 * by ACPI platform (BIOS, firmware) to its pre-sleep state.
3136 * Unfortunately some BIOSes fail to do that and that leads to
3137 * unexpected and serious consequences during wake up like a system
3138 * getting stuck in SMI handlers.
3139 * This hack is picked up from Linux, which claims that it follows
3142 if (sleep_result == 1 && state != ACPI_STATE_S4)
3143 AcpiWriteBitRegister(ACPI_BITREG_SCI_ENABLE, ACPI_ENABLE_EVENT);
3145 if (sleep_result == 1 && state == ACPI_STATE_S3) {
3147 * Prevent mis-interpretation of the wakeup by power button
3148 * as a request for power off.
3149 * Ideally we should post an appropriate wakeup event,
3150 * perhaps using acpi_event_power_button_wake or alike.
3152 * Clearing of power button status after wakeup is mandated
3153 * by ACPI specification in section "Fixed Power Button".
3155 * XXX As of ACPICA 20121114 AcpiGetEventStatus provides
3156 * status as 0/1 corressponding to inactive/active despite
3157 * its type being ACPI_EVENT_STATUS. In other words,
3158 * we should not test for ACPI_EVENT_FLAG_SET for time being.
3160 if (ACPI_SUCCESS(AcpiGetEventStatus(ACPI_EVENT_POWER_BUTTON,
3161 &power_button_status)) && power_button_status != 0) {
3162 AcpiClearEvent(ACPI_EVENT_POWER_BUTTON);
3163 device_printf(sc->acpi_dev,
3164 "cleared fixed power button status\n");
3170 /* call acpi_wakeup_machdep() again with interrupt enabled */
3171 acpi_wakeup_machdep(sc, state, sleep_result, 1);
3173 AcpiLeaveSleepStatePrep(state);
3175 if (sleep_result == -1)
3178 /* Re-enable ACPI hardware on wakeup from sleep state 4. */
3179 if (state == ACPI_STATE_S4)
3182 status = AcpiEnterSleepState(state);
3184 AcpiLeaveSleepStatePrep(state);
3185 if (ACPI_FAILURE(status)) {
3186 device_printf(sc->acpi_dev, "AcpiEnterSleepState failed - %s\n",
3187 AcpiFormatException(status));
3191 slp_state = ACPI_SS_SLEPT;
3194 * Back out state according to how far along we got in the suspend
3195 * process. This handles both the error and success cases.
3198 if (slp_state >= ACPI_SS_SLP_PREP)
3200 if (slp_state >= ACPI_SS_GPE_SET) {
3201 acpi_wake_prep_walk(state);
3202 sc->acpi_sstate = ACPI_STATE_S0;
3204 if (slp_state >= ACPI_SS_DEV_SUSPEND)
3205 DEVICE_RESUME(root_bus);
3206 if (slp_state >= ACPI_SS_SLP_PREP)
3207 AcpiLeaveSleepState(state);
3208 if (slp_state >= ACPI_SS_SLEPT) {
3209 #if defined(__i386__) || defined(__amd64__)
3210 /* NB: we are still using ACPI timecounter at this point. */
3213 acpi_resync_clock(sc);
3214 acpi_enable_fixed_events(sc);
3216 sc->acpi_next_sstate = 0;
3220 #ifdef EARLY_AP_STARTUP
3221 thread_lock(curthread);
3222 sched_unbind(curthread);
3223 thread_unlock(curthread);
3226 thread_lock(curthread);
3227 sched_unbind(curthread);
3228 thread_unlock(curthread);
3234 EVENTHANDLER_INVOKE(power_resume);
3236 /* Allow another sleep request after a while. */
3237 callout_schedule(&acpi_sleep_timer, hz * ACPI_MINIMUM_AWAKETIME);
3239 /* Run /etc/rc.resume after we are back. */
3240 if (devctl_process_running())
3241 acpi_UserNotify("Resume", ACPI_ROOT_OBJECT, state);
3243 return_ACPI_STATUS (status);
3247 acpi_resync_clock(struct acpi_softc *sc)
3251 * Warm up timecounter again and reset system clock.
3253 (void)timecounter->tc_get_timecount(timecounter);
3254 inittodr(time_second + sc->acpi_sleep_delay);
3257 /* Enable or disable the device's wake GPE. */
3259 acpi_wake_set_enable(device_t dev, int enable)
3261 struct acpi_prw_data prw;
3265 /* Make sure the device supports waking the system and get the GPE. */
3266 if (acpi_parse_prw(acpi_get_handle(dev), &prw) != 0)
3269 flags = acpi_get_flags(dev);
3271 status = AcpiSetGpeWakeMask(prw.gpe_handle, prw.gpe_bit,
3273 if (ACPI_FAILURE(status)) {
3274 device_printf(dev, "enable wake failed\n");
3277 acpi_set_flags(dev, flags | ACPI_FLAG_WAKE_ENABLED);
3279 status = AcpiSetGpeWakeMask(prw.gpe_handle, prw.gpe_bit,
3281 if (ACPI_FAILURE(status)) {
3282 device_printf(dev, "disable wake failed\n");
3285 acpi_set_flags(dev, flags & ~ACPI_FLAG_WAKE_ENABLED);
3292 acpi_wake_sleep_prep(ACPI_HANDLE handle, int sstate)
3294 struct acpi_prw_data prw;
3297 /* Check that this is a wake-capable device and get its GPE. */
3298 if (acpi_parse_prw(handle, &prw) != 0)
3300 dev = acpi_get_device(handle);
3303 * The destination sleep state must be less than (i.e., higher power)
3304 * or equal to the value specified by _PRW. If this GPE cannot be
3305 * enabled for the next sleep state, then disable it. If it can and
3306 * the user requested it be enabled, turn on any required power resources
3309 if (sstate > prw.lowest_wake) {
3310 AcpiSetGpeWakeMask(prw.gpe_handle, prw.gpe_bit, ACPI_GPE_DISABLE);
3312 device_printf(dev, "wake_prep disabled wake for %s (S%d)\n",
3313 acpi_name(handle), sstate);
3314 } else if (dev && (acpi_get_flags(dev) & ACPI_FLAG_WAKE_ENABLED) != 0) {
3315 acpi_pwr_wake_enable(handle, 1);
3316 acpi_SetInteger(handle, "_PSW", 1);
3318 device_printf(dev, "wake_prep enabled for %s (S%d)\n",
3319 acpi_name(handle), sstate);
3326 acpi_wake_run_prep(ACPI_HANDLE handle, int sstate)
3328 struct acpi_prw_data prw;
3332 * Check that this is a wake-capable device and get its GPE. Return
3333 * now if the user didn't enable this device for wake.
3335 if (acpi_parse_prw(handle, &prw) != 0)
3337 dev = acpi_get_device(handle);
3338 if (dev == NULL || (acpi_get_flags(dev) & ACPI_FLAG_WAKE_ENABLED) == 0)
3342 * If this GPE couldn't be enabled for the previous sleep state, it was
3343 * disabled before going to sleep so re-enable it. If it was enabled,
3344 * clear _PSW and turn off any power resources it used.
3346 if (sstate > prw.lowest_wake) {
3347 AcpiSetGpeWakeMask(prw.gpe_handle, prw.gpe_bit, ACPI_GPE_ENABLE);
3349 device_printf(dev, "run_prep re-enabled %s\n", acpi_name(handle));
3351 acpi_SetInteger(handle, "_PSW", 0);
3352 acpi_pwr_wake_enable(handle, 0);
3354 device_printf(dev, "run_prep cleaned up for %s\n",
3362 acpi_wake_prep(ACPI_HANDLE handle, UINT32 level, void *context, void **status)
3366 /* If suspending, run the sleep prep function, otherwise wake. */
3367 sstate = *(int *)context;
3368 if (AcpiGbl_SystemAwakeAndRunning)
3369 acpi_wake_sleep_prep(handle, sstate);
3371 acpi_wake_run_prep(handle, sstate);
3375 /* Walk the tree rooted at acpi0 to prep devices for suspend/resume. */
3377 acpi_wake_prep_walk(int sstate)
3379 ACPI_HANDLE sb_handle;
3381 if (ACPI_SUCCESS(AcpiGetHandle(ACPI_ROOT_OBJECT, "\\_SB_", &sb_handle)))
3382 AcpiWalkNamespace(ACPI_TYPE_DEVICE, sb_handle, 100,
3383 acpi_wake_prep, NULL, &sstate, NULL);
3387 /* Walk the tree rooted at acpi0 to attach per-device wake sysctls. */
3389 acpi_wake_sysctl_walk(device_t dev)
3391 int error, i, numdevs;
3396 error = device_get_children(dev, &devlist, &numdevs);
3397 if (error != 0 || numdevs == 0) {
3399 free(devlist, M_TEMP);
3402 for (i = 0; i < numdevs; i++) {
3404 acpi_wake_sysctl_walk(child);
3405 if (!device_is_attached(child))
3407 status = AcpiEvaluateObject(acpi_get_handle(child), "_PRW", NULL, NULL);
3408 if (ACPI_SUCCESS(status)) {
3409 SYSCTL_ADD_PROC(device_get_sysctl_ctx(child),
3410 SYSCTL_CHILDREN(device_get_sysctl_tree(child)), OID_AUTO,
3411 "wake", CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_NEEDGIANT, child, 0,
3412 acpi_wake_set_sysctl, "I", "Device set to wake the system");
3415 free(devlist, M_TEMP);
3420 /* Enable or disable wake from userland. */
3422 acpi_wake_set_sysctl(SYSCTL_HANDLER_ARGS)
3427 dev = (device_t)arg1;
3428 enable = (acpi_get_flags(dev) & ACPI_FLAG_WAKE_ENABLED) ? 1 : 0;
3430 error = sysctl_handle_int(oidp, &enable, 0, req);
3431 if (error != 0 || req->newptr == NULL)
3433 if (enable != 0 && enable != 1)
3436 return (acpi_wake_set_enable(dev, enable));
3439 /* Parse a device's _PRW into a structure. */
3441 acpi_parse_prw(ACPI_HANDLE h, struct acpi_prw_data *prw)
3444 ACPI_BUFFER prw_buffer;
3445 ACPI_OBJECT *res, *res2;
3446 int error, i, power_count;
3448 if (h == NULL || prw == NULL)
3452 * The _PRW object (7.2.9) is only required for devices that have the
3453 * ability to wake the system from a sleeping state.
3456 prw_buffer.Pointer = NULL;
3457 prw_buffer.Length = ACPI_ALLOCATE_BUFFER;
3458 status = AcpiEvaluateObject(h, "_PRW", NULL, &prw_buffer);
3459 if (ACPI_FAILURE(status))
3461 res = (ACPI_OBJECT *)prw_buffer.Pointer;
3464 if (!ACPI_PKG_VALID(res, 2))
3468 * Element 1 of the _PRW object:
3469 * The lowest power system sleeping state that can be entered while still
3470 * providing wake functionality. The sleeping state being entered must
3471 * be less than (i.e., higher power) or equal to this value.
3473 if (acpi_PkgInt32(res, 1, &prw->lowest_wake) != 0)
3477 * Element 0 of the _PRW object:
3479 switch (res->Package.Elements[0].Type) {
3480 case ACPI_TYPE_INTEGER:
3482 * If the data type of this package element is numeric, then this
3483 * _PRW package element is the bit index in the GPEx_EN, in the
3484 * GPE blocks described in the FADT, of the enable bit that is
3485 * enabled for the wake event.
3487 prw->gpe_handle = NULL;
3488 prw->gpe_bit = res->Package.Elements[0].Integer.Value;
3491 case ACPI_TYPE_PACKAGE:
3493 * If the data type of this package element is a package, then this
3494 * _PRW package element is itself a package containing two
3495 * elements. The first is an object reference to the GPE Block
3496 * device that contains the GPE that will be triggered by the wake
3497 * event. The second element is numeric and it contains the bit
3498 * index in the GPEx_EN, in the GPE Block referenced by the
3499 * first element in the package, of the enable bit that is enabled for
3502 * For example, if this field is a package then it is of the form:
3503 * Package() {\_SB.PCI0.ISA.GPE, 2}
3505 res2 = &res->Package.Elements[0];
3506 if (!ACPI_PKG_VALID(res2, 2))
3508 prw->gpe_handle = acpi_GetReference(NULL, &res2->Package.Elements[0]);
3509 if (prw->gpe_handle == NULL)
3511 if (acpi_PkgInt32(res2, 1, &prw->gpe_bit) != 0)
3519 /* Elements 2 to N of the _PRW object are power resources. */
3520 power_count = res->Package.Count - 2;
3521 if (power_count > ACPI_PRW_MAX_POWERRES) {
3522 printf("ACPI device %s has too many power resources\n", acpi_name(h));
3525 prw->power_res_count = power_count;
3526 for (i = 0; i < power_count; i++)
3527 prw->power_res[i] = res->Package.Elements[i];
3530 if (prw_buffer.Pointer != NULL)
3531 AcpiOsFree(prw_buffer.Pointer);
3536 * ACPI Event Handlers
3539 /* System Event Handlers (registered by EVENTHANDLER_REGISTER) */
3542 acpi_system_eventhandler_sleep(void *arg, int state)
3544 struct acpi_softc *sc = (struct acpi_softc *)arg;
3547 ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, state);
3549 /* Check if button action is disabled or unknown. */
3550 if (state == ACPI_STATE_UNKNOWN)
3553 /* Request that the system prepare to enter the given suspend state. */
3554 ret = acpi_ReqSleepState(sc, state);
3556 device_printf(sc->acpi_dev,
3557 "request to enter state S%d failed (err %d)\n", state, ret);
3563 acpi_system_eventhandler_wakeup(void *arg, int state)
3566 ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, state);
3568 /* Currently, nothing to do for wakeup. */
3574 * ACPICA Event Handlers (FixedEvent, also called from button notify handler)
3577 acpi_invoke_sleep_eventhandler(void *context)
3580 EVENTHANDLER_INVOKE(acpi_sleep_event, *(int *)context);
3584 acpi_invoke_wake_eventhandler(void *context)
3587 EVENTHANDLER_INVOKE(acpi_wakeup_event, *(int *)context);
3591 acpi_event_power_button_sleep(void *context)
3593 struct acpi_softc *sc = (struct acpi_softc *)context;
3595 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
3597 if (ACPI_FAILURE(AcpiOsExecute(OSL_NOTIFY_HANDLER,
3598 acpi_invoke_sleep_eventhandler, &sc->acpi_power_button_sx)))
3599 return_VALUE (ACPI_INTERRUPT_NOT_HANDLED);
3600 return_VALUE (ACPI_INTERRUPT_HANDLED);
3604 acpi_event_power_button_wake(void *context)
3606 struct acpi_softc *sc = (struct acpi_softc *)context;
3608 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
3610 if (ACPI_FAILURE(AcpiOsExecute(OSL_NOTIFY_HANDLER,
3611 acpi_invoke_wake_eventhandler, &sc->acpi_power_button_sx)))
3612 return_VALUE (ACPI_INTERRUPT_NOT_HANDLED);
3613 return_VALUE (ACPI_INTERRUPT_HANDLED);
3617 acpi_event_sleep_button_sleep(void *context)
3619 struct acpi_softc *sc = (struct acpi_softc *)context;
3621 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
3623 if (ACPI_FAILURE(AcpiOsExecute(OSL_NOTIFY_HANDLER,
3624 acpi_invoke_sleep_eventhandler, &sc->acpi_sleep_button_sx)))
3625 return_VALUE (ACPI_INTERRUPT_NOT_HANDLED);
3626 return_VALUE (ACPI_INTERRUPT_HANDLED);
3630 acpi_event_sleep_button_wake(void *context)
3632 struct acpi_softc *sc = (struct acpi_softc *)context;
3634 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
3636 if (ACPI_FAILURE(AcpiOsExecute(OSL_NOTIFY_HANDLER,
3637 acpi_invoke_wake_eventhandler, &sc->acpi_sleep_button_sx)))
3638 return_VALUE (ACPI_INTERRUPT_NOT_HANDLED);
3639 return_VALUE (ACPI_INTERRUPT_HANDLED);
3643 * XXX This static buffer is suboptimal. There is no locking so only
3644 * use this for single-threaded callers.
3647 acpi_name(ACPI_HANDLE handle)
3650 static char data[256];
3652 buf.Length = sizeof(data);
3655 if (handle && ACPI_SUCCESS(AcpiGetName(handle, ACPI_FULL_PATHNAME, &buf)))
3657 return ("(unknown)");
3661 * Debugging/bug-avoidance. Avoid trying to fetch info on various
3662 * parts of the namespace.
3665 acpi_avoid(ACPI_HANDLE handle)
3667 char *cp, *env, *np;
3670 np = acpi_name(handle);
3673 if ((env = kern_getenv("debug.acpi.avoid")) == NULL)
3676 /* Scan the avoid list checking for a match */
3679 while (*cp != 0 && isspace(*cp))
3684 while (cp[len] != 0 && !isspace(cp[len]))
3686 if (!strncmp(cp, np, len)) {
3698 * Debugging/bug-avoidance. Disable ACPI subsystem components.
3701 acpi_disabled(char *subsys)
3706 if ((env = kern_getenv("debug.acpi.disabled")) == NULL)
3708 if (strcmp(env, "all") == 0) {
3713 /* Scan the disable list, checking for a match. */
3716 while (*cp != '\0' && isspace(*cp))
3721 while (cp[len] != '\0' && !isspace(cp[len]))
3723 if (strncmp(cp, subsys, len) == 0) {
3735 acpi_lookup(void *arg, const char *name, device_t *dev)
3743 * Allow any handle name that is specified as an absolute path and
3744 * starts with '\'. We could restrict this to \_SB and friends,
3745 * but see acpi_probe_children() for notes on why we scan the entire
3746 * namespace for devices.
3748 * XXX: The pathname argument to AcpiGetHandle() should be fixed to
3751 if (name[0] != '\\')
3753 if (ACPI_FAILURE(AcpiGetHandle(ACPI_ROOT_OBJECT, __DECONST(char *, name),
3756 *dev = acpi_get_device(handle);
3760 * Control interface.
3762 * We multiplex ioctls for all participating ACPI devices here. Individual
3763 * drivers wanting to be accessible via /dev/acpi should use the
3764 * register/deregister interface to make their handlers visible.
3766 struct acpi_ioctl_hook
3768 TAILQ_ENTRY(acpi_ioctl_hook) link;
3774 static TAILQ_HEAD(,acpi_ioctl_hook) acpi_ioctl_hooks;
3775 static int acpi_ioctl_hooks_initted;
3778 acpi_register_ioctl(u_long cmd, acpi_ioctl_fn fn, void *arg)
3780 struct acpi_ioctl_hook *hp;
3782 if ((hp = malloc(sizeof(*hp), M_ACPIDEV, M_NOWAIT)) == NULL)
3789 if (acpi_ioctl_hooks_initted == 0) {
3790 TAILQ_INIT(&acpi_ioctl_hooks);
3791 acpi_ioctl_hooks_initted = 1;
3793 TAILQ_INSERT_TAIL(&acpi_ioctl_hooks, hp, link);
3800 acpi_deregister_ioctl(u_long cmd, acpi_ioctl_fn fn)
3802 struct acpi_ioctl_hook *hp;
3805 TAILQ_FOREACH(hp, &acpi_ioctl_hooks, link)
3806 if (hp->cmd == cmd && hp->fn == fn)
3810 TAILQ_REMOVE(&acpi_ioctl_hooks, hp, link);
3811 free(hp, M_ACPIDEV);
3817 acpiopen(struct cdev *dev, int flag, int fmt, struct thread *td)
3823 acpiclose(struct cdev *dev, int flag, int fmt, struct thread *td)
3829 acpiioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag, struct thread *td)
3831 struct acpi_softc *sc;
3832 struct acpi_ioctl_hook *hp;
3840 * Scan the list of registered ioctls, looking for handlers.
3843 if (acpi_ioctl_hooks_initted)
3844 TAILQ_FOREACH(hp, &acpi_ioctl_hooks, link) {
3850 return (hp->fn(cmd, addr, hp->arg));
3853 * Core ioctls are not permitted for non-writable user.
3854 * Currently, other ioctls just fetch information.
3855 * Not changing system behavior.
3857 if ((flag & FWRITE) == 0)
3860 /* Core system ioctls. */
3862 case ACPIIO_REQSLPSTATE:
3863 state = *(int *)addr;
3864 if (state != ACPI_STATE_S5)
3865 return (acpi_ReqSleepState(sc, state));
3866 device_printf(sc->acpi_dev, "power off via acpi ioctl not supported\n");
3869 case ACPIIO_ACKSLPSTATE:
3870 error = *(int *)addr;
3871 error = acpi_AckSleepState(sc->acpi_clone, error);
3873 case ACPIIO_SETSLPSTATE: /* DEPRECATED */
3874 state = *(int *)addr;
3875 if (state < ACPI_STATE_S0 || state > ACPI_S_STATES_MAX)
3877 if (!acpi_sleep_states[state])
3878 return (EOPNOTSUPP);
3879 if (ACPI_FAILURE(acpi_SetSleepState(sc, state)))
3891 acpi_sname2sstate(const char *sname)
3895 if (toupper(sname[0]) == 'S') {
3896 sstate = sname[1] - '0';
3897 if (sstate >= ACPI_STATE_S0 && sstate <= ACPI_STATE_S5 &&
3900 } else if (strcasecmp(sname, "NONE") == 0)
3901 return (ACPI_STATE_UNKNOWN);
3906 acpi_sstate2sname(int sstate)
3908 static const char *snames[] = { "S0", "S1", "S2", "S3", "S4", "S5" };
3910 if (sstate >= ACPI_STATE_S0 && sstate <= ACPI_STATE_S5)
3911 return (snames[sstate]);
3912 else if (sstate == ACPI_STATE_UNKNOWN)
3918 acpi_supported_sleep_state_sysctl(SYSCTL_HANDLER_ARGS)
3924 sbuf_new(&sb, NULL, 32, SBUF_AUTOEXTEND);
3925 for (state = ACPI_STATE_S1; state < ACPI_S_STATE_COUNT; state++)
3926 if (acpi_sleep_states[state])
3927 sbuf_printf(&sb, "%s ", acpi_sstate2sname(state));
3930 error = sysctl_handle_string(oidp, sbuf_data(&sb), sbuf_len(&sb), req);
3936 acpi_sleep_state_sysctl(SYSCTL_HANDLER_ARGS)
3938 char sleep_state[10];
3939 int error, new_state, old_state;
3941 old_state = *(int *)oidp->oid_arg1;
3942 strlcpy(sleep_state, acpi_sstate2sname(old_state), sizeof(sleep_state));
3943 error = sysctl_handle_string(oidp, sleep_state, sizeof(sleep_state), req);
3944 if (error == 0 && req->newptr != NULL) {
3945 new_state = acpi_sname2sstate(sleep_state);
3946 if (new_state < ACPI_STATE_S1)
3948 if (new_state < ACPI_S_STATE_COUNT && !acpi_sleep_states[new_state])
3949 return (EOPNOTSUPP);
3950 if (new_state != old_state)
3951 *(int *)oidp->oid_arg1 = new_state;
3956 /* Inform devctl(4) when we receive a Notify. */
3958 acpi_UserNotify(const char *subsystem, ACPI_HANDLE h, uint8_t notify)
3960 char notify_buf[16];
3961 ACPI_BUFFER handle_buf;
3964 if (subsystem == NULL)
3967 handle_buf.Pointer = NULL;
3968 handle_buf.Length = ACPI_ALLOCATE_BUFFER;
3969 status = AcpiNsHandleToPathname(h, &handle_buf, FALSE);
3970 if (ACPI_FAILURE(status))
3972 snprintf(notify_buf, sizeof(notify_buf), "notify=0x%02x", notify);
3973 devctl_notify("ACPI", subsystem, handle_buf.Pointer, notify_buf);
3974 AcpiOsFree(handle_buf.Pointer);
3979 * Support for parsing debug options from the kernel environment.
3981 * Bits may be set in the AcpiDbgLayer and AcpiDbgLevel debug registers
3982 * by specifying the names of the bits in the debug.acpi.layer and
3983 * debug.acpi.level environment variables. Bits may be unset by
3984 * prefixing the bit name with !.
3992 static struct debugtag dbg_layer[] = {
3993 {"ACPI_UTILITIES", ACPI_UTILITIES},
3994 {"ACPI_HARDWARE", ACPI_HARDWARE},
3995 {"ACPI_EVENTS", ACPI_EVENTS},
3996 {"ACPI_TABLES", ACPI_TABLES},
3997 {"ACPI_NAMESPACE", ACPI_NAMESPACE},
3998 {"ACPI_PARSER", ACPI_PARSER},
3999 {"ACPI_DISPATCHER", ACPI_DISPATCHER},
4000 {"ACPI_EXECUTER", ACPI_EXECUTER},
4001 {"ACPI_RESOURCES", ACPI_RESOURCES},
4002 {"ACPI_CA_DEBUGGER", ACPI_CA_DEBUGGER},
4003 {"ACPI_OS_SERVICES", ACPI_OS_SERVICES},
4004 {"ACPI_CA_DISASSEMBLER", ACPI_CA_DISASSEMBLER},
4005 {"ACPI_ALL_COMPONENTS", ACPI_ALL_COMPONENTS},
4007 {"ACPI_AC_ADAPTER", ACPI_AC_ADAPTER},
4008 {"ACPI_BATTERY", ACPI_BATTERY},
4009 {"ACPI_BUS", ACPI_BUS},
4010 {"ACPI_BUTTON", ACPI_BUTTON},
4011 {"ACPI_EC", ACPI_EC},
4012 {"ACPI_FAN", ACPI_FAN},
4013 {"ACPI_POWERRES", ACPI_POWERRES},
4014 {"ACPI_PROCESSOR", ACPI_PROCESSOR},
4015 {"ACPI_THERMAL", ACPI_THERMAL},
4016 {"ACPI_TIMER", ACPI_TIMER},
4017 {"ACPI_ALL_DRIVERS", ACPI_ALL_DRIVERS},
4021 static struct debugtag dbg_level[] = {
4022 {"ACPI_LV_INIT", ACPI_LV_INIT},
4023 {"ACPI_LV_DEBUG_OBJECT", ACPI_LV_DEBUG_OBJECT},
4024 {"ACPI_LV_INFO", ACPI_LV_INFO},
4025 {"ACPI_LV_REPAIR", ACPI_LV_REPAIR},
4026 {"ACPI_LV_ALL_EXCEPTIONS", ACPI_LV_ALL_EXCEPTIONS},
4028 /* Trace verbosity level 1 [Standard Trace Level] */
4029 {"ACPI_LV_INIT_NAMES", ACPI_LV_INIT_NAMES},
4030 {"ACPI_LV_PARSE", ACPI_LV_PARSE},
4031 {"ACPI_LV_LOAD", ACPI_LV_LOAD},
4032 {"ACPI_LV_DISPATCH", ACPI_LV_DISPATCH},
4033 {"ACPI_LV_EXEC", ACPI_LV_EXEC},
4034 {"ACPI_LV_NAMES", ACPI_LV_NAMES},
4035 {"ACPI_LV_OPREGION", ACPI_LV_OPREGION},
4036 {"ACPI_LV_BFIELD", ACPI_LV_BFIELD},
4037 {"ACPI_LV_TABLES", ACPI_LV_TABLES},
4038 {"ACPI_LV_VALUES", ACPI_LV_VALUES},
4039 {"ACPI_LV_OBJECTS", ACPI_LV_OBJECTS},
4040 {"ACPI_LV_RESOURCES", ACPI_LV_RESOURCES},
4041 {"ACPI_LV_USER_REQUESTS", ACPI_LV_USER_REQUESTS},
4042 {"ACPI_LV_PACKAGE", ACPI_LV_PACKAGE},
4043 {"ACPI_LV_VERBOSITY1", ACPI_LV_VERBOSITY1},
4045 /* Trace verbosity level 2 [Function tracing and memory allocation] */
4046 {"ACPI_LV_ALLOCATIONS", ACPI_LV_ALLOCATIONS},
4047 {"ACPI_LV_FUNCTIONS", ACPI_LV_FUNCTIONS},
4048 {"ACPI_LV_OPTIMIZATIONS", ACPI_LV_OPTIMIZATIONS},
4049 {"ACPI_LV_VERBOSITY2", ACPI_LV_VERBOSITY2},
4050 {"ACPI_LV_ALL", ACPI_LV_ALL},
4052 /* Trace verbosity level 3 [Threading, I/O, and Interrupts] */
4053 {"ACPI_LV_MUTEX", ACPI_LV_MUTEX},
4054 {"ACPI_LV_THREADS", ACPI_LV_THREADS},
4055 {"ACPI_LV_IO", ACPI_LV_IO},
4056 {"ACPI_LV_INTERRUPTS", ACPI_LV_INTERRUPTS},
4057 {"ACPI_LV_VERBOSITY3", ACPI_LV_VERBOSITY3},
4059 /* Exceptionally verbose output -- also used in the global "DebugLevel" */
4060 {"ACPI_LV_AML_DISASSEMBLE", ACPI_LV_AML_DISASSEMBLE},
4061 {"ACPI_LV_VERBOSE_INFO", ACPI_LV_VERBOSE_INFO},
4062 {"ACPI_LV_FULL_TABLES", ACPI_LV_FULL_TABLES},
4063 {"ACPI_LV_EVENTS", ACPI_LV_EVENTS},
4064 {"ACPI_LV_VERBOSE", ACPI_LV_VERBOSE},
4069 acpi_parse_debug(char *cp, struct debugtag *tag, UINT32 *flag)
4081 while (*ep && !isspace(*ep))
4092 for (i = 0; tag[i].name != NULL; i++) {
4093 if (!strncmp(cp, tag[i].name, l)) {
4095 *flag |= tag[i].value;
4097 *flag &= ~tag[i].value;
4105 acpi_set_debugging(void *junk)
4107 char *layer, *level;
4114 layer = kern_getenv("debug.acpi.layer");
4115 level = kern_getenv("debug.acpi.level");
4116 if (layer == NULL && level == NULL)
4119 printf("ACPI set debug");
4120 if (layer != NULL) {
4121 if (strcmp("NONE", layer) != 0)
4122 printf(" layer '%s'", layer);
4123 acpi_parse_debug(layer, &dbg_layer[0], &AcpiDbgLayer);
4126 if (level != NULL) {
4127 if (strcmp("NONE", level) != 0)
4128 printf(" level '%s'", level);
4129 acpi_parse_debug(level, &dbg_level[0], &AcpiDbgLevel);
4135 SYSINIT(acpi_debugging, SI_SUB_TUNABLES, SI_ORDER_ANY, acpi_set_debugging,
4139 acpi_debug_sysctl(SYSCTL_HANDLER_ARGS)
4142 struct debugtag *tag;
4146 if (sbuf_new(&sb, NULL, 128, SBUF_AUTOEXTEND) == NULL)
4148 if (strcmp(oidp->oid_arg1, "debug.acpi.layer") == 0) {
4149 tag = &dbg_layer[0];
4150 dbg = &AcpiDbgLayer;
4152 tag = &dbg_level[0];
4153 dbg = &AcpiDbgLevel;
4156 /* Get old values if this is a get request. */
4157 ACPI_SERIAL_BEGIN(acpi);
4159 sbuf_cpy(&sb, "NONE");
4160 } else if (req->newptr == NULL) {
4161 for (; tag->name != NULL; tag++) {
4162 if ((*dbg & tag->value) == tag->value)
4163 sbuf_printf(&sb, "%s ", tag->name);
4168 strlcpy(temp, sbuf_data(&sb), sizeof(temp));
4171 error = sysctl_handle_string(oidp, temp, sizeof(temp), req);
4173 /* Check for error or no change */
4174 if (error == 0 && req->newptr != NULL) {
4176 kern_setenv((char *)oidp->oid_arg1, temp);
4177 acpi_set_debugging(NULL);
4179 ACPI_SERIAL_END(acpi);
4184 SYSCTL_PROC(_debug_acpi, OID_AUTO, layer,
4185 CTLFLAG_RW | CTLTYPE_STRING | CTLFLAG_NEEDGIANT, "debug.acpi.layer", 0,
4186 acpi_debug_sysctl, "A",
4188 SYSCTL_PROC(_debug_acpi, OID_AUTO, level,
4189 CTLFLAG_RW | CTLTYPE_STRING | CTLFLAG_NEEDGIANT, "debug.acpi.level", 0,
4190 acpi_debug_sysctl, "A",
4192 #endif /* ACPI_DEBUG */
4195 acpi_debug_objects_sysctl(SYSCTL_HANDLER_ARGS)
4200 old = acpi_debug_objects;
4201 error = sysctl_handle_int(oidp, &acpi_debug_objects, 0, req);
4202 if (error != 0 || req->newptr == NULL)
4204 if (old == acpi_debug_objects || (old && acpi_debug_objects))
4207 ACPI_SERIAL_BEGIN(acpi);
4208 AcpiGbl_EnableAmlDebugObject = acpi_debug_objects ? TRUE : FALSE;
4209 ACPI_SERIAL_END(acpi);
4215 acpi_parse_interfaces(char *str, struct acpi_interface *iface)
4222 while (isspace(*p) || *p == ',')
4227 p = strdup(p, M_TEMP);
4228 for (i = 0; i < len; i++)
4233 if (isspace(p[i]) || p[i] == '\0')
4236 i += strlen(p + i) + 1;
4243 iface->data = malloc(sizeof(*iface->data) * j, M_TEMP, M_WAITOK);
4247 if (isspace(p[i]) || p[i] == '\0')
4250 iface->data[j] = p + i;
4251 i += strlen(p + i) + 1;
4259 acpi_free_interfaces(struct acpi_interface *iface)
4262 free(iface->data[0], M_TEMP);
4263 free(iface->data, M_TEMP);
4267 acpi_reset_interfaces(device_t dev)
4269 struct acpi_interface list;
4273 if (acpi_parse_interfaces(acpi_install_interface, &list) > 0) {
4274 for (i = 0; i < list.num; i++) {
4275 status = AcpiInstallInterface(list.data[i]);
4276 if (ACPI_FAILURE(status))
4278 "failed to install _OSI(\"%s\"): %s\n",
4279 list.data[i], AcpiFormatException(status));
4280 else if (bootverbose)
4281 device_printf(dev, "installed _OSI(\"%s\")\n",
4284 acpi_free_interfaces(&list);
4286 if (acpi_parse_interfaces(acpi_remove_interface, &list) > 0) {
4287 for (i = 0; i < list.num; i++) {
4288 status = AcpiRemoveInterface(list.data[i]);
4289 if (ACPI_FAILURE(status))
4291 "failed to remove _OSI(\"%s\"): %s\n",
4292 list.data[i], AcpiFormatException(status));
4293 else if (bootverbose)
4294 device_printf(dev, "removed _OSI(\"%s\")\n",
4297 acpi_free_interfaces(&list);
4302 acpi_pm_func(u_long cmd, void *arg, ...)
4304 int state, acpi_state;
4306 struct acpi_softc *sc;
4311 case POWER_CMD_SUSPEND:
4312 sc = (struct acpi_softc *)arg;
4319 state = va_arg(ap, int);
4323 case POWER_SLEEP_STATE_STANDBY:
4324 acpi_state = sc->acpi_standby_sx;
4326 case POWER_SLEEP_STATE_SUSPEND:
4327 acpi_state = sc->acpi_suspend_sx;
4329 case POWER_SLEEP_STATE_HIBERNATE:
4330 acpi_state = ACPI_STATE_S4;
4337 if (ACPI_FAILURE(acpi_EnterSleepState(sc, acpi_state)))
4350 acpi_pm_register(void *arg)
4352 if (!cold || resource_disabled("acpi", 0))
4355 power_pm_register(POWER_PM_TYPE_ACPI, acpi_pm_func, NULL);
4358 SYSINIT(power, SI_SUB_KLD, SI_ORDER_ANY, acpi_pm_register, NULL);