sys: Some whitespace cleanup.
[dragonfly.git] / sys / dev / acpica / acpi.c
blob15a611fd2eddf65c842979aa28c283d4681c10d7
1 /*-
2 * Copyright (c) 2000 Takanori Watanabe <takawata@jp.kfreebsd.org>
3 * Copyright (c) 2000 Mitsuru IWASAKI <iwasaki@jp.kfreebsd.org>
4 * Copyright (c) 2000, 2001 Michael Smith
5 * Copyright (c) 2000 BSDi
6 * All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
29 * $FreeBSD: src/sys/dev/acpica/acpi.c,v 1.243.2.4.4.1 2009/04/15 03:14:26 kensmith Exp $
32 #include "opt_acpi.h"
33 #include <sys/param.h>
34 #include <sys/kernel.h>
35 #include <sys/proc.h>
36 #include <sys/fcntl.h>
37 #include <sys/malloc.h>
38 #include <sys/module.h>
39 #include <sys/bus.h>
40 #include <sys/conf.h>
41 #include <sys/reboot.h>
42 #include <sys/sysctl.h>
43 #include <sys/ctype.h>
44 #include <sys/linker.h>
45 #include <sys/power.h>
46 #include <sys/sbuf.h>
47 #include <sys/device.h>
48 #include <sys/spinlock.h>
49 #include <sys/spinlock2.h>
50 #include <sys/uuid.h>
52 #include <sys/rman.h>
53 #include <bus/isa/isavar.h>
54 #include <bus/isa/pnpvar.h>
56 #include "acpi.h"
57 #include <dev/acpica/acpivar.h>
58 #include <dev/acpica/acpiio.h>
59 #include <dev/acpica/acpiio_mcall.h>
60 #include "achware.h"
61 #include "acnamesp.h"
62 #include "acglobal.h"
64 #include "pci_if.h"
65 #include <bus/pci/pci_cfgreg.h>
66 #include <bus/pci/pcivar.h>
67 #include <bus/pci/pci_private.h>
69 #include <vm/vm_param.h>
71 MALLOC_DEFINE(M_ACPIDEV, "acpidev", "ACPI devices");
73 /* Hooks for the ACPICA debugging infrastructure */
74 #define _COMPONENT ACPI_BUS
75 ACPI_MODULE_NAME("ACPI");
77 static d_open_t acpiopen;
78 static d_close_t acpiclose;
79 static d_ioctl_t acpiioctl;
81 static struct dev_ops acpi_ops = {
82 { "acpi", 0, D_MPSAFE },
83 .d_open = acpiopen,
84 .d_close = acpiclose,
85 .d_ioctl = acpiioctl
88 struct acpi_interface {
89 ACPI_STRING *data;
90 int num;
93 /* Global mutex for locking access to the ACPI subsystem. */
94 struct lock acpi_lock;
95 struct lwkt_token acpi_token = LWKT_TOKEN_INITIALIZER(acpi_token);
97 /* Bitmap of device quirks. */
98 int acpi_quirks;
100 static int acpi_modevent(struct module *mod, int event, void *junk);
101 static void acpi_identify(driver_t *driver, device_t parent);
102 static int acpi_probe(device_t dev);
103 static int acpi_attach(device_t dev);
104 static int acpi_suspend(device_t dev);
105 static int acpi_resume(device_t dev);
106 static int acpi_shutdown(device_t dev);
107 static device_t acpi_add_child(device_t bus, device_t parent, int order, const char *name,
108 int unit);
109 static int acpi_print_child(device_t bus, device_t child);
110 static void acpi_probe_nomatch(device_t bus, device_t child);
111 static void acpi_driver_added(device_t dev, driver_t *driver);
112 static int acpi_read_ivar(device_t dev, device_t child, int index,
113 uintptr_t *result);
114 static int acpi_write_ivar(device_t dev, device_t child, int index,
115 uintptr_t value);
116 static struct resource_list *acpi_get_rlist(device_t dev, device_t child);
117 static int acpi_sysres_alloc(device_t dev);
118 static struct resource *acpi_alloc_resource(device_t bus, device_t child,
119 int type, int *rid, u_long start, u_long end,
120 u_long count, u_int flags, int cpuid);
121 static int acpi_release_resource(device_t bus, device_t child, int type,
122 int rid, struct resource *r);
123 static void acpi_delete_resource(device_t bus, device_t child, int type,
124 int rid);
125 static uint32_t acpi_isa_get_logicalid(device_t dev);
126 static int acpi_isa_get_compatid(device_t dev, uint32_t *cids, int count);
127 static char *acpi_device_id_probe(device_t bus, device_t dev, char **ids);
128 static ACPI_STATUS acpi_device_eval_obj(device_t bus, device_t dev,
129 ACPI_STRING pathname, ACPI_OBJECT_LIST *parameters,
130 ACPI_BUFFER *ret);
131 static int acpi_device_pwr_for_sleep(device_t bus, device_t dev,
132 int *dstate);
133 static ACPI_STATUS acpi_device_scan_cb(ACPI_HANDLE h, UINT32 level,
134 void *context, void **retval);
135 static ACPI_STATUS acpi_device_scan_children(device_t bus, device_t dev,
136 int max_depth, acpi_scan_cb_t user_fn, void *arg);
137 static int acpi_set_powerstate_method(device_t bus, device_t child,
138 int state);
139 static int acpi_isa_pnp_probe(device_t bus, device_t child,
140 struct isa_pnp_id *ids);
141 static void acpi_probe_children(device_t bus);
142 static void acpi_probe_order(ACPI_HANDLE handle, int *order);
143 static ACPI_STATUS acpi_probe_child(ACPI_HANDLE handle, UINT32 level,
144 void *context, void **status);
145 static ACPI_STATUS acpi_EnterSleepState(struct acpi_softc *sc, int state);
146 static void acpi_shutdown_final(void *arg, int howto);
147 static void acpi_enable_fixed_events(struct acpi_softc *sc);
148 static int acpi_wake_sleep_prep(ACPI_HANDLE handle, int sstate);
149 static int acpi_wake_run_prep(ACPI_HANDLE handle, int sstate);
150 static int acpi_wake_prep_walk(int sstate);
151 static int acpi_wake_sysctl_walk(device_t dev);
152 #ifdef notyet
153 static int acpi_wake_set_sysctl(SYSCTL_HANDLER_ARGS);
154 #endif
155 static void acpi_system_eventhandler_sleep(void *arg, int state);
156 static void acpi_system_eventhandler_wakeup(void *arg, int state);
157 static int acpi_supported_sleep_state_sysctl(SYSCTL_HANDLER_ARGS);
158 static int acpi_sleep_state_sysctl(SYSCTL_HANDLER_ARGS);
159 static int acpi_debug_objects_sysctl(SYSCTL_HANDLER_ARGS);
160 static int acpi_pm_func(u_long cmd, void *arg, ...);
161 static int acpi_child_location_str_method(device_t acdev, device_t child,
162 char *buf, size_t buflen);
163 static int acpi_child_pnpinfo_str_method(device_t acdev, device_t child,
164 char *buf, size_t buflen);
165 static void acpi_enable_pcie(void);
166 static void acpi_reset_interfaces(device_t dev);
168 static device_method_t acpi_methods[] = {
169 /* Device interface */
170 DEVMETHOD(device_identify, acpi_identify),
171 DEVMETHOD(device_probe, acpi_probe),
172 DEVMETHOD(device_attach, acpi_attach),
173 DEVMETHOD(device_shutdown, acpi_shutdown),
174 DEVMETHOD(device_detach, bus_generic_detach),
175 DEVMETHOD(device_suspend, acpi_suspend),
176 DEVMETHOD(device_resume, acpi_resume),
178 /* Bus interface */
179 DEVMETHOD(bus_add_child, acpi_add_child),
180 DEVMETHOD(bus_print_child, acpi_print_child),
181 DEVMETHOD(bus_probe_nomatch, acpi_probe_nomatch),
182 DEVMETHOD(bus_driver_added, acpi_driver_added),
183 DEVMETHOD(bus_read_ivar, acpi_read_ivar),
184 DEVMETHOD(bus_write_ivar, acpi_write_ivar),
185 DEVMETHOD(bus_get_resource_list, acpi_get_rlist),
186 DEVMETHOD(bus_set_resource, bus_generic_rl_set_resource),
187 DEVMETHOD(bus_get_resource, bus_generic_rl_get_resource),
188 DEVMETHOD(bus_alloc_resource, acpi_alloc_resource),
189 DEVMETHOD(bus_release_resource, acpi_release_resource),
190 DEVMETHOD(bus_delete_resource, acpi_delete_resource),
191 DEVMETHOD(bus_child_pnpinfo_str, acpi_child_pnpinfo_str_method),
192 DEVMETHOD(bus_child_location_str, acpi_child_location_str_method),
193 DEVMETHOD(bus_activate_resource, bus_generic_activate_resource),
194 DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource),
195 DEVMETHOD(bus_setup_intr, bus_generic_setup_intr),
196 DEVMETHOD(bus_teardown_intr, bus_generic_teardown_intr),
198 /* ACPI bus */
199 DEVMETHOD(acpi_id_probe, acpi_device_id_probe),
200 DEVMETHOD(acpi_evaluate_object, acpi_device_eval_obj),
201 DEVMETHOD(acpi_pwr_for_sleep, acpi_device_pwr_for_sleep),
202 DEVMETHOD(acpi_scan_children, acpi_device_scan_children),
204 /* PCI emulation */
205 DEVMETHOD(pci_set_powerstate, acpi_set_powerstate_method),
207 /* ISA emulation */
208 DEVMETHOD(isa_pnp_probe, acpi_isa_pnp_probe),
210 DEVMETHOD_END
213 static driver_t acpi_driver = {
214 "acpi",
215 acpi_methods,
216 sizeof(struct acpi_softc),
219 static devclass_t acpi_devclass;
220 DRIVER_MODULE(acpi, nexus, acpi_driver, acpi_devclass, acpi_modevent, NULL);
221 MODULE_VERSION(acpi, 1);
223 ACPI_SERIAL_DECL(acpi, "ACPI serializer");
225 /* Local pools for managing system resources for ACPI child devices. */
226 static struct rman acpi_rman_io, acpi_rman_mem;
228 #define ACPI_MINIMUM_AWAKETIME 5
230 static const char* sleep_state_names[] = {
231 "S0", "S1", "S2", "S3", "S4", "S5", "NONE"};
233 SYSCTL_NODE(_debug, OID_AUTO, acpi, CTLFLAG_RD, NULL, "ACPI debugging");
234 static char acpi_ca_version[12];
235 SYSCTL_STRING(_debug_acpi, OID_AUTO, acpi_ca_version, CTLFLAG_RD,
236 acpi_ca_version, 0, "Version of Intel ACPICA");
239 * Allow overriding _OSI methods.
241 static char acpi_install_interface[256];
242 TUNABLE_STR("hw.acpi.install_interface", acpi_install_interface,
243 sizeof(acpi_install_interface));
244 static char acpi_remove_interface[256];
245 TUNABLE_STR("hw.acpi.remove_interface", acpi_remove_interface,
246 sizeof(acpi_remove_interface));
249 * Use this tunable to disable the control method auto-serialization
250 * mechanism that was added in 20140214 and superseded the previous
251 * AcpiGbl_SerializeAllMethods global.
253 static int acpi_auto_serialize_methods = 1;
254 TUNABLE_INT("hw.acpi.auto_serialize_methods", &acpi_auto_serialize_methods);
256 /* Allow users to dump Debug objects without ACPI debugger. */
257 static int acpi_debug_objects;
258 TUNABLE_INT("debug.acpi.enable_debug_objects", &acpi_debug_objects);
259 SYSCTL_PROC(_debug_acpi, OID_AUTO, enable_debug_objects,
260 CTLFLAG_RW | CTLTYPE_INT, NULL, 0, acpi_debug_objects_sysctl, "I",
261 "Enable Debug objects.");
263 /* Allow ignoring the XSDT. */
264 static int acpi_ignore_xsdt;
265 TUNABLE_INT("debug.acpi.ignore_xsdt", &acpi_ignore_xsdt);
266 SYSCTL_INT(_debug_acpi, OID_AUTO, ignore_xsdt, CTLFLAG_RD,
267 &acpi_ignore_xsdt, 1, "Ignore the XSDT, forcing the use of the RSDT.");
269 /* Allow the interpreter to ignore common mistakes in BIOS. */
270 static int acpi_interpreter_slack = 1;
271 TUNABLE_INT("debug.acpi.interpreter_slack", &acpi_interpreter_slack);
272 SYSCTL_INT(_debug_acpi, OID_AUTO, interpreter_slack, CTLFLAG_RD,
273 &acpi_interpreter_slack, 1, "Turn on interpreter slack mode.");
275 /* Allow preferring 32-bit FADT register addresses over the 64-bit ones. */
276 static int acpi_fadt_addr32;
277 TUNABLE_INT("debug.acpi.fadt_addr32", &acpi_fadt_addr32);
278 SYSCTL_INT(_debug_acpi, OID_AUTO, fadt_addr32, CTLFLAG_RD,
279 &acpi_fadt_addr32, 1,
280 "Prefer 32-bit FADT register addresses over 64-bit ones.");
282 /* Prefer 32-bit FACS table addresses over the 64-bit ones. */
283 static int acpi_facs_addr32 = 1;
284 TUNABLE_INT("debug.acpi.facs_addr32", &acpi_facs_addr32);
285 SYSCTL_INT(_debug_acpi, OID_AUTO, facs_addr32, CTLFLAG_RD,
286 &acpi_facs_addr32, 1,
287 "Prefer 32-bit FACS table addresses over 64-bit ones.");
289 static int acpi_group_module_level_code;
290 TUNABLE_INT("debug.acpi.group_module_level_code", &acpi_group_module_level_code);
291 SYSCTL_INT(_debug_acpi, OID_AUTO, group_module_level_code, CTLFLAG_RD,
292 &acpi_group_module_level_code, 1,
293 "Group module-level code.");
295 /* Power devices off and on in suspend and resume. XXX Remove once tested. */
296 static int acpi_do_powerstate = 1;
297 TUNABLE_INT("debug.acpi.do_powerstate", &acpi_do_powerstate);
298 SYSCTL_INT(_debug_acpi, OID_AUTO, do_powerstate, CTLFLAG_RW,
299 &acpi_do_powerstate, 1, "Turn off devices when suspending.");
301 /* Allow users to override quirks. */
302 TUNABLE_INT("debug.acpi.quirks", &acpi_quirks);
304 /* Allow to call ACPI methods from userland. */
305 static int acpi_allow_mcall;
306 TUNABLE_INT("debug.acpi.allow_method_calls", &acpi_allow_mcall);
308 static int acpi_susp_bounce;
309 SYSCTL_INT(_debug_acpi, OID_AUTO, suspend_bounce, CTLFLAG_RW,
310 &acpi_susp_bounce, 0, "Don't actually suspend, just test devices.");
313 * ACPI can only be loaded as a module by the loader; activating it after
314 * system bootstrap time is not useful, and can be fatal to the system.
315 * It also cannot be unloaded, since the entire system bus heirarchy hangs
316 * off it.
318 static int
319 acpi_modevent(struct module *mod, int event, void *junk)
321 switch (event) {
322 case MOD_LOAD:
323 if (!cold) {
324 kprintf("The ACPI driver cannot be loaded after boot.\n");
325 return (EPERM);
327 break;
328 case MOD_UNLOAD:
329 if (!cold && power_pm_get_type() == POWER_PM_TYPE_ACPI)
330 return (EBUSY);
331 break;
332 default:
333 break;
335 return (0);
339 * Perform early initialization.
341 ACPI_STATUS
342 acpi_Startup(void)
344 static int started = 0;
345 ACPI_STATUS status;
346 int val;
348 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
350 /* Only run the startup code once. The MADT driver also calls this. */
351 if (started)
352 return_VALUE (AE_OK);
353 started = 1;
355 /* Start up the ACPICA subsystem. */
356 status = AcpiInitializeSubsystem();
357 if (ACPI_FAILURE(status)) {
358 kprintf("ACPI: Subsystem initialization failed: %s\n",
359 AcpiFormatException(status));
360 return_VALUE (status);
364 * Pre-allocate space for RSDT/XSDT and DSDT tables and allow resizing
365 * if more tables exist.
367 if (ACPI_FAILURE(status = AcpiInitializeTables(NULL, 2, TRUE))) {
368 kprintf("ACPI: Table initialization failed: %s\n",
369 AcpiFormatException(status));
370 return_VALUE (status);
373 /* Set up any quirks we have for this system. */
374 if (acpi_quirks == ACPI_Q_OK)
375 acpi_table_quirks(&acpi_quirks);
377 /* If the user manually set the disabled hint to 0, force-enable ACPI. */
378 if (resource_int_value("acpi", 0, "disabled", &val) == 0 && val == 0)
379 acpi_quirks &= ~ACPI_Q_BROKEN;
380 if (acpi_quirks & ACPI_Q_BROKEN) {
381 kprintf("ACPI disabled by blacklist. Contact your BIOS vendor.\n");
382 status = AE_SUPPORT;
385 return_VALUE (status);
389 * Detect ACPI, perform early initialisation
391 static void
392 acpi_identify(driver_t *driver, device_t parent)
394 device_t child;
396 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
398 if (!cold)
399 return_VOID;
401 /* Check that we haven't been disabled with a hint. */
402 if (resource_disabled("acpi", 0))
403 return_VOID;
405 /* Make sure we're not being doubly invoked. */
406 if (device_find_child(parent, "acpi", 0) != NULL)
407 return_VOID;
409 ksnprintf(acpi_ca_version, sizeof(acpi_ca_version), "%x", ACPI_CA_VERSION);
411 /* Initialize root tables. */
412 if (ACPI_FAILURE(acpi_Startup())) {
413 kprintf("ACPI: Try disabling either ACPI or apic support.\n");
414 return_VOID;
417 /* Attach the actual ACPI device. */
418 if ((child = BUS_ADD_CHILD(parent, parent, 10, "acpi", 0)) == NULL) {
419 device_printf(parent, "device_identify failed\n");
420 return_VOID;
425 * Fetch some descriptive data from ACPI to put in our attach message.
427 static int
428 acpi_probe(device_t dev)
430 ACPI_TABLE_RSDP *rsdp;
431 ACPI_TABLE_HEADER *rsdt;
432 ACPI_PHYSICAL_ADDRESS paddr;
433 char buf[ACPI_OEM_ID_SIZE + ACPI_OEM_TABLE_ID_SIZE + 2];
434 struct sbuf sb;
436 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
438 if (power_pm_get_type() != POWER_PM_TYPE_NONE &&
439 power_pm_get_type() != POWER_PM_TYPE_ACPI) {
440 device_printf(dev, "probe failed, other PM system enabled.\n");
441 return_VALUE (ENXIO);
444 if ((paddr = AcpiOsGetRootPointer()) == 0 ||
445 (rsdp = AcpiOsMapMemory(paddr, sizeof(ACPI_TABLE_RSDP))) == NULL)
446 return_VALUE (ENXIO);
447 if (acpi_ignore_xsdt == 0 &&
448 rsdp->Revision > 1 && rsdp->XsdtPhysicalAddress != 0)
449 paddr = (ACPI_PHYSICAL_ADDRESS)rsdp->XsdtPhysicalAddress;
450 else
451 paddr = (ACPI_PHYSICAL_ADDRESS)rsdp->RsdtPhysicalAddress;
452 AcpiOsUnmapMemory(rsdp, sizeof(ACPI_TABLE_RSDP));
454 if ((rsdt = AcpiOsMapMemory(paddr, sizeof(ACPI_TABLE_HEADER))) == NULL)
455 return_VALUE (ENXIO);
456 sbuf_new(&sb, buf, sizeof(buf), SBUF_FIXEDLEN);
457 sbuf_bcat(&sb, rsdt->OemId, ACPI_OEM_ID_SIZE);
458 sbuf_trim(&sb);
459 sbuf_putc(&sb, ' ');
460 sbuf_bcat(&sb, rsdt->OemTableId, ACPI_OEM_TABLE_ID_SIZE);
461 sbuf_trim(&sb);
462 sbuf_finish(&sb);
463 device_set_desc_copy(dev, sbuf_data(&sb));
464 sbuf_delete(&sb);
465 AcpiOsUnmapMemory(rsdt, sizeof(ACPI_TABLE_HEADER));
467 return_VALUE (0);
470 static int
471 acpi_attach(device_t dev)
473 struct acpi_softc *sc;
474 ACPI_STATUS status;
475 int error, state;
476 UINT32 flags;
477 UINT8 TypeA, TypeB;
478 char *env;
480 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
482 sc = device_get_softc(dev);
483 sc->acpi_dev = dev;
484 callout_init(&sc->susp_force_to);
486 if ((error = acpi_task_thread_init())) {
487 device_printf(dev, "Could not start task thread.\n");
488 goto out2;
491 error = ENXIO;
493 /* Initialize resource manager. */
494 acpi_rman_io.rm_type = RMAN_ARRAY;
495 acpi_rman_io.rm_start = 0;
496 acpi_rman_io.rm_end = 0xffff;
497 acpi_rman_io.rm_descr = "ACPI I/O ports";
498 if (rman_init(&acpi_rman_io, -1) != 0)
499 panic("acpi rman_init IO ports failed");
500 acpi_rman_mem.rm_type = RMAN_ARRAY;
501 acpi_rman_mem.rm_start = 0;
502 acpi_rman_mem.rm_end = ~0ul;
503 acpi_rman_mem.rm_descr = "ACPI I/O memory addresses";
504 if (rman_init(&acpi_rman_mem, -1) != 0)
505 panic("acpi rman_init memory failed");
507 /* Initialise the ACPI mutex */
508 ACPI_LOCK_INIT(acpi, "acpi");
509 ACPI_SERIAL_INIT(acpi);
511 ACPI_LOCK(acpi);
514 * Set the globals from our tunables. This is needed because ACPICA
515 * uses UINT8 for some values and we have no tunable_byte.
517 AcpiGbl_AutoSerializeMethods = acpi_auto_serialize_methods ? TRUE : FALSE;
518 AcpiGbl_DoNotUseXsdt = acpi_ignore_xsdt ? TRUE : FALSE;
519 AcpiGbl_EnableAmlDebugObject = acpi_debug_objects ? TRUE : FALSE;
520 AcpiGbl_EnableInterpreterSlack = acpi_interpreter_slack ? TRUE : FALSE;
521 AcpiGbl_GroupModuleLevelCode = acpi_group_module_level_code ? TRUE : FALSE;
522 AcpiGbl_Use32BitFadtAddresses = acpi_fadt_addr32 ? TRUE : FALSE;
523 AcpiGbl_Use32BitFacsAddresses = acpi_facs_addr32 ? TRUE : FALSE;
525 #ifndef ACPI_DEBUG
527 * Disable Debug Object output.
529 AcpiDbgLevel &= ~ACPI_LV_DEBUG_OBJECT;
530 #endif
532 /* Override OS interfaces if the user requested. */
533 acpi_reset_interfaces(dev);
535 /* Load ACPI name space. */
536 status = AcpiLoadTables();
537 if (ACPI_FAILURE(status)) {
538 device_printf(dev, "Could not load Namespace: %s\n",
539 AcpiFormatException(status));
540 goto out;
543 /* Handle MCFG table if present. */
544 acpi_enable_pcie();
547 * Note that some systems (specifically, those with namespace evaluation
548 * issues that require the avoidance of parts of the namespace) must
549 * avoid running _INI and _STA on everything, as well as dodging the final
550 * object init pass.
552 * For these devices, we set ACPI_NO_DEVICE_INIT and ACPI_NO_OBJECT_INIT).
554 * XXX We should arrange for the object init pass after we have attached
555 * all our child devices, but on many systems it works here.
557 flags = ACPI_FULL_INITIALIZATION;
558 if (ktestenv("debug.acpi.avoid"))
559 flags = ACPI_NO_DEVICE_INIT | ACPI_NO_OBJECT_INIT;
561 /* Bring the hardware and basic handlers online. */
562 if (ACPI_FAILURE(status = AcpiEnableSubsystem(flags))) {
563 device_printf(dev, "Could not enable ACPI: %s\n",
564 AcpiFormatException(status));
565 goto out;
569 * Fix up the interrupt timer after enabling ACPI, so that the
570 * interrupt cputimer that choked by ACPI power management could
571 * be resurrected before probing various devices.
573 DELAY(5000);
574 cputimer_intr_pmfixup();
577 * Call the ECDT probe function to provide EC functionality before
578 * the namespace has been evaluated.
580 * XXX This happens before the sysresource devices have been probed and
581 * attached so its resources come from nexus0. In practice, this isn't
582 * a problem but should be addressed eventually.
584 acpi_ec_ecdt_probe(dev);
586 /* Bring device objects and regions online. */
587 if (ACPI_FAILURE(status = AcpiInitializeObjects(flags))) {
588 device_printf(dev, "Could not initialize ACPI objects: %s\n",
589 AcpiFormatException(status));
590 goto out;
594 * Setup our sysctl tree.
596 * XXX: This doesn't check to make sure that none of these fail.
598 sysctl_ctx_init(&sc->acpi_sysctl_ctx);
599 sc->acpi_sysctl_tree = SYSCTL_ADD_NODE(&sc->acpi_sysctl_ctx,
600 SYSCTL_STATIC_CHILDREN(_hw), OID_AUTO,
601 device_get_name(dev), CTLFLAG_RD, 0, "");
602 SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
603 OID_AUTO, "supported_sleep_state", CTLTYPE_STRING | CTLFLAG_RD,
604 0, 0, acpi_supported_sleep_state_sysctl, "A", "");
605 SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
606 OID_AUTO, "power_button_state", CTLTYPE_STRING | CTLFLAG_RW,
607 &sc->acpi_power_button_sx, 0, acpi_sleep_state_sysctl, "A", "");
608 SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
609 OID_AUTO, "sleep_button_state", CTLTYPE_STRING | CTLFLAG_RW,
610 &sc->acpi_sleep_button_sx, 0, acpi_sleep_state_sysctl, "A", "");
611 SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
612 OID_AUTO, "lid_switch_state", CTLTYPE_STRING | CTLFLAG_RW,
613 &sc->acpi_lid_switch_sx, 0, acpi_sleep_state_sysctl, "A", "");
614 SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
615 OID_AUTO, "standby_state", CTLTYPE_STRING | CTLFLAG_RW,
616 &sc->acpi_standby_sx, 0, acpi_sleep_state_sysctl, "A", "");
617 SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
618 OID_AUTO, "suspend_state", CTLTYPE_STRING | CTLFLAG_RW,
619 &sc->acpi_suspend_sx, 0, acpi_sleep_state_sysctl, "A", "");
620 SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
621 OID_AUTO, "sleep_delay", CTLFLAG_RW, &sc->acpi_sleep_delay, 0,
622 "sleep delay");
623 SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
624 OID_AUTO, "s4bios", CTLFLAG_RW, &sc->acpi_s4bios, 0, "S4BIOS mode");
625 SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
626 OID_AUTO, "verbose", CTLFLAG_RW, &sc->acpi_verbose, 0, "verbose mode");
627 SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
628 OID_AUTO, "disable_on_reboot", CTLFLAG_RW,
629 &sc->acpi_do_disable, 0, "Disable ACPI when rebooting/halting system");
630 SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
631 OID_AUTO, "handle_reboot", CTLFLAG_RW,
632 &sc->acpi_handle_reboot, 0, "Use ACPI Reset Register to reboot");
635 * Default to 1 second before sleeping to give some machines time to
636 * stabilize.
638 sc->acpi_sleep_delay = 1;
639 if (bootverbose)
640 sc->acpi_verbose = 1;
641 if ((env = kgetenv("hw.acpi.verbose")) != NULL) {
642 if (strcmp(env, "0") != 0)
643 sc->acpi_verbose = 1;
644 kfreeenv(env);
647 /* Only enable reboot by default if the FADT says it is available. */
648 if (AcpiGbl_FADT.Flags & ACPI_FADT_RESET_REGISTER)
649 sc->acpi_handle_reboot = 1;
651 /* Only enable S4BIOS by default if the FACS says it is available. */
652 if (AcpiGbl_FACS->Flags & ACPI_FACS_S4_BIOS_PRESENT)
653 sc->acpi_s4bios = 1;
656 * Dispatch the default sleep state to devices. The lid switch is set
657 * to NONE by default to avoid surprising users.
659 sc->acpi_power_button_sx = ACPI_STATE_S5;
660 sc->acpi_lid_switch_sx = ACPI_S_STATES_MAX + 1;
661 sc->acpi_standby_sx = ACPI_STATE_S1;
662 sc->acpi_suspend_sx = ACPI_STATE_S3;
664 /* Pick the first valid sleep state for the sleep button default. */
665 sc->acpi_sleep_button_sx = ACPI_S_STATES_MAX + 1;
666 for (state = ACPI_STATE_S1; state <= ACPI_STATE_S4; state++)
667 if (ACPI_SUCCESS(AcpiGetSleepTypeData(state, &TypeA, &TypeB))) {
668 sc->acpi_sleep_button_sx = state;
669 break;
672 acpi_enable_fixed_events(sc);
675 * Scan the namespace and attach/initialise children.
678 /* Register our shutdown handler. */
679 EVENTHANDLER_REGISTER(shutdown_final, acpi_shutdown_final, sc,
680 SHUTDOWN_PRI_LAST);
683 * Register our acpi event handlers.
684 * XXX should be configurable eg. via userland policy manager.
686 EVENTHANDLER_REGISTER(acpi_sleep_event, acpi_system_eventhandler_sleep,
687 sc, ACPI_EVENT_PRI_LAST);
688 EVENTHANDLER_REGISTER(acpi_wakeup_event, acpi_system_eventhandler_wakeup,
689 sc, ACPI_EVENT_PRI_LAST);
691 /* Flag our initial states. */
692 sc->acpi_enabled = 1;
693 sc->acpi_sstate = ACPI_STATE_S0;
694 sc->acpi_sleep_disabled = 0;
695 /* Create the control device */
696 sc->acpi_dev_t = make_dev(&acpi_ops, 0, UID_ROOT, GID_WHEEL, 0644, "acpi");
697 sc->acpi_dev_t->si_drv1 = sc;
699 if ((error = acpi_machdep_init(dev)))
700 goto out;
702 /* Register ACPI again to pass the correct argument of pm_func. */
703 power_pm_register(POWER_PM_TYPE_ACPI, acpi_pm_func, sc);
705 if (!acpi_disabled("bus"))
706 acpi_probe_children(dev);
708 /* Update all GPEs and enable runtime GPEs. */
709 status = AcpiUpdateAllGpes();
710 if (ACPI_FAILURE(status)) {
711 device_printf(dev, "Could not update all GPEs: %s\n",
712 AcpiFormatException(status));
715 /* Allow sleep request after a while. */
716 /* timeout(acpi_sleep_enable, sc, hz * ACPI_MINIMUM_AWAKETIME); */
718 error = 0;
720 out:
721 ACPI_UNLOCK(acpi);
722 out2:
723 cputimer_intr_pmfixup();
724 acpi_task_thread_schedule();
726 return_VALUE (error);
729 static int
730 acpi_suspend(device_t dev)
732 device_t child, *devlist;
733 int error, i, numdevs, pstate;
735 /* First give child devices a chance to suspend. */
736 error = bus_generic_suspend(dev);
737 if (error)
738 return (error);
741 * Now, set them into the appropriate power state, usually D3. If the
742 * device has an _SxD method for the next sleep state, use that power
743 * state instead.
745 device_get_children(dev, &devlist, &numdevs);
746 for (i = 0; i < numdevs; i++) {
747 /* If the device is not attached, we've powered it down elsewhere. */
748 child = devlist[i];
749 if (!device_is_attached(child))
750 continue;
753 * Default to D3 for all sleep states. The _SxD method is optional
754 * so set the powerstate even if it's absent.
756 pstate = PCI_POWERSTATE_D3;
757 error = acpi_device_pwr_for_sleep(device_get_parent(child),
758 child, &pstate);
759 if ((error == 0 || error == ESRCH) && acpi_do_powerstate)
760 pci_set_powerstate(child, pstate);
762 kfree(devlist, M_TEMP);
763 error = 0;
765 return (error);
768 static int
769 acpi_resume(device_t dev)
771 ACPI_HANDLE handle;
772 int i, numdevs;
773 device_t child, *devlist;
776 * Put all devices in D0 before resuming them. Call _S0D on each one
777 * since some systems expect this.
779 device_get_children(dev, &devlist, &numdevs);
780 for (i = 0; i < numdevs; i++) {
781 child = devlist[i];
782 handle = acpi_get_handle(child);
783 if (handle)
784 AcpiEvaluateObject(handle, "_S0D", NULL, NULL);
785 if (device_is_attached(child) && acpi_do_powerstate)
786 pci_set_powerstate(child, PCI_POWERSTATE_D0);
788 kfree(devlist, M_TEMP);
790 return (bus_generic_resume(dev));
793 static int
794 acpi_shutdown(device_t dev)
796 /* Allow children to shutdown first. */
797 bus_generic_shutdown(dev);
800 * Enable any GPEs that are able to power-on the system (i.e., RTC).
801 * Also, disable any that are not valid for this state (most).
803 acpi_wake_prep_walk(ACPI_STATE_S5);
805 return (0);
809 * Handle a new device being added
811 static device_t
812 acpi_add_child(device_t bus, device_t parent, int order, const char *name, int unit)
814 struct acpi_device *ad;
815 device_t child;
817 if ((ad = kmalloc(sizeof(*ad), M_ACPIDEV, M_NOWAIT | M_ZERO)) == NULL)
818 return (NULL);
820 resource_list_init(&ad->ad_rl);
821 child = device_add_child_ordered(parent, order, name, unit);
822 if (child != NULL)
823 device_set_ivars(child, ad);
824 else
825 kfree(ad, M_ACPIDEV);
826 return (child);
829 static int
830 acpi_print_child(device_t bus, device_t child)
832 struct acpi_device *adev = device_get_ivars(child);
833 struct resource_list *rl = &adev->ad_rl;
834 int retval = 0;
836 retval += bus_print_child_header(bus, child);
837 retval += resource_list_print_type(rl, "port", SYS_RES_IOPORT, "%#lx");
838 retval += resource_list_print_type(rl, "iomem", SYS_RES_MEMORY, "%#lx");
839 retval += resource_list_print_type(rl, "irq", SYS_RES_IRQ, "%ld");
840 retval += resource_list_print_type(rl, "drq", SYS_RES_DRQ, "%ld");
841 if (device_get_flags(child))
842 retval += kprintf(" flags %#x", device_get_flags(child));
843 retval += bus_print_child_footer(bus, child);
845 return (retval);
849 * If this device is an ACPI child but no one claimed it, attempt
850 * to power it off. We'll power it back up when a driver is added.
852 * XXX Disabled for now since many necessary devices (like fdc and
853 * ATA) don't claim the devices we created for them but still expect
854 * them to be powered up.
856 static void
857 acpi_probe_nomatch(device_t bus, device_t child)
860 /* pci_set_powerstate(child, PCI_POWERSTATE_D3); */
864 * If a new driver has a chance to probe a child, first power it up.
866 * XXX Disabled for now (see acpi_probe_nomatch for details).
868 static void
869 acpi_driver_added(device_t dev, driver_t *driver)
871 device_t child, *devlist;
872 int i, numdevs;
874 DEVICE_IDENTIFY(driver, dev);
875 device_get_children(dev, &devlist, &numdevs);
876 for (i = 0; i < numdevs; i++) {
877 child = devlist[i];
878 if (device_get_state(child) == DS_NOTPRESENT) {
879 /* pci_set_powerstate(child, PCI_POWERSTATE_D0); */
880 if (device_probe_and_attach(child) != 0)
881 ; /* pci_set_powerstate(child, PCI_POWERSTATE_D3); */
884 kfree(devlist, M_TEMP);
887 /* Location hint for devctl(8) */
888 static int
889 acpi_child_location_str_method(device_t cbdev, device_t child, char *buf,
890 size_t buflen)
892 struct acpi_device *dinfo = device_get_ivars(child);
894 if (dinfo->ad_handle)
895 ksnprintf(buf, buflen, "handle=%s", acpi_name(dinfo->ad_handle));
896 else
897 ksnprintf(buf, buflen, "unknown");
898 return (0);
901 /* PnP information for devctl(8) */
902 static int
903 acpi_child_pnpinfo_str_method(device_t cbdev, device_t child, char *buf,
904 size_t buflen)
906 ACPI_DEVICE_INFO *adinfo;
907 struct acpi_device *dinfo = device_get_ivars(child);
909 if (ACPI_FAILURE(AcpiGetObjectInfo(dinfo->ad_handle, &adinfo))) {
910 ksnprintf(buf, buflen, "unknown");
911 } else {
912 ksnprintf(buf, buflen, "_HID=%s _UID=%s",
913 (adinfo->Valid & ACPI_VALID_HID) ?
914 adinfo->HardwareId.String : "none",
915 (adinfo->Valid & ACPI_VALID_UID) ?
916 adinfo->UniqueId.String : "0");
917 if (adinfo)
918 AcpiOsFree(adinfo);
920 return (0);
924 * Handle per-device ivars
926 static int
927 acpi_read_ivar(device_t dev, device_t child, int index, uintptr_t *result)
929 struct acpi_device *ad;
931 if ((ad = device_get_ivars(child)) == NULL) {
932 device_printf(child, "device has no ivars\n");
933 return (ENOENT);
936 /* ACPI and ISA compatibility ivars */
937 switch(index) {
938 case ACPI_IVAR_HANDLE:
939 *(ACPI_HANDLE *)result = ad->ad_handle;
940 break;
941 case ACPI_IVAR_MAGIC:
942 *result = ad->ad_magic;
943 break;
944 case ACPI_IVAR_PRIVATE:
945 *(void **)result = ad->ad_private;
946 break;
947 case ACPI_IVAR_FLAGS:
948 *(int *)result = ad->ad_flags;
949 break;
950 case ISA_IVAR_VENDORID:
951 case ISA_IVAR_SERIAL:
952 case ISA_IVAR_COMPATID:
953 *(int *)result = -1;
954 break;
955 case ISA_IVAR_LOGICALID:
956 *(int *)result = acpi_isa_get_logicalid(child);
957 break;
958 default:
959 return (ENOENT);
962 return (0);
965 static int
966 acpi_write_ivar(device_t dev, device_t child, int index, uintptr_t value)
968 struct acpi_device *ad;
970 if ((ad = device_get_ivars(child)) == NULL) {
971 device_printf(child, "device has no ivars\n");
972 return (ENOENT);
975 switch(index) {
976 case ACPI_IVAR_HANDLE:
977 ad->ad_handle = (ACPI_HANDLE)value;
978 break;
979 case ACPI_IVAR_MAGIC:
980 ad->ad_magic = value;
981 break;
982 case ACPI_IVAR_PRIVATE:
983 ad->ad_private = (void *)value;
984 break;
985 case ACPI_IVAR_FLAGS:
986 ad->ad_flags = (int)value;
987 break;
988 default:
989 panic("bad ivar write request (%d)", index);
990 return (ENOENT);
993 return (0);
997 * Handle child resource allocation/removal
999 static struct resource_list *
1000 acpi_get_rlist(device_t dev, device_t child)
1002 struct acpi_device *ad;
1004 ad = device_get_ivars(child);
1005 return (&ad->ad_rl);
1009 * Pre-allocate/manage all memory and IO resources. Since rman can't handle
1010 * duplicates, we merge any in the sysresource attach routine.
1012 static int
1013 acpi_sysres_alloc(device_t dev)
1015 struct resource *res;
1016 struct resource_list *rl;
1017 struct resource_list_entry *rle;
1018 struct rman *rm;
1019 char *sysres_ids[] = { "PNP0C01", "PNP0C02", NULL };
1020 device_t *children;
1021 int child_count, i;
1023 * Probe/attach any sysresource devices. This would be unnecessary if we
1024 * had multi-pass probe/attach.
1026 if (device_get_children(dev, &children, &child_count) != 0)
1027 return (ENXIO);
1028 for (i = 0; i < child_count; i++) {
1029 if (ACPI_ID_PROBE(dev, children[i], sysres_ids) != NULL)
1030 device_probe_and_attach(children[i]);
1032 kfree(children, M_TEMP);
1034 rl = BUS_GET_RESOURCE_LIST(device_get_parent(dev), dev);
1035 if(!rl)
1036 return 0;
1037 SLIST_FOREACH(rle, rl, link) {
1038 if (rle->res != NULL) {
1039 device_printf(dev, "duplicate resource for %lx\n", rle->start);
1040 continue;
1043 /* Only memory and IO resources are valid here. */
1044 switch (rle->type) {
1045 case SYS_RES_IOPORT:
1046 rm = &acpi_rman_io;
1047 break;
1048 case SYS_RES_MEMORY:
1049 rm = &acpi_rman_mem;
1050 break;
1051 default:
1052 continue;
1055 /* Pre-allocate resource and add to our rman pool. */
1056 res = BUS_ALLOC_RESOURCE(device_get_parent(dev), dev, rle->type,
1057 &rle->rid, rle->start, rle->start + rle->count - 1, rle->count,
1058 0, -1);
1059 if (res != NULL) {
1060 rman_manage_region(rm, rman_get_start(res), rman_get_end(res));
1061 rle->res = res;
1062 } else
1063 device_printf(dev, "reservation of %lx, %lx (%d) failed\n",
1064 rle->start, rle->count, rle->type);
1066 return (0);
1069 static struct resource *
1070 acpi_alloc_resource(device_t bus, device_t child, int type, int *rid,
1071 u_long start, u_long end, u_long count, u_int flags, int cpuid)
1073 ACPI_RESOURCE ares;
1074 struct acpi_device *ad = device_get_ivars(child);
1075 struct resource_list *rl = &ad->ad_rl;
1076 struct resource_list_entry *rle;
1077 struct resource *res;
1078 struct rman *rm;
1080 res = NULL;
1082 /* We only handle memory and IO resources through rman. */
1083 switch (type) {
1084 case SYS_RES_IOPORT:
1085 rm = &acpi_rman_io;
1086 break;
1087 case SYS_RES_MEMORY:
1088 rm = &acpi_rman_mem;
1089 break;
1090 default:
1091 rm = NULL;
1094 ACPI_SERIAL_BEGIN(acpi);
1097 * If this is an allocation of the "default" range for a given RID, and
1098 * we know what the resources for this device are (i.e., they're on the
1099 * child's resource list), use those start/end values.
1101 if (bus == device_get_parent(child) && start == 0UL && end == ~0UL) {
1102 rle = resource_list_find(rl, type, *rid);
1103 if (rle == NULL)
1104 goto out;
1105 start = rle->start;
1106 end = rle->end;
1107 count = rle->count;
1108 cpuid = rle->cpuid;
1112 * If this is an allocation of a specific range, see if we can satisfy
1113 * the request from our system resource regions. If we can't, pass the
1114 * request up to the parent.
1116 if (start + count - 1 == end && rm != NULL)
1117 res = rman_reserve_resource(rm, start, end, count, flags & ~RF_ACTIVE,
1118 child);
1119 if (res == NULL) {
1120 res = BUS_ALLOC_RESOURCE(device_get_parent(bus), child, type, rid,
1121 start, end, count, flags, cpuid);
1122 } else {
1123 rman_set_rid(res, *rid);
1125 /* If requested, activate the resource using the parent's method. */
1126 if (flags & RF_ACTIVE)
1127 if (bus_activate_resource(child, type, *rid, res) != 0) {
1128 rman_release_resource(res);
1129 res = NULL;
1130 goto out;
1134 if (res != NULL && device_get_parent(child) == bus)
1135 switch (type) {
1136 case SYS_RES_IRQ:
1138 * Since bus_config_intr() takes immediate effect, we cannot
1139 * configure the interrupt associated with a device when we
1140 * parse the resources but have to defer it until a driver
1141 * actually allocates the interrupt via bus_alloc_resource().
1143 * NB: Lookup failure is fine, since the device may add its
1144 * own interrupt resources, e.g. MSI or MSI-X.
1146 if (ACPI_SUCCESS(
1147 acpi_lookup_irq_resource(child, *rid, res, &ares))) {
1148 acpi_config_intr(child, &ares);
1149 } else {
1150 kprintf("irq resource not found\n");
1152 break;
1155 out:
1156 ACPI_SERIAL_END(acpi);
1157 return (res);
1160 static int
1161 acpi_release_resource(device_t bus, device_t child, int type, int rid,
1162 struct resource *r)
1164 struct rman *rm;
1165 int ret;
1167 /* We only handle memory and IO resources through rman. */
1168 switch (type) {
1169 case SYS_RES_IOPORT:
1170 rm = &acpi_rman_io;
1171 break;
1172 case SYS_RES_MEMORY:
1173 rm = &acpi_rman_mem;
1174 break;
1175 default:
1176 rm = NULL;
1179 ACPI_SERIAL_BEGIN(acpi);
1182 * If this resource belongs to one of our internal managers,
1183 * deactivate it and release it to the local pool. If it doesn't,
1184 * pass this request up to the parent.
1186 if (rm != NULL && rman_is_region_manager(r, rm)) {
1187 if (rman_get_flags(r) & RF_ACTIVE) {
1188 ret = bus_deactivate_resource(child, type, rid, r);
1189 if (ret != 0)
1190 goto out;
1192 ret = rman_release_resource(r);
1193 } else
1194 ret = BUS_RELEASE_RESOURCE(device_get_parent(bus), child, type, rid, r);
1196 out:
1197 ACPI_SERIAL_END(acpi);
1198 return (ret);
1201 static void
1202 acpi_delete_resource(device_t bus, device_t child, int type, int rid)
1204 struct resource_list *rl;
1206 rl = acpi_get_rlist(bus, child);
1207 resource_list_delete(rl, type, rid);
1210 /* Allocate an IO port or memory resource, given its GAS. */
1212 acpi_bus_alloc_gas(device_t dev, int *type, int *rid, ACPI_GENERIC_ADDRESS *gas,
1213 struct resource **res, u_int flags)
1215 int error, res_type;
1217 error = ENOMEM;
1218 if (type == NULL || rid == NULL || gas == NULL || res == NULL)
1219 return (EINVAL);
1221 /* We only support memory and IO spaces. */
1222 switch (gas->SpaceId) {
1223 case ACPI_ADR_SPACE_SYSTEM_MEMORY:
1224 res_type = SYS_RES_MEMORY;
1225 break;
1226 case ACPI_ADR_SPACE_SYSTEM_IO:
1227 res_type = SYS_RES_IOPORT;
1228 break;
1229 default:
1230 return (EOPNOTSUPP);
1234 * If the register width is less than 8, assume the BIOS author means
1235 * it is a bit field and just allocate a byte.
1237 if (gas->BitWidth && gas->BitWidth < 8)
1238 gas->BitWidth = 8;
1240 /* Validate the address after we're sure we support the space. */
1241 if (gas->Address == 0 || gas->BitWidth == 0)
1242 return (EINVAL);
1244 bus_set_resource(dev, res_type, *rid, gas->Address,
1245 gas->BitWidth / 8, -1);
1246 *res = bus_alloc_resource_any(dev, res_type, rid, RF_ACTIVE | flags);
1247 if (*res != NULL) {
1248 *type = res_type;
1249 error = 0;
1250 } else
1251 bus_delete_resource(dev, res_type, *rid);
1253 return (error);
1256 ACPI_STATUS
1257 acpi_eval_osc(device_t dev, ACPI_HANDLE handle, const char *uuidstr,
1258 int revision, uint32_t *buf, int count)
1260 ACPI_BUFFER retbuf = { ACPI_ALLOCATE_BUFFER, NULL };
1261 ACPI_OBJECT_LIST arglist;
1262 ACPI_OBJECT arg[4];
1263 ACPI_OBJECT *retobj;
1264 ACPI_STATUS status;
1265 struct uuid uuid;
1266 uint32_t error;
1267 uint8_t oscuuid[16];
1268 int i;
1270 if (parse_uuid(uuidstr, &uuid) != 0)
1271 return (AE_ERROR);
1272 le_uuid_enc(oscuuid, &uuid);
1274 arglist.Pointer = arg;
1275 arglist.Count = 4;
1276 arg[0].Type = ACPI_TYPE_BUFFER;
1277 arg[0].Buffer.Length = sizeof(oscuuid);
1278 arg[0].Buffer.Pointer = oscuuid; /* UUID */
1279 arg[1].Type = ACPI_TYPE_INTEGER;
1280 arg[1].Integer.Value = revision; /* revision */
1281 arg[2].Type = ACPI_TYPE_INTEGER;
1282 arg[2].Integer.Value = count; /* # of cap integers */
1283 arg[3].Type = ACPI_TYPE_BUFFER;
1284 arg[3].Buffer.Length = count * sizeof(uint32_t); /* capabilities buffer */
1285 arg[3].Buffer.Pointer = (uint8_t *)buf;
1287 status = AcpiEvaluateObject(handle, "_OSC", &arglist, &retbuf);
1288 if (ACPI_FAILURE(status))
1289 goto done;
1290 retobj = retbuf.Pointer;
1291 error = ((uint32_t *)retobj->Buffer.Pointer)[0] & ACPI_OSCERR_MASK;
1292 if (error == 0)
1293 goto done;
1294 status = AE_ERROR;
1295 if (error & ACPI_OSCERR_OSCFAIL)
1296 device_printf(dev, "_OSC unable to process request\n");
1297 if (error & ACPI_OSCERR_UUID)
1298 device_printf(dev, "_OSC unrecognized UUID (%s)\n", uuidstr);
1299 if (error & ACPI_OSCERR_REVISION)
1300 device_printf(dev, "_OSC unrecognized revision ID (%d)\n", revision);
1301 if (error & ACPI_OSCERR_CAPSMASKED) {
1302 if ((buf[0] & ACPI_OSC_QUERY_SUPPORT) == 0) {
1303 for (i = 1; i < count; i++) {
1304 device_printf(dev,
1305 "_OSC capabilities have been masked: buf[%d]:%#x\n",
1306 i, buf[i] & ~((uint32_t *)retobj->Buffer.Pointer)[i]);
1308 status = AE_SUPPORT;
1309 } else {
1310 status = AE_OK;
1314 done:
1315 if (retbuf.Pointer != NULL)
1316 AcpiOsFree(retbuf.Pointer);
1317 return (status);
1320 /* Probe _HID and _CID for compatible ISA PNP ids. */
1321 static uint32_t
1322 acpi_isa_get_logicalid(device_t dev)
1324 ACPI_DEVICE_INFO *devinfo;
1325 ACPI_HANDLE h;
1326 uint32_t pnpid;
1328 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1330 devinfo = NULL;
1331 pnpid = 0;
1333 /* Fetch and validate the HID. */
1334 if ((h = acpi_get_handle(dev)) == NULL ||
1335 ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo)))
1336 goto out;
1338 if ((devinfo->Valid & ACPI_VALID_HID) != 0)
1339 pnpid = PNP_EISAID(devinfo->HardwareId.String);
1341 out:
1342 if (devinfo)
1343 AcpiOsFree(devinfo);
1344 return_VALUE (pnpid);
1347 static int
1348 acpi_isa_get_compatid(device_t dev, uint32_t *cids, int count)
1350 ACPI_DEVICE_INFO *devinfo;
1351 ACPI_HANDLE h;
1352 uint32_t *pnpid;
1353 int valid, i;
1355 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1357 devinfo = NULL;
1358 pnpid = cids;
1359 valid = 0;
1361 /* Fetch and validate the CID */
1362 if ((h = acpi_get_handle(dev)) == NULL ||
1363 ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo)) ||
1364 (devinfo->Valid & ACPI_VALID_CID) == 0)
1365 goto out;
1367 if (devinfo->CompatibleIdList.Count < count)
1368 count = devinfo->CompatibleIdList.Count;
1369 for (i = 0; i < count; i++) {
1370 if (strncmp(devinfo->CompatibleIdList.Ids[i].String, "PNP", 3) != 0)
1371 continue;
1372 *pnpid++ = PNP_EISAID(devinfo->CompatibleIdList.Ids[i].String);
1373 valid++;
1376 out:
1377 if (devinfo)
1378 AcpiOsFree(devinfo);
1379 return_VALUE (valid);
1382 static char *
1383 acpi_device_id_probe(device_t bus, device_t dev, char **ids)
1385 ACPI_HANDLE h;
1386 int i;
1388 h = acpi_get_handle(dev);
1389 if (ids == NULL || h == NULL || acpi_get_type(dev) != ACPI_TYPE_DEVICE)
1390 return (NULL);
1392 /* Try to match one of the array of IDs with a HID or CID. */
1393 for (i = 0; ids[i] != NULL; i++) {
1394 if (acpi_MatchHid(h, ids[i]))
1395 return (ids[i]);
1397 return (NULL);
1400 static ACPI_STATUS
1401 acpi_device_eval_obj(device_t bus, device_t dev, ACPI_STRING pathname,
1402 ACPI_OBJECT_LIST *parameters, ACPI_BUFFER *ret)
1404 ACPI_HANDLE h;
1406 if (dev == NULL)
1407 h = ACPI_ROOT_OBJECT;
1408 else if ((h = acpi_get_handle(dev)) == NULL)
1409 return (AE_BAD_PARAMETER);
1410 return (AcpiEvaluateObject(h, pathname, parameters, ret));
1413 static int
1414 acpi_device_pwr_for_sleep(device_t bus, device_t dev, int *dstate)
1416 struct acpi_softc *sc;
1417 ACPI_HANDLE handle;
1418 ACPI_STATUS status;
1419 char sxd[8];
1420 int error;
1422 sc = device_get_softc(bus);
1423 handle = acpi_get_handle(dev);
1426 * XXX If we find these devices, don't try to power them down.
1427 * The serial and IRDA ports on my T23 hang the system when
1428 * set to D3 and it appears that such legacy devices may
1429 * need special handling in their drivers.
1431 if (handle == NULL ||
1432 acpi_MatchHid(handle, "PNP0500") ||
1433 acpi_MatchHid(handle, "PNP0501") ||
1434 acpi_MatchHid(handle, "PNP0502") ||
1435 acpi_MatchHid(handle, "PNP0510") ||
1436 acpi_MatchHid(handle, "PNP0511"))
1437 return (ENXIO);
1440 * Override next state with the value from _SxD, if present. If no
1441 * dstate argument was provided, don't fetch the return value.
1443 ksnprintf(sxd, sizeof(sxd), "_S%dD", sc->acpi_sstate);
1444 if (dstate)
1445 status = acpi_GetInteger(handle, sxd, dstate);
1446 else
1447 status = AcpiEvaluateObject(handle, sxd, NULL, NULL);
1449 switch (status) {
1450 case AE_OK:
1451 error = 0;
1452 break;
1453 case AE_NOT_FOUND:
1454 error = ESRCH;
1455 break;
1456 default:
1457 error = ENXIO;
1458 break;
1461 return (error);
1464 /* Callback arg for our implementation of walking the namespace. */
1465 struct acpi_device_scan_ctx {
1466 acpi_scan_cb_t user_fn;
1467 void *arg;
1468 ACPI_HANDLE parent;
1471 static ACPI_STATUS
1472 acpi_device_scan_cb(ACPI_HANDLE h, UINT32 level, void *arg, void **retval)
1474 struct acpi_device_scan_ctx *ctx;
1475 device_t dev, old_dev;
1476 ACPI_STATUS status;
1477 ACPI_OBJECT_TYPE type;
1480 * Skip this device if we think we'll have trouble with it or it is
1481 * the parent where the scan began.
1483 ctx = (struct acpi_device_scan_ctx *)arg;
1484 if (acpi_avoid(h) || h == ctx->parent)
1485 return (AE_OK);
1487 /* If this is not a valid device type (e.g., a method), skip it. */
1488 if (ACPI_FAILURE(AcpiGetType(h, &type)))
1489 return (AE_OK);
1490 if (type != ACPI_TYPE_DEVICE && type != ACPI_TYPE_PROCESSOR &&
1491 type != ACPI_TYPE_THERMAL && type != ACPI_TYPE_POWER)
1492 return (AE_OK);
1495 * Call the user function with the current device. If it is unchanged
1496 * afterwards, return. Otherwise, we update the handle to the new dev.
1498 old_dev = acpi_get_device(h);
1499 dev = old_dev;
1500 status = ctx->user_fn(h, &dev, level, ctx->arg);
1501 if (ACPI_FAILURE(status) || old_dev == dev)
1502 return (status);
1504 /* Remove the old child and its connection to the handle. */
1505 if (old_dev != NULL) {
1506 device_delete_child(device_get_parent(old_dev), old_dev);
1507 AcpiDetachData(h, acpi_fake_objhandler);
1510 /* Recreate the handle association if the user created a device. */
1511 if (dev != NULL)
1512 AcpiAttachData(h, acpi_fake_objhandler, dev);
1514 return (AE_OK);
1517 static ACPI_STATUS
1518 acpi_device_scan_children(device_t bus, device_t dev, int max_depth,
1519 acpi_scan_cb_t user_fn, void *arg)
1521 ACPI_HANDLE h;
1522 struct acpi_device_scan_ctx ctx;
1524 if (acpi_disabled("children"))
1525 return (AE_OK);
1527 if (dev == NULL)
1528 h = ACPI_ROOT_OBJECT;
1529 else if ((h = acpi_get_handle(dev)) == NULL)
1530 return (AE_BAD_PARAMETER);
1531 ctx.user_fn = user_fn;
1532 ctx.arg = arg;
1533 ctx.parent = h;
1534 return (AcpiWalkNamespace(ACPI_TYPE_ANY, h, max_depth,
1535 acpi_device_scan_cb, NULL, &ctx, NULL));
1539 * Even though ACPI devices are not PCI, we use the PCI approach for setting
1540 * device power states since it's close enough to ACPI.
1542 static int
1543 acpi_set_powerstate_method(device_t bus, device_t child, int state)
1545 ACPI_HANDLE h;
1546 ACPI_STATUS status;
1547 int error;
1549 error = 0;
1550 h = acpi_get_handle(child);
1551 if (state < ACPI_STATE_D0 || state > ACPI_STATE_D3)
1552 return (EINVAL);
1553 if (h == NULL)
1554 return (0);
1556 /* Ignore errors if the power methods aren't present. */
1557 status = acpi_pwr_switch_consumer(h, state);
1558 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND
1559 && status != AE_BAD_PARAMETER)
1560 device_printf(bus, "failed to set ACPI power state D%d on %s: %s\n",
1561 state, acpi_name(h), AcpiFormatException(status));
1563 return (error);
1566 static int
1567 acpi_isa_pnp_probe(device_t bus, device_t child, struct isa_pnp_id *ids)
1569 int result, cid_count, i;
1570 uint32_t lid, cids[8];
1572 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1575 * ISA-style drivers attached to ACPI may persist and
1576 * probe manually if we return ENOENT. We never want
1577 * that to happen, so don't ever return it.
1579 result = ENXIO;
1581 /* Scan the supplied IDs for a match */
1582 lid = acpi_isa_get_logicalid(child);
1583 cid_count = acpi_isa_get_compatid(child, cids, 8);
1584 while (ids && ids->ip_id) {
1585 if (lid == ids->ip_id) {
1586 result = 0;
1587 goto out;
1589 for (i = 0; i < cid_count; i++) {
1590 if (cids[i] == ids->ip_id) {
1591 result = 0;
1592 goto out;
1595 ids++;
1598 out:
1599 if (result == 0 && ids->ip_desc)
1600 device_set_desc(child, ids->ip_desc);
1602 return_VALUE (result);
1606 * Look for a MCFG table. If it is present, use the settings for
1607 * domain (segment) 0 to setup PCI config space access via the memory
1608 * map.
1610 static void
1611 acpi_enable_pcie(void)
1613 ACPI_TABLE_HEADER *hdr;
1614 ACPI_MCFG_ALLOCATION *alloc, *end;
1615 ACPI_STATUS status;
1617 status = AcpiGetTable(ACPI_SIG_MCFG, 1, &hdr);
1618 if (ACPI_FAILURE(status))
1619 return;
1621 end = (ACPI_MCFG_ALLOCATION *)((char *)hdr + hdr->Length);
1622 alloc = (ACPI_MCFG_ALLOCATION *)((ACPI_TABLE_MCFG *)hdr + 1);
1623 while (alloc < end) {
1624 if (alloc->PciSegment == 0) {
1625 pcie_cfgregopen(alloc->Address, alloc->StartBusNumber,
1626 alloc->EndBusNumber);
1627 return;
1629 alloc++;
1634 * Scan all of the ACPI namespace and attach child devices.
1636 * We should only expect to find devices in the \_PR, \_TZ, \_SI, and
1637 * \_SB scopes, and \_PR and \_TZ became obsolete in the ACPI 2.0 spec.
1638 * However, in violation of the spec, some systems place their PCI link
1639 * devices in \, so we have to walk the whole namespace. We check the
1640 * type of namespace nodes, so this should be ok.
1642 static void
1643 acpi_probe_children(device_t bus)
1646 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1649 * Scan the namespace and insert placeholders for all the devices that
1650 * we find. We also probe/attach any early devices.
1652 * Note that we use AcpiWalkNamespace rather than AcpiGetDevices because
1653 * we want to create nodes for all devices, not just those that are
1654 * currently present. (This assumes that we don't want to create/remove
1655 * devices as they appear, which might be smarter.)
1657 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "namespace scan\n"));
1658 AcpiWalkNamespace(ACPI_TYPE_ANY, ACPI_ROOT_OBJECT, 100,
1659 acpi_probe_child, NULL, bus, NULL);
1661 /* Pre-allocate resources for our rman from any sysresource devices. */
1662 acpi_sysres_alloc(bus);
1663 /* Create any static children by calling device identify methods. */
1664 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "device identify routines\n"));
1665 bus_generic_probe(bus);
1667 /* Probe/attach all children, created staticly and from the namespace. */
1668 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "first bus_generic_attach\n"));
1669 bus_generic_attach(bus);
1672 * Some of these children may have attached others as part of their attach
1673 * process (eg. the root PCI bus driver), so rescan.
1675 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "second bus_generic_attach\n"));
1676 bus_generic_attach(bus);
1678 /* Attach wake sysctls. */
1679 acpi_wake_sysctl_walk(bus);
1681 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "done attaching children\n"));
1682 return_VOID;
1686 * Determine the probe order for a given device.
1688 static void
1689 acpi_probe_order(ACPI_HANDLE handle, int *order)
1691 ACPI_OBJECT_TYPE type;
1694 * 1. I/O port and memory system resource holders
1695 * 2. Embedded controllers (to handle early accesses)
1696 * 3. PCI Link Devices
1697 * 100000. CPUs
1699 AcpiGetType(handle, &type);
1700 if (acpi_MatchHid(handle, "PNP0C01") || acpi_MatchHid(handle, "PNP0C02"))
1701 *order = 1;
1702 else if (acpi_MatchHid(handle, "PNP0C09"))
1703 *order = 2;
1704 else if (acpi_MatchHid(handle, "PNP0C0F"))
1705 *order = 3;
1706 else if (type == ACPI_TYPE_PROCESSOR)
1707 *order = 100000;
1711 * Evaluate a child device and determine whether we might attach a device to
1712 * it.
1714 static ACPI_STATUS
1715 acpi_probe_child(ACPI_HANDLE handle, UINT32 level, void *context, void **status)
1717 struct acpi_prw_data prw;
1718 ACPI_OBJECT_TYPE type;
1719 ACPI_HANDLE h;
1720 device_t bus, child;
1721 int order;
1722 char *handle_str;
1724 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1726 if (acpi_disabled("children"))
1727 return_ACPI_STATUS (AE_OK);
1729 /* Skip this device if we think we'll have trouble with it. */
1730 if (acpi_avoid(handle))
1731 return_ACPI_STATUS (AE_OK);
1733 bus = (device_t)context;
1734 if (ACPI_SUCCESS(AcpiGetType(handle, &type))) {
1735 handle_str = acpi_name(handle);
1736 switch (type) {
1737 case ACPI_TYPE_DEVICE:
1739 * Since we scan from \, be sure to skip system scope objects.
1740 * \_SB_ and \_TZ_ are defined in ACPICA as devices to work around
1741 * BIOS bugs. For example, \_SB_ is to allow \_SB_._INI to be run
1742 * during the intialization and \_TZ_ is to support Notify() on it.
1744 if (strcmp(handle_str, "\\_SB_") == 0 ||
1745 strcmp(handle_str, "\\_TZ_") == 0)
1746 break;
1748 if (acpi_parse_prw(handle, &prw) == 0)
1749 AcpiSetupGpeForWake(handle, prw.gpe_handle, prw.gpe_bit);
1751 /* FALLTHROUGH */
1752 case ACPI_TYPE_PROCESSOR:
1753 case ACPI_TYPE_THERMAL:
1754 case ACPI_TYPE_POWER:
1756 * Create a placeholder device for this node. Sort the
1757 * placeholder so that the probe/attach passes will run
1758 * breadth-first. Orders less than ACPI_DEV_BASE_ORDER
1759 * are reserved for special objects (i.e., system
1760 * resources). CPU devices have a very high order to
1761 * ensure they are probed after other devices.
1763 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "scanning '%s'\n", handle_str));
1764 order = level * 10 + 100;
1765 acpi_probe_order(handle, &order);
1766 child = BUS_ADD_CHILD(bus, bus, order, NULL, -1);
1767 if (child == NULL)
1768 break;
1770 /* Associate the handle with the device_t and vice versa. */
1771 acpi_set_handle(child, handle);
1772 AcpiAttachData(handle, acpi_fake_objhandler, child);
1775 * Check that the device is present. If it's not present,
1776 * leave it disabled (so that we have a device_t attached to
1777 * the handle, but we don't probe it).
1779 * XXX PCI link devices sometimes report "present" but not
1780 * "functional" (i.e. if disabled). Go ahead and probe them
1781 * anyway since we may enable them later.
1783 if (type == ACPI_TYPE_DEVICE && !acpi_DeviceIsPresent(child)) {
1784 /* Never disable PCI link devices. */
1785 if (acpi_MatchHid(handle, "PNP0C0F"))
1786 break;
1788 * Docking stations should remain enabled since the system
1789 * may be undocked at boot.
1791 if (ACPI_SUCCESS(AcpiGetHandle(handle, "_DCK", &h)))
1792 break;
1794 device_disable(child);
1795 break;
1799 * Get the device's resource settings and attach them.
1800 * Note that if the device has _PRS but no _CRS, we need
1801 * to decide when it's appropriate to try to configure the
1802 * device. Ignore the return value here; it's OK for the
1803 * device not to have any resources.
1805 acpi_parse_resources(child, handle, &acpi_res_parse_set, NULL);
1806 break;
1810 return_ACPI_STATUS (AE_OK);
1814 * AcpiAttachData() requires an object handler but never uses it. This is a
1815 * placeholder object handler so we can store a device_t in an ACPI_HANDLE.
1817 void
1818 acpi_fake_objhandler(ACPI_HANDLE h, void *data)
1822 static void
1823 acpi_shutdown_final(void *arg, int howto)
1825 struct acpi_softc *sc;
1826 ACPI_STATUS status;
1829 * XXX Shutdown code should only run on the BSP (cpuid 0).
1830 * Some chipsets do not power off the system correctly if called from
1831 * an AP.
1833 sc = arg;
1834 if ((howto & RB_POWEROFF) != 0) {
1835 status = AcpiEnterSleepStatePrep(ACPI_STATE_S5);
1836 if (ACPI_FAILURE(status)) {
1837 device_printf(sc->acpi_dev, "AcpiEnterSleepStatePrep failed - %s\n",
1838 AcpiFormatException(status));
1839 return;
1841 device_printf(sc->acpi_dev, "Powering system off\n");
1842 ACPI_DISABLE_IRQS();
1843 status = AcpiEnterSleepState(ACPI_STATE_S5);
1844 if (ACPI_FAILURE(status)) {
1845 device_printf(sc->acpi_dev, "power-off failed - %s\n",
1846 AcpiFormatException(status));
1847 } else {
1848 DELAY(1000000);
1849 device_printf(sc->acpi_dev, "power-off failed - timeout\n");
1851 } else if ((howto & RB_HALT) == 0 && sc->acpi_handle_reboot) {
1852 /* Reboot using the reset register. */
1853 status = AcpiReset();
1854 if (ACPI_FAILURE(status)) {
1855 if (status != AE_NOT_EXIST)
1856 device_printf(sc->acpi_dev, "reset failed - %s\n",
1857 AcpiFormatException(status));
1858 } else {
1859 DELAY(1000000);
1860 device_printf(sc->acpi_dev, "reset failed - timeout\n");
1862 } else if (sc->acpi_do_disable && panicstr == NULL) {
1864 * Only disable ACPI if the user requested. On some systems, writing
1865 * the disable value to SMI_CMD hangs the system.
1867 device_printf(sc->acpi_dev, "Shutting down\n");
1868 AcpiTerminate();
1872 static void
1873 acpi_enable_fixed_events(struct acpi_softc *sc)
1875 static int first_time = 1;
1877 /* Enable and clear fixed events and install handlers. */
1878 if ((AcpiGbl_FADT.Flags & ACPI_FADT_POWER_BUTTON) == 0) {
1879 AcpiClearEvent(ACPI_EVENT_POWER_BUTTON);
1880 AcpiInstallFixedEventHandler(ACPI_EVENT_POWER_BUTTON,
1881 acpi_event_power_button_sleep, sc);
1882 if (first_time)
1883 device_printf(sc->acpi_dev, "Power Button (fixed)\n");
1885 if ((AcpiGbl_FADT.Flags & ACPI_FADT_SLEEP_BUTTON) == 0) {
1886 AcpiClearEvent(ACPI_EVENT_SLEEP_BUTTON);
1887 AcpiInstallFixedEventHandler(ACPI_EVENT_SLEEP_BUTTON,
1888 acpi_event_sleep_button_sleep, sc);
1889 if (first_time)
1890 device_printf(sc->acpi_dev, "Sleep Button (fixed)\n");
1893 first_time = 0;
1897 * Returns true if the device is actually present and should
1898 * be attached to. This requires the present, enabled, UI-visible
1899 * and diagnostics-passed bits to be set.
1901 BOOLEAN
1902 acpi_DeviceIsPresent(device_t dev)
1904 ACPI_DEVICE_INFO *devinfo;
1905 ACPI_HANDLE h;
1906 int ret;
1908 ret = FALSE;
1909 if ((h = acpi_get_handle(dev)) == NULL ||
1910 ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo)))
1911 return (FALSE);
1913 /* If no _STA method, must be present */
1914 if ((devinfo->Valid & ACPI_VALID_STA) == 0)
1915 ret = TRUE;
1917 /* Return true for 'present' and 'functioning' */
1918 if (ACPI_DEVICE_PRESENT(devinfo->CurrentStatus))
1919 ret = TRUE;
1921 AcpiOsFree(devinfo);
1922 return (ret);
1926 * Returns true if the battery is actually present and inserted.
1928 BOOLEAN
1929 acpi_BatteryIsPresent(device_t dev)
1931 ACPI_DEVICE_INFO *devinfo;
1932 ACPI_HANDLE h;
1933 int ret;
1935 ret = FALSE;
1936 if ((h = acpi_get_handle(dev)) == NULL ||
1937 ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo)))
1938 return (FALSE);
1940 /* If no _STA method, must be present */
1941 if ((devinfo->Valid & ACPI_VALID_STA) == 0)
1942 ret = TRUE;
1944 /* Return true for 'present', 'battery present', and 'functioning' */
1945 if (ACPI_BATTERY_PRESENT(devinfo->CurrentStatus))
1946 ret = TRUE;
1948 AcpiOsFree(devinfo);
1949 return (ret);
1953 * Match a HID string against a handle
1955 BOOLEAN
1956 acpi_MatchHid(ACPI_HANDLE h, const char *hid)
1958 ACPI_DEVICE_INFO *devinfo;
1959 int ret, i;
1961 ret = FALSE;
1962 if (hid == NULL || h == NULL ||
1963 ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo)))
1964 return (ret);
1966 if ((devinfo->Valid & ACPI_VALID_HID) != 0 &&
1967 strcmp(hid, devinfo->HardwareId.String) == 0)
1968 ret = TRUE;
1969 else if ((devinfo->Valid & ACPI_VALID_CID) != 0) {
1970 for (i = 0; i < devinfo->CompatibleIdList.Count; i++) {
1971 if (strcmp(hid, devinfo->CompatibleIdList.Ids[i].String) == 0) {
1972 ret = TRUE;
1973 break;
1978 AcpiOsFree(devinfo);
1979 return (ret);
1983 * Match a UID string against a handle
1985 BOOLEAN
1986 acpi_MatchUid(ACPI_HANDLE h, const char *uid)
1988 ACPI_DEVICE_INFO *devinfo;
1989 int ret;
1991 ret = FALSE;
1992 if (uid == NULL || h == NULL ||
1993 ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo)))
1994 return (ret);
1996 if ((devinfo->Valid & ACPI_VALID_UID) != 0 &&
1997 strcmp(uid, devinfo->UniqueId.String) == 0)
1998 ret = TRUE;
2000 AcpiOsFree(devinfo);
2001 return (ret);
2005 * Return the handle of a named object within our scope, ie. that of (parent)
2006 * or one if its parents.
2008 ACPI_STATUS
2009 acpi_GetHandleInScope(ACPI_HANDLE parent, char *path, ACPI_HANDLE *result)
2011 ACPI_HANDLE r;
2012 ACPI_STATUS status;
2014 /* Walk back up the tree to the root */
2015 for (;;) {
2016 status = AcpiGetHandle(parent, path, &r);
2017 if (ACPI_SUCCESS(status)) {
2018 *result = r;
2019 return (AE_OK);
2021 /* XXX Return error here? */
2022 if (status != AE_NOT_FOUND)
2023 return (AE_OK);
2024 if (ACPI_FAILURE(AcpiGetParent(parent, &r)))
2025 return (AE_NOT_FOUND);
2026 parent = r;
2031 * Allocate a buffer with a preset data size.
2033 ACPI_BUFFER *
2034 acpi_AllocBuffer(int size)
2036 ACPI_BUFFER *buf;
2038 if ((buf = kmalloc(size + sizeof(*buf), M_ACPIDEV, M_NOWAIT)) == NULL)
2039 return (NULL);
2040 buf->Length = size;
2041 buf->Pointer = (void *)(buf + 1);
2042 return (buf);
2045 ACPI_STATUS
2046 acpi_SetInteger(ACPI_HANDLE handle, char *path, UINT32 number)
2048 ACPI_OBJECT arg1;
2049 ACPI_OBJECT_LIST args;
2051 arg1.Type = ACPI_TYPE_INTEGER;
2052 arg1.Integer.Value = number;
2053 args.Count = 1;
2054 args.Pointer = &arg1;
2056 return (AcpiEvaluateObject(handle, path, &args, NULL));
2060 * Evaluate a path that should return an integer.
2062 ACPI_STATUS
2063 acpi_GetInteger(ACPI_HANDLE handle, char *path, UINT32 *number)
2065 ACPI_STATUS status;
2066 ACPI_BUFFER buf;
2067 ACPI_OBJECT param;
2069 if (handle == NULL)
2070 handle = ACPI_ROOT_OBJECT;
2073 * Assume that what we've been pointed at is an Integer object, or
2074 * a method that will return an Integer.
2076 buf.Pointer = &param;
2077 buf.Length = sizeof(param);
2078 status = AcpiEvaluateObject(handle, path, NULL, &buf);
2079 if (ACPI_SUCCESS(status)) {
2080 if (param.Type == ACPI_TYPE_INTEGER)
2081 *number = param.Integer.Value;
2082 else
2083 status = AE_TYPE;
2087 * In some applications, a method that's expected to return an Integer
2088 * may instead return a Buffer (probably to simplify some internal
2089 * arithmetic). We'll try to fetch whatever it is, and if it's a Buffer,
2090 * convert it into an Integer as best we can.
2092 * This is a hack.
2094 if (status == AE_BUFFER_OVERFLOW) {
2095 if ((buf.Pointer = AcpiOsAllocate(buf.Length)) == NULL) {
2096 status = AE_NO_MEMORY;
2097 } else {
2098 status = AcpiEvaluateObject(handle, path, NULL, &buf);
2099 if (ACPI_SUCCESS(status))
2100 status = acpi_ConvertBufferToInteger(&buf, number);
2101 AcpiOsFree(buf.Pointer);
2104 return (status);
2107 ACPI_STATUS
2108 acpi_ConvertBufferToInteger(ACPI_BUFFER *bufp, UINT32 *number)
2110 ACPI_OBJECT *p;
2111 UINT8 *val;
2112 int i;
2114 p = (ACPI_OBJECT *)bufp->Pointer;
2115 if (p->Type == ACPI_TYPE_INTEGER) {
2116 *number = p->Integer.Value;
2117 return (AE_OK);
2119 if (p->Type != ACPI_TYPE_BUFFER)
2120 return (AE_TYPE);
2121 if (p->Buffer.Length > sizeof(int))
2122 return (AE_BAD_DATA);
2124 *number = 0;
2125 val = p->Buffer.Pointer;
2126 for (i = 0; i < p->Buffer.Length; i++)
2127 *number += val[i] << (i * 8);
2128 return (AE_OK);
2132 * Iterate over the elements of an a package object, calling the supplied
2133 * function for each element.
2135 * XXX possible enhancement might be to abort traversal on error.
2137 ACPI_STATUS
2138 acpi_ForeachPackageObject(ACPI_OBJECT *pkg,
2139 void (*func)(ACPI_OBJECT *comp, void *arg), void *arg)
2141 ACPI_OBJECT *comp;
2142 int i;
2144 if (pkg == NULL || pkg->Type != ACPI_TYPE_PACKAGE)
2145 return (AE_BAD_PARAMETER);
2147 /* Iterate over components */
2148 i = 0;
2149 comp = pkg->Package.Elements;
2150 for (; i < pkg->Package.Count; i++, comp++)
2151 func(comp, arg);
2153 return (AE_OK);
2157 * Find the (index)th resource object in a set.
2159 ACPI_STATUS
2160 acpi_FindIndexedResource(ACPI_BUFFER *buf, int index, ACPI_RESOURCE **resp)
2162 ACPI_RESOURCE *rp;
2163 int i;
2165 rp = (ACPI_RESOURCE *)buf->Pointer;
2166 i = index;
2167 while (i-- > 0) {
2168 /* Range check */
2169 if (rp > (ACPI_RESOURCE *)((uint8_t *)buf->Pointer + buf->Length))
2170 return (AE_BAD_PARAMETER);
2172 /* Check for terminator */
2173 if (rp->Type == ACPI_RESOURCE_TYPE_END_TAG || rp->Length == 0)
2174 return (AE_NOT_FOUND);
2175 rp = ACPI_NEXT_RESOURCE(rp);
2177 if (resp != NULL)
2178 *resp = rp;
2180 return (AE_OK);
2184 * Append an ACPI_RESOURCE to an ACPI_BUFFER.
2186 * Given a pointer to an ACPI_RESOURCE structure, expand the ACPI_BUFFER
2187 * provided to contain it. If the ACPI_BUFFER is empty, allocate a sensible
2188 * backing block. If the ACPI_RESOURCE is NULL, return an empty set of
2189 * resources.
2191 #define ACPI_INITIAL_RESOURCE_BUFFER_SIZE 512
2193 ACPI_STATUS
2194 acpi_AppendBufferResource(ACPI_BUFFER *buf, ACPI_RESOURCE *res)
2196 ACPI_RESOURCE *rp;
2197 void *newp;
2199 /* Initialise the buffer if necessary. */
2200 if (buf->Pointer == NULL) {
2201 buf->Length = ACPI_INITIAL_RESOURCE_BUFFER_SIZE;
2202 if ((buf->Pointer = AcpiOsAllocate(buf->Length)) == NULL)
2203 return (AE_NO_MEMORY);
2204 rp = (ACPI_RESOURCE *)buf->Pointer;
2205 rp->Type = ACPI_RESOURCE_TYPE_END_TAG;
2206 rp->Length = ACPI_RS_SIZE_MIN;
2208 if (res == NULL)
2209 return (AE_OK);
2212 * Scan the current buffer looking for the terminator.
2213 * This will either find the terminator or hit the end
2214 * of the buffer and return an error.
2216 rp = (ACPI_RESOURCE *)buf->Pointer;
2217 for (;;) {
2218 /* Range check, don't go outside the buffer */
2219 if (rp >= (ACPI_RESOURCE *)((uint8_t *)buf->Pointer + buf->Length))
2220 return (AE_BAD_PARAMETER);
2221 if (rp->Type == ACPI_RESOURCE_TYPE_END_TAG || rp->Length == 0)
2222 break;
2223 rp = ACPI_NEXT_RESOURCE(rp);
2227 * Check the size of the buffer and expand if required.
2229 * Required size is:
2230 * size of existing resources before terminator +
2231 * size of new resource and header +
2232 * size of terminator.
2234 * Note that this loop should really only run once, unless
2235 * for some reason we are stuffing a *really* huge resource.
2237 while ((((uint8_t *)rp - (uint8_t *)buf->Pointer) +
2238 res->Length + ACPI_RS_SIZE_NO_DATA +
2239 ACPI_RS_SIZE_MIN) >= buf->Length) {
2240 if ((newp = AcpiOsAllocate(buf->Length * 2)) == NULL)
2241 return (AE_NO_MEMORY);
2242 bcopy(buf->Pointer, newp, buf->Length);
2243 rp = (ACPI_RESOURCE *)((uint8_t *)newp +
2244 ((uint8_t *)rp - (uint8_t *)buf->Pointer));
2245 AcpiOsFree(buf->Pointer);
2246 buf->Pointer = newp;
2247 buf->Length += buf->Length;
2250 /* Insert the new resource. */
2251 bcopy(res, rp, res->Length + ACPI_RS_SIZE_NO_DATA);
2253 /* And add the terminator. */
2254 rp = ACPI_NEXT_RESOURCE(rp);
2255 rp->Type = ACPI_RESOURCE_TYPE_END_TAG;
2256 rp->Length = ACPI_RS_SIZE_MIN;
2258 return (AE_OK);
2262 * Set interrupt model.
2264 ACPI_STATUS
2265 acpi_SetIntrModel(int model)
2268 return (acpi_SetInteger(ACPI_ROOT_OBJECT, "_PIC", model));
2272 * DEPRECATED. This interface has serious deficiencies and will be
2273 * removed.
2275 * Immediately enter the sleep state. In the old model, acpiconf(8) ran
2276 * rc.suspend and rc.resume so we don't have to notify devd(8) to do this.
2278 ACPI_STATUS
2279 acpi_SetSleepState(struct acpi_softc *sc, int state)
2281 static int once;
2283 if (!once) {
2284 device_printf(sc->acpi_dev,
2285 "warning: acpi_SetSleepState() deprecated, need to update your software\n");
2286 once = 1;
2288 return (acpi_EnterSleepState(sc, state));
2291 static void
2292 acpi_sleep_force(void *arg)
2294 struct acpi_softc *sc;
2296 sc = arg;
2297 device_printf(sc->acpi_dev,
2298 "suspend request timed out, forcing sleep now\n");
2299 if (ACPI_FAILURE(acpi_EnterSleepState(sc, sc->acpi_next_sstate)))
2300 device_printf(sc->acpi_dev, "force sleep state S%d failed\n",
2301 sc->acpi_next_sstate);
2305 * Request that the system enter the given suspend state. All /dev/apm
2306 * devices and devd(8) will be notified. Userland then has a chance to
2307 * save state and acknowledge the request. The system sleeps once all
2308 * acks are in.
2311 acpi_ReqSleepState(struct acpi_softc *sc, int state)
2313 #ifdef notyet
2314 struct apm_clone_data *clone;
2315 #endif
2317 if (state < ACPI_STATE_S1 || state > ACPI_STATE_S5)
2318 return (EINVAL);
2320 /* S5 (soft-off) should be entered directly with no waiting. */
2321 if (state == ACPI_STATE_S5) {
2322 if (ACPI_SUCCESS(acpi_EnterSleepState(sc, state)))
2323 return (0);
2324 else
2325 return (ENXIO);
2328 /* This platform does not support acpi suspend/resume. */
2329 return (EOPNOTSUPP);
2331 /* If a suspend request is already in progress, just return. */
2332 ACPI_LOCK(acpi);
2333 if (sc->acpi_next_sstate != 0) {
2334 ACPI_UNLOCK(acpi);
2335 return (0);
2338 /* Record the pending state and notify all apm devices. */
2339 sc->acpi_next_sstate = state;
2340 #if 0
2341 STAILQ_FOREACH(clone, &sc->apm_cdevs, entries) {
2342 clone->notify_status = APM_EV_NONE;
2343 if ((clone->flags & ACPI_EVF_DEVD) == 0) {
2344 KNOTE(&clone->sel_read.si_note, 0);
2347 #endif
2349 /* If devd(8) is not running, immediately enter the sleep state. */
2350 if (devctl_process_running() == FALSE) {
2351 ACPI_UNLOCK(acpi);
2352 if (ACPI_SUCCESS(acpi_EnterSleepState(sc, sc->acpi_next_sstate))) {
2353 return (0);
2354 } else {
2355 return (ENXIO);
2359 /* Now notify devd(8) also. */
2360 acpi_UserNotify("Suspend", ACPI_ROOT_OBJECT, state);
2363 * Set a timeout to fire if userland doesn't ack the suspend request
2364 * in time. This way we still eventually go to sleep if we were
2365 * overheating or running low on battery, even if userland is hung.
2366 * We cancel this timeout once all userland acks are in or the
2367 * suspend request is aborted.
2369 callout_reset(&sc->susp_force_to, 10 * hz, acpi_sleep_force, sc);
2370 ACPI_UNLOCK(acpi);
2372 return (0);
2376 * Acknowledge (or reject) a pending sleep state. The caller has
2377 * prepared for suspend and is now ready for it to proceed. If the
2378 * error argument is non-zero, it indicates suspend should be cancelled
2379 * and gives an errno value describing why. Once all votes are in,
2380 * we suspend the system.
2383 acpi_AckSleepState(struct apm_clone_data *clone, int error)
2385 struct acpi_softc *sc;
2386 int ret, sleeping;
2388 /* This platform does not support acpi suspend/resume. */
2389 return (EOPNOTSUPP);
2391 /* If no pending sleep state, return an error. */
2392 ACPI_LOCK(acpi);
2393 sc = clone->acpi_sc;
2394 if (sc->acpi_next_sstate == 0) {
2395 ACPI_UNLOCK(acpi);
2396 return (ENXIO);
2399 /* Caller wants to abort suspend process. */
2400 if (error) {
2401 sc->acpi_next_sstate = 0;
2402 callout_stop(&sc->susp_force_to);
2403 device_printf(sc->acpi_dev,
2404 "listener on %s cancelled the pending suspend\n",
2405 devtoname(clone->cdev));
2406 ACPI_UNLOCK(acpi);
2407 return (0);
2411 * Mark this device as acking the suspend request. Then, walk through
2412 * all devices, seeing if they agree yet. We only count devices that
2413 * are writable since read-only devices couldn't ack the request.
2415 clone->notify_status = APM_EV_ACKED;
2416 sleeping = TRUE;
2417 STAILQ_FOREACH(clone, &sc->apm_cdevs, entries) {
2418 if ((clone->flags & ACPI_EVF_WRITE) != 0 &&
2419 clone->notify_status != APM_EV_ACKED) {
2420 sleeping = FALSE;
2421 break;
2425 /* If all devices have voted "yes", we will suspend now. */
2426 if (sleeping)
2427 callout_stop(&sc->susp_force_to);
2428 ACPI_UNLOCK(acpi);
2429 ret = 0;
2430 if (sleeping) {
2431 if (ACPI_FAILURE(acpi_EnterSleepState(sc, sc->acpi_next_sstate)))
2432 ret = ENODEV;
2435 return (ret);
2438 static void
2439 acpi_sleep_enable(void *arg)
2441 ((struct acpi_softc *)arg)->acpi_sleep_disabled = 0;
2444 enum acpi_sleep_state {
2445 ACPI_SS_NONE,
2446 ACPI_SS_GPE_SET,
2447 ACPI_SS_DEV_SUSPEND,
2448 ACPI_SS_SLP_PREP,
2449 ACPI_SS_SLEPT,
2453 * Enter the desired system sleep state.
2455 * Currently we support S1-S5 but S4 is only S4BIOS
2457 static ACPI_STATUS
2458 acpi_EnterSleepState(struct acpi_softc *sc, int state)
2460 ACPI_STATUS status;
2461 UINT8 TypeA;
2462 UINT8 TypeB;
2463 enum acpi_sleep_state slp_state;
2465 ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, state);
2467 /* Re-entry once we're suspending is not allowed. */
2468 status = AE_OK;
2469 ACPI_LOCK(acpi);
2470 if (sc->acpi_sleep_disabled) {
2471 ACPI_UNLOCK(acpi);
2472 device_printf(sc->acpi_dev,
2473 "suspend request ignored (not ready yet)\n");
2474 return (AE_ERROR);
2476 sc->acpi_sleep_disabled = 1;
2477 ACPI_UNLOCK(acpi);
2480 * Be sure to hold Giant across DEVICE_SUSPEND/RESUME since non-MPSAFE
2481 * drivers need this.
2483 //get_mplock();
2485 slp_state = ACPI_SS_NONE;
2486 switch (state) {
2487 case ACPI_STATE_S1:
2488 case ACPI_STATE_S2:
2489 case ACPI_STATE_S3:
2490 case ACPI_STATE_S4:
2491 status = AcpiGetSleepTypeData(state, &TypeA, &TypeB);
2492 if (status == AE_NOT_FOUND) {
2493 device_printf(sc->acpi_dev,
2494 "Sleep state S%d not supported by BIOS\n", state);
2495 break;
2496 } else if (ACPI_FAILURE(status)) {
2497 device_printf(sc->acpi_dev, "AcpiGetSleepTypeData failed - %s\n",
2498 AcpiFormatException(status));
2499 break;
2502 sc->acpi_sstate = state;
2504 /* Enable any GPEs as appropriate and requested by the user. */
2505 acpi_wake_prep_walk(state);
2506 slp_state = ACPI_SS_GPE_SET;
2509 * Inform all devices that we are going to sleep. If at least one
2510 * device fails, DEVICE_SUSPEND() automatically resumes the tree.
2512 * XXX Note that a better two-pass approach with a 'veto' pass
2513 * followed by a "real thing" pass would be better, but the current
2514 * bus interface does not provide for this.
2516 if (DEVICE_SUSPEND(root_bus) != 0) {
2517 device_printf(sc->acpi_dev, "device_suspend failed\n");
2518 break;
2520 slp_state = ACPI_SS_DEV_SUSPEND;
2522 /* If testing device suspend only, back out of everything here. */
2523 if (acpi_susp_bounce)
2524 break;
2526 status = AcpiEnterSleepStatePrep(state);
2527 if (ACPI_FAILURE(status)) {
2528 device_printf(sc->acpi_dev, "AcpiEnterSleepStatePrep failed - %s\n",
2529 AcpiFormatException(status));
2530 break;
2532 slp_state = ACPI_SS_SLP_PREP;
2534 if (sc->acpi_sleep_delay > 0)
2535 DELAY(sc->acpi_sleep_delay * 1000000);
2537 if (state != ACPI_STATE_S1) {
2538 acpi_sleep_machdep(sc, state);
2540 /* Re-enable ACPI hardware on wakeup from sleep state 4. */
2541 if (state == ACPI_STATE_S4)
2542 AcpiEnable();
2543 } else {
2544 ACPI_DISABLE_IRQS();
2545 status = AcpiEnterSleepState(state);
2546 if (ACPI_FAILURE(status)) {
2547 device_printf(sc->acpi_dev, "AcpiEnterSleepState failed - %s\n",
2548 AcpiFormatException(status));
2549 break;
2552 slp_state = ACPI_SS_SLEPT;
2553 break;
2554 case ACPI_STATE_S5:
2556 * Shut down cleanly and power off. This will call us back through the
2557 * shutdown handlers.
2559 shutdown_nice(RB_POWEROFF);
2560 break;
2561 case ACPI_STATE_S0:
2562 default:
2563 status = AE_BAD_PARAMETER;
2564 break;
2568 * Back out state according to how far along we got in the suspend
2569 * process. This handles both the error and success cases.
2571 sc->acpi_next_sstate = 0;
2572 if (slp_state >= ACPI_SS_GPE_SET) {
2573 acpi_wake_prep_walk(state);
2574 sc->acpi_sstate = ACPI_STATE_S0;
2576 if (slp_state >= ACPI_SS_SLP_PREP)
2577 AcpiLeaveSleepState(state);
2578 if (slp_state >= ACPI_SS_DEV_SUSPEND)
2579 DEVICE_RESUME(root_bus);
2580 if (slp_state >= ACPI_SS_SLEPT)
2581 acpi_enable_fixed_events(sc);
2583 /* Allow another sleep request after a while. */
2584 /* XXX: needs timeout */
2585 if (state != ACPI_STATE_S5)
2586 acpi_sleep_enable(sc);
2588 /* Run /etc/rc.resume after we are back. */
2589 acpi_UserNotify("Resume", ACPI_ROOT_OBJECT, state);
2591 //rel_mplock();
2593 return_ACPI_STATUS (status);
2596 /* Enable or disable the device's GPE. */
2598 acpi_wake_set_enable(device_t dev, int enable)
2600 struct acpi_prw_data prw;
2601 ACPI_STATUS status;
2602 int flags;
2604 /* Make sure the device supports waking the system and get the GPE. */
2605 if (acpi_parse_prw(acpi_get_handle(dev), &prw) != 0)
2606 return (ENXIO);
2608 flags = acpi_get_flags(dev);
2609 if (enable) {
2610 status = AcpiSetGpeWakeMask(prw.gpe_handle, prw.gpe_bit,
2611 ACPI_GPE_ENABLE);
2612 if (ACPI_FAILURE(status)) {
2613 device_printf(dev, "enable wake failed\n");
2614 return (ENXIO);
2616 acpi_set_flags(dev, flags | ACPI_FLAG_WAKE_ENABLED);
2617 } else {
2618 status = AcpiSetGpeWakeMask(prw.gpe_handle, prw.gpe_bit,
2619 ACPI_GPE_DISABLE);
2620 if (ACPI_FAILURE(status)) {
2621 device_printf(dev, "disable wake failed\n");
2622 return (ENXIO);
2624 acpi_set_flags(dev, flags & ~ACPI_FLAG_WAKE_ENABLED);
2627 return (0);
2630 static int
2631 acpi_wake_sleep_prep(ACPI_HANDLE handle, int sstate)
2633 struct acpi_prw_data prw;
2634 device_t dev;
2636 /* Check that this is a wake-capable device and get its GPE. */
2637 if (acpi_parse_prw(handle, &prw) != 0)
2638 return (ENXIO);
2639 dev = acpi_get_device(handle);
2642 * The destination sleep state must be less than (i.e., higher power)
2643 * or equal to the value specified by _PRW. If this GPE cannot be
2644 * enabled for the next sleep state, then disable it. If it can and
2645 * the user requested it be enabled, turn on any required power resources
2646 * and set _PSW.
2648 if (sstate > prw.lowest_wake) {
2649 AcpiSetGpeWakeMask(prw.gpe_handle, prw.gpe_bit, ACPI_GPE_DISABLE);
2650 if (bootverbose)
2651 device_printf(dev, "wake_prep disabled wake for %s (S%d)\n",
2652 acpi_name(handle), sstate);
2653 } else if (dev && (acpi_get_flags(dev) & ACPI_FLAG_WAKE_ENABLED) != 0) {
2654 acpi_pwr_wake_enable(handle, 1);
2655 acpi_SetInteger(handle, "_PSW", 1);
2656 if (bootverbose)
2657 device_printf(dev, "wake_prep enabled for %s (S%d)\n",
2658 acpi_name(handle), sstate);
2661 return (0);
2664 static int
2665 acpi_wake_run_prep(ACPI_HANDLE handle, int sstate)
2667 struct acpi_prw_data prw;
2668 device_t dev;
2671 * Check that this is a wake-capable device and get its GPE. Return
2672 * now if the user didn't enable this device for wake.
2674 if (acpi_parse_prw(handle, &prw) != 0)
2675 return (ENXIO);
2676 dev = acpi_get_device(handle);
2677 if (dev == NULL || (acpi_get_flags(dev) & ACPI_FLAG_WAKE_ENABLED) == 0)
2678 return (0);
2681 * If this GPE couldn't be enabled for the previous sleep state, it was
2682 * disabled before going to sleep so re-enable it. If it was enabled,
2683 * clear _PSW and turn off any power resources it used.
2685 if (sstate > prw.lowest_wake) {
2686 AcpiSetGpeWakeMask(prw.gpe_handle, prw.gpe_bit, ACPI_GPE_ENABLE);
2687 if (bootverbose)
2688 device_printf(dev, "run_prep re-enabled %s\n", acpi_name(handle));
2689 } else {
2690 acpi_SetInteger(handle, "_PSW", 0);
2691 acpi_pwr_wake_enable(handle, 0);
2692 if (bootverbose)
2693 device_printf(dev, "run_prep cleaned up for %s\n",
2694 acpi_name(handle));
2697 return (0);
2700 static ACPI_STATUS
2701 acpi_wake_prep(ACPI_HANDLE handle, UINT32 level, void *context, void **status)
2703 int sstate;
2705 /* If suspending, run the sleep prep function, otherwise wake. */
2706 sstate = *(int *)context;
2707 if (AcpiGbl_SystemAwakeAndRunning)
2708 acpi_wake_sleep_prep(handle, sstate);
2709 else
2710 acpi_wake_run_prep(handle, sstate);
2711 return (AE_OK);
2714 /* Walk the tree rooted at acpi0 to prep devices for suspend/resume. */
2715 static int
2716 acpi_wake_prep_walk(int sstate)
2718 ACPI_HANDLE sb_handle;
2720 if (ACPI_SUCCESS(AcpiGetHandle(ACPI_ROOT_OBJECT, "\\_SB_", &sb_handle))) {
2721 AcpiWalkNamespace(ACPI_TYPE_DEVICE, sb_handle, 100,
2722 acpi_wake_prep, NULL, &sstate, NULL);
2724 return (0);
2727 /* Walk the tree rooted at acpi0 to attach per-device wake sysctls. */
2728 static int
2729 acpi_wake_sysctl_walk(device_t dev)
2731 #ifdef notyet
2732 int error, i, numdevs;
2733 device_t *devlist;
2734 device_t child;
2735 ACPI_STATUS status;
2737 error = device_get_children(dev, &devlist, &numdevs);
2738 if (error != 0 || numdevs == 0) {
2739 if (numdevs == 0)
2740 kfree(devlist, M_TEMP);
2741 return (error);
2743 for (i = 0; i < numdevs; i++) {
2744 child = devlist[i];
2745 acpi_wake_sysctl_walk(child);
2746 if (!device_is_attached(child))
2747 continue;
2748 status = AcpiEvaluateObject(acpi_get_handle(child), "_PRW", NULL, NULL);
2749 if (ACPI_SUCCESS(status)) {
2750 SYSCTL_ADD_PROC(device_get_sysctl_ctx(child),
2751 SYSCTL_CHILDREN(device_get_sysctl_tree(child)), OID_AUTO,
2752 "wake", CTLTYPE_INT | CTLFLAG_RW, child, 0,
2753 acpi_wake_set_sysctl, "I", "Device set to wake the system");
2756 kfree(devlist, M_TEMP);
2757 #endif
2759 return (0);
2762 #ifdef notyet
2763 /* Enable or disable wake from userland. */
2764 static int
2765 acpi_wake_set_sysctl(SYSCTL_HANDLER_ARGS)
2767 int enable, error;
2768 device_t dev;
2770 dev = (device_t)arg1;
2771 enable = (acpi_get_flags(dev) & ACPI_FLAG_WAKE_ENABLED) ? 1 : 0;
2773 error = sysctl_handle_int(oidp, &enable, 0, req);
2774 if (error != 0 || req->newptr == NULL)
2775 return (error);
2776 if (enable != 0 && enable != 1)
2777 return (EINVAL);
2779 return (acpi_wake_set_enable(dev, enable));
2781 #endif
2783 /* Parse a device's _PRW into a structure. */
2785 acpi_parse_prw(ACPI_HANDLE h, struct acpi_prw_data *prw)
2787 ACPI_STATUS status;
2788 ACPI_BUFFER prw_buffer;
2789 ACPI_OBJECT *res, *res2;
2790 int error, i, power_count;
2792 if (h == NULL || prw == NULL)
2793 return (EINVAL);
2796 * The _PRW object (7.2.9) is only required for devices that have the
2797 * ability to wake the system from a sleeping state.
2799 error = EINVAL;
2800 prw_buffer.Pointer = NULL;
2801 prw_buffer.Length = ACPI_ALLOCATE_BUFFER;
2802 status = AcpiEvaluateObject(h, "_PRW", NULL, &prw_buffer);
2803 if (ACPI_FAILURE(status))
2804 return (ENOENT);
2805 res = (ACPI_OBJECT *)prw_buffer.Pointer;
2806 if (res == NULL)
2807 return (ENOENT);
2808 if (!ACPI_PKG_VALID(res, 2))
2809 goto out;
2812 * Element 1 of the _PRW object:
2813 * The lowest power system sleeping state that can be entered while still
2814 * providing wake functionality. The sleeping state being entered must
2815 * be less than (i.e., higher power) or equal to this value.
2817 if (acpi_PkgInt32(res, 1, &prw->lowest_wake) != 0)
2818 goto out;
2821 * Element 0 of the _PRW object:
2823 switch (res->Package.Elements[0].Type) {
2824 case ACPI_TYPE_INTEGER:
2826 * If the data type of this package element is numeric, then this
2827 * _PRW package element is the bit index in the GPEx_EN, in the
2828 * GPE blocks described in the FADT, of the enable bit that is
2829 * enabled for the wake event.
2831 prw->gpe_handle = NULL;
2832 prw->gpe_bit = res->Package.Elements[0].Integer.Value;
2833 error = 0;
2834 break;
2835 case ACPI_TYPE_PACKAGE:
2837 * If the data type of this package element is a package, then this
2838 * _PRW package element is itself a package containing two
2839 * elements. The first is an object reference to the GPE Block
2840 * device that contains the GPE that will be triggered by the wake
2841 * event. The second element is numeric and it contains the bit
2842 * index in the GPEx_EN, in the GPE Block referenced by the
2843 * first element in the package, of the enable bit that is enabled for
2844 * the wake event.
2846 * For example, if this field is a package then it is of the form:
2847 * Package() {\_SB.PCI0.ISA.GPE, 2}
2849 res2 = &res->Package.Elements[0];
2850 if (!ACPI_PKG_VALID(res2, 2))
2851 goto out;
2852 prw->gpe_handle = acpi_GetReference(NULL, &res2->Package.Elements[0]);
2853 if (prw->gpe_handle == NULL)
2854 goto out;
2855 if (acpi_PkgInt32(res2, 1, &prw->gpe_bit) != 0)
2856 goto out;
2857 error = 0;
2858 break;
2859 default:
2860 goto out;
2863 /* Elements 2 to N of the _PRW object are power resources. */
2864 power_count = res->Package.Count - 2;
2865 if (power_count > ACPI_PRW_MAX_POWERRES) {
2866 kprintf("ACPI device %s has too many power resources\n", acpi_name(h));
2867 power_count = 0;
2869 prw->power_res_count = power_count;
2870 for (i = 0; i < power_count; i++)
2871 prw->power_res[i] = res->Package.Elements[i];
2873 out:
2874 if (prw_buffer.Pointer != NULL)
2875 AcpiOsFree(prw_buffer.Pointer);
2876 return (error);
2880 * ACPI Event Handlers
2883 /* System Event Handlers (registered by EVENTHANDLER_REGISTER) */
2885 static void
2886 acpi_system_eventhandler_sleep(void *arg, int state)
2888 struct acpi_softc *sc;
2889 int ret;
2891 ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, state);
2893 sc = arg;
2895 /* Check if button action is disabled. */
2896 if (state == ACPI_S_STATES_MAX + 1)
2897 return;
2899 /* Request that the system prepare to enter the given suspend state. */
2900 ret = acpi_ReqSleepState((struct acpi_softc *)arg, state);
2901 if (ret != 0)
2902 device_printf(sc->acpi_dev,
2903 "request to enter state S%d failed (err %d)\n", state, ret);
2905 return_VOID;
2908 static void
2909 acpi_system_eventhandler_wakeup(void *arg, int state)
2912 ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, state);
2914 /* Currently, nothing to do for wakeup. */
2916 return_VOID;
2920 * ACPICA Event Handlers (FixedEvent, also called from button notify handler)
2922 UINT32
2923 acpi_event_power_button_sleep(void *context)
2925 struct acpi_softc *sc = (struct acpi_softc *)context;
2927 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
2929 EVENTHANDLER_INVOKE(acpi_sleep_event, sc->acpi_power_button_sx);
2931 return_VALUE (ACPI_INTERRUPT_HANDLED);
2934 UINT32
2935 acpi_event_power_button_wake(void *context)
2937 struct acpi_softc *sc = (struct acpi_softc *)context;
2939 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
2941 EVENTHANDLER_INVOKE(acpi_wakeup_event, sc->acpi_power_button_sx);
2943 return_VALUE (ACPI_INTERRUPT_HANDLED);
2946 UINT32
2947 acpi_event_sleep_button_sleep(void *context)
2949 struct acpi_softc *sc = (struct acpi_softc *)context;
2951 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
2953 EVENTHANDLER_INVOKE(acpi_sleep_event, sc->acpi_sleep_button_sx);
2955 return_VALUE (ACPI_INTERRUPT_HANDLED);
2958 UINT32
2959 acpi_event_sleep_button_wake(void *context)
2961 struct acpi_softc *sc = (struct acpi_softc *)context;
2963 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
2965 EVENTHANDLER_INVOKE(acpi_wakeup_event, sc->acpi_sleep_button_sx);
2967 return_VALUE (ACPI_INTERRUPT_HANDLED);
2971 * XXX This static buffer is suboptimal. There is no locking so only
2972 * use this for single-threaded callers.
2974 char *
2975 acpi_name(ACPI_HANDLE handle)
2977 ACPI_BUFFER buf;
2978 static char data[256];
2980 buf.Length = sizeof(data);
2981 buf.Pointer = data;
2983 if (handle && ACPI_SUCCESS(AcpiGetName(handle, ACPI_FULL_PATHNAME, &buf)))
2984 return (data);
2985 return ("(unknown)");
2989 * Debugging/bug-avoidance. Avoid trying to fetch info on various
2990 * parts of the namespace.
2993 acpi_avoid(ACPI_HANDLE handle)
2995 char *cp, *env, *np;
2996 int len;
2998 np = acpi_name(handle);
2999 if (*np == '\\')
3000 np++;
3001 if ((env = kgetenv("debug.acpi.avoid")) == NULL)
3002 return (0);
3004 /* Scan the avoid list checking for a match */
3005 cp = env;
3006 for (;;) {
3007 while (*cp != 0 && isspace(*cp))
3008 cp++;
3009 if (*cp == 0)
3010 break;
3011 len = 0;
3012 while (cp[len] != 0 && !isspace(cp[len]))
3013 len++;
3014 if (!strncmp(cp, np, len)) {
3015 kfreeenv(env);
3016 return(1);
3018 cp += len;
3020 kfreeenv(env);
3022 return (0);
3026 * Debugging/bug-avoidance. Disable ACPI subsystem components.
3029 acpi_disabled(char *subsys)
3031 char *cp, *env;
3032 int len;
3034 if ((env = kgetenv("debug.acpi.disabled")) == NULL)
3035 return (0);
3036 if (strcmp(env, "all") == 0) {
3037 kfreeenv(env);
3038 return (1);
3041 /* Scan the disable list, checking for a match. */
3042 cp = env;
3043 for (;;) {
3044 while (*cp != '\0' && isspace(*cp))
3045 cp++;
3046 if (*cp == '\0')
3047 break;
3048 len = 0;
3049 while (cp[len] != '\0' && !isspace(cp[len]))
3050 len++;
3051 if (strncmp(cp, subsys, len) == 0) {
3052 kfreeenv(env);
3053 return (1);
3055 cp += len;
3057 kfreeenv(env);
3059 return (0);
3063 * Debugging/bug-avoidance. Enable ACPI subsystem components. Most
3064 * components are enabled by default. The ones that are not have to be
3065 * enabled via debug.acpi.enabled.
3068 acpi_enabled(char *subsys)
3070 char *cp, *env;
3071 int len;
3073 if ((env = kgetenv("debug.acpi.enabled")) == NULL)
3074 return (0);
3075 if (strcmp(env, "all") == 0) {
3076 kfreeenv(env);
3077 return (1);
3080 /* Scan the enable list, checking for a match. */
3081 cp = env;
3082 for (;;) {
3083 while (*cp != '\0' && isspace(*cp))
3084 cp++;
3085 if (*cp == '\0')
3086 break;
3087 len = 0;
3088 while (cp[len] != '\0' && !isspace(cp[len]))
3089 len++;
3090 if (strncmp(cp, subsys, len) == 0) {
3091 kfreeenv(env);
3092 return (1);
3094 cp += len;
3096 kfreeenv(env);
3098 return (0);
3102 * Control interface.
3104 * We multiplex ioctls for all participating ACPI devices here. Individual
3105 * drivers wanting to be accessible via /dev/acpi should use the
3106 * register/deregister interface to make their handlers visible.
3108 struct acpi_ioctl_hook
3110 TAILQ_ENTRY(acpi_ioctl_hook) link;
3111 u_long cmd;
3112 acpi_ioctl_fn fn;
3113 void *arg;
3116 static TAILQ_HEAD(,acpi_ioctl_hook) acpi_ioctl_hooks;
3117 static int acpi_ioctl_hooks_initted;
3120 acpi_register_ioctl(u_long cmd, acpi_ioctl_fn fn, void *arg)
3122 struct acpi_ioctl_hook *hp;
3124 if ((hp = kmalloc(sizeof(*hp), M_ACPIDEV, M_NOWAIT)) == NULL)
3125 return (ENOMEM);
3126 hp->cmd = cmd;
3127 hp->fn = fn;
3128 hp->arg = arg;
3130 ACPI_LOCK(acpi);
3131 if (acpi_ioctl_hooks_initted == 0) {
3132 TAILQ_INIT(&acpi_ioctl_hooks);
3133 acpi_ioctl_hooks_initted = 1;
3135 TAILQ_INSERT_TAIL(&acpi_ioctl_hooks, hp, link);
3136 ACPI_UNLOCK(acpi);
3138 return (0);
3141 void
3142 acpi_deregister_ioctl(u_long cmd, acpi_ioctl_fn fn)
3144 struct acpi_ioctl_hook *hp;
3146 ACPI_LOCK(acpi);
3147 TAILQ_FOREACH(hp, &acpi_ioctl_hooks, link)
3148 if (hp->cmd == cmd && hp->fn == fn)
3149 break;
3151 if (hp != NULL) {
3152 TAILQ_REMOVE(&acpi_ioctl_hooks, hp, link);
3153 kfree(hp, M_ACPIDEV);
3155 ACPI_UNLOCK(acpi);
3158 static int
3159 acpiopen(struct dev_open_args *ap)
3161 return (0);
3164 static int
3165 acpiclose(struct dev_close_args *ap)
3167 return (0);
3170 static int
3171 acpiioctl(struct dev_ioctl_args *ap)
3173 struct acpi_softc *sc;
3174 struct acpi_ioctl_hook *hp;
3175 int error, state;
3177 error = 0;
3178 hp = NULL;
3179 sc = ap->a_head.a_dev->si_drv1;
3182 * Scan the list of registered ioctls, looking for handlers.
3184 lwkt_gettoken(&acpi_token);
3185 ACPI_LOCK(acpi);
3186 if (acpi_ioctl_hooks_initted) {
3187 TAILQ_FOREACH(hp, &acpi_ioctl_hooks, link) {
3188 if (hp->cmd == ap->a_cmd)
3189 break;
3192 ACPI_UNLOCK(acpi);
3193 if (hp) {
3194 error = hp->fn(ap->a_cmd, ap->a_data, hp->arg);
3195 lwkt_reltoken(&acpi_token);
3196 return error;
3200 * Core ioctls are not permitted for non-writable user.
3201 * Currently, other ioctls just fetch information.
3202 * Not changing system behavior.
3204 if ((ap->a_fflag & FWRITE) == 0) {
3205 lwkt_reltoken(&acpi_token);
3206 return (EPERM);
3209 /* Core system ioctls. */
3210 switch (ap->a_cmd) {
3211 case ACPIIO_REQSLPSTATE:
3212 state = *(int *)ap->a_data;
3213 if (state != ACPI_STATE_S5)
3214 error = acpi_ReqSleepState(sc, state);
3215 else {
3216 device_printf(sc->acpi_dev,
3217 "power off via acpi ioctl not supported\n");
3218 error = ENXIO;
3220 break;
3221 case ACPIIO_ACKSLPSTATE:
3222 error = EOPNOTSUPP;
3223 #if 0 /* notyet */
3224 error = *(int *)ap->a_data;
3225 error = acpi_AckSleepState(sc->acpi_clone, error);
3226 #endif
3227 break;
3228 case ACPIIO_SETSLPSTATE: /* DEPRECATED */
3229 error = EINVAL;
3230 state = *(int *)ap->a_data;
3231 if (state >= ACPI_STATE_S0 && state <= ACPI_S_STATES_MAX)
3232 if (ACPI_SUCCESS(acpi_SetSleepState(sc, state)))
3233 error = 0;
3234 break;
3235 case ACPIIO_DO_MCALL:
3236 if (acpi_allow_mcall == 1) {
3237 struct acpi_mcall_ioctl_arg *params;
3238 ACPI_BUFFER result = { ACPI_ALLOCATE_BUFFER, NULL };
3239 ACPI_OBJECT *resobj;
3241 error = EINVAL;
3242 params = (struct acpi_mcall_ioctl_arg *)ap->a_data;
3243 params->retval = AcpiEvaluateObject(NULL, params->path,
3244 &params->args, &result);
3245 if (ACPI_SUCCESS(params->retval) && result.Pointer != NULL &&
3246 params->result.Pointer != NULL) {
3247 params->result.Length = min(params->result.Length,
3248 result.Length);
3249 copyout(result.Pointer, params->result.Pointer,
3250 params->result.Length);
3251 params->reslen = result.Length;
3252 if (result.Length >= sizeof(ACPI_OBJECT)) {
3253 resobj = (ACPI_OBJECT *)params->result.Pointer;
3254 switch (resobj->Type) {
3255 case ACPI_TYPE_STRING:
3256 resobj->String.Pointer = (char *)
3257 ((UINT8 *)(resobj->String.Pointer) -
3258 (UINT8 *)result.Pointer +
3259 (UINT8 *)resobj);
3260 break;
3261 case ACPI_TYPE_BUFFER:
3262 resobj->Buffer.Pointer -= (UINT8 *)result.Pointer -
3263 (UINT8 *)resobj;
3264 break;
3267 error = 0;
3269 if (result.Pointer != NULL)
3270 AcpiOsFree(result.Pointer);
3271 } else {
3272 device_printf(sc->acpi_dev,
3273 "debug.acpi.allow_method_calls must be set\n");
3274 error = ENXIO;
3276 break;
3277 default:
3278 error = ENXIO;
3279 break;
3281 lwkt_reltoken(&acpi_token);
3283 return (error);
3286 static int
3287 acpi_supported_sleep_state_sysctl(SYSCTL_HANDLER_ARGS)
3289 int error;
3290 struct sbuf sb;
3291 UINT8 state, TypeA, TypeB;
3293 sbuf_new(&sb, NULL, 32, SBUF_AUTOEXTEND);
3294 for (state = ACPI_STATE_S1; state < ACPI_S_STATES_MAX + 1; state++)
3295 if (ACPI_SUCCESS(AcpiGetSleepTypeData(state, &TypeA, &TypeB)))
3296 sbuf_printf(&sb, "S%d ", state);
3297 sbuf_trim(&sb);
3298 sbuf_finish(&sb);
3299 error = sysctl_handle_string(oidp, sbuf_data(&sb), sbuf_len(&sb), req);
3300 sbuf_delete(&sb);
3301 return (error);
3304 static int
3305 acpi_sleep_state_sysctl(SYSCTL_HANDLER_ARGS)
3307 char sleep_state[10];
3308 int error;
3309 u_int new_state, old_state;
3311 old_state = *(u_int *)oidp->oid_arg1;
3312 if (old_state > ACPI_S_STATES_MAX + 1)
3313 strlcpy(sleep_state, "unknown", sizeof(sleep_state));
3314 else
3315 strlcpy(sleep_state, sleep_state_names[old_state], sizeof(sleep_state));
3316 error = sysctl_handle_string(oidp, sleep_state, sizeof(sleep_state), req);
3317 if (error == 0 && req->newptr != NULL) {
3318 new_state = ACPI_STATE_S0;
3319 for (; new_state <= ACPI_S_STATES_MAX + 1; new_state++)
3320 if (strcmp(sleep_state, sleep_state_names[new_state]) == 0)
3321 break;
3322 if (new_state <= ACPI_S_STATES_MAX + 1) {
3323 if (new_state != old_state)
3324 *(u_int *)oidp->oid_arg1 = new_state;
3325 } else
3326 error = EINVAL;
3329 return (error);
3332 /* Inform devctl(4) when we receive a Notify. */
3333 void
3334 acpi_UserNotify(const char *subsystem, ACPI_HANDLE h, uint8_t notify)
3336 char notify_buf[16];
3337 ACPI_BUFFER handle_buf;
3338 ACPI_STATUS status;
3340 if (subsystem == NULL)
3341 return;
3343 handle_buf.Pointer = NULL;
3344 handle_buf.Length = ACPI_ALLOCATE_BUFFER;
3345 status = AcpiNsHandleToPathname(h, &handle_buf, FALSE);
3346 if (ACPI_FAILURE(status))
3347 return;
3348 ksnprintf(notify_buf, sizeof(notify_buf), "notify=0x%02x", notify);
3349 devctl_notify("ACPI", subsystem, handle_buf.Pointer, notify_buf);
3350 AcpiOsFree(handle_buf.Pointer);
3353 #ifdef ACPI_DEBUG
3355 * Support for parsing debug options from the kernel environment.
3357 * Bits may be set in the AcpiDbgLayer and AcpiDbgLevel debug registers
3358 * by specifying the names of the bits in the debug.acpi.layer and
3359 * debug.acpi.level environment variables. Bits may be unset by
3360 * prefixing the bit name with !.
3362 struct debugtag
3364 char *name;
3365 UINT32 value;
3368 static struct debugtag dbg_layer[] = {
3369 {"ACPI_UTILITIES", ACPI_UTILITIES},
3370 {"ACPI_HARDWARE", ACPI_HARDWARE},
3371 {"ACPI_EVENTS", ACPI_EVENTS},
3372 {"ACPI_TABLES", ACPI_TABLES},
3373 {"ACPI_NAMESPACE", ACPI_NAMESPACE},
3374 {"ACPI_PARSER", ACPI_PARSER},
3375 {"ACPI_DISPATCHER", ACPI_DISPATCHER},
3376 {"ACPI_EXECUTER", ACPI_EXECUTER},
3377 {"ACPI_RESOURCES", ACPI_RESOURCES},
3378 {"ACPI_CA_DEBUGGER", ACPI_CA_DEBUGGER},
3379 {"ACPI_OS_SERVICES", ACPI_OS_SERVICES},
3380 {"ACPI_CA_DISASSEMBLER", ACPI_CA_DISASSEMBLER},
3381 {"ACPI_ALL_COMPONENTS", ACPI_ALL_COMPONENTS},
3383 {"ACPI_AC_ADAPTER", ACPI_AC_ADAPTER},
3384 {"ACPI_BATTERY", ACPI_BATTERY},
3385 {"ACPI_BUS", ACPI_BUS},
3386 {"ACPI_BUTTON", ACPI_BUTTON},
3387 {"ACPI_EC", ACPI_EC},
3388 {"ACPI_FAN", ACPI_FAN},
3389 {"ACPI_POWERRES", ACPI_POWERRES},
3390 {"ACPI_PROCESSOR", ACPI_PROCESSOR},
3391 {"ACPI_THERMAL", ACPI_THERMAL},
3392 {"ACPI_TIMER", ACPI_TIMER},
3393 {"ACPI_ALL_DRIVERS", ACPI_ALL_DRIVERS},
3394 {NULL, 0}
3397 static struct debugtag dbg_level[] = {
3398 {"ACPI_LV_INIT", ACPI_LV_INIT},
3399 {"ACPI_LV_DEBUG_OBJECT", ACPI_LV_DEBUG_OBJECT},
3400 {"ACPI_LV_INFO", ACPI_LV_INFO},
3401 {"ACPI_LV_REPAIR", ACPI_LV_REPAIR},
3402 {"ACPI_LV_ALL_EXCEPTIONS", ACPI_LV_ALL_EXCEPTIONS},
3404 /* Trace verbosity level 1 [Standard Trace Level] */
3405 {"ACPI_LV_INIT_NAMES", ACPI_LV_INIT_NAMES},
3406 {"ACPI_LV_PARSE", ACPI_LV_PARSE},
3407 {"ACPI_LV_LOAD", ACPI_LV_LOAD},
3408 {"ACPI_LV_DISPATCH", ACPI_LV_DISPATCH},
3409 {"ACPI_LV_EXEC", ACPI_LV_EXEC},
3410 {"ACPI_LV_NAMES", ACPI_LV_NAMES},
3411 {"ACPI_LV_OPREGION", ACPI_LV_OPREGION},
3412 {"ACPI_LV_BFIELD", ACPI_LV_BFIELD},
3413 {"ACPI_LV_TABLES", ACPI_LV_TABLES},
3414 {"ACPI_LV_VALUES", ACPI_LV_VALUES},
3415 {"ACPI_LV_OBJECTS", ACPI_LV_OBJECTS},
3416 {"ACPI_LV_RESOURCES", ACPI_LV_RESOURCES},
3417 {"ACPI_LV_USER_REQUESTS", ACPI_LV_USER_REQUESTS},
3418 {"ACPI_LV_PACKAGE", ACPI_LV_PACKAGE},
3419 {"ACPI_LV_VERBOSITY1", ACPI_LV_VERBOSITY1},
3421 /* Trace verbosity level 2 [Function tracing and memory allocation] */
3422 {"ACPI_LV_ALLOCATIONS", ACPI_LV_ALLOCATIONS},
3423 {"ACPI_LV_FUNCTIONS", ACPI_LV_FUNCTIONS},
3424 {"ACPI_LV_OPTIMIZATIONS", ACPI_LV_OPTIMIZATIONS},
3425 {"ACPI_LV_VERBOSITY2", ACPI_LV_VERBOSITY2},
3426 {"ACPI_LV_ALL", ACPI_LV_ALL},
3428 /* Trace verbosity level 3 [Threading, I/O, and Interrupts] */
3429 {"ACPI_LV_MUTEX", ACPI_LV_MUTEX},
3430 {"ACPI_LV_THREADS", ACPI_LV_THREADS},
3431 {"ACPI_LV_IO", ACPI_LV_IO},
3432 {"ACPI_LV_INTERRUPTS", ACPI_LV_INTERRUPTS},
3433 {"ACPI_LV_VERBOSITY3", ACPI_LV_VERBOSITY3},
3435 /* Exceptionally verbose output -- also used in the global "DebugLevel" */
3436 {"ACPI_LV_AML_DISASSEMBLE", ACPI_LV_AML_DISASSEMBLE},
3437 {"ACPI_LV_VERBOSE_INFO", ACPI_LV_VERBOSE_INFO},
3438 {"ACPI_LV_FULL_TABLES", ACPI_LV_FULL_TABLES},
3439 {"ACPI_LV_EVENTS", ACPI_LV_EVENTS},
3440 {"ACPI_LV_VERBOSE", ACPI_LV_VERBOSE},
3441 {NULL, 0}
3444 static void
3445 acpi_parse_debug(char *cp, struct debugtag *tag, UINT32 *flag)
3447 char *ep;
3448 int i, l;
3449 int set;
3451 while (*cp) {
3452 if (isspace(*cp)) {
3453 cp++;
3454 continue;
3456 ep = cp;
3457 while (*ep && !isspace(*ep))
3458 ep++;
3459 if (*cp == '!') {
3460 set = 0;
3461 cp++;
3462 if (cp == ep)
3463 continue;
3464 } else {
3465 set = 1;
3467 l = ep - cp;
3468 for (i = 0; tag[i].name != NULL; i++) {
3469 if (!strncmp(cp, tag[i].name, l)) {
3470 if (set)
3471 *flag |= tag[i].value;
3472 else
3473 *flag &= ~tag[i].value;
3476 cp = ep;
3480 static void
3481 acpi_set_debugging(void *junk)
3483 char *layer, *level;
3485 if (cold) {
3486 AcpiDbgLayer = 0;
3487 AcpiDbgLevel = 0;
3490 layer = kgetenv("debug.acpi.layer");
3491 level = kgetenv("debug.acpi.level");
3492 if (layer == NULL && level == NULL)
3493 return;
3495 kprintf("ACPI set debug");
3496 if (layer != NULL) {
3497 if (strcmp("NONE", layer) != 0)
3498 kprintf(" layer '%s'", layer);
3499 acpi_parse_debug(layer, &dbg_layer[0], &AcpiDbgLayer);
3500 kfreeenv(layer);
3502 if (level != NULL) {
3503 if (strcmp("NONE", level) != 0)
3504 kprintf(" level '%s'", level);
3505 acpi_parse_debug(level, &dbg_level[0], &AcpiDbgLevel);
3506 kfreeenv(level);
3508 kprintf("\n");
3511 SYSINIT(acpi_debugging, SI_BOOT1_TUNABLES, SI_ORDER_ANY, acpi_set_debugging,
3512 NULL);
3514 static int
3515 acpi_debug_sysctl(SYSCTL_HANDLER_ARGS)
3517 int error, *dbg;
3518 struct debugtag *tag;
3519 struct sbuf sb;
3521 if (sbuf_new(&sb, NULL, 128, SBUF_AUTOEXTEND) == NULL)
3522 return (ENOMEM);
3523 if (strcmp(oidp->oid_arg1, "debug.acpi.layer") == 0) {
3524 tag = &dbg_layer[0];
3525 dbg = &AcpiDbgLayer;
3526 } else {
3527 tag = &dbg_level[0];
3528 dbg = &AcpiDbgLevel;
3531 /* Get old values if this is a get request. */
3532 ACPI_SERIAL_BEGIN(acpi);
3533 if (*dbg == 0) {
3534 sbuf_cpy(&sb, "NONE");
3535 } else if (req->newptr == NULL) {
3536 for (; tag->name != NULL; tag++) {
3537 if ((*dbg & tag->value) == tag->value)
3538 sbuf_printf(&sb, "%s ", tag->name);
3541 sbuf_trim(&sb);
3542 sbuf_finish(&sb);
3544 /* Copy out the old values to the user. */
3545 error = SYSCTL_OUT(req, sbuf_data(&sb), sbuf_len(&sb));
3546 sbuf_delete(&sb);
3548 /* If the user is setting a string, parse it. */
3549 if (error == 0 && req->newptr != NULL) {
3550 *dbg = 0;
3551 ksetenv((char *)oidp->oid_arg1, (char *)req->newptr);
3552 acpi_set_debugging(NULL);
3554 ACPI_SERIAL_END(acpi);
3556 return (error);
3559 SYSCTL_PROC(_debug_acpi, OID_AUTO, layer, CTLFLAG_RW | CTLTYPE_STRING,
3560 "debug.acpi.layer", 0, acpi_debug_sysctl, "A", "");
3561 SYSCTL_PROC(_debug_acpi, OID_AUTO, level, CTLFLAG_RW | CTLTYPE_STRING,
3562 "debug.acpi.level", 0, acpi_debug_sysctl, "A", "");
3563 #endif /* ACPI_DEBUG */
3565 static int
3566 acpi_debug_objects_sysctl(SYSCTL_HANDLER_ARGS)
3568 int error;
3569 int old;
3571 old = acpi_debug_objects;
3572 error = sysctl_handle_int(oidp, &acpi_debug_objects, 0, req);
3573 if (error != 0 || req->newptr == NULL)
3574 return (error);
3575 if (old == acpi_debug_objects || (old && acpi_debug_objects))
3576 return (0);
3578 ACPI_SERIAL_BEGIN(acpi);
3579 AcpiGbl_EnableAmlDebugObject = acpi_debug_objects ? TRUE : FALSE;
3580 ACPI_SERIAL_END(acpi);
3582 return (0);
3586 static int
3587 acpi_parse_interfaces(char *str, struct acpi_interface *iface)
3589 char *p;
3590 size_t len;
3591 int i, j;
3593 p = str;
3594 while (isspace(*p) || *p == ',')
3595 p++;
3596 len = strlen(p);
3597 if (len == 0)
3598 return (0);
3599 p = kstrdup(p, M_TEMP);
3600 for (i = 0; i < len; i++)
3601 if (p[i] == ',')
3602 p[i] = '\0';
3603 i = j = 0;
3604 while (i < len)
3605 if (isspace(p[i]) || p[i] == '\0')
3606 i++;
3607 else {
3608 i += strlen(p + i) + 1;
3609 j++;
3611 if (j == 0) {
3612 kfree(p, M_TEMP);
3613 return (0);
3615 iface->data = kmalloc(sizeof(*iface->data) * j, M_TEMP, M_WAITOK);
3616 iface->num = j;
3617 i = j = 0;
3618 while (i < len)
3619 if (isspace(p[i]) || p[i] == '\0')
3620 i++;
3621 else {
3622 iface->data[j] = p + i;
3623 i += strlen(p + i) + 1;
3624 j++;
3627 return (j);
3630 static void
3631 acpi_free_interfaces(struct acpi_interface *iface)
3633 kfree(iface->data[0], M_TEMP);
3634 kfree(iface->data, M_TEMP);
3637 static void
3638 acpi_reset_interfaces(device_t dev)
3640 struct acpi_interface list;
3641 ACPI_STATUS status;
3642 int i;
3644 if (acpi_parse_interfaces(acpi_install_interface, &list) > 0) {
3645 for (i = 0; i < list.num; i++) {
3646 status = AcpiInstallInterface(list.data[i]);
3647 if (ACPI_FAILURE(status))
3648 device_printf(dev,
3649 "failed to install _OSI(\"%s\"): %s\n",
3650 list.data[i], AcpiFormatException(status));
3651 else if (bootverbose)
3652 device_printf(dev, "installed _OSI(\"%s\")\n",
3653 list.data[i]);
3655 acpi_free_interfaces(&list);
3657 if (acpi_parse_interfaces(acpi_remove_interface, &list) > 0) {
3658 for (i = 0; i < list.num; i++) {
3659 status = AcpiRemoveInterface(list.data[i]);
3660 if (ACPI_FAILURE(status))
3661 device_printf(dev,
3662 "failed to remove _OSI(\"%s\"): %s\n",
3663 list.data[i], AcpiFormatException(status));
3664 else if (bootverbose)
3665 device_printf(dev, "removed _OSI(\"%s\")\n",
3666 list.data[i]);
3668 acpi_free_interfaces(&list);
3672 static int
3673 acpi_pm_func(u_long cmd, void *arg, ...)
3675 int state, acpi_state;
3676 int error;
3677 struct acpi_softc *sc;
3678 __va_list ap;
3680 error = 0;
3681 switch (cmd) {
3682 case POWER_CMD_SUSPEND:
3683 sc = (struct acpi_softc *)arg;
3684 if (sc == NULL) {
3685 error = EINVAL;
3686 goto out;
3689 __va_start(ap, arg);
3690 state = __va_arg(ap, int);
3691 __va_end(ap);
3693 switch (state) {
3694 case POWER_SLEEP_STATE_STANDBY:
3695 acpi_state = sc->acpi_standby_sx;
3696 break;
3697 case POWER_SLEEP_STATE_SUSPEND:
3698 acpi_state = sc->acpi_suspend_sx;
3699 break;
3700 case POWER_SLEEP_STATE_HIBERNATE:
3701 acpi_state = ACPI_STATE_S4;
3702 break;
3703 default:
3704 error = EINVAL;
3705 goto out;
3708 if (ACPI_FAILURE(acpi_EnterSleepState(sc, acpi_state)))
3709 error = ENXIO;
3710 break;
3711 default:
3712 error = EINVAL;
3713 goto out;
3716 out:
3717 return (error);
3720 static void
3721 acpi_pm_register(void *arg)
3723 if (!cold || resource_disabled("acpi", 0))
3724 return;
3726 power_pm_register(POWER_PM_TYPE_ACPI, acpi_pm_func, NULL);
3729 SYSINIT(power, SI_BOOT2_KLD, SI_ORDER_ANY, acpi_pm_register, 0);