Sync ACPICA with Intel's version 20190215.
[dragonfly.git] / sys / dev / acpica / acpi.c
blob5a25342c7cc18b23fe54665c895671bcbe9fde5c
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 void acpi_disable_not_present(device_t child);
144 static void acpi_reprobe_children(device_t bus, device_t *children,
145 int cnt);
146 static ACPI_STATUS acpi_probe_child(ACPI_HANDLE handle, UINT32 level,
147 void *context, void **status);
148 static ACPI_STATUS acpi_EnterSleepState(struct acpi_softc *sc, int state);
149 static void acpi_shutdown_final(void *arg, int howto);
150 static void acpi_enable_fixed_events(struct acpi_softc *sc);
151 static int acpi_wake_sleep_prep(ACPI_HANDLE handle, int sstate);
152 static int acpi_wake_run_prep(ACPI_HANDLE handle, int sstate);
153 static int acpi_wake_prep_walk(int sstate);
154 static int acpi_wake_sysctl_walk(device_t dev);
155 #ifdef notyet
156 static int acpi_wake_set_sysctl(SYSCTL_HANDLER_ARGS);
157 #endif
158 static void acpi_system_eventhandler_sleep(void *arg, int state);
159 static void acpi_system_eventhandler_wakeup(void *arg, int state);
160 static int acpi_supported_sleep_state_sysctl(SYSCTL_HANDLER_ARGS);
161 static int acpi_sleep_state_sysctl(SYSCTL_HANDLER_ARGS);
162 static int acpi_debug_objects_sysctl(SYSCTL_HANDLER_ARGS);
163 static int acpi_pm_func(u_long cmd, void *arg, ...);
164 static int acpi_child_location_str_method(device_t acdev, device_t child,
165 char *buf, size_t buflen);
166 static int acpi_child_pnpinfo_str_method(device_t acdev, device_t child,
167 char *buf, size_t buflen);
168 static void acpi_enable_pcie(void);
169 static void acpi_reset_interfaces(device_t dev);
171 static device_method_t acpi_methods[] = {
172 /* Device interface */
173 DEVMETHOD(device_identify, acpi_identify),
174 DEVMETHOD(device_probe, acpi_probe),
175 DEVMETHOD(device_attach, acpi_attach),
176 DEVMETHOD(device_shutdown, acpi_shutdown),
177 DEVMETHOD(device_detach, bus_generic_detach),
178 DEVMETHOD(device_suspend, acpi_suspend),
179 DEVMETHOD(device_resume, acpi_resume),
181 /* Bus interface */
182 DEVMETHOD(bus_add_child, acpi_add_child),
183 DEVMETHOD(bus_print_child, acpi_print_child),
184 DEVMETHOD(bus_probe_nomatch, acpi_probe_nomatch),
185 DEVMETHOD(bus_driver_added, acpi_driver_added),
186 DEVMETHOD(bus_read_ivar, acpi_read_ivar),
187 DEVMETHOD(bus_write_ivar, acpi_write_ivar),
188 DEVMETHOD(bus_get_resource_list, acpi_get_rlist),
189 DEVMETHOD(bus_set_resource, bus_generic_rl_set_resource),
190 DEVMETHOD(bus_get_resource, bus_generic_rl_get_resource),
191 DEVMETHOD(bus_alloc_resource, acpi_alloc_resource),
192 DEVMETHOD(bus_release_resource, acpi_release_resource),
193 DEVMETHOD(bus_delete_resource, acpi_delete_resource),
194 DEVMETHOD(bus_child_pnpinfo_str, acpi_child_pnpinfo_str_method),
195 DEVMETHOD(bus_child_location_str, acpi_child_location_str_method),
196 DEVMETHOD(bus_activate_resource, bus_generic_activate_resource),
197 DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource),
198 DEVMETHOD(bus_setup_intr, bus_generic_setup_intr),
199 DEVMETHOD(bus_teardown_intr, bus_generic_teardown_intr),
201 /* ACPI bus */
202 DEVMETHOD(acpi_id_probe, acpi_device_id_probe),
203 DEVMETHOD(acpi_evaluate_object, acpi_device_eval_obj),
204 DEVMETHOD(acpi_pwr_for_sleep, acpi_device_pwr_for_sleep),
205 DEVMETHOD(acpi_scan_children, acpi_device_scan_children),
207 /* PCI emulation */
208 DEVMETHOD(pci_set_powerstate, acpi_set_powerstate_method),
210 /* ISA emulation */
211 DEVMETHOD(isa_pnp_probe, acpi_isa_pnp_probe),
213 DEVMETHOD_END
216 static driver_t acpi_driver = {
217 "acpi",
218 acpi_methods,
219 sizeof(struct acpi_softc),
220 .gpri = KOBJ_GPRI_ACPI+2
223 static devclass_t acpi_devclass;
224 DRIVER_MODULE(acpi, nexus, acpi_driver, acpi_devclass, acpi_modevent, NULL);
225 MODULE_VERSION(acpi, 1);
227 ACPI_SERIAL_DECL(acpi, "ACPI serializer");
229 /* Local pools for managing system resources for ACPI child devices. */
230 static struct rman acpi_rman_io, acpi_rman_mem;
232 #define ACPI_MINIMUM_AWAKETIME 5
234 static const char* sleep_state_names[] = {
235 "S0", "S1", "S2", "S3", "S4", "S5", "NONE"};
237 SYSCTL_NODE(_debug, OID_AUTO, acpi, CTLFLAG_RD, NULL, "ACPI debugging");
238 static char acpi_ca_version[12];
239 SYSCTL_STRING(_debug_acpi, OID_AUTO, acpi_ca_version, CTLFLAG_RD,
240 acpi_ca_version, 0, "Version of Intel ACPICA");
243 * Allow overriding _OSI methods.
245 static char acpi_install_interface[256];
246 TUNABLE_STR("hw.acpi.install_interface", acpi_install_interface,
247 sizeof(acpi_install_interface));
248 static char acpi_remove_interface[256];
249 TUNABLE_STR("hw.acpi.remove_interface", acpi_remove_interface,
250 sizeof(acpi_remove_interface));
253 * Use this tunable to disable the control method auto-serialization
254 * mechanism that was added in 20140214 and superseded the previous
255 * AcpiGbl_SerializeAllMethods global.
257 static int acpi_auto_serialize_methods = 1;
258 TUNABLE_INT("hw.acpi.auto_serialize_methods", &acpi_auto_serialize_methods);
260 /* Allow users to dump Debug objects without ACPI debugger. */
261 static int acpi_debug_objects;
262 TUNABLE_INT("debug.acpi.enable_debug_objects", &acpi_debug_objects);
263 SYSCTL_PROC(_debug_acpi, OID_AUTO, enable_debug_objects,
264 CTLFLAG_RW | CTLTYPE_INT, NULL, 0, acpi_debug_objects_sysctl, "I",
265 "Enable Debug objects.");
267 /* Allow ignoring the XSDT. */
268 static int acpi_ignore_xsdt;
269 TUNABLE_INT("debug.acpi.ignore_xsdt", &acpi_ignore_xsdt);
270 SYSCTL_INT(_debug_acpi, OID_AUTO, ignore_xsdt, CTLFLAG_RD,
271 &acpi_ignore_xsdt, 1, "Ignore the XSDT, forcing the use of the RSDT.");
273 /* Allow the interpreter to ignore common mistakes in BIOS. */
274 static int acpi_interpreter_slack = 1;
275 TUNABLE_INT("debug.acpi.interpreter_slack", &acpi_interpreter_slack);
276 SYSCTL_INT(_debug_acpi, OID_AUTO, interpreter_slack, CTLFLAG_RD,
277 &acpi_interpreter_slack, 1, "Turn on interpreter slack mode.");
279 /* Allow preferring 32-bit FADT register addresses over the 64-bit ones. */
280 static int acpi_fadt_addr32;
281 TUNABLE_INT("debug.acpi.fadt_addr32", &acpi_fadt_addr32);
282 SYSCTL_INT(_debug_acpi, OID_AUTO, fadt_addr32, CTLFLAG_RD,
283 &acpi_fadt_addr32, 1,
284 "Prefer 32-bit FADT register addresses over 64-bit ones.");
286 /* Prefer 32-bit FACS table addresses over the 64-bit ones. */
287 static int acpi_facs_addr32 = 1;
288 TUNABLE_INT("debug.acpi.facs_addr32", &acpi_facs_addr32);
289 SYSCTL_INT(_debug_acpi, OID_AUTO, facs_addr32, CTLFLAG_RD,
290 &acpi_facs_addr32, 1,
291 "Prefer 32-bit FACS table addresses over 64-bit ones.");
293 /* Power devices off and on in suspend and resume. XXX Remove once tested. */
294 static int acpi_do_powerstate = 1;
295 TUNABLE_INT("debug.acpi.do_powerstate", &acpi_do_powerstate);
296 SYSCTL_INT(_debug_acpi, OID_AUTO, do_powerstate, CTLFLAG_RW,
297 &acpi_do_powerstate, 1, "Turn off devices when suspending.");
299 /* Allow users to override quirks. */
300 TUNABLE_INT("debug.acpi.quirks", &acpi_quirks);
302 /* Allow to call ACPI methods from userland. */
303 static int acpi_allow_mcall;
304 TUNABLE_INT("debug.acpi.allow_method_calls", &acpi_allow_mcall);
306 static int acpi_susp_bounce;
307 SYSCTL_INT(_debug_acpi, OID_AUTO, suspend_bounce, CTLFLAG_RW,
308 &acpi_susp_bounce, 0, "Don't actually suspend, just test devices.");
311 * ACPI can only be loaded as a module by the loader; activating it after
312 * system bootstrap time is not useful, and can be fatal to the system.
313 * It also cannot be unloaded, since the entire system bus heirarchy hangs
314 * off it.
316 static int
317 acpi_modevent(struct module *mod, int event, void *junk)
319 switch (event) {
320 case MOD_LOAD:
321 if (!cold) {
322 kprintf("The ACPI driver cannot be loaded after boot.\n");
323 return (EPERM);
325 break;
326 case MOD_UNLOAD:
327 if (!cold && power_pm_get_type() == POWER_PM_TYPE_ACPI)
328 return (EBUSY);
329 break;
330 default:
331 break;
333 return (0);
337 * Perform early initialization.
339 ACPI_STATUS
340 acpi_Startup(void)
342 static int started = 0;
343 ACPI_STATUS status;
344 int val;
346 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
348 /* Only run the startup code once. The MADT driver also calls this. */
349 if (started)
350 return_VALUE (AE_OK);
351 started = 1;
353 /* Start up the ACPICA subsystem. */
354 status = AcpiInitializeSubsystem();
355 if (ACPI_FAILURE(status)) {
356 kprintf("ACPI: Subsystem initialization failed: %s\n",
357 AcpiFormatException(status));
358 return_VALUE (status);
362 * Pre-allocate space for RSDT/XSDT and DSDT tables and allow resizing
363 * if more tables exist.
365 if (ACPI_FAILURE(status = AcpiInitializeTables(NULL, 2, TRUE))) {
366 kprintf("ACPI: Table initialization failed: %s\n",
367 AcpiFormatException(status));
368 return_VALUE (status);
371 /* Set up any quirks we have for this system. */
372 if (acpi_quirks == ACPI_Q_OK)
373 acpi_table_quirks(&acpi_quirks);
375 /* If the user manually set the disabled hint to 0, force-enable ACPI. */
376 if (resource_int_value("acpi", 0, "disabled", &val) == 0 && val == 0)
377 acpi_quirks &= ~ACPI_Q_BROKEN;
378 if (acpi_quirks & ACPI_Q_BROKEN) {
379 kprintf("ACPI disabled by blacklist. Contact your BIOS vendor.\n");
380 status = AE_SUPPORT;
383 return_VALUE (status);
387 * Detect ACPI, perform early initialisation
389 static void
390 acpi_identify(driver_t *driver, device_t parent)
392 device_t child;
394 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
396 if (!cold)
397 return_VOID;
399 /* Check that we haven't been disabled with a hint. */
400 if (resource_disabled("acpi", 0))
401 return_VOID;
403 /* Make sure we're not being doubly invoked. */
404 if (device_find_child(parent, "acpi", 0) != NULL)
405 return_VOID;
407 ksnprintf(acpi_ca_version, sizeof(acpi_ca_version), "%x", ACPI_CA_VERSION);
409 /* Initialize root tables. */
410 if (ACPI_FAILURE(acpi_Startup())) {
411 kprintf("ACPI: Try disabling either ACPI or apic support.\n");
412 return_VOID;
415 /* Attach the actual ACPI device. */
416 if ((child = BUS_ADD_CHILD(parent, parent, 10, "acpi", 0)) == NULL) {
417 device_printf(parent, "device_identify failed\n");
418 return_VOID;
423 * Fetch some descriptive data from ACPI to put in our attach message.
425 static int
426 acpi_probe(device_t dev)
428 ACPI_TABLE_RSDP *rsdp;
429 ACPI_TABLE_HEADER *rsdt;
430 ACPI_PHYSICAL_ADDRESS paddr;
431 char buf[ACPI_OEM_ID_SIZE + ACPI_OEM_TABLE_ID_SIZE + 2];
432 struct sbuf sb;
434 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
436 if (power_pm_get_type() != POWER_PM_TYPE_NONE &&
437 power_pm_get_type() != POWER_PM_TYPE_ACPI) {
438 device_printf(dev, "probe failed, other PM system enabled.\n");
439 return_VALUE (ENXIO);
442 if ((paddr = AcpiOsGetRootPointer()) == 0 ||
443 (rsdp = AcpiOsMapMemory(paddr, sizeof(ACPI_TABLE_RSDP))) == NULL)
444 return_VALUE (ENXIO);
445 if (acpi_ignore_xsdt == 0 &&
446 rsdp->Revision > 1 && rsdp->XsdtPhysicalAddress != 0)
447 paddr = (ACPI_PHYSICAL_ADDRESS)rsdp->XsdtPhysicalAddress;
448 else
449 paddr = (ACPI_PHYSICAL_ADDRESS)rsdp->RsdtPhysicalAddress;
450 AcpiOsUnmapMemory(rsdp, sizeof(ACPI_TABLE_RSDP));
452 if ((rsdt = AcpiOsMapMemory(paddr, sizeof(ACPI_TABLE_HEADER))) == NULL)
453 return_VALUE (ENXIO);
454 sbuf_new(&sb, buf, sizeof(buf), SBUF_FIXEDLEN);
455 sbuf_bcat(&sb, rsdt->OemId, ACPI_OEM_ID_SIZE);
456 sbuf_trim(&sb);
457 sbuf_putc(&sb, ' ');
458 sbuf_bcat(&sb, rsdt->OemTableId, ACPI_OEM_TABLE_ID_SIZE);
459 sbuf_trim(&sb);
460 sbuf_finish(&sb);
461 device_set_desc_copy(dev, sbuf_data(&sb));
462 sbuf_delete(&sb);
463 AcpiOsUnmapMemory(rsdt, sizeof(ACPI_TABLE_HEADER));
465 return_VALUE (0);
468 static int
469 acpi_attach(device_t dev)
471 struct acpi_softc *sc;
472 ACPI_STATUS status;
473 int error, state;
474 UINT32 flags;
475 UINT8 TypeA, TypeB;
476 char *env;
478 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
480 sc = device_get_softc(dev);
481 sc->acpi_dev = dev;
482 callout_init(&sc->susp_force_to);
484 if ((error = acpi_task_thread_init())) {
485 device_printf(dev, "Could not start task thread.\n");
486 goto out2;
489 error = ENXIO;
491 /* Initialize resource manager. */
492 acpi_rman_io.rm_type = RMAN_ARRAY;
493 acpi_rman_io.rm_start = 0;
494 acpi_rman_io.rm_end = 0xffff;
495 acpi_rman_io.rm_descr = "ACPI I/O ports";
496 if (rman_init(&acpi_rman_io, -1) != 0)
497 panic("acpi rman_init IO ports failed");
498 acpi_rman_mem.rm_type = RMAN_ARRAY;
499 acpi_rman_mem.rm_start = 0;
500 acpi_rman_mem.rm_end = ~0ul;
501 acpi_rman_mem.rm_descr = "ACPI I/O memory addresses";
502 if (rman_init(&acpi_rman_mem, -1) != 0)
503 panic("acpi rman_init memory failed");
505 /* Initialise the ACPI mutex */
506 ACPI_LOCK_INIT(acpi, "acpi");
507 ACPI_SERIAL_INIT(acpi);
509 ACPI_LOCK(acpi);
512 * Set the globals from our tunables. This is needed because ACPICA
513 * uses UINT8 for some values and we have no tunable_byte.
515 AcpiGbl_AutoSerializeMethods = acpi_auto_serialize_methods ? TRUE : FALSE;
516 AcpiGbl_DoNotUseXsdt = acpi_ignore_xsdt ? TRUE : FALSE;
517 AcpiGbl_EnableAmlDebugObject = acpi_debug_objects ? TRUE : FALSE;
518 AcpiGbl_EnableInterpreterSlack = acpi_interpreter_slack ? TRUE : FALSE;
519 AcpiGbl_Use32BitFadtAddresses = acpi_fadt_addr32 ? TRUE : FALSE;
520 AcpiGbl_Use32BitFacsAddresses = acpi_facs_addr32 ? TRUE : FALSE;
522 #ifndef ACPI_DEBUG
524 * Disable Debug Object output.
526 AcpiDbgLevel &= ~ACPI_LV_DEBUG_OBJECT;
527 #endif
529 /* Override OS interfaces if the user requested. */
530 acpi_reset_interfaces(dev);
532 /* Load ACPI name space. */
533 status = AcpiLoadTables();
534 if (ACPI_FAILURE(status)) {
535 device_printf(dev, "Could not load Namespace: %s\n",
536 AcpiFormatException(status));
537 goto out;
540 /* Handle MCFG table if present. */
541 acpi_enable_pcie();
544 * Note that some systems (specifically, those with namespace evaluation
545 * issues that require the avoidance of parts of the namespace) must
546 * avoid running _INI and _STA on everything, as well as dodging the final
547 * object init pass.
549 * For these devices, we set ACPI_NO_DEVICE_INIT and ACPI_NO_OBJECT_INIT).
551 * XXX We should arrange for the object init pass after we have attached
552 * all our child devices, but on many systems it works here.
554 flags = ACPI_FULL_INITIALIZATION;
555 if (ktestenv("debug.acpi.avoid"))
556 flags = ACPI_NO_DEVICE_INIT | ACPI_NO_OBJECT_INIT;
558 /* Bring the hardware and basic handlers online. */
559 if (ACPI_FAILURE(status = AcpiEnableSubsystem(flags))) {
560 device_printf(dev, "Could not enable ACPI: %s\n",
561 AcpiFormatException(status));
562 goto out;
566 * Fix up the interrupt timer after enabling ACPI, so that the
567 * interrupt cputimer that choked by ACPI power management could
568 * be resurrected before probing various devices.
570 DELAY(5000);
571 cputimer_intr_pmfixup();
574 * Call the ECDT probe function to provide EC functionality before
575 * the namespace has been evaluated.
577 * XXX This happens before the sysresource devices have been probed and
578 * attached so its resources come from nexus0. In practice, this isn't
579 * a problem but should be addressed eventually.
581 acpi_ec_ecdt_probe(dev);
583 /* Bring device objects and regions online. */
584 if (ACPI_FAILURE(status = AcpiInitializeObjects(flags))) {
585 device_printf(dev, "Could not initialize ACPI objects: %s\n",
586 AcpiFormatException(status));
587 goto out;
591 * Setup our sysctl tree.
593 * XXX: This doesn't check to make sure that none of these fail.
595 sysctl_ctx_init(&sc->acpi_sysctl_ctx);
596 sc->acpi_sysctl_tree = SYSCTL_ADD_NODE(&sc->acpi_sysctl_ctx,
597 SYSCTL_STATIC_CHILDREN(_hw), OID_AUTO,
598 device_get_name(dev), CTLFLAG_RD, 0, "");
599 SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
600 OID_AUTO, "supported_sleep_state", CTLTYPE_STRING | CTLFLAG_RD,
601 0, 0, acpi_supported_sleep_state_sysctl, "A", "");
602 SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
603 OID_AUTO, "power_button_state", CTLTYPE_STRING | CTLFLAG_RW,
604 &sc->acpi_power_button_sx, 0, acpi_sleep_state_sysctl, "A", "");
605 SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
606 OID_AUTO, "sleep_button_state", CTLTYPE_STRING | CTLFLAG_RW,
607 &sc->acpi_sleep_button_sx, 0, acpi_sleep_state_sysctl, "A", "");
608 SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
609 OID_AUTO, "lid_switch_state", CTLTYPE_STRING | CTLFLAG_RW,
610 &sc->acpi_lid_switch_sx, 0, acpi_sleep_state_sysctl, "A", "");
611 SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
612 OID_AUTO, "standby_state", CTLTYPE_STRING | CTLFLAG_RW,
613 &sc->acpi_standby_sx, 0, acpi_sleep_state_sysctl, "A", "");
614 SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
615 OID_AUTO, "suspend_state", CTLTYPE_STRING | CTLFLAG_RW,
616 &sc->acpi_suspend_sx, 0, acpi_sleep_state_sysctl, "A", "");
617 SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
618 OID_AUTO, "sleep_delay", CTLFLAG_RW, &sc->acpi_sleep_delay, 0,
619 "sleep delay");
620 SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
621 OID_AUTO, "s4bios", CTLFLAG_RW, &sc->acpi_s4bios, 0, "S4BIOS mode");
622 SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
623 OID_AUTO, "verbose", CTLFLAG_RW, &sc->acpi_verbose, 0, "verbose mode");
624 SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
625 OID_AUTO, "disable_on_reboot", CTLFLAG_RW,
626 &sc->acpi_do_disable, 0, "Disable ACPI when rebooting/halting system");
627 SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
628 OID_AUTO, "handle_reboot", CTLFLAG_RW,
629 &sc->acpi_handle_reboot, 0, "Use ACPI Reset Register to reboot");
632 * Default to 1 second before sleeping to give some machines time to
633 * stabilize.
635 sc->acpi_sleep_delay = 1;
636 if (bootverbose)
637 sc->acpi_verbose = 1;
638 if ((env = kgetenv("hw.acpi.verbose")) != NULL) {
639 if (strcmp(env, "0") != 0)
640 sc->acpi_verbose = 1;
641 kfreeenv(env);
644 /* Only enable reboot by default if the FADT says it is available. */
645 if (AcpiGbl_FADT.Flags & ACPI_FADT_RESET_REGISTER)
646 sc->acpi_handle_reboot = 1;
648 /* Only enable S4BIOS by default if the FACS says it is available. */
649 if (AcpiGbl_FACS->Flags & ACPI_FACS_S4_BIOS_PRESENT)
650 sc->acpi_s4bios = 1;
653 * Dispatch the default sleep state to devices. The lid switch is set
654 * to NONE by default to avoid surprising users.
656 sc->acpi_power_button_sx = ACPI_STATE_S5;
657 sc->acpi_lid_switch_sx = ACPI_S_STATES_MAX + 1;
658 sc->acpi_standby_sx = ACPI_STATE_S1;
659 sc->acpi_suspend_sx = ACPI_STATE_S3;
661 /* Pick the first valid sleep state for the sleep button default. */
662 sc->acpi_sleep_button_sx = ACPI_S_STATES_MAX + 1;
663 for (state = ACPI_STATE_S1; state <= ACPI_STATE_S4; state++)
664 if (ACPI_SUCCESS(AcpiGetSleepTypeData(state, &TypeA, &TypeB))) {
665 sc->acpi_sleep_button_sx = state;
666 break;
669 acpi_enable_fixed_events(sc);
672 * Scan the namespace and attach/initialise children.
675 /* Register our shutdown handler. */
676 EVENTHANDLER_REGISTER(shutdown_final, acpi_shutdown_final, sc,
677 SHUTDOWN_PRI_LAST);
680 * Register our acpi event handlers.
681 * XXX should be configurable eg. via userland policy manager.
683 EVENTHANDLER_REGISTER(acpi_sleep_event, acpi_system_eventhandler_sleep,
684 sc, ACPI_EVENT_PRI_LAST);
685 EVENTHANDLER_REGISTER(acpi_wakeup_event, acpi_system_eventhandler_wakeup,
686 sc, ACPI_EVENT_PRI_LAST);
688 /* Flag our initial states. */
689 sc->acpi_enabled = 1;
690 sc->acpi_sstate = ACPI_STATE_S0;
691 sc->acpi_sleep_disabled = 0;
692 /* Create the control device */
693 sc->acpi_dev_t = make_dev(&acpi_ops, 0, UID_ROOT, GID_WHEEL, 0644, "acpi");
694 sc->acpi_dev_t->si_drv1 = sc;
696 if ((error = acpi_machdep_init(dev)))
697 goto out;
699 /* Register ACPI again to pass the correct argument of pm_func. */
700 power_pm_register(POWER_PM_TYPE_ACPI, acpi_pm_func, sc);
702 if (!acpi_disabled("bus"))
703 acpi_probe_children(dev);
705 /* Update all GPEs and enable runtime GPEs. */
706 status = AcpiUpdateAllGpes();
707 if (ACPI_FAILURE(status)) {
708 device_printf(dev, "Could not update all GPEs: %s\n",
709 AcpiFormatException(status));
712 /* Allow sleep request after a while. */
713 /* timeout(acpi_sleep_enable, sc, hz * ACPI_MINIMUM_AWAKETIME); */
715 error = 0;
717 out:
718 ACPI_UNLOCK(acpi);
719 out2:
720 cputimer_intr_pmfixup();
721 acpi_task_thread_schedule();
723 return_VALUE (error);
726 static int
727 acpi_suspend(device_t dev)
729 device_t child, *devlist;
730 int error, i, numdevs, pstate;
732 /* First give child devices a chance to suspend. */
733 error = bus_generic_suspend(dev);
734 if (error)
735 return (error);
738 * Now, set them into the appropriate power state, usually D3. If the
739 * device has an _SxD method for the next sleep state, use that power
740 * state instead.
742 device_get_children(dev, &devlist, &numdevs);
743 for (i = 0; i < numdevs; i++) {
744 /* If the device is not attached, we've powered it down elsewhere. */
745 child = devlist[i];
746 if (!device_is_attached(child))
747 continue;
750 * Default to D3 for all sleep states. The _SxD method is optional
751 * so set the powerstate even if it's absent.
753 pstate = PCI_POWERSTATE_D3;
754 error = acpi_device_pwr_for_sleep(device_get_parent(child),
755 child, &pstate);
756 if ((error == 0 || error == ESRCH) && acpi_do_powerstate)
757 pci_set_powerstate(child, pstate);
759 kfree(devlist, M_TEMP);
760 error = 0;
762 return (error);
765 static int
766 acpi_resume(device_t dev)
768 ACPI_HANDLE handle;
769 int i, numdevs;
770 device_t child, *devlist;
773 * Put all devices in D0 before resuming them. Call _S0D on each one
774 * since some systems expect this.
776 device_get_children(dev, &devlist, &numdevs);
777 for (i = 0; i < numdevs; i++) {
778 child = devlist[i];
779 handle = acpi_get_handle(child);
780 if (handle)
781 AcpiEvaluateObject(handle, "_S0D", NULL, NULL);
782 if (device_is_attached(child) && acpi_do_powerstate)
783 pci_set_powerstate(child, PCI_POWERSTATE_D0);
785 kfree(devlist, M_TEMP);
787 return (bus_generic_resume(dev));
790 static int
791 acpi_shutdown(device_t dev)
793 /* Allow children to shutdown first. */
794 bus_generic_shutdown(dev);
797 * Enable any GPEs that are able to power-on the system (i.e., RTC).
798 * Also, disable any that are not valid for this state (most).
800 acpi_wake_prep_walk(ACPI_STATE_S5);
802 return (0);
806 * Handle a new device being added
808 static device_t
809 acpi_add_child(device_t bus, device_t parent, int order, const char *name, int unit)
811 struct acpi_device *ad;
812 device_t child;
814 if ((ad = kmalloc(sizeof(*ad), M_ACPIDEV, M_NOWAIT | M_ZERO)) == NULL)
815 return (NULL);
817 resource_list_init(&ad->ad_rl);
818 child = device_add_child_ordered(parent, order, name, unit);
819 if (child != NULL)
820 device_set_ivars(child, ad);
821 else
822 kfree(ad, M_ACPIDEV);
823 return (child);
826 static int
827 acpi_print_child(device_t bus, device_t child)
829 struct acpi_device *adev = device_get_ivars(child);
830 struct resource_list *rl = &adev->ad_rl;
831 int retval = 0;
833 retval += bus_print_child_header(bus, child);
834 retval += resource_list_print_type(rl, "port", SYS_RES_IOPORT, "%#lx");
835 retval += resource_list_print_type(rl, "iomem", SYS_RES_MEMORY, "%#lx");
836 retval += resource_list_print_type(rl, "irq", SYS_RES_IRQ, "%ld");
837 retval += resource_list_print_type(rl, "drq", SYS_RES_DRQ, "%ld");
838 if (device_get_flags(child))
839 retval += kprintf(" flags %#x", device_get_flags(child));
840 retval += bus_print_child_footer(bus, child);
842 return (retval);
846 * If this device is an ACPI child but no one claimed it, attempt
847 * to power it off. We'll power it back up when a driver is added.
849 * XXX Disabled for now since many necessary devices (like fdc and
850 * ATA) don't claim the devices we created for them but still expect
851 * them to be powered up.
853 static void
854 acpi_probe_nomatch(device_t bus, device_t child)
857 /* pci_set_powerstate(child, PCI_POWERSTATE_D3); */
861 * If a new driver has a chance to probe a child, first power it up.
863 * XXX Disabled for now (see acpi_probe_nomatch for details).
865 static void
866 acpi_driver_added(device_t dev, driver_t *driver)
868 device_t child, *devlist;
869 int i, numdevs;
871 DEVICE_IDENTIFY(driver, dev);
872 device_get_children(dev, &devlist, &numdevs);
873 for (i = 0; i < numdevs; i++) {
874 child = devlist[i];
875 if (device_get_state(child) == DS_NOTPRESENT) {
876 /* pci_set_powerstate(child, PCI_POWERSTATE_D0); */
877 if (device_probe_and_attach(child) != 0) {
878 ; /* pci_set_powerstate(child, PCI_POWERSTATE_D3); */
882 kfree(devlist, M_TEMP);
885 /* Location hint for devctl(8) */
886 static int
887 acpi_child_location_str_method(device_t cbdev, device_t child, char *buf,
888 size_t buflen)
890 struct acpi_device *dinfo = device_get_ivars(child);
892 if (dinfo->ad_handle)
893 ksnprintf(buf, buflen, "handle=%s", acpi_name(dinfo->ad_handle));
894 else
895 ksnprintf(buf, buflen, "unknown");
896 return (0);
899 /* PnP information for devctl(8) */
900 static int
901 acpi_child_pnpinfo_str_method(device_t cbdev, device_t child, char *buf,
902 size_t buflen)
904 ACPI_DEVICE_INFO *adinfo;
905 struct acpi_device *dinfo = device_get_ivars(child);
907 if (ACPI_FAILURE(AcpiGetObjectInfo(dinfo->ad_handle, &adinfo))) {
908 ksnprintf(buf, buflen, "unknown");
909 } else {
910 ksnprintf(buf, buflen, "_HID=%s _UID=%s",
911 (adinfo->Valid & ACPI_VALID_HID) ?
912 adinfo->HardwareId.String : "none",
913 (adinfo->Valid & ACPI_VALID_UID) ?
914 adinfo->UniqueId.String : "0");
915 if (adinfo)
916 AcpiOsFree(adinfo);
918 return (0);
922 * Handle per-device ivars
924 static int
925 acpi_read_ivar(device_t dev, device_t child, int index, uintptr_t *result)
927 struct acpi_device *ad;
929 if ((ad = device_get_ivars(child)) == NULL) {
930 device_printf(child, "device has no ivars\n");
931 return (ENOENT);
934 /* ACPI and ISA compatibility ivars */
935 switch(index) {
936 case ACPI_IVAR_HANDLE:
937 *(ACPI_HANDLE *)result = ad->ad_handle;
938 break;
939 case ACPI_IVAR_MAGIC:
940 *result = ad->ad_magic;
941 break;
942 case ACPI_IVAR_PRIVATE:
943 *(void **)result = ad->ad_private;
944 break;
945 case ACPI_IVAR_FLAGS:
946 *(int *)result = ad->ad_flags;
947 break;
948 case ACPI_IVAR_RECHECK:
949 *(int *)result = ad->ad_recheck;
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 case ACPI_IVAR_RECHECK:
990 ad->ad_recheck = (int)value;
991 break;
992 default:
993 panic("bad ivar write request (%d)", index);
994 return (ENOENT);
997 return (0);
1001 * Handle child resource allocation/removal
1003 static struct resource_list *
1004 acpi_get_rlist(device_t dev, device_t child)
1006 struct acpi_device *ad;
1008 ad = device_get_ivars(child);
1009 return (&ad->ad_rl);
1013 * Pre-allocate/manage all memory and IO resources. Since rman can't handle
1014 * duplicates, we merge any in the sysresource attach routine.
1016 static int
1017 acpi_sysres_alloc(device_t dev)
1019 struct resource *res;
1020 struct resource_list *rl;
1021 struct resource_list_entry *rle;
1022 struct rman *rm;
1023 char *sysres_ids[] = { "PNP0C01", "PNP0C02", NULL };
1024 device_t *children;
1025 int child_count, i;
1027 * Probe/attach any sysresource devices. This would be unnecessary if we
1028 * had multi-pass probe/attach.
1030 if (device_get_children(dev, &children, &child_count) != 0)
1031 return (ENXIO);
1032 for (i = 0; i < child_count; i++) {
1033 if (ACPI_ID_PROBE(dev, children[i], sysres_ids) != NULL)
1034 device_probe_and_attach(children[i]);
1036 kfree(children, M_TEMP);
1038 rl = BUS_GET_RESOURCE_LIST(device_get_parent(dev), dev);
1039 if(!rl)
1040 return 0;
1041 SLIST_FOREACH(rle, rl, link) {
1042 if (rle->res != NULL) {
1043 device_printf(dev, "duplicate resource for %lx\n", rle->start);
1044 continue;
1047 /* Only memory and IO resources are valid here. */
1048 switch (rle->type) {
1049 case SYS_RES_IOPORT:
1050 rm = &acpi_rman_io;
1051 break;
1052 case SYS_RES_MEMORY:
1053 rm = &acpi_rman_mem;
1054 break;
1055 default:
1056 continue;
1059 /* Pre-allocate resource and add to our rman pool. */
1060 res = BUS_ALLOC_RESOURCE(device_get_parent(dev), dev, rle->type,
1061 &rle->rid, rle->start, rle->start + rle->count - 1, rle->count,
1062 0, -1);
1063 if (res != NULL) {
1064 rman_manage_region(rm, rman_get_start(res), rman_get_end(res));
1065 rle->res = res;
1066 } else
1067 device_printf(dev, "reservation of %lx, %lx (%d) failed\n",
1068 rle->start, rle->count, rle->type);
1070 return (0);
1073 static struct resource *
1074 acpi_alloc_resource(device_t bus, device_t child, int type, int *rid,
1075 u_long start, u_long end, u_long count, u_int flags, int cpuid)
1077 ACPI_RESOURCE ares;
1078 struct acpi_device *ad = device_get_ivars(child);
1079 struct resource_list *rl = &ad->ad_rl;
1080 struct resource_list_entry *rle;
1081 struct resource *res;
1082 struct rman *rm;
1084 res = NULL;
1086 /* We only handle memory and IO resources through rman. */
1087 switch (type) {
1088 case SYS_RES_IOPORT:
1089 rm = &acpi_rman_io;
1090 break;
1091 case SYS_RES_MEMORY:
1092 rm = &acpi_rman_mem;
1093 break;
1094 default:
1095 rm = NULL;
1098 ACPI_SERIAL_BEGIN(acpi);
1101 * If this is an allocation of the "default" range for a given RID, and
1102 * we know what the resources for this device are (i.e., they're on the
1103 * child's resource list), use those start/end values.
1105 if (bus == device_get_parent(child) && start == 0UL && end == ~0UL) {
1106 rle = resource_list_find(rl, type, *rid);
1107 if (rle == NULL)
1108 goto out;
1109 start = rle->start;
1110 end = rle->end;
1111 count = rle->count;
1112 cpuid = rle->cpuid;
1116 * If this is an allocation of a specific range, see if we can satisfy
1117 * the request from our system resource regions. If we can't, pass the
1118 * request up to the parent.
1120 if (start + count - 1 == end && rm != NULL)
1121 res = rman_reserve_resource(rm, start, end, count, flags & ~RF_ACTIVE,
1122 child);
1123 if (res == NULL) {
1124 res = BUS_ALLOC_RESOURCE(device_get_parent(bus), child, type, rid,
1125 start, end, count, flags, cpuid);
1126 } else {
1127 rman_set_rid(res, *rid);
1129 /* If requested, activate the resource using the parent's method. */
1130 if (flags & RF_ACTIVE)
1131 if (bus_activate_resource(child, type, *rid, res) != 0) {
1132 rman_release_resource(res);
1133 res = NULL;
1134 goto out;
1138 if (res != NULL && device_get_parent(child) == bus)
1139 switch (type) {
1140 case SYS_RES_IRQ:
1142 * Since bus_config_intr() takes immediate effect, we cannot
1143 * configure the interrupt associated with a device when we
1144 * parse the resources but have to defer it until a driver
1145 * actually allocates the interrupt via bus_alloc_resource().
1147 * NB: Lookup failure is fine, since the device may add its
1148 * own interrupt resources, e.g. MSI or MSI-X.
1150 if (ACPI_SUCCESS(
1151 acpi_lookup_irq_resource(child, *rid, res, &ares))) {
1152 acpi_config_intr(child, &ares);
1153 } else {
1154 kprintf("irq resource not found\n");
1156 break;
1159 out:
1160 ACPI_SERIAL_END(acpi);
1161 return (res);
1164 static int
1165 acpi_release_resource(device_t bus, device_t child, int type, int rid,
1166 struct resource *r)
1168 struct rman *rm;
1169 int ret;
1171 /* We only handle memory and IO resources through rman. */
1172 switch (type) {
1173 case SYS_RES_IOPORT:
1174 rm = &acpi_rman_io;
1175 break;
1176 case SYS_RES_MEMORY:
1177 rm = &acpi_rman_mem;
1178 break;
1179 default:
1180 rm = NULL;
1183 ACPI_SERIAL_BEGIN(acpi);
1186 * If this resource belongs to one of our internal managers,
1187 * deactivate it and release it to the local pool. If it doesn't,
1188 * pass this request up to the parent.
1190 if (rm != NULL && rman_is_region_manager(r, rm)) {
1191 if (rman_get_flags(r) & RF_ACTIVE) {
1192 ret = bus_deactivate_resource(child, type, rid, r);
1193 if (ret != 0)
1194 goto out;
1196 ret = rman_release_resource(r);
1197 } else
1198 ret = BUS_RELEASE_RESOURCE(device_get_parent(bus), child, type, rid, r);
1200 out:
1201 ACPI_SERIAL_END(acpi);
1202 return (ret);
1205 static void
1206 acpi_delete_resource(device_t bus, device_t child, int type, int rid)
1208 struct resource_list *rl;
1210 rl = acpi_get_rlist(bus, child);
1211 resource_list_delete(rl, type, rid);
1214 /* Allocate an IO port or memory resource, given its GAS. */
1216 acpi_bus_alloc_gas(device_t dev, int *type, int *rid, ACPI_GENERIC_ADDRESS *gas,
1217 struct resource **res, u_int flags)
1219 int error, res_type;
1221 error = ENOMEM;
1222 if (type == NULL || rid == NULL || gas == NULL || res == NULL)
1223 return (EINVAL);
1225 /* We only support memory and IO spaces. */
1226 switch (gas->SpaceId) {
1227 case ACPI_ADR_SPACE_SYSTEM_MEMORY:
1228 res_type = SYS_RES_MEMORY;
1229 break;
1230 case ACPI_ADR_SPACE_SYSTEM_IO:
1231 res_type = SYS_RES_IOPORT;
1232 break;
1233 default:
1234 return (EOPNOTSUPP);
1238 * If the register width is less than 8, assume the BIOS author means
1239 * it is a bit field and just allocate a byte.
1241 if (gas->BitWidth && gas->BitWidth < 8)
1242 gas->BitWidth = 8;
1244 /* Validate the address after we're sure we support the space. */
1245 if (gas->Address == 0 || gas->BitWidth == 0)
1246 return (EINVAL);
1248 bus_set_resource(dev, res_type, *rid, gas->Address,
1249 gas->BitWidth / 8, -1);
1250 *res = bus_alloc_resource_any(dev, res_type, rid, RF_ACTIVE | flags);
1251 if (*res != NULL) {
1252 *type = res_type;
1253 error = 0;
1254 } else
1255 bus_delete_resource(dev, res_type, *rid);
1257 return (error);
1260 ACPI_STATUS
1261 acpi_eval_osc(device_t dev, ACPI_HANDLE handle, const char *uuidstr,
1262 int revision, uint32_t *buf, int count)
1264 ACPI_BUFFER retbuf = { ACPI_ALLOCATE_BUFFER, NULL };
1265 ACPI_OBJECT_LIST arglist;
1266 ACPI_OBJECT arg[4];
1267 ACPI_OBJECT *retobj;
1268 ACPI_STATUS status;
1269 struct uuid uuid;
1270 uint32_t error;
1271 uint8_t oscuuid[ACPI_UUID_LENGTH];
1272 int i;
1274 if (parse_uuid(uuidstr, &uuid) != 0)
1275 return (AE_ERROR);
1276 le_uuid_enc(oscuuid, &uuid);
1278 arglist.Pointer = arg;
1279 arglist.Count = 4;
1280 arg[0].Type = ACPI_TYPE_BUFFER;
1281 arg[0].Buffer.Length = ACPI_UUID_LENGTH;
1282 arg[0].Buffer.Pointer = oscuuid; /* UUID */
1283 arg[1].Type = ACPI_TYPE_INTEGER;
1284 arg[1].Integer.Value = revision; /* revision */
1285 arg[2].Type = ACPI_TYPE_INTEGER;
1286 arg[2].Integer.Value = count; /* # of cap integers */
1287 arg[3].Type = ACPI_TYPE_BUFFER;
1288 arg[3].Buffer.Length = count * sizeof(uint32_t); /* capabilities buffer */
1289 arg[3].Buffer.Pointer = (uint8_t *)buf;
1291 status = AcpiEvaluateObject(handle, "_OSC", &arglist, &retbuf);
1292 if (ACPI_FAILURE(status))
1293 goto done;
1294 retobj = retbuf.Pointer;
1295 error = ((uint32_t *)retobj->Buffer.Pointer)[0] & ACPI_OSC_ERRMASK;
1296 if (error == 0)
1297 goto done;
1298 status = AE_ERROR;
1299 if (error & ACPI_OSCERR_FAILURE)
1300 device_printf(dev, "_OSC unable to process request\n");
1301 if (error & ACPI_OSCERR_BADUUID)
1302 device_printf(dev, "_OSC unrecognized UUID (%s)\n", uuidstr);
1303 if (error & ACPI_OSCERR_BADREV)
1304 device_printf(dev, "_OSC unrecognized revision ID (%d)\n", revision);
1305 if (error & ACPI_OSCERR_CAPSMASKED) {
1306 if ((buf[0] & ACPI_OSC_QUERY_SUPPORT) == 0) {
1307 for (i = 1; i < count; i++) {
1308 device_printf(dev,
1309 "_OSC capabilities have been masked: buf[%d]:%#x\n",
1310 i, buf[i] & ~((uint32_t *)retobj->Buffer.Pointer)[i]);
1312 status = AE_SUPPORT;
1313 } else {
1314 status = AE_OK;
1317 if (buf[0] & ACPI_OSC_QUERY_SUPPORT) {
1318 for (i = 0; i < count; i++)
1319 buf[i] = ((uint32_t *)retobj->Buffer.Pointer)[i];
1322 done:
1323 if (retbuf.Pointer != NULL)
1324 AcpiOsFree(retbuf.Pointer);
1325 return (status);
1328 /* Probe _HID and _CID for compatible ISA PNP ids. */
1329 static uint32_t
1330 acpi_isa_get_logicalid(device_t dev)
1332 ACPI_DEVICE_INFO *devinfo;
1333 ACPI_HANDLE h;
1334 uint32_t pnpid;
1336 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1338 devinfo = NULL;
1339 pnpid = 0;
1341 /* Fetch and validate the HID. */
1342 if ((h = acpi_get_handle(dev)) == NULL ||
1343 ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo)))
1344 goto out;
1346 if ((devinfo->Valid & ACPI_VALID_HID) != 0)
1347 pnpid = PNP_EISAID(devinfo->HardwareId.String);
1349 out:
1350 if (devinfo)
1351 AcpiOsFree(devinfo);
1352 return_VALUE (pnpid);
1355 static int
1356 acpi_isa_get_compatid(device_t dev, uint32_t *cids, int count)
1358 ACPI_DEVICE_INFO *devinfo;
1359 ACPI_HANDLE h;
1360 uint32_t *pnpid;
1361 int valid, i;
1363 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1365 devinfo = NULL;
1366 pnpid = cids;
1367 valid = 0;
1369 /* Fetch and validate the CID */
1370 if ((h = acpi_get_handle(dev)) == NULL ||
1371 ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo)) ||
1372 (devinfo->Valid & ACPI_VALID_CID) == 0)
1373 goto out;
1375 if (devinfo->CompatibleIdList.Count < count)
1376 count = devinfo->CompatibleIdList.Count;
1377 for (i = 0; i < count; i++) {
1378 if (strncmp(devinfo->CompatibleIdList.Ids[i].String, "PNP", 3) != 0)
1379 continue;
1380 *pnpid++ = PNP_EISAID(devinfo->CompatibleIdList.Ids[i].String);
1381 valid++;
1384 out:
1385 if (devinfo)
1386 AcpiOsFree(devinfo);
1387 return_VALUE (valid);
1390 static char *
1391 acpi_device_id_probe(device_t bus, device_t dev, char **ids)
1393 ACPI_HANDLE h;
1394 int i;
1396 h = acpi_get_handle(dev);
1397 if (ids == NULL || h == NULL || acpi_get_type(dev) != ACPI_TYPE_DEVICE)
1398 return (NULL);
1400 /* Try to match one of the array of IDs with a HID or CID. */
1401 for (i = 0; ids[i] != NULL; i++) {
1402 if (acpi_MatchHid(h, ids[i]))
1403 return (ids[i]);
1405 return (NULL);
1408 static ACPI_STATUS
1409 acpi_device_eval_obj(device_t bus, device_t dev, ACPI_STRING pathname,
1410 ACPI_OBJECT_LIST *parameters, ACPI_BUFFER *ret)
1412 ACPI_HANDLE h;
1414 if (dev == NULL)
1415 h = ACPI_ROOT_OBJECT;
1416 else if ((h = acpi_get_handle(dev)) == NULL)
1417 return (AE_BAD_PARAMETER);
1418 return (AcpiEvaluateObject(h, pathname, parameters, ret));
1421 static int
1422 acpi_device_pwr_for_sleep(device_t bus, device_t dev, int *dstate)
1424 struct acpi_softc *sc;
1425 ACPI_HANDLE handle;
1426 ACPI_STATUS status;
1427 char sxd[8];
1428 int error;
1430 sc = device_get_softc(bus);
1431 handle = acpi_get_handle(dev);
1434 * XXX If we find these devices, don't try to power them down.
1435 * The serial and IRDA ports on my T23 hang the system when
1436 * set to D3 and it appears that such legacy devices may
1437 * need special handling in their drivers.
1439 if (handle == NULL ||
1440 acpi_MatchHid(handle, "PNP0500") ||
1441 acpi_MatchHid(handle, "PNP0501") ||
1442 acpi_MatchHid(handle, "PNP0502") ||
1443 acpi_MatchHid(handle, "PNP0510") ||
1444 acpi_MatchHid(handle, "PNP0511"))
1445 return (ENXIO);
1448 * Override next state with the value from _SxD, if present. If no
1449 * dstate argument was provided, don't fetch the return value.
1451 ksnprintf(sxd, sizeof(sxd), "_S%dD", sc->acpi_sstate);
1452 if (dstate)
1453 status = acpi_GetInteger(handle, sxd, dstate);
1454 else
1455 status = AcpiEvaluateObject(handle, sxd, NULL, NULL);
1457 switch (status) {
1458 case AE_OK:
1459 error = 0;
1460 break;
1461 case AE_NOT_FOUND:
1462 error = ESRCH;
1463 break;
1464 default:
1465 error = ENXIO;
1466 break;
1469 return (error);
1472 /* Callback arg for our implementation of walking the namespace. */
1473 struct acpi_device_scan_ctx {
1474 acpi_scan_cb_t user_fn;
1475 void *arg;
1476 ACPI_HANDLE parent;
1479 static ACPI_STATUS
1480 acpi_device_scan_cb(ACPI_HANDLE h, UINT32 level, void *arg, void **retval)
1482 struct acpi_device_scan_ctx *ctx;
1483 device_t dev, old_dev;
1484 ACPI_STATUS status;
1485 ACPI_OBJECT_TYPE type;
1488 * Skip this device if we think we'll have trouble with it or it is
1489 * the parent where the scan began.
1491 ctx = (struct acpi_device_scan_ctx *)arg;
1492 if (acpi_avoid(h) || h == ctx->parent)
1493 return (AE_OK);
1495 /* If this is not a valid device type (e.g., a method), skip it. */
1496 if (ACPI_FAILURE(AcpiGetType(h, &type)))
1497 return (AE_OK);
1498 if (type != ACPI_TYPE_DEVICE && type != ACPI_TYPE_PROCESSOR &&
1499 type != ACPI_TYPE_THERMAL && type != ACPI_TYPE_POWER)
1500 return (AE_OK);
1503 * Call the user function with the current device. If it is unchanged
1504 * afterwards, return. Otherwise, we update the handle to the new dev.
1506 old_dev = acpi_get_device(h);
1507 dev = old_dev;
1508 status = ctx->user_fn(h, &dev, level, ctx->arg);
1509 if (ACPI_FAILURE(status) || old_dev == dev)
1510 return (status);
1512 /* Remove the old child and its connection to the handle. */
1513 if (old_dev != NULL) {
1514 device_delete_child(device_get_parent(old_dev), old_dev);
1515 AcpiDetachData(h, acpi_fake_objhandler);
1518 /* Recreate the handle association if the user created a device. */
1519 if (dev != NULL)
1520 AcpiAttachData(h, acpi_fake_objhandler, dev);
1522 return (AE_OK);
1525 static ACPI_STATUS
1526 acpi_device_scan_children(device_t bus, device_t dev, int max_depth,
1527 acpi_scan_cb_t user_fn, void *arg)
1529 ACPI_HANDLE h;
1530 struct acpi_device_scan_ctx ctx;
1532 if (acpi_disabled("children"))
1533 return (AE_OK);
1535 if (dev == NULL)
1536 h = ACPI_ROOT_OBJECT;
1537 else if ((h = acpi_get_handle(dev)) == NULL)
1538 return (AE_BAD_PARAMETER);
1539 ctx.user_fn = user_fn;
1540 ctx.arg = arg;
1541 ctx.parent = h;
1542 return (AcpiWalkNamespace(ACPI_TYPE_ANY, h, max_depth,
1543 acpi_device_scan_cb, NULL, &ctx, NULL));
1547 * Even though ACPI devices are not PCI, we use the PCI approach for setting
1548 * device power states since it's close enough to ACPI.
1550 static int
1551 acpi_set_powerstate_method(device_t bus, device_t child, int state)
1553 ACPI_HANDLE h;
1554 ACPI_STATUS status;
1555 int error;
1557 error = 0;
1558 h = acpi_get_handle(child);
1559 if (state < ACPI_STATE_D0 || state > ACPI_STATE_D3)
1560 return (EINVAL);
1561 if (h == NULL)
1562 return (0);
1564 /* Ignore errors if the power methods aren't present. */
1565 status = acpi_pwr_switch_consumer(h, state);
1566 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND
1567 && status != AE_BAD_PARAMETER)
1568 device_printf(bus, "failed to set ACPI power state D%d on %s: %s\n",
1569 state, acpi_name(h), AcpiFormatException(status));
1571 return (error);
1574 static int
1575 acpi_isa_pnp_probe(device_t bus, device_t child, struct isa_pnp_id *ids)
1577 int result, cid_count, i;
1578 uint32_t lid, cids[8];
1580 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1583 * ISA-style drivers attached to ACPI may persist and
1584 * probe manually if we return ENOENT. We never want
1585 * that to happen, so don't ever return it.
1587 result = ENXIO;
1589 /* Scan the supplied IDs for a match */
1590 lid = acpi_isa_get_logicalid(child);
1591 cid_count = acpi_isa_get_compatid(child, cids, 8);
1592 while (ids && ids->ip_id) {
1593 if (lid == ids->ip_id) {
1594 result = 0;
1595 goto out;
1597 for (i = 0; i < cid_count; i++) {
1598 if (cids[i] == ids->ip_id) {
1599 result = 0;
1600 goto out;
1603 ids++;
1606 out:
1607 if (result == 0 && ids->ip_desc)
1608 device_set_desc(child, ids->ip_desc);
1610 return_VALUE (result);
1614 * Look for a MCFG table. If it is present, use the settings for
1615 * domain (segment) 0 to setup PCI config space access via the memory
1616 * map.
1618 static void
1619 acpi_enable_pcie(void)
1621 ACPI_TABLE_HEADER *hdr;
1622 ACPI_MCFG_ALLOCATION *alloc, *end;
1623 ACPI_STATUS status;
1625 status = AcpiGetTable(ACPI_SIG_MCFG, 1, &hdr);
1626 if (ACPI_FAILURE(status))
1627 return;
1629 end = (ACPI_MCFG_ALLOCATION *)((char *)hdr + hdr->Length);
1630 alloc = (ACPI_MCFG_ALLOCATION *)((ACPI_TABLE_MCFG *)hdr + 1);
1631 while (alloc < end) {
1632 if (alloc->PciSegment == 0) {
1633 pcie_cfgregopen(alloc->Address, alloc->StartBusNumber,
1634 alloc->EndBusNumber);
1635 return;
1637 alloc++;
1642 * Scan all of the ACPI namespace and attach child devices.
1644 * We should only expect to find devices in the \_PR, \_TZ, \_SI, and
1645 * \_SB scopes, and \_PR and \_TZ became obsolete in the ACPI 2.0 spec.
1646 * However, in violation of the spec, some systems place their PCI link
1647 * devices in \, so we have to walk the whole namespace. We check the
1648 * type of namespace nodes, so this should be ok.
1650 static void
1651 acpi_probe_children(device_t bus)
1653 device_t *children;
1654 int cnt;
1656 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1659 * Scan the namespace and insert placeholders for all the devices that
1660 * we find. We also probe/attach any early devices.
1662 * Note that we use AcpiWalkNamespace rather than AcpiGetDevices because
1663 * we want to create nodes for all devices, not just those that are
1664 * currently present. (This assumes that we don't want to create/remove
1665 * devices as they appear, which might be smarter.)
1667 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "namespace scan\n"));
1668 AcpiWalkNamespace(ACPI_TYPE_ANY, ACPI_ROOT_OBJECT, 100,
1669 acpi_probe_child, NULL, bus, NULL);
1670 /* This gets us all the children that we added from the ACPI namespace. */
1671 device_get_children(bus, &children, &cnt);
1673 /* Pre-allocate resources for our rman from any sysresource devices. */
1674 acpi_sysres_alloc(bus);
1675 /* Create any static children by calling device identify methods. */
1676 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "device identify routines\n"));
1677 bus_generic_probe(bus);
1679 /* Probe/attach all children, created staticly and from the namespace. */
1680 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "first bus_generic_attach\n"));
1681 bus_generic_attach_gpri(bus, KOBJ_GPRI_ACPI+2);
1682 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "second bus_generic_attach\n"));
1683 bus_generic_attach_gpri(bus, KOBJ_GPRI_ACPI+1);
1684 /* Re-check device presence for previously disabled devices. */
1685 acpi_reprobe_children(bus, children, cnt);
1686 kfree(children, M_TEMP);
1687 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "third bus_generic_attach\n"));
1688 bus_generic_attach_gpri(bus, KOBJ_GPRI_ACPI);
1689 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "fourth bus_generic_attach\n"));
1690 bus_generic_attach_gpri(bus, KOBJ_GPRI_ACPI);
1693 * Some of these children may have attached others as part of their attach
1694 * process (eg. the root PCI bus driver), so rescan.
1696 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "fifth bus_generic_attach\n"));
1697 bus_generic_attach(bus);
1699 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "sixth bus_generic_attach\n"));
1700 bus_generic_attach(bus);
1702 /* Attach wake sysctls. */
1703 acpi_wake_sysctl_walk(bus);
1705 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "done attaching children\n"));
1706 return_VOID;
1710 * Determine the probe order for a given device.
1712 static void
1713 acpi_probe_order(ACPI_HANDLE handle, int *order)
1715 ACPI_OBJECT_TYPE type;
1718 * 1. I/O port and memory system resource holders
1719 * 2. Embedded controllers (to handle early accesses)
1720 * 3. PCI Link Devices
1721 * 100000. CPUs
1723 AcpiGetType(handle, &type);
1724 if (acpi_MatchHid(handle, "PNP0C01") || acpi_MatchHid(handle, "PNP0C02"))
1725 *order = 1;
1726 else if (acpi_MatchHid(handle, "PNP0C09"))
1727 *order = 2;
1728 else if (acpi_MatchHid(handle, "PNP0C0F"))
1729 *order = 3;
1730 else if (type == ACPI_TYPE_PROCESSOR)
1731 *order = 100000;
1735 * Flag a device as disabled, because it isn't present according to the
1736 * _STA method. We set the recheck instance-variable, to make sure that we
1737 * recheck the device presence at a later point.
1739 static void
1740 acpi_disable_not_present(device_t child)
1742 device_disable(child);
1743 acpi_set_recheck(child, 1);
1747 * This rechecks the device presence for all the devices which were disabled
1748 * using acpi_disable_not_present().
1750 static void
1751 acpi_reprobe_children(device_t bus, device_t *children, int cnt)
1753 int i;
1755 for (i = 0; i < cnt; i++) {
1756 device_t dev = children[i];
1758 if (device_is_enabled(dev))
1759 continue;
1761 if (acpi_get_recheck(dev)) {
1762 if (acpi_DeviceIsPresent(dev)) {
1763 acpi_set_recheck(dev, 0);
1764 device_enable(dev);
1766 * Currently we parse the resources for every
1767 * device at the first time, when we see
1768 * that it is present.
1770 acpi_parse_resources(dev, acpi_get_handle(dev),
1771 &acpi_res_parse_set, NULL);
1778 * Evaluate a child device and determine whether we might attach a device to
1779 * it.
1781 static ACPI_STATUS
1782 acpi_probe_child(ACPI_HANDLE handle, UINT32 level, void *context, void **status)
1784 struct acpi_prw_data prw;
1785 ACPI_OBJECT_TYPE type;
1786 ACPI_HANDLE h;
1787 device_t bus, child;
1788 int order;
1789 char *handle_str;
1791 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1793 if (acpi_disabled("children"))
1794 return_ACPI_STATUS (AE_OK);
1796 /* Skip this device if we think we'll have trouble with it. */
1797 if (acpi_avoid(handle))
1798 return_ACPI_STATUS (AE_OK);
1800 bus = (device_t)context;
1801 if (ACPI_SUCCESS(AcpiGetType(handle, &type))) {
1802 handle_str = acpi_name(handle);
1803 switch (type) {
1804 case ACPI_TYPE_DEVICE:
1806 * Since we scan from \, be sure to skip system scope objects.
1807 * \_SB_ and \_TZ_ are defined in ACPICA as devices to work around
1808 * BIOS bugs. For example, \_SB_ is to allow \_SB_._INI to be run
1809 * during the intialization and \_TZ_ is to support Notify() on it.
1811 if (strcmp(handle_str, "\\_SB_") == 0 ||
1812 strcmp(handle_str, "\\_TZ_") == 0)
1813 break;
1815 if (acpi_parse_prw(handle, &prw) == 0)
1816 AcpiSetupGpeForWake(handle, prw.gpe_handle, prw.gpe_bit);
1818 /* FALLTHROUGH */
1819 case ACPI_TYPE_PROCESSOR:
1820 case ACPI_TYPE_THERMAL:
1821 case ACPI_TYPE_POWER:
1823 * Create a placeholder device for this node. Sort the
1824 * placeholder so that the probe/attach passes will run
1825 * breadth-first. Orders less than ACPI_DEV_BASE_ORDER
1826 * are reserved for special objects (i.e., system
1827 * resources). CPU devices have a very high order to
1828 * ensure they are probed after other devices.
1830 ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "scanning '%s'\n", handle_str));
1831 order = level * 10 + 100;
1832 acpi_probe_order(handle, &order);
1833 child = BUS_ADD_CHILD(bus, bus, order, NULL, -1);
1834 if (child == NULL)
1835 break;
1837 /* Associate the handle with the device_t and vice versa. */
1838 acpi_set_handle(child, handle);
1839 AcpiAttachData(handle, acpi_fake_objhandler, child);
1842 * Check that the device is present. If it's not present,
1843 * leave it disabled (so that we have a device_t attached to
1844 * the handle, but we don't probe it).
1846 * XXX PCI link devices sometimes report "present" but not
1847 * "functional" (i.e. if disabled). Go ahead and probe them
1848 * anyway since we may enable them later.
1850 if (type == ACPI_TYPE_DEVICE && !acpi_DeviceIsPresent(child)) {
1851 /* Never disable PCI link devices. */
1852 if (acpi_MatchHid(handle, "PNP0C0F"))
1853 break;
1855 * Docking stations should remain enabled since the system
1856 * may be undocked at boot.
1858 if (ACPI_SUCCESS(AcpiGetHandle(handle, "_DCK", &h)))
1859 break;
1861 acpi_disable_not_present(child);
1862 break;
1866 * Get the device's resource settings and attach them.
1867 * Note that if the device has _PRS but no _CRS, we need
1868 * to decide when it's appropriate to try to configure the
1869 * device. Ignore the return value here; it's OK for the
1870 * device not to have any resources.
1872 acpi_parse_resources(child, handle, &acpi_res_parse_set, NULL);
1873 break;
1877 return_ACPI_STATUS (AE_OK);
1881 * AcpiAttachData() requires an object handler but never uses it. This is a
1882 * placeholder object handler so we can store a device_t in an ACPI_HANDLE.
1884 void
1885 acpi_fake_objhandler(ACPI_HANDLE h, void *data)
1889 static void
1890 acpi_shutdown_final(void *arg, int howto)
1892 struct acpi_softc *sc;
1893 ACPI_STATUS status;
1896 * XXX Shutdown code should only run on the BSP (cpuid 0).
1897 * Some chipsets do not power off the system correctly if called from
1898 * an AP.
1900 sc = arg;
1901 if ((howto & RB_POWEROFF) != 0) {
1902 status = AcpiEnterSleepStatePrep(ACPI_STATE_S5);
1903 if (ACPI_FAILURE(status)) {
1904 device_printf(sc->acpi_dev, "AcpiEnterSleepStatePrep failed - %s\n",
1905 AcpiFormatException(status));
1906 return;
1908 device_printf(sc->acpi_dev, "Powering system off\n");
1909 ACPI_DISABLE_IRQS();
1910 status = AcpiEnterSleepState(ACPI_STATE_S5);
1911 if (ACPI_FAILURE(status)) {
1912 device_printf(sc->acpi_dev, "power-off failed - %s\n",
1913 AcpiFormatException(status));
1914 } else {
1915 DELAY(1000000);
1916 device_printf(sc->acpi_dev, "power-off failed - timeout\n");
1918 } else if ((howto & RB_HALT) == 0 && sc->acpi_handle_reboot) {
1919 /* Reboot using the reset register. */
1920 status = AcpiReset();
1921 if (ACPI_FAILURE(status)) {
1922 if (status != AE_NOT_EXIST)
1923 device_printf(sc->acpi_dev, "reset failed - %s\n",
1924 AcpiFormatException(status));
1925 } else {
1926 DELAY(1000000);
1927 device_printf(sc->acpi_dev, "reset failed - timeout\n");
1929 } else if (sc->acpi_do_disable && panicstr == NULL) {
1931 * Only disable ACPI if the user requested. On some systems, writing
1932 * the disable value to SMI_CMD hangs the system.
1934 device_printf(sc->acpi_dev, "Shutting down\n");
1935 AcpiTerminate();
1939 static void
1940 acpi_enable_fixed_events(struct acpi_softc *sc)
1942 static int first_time = 1;
1944 /* Enable and clear fixed events and install handlers. */
1945 if ((AcpiGbl_FADT.Flags & ACPI_FADT_POWER_BUTTON) == 0) {
1946 AcpiClearEvent(ACPI_EVENT_POWER_BUTTON);
1947 AcpiInstallFixedEventHandler(ACPI_EVENT_POWER_BUTTON,
1948 acpi_event_power_button_sleep, sc);
1949 if (first_time)
1950 device_printf(sc->acpi_dev, "Power Button (fixed)\n");
1952 if ((AcpiGbl_FADT.Flags & ACPI_FADT_SLEEP_BUTTON) == 0) {
1953 AcpiClearEvent(ACPI_EVENT_SLEEP_BUTTON);
1954 AcpiInstallFixedEventHandler(ACPI_EVENT_SLEEP_BUTTON,
1955 acpi_event_sleep_button_sleep, sc);
1956 if (first_time)
1957 device_printf(sc->acpi_dev, "Sleep Button (fixed)\n");
1960 first_time = 0;
1964 * Returns true if the device is actually present and should
1965 * be attached to. This requires the present, enabled, UI-visible
1966 * and diagnostics-passed bits to be set.
1968 BOOLEAN
1969 acpi_DeviceIsPresent(device_t dev)
1971 ACPI_HANDLE h;
1972 UINT32 s;
1973 ACPI_STATUS status;
1975 h = acpi_get_handle(dev);
1976 if (h == NULL)
1977 return (FALSE);
1978 status = acpi_GetInteger(h, "_STA", &s);
1981 * If no _STA method or if it failed, then assume that
1982 * the device is present.
1984 if (ACPI_FAILURE(status))
1985 return (TRUE);
1987 return (ACPI_DEVICE_PRESENT(s) ? TRUE : FALSE);
1991 * Returns true if the battery is actually present and inserted.
1993 BOOLEAN
1994 acpi_BatteryIsPresent(device_t dev)
1996 ACPI_HANDLE h;
1997 UINT32 s;
1998 ACPI_STATUS status;
2000 h = acpi_get_handle(dev);
2001 if (h == NULL)
2002 return (FALSE);
2003 status = acpi_GetInteger(h, "_STA", &s);
2006 * If no _STA method or if it failed, then assume that
2007 * the device is present.
2009 if (ACPI_FAILURE(status))
2010 return (TRUE);
2012 return (ACPI_BATTERY_PRESENT(s) ? TRUE : FALSE);
2016 * Match a HID string against a handle
2018 BOOLEAN
2019 acpi_MatchHid(ACPI_HANDLE h, const char *hid)
2021 ACPI_DEVICE_INFO *devinfo;
2022 int ret, i;
2024 ret = FALSE;
2025 if (hid == NULL || h == NULL ||
2026 ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo)))
2027 return (ret);
2029 if ((devinfo->Valid & ACPI_VALID_HID) != 0 &&
2030 strcmp(hid, devinfo->HardwareId.String) == 0)
2031 ret = TRUE;
2032 else if ((devinfo->Valid & ACPI_VALID_CID) != 0) {
2033 for (i = 0; i < devinfo->CompatibleIdList.Count; i++) {
2034 if (strcmp(hid, devinfo->CompatibleIdList.Ids[i].String) == 0) {
2035 ret = TRUE;
2036 break;
2041 AcpiOsFree(devinfo);
2042 return (ret);
2046 * Match a UID string against a handle
2048 BOOLEAN
2049 acpi_MatchUid(ACPI_HANDLE h, const char *uid)
2051 ACPI_DEVICE_INFO *devinfo;
2052 int ret;
2054 ret = FALSE;
2055 if (uid == NULL || h == NULL ||
2056 ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo)))
2057 return (ret);
2059 if ((devinfo->Valid & ACPI_VALID_UID) != 0 &&
2060 strcmp(uid, devinfo->UniqueId.String) == 0)
2061 ret = TRUE;
2063 AcpiOsFree(devinfo);
2064 return (ret);
2068 * Return the handle of a named object within our scope, ie. that of (parent)
2069 * or one if its parents.
2071 ACPI_STATUS
2072 acpi_GetHandleInScope(ACPI_HANDLE parent, char *path, ACPI_HANDLE *result)
2074 ACPI_HANDLE r;
2075 ACPI_STATUS status;
2077 /* Walk back up the tree to the root */
2078 for (;;) {
2079 status = AcpiGetHandle(parent, path, &r);
2080 if (ACPI_SUCCESS(status)) {
2081 *result = r;
2082 return (AE_OK);
2084 /* XXX Return error here? */
2085 if (status != AE_NOT_FOUND)
2086 return (AE_OK);
2087 if (ACPI_FAILURE(AcpiGetParent(parent, &r)))
2088 return (AE_NOT_FOUND);
2089 parent = r;
2094 * Allocate a buffer with a preset data size.
2096 ACPI_BUFFER *
2097 acpi_AllocBuffer(int size)
2099 ACPI_BUFFER *buf;
2101 if ((buf = kmalloc(size + sizeof(*buf), M_ACPIDEV, M_NOWAIT)) == NULL)
2102 return (NULL);
2103 buf->Length = size;
2104 buf->Pointer = (void *)(buf + 1);
2105 return (buf);
2108 ACPI_STATUS
2109 acpi_SetInteger(ACPI_HANDLE handle, char *path, UINT32 number)
2111 ACPI_OBJECT arg1;
2112 ACPI_OBJECT_LIST args;
2114 arg1.Type = ACPI_TYPE_INTEGER;
2115 arg1.Integer.Value = number;
2116 args.Count = 1;
2117 args.Pointer = &arg1;
2119 return (AcpiEvaluateObject(handle, path, &args, NULL));
2123 * Evaluate a path that should return an integer.
2125 ACPI_STATUS
2126 acpi_GetInteger(ACPI_HANDLE handle, char *path, UINT32 *number)
2128 ACPI_STATUS status;
2129 ACPI_BUFFER buf;
2130 ACPI_OBJECT param;
2132 if (handle == NULL)
2133 handle = ACPI_ROOT_OBJECT;
2136 * Assume that what we've been pointed at is an Integer object, or
2137 * a method that will return an Integer.
2139 buf.Pointer = &param;
2140 buf.Length = sizeof(param);
2141 status = AcpiEvaluateObject(handle, path, NULL, &buf);
2142 if (ACPI_SUCCESS(status)) {
2143 if (param.Type == ACPI_TYPE_INTEGER)
2144 *number = param.Integer.Value;
2145 else
2146 status = AE_TYPE;
2150 * In some applications, a method that's expected to return an Integer
2151 * may instead return a Buffer (probably to simplify some internal
2152 * arithmetic). We'll try to fetch whatever it is, and if it's a Buffer,
2153 * convert it into an Integer as best we can.
2155 * This is a hack.
2157 if (status == AE_BUFFER_OVERFLOW) {
2158 if ((buf.Pointer = AcpiOsAllocate(buf.Length)) == NULL) {
2159 status = AE_NO_MEMORY;
2160 } else {
2161 status = AcpiEvaluateObject(handle, path, NULL, &buf);
2162 if (ACPI_SUCCESS(status))
2163 status = acpi_ConvertBufferToInteger(&buf, number);
2164 AcpiOsFree(buf.Pointer);
2167 return (status);
2170 ACPI_STATUS
2171 acpi_ConvertBufferToInteger(ACPI_BUFFER *bufp, UINT32 *number)
2173 ACPI_OBJECT *p;
2174 UINT8 *val;
2175 int i;
2177 p = (ACPI_OBJECT *)bufp->Pointer;
2178 if (p->Type == ACPI_TYPE_INTEGER) {
2179 *number = p->Integer.Value;
2180 return (AE_OK);
2182 if (p->Type != ACPI_TYPE_BUFFER)
2183 return (AE_TYPE);
2184 if (p->Buffer.Length > sizeof(int))
2185 return (AE_BAD_DATA);
2187 *number = 0;
2188 val = p->Buffer.Pointer;
2189 for (i = 0; i < p->Buffer.Length; i++)
2190 *number += val[i] << (i * 8);
2191 return (AE_OK);
2195 * Iterate over the elements of an a package object, calling the supplied
2196 * function for each element.
2198 * XXX possible enhancement might be to abort traversal on error.
2200 ACPI_STATUS
2201 acpi_ForeachPackageObject(ACPI_OBJECT *pkg,
2202 void (*func)(ACPI_OBJECT *comp, void *arg), void *arg)
2204 ACPI_OBJECT *comp;
2205 int i;
2207 if (pkg == NULL || pkg->Type != ACPI_TYPE_PACKAGE)
2208 return (AE_BAD_PARAMETER);
2210 /* Iterate over components */
2211 i = 0;
2212 comp = pkg->Package.Elements;
2213 for (; i < pkg->Package.Count; i++, comp++)
2214 func(comp, arg);
2216 return (AE_OK);
2220 * Find the (index)th resource object in a set.
2222 ACPI_STATUS
2223 acpi_FindIndexedResource(ACPI_BUFFER *buf, int index, ACPI_RESOURCE **resp)
2225 ACPI_RESOURCE *rp;
2226 int i;
2228 rp = (ACPI_RESOURCE *)buf->Pointer;
2229 i = index;
2230 while (i-- > 0) {
2231 /* Range check */
2232 if (rp > (ACPI_RESOURCE *)((uint8_t *)buf->Pointer + buf->Length))
2233 return (AE_BAD_PARAMETER);
2235 /* Check for terminator */
2236 if (rp->Type == ACPI_RESOURCE_TYPE_END_TAG || rp->Length == 0)
2237 return (AE_NOT_FOUND);
2238 rp = ACPI_NEXT_RESOURCE(rp);
2240 if (resp != NULL)
2241 *resp = rp;
2243 return (AE_OK);
2247 * Append an ACPI_RESOURCE to an ACPI_BUFFER.
2249 * Given a pointer to an ACPI_RESOURCE structure, expand the ACPI_BUFFER
2250 * provided to contain it. If the ACPI_BUFFER is empty, allocate a sensible
2251 * backing block. If the ACPI_RESOURCE is NULL, return an empty set of
2252 * resources.
2254 #define ACPI_INITIAL_RESOURCE_BUFFER_SIZE 512
2256 ACPI_STATUS
2257 acpi_AppendBufferResource(ACPI_BUFFER *buf, ACPI_RESOURCE *res)
2259 ACPI_RESOURCE *rp;
2260 void *newp;
2262 /* Initialise the buffer if necessary. */
2263 if (buf->Pointer == NULL) {
2264 buf->Length = ACPI_INITIAL_RESOURCE_BUFFER_SIZE;
2265 if ((buf->Pointer = AcpiOsAllocate(buf->Length)) == NULL)
2266 return (AE_NO_MEMORY);
2267 rp = (ACPI_RESOURCE *)buf->Pointer;
2268 rp->Type = ACPI_RESOURCE_TYPE_END_TAG;
2269 rp->Length = ACPI_RS_SIZE_MIN;
2271 if (res == NULL)
2272 return (AE_OK);
2275 * Scan the current buffer looking for the terminator.
2276 * This will either find the terminator or hit the end
2277 * of the buffer and return an error.
2279 rp = (ACPI_RESOURCE *)buf->Pointer;
2280 for (;;) {
2281 /* Range check, don't go outside the buffer */
2282 if (rp >= (ACPI_RESOURCE *)((uint8_t *)buf->Pointer + buf->Length))
2283 return (AE_BAD_PARAMETER);
2284 if (rp->Type == ACPI_RESOURCE_TYPE_END_TAG || rp->Length == 0)
2285 break;
2286 rp = ACPI_NEXT_RESOURCE(rp);
2290 * Check the size of the buffer and expand if required.
2292 * Required size is:
2293 * size of existing resources before terminator +
2294 * size of new resource and header +
2295 * size of terminator.
2297 * Note that this loop should really only run once, unless
2298 * for some reason we are stuffing a *really* huge resource.
2300 while ((((uint8_t *)rp - (uint8_t *)buf->Pointer) +
2301 res->Length + ACPI_RS_SIZE_NO_DATA +
2302 ACPI_RS_SIZE_MIN) >= buf->Length) {
2303 if ((newp = AcpiOsAllocate(buf->Length * 2)) == NULL)
2304 return (AE_NO_MEMORY);
2305 bcopy(buf->Pointer, newp, buf->Length);
2306 rp = (ACPI_RESOURCE *)((uint8_t *)newp +
2307 ((uint8_t *)rp - (uint8_t *)buf->Pointer));
2308 AcpiOsFree(buf->Pointer);
2309 buf->Pointer = newp;
2310 buf->Length += buf->Length;
2313 /* Insert the new resource. */
2314 bcopy(res, rp, res->Length + ACPI_RS_SIZE_NO_DATA);
2316 /* And add the terminator. */
2317 rp = ACPI_NEXT_RESOURCE(rp);
2318 rp->Type = ACPI_RESOURCE_TYPE_END_TAG;
2319 rp->Length = ACPI_RS_SIZE_MIN;
2321 return (AE_OK);
2325 * Set interrupt model.
2327 ACPI_STATUS
2328 acpi_SetIntrModel(int model)
2331 return (acpi_SetInteger(ACPI_ROOT_OBJECT, "_PIC", model));
2335 * DEPRECATED. This interface has serious deficiencies and will be
2336 * removed.
2338 * Immediately enter the sleep state. In the old model, acpiconf(8) ran
2339 * rc.suspend and rc.resume so we don't have to notify devd(8) to do this.
2341 ACPI_STATUS
2342 acpi_SetSleepState(struct acpi_softc *sc, int state)
2344 static int once;
2346 if (!once) {
2347 device_printf(sc->acpi_dev,
2348 "warning: acpi_SetSleepState() deprecated, need to update your software\n");
2349 once = 1;
2351 return (acpi_EnterSleepState(sc, state));
2354 static void
2355 acpi_sleep_force(void *arg)
2357 struct acpi_softc *sc;
2359 sc = arg;
2360 device_printf(sc->acpi_dev,
2361 "suspend request timed out, forcing sleep now\n");
2362 if (ACPI_FAILURE(acpi_EnterSleepState(sc, sc->acpi_next_sstate)))
2363 device_printf(sc->acpi_dev, "force sleep state S%d failed\n",
2364 sc->acpi_next_sstate);
2368 * Request that the system enter the given suspend state. All /dev/apm
2369 * devices and devd(8) will be notified. Userland then has a chance to
2370 * save state and acknowledge the request. The system sleeps once all
2371 * acks are in.
2374 acpi_ReqSleepState(struct acpi_softc *sc, int state)
2376 #ifdef notyet
2377 struct apm_clone_data *clone;
2378 #endif
2380 if (state < ACPI_STATE_S1 || state > ACPI_STATE_S5)
2381 return (EINVAL);
2383 /* S5 (soft-off) should be entered directly with no waiting. */
2384 if (state == ACPI_STATE_S5) {
2385 if (ACPI_SUCCESS(acpi_EnterSleepState(sc, state)))
2386 return (0);
2387 else
2388 return (ENXIO);
2391 /* This platform does not support acpi suspend/resume. */
2392 return (EOPNOTSUPP);
2394 /* If a suspend request is already in progress, just return. */
2395 ACPI_LOCK(acpi);
2396 if (sc->acpi_next_sstate != 0) {
2397 ACPI_UNLOCK(acpi);
2398 return (0);
2401 /* Record the pending state and notify all apm devices. */
2402 sc->acpi_next_sstate = state;
2403 #if 0
2404 STAILQ_FOREACH(clone, &sc->apm_cdevs, entries) {
2405 clone->notify_status = APM_EV_NONE;
2406 if ((clone->flags & ACPI_EVF_DEVD) == 0) {
2407 KNOTE(&clone->sel_read.si_note, 0);
2410 #endif
2412 /* If devd(8) is not running, immediately enter the sleep state. */
2413 if (devctl_process_running() == FALSE) {
2414 ACPI_UNLOCK(acpi);
2415 if (ACPI_SUCCESS(acpi_EnterSleepState(sc, sc->acpi_next_sstate))) {
2416 return (0);
2417 } else {
2418 return (ENXIO);
2422 /* Now notify devd(8) also. */
2423 acpi_UserNotify("Suspend", ACPI_ROOT_OBJECT, state);
2426 * Set a timeout to fire if userland doesn't ack the suspend request
2427 * in time. This way we still eventually go to sleep if we were
2428 * overheating or running low on battery, even if userland is hung.
2429 * We cancel this timeout once all userland acks are in or the
2430 * suspend request is aborted.
2432 callout_reset(&sc->susp_force_to, 10 * hz, acpi_sleep_force, sc);
2433 ACPI_UNLOCK(acpi);
2435 return (0);
2439 * Acknowledge (or reject) a pending sleep state. The caller has
2440 * prepared for suspend and is now ready for it to proceed. If the
2441 * error argument is non-zero, it indicates suspend should be cancelled
2442 * and gives an errno value describing why. Once all votes are in,
2443 * we suspend the system.
2446 acpi_AckSleepState(struct apm_clone_data *clone, int error)
2448 struct acpi_softc *sc;
2449 int ret, sleeping;
2451 /* This platform does not support acpi suspend/resume. */
2452 return (EOPNOTSUPP);
2454 /* If no pending sleep state, return an error. */
2455 ACPI_LOCK(acpi);
2456 sc = clone->acpi_sc;
2457 if (sc->acpi_next_sstate == 0) {
2458 ACPI_UNLOCK(acpi);
2459 return (ENXIO);
2462 /* Caller wants to abort suspend process. */
2463 if (error) {
2464 sc->acpi_next_sstate = 0;
2465 callout_stop(&sc->susp_force_to);
2466 device_printf(sc->acpi_dev,
2467 "listener on %s cancelled the pending suspend\n",
2468 devtoname(clone->cdev));
2469 ACPI_UNLOCK(acpi);
2470 return (0);
2474 * Mark this device as acking the suspend request. Then, walk through
2475 * all devices, seeing if they agree yet. We only count devices that
2476 * are writable since read-only devices couldn't ack the request.
2478 clone->notify_status = APM_EV_ACKED;
2479 sleeping = TRUE;
2480 STAILQ_FOREACH(clone, &sc->apm_cdevs, entries) {
2481 if ((clone->flags & ACPI_EVF_WRITE) != 0 &&
2482 clone->notify_status != APM_EV_ACKED) {
2483 sleeping = FALSE;
2484 break;
2488 /* If all devices have voted "yes", we will suspend now. */
2489 if (sleeping)
2490 callout_stop(&sc->susp_force_to);
2491 ACPI_UNLOCK(acpi);
2492 ret = 0;
2493 if (sleeping) {
2494 if (ACPI_FAILURE(acpi_EnterSleepState(sc, sc->acpi_next_sstate)))
2495 ret = ENODEV;
2498 return (ret);
2501 static void
2502 acpi_sleep_enable(void *arg)
2504 ((struct acpi_softc *)arg)->acpi_sleep_disabled = 0;
2507 enum acpi_sleep_state {
2508 ACPI_SS_NONE,
2509 ACPI_SS_GPE_SET,
2510 ACPI_SS_DEV_SUSPEND,
2511 ACPI_SS_SLP_PREP,
2512 ACPI_SS_SLEPT,
2516 * Enter the desired system sleep state.
2518 * Currently we support S1-S5 but S4 is only S4BIOS
2520 static ACPI_STATUS
2521 acpi_EnterSleepState(struct acpi_softc *sc, int state)
2523 ACPI_STATUS status;
2524 UINT8 TypeA;
2525 UINT8 TypeB;
2526 enum acpi_sleep_state slp_state;
2528 ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, state);
2530 /* Re-entry once we're suspending is not allowed. */
2531 status = AE_OK;
2532 ACPI_LOCK(acpi);
2533 if (sc->acpi_sleep_disabled) {
2534 ACPI_UNLOCK(acpi);
2535 device_printf(sc->acpi_dev,
2536 "suspend request ignored (not ready yet)\n");
2537 return (AE_ERROR);
2539 sc->acpi_sleep_disabled = 1;
2540 ACPI_UNLOCK(acpi);
2543 * Be sure to hold Giant across DEVICE_SUSPEND/RESUME since non-MPSAFE
2544 * drivers need this.
2546 //get_mplock();
2548 slp_state = ACPI_SS_NONE;
2549 switch (state) {
2550 case ACPI_STATE_S1:
2551 case ACPI_STATE_S2:
2552 case ACPI_STATE_S3:
2553 case ACPI_STATE_S4:
2554 status = AcpiGetSleepTypeData(state, &TypeA, &TypeB);
2555 if (status == AE_NOT_FOUND) {
2556 device_printf(sc->acpi_dev,
2557 "Sleep state S%d not supported by BIOS\n", state);
2558 break;
2559 } else if (ACPI_FAILURE(status)) {
2560 device_printf(sc->acpi_dev, "AcpiGetSleepTypeData failed - %s\n",
2561 AcpiFormatException(status));
2562 break;
2565 sc->acpi_sstate = state;
2567 /* Enable any GPEs as appropriate and requested by the user. */
2568 acpi_wake_prep_walk(state);
2569 slp_state = ACPI_SS_GPE_SET;
2572 * Inform all devices that we are going to sleep. If at least one
2573 * device fails, DEVICE_SUSPEND() automatically resumes the tree.
2575 * XXX Note that a better two-pass approach with a 'veto' pass
2576 * followed by a "real thing" pass would be better, but the current
2577 * bus interface does not provide for this.
2579 if (DEVICE_SUSPEND(root_bus) != 0) {
2580 device_printf(sc->acpi_dev, "device_suspend failed\n");
2581 break;
2583 slp_state = ACPI_SS_DEV_SUSPEND;
2585 /* If testing device suspend only, back out of everything here. */
2586 if (acpi_susp_bounce)
2587 break;
2589 status = AcpiEnterSleepStatePrep(state);
2590 if (ACPI_FAILURE(status)) {
2591 device_printf(sc->acpi_dev, "AcpiEnterSleepStatePrep failed - %s\n",
2592 AcpiFormatException(status));
2593 break;
2595 slp_state = ACPI_SS_SLP_PREP;
2597 if (sc->acpi_sleep_delay > 0)
2598 DELAY(sc->acpi_sleep_delay * 1000000);
2600 if (state != ACPI_STATE_S1) {
2601 acpi_sleep_machdep(sc, state);
2603 /* Re-enable ACPI hardware on wakeup from sleep state 4. */
2604 if (state == ACPI_STATE_S4)
2605 AcpiEnable();
2606 } else {
2607 ACPI_DISABLE_IRQS();
2608 status = AcpiEnterSleepState(state);
2609 if (ACPI_FAILURE(status)) {
2610 device_printf(sc->acpi_dev, "AcpiEnterSleepState failed - %s\n",
2611 AcpiFormatException(status));
2612 break;
2615 slp_state = ACPI_SS_SLEPT;
2616 break;
2617 case ACPI_STATE_S5:
2619 * Shut down cleanly and power off. This will call us back through the
2620 * shutdown handlers.
2622 shutdown_nice(RB_POWEROFF);
2623 break;
2624 case ACPI_STATE_S0:
2625 default:
2626 status = AE_BAD_PARAMETER;
2627 break;
2631 * Back out state according to how far along we got in the suspend
2632 * process. This handles both the error and success cases.
2634 sc->acpi_next_sstate = 0;
2635 if (slp_state >= ACPI_SS_GPE_SET) {
2636 acpi_wake_prep_walk(state);
2637 sc->acpi_sstate = ACPI_STATE_S0;
2639 if (slp_state >= ACPI_SS_SLP_PREP)
2640 AcpiLeaveSleepState(state);
2641 if (slp_state >= ACPI_SS_DEV_SUSPEND)
2642 DEVICE_RESUME(root_bus);
2643 if (slp_state >= ACPI_SS_SLEPT)
2644 acpi_enable_fixed_events(sc);
2646 /* Allow another sleep request after a while. */
2647 /* XXX: needs timeout */
2648 if (state != ACPI_STATE_S5)
2649 acpi_sleep_enable(sc);
2651 /* Run /etc/rc.resume after we are back. */
2652 acpi_UserNotify("Resume", ACPI_ROOT_OBJECT, state);
2654 //rel_mplock();
2656 return_ACPI_STATUS (status);
2659 /* Enable or disable the device's GPE. */
2661 acpi_wake_set_enable(device_t dev, int enable)
2663 struct acpi_prw_data prw;
2664 ACPI_STATUS status;
2665 int flags;
2667 /* Make sure the device supports waking the system and get the GPE. */
2668 if (acpi_parse_prw(acpi_get_handle(dev), &prw) != 0)
2669 return (ENXIO);
2671 flags = acpi_get_flags(dev);
2672 if (enable) {
2673 status = AcpiSetGpeWakeMask(prw.gpe_handle, prw.gpe_bit,
2674 ACPI_GPE_ENABLE);
2675 if (ACPI_FAILURE(status)) {
2676 device_printf(dev, "enable wake failed\n");
2677 return (ENXIO);
2679 acpi_set_flags(dev, flags | ACPI_FLAG_WAKE_ENABLED);
2680 } else {
2681 status = AcpiSetGpeWakeMask(prw.gpe_handle, prw.gpe_bit,
2682 ACPI_GPE_DISABLE);
2683 if (ACPI_FAILURE(status)) {
2684 device_printf(dev, "disable wake failed\n");
2685 return (ENXIO);
2687 acpi_set_flags(dev, flags & ~ACPI_FLAG_WAKE_ENABLED);
2690 return (0);
2693 static int
2694 acpi_wake_sleep_prep(ACPI_HANDLE handle, int sstate)
2696 struct acpi_prw_data prw;
2697 device_t dev;
2699 /* Check that this is a wake-capable device and get its GPE. */
2700 if (acpi_parse_prw(handle, &prw) != 0)
2701 return (ENXIO);
2702 dev = acpi_get_device(handle);
2705 * The destination sleep state must be less than (i.e., higher power)
2706 * or equal to the value specified by _PRW. If this GPE cannot be
2707 * enabled for the next sleep state, then disable it. If it can and
2708 * the user requested it be enabled, turn on any required power resources
2709 * and set _PSW.
2711 if (sstate > prw.lowest_wake) {
2712 AcpiSetGpeWakeMask(prw.gpe_handle, prw.gpe_bit, ACPI_GPE_DISABLE);
2713 if (bootverbose)
2714 device_printf(dev, "wake_prep disabled wake for %s (S%d)\n",
2715 acpi_name(handle), sstate);
2716 } else if (dev && (acpi_get_flags(dev) & ACPI_FLAG_WAKE_ENABLED) != 0) {
2717 acpi_pwr_wake_enable(handle, 1);
2718 acpi_SetInteger(handle, "_PSW", 1);
2719 if (bootverbose)
2720 device_printf(dev, "wake_prep enabled for %s (S%d)\n",
2721 acpi_name(handle), sstate);
2724 return (0);
2727 static int
2728 acpi_wake_run_prep(ACPI_HANDLE handle, int sstate)
2730 struct acpi_prw_data prw;
2731 device_t dev;
2734 * Check that this is a wake-capable device and get its GPE. Return
2735 * now if the user didn't enable this device for wake.
2737 if (acpi_parse_prw(handle, &prw) != 0)
2738 return (ENXIO);
2739 dev = acpi_get_device(handle);
2740 if (dev == NULL || (acpi_get_flags(dev) & ACPI_FLAG_WAKE_ENABLED) == 0)
2741 return (0);
2744 * If this GPE couldn't be enabled for the previous sleep state, it was
2745 * disabled before going to sleep so re-enable it. If it was enabled,
2746 * clear _PSW and turn off any power resources it used.
2748 if (sstate > prw.lowest_wake) {
2749 AcpiSetGpeWakeMask(prw.gpe_handle, prw.gpe_bit, ACPI_GPE_ENABLE);
2750 if (bootverbose)
2751 device_printf(dev, "run_prep re-enabled %s\n", acpi_name(handle));
2752 } else {
2753 acpi_SetInteger(handle, "_PSW", 0);
2754 acpi_pwr_wake_enable(handle, 0);
2755 if (bootverbose)
2756 device_printf(dev, "run_prep cleaned up for %s\n",
2757 acpi_name(handle));
2760 return (0);
2763 static ACPI_STATUS
2764 acpi_wake_prep(ACPI_HANDLE handle, UINT32 level, void *context, void **status)
2766 int sstate;
2768 /* If suspending, run the sleep prep function, otherwise wake. */
2769 sstate = *(int *)context;
2770 if (AcpiGbl_SystemAwakeAndRunning)
2771 acpi_wake_sleep_prep(handle, sstate);
2772 else
2773 acpi_wake_run_prep(handle, sstate);
2774 return (AE_OK);
2777 /* Walk the tree rooted at acpi0 to prep devices for suspend/resume. */
2778 static int
2779 acpi_wake_prep_walk(int sstate)
2781 ACPI_HANDLE sb_handle;
2783 if (ACPI_SUCCESS(AcpiGetHandle(ACPI_ROOT_OBJECT, "\\_SB_", &sb_handle))) {
2784 AcpiWalkNamespace(ACPI_TYPE_DEVICE, sb_handle, 100,
2785 acpi_wake_prep, NULL, &sstate, NULL);
2787 return (0);
2790 /* Walk the tree rooted at acpi0 to attach per-device wake sysctls. */
2791 static int
2792 acpi_wake_sysctl_walk(device_t dev)
2794 #ifdef notyet
2795 int error, i, numdevs;
2796 device_t *devlist;
2797 device_t child;
2798 ACPI_STATUS status;
2800 error = device_get_children(dev, &devlist, &numdevs);
2801 if (error != 0 || numdevs == 0) {
2802 if (numdevs == 0)
2803 kfree(devlist, M_TEMP);
2804 return (error);
2806 for (i = 0; i < numdevs; i++) {
2807 child = devlist[i];
2808 acpi_wake_sysctl_walk(child);
2809 if (!device_is_attached(child))
2810 continue;
2811 status = AcpiEvaluateObject(acpi_get_handle(child), "_PRW", NULL, NULL);
2812 if (ACPI_SUCCESS(status)) {
2813 SYSCTL_ADD_PROC(device_get_sysctl_ctx(child),
2814 SYSCTL_CHILDREN(device_get_sysctl_tree(child)), OID_AUTO,
2815 "wake", CTLTYPE_INT | CTLFLAG_RW, child, 0,
2816 acpi_wake_set_sysctl, "I", "Device set to wake the system");
2819 kfree(devlist, M_TEMP);
2820 #endif
2822 return (0);
2825 #ifdef notyet
2826 /* Enable or disable wake from userland. */
2827 static int
2828 acpi_wake_set_sysctl(SYSCTL_HANDLER_ARGS)
2830 int enable, error;
2831 device_t dev;
2833 dev = (device_t)arg1;
2834 enable = (acpi_get_flags(dev) & ACPI_FLAG_WAKE_ENABLED) ? 1 : 0;
2836 error = sysctl_handle_int(oidp, &enable, 0, req);
2837 if (error != 0 || req->newptr == NULL)
2838 return (error);
2839 if (enable != 0 && enable != 1)
2840 return (EINVAL);
2842 return (acpi_wake_set_enable(dev, enable));
2844 #endif
2846 /* Parse a device's _PRW into a structure. */
2848 acpi_parse_prw(ACPI_HANDLE h, struct acpi_prw_data *prw)
2850 ACPI_STATUS status;
2851 ACPI_BUFFER prw_buffer;
2852 ACPI_OBJECT *res, *res2;
2853 int error, i, power_count;
2855 if (h == NULL || prw == NULL)
2856 return (EINVAL);
2859 * The _PRW object (7.2.9) is only required for devices that have the
2860 * ability to wake the system from a sleeping state.
2862 error = EINVAL;
2863 prw_buffer.Pointer = NULL;
2864 prw_buffer.Length = ACPI_ALLOCATE_BUFFER;
2865 status = AcpiEvaluateObject(h, "_PRW", NULL, &prw_buffer);
2866 if (ACPI_FAILURE(status))
2867 return (ENOENT);
2868 res = (ACPI_OBJECT *)prw_buffer.Pointer;
2869 if (res == NULL)
2870 return (ENOENT);
2871 if (!ACPI_PKG_VALID(res, 2))
2872 goto out;
2875 * Element 1 of the _PRW object:
2876 * The lowest power system sleeping state that can be entered while still
2877 * providing wake functionality. The sleeping state being entered must
2878 * be less than (i.e., higher power) or equal to this value.
2880 if (acpi_PkgInt32(res, 1, &prw->lowest_wake) != 0)
2881 goto out;
2884 * Element 0 of the _PRW object:
2886 switch (res->Package.Elements[0].Type) {
2887 case ACPI_TYPE_INTEGER:
2889 * If the data type of this package element is numeric, then this
2890 * _PRW package element is the bit index in the GPEx_EN, in the
2891 * GPE blocks described in the FADT, of the enable bit that is
2892 * enabled for the wake event.
2894 prw->gpe_handle = NULL;
2895 prw->gpe_bit = res->Package.Elements[0].Integer.Value;
2896 error = 0;
2897 break;
2898 case ACPI_TYPE_PACKAGE:
2900 * If the data type of this package element is a package, then this
2901 * _PRW package element is itself a package containing two
2902 * elements. The first is an object reference to the GPE Block
2903 * device that contains the GPE that will be triggered by the wake
2904 * event. The second element is numeric and it contains the bit
2905 * index in the GPEx_EN, in the GPE Block referenced by the
2906 * first element in the package, of the enable bit that is enabled for
2907 * the wake event.
2909 * For example, if this field is a package then it is of the form:
2910 * Package() {\_SB.PCI0.ISA.GPE, 2}
2912 res2 = &res->Package.Elements[0];
2913 if (!ACPI_PKG_VALID(res2, 2))
2914 goto out;
2915 prw->gpe_handle = acpi_GetReference(NULL, &res2->Package.Elements[0]);
2916 if (prw->gpe_handle == NULL)
2917 goto out;
2918 if (acpi_PkgInt32(res2, 1, &prw->gpe_bit) != 0)
2919 goto out;
2920 error = 0;
2921 break;
2922 default:
2923 goto out;
2926 /* Elements 2 to N of the _PRW object are power resources. */
2927 power_count = res->Package.Count - 2;
2928 if (power_count > ACPI_PRW_MAX_POWERRES) {
2929 kprintf("ACPI device %s has too many power resources\n", acpi_name(h));
2930 power_count = 0;
2932 prw->power_res_count = power_count;
2933 for (i = 0; i < power_count; i++)
2934 prw->power_res[i] = res->Package.Elements[i];
2936 out:
2937 if (prw_buffer.Pointer != NULL)
2938 AcpiOsFree(prw_buffer.Pointer);
2939 return (error);
2943 * ACPI Event Handlers
2946 /* System Event Handlers (registered by EVENTHANDLER_REGISTER) */
2948 static void
2949 acpi_system_eventhandler_sleep(void *arg, int state)
2951 struct acpi_softc *sc;
2952 int ret;
2954 ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, state);
2956 sc = arg;
2958 /* Check if button action is disabled. */
2959 if (state == ACPI_S_STATES_MAX + 1)
2960 return;
2962 /* Request that the system prepare to enter the given suspend state. */
2963 ret = acpi_ReqSleepState((struct acpi_softc *)arg, state);
2964 if (ret != 0)
2965 device_printf(sc->acpi_dev,
2966 "request to enter state S%d failed (err %d)\n", state, ret);
2968 return_VOID;
2971 static void
2972 acpi_system_eventhandler_wakeup(void *arg, int state)
2975 ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, state);
2977 /* Currently, nothing to do for wakeup. */
2979 return_VOID;
2983 * ACPICA Event Handlers (FixedEvent, also called from button notify handler)
2985 UINT32
2986 acpi_event_power_button_sleep(void *context)
2988 struct acpi_softc *sc = (struct acpi_softc *)context;
2990 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
2992 EVENTHANDLER_INVOKE(acpi_sleep_event, sc->acpi_power_button_sx);
2994 return_VALUE (ACPI_INTERRUPT_HANDLED);
2997 UINT32
2998 acpi_event_power_button_wake(void *context)
3000 struct acpi_softc *sc = (struct acpi_softc *)context;
3002 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
3004 EVENTHANDLER_INVOKE(acpi_wakeup_event, sc->acpi_power_button_sx);
3006 return_VALUE (ACPI_INTERRUPT_HANDLED);
3009 UINT32
3010 acpi_event_sleep_button_sleep(void *context)
3012 struct acpi_softc *sc = (struct acpi_softc *)context;
3014 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
3016 EVENTHANDLER_INVOKE(acpi_sleep_event, sc->acpi_sleep_button_sx);
3018 return_VALUE (ACPI_INTERRUPT_HANDLED);
3021 UINT32
3022 acpi_event_sleep_button_wake(void *context)
3024 struct acpi_softc *sc = (struct acpi_softc *)context;
3026 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
3028 EVENTHANDLER_INVOKE(acpi_wakeup_event, sc->acpi_sleep_button_sx);
3030 return_VALUE (ACPI_INTERRUPT_HANDLED);
3034 * XXX This static buffer is suboptimal. There is no locking so only
3035 * use this for single-threaded callers.
3037 char *
3038 acpi_name(ACPI_HANDLE handle)
3040 ACPI_BUFFER buf;
3041 static char data[256];
3043 buf.Length = sizeof(data);
3044 buf.Pointer = data;
3046 if (handle && ACPI_SUCCESS(AcpiGetName(handle, ACPI_FULL_PATHNAME, &buf)))
3047 return (data);
3048 return ("(unknown)");
3052 * Debugging/bug-avoidance. Avoid trying to fetch info on various
3053 * parts of the namespace.
3056 acpi_avoid(ACPI_HANDLE handle)
3058 char *cp, *env, *np;
3059 int len;
3061 np = acpi_name(handle);
3062 if (*np == '\\')
3063 np++;
3064 if ((env = kgetenv("debug.acpi.avoid")) == NULL)
3065 return (0);
3067 /* Scan the avoid list checking for a match */
3068 cp = env;
3069 for (;;) {
3070 while (*cp != 0 && isspace(*cp))
3071 cp++;
3072 if (*cp == 0)
3073 break;
3074 len = 0;
3075 while (cp[len] != 0 && !isspace(cp[len]))
3076 len++;
3077 if (!strncmp(cp, np, len)) {
3078 kfreeenv(env);
3079 return(1);
3081 cp += len;
3083 kfreeenv(env);
3085 return (0);
3089 * Debugging/bug-avoidance. Disable ACPI subsystem components.
3092 acpi_disabled(char *subsys)
3094 char *cp, *env;
3095 int len;
3097 if ((env = kgetenv("debug.acpi.disabled")) == NULL)
3098 return (0);
3099 if (strcmp(env, "all") == 0) {
3100 kfreeenv(env);
3101 return (1);
3104 /* Scan the disable list, checking for a match. */
3105 cp = env;
3106 for (;;) {
3107 while (*cp != '\0' && isspace(*cp))
3108 cp++;
3109 if (*cp == '\0')
3110 break;
3111 len = 0;
3112 while (cp[len] != '\0' && !isspace(cp[len]))
3113 len++;
3114 if (strncmp(cp, subsys, len) == 0) {
3115 kfreeenv(env);
3116 return (1);
3118 cp += len;
3120 kfreeenv(env);
3122 return (0);
3126 * Debugging/bug-avoidance. Enable ACPI subsystem components. Most
3127 * components are enabled by default. The ones that are not have to be
3128 * enabled via debug.acpi.enabled.
3131 acpi_enabled(char *subsys)
3133 char *cp, *env;
3134 int len;
3136 if ((env = kgetenv("debug.acpi.enabled")) == NULL)
3137 return (0);
3138 if (strcmp(env, "all") == 0) {
3139 kfreeenv(env);
3140 return (1);
3143 /* Scan the enable list, checking for a match. */
3144 cp = env;
3145 for (;;) {
3146 while (*cp != '\0' && isspace(*cp))
3147 cp++;
3148 if (*cp == '\0')
3149 break;
3150 len = 0;
3151 while (cp[len] != '\0' && !isspace(cp[len]))
3152 len++;
3153 if (strncmp(cp, subsys, len) == 0) {
3154 kfreeenv(env);
3155 return (1);
3157 cp += len;
3159 kfreeenv(env);
3161 return (0);
3165 * Control interface.
3167 * We multiplex ioctls for all participating ACPI devices here. Individual
3168 * drivers wanting to be accessible via /dev/acpi should use the
3169 * register/deregister interface to make their handlers visible.
3171 struct acpi_ioctl_hook
3173 TAILQ_ENTRY(acpi_ioctl_hook) link;
3174 u_long cmd;
3175 acpi_ioctl_fn fn;
3176 void *arg;
3179 static TAILQ_HEAD(,acpi_ioctl_hook) acpi_ioctl_hooks;
3180 static int acpi_ioctl_hooks_initted;
3183 acpi_register_ioctl(u_long cmd, acpi_ioctl_fn fn, void *arg)
3185 struct acpi_ioctl_hook *hp;
3187 if ((hp = kmalloc(sizeof(*hp), M_ACPIDEV, M_NOWAIT)) == NULL)
3188 return (ENOMEM);
3189 hp->cmd = cmd;
3190 hp->fn = fn;
3191 hp->arg = arg;
3193 ACPI_LOCK(acpi);
3194 if (acpi_ioctl_hooks_initted == 0) {
3195 TAILQ_INIT(&acpi_ioctl_hooks);
3196 acpi_ioctl_hooks_initted = 1;
3198 TAILQ_INSERT_TAIL(&acpi_ioctl_hooks, hp, link);
3199 ACPI_UNLOCK(acpi);
3201 return (0);
3204 void
3205 acpi_deregister_ioctl(u_long cmd, acpi_ioctl_fn fn)
3207 struct acpi_ioctl_hook *hp;
3209 ACPI_LOCK(acpi);
3210 TAILQ_FOREACH(hp, &acpi_ioctl_hooks, link)
3211 if (hp->cmd == cmd && hp->fn == fn)
3212 break;
3214 if (hp != NULL) {
3215 TAILQ_REMOVE(&acpi_ioctl_hooks, hp, link);
3216 kfree(hp, M_ACPIDEV);
3218 ACPI_UNLOCK(acpi);
3221 static int
3222 acpiopen(struct dev_open_args *ap)
3224 return (0);
3227 static int
3228 acpiclose(struct dev_close_args *ap)
3230 return (0);
3233 static int
3234 acpiioctl(struct dev_ioctl_args *ap)
3236 struct acpi_softc *sc;
3237 struct acpi_ioctl_hook *hp;
3238 int error, state;
3240 error = 0;
3241 hp = NULL;
3242 sc = ap->a_head.a_dev->si_drv1;
3245 * Scan the list of registered ioctls, looking for handlers.
3247 lwkt_gettoken(&acpi_token);
3248 ACPI_LOCK(acpi);
3249 if (acpi_ioctl_hooks_initted) {
3250 TAILQ_FOREACH(hp, &acpi_ioctl_hooks, link) {
3251 if (hp->cmd == ap->a_cmd)
3252 break;
3255 ACPI_UNLOCK(acpi);
3256 if (hp) {
3257 error = hp->fn(ap->a_cmd, ap->a_data, hp->arg);
3258 lwkt_reltoken(&acpi_token);
3259 return error;
3263 * Core ioctls are not permitted for non-writable user.
3264 * Currently, other ioctls just fetch information.
3265 * Not changing system behavior.
3267 if ((ap->a_fflag & FWRITE) == 0) {
3268 lwkt_reltoken(&acpi_token);
3269 return (EPERM);
3272 /* Core system ioctls. */
3273 switch (ap->a_cmd) {
3274 case ACPIIO_REQSLPSTATE:
3275 state = *(int *)ap->a_data;
3276 if (state != ACPI_STATE_S5)
3277 error = acpi_ReqSleepState(sc, state);
3278 else {
3279 device_printf(sc->acpi_dev,
3280 "power off via acpi ioctl not supported\n");
3281 error = ENXIO;
3283 break;
3284 case ACPIIO_ACKSLPSTATE:
3285 error = EOPNOTSUPP;
3286 #if 0 /* notyet */
3287 error = *(int *)ap->a_data;
3288 error = acpi_AckSleepState(sc->acpi_clone, error);
3289 #endif
3290 break;
3291 case ACPIIO_SETSLPSTATE: /* DEPRECATED */
3292 error = EINVAL;
3293 state = *(int *)ap->a_data;
3294 if (state >= ACPI_STATE_S0 && state <= ACPI_S_STATES_MAX)
3295 if (ACPI_SUCCESS(acpi_SetSleepState(sc, state)))
3296 error = 0;
3297 break;
3298 case ACPIIO_DO_MCALL:
3299 if (acpi_allow_mcall == 1) {
3300 struct acpi_mcall_ioctl_arg *params;
3301 ACPI_BUFFER result = { ACPI_ALLOCATE_BUFFER, NULL };
3302 ACPI_OBJECT *resobj;
3304 error = EINVAL;
3305 params = (struct acpi_mcall_ioctl_arg *)ap->a_data;
3306 params->retval = AcpiEvaluateObject(NULL, params->path,
3307 &params->args, &result);
3308 if (ACPI_SUCCESS(params->retval) && result.Pointer != NULL &&
3309 params->result.Pointer != NULL) {
3310 params->result.Length = min(params->result.Length,
3311 result.Length);
3312 copyout(result.Pointer, params->result.Pointer,
3313 params->result.Length);
3314 params->reslen = result.Length;
3315 if (result.Length >= sizeof(ACPI_OBJECT)) {
3316 resobj = (ACPI_OBJECT *)params->result.Pointer;
3317 switch (resobj->Type) {
3318 case ACPI_TYPE_STRING:
3319 resobj->String.Pointer = (char *)
3320 ((UINT8 *)(resobj->String.Pointer) -
3321 (UINT8 *)result.Pointer +
3322 (UINT8 *)resobj);
3323 break;
3324 case ACPI_TYPE_BUFFER:
3325 resobj->Buffer.Pointer -= (UINT8 *)result.Pointer -
3326 (UINT8 *)resobj;
3327 break;
3330 error = 0;
3332 if (result.Pointer != NULL)
3333 AcpiOsFree(result.Pointer);
3334 } else {
3335 device_printf(sc->acpi_dev,
3336 "debug.acpi.allow_method_calls must be set\n");
3337 error = ENXIO;
3339 break;
3340 default:
3341 error = ENXIO;
3342 break;
3344 lwkt_reltoken(&acpi_token);
3346 return (error);
3349 static int
3350 acpi_supported_sleep_state_sysctl(SYSCTL_HANDLER_ARGS)
3352 int error;
3353 struct sbuf sb;
3354 UINT8 state, TypeA, TypeB;
3356 sbuf_new(&sb, NULL, 32, SBUF_AUTOEXTEND);
3357 for (state = ACPI_STATE_S1; state < ACPI_S_STATES_MAX + 1; state++)
3358 if (ACPI_SUCCESS(AcpiGetSleepTypeData(state, &TypeA, &TypeB)))
3359 sbuf_printf(&sb, "S%d ", state);
3360 sbuf_trim(&sb);
3361 sbuf_finish(&sb);
3362 error = sysctl_handle_string(oidp, sbuf_data(&sb), sbuf_len(&sb), req);
3363 sbuf_delete(&sb);
3364 return (error);
3367 static int
3368 acpi_sleep_state_sysctl(SYSCTL_HANDLER_ARGS)
3370 char sleep_state[10];
3371 int error;
3372 u_int new_state, old_state;
3374 old_state = *(u_int *)oidp->oid_arg1;
3375 if (old_state > ACPI_S_STATES_MAX + 1)
3376 strlcpy(sleep_state, "unknown", sizeof(sleep_state));
3377 else
3378 strlcpy(sleep_state, sleep_state_names[old_state], sizeof(sleep_state));
3379 error = sysctl_handle_string(oidp, sleep_state, sizeof(sleep_state), req);
3380 if (error == 0 && req->newptr != NULL) {
3381 new_state = ACPI_STATE_S0;
3382 for (; new_state <= ACPI_S_STATES_MAX + 1; new_state++)
3383 if (strcmp(sleep_state, sleep_state_names[new_state]) == 0)
3384 break;
3385 if (new_state <= ACPI_S_STATES_MAX + 1) {
3386 if (new_state != old_state)
3387 *(u_int *)oidp->oid_arg1 = new_state;
3388 } else
3389 error = EINVAL;
3392 return (error);
3395 /* Inform devctl(4) when we receive a Notify. */
3396 void
3397 acpi_UserNotify(const char *subsystem, ACPI_HANDLE h, uint8_t notify)
3399 char notify_buf[16];
3400 ACPI_BUFFER handle_buf;
3401 ACPI_STATUS status;
3403 if (subsystem == NULL)
3404 return;
3406 handle_buf.Pointer = NULL;
3407 handle_buf.Length = ACPI_ALLOCATE_BUFFER;
3408 status = AcpiNsHandleToPathname(h, &handle_buf, FALSE);
3409 if (ACPI_FAILURE(status))
3410 return;
3411 ksnprintf(notify_buf, sizeof(notify_buf), "notify=0x%02x", notify);
3412 devctl_notify("ACPI", subsystem, handle_buf.Pointer, notify_buf);
3413 AcpiOsFree(handle_buf.Pointer);
3416 #ifdef ACPI_DEBUG
3418 * Support for parsing debug options from the kernel environment.
3420 * Bits may be set in the AcpiDbgLayer and AcpiDbgLevel debug registers
3421 * by specifying the names of the bits in the debug.acpi.layer and
3422 * debug.acpi.level environment variables. Bits may be unset by
3423 * prefixing the bit name with !.
3425 struct debugtag
3427 char *name;
3428 UINT32 value;
3431 static struct debugtag dbg_layer[] = {
3432 {"ACPI_UTILITIES", ACPI_UTILITIES},
3433 {"ACPI_HARDWARE", ACPI_HARDWARE},
3434 {"ACPI_EVENTS", ACPI_EVENTS},
3435 {"ACPI_TABLES", ACPI_TABLES},
3436 {"ACPI_NAMESPACE", ACPI_NAMESPACE},
3437 {"ACPI_PARSER", ACPI_PARSER},
3438 {"ACPI_DISPATCHER", ACPI_DISPATCHER},
3439 {"ACPI_EXECUTER", ACPI_EXECUTER},
3440 {"ACPI_RESOURCES", ACPI_RESOURCES},
3441 {"ACPI_CA_DEBUGGER", ACPI_CA_DEBUGGER},
3442 {"ACPI_OS_SERVICES", ACPI_OS_SERVICES},
3443 {"ACPI_CA_DISASSEMBLER", ACPI_CA_DISASSEMBLER},
3444 {"ACPI_ALL_COMPONENTS", ACPI_ALL_COMPONENTS},
3446 {"ACPI_AC_ADAPTER", ACPI_AC_ADAPTER},
3447 {"ACPI_BATTERY", ACPI_BATTERY},
3448 {"ACPI_BUS", ACPI_BUS},
3449 {"ACPI_BUTTON", ACPI_BUTTON},
3450 {"ACPI_EC", ACPI_EC},
3451 {"ACPI_FAN", ACPI_FAN},
3452 {"ACPI_POWERRES", ACPI_POWERRES},
3453 {"ACPI_PROCESSOR", ACPI_PROCESSOR},
3454 {"ACPI_THERMAL", ACPI_THERMAL},
3455 {"ACPI_TIMER", ACPI_TIMER},
3456 {"ACPI_ALL_DRIVERS", ACPI_ALL_DRIVERS},
3457 {NULL, 0}
3460 static struct debugtag dbg_level[] = {
3461 {"ACPI_LV_INIT", ACPI_LV_INIT},
3462 {"ACPI_LV_DEBUG_OBJECT", ACPI_LV_DEBUG_OBJECT},
3463 {"ACPI_LV_INFO", ACPI_LV_INFO},
3464 {"ACPI_LV_REPAIR", ACPI_LV_REPAIR},
3465 {"ACPI_LV_ALL_EXCEPTIONS", ACPI_LV_ALL_EXCEPTIONS},
3467 /* Trace verbosity level 1 [Standard Trace Level] */
3468 {"ACPI_LV_INIT_NAMES", ACPI_LV_INIT_NAMES},
3469 {"ACPI_LV_PARSE", ACPI_LV_PARSE},
3470 {"ACPI_LV_LOAD", ACPI_LV_LOAD},
3471 {"ACPI_LV_DISPATCH", ACPI_LV_DISPATCH},
3472 {"ACPI_LV_EXEC", ACPI_LV_EXEC},
3473 {"ACPI_LV_NAMES", ACPI_LV_NAMES},
3474 {"ACPI_LV_OPREGION", ACPI_LV_OPREGION},
3475 {"ACPI_LV_BFIELD", ACPI_LV_BFIELD},
3476 {"ACPI_LV_TABLES", ACPI_LV_TABLES},
3477 {"ACPI_LV_VALUES", ACPI_LV_VALUES},
3478 {"ACPI_LV_OBJECTS", ACPI_LV_OBJECTS},
3479 {"ACPI_LV_RESOURCES", ACPI_LV_RESOURCES},
3480 {"ACPI_LV_USER_REQUESTS", ACPI_LV_USER_REQUESTS},
3481 {"ACPI_LV_PACKAGE", ACPI_LV_PACKAGE},
3482 {"ACPI_LV_EVALUATION", ACPI_LV_EVALUATION},
3483 {"ACPI_LV_VERBOSITY1", ACPI_LV_VERBOSITY1},
3485 /* Trace verbosity level 2 [Function tracing and memory allocation] */
3486 {"ACPI_LV_ALLOCATIONS", ACPI_LV_ALLOCATIONS},
3487 {"ACPI_LV_FUNCTIONS", ACPI_LV_FUNCTIONS},
3488 {"ACPI_LV_OPTIMIZATIONS", ACPI_LV_OPTIMIZATIONS},
3489 {"ACPI_LV_VERBOSITY2", ACPI_LV_VERBOSITY2},
3490 {"ACPI_LV_ALL", ACPI_LV_ALL},
3492 /* Trace verbosity level 3 [Threading, I/O, and Interrupts] */
3493 {"ACPI_LV_MUTEX", ACPI_LV_MUTEX},
3494 {"ACPI_LV_THREADS", ACPI_LV_THREADS},
3495 {"ACPI_LV_IO", ACPI_LV_IO},
3496 {"ACPI_LV_INTERRUPTS", ACPI_LV_INTERRUPTS},
3497 {"ACPI_LV_VERBOSITY3", ACPI_LV_VERBOSITY3},
3499 /* Exceptionally verbose output -- also used in the global "DebugLevel" */
3500 {"ACPI_LV_AML_DISASSEMBLE", ACPI_LV_AML_DISASSEMBLE},
3501 {"ACPI_LV_VERBOSE_INFO", ACPI_LV_VERBOSE_INFO},
3502 {"ACPI_LV_FULL_TABLES", ACPI_LV_FULL_TABLES},
3503 {"ACPI_LV_EVENTS", ACPI_LV_EVENTS},
3504 {"ACPI_LV_VERBOSE", ACPI_LV_VERBOSE},
3505 {NULL, 0}
3508 static void
3509 acpi_parse_debug(char *cp, struct debugtag *tag, UINT32 *flag)
3511 char *ep;
3512 int i, l;
3513 int set;
3515 while (*cp) {
3516 if (isspace(*cp)) {
3517 cp++;
3518 continue;
3520 ep = cp;
3521 while (*ep && !isspace(*ep))
3522 ep++;
3523 if (*cp == '!') {
3524 set = 0;
3525 cp++;
3526 if (cp == ep)
3527 continue;
3528 } else {
3529 set = 1;
3531 l = ep - cp;
3532 for (i = 0; tag[i].name != NULL; i++) {
3533 if (!strncmp(cp, tag[i].name, l)) {
3534 if (set)
3535 *flag |= tag[i].value;
3536 else
3537 *flag &= ~tag[i].value;
3540 cp = ep;
3544 static void
3545 acpi_set_debugging(void *junk)
3547 char *layer, *level;
3549 if (cold) {
3550 AcpiDbgLayer = 0;
3551 AcpiDbgLevel = 0;
3554 layer = kgetenv("debug.acpi.layer");
3555 level = kgetenv("debug.acpi.level");
3556 if (layer == NULL && level == NULL)
3557 return;
3559 kprintf("ACPI set debug");
3560 if (layer != NULL) {
3561 if (strcmp("NONE", layer) != 0)
3562 kprintf(" layer '%s'", layer);
3563 acpi_parse_debug(layer, &dbg_layer[0], &AcpiDbgLayer);
3564 kfreeenv(layer);
3566 if (level != NULL) {
3567 if (strcmp("NONE", level) != 0)
3568 kprintf(" level '%s'", level);
3569 acpi_parse_debug(level, &dbg_level[0], &AcpiDbgLevel);
3570 kfreeenv(level);
3572 kprintf("\n");
3575 SYSINIT(acpi_debugging, SI_BOOT1_TUNABLES, SI_ORDER_ANY, acpi_set_debugging,
3576 NULL);
3578 static int
3579 acpi_debug_sysctl(SYSCTL_HANDLER_ARGS)
3581 int error, *dbg;
3582 struct debugtag *tag;
3583 struct sbuf sb;
3585 if (sbuf_new(&sb, NULL, 128, SBUF_AUTOEXTEND) == NULL)
3586 return (ENOMEM);
3587 if (strcmp(oidp->oid_arg1, "debug.acpi.layer") == 0) {
3588 tag = &dbg_layer[0];
3589 dbg = &AcpiDbgLayer;
3590 } else {
3591 tag = &dbg_level[0];
3592 dbg = &AcpiDbgLevel;
3595 /* Get old values if this is a get request. */
3596 ACPI_SERIAL_BEGIN(acpi);
3597 if (*dbg == 0) {
3598 sbuf_cpy(&sb, "NONE");
3599 } else if (req->newptr == NULL) {
3600 for (; tag->name != NULL; tag++) {
3601 if ((*dbg & tag->value) == tag->value)
3602 sbuf_printf(&sb, "%s ", tag->name);
3605 sbuf_trim(&sb);
3606 sbuf_finish(&sb);
3608 /* Copy out the old values to the user. */
3609 error = SYSCTL_OUT(req, sbuf_data(&sb), sbuf_len(&sb));
3610 sbuf_delete(&sb);
3612 /* If the user is setting a string, parse it. */
3613 if (error == 0 && req->newptr != NULL) {
3614 *dbg = 0;
3615 ksetenv((char *)oidp->oid_arg1, (char *)req->newptr);
3616 acpi_set_debugging(NULL);
3618 ACPI_SERIAL_END(acpi);
3620 return (error);
3623 SYSCTL_PROC(_debug_acpi, OID_AUTO, layer, CTLFLAG_RW | CTLTYPE_STRING,
3624 "debug.acpi.layer", 0, acpi_debug_sysctl, "A", "");
3625 SYSCTL_PROC(_debug_acpi, OID_AUTO, level, CTLFLAG_RW | CTLTYPE_STRING,
3626 "debug.acpi.level", 0, acpi_debug_sysctl, "A", "");
3627 #endif /* ACPI_DEBUG */
3629 static int
3630 acpi_debug_objects_sysctl(SYSCTL_HANDLER_ARGS)
3632 int error;
3633 int old;
3635 old = acpi_debug_objects;
3636 error = sysctl_handle_int(oidp, &acpi_debug_objects, 0, req);
3637 if (error != 0 || req->newptr == NULL)
3638 return (error);
3639 if (old == acpi_debug_objects || (old && acpi_debug_objects))
3640 return (0);
3642 ACPI_SERIAL_BEGIN(acpi);
3643 AcpiGbl_EnableAmlDebugObject = acpi_debug_objects ? TRUE : FALSE;
3644 ACPI_SERIAL_END(acpi);
3646 return (0);
3650 static int
3651 acpi_parse_interfaces(char *str, struct acpi_interface *iface)
3653 char *p;
3654 size_t len;
3655 int i, j;
3657 p = str;
3658 while (isspace(*p) || *p == ',')
3659 p++;
3660 len = strlen(p);
3661 if (len == 0)
3662 return (0);
3663 p = kstrdup(p, M_TEMP);
3664 for (i = 0; i < len; i++)
3665 if (p[i] == ',')
3666 p[i] = '\0';
3667 i = j = 0;
3668 while (i < len)
3669 if (isspace(p[i]) || p[i] == '\0')
3670 i++;
3671 else {
3672 i += strlen(p + i) + 1;
3673 j++;
3675 if (j == 0) {
3676 kfree(p, M_TEMP);
3677 return (0);
3679 iface->data = kmalloc(sizeof(*iface->data) * j, M_TEMP, M_WAITOK);
3680 iface->num = j;
3681 i = j = 0;
3682 while (i < len)
3683 if (isspace(p[i]) || p[i] == '\0')
3684 i++;
3685 else {
3686 iface->data[j] = p + i;
3687 i += strlen(p + i) + 1;
3688 j++;
3691 return (j);
3694 static void
3695 acpi_free_interfaces(struct acpi_interface *iface)
3697 kfree(iface->data[0], M_TEMP);
3698 kfree(iface->data, M_TEMP);
3701 static void
3702 acpi_reset_interfaces(device_t dev)
3704 struct acpi_interface list;
3705 ACPI_STATUS status;
3706 int i;
3708 if (acpi_parse_interfaces(acpi_install_interface, &list) > 0) {
3709 for (i = 0; i < list.num; i++) {
3710 status = AcpiInstallInterface(list.data[i]);
3711 if (ACPI_FAILURE(status))
3712 device_printf(dev,
3713 "failed to install _OSI(\"%s\"): %s\n",
3714 list.data[i], AcpiFormatException(status));
3715 else if (bootverbose)
3716 device_printf(dev, "installed _OSI(\"%s\")\n",
3717 list.data[i]);
3719 acpi_free_interfaces(&list);
3721 if (acpi_parse_interfaces(acpi_remove_interface, &list) > 0) {
3722 for (i = 0; i < list.num; i++) {
3723 status = AcpiRemoveInterface(list.data[i]);
3724 if (ACPI_FAILURE(status))
3725 device_printf(dev,
3726 "failed to remove _OSI(\"%s\"): %s\n",
3727 list.data[i], AcpiFormatException(status));
3728 else if (bootverbose)
3729 device_printf(dev, "removed _OSI(\"%s\")\n",
3730 list.data[i]);
3732 acpi_free_interfaces(&list);
3736 static int
3737 acpi_pm_func(u_long cmd, void *arg, ...)
3739 int state, acpi_state;
3740 int error;
3741 struct acpi_softc *sc;
3742 __va_list ap;
3744 error = 0;
3745 switch (cmd) {
3746 case POWER_CMD_SUSPEND:
3747 sc = (struct acpi_softc *)arg;
3748 if (sc == NULL) {
3749 error = EINVAL;
3750 goto out;
3753 __va_start(ap, arg);
3754 state = __va_arg(ap, int);
3755 __va_end(ap);
3757 switch (state) {
3758 case POWER_SLEEP_STATE_STANDBY:
3759 acpi_state = sc->acpi_standby_sx;
3760 break;
3761 case POWER_SLEEP_STATE_SUSPEND:
3762 acpi_state = sc->acpi_suspend_sx;
3763 break;
3764 case POWER_SLEEP_STATE_HIBERNATE:
3765 acpi_state = ACPI_STATE_S4;
3766 break;
3767 default:
3768 error = EINVAL;
3769 goto out;
3772 if (ACPI_FAILURE(acpi_EnterSleepState(sc, acpi_state)))
3773 error = ENXIO;
3774 break;
3775 default:
3776 error = EINVAL;
3777 goto out;
3780 out:
3781 return (error);
3784 static void
3785 acpi_pm_register(void *arg)
3787 if (!cold || resource_disabled("acpi", 0))
3788 return;
3790 power_pm_register(POWER_PM_TYPE_ACPI, acpi_pm_func, NULL);
3793 SYSINIT(power, SI_BOOT2_KLD, SI_ORDER_ANY, acpi_pm_register, 0);