sched_setaffinity.2: Small markup fix.
[dragonfly.git] / sys / dev / acpica / acpi.c
blob954e7225415c81ab585f30d3f167a1c4c2e5e8e7
1 /*-
2 * Copyright (c) 2000 Takanori Watanabe <takawata@jp.kfreebsd.org>
3 * Copyright (c) 2000 Mitsuru IWASAKI <iwasaki@jp.kfreebsd.org>
4 * Copyright (c) 2000, 2001 Michael Smith
5 * Copyright (c) 2000 BSDi
6 * All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
29 * $FreeBSD: src/sys/dev/acpica/acpi.c,v 1.243.2.4.4.1 2009/04/15 03:14:26 kensmith Exp $
32 #include "opt_acpi.h"
33 #include <sys/param.h>
34 #include <sys/kernel.h>
35 #include <sys/proc.h>
36 #include <sys/fcntl.h>
37 #include <sys/malloc.h>
38 #include <sys/module.h>
39 #include <sys/bus.h>
40 #include <sys/conf.h>
41 #include <sys/reboot.h>
42 #include <sys/sysctl.h>
43 #include <sys/ctype.h>
44 #include <sys/linker.h>
45 #include <sys/power.h>
46 #include <sys/sbuf.h>
47 #include <sys/device.h>
48 #include <sys/spinlock.h>
49 #include <sys/spinlock2.h>
50 #include <sys/uuid.h>
52 #include <sys/rman.h>
53 #include <bus/isa/isavar.h>
54 #include <bus/isa/pnpvar.h>
56 #include "acpi.h"
57 #include <dev/acpica/acpivar.h>
58 #include <dev/acpica/acpiio.h>
59 #include <dev/acpica/acpiio_mcall.h>
60 #include "achware.h"
61 #include "acnamesp.h"
62 #include "acglobal.h"
64 #include "pci_if.h"
65 #include <bus/pci/pci_cfgreg.h>
66 #include <bus/pci/pcivar.h>
67 #include <bus/pci/pci_private.h>
69 #include <vm/vm_param.h>
71 MALLOC_DEFINE(M_ACPIDEV, "acpidev", "ACPI devices");
73 /* Hooks for the ACPICA debugging infrastructure */
74 #define _COMPONENT ACPI_BUS
75 ACPI_MODULE_NAME("ACPI");
77 static d_open_t acpiopen;
78 static d_close_t acpiclose;
79 static d_ioctl_t acpiioctl;
81 static struct dev_ops acpi_ops = {
82 { "acpi", 0, D_MPSAFE },
83 .d_open = acpiopen,
84 .d_close = acpiclose,
85 .d_ioctl = acpiioctl
88 struct acpi_interface {
89 ACPI_STRING *data;
90 int num;
93 /* Global mutex for locking access to the ACPI subsystem. */
94 struct lock acpi_lock;
95 struct lwkt_token acpi_token = LWKT_TOKEN_INITIALIZER(acpi_token);
97 /* Bitmap of device quirks. */
98 int acpi_quirks;
100 static int acpi_modevent(struct module *mod, int event, void *junk);
101 static void acpi_identify(driver_t *driver, device_t parent);
102 static int acpi_probe(device_t dev);
103 static int acpi_attach(device_t dev);
104 static int acpi_suspend(device_t dev);
105 static int acpi_resume(device_t dev);
106 static int acpi_shutdown(device_t dev);
107 static device_t acpi_add_child(device_t bus, device_t parent, int order, const char *name,
108 int unit);
109 static int acpi_print_child(device_t bus, device_t child);
110 static void acpi_probe_nomatch(device_t bus, device_t child);
111 static void acpi_driver_added(device_t dev, driver_t *driver);
112 static int acpi_read_ivar(device_t dev, device_t child, int index,
113 uintptr_t *result);
114 static int acpi_write_ivar(device_t dev, device_t child, int index,
115 uintptr_t value);
116 static struct resource_list *acpi_get_rlist(device_t dev, device_t child);
117 static int acpi_sysres_alloc(device_t dev);
118 static struct resource *acpi_alloc_resource(device_t bus, device_t child,
119 int type, int *rid, u_long start, u_long end,
120 u_long count, u_int flags, int cpuid);
121 static int acpi_release_resource(device_t bus, device_t child, int type,
122 int rid, struct resource *r);
123 static void acpi_delete_resource(device_t bus, device_t child, int type,
124 int rid);
125 static uint32_t acpi_isa_get_logicalid(device_t dev);
126 static int acpi_isa_get_compatid(device_t dev, uint32_t *cids, int count);
127 static char *acpi_device_id_probe(device_t bus, device_t dev, char **ids);
128 static ACPI_STATUS acpi_device_eval_obj(device_t bus, device_t dev,
129 ACPI_STRING pathname, ACPI_OBJECT_LIST *parameters,
130 ACPI_BUFFER *ret);
131 static int acpi_device_pwr_for_sleep(device_t bus, device_t dev,
132 int *dstate);
133 static ACPI_STATUS acpi_device_scan_cb(ACPI_HANDLE h, UINT32 level,
134 void *context, void **retval);
135 static ACPI_STATUS acpi_device_scan_children(device_t bus, device_t dev,
136 int max_depth, acpi_scan_cb_t user_fn, void *arg);
137 static int acpi_set_powerstate_method(device_t bus, device_t child,
138 int state);
139 static int acpi_isa_pnp_probe(device_t bus, device_t child,
140 struct isa_pnp_id *ids);
141 static void acpi_probe_children(device_t bus);
142 static void acpi_probe_order(ACPI_HANDLE handle, int *order);
143 static ACPI_STATUS acpi_probe_child(ACPI_HANDLE handle, UINT32 level,
144 void *context, void **status);
145 static ACPI_STATUS acpi_EnterSleepState(struct acpi_softc *sc, int state);
146 static void acpi_shutdown_final(void *arg, int howto);
147 static void acpi_enable_fixed_events(struct acpi_softc *sc);
148 static int acpi_wake_sleep_prep(ACPI_HANDLE handle, int sstate);
149 static int acpi_wake_run_prep(ACPI_HANDLE handle, int sstate);
150 static int acpi_wake_prep_walk(int sstate);
151 static int acpi_wake_sysctl_walk(device_t dev);
152 #ifdef notyet
153 static int acpi_wake_set_sysctl(SYSCTL_HANDLER_ARGS);
154 #endif
155 static void acpi_system_eventhandler_sleep(void *arg, int state);
156 static void acpi_system_eventhandler_wakeup(void *arg, int state);
157 static int acpi_supported_sleep_state_sysctl(SYSCTL_HANDLER_ARGS);
158 static int acpi_sleep_state_sysctl(SYSCTL_HANDLER_ARGS);
159 static int acpi_debug_objects_sysctl(SYSCTL_HANDLER_ARGS);
160 static int acpi_pm_func(u_long cmd, void *arg, ...);
161 static int acpi_child_location_str_method(device_t acdev, device_t child,
162 char *buf, size_t buflen);
163 static int acpi_child_pnpinfo_str_method(device_t acdev, device_t child,
164 char *buf, size_t buflen);
165 static void acpi_enable_pcie(void);
166 static void acpi_reset_interfaces(device_t dev);
168 static device_method_t acpi_methods[] = {
169 /* Device interface */
170 DEVMETHOD(device_identify, acpi_identify),
171 DEVMETHOD(device_probe, acpi_probe),
172 DEVMETHOD(device_attach, acpi_attach),
173 DEVMETHOD(device_shutdown, acpi_shutdown),
174 DEVMETHOD(device_detach, bus_generic_detach),
175 DEVMETHOD(device_suspend, acpi_suspend),
176 DEVMETHOD(device_resume, acpi_resume),
178 /* Bus interface */
179 DEVMETHOD(bus_add_child, acpi_add_child),
180 DEVMETHOD(bus_print_child, acpi_print_child),
181 DEVMETHOD(bus_probe_nomatch, acpi_probe_nomatch),
182 DEVMETHOD(bus_driver_added, acpi_driver_added),
183 DEVMETHOD(bus_read_ivar, acpi_read_ivar),
184 DEVMETHOD(bus_write_ivar, acpi_write_ivar),
185 DEVMETHOD(bus_get_resource_list, acpi_get_rlist),
186 DEVMETHOD(bus_set_resource, bus_generic_rl_set_resource),
187 DEVMETHOD(bus_get_resource, bus_generic_rl_get_resource),
188 DEVMETHOD(bus_alloc_resource, acpi_alloc_resource),
189 DEVMETHOD(bus_release_resource, acpi_release_resource),
190 DEVMETHOD(bus_delete_resource, acpi_delete_resource),
191 DEVMETHOD(bus_child_pnpinfo_str, acpi_child_pnpinfo_str_method),
192 DEVMETHOD(bus_child_location_str, acpi_child_location_str_method),
193 DEVMETHOD(bus_activate_resource, bus_generic_activate_resource),
194 DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource),
195 DEVMETHOD(bus_setup_intr, bus_generic_setup_intr),
196 DEVMETHOD(bus_teardown_intr, bus_generic_teardown_intr),
198 /* ACPI bus */
199 DEVMETHOD(acpi_id_probe, acpi_device_id_probe),
200 DEVMETHOD(acpi_evaluate_object, acpi_device_eval_obj),
201 DEVMETHOD(acpi_pwr_for_sleep, acpi_device_pwr_for_sleep),
202 DEVMETHOD(acpi_scan_children, acpi_device_scan_children),
204 /* PCI emulation */
205 DEVMETHOD(pci_set_powerstate, acpi_set_powerstate_method),
207 /* ISA emulation */
208 DEVMETHOD(isa_pnp_probe, acpi_isa_pnp_probe),
210 DEVMETHOD_END
213 static driver_t acpi_driver = {
214 "acpi",
215 acpi_methods,
216 sizeof(struct acpi_softc),
219 static devclass_t acpi_devclass;
220 DRIVER_MODULE(acpi, nexus, acpi_driver, acpi_devclass, acpi_modevent, NULL);
221 MODULE_VERSION(acpi, 1);
223 ACPI_SERIAL_DECL(acpi, "ACPI serializer");
225 /* Local pools for managing system resources for ACPI child devices. */
226 static struct rman acpi_rman_io, acpi_rman_mem;
228 #define ACPI_MINIMUM_AWAKETIME 5
230 static const char* sleep_state_names[] = {
231 "S0", "S1", "S2", "S3", "S4", "S5", "NONE"};
233 SYSCTL_NODE(_debug, OID_AUTO, acpi, CTLFLAG_RD, NULL, "ACPI debugging");
234 static char acpi_ca_version[12];
235 SYSCTL_STRING(_debug_acpi, OID_AUTO, acpi_ca_version, CTLFLAG_RD,
236 acpi_ca_version, 0, "Version of Intel ACPICA");
239 * Allow overriding _OSI methods.
241 static char acpi_install_interface[256];
242 TUNABLE_STR("hw.acpi.install_interface", acpi_install_interface,
243 sizeof(acpi_install_interface));
244 static char acpi_remove_interface[256];
245 TUNABLE_STR("hw.acpi.remove_interface", acpi_remove_interface,
246 sizeof(acpi_remove_interface));
249 * Use this tunable to disable the control method auto-serialization
250 * mechanism that was added in 20140214 and superseded the previous
251 * AcpiGbl_SerializeAllMethods global.
253 static int acpi_auto_serialize_methods = 1;
254 TUNABLE_INT("hw.acpi.auto_serialize_methods", &acpi_auto_serialize_methods);
256 /* Allow users to dump Debug objects without ACPI debugger. */
257 static int acpi_debug_objects;
258 TUNABLE_INT("debug.acpi.enable_debug_objects", &acpi_debug_objects);
259 SYSCTL_PROC(_debug_acpi, OID_AUTO, enable_debug_objects,
260 CTLFLAG_RW | CTLTYPE_INT, NULL, 0, acpi_debug_objects_sysctl, "I",
261 "Enable Debug objects.");
263 /* Allow ignoring the XSDT. */
264 static int acpi_ignore_xsdt;
265 TUNABLE_INT("debug.acpi.ignore_xsdt", &acpi_ignore_xsdt);
266 SYSCTL_INT(_debug_acpi, OID_AUTO, ignore_xsdt, CTLFLAG_RD,
267 &acpi_ignore_xsdt, 1, "Ignore the XSDT, forcing the use of the RSDT.");
269 /* Allow the interpreter to ignore common mistakes in BIOS. */
270 static int acpi_interpreter_slack = 1;
271 TUNABLE_INT("debug.acpi.interpreter_slack", &acpi_interpreter_slack);
272 SYSCTL_INT(_debug_acpi, OID_AUTO, interpreter_slack, CTLFLAG_RD,
273 &acpi_interpreter_slack, 1, "Turn on interpreter slack mode.");
275 /* Allow preferring 32-bit FADT register addresses over the 64-bit ones. */
276 static int acpi_fadt_addr32;
277 TUNABLE_INT("debug.acpi.fadt_addr32", &acpi_fadt_addr32);
278 SYSCTL_INT(_debug_acpi, OID_AUTO, fadt_addr32, CTLFLAG_RD,
279 &acpi_fadt_addr32, 1,
280 "Prefer 32-bit FADT register addresses over 64-bit ones.");
282 /* Prefer 32-bit FACS table addresses over the 64-bit ones. */
283 static int acpi_facs_addr32 = 1;
284 TUNABLE_INT("debug.acpi.facs_addr32", &acpi_facs_addr32);
285 SYSCTL_INT(_debug_acpi, OID_AUTO, facs_addr32, CTLFLAG_RD,
286 &acpi_facs_addr32, 1,
287 "Prefer 32-bit FACS table addresses over 64-bit ones.");
289 static int acpi_group_module_level_code;
290 TUNABLE_INT("debug.acpi.group_module_level_code", &acpi_group_module_level_code);
291 SYSCTL_INT(_debug_acpi, OID_AUTO, group_module_level_code, CTLFLAG_RD,
292 &acpi_group_module_level_code, 1,
293 "Group module-level code.");
295 /* Power devices off and on in suspend and resume. XXX Remove once tested. */
296 static int acpi_do_powerstate = 1;
297 TUNABLE_INT("debug.acpi.do_powerstate", &acpi_do_powerstate);
298 SYSCTL_INT(_debug_acpi, OID_AUTO, do_powerstate, CTLFLAG_RW,
299 &acpi_do_powerstate, 1, "Turn off devices when suspending.");
301 /* Allow users to override quirks. */
302 TUNABLE_INT("debug.acpi.quirks", &acpi_quirks);
304 /* Allow to call ACPI methods from userland. */
305 static int acpi_allow_mcall;
306 TUNABLE_INT("debug.acpi.allow_method_calls", &acpi_allow_mcall);
308 static int acpi_susp_bounce;
309 SYSCTL_INT(_debug_acpi, OID_AUTO, suspend_bounce, CTLFLAG_RW,
310 &acpi_susp_bounce, 0, "Don't actually suspend, just test devices.");
313 * ACPI can only be loaded as a module by the loader; activating it after
314 * system bootstrap time is not useful, and can be fatal to the system.
315 * It also cannot be unloaded, since the entire system bus heirarchy hangs
316 * off it.
318 static int
319 acpi_modevent(struct module *mod, int event, void *junk)
321 switch (event) {
322 case MOD_LOAD:
323 if (!cold) {
324 kprintf("The ACPI driver cannot be loaded after boot.\n");
325 return (EPERM);
327 break;
328 case MOD_UNLOAD:
329 if (!cold && power_pm_get_type() == POWER_PM_TYPE_ACPI)
330 return (EBUSY);
331 break;
332 default:
333 break;
335 return (0);
339 * Perform early initialization.
341 ACPI_STATUS
342 acpi_Startup(void)
344 static int started = 0;
345 ACPI_STATUS status;
346 int val;
348 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
350 /* Only run the startup code once. The MADT driver also calls this. */
351 if (started)
352 return_VALUE (AE_OK);
353 started = 1;
356 * Pre-allocate space for RSDT/XSDT and DSDT tables and allow resizing
357 * if more tables exist.
359 if (ACPI_FAILURE(status = AcpiInitializeTables(NULL, 2, TRUE))) {
360 kprintf("ACPI: Table initialisation failed: %s\n",
361 AcpiFormatException(status));
362 return_VALUE (status);
365 /* Set up any quirks we have for this system. */
366 if (acpi_quirks == ACPI_Q_OK)
367 acpi_table_quirks(&acpi_quirks);
369 /* If the user manually set the disabled hint to 0, force-enable ACPI. */
370 if (resource_int_value("acpi", 0, "disabled", &val) == 0 && val == 0)
371 acpi_quirks &= ~ACPI_Q_BROKEN;
372 if (acpi_quirks & ACPI_Q_BROKEN) {
373 kprintf("ACPI disabled by blacklist. Contact your BIOS vendor.\n");
374 status = AE_SUPPORT;
377 return_VALUE (status);
381 * Detect ACPI, perform early initialisation
383 static void
384 acpi_identify(driver_t *driver, device_t parent)
386 device_t child;
388 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
390 if (!cold)
391 return_VOID;
393 /* Check that we haven't been disabled with a hint. */
394 if (resource_disabled("acpi", 0))
395 return_VOID;
397 /* Make sure we're not being doubly invoked. */
398 if (device_find_child(parent, "acpi", 0) != NULL)
399 return_VOID;
401 ksnprintf(acpi_ca_version, sizeof(acpi_ca_version), "%x", ACPI_CA_VERSION);
403 /* Initialize root tables. */
404 if (ACPI_FAILURE(acpi_Startup())) {
405 kprintf("ACPI: Try disabling either ACPI or apic support.\n");
406 return_VOID;
409 /* Attach the actual ACPI device. */
410 if ((child = BUS_ADD_CHILD(parent, parent, 10, "acpi", 0)) == NULL) {
411 device_printf(parent, "device_identify failed\n");
412 return_VOID;
417 * Fetch some descriptive data from ACPI to put in our attach message.
419 static int
420 acpi_probe(device_t dev)
422 ACPI_TABLE_RSDP *rsdp;
423 ACPI_TABLE_HEADER *rsdt;
424 ACPI_PHYSICAL_ADDRESS paddr;
425 char buf[ACPI_OEM_ID_SIZE + ACPI_OEM_TABLE_ID_SIZE + 2];
426 struct sbuf sb;
428 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
430 if (power_pm_get_type() != POWER_PM_TYPE_NONE &&
431 power_pm_get_type() != POWER_PM_TYPE_ACPI) {
432 device_printf(dev, "probe failed, other PM system enabled.\n");
433 return_VALUE (ENXIO);
436 if ((paddr = AcpiOsGetRootPointer()) == 0 ||
437 (rsdp = AcpiOsMapMemory(paddr, sizeof(ACPI_TABLE_RSDP))) == NULL)
438 return_VALUE (ENXIO);
439 if (acpi_ignore_xsdt == 0 &&
440 rsdp->Revision > 1 && rsdp->XsdtPhysicalAddress != 0)
441 paddr = (ACPI_PHYSICAL_ADDRESS)rsdp->XsdtPhysicalAddress;
442 else
443 paddr = (ACPI_PHYSICAL_ADDRESS)rsdp->RsdtPhysicalAddress;
444 AcpiOsUnmapMemory(rsdp, sizeof(ACPI_TABLE_RSDP));
446 if ((rsdt = AcpiOsMapMemory(paddr, sizeof(ACPI_TABLE_HEADER))) == NULL)
447 return_VALUE (ENXIO);
448 sbuf_new(&sb, buf, sizeof(buf), SBUF_FIXEDLEN);
449 sbuf_bcat(&sb, rsdt->OemId, ACPI_OEM_ID_SIZE);
450 sbuf_trim(&sb);
451 sbuf_putc(&sb, ' ');
452 sbuf_bcat(&sb, rsdt->OemTableId, ACPI_OEM_TABLE_ID_SIZE);
453 sbuf_trim(&sb);
454 sbuf_finish(&sb);
455 device_set_desc_copy(dev, sbuf_data(&sb));
456 sbuf_delete(&sb);
457 AcpiOsUnmapMemory(rsdt, sizeof(ACPI_TABLE_HEADER));
459 return_VALUE (0);
462 static int
463 acpi_attach(device_t dev)
465 struct acpi_softc *sc;
466 ACPI_STATUS status;
467 int error, state;
468 UINT32 flags;
469 UINT8 TypeA, TypeB;
470 char *env;
472 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
474 sc = device_get_softc(dev);
475 sc->acpi_dev = dev;
476 callout_init(&sc->susp_force_to);
478 if ((error = acpi_task_thread_init())) {
479 device_printf(dev, "Could not start task thread.\n");
480 goto out2;
483 error = ENXIO;
485 /* Initialize resource manager. */
486 acpi_rman_io.rm_type = RMAN_ARRAY;
487 acpi_rman_io.rm_start = 0;
488 acpi_rman_io.rm_end = 0xffff;
489 acpi_rman_io.rm_descr = "ACPI I/O ports";
490 if (rman_init(&acpi_rman_io, -1) != 0)
491 panic("acpi rman_init IO ports failed");
492 acpi_rman_mem.rm_type = RMAN_ARRAY;
493 acpi_rman_mem.rm_start = 0;
494 acpi_rman_mem.rm_end = ~0ul;
495 acpi_rman_mem.rm_descr = "ACPI I/O memory addresses";
496 if (rman_init(&acpi_rman_mem, -1) != 0)
497 panic("acpi rman_init memory failed");
499 /* Initialise the ACPI mutex */
500 ACPI_LOCK_INIT(acpi, "acpi");
501 ACPI_SERIAL_INIT(acpi);
503 ACPI_LOCK(acpi);
506 * Set the globals from our tunables. This is needed because ACPICA
507 * uses UINT8 for some values and we have no tunable_byte.
509 AcpiGbl_AutoSerializeMethods = acpi_auto_serialize_methods ? TRUE : FALSE;
510 AcpiGbl_DoNotUseXsdt = acpi_ignore_xsdt ? TRUE : FALSE;
511 AcpiGbl_EnableAmlDebugObject = acpi_debug_objects ? TRUE : FALSE;
512 AcpiGbl_EnableInterpreterSlack = acpi_interpreter_slack ? TRUE : FALSE;
513 AcpiGbl_GroupModuleLevelCode = acpi_group_module_level_code ? TRUE : FALSE;
514 AcpiGbl_Use32BitFadtAddresses = acpi_fadt_addr32 ? TRUE : FALSE;
515 AcpiGbl_Use32BitFacsAddresses = acpi_facs_addr32 ? TRUE : FALSE;
517 #ifndef ACPI_DEBUG
519 * Disable Debug Object output.
521 AcpiDbgLevel &= ~ACPI_LV_DEBUG_OBJECT;
522 #endif
524 /* Start up the ACPICA subsystem. */
525 status = AcpiInitializeSubsystem();
526 if (ACPI_FAILURE(status)) {
527 device_printf(dev, "Could not initialize Subsystem: %s\n",
528 AcpiFormatException(status));
529 goto out;
532 /* Override OS interfaces if the user requested. */
533 acpi_reset_interfaces(dev);
535 /* Load ACPI name space. */
536 status = AcpiLoadTables();
537 if (ACPI_FAILURE(status)) {
538 device_printf(dev, "Could not load Namespace: %s\n",
539 AcpiFormatException(status));
540 goto out;
543 /* Handle MCFG table if present. */
544 acpi_enable_pcie();
547 * Note that some systems (specifically, those with namespace evaluation
548 * issues that require the avoidance of parts of the namespace) must
549 * avoid running _INI and _STA on everything, as well as dodging the final
550 * object init pass.
552 * For these devices, we set ACPI_NO_DEVICE_INIT and ACPI_NO_OBJECT_INIT).
554 * XXX We should arrange for the object init pass after we have attached
555 * all our child devices, but on many systems it works here.
557 flags = ACPI_FULL_INITIALIZATION;
558 if (ktestenv("debug.acpi.avoid"))
559 flags = ACPI_NO_DEVICE_INIT | ACPI_NO_OBJECT_INIT;
561 /* Bring the hardware and basic handlers online. */
562 if (ACPI_FAILURE(status = AcpiEnableSubsystem(flags))) {
563 device_printf(dev, "Could not enable ACPI: %s\n",
564 AcpiFormatException(status));
565 goto out;
569 * Fix up the interrupt timer after enabling ACPI, so that the
570 * interrupt cputimer that choked by ACPI power management could
571 * be resurrected before probing various devices.
573 DELAY(5000);
574 cputimer_intr_pmfixup();
577 * Call the ECDT probe function to provide EC functionality before
578 * the namespace has been evaluated.
580 * XXX This happens before the sysresource devices have been probed and
581 * attached so its resources come from nexus0. In practice, this isn't
582 * a problem but should be addressed eventually.
584 acpi_ec_ecdt_probe(dev);
586 /* Bring device objects and regions online. */
587 if (ACPI_FAILURE(status = AcpiInitializeObjects(flags))) {
588 device_printf(dev, "Could not initialize ACPI objects: %s\n",
589 AcpiFormatException(status));
590 goto out;
594 * Setup our sysctl tree.
596 * XXX: This doesn't check to make sure that none of these fail.
598 sysctl_ctx_init(&sc->acpi_sysctl_ctx);
599 sc->acpi_sysctl_tree = SYSCTL_ADD_NODE(&sc->acpi_sysctl_ctx,
600 SYSCTL_STATIC_CHILDREN(_hw), OID_AUTO,
601 device_get_name(dev), CTLFLAG_RD, 0, "");
602 SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
603 OID_AUTO, "supported_sleep_state", CTLTYPE_STRING | CTLFLAG_RD,
604 0, 0, acpi_supported_sleep_state_sysctl, "A", "");
605 SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
606 OID_AUTO, "power_button_state", CTLTYPE_STRING | CTLFLAG_RW,
607 &sc->acpi_power_button_sx, 0, acpi_sleep_state_sysctl, "A", "");
608 SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
609 OID_AUTO, "sleep_button_state", CTLTYPE_STRING | CTLFLAG_RW,
610 &sc->acpi_sleep_button_sx, 0, acpi_sleep_state_sysctl, "A", "");
611 SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
612 OID_AUTO, "lid_switch_state", CTLTYPE_STRING | CTLFLAG_RW,
613 &sc->acpi_lid_switch_sx, 0, acpi_sleep_state_sysctl, "A", "");
614 SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
615 OID_AUTO, "standby_state", CTLTYPE_STRING | CTLFLAG_RW,
616 &sc->acpi_standby_sx, 0, acpi_sleep_state_sysctl, "A", "");
617 SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
618 OID_AUTO, "suspend_state", CTLTYPE_STRING | CTLFLAG_RW,
619 &sc->acpi_suspend_sx, 0, acpi_sleep_state_sysctl, "A", "");
620 SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
621 OID_AUTO, "sleep_delay", CTLFLAG_RW, &sc->acpi_sleep_delay, 0,
622 "sleep delay");
623 SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
624 OID_AUTO, "s4bios", CTLFLAG_RW, &sc->acpi_s4bios, 0, "S4BIOS mode");
625 SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
626 OID_AUTO, "verbose", CTLFLAG_RW, &sc->acpi_verbose, 0, "verbose mode");
627 SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
628 OID_AUTO, "disable_on_reboot", CTLFLAG_RW,
629 &sc->acpi_do_disable, 0, "Disable ACPI when rebooting/halting system");
630 SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
631 OID_AUTO, "handle_reboot", CTLFLAG_RW,
632 &sc->acpi_handle_reboot, 0, "Use ACPI Reset Register to reboot");
635 * Default to 1 second before sleeping to give some machines time to
636 * stabilize.
638 sc->acpi_sleep_delay = 1;
639 if (bootverbose)
640 sc->acpi_verbose = 1;
641 if ((env = kgetenv("hw.acpi.verbose")) != NULL) {
642 if (strcmp(env, "0") != 0)
643 sc->acpi_verbose = 1;
644 kfreeenv(env);
647 /* Only enable reboot by default if the FADT says it is available. */
648 if (AcpiGbl_FADT.Flags & ACPI_FADT_RESET_REGISTER)
649 sc->acpi_handle_reboot = 1;
651 /* Only enable S4BIOS by default if the FACS says it is available. */
652 if (AcpiGbl_FACS->Flags & ACPI_FACS_S4_BIOS_PRESENT)
653 sc->acpi_s4bios = 1;
656 * Dispatch the default sleep state to devices. The lid switch is set
657 * to NONE by default to avoid surprising users.
659 sc->acpi_power_button_sx = ACPI_STATE_S5;
660 sc->acpi_lid_switch_sx = ACPI_S_STATES_MAX + 1;
661 sc->acpi_standby_sx = ACPI_STATE_S1;
662 sc->acpi_suspend_sx = ACPI_STATE_S3;
664 /* Pick the first valid sleep state for the sleep button default. */
665 sc->acpi_sleep_button_sx = ACPI_S_STATES_MAX + 1;
666 for (state = ACPI_STATE_S1; state <= ACPI_STATE_S4; state++)
667 if (ACPI_SUCCESS(AcpiGetSleepTypeData(state, &TypeA, &TypeB))) {
668 sc->acpi_sleep_button_sx = state;
669 break;
672 acpi_enable_fixed_events(sc);
675 * Scan the namespace and attach/initialise children.
678 /* Register our shutdown handler. */
679 EVENTHANDLER_REGISTER(shutdown_final, acpi_shutdown_final, sc,
680 SHUTDOWN_PRI_LAST);
683 * Register our acpi event handlers.
684 * XXX should be configurable eg. via userland policy manager.
686 EVENTHANDLER_REGISTER(acpi_sleep_event, acpi_system_eventhandler_sleep,
687 sc, ACPI_EVENT_PRI_LAST);
688 EVENTHANDLER_REGISTER(acpi_wakeup_event, acpi_system_eventhandler_wakeup,
689 sc, ACPI_EVENT_PRI_LAST);
691 /* Flag our initial states. */
692 sc->acpi_enabled = 1;
693 sc->acpi_sstate = ACPI_STATE_S0;
694 sc->acpi_sleep_disabled = 0;
695 /* Create the control device */
696 sc->acpi_dev_t = make_dev(&acpi_ops, 0, UID_ROOT, GID_WHEEL, 0644, "acpi");
697 sc->acpi_dev_t->si_drv1 = sc;
699 if ((error = acpi_machdep_init(dev)))
700 goto out;
702 /* Register ACPI again to pass the correct argument of pm_func. */
703 power_pm_register(POWER_PM_TYPE_ACPI, acpi_pm_func, sc);
705 if (!acpi_disabled("bus"))
706 acpi_probe_children(dev);
708 /* Update all GPEs and enable runtime GPEs. */
709 status = AcpiUpdateAllGpes();
710 if (ACPI_FAILURE(status)) {
711 device_printf(dev, "Could not update all GPEs: %s\n",
712 AcpiFormatException(status));
715 /* Allow sleep request after a while. */
716 /* timeout(acpi_sleep_enable, sc, hz * ACPI_MINIMUM_AWAKETIME); */
718 error = 0;
720 out:
721 ACPI_UNLOCK(acpi);
722 out2:
723 cputimer_intr_pmfixup();
724 acpi_task_thread_schedule();
726 return_VALUE (error);
729 static int
730 acpi_suspend(device_t dev)
732 device_t child, *devlist;
733 int error, i, numdevs, pstate;
735 /* First give child devices a chance to suspend. */
736 error = bus_generic_suspend(dev);
737 if (error)
738 return (error);
741 * Now, set them into the appropriate power state, usually D3. If the
742 * device has an _SxD method for the next sleep state, use that power
743 * state instead.
745 device_get_children(dev, &devlist, &numdevs);
746 for (i = 0; i < numdevs; i++) {
747 /* If the device is not attached, we've powered it down elsewhere. */
748 child = devlist[i];
749 if (!device_is_attached(child))
750 continue;
753 * Default to D3 for all sleep states. The _SxD method is optional
754 * so set the powerstate even if it's absent.
756 pstate = PCI_POWERSTATE_D3;
757 error = acpi_device_pwr_for_sleep(device_get_parent(child),
758 child, &pstate);
759 if ((error == 0 || error == ESRCH) && acpi_do_powerstate)
760 pci_set_powerstate(child, pstate);
762 kfree(devlist, M_TEMP);
763 error = 0;
765 return (error);
768 static int
769 acpi_resume(device_t dev)
771 ACPI_HANDLE handle;
772 int i, numdevs;
773 device_t child, *devlist;
776 * Put all devices in D0 before resuming them. Call _S0D on each one
777 * since some systems expect this.
779 device_get_children(dev, &devlist, &numdevs);
780 for (i = 0; i < numdevs; i++) {
781 child = devlist[i];
782 handle = acpi_get_handle(child);
783 if (handle)
784 AcpiEvaluateObject(handle, "_S0D", NULL, NULL);
785 if (device_is_attached(child) && acpi_do_powerstate)
786 pci_set_powerstate(child, PCI_POWERSTATE_D0);
788 kfree(devlist, M_TEMP);
790 return (bus_generic_resume(dev));
793 static int
794 acpi_shutdown(device_t dev)
796 /* Allow children to shutdown first. */
797 bus_generic_shutdown(dev);
800 * Enable any GPEs that are able to power-on the system (i.e., RTC).
801 * Also, disable any that are not valid for this state (most).
803 acpi_wake_prep_walk(ACPI_STATE_S5);
805 return (0);
809 * Handle a new device being added
811 static device_t
812 acpi_add_child(device_t bus, device_t parent, int order, const char *name, int unit)
814 struct acpi_device *ad;
815 device_t child;
817 if ((ad = kmalloc(sizeof(*ad), M_ACPIDEV, M_NOWAIT | M_ZERO)) == NULL)
818 return (NULL);
820 resource_list_init(&ad->ad_rl);
821 child = device_add_child_ordered(parent, order, name, unit);
822 if (child != NULL)
823 device_set_ivars(child, ad);
824 else
825 kfree(ad, M_ACPIDEV);
826 return (child);
829 static int
830 acpi_print_child(device_t bus, device_t child)
832 struct acpi_device *adev = device_get_ivars(child);
833 struct resource_list *rl = &adev->ad_rl;
834 int retval = 0;
836 retval += bus_print_child_header(bus, child);
837 retval += resource_list_print_type(rl, "port", SYS_RES_IOPORT, "%#lx");
838 retval += resource_list_print_type(rl, "iomem", SYS_RES_MEMORY, "%#lx");
839 retval += resource_list_print_type(rl, "irq", SYS_RES_IRQ, "%ld");
840 retval += resource_list_print_type(rl, "drq", SYS_RES_DRQ, "%ld");
841 if (device_get_flags(child))
842 retval += kprintf(" flags %#x", device_get_flags(child));
843 retval += bus_print_child_footer(bus, child);
845 return (retval);
849 * If this device is an ACPI child but no one claimed it, attempt
850 * to power it off. We'll power it back up when a driver is added.
852 * XXX Disabled for now since many necessary devices (like fdc and
853 * ATA) don't claim the devices we created for them but still expect
854 * them to be powered up.
856 static void
857 acpi_probe_nomatch(device_t bus, device_t child)
860 /* pci_set_powerstate(child, PCI_POWERSTATE_D3); */
864 * If a new driver has a chance to probe a child, first power it up.
866 * XXX Disabled for now (see acpi_probe_nomatch for details).
868 static void
869 acpi_driver_added(device_t dev, driver_t *driver)
871 device_t child, *devlist;
872 int i, numdevs;
874 DEVICE_IDENTIFY(driver, dev);
875 device_get_children(dev, &devlist, &numdevs);
876 for (i = 0; i < numdevs; i++) {
877 child = devlist[i];
878 if (device_get_state(child) == DS_NOTPRESENT) {
879 /* pci_set_powerstate(child, PCI_POWERSTATE_D0); */
880 if (device_probe_and_attach(child) != 0)
881 ; /* pci_set_powerstate(child, PCI_POWERSTATE_D3); */
884 kfree(devlist, M_TEMP);
887 /* Location hint for devctl(8) */
888 static int
889 acpi_child_location_str_method(device_t cbdev, device_t child, char *buf,
890 size_t buflen)
892 struct acpi_device *dinfo = device_get_ivars(child);
894 if (dinfo->ad_handle)
895 ksnprintf(buf, buflen, "handle=%s", acpi_name(dinfo->ad_handle));
896 else
897 ksnprintf(buf, buflen, "unknown");
898 return (0);
901 /* PnP information for devctl(8) */
902 static int
903 acpi_child_pnpinfo_str_method(device_t cbdev, device_t child, char *buf,
904 size_t buflen)
906 ACPI_DEVICE_INFO *adinfo;
907 struct acpi_device *dinfo = device_get_ivars(child);
908 char *end;
910 if (ACPI_FAILURE(AcpiGetObjectInfo(dinfo->ad_handle, &adinfo))) {
911 ksnprintf(buf, buflen, "unknown");
912 } else {
913 ksnprintf(buf, buflen, "_HID=%s _UID=%lu",
914 (adinfo->Valid & ACPI_VALID_HID) ?
915 adinfo->HardwareId.String : "none",
916 (adinfo->Valid & ACPI_VALID_UID) ?
917 strtoul(adinfo->UniqueId.String, &end, 10) : 0);
918 if (adinfo)
919 AcpiOsFree(adinfo);
921 return (0);
925 * Handle per-device ivars
927 static int
928 acpi_read_ivar(device_t dev, device_t child, int index, uintptr_t *result)
930 struct acpi_device *ad;
932 if ((ad = device_get_ivars(child)) == NULL) {
933 device_printf(child, "device has no ivars\n");
934 return (ENOENT);
937 /* ACPI and ISA compatibility ivars */
938 switch(index) {
939 case ACPI_IVAR_HANDLE:
940 *(ACPI_HANDLE *)result = ad->ad_handle;
941 break;
942 case ACPI_IVAR_MAGIC:
943 *result = ad->ad_magic;
944 break;
945 case ACPI_IVAR_PRIVATE:
946 *(void **)result = ad->ad_private;
947 break;
948 case ACPI_IVAR_FLAGS:
949 *(int *)result = ad->ad_flags;
950 break;
951 case ISA_IVAR_VENDORID:
952 case ISA_IVAR_SERIAL:
953 case ISA_IVAR_COMPATID:
954 *(int *)result = -1;
955 break;
956 case ISA_IVAR_LOGICALID:
957 *(int *)result = acpi_isa_get_logicalid(child);
958 break;
959 default:
960 return (ENOENT);
963 return (0);
966 static int
967 acpi_write_ivar(device_t dev, device_t child, int index, uintptr_t value)
969 struct acpi_device *ad;
971 if ((ad = device_get_ivars(child)) == NULL) {
972 device_printf(child, "device has no ivars\n");
973 return (ENOENT);
976 switch(index) {
977 case ACPI_IVAR_HANDLE:
978 ad->ad_handle = (ACPI_HANDLE)value;
979 break;
980 case ACPI_IVAR_MAGIC:
981 ad->ad_magic = value;
982 break;
983 case ACPI_IVAR_PRIVATE:
984 ad->ad_private = (void *)value;
985 break;
986 case ACPI_IVAR_FLAGS:
987 ad->ad_flags = (int)value;
988 break;
989 default:
990 panic("bad ivar write request (%d)", index);
991 return (ENOENT);
994 return (0);
998 * Handle child resource allocation/removal
1000 static struct resource_list *
1001 acpi_get_rlist(device_t dev, device_t child)
1003 struct acpi_device *ad;
1005 ad = device_get_ivars(child);
1006 return (&ad->ad_rl);
1010 * Pre-allocate/manage all memory and IO resources. Since rman can't handle
1011 * duplicates, we merge any in the sysresource attach routine.
1013 static int
1014 acpi_sysres_alloc(device_t dev)
1016 struct resource *res;
1017 struct resource_list *rl;
1018 struct resource_list_entry *rle;
1019 struct rman *rm;
1020 char *sysres_ids[] = { "PNP0C01", "PNP0C02", NULL };
1021 device_t *children;
1022 int child_count, i;
1024 * Probe/attach any sysresource devices. This would be unnecessary if we
1025 * had multi-pass probe/attach.
1027 if (device_get_children(dev, &children, &child_count) != 0)
1028 return (ENXIO);
1029 for (i = 0; i < child_count; i++) {
1030 if (ACPI_ID_PROBE(dev, children[i], sysres_ids) != NULL)
1031 device_probe_and_attach(children[i]);
1033 kfree(children, M_TEMP);
1035 rl = BUS_GET_RESOURCE_LIST(device_get_parent(dev), dev);
1036 if(!rl)
1037 return 0;
1038 SLIST_FOREACH(rle, rl, link) {
1039 if (rle->res != NULL) {
1040 device_printf(dev, "duplicate resource for %lx\n", rle->start);
1041 continue;
1044 /* Only memory and IO resources are valid here. */
1045 switch (rle->type) {
1046 case SYS_RES_IOPORT:
1047 rm = &acpi_rman_io;
1048 break;
1049 case SYS_RES_MEMORY:
1050 rm = &acpi_rman_mem;
1051 break;
1052 default:
1053 continue;
1056 /* Pre-allocate resource and add to our rman pool. */
1057 res = BUS_ALLOC_RESOURCE(device_get_parent(dev), dev, rle->type,
1058 &rle->rid, rle->start, rle->start + rle->count - 1, rle->count,
1059 0, -1);
1060 if (res != NULL) {
1061 rman_manage_region(rm, rman_get_start(res), rman_get_end(res));
1062 rle->res = res;
1063 } else
1064 device_printf(dev, "reservation of %lx, %lx (%d) failed\n",
1065 rle->start, rle->count, rle->type);
1067 return (0);
1070 static struct resource *
1071 acpi_alloc_resource(device_t bus, device_t child, int type, int *rid,
1072 u_long start, u_long end, u_long count, u_int flags, int cpuid)
1074 ACPI_RESOURCE ares;
1075 struct acpi_device *ad = device_get_ivars(child);
1076 struct resource_list *rl = &ad->ad_rl;
1077 struct resource_list_entry *rle;
1078 struct resource *res;
1079 struct rman *rm;
1081 res = NULL;
1083 /* We only handle memory and IO resources through rman. */
1084 switch (type) {
1085 case SYS_RES_IOPORT:
1086 rm = &acpi_rman_io;
1087 break;
1088 case SYS_RES_MEMORY:
1089 rm = &acpi_rman_mem;
1090 break;
1091 default:
1092 rm = NULL;
1095 ACPI_SERIAL_BEGIN(acpi);
1098 * If this is an allocation of the "default" range for a given RID, and
1099 * we know what the resources for this device are (i.e., they're on the
1100 * child's resource list), use those start/end values.
1102 if (bus == device_get_parent(child) && start == 0UL && end == ~0UL) {
1103 rle = resource_list_find(rl, type, *rid);
1104 if (rle == NULL)
1105 goto out;
1106 start = rle->start;
1107 end = rle->end;
1108 count = rle->count;
1109 cpuid = rle->cpuid;
1113 * If this is an allocation of a specific range, see if we can satisfy
1114 * the request from our system resource regions. If we can't, pass the
1115 * request up to the parent.
1117 if (start + count - 1 == end && rm != NULL)
1118 res = rman_reserve_resource(rm, start, end, count, flags & ~RF_ACTIVE,
1119 child);
1120 if (res == NULL) {
1121 res = BUS_ALLOC_RESOURCE(device_get_parent(bus), child, type, rid,
1122 start, end, count, flags, cpuid);
1123 } else {
1124 rman_set_rid(res, *rid);
1126 /* If requested, activate the resource using the parent's method. */
1127 if (flags & RF_ACTIVE)
1128 if (bus_activate_resource(child, type, *rid, res) != 0) {
1129 rman_release_resource(res);
1130 res = NULL;
1131 goto out;
1135 if (res != NULL && device_get_parent(child) == bus)
1136 switch (type) {
1137 case SYS_RES_IRQ:
1139 * Since bus_config_intr() takes immediate effect, we cannot
1140 * configure the interrupt associated with a device when we
1141 * parse the resources but have to defer it until a driver
1142 * actually allocates the interrupt via bus_alloc_resource().
1144 * NB: Lookup failure is fine, since the device may add its
1145 * own interrupt resources, e.g. MSI or MSI-X.
1147 if (ACPI_SUCCESS(
1148 acpi_lookup_irq_resource(child, *rid, res, &ares))) {
1149 acpi_config_intr(child, &ares);
1150 } else {
1151 kprintf("irq resource not found\n");
1153 break;
1156 out:
1157 ACPI_SERIAL_END(acpi);
1158 return (res);
1161 static int
1162 acpi_release_resource(device_t bus, device_t child, int type, int rid,
1163 struct resource *r)
1165 struct rman *rm;
1166 int ret;
1168 /* We only handle memory and IO resources through rman. */
1169 switch (type) {
1170 case SYS_RES_IOPORT:
1171 rm = &acpi_rman_io;
1172 break;
1173 case SYS_RES_MEMORY:
1174 rm = &acpi_rman_mem;
1175 break;
1176 default:
1177 rm = NULL;
1180 ACPI_SERIAL_BEGIN(acpi);
1183 * If this resource belongs to one of our internal managers,
1184 * deactivate it and release it to the local pool. If it doesn't,
1185 * pass this request up to the parent.
1187 if (rm != NULL && rman_is_region_manager(r, rm)) {
1188 if (rman_get_flags(r) & RF_ACTIVE) {
1189 ret = bus_deactivate_resource(child, type, rid, r);
1190 if (ret != 0)
1191 goto out;
1193 ret = rman_release_resource(r);
1194 } else
1195 ret = BUS_RELEASE_RESOURCE(device_get_parent(bus), child, type, rid, r);
1197 out:
1198 ACPI_SERIAL_END(acpi);
1199 return (ret);
1202 static void
1203 acpi_delete_resource(device_t bus, device_t child, int type, int rid)
1205 struct resource_list *rl;
1207 rl = acpi_get_rlist(bus, child);
1208 resource_list_delete(rl, type, rid);
1211 /* Allocate an IO port or memory resource, given its GAS. */
1213 acpi_bus_alloc_gas(device_t dev, int *type, int *rid, ACPI_GENERIC_ADDRESS *gas,
1214 struct resource **res, u_int flags)
1216 int error, res_type;
1218 error = ENOMEM;
1219 if (type == NULL || rid == NULL || gas == NULL || res == NULL)
1220 return (EINVAL);
1222 /* We only support memory and IO spaces. */
1223 switch (gas->SpaceId) {
1224 case ACPI_ADR_SPACE_SYSTEM_MEMORY:
1225 res_type = SYS_RES_MEMORY;
1226 break;
1227 case ACPI_ADR_SPACE_SYSTEM_IO:
1228 res_type = SYS_RES_IOPORT;
1229 break;
1230 default:
1231 return (EOPNOTSUPP);
1235 * If the register width is less than 8, assume the BIOS author means
1236 * it is a bit field and just allocate a byte.
1238 if (gas->BitWidth && gas->BitWidth < 8)
1239 gas->BitWidth = 8;
1241 /* Validate the address after we're sure we support the space. */
1242 if (gas->Address == 0 || gas->BitWidth == 0)
1243 return (EINVAL);
1245 bus_set_resource(dev, res_type, *rid, gas->Address,
1246 gas->BitWidth / 8, -1);
1247 *res = bus_alloc_resource_any(dev, res_type, rid, RF_ACTIVE | flags);
1248 if (*res != NULL) {
1249 *type = res_type;
1250 error = 0;
1251 } else
1252 bus_delete_resource(dev, res_type, *rid);
1254 return (error);
1257 ACPI_STATUS
1258 acpi_eval_osc(device_t dev, ACPI_HANDLE handle, const char *uuidstr,
1259 int revision, uint32_t *buf, int count)
1261 ACPI_BUFFER retbuf = { ACPI_ALLOCATE_BUFFER, NULL };
1262 ACPI_OBJECT_LIST arglist;
1263 ACPI_OBJECT arg[4];
1264 ACPI_OBJECT *retobj;
1265 ACPI_STATUS status;
1266 struct uuid uuid;
1267 uint32_t error;
1268 uint8_t oscuuid[16];
1269 int i;
1271 if (parse_uuid(uuidstr, &uuid) != 0)
1272 return (AE_ERROR);
1273 le_uuid_enc(oscuuid, &uuid);
1275 arglist.Pointer = arg;
1276 arglist.Count = 4;
1277 arg[0].Type = ACPI_TYPE_BUFFER;
1278 arg[0].Buffer.Length = sizeof(oscuuid);
1279 arg[0].Buffer.Pointer = oscuuid; /* UUID */
1280 arg[1].Type = ACPI_TYPE_INTEGER;
1281 arg[1].Integer.Value = revision; /* revision */
1282 arg[2].Type = ACPI_TYPE_INTEGER;
1283 arg[2].Integer.Value = count; /* # of cap integers */
1284 arg[3].Type = ACPI_TYPE_BUFFER;
1285 arg[3].Buffer.Length = count * sizeof(uint32_t); /* capabilities buffer */
1286 arg[3].Buffer.Pointer = (uint8_t *)buf;
1288 status = AcpiEvaluateObject(handle, "_OSC", &arglist, &retbuf);
1289 if (ACPI_FAILURE(status))
1290 goto done;
1291 retobj = retbuf.Pointer;
1292 error = ((uint32_t *)retobj->Buffer.Pointer)[0] & ACPI_OSCERR_MASK;
1293 if (error == 0)
1294 goto done;
1295 status = AE_ERROR;
1296 if (error & ACPI_OSCERR_OSCFAIL)
1297 device_printf(dev, "_OSC unable to process request\n");
1298 if (error & ACPI_OSCERR_UUID)
1299 device_printf(dev, "_OSC unrecognized UUID (%s)\n", uuidstr);
1300 if (error & ACPI_OSCERR_REVISION)
1301 device_printf(dev, "_OSC unrecognized revision ID (%d)\n", revision);
1302 if (error & ACPI_OSCERR_CAPSMASKED) {
1303 if ((buf[0] & ACPI_OSC_QUERY_SUPPORT) == 0) {
1304 for (i = 1; i < count; i++) {
1305 device_printf(dev,
1306 "_OSC capabilities have been masked: buf[%d]:%#x\n",
1307 i, buf[i] & ~((uint32_t *)retobj->Buffer.Pointer)[i]);
1309 status = AE_SUPPORT;
1310 } else {
1311 status = AE_OK;
1315 done:
1316 if (retbuf.Pointer != NULL)
1317 AcpiOsFree(retbuf.Pointer);
1318 return (status);
1321 /* Probe _HID and _CID for compatible ISA PNP ids. */
1322 static uint32_t
1323 acpi_isa_get_logicalid(device_t dev)
1325 ACPI_DEVICE_INFO *devinfo;
1326 ACPI_HANDLE h;
1327 uint32_t pnpid;
1329 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1331 devinfo = NULL;
1332 pnpid = 0;
1334 /* Fetch and validate the HID. */
1335 if ((h = acpi_get_handle(dev)) == NULL ||
1336 ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo)))
1337 goto out;
1339 if ((devinfo->Valid & ACPI_VALID_HID) != 0)
1340 pnpid = PNP_EISAID(devinfo->HardwareId.String);
1342 out:
1343 if (devinfo)
1344 AcpiOsFree(devinfo);
1345 return_VALUE (pnpid);
1348 static int
1349 acpi_isa_get_compatid(device_t dev, uint32_t *cids, int count)
1351 ACPI_DEVICE_INFO *devinfo;
1352 ACPI_HANDLE h;
1353 uint32_t *pnpid;
1354 int valid, i;
1356 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1358 devinfo = NULL;
1359 pnpid = cids;
1360 valid = 0;
1362 /* Fetch and validate the CID */
1363 if ((h = acpi_get_handle(dev)) == NULL ||
1364 ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo)) ||
1365 (devinfo->Valid & ACPI_VALID_CID) == 0)
1366 goto out;
1368 if (devinfo->CompatibleIdList.Count < count)
1369 count = devinfo->CompatibleIdList.Count;
1370 for (i = 0; i < count; i++) {
1371 if (strncmp(devinfo->CompatibleIdList.Ids[i].String, "PNP", 3) != 0)
1372 continue;
1373 *pnpid++ = PNP_EISAID(devinfo->CompatibleIdList.Ids[i].String);
1374 valid++;
1377 out:
1378 if (devinfo)
1379 AcpiOsFree(devinfo);
1380 return_VALUE (valid);
1383 static char *
1384 acpi_device_id_probe(device_t bus, device_t dev, char **ids)
1386 ACPI_HANDLE h;
1387 int i;
1389 h = acpi_get_handle(dev);
1390 if (ids == NULL || h == NULL || acpi_get_type(dev) != ACPI_TYPE_DEVICE)
1391 return (NULL);
1393 /* Try to match one of the array of IDs with a HID or CID. */
1394 for (i = 0; ids[i] != NULL; i++) {
1395 if (acpi_MatchHid(h, ids[i]))
1396 return (ids[i]);
1398 return (NULL);
1401 static ACPI_STATUS
1402 acpi_device_eval_obj(device_t bus, device_t dev, ACPI_STRING pathname,
1403 ACPI_OBJECT_LIST *parameters, ACPI_BUFFER *ret)
1405 ACPI_HANDLE h;
1407 if (dev == NULL)
1408 h = ACPI_ROOT_OBJECT;
1409 else if ((h = acpi_get_handle(dev)) == NULL)
1410 return (AE_BAD_PARAMETER);
1411 return (AcpiEvaluateObject(h, pathname, parameters, ret));
1414 static int
1415 acpi_device_pwr_for_sleep(device_t bus, device_t dev, int *dstate)
1417 struct acpi_softc *sc;
1418 ACPI_HANDLE handle;
1419 ACPI_STATUS status;
1420 char sxd[8];
1421 int error;
1423 sc = device_get_softc(bus);
1424 handle = acpi_get_handle(dev);
1427 * XXX If we find these devices, don't try to power them down.
1428 * The serial and IRDA ports on my T23 hang the system when
1429 * set to D3 and it appears that such legacy devices may
1430 * need special handling in their drivers.
1432 if (handle == NULL ||
1433 acpi_MatchHid(handle, "PNP0500") ||
1434 acpi_MatchHid(handle, "PNP0501") ||
1435 acpi_MatchHid(handle, "PNP0502") ||
1436 acpi_MatchHid(handle, "PNP0510") ||
1437 acpi_MatchHid(handle, "PNP0511"))
1438 return (ENXIO);
1441 * Override next state with the value from _SxD, if present. If no
1442 * dstate argument was provided, don't fetch the return value.
1444 ksnprintf(sxd, sizeof(sxd), "_S%dD", sc->acpi_sstate);
1445 if (dstate)
1446 status = acpi_GetInteger(handle, sxd, dstate);
1447 else
1448 status = AcpiEvaluateObject(handle, sxd, NULL, NULL);
1450 switch (status) {
1451 case AE_OK:
1452 error = 0;
1453 break;
1454 case AE_NOT_FOUND:
1455 error = ESRCH;
1456 break;
1457 default:
1458 error = ENXIO;
1459 break;
1462 return (error);
1465 /* Callback arg for our implementation of walking the namespace. */
1466 struct acpi_device_scan_ctx {
1467 acpi_scan_cb_t user_fn;
1468 void *arg;
1469 ACPI_HANDLE parent;
1472 static ACPI_STATUS
1473 acpi_device_scan_cb(ACPI_HANDLE h, UINT32 level, void *arg, void **retval)
1475 struct acpi_device_scan_ctx *ctx;
1476 device_t dev, old_dev;
1477 ACPI_STATUS status;
1478 ACPI_OBJECT_TYPE type;
1481 * Skip this device if we think we'll have trouble with it or it is
1482 * the parent where the scan began.
1484 ctx = (struct acpi_device_scan_ctx *)arg;
1485 if (acpi_avoid(h) || h == ctx->parent)
1486 return (AE_OK);
1488 /* If this is not a valid device type (e.g., a method), skip it. */
1489 if (ACPI_FAILURE(AcpiGetType(h, &type)))
1490 return (AE_OK);
1491 if (type != ACPI_TYPE_DEVICE && type != ACPI_TYPE_PROCESSOR &&
1492 type != ACPI_TYPE_THERMAL && type != ACPI_TYPE_POWER)
1493 return (AE_OK);
1496 * Call the user function with the current device. If it is unchanged
1497 * afterwards, return. Otherwise, we update the handle to the new dev.
1499 old_dev = acpi_get_device(h);
1500 dev = old_dev;
1501 status = ctx->user_fn(h, &dev, level, ctx->arg);
1502 if (ACPI_FAILURE(status) || old_dev == dev)
1503 return (status);
1505 /* Remove the old child and its connection to the handle. */
1506 if (old_dev != NULL) {
1507 device_delete_child(device_get_parent(old_dev), old_dev);
1508 AcpiDetachData(h, acpi_fake_objhandler);
1511 /* Recreate the handle association if the user created a device. */
1512 if (dev != NULL)
1513 AcpiAttachData(h, acpi_fake_objhandler, dev);
1515 return (AE_OK);
1518 static ACPI_STATUS
1519 acpi_device_scan_children(device_t bus, device_t dev, int max_depth,
1520 acpi_scan_cb_t user_fn, void *arg)
1522 ACPI_HANDLE h;
1523 struct acpi_device_scan_ctx ctx;
1525 if (acpi_disabled("children"))
1526 return (AE_OK);
1528 if (dev == NULL)
1529 h = ACPI_ROOT_OBJECT;
1530 else if ((h = acpi_get_handle(dev)) == NULL)
1531 return (AE_BAD_PARAMETER);
1532 ctx.user_fn = user_fn;
1533 ctx.arg = arg;
1534 ctx.parent = h;
1535 return (AcpiWalkNamespace(ACPI_TYPE_ANY, h, max_depth,
1536 acpi_device_scan_cb, NULL, &ctx, NULL));
1540 * Even though ACPI devices are not PCI, we use the PCI approach for setting
1541 * device power states since it's close enough to ACPI.
1543 static int
1544 acpi_set_powerstate_method(device_t bus, device_t child, int state)
1546 ACPI_HANDLE h;
1547 ACPI_STATUS status;
1548 int error;
1550 error = 0;
1551 h = acpi_get_handle(child);
1552 if (state < ACPI_STATE_D0 || state > ACPI_STATE_D3)
1553 return (EINVAL);
1554 if (h == NULL)
1555 return (0);
1557 /* Ignore errors if the power methods aren't present. */
1558 status = acpi_pwr_switch_consumer(h, state);
1559 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND
1560 && status != AE_BAD_PARAMETER)
1561 device_printf(bus, "failed to set ACPI power state D%d on %s: %s\n",
1562 state, acpi_name(h), AcpiFormatException(status));
1564 return (error);
1567 static int
1568 acpi_isa_pnp_probe(device_t bus, device_t child, struct isa_pnp_id *ids)
1570 int result, cid_count, i;
1571 uint32_t lid, cids[8];
1573 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1576 * ISA-style drivers attached to ACPI may persist and
1577 * probe manually if we return ENOENT. We never want
1578 * that to happen, so don't ever return it.
1580 result = ENXIO;
1582 /* Scan the supplied IDs for a match */
1583 lid = acpi_isa_get_logicalid(child);
1584 cid_count = acpi_isa_get_compatid(child, cids, 8);
1585 while (ids && ids->ip_id) {
1586 if (lid == ids->ip_id) {
1587 result = 0;
1588 goto out;
1590 for (i = 0; i < cid_count; i++) {
1591 if (cids[i] == ids->ip_id) {
1592 result = 0;
1593 goto out;
1596 ids++;
1599 out:
1600 if (result == 0 && ids->ip_desc)
1601 device_set_desc(child, ids->ip_desc);
1603 return_VALUE (result);
1607 * Look for a MCFG table. If it is present, use the settings for
1608 * domain (segment) 0 to setup PCI config space access via the memory
1609 * map.
1611 static void
1612 acpi_enable_pcie(void)
1614 ACPI_TABLE_HEADER *hdr;
1615 ACPI_MCFG_ALLOCATION *alloc, *end;
1616 ACPI_STATUS status;
1618 status = AcpiGetTable(ACPI_SIG_MCFG, 1, &hdr);
1619 if (ACPI_FAILURE(status))
1620 return;
1622 end = (ACPI_MCFG_ALLOCATION *)((char *)hdr + hdr->Length);
1623 alloc = (ACPI_MCFG_ALLOCATION *)((ACPI_TABLE_MCFG *)hdr + 1);
1624 while (alloc < end) {
1625 if (alloc->PciSegment == 0) {
1626 pcie_cfgregopen(alloc->Address, alloc->StartBusNumber,
1627 alloc->EndBusNumber);
1628 return;
1630 alloc++;
1635 * Scan all of the ACPI namespace and attach child devices.
1637 * We should only expect to find devices in the \_PR, \_TZ, \_SI, and
1638 * \_SB scopes, and \_PR and \_TZ became obsolete in the ACPI 2.0 spec.
1639 * However, in violation of the spec, some systems place their PCI link
1640 * devices in \, so we have to walk the whole namespace. We check the
1641 * type of namespace nodes, so this should be ok.
1643 static void
1644 acpi_probe_children(device_t bus)
1647 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1650 * Scan the namespace and insert placeholders for all the devices that
1651 * we find. We also probe/attach any early devices.
1653 * Note that we use AcpiWalkNamespace rather than AcpiGetDevices because
1654 * we want to create nodes for all devices, not just those that are
1655 * currently present. (This assumes that we don't want to create/remove
1656 * devices as they appear, which might be smarter.)
1658 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "namespace scan\n"));
1659 AcpiWalkNamespace(ACPI_TYPE_ANY, ACPI_ROOT_OBJECT, 100,
1660 acpi_probe_child, NULL, bus, NULL);
1662 /* Pre-allocate resources for our rman from any sysresource devices. */
1663 acpi_sysres_alloc(bus);
1664 /* Create any static children by calling device identify methods. */
1665 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "device identify routines\n"));
1666 bus_generic_probe(bus);
1668 /* Probe/attach all children, created staticly and from the namespace. */
1669 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "first bus_generic_attach\n"));
1670 bus_generic_attach(bus);
1673 * Some of these children may have attached others as part of their attach
1674 * process (eg. the root PCI bus driver), so rescan.
1676 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "second bus_generic_attach\n"));
1677 bus_generic_attach(bus);
1679 /* Attach wake sysctls. */
1680 acpi_wake_sysctl_walk(bus);
1682 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "done attaching children\n"));
1683 return_VOID;
1687 * Determine the probe order for a given device.
1689 static void
1690 acpi_probe_order(ACPI_HANDLE handle, int *order)
1692 ACPI_OBJECT_TYPE type;
1695 * 1. I/O port and memory system resource holders
1696 * 2. Embedded controllers (to handle early accesses)
1697 * 3. PCI Link Devices
1698 * 100000. CPUs
1700 AcpiGetType(handle, &type);
1701 if (acpi_MatchHid(handle, "PNP0C01") || acpi_MatchHid(handle, "PNP0C02"))
1702 *order = 1;
1703 else if (acpi_MatchHid(handle, "PNP0C09"))
1704 *order = 2;
1705 else if (acpi_MatchHid(handle, "PNP0C0F"))
1706 *order = 3;
1707 else if (type == ACPI_TYPE_PROCESSOR)
1708 *order = 100000;
1712 * Evaluate a child device and determine whether we might attach a device to
1713 * it.
1715 static ACPI_STATUS
1716 acpi_probe_child(ACPI_HANDLE handle, UINT32 level, void *context, void **status)
1718 struct acpi_prw_data prw;
1719 ACPI_OBJECT_TYPE type;
1720 ACPI_HANDLE h;
1721 device_t bus, child;
1722 int order;
1723 char *handle_str;
1725 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1727 if (acpi_disabled("children"))
1728 return_ACPI_STATUS (AE_OK);
1730 /* Skip this device if we think we'll have trouble with it. */
1731 if (acpi_avoid(handle))
1732 return_ACPI_STATUS (AE_OK);
1734 bus = (device_t)context;
1735 if (ACPI_SUCCESS(AcpiGetType(handle, &type))) {
1736 handle_str = acpi_name(handle);
1737 switch (type) {
1738 case ACPI_TYPE_DEVICE:
1740 * Since we scan from \, be sure to skip system scope objects.
1741 * \_SB_ and \_TZ_ are defined in ACPICA as devices to work around
1742 * BIOS bugs. For example, \_SB_ is to allow \_SB_._INI to be run
1743 * during the intialization and \_TZ_ is to support Notify() on it.
1745 if (strcmp(handle_str, "\\_SB_") == 0 ||
1746 strcmp(handle_str, "\\_TZ_") == 0)
1747 break;
1749 if (acpi_parse_prw(handle, &prw) == 0)
1750 AcpiSetupGpeForWake(handle, prw.gpe_handle, prw.gpe_bit);
1752 /* FALLTHROUGH */
1753 case ACPI_TYPE_PROCESSOR:
1754 case ACPI_TYPE_THERMAL:
1755 case ACPI_TYPE_POWER:
1757 * Create a placeholder device for this node. Sort the
1758 * placeholder so that the probe/attach passes will run
1759 * breadth-first. Orders less than ACPI_DEV_BASE_ORDER
1760 * are reserved for special objects (i.e., system
1761 * resources). CPU devices have a very high order to
1762 * ensure they are probed after other devices.
1764 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "scanning '%s'\n", handle_str));
1765 order = level * 10 + 100;
1766 acpi_probe_order(handle, &order);
1767 child = BUS_ADD_CHILD(bus, bus, order, NULL, -1);
1768 if (child == NULL)
1769 break;
1771 /* Associate the handle with the device_t and vice versa. */
1772 acpi_set_handle(child, handle);
1773 AcpiAttachData(handle, acpi_fake_objhandler, child);
1776 * Check that the device is present. If it's not present,
1777 * leave it disabled (so that we have a device_t attached to
1778 * the handle, but we don't probe it).
1780 * XXX PCI link devices sometimes report "present" but not
1781 * "functional" (i.e. if disabled). Go ahead and probe them
1782 * anyway since we may enable them later.
1784 if (type == ACPI_TYPE_DEVICE && !acpi_DeviceIsPresent(child)) {
1785 /* Never disable PCI link devices. */
1786 if (acpi_MatchHid(handle, "PNP0C0F"))
1787 break;
1789 * Docking stations should remain enabled since the system
1790 * may be undocked at boot.
1792 if (ACPI_SUCCESS(AcpiGetHandle(handle, "_DCK", &h)))
1793 break;
1795 device_disable(child);
1796 break;
1800 * Get the device's resource settings and attach them.
1801 * Note that if the device has _PRS but no _CRS, we need
1802 * to decide when it's appropriate to try to configure the
1803 * device. Ignore the return value here; it's OK for the
1804 * device not to have any resources.
1806 acpi_parse_resources(child, handle, &acpi_res_parse_set, NULL);
1807 break;
1811 return_ACPI_STATUS (AE_OK);
1815 * AcpiAttachData() requires an object handler but never uses it. This is a
1816 * placeholder object handler so we can store a device_t in an ACPI_HANDLE.
1818 void
1819 acpi_fake_objhandler(ACPI_HANDLE h, void *data)
1823 static void
1824 acpi_shutdown_final(void *arg, int howto)
1826 struct acpi_softc *sc;
1827 ACPI_STATUS status;
1830 * XXX Shutdown code should only run on the BSP (cpuid 0).
1831 * Some chipsets do not power off the system correctly if called from
1832 * an AP.
1834 sc = arg;
1835 if ((howto & RB_POWEROFF) != 0) {
1836 status = AcpiEnterSleepStatePrep(ACPI_STATE_S5);
1837 if (ACPI_FAILURE(status)) {
1838 device_printf(sc->acpi_dev, "AcpiEnterSleepStatePrep failed - %s\n",
1839 AcpiFormatException(status));
1840 return;
1842 device_printf(sc->acpi_dev, "Powering system off\n");
1843 ACPI_DISABLE_IRQS();
1844 status = AcpiEnterSleepState(ACPI_STATE_S5);
1845 if (ACPI_FAILURE(status)) {
1846 device_printf(sc->acpi_dev, "power-off failed - %s\n",
1847 AcpiFormatException(status));
1848 } else {
1849 DELAY(1000000);
1850 device_printf(sc->acpi_dev, "power-off failed - timeout\n");
1852 } else if ((howto & RB_HALT) == 0 && sc->acpi_handle_reboot) {
1853 /* Reboot using the reset register. */
1854 status = AcpiReset();
1855 if (ACPI_FAILURE(status)) {
1856 if (status != AE_NOT_EXIST)
1857 device_printf(sc->acpi_dev, "reset failed - %s\n",
1858 AcpiFormatException(status));
1859 } else {
1860 DELAY(1000000);
1861 device_printf(sc->acpi_dev, "reset failed - timeout\n");
1863 } else if (sc->acpi_do_disable && panicstr == NULL) {
1865 * Only disable ACPI if the user requested. On some systems, writing
1866 * the disable value to SMI_CMD hangs the system.
1868 device_printf(sc->acpi_dev, "Shutting down\n");
1869 AcpiTerminate();
1873 static void
1874 acpi_enable_fixed_events(struct acpi_softc *sc)
1876 static int first_time = 1;
1878 /* Enable and clear fixed events and install handlers. */
1879 if ((AcpiGbl_FADT.Flags & ACPI_FADT_POWER_BUTTON) == 0) {
1880 AcpiClearEvent(ACPI_EVENT_POWER_BUTTON);
1881 AcpiInstallFixedEventHandler(ACPI_EVENT_POWER_BUTTON,
1882 acpi_event_power_button_sleep, sc);
1883 if (first_time)
1884 device_printf(sc->acpi_dev, "Power Button (fixed)\n");
1886 if ((AcpiGbl_FADT.Flags & ACPI_FADT_SLEEP_BUTTON) == 0) {
1887 AcpiClearEvent(ACPI_EVENT_SLEEP_BUTTON);
1888 AcpiInstallFixedEventHandler(ACPI_EVENT_SLEEP_BUTTON,
1889 acpi_event_sleep_button_sleep, sc);
1890 if (first_time)
1891 device_printf(sc->acpi_dev, "Sleep Button (fixed)\n");
1894 first_time = 0;
1898 * Returns true if the device is actually present and should
1899 * be attached to. This requires the present, enabled, UI-visible
1900 * and diagnostics-passed bits to be set.
1902 BOOLEAN
1903 acpi_DeviceIsPresent(device_t dev)
1905 ACPI_DEVICE_INFO *devinfo;
1906 ACPI_HANDLE h;
1907 int ret;
1909 ret = FALSE;
1910 if ((h = acpi_get_handle(dev)) == NULL ||
1911 ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo)))
1912 return (FALSE);
1914 /* If no _STA method, must be present */
1915 if ((devinfo->Valid & ACPI_VALID_STA) == 0)
1916 ret = TRUE;
1918 /* Return true for 'present' and 'functioning' */
1919 if (ACPI_DEVICE_PRESENT(devinfo->CurrentStatus))
1920 ret = TRUE;
1922 AcpiOsFree(devinfo);
1923 return (ret);
1927 * Returns true if the battery is actually present and inserted.
1929 BOOLEAN
1930 acpi_BatteryIsPresent(device_t dev)
1932 ACPI_DEVICE_INFO *devinfo;
1933 ACPI_HANDLE h;
1934 int ret;
1936 ret = FALSE;
1937 if ((h = acpi_get_handle(dev)) == NULL ||
1938 ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo)))
1939 return (FALSE);
1941 /* If no _STA method, must be present */
1942 if ((devinfo->Valid & ACPI_VALID_STA) == 0)
1943 ret = TRUE;
1945 /* Return true for 'present', 'battery present', and 'functioning' */
1946 if (ACPI_BATTERY_PRESENT(devinfo->CurrentStatus))
1947 ret = TRUE;
1949 AcpiOsFree(devinfo);
1950 return (ret);
1954 * Match a HID string against a handle
1956 BOOLEAN
1957 acpi_MatchHid(ACPI_HANDLE h, const char *hid)
1959 ACPI_DEVICE_INFO *devinfo;
1960 int ret, i;
1962 ret = FALSE;
1963 if (hid == NULL || h == NULL ||
1964 ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo)))
1965 return (ret);
1967 if ((devinfo->Valid & ACPI_VALID_HID) != 0 &&
1968 strcmp(hid, devinfo->HardwareId.String) == 0)
1969 ret = TRUE;
1970 else if ((devinfo->Valid & ACPI_VALID_CID) != 0) {
1971 for (i = 0; i < devinfo->CompatibleIdList.Count; i++) {
1972 if (strcmp(hid, devinfo->CompatibleIdList.Ids[i].String) == 0) {
1973 ret = TRUE;
1974 break;
1979 AcpiOsFree(devinfo);
1980 return (ret);
1984 * Match a UID string against a handle
1986 BOOLEAN
1987 acpi_MatchUid(ACPI_HANDLE h, const char *uid)
1989 ACPI_DEVICE_INFO *devinfo;
1990 int ret;
1992 ret = FALSE;
1993 if (uid == NULL || h == NULL ||
1994 ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo)))
1995 return (ret);
1997 if ((devinfo->Valid & ACPI_VALID_UID) != 0 &&
1998 strcmp(uid, devinfo->UniqueId.String) == 0)
1999 ret = TRUE;
2001 AcpiOsFree(devinfo);
2002 return (ret);
2006 * Return the handle of a named object within our scope, ie. that of (parent)
2007 * or one if its parents.
2009 ACPI_STATUS
2010 acpi_GetHandleInScope(ACPI_HANDLE parent, char *path, ACPI_HANDLE *result)
2012 ACPI_HANDLE r;
2013 ACPI_STATUS status;
2015 /* Walk back up the tree to the root */
2016 for (;;) {
2017 status = AcpiGetHandle(parent, path, &r);
2018 if (ACPI_SUCCESS(status)) {
2019 *result = r;
2020 return (AE_OK);
2022 /* XXX Return error here? */
2023 if (status != AE_NOT_FOUND)
2024 return (AE_OK);
2025 if (ACPI_FAILURE(AcpiGetParent(parent, &r)))
2026 return (AE_NOT_FOUND);
2027 parent = r;
2032 * Allocate a buffer with a preset data size.
2034 ACPI_BUFFER *
2035 acpi_AllocBuffer(int size)
2037 ACPI_BUFFER *buf;
2039 if ((buf = kmalloc(size + sizeof(*buf), M_ACPIDEV, M_NOWAIT)) == NULL)
2040 return (NULL);
2041 buf->Length = size;
2042 buf->Pointer = (void *)(buf + 1);
2043 return (buf);
2046 ACPI_STATUS
2047 acpi_SetInteger(ACPI_HANDLE handle, char *path, UINT32 number)
2049 ACPI_OBJECT arg1;
2050 ACPI_OBJECT_LIST args;
2052 arg1.Type = ACPI_TYPE_INTEGER;
2053 arg1.Integer.Value = number;
2054 args.Count = 1;
2055 args.Pointer = &arg1;
2057 return (AcpiEvaluateObject(handle, path, &args, NULL));
2061 * Evaluate a path that should return an integer.
2063 ACPI_STATUS
2064 acpi_GetInteger(ACPI_HANDLE handle, char *path, UINT32 *number)
2066 ACPI_STATUS status;
2067 ACPI_BUFFER buf;
2068 ACPI_OBJECT param;
2070 if (handle == NULL)
2071 handle = ACPI_ROOT_OBJECT;
2074 * Assume that what we've been pointed at is an Integer object, or
2075 * a method that will return an Integer.
2077 buf.Pointer = &param;
2078 buf.Length = sizeof(param);
2079 status = AcpiEvaluateObject(handle, path, NULL, &buf);
2080 if (ACPI_SUCCESS(status)) {
2081 if (param.Type == ACPI_TYPE_INTEGER)
2082 *number = param.Integer.Value;
2083 else
2084 status = AE_TYPE;
2088 * In some applications, a method that's expected to return an Integer
2089 * may instead return a Buffer (probably to simplify some internal
2090 * arithmetic). We'll try to fetch whatever it is, and if it's a Buffer,
2091 * convert it into an Integer as best we can.
2093 * This is a hack.
2095 if (status == AE_BUFFER_OVERFLOW) {
2096 if ((buf.Pointer = AcpiOsAllocate(buf.Length)) == NULL) {
2097 status = AE_NO_MEMORY;
2098 } else {
2099 status = AcpiEvaluateObject(handle, path, NULL, &buf);
2100 if (ACPI_SUCCESS(status))
2101 status = acpi_ConvertBufferToInteger(&buf, number);
2102 AcpiOsFree(buf.Pointer);
2105 return (status);
2108 ACPI_STATUS
2109 acpi_ConvertBufferToInteger(ACPI_BUFFER *bufp, UINT32 *number)
2111 ACPI_OBJECT *p;
2112 UINT8 *val;
2113 int i;
2115 p = (ACPI_OBJECT *)bufp->Pointer;
2116 if (p->Type == ACPI_TYPE_INTEGER) {
2117 *number = p->Integer.Value;
2118 return (AE_OK);
2120 if (p->Type != ACPI_TYPE_BUFFER)
2121 return (AE_TYPE);
2122 if (p->Buffer.Length > sizeof(int))
2123 return (AE_BAD_DATA);
2125 *number = 0;
2126 val = p->Buffer.Pointer;
2127 for (i = 0; i < p->Buffer.Length; i++)
2128 *number += val[i] << (i * 8);
2129 return (AE_OK);
2133 * Iterate over the elements of an a package object, calling the supplied
2134 * function for each element.
2136 * XXX possible enhancement might be to abort traversal on error.
2138 ACPI_STATUS
2139 acpi_ForeachPackageObject(ACPI_OBJECT *pkg,
2140 void (*func)(ACPI_OBJECT *comp, void *arg), void *arg)
2142 ACPI_OBJECT *comp;
2143 int i;
2145 if (pkg == NULL || pkg->Type != ACPI_TYPE_PACKAGE)
2146 return (AE_BAD_PARAMETER);
2148 /* Iterate over components */
2149 i = 0;
2150 comp = pkg->Package.Elements;
2151 for (; i < pkg->Package.Count; i++, comp++)
2152 func(comp, arg);
2154 return (AE_OK);
2158 * Find the (index)th resource object in a set.
2160 ACPI_STATUS
2161 acpi_FindIndexedResource(ACPI_BUFFER *buf, int index, ACPI_RESOURCE **resp)
2163 ACPI_RESOURCE *rp;
2164 int i;
2166 rp = (ACPI_RESOURCE *)buf->Pointer;
2167 i = index;
2168 while (i-- > 0) {
2169 /* Range check */
2170 if (rp > (ACPI_RESOURCE *)((uint8_t *)buf->Pointer + buf->Length))
2171 return (AE_BAD_PARAMETER);
2173 /* Check for terminator */
2174 if (rp->Type == ACPI_RESOURCE_TYPE_END_TAG || rp->Length == 0)
2175 return (AE_NOT_FOUND);
2176 rp = ACPI_NEXT_RESOURCE(rp);
2178 if (resp != NULL)
2179 *resp = rp;
2181 return (AE_OK);
2185 * Append an ACPI_RESOURCE to an ACPI_BUFFER.
2187 * Given a pointer to an ACPI_RESOURCE structure, expand the ACPI_BUFFER
2188 * provided to contain it. If the ACPI_BUFFER is empty, allocate a sensible
2189 * backing block. If the ACPI_RESOURCE is NULL, return an empty set of
2190 * resources.
2192 #define ACPI_INITIAL_RESOURCE_BUFFER_SIZE 512
2194 ACPI_STATUS
2195 acpi_AppendBufferResource(ACPI_BUFFER *buf, ACPI_RESOURCE *res)
2197 ACPI_RESOURCE *rp;
2198 void *newp;
2200 /* Initialise the buffer if necessary. */
2201 if (buf->Pointer == NULL) {
2202 buf->Length = ACPI_INITIAL_RESOURCE_BUFFER_SIZE;
2203 if ((buf->Pointer = AcpiOsAllocate(buf->Length)) == NULL)
2204 return (AE_NO_MEMORY);
2205 rp = (ACPI_RESOURCE *)buf->Pointer;
2206 rp->Type = ACPI_RESOURCE_TYPE_END_TAG;
2207 rp->Length = ACPI_RS_SIZE_MIN;
2209 if (res == NULL)
2210 return (AE_OK);
2213 * Scan the current buffer looking for the terminator.
2214 * This will either find the terminator or hit the end
2215 * of the buffer and return an error.
2217 rp = (ACPI_RESOURCE *)buf->Pointer;
2218 for (;;) {
2219 /* Range check, don't go outside the buffer */
2220 if (rp >= (ACPI_RESOURCE *)((uint8_t *)buf->Pointer + buf->Length))
2221 return (AE_BAD_PARAMETER);
2222 if (rp->Type == ACPI_RESOURCE_TYPE_END_TAG || rp->Length == 0)
2223 break;
2224 rp = ACPI_NEXT_RESOURCE(rp);
2228 * Check the size of the buffer and expand if required.
2230 * Required size is:
2231 * size of existing resources before terminator +
2232 * size of new resource and header +
2233 * size of terminator.
2235 * Note that this loop should really only run once, unless
2236 * for some reason we are stuffing a *really* huge resource.
2238 while ((((uint8_t *)rp - (uint8_t *)buf->Pointer) +
2239 res->Length + ACPI_RS_SIZE_NO_DATA +
2240 ACPI_RS_SIZE_MIN) >= buf->Length) {
2241 if ((newp = AcpiOsAllocate(buf->Length * 2)) == NULL)
2242 return (AE_NO_MEMORY);
2243 bcopy(buf->Pointer, newp, buf->Length);
2244 rp = (ACPI_RESOURCE *)((uint8_t *)newp +
2245 ((uint8_t *)rp - (uint8_t *)buf->Pointer));
2246 AcpiOsFree(buf->Pointer);
2247 buf->Pointer = newp;
2248 buf->Length += buf->Length;
2251 /* Insert the new resource. */
2252 bcopy(res, rp, res->Length + ACPI_RS_SIZE_NO_DATA);
2254 /* And add the terminator. */
2255 rp = ACPI_NEXT_RESOURCE(rp);
2256 rp->Type = ACPI_RESOURCE_TYPE_END_TAG;
2257 rp->Length = ACPI_RS_SIZE_MIN;
2259 return (AE_OK);
2263 * Set interrupt model.
2265 ACPI_STATUS
2266 acpi_SetIntrModel(int model)
2269 return (acpi_SetInteger(ACPI_ROOT_OBJECT, "_PIC", model));
2273 * DEPRECATED. This interface has serious deficiencies and will be
2274 * removed.
2276 * Immediately enter the sleep state. In the old model, acpiconf(8) ran
2277 * rc.suspend and rc.resume so we don't have to notify devd(8) to do this.
2279 ACPI_STATUS
2280 acpi_SetSleepState(struct acpi_softc *sc, int state)
2282 static int once;
2284 if (!once) {
2285 device_printf(sc->acpi_dev,
2286 "warning: acpi_SetSleepState() deprecated, need to update your software\n");
2287 once = 1;
2289 return (acpi_EnterSleepState(sc, state));
2292 static void
2293 acpi_sleep_force(void *arg)
2295 struct acpi_softc *sc;
2297 sc = arg;
2298 device_printf(sc->acpi_dev,
2299 "suspend request timed out, forcing sleep now\n");
2300 if (ACPI_FAILURE(acpi_EnterSleepState(sc, sc->acpi_next_sstate)))
2301 device_printf(sc->acpi_dev, "force sleep state S%d failed\n",
2302 sc->acpi_next_sstate);
2306 * Request that the system enter the given suspend state. All /dev/apm
2307 * devices and devd(8) will be notified. Userland then has a chance to
2308 * save state and acknowledge the request. The system sleeps once all
2309 * acks are in.
2312 acpi_ReqSleepState(struct acpi_softc *sc, int state)
2314 #ifdef notyet
2315 struct apm_clone_data *clone;
2316 #endif
2318 if (state < ACPI_STATE_S1 || state > ACPI_STATE_S5)
2319 return (EINVAL);
2321 /* S5 (soft-off) should be entered directly with no waiting. */
2322 if (state == ACPI_STATE_S5) {
2323 if (ACPI_SUCCESS(acpi_EnterSleepState(sc, state)))
2324 return (0);
2325 else
2326 return (ENXIO);
2329 /* This platform does not support acpi suspend/resume. */
2330 return (EOPNOTSUPP);
2332 /* If a suspend request is already in progress, just return. */
2333 ACPI_LOCK(acpi);
2334 if (sc->acpi_next_sstate != 0) {
2335 ACPI_UNLOCK(acpi);
2336 return (0);
2339 /* Record the pending state and notify all apm devices. */
2340 sc->acpi_next_sstate = state;
2341 #if 0
2342 STAILQ_FOREACH(clone, &sc->apm_cdevs, entries) {
2343 clone->notify_status = APM_EV_NONE;
2344 if ((clone->flags & ACPI_EVF_DEVD) == 0) {
2345 KNOTE(&clone->sel_read.si_note, 0);
2348 #endif
2350 /* If devd(8) is not running, immediately enter the sleep state. */
2351 if (devctl_process_running() == FALSE) {
2352 ACPI_UNLOCK(acpi);
2353 if (ACPI_SUCCESS(acpi_EnterSleepState(sc, sc->acpi_next_sstate))) {
2354 return (0);
2355 } else {
2356 return (ENXIO);
2360 /* Now notify devd(8) also. */
2361 acpi_UserNotify("Suspend", ACPI_ROOT_OBJECT, state);
2364 * Set a timeout to fire if userland doesn't ack the suspend request
2365 * in time. This way we still eventually go to sleep if we were
2366 * overheating or running low on battery, even if userland is hung.
2367 * We cancel this timeout once all userland acks are in or the
2368 * suspend request is aborted.
2370 callout_reset(&sc->susp_force_to, 10 * hz, acpi_sleep_force, sc);
2371 ACPI_UNLOCK(acpi);
2373 return (0);
2377 * Acknowledge (or reject) a pending sleep state. The caller has
2378 * prepared for suspend and is now ready for it to proceed. If the
2379 * error argument is non-zero, it indicates suspend should be cancelled
2380 * and gives an errno value describing why. Once all votes are in,
2381 * we suspend the system.
2384 acpi_AckSleepState(struct apm_clone_data *clone, int error)
2386 struct acpi_softc *sc;
2387 int ret, sleeping;
2389 /* This platform does not support acpi suspend/resume. */
2390 return (EOPNOTSUPP);
2392 /* If no pending sleep state, return an error. */
2393 ACPI_LOCK(acpi);
2394 sc = clone->acpi_sc;
2395 if (sc->acpi_next_sstate == 0) {
2396 ACPI_UNLOCK(acpi);
2397 return (ENXIO);
2400 /* Caller wants to abort suspend process. */
2401 if (error) {
2402 sc->acpi_next_sstate = 0;
2403 callout_stop(&sc->susp_force_to);
2404 device_printf(sc->acpi_dev,
2405 "listener on %s cancelled the pending suspend\n",
2406 devtoname(clone->cdev));
2407 ACPI_UNLOCK(acpi);
2408 return (0);
2412 * Mark this device as acking the suspend request. Then, walk through
2413 * all devices, seeing if they agree yet. We only count devices that
2414 * are writable since read-only devices couldn't ack the request.
2416 clone->notify_status = APM_EV_ACKED;
2417 sleeping = TRUE;
2418 STAILQ_FOREACH(clone, &sc->apm_cdevs, entries) {
2419 if ((clone->flags & ACPI_EVF_WRITE) != 0 &&
2420 clone->notify_status != APM_EV_ACKED) {
2421 sleeping = FALSE;
2422 break;
2426 /* If all devices have voted "yes", we will suspend now. */
2427 if (sleeping)
2428 callout_stop(&sc->susp_force_to);
2429 ACPI_UNLOCK(acpi);
2430 ret = 0;
2431 if (sleeping) {
2432 if (ACPI_FAILURE(acpi_EnterSleepState(sc, sc->acpi_next_sstate)))
2433 ret = ENODEV;
2436 return (ret);
2439 static void
2440 acpi_sleep_enable(void *arg)
2442 ((struct acpi_softc *)arg)->acpi_sleep_disabled = 0;
2445 enum acpi_sleep_state {
2446 ACPI_SS_NONE,
2447 ACPI_SS_GPE_SET,
2448 ACPI_SS_DEV_SUSPEND,
2449 ACPI_SS_SLP_PREP,
2450 ACPI_SS_SLEPT,
2454 * Enter the desired system sleep state.
2456 * Currently we support S1-S5 but S4 is only S4BIOS
2458 static ACPI_STATUS
2459 acpi_EnterSleepState(struct acpi_softc *sc, int state)
2461 ACPI_STATUS status;
2462 UINT8 TypeA;
2463 UINT8 TypeB;
2464 enum acpi_sleep_state slp_state;
2466 ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, state);
2468 /* Re-entry once we're suspending is not allowed. */
2469 status = AE_OK;
2470 ACPI_LOCK(acpi);
2471 if (sc->acpi_sleep_disabled) {
2472 ACPI_UNLOCK(acpi);
2473 device_printf(sc->acpi_dev,
2474 "suspend request ignored (not ready yet)\n");
2475 return (AE_ERROR);
2477 sc->acpi_sleep_disabled = 1;
2478 ACPI_UNLOCK(acpi);
2481 * Be sure to hold Giant across DEVICE_SUSPEND/RESUME since non-MPSAFE
2482 * drivers need this.
2484 //get_mplock();
2486 slp_state = ACPI_SS_NONE;
2487 switch (state) {
2488 case ACPI_STATE_S1:
2489 case ACPI_STATE_S2:
2490 case ACPI_STATE_S3:
2491 case ACPI_STATE_S4:
2492 status = AcpiGetSleepTypeData(state, &TypeA, &TypeB);
2493 if (status == AE_NOT_FOUND) {
2494 device_printf(sc->acpi_dev,
2495 "Sleep state S%d not supported by BIOS\n", state);
2496 break;
2497 } else if (ACPI_FAILURE(status)) {
2498 device_printf(sc->acpi_dev, "AcpiGetSleepTypeData failed - %s\n",
2499 AcpiFormatException(status));
2500 break;
2503 sc->acpi_sstate = state;
2505 /* Enable any GPEs as appropriate and requested by the user. */
2506 acpi_wake_prep_walk(state);
2507 slp_state = ACPI_SS_GPE_SET;
2510 * Inform all devices that we are going to sleep. If at least one
2511 * device fails, DEVICE_SUSPEND() automatically resumes the tree.
2513 * XXX Note that a better two-pass approach with a 'veto' pass
2514 * followed by a "real thing" pass would be better, but the current
2515 * bus interface does not provide for this.
2517 if (DEVICE_SUSPEND(root_bus) != 0) {
2518 device_printf(sc->acpi_dev, "device_suspend failed\n");
2519 break;
2521 slp_state = ACPI_SS_DEV_SUSPEND;
2523 /* If testing device suspend only, back out of everything here. */
2524 if (acpi_susp_bounce)
2525 break;
2527 status = AcpiEnterSleepStatePrep(state);
2528 if (ACPI_FAILURE(status)) {
2529 device_printf(sc->acpi_dev, "AcpiEnterSleepStatePrep failed - %s\n",
2530 AcpiFormatException(status));
2531 break;
2533 slp_state = ACPI_SS_SLP_PREP;
2535 if (sc->acpi_sleep_delay > 0)
2536 DELAY(sc->acpi_sleep_delay * 1000000);
2538 if (state != ACPI_STATE_S1) {
2539 acpi_sleep_machdep(sc, state);
2541 /* Re-enable ACPI hardware on wakeup from sleep state 4. */
2542 if (state == ACPI_STATE_S4)
2543 AcpiEnable();
2544 } else {
2545 ACPI_DISABLE_IRQS();
2546 status = AcpiEnterSleepState(state);
2547 if (ACPI_FAILURE(status)) {
2548 device_printf(sc->acpi_dev, "AcpiEnterSleepState failed - %s\n",
2549 AcpiFormatException(status));
2550 break;
2553 slp_state = ACPI_SS_SLEPT;
2554 break;
2555 case ACPI_STATE_S5:
2557 * Shut down cleanly and power off. This will call us back through the
2558 * shutdown handlers.
2560 shutdown_nice(RB_POWEROFF);
2561 break;
2562 case ACPI_STATE_S0:
2563 default:
2564 status = AE_BAD_PARAMETER;
2565 break;
2569 * Back out state according to how far along we got in the suspend
2570 * process. This handles both the error and success cases.
2572 sc->acpi_next_sstate = 0;
2573 if (slp_state >= ACPI_SS_GPE_SET) {
2574 acpi_wake_prep_walk(state);
2575 sc->acpi_sstate = ACPI_STATE_S0;
2577 if (slp_state >= ACPI_SS_SLP_PREP)
2578 AcpiLeaveSleepState(state);
2579 if (slp_state >= ACPI_SS_DEV_SUSPEND)
2580 DEVICE_RESUME(root_bus);
2581 if (slp_state >= ACPI_SS_SLEPT)
2582 acpi_enable_fixed_events(sc);
2584 /* Allow another sleep request after a while. */
2585 /* XXX: needs timeout */
2586 if (state != ACPI_STATE_S5)
2587 acpi_sleep_enable(sc);
2589 /* Run /etc/rc.resume after we are back. */
2590 acpi_UserNotify("Resume", ACPI_ROOT_OBJECT, state);
2592 //rel_mplock();
2594 return_ACPI_STATUS (status);
2597 /* Enable or disable the device's GPE. */
2599 acpi_wake_set_enable(device_t dev, int enable)
2601 struct acpi_prw_data prw;
2602 ACPI_STATUS status;
2603 int flags;
2605 /* Make sure the device supports waking the system and get the GPE. */
2606 if (acpi_parse_prw(acpi_get_handle(dev), &prw) != 0)
2607 return (ENXIO);
2609 flags = acpi_get_flags(dev);
2610 if (enable) {
2611 status = AcpiSetGpeWakeMask(prw.gpe_handle, prw.gpe_bit,
2612 ACPI_GPE_ENABLE);
2613 if (ACPI_FAILURE(status)) {
2614 device_printf(dev, "enable wake failed\n");
2615 return (ENXIO);
2617 acpi_set_flags(dev, flags | ACPI_FLAG_WAKE_ENABLED);
2618 } else {
2619 status = AcpiSetGpeWakeMask(prw.gpe_handle, prw.gpe_bit,
2620 ACPI_GPE_DISABLE);
2621 if (ACPI_FAILURE(status)) {
2622 device_printf(dev, "disable wake failed\n");
2623 return (ENXIO);
2625 acpi_set_flags(dev, flags & ~ACPI_FLAG_WAKE_ENABLED);
2628 return (0);
2631 static int
2632 acpi_wake_sleep_prep(ACPI_HANDLE handle, int sstate)
2634 struct acpi_prw_data prw;
2635 device_t dev;
2637 /* Check that this is a wake-capable device and get its GPE. */
2638 if (acpi_parse_prw(handle, &prw) != 0)
2639 return (ENXIO);
2640 dev = acpi_get_device(handle);
2643 * The destination sleep state must be less than (i.e., higher power)
2644 * or equal to the value specified by _PRW. If this GPE cannot be
2645 * enabled for the next sleep state, then disable it. If it can and
2646 * the user requested it be enabled, turn on any required power resources
2647 * and set _PSW.
2649 if (sstate > prw.lowest_wake) {
2650 AcpiSetGpeWakeMask(prw.gpe_handle, prw.gpe_bit, ACPI_GPE_DISABLE);
2651 if (bootverbose)
2652 device_printf(dev, "wake_prep disabled wake for %s (S%d)\n",
2653 acpi_name(handle), sstate);
2654 } else if (dev && (acpi_get_flags(dev) & ACPI_FLAG_WAKE_ENABLED) != 0) {
2655 acpi_pwr_wake_enable(handle, 1);
2656 acpi_SetInteger(handle, "_PSW", 1);
2657 if (bootverbose)
2658 device_printf(dev, "wake_prep enabled for %s (S%d)\n",
2659 acpi_name(handle), sstate);
2662 return (0);
2665 static int
2666 acpi_wake_run_prep(ACPI_HANDLE handle, int sstate)
2668 struct acpi_prw_data prw;
2669 device_t dev;
2672 * Check that this is a wake-capable device and get its GPE. Return
2673 * now if the user didn't enable this device for wake.
2675 if (acpi_parse_prw(handle, &prw) != 0)
2676 return (ENXIO);
2677 dev = acpi_get_device(handle);
2678 if (dev == NULL || (acpi_get_flags(dev) & ACPI_FLAG_WAKE_ENABLED) == 0)
2679 return (0);
2682 * If this GPE couldn't be enabled for the previous sleep state, it was
2683 * disabled before going to sleep so re-enable it. If it was enabled,
2684 * clear _PSW and turn off any power resources it used.
2686 if (sstate > prw.lowest_wake) {
2687 AcpiSetGpeWakeMask(prw.gpe_handle, prw.gpe_bit, ACPI_GPE_ENABLE);
2688 if (bootverbose)
2689 device_printf(dev, "run_prep re-enabled %s\n", acpi_name(handle));
2690 } else {
2691 acpi_SetInteger(handle, "_PSW", 0);
2692 acpi_pwr_wake_enable(handle, 0);
2693 if (bootverbose)
2694 device_printf(dev, "run_prep cleaned up for %s\n",
2695 acpi_name(handle));
2698 return (0);
2701 static ACPI_STATUS
2702 acpi_wake_prep(ACPI_HANDLE handle, UINT32 level, void *context, void **status)
2704 int sstate;
2706 /* If suspending, run the sleep prep function, otherwise wake. */
2707 sstate = *(int *)context;
2708 if (AcpiGbl_SystemAwakeAndRunning)
2709 acpi_wake_sleep_prep(handle, sstate);
2710 else
2711 acpi_wake_run_prep(handle, sstate);
2712 return (AE_OK);
2715 /* Walk the tree rooted at acpi0 to prep devices for suspend/resume. */
2716 static int
2717 acpi_wake_prep_walk(int sstate)
2719 ACPI_HANDLE sb_handle;
2721 if (ACPI_SUCCESS(AcpiGetHandle(ACPI_ROOT_OBJECT, "\\_SB_", &sb_handle))) {
2722 AcpiWalkNamespace(ACPI_TYPE_DEVICE, sb_handle, 100,
2723 acpi_wake_prep, NULL, &sstate, NULL);
2725 return (0);
2728 /* Walk the tree rooted at acpi0 to attach per-device wake sysctls. */
2729 static int
2730 acpi_wake_sysctl_walk(device_t dev)
2732 #ifdef notyet
2733 int error, i, numdevs;
2734 device_t *devlist;
2735 device_t child;
2736 ACPI_STATUS status;
2738 error = device_get_children(dev, &devlist, &numdevs);
2739 if (error != 0 || numdevs == 0) {
2740 if (numdevs == 0)
2741 kfree(devlist, M_TEMP);
2742 return (error);
2744 for (i = 0; i < numdevs; i++) {
2745 child = devlist[i];
2746 acpi_wake_sysctl_walk(child);
2747 if (!device_is_attached(child))
2748 continue;
2749 status = AcpiEvaluateObject(acpi_get_handle(child), "_PRW", NULL, NULL);
2750 if (ACPI_SUCCESS(status)) {
2751 SYSCTL_ADD_PROC(device_get_sysctl_ctx(child),
2752 SYSCTL_CHILDREN(device_get_sysctl_tree(child)), OID_AUTO,
2753 "wake", CTLTYPE_INT | CTLFLAG_RW, child, 0,
2754 acpi_wake_set_sysctl, "I", "Device set to wake the system");
2757 kfree(devlist, M_TEMP);
2758 #endif
2760 return (0);
2763 #ifdef notyet
2764 /* Enable or disable wake from userland. */
2765 static int
2766 acpi_wake_set_sysctl(SYSCTL_HANDLER_ARGS)
2768 int enable, error;
2769 device_t dev;
2771 dev = (device_t)arg1;
2772 enable = (acpi_get_flags(dev) & ACPI_FLAG_WAKE_ENABLED) ? 1 : 0;
2774 error = sysctl_handle_int(oidp, &enable, 0, req);
2775 if (error != 0 || req->newptr == NULL)
2776 return (error);
2777 if (enable != 0 && enable != 1)
2778 return (EINVAL);
2780 return (acpi_wake_set_enable(dev, enable));
2782 #endif
2784 /* Parse a device's _PRW into a structure. */
2786 acpi_parse_prw(ACPI_HANDLE h, struct acpi_prw_data *prw)
2788 ACPI_STATUS status;
2789 ACPI_BUFFER prw_buffer;
2790 ACPI_OBJECT *res, *res2;
2791 int error, i, power_count;
2793 if (h == NULL || prw == NULL)
2794 return (EINVAL);
2797 * The _PRW object (7.2.9) is only required for devices that have the
2798 * ability to wake the system from a sleeping state.
2800 error = EINVAL;
2801 prw_buffer.Pointer = NULL;
2802 prw_buffer.Length = ACPI_ALLOCATE_BUFFER;
2803 status = AcpiEvaluateObject(h, "_PRW", NULL, &prw_buffer);
2804 if (ACPI_FAILURE(status))
2805 return (ENOENT);
2806 res = (ACPI_OBJECT *)prw_buffer.Pointer;
2807 if (res == NULL)
2808 return (ENOENT);
2809 if (!ACPI_PKG_VALID(res, 2))
2810 goto out;
2813 * Element 1 of the _PRW object:
2814 * The lowest power system sleeping state that can be entered while still
2815 * providing wake functionality. The sleeping state being entered must
2816 * be less than (i.e., higher power) or equal to this value.
2818 if (acpi_PkgInt32(res, 1, &prw->lowest_wake) != 0)
2819 goto out;
2822 * Element 0 of the _PRW object:
2824 switch (res->Package.Elements[0].Type) {
2825 case ACPI_TYPE_INTEGER:
2827 * If the data type of this package element is numeric, then this
2828 * _PRW package element is the bit index in the GPEx_EN, in the
2829 * GPE blocks described in the FADT, of the enable bit that is
2830 * enabled for the wake event.
2832 prw->gpe_handle = NULL;
2833 prw->gpe_bit = res->Package.Elements[0].Integer.Value;
2834 error = 0;
2835 break;
2836 case ACPI_TYPE_PACKAGE:
2838 * If the data type of this package element is a package, then this
2839 * _PRW package element is itself a package containing two
2840 * elements. The first is an object reference to the GPE Block
2841 * device that contains the GPE that will be triggered by the wake
2842 * event. The second element is numeric and it contains the bit
2843 * index in the GPEx_EN, in the GPE Block referenced by the
2844 * first element in the package, of the enable bit that is enabled for
2845 * the wake event.
2847 * For example, if this field is a package then it is of the form:
2848 * Package() {\_SB.PCI0.ISA.GPE, 2}
2850 res2 = &res->Package.Elements[0];
2851 if (!ACPI_PKG_VALID(res2, 2))
2852 goto out;
2853 prw->gpe_handle = acpi_GetReference(NULL, &res2->Package.Elements[0]);
2854 if (prw->gpe_handle == NULL)
2855 goto out;
2856 if (acpi_PkgInt32(res2, 1, &prw->gpe_bit) != 0)
2857 goto out;
2858 error = 0;
2859 break;
2860 default:
2861 goto out;
2864 /* Elements 2 to N of the _PRW object are power resources. */
2865 power_count = res->Package.Count - 2;
2866 if (power_count > ACPI_PRW_MAX_POWERRES) {
2867 kprintf("ACPI device %s has too many power resources\n", acpi_name(h));
2868 power_count = 0;
2870 prw->power_res_count = power_count;
2871 for (i = 0; i < power_count; i++)
2872 prw->power_res[i] = res->Package.Elements[i];
2874 out:
2875 if (prw_buffer.Pointer != NULL)
2876 AcpiOsFree(prw_buffer.Pointer);
2877 return (error);
2881 * ACPI Event Handlers
2884 /* System Event Handlers (registered by EVENTHANDLER_REGISTER) */
2886 static void
2887 acpi_system_eventhandler_sleep(void *arg, int state)
2889 struct acpi_softc *sc;
2890 int ret;
2892 ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, state);
2894 sc = arg;
2896 /* Check if button action is disabled. */
2897 if (state == ACPI_S_STATES_MAX + 1)
2898 return;
2900 /* Request that the system prepare to enter the given suspend state. */
2901 ret = acpi_ReqSleepState((struct acpi_softc *)arg, state);
2902 if (ret != 0)
2903 device_printf(sc->acpi_dev,
2904 "request to enter state S%d failed (err %d)\n", state, ret);
2906 return_VOID;
2909 static void
2910 acpi_system_eventhandler_wakeup(void *arg, int state)
2913 ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, state);
2915 /* Currently, nothing to do for wakeup. */
2917 return_VOID;
2921 * ACPICA Event Handlers (FixedEvent, also called from button notify handler)
2923 UINT32
2924 acpi_event_power_button_sleep(void *context)
2926 struct acpi_softc *sc = (struct acpi_softc *)context;
2928 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
2930 EVENTHANDLER_INVOKE(acpi_sleep_event, sc->acpi_power_button_sx);
2932 return_VALUE (ACPI_INTERRUPT_HANDLED);
2935 UINT32
2936 acpi_event_power_button_wake(void *context)
2938 struct acpi_softc *sc = (struct acpi_softc *)context;
2940 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
2942 EVENTHANDLER_INVOKE(acpi_wakeup_event, sc->acpi_power_button_sx);
2944 return_VALUE (ACPI_INTERRUPT_HANDLED);
2947 UINT32
2948 acpi_event_sleep_button_sleep(void *context)
2950 struct acpi_softc *sc = (struct acpi_softc *)context;
2952 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
2954 EVENTHANDLER_INVOKE(acpi_sleep_event, sc->acpi_sleep_button_sx);
2956 return_VALUE (ACPI_INTERRUPT_HANDLED);
2959 UINT32
2960 acpi_event_sleep_button_wake(void *context)
2962 struct acpi_softc *sc = (struct acpi_softc *)context;
2964 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
2966 EVENTHANDLER_INVOKE(acpi_wakeup_event, sc->acpi_sleep_button_sx);
2968 return_VALUE (ACPI_INTERRUPT_HANDLED);
2972 * XXX This static buffer is suboptimal. There is no locking so only
2973 * use this for single-threaded callers.
2975 char *
2976 acpi_name(ACPI_HANDLE handle)
2978 ACPI_BUFFER buf;
2979 static char data[256];
2981 buf.Length = sizeof(data);
2982 buf.Pointer = data;
2984 if (handle && ACPI_SUCCESS(AcpiGetName(handle, ACPI_FULL_PATHNAME, &buf)))
2985 return (data);
2986 return ("(unknown)");
2990 * Debugging/bug-avoidance. Avoid trying to fetch info on various
2991 * parts of the namespace.
2994 acpi_avoid(ACPI_HANDLE handle)
2996 char *cp, *env, *np;
2997 int len;
2999 np = acpi_name(handle);
3000 if (*np == '\\')
3001 np++;
3002 if ((env = kgetenv("debug.acpi.avoid")) == NULL)
3003 return (0);
3005 /* Scan the avoid list checking for a match */
3006 cp = env;
3007 for (;;) {
3008 while (*cp != 0 && isspace(*cp))
3009 cp++;
3010 if (*cp == 0)
3011 break;
3012 len = 0;
3013 while (cp[len] != 0 && !isspace(cp[len]))
3014 len++;
3015 if (!strncmp(cp, np, len)) {
3016 kfreeenv(env);
3017 return(1);
3019 cp += len;
3021 kfreeenv(env);
3023 return (0);
3027 * Debugging/bug-avoidance. Disable ACPI subsystem components.
3030 acpi_disabled(char *subsys)
3032 char *cp, *env;
3033 int len;
3035 if ((env = kgetenv("debug.acpi.disabled")) == NULL)
3036 return (0);
3037 if (strcmp(env, "all") == 0) {
3038 kfreeenv(env);
3039 return (1);
3042 /* Scan the disable list, checking for a match. */
3043 cp = env;
3044 for (;;) {
3045 while (*cp != '\0' && isspace(*cp))
3046 cp++;
3047 if (*cp == '\0')
3048 break;
3049 len = 0;
3050 while (cp[len] != '\0' && !isspace(cp[len]))
3051 len++;
3052 if (strncmp(cp, subsys, len) == 0) {
3053 kfreeenv(env);
3054 return (1);
3056 cp += len;
3058 kfreeenv(env);
3060 return (0);
3064 * Debugging/bug-avoidance. Enable ACPI subsystem components. Most
3065 * components are enabled by default. The ones that are not have to be
3066 * enabled via debug.acpi.enabled.
3069 acpi_enabled(char *subsys)
3071 char *cp, *env;
3072 int len;
3074 if ((env = kgetenv("debug.acpi.enabled")) == NULL)
3075 return (0);
3076 if (strcmp(env, "all") == 0) {
3077 kfreeenv(env);
3078 return (1);
3081 /* Scan the enable list, checking for a match. */
3082 cp = env;
3083 for (;;) {
3084 while (*cp != '\0' && isspace(*cp))
3085 cp++;
3086 if (*cp == '\0')
3087 break;
3088 len = 0;
3089 while (cp[len] != '\0' && !isspace(cp[len]))
3090 len++;
3091 if (strncmp(cp, subsys, len) == 0) {
3092 kfreeenv(env);
3093 return (1);
3095 cp += len;
3097 kfreeenv(env);
3099 return (0);
3103 * Control interface.
3105 * We multiplex ioctls for all participating ACPI devices here. Individual
3106 * drivers wanting to be accessible via /dev/acpi should use the
3107 * register/deregister interface to make their handlers visible.
3109 struct acpi_ioctl_hook
3111 TAILQ_ENTRY(acpi_ioctl_hook) link;
3112 u_long cmd;
3113 acpi_ioctl_fn fn;
3114 void *arg;
3117 static TAILQ_HEAD(,acpi_ioctl_hook) acpi_ioctl_hooks;
3118 static int acpi_ioctl_hooks_initted;
3121 acpi_register_ioctl(u_long cmd, acpi_ioctl_fn fn, void *arg)
3123 struct acpi_ioctl_hook *hp;
3125 if ((hp = kmalloc(sizeof(*hp), M_ACPIDEV, M_NOWAIT)) == NULL)
3126 return (ENOMEM);
3127 hp->cmd = cmd;
3128 hp->fn = fn;
3129 hp->arg = arg;
3131 ACPI_LOCK(acpi);
3132 if (acpi_ioctl_hooks_initted == 0) {
3133 TAILQ_INIT(&acpi_ioctl_hooks);
3134 acpi_ioctl_hooks_initted = 1;
3136 TAILQ_INSERT_TAIL(&acpi_ioctl_hooks, hp, link);
3137 ACPI_UNLOCK(acpi);
3139 return (0);
3142 void
3143 acpi_deregister_ioctl(u_long cmd, acpi_ioctl_fn fn)
3145 struct acpi_ioctl_hook *hp;
3147 ACPI_LOCK(acpi);
3148 TAILQ_FOREACH(hp, &acpi_ioctl_hooks, link)
3149 if (hp->cmd == cmd && hp->fn == fn)
3150 break;
3152 if (hp != NULL) {
3153 TAILQ_REMOVE(&acpi_ioctl_hooks, hp, link);
3154 kfree(hp, M_ACPIDEV);
3156 ACPI_UNLOCK(acpi);
3159 static int
3160 acpiopen(struct dev_open_args *ap)
3162 return (0);
3165 static int
3166 acpiclose(struct dev_close_args *ap)
3168 return (0);
3171 static int
3172 acpiioctl(struct dev_ioctl_args *ap)
3174 struct acpi_softc *sc;
3175 struct acpi_ioctl_hook *hp;
3176 int error, state;
3178 error = 0;
3179 hp = NULL;
3180 sc = ap->a_head.a_dev->si_drv1;
3183 * Scan the list of registered ioctls, looking for handlers.
3185 lwkt_gettoken(&acpi_token);
3186 ACPI_LOCK(acpi);
3187 if (acpi_ioctl_hooks_initted) {
3188 TAILQ_FOREACH(hp, &acpi_ioctl_hooks, link) {
3189 if (hp->cmd == ap->a_cmd)
3190 break;
3193 ACPI_UNLOCK(acpi);
3194 if (hp) {
3195 error = hp->fn(ap->a_cmd, ap->a_data, hp->arg);
3196 lwkt_reltoken(&acpi_token);
3197 return error;
3201 * Core ioctls are not permitted for non-writable user.
3202 * Currently, other ioctls just fetch information.
3203 * Not changing system behavior.
3205 if ((ap->a_fflag & FWRITE) == 0) {
3206 lwkt_reltoken(&acpi_token);
3207 return (EPERM);
3210 /* Core system ioctls. */
3211 switch (ap->a_cmd) {
3212 case ACPIIO_REQSLPSTATE:
3213 state = *(int *)ap->a_data;
3214 if (state != ACPI_STATE_S5)
3215 error = acpi_ReqSleepState(sc, state);
3216 else {
3217 device_printf(sc->acpi_dev,
3218 "power off via acpi ioctl not supported\n");
3219 error = ENXIO;
3221 break;
3222 case ACPIIO_ACKSLPSTATE:
3223 error = EOPNOTSUPP;
3224 #if 0 /* notyet */
3225 error = *(int *)ap->a_data;
3226 error = acpi_AckSleepState(sc->acpi_clone, error);
3227 #endif
3228 break;
3229 case ACPIIO_SETSLPSTATE: /* DEPRECATED */
3230 error = EINVAL;
3231 state = *(int *)ap->a_data;
3232 if (state >= ACPI_STATE_S0 && state <= ACPI_S_STATES_MAX)
3233 if (ACPI_SUCCESS(acpi_SetSleepState(sc, state)))
3234 error = 0;
3235 break;
3236 case ACPIIO_DO_MCALL:
3237 if (acpi_allow_mcall == 1) {
3238 struct acpi_mcall_ioctl_arg *params;
3239 ACPI_BUFFER result = { ACPI_ALLOCATE_BUFFER, NULL };
3240 ACPI_OBJECT *resobj;
3242 error = EINVAL;
3243 params = (struct acpi_mcall_ioctl_arg *)ap->a_data;
3244 params->retval = AcpiEvaluateObject(NULL, params->path,
3245 &params->args, &result);
3246 if (ACPI_SUCCESS(params->retval) && result.Pointer != NULL &&
3247 params->result.Pointer != NULL) {
3248 params->result.Length = min(params->result.Length,
3249 result.Length);
3250 copyout(result.Pointer, params->result.Pointer,
3251 params->result.Length);
3252 params->reslen = result.Length;
3253 if (result.Length >= sizeof(ACPI_OBJECT)) {
3254 resobj = (ACPI_OBJECT *)params->result.Pointer;
3255 switch (resobj->Type) {
3256 case ACPI_TYPE_STRING:
3257 resobj->String.Pointer = (char *)
3258 ((UINT8 *)(resobj->String.Pointer) -
3259 (UINT8 *)result.Pointer +
3260 (UINT8 *)resobj);
3261 break;
3262 case ACPI_TYPE_BUFFER:
3263 resobj->Buffer.Pointer -= (UINT8 *)result.Pointer -
3264 (UINT8 *)resobj;
3265 break;
3268 error = 0;
3270 if (result.Pointer != NULL)
3271 AcpiOsFree(result.Pointer);
3272 } else {
3273 device_printf(sc->acpi_dev,
3274 "debug.acpi.allow_method_calls must be set\n");
3275 error = ENXIO;
3277 break;
3278 default:
3279 error = ENXIO;
3280 break;
3282 lwkt_reltoken(&acpi_token);
3284 return (error);
3287 static int
3288 acpi_supported_sleep_state_sysctl(SYSCTL_HANDLER_ARGS)
3290 int error;
3291 struct sbuf sb;
3292 UINT8 state, TypeA, TypeB;
3294 sbuf_new(&sb, NULL, 32, SBUF_AUTOEXTEND);
3295 for (state = ACPI_STATE_S1; state < ACPI_S_STATES_MAX + 1; state++)
3296 if (ACPI_SUCCESS(AcpiGetSleepTypeData(state, &TypeA, &TypeB)))
3297 sbuf_printf(&sb, "S%d ", state);
3298 sbuf_trim(&sb);
3299 sbuf_finish(&sb);
3300 error = sysctl_handle_string(oidp, sbuf_data(&sb), sbuf_len(&sb), req);
3301 sbuf_delete(&sb);
3302 return (error);
3305 static int
3306 acpi_sleep_state_sysctl(SYSCTL_HANDLER_ARGS)
3308 char sleep_state[10];
3309 int error;
3310 u_int new_state, old_state;
3312 old_state = *(u_int *)oidp->oid_arg1;
3313 if (old_state > ACPI_S_STATES_MAX + 1)
3314 strlcpy(sleep_state, "unknown", sizeof(sleep_state));
3315 else
3316 strlcpy(sleep_state, sleep_state_names[old_state], sizeof(sleep_state));
3317 error = sysctl_handle_string(oidp, sleep_state, sizeof(sleep_state), req);
3318 if (error == 0 && req->newptr != NULL) {
3319 new_state = ACPI_STATE_S0;
3320 for (; new_state <= ACPI_S_STATES_MAX + 1; new_state++)
3321 if (strcmp(sleep_state, sleep_state_names[new_state]) == 0)
3322 break;
3323 if (new_state <= ACPI_S_STATES_MAX + 1) {
3324 if (new_state != old_state)
3325 *(u_int *)oidp->oid_arg1 = new_state;
3326 } else
3327 error = EINVAL;
3330 return (error);
3333 /* Inform devctl(4) when we receive a Notify. */
3334 void
3335 acpi_UserNotify(const char *subsystem, ACPI_HANDLE h, uint8_t notify)
3337 char notify_buf[16];
3338 ACPI_BUFFER handle_buf;
3339 ACPI_STATUS status;
3341 if (subsystem == NULL)
3342 return;
3344 handle_buf.Pointer = NULL;
3345 handle_buf.Length = ACPI_ALLOCATE_BUFFER;
3346 status = AcpiNsHandleToPathname(h, &handle_buf, FALSE);
3347 if (ACPI_FAILURE(status))
3348 return;
3349 ksnprintf(notify_buf, sizeof(notify_buf), "notify=0x%02x", notify);
3350 devctl_notify("ACPI", subsystem, handle_buf.Pointer, notify_buf);
3351 AcpiOsFree(handle_buf.Pointer);
3354 #ifdef ACPI_DEBUG
3356 * Support for parsing debug options from the kernel environment.
3358 * Bits may be set in the AcpiDbgLayer and AcpiDbgLevel debug registers
3359 * by specifying the names of the bits in the debug.acpi.layer and
3360 * debug.acpi.level environment variables. Bits may be unset by
3361 * prefixing the bit name with !.
3363 struct debugtag
3365 char *name;
3366 UINT32 value;
3369 static struct debugtag dbg_layer[] = {
3370 {"ACPI_UTILITIES", ACPI_UTILITIES},
3371 {"ACPI_HARDWARE", ACPI_HARDWARE},
3372 {"ACPI_EVENTS", ACPI_EVENTS},
3373 {"ACPI_TABLES", ACPI_TABLES},
3374 {"ACPI_NAMESPACE", ACPI_NAMESPACE},
3375 {"ACPI_PARSER", ACPI_PARSER},
3376 {"ACPI_DISPATCHER", ACPI_DISPATCHER},
3377 {"ACPI_EXECUTER", ACPI_EXECUTER},
3378 {"ACPI_RESOURCES", ACPI_RESOURCES},
3379 {"ACPI_CA_DEBUGGER", ACPI_CA_DEBUGGER},
3380 {"ACPI_OS_SERVICES", ACPI_OS_SERVICES},
3381 {"ACPI_CA_DISASSEMBLER", ACPI_CA_DISASSEMBLER},
3382 {"ACPI_ALL_COMPONENTS", ACPI_ALL_COMPONENTS},
3384 {"ACPI_AC_ADAPTER", ACPI_AC_ADAPTER},
3385 {"ACPI_BATTERY", ACPI_BATTERY},
3386 {"ACPI_BUS", ACPI_BUS},
3387 {"ACPI_BUTTON", ACPI_BUTTON},
3388 {"ACPI_EC", ACPI_EC},
3389 {"ACPI_FAN", ACPI_FAN},
3390 {"ACPI_POWERRES", ACPI_POWERRES},
3391 {"ACPI_PROCESSOR", ACPI_PROCESSOR},
3392 {"ACPI_THERMAL", ACPI_THERMAL},
3393 {"ACPI_TIMER", ACPI_TIMER},
3394 {"ACPI_ALL_DRIVERS", ACPI_ALL_DRIVERS},
3395 {NULL, 0}
3398 static struct debugtag dbg_level[] = {
3399 {"ACPI_LV_INIT", ACPI_LV_INIT},
3400 {"ACPI_LV_DEBUG_OBJECT", ACPI_LV_DEBUG_OBJECT},
3401 {"ACPI_LV_INFO", ACPI_LV_INFO},
3402 {"ACPI_LV_REPAIR", ACPI_LV_REPAIR},
3403 {"ACPI_LV_ALL_EXCEPTIONS", ACPI_LV_ALL_EXCEPTIONS},
3405 /* Trace verbosity level 1 [Standard Trace Level] */
3406 {"ACPI_LV_INIT_NAMES", ACPI_LV_INIT_NAMES},
3407 {"ACPI_LV_PARSE", ACPI_LV_PARSE},
3408 {"ACPI_LV_LOAD", ACPI_LV_LOAD},
3409 {"ACPI_LV_DISPATCH", ACPI_LV_DISPATCH},
3410 {"ACPI_LV_EXEC", ACPI_LV_EXEC},
3411 {"ACPI_LV_NAMES", ACPI_LV_NAMES},
3412 {"ACPI_LV_OPREGION", ACPI_LV_OPREGION},
3413 {"ACPI_LV_BFIELD", ACPI_LV_BFIELD},
3414 {"ACPI_LV_TABLES", ACPI_LV_TABLES},
3415 {"ACPI_LV_VALUES", ACPI_LV_VALUES},
3416 {"ACPI_LV_OBJECTS", ACPI_LV_OBJECTS},
3417 {"ACPI_LV_RESOURCES", ACPI_LV_RESOURCES},
3418 {"ACPI_LV_USER_REQUESTS", ACPI_LV_USER_REQUESTS},
3419 {"ACPI_LV_PACKAGE", ACPI_LV_PACKAGE},
3420 {"ACPI_LV_VERBOSITY1", ACPI_LV_VERBOSITY1},
3422 /* Trace verbosity level 2 [Function tracing and memory allocation] */
3423 {"ACPI_LV_ALLOCATIONS", ACPI_LV_ALLOCATIONS},
3424 {"ACPI_LV_FUNCTIONS", ACPI_LV_FUNCTIONS},
3425 {"ACPI_LV_OPTIMIZATIONS", ACPI_LV_OPTIMIZATIONS},
3426 {"ACPI_LV_VERBOSITY2", ACPI_LV_VERBOSITY2},
3427 {"ACPI_LV_ALL", ACPI_LV_ALL},
3429 /* Trace verbosity level 3 [Threading, I/O, and Interrupts] */
3430 {"ACPI_LV_MUTEX", ACPI_LV_MUTEX},
3431 {"ACPI_LV_THREADS", ACPI_LV_THREADS},
3432 {"ACPI_LV_IO", ACPI_LV_IO},
3433 {"ACPI_LV_INTERRUPTS", ACPI_LV_INTERRUPTS},
3434 {"ACPI_LV_VERBOSITY3", ACPI_LV_VERBOSITY3},
3436 /* Exceptionally verbose output -- also used in the global "DebugLevel" */
3437 {"ACPI_LV_AML_DISASSEMBLE", ACPI_LV_AML_DISASSEMBLE},
3438 {"ACPI_LV_VERBOSE_INFO", ACPI_LV_VERBOSE_INFO},
3439 {"ACPI_LV_FULL_TABLES", ACPI_LV_FULL_TABLES},
3440 {"ACPI_LV_EVENTS", ACPI_LV_EVENTS},
3441 {"ACPI_LV_VERBOSE", ACPI_LV_VERBOSE},
3442 {NULL, 0}
3445 static void
3446 acpi_parse_debug(char *cp, struct debugtag *tag, UINT32 *flag)
3448 char *ep;
3449 int i, l;
3450 int set;
3452 while (*cp) {
3453 if (isspace(*cp)) {
3454 cp++;
3455 continue;
3457 ep = cp;
3458 while (*ep && !isspace(*ep))
3459 ep++;
3460 if (*cp == '!') {
3461 set = 0;
3462 cp++;
3463 if (cp == ep)
3464 continue;
3465 } else {
3466 set = 1;
3468 l = ep - cp;
3469 for (i = 0; tag[i].name != NULL; i++) {
3470 if (!strncmp(cp, tag[i].name, l)) {
3471 if (set)
3472 *flag |= tag[i].value;
3473 else
3474 *flag &= ~tag[i].value;
3477 cp = ep;
3481 static void
3482 acpi_set_debugging(void *junk)
3484 char *layer, *level;
3486 if (cold) {
3487 AcpiDbgLayer = 0;
3488 AcpiDbgLevel = 0;
3491 layer = kgetenv("debug.acpi.layer");
3492 level = kgetenv("debug.acpi.level");
3493 if (layer == NULL && level == NULL)
3494 return;
3496 kprintf("ACPI set debug");
3497 if (layer != NULL) {
3498 if (strcmp("NONE", layer) != 0)
3499 kprintf(" layer '%s'", layer);
3500 acpi_parse_debug(layer, &dbg_layer[0], &AcpiDbgLayer);
3501 kfreeenv(layer);
3503 if (level != NULL) {
3504 if (strcmp("NONE", level) != 0)
3505 kprintf(" level '%s'", level);
3506 acpi_parse_debug(level, &dbg_level[0], &AcpiDbgLevel);
3507 kfreeenv(level);
3509 kprintf("\n");
3512 SYSINIT(acpi_debugging, SI_BOOT1_TUNABLES, SI_ORDER_ANY, acpi_set_debugging,
3513 NULL);
3515 static int
3516 acpi_debug_sysctl(SYSCTL_HANDLER_ARGS)
3518 int error, *dbg;
3519 struct debugtag *tag;
3520 struct sbuf sb;
3522 if (sbuf_new(&sb, NULL, 128, SBUF_AUTOEXTEND) == NULL)
3523 return (ENOMEM);
3524 if (strcmp(oidp->oid_arg1, "debug.acpi.layer") == 0) {
3525 tag = &dbg_layer[0];
3526 dbg = &AcpiDbgLayer;
3527 } else {
3528 tag = &dbg_level[0];
3529 dbg = &AcpiDbgLevel;
3532 /* Get old values if this is a get request. */
3533 ACPI_SERIAL_BEGIN(acpi);
3534 if (*dbg == 0) {
3535 sbuf_cpy(&sb, "NONE");
3536 } else if (req->newptr == NULL) {
3537 for (; tag->name != NULL; tag++) {
3538 if ((*dbg & tag->value) == tag->value)
3539 sbuf_printf(&sb, "%s ", tag->name);
3542 sbuf_trim(&sb);
3543 sbuf_finish(&sb);
3545 /* Copy out the old values to the user. */
3546 error = SYSCTL_OUT(req, sbuf_data(&sb), sbuf_len(&sb));
3547 sbuf_delete(&sb);
3549 /* If the user is setting a string, parse it. */
3550 if (error == 0 && req->newptr != NULL) {
3551 *dbg = 0;
3552 ksetenv((char *)oidp->oid_arg1, (char *)req->newptr);
3553 acpi_set_debugging(NULL);
3555 ACPI_SERIAL_END(acpi);
3557 return (error);
3560 SYSCTL_PROC(_debug_acpi, OID_AUTO, layer, CTLFLAG_RW | CTLTYPE_STRING,
3561 "debug.acpi.layer", 0, acpi_debug_sysctl, "A", "");
3562 SYSCTL_PROC(_debug_acpi, OID_AUTO, level, CTLFLAG_RW | CTLTYPE_STRING,
3563 "debug.acpi.level", 0, acpi_debug_sysctl, "A", "");
3564 #endif /* ACPI_DEBUG */
3566 static int
3567 acpi_debug_objects_sysctl(SYSCTL_HANDLER_ARGS)
3569 int error;
3570 int old;
3572 old = acpi_debug_objects;
3573 error = sysctl_handle_int(oidp, &acpi_debug_objects, 0, req);
3574 if (error != 0 || req->newptr == NULL)
3575 return (error);
3576 if (old == acpi_debug_objects || (old && acpi_debug_objects))
3577 return (0);
3579 ACPI_SERIAL_BEGIN(acpi);
3580 AcpiGbl_EnableAmlDebugObject = acpi_debug_objects ? TRUE : FALSE;
3581 ACPI_SERIAL_END(acpi);
3583 return (0);
3587 static int
3588 acpi_parse_interfaces(char *str, struct acpi_interface *iface)
3590 char *p;
3591 size_t len;
3592 int i, j;
3594 p = str;
3595 while (isspace(*p) || *p == ',')
3596 p++;
3597 len = strlen(p);
3598 if (len == 0)
3599 return (0);
3600 p = kstrdup(p, M_TEMP);
3601 for (i = 0; i < len; i++)
3602 if (p[i] == ',')
3603 p[i] = '\0';
3604 i = j = 0;
3605 while (i < len)
3606 if (isspace(p[i]) || p[i] == '\0')
3607 i++;
3608 else {
3609 i += strlen(p + i) + 1;
3610 j++;
3612 if (j == 0) {
3613 kfree(p, M_TEMP);
3614 return (0);
3616 iface->data = kmalloc(sizeof(*iface->data) * j, M_TEMP, M_WAITOK);
3617 iface->num = j;
3618 i = j = 0;
3619 while (i < len)
3620 if (isspace(p[i]) || p[i] == '\0')
3621 i++;
3622 else {
3623 iface->data[j] = p + i;
3624 i += strlen(p + i) + 1;
3625 j++;
3628 return (j);
3631 static void
3632 acpi_free_interfaces(struct acpi_interface *iface)
3634 kfree(iface->data[0], M_TEMP);
3635 kfree(iface->data, M_TEMP);
3638 static void
3639 acpi_reset_interfaces(device_t dev)
3641 struct acpi_interface list;
3642 ACPI_STATUS status;
3643 int i;
3645 if (acpi_parse_interfaces(acpi_install_interface, &list) > 0) {
3646 for (i = 0; i < list.num; i++) {
3647 status = AcpiInstallInterface(list.data[i]);
3648 if (ACPI_FAILURE(status))
3649 device_printf(dev,
3650 "failed to install _OSI(\"%s\"): %s\n",
3651 list.data[i], AcpiFormatException(status));
3652 else if (bootverbose)
3653 device_printf(dev, "installed _OSI(\"%s\")\n",
3654 list.data[i]);
3656 acpi_free_interfaces(&list);
3658 if (acpi_parse_interfaces(acpi_remove_interface, &list) > 0) {
3659 for (i = 0; i < list.num; i++) {
3660 status = AcpiRemoveInterface(list.data[i]);
3661 if (ACPI_FAILURE(status))
3662 device_printf(dev,
3663 "failed to remove _OSI(\"%s\"): %s\n",
3664 list.data[i], AcpiFormatException(status));
3665 else if (bootverbose)
3666 device_printf(dev, "removed _OSI(\"%s\")\n",
3667 list.data[i]);
3669 acpi_free_interfaces(&list);
3673 static int
3674 acpi_pm_func(u_long cmd, void *arg, ...)
3676 int state, acpi_state;
3677 int error;
3678 struct acpi_softc *sc;
3679 __va_list ap;
3681 error = 0;
3682 switch (cmd) {
3683 case POWER_CMD_SUSPEND:
3684 sc = (struct acpi_softc *)arg;
3685 if (sc == NULL) {
3686 error = EINVAL;
3687 goto out;
3690 __va_start(ap, arg);
3691 state = __va_arg(ap, int);
3692 __va_end(ap);
3694 switch (state) {
3695 case POWER_SLEEP_STATE_STANDBY:
3696 acpi_state = sc->acpi_standby_sx;
3697 break;
3698 case POWER_SLEEP_STATE_SUSPEND:
3699 acpi_state = sc->acpi_suspend_sx;
3700 break;
3701 case POWER_SLEEP_STATE_HIBERNATE:
3702 acpi_state = ACPI_STATE_S4;
3703 break;
3704 default:
3705 error = EINVAL;
3706 goto out;
3709 if (ACPI_FAILURE(acpi_EnterSleepState(sc, acpi_state)))
3710 error = ENXIO;
3711 break;
3712 default:
3713 error = EINVAL;
3714 goto out;
3717 out:
3718 return (error);
3721 static void
3722 acpi_pm_register(void *arg)
3724 if (!cold || resource_disabled("acpi", 0))
3725 return;
3727 power_pm_register(POWER_PM_TYPE_ACPI, acpi_pm_func, NULL);
3730 SYSINIT(power, SI_BOOT2_KLD, SI_ORDER_ANY, acpi_pm_register, 0);