kernel - Incidental MPLOCK removal (non-performance)
[dragonfly.git] / sys / dev / acpica / acpi.c
blob29f628cb45192f5fc6467efbc813d37c37ed8c57
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, 0 },
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;
96 /* Bitmap of device quirks. */
97 int acpi_quirks;
99 static int acpi_modevent(struct module *mod, int event, void *junk);
100 static void acpi_identify(driver_t *driver, device_t parent);
101 static int acpi_probe(device_t dev);
102 static int acpi_attach(device_t dev);
103 static int acpi_suspend(device_t dev);
104 static int acpi_resume(device_t dev);
105 static int acpi_shutdown(device_t dev);
106 static device_t acpi_add_child(device_t bus, device_t parent, int order, const char *name,
107 int unit);
108 static int acpi_print_child(device_t bus, device_t child);
109 static void acpi_probe_nomatch(device_t bus, device_t child);
110 static void acpi_driver_added(device_t dev, driver_t *driver);
111 static int acpi_read_ivar(device_t dev, device_t child, int index,
112 uintptr_t *result);
113 static int acpi_write_ivar(device_t dev, device_t child, int index,
114 uintptr_t value);
115 static struct resource_list *acpi_get_rlist(device_t dev, device_t child);
116 static int acpi_sysres_alloc(device_t dev);
117 static struct resource *acpi_alloc_resource(device_t bus, device_t child,
118 int type, int *rid, u_long start, u_long end,
119 u_long count, u_int flags, int cpuid);
120 static int acpi_release_resource(device_t bus, device_t child, int type,
121 int rid, struct resource *r);
122 static void acpi_delete_resource(device_t bus, device_t child, int type,
123 int rid);
124 static uint32_t acpi_isa_get_logicalid(device_t dev);
125 static int acpi_isa_get_compatid(device_t dev, uint32_t *cids, int count);
126 static char *acpi_device_id_probe(device_t bus, device_t dev, char **ids);
127 static ACPI_STATUS acpi_device_eval_obj(device_t bus, device_t dev,
128 ACPI_STRING pathname, ACPI_OBJECT_LIST *parameters,
129 ACPI_BUFFER *ret);
130 static int acpi_device_pwr_for_sleep(device_t bus, device_t dev,
131 int *dstate);
132 static ACPI_STATUS acpi_device_scan_cb(ACPI_HANDLE h, UINT32 level,
133 void *context, void **retval);
134 static ACPI_STATUS acpi_device_scan_children(device_t bus, device_t dev,
135 int max_depth, acpi_scan_cb_t user_fn, void *arg);
136 static int acpi_set_powerstate_method(device_t bus, device_t child,
137 int state);
138 static int acpi_isa_pnp_probe(device_t bus, device_t child,
139 struct isa_pnp_id *ids);
140 static void acpi_probe_children(device_t bus);
141 static void acpi_probe_order(ACPI_HANDLE handle, int *order);
142 static ACPI_STATUS acpi_probe_child(ACPI_HANDLE handle, UINT32 level,
143 void *context, void **status);
144 static ACPI_STATUS acpi_EnterSleepState(struct acpi_softc *sc, int state);
145 static void acpi_shutdown_final(void *arg, int howto);
146 static void acpi_enable_fixed_events(struct acpi_softc *sc);
147 static int acpi_wake_sleep_prep(ACPI_HANDLE handle, int sstate);
148 static int acpi_wake_run_prep(ACPI_HANDLE handle, int sstate);
149 static int acpi_wake_prep_walk(int sstate);
150 static int acpi_wake_sysctl_walk(device_t dev);
151 #ifdef notyet
152 static int acpi_wake_set_sysctl(SYSCTL_HANDLER_ARGS);
153 #endif
154 static void acpi_system_eventhandler_sleep(void *arg, int state);
155 static void acpi_system_eventhandler_wakeup(void *arg, int state);
156 static int acpi_supported_sleep_state_sysctl(SYSCTL_HANDLER_ARGS);
157 static int acpi_sleep_state_sysctl(SYSCTL_HANDLER_ARGS);
158 static int acpi_debug_objects_sysctl(SYSCTL_HANDLER_ARGS);
159 static int acpi_pm_func(u_long cmd, void *arg, ...);
160 static int acpi_child_location_str_method(device_t acdev, device_t child,
161 char *buf, size_t buflen);
162 static int acpi_child_pnpinfo_str_method(device_t acdev, device_t child,
163 char *buf, size_t buflen);
164 static void acpi_enable_pcie(void);
165 static void acpi_reset_interfaces(device_t dev);
167 static device_method_t acpi_methods[] = {
168 /* Device interface */
169 DEVMETHOD(device_identify, acpi_identify),
170 DEVMETHOD(device_probe, acpi_probe),
171 DEVMETHOD(device_attach, acpi_attach),
172 DEVMETHOD(device_shutdown, acpi_shutdown),
173 DEVMETHOD(device_detach, bus_generic_detach),
174 DEVMETHOD(device_suspend, acpi_suspend),
175 DEVMETHOD(device_resume, acpi_resume),
177 /* Bus interface */
178 DEVMETHOD(bus_add_child, acpi_add_child),
179 DEVMETHOD(bus_print_child, acpi_print_child),
180 DEVMETHOD(bus_probe_nomatch, acpi_probe_nomatch),
181 DEVMETHOD(bus_driver_added, acpi_driver_added),
182 DEVMETHOD(bus_read_ivar, acpi_read_ivar),
183 DEVMETHOD(bus_write_ivar, acpi_write_ivar),
184 DEVMETHOD(bus_get_resource_list, acpi_get_rlist),
185 DEVMETHOD(bus_set_resource, bus_generic_rl_set_resource),
186 DEVMETHOD(bus_get_resource, bus_generic_rl_get_resource),
187 DEVMETHOD(bus_alloc_resource, acpi_alloc_resource),
188 DEVMETHOD(bus_release_resource, acpi_release_resource),
189 DEVMETHOD(bus_delete_resource, acpi_delete_resource),
190 DEVMETHOD(bus_child_pnpinfo_str, acpi_child_pnpinfo_str_method),
191 DEVMETHOD(bus_child_location_str, acpi_child_location_str_method),
192 DEVMETHOD(bus_activate_resource, bus_generic_activate_resource),
193 DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource),
194 DEVMETHOD(bus_setup_intr, bus_generic_setup_intr),
195 DEVMETHOD(bus_teardown_intr, bus_generic_teardown_intr),
197 /* ACPI bus */
198 DEVMETHOD(acpi_id_probe, acpi_device_id_probe),
199 DEVMETHOD(acpi_evaluate_object, acpi_device_eval_obj),
200 DEVMETHOD(acpi_pwr_for_sleep, acpi_device_pwr_for_sleep),
201 DEVMETHOD(acpi_scan_children, acpi_device_scan_children),
203 /* PCI emulation */
204 DEVMETHOD(pci_set_powerstate, acpi_set_powerstate_method),
206 /* ISA emulation */
207 DEVMETHOD(isa_pnp_probe, acpi_isa_pnp_probe),
209 DEVMETHOD_END
212 static driver_t acpi_driver = {
213 "acpi",
214 acpi_methods,
215 sizeof(struct acpi_softc),
218 static devclass_t acpi_devclass;
219 DRIVER_MODULE(acpi, nexus, acpi_driver, acpi_devclass, acpi_modevent, NULL);
220 MODULE_VERSION(acpi, 1);
222 ACPI_SERIAL_DECL(acpi, "ACPI serializer");
224 /* Local pools for managing system resources for ACPI child devices. */
225 static struct rman acpi_rman_io, acpi_rman_mem;
227 #define ACPI_MINIMUM_AWAKETIME 5
229 static const char* sleep_state_names[] = {
230 "S0", "S1", "S2", "S3", "S4", "S5", "NONE"};
232 SYSCTL_NODE(_debug, OID_AUTO, acpi, CTLFLAG_RD, NULL, "ACPI debugging");
233 static char acpi_ca_version[12];
234 SYSCTL_STRING(_debug_acpi, OID_AUTO, acpi_ca_version, CTLFLAG_RD,
235 acpi_ca_version, 0, "Version of Intel ACPICA");
238 * Allow overriding _OSI methods.
240 static char acpi_install_interface[256];
241 TUNABLE_STR("hw.acpi.install_interface", acpi_install_interface,
242 sizeof(acpi_install_interface));
243 static char acpi_remove_interface[256];
244 TUNABLE_STR("hw.acpi.remove_interface", acpi_remove_interface,
245 sizeof(acpi_remove_interface));
248 * Use this tunable to disable the control method auto-serialization
249 * mechanism that was added in 20140214 and superseded the previous
250 * AcpiGbl_SerializeAllMethods global.
252 static int acpi_auto_serialize_methods = 1;
253 TUNABLE_INT("hw.acpi.auto_serialize_methods", &acpi_auto_serialize_methods);
255 /* Allow users to dump Debug objects without ACPI debugger. */
256 static int acpi_debug_objects;
257 TUNABLE_INT("debug.acpi.enable_debug_objects", &acpi_debug_objects);
258 SYSCTL_PROC(_debug_acpi, OID_AUTO, enable_debug_objects,
259 CTLFLAG_RW | CTLTYPE_INT, NULL, 0, acpi_debug_objects_sysctl, "I",
260 "Enable Debug objects.");
262 /* Allow ignoring the XSDT. */
263 static int acpi_ignore_xsdt;
264 TUNABLE_INT("debug.acpi.ignore_xsdt", &acpi_ignore_xsdt);
265 SYSCTL_INT(_debug_acpi, OID_AUTO, ignore_xsdt, CTLFLAG_RD,
266 &acpi_ignore_xsdt, 1, "Ignore the XSDT, forcing the use of the RSDT.");
268 /* Allow the interpreter to ignore common mistakes in BIOS. */
269 static int acpi_interpreter_slack = 1;
270 TUNABLE_INT("debug.acpi.interpreter_slack", &acpi_interpreter_slack);
271 SYSCTL_INT(_debug_acpi, OID_AUTO, interpreter_slack, CTLFLAG_RD,
272 &acpi_interpreter_slack, 1, "Turn on interpreter slack mode.");
274 /* Allow preferring 32-bit FADT register addresses over the 64-bit ones. */
275 static int acpi_fadt_addr32;
276 TUNABLE_INT("debug.acpi.fadt_addr32", &acpi_fadt_addr32);
277 SYSCTL_INT(_debug_acpi, OID_AUTO, fadt_addr32, CTLFLAG_RD,
278 &acpi_fadt_addr32, 1,
279 "Prefer 32-bit FADT register addresses over 64-bit ones.");
281 /* Prefer 32-bit FACS table addresses over the 64-bit ones. */
282 static int acpi_facs_addr32 = 1;
283 TUNABLE_INT("debug.acpi.facs_addr32", &acpi_facs_addr32);
284 SYSCTL_INT(_debug_acpi, OID_AUTO, facs_addr32, CTLFLAG_RD,
285 &acpi_facs_addr32, 1,
286 "Prefer 32-bit FACS table addresses over 64-bit ones.");
288 static int acpi_group_module_level_code;
289 TUNABLE_INT("debug.acpi.group_module_level_code", &acpi_group_module_level_code);
290 SYSCTL_INT(_debug_acpi, OID_AUTO, group_module_level_code, CTLFLAG_RD,
291 &acpi_group_module_level_code, 1,
292 "Group module-level code.");
294 /* Power devices off and on in suspend and resume. XXX Remove once tested. */
295 static int acpi_do_powerstate = 1;
296 TUNABLE_INT("debug.acpi.do_powerstate", &acpi_do_powerstate);
297 SYSCTL_INT(_debug_acpi, OID_AUTO, do_powerstate, CTLFLAG_RW,
298 &acpi_do_powerstate, 1, "Turn off devices when suspending.");
300 /* Allow users to override quirks. */
301 TUNABLE_INT("debug.acpi.quirks", &acpi_quirks);
303 /* Allow to call ACPI methods from userland. */
304 static int acpi_allow_mcall;
305 TUNABLE_INT("debug.acpi.allow_method_calls", &acpi_allow_mcall);
307 static int acpi_susp_bounce;
308 SYSCTL_INT(_debug_acpi, OID_AUTO, suspend_bounce, CTLFLAG_RW,
309 &acpi_susp_bounce, 0, "Don't actually suspend, just test devices.");
312 * ACPI can only be loaded as a module by the loader; activating it after
313 * system bootstrap time is not useful, and can be fatal to the system.
314 * It also cannot be unloaded, since the entire system bus heirarchy hangs
315 * off it.
317 static int
318 acpi_modevent(struct module *mod, int event, void *junk)
320 switch (event) {
321 case MOD_LOAD:
322 if (!cold) {
323 kprintf("The ACPI driver cannot be loaded after boot.\n");
324 return (EPERM);
326 break;
327 case MOD_UNLOAD:
328 if (!cold && power_pm_get_type() == POWER_PM_TYPE_ACPI)
329 return (EBUSY);
330 break;
331 default:
332 break;
334 return (0);
338 * Perform early initialization.
340 ACPI_STATUS
341 acpi_Startup(void)
343 static int started = 0;
344 ACPI_STATUS status;
345 int val;
347 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
349 /* Only run the startup code once. The MADT driver also calls this. */
350 if (started)
351 return_VALUE (AE_OK);
352 started = 1;
355 * Pre-allocate space for RSDT/XSDT and DSDT tables and allow resizing
356 * if more tables exist.
358 if (ACPI_FAILURE(status = AcpiInitializeTables(NULL, 2, TRUE))) {
359 kprintf("ACPI: Table initialisation failed: %s\n",
360 AcpiFormatException(status));
361 return_VALUE (status);
364 /* Set up any quirks we have for this system. */
365 if (acpi_quirks == ACPI_Q_OK)
366 acpi_table_quirks(&acpi_quirks);
368 /* If the user manually set the disabled hint to 0, force-enable ACPI. */
369 if (resource_int_value("acpi", 0, "disabled", &val) == 0 && val == 0)
370 acpi_quirks &= ~ACPI_Q_BROKEN;
371 if (acpi_quirks & ACPI_Q_BROKEN) {
372 kprintf("ACPI disabled by blacklist. Contact your BIOS vendor.\n");
373 status = AE_SUPPORT;
376 return_VALUE (status);
380 * Detect ACPI, perform early initialisation
382 static void
383 acpi_identify(driver_t *driver, device_t parent)
385 device_t child;
387 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
389 if (!cold)
390 return_VOID;
392 /* Check that we haven't been disabled with a hint. */
393 if (resource_disabled("acpi", 0))
394 return_VOID;
396 /* Make sure we're not being doubly invoked. */
397 if (device_find_child(parent, "acpi", 0) != NULL)
398 return_VOID;
400 ksnprintf(acpi_ca_version, sizeof(acpi_ca_version), "%x", ACPI_CA_VERSION);
402 /* Initialize root tables. */
403 if (ACPI_FAILURE(acpi_Startup())) {
404 kprintf("ACPI: Try disabling either ACPI or apic support.\n");
405 return_VOID;
408 /* Attach the actual ACPI device. */
409 if ((child = BUS_ADD_CHILD(parent, parent, 10, "acpi", 0)) == NULL) {
410 device_printf(parent, "device_identify failed\n");
411 return_VOID;
416 * Fetch some descriptive data from ACPI to put in our attach message.
418 static int
419 acpi_probe(device_t dev)
421 ACPI_TABLE_RSDP *rsdp;
422 ACPI_TABLE_HEADER *rsdt;
423 ACPI_PHYSICAL_ADDRESS paddr;
424 char buf[ACPI_OEM_ID_SIZE + ACPI_OEM_TABLE_ID_SIZE + 2];
425 struct sbuf sb;
427 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
429 if (power_pm_get_type() != POWER_PM_TYPE_NONE &&
430 power_pm_get_type() != POWER_PM_TYPE_ACPI) {
431 device_printf(dev, "probe failed, other PM system enabled.\n");
432 return_VALUE (ENXIO);
435 if ((paddr = AcpiOsGetRootPointer()) == 0 ||
436 (rsdp = AcpiOsMapMemory(paddr, sizeof(ACPI_TABLE_RSDP))) == NULL)
437 return_VALUE (ENXIO);
438 if (acpi_ignore_xsdt == 0 &&
439 rsdp->Revision > 1 && rsdp->XsdtPhysicalAddress != 0)
440 paddr = (ACPI_PHYSICAL_ADDRESS)rsdp->XsdtPhysicalAddress;
441 else
442 paddr = (ACPI_PHYSICAL_ADDRESS)rsdp->RsdtPhysicalAddress;
443 AcpiOsUnmapMemory(rsdp, sizeof(ACPI_TABLE_RSDP));
445 if ((rsdt = AcpiOsMapMemory(paddr, sizeof(ACPI_TABLE_HEADER))) == NULL)
446 return_VALUE (ENXIO);
447 sbuf_new(&sb, buf, sizeof(buf), SBUF_FIXEDLEN);
448 sbuf_bcat(&sb, rsdt->OemId, ACPI_OEM_ID_SIZE);
449 sbuf_trim(&sb);
450 sbuf_putc(&sb, ' ');
451 sbuf_bcat(&sb, rsdt->OemTableId, ACPI_OEM_TABLE_ID_SIZE);
452 sbuf_trim(&sb);
453 sbuf_finish(&sb);
454 device_set_desc_copy(dev, sbuf_data(&sb));
455 sbuf_delete(&sb);
456 AcpiOsUnmapMemory(rsdt, sizeof(ACPI_TABLE_HEADER));
458 return_VALUE (0);
461 static int
462 acpi_attach(device_t dev)
464 struct acpi_softc *sc;
465 ACPI_STATUS status;
466 int error, state;
467 UINT32 flags;
468 UINT8 TypeA, TypeB;
469 char *env;
471 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
473 sc = device_get_softc(dev);
474 sc->acpi_dev = dev;
475 callout_init(&sc->susp_force_to);
477 if ((error = acpi_task_thread_init())) {
478 device_printf(dev, "Could not start task thread.\n");
479 goto out;
482 error = ENXIO;
484 /* Initialize resource manager. */
485 acpi_rman_io.rm_type = RMAN_ARRAY;
486 acpi_rman_io.rm_start = 0;
487 acpi_rman_io.rm_end = 0xffff;
488 acpi_rman_io.rm_descr = "ACPI I/O ports";
489 if (rman_init(&acpi_rman_io, -1) != 0)
490 panic("acpi rman_init IO ports failed");
491 acpi_rman_mem.rm_type = RMAN_ARRAY;
492 acpi_rman_mem.rm_start = 0;
493 acpi_rman_mem.rm_end = ~0ul;
494 acpi_rman_mem.rm_descr = "ACPI I/O memory addresses";
495 if (rman_init(&acpi_rman_mem, -1) != 0)
496 panic("acpi rman_init memory failed");
498 /* Initialise the ACPI mutex */
499 ACPI_LOCK_INIT(acpi, "acpi");
500 ACPI_SERIAL_INIT(acpi);
503 * Set the globals from our tunables. This is needed because ACPICA
504 * uses UINT8 for some values and we have no tunable_byte.
506 AcpiGbl_AutoSerializeMethods = acpi_auto_serialize_methods ? TRUE : FALSE;
507 AcpiGbl_DoNotUseXsdt = acpi_ignore_xsdt ? TRUE : FALSE;
508 AcpiGbl_EnableAmlDebugObject = acpi_debug_objects ? TRUE : FALSE;
509 AcpiGbl_EnableInterpreterSlack = acpi_interpreter_slack ? TRUE : FALSE;
510 AcpiGbl_GroupModuleLevelCode = acpi_group_module_level_code ? TRUE : FALSE;
511 AcpiGbl_Use32BitFadtAddresses = acpi_fadt_addr32 ? TRUE : FALSE;
512 AcpiGbl_Use32BitFacsAddresses = acpi_facs_addr32 ? TRUE : FALSE;
514 #ifndef ACPI_DEBUG
516 * Disable Debug Object output.
518 AcpiDbgLevel &= ~ACPI_LV_DEBUG_OBJECT;
519 #endif
521 /* Start up the ACPICA subsystem. */
522 status = AcpiInitializeSubsystem();
523 if (ACPI_FAILURE(status)) {
524 device_printf(dev, "Could not initialize Subsystem: %s\n",
525 AcpiFormatException(status));
526 goto out;
529 /* Override OS interfaces if the user requested. */
530 acpi_reset_interfaces(dev);
532 /* Load ACPI name space. */
533 status = AcpiLoadTables();
534 if (ACPI_FAILURE(status)) {
535 device_printf(dev, "Could not load Namespace: %s\n",
536 AcpiFormatException(status));
537 goto out;
540 /* Handle MCFG table if present. */
541 acpi_enable_pcie();
544 * Note that some systems (specifically, those with namespace evaluation
545 * issues that require the avoidance of parts of the namespace) must
546 * avoid running _INI and _STA on everything, as well as dodging the final
547 * object init pass.
549 * For these devices, we set ACPI_NO_DEVICE_INIT and ACPI_NO_OBJECT_INIT).
551 * XXX We should arrange for the object init pass after we have attached
552 * all our child devices, but on many systems it works here.
554 flags = ACPI_FULL_INITIALIZATION;
555 if (ktestenv("debug.acpi.avoid"))
556 flags = ACPI_NO_DEVICE_INIT | ACPI_NO_OBJECT_INIT;
558 /* Bring the hardware and basic handlers online. */
559 if (ACPI_FAILURE(status = AcpiEnableSubsystem(flags))) {
560 device_printf(dev, "Could not enable ACPI: %s\n",
561 AcpiFormatException(status));
562 goto out;
566 * Fix up the interrupt timer after enabling ACPI, so that the
567 * interrupt cputimer that choked by ACPI power management could
568 * be resurrected before probing various devices.
570 DELAY(5000);
571 cputimer_intr_pmfixup();
574 * Call the ECDT probe function to provide EC functionality before
575 * the namespace has been evaluated.
577 * XXX This happens before the sysresource devices have been probed and
578 * attached so its resources come from nexus0. In practice, this isn't
579 * a problem but should be addressed eventually.
581 acpi_ec_ecdt_probe(dev);
583 /* Bring device objects and regions online. */
584 if (ACPI_FAILURE(status = AcpiInitializeObjects(flags))) {
585 device_printf(dev, "Could not initialize ACPI objects: %s\n",
586 AcpiFormatException(status));
587 goto out;
591 * Setup our sysctl tree.
593 * XXX: This doesn't check to make sure that none of these fail.
595 sysctl_ctx_init(&sc->acpi_sysctl_ctx);
596 sc->acpi_sysctl_tree = SYSCTL_ADD_NODE(&sc->acpi_sysctl_ctx,
597 SYSCTL_STATIC_CHILDREN(_hw), OID_AUTO,
598 device_get_name(dev), CTLFLAG_RD, 0, "");
599 SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
600 OID_AUTO, "supported_sleep_state", CTLTYPE_STRING | CTLFLAG_RD,
601 0, 0, acpi_supported_sleep_state_sysctl, "A", "");
602 SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
603 OID_AUTO, "power_button_state", CTLTYPE_STRING | CTLFLAG_RW,
604 &sc->acpi_power_button_sx, 0, acpi_sleep_state_sysctl, "A", "");
605 SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
606 OID_AUTO, "sleep_button_state", CTLTYPE_STRING | CTLFLAG_RW,
607 &sc->acpi_sleep_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, "lid_switch_state", CTLTYPE_STRING | CTLFLAG_RW,
610 &sc->acpi_lid_switch_sx, 0, acpi_sleep_state_sysctl, "A", "");
611 SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
612 OID_AUTO, "standby_state", CTLTYPE_STRING | CTLFLAG_RW,
613 &sc->acpi_standby_sx, 0, acpi_sleep_state_sysctl, "A", "");
614 SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
615 OID_AUTO, "suspend_state", CTLTYPE_STRING | CTLFLAG_RW,
616 &sc->acpi_suspend_sx, 0, acpi_sleep_state_sysctl, "A", "");
617 SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
618 OID_AUTO, "sleep_delay", CTLFLAG_RW, &sc->acpi_sleep_delay, 0,
619 "sleep delay");
620 SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
621 OID_AUTO, "s4bios", CTLFLAG_RW, &sc->acpi_s4bios, 0, "S4BIOS mode");
622 SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
623 OID_AUTO, "verbose", CTLFLAG_RW, &sc->acpi_verbose, 0, "verbose mode");
624 SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
625 OID_AUTO, "disable_on_reboot", CTLFLAG_RW,
626 &sc->acpi_do_disable, 0, "Disable ACPI when rebooting/halting system");
627 SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
628 OID_AUTO, "handle_reboot", CTLFLAG_RW,
629 &sc->acpi_handle_reboot, 0, "Use ACPI Reset Register to reboot");
632 * Default to 1 second before sleeping to give some machines time to
633 * stabilize.
635 sc->acpi_sleep_delay = 1;
636 if (bootverbose)
637 sc->acpi_verbose = 1;
638 if ((env = kgetenv("hw.acpi.verbose")) != NULL) {
639 if (strcmp(env, "0") != 0)
640 sc->acpi_verbose = 1;
641 kfreeenv(env);
644 /* Only enable reboot by default if the FADT says it is available. */
645 if (AcpiGbl_FADT.Flags & ACPI_FADT_RESET_REGISTER)
646 sc->acpi_handle_reboot = 1;
648 /* Only enable S4BIOS by default if the FACS says it is available. */
649 if (AcpiGbl_FACS->Flags & ACPI_FACS_S4_BIOS_PRESENT)
650 sc->acpi_s4bios = 1;
653 * Dispatch the default sleep state to devices. The lid switch is set
654 * to NONE by default to avoid surprising users.
656 sc->acpi_power_button_sx = ACPI_STATE_S5;
657 sc->acpi_lid_switch_sx = ACPI_S_STATES_MAX + 1;
658 sc->acpi_standby_sx = ACPI_STATE_S1;
659 sc->acpi_suspend_sx = ACPI_STATE_S3;
661 /* Pick the first valid sleep state for the sleep button default. */
662 sc->acpi_sleep_button_sx = ACPI_S_STATES_MAX + 1;
663 for (state = ACPI_STATE_S1; state <= ACPI_STATE_S4; state++)
664 if (ACPI_SUCCESS(AcpiGetSleepTypeData(state, &TypeA, &TypeB))) {
665 sc->acpi_sleep_button_sx = state;
666 break;
669 acpi_enable_fixed_events(sc);
672 * Scan the namespace and attach/initialise children.
675 /* Register our shutdown handler. */
676 EVENTHANDLER_REGISTER(shutdown_final, acpi_shutdown_final, sc,
677 SHUTDOWN_PRI_LAST);
680 * Register our acpi event handlers.
681 * XXX should be configurable eg. via userland policy manager.
683 EVENTHANDLER_REGISTER(acpi_sleep_event, acpi_system_eventhandler_sleep,
684 sc, ACPI_EVENT_PRI_LAST);
685 EVENTHANDLER_REGISTER(acpi_wakeup_event, acpi_system_eventhandler_wakeup,
686 sc, ACPI_EVENT_PRI_LAST);
688 /* Flag our initial states. */
689 sc->acpi_enabled = 1;
690 sc->acpi_sstate = ACPI_STATE_S0;
691 sc->acpi_sleep_disabled = 0;
692 /* Create the control device */
693 sc->acpi_dev_t = make_dev(&acpi_ops, 0, UID_ROOT, GID_WHEEL, 0644, "acpi");
694 sc->acpi_dev_t->si_drv1 = sc;
696 if ((error = acpi_machdep_init(dev)))
697 goto out;
699 /* Register ACPI again to pass the correct argument of pm_func. */
700 power_pm_register(POWER_PM_TYPE_ACPI, acpi_pm_func, sc);
702 if (!acpi_disabled("bus"))
703 acpi_probe_children(dev);
705 /* Update all GPEs and enable runtime GPEs. */
706 status = AcpiUpdateAllGpes();
707 if (ACPI_FAILURE(status)) {
708 device_printf(dev, "Could not update all GPEs: %s\n",
709 AcpiFormatException(status));
712 /* Allow sleep request after a while. */
713 /* timeout(acpi_sleep_enable, sc, hz * ACPI_MINIMUM_AWAKETIME); */
715 error = 0;
717 out:
718 cputimer_intr_pmfixup();
719 acpi_task_thread_schedule();
720 return_VALUE (error);
723 static int
724 acpi_suspend(device_t dev)
726 device_t child, *devlist;
727 int error, i, numdevs, pstate;
729 /* First give child devices a chance to suspend. */
730 error = bus_generic_suspend(dev);
731 if (error)
732 return (error);
735 * Now, set them into the appropriate power state, usually D3. If the
736 * device has an _SxD method for the next sleep state, use that power
737 * state instead.
739 device_get_children(dev, &devlist, &numdevs);
740 for (i = 0; i < numdevs; i++) {
741 /* If the device is not attached, we've powered it down elsewhere. */
742 child = devlist[i];
743 if (!device_is_attached(child))
744 continue;
747 * Default to D3 for all sleep states. The _SxD method is optional
748 * so set the powerstate even if it's absent.
750 pstate = PCI_POWERSTATE_D3;
751 error = acpi_device_pwr_for_sleep(device_get_parent(child),
752 child, &pstate);
753 if ((error == 0 || error == ESRCH) && acpi_do_powerstate)
754 pci_set_powerstate(child, pstate);
756 kfree(devlist, M_TEMP);
757 error = 0;
759 return (error);
762 static int
763 acpi_resume(device_t dev)
765 ACPI_HANDLE handle;
766 int i, numdevs;
767 device_t child, *devlist;
770 * Put all devices in D0 before resuming them. Call _S0D on each one
771 * since some systems expect this.
773 device_get_children(dev, &devlist, &numdevs);
774 for (i = 0; i < numdevs; i++) {
775 child = devlist[i];
776 handle = acpi_get_handle(child);
777 if (handle)
778 AcpiEvaluateObject(handle, "_S0D", NULL, NULL);
779 if (device_is_attached(child) && acpi_do_powerstate)
780 pci_set_powerstate(child, PCI_POWERSTATE_D0);
782 kfree(devlist, M_TEMP);
784 return (bus_generic_resume(dev));
787 static int
788 acpi_shutdown(device_t dev)
790 /* Allow children to shutdown first. */
791 bus_generic_shutdown(dev);
794 * Enable any GPEs that are able to power-on the system (i.e., RTC).
795 * Also, disable any that are not valid for this state (most).
797 acpi_wake_prep_walk(ACPI_STATE_S5);
799 return (0);
803 * Handle a new device being added
805 static device_t
806 acpi_add_child(device_t bus, device_t parent, int order, const char *name, int unit)
808 struct acpi_device *ad;
809 device_t child;
811 if ((ad = kmalloc(sizeof(*ad), M_ACPIDEV, M_NOWAIT | M_ZERO)) == NULL)
812 return (NULL);
814 resource_list_init(&ad->ad_rl);
815 child = device_add_child_ordered(parent, order, name, unit);
816 if (child != NULL)
817 device_set_ivars(child, ad);
818 else
819 kfree(ad, M_ACPIDEV);
820 return (child);
823 static int
824 acpi_print_child(device_t bus, device_t child)
826 struct acpi_device *adev = device_get_ivars(child);
827 struct resource_list *rl = &adev->ad_rl;
828 int retval = 0;
830 retval += bus_print_child_header(bus, child);
831 retval += resource_list_print_type(rl, "port", SYS_RES_IOPORT, "%#lx");
832 retval += resource_list_print_type(rl, "iomem", SYS_RES_MEMORY, "%#lx");
833 retval += resource_list_print_type(rl, "irq", SYS_RES_IRQ, "%ld");
834 retval += resource_list_print_type(rl, "drq", SYS_RES_DRQ, "%ld");
835 if (device_get_flags(child))
836 retval += kprintf(" flags %#x", device_get_flags(child));
837 retval += bus_print_child_footer(bus, child);
839 return (retval);
843 * If this device is an ACPI child but no one claimed it, attempt
844 * to power it off. We'll power it back up when a driver is added.
846 * XXX Disabled for now since many necessary devices (like fdc and
847 * ATA) don't claim the devices we created for them but still expect
848 * them to be powered up.
850 static void
851 acpi_probe_nomatch(device_t bus, device_t child)
854 /* pci_set_powerstate(child, PCI_POWERSTATE_D3); */
858 * If a new driver has a chance to probe a child, first power it up.
860 * XXX Disabled for now (see acpi_probe_nomatch for details).
862 static void
863 acpi_driver_added(device_t dev, driver_t *driver)
865 device_t child, *devlist;
866 int i, numdevs;
868 DEVICE_IDENTIFY(driver, dev);
869 device_get_children(dev, &devlist, &numdevs);
870 for (i = 0; i < numdevs; i++) {
871 child = devlist[i];
872 if (device_get_state(child) == DS_NOTPRESENT) {
873 /* pci_set_powerstate(child, PCI_POWERSTATE_D0); */
874 if (device_probe_and_attach(child) != 0)
875 ; /* pci_set_powerstate(child, PCI_POWERSTATE_D3); */
878 kfree(devlist, M_TEMP);
881 /* Location hint for devctl(8) */
882 static int
883 acpi_child_location_str_method(device_t cbdev, device_t child, char *buf,
884 size_t buflen)
886 struct acpi_device *dinfo = device_get_ivars(child);
888 if (dinfo->ad_handle)
889 ksnprintf(buf, buflen, "handle=%s", acpi_name(dinfo->ad_handle));
890 else
891 ksnprintf(buf, buflen, "unknown");
892 return (0);
895 /* PnP information for devctl(8) */
896 static int
897 acpi_child_pnpinfo_str_method(device_t cbdev, device_t child, char *buf,
898 size_t buflen)
900 ACPI_DEVICE_INFO *adinfo;
901 struct acpi_device *dinfo = device_get_ivars(child);
902 char *end;
904 if (ACPI_FAILURE(AcpiGetObjectInfo(dinfo->ad_handle, &adinfo))) {
905 ksnprintf(buf, buflen, "unknown");
906 } else {
907 ksnprintf(buf, buflen, "_HID=%s _UID=%lu",
908 (adinfo->Valid & ACPI_VALID_HID) ?
909 adinfo->HardwareId.String : "none",
910 (adinfo->Valid & ACPI_VALID_UID) ?
911 strtoul(adinfo->UniqueId.String, &end, 10) : 0);
912 if (adinfo)
913 AcpiOsFree(adinfo);
915 return (0);
919 * Handle per-device ivars
921 static int
922 acpi_read_ivar(device_t dev, device_t child, int index, uintptr_t *result)
924 struct acpi_device *ad;
926 if ((ad = device_get_ivars(child)) == NULL) {
927 device_printf(child, "device has no ivars\n");
928 return (ENOENT);
931 /* ACPI and ISA compatibility ivars */
932 switch(index) {
933 case ACPI_IVAR_HANDLE:
934 *(ACPI_HANDLE *)result = ad->ad_handle;
935 break;
936 case ACPI_IVAR_MAGIC:
937 *result = ad->ad_magic;
938 break;
939 case ACPI_IVAR_PRIVATE:
940 *(void **)result = ad->ad_private;
941 break;
942 case ACPI_IVAR_FLAGS:
943 *(int *)result = ad->ad_flags;
944 break;
945 case ISA_IVAR_VENDORID:
946 case ISA_IVAR_SERIAL:
947 case ISA_IVAR_COMPATID:
948 *(int *)result = -1;
949 break;
950 case ISA_IVAR_LOGICALID:
951 *(int *)result = acpi_isa_get_logicalid(child);
952 break;
953 default:
954 return (ENOENT);
957 return (0);
960 static int
961 acpi_write_ivar(device_t dev, device_t child, int index, uintptr_t value)
963 struct acpi_device *ad;
965 if ((ad = device_get_ivars(child)) == NULL) {
966 device_printf(child, "device has no ivars\n");
967 return (ENOENT);
970 switch(index) {
971 case ACPI_IVAR_HANDLE:
972 ad->ad_handle = (ACPI_HANDLE)value;
973 break;
974 case ACPI_IVAR_MAGIC:
975 ad->ad_magic = value;
976 break;
977 case ACPI_IVAR_PRIVATE:
978 ad->ad_private = (void *)value;
979 break;
980 case ACPI_IVAR_FLAGS:
981 ad->ad_flags = (int)value;
982 break;
983 default:
984 panic("bad ivar write request (%d)", index);
985 return (ENOENT);
988 return (0);
992 * Handle child resource allocation/removal
994 static struct resource_list *
995 acpi_get_rlist(device_t dev, device_t child)
997 struct acpi_device *ad;
999 ad = device_get_ivars(child);
1000 return (&ad->ad_rl);
1004 * Pre-allocate/manage all memory and IO resources. Since rman can't handle
1005 * duplicates, we merge any in the sysresource attach routine.
1007 static int
1008 acpi_sysres_alloc(device_t dev)
1010 struct resource *res;
1011 struct resource_list *rl;
1012 struct resource_list_entry *rle;
1013 struct rman *rm;
1014 char *sysres_ids[] = { "PNP0C01", "PNP0C02", NULL };
1015 device_t *children;
1016 int child_count, i;
1018 * Probe/attach any sysresource devices. This would be unnecessary if we
1019 * had multi-pass probe/attach.
1021 if (device_get_children(dev, &children, &child_count) != 0)
1022 return (ENXIO);
1023 for (i = 0; i < child_count; i++) {
1024 if (ACPI_ID_PROBE(dev, children[i], sysres_ids) != NULL)
1025 device_probe_and_attach(children[i]);
1027 kfree(children, M_TEMP);
1029 rl = BUS_GET_RESOURCE_LIST(device_get_parent(dev), dev);
1030 if(!rl)
1031 return 0;
1032 SLIST_FOREACH(rle, rl, link) {
1033 if (rle->res != NULL) {
1034 device_printf(dev, "duplicate resource for %lx\n", rle->start);
1035 continue;
1038 /* Only memory and IO resources are valid here. */
1039 switch (rle->type) {
1040 case SYS_RES_IOPORT:
1041 rm = &acpi_rman_io;
1042 break;
1043 case SYS_RES_MEMORY:
1044 rm = &acpi_rman_mem;
1045 break;
1046 default:
1047 continue;
1050 /* Pre-allocate resource and add to our rman pool. */
1051 res = BUS_ALLOC_RESOURCE(device_get_parent(dev), dev, rle->type,
1052 &rle->rid, rle->start, rle->start + rle->count - 1, rle->count,
1053 0, -1);
1054 if (res != NULL) {
1055 rman_manage_region(rm, rman_get_start(res), rman_get_end(res));
1056 rle->res = res;
1057 } else
1058 device_printf(dev, "reservation of %lx, %lx (%d) failed\n",
1059 rle->start, rle->count, rle->type);
1061 return (0);
1064 static struct resource *
1065 acpi_alloc_resource(device_t bus, device_t child, int type, int *rid,
1066 u_long start, u_long end, u_long count, u_int flags, int cpuid)
1068 ACPI_RESOURCE ares;
1069 struct acpi_device *ad = device_get_ivars(child);
1070 struct resource_list *rl = &ad->ad_rl;
1071 struct resource_list_entry *rle;
1072 struct resource *res;
1073 struct rman *rm;
1075 res = NULL;
1077 /* We only handle memory and IO resources through rman. */
1078 switch (type) {
1079 case SYS_RES_IOPORT:
1080 rm = &acpi_rman_io;
1081 break;
1082 case SYS_RES_MEMORY:
1083 rm = &acpi_rman_mem;
1084 break;
1085 default:
1086 rm = NULL;
1089 ACPI_SERIAL_BEGIN(acpi);
1092 * If this is an allocation of the "default" range for a given RID, and
1093 * we know what the resources for this device are (i.e., they're on the
1094 * child's resource list), use those start/end values.
1096 if (bus == device_get_parent(child) && start == 0UL && end == ~0UL) {
1097 rle = resource_list_find(rl, type, *rid);
1098 if (rle == NULL)
1099 goto out;
1100 start = rle->start;
1101 end = rle->end;
1102 count = rle->count;
1103 cpuid = rle->cpuid;
1107 * If this is an allocation of a specific range, see if we can satisfy
1108 * the request from our system resource regions. If we can't, pass the
1109 * request up to the parent.
1111 if (start + count - 1 == end && rm != NULL)
1112 res = rman_reserve_resource(rm, start, end, count, flags & ~RF_ACTIVE,
1113 child);
1114 if (res == NULL) {
1115 res = BUS_ALLOC_RESOURCE(device_get_parent(bus), child, type, rid,
1116 start, end, count, flags, cpuid);
1117 } else {
1118 rman_set_rid(res, *rid);
1120 /* If requested, activate the resource using the parent's method. */
1121 if (flags & RF_ACTIVE)
1122 if (bus_activate_resource(child, type, *rid, res) != 0) {
1123 rman_release_resource(res);
1124 res = NULL;
1125 goto out;
1129 if (res != NULL && device_get_parent(child) == bus)
1130 switch (type) {
1131 case SYS_RES_IRQ:
1133 * Since bus_config_intr() takes immediate effect, we cannot
1134 * configure the interrupt associated with a device when we
1135 * parse the resources but have to defer it until a driver
1136 * actually allocates the interrupt via bus_alloc_resource().
1138 * NB: Lookup failure is fine, since the device may add its
1139 * own interrupt resources, e.g. MSI or MSI-X.
1141 if (ACPI_SUCCESS(
1142 acpi_lookup_irq_resource(child, *rid, res, &ares))) {
1143 acpi_config_intr(child, &ares);
1144 } else {
1145 kprintf("irq resource not found\n");
1147 break;
1150 out:
1151 ACPI_SERIAL_END(acpi);
1152 return (res);
1155 static int
1156 acpi_release_resource(device_t bus, device_t child, int type, int rid,
1157 struct resource *r)
1159 struct rman *rm;
1160 int ret;
1162 /* We only handle memory and IO resources through rman. */
1163 switch (type) {
1164 case SYS_RES_IOPORT:
1165 rm = &acpi_rman_io;
1166 break;
1167 case SYS_RES_MEMORY:
1168 rm = &acpi_rman_mem;
1169 break;
1170 default:
1171 rm = NULL;
1174 ACPI_SERIAL_BEGIN(acpi);
1177 * If this resource belongs to one of our internal managers,
1178 * deactivate it and release it to the local pool. If it doesn't,
1179 * pass this request up to the parent.
1181 if (rm != NULL && rman_is_region_manager(r, rm)) {
1182 if (rman_get_flags(r) & RF_ACTIVE) {
1183 ret = bus_deactivate_resource(child, type, rid, r);
1184 if (ret != 0)
1185 goto out;
1187 ret = rman_release_resource(r);
1188 } else
1189 ret = BUS_RELEASE_RESOURCE(device_get_parent(bus), child, type, rid, r);
1191 out:
1192 ACPI_SERIAL_END(acpi);
1193 return (ret);
1196 static void
1197 acpi_delete_resource(device_t bus, device_t child, int type, int rid)
1199 struct resource_list *rl;
1201 rl = acpi_get_rlist(bus, child);
1202 resource_list_delete(rl, type, rid);
1205 /* Allocate an IO port or memory resource, given its GAS. */
1207 acpi_bus_alloc_gas(device_t dev, int *type, int *rid, ACPI_GENERIC_ADDRESS *gas,
1208 struct resource **res, u_int flags)
1210 int error, res_type;
1212 error = ENOMEM;
1213 if (type == NULL || rid == NULL || gas == NULL || res == NULL)
1214 return (EINVAL);
1216 /* We only support memory and IO spaces. */
1217 switch (gas->SpaceId) {
1218 case ACPI_ADR_SPACE_SYSTEM_MEMORY:
1219 res_type = SYS_RES_MEMORY;
1220 break;
1221 case ACPI_ADR_SPACE_SYSTEM_IO:
1222 res_type = SYS_RES_IOPORT;
1223 break;
1224 default:
1225 return (EOPNOTSUPP);
1229 * If the register width is less than 8, assume the BIOS author means
1230 * it is a bit field and just allocate a byte.
1232 if (gas->BitWidth && gas->BitWidth < 8)
1233 gas->BitWidth = 8;
1235 /* Validate the address after we're sure we support the space. */
1236 if (gas->Address == 0 || gas->BitWidth == 0)
1237 return (EINVAL);
1239 bus_set_resource(dev, res_type, *rid, gas->Address,
1240 gas->BitWidth / 8, -1);
1241 *res = bus_alloc_resource_any(dev, res_type, rid, RF_ACTIVE | flags);
1242 if (*res != NULL) {
1243 *type = res_type;
1244 error = 0;
1245 } else
1246 bus_delete_resource(dev, res_type, *rid);
1248 return (error);
1251 ACPI_STATUS
1252 acpi_eval_osc(device_t dev, ACPI_HANDLE handle, const char *uuidstr,
1253 int revision, uint32_t *buf, int count)
1255 ACPI_BUFFER retbuf = { ACPI_ALLOCATE_BUFFER, NULL };
1256 ACPI_OBJECT_LIST arglist;
1257 ACPI_OBJECT arg[4];
1258 ACPI_OBJECT *retobj;
1259 ACPI_STATUS status;
1260 struct uuid uuid;
1261 uint32_t error;
1262 uint8_t oscuuid[16];
1263 int i;
1265 if (parse_uuid(uuidstr, &uuid) != 0)
1266 return (AE_ERROR);
1267 le_uuid_enc(oscuuid, &uuid);
1269 arglist.Pointer = arg;
1270 arglist.Count = 4;
1271 arg[0].Type = ACPI_TYPE_BUFFER;
1272 arg[0].Buffer.Length = sizeof(oscuuid);
1273 arg[0].Buffer.Pointer = oscuuid; /* UUID */
1274 arg[1].Type = ACPI_TYPE_INTEGER;
1275 arg[1].Integer.Value = revision; /* revision */
1276 arg[2].Type = ACPI_TYPE_INTEGER;
1277 arg[2].Integer.Value = count; /* # of cap integers */
1278 arg[3].Type = ACPI_TYPE_BUFFER;
1279 arg[3].Buffer.Length = count * sizeof(uint32_t); /* capabilities buffer */
1280 arg[3].Buffer.Pointer = (uint8_t *)buf;
1282 status = AcpiEvaluateObject(handle, "_OSC", &arglist, &retbuf);
1283 if (ACPI_FAILURE(status))
1284 goto done;
1285 retobj = retbuf.Pointer;
1286 error = ((uint32_t *)retobj->Buffer.Pointer)[0] & ACPI_OSCERR_MASK;
1287 if (error == 0)
1288 goto done;
1289 status = AE_ERROR;
1290 if (error & ACPI_OSCERR_OSCFAIL)
1291 device_printf(dev, "_OSC unable to process request\n");
1292 if (error & ACPI_OSCERR_UUID)
1293 device_printf(dev, "_OSC unrecognized UUID (%s)\n", uuidstr);
1294 if (error & ACPI_OSCERR_REVISION)
1295 device_printf(dev, "_OSC unrecognized revision ID (%d)\n", revision);
1296 if (error & ACPI_OSCERR_CAPSMASKED) {
1297 if ((buf[0] & ACPI_OSC_QUERY_SUPPORT) == 0) {
1298 for (i = 1; i < count; i++) {
1299 device_printf(dev,
1300 "_OSC capabilities have been masked: buf[%d]:%#x\n",
1301 i, buf[i] & ~((uint32_t *)retobj->Buffer.Pointer)[i]);
1303 status = AE_SUPPORT;
1304 } else {
1305 status = AE_OK;
1309 done:
1310 if (retbuf.Pointer != NULL)
1311 AcpiOsFree(retbuf.Pointer);
1312 return (status);
1315 /* Probe _HID and _CID for compatible ISA PNP ids. */
1316 static uint32_t
1317 acpi_isa_get_logicalid(device_t dev)
1319 ACPI_DEVICE_INFO *devinfo;
1320 ACPI_HANDLE h;
1321 uint32_t pnpid;
1323 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1325 devinfo = NULL;
1326 pnpid = 0;
1328 /* Fetch and validate the HID. */
1329 if ((h = acpi_get_handle(dev)) == NULL ||
1330 ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo)))
1331 goto out;
1333 if ((devinfo->Valid & ACPI_VALID_HID) != 0)
1334 pnpid = PNP_EISAID(devinfo->HardwareId.String);
1336 out:
1337 if (devinfo)
1338 AcpiOsFree(devinfo);
1339 return_VALUE (pnpid);
1342 static int
1343 acpi_isa_get_compatid(device_t dev, uint32_t *cids, int count)
1345 ACPI_DEVICE_INFO *devinfo;
1346 ACPI_HANDLE h;
1347 uint32_t *pnpid;
1348 int valid, i;
1350 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1352 devinfo = NULL;
1353 pnpid = cids;
1354 valid = 0;
1356 /* Fetch and validate the CID */
1357 if ((h = acpi_get_handle(dev)) == NULL ||
1358 ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo)) ||
1359 (devinfo->Valid & ACPI_VALID_CID) == 0)
1360 goto out;
1362 if (devinfo->CompatibleIdList.Count < count)
1363 count = devinfo->CompatibleIdList.Count;
1364 for (i = 0; i < count; i++) {
1365 if (strncmp(devinfo->CompatibleIdList.Ids[i].String, "PNP", 3) != 0)
1366 continue;
1367 *pnpid++ = PNP_EISAID(devinfo->CompatibleIdList.Ids[i].String);
1368 valid++;
1371 out:
1372 if (devinfo)
1373 AcpiOsFree(devinfo);
1374 return_VALUE (valid);
1377 static char *
1378 acpi_device_id_probe(device_t bus, device_t dev, char **ids)
1380 ACPI_HANDLE h;
1381 int i;
1383 h = acpi_get_handle(dev);
1384 if (ids == NULL || h == NULL || acpi_get_type(dev) != ACPI_TYPE_DEVICE)
1385 return (NULL);
1387 /* Try to match one of the array of IDs with a HID or CID. */
1388 for (i = 0; ids[i] != NULL; i++) {
1389 if (acpi_MatchHid(h, ids[i]))
1390 return (ids[i]);
1392 return (NULL);
1395 static ACPI_STATUS
1396 acpi_device_eval_obj(device_t bus, device_t dev, ACPI_STRING pathname,
1397 ACPI_OBJECT_LIST *parameters, ACPI_BUFFER *ret)
1399 ACPI_HANDLE h;
1401 if (dev == NULL)
1402 h = ACPI_ROOT_OBJECT;
1403 else if ((h = acpi_get_handle(dev)) == NULL)
1404 return (AE_BAD_PARAMETER);
1405 return (AcpiEvaluateObject(h, pathname, parameters, ret));
1408 static int
1409 acpi_device_pwr_for_sleep(device_t bus, device_t dev, int *dstate)
1411 struct acpi_softc *sc;
1412 ACPI_HANDLE handle;
1413 ACPI_STATUS status;
1414 char sxd[8];
1415 int error;
1417 sc = device_get_softc(bus);
1418 handle = acpi_get_handle(dev);
1421 * XXX If we find these devices, don't try to power them down.
1422 * The serial and IRDA ports on my T23 hang the system when
1423 * set to D3 and it appears that such legacy devices may
1424 * need special handling in their drivers.
1426 if (handle == NULL ||
1427 acpi_MatchHid(handle, "PNP0500") ||
1428 acpi_MatchHid(handle, "PNP0501") ||
1429 acpi_MatchHid(handle, "PNP0502") ||
1430 acpi_MatchHid(handle, "PNP0510") ||
1431 acpi_MatchHid(handle, "PNP0511"))
1432 return (ENXIO);
1435 * Override next state with the value from _SxD, if present. If no
1436 * dstate argument was provided, don't fetch the return value.
1438 ksnprintf(sxd, sizeof(sxd), "_S%dD", sc->acpi_sstate);
1439 if (dstate)
1440 status = acpi_GetInteger(handle, sxd, dstate);
1441 else
1442 status = AcpiEvaluateObject(handle, sxd, NULL, NULL);
1444 switch (status) {
1445 case AE_OK:
1446 error = 0;
1447 break;
1448 case AE_NOT_FOUND:
1449 error = ESRCH;
1450 break;
1451 default:
1452 error = ENXIO;
1453 break;
1456 return (error);
1459 /* Callback arg for our implementation of walking the namespace. */
1460 struct acpi_device_scan_ctx {
1461 acpi_scan_cb_t user_fn;
1462 void *arg;
1463 ACPI_HANDLE parent;
1466 static ACPI_STATUS
1467 acpi_device_scan_cb(ACPI_HANDLE h, UINT32 level, void *arg, void **retval)
1469 struct acpi_device_scan_ctx *ctx;
1470 device_t dev, old_dev;
1471 ACPI_STATUS status;
1472 ACPI_OBJECT_TYPE type;
1475 * Skip this device if we think we'll have trouble with it or it is
1476 * the parent where the scan began.
1478 ctx = (struct acpi_device_scan_ctx *)arg;
1479 if (acpi_avoid(h) || h == ctx->parent)
1480 return (AE_OK);
1482 /* If this is not a valid device type (e.g., a method), skip it. */
1483 if (ACPI_FAILURE(AcpiGetType(h, &type)))
1484 return (AE_OK);
1485 if (type != ACPI_TYPE_DEVICE && type != ACPI_TYPE_PROCESSOR &&
1486 type != ACPI_TYPE_THERMAL && type != ACPI_TYPE_POWER)
1487 return (AE_OK);
1490 * Call the user function with the current device. If it is unchanged
1491 * afterwards, return. Otherwise, we update the handle to the new dev.
1493 old_dev = acpi_get_device(h);
1494 dev = old_dev;
1495 status = ctx->user_fn(h, &dev, level, ctx->arg);
1496 if (ACPI_FAILURE(status) || old_dev == dev)
1497 return (status);
1499 /* Remove the old child and its connection to the handle. */
1500 if (old_dev != NULL) {
1501 device_delete_child(device_get_parent(old_dev), old_dev);
1502 AcpiDetachData(h, acpi_fake_objhandler);
1505 /* Recreate the handle association if the user created a device. */
1506 if (dev != NULL)
1507 AcpiAttachData(h, acpi_fake_objhandler, dev);
1509 return (AE_OK);
1512 static ACPI_STATUS
1513 acpi_device_scan_children(device_t bus, device_t dev, int max_depth,
1514 acpi_scan_cb_t user_fn, void *arg)
1516 ACPI_HANDLE h;
1517 struct acpi_device_scan_ctx ctx;
1519 if (acpi_disabled("children"))
1520 return (AE_OK);
1522 if (dev == NULL)
1523 h = ACPI_ROOT_OBJECT;
1524 else if ((h = acpi_get_handle(dev)) == NULL)
1525 return (AE_BAD_PARAMETER);
1526 ctx.user_fn = user_fn;
1527 ctx.arg = arg;
1528 ctx.parent = h;
1529 return (AcpiWalkNamespace(ACPI_TYPE_ANY, h, max_depth,
1530 acpi_device_scan_cb, NULL, &ctx, NULL));
1534 * Even though ACPI devices are not PCI, we use the PCI approach for setting
1535 * device power states since it's close enough to ACPI.
1537 static int
1538 acpi_set_powerstate_method(device_t bus, device_t child, int state)
1540 ACPI_HANDLE h;
1541 ACPI_STATUS status;
1542 int error;
1544 error = 0;
1545 h = acpi_get_handle(child);
1546 if (state < ACPI_STATE_D0 || state > ACPI_STATE_D3)
1547 return (EINVAL);
1548 if (h == NULL)
1549 return (0);
1551 /* Ignore errors if the power methods aren't present. */
1552 status = acpi_pwr_switch_consumer(h, state);
1553 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND
1554 && status != AE_BAD_PARAMETER)
1555 device_printf(bus, "failed to set ACPI power state D%d on %s: %s\n",
1556 state, acpi_name(h), AcpiFormatException(status));
1558 return (error);
1561 static int
1562 acpi_isa_pnp_probe(device_t bus, device_t child, struct isa_pnp_id *ids)
1564 int result, cid_count, i;
1565 uint32_t lid, cids[8];
1567 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1570 * ISA-style drivers attached to ACPI may persist and
1571 * probe manually if we return ENOENT. We never want
1572 * that to happen, so don't ever return it.
1574 result = ENXIO;
1576 /* Scan the supplied IDs for a match */
1577 lid = acpi_isa_get_logicalid(child);
1578 cid_count = acpi_isa_get_compatid(child, cids, 8);
1579 while (ids && ids->ip_id) {
1580 if (lid == ids->ip_id) {
1581 result = 0;
1582 goto out;
1584 for (i = 0; i < cid_count; i++) {
1585 if (cids[i] == ids->ip_id) {
1586 result = 0;
1587 goto out;
1590 ids++;
1593 out:
1594 if (result == 0 && ids->ip_desc)
1595 device_set_desc(child, ids->ip_desc);
1597 return_VALUE (result);
1601 * Look for a MCFG table. If it is present, use the settings for
1602 * domain (segment) 0 to setup PCI config space access via the memory
1603 * map.
1605 static void
1606 acpi_enable_pcie(void)
1608 ACPI_TABLE_HEADER *hdr;
1609 ACPI_MCFG_ALLOCATION *alloc, *end;
1610 ACPI_STATUS status;
1612 status = AcpiGetTable(ACPI_SIG_MCFG, 1, &hdr);
1613 if (ACPI_FAILURE(status))
1614 return;
1616 end = (ACPI_MCFG_ALLOCATION *)((char *)hdr + hdr->Length);
1617 alloc = (ACPI_MCFG_ALLOCATION *)((ACPI_TABLE_MCFG *)hdr + 1);
1618 while (alloc < end) {
1619 if (alloc->PciSegment == 0) {
1620 pcie_cfgregopen(alloc->Address, alloc->StartBusNumber,
1621 alloc->EndBusNumber);
1622 return;
1624 alloc++;
1629 * Scan all of the ACPI namespace and attach child devices.
1631 * We should only expect to find devices in the \_PR, \_TZ, \_SI, and
1632 * \_SB scopes, and \_PR and \_TZ became obsolete in the ACPI 2.0 spec.
1633 * However, in violation of the spec, some systems place their PCI link
1634 * devices in \, so we have to walk the whole namespace. We check the
1635 * type of namespace nodes, so this should be ok.
1637 static void
1638 acpi_probe_children(device_t bus)
1641 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1644 * Scan the namespace and insert placeholders for all the devices that
1645 * we find. We also probe/attach any early devices.
1647 * Note that we use AcpiWalkNamespace rather than AcpiGetDevices because
1648 * we want to create nodes for all devices, not just those that are
1649 * currently present. (This assumes that we don't want to create/remove
1650 * devices as they appear, which might be smarter.)
1652 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "namespace scan\n"));
1653 AcpiWalkNamespace(ACPI_TYPE_ANY, ACPI_ROOT_OBJECT, 100,
1654 acpi_probe_child, NULL, bus, NULL);
1656 /* Pre-allocate resources for our rman from any sysresource devices. */
1657 acpi_sysres_alloc(bus);
1658 /* Create any static children by calling device identify methods. */
1659 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "device identify routines\n"));
1660 bus_generic_probe(bus);
1662 /* Probe/attach all children, created staticly and from the namespace. */
1663 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "first bus_generic_attach\n"));
1664 bus_generic_attach(bus);
1667 * Some of these children may have attached others as part of their attach
1668 * process (eg. the root PCI bus driver), so rescan.
1670 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "second bus_generic_attach\n"));
1671 bus_generic_attach(bus);
1673 /* Attach wake sysctls. */
1674 acpi_wake_sysctl_walk(bus);
1676 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "done attaching children\n"));
1677 return_VOID;
1681 * Determine the probe order for a given device.
1683 static void
1684 acpi_probe_order(ACPI_HANDLE handle, int *order)
1686 ACPI_OBJECT_TYPE type;
1689 * 1. I/O port and memory system resource holders
1690 * 2. Embedded controllers (to handle early accesses)
1691 * 3. PCI Link Devices
1692 * 100000. CPUs
1694 AcpiGetType(handle, &type);
1695 if (acpi_MatchHid(handle, "PNP0C01") || acpi_MatchHid(handle, "PNP0C02"))
1696 *order = 1;
1697 else if (acpi_MatchHid(handle, "PNP0C09"))
1698 *order = 2;
1699 else if (acpi_MatchHid(handle, "PNP0C0F"))
1700 *order = 3;
1701 else if (type == ACPI_TYPE_PROCESSOR)
1702 *order = 100000;
1706 * Evaluate a child device and determine whether we might attach a device to
1707 * it.
1709 static ACPI_STATUS
1710 acpi_probe_child(ACPI_HANDLE handle, UINT32 level, void *context, void **status)
1712 struct acpi_prw_data prw;
1713 ACPI_OBJECT_TYPE type;
1714 ACPI_HANDLE h;
1715 device_t bus, child;
1716 int order;
1717 char *handle_str;
1719 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1721 if (acpi_disabled("children"))
1722 return_ACPI_STATUS (AE_OK);
1724 /* Skip this device if we think we'll have trouble with it. */
1725 if (acpi_avoid(handle))
1726 return_ACPI_STATUS (AE_OK);
1728 bus = (device_t)context;
1729 if (ACPI_SUCCESS(AcpiGetType(handle, &type))) {
1730 handle_str = acpi_name(handle);
1731 switch (type) {
1732 case ACPI_TYPE_DEVICE:
1734 * Since we scan from \, be sure to skip system scope objects.
1735 * \_SB_ and \_TZ_ are defined in ACPICA as devices to work around
1736 * BIOS bugs. For example, \_SB_ is to allow \_SB_._INI to be run
1737 * during the intialization and \_TZ_ is to support Notify() on it.
1739 if (strcmp(handle_str, "\\_SB_") == 0 ||
1740 strcmp(handle_str, "\\_TZ_") == 0)
1741 break;
1743 if (acpi_parse_prw(handle, &prw) == 0)
1744 AcpiSetupGpeForWake(handle, prw.gpe_handle, prw.gpe_bit);
1746 /* FALLTHROUGH */
1747 case ACPI_TYPE_PROCESSOR:
1748 case ACPI_TYPE_THERMAL:
1749 case ACPI_TYPE_POWER:
1751 * Create a placeholder device for this node. Sort the
1752 * placeholder so that the probe/attach passes will run
1753 * breadth-first. Orders less than ACPI_DEV_BASE_ORDER
1754 * are reserved for special objects (i.e., system
1755 * resources). CPU devices have a very high order to
1756 * ensure they are probed after other devices.
1758 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "scanning '%s'\n", handle_str));
1759 order = level * 10 + 100;
1760 acpi_probe_order(handle, &order);
1761 child = BUS_ADD_CHILD(bus, bus, order, NULL, -1);
1762 if (child == NULL)
1763 break;
1765 /* Associate the handle with the device_t and vice versa. */
1766 acpi_set_handle(child, handle);
1767 AcpiAttachData(handle, acpi_fake_objhandler, child);
1770 * Check that the device is present. If it's not present,
1771 * leave it disabled (so that we have a device_t attached to
1772 * the handle, but we don't probe it).
1774 * XXX PCI link devices sometimes report "present" but not
1775 * "functional" (i.e. if disabled). Go ahead and probe them
1776 * anyway since we may enable them later.
1778 if (type == ACPI_TYPE_DEVICE && !acpi_DeviceIsPresent(child)) {
1779 /* Never disable PCI link devices. */
1780 if (acpi_MatchHid(handle, "PNP0C0F"))
1781 break;
1783 * Docking stations should remain enabled since the system
1784 * may be undocked at boot.
1786 if (ACPI_SUCCESS(AcpiGetHandle(handle, "_DCK", &h)))
1787 break;
1789 device_disable(child);
1790 break;
1794 * Get the device's resource settings and attach them.
1795 * Note that if the device has _PRS but no _CRS, we need
1796 * to decide when it's appropriate to try to configure the
1797 * device. Ignore the return value here; it's OK for the
1798 * device not to have any resources.
1800 acpi_parse_resources(child, handle, &acpi_res_parse_set, NULL);
1801 break;
1805 return_ACPI_STATUS (AE_OK);
1809 * AcpiAttachData() requires an object handler but never uses it. This is a
1810 * placeholder object handler so we can store a device_t in an ACPI_HANDLE.
1812 void
1813 acpi_fake_objhandler(ACPI_HANDLE h, void *data)
1817 static void
1818 acpi_shutdown_final(void *arg, int howto)
1820 struct acpi_softc *sc;
1821 ACPI_STATUS status;
1824 * XXX Shutdown code should only run on the BSP (cpuid 0).
1825 * Some chipsets do not power off the system correctly if called from
1826 * an AP.
1828 sc = arg;
1829 if ((howto & RB_POWEROFF) != 0) {
1830 status = AcpiEnterSleepStatePrep(ACPI_STATE_S5);
1831 if (ACPI_FAILURE(status)) {
1832 device_printf(sc->acpi_dev, "AcpiEnterSleepStatePrep failed - %s\n",
1833 AcpiFormatException(status));
1834 return;
1836 device_printf(sc->acpi_dev, "Powering system off\n");
1837 ACPI_DISABLE_IRQS();
1838 status = AcpiEnterSleepState(ACPI_STATE_S5);
1839 if (ACPI_FAILURE(status)) {
1840 device_printf(sc->acpi_dev, "power-off failed - %s\n",
1841 AcpiFormatException(status));
1842 } else {
1843 DELAY(1000000);
1844 device_printf(sc->acpi_dev, "power-off failed - timeout\n");
1846 } else if ((howto & RB_HALT) == 0 && sc->acpi_handle_reboot) {
1847 /* Reboot using the reset register. */
1848 status = AcpiReset();
1849 if (ACPI_FAILURE(status)) {
1850 if (status != AE_NOT_EXIST)
1851 device_printf(sc->acpi_dev, "reset failed - %s\n",
1852 AcpiFormatException(status));
1853 } else {
1854 DELAY(1000000);
1855 device_printf(sc->acpi_dev, "reset failed - timeout\n");
1857 } else if (sc->acpi_do_disable && panicstr == NULL) {
1859 * Only disable ACPI if the user requested. On some systems, writing
1860 * the disable value to SMI_CMD hangs the system.
1862 device_printf(sc->acpi_dev, "Shutting down\n");
1863 AcpiTerminate();
1867 static void
1868 acpi_enable_fixed_events(struct acpi_softc *sc)
1870 static int first_time = 1;
1872 /* Enable and clear fixed events and install handlers. */
1873 if ((AcpiGbl_FADT.Flags & ACPI_FADT_POWER_BUTTON) == 0) {
1874 AcpiClearEvent(ACPI_EVENT_POWER_BUTTON);
1875 AcpiInstallFixedEventHandler(ACPI_EVENT_POWER_BUTTON,
1876 acpi_event_power_button_sleep, sc);
1877 if (first_time)
1878 device_printf(sc->acpi_dev, "Power Button (fixed)\n");
1880 if ((AcpiGbl_FADT.Flags & ACPI_FADT_SLEEP_BUTTON) == 0) {
1881 AcpiClearEvent(ACPI_EVENT_SLEEP_BUTTON);
1882 AcpiInstallFixedEventHandler(ACPI_EVENT_SLEEP_BUTTON,
1883 acpi_event_sleep_button_sleep, sc);
1884 if (first_time)
1885 device_printf(sc->acpi_dev, "Sleep Button (fixed)\n");
1888 first_time = 0;
1892 * Returns true if the device is actually present and should
1893 * be attached to. This requires the present, enabled, UI-visible
1894 * and diagnostics-passed bits to be set.
1896 BOOLEAN
1897 acpi_DeviceIsPresent(device_t dev)
1899 ACPI_DEVICE_INFO *devinfo;
1900 ACPI_HANDLE h;
1901 int ret;
1903 ret = FALSE;
1904 if ((h = acpi_get_handle(dev)) == NULL ||
1905 ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo)))
1906 return (FALSE);
1908 /* If no _STA method, must be present */
1909 if ((devinfo->Valid & ACPI_VALID_STA) == 0)
1910 ret = TRUE;
1912 /* Return true for 'present' and 'functioning' */
1913 if (ACPI_DEVICE_PRESENT(devinfo->CurrentStatus))
1914 ret = TRUE;
1916 AcpiOsFree(devinfo);
1917 return (ret);
1921 * Returns true if the battery is actually present and inserted.
1923 BOOLEAN
1924 acpi_BatteryIsPresent(device_t dev)
1926 ACPI_DEVICE_INFO *devinfo;
1927 ACPI_HANDLE h;
1928 int ret;
1930 ret = FALSE;
1931 if ((h = acpi_get_handle(dev)) == NULL ||
1932 ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo)))
1933 return (FALSE);
1935 /* If no _STA method, must be present */
1936 if ((devinfo->Valid & ACPI_VALID_STA) == 0)
1937 ret = TRUE;
1939 /* Return true for 'present', 'battery present', and 'functioning' */
1940 if (ACPI_BATTERY_PRESENT(devinfo->CurrentStatus))
1941 ret = TRUE;
1943 AcpiOsFree(devinfo);
1944 return (ret);
1948 * Match a HID string against a handle
1950 BOOLEAN
1951 acpi_MatchHid(ACPI_HANDLE h, const char *hid)
1953 ACPI_DEVICE_INFO *devinfo;
1954 int ret, i;
1956 ret = FALSE;
1957 if (hid == NULL || h == NULL ||
1958 ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo)))
1959 return (ret);
1961 if ((devinfo->Valid & ACPI_VALID_HID) != 0 &&
1962 strcmp(hid, devinfo->HardwareId.String) == 0)
1963 ret = TRUE;
1964 else if ((devinfo->Valid & ACPI_VALID_CID) != 0) {
1965 for (i = 0; i < devinfo->CompatibleIdList.Count; i++) {
1966 if (strcmp(hid, devinfo->CompatibleIdList.Ids[i].String) == 0) {
1967 ret = TRUE;
1968 break;
1973 AcpiOsFree(devinfo);
1974 return (ret);
1978 * Match a UID string against a handle
1980 BOOLEAN
1981 acpi_MatchUid(ACPI_HANDLE h, const char *uid)
1983 ACPI_DEVICE_INFO *devinfo;
1984 int ret;
1986 ret = FALSE;
1987 if (uid == NULL || h == NULL ||
1988 ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo)))
1989 return (ret);
1991 if ((devinfo->Valid & ACPI_VALID_UID) != 0 &&
1992 strcmp(uid, devinfo->UniqueId.String) == 0)
1993 ret = TRUE;
1995 AcpiOsFree(devinfo);
1996 return (ret);
2000 * Return the handle of a named object within our scope, ie. that of (parent)
2001 * or one if its parents.
2003 ACPI_STATUS
2004 acpi_GetHandleInScope(ACPI_HANDLE parent, char *path, ACPI_HANDLE *result)
2006 ACPI_HANDLE r;
2007 ACPI_STATUS status;
2009 /* Walk back up the tree to the root */
2010 for (;;) {
2011 status = AcpiGetHandle(parent, path, &r);
2012 if (ACPI_SUCCESS(status)) {
2013 *result = r;
2014 return (AE_OK);
2016 /* XXX Return error here? */
2017 if (status != AE_NOT_FOUND)
2018 return (AE_OK);
2019 if (ACPI_FAILURE(AcpiGetParent(parent, &r)))
2020 return (AE_NOT_FOUND);
2021 parent = r;
2026 * Allocate a buffer with a preset data size.
2028 ACPI_BUFFER *
2029 acpi_AllocBuffer(int size)
2031 ACPI_BUFFER *buf;
2033 if ((buf = kmalloc(size + sizeof(*buf), M_ACPIDEV, M_NOWAIT)) == NULL)
2034 return (NULL);
2035 buf->Length = size;
2036 buf->Pointer = (void *)(buf + 1);
2037 return (buf);
2040 ACPI_STATUS
2041 acpi_SetInteger(ACPI_HANDLE handle, char *path, UINT32 number)
2043 ACPI_OBJECT arg1;
2044 ACPI_OBJECT_LIST args;
2046 arg1.Type = ACPI_TYPE_INTEGER;
2047 arg1.Integer.Value = number;
2048 args.Count = 1;
2049 args.Pointer = &arg1;
2051 return (AcpiEvaluateObject(handle, path, &args, NULL));
2055 * Evaluate a path that should return an integer.
2057 ACPI_STATUS
2058 acpi_GetInteger(ACPI_HANDLE handle, char *path, UINT32 *number)
2060 ACPI_STATUS status;
2061 ACPI_BUFFER buf;
2062 ACPI_OBJECT param;
2064 if (handle == NULL)
2065 handle = ACPI_ROOT_OBJECT;
2068 * Assume that what we've been pointed at is an Integer object, or
2069 * a method that will return an Integer.
2071 buf.Pointer = &param;
2072 buf.Length = sizeof(param);
2073 status = AcpiEvaluateObject(handle, path, NULL, &buf);
2074 if (ACPI_SUCCESS(status)) {
2075 if (param.Type == ACPI_TYPE_INTEGER)
2076 *number = param.Integer.Value;
2077 else
2078 status = AE_TYPE;
2082 * In some applications, a method that's expected to return an Integer
2083 * may instead return a Buffer (probably to simplify some internal
2084 * arithmetic). We'll try to fetch whatever it is, and if it's a Buffer,
2085 * convert it into an Integer as best we can.
2087 * This is a hack.
2089 if (status == AE_BUFFER_OVERFLOW) {
2090 if ((buf.Pointer = AcpiOsAllocate(buf.Length)) == NULL) {
2091 status = AE_NO_MEMORY;
2092 } else {
2093 status = AcpiEvaluateObject(handle, path, NULL, &buf);
2094 if (ACPI_SUCCESS(status))
2095 status = acpi_ConvertBufferToInteger(&buf, number);
2096 AcpiOsFree(buf.Pointer);
2099 return (status);
2102 ACPI_STATUS
2103 acpi_ConvertBufferToInteger(ACPI_BUFFER *bufp, UINT32 *number)
2105 ACPI_OBJECT *p;
2106 UINT8 *val;
2107 int i;
2109 p = (ACPI_OBJECT *)bufp->Pointer;
2110 if (p->Type == ACPI_TYPE_INTEGER) {
2111 *number = p->Integer.Value;
2112 return (AE_OK);
2114 if (p->Type != ACPI_TYPE_BUFFER)
2115 return (AE_TYPE);
2116 if (p->Buffer.Length > sizeof(int))
2117 return (AE_BAD_DATA);
2119 *number = 0;
2120 val = p->Buffer.Pointer;
2121 for (i = 0; i < p->Buffer.Length; i++)
2122 *number += val[i] << (i * 8);
2123 return (AE_OK);
2127 * Iterate over the elements of an a package object, calling the supplied
2128 * function for each element.
2130 * XXX possible enhancement might be to abort traversal on error.
2132 ACPI_STATUS
2133 acpi_ForeachPackageObject(ACPI_OBJECT *pkg,
2134 void (*func)(ACPI_OBJECT *comp, void *arg), void *arg)
2136 ACPI_OBJECT *comp;
2137 int i;
2139 if (pkg == NULL || pkg->Type != ACPI_TYPE_PACKAGE)
2140 return (AE_BAD_PARAMETER);
2142 /* Iterate over components */
2143 i = 0;
2144 comp = pkg->Package.Elements;
2145 for (; i < pkg->Package.Count; i++, comp++)
2146 func(comp, arg);
2148 return (AE_OK);
2152 * Find the (index)th resource object in a set.
2154 ACPI_STATUS
2155 acpi_FindIndexedResource(ACPI_BUFFER *buf, int index, ACPI_RESOURCE **resp)
2157 ACPI_RESOURCE *rp;
2158 int i;
2160 rp = (ACPI_RESOURCE *)buf->Pointer;
2161 i = index;
2162 while (i-- > 0) {
2163 /* Range check */
2164 if (rp > (ACPI_RESOURCE *)((uint8_t *)buf->Pointer + buf->Length))
2165 return (AE_BAD_PARAMETER);
2167 /* Check for terminator */
2168 if (rp->Type == ACPI_RESOURCE_TYPE_END_TAG || rp->Length == 0)
2169 return (AE_NOT_FOUND);
2170 rp = ACPI_NEXT_RESOURCE(rp);
2172 if (resp != NULL)
2173 *resp = rp;
2175 return (AE_OK);
2179 * Append an ACPI_RESOURCE to an ACPI_BUFFER.
2181 * Given a pointer to an ACPI_RESOURCE structure, expand the ACPI_BUFFER
2182 * provided to contain it. If the ACPI_BUFFER is empty, allocate a sensible
2183 * backing block. If the ACPI_RESOURCE is NULL, return an empty set of
2184 * resources.
2186 #define ACPI_INITIAL_RESOURCE_BUFFER_SIZE 512
2188 ACPI_STATUS
2189 acpi_AppendBufferResource(ACPI_BUFFER *buf, ACPI_RESOURCE *res)
2191 ACPI_RESOURCE *rp;
2192 void *newp;
2194 /* Initialise the buffer if necessary. */
2195 if (buf->Pointer == NULL) {
2196 buf->Length = ACPI_INITIAL_RESOURCE_BUFFER_SIZE;
2197 if ((buf->Pointer = AcpiOsAllocate(buf->Length)) == NULL)
2198 return (AE_NO_MEMORY);
2199 rp = (ACPI_RESOURCE *)buf->Pointer;
2200 rp->Type = ACPI_RESOURCE_TYPE_END_TAG;
2201 rp->Length = ACPI_RS_SIZE_MIN;
2203 if (res == NULL)
2204 return (AE_OK);
2207 * Scan the current buffer looking for the terminator.
2208 * This will either find the terminator or hit the end
2209 * of the buffer and return an error.
2211 rp = (ACPI_RESOURCE *)buf->Pointer;
2212 for (;;) {
2213 /* Range check, don't go outside the buffer */
2214 if (rp >= (ACPI_RESOURCE *)((uint8_t *)buf->Pointer + buf->Length))
2215 return (AE_BAD_PARAMETER);
2216 if (rp->Type == ACPI_RESOURCE_TYPE_END_TAG || rp->Length == 0)
2217 break;
2218 rp = ACPI_NEXT_RESOURCE(rp);
2222 * Check the size of the buffer and expand if required.
2224 * Required size is:
2225 * size of existing resources before terminator +
2226 * size of new resource and header +
2227 * size of terminator.
2229 * Note that this loop should really only run once, unless
2230 * for some reason we are stuffing a *really* huge resource.
2232 while ((((uint8_t *)rp - (uint8_t *)buf->Pointer) +
2233 res->Length + ACPI_RS_SIZE_NO_DATA +
2234 ACPI_RS_SIZE_MIN) >= buf->Length) {
2235 if ((newp = AcpiOsAllocate(buf->Length * 2)) == NULL)
2236 return (AE_NO_MEMORY);
2237 bcopy(buf->Pointer, newp, buf->Length);
2238 rp = (ACPI_RESOURCE *)((uint8_t *)newp +
2239 ((uint8_t *)rp - (uint8_t *)buf->Pointer));
2240 AcpiOsFree(buf->Pointer);
2241 buf->Pointer = newp;
2242 buf->Length += buf->Length;
2245 /* Insert the new resource. */
2246 bcopy(res, rp, res->Length + ACPI_RS_SIZE_NO_DATA);
2248 /* And add the terminator. */
2249 rp = ACPI_NEXT_RESOURCE(rp);
2250 rp->Type = ACPI_RESOURCE_TYPE_END_TAG;
2251 rp->Length = ACPI_RS_SIZE_MIN;
2253 return (AE_OK);
2257 * Set interrupt model.
2259 ACPI_STATUS
2260 acpi_SetIntrModel(int model)
2263 return (acpi_SetInteger(ACPI_ROOT_OBJECT, "_PIC", model));
2267 * DEPRECATED. This interface has serious deficiencies and will be
2268 * removed.
2270 * Immediately enter the sleep state. In the old model, acpiconf(8) ran
2271 * rc.suspend and rc.resume so we don't have to notify devd(8) to do this.
2273 ACPI_STATUS
2274 acpi_SetSleepState(struct acpi_softc *sc, int state)
2276 static int once;
2278 if (!once) {
2279 device_printf(sc->acpi_dev,
2280 "warning: acpi_SetSleepState() deprecated, need to update your software\n");
2281 once = 1;
2283 return (acpi_EnterSleepState(sc, state));
2286 static void
2287 acpi_sleep_force(void *arg)
2289 struct acpi_softc *sc;
2291 sc = arg;
2292 device_printf(sc->acpi_dev,
2293 "suspend request timed out, forcing sleep now\n");
2294 if (ACPI_FAILURE(acpi_EnterSleepState(sc, sc->acpi_next_sstate)))
2295 device_printf(sc->acpi_dev, "force sleep state S%d failed\n",
2296 sc->acpi_next_sstate);
2300 * Request that the system enter the given suspend state. All /dev/apm
2301 * devices and devd(8) will be notified. Userland then has a chance to
2302 * save state and acknowledge the request. The system sleeps once all
2303 * acks are in.
2306 acpi_ReqSleepState(struct acpi_softc *sc, int state)
2308 #ifdef notyet
2309 struct apm_clone_data *clone;
2310 #endif
2312 if (state < ACPI_STATE_S1 || state > ACPI_STATE_S5)
2313 return (EINVAL);
2315 /* S5 (soft-off) should be entered directly with no waiting. */
2316 if (state == ACPI_STATE_S5) {
2317 if (ACPI_SUCCESS(acpi_EnterSleepState(sc, state)))
2318 return (0);
2319 else
2320 return (ENXIO);
2323 /* This platform does not support acpi suspend/resume. */
2324 return (EOPNOTSUPP);
2326 /* If a suspend request is already in progress, just return. */
2327 ACPI_LOCK(acpi);
2328 if (sc->acpi_next_sstate != 0) {
2329 ACPI_UNLOCK(acpi);
2330 return (0);
2333 /* Record the pending state and notify all apm devices. */
2334 sc->acpi_next_sstate = state;
2335 #if 0
2336 STAILQ_FOREACH(clone, &sc->apm_cdevs, entries) {
2337 clone->notify_status = APM_EV_NONE;
2338 if ((clone->flags & ACPI_EVF_DEVD) == 0) {
2339 KNOTE(&clone->sel_read.si_note, 0);
2342 #endif
2344 /* If devd(8) is not running, immediately enter the sleep state. */
2345 if (devctl_process_running() == FALSE) {
2346 ACPI_UNLOCK(acpi);
2347 if (ACPI_SUCCESS(acpi_EnterSleepState(sc, sc->acpi_next_sstate))) {
2348 return (0);
2349 } else {
2350 return (ENXIO);
2354 /* Now notify devd(8) also. */
2355 acpi_UserNotify("Suspend", ACPI_ROOT_OBJECT, state);
2358 * Set a timeout to fire if userland doesn't ack the suspend request
2359 * in time. This way we still eventually go to sleep if we were
2360 * overheating or running low on battery, even if userland is hung.
2361 * We cancel this timeout once all userland acks are in or the
2362 * suspend request is aborted.
2364 callout_reset(&sc->susp_force_to, 10 * hz, acpi_sleep_force, sc);
2365 ACPI_UNLOCK(acpi);
2366 return (0);
2370 * Acknowledge (or reject) a pending sleep state. The caller has
2371 * prepared for suspend and is now ready for it to proceed. If the
2372 * error argument is non-zero, it indicates suspend should be cancelled
2373 * and gives an errno value describing why. Once all votes are in,
2374 * we suspend the system.
2377 acpi_AckSleepState(struct apm_clone_data *clone, int error)
2379 struct acpi_softc *sc;
2380 int ret, sleeping;
2382 /* This platform does not support acpi suspend/resume. */
2383 return (EOPNOTSUPP);
2385 /* If no pending sleep state, return an error. */
2386 ACPI_LOCK(acpi);
2387 sc = clone->acpi_sc;
2388 if (sc->acpi_next_sstate == 0) {
2389 ACPI_UNLOCK(acpi);
2390 return (ENXIO);
2393 /* Caller wants to abort suspend process. */
2394 if (error) {
2395 sc->acpi_next_sstate = 0;
2396 callout_stop(&sc->susp_force_to);
2397 device_printf(sc->acpi_dev,
2398 "listener on %s cancelled the pending suspend\n",
2399 devtoname(clone->cdev));
2400 ACPI_UNLOCK(acpi);
2401 return (0);
2405 * Mark this device as acking the suspend request. Then, walk through
2406 * all devices, seeing if they agree yet. We only count devices that
2407 * are writable since read-only devices couldn't ack the request.
2409 clone->notify_status = APM_EV_ACKED;
2410 sleeping = TRUE;
2411 STAILQ_FOREACH(clone, &sc->apm_cdevs, entries) {
2412 if ((clone->flags & ACPI_EVF_WRITE) != 0 &&
2413 clone->notify_status != APM_EV_ACKED) {
2414 sleeping = FALSE;
2415 break;
2419 /* If all devices have voted "yes", we will suspend now. */
2420 if (sleeping)
2421 callout_stop(&sc->susp_force_to);
2422 ACPI_UNLOCK(acpi);
2423 ret = 0;
2424 if (sleeping) {
2425 if (ACPI_FAILURE(acpi_EnterSleepState(sc, sc->acpi_next_sstate)))
2426 ret = ENODEV;
2429 return (ret);
2432 static void
2433 acpi_sleep_enable(void *arg)
2435 ((struct acpi_softc *)arg)->acpi_sleep_disabled = 0;
2438 enum acpi_sleep_state {
2439 ACPI_SS_NONE,
2440 ACPI_SS_GPE_SET,
2441 ACPI_SS_DEV_SUSPEND,
2442 ACPI_SS_SLP_PREP,
2443 ACPI_SS_SLEPT,
2447 * Enter the desired system sleep state.
2449 * Currently we support S1-S5 but S4 is only S4BIOS
2451 static ACPI_STATUS
2452 acpi_EnterSleepState(struct acpi_softc *sc, int state)
2454 ACPI_STATUS status;
2455 UINT8 TypeA;
2456 UINT8 TypeB;
2457 enum acpi_sleep_state slp_state;
2459 ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, state);
2461 /* Re-entry once we're suspending is not allowed. */
2462 status = AE_OK;
2463 ACPI_LOCK(acpi);
2464 if (sc->acpi_sleep_disabled) {
2465 ACPI_UNLOCK(acpi);
2466 device_printf(sc->acpi_dev,
2467 "suspend request ignored (not ready yet)\n");
2468 return (AE_ERROR);
2470 sc->acpi_sleep_disabled = 1;
2471 ACPI_UNLOCK(acpi);
2474 * Be sure to hold Giant across DEVICE_SUSPEND/RESUME since non-MPSAFE
2475 * drivers need this.
2477 //get_mplock();
2478 slp_state = ACPI_SS_NONE;
2479 switch (state) {
2480 case ACPI_STATE_S1:
2481 case ACPI_STATE_S2:
2482 case ACPI_STATE_S3:
2483 case ACPI_STATE_S4:
2484 status = AcpiGetSleepTypeData(state, &TypeA, &TypeB);
2485 if (status == AE_NOT_FOUND) {
2486 device_printf(sc->acpi_dev,
2487 "Sleep state S%d not supported by BIOS\n", state);
2488 break;
2489 } else if (ACPI_FAILURE(status)) {
2490 device_printf(sc->acpi_dev, "AcpiGetSleepTypeData failed - %s\n",
2491 AcpiFormatException(status));
2492 break;
2495 sc->acpi_sstate = state;
2497 /* Enable any GPEs as appropriate and requested by the user. */
2498 acpi_wake_prep_walk(state);
2499 slp_state = ACPI_SS_GPE_SET;
2502 * Inform all devices that we are going to sleep. If at least one
2503 * device fails, DEVICE_SUSPEND() automatically resumes the tree.
2505 * XXX Note that a better two-pass approach with a 'veto' pass
2506 * followed by a "real thing" pass would be better, but the current
2507 * bus interface does not provide for this.
2509 if (DEVICE_SUSPEND(root_bus) != 0) {
2510 device_printf(sc->acpi_dev, "device_suspend failed\n");
2511 break;
2513 slp_state = ACPI_SS_DEV_SUSPEND;
2515 /* If testing device suspend only, back out of everything here. */
2516 if (acpi_susp_bounce)
2517 break;
2519 status = AcpiEnterSleepStatePrep(state);
2520 if (ACPI_FAILURE(status)) {
2521 device_printf(sc->acpi_dev, "AcpiEnterSleepStatePrep failed - %s\n",
2522 AcpiFormatException(status));
2523 break;
2525 slp_state = ACPI_SS_SLP_PREP;
2527 if (sc->acpi_sleep_delay > 0)
2528 DELAY(sc->acpi_sleep_delay * 1000000);
2530 if (state != ACPI_STATE_S1) {
2531 acpi_sleep_machdep(sc, state);
2533 /* Re-enable ACPI hardware on wakeup from sleep state 4. */
2534 if (state == ACPI_STATE_S4)
2535 AcpiEnable();
2536 } else {
2537 ACPI_DISABLE_IRQS();
2538 status = AcpiEnterSleepState(state);
2539 if (ACPI_FAILURE(status)) {
2540 device_printf(sc->acpi_dev, "AcpiEnterSleepState failed - %s\n",
2541 AcpiFormatException(status));
2542 break;
2545 slp_state = ACPI_SS_SLEPT;
2546 break;
2547 case ACPI_STATE_S5:
2549 * Shut down cleanly and power off. This will call us back through the
2550 * shutdown handlers.
2552 shutdown_nice(RB_POWEROFF);
2553 break;
2554 case ACPI_STATE_S0:
2555 default:
2556 status = AE_BAD_PARAMETER;
2557 break;
2561 * Back out state according to how far along we got in the suspend
2562 * process. This handles both the error and success cases.
2564 sc->acpi_next_sstate = 0;
2565 if (slp_state >= ACPI_SS_GPE_SET) {
2566 acpi_wake_prep_walk(state);
2567 sc->acpi_sstate = ACPI_STATE_S0;
2569 if (slp_state >= ACPI_SS_SLP_PREP)
2570 AcpiLeaveSleepState(state);
2571 if (slp_state >= ACPI_SS_DEV_SUSPEND)
2572 DEVICE_RESUME(root_bus);
2573 if (slp_state >= ACPI_SS_SLEPT)
2574 acpi_enable_fixed_events(sc);
2576 /* Allow another sleep request after a while. */
2577 /* XXX: needs timeout */
2578 if (state != ACPI_STATE_S5)
2579 acpi_sleep_enable(sc);
2581 /* Run /etc/rc.resume after we are back. */
2582 acpi_UserNotify("Resume", ACPI_ROOT_OBJECT, state);
2584 //rel_mplock();
2585 return_ACPI_STATUS (status);
2588 /* Enable or disable the device's GPE. */
2590 acpi_wake_set_enable(device_t dev, int enable)
2592 struct acpi_prw_data prw;
2593 ACPI_STATUS status;
2594 int flags;
2596 /* Make sure the device supports waking the system and get the GPE. */
2597 if (acpi_parse_prw(acpi_get_handle(dev), &prw) != 0)
2598 return (ENXIO);
2600 flags = acpi_get_flags(dev);
2601 if (enable) {
2602 status = AcpiSetGpeWakeMask(prw.gpe_handle, prw.gpe_bit,
2603 ACPI_GPE_ENABLE);
2604 if (ACPI_FAILURE(status)) {
2605 device_printf(dev, "enable wake failed\n");
2606 return (ENXIO);
2608 acpi_set_flags(dev, flags | ACPI_FLAG_WAKE_ENABLED);
2609 } else {
2610 status = AcpiSetGpeWakeMask(prw.gpe_handle, prw.gpe_bit,
2611 ACPI_GPE_DISABLE);
2612 if (ACPI_FAILURE(status)) {
2613 device_printf(dev, "disable wake failed\n");
2614 return (ENXIO);
2616 acpi_set_flags(dev, flags & ~ACPI_FLAG_WAKE_ENABLED);
2619 return (0);
2622 static int
2623 acpi_wake_sleep_prep(ACPI_HANDLE handle, int sstate)
2625 struct acpi_prw_data prw;
2626 device_t dev;
2628 /* Check that this is a wake-capable device and get its GPE. */
2629 if (acpi_parse_prw(handle, &prw) != 0)
2630 return (ENXIO);
2631 dev = acpi_get_device(handle);
2634 * The destination sleep state must be less than (i.e., higher power)
2635 * or equal to the value specified by _PRW. If this GPE cannot be
2636 * enabled for the next sleep state, then disable it. If it can and
2637 * the user requested it be enabled, turn on any required power resources
2638 * and set _PSW.
2640 if (sstate > prw.lowest_wake) {
2641 AcpiSetGpeWakeMask(prw.gpe_handle, prw.gpe_bit, ACPI_GPE_DISABLE);
2642 if (bootverbose)
2643 device_printf(dev, "wake_prep disabled wake for %s (S%d)\n",
2644 acpi_name(handle), sstate);
2645 } else if (dev && (acpi_get_flags(dev) & ACPI_FLAG_WAKE_ENABLED) != 0) {
2646 acpi_pwr_wake_enable(handle, 1);
2647 acpi_SetInteger(handle, "_PSW", 1);
2648 if (bootverbose)
2649 device_printf(dev, "wake_prep enabled for %s (S%d)\n",
2650 acpi_name(handle), sstate);
2653 return (0);
2656 static int
2657 acpi_wake_run_prep(ACPI_HANDLE handle, int sstate)
2659 struct acpi_prw_data prw;
2660 device_t dev;
2663 * Check that this is a wake-capable device and get its GPE. Return
2664 * now if the user didn't enable this device for wake.
2666 if (acpi_parse_prw(handle, &prw) != 0)
2667 return (ENXIO);
2668 dev = acpi_get_device(handle);
2669 if (dev == NULL || (acpi_get_flags(dev) & ACPI_FLAG_WAKE_ENABLED) == 0)
2670 return (0);
2673 * If this GPE couldn't be enabled for the previous sleep state, it was
2674 * disabled before going to sleep so re-enable it. If it was enabled,
2675 * clear _PSW and turn off any power resources it used.
2677 if (sstate > prw.lowest_wake) {
2678 AcpiSetGpeWakeMask(prw.gpe_handle, prw.gpe_bit, ACPI_GPE_ENABLE);
2679 if (bootverbose)
2680 device_printf(dev, "run_prep re-enabled %s\n", acpi_name(handle));
2681 } else {
2682 acpi_SetInteger(handle, "_PSW", 0);
2683 acpi_pwr_wake_enable(handle, 0);
2684 if (bootverbose)
2685 device_printf(dev, "run_prep cleaned up for %s\n",
2686 acpi_name(handle));
2689 return (0);
2692 static ACPI_STATUS
2693 acpi_wake_prep(ACPI_HANDLE handle, UINT32 level, void *context, void **status)
2695 int sstate;
2697 /* If suspending, run the sleep prep function, otherwise wake. */
2698 sstate = *(int *)context;
2699 if (AcpiGbl_SystemAwakeAndRunning)
2700 acpi_wake_sleep_prep(handle, sstate);
2701 else
2702 acpi_wake_run_prep(handle, sstate);
2703 return (AE_OK);
2706 /* Walk the tree rooted at acpi0 to prep devices for suspend/resume. */
2707 static int
2708 acpi_wake_prep_walk(int sstate)
2710 ACPI_HANDLE sb_handle;
2712 if (ACPI_SUCCESS(AcpiGetHandle(ACPI_ROOT_OBJECT, "\\_SB_", &sb_handle))) {
2713 AcpiWalkNamespace(ACPI_TYPE_DEVICE, sb_handle, 100,
2714 acpi_wake_prep, NULL, &sstate, NULL);
2716 return (0);
2719 /* Walk the tree rooted at acpi0 to attach per-device wake sysctls. */
2720 static int
2721 acpi_wake_sysctl_walk(device_t dev)
2723 #ifdef notyet
2724 int error, i, numdevs;
2725 device_t *devlist;
2726 device_t child;
2727 ACPI_STATUS status;
2729 error = device_get_children(dev, &devlist, &numdevs);
2730 if (error != 0 || numdevs == 0) {
2731 if (numdevs == 0)
2732 kfree(devlist, M_TEMP);
2733 return (error);
2735 for (i = 0; i < numdevs; i++) {
2736 child = devlist[i];
2737 acpi_wake_sysctl_walk(child);
2738 if (!device_is_attached(child))
2739 continue;
2740 status = AcpiEvaluateObject(acpi_get_handle(child), "_PRW", NULL, NULL);
2741 if (ACPI_SUCCESS(status)) {
2742 SYSCTL_ADD_PROC(device_get_sysctl_ctx(child),
2743 SYSCTL_CHILDREN(device_get_sysctl_tree(child)), OID_AUTO,
2744 "wake", CTLTYPE_INT | CTLFLAG_RW, child, 0,
2745 acpi_wake_set_sysctl, "I", "Device set to wake the system");
2748 kfree(devlist, M_TEMP);
2749 #endif
2751 return (0);
2754 #ifdef notyet
2755 /* Enable or disable wake from userland. */
2756 static int
2757 acpi_wake_set_sysctl(SYSCTL_HANDLER_ARGS)
2759 int enable, error;
2760 device_t dev;
2762 dev = (device_t)arg1;
2763 enable = (acpi_get_flags(dev) & ACPI_FLAG_WAKE_ENABLED) ? 1 : 0;
2765 error = sysctl_handle_int(oidp, &enable, 0, req);
2766 if (error != 0 || req->newptr == NULL)
2767 return (error);
2768 if (enable != 0 && enable != 1)
2769 return (EINVAL);
2771 return (acpi_wake_set_enable(dev, enable));
2773 #endif
2775 /* Parse a device's _PRW into a structure. */
2777 acpi_parse_prw(ACPI_HANDLE h, struct acpi_prw_data *prw)
2779 ACPI_STATUS status;
2780 ACPI_BUFFER prw_buffer;
2781 ACPI_OBJECT *res, *res2;
2782 int error, i, power_count;
2784 if (h == NULL || prw == NULL)
2785 return (EINVAL);
2788 * The _PRW object (7.2.9) is only required for devices that have the
2789 * ability to wake the system from a sleeping state.
2791 error = EINVAL;
2792 prw_buffer.Pointer = NULL;
2793 prw_buffer.Length = ACPI_ALLOCATE_BUFFER;
2794 status = AcpiEvaluateObject(h, "_PRW", NULL, &prw_buffer);
2795 if (ACPI_FAILURE(status))
2796 return (ENOENT);
2797 res = (ACPI_OBJECT *)prw_buffer.Pointer;
2798 if (res == NULL)
2799 return (ENOENT);
2800 if (!ACPI_PKG_VALID(res, 2))
2801 goto out;
2804 * Element 1 of the _PRW object:
2805 * The lowest power system sleeping state that can be entered while still
2806 * providing wake functionality. The sleeping state being entered must
2807 * be less than (i.e., higher power) or equal to this value.
2809 if (acpi_PkgInt32(res, 1, &prw->lowest_wake) != 0)
2810 goto out;
2813 * Element 0 of the _PRW object:
2815 switch (res->Package.Elements[0].Type) {
2816 case ACPI_TYPE_INTEGER:
2818 * If the data type of this package element is numeric, then this
2819 * _PRW package element is the bit index in the GPEx_EN, in the
2820 * GPE blocks described in the FADT, of the enable bit that is
2821 * enabled for the wake event.
2823 prw->gpe_handle = NULL;
2824 prw->gpe_bit = res->Package.Elements[0].Integer.Value;
2825 error = 0;
2826 break;
2827 case ACPI_TYPE_PACKAGE:
2829 * If the data type of this package element is a package, then this
2830 * _PRW package element is itself a package containing two
2831 * elements. The first is an object reference to the GPE Block
2832 * device that contains the GPE that will be triggered by the wake
2833 * event. The second element is numeric and it contains the bit
2834 * index in the GPEx_EN, in the GPE Block referenced by the
2835 * first element in the package, of the enable bit that is enabled for
2836 * the wake event.
2838 * For example, if this field is a package then it is of the form:
2839 * Package() {\_SB.PCI0.ISA.GPE, 2}
2841 res2 = &res->Package.Elements[0];
2842 if (!ACPI_PKG_VALID(res2, 2))
2843 goto out;
2844 prw->gpe_handle = acpi_GetReference(NULL, &res2->Package.Elements[0]);
2845 if (prw->gpe_handle == NULL)
2846 goto out;
2847 if (acpi_PkgInt32(res2, 1, &prw->gpe_bit) != 0)
2848 goto out;
2849 error = 0;
2850 break;
2851 default:
2852 goto out;
2855 /* Elements 2 to N of the _PRW object are power resources. */
2856 power_count = res->Package.Count - 2;
2857 if (power_count > ACPI_PRW_MAX_POWERRES) {
2858 kprintf("ACPI device %s has too many power resources\n", acpi_name(h));
2859 power_count = 0;
2861 prw->power_res_count = power_count;
2862 for (i = 0; i < power_count; i++)
2863 prw->power_res[i] = res->Package.Elements[i];
2865 out:
2866 if (prw_buffer.Pointer != NULL)
2867 AcpiOsFree(prw_buffer.Pointer);
2868 return (error);
2872 * ACPI Event Handlers
2875 /* System Event Handlers (registered by EVENTHANDLER_REGISTER) */
2877 static void
2878 acpi_system_eventhandler_sleep(void *arg, int state)
2880 struct acpi_softc *sc;
2881 int ret;
2883 ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, state);
2885 sc = arg;
2887 /* Check if button action is disabled. */
2888 if (state == ACPI_S_STATES_MAX + 1)
2889 return;
2891 /* Request that the system prepare to enter the given suspend state. */
2892 ret = acpi_ReqSleepState((struct acpi_softc *)arg, state);
2893 if (ret != 0)
2894 device_printf(sc->acpi_dev,
2895 "request to enter state S%d failed (err %d)\n", state, ret);
2897 return_VOID;
2900 static void
2901 acpi_system_eventhandler_wakeup(void *arg, int state)
2904 ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, state);
2906 /* Currently, nothing to do for wakeup. */
2908 return_VOID;
2912 * ACPICA Event Handlers (FixedEvent, also called from button notify handler)
2914 UINT32
2915 acpi_event_power_button_sleep(void *context)
2917 struct acpi_softc *sc = (struct acpi_softc *)context;
2919 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
2921 EVENTHANDLER_INVOKE(acpi_sleep_event, sc->acpi_power_button_sx);
2923 return_VALUE (ACPI_INTERRUPT_HANDLED);
2926 UINT32
2927 acpi_event_power_button_wake(void *context)
2929 struct acpi_softc *sc = (struct acpi_softc *)context;
2931 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
2933 EVENTHANDLER_INVOKE(acpi_wakeup_event, sc->acpi_power_button_sx);
2935 return_VALUE (ACPI_INTERRUPT_HANDLED);
2938 UINT32
2939 acpi_event_sleep_button_sleep(void *context)
2941 struct acpi_softc *sc = (struct acpi_softc *)context;
2943 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
2945 EVENTHANDLER_INVOKE(acpi_sleep_event, sc->acpi_sleep_button_sx);
2947 return_VALUE (ACPI_INTERRUPT_HANDLED);
2950 UINT32
2951 acpi_event_sleep_button_wake(void *context)
2953 struct acpi_softc *sc = (struct acpi_softc *)context;
2955 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
2957 EVENTHANDLER_INVOKE(acpi_wakeup_event, sc->acpi_sleep_button_sx);
2959 return_VALUE (ACPI_INTERRUPT_HANDLED);
2963 * XXX This static buffer is suboptimal. There is no locking so only
2964 * use this for single-threaded callers.
2966 char *
2967 acpi_name(ACPI_HANDLE handle)
2969 ACPI_BUFFER buf;
2970 static char data[256];
2972 buf.Length = sizeof(data);
2973 buf.Pointer = data;
2975 if (handle && ACPI_SUCCESS(AcpiGetName(handle, ACPI_FULL_PATHNAME, &buf)))
2976 return (data);
2977 return ("(unknown)");
2981 * Debugging/bug-avoidance. Avoid trying to fetch info on various
2982 * parts of the namespace.
2985 acpi_avoid(ACPI_HANDLE handle)
2987 char *cp, *env, *np;
2988 int len;
2990 np = acpi_name(handle);
2991 if (*np == '\\')
2992 np++;
2993 if ((env = kgetenv("debug.acpi.avoid")) == NULL)
2994 return (0);
2996 /* Scan the avoid list checking for a match */
2997 cp = env;
2998 for (;;) {
2999 while (*cp != 0 && isspace(*cp))
3000 cp++;
3001 if (*cp == 0)
3002 break;
3003 len = 0;
3004 while (cp[len] != 0 && !isspace(cp[len]))
3005 len++;
3006 if (!strncmp(cp, np, len)) {
3007 kfreeenv(env);
3008 return(1);
3010 cp += len;
3012 kfreeenv(env);
3014 return (0);
3018 * Debugging/bug-avoidance. Disable ACPI subsystem components.
3021 acpi_disabled(char *subsys)
3023 char *cp, *env;
3024 int len;
3026 if ((env = kgetenv("debug.acpi.disabled")) == NULL)
3027 return (0);
3028 if (strcmp(env, "all") == 0) {
3029 kfreeenv(env);
3030 return (1);
3033 /* Scan the disable list, checking for a match. */
3034 cp = env;
3035 for (;;) {
3036 while (*cp != '\0' && isspace(*cp))
3037 cp++;
3038 if (*cp == '\0')
3039 break;
3040 len = 0;
3041 while (cp[len] != '\0' && !isspace(cp[len]))
3042 len++;
3043 if (strncmp(cp, subsys, len) == 0) {
3044 kfreeenv(env);
3045 return (1);
3047 cp += len;
3049 kfreeenv(env);
3051 return (0);
3055 * Debugging/bug-avoidance. Enable ACPI subsystem components. Most
3056 * components are enabled by default. The ones that are not have to be
3057 * enabled via debug.acpi.enabled.
3060 acpi_enabled(char *subsys)
3062 char *cp, *env;
3063 int len;
3065 if ((env = kgetenv("debug.acpi.enabled")) == NULL)
3066 return (0);
3067 if (strcmp(env, "all") == 0) {
3068 kfreeenv(env);
3069 return (1);
3072 /* Scan the enable list, checking for a match. */
3073 cp = env;
3074 for (;;) {
3075 while (*cp != '\0' && isspace(*cp))
3076 cp++;
3077 if (*cp == '\0')
3078 break;
3079 len = 0;
3080 while (cp[len] != '\0' && !isspace(cp[len]))
3081 len++;
3082 if (strncmp(cp, subsys, len) == 0) {
3083 kfreeenv(env);
3084 return (1);
3086 cp += len;
3088 kfreeenv(env);
3090 return (0);
3094 * Control interface.
3096 * We multiplex ioctls for all participating ACPI devices here. Individual
3097 * drivers wanting to be accessible via /dev/acpi should use the
3098 * register/deregister interface to make their handlers visible.
3100 struct acpi_ioctl_hook
3102 TAILQ_ENTRY(acpi_ioctl_hook) link;
3103 u_long cmd;
3104 acpi_ioctl_fn fn;
3105 void *arg;
3108 static TAILQ_HEAD(,acpi_ioctl_hook) acpi_ioctl_hooks;
3109 static int acpi_ioctl_hooks_initted;
3112 acpi_register_ioctl(u_long cmd, acpi_ioctl_fn fn, void *arg)
3114 struct acpi_ioctl_hook *hp;
3116 if ((hp = kmalloc(sizeof(*hp), M_ACPIDEV, M_NOWAIT)) == NULL)
3117 return (ENOMEM);
3118 hp->cmd = cmd;
3119 hp->fn = fn;
3120 hp->arg = arg;
3122 ACPI_LOCK(acpi);
3123 if (acpi_ioctl_hooks_initted == 0) {
3124 TAILQ_INIT(&acpi_ioctl_hooks);
3125 acpi_ioctl_hooks_initted = 1;
3127 TAILQ_INSERT_TAIL(&acpi_ioctl_hooks, hp, link);
3128 ACPI_UNLOCK(acpi);
3130 return (0);
3133 void
3134 acpi_deregister_ioctl(u_long cmd, acpi_ioctl_fn fn)
3136 struct acpi_ioctl_hook *hp;
3138 ACPI_LOCK(acpi);
3139 TAILQ_FOREACH(hp, &acpi_ioctl_hooks, link)
3140 if (hp->cmd == cmd && hp->fn == fn)
3141 break;
3143 if (hp != NULL) {
3144 TAILQ_REMOVE(&acpi_ioctl_hooks, hp, link);
3145 kfree(hp, M_ACPIDEV);
3147 ACPI_UNLOCK(acpi);
3150 static int
3151 acpiopen(struct dev_open_args *ap)
3153 return (0);
3156 static int
3157 acpiclose(struct dev_close_args *ap)
3159 return (0);
3162 static int
3163 acpiioctl(struct dev_ioctl_args *ap)
3165 struct acpi_softc *sc;
3166 struct acpi_ioctl_hook *hp;
3167 int error, state;
3169 error = 0;
3170 hp = NULL;
3171 sc = ap->a_head.a_dev->si_drv1;
3174 * Scan the list of registered ioctls, looking for handlers.
3176 ACPI_LOCK(acpi);
3177 if (acpi_ioctl_hooks_initted)
3178 TAILQ_FOREACH(hp, &acpi_ioctl_hooks, link) {
3179 if (hp->cmd == ap->a_cmd)
3180 break;
3182 ACPI_UNLOCK(acpi);
3183 if (hp)
3184 return (hp->fn(ap->a_cmd, ap->a_data, hp->arg));
3187 * Core ioctls are not permitted for non-writable user.
3188 * Currently, other ioctls just fetch information.
3189 * Not changing system behavior.
3191 if ((ap->a_fflag & FWRITE) == 0)
3192 return (EPERM);
3194 /* Core system ioctls. */
3195 switch (ap->a_cmd) {
3196 case ACPIIO_REQSLPSTATE:
3197 state = *(int *)ap->a_data;
3198 if (state != ACPI_STATE_S5)
3199 error = acpi_ReqSleepState(sc, state);
3200 else {
3201 device_printf(sc->acpi_dev,
3202 "power off via acpi ioctl not supported\n");
3203 error = ENXIO;
3205 break;
3206 case ACPIIO_ACKSLPSTATE:
3207 error = EOPNOTSUPP;
3208 #if 0 /* notyet */
3209 error = *(int *)ap->a_data;
3210 error = acpi_AckSleepState(sc->acpi_clone, error);
3211 #endif
3212 break;
3213 case ACPIIO_SETSLPSTATE: /* DEPRECATED */
3214 error = EINVAL;
3215 state = *(int *)ap->a_data;
3216 if (state >= ACPI_STATE_S0 && state <= ACPI_S_STATES_MAX)
3217 if (ACPI_SUCCESS(acpi_SetSleepState(sc, state)))
3218 error = 0;
3219 break;
3220 case ACPIIO_DO_MCALL:
3221 if (acpi_allow_mcall == 1) {
3222 struct acpi_mcall_ioctl_arg *params;
3223 ACPI_BUFFER result = { ACPI_ALLOCATE_BUFFER, NULL };
3224 ACPI_OBJECT *resobj;
3226 error = EINVAL;
3227 params = (struct acpi_mcall_ioctl_arg *)ap->a_data;
3228 params->retval = AcpiEvaluateObject(NULL, params->path,
3229 &params->args, &result);
3230 if (ACPI_SUCCESS(params->retval) && result.Pointer != NULL &&
3231 params->result.Pointer != NULL) {
3232 params->result.Length = min(params->result.Length,
3233 result.Length);
3234 copyout(result.Pointer, params->result.Pointer,
3235 params->result.Length);
3236 params->reslen = result.Length;
3237 if (result.Length >= sizeof(ACPI_OBJECT)) {
3238 resobj = (ACPI_OBJECT *)params->result.Pointer;
3239 switch (resobj->Type) {
3240 case ACPI_TYPE_STRING:
3241 resobj->String.Pointer = (char *)
3242 ((UINT8 *)(resobj->String.Pointer) -
3243 (UINT8 *)result.Pointer +
3244 (UINT8 *)resobj);
3245 break;
3246 case ACPI_TYPE_BUFFER:
3247 resobj->Buffer.Pointer -= (UINT8 *)result.Pointer -
3248 (UINT8 *)resobj;
3249 break;
3252 error = 0;
3254 if (result.Pointer != NULL)
3255 AcpiOsFree(result.Pointer);
3256 } else {
3257 device_printf(sc->acpi_dev,
3258 "debug.acpi.allow_method_calls must be set\n");
3259 error = ENXIO;
3261 break;
3262 default:
3263 error = ENXIO;
3264 break;
3266 return (error);
3269 static int
3270 acpi_supported_sleep_state_sysctl(SYSCTL_HANDLER_ARGS)
3272 int error;
3273 struct sbuf sb;
3274 UINT8 state, TypeA, TypeB;
3276 sbuf_new(&sb, NULL, 32, SBUF_AUTOEXTEND);
3277 for (state = ACPI_STATE_S1; state < ACPI_S_STATES_MAX + 1; state++)
3278 if (ACPI_SUCCESS(AcpiGetSleepTypeData(state, &TypeA, &TypeB)))
3279 sbuf_printf(&sb, "S%d ", state);
3280 sbuf_trim(&sb);
3281 sbuf_finish(&sb);
3282 error = sysctl_handle_string(oidp, sbuf_data(&sb), sbuf_len(&sb), req);
3283 sbuf_delete(&sb);
3284 return (error);
3287 static int
3288 acpi_sleep_state_sysctl(SYSCTL_HANDLER_ARGS)
3290 char sleep_state[10];
3291 int error;
3292 u_int new_state, old_state;
3294 old_state = *(u_int *)oidp->oid_arg1;
3295 if (old_state > ACPI_S_STATES_MAX + 1)
3296 strlcpy(sleep_state, "unknown", sizeof(sleep_state));
3297 else
3298 strlcpy(sleep_state, sleep_state_names[old_state], sizeof(sleep_state));
3299 error = sysctl_handle_string(oidp, sleep_state, sizeof(sleep_state), req);
3300 if (error == 0 && req->newptr != NULL) {
3301 new_state = ACPI_STATE_S0;
3302 for (; new_state <= ACPI_S_STATES_MAX + 1; new_state++)
3303 if (strcmp(sleep_state, sleep_state_names[new_state]) == 0)
3304 break;
3305 if (new_state <= ACPI_S_STATES_MAX + 1) {
3306 if (new_state != old_state)
3307 *(u_int *)oidp->oid_arg1 = new_state;
3308 } else
3309 error = EINVAL;
3312 return (error);
3315 /* Inform devctl(4) when we receive a Notify. */
3316 void
3317 acpi_UserNotify(const char *subsystem, ACPI_HANDLE h, uint8_t notify)
3319 char notify_buf[16];
3320 ACPI_BUFFER handle_buf;
3321 ACPI_STATUS status;
3323 if (subsystem == NULL)
3324 return;
3326 handle_buf.Pointer = NULL;
3327 handle_buf.Length = ACPI_ALLOCATE_BUFFER;
3328 status = AcpiNsHandleToPathname(h, &handle_buf, FALSE);
3329 if (ACPI_FAILURE(status))
3330 return;
3331 ksnprintf(notify_buf, sizeof(notify_buf), "notify=0x%02x", notify);
3332 devctl_notify("ACPI", subsystem, handle_buf.Pointer, notify_buf);
3333 AcpiOsFree(handle_buf.Pointer);
3336 #ifdef ACPI_DEBUG
3338 * Support for parsing debug options from the kernel environment.
3340 * Bits may be set in the AcpiDbgLayer and AcpiDbgLevel debug registers
3341 * by specifying the names of the bits in the debug.acpi.layer and
3342 * debug.acpi.level environment variables. Bits may be unset by
3343 * prefixing the bit name with !.
3345 struct debugtag
3347 char *name;
3348 UINT32 value;
3351 static struct debugtag dbg_layer[] = {
3352 {"ACPI_UTILITIES", ACPI_UTILITIES},
3353 {"ACPI_HARDWARE", ACPI_HARDWARE},
3354 {"ACPI_EVENTS", ACPI_EVENTS},
3355 {"ACPI_TABLES", ACPI_TABLES},
3356 {"ACPI_NAMESPACE", ACPI_NAMESPACE},
3357 {"ACPI_PARSER", ACPI_PARSER},
3358 {"ACPI_DISPATCHER", ACPI_DISPATCHER},
3359 {"ACPI_EXECUTER", ACPI_EXECUTER},
3360 {"ACPI_RESOURCES", ACPI_RESOURCES},
3361 {"ACPI_CA_DEBUGGER", ACPI_CA_DEBUGGER},
3362 {"ACPI_OS_SERVICES", ACPI_OS_SERVICES},
3363 {"ACPI_CA_DISASSEMBLER", ACPI_CA_DISASSEMBLER},
3364 {"ACPI_ALL_COMPONENTS", ACPI_ALL_COMPONENTS},
3366 {"ACPI_AC_ADAPTER", ACPI_AC_ADAPTER},
3367 {"ACPI_BATTERY", ACPI_BATTERY},
3368 {"ACPI_BUS", ACPI_BUS},
3369 {"ACPI_BUTTON", ACPI_BUTTON},
3370 {"ACPI_EC", ACPI_EC},
3371 {"ACPI_FAN", ACPI_FAN},
3372 {"ACPI_POWERRES", ACPI_POWERRES},
3373 {"ACPI_PROCESSOR", ACPI_PROCESSOR},
3374 {"ACPI_THERMAL", ACPI_THERMAL},
3375 {"ACPI_TIMER", ACPI_TIMER},
3376 {"ACPI_ALL_DRIVERS", ACPI_ALL_DRIVERS},
3377 {NULL, 0}
3380 static struct debugtag dbg_level[] = {
3381 {"ACPI_LV_INIT", ACPI_LV_INIT},
3382 {"ACPI_LV_DEBUG_OBJECT", ACPI_LV_DEBUG_OBJECT},
3383 {"ACPI_LV_INFO", ACPI_LV_INFO},
3384 {"ACPI_LV_REPAIR", ACPI_LV_REPAIR},
3385 {"ACPI_LV_ALL_EXCEPTIONS", ACPI_LV_ALL_EXCEPTIONS},
3387 /* Trace verbosity level 1 [Standard Trace Level] */
3388 {"ACPI_LV_INIT_NAMES", ACPI_LV_INIT_NAMES},
3389 {"ACPI_LV_PARSE", ACPI_LV_PARSE},
3390 {"ACPI_LV_LOAD", ACPI_LV_LOAD},
3391 {"ACPI_LV_DISPATCH", ACPI_LV_DISPATCH},
3392 {"ACPI_LV_EXEC", ACPI_LV_EXEC},
3393 {"ACPI_LV_NAMES", ACPI_LV_NAMES},
3394 {"ACPI_LV_OPREGION", ACPI_LV_OPREGION},
3395 {"ACPI_LV_BFIELD", ACPI_LV_BFIELD},
3396 {"ACPI_LV_TABLES", ACPI_LV_TABLES},
3397 {"ACPI_LV_VALUES", ACPI_LV_VALUES},
3398 {"ACPI_LV_OBJECTS", ACPI_LV_OBJECTS},
3399 {"ACPI_LV_RESOURCES", ACPI_LV_RESOURCES},
3400 {"ACPI_LV_USER_REQUESTS", ACPI_LV_USER_REQUESTS},
3401 {"ACPI_LV_PACKAGE", ACPI_LV_PACKAGE},
3402 {"ACPI_LV_VERBOSITY1", ACPI_LV_VERBOSITY1},
3404 /* Trace verbosity level 2 [Function tracing and memory allocation] */
3405 {"ACPI_LV_ALLOCATIONS", ACPI_LV_ALLOCATIONS},
3406 {"ACPI_LV_FUNCTIONS", ACPI_LV_FUNCTIONS},
3407 {"ACPI_LV_OPTIMIZATIONS", ACPI_LV_OPTIMIZATIONS},
3408 {"ACPI_LV_VERBOSITY2", ACPI_LV_VERBOSITY2},
3409 {"ACPI_LV_ALL", ACPI_LV_ALL},
3411 /* Trace verbosity level 3 [Threading, I/O, and Interrupts] */
3412 {"ACPI_LV_MUTEX", ACPI_LV_MUTEX},
3413 {"ACPI_LV_THREADS", ACPI_LV_THREADS},
3414 {"ACPI_LV_IO", ACPI_LV_IO},
3415 {"ACPI_LV_INTERRUPTS", ACPI_LV_INTERRUPTS},
3416 {"ACPI_LV_VERBOSITY3", ACPI_LV_VERBOSITY3},
3418 /* Exceptionally verbose output -- also used in the global "DebugLevel" */
3419 {"ACPI_LV_AML_DISASSEMBLE", ACPI_LV_AML_DISASSEMBLE},
3420 {"ACPI_LV_VERBOSE_INFO", ACPI_LV_VERBOSE_INFO},
3421 {"ACPI_LV_FULL_TABLES", ACPI_LV_FULL_TABLES},
3422 {"ACPI_LV_EVENTS", ACPI_LV_EVENTS},
3423 {"ACPI_LV_VERBOSE", ACPI_LV_VERBOSE},
3424 {NULL, 0}
3427 static void
3428 acpi_parse_debug(char *cp, struct debugtag *tag, UINT32 *flag)
3430 char *ep;
3431 int i, l;
3432 int set;
3434 while (*cp) {
3435 if (isspace(*cp)) {
3436 cp++;
3437 continue;
3439 ep = cp;
3440 while (*ep && !isspace(*ep))
3441 ep++;
3442 if (*cp == '!') {
3443 set = 0;
3444 cp++;
3445 if (cp == ep)
3446 continue;
3447 } else {
3448 set = 1;
3450 l = ep - cp;
3451 for (i = 0; tag[i].name != NULL; i++) {
3452 if (!strncmp(cp, tag[i].name, l)) {
3453 if (set)
3454 *flag |= tag[i].value;
3455 else
3456 *flag &= ~tag[i].value;
3459 cp = ep;
3463 static void
3464 acpi_set_debugging(void *junk)
3466 char *layer, *level;
3468 if (cold) {
3469 AcpiDbgLayer = 0;
3470 AcpiDbgLevel = 0;
3473 layer = kgetenv("debug.acpi.layer");
3474 level = kgetenv("debug.acpi.level");
3475 if (layer == NULL && level == NULL)
3476 return;
3478 kprintf("ACPI set debug");
3479 if (layer != NULL) {
3480 if (strcmp("NONE", layer) != 0)
3481 kprintf(" layer '%s'", layer);
3482 acpi_parse_debug(layer, &dbg_layer[0], &AcpiDbgLayer);
3483 kfreeenv(layer);
3485 if (level != NULL) {
3486 if (strcmp("NONE", level) != 0)
3487 kprintf(" level '%s'", level);
3488 acpi_parse_debug(level, &dbg_level[0], &AcpiDbgLevel);
3489 kfreeenv(level);
3491 kprintf("\n");
3494 SYSINIT(acpi_debugging, SI_BOOT1_TUNABLES, SI_ORDER_ANY, acpi_set_debugging,
3495 NULL);
3497 static int
3498 acpi_debug_sysctl(SYSCTL_HANDLER_ARGS)
3500 int error, *dbg;
3501 struct debugtag *tag;
3502 struct sbuf sb;
3504 if (sbuf_new(&sb, NULL, 128, SBUF_AUTOEXTEND) == NULL)
3505 return (ENOMEM);
3506 if (strcmp(oidp->oid_arg1, "debug.acpi.layer") == 0) {
3507 tag = &dbg_layer[0];
3508 dbg = &AcpiDbgLayer;
3509 } else {
3510 tag = &dbg_level[0];
3511 dbg = &AcpiDbgLevel;
3514 /* Get old values if this is a get request. */
3515 ACPI_SERIAL_BEGIN(acpi);
3516 if (*dbg == 0) {
3517 sbuf_cpy(&sb, "NONE");
3518 } else if (req->newptr == NULL) {
3519 for (; tag->name != NULL; tag++) {
3520 if ((*dbg & tag->value) == tag->value)
3521 sbuf_printf(&sb, "%s ", tag->name);
3524 sbuf_trim(&sb);
3525 sbuf_finish(&sb);
3527 /* Copy out the old values to the user. */
3528 error = SYSCTL_OUT(req, sbuf_data(&sb), sbuf_len(&sb));
3529 sbuf_delete(&sb);
3531 /* If the user is setting a string, parse it. */
3532 if (error == 0 && req->newptr != NULL) {
3533 *dbg = 0;
3534 ksetenv((char *)oidp->oid_arg1, (char *)req->newptr);
3535 acpi_set_debugging(NULL);
3537 ACPI_SERIAL_END(acpi);
3539 return (error);
3542 SYSCTL_PROC(_debug_acpi, OID_AUTO, layer, CTLFLAG_RW | CTLTYPE_STRING,
3543 "debug.acpi.layer", 0, acpi_debug_sysctl, "A", "");
3544 SYSCTL_PROC(_debug_acpi, OID_AUTO, level, CTLFLAG_RW | CTLTYPE_STRING,
3545 "debug.acpi.level", 0, acpi_debug_sysctl, "A", "");
3546 #endif /* ACPI_DEBUG */
3548 static int
3549 acpi_debug_objects_sysctl(SYSCTL_HANDLER_ARGS)
3551 int error;
3552 int old;
3554 old = acpi_debug_objects;
3555 error = sysctl_handle_int(oidp, &acpi_debug_objects, 0, req);
3556 if (error != 0 || req->newptr == NULL)
3557 return (error);
3558 if (old == acpi_debug_objects || (old && acpi_debug_objects))
3559 return (0);
3561 ACPI_SERIAL_BEGIN(acpi);
3562 AcpiGbl_EnableAmlDebugObject = acpi_debug_objects ? TRUE : FALSE;
3563 ACPI_SERIAL_END(acpi);
3565 return (0);
3569 static int
3570 acpi_parse_interfaces(char *str, struct acpi_interface *iface)
3572 char *p;
3573 size_t len;
3574 int i, j;
3576 p = str;
3577 while (isspace(*p) || *p == ',')
3578 p++;
3579 len = strlen(p);
3580 if (len == 0)
3581 return (0);
3582 p = kstrdup(p, M_TEMP);
3583 for (i = 0; i < len; i++)
3584 if (p[i] == ',')
3585 p[i] = '\0';
3586 i = j = 0;
3587 while (i < len)
3588 if (isspace(p[i]) || p[i] == '\0')
3589 i++;
3590 else {
3591 i += strlen(p + i) + 1;
3592 j++;
3594 if (j == 0) {
3595 kfree(p, M_TEMP);
3596 return (0);
3598 iface->data = kmalloc(sizeof(*iface->data) * j, M_TEMP, M_WAITOK);
3599 iface->num = j;
3600 i = j = 0;
3601 while (i < len)
3602 if (isspace(p[i]) || p[i] == '\0')
3603 i++;
3604 else {
3605 iface->data[j] = p + i;
3606 i += strlen(p + i) + 1;
3607 j++;
3610 return (j);
3613 static void
3614 acpi_free_interfaces(struct acpi_interface *iface)
3616 kfree(iface->data[0], M_TEMP);
3617 kfree(iface->data, M_TEMP);
3620 static void
3621 acpi_reset_interfaces(device_t dev)
3623 struct acpi_interface list;
3624 ACPI_STATUS status;
3625 int i;
3627 if (acpi_parse_interfaces(acpi_install_interface, &list) > 0) {
3628 for (i = 0; i < list.num; i++) {
3629 status = AcpiInstallInterface(list.data[i]);
3630 if (ACPI_FAILURE(status))
3631 device_printf(dev,
3632 "failed to install _OSI(\"%s\"): %s\n",
3633 list.data[i], AcpiFormatException(status));
3634 else if (bootverbose)
3635 device_printf(dev, "installed _OSI(\"%s\")\n",
3636 list.data[i]);
3638 acpi_free_interfaces(&list);
3640 if (acpi_parse_interfaces(acpi_remove_interface, &list) > 0) {
3641 for (i = 0; i < list.num; i++) {
3642 status = AcpiRemoveInterface(list.data[i]);
3643 if (ACPI_FAILURE(status))
3644 device_printf(dev,
3645 "failed to remove _OSI(\"%s\"): %s\n",
3646 list.data[i], AcpiFormatException(status));
3647 else if (bootverbose)
3648 device_printf(dev, "removed _OSI(\"%s\")\n",
3649 list.data[i]);
3651 acpi_free_interfaces(&list);
3655 static int
3656 acpi_pm_func(u_long cmd, void *arg, ...)
3658 int state, acpi_state;
3659 int error;
3660 struct acpi_softc *sc;
3661 __va_list ap;
3663 error = 0;
3664 switch (cmd) {
3665 case POWER_CMD_SUSPEND:
3666 sc = (struct acpi_softc *)arg;
3667 if (sc == NULL) {
3668 error = EINVAL;
3669 goto out;
3672 __va_start(ap, arg);
3673 state = __va_arg(ap, int);
3674 __va_end(ap);
3676 switch (state) {
3677 case POWER_SLEEP_STATE_STANDBY:
3678 acpi_state = sc->acpi_standby_sx;
3679 break;
3680 case POWER_SLEEP_STATE_SUSPEND:
3681 acpi_state = sc->acpi_suspend_sx;
3682 break;
3683 case POWER_SLEEP_STATE_HIBERNATE:
3684 acpi_state = ACPI_STATE_S4;
3685 break;
3686 default:
3687 error = EINVAL;
3688 goto out;
3691 if (ACPI_FAILURE(acpi_EnterSleepState(sc, acpi_state)))
3692 error = ENXIO;
3693 break;
3694 default:
3695 error = EINVAL;
3696 goto out;
3699 out:
3700 return (error);
3703 static void
3704 acpi_pm_register(void *arg)
3706 if (!cold || resource_disabled("acpi", 0))
3707 return;
3709 power_pm_register(POWER_PM_TYPE_ACPI, acpi_pm_func, NULL);
3712 SYSINIT(power, SI_BOOT2_KLD, SI_ORDER_ANY, acpi_pm_register, 0);