xref: /dragonfly/sys/dev/acpica/acpi.c (revision 63e03116)
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.
7  *
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.
16  *
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.
28  *
29  * $FreeBSD: src/sys/dev/acpica/acpi.c,v 1.243.2.4.4.1 2009/04/15 03:14:26 kensmith Exp $
30  */
31 
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>
51 
52 #include <sys/rman.h>
53 #include <bus/isa/isavar.h>
54 #include <bus/isa/pnpvar.h>
55 
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"
63 
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>
68 
69 #include <vm/vm_param.h>
70 
71 MALLOC_DEFINE(M_ACPIDEV, "acpidev", "ACPI devices");
72 
73 /* Hooks for the ACPICA debugging infrastructure */
74 #define _COMPONENT	ACPI_BUS
75 ACPI_MODULE_NAME("ACPI");
76 
77 static d_open_t		acpiopen;
78 static d_close_t	acpiclose;
79 static d_ioctl_t	acpiioctl;
80 
81 static struct dev_ops acpi_ops = {
82         { "acpi", 0, D_MPSAFE },
83         .d_open = acpiopen,
84         .d_close = acpiclose,
85         .d_ioctl = acpiioctl
86 };
87 
88 struct acpi_interface {
89 	ACPI_STRING	*data;
90 	int		num;
91 };
92 
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);
96 
97 /* Bitmap of device quirks. */
98 int		acpi_quirks;
99 
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);
170 static void	acpi_call_fixup_pointers(ACPI_OBJECT *p, UINT8 *orig);
171 static int	acpi_call_ioctl(caddr_t addr);
172 static ACPI_OBJECT_LIST *acpi_copyin_object_list(ACPI_OBJECT_LIST *src);
173 static void	acpi_free_object_list(ACPI_OBJECT_LIST *list);
174 
175 static device_method_t acpi_methods[] = {
176     /* Device interface */
177     DEVMETHOD(device_identify,		acpi_identify),
178     DEVMETHOD(device_probe,		acpi_probe),
179     DEVMETHOD(device_attach,		acpi_attach),
180     DEVMETHOD(device_shutdown,		acpi_shutdown),
181     DEVMETHOD(device_detach,		bus_generic_detach),
182     DEVMETHOD(device_suspend,		acpi_suspend),
183     DEVMETHOD(device_resume,		acpi_resume),
184 
185     /* Bus interface */
186     DEVMETHOD(bus_add_child,		acpi_add_child),
187     DEVMETHOD(bus_print_child,		acpi_print_child),
188     DEVMETHOD(bus_probe_nomatch,	acpi_probe_nomatch),
189     DEVMETHOD(bus_driver_added,		acpi_driver_added),
190     DEVMETHOD(bus_read_ivar,		acpi_read_ivar),
191     DEVMETHOD(bus_write_ivar,		acpi_write_ivar),
192     DEVMETHOD(bus_get_resource_list,	acpi_get_rlist),
193     DEVMETHOD(bus_set_resource,		bus_generic_rl_set_resource),
194     DEVMETHOD(bus_get_resource,		bus_generic_rl_get_resource),
195     DEVMETHOD(bus_alloc_resource,	acpi_alloc_resource),
196     DEVMETHOD(bus_release_resource,	acpi_release_resource),
197     DEVMETHOD(bus_delete_resource,	acpi_delete_resource),
198     DEVMETHOD(bus_child_pnpinfo_str,	acpi_child_pnpinfo_str_method),
199     DEVMETHOD(bus_child_location_str,	acpi_child_location_str_method),
200     DEVMETHOD(bus_activate_resource,	bus_generic_activate_resource),
201     DEVMETHOD(bus_deactivate_resource,	bus_generic_deactivate_resource),
202     DEVMETHOD(bus_setup_intr,		bus_generic_setup_intr),
203     DEVMETHOD(bus_teardown_intr,	bus_generic_teardown_intr),
204 
205     /* ACPI bus */
206     DEVMETHOD(acpi_id_probe,		acpi_device_id_probe),
207     DEVMETHOD(acpi_evaluate_object,	acpi_device_eval_obj),
208     DEVMETHOD(acpi_pwr_for_sleep,	acpi_device_pwr_for_sleep),
209     DEVMETHOD(acpi_scan_children,	acpi_device_scan_children),
210 
211     /* PCI emulation */
212     DEVMETHOD(pci_set_powerstate,	acpi_set_powerstate_method),
213 
214     /* ISA emulation */
215     DEVMETHOD(isa_pnp_probe,		acpi_isa_pnp_probe),
216 
217     DEVMETHOD_END
218 };
219 
220 static driver_t acpi_driver = {
221     "acpi",
222     acpi_methods,
223     sizeof(struct acpi_softc),
224     .gpri = KOBJ_GPRI_ACPI+2
225 };
226 
227 static devclass_t acpi_devclass;
228 DRIVER_MODULE(acpi, nexus, acpi_driver, acpi_devclass, acpi_modevent, NULL);
229 MODULE_VERSION(acpi, 1);
230 
231 ACPI_SERIAL_DECL(acpi, "ACPI serializer");
232 
233 /* Local pools for managing system resources for ACPI child devices. */
234 static struct rman acpi_rman_io, acpi_rman_mem;
235 
236 #define ACPI_MINIMUM_AWAKETIME	5
237 
238 static const char* sleep_state_names[] = {
239     "S0", "S1", "S2", "S3", "S4", "S5", "NONE"};
240 
241 SYSCTL_NODE(_debug, OID_AUTO, acpi, CTLFLAG_RD, NULL, "ACPI debugging");
242 static char acpi_ca_version[12];
243 SYSCTL_STRING(_debug_acpi, OID_AUTO, acpi_ca_version, CTLFLAG_RD,
244 	      acpi_ca_version, 0, "Version of Intel ACPICA");
245 
246 /*
247  * Allow overriding _OSI methods.
248  */
249 static char acpi_install_interface[256];
250 TUNABLE_STR("hw.acpi.install_interface", acpi_install_interface,
251     sizeof(acpi_install_interface));
252 static char acpi_remove_interface[256];
253 TUNABLE_STR("hw.acpi.remove_interface", acpi_remove_interface,
254     sizeof(acpi_remove_interface));
255 
256 /*
257  * Use this tunable to disable the control method auto-serialization
258  * mechanism that was added in 20140214 and superseded the previous
259  * AcpiGbl_SerializeAllMethods global.
260  */
261 static int acpi_auto_serialize_methods = 1;
262 TUNABLE_INT("hw.acpi.auto_serialize_methods", &acpi_auto_serialize_methods);
263 
264 /* Allow users to dump Debug objects without ACPI debugger. */
265 static int acpi_debug_objects;
266 TUNABLE_INT("debug.acpi.enable_debug_objects", &acpi_debug_objects);
267 SYSCTL_PROC(_debug_acpi, OID_AUTO, enable_debug_objects,
268     CTLFLAG_RW | CTLTYPE_INT, NULL, 0, acpi_debug_objects_sysctl, "I",
269     "Enable Debug objects.");
270 
271 /* Allow ignoring the XSDT. */
272 static int acpi_ignore_xsdt;
273 TUNABLE_INT("debug.acpi.ignore_xsdt", &acpi_ignore_xsdt);
274 SYSCTL_INT(_debug_acpi, OID_AUTO, ignore_xsdt, CTLFLAG_RD,
275     &acpi_ignore_xsdt, 1, "Ignore the XSDT, forcing the use of the RSDT.");
276 
277 /* Allow the interpreter to ignore common mistakes in BIOS. */
278 static int acpi_interpreter_slack = 1;
279 TUNABLE_INT("debug.acpi.interpreter_slack", &acpi_interpreter_slack);
280 SYSCTL_INT(_debug_acpi, OID_AUTO, interpreter_slack, CTLFLAG_RD,
281     &acpi_interpreter_slack, 1, "Turn on interpreter slack mode.");
282 
283 /* Allow preferring 32-bit FADT register addresses over the 64-bit ones. */
284 static int acpi_fadt_addr32;
285 TUNABLE_INT("debug.acpi.fadt_addr32", &acpi_fadt_addr32);
286 SYSCTL_INT(_debug_acpi, OID_AUTO, fadt_addr32, CTLFLAG_RD,
287     &acpi_fadt_addr32, 1,
288     "Prefer 32-bit FADT register addresses over 64-bit ones.");
289 
290 /* Prefer 32-bit FACS table addresses over the 64-bit ones. */
291 static int acpi_facs_addr32 = 1;
292 TUNABLE_INT("debug.acpi.facs_addr32", &acpi_facs_addr32);
293 SYSCTL_INT(_debug_acpi, OID_AUTO, facs_addr32, CTLFLAG_RD,
294     &acpi_facs_addr32, 1,
295     "Prefer 32-bit FACS table addresses over 64-bit ones.");
296 
297 /* Power devices off and on in suspend and resume.  XXX Remove once tested. */
298 static int acpi_do_powerstate = 1;
299 TUNABLE_INT("debug.acpi.do_powerstate", &acpi_do_powerstate);
300 SYSCTL_INT(_debug_acpi, OID_AUTO, do_powerstate, CTLFLAG_RW,
301     &acpi_do_powerstate, 1, "Turn off devices when suspending.");
302 
303 /* Allow users to override quirks. */
304 TUNABLE_INT("debug.acpi.quirks", &acpi_quirks);
305 
306 /* Allow to call ACPI methods from userland. */
307 static int acpi_allow_mcall;
308 TUNABLE_INT("debug.acpi.allow_method_calls", &acpi_allow_mcall);
309 
310 static int acpi_susp_bounce;
311 SYSCTL_INT(_debug_acpi, OID_AUTO, suspend_bounce, CTLFLAG_RW,
312     &acpi_susp_bounce, 0, "Don't actually suspend, just test devices.");
313 
314 /*
315  * ACPI can only be loaded as a module by the loader; activating it after
316  * system bootstrap time is not useful, and can be fatal to the system.
317  * It also cannot be unloaded, since the entire system bus heirarchy hangs
318  * off it.
319  */
320 static int
321 acpi_modevent(struct module *mod, int event, void *junk)
322 {
323     switch (event) {
324     case MOD_LOAD:
325 	if (!cold) {
326 	    kprintf("The ACPI driver cannot be loaded after boot.\n");
327 	    return (EPERM);
328 	}
329 	break;
330     case MOD_UNLOAD:
331 	if (!cold && power_pm_get_type() == POWER_PM_TYPE_ACPI)
332 	    return (EBUSY);
333 	break;
334     default:
335 	break;
336     }
337     return (0);
338 }
339 
340 /*
341  * Perform early initialization.
342  */
343 ACPI_STATUS
344 acpi_Startup(void)
345 {
346     static int started = 0;
347     ACPI_STATUS status;
348     int val;
349 
350     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
351 
352     /* Only run the startup code once.  The MADT driver also calls this. */
353     if (started)
354 	return_VALUE (AE_OK);
355     started = 1;
356 
357     /* Start up the ACPICA subsystem. */
358     status = AcpiInitializeSubsystem();
359     if (ACPI_FAILURE(status)) {
360 	kprintf("ACPI: Subsystem initialization failed: %s\n",
361 	    AcpiFormatException(status));
362 	return_VALUE (status);
363     }
364 
365     /*
366      * Pre-allocate space for RSDT/XSDT and DSDT tables and allow resizing
367      * if more tables exist.
368      */
369     if (ACPI_FAILURE(status = AcpiInitializeTables(NULL, 2, TRUE))) {
370 	kprintf("ACPI: Table initialization failed: %s\n",
371 	    AcpiFormatException(status));
372 	return_VALUE (status);
373     }
374 
375     /* Set up any quirks we have for this system. */
376     if (acpi_quirks == ACPI_Q_OK)
377 	acpi_table_quirks(&acpi_quirks);
378 
379     /* If the user manually set the disabled hint to 0, force-enable ACPI. */
380     if (resource_int_value("acpi", 0, "disabled", &val) == 0 && val == 0)
381 	acpi_quirks &= ~ACPI_Q_BROKEN;
382     if (acpi_quirks & ACPI_Q_BROKEN) {
383 	kprintf("ACPI disabled by blacklist.  Contact your BIOS vendor.\n");
384 	status = AE_SUPPORT;
385     }
386 
387     return_VALUE (status);
388 }
389 
390 /*
391  * Detect ACPI, perform early initialisation
392  */
393 static void
394 acpi_identify(driver_t *driver, device_t parent)
395 {
396     device_t	child;
397 
398     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
399 
400     if (!cold)
401 	return_VOID;
402 
403     /* Check that we haven't been disabled with a hint. */
404     if (resource_disabled("acpi", 0))
405 	return_VOID;
406 
407     /* Make sure we're not being doubly invoked. */
408     if (device_find_child(parent, "acpi", 0) != NULL)
409 	return_VOID;
410 
411     ksnprintf(acpi_ca_version, sizeof(acpi_ca_version), "%x", ACPI_CA_VERSION);
412 
413     /* Initialize root tables. */
414     if (ACPI_FAILURE(acpi_Startup())) {
415 	kprintf("ACPI: Try disabling either ACPI or apic support.\n");
416 	return_VOID;
417     }
418 
419     /* Attach the actual ACPI device. */
420     if ((child = BUS_ADD_CHILD(parent, parent, 10, "acpi", 0)) == NULL) {
421 	device_printf(parent, "device_identify failed\n");
422 	return_VOID;
423     }
424 }
425 
426 /*
427  * Fetch some descriptive data from ACPI to put in our attach message.
428  */
429 static int
430 acpi_probe(device_t dev)
431 {
432     ACPI_TABLE_RSDP	*rsdp;
433     ACPI_TABLE_HEADER	*rsdt;
434     ACPI_PHYSICAL_ADDRESS paddr;
435     char		buf[ACPI_OEM_ID_SIZE + ACPI_OEM_TABLE_ID_SIZE + 2];
436     struct sbuf		sb;
437 
438     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
439 
440     if (power_pm_get_type() != POWER_PM_TYPE_NONE &&
441 	power_pm_get_type() != POWER_PM_TYPE_ACPI) {
442 	device_printf(dev, "probe failed, other PM system enabled.\n");
443 	return_VALUE (ENXIO);
444     }
445 
446     if ((paddr = AcpiOsGetRootPointer()) == 0 ||
447 	(rsdp = AcpiOsMapMemory(paddr, sizeof(ACPI_TABLE_RSDP))) == NULL)
448 	return_VALUE (ENXIO);
449     if (acpi_ignore_xsdt == 0 &&
450 	rsdp->Revision > 1 && rsdp->XsdtPhysicalAddress != 0)
451 	paddr = (ACPI_PHYSICAL_ADDRESS)rsdp->XsdtPhysicalAddress;
452     else
453 	paddr = (ACPI_PHYSICAL_ADDRESS)rsdp->RsdtPhysicalAddress;
454     AcpiOsUnmapMemory(rsdp, sizeof(ACPI_TABLE_RSDP));
455 
456     if ((rsdt = AcpiOsMapMemory(paddr, sizeof(ACPI_TABLE_HEADER))) == NULL)
457 	return_VALUE (ENXIO);
458     sbuf_new(&sb, buf, sizeof(buf), SBUF_FIXEDLEN);
459     sbuf_bcat(&sb, rsdt->OemId, ACPI_OEM_ID_SIZE);
460     sbuf_trim(&sb);
461     sbuf_putc(&sb, ' ');
462     sbuf_bcat(&sb, rsdt->OemTableId, ACPI_OEM_TABLE_ID_SIZE);
463     sbuf_trim(&sb);
464     sbuf_finish(&sb);
465     device_set_desc_copy(dev, sbuf_data(&sb));
466     sbuf_delete(&sb);
467     AcpiOsUnmapMemory(rsdt, sizeof(ACPI_TABLE_HEADER));
468 
469     return_VALUE (0);
470 }
471 
472 static int
473 acpi_attach(device_t dev)
474 {
475     struct acpi_softc	*sc;
476     ACPI_STATUS		status;
477     int			error, state;
478     UINT32		flags;
479     UINT8		TypeA, TypeB;
480     char		*env;
481 
482     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
483 
484     sc = device_get_softc(dev);
485     sc->acpi_dev = dev;
486     callout_init(&sc->susp_force_to);
487 
488     if ((error = acpi_task_thread_init())) {
489         device_printf(dev, "Could not start task thread.\n");
490         goto out2;
491     }
492 
493     error = ENXIO;
494 
495     /* Initialize resource manager. */
496     acpi_rman_io.rm_type = RMAN_ARRAY;
497     acpi_rman_io.rm_start = 0;
498     acpi_rman_io.rm_end = 0xffff;
499     acpi_rman_io.rm_descr = "ACPI I/O ports";
500     if (rman_init(&acpi_rman_io, -1) != 0)
501 	panic("acpi rman_init IO ports failed");
502     acpi_rman_mem.rm_type = RMAN_ARRAY;
503     acpi_rman_mem.rm_start = 0;
504     acpi_rman_mem.rm_end = ~0ul;
505     acpi_rman_mem.rm_descr = "ACPI I/O memory addresses";
506     if (rman_init(&acpi_rman_mem, -1) != 0)
507 	panic("acpi rman_init memory failed");
508 
509     /* Initialise the ACPI mutex */
510     ACPI_LOCK_INIT(acpi, "acpi");
511     ACPI_SERIAL_INIT(acpi);
512 
513     ACPI_LOCK(acpi);
514 
515     /*
516      * Set the globals from our tunables.  This is needed because ACPICA
517      * uses UINT8 for some values and we have no tunable_byte.
518      */
519     AcpiGbl_AutoSerializeMethods = acpi_auto_serialize_methods ? TRUE : FALSE;
520     AcpiGbl_DoNotUseXsdt = acpi_ignore_xsdt ? TRUE : FALSE;
521     AcpiGbl_EnableAmlDebugObject = acpi_debug_objects ? TRUE : FALSE;
522     AcpiGbl_EnableInterpreterSlack = acpi_interpreter_slack ? TRUE : FALSE;
523     AcpiGbl_Use32BitFadtAddresses = acpi_fadt_addr32 ? TRUE : FALSE;
524     AcpiGbl_Use32BitFacsAddresses = acpi_facs_addr32 ? TRUE : FALSE;
525 
526 #ifndef ACPI_DEBUG
527     /*
528      * Disable Debug Object output.
529      */
530     AcpiDbgLevel &= ~ACPI_LV_DEBUG_OBJECT;
531 #endif
532 
533     /* Override OS interfaces if the user requested. */
534     acpi_reset_interfaces(dev);
535 
536     /* Load ACPI name space. */
537     status = AcpiLoadTables();
538     if (ACPI_FAILURE(status)) {
539 	device_printf(dev, "Could not load Namespace: %s\n",
540 		      AcpiFormatException(status));
541 	goto out;
542     }
543 
544     /* Handle MCFG table if present. */
545     acpi_enable_pcie();
546 
547     /*
548      * Note that some systems (specifically, those with namespace evaluation
549      * issues that require the avoidance of parts of the namespace) must
550      * avoid running _INI and _STA on everything, as well as dodging the final
551      * object init pass.
552      *
553      * For these devices, we set ACPI_NO_DEVICE_INIT and ACPI_NO_OBJECT_INIT).
554      *
555      * XXX We should arrange for the object init pass after we have attached
556      *     all our child devices, but on many systems it works here.
557      */
558     flags = ACPI_FULL_INITIALIZATION;
559     if (ktestenv("debug.acpi.avoid"))
560 	flags = ACPI_NO_DEVICE_INIT | ACPI_NO_OBJECT_INIT;
561 
562     /* Bring the hardware and basic handlers online. */
563     if (ACPI_FAILURE(status = AcpiEnableSubsystem(flags))) {
564 	device_printf(dev, "Could not enable ACPI: %s\n",
565 		      AcpiFormatException(status));
566 	goto out;
567     }
568 
569     /*
570      * Fix up the interrupt timer after enabling ACPI, so that the
571      * interrupt cputimer that choked by ACPI power management could
572      * be resurrected before probing various devices.
573      */
574     DELAY(5000);
575     cputimer_intr_pmfixup();
576 
577     /*
578      * Call the ECDT probe function to provide EC functionality before
579      * the namespace has been evaluated.
580      *
581      * XXX This happens before the sysresource devices have been probed and
582      * attached so its resources come from nexus0.  In practice, this isn't
583      * a problem but should be addressed eventually.
584      */
585     acpi_ec_ecdt_probe(dev);
586 
587     /* Bring device objects and regions online. */
588     if (ACPI_FAILURE(status = AcpiInitializeObjects(flags))) {
589 	device_printf(dev, "Could not initialize ACPI objects: %s\n",
590 		      AcpiFormatException(status));
591 	goto out;
592     }
593 
594     /*
595      * Setup our sysctl tree.
596      *
597      * XXX: This doesn't check to make sure that none of these fail.
598      */
599     sysctl_ctx_init(&sc->acpi_sysctl_ctx);
600     sc->acpi_sysctl_tree = SYSCTL_ADD_NODE(&sc->acpi_sysctl_ctx,
601 			       SYSCTL_STATIC_CHILDREN(_hw), OID_AUTO,
602 			       device_get_name(dev), CTLFLAG_RD, 0, "");
603     SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
604 	OID_AUTO, "supported_sleep_state", CTLTYPE_STRING | CTLFLAG_RD,
605 	0, 0, acpi_supported_sleep_state_sysctl, "A", "");
606     SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
607 	OID_AUTO, "power_button_state", CTLTYPE_STRING | CTLFLAG_RW,
608 	&sc->acpi_power_button_sx, 0, acpi_sleep_state_sysctl, "A", "");
609     SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
610 	OID_AUTO, "sleep_button_state", CTLTYPE_STRING | CTLFLAG_RW,
611 	&sc->acpi_sleep_button_sx, 0, acpi_sleep_state_sysctl, "A", "");
612     SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
613 	OID_AUTO, "lid_switch_state", CTLTYPE_STRING | CTLFLAG_RW,
614 	&sc->acpi_lid_switch_sx, 0, acpi_sleep_state_sysctl, "A", "");
615     SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
616 	OID_AUTO, "standby_state", CTLTYPE_STRING | CTLFLAG_RW,
617 	&sc->acpi_standby_sx, 0, acpi_sleep_state_sysctl, "A", "");
618     SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
619 	OID_AUTO, "suspend_state", CTLTYPE_STRING | CTLFLAG_RW,
620 	&sc->acpi_suspend_sx, 0, acpi_sleep_state_sysctl, "A", "");
621     SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
622 	OID_AUTO, "sleep_delay", CTLFLAG_RW, &sc->acpi_sleep_delay, 0,
623 	"sleep delay");
624     SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
625 	OID_AUTO, "s4bios", CTLFLAG_RW, &sc->acpi_s4bios, 0, "S4BIOS mode");
626     SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
627 	OID_AUTO, "verbose", CTLFLAG_RW, &sc->acpi_verbose, 0, "verbose mode");
628     SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
629 	OID_AUTO, "disable_on_reboot", CTLFLAG_RW,
630 	&sc->acpi_do_disable, 0, "Disable ACPI when rebooting/halting system");
631     SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
632 	OID_AUTO, "handle_reboot", CTLFLAG_RW,
633 	&sc->acpi_handle_reboot, 0, "Use ACPI Reset Register to reboot");
634 
635     /*
636      * Default to 1 second before sleeping to give some machines time to
637      * stabilize.
638      */
639     sc->acpi_sleep_delay = 1;
640     if (bootverbose)
641 	sc->acpi_verbose = 1;
642     if ((env = kgetenv("hw.acpi.verbose")) != NULL) {
643 	if (strcmp(env, "0") != 0)
644 	    sc->acpi_verbose = 1;
645 	kfreeenv(env);
646     }
647 
648     /* Only enable reboot by default if the FADT says it is available. */
649     if (AcpiGbl_FADT.Flags & ACPI_FADT_RESET_REGISTER)
650 	sc->acpi_handle_reboot = 1;
651 
652     /* Only enable S4BIOS by default if the FACS says it is available. */
653     if (AcpiGbl_FACS->Flags & ACPI_FACS_S4_BIOS_PRESENT)
654 	sc->acpi_s4bios = 1;
655 
656     /*
657      * Dispatch the default sleep state to devices.  The lid switch is set
658      * to NONE by default to avoid surprising users.
659      */
660     sc->acpi_power_button_sx = ACPI_STATE_S5;
661     sc->acpi_lid_switch_sx = ACPI_S_STATES_MAX + 1;
662     sc->acpi_standby_sx = ACPI_STATE_S1;
663     sc->acpi_suspend_sx = ACPI_STATE_S3;
664 
665     /* Pick the first valid sleep state for the sleep button default. */
666     sc->acpi_sleep_button_sx = ACPI_S_STATES_MAX + 1;
667     for (state = ACPI_STATE_S1; state <= ACPI_STATE_S4; state++)
668 	if (ACPI_SUCCESS(AcpiGetSleepTypeData(state, &TypeA, &TypeB))) {
669 	    sc->acpi_sleep_button_sx = state;
670 	    break;
671 	}
672 
673     acpi_enable_fixed_events(sc);
674 
675     /*
676      * Scan the namespace and attach/initialise children.
677      */
678 
679     /* Register our shutdown handler. */
680     EVENTHANDLER_REGISTER(shutdown_final, acpi_shutdown_final, sc,
681 	SHUTDOWN_PRI_LAST);
682 
683     /*
684      * Register our acpi event handlers.
685      * XXX should be configurable eg. via userland policy manager.
686      */
687     EVENTHANDLER_REGISTER(acpi_sleep_event, acpi_system_eventhandler_sleep,
688 	sc, ACPI_EVENT_PRI_LAST);
689     EVENTHANDLER_REGISTER(acpi_wakeup_event, acpi_system_eventhandler_wakeup,
690 	sc, ACPI_EVENT_PRI_LAST);
691 
692     /* Flag our initial states. */
693     sc->acpi_enabled = 1;
694     sc->acpi_sstate = ACPI_STATE_S0;
695     sc->acpi_sleep_disabled = 0;
696     /* Create the control device */
697     sc->acpi_dev_t = make_dev(&acpi_ops, 0, UID_ROOT, GID_WHEEL, 0644, "acpi");
698     sc->acpi_dev_t->si_drv1 = sc;
699 
700     if ((error = acpi_machdep_init(dev)))
701 	goto out;
702 
703     /* Register ACPI again to pass the correct argument of pm_func. */
704     power_pm_register(POWER_PM_TYPE_ACPI, acpi_pm_func, sc);
705 
706     if (!acpi_disabled("bus"))
707 	acpi_probe_children(dev);
708 
709     /* Update all GPEs and enable runtime GPEs. */
710     status = AcpiUpdateAllGpes();
711     if (ACPI_FAILURE(status)) {
712 	device_printf(dev, "Could not update all GPEs: %s\n",
713 		      AcpiFormatException(status));
714     }
715 
716     /* Allow sleep request after a while. */
717     /* timeout(acpi_sleep_enable, sc, hz * ACPI_MINIMUM_AWAKETIME); */
718 
719     error = 0;
720 
721  out:
722     ACPI_UNLOCK(acpi);
723  out2:
724     cputimer_intr_pmfixup();
725     acpi_task_thread_schedule();
726 
727     return_VALUE (error);
728 }
729 
730 static int
731 acpi_suspend(device_t dev)
732 {
733     device_t child, *devlist;
734     int error, i, numdevs, pstate;
735 
736     /* First give child devices a chance to suspend. */
737     error = bus_generic_suspend(dev);
738     if (error)
739 	return (error);
740 
741     /*
742      * Now, set them into the appropriate power state, usually D3.  If the
743      * device has an _SxD method for the next sleep state, use that power
744      * state instead.
745      */
746     device_get_children(dev, &devlist, &numdevs);
747     for (i = 0; i < numdevs; i++) {
748 	/* If the device is not attached, we've powered it down elsewhere. */
749 	child = devlist[i];
750 	if (!device_is_attached(child))
751 	    continue;
752 
753 	/*
754 	 * Default to D3 for all sleep states.  The _SxD method is optional
755 	 * so set the powerstate even if it's absent.
756 	 */
757 	pstate = PCI_POWERSTATE_D3;
758 	error = acpi_device_pwr_for_sleep(device_get_parent(child),
759 	    child, &pstate);
760 	if ((error == 0 || error == ESRCH) && acpi_do_powerstate)
761 	    pci_set_powerstate(child, pstate);
762     }
763     kfree(devlist, M_TEMP);
764     error = 0;
765 
766     return (error);
767 }
768 
769 static int
770 acpi_resume(device_t dev)
771 {
772     ACPI_HANDLE handle;
773     int i, numdevs;
774     device_t child, *devlist;
775 
776     /*
777      * Put all devices in D0 before resuming them.  Call _S0D on each one
778      * since some systems expect this.
779      */
780     device_get_children(dev, &devlist, &numdevs);
781     for (i = 0; i < numdevs; i++) {
782 	child = devlist[i];
783 	handle = acpi_get_handle(child);
784 	if (handle)
785 	    AcpiEvaluateObject(handle, "_S0D", NULL, NULL);
786 	if (device_is_attached(child) && acpi_do_powerstate)
787 	    pci_set_powerstate(child, PCI_POWERSTATE_D0);
788     }
789     kfree(devlist, M_TEMP);
790 
791     return (bus_generic_resume(dev));
792 }
793 
794 static int
795 acpi_shutdown(device_t dev)
796 {
797     /* Allow children to shutdown first. */
798     bus_generic_shutdown(dev);
799 
800     /*
801      * Enable any GPEs that are able to power-on the system (i.e., RTC).
802      * Also, disable any that are not valid for this state (most).
803      */
804     acpi_wake_prep_walk(ACPI_STATE_S5);
805 
806     return (0);
807 }
808 
809 /*
810  * Handle a new device being added
811  */
812 static device_t
813 acpi_add_child(device_t bus, device_t parent, int order, const char *name, int unit)
814 {
815     struct acpi_device	*ad;
816     device_t		child;
817 
818     if ((ad = kmalloc(sizeof(*ad), M_ACPIDEV, M_NOWAIT | M_ZERO)) == NULL)
819 	return (NULL);
820 
821     resource_list_init(&ad->ad_rl);
822     child = device_add_child_ordered(parent, order, name, unit);
823     if (child != NULL)
824 	device_set_ivars(child, ad);
825     else
826 	kfree(ad, M_ACPIDEV);
827     return (child);
828 }
829 
830 static int
831 acpi_print_child(device_t bus, device_t child)
832 {
833     struct acpi_device	 *adev = device_get_ivars(child);
834     struct resource_list *rl = &adev->ad_rl;
835     int retval = 0;
836 
837     retval += bus_print_child_header(bus, child);
838     retval += resource_list_print_type(rl, "port",  SYS_RES_IOPORT, "%#lx");
839     retval += resource_list_print_type(rl, "iomem", SYS_RES_MEMORY, "%#lx");
840     retval += resource_list_print_type(rl, "irq",   SYS_RES_IRQ,    "%ld");
841     retval += resource_list_print_type(rl, "drq",   SYS_RES_DRQ,    "%ld");
842     if (device_get_flags(child))
843 	retval += kprintf(" flags %#x", device_get_flags(child));
844     retval += bus_print_child_footer(bus, child);
845 
846     return (retval);
847 }
848 
849 /*
850  * If this device is an ACPI child but no one claimed it, attempt
851  * to power it off.  We'll power it back up when a driver is added.
852  *
853  * XXX Disabled for now since many necessary devices (like fdc and
854  * ATA) don't claim the devices we created for them but still expect
855  * them to be powered up.
856  */
857 static void
858 acpi_probe_nomatch(device_t bus, device_t child)
859 {
860 
861     /* pci_set_powerstate(child, PCI_POWERSTATE_D3); */
862 }
863 
864 /*
865  * If a new driver has a chance to probe a child, first power it up.
866  *
867  * XXX Disabled for now (see acpi_probe_nomatch for details).
868  */
869 static void
870 acpi_driver_added(device_t dev, driver_t *driver)
871 {
872     device_t child, *devlist;
873     int i, numdevs;
874 
875     DEVICE_IDENTIFY(driver, dev);
876     device_get_children(dev, &devlist, &numdevs);
877     for (i = 0; i < numdevs; i++) {
878 	child = devlist[i];
879 	if (device_get_state(child) == DS_NOTPRESENT) {
880 	    /* pci_set_powerstate(child, PCI_POWERSTATE_D0); */
881 	    if (device_probe_and_attach(child) != 0) {
882 		; /* pci_set_powerstate(child, PCI_POWERSTATE_D3); */
883 	    }
884 	}
885     }
886     kfree(devlist, M_TEMP);
887 }
888 
889 /* Location hint for devctl(8) */
890 static int
891 acpi_child_location_str_method(device_t cbdev, device_t child, char *buf,
892     size_t buflen)
893 {
894     struct acpi_device *dinfo = device_get_ivars(child);
895 
896     if (dinfo->ad_handle)
897 	ksnprintf(buf, buflen, "handle=%s", acpi_name(dinfo->ad_handle));
898     else
899 	ksnprintf(buf, buflen, "unknown");
900     return (0);
901 }
902 
903 /* PnP information for devctl(8) */
904 static int
905 acpi_child_pnpinfo_str_method(device_t cbdev, device_t child, char *buf,
906     size_t buflen)
907 {
908     ACPI_DEVICE_INFO *adinfo;
909     struct acpi_device *dinfo = device_get_ivars(child);
910 
911     if (ACPI_FAILURE(AcpiGetObjectInfo(dinfo->ad_handle, &adinfo))) {
912 	ksnprintf(buf, buflen, "unknown");
913     } else {
914 	ksnprintf(buf, buflen, "_HID=%s _UID=%s",
915 		 (adinfo->Valid & ACPI_VALID_HID) ?
916 		  adinfo->HardwareId.String : "none",
917 		 (adinfo->Valid & ACPI_VALID_UID) ?
918 		  adinfo->UniqueId.String : "0");
919 	AcpiOsFree(adinfo);
920     }
921     return (0);
922 }
923 
924 /*
925  * Handle per-device ivars
926  */
927 static int
928 acpi_read_ivar(device_t dev, device_t child, int index, uintptr_t *result)
929 {
930     struct acpi_device	*ad;
931 
932     if ((ad = device_get_ivars(child)) == NULL) {
933 	device_printf(child, "device has no ivars\n");
934 	return (ENOENT);
935     }
936 
937     /* ACPI and ISA compatibility ivars */
938     switch(index) {
939     case ACPI_IVAR_HANDLE:
940 	*(ACPI_HANDLE *)result = ad->ad_handle;
941 	break;
942     case ACPI_IVAR_MAGIC:
943 	*result = ad->ad_magic;
944 	break;
945     case ACPI_IVAR_PRIVATE:
946 	*(void **)result = ad->ad_private;
947 	break;
948     case ACPI_IVAR_FLAGS:
949 	*(int *)result = ad->ad_flags;
950 	break;
951     case ACPI_IVAR_RECHECK:
952 	*(int *)result = ad->ad_recheck;
953 	break;
954     case ISA_IVAR_VENDORID:
955     case ISA_IVAR_SERIAL:
956     case ISA_IVAR_COMPATID:
957 	*(int *)result = -1;
958 	break;
959     case ISA_IVAR_LOGICALID:
960 	*(int *)result = acpi_isa_get_logicalid(child);
961 	break;
962     default:
963 	return (ENOENT);
964     }
965 
966     return (0);
967 }
968 
969 static int
970 acpi_write_ivar(device_t dev, device_t child, int index, uintptr_t value)
971 {
972     struct acpi_device	*ad;
973 
974     if ((ad = device_get_ivars(child)) == NULL) {
975 	device_printf(child, "device has no ivars\n");
976 	return (ENOENT);
977     }
978 
979     switch(index) {
980     case ACPI_IVAR_HANDLE:
981 	ad->ad_handle = (ACPI_HANDLE)value;
982 	break;
983     case ACPI_IVAR_MAGIC:
984 	ad->ad_magic = value;
985 	break;
986     case ACPI_IVAR_PRIVATE:
987 	ad->ad_private = (void *)value;
988 	break;
989     case ACPI_IVAR_FLAGS:
990 	ad->ad_flags = (int)value;
991 	break;
992     case ACPI_IVAR_RECHECK:
993 	ad->ad_recheck = (int)value;
994 	break;
995     default:
996 	panic("bad ivar write request (%d)", index);
997 	return (ENOENT);
998     }
999 
1000     return (0);
1001 }
1002 
1003 /*
1004  * Handle child resource allocation/removal
1005  */
1006 static struct resource_list *
1007 acpi_get_rlist(device_t dev, device_t child)
1008 {
1009     struct acpi_device		*ad;
1010 
1011     ad = device_get_ivars(child);
1012     return (&ad->ad_rl);
1013 }
1014 
1015 /*
1016  * Pre-allocate/manage all memory and IO resources.  Since rman can't handle
1017  * duplicates, we merge any in the sysresource attach routine.
1018  */
1019 static int
1020 acpi_sysres_alloc(device_t dev)
1021 {
1022     struct resource *res;
1023     struct resource_list *rl;
1024     struct resource_list_entry *rle;
1025     struct rman *rm;
1026     char *sysres_ids[] = { "PNP0C01", "PNP0C02", NULL };
1027     device_t *children;
1028     int child_count, i;
1029     /*
1030      * Probe/attach any sysresource devices.  This would be unnecessary if we
1031      * had multi-pass probe/attach.
1032      */
1033     if (device_get_children(dev, &children, &child_count) != 0)
1034 	return (ENXIO);
1035     for (i = 0; i < child_count; i++) {
1036 	if (ACPI_ID_PROBE(dev, children[i], sysres_ids) != NULL)
1037 	    device_probe_and_attach(children[i]);
1038     }
1039     kfree(children, M_TEMP);
1040 
1041     rl = BUS_GET_RESOURCE_LIST(device_get_parent(dev), dev);
1042     if(!rl)
1043 	return 0;
1044     SLIST_FOREACH(rle, rl, link) {
1045 	if (rle->res != NULL) {
1046 	    device_printf(dev, "duplicate resource for %lx\n", rle->start);
1047 	    continue;
1048 	}
1049 
1050 	/* Only memory and IO resources are valid here. */
1051 	switch (rle->type) {
1052 	case SYS_RES_IOPORT:
1053 	    rm = &acpi_rman_io;
1054 	    break;
1055 	case SYS_RES_MEMORY:
1056 	    rm = &acpi_rman_mem;
1057 	    break;
1058 	default:
1059 	    continue;
1060 	}
1061 
1062 	/* Pre-allocate resource and add to our rman pool. */
1063 	res = BUS_ALLOC_RESOURCE(device_get_parent(dev), dev, rle->type,
1064 	    &rle->rid, rle->start, rle->start + rle->count - 1, rle->count,
1065 	    0, -1);
1066 	if (res != NULL) {
1067 	    rman_manage_region(rm, rman_get_start(res), rman_get_end(res));
1068 	    rle->res = res;
1069 	} else
1070 	    device_printf(dev, "reservation of %lx, %lx (%d) failed\n",
1071 		rle->start, rle->count, rle->type);
1072     }
1073     return (0);
1074 }
1075 
1076 static struct resource *
1077 acpi_alloc_resource(device_t bus, device_t child, int type, int *rid,
1078     u_long start, u_long end, u_long count, u_int flags, int cpuid)
1079 {
1080     ACPI_RESOURCE ares;
1081     struct acpi_device *ad = device_get_ivars(child);
1082     struct resource_list *rl = &ad->ad_rl;
1083     struct resource_list_entry *rle;
1084     struct resource *res;
1085     struct rman *rm;
1086 
1087     res = NULL;
1088 
1089     /* We only handle memory and IO resources through rman. */
1090     switch (type) {
1091     case SYS_RES_IOPORT:
1092 	rm = &acpi_rman_io;
1093 	break;
1094     case SYS_RES_MEMORY:
1095 	rm = &acpi_rman_mem;
1096 	break;
1097     default:
1098 	rm = NULL;
1099     }
1100 
1101     ACPI_SERIAL_BEGIN(acpi);
1102 
1103     /*
1104      * If this is an allocation of the "default" range for a given RID, and
1105      * we know what the resources for this device are (i.e., they're on the
1106      * child's resource list), use those start/end values.
1107      */
1108     if (bus == device_get_parent(child) && start == 0UL && end == ~0UL) {
1109 	rle = resource_list_find(rl, type, *rid);
1110 	if (rle == NULL)
1111 	    goto out;
1112 	start = rle->start;
1113 	end = rle->end;
1114 	count = rle->count;
1115 	cpuid = rle->cpuid;
1116     }
1117 
1118     /*
1119      * If this is an allocation of a specific range, see if we can satisfy
1120      * the request from our system resource regions.  If we can't, pass the
1121      * request up to the parent.
1122      */
1123     if (start + count - 1 == end && rm != NULL)
1124 	res = rman_reserve_resource(rm, start, end, count, flags & ~RF_ACTIVE,
1125 	    child);
1126     if (res == NULL) {
1127 	res = BUS_ALLOC_RESOURCE(device_get_parent(bus), child, type, rid,
1128 	    start, end, count, flags, cpuid);
1129     } else {
1130 	rman_set_rid(res, *rid);
1131 
1132 	/* If requested, activate the resource using the parent's method. */
1133 	if (flags & RF_ACTIVE)
1134 	    if (bus_activate_resource(child, type, *rid, res) != 0) {
1135 		rman_release_resource(res);
1136 		res = NULL;
1137 		goto out;
1138 	    }
1139     }
1140 
1141     if (res != NULL && device_get_parent(child) == bus)
1142 	switch (type) {
1143 	case SYS_RES_IRQ:
1144 	    /*
1145 	     * Since bus_config_intr() takes immediate effect, we cannot
1146 	     * configure the interrupt associated with a device when we
1147 	     * parse the resources but have to defer it until a driver
1148 	     * actually allocates the interrupt via bus_alloc_resource().
1149 	     *
1150 	     * NB: Lookup failure is fine, since the device may add its
1151 	     * own interrupt resources, e.g. MSI or MSI-X.
1152 	     */
1153 	    if (ACPI_SUCCESS(
1154 		    acpi_lookup_irq_resource(child, *rid, res, &ares))) {
1155 		acpi_config_intr(child, &ares);
1156 	    } else {
1157 		kprintf("irq resource not found\n");
1158 	    }
1159 	    break;
1160 	}
1161 
1162 out:
1163     ACPI_SERIAL_END(acpi);
1164     return (res);
1165 }
1166 
1167 static int
1168 acpi_release_resource(device_t bus, device_t child, int type, int rid,
1169     struct resource *r)
1170 {
1171     struct rman *rm;
1172     int ret;
1173 
1174     /* We only handle memory and IO resources through rman. */
1175     switch (type) {
1176     case SYS_RES_IOPORT:
1177 	rm = &acpi_rman_io;
1178 	break;
1179     case SYS_RES_MEMORY:
1180 	rm = &acpi_rman_mem;
1181 	break;
1182     default:
1183 	rm = NULL;
1184     }
1185 
1186     ACPI_SERIAL_BEGIN(acpi);
1187 
1188     /*
1189      * If this resource belongs to one of our internal managers,
1190      * deactivate it and release it to the local pool.  If it doesn't,
1191      * pass this request up to the parent.
1192      */
1193     if (rm != NULL && rman_is_region_manager(r, rm)) {
1194 	if (rman_get_flags(r) & RF_ACTIVE) {
1195 	    ret = bus_deactivate_resource(child, type, rid, r);
1196 	    if (ret != 0)
1197 		goto out;
1198 	}
1199 	ret = rman_release_resource(r);
1200     } else
1201 	ret = BUS_RELEASE_RESOURCE(device_get_parent(bus), child, type, rid, r);
1202 
1203 out:
1204     ACPI_SERIAL_END(acpi);
1205     return (ret);
1206 }
1207 
1208 static void
1209 acpi_delete_resource(device_t bus, device_t child, int type, int rid)
1210 {
1211     struct resource_list *rl;
1212 
1213     rl = acpi_get_rlist(bus, child);
1214     resource_list_delete(rl, type, rid);
1215 }
1216 
1217 /* Allocate an IO port or memory resource, given its GAS. */
1218 int
1219 acpi_bus_alloc_gas(device_t dev, int *type, int *rid, ACPI_GENERIC_ADDRESS *gas,
1220     struct resource **res, u_int flags)
1221 {
1222     int error, res_type;
1223 
1224     error = ENOMEM;
1225     if (type == NULL || rid == NULL || gas == NULL || res == NULL)
1226 	return (EINVAL);
1227 
1228     /* We only support memory and IO spaces. */
1229     switch (gas->SpaceId) {
1230     case ACPI_ADR_SPACE_SYSTEM_MEMORY:
1231 	res_type = SYS_RES_MEMORY;
1232 	break;
1233     case ACPI_ADR_SPACE_SYSTEM_IO:
1234 	res_type = SYS_RES_IOPORT;
1235 	break;
1236     default:
1237 	return (EOPNOTSUPP);
1238     }
1239 
1240     /*
1241      * If the register width is less than 8, assume the BIOS author means
1242      * it is a bit field and just allocate a byte.
1243      */
1244     if (gas->BitWidth && gas->BitWidth < 8)
1245 	gas->BitWidth = 8;
1246 
1247     /* Validate the address after we're sure we support the space. */
1248     if (gas->Address == 0 || gas->BitWidth == 0)
1249 	return (EINVAL);
1250 
1251     bus_set_resource(dev, res_type, *rid, gas->Address,
1252 	gas->BitWidth / 8, -1);
1253     *res = bus_alloc_resource_any(dev, res_type, rid, RF_ACTIVE | flags);
1254     if (*res != NULL) {
1255 	*type = res_type;
1256 	error = 0;
1257     } else
1258 	bus_delete_resource(dev, res_type, *rid);
1259 
1260     return (error);
1261 }
1262 
1263 ACPI_STATUS
1264 acpi_eval_osc(device_t dev, ACPI_HANDLE handle, const char *uuidstr,
1265     int revision, uint32_t *buf, int count)
1266 {
1267     ACPI_BUFFER		retbuf = { ACPI_ALLOCATE_BUFFER, NULL };
1268     ACPI_OBJECT_LIST	arglist;
1269     ACPI_OBJECT		arg[4];
1270     ACPI_OBJECT		*retobj;
1271     ACPI_STATUS		status;
1272     struct uuid		uuid;
1273     uint32_t		error;
1274     uint8_t		oscuuid[ACPI_UUID_LENGTH];
1275     int			i;
1276 
1277     if (parse_uuid(uuidstr, &uuid) != 0)
1278 	    return (AE_ERROR);
1279     le_uuid_enc(oscuuid, &uuid);
1280 
1281     arglist.Pointer = arg;
1282     arglist.Count = 4;
1283     arg[0].Type = ACPI_TYPE_BUFFER;
1284     arg[0].Buffer.Length = ACPI_UUID_LENGTH;
1285     arg[0].Buffer.Pointer = oscuuid;		/* UUID */
1286     arg[1].Type = ACPI_TYPE_INTEGER;
1287     arg[1].Integer.Value = revision;		/* revision */
1288     arg[2].Type = ACPI_TYPE_INTEGER;
1289     arg[2].Integer.Value = count;		/* # of cap integers */
1290     arg[3].Type = ACPI_TYPE_BUFFER;
1291     arg[3].Buffer.Length = count * sizeof(uint32_t); /* capabilities buffer */
1292     arg[3].Buffer.Pointer = (uint8_t *)buf;
1293 
1294     status = AcpiEvaluateObject(handle, "_OSC", &arglist, &retbuf);
1295     if (ACPI_FAILURE(status))
1296 	goto done;
1297     retobj = retbuf.Pointer;
1298     error = ((uint32_t *)retobj->Buffer.Pointer)[0] & ACPI_OSC_ERRMASK;
1299     if (error == 0)
1300 	goto done;
1301     status = AE_ERROR;
1302     if (error & ACPI_OSCERR_FAILURE)
1303 	device_printf(dev, "_OSC unable to process request\n");
1304     if (error & ACPI_OSCERR_BADUUID)
1305 	device_printf(dev, "_OSC unrecognized UUID (%s)\n", uuidstr);
1306     if (error & ACPI_OSCERR_BADREV)
1307 	device_printf(dev, "_OSC unrecognized revision ID (%d)\n", revision);
1308     if (error & ACPI_OSCERR_CAPSMASKED) {
1309 	if ((buf[0] & ACPI_OSC_QUERY_SUPPORT) == 0) {
1310 	    for (i = 1; i < count; i++) {
1311 		device_printf(dev,
1312 		    "_OSC capabilities have been masked: buf[%d]:%#x\n",
1313 		    i, buf[i] & ~((uint32_t *)retobj->Buffer.Pointer)[i]);
1314 	    }
1315 	    status = AE_SUPPORT;
1316 	} else {
1317 	    status = AE_OK;
1318 	}
1319     }
1320     if (buf[0] & ACPI_OSC_QUERY_SUPPORT) {
1321 	for (i = 0; i < count; i++)
1322 	    buf[i] = ((uint32_t *)retobj->Buffer.Pointer)[i];
1323     }
1324 
1325 done:
1326     if (retbuf.Pointer != NULL)
1327 	AcpiOsFree(retbuf.Pointer);
1328     return (status);
1329 }
1330 
1331 /* Probe _HID and _CID for compatible ISA PNP ids. */
1332 static uint32_t
1333 acpi_isa_get_logicalid(device_t dev)
1334 {
1335     ACPI_DEVICE_INFO	*devinfo;
1336     ACPI_HANDLE		h;
1337     uint32_t		pnpid;
1338 
1339     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1340 
1341     devinfo = NULL;
1342     pnpid = 0;
1343 
1344     /* Fetch and validate the HID. */
1345     if ((h = acpi_get_handle(dev)) == NULL ||
1346 	ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo)))
1347 	goto out;
1348 
1349     if ((devinfo->Valid & ACPI_VALID_HID) != 0)
1350 	pnpid = PNP_EISAID(devinfo->HardwareId.String);
1351 
1352 out:
1353     if (devinfo)
1354 	AcpiOsFree(devinfo);
1355     return_VALUE (pnpid);
1356 }
1357 
1358 static int
1359 acpi_isa_get_compatid(device_t dev, uint32_t *cids, int count)
1360 {
1361     ACPI_DEVICE_INFO	*devinfo;
1362     ACPI_HANDLE		h;
1363     uint32_t		*pnpid;
1364     int			valid, i;
1365 
1366     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1367 
1368     devinfo = NULL;
1369     pnpid = cids;
1370     valid = 0;
1371 
1372     /* Fetch and validate the CID */
1373     if ((h = acpi_get_handle(dev)) == NULL ||
1374 	ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo)) ||
1375 	(devinfo->Valid & ACPI_VALID_CID) == 0)
1376 	goto out;
1377 
1378     if (devinfo->CompatibleIdList.Count < count)
1379 	count = devinfo->CompatibleIdList.Count;
1380     for (i = 0; i < count; i++) {
1381 	if (strncmp(devinfo->CompatibleIdList.Ids[i].String, "PNP", 3) != 0)
1382 	    continue;
1383 	*pnpid++ = PNP_EISAID(devinfo->CompatibleIdList.Ids[i].String);
1384 	valid++;
1385     }
1386 
1387 out:
1388     if (devinfo)
1389 	AcpiOsFree(devinfo);
1390     return_VALUE (valid);
1391 }
1392 
1393 static char *
1394 acpi_device_id_probe(device_t bus, device_t dev, char **ids)
1395 {
1396     ACPI_HANDLE h;
1397     int i;
1398 
1399     h = acpi_get_handle(dev);
1400     if (ids == NULL || h == NULL || acpi_get_type(dev) != ACPI_TYPE_DEVICE)
1401 	return (NULL);
1402 
1403     /* Try to match one of the array of IDs with a HID or CID. */
1404     for (i = 0; ids[i] != NULL; i++) {
1405 	if (acpi_MatchHid(h, ids[i]))
1406 	    return (ids[i]);
1407     }
1408     return (NULL);
1409 }
1410 
1411 static ACPI_STATUS
1412 acpi_device_eval_obj(device_t bus, device_t dev, ACPI_STRING pathname,
1413     ACPI_OBJECT_LIST *parameters, ACPI_BUFFER *ret)
1414 {
1415     ACPI_HANDLE h;
1416 
1417     if (dev == NULL)
1418 	h = ACPI_ROOT_OBJECT;
1419     else if ((h = acpi_get_handle(dev)) == NULL)
1420 	return (AE_BAD_PARAMETER);
1421     return (AcpiEvaluateObject(h, pathname, parameters, ret));
1422 }
1423 
1424 static int
1425 acpi_device_pwr_for_sleep(device_t bus, device_t dev, int *dstate)
1426 {
1427     struct acpi_softc *sc;
1428     ACPI_HANDLE handle;
1429     ACPI_STATUS status;
1430     char sxd[8];
1431     int error;
1432 
1433     sc = device_get_softc(bus);
1434     handle = acpi_get_handle(dev);
1435 
1436     /*
1437      * XXX If we find these devices, don't try to power them down.
1438      * The serial and IRDA ports on my T23 hang the system when
1439      * set to D3 and it appears that such legacy devices may
1440      * need special handling in their drivers.
1441      */
1442     if (handle == NULL ||
1443 	acpi_MatchHid(handle, "PNP0500") ||
1444 	acpi_MatchHid(handle, "PNP0501") ||
1445 	acpi_MatchHid(handle, "PNP0502") ||
1446 	acpi_MatchHid(handle, "PNP0510") ||
1447 	acpi_MatchHid(handle, "PNP0511"))
1448 	return (ENXIO);
1449 
1450     /*
1451      * Override next state with the value from _SxD, if present.  If no
1452      * dstate argument was provided, don't fetch the return value.
1453      */
1454     ksnprintf(sxd, sizeof(sxd), "_S%dD", sc->acpi_sstate);
1455     if (dstate)
1456 	status = acpi_GetInteger(handle, sxd, dstate);
1457     else
1458 	status = AcpiEvaluateObject(handle, sxd, NULL, NULL);
1459 
1460     switch (status) {
1461     case AE_OK:
1462 	error = 0;
1463 	break;
1464     case AE_NOT_FOUND:
1465 	error = ESRCH;
1466 	break;
1467     default:
1468 	error = ENXIO;
1469 	break;
1470     }
1471 
1472     return (error);
1473 }
1474 
1475 /* Callback arg for our implementation of walking the namespace. */
1476 struct acpi_device_scan_ctx {
1477     acpi_scan_cb_t	user_fn;
1478     void		*arg;
1479     ACPI_HANDLE		parent;
1480 };
1481 
1482 static ACPI_STATUS
1483 acpi_device_scan_cb(ACPI_HANDLE h, UINT32 level, void *arg, void **retval)
1484 {
1485     struct acpi_device_scan_ctx *ctx;
1486     device_t dev, old_dev;
1487     ACPI_STATUS status;
1488     ACPI_OBJECT_TYPE type;
1489 
1490     /*
1491      * Skip this device if we think we'll have trouble with it or it is
1492      * the parent where the scan began.
1493      */
1494     ctx = (struct acpi_device_scan_ctx *)arg;
1495     if (acpi_avoid(h) || h == ctx->parent)
1496 	return (AE_OK);
1497 
1498     /* If this is not a valid device type (e.g., a method), skip it. */
1499     if (ACPI_FAILURE(AcpiGetType(h, &type)))
1500 	return (AE_OK);
1501     if (type != ACPI_TYPE_DEVICE && type != ACPI_TYPE_PROCESSOR &&
1502 	type != ACPI_TYPE_THERMAL && type != ACPI_TYPE_POWER)
1503 	return (AE_OK);
1504 
1505     /*
1506      * Call the user function with the current device.  If it is unchanged
1507      * afterwards, return.  Otherwise, we update the handle to the new dev.
1508      */
1509     old_dev = acpi_get_device(h);
1510     dev = old_dev;
1511     status = ctx->user_fn(h, &dev, level, ctx->arg);
1512     if (ACPI_FAILURE(status) || old_dev == dev)
1513 	return (status);
1514 
1515     /* Remove the old child and its connection to the handle. */
1516     if (old_dev != NULL) {
1517 	device_delete_child(device_get_parent(old_dev), old_dev);
1518 	AcpiDetachData(h, acpi_fake_objhandler);
1519     }
1520 
1521     /* Recreate the handle association if the user created a device. */
1522     if (dev != NULL)
1523 	AcpiAttachData(h, acpi_fake_objhandler, dev);
1524 
1525     return (AE_OK);
1526 }
1527 
1528 static ACPI_STATUS
1529 acpi_device_scan_children(device_t bus, device_t dev, int max_depth,
1530     acpi_scan_cb_t user_fn, void *arg)
1531 {
1532     ACPI_HANDLE h;
1533     struct acpi_device_scan_ctx ctx;
1534 
1535     if (acpi_disabled("children"))
1536 	return (AE_OK);
1537 
1538     if (dev == NULL)
1539 	h = ACPI_ROOT_OBJECT;
1540     else if ((h = acpi_get_handle(dev)) == NULL)
1541 	return (AE_BAD_PARAMETER);
1542     ctx.user_fn = user_fn;
1543     ctx.arg = arg;
1544     ctx.parent = h;
1545     return (AcpiWalkNamespace(ACPI_TYPE_ANY, h, max_depth,
1546 	acpi_device_scan_cb, NULL, &ctx, NULL));
1547 }
1548 
1549 /*
1550  * Even though ACPI devices are not PCI, we use the PCI approach for setting
1551  * device power states since it's close enough to ACPI.
1552  */
1553 static int
1554 acpi_set_powerstate_method(device_t bus, device_t child, int state)
1555 {
1556     ACPI_HANDLE h;
1557     ACPI_STATUS status;
1558     int error;
1559 
1560     error = 0;
1561     h = acpi_get_handle(child);
1562     if (state < ACPI_STATE_D0 || state > ACPI_STATE_D3)
1563 	return (EINVAL);
1564     if (h == NULL)
1565 	return (0);
1566 
1567     /* Ignore errors if the power methods aren't present. */
1568     status = acpi_pwr_switch_consumer(h, state);
1569     if (ACPI_FAILURE(status) && status != AE_NOT_FOUND
1570 	&& status != AE_BAD_PARAMETER)
1571 	device_printf(bus, "failed to set ACPI power state D%d on %s: %s\n",
1572 	    state, acpi_name(h), AcpiFormatException(status));
1573 
1574     return (error);
1575 }
1576 
1577 static int
1578 acpi_isa_pnp_probe(device_t bus, device_t child, struct isa_pnp_id *ids)
1579 {
1580     int			result, cid_count, i;
1581     uint32_t		lid, cids[8];
1582 
1583     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1584 
1585     /*
1586      * ISA-style drivers attached to ACPI may persist and
1587      * probe manually if we return ENOENT.  We never want
1588      * that to happen, so don't ever return it.
1589      */
1590     result = ENXIO;
1591 
1592     /* Scan the supplied IDs for a match */
1593     lid = acpi_isa_get_logicalid(child);
1594     cid_count = acpi_isa_get_compatid(child, cids, 8);
1595     while (ids && ids->ip_id) {
1596 	if (lid == ids->ip_id) {
1597 	    result = 0;
1598 	    goto out;
1599 	}
1600 	for (i = 0; i < cid_count; i++) {
1601 	    if (cids[i] == ids->ip_id) {
1602 		result = 0;
1603 		goto out;
1604 	    }
1605 	}
1606 	ids++;
1607     }
1608 
1609  out:
1610     if (result == 0 && ids->ip_desc)
1611 	device_set_desc(child, ids->ip_desc);
1612 
1613     return_VALUE (result);
1614 }
1615 
1616 /*
1617  * Look for a MCFG table.  If it is present, use the settings for
1618  * domain (segment) 0 to setup PCI config space access via the memory
1619  * map.
1620  */
1621 static void
1622 acpi_enable_pcie(void)
1623 {
1624 	ACPI_TABLE_HEADER *hdr;
1625 	ACPI_MCFG_ALLOCATION *alloc, *end;
1626 	ACPI_STATUS status;
1627 
1628 	status = AcpiGetTable(ACPI_SIG_MCFG, 1, &hdr);
1629 	if (ACPI_FAILURE(status))
1630 		return;
1631 
1632 	end = (ACPI_MCFG_ALLOCATION *)((char *)hdr + hdr->Length);
1633 	alloc = (ACPI_MCFG_ALLOCATION *)((ACPI_TABLE_MCFG *)hdr + 1);
1634 	while (alloc < end) {
1635 		if (alloc->PciSegment == 0) {
1636 			pcie_cfgregopen(alloc->Address, alloc->StartBusNumber,
1637 			    alloc->EndBusNumber);
1638 			return;
1639 		}
1640 		alloc++;
1641 	}
1642 }
1643 
1644 /*
1645  * Scan all of the ACPI namespace and attach child devices.
1646  *
1647  * We should only expect to find devices in the \_PR, \_TZ, \_SI, and
1648  * \_SB scopes, and \_PR and \_TZ became obsolete in the ACPI 2.0 spec.
1649  * However, in violation of the spec, some systems place their PCI link
1650  * devices in \, so we have to walk the whole namespace.  We check the
1651  * type of namespace nodes, so this should be ok.
1652  */
1653 static void
1654 acpi_probe_children(device_t bus)
1655 {
1656     device_t *children;
1657     int cnt;
1658 
1659     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1660 
1661     /*
1662      * Scan the namespace and insert placeholders for all the devices that
1663      * we find.  We also probe/attach any early devices.
1664      *
1665      * Note that we use AcpiWalkNamespace rather than AcpiGetDevices because
1666      * we want to create nodes for all devices, not just those that are
1667      * currently present. (This assumes that we don't want to create/remove
1668      * devices as they appear, which might be smarter.)
1669      */
1670     ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "namespace scan\n"));
1671     AcpiWalkNamespace(ACPI_TYPE_ANY, ACPI_ROOT_OBJECT, 100,
1672 	acpi_probe_child, NULL, bus, NULL);
1673     /* This gets us all the children that we added from the ACPI namespace. */
1674     device_get_children(bus, &children, &cnt);
1675 
1676     /* Pre-allocate resources for our rman from any sysresource devices. */
1677     acpi_sysres_alloc(bus);
1678     /* Create any static children by calling device identify methods. */
1679     ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "device identify routines\n"));
1680     bus_generic_probe(bus);
1681 
1682     /* Probe/attach all children, created staticly and from the namespace. */
1683     ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "first bus_generic_attach\n"));
1684     bus_generic_attach_gpri(bus, KOBJ_GPRI_ACPI+2);
1685     ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "second bus_generic_attach\n"));
1686     bus_generic_attach_gpri(bus, KOBJ_GPRI_ACPI+1);
1687     /* Re-check device presence for previously disabled devices. */
1688     acpi_reprobe_children(bus, children, cnt);
1689     kfree(children, M_TEMP);
1690     ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "third bus_generic_attach\n"));
1691     bus_generic_attach_gpri(bus, KOBJ_GPRI_ACPI);
1692     ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "fourth bus_generic_attach\n"));
1693     bus_generic_attach_gpri(bus, KOBJ_GPRI_ACPI);
1694 
1695     /*
1696      * Some of these children may have attached others as part of their attach
1697      * process (eg. the root PCI bus driver), so rescan.
1698      */
1699     ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "fifth bus_generic_attach\n"));
1700     bus_generic_attach(bus);
1701 
1702     ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "sixth bus_generic_attach\n"));
1703     bus_generic_attach(bus);
1704 
1705     /* Attach wake sysctls. */
1706     acpi_wake_sysctl_walk(bus);
1707 
1708     ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "done attaching children\n"));
1709     return_VOID;
1710 }
1711 
1712 /*
1713  * Determine the probe order for a given device.
1714  */
1715 static void
1716 acpi_probe_order(ACPI_HANDLE handle, int *order)
1717 {
1718     ACPI_OBJECT_TYPE type;
1719 
1720     /*
1721      * 1. I/O port and memory system resource holders
1722      * 2. Embedded controllers (to handle early accesses)
1723      * 3. PCI Link Devices
1724      * 100000. CPUs
1725      */
1726     AcpiGetType(handle, &type);
1727     if (acpi_MatchHid(handle, "PNP0C01") || acpi_MatchHid(handle, "PNP0C02"))
1728 	*order = 1;
1729     else if (acpi_MatchHid(handle, "PNP0C09"))
1730 	*order = 2;
1731     else if (acpi_MatchHid(handle, "PNP0C0F"))
1732 	*order = 3;
1733     else if (type == ACPI_TYPE_PROCESSOR)
1734 	*order = 100000;
1735 }
1736 
1737 /*
1738  * Flag a device as disabled, because it isn't present according to the
1739  * _STA method. We set the recheck instance-variable, to make sure that we
1740  * recheck the device presence at a later point.
1741  */
1742 static void
1743 acpi_disable_not_present(device_t child)
1744 {
1745 	device_disable(child);
1746 	acpi_set_recheck(child, 1);
1747 }
1748 
1749 /*
1750  * This rechecks the device presence for all the devices which were disabled
1751  * using acpi_disable_not_present().
1752  */
1753 static void
1754 acpi_reprobe_children(device_t bus, device_t *children, int cnt)
1755 {
1756 	int i;
1757 
1758 	for (i = 0; i < cnt; i++) {
1759 		device_t dev = children[i];
1760 
1761 		if (device_is_enabled(dev))
1762 			continue;
1763 
1764 		if (acpi_get_recheck(dev)) {
1765 			if (acpi_DeviceIsPresent(dev)) {
1766 				acpi_set_recheck(dev, 0);
1767 				device_enable(dev);
1768 				/*
1769 				 * Currently we parse the resources for every
1770 				 * device at the first time, when we see
1771 				 * that it is present.
1772 				 */
1773 				acpi_parse_resources(dev, acpi_get_handle(dev),
1774 				    &acpi_res_parse_set, NULL);
1775 			}
1776 		}
1777 	}
1778 }
1779 
1780 /*
1781  * Evaluate a child device and determine whether we might attach a device to
1782  * it.
1783  */
1784 static ACPI_STATUS
1785 acpi_probe_child(ACPI_HANDLE handle, UINT32 level, void *context, void **status)
1786 {
1787     struct acpi_prw_data prw;
1788     ACPI_OBJECT_TYPE type;
1789     ACPI_HANDLE h;
1790     device_t bus, child;
1791     int order;
1792     char *handle_str;
1793 
1794     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1795 
1796     if (acpi_disabled("children"))
1797 	return_ACPI_STATUS (AE_OK);
1798 
1799     /* Skip this device if we think we'll have trouble with it. */
1800     if (acpi_avoid(handle))
1801 	return_ACPI_STATUS (AE_OK);
1802 
1803     bus = (device_t)context;
1804     if (ACPI_SUCCESS(AcpiGetType(handle, &type))) {
1805 	handle_str = acpi_name(handle);
1806 	switch (type) {
1807 	case ACPI_TYPE_DEVICE:
1808 	    /*
1809 	     * Since we scan from \, be sure to skip system scope objects.
1810 	     * \_SB_ and \_TZ_ are defined in ACPICA as devices to work around
1811 	     * BIOS bugs.  For example, \_SB_ is to allow \_SB_._INI to be run
1812 	     * during the intialization and \_TZ_ is to support Notify() on it.
1813 	     */
1814 	    if (strcmp(handle_str, "\\_SB_") == 0 ||
1815 		strcmp(handle_str, "\\_TZ_") == 0)
1816 		break;
1817 
1818 	    if (acpi_parse_prw(handle, &prw) == 0)
1819 		AcpiSetupGpeForWake(handle, prw.gpe_handle, prw.gpe_bit);
1820 
1821 	    /* FALLTHROUGH */
1822 	case ACPI_TYPE_PROCESSOR:
1823 	case ACPI_TYPE_THERMAL:
1824 	case ACPI_TYPE_POWER:
1825 	    /*
1826 	     * Create a placeholder device for this node.  Sort the
1827 	     * placeholder so that the probe/attach passes will run
1828 	     * breadth-first.  Orders less than ACPI_DEV_BASE_ORDER
1829 	     * are reserved for special objects (i.e., system
1830 	     * resources).  CPU devices have a very high order to
1831 	     * ensure they are probed after other devices.
1832 	     */
1833 	    ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "scanning '%s'\n", handle_str));
1834 	    order = level * 10 + 100;
1835 	    acpi_probe_order(handle, &order);
1836 	    child = BUS_ADD_CHILD(bus, bus, order, NULL, -1);
1837 	    if (child == NULL)
1838 		break;
1839 
1840 	    /* Associate the handle with the device_t and vice versa. */
1841 	    acpi_set_handle(child, handle);
1842 	    AcpiAttachData(handle, acpi_fake_objhandler, child);
1843 
1844 	    /*
1845 	     * Check that the device is present.  If it's not present,
1846 	     * leave it disabled (so that we have a device_t attached to
1847 	     * the handle, but we don't probe it).
1848 	     *
1849 	     * XXX PCI link devices sometimes report "present" but not
1850 	     * "functional" (i.e. if disabled).  Go ahead and probe them
1851 	     * anyway since we may enable them later.
1852 	     */
1853 	    if (type == ACPI_TYPE_DEVICE && !acpi_DeviceIsPresent(child)) {
1854 		/* Never disable PCI link devices. */
1855 		if (acpi_MatchHid(handle, "PNP0C0F"))
1856 		    break;
1857 		/*
1858 		 * Docking stations should remain enabled since the system
1859 		 * may be undocked at boot.
1860 		 */
1861 		if (ACPI_SUCCESS(AcpiGetHandle(handle, "_DCK", &h)))
1862 		    break;
1863 
1864 		acpi_disable_not_present(child);
1865 		break;
1866 	    }
1867 
1868 	    /*
1869 	     * Get the device's resource settings and attach them.
1870 	     * Note that if the device has _PRS but no _CRS, we need
1871 	     * to decide when it's appropriate to try to configure the
1872 	     * device.  Ignore the return value here; it's OK for the
1873 	     * device not to have any resources.
1874 	     */
1875 	    acpi_parse_resources(child, handle, &acpi_res_parse_set, NULL);
1876 	    break;
1877 	}
1878     }
1879 
1880     return_ACPI_STATUS (AE_OK);
1881 }
1882 
1883 /*
1884  * AcpiAttachData() requires an object handler but never uses it.  This is a
1885  * placeholder object handler so we can store a device_t in an ACPI_HANDLE.
1886  */
1887 void
1888 acpi_fake_objhandler(ACPI_HANDLE h, void *data)
1889 {
1890 }
1891 
1892 static void
1893 acpi_shutdown_final(void *arg, int howto)
1894 {
1895     struct acpi_softc *sc;
1896     ACPI_STATUS status;
1897 
1898     /*
1899      * XXX Shutdown code should only run on the BSP (cpuid 0).
1900      * Some chipsets do not power off the system correctly if called from
1901      * an AP.
1902      */
1903     sc = arg;
1904     if ((howto & RB_POWEROFF) != 0) {
1905 	status = AcpiEnterSleepStatePrep(ACPI_STATE_S5);
1906 	if (ACPI_FAILURE(status)) {
1907 	    device_printf(sc->acpi_dev, "AcpiEnterSleepStatePrep failed - %s\n",
1908 		   AcpiFormatException(status));
1909 	    return;
1910 	}
1911 	device_printf(sc->acpi_dev, "Powering system off\n");
1912 	ACPI_DISABLE_IRQS();
1913 	status = AcpiEnterSleepState(ACPI_STATE_S5);
1914 	if (ACPI_FAILURE(status)) {
1915 	    device_printf(sc->acpi_dev, "power-off failed - %s\n",
1916 		AcpiFormatException(status));
1917 	} else {
1918 	    DELAY(1000000);
1919 	    device_printf(sc->acpi_dev, "power-off failed - timeout\n");
1920 	}
1921     } else if ((howto & RB_HALT) == 0 && sc->acpi_handle_reboot) {
1922 	/* Reboot using the reset register. */
1923 	status = AcpiReset();
1924 	if (ACPI_FAILURE(status)) {
1925 	    if (status != AE_NOT_EXIST)
1926 		    device_printf(sc->acpi_dev, "reset failed - %s\n",
1927 			AcpiFormatException(status));
1928 	} else {
1929 	    DELAY(1000000);
1930 	    device_printf(sc->acpi_dev, "reset failed - timeout\n");
1931 	}
1932     } else if (sc->acpi_do_disable && panicstr == NULL) {
1933 	/*
1934 	 * Only disable ACPI if the user requested.  On some systems, writing
1935 	 * the disable value to SMI_CMD hangs the system.
1936 	 */
1937 	device_printf(sc->acpi_dev, "Shutting down\n");
1938 	AcpiTerminate();
1939     }
1940 }
1941 
1942 static void
1943 acpi_enable_fixed_events(struct acpi_softc *sc)
1944 {
1945     static int	first_time = 1;
1946 
1947     /* Enable and clear fixed events and install handlers. */
1948     if ((AcpiGbl_FADT.Flags & ACPI_FADT_POWER_BUTTON) == 0) {
1949 	AcpiClearEvent(ACPI_EVENT_POWER_BUTTON);
1950 	AcpiInstallFixedEventHandler(ACPI_EVENT_POWER_BUTTON,
1951 				     acpi_event_power_button_sleep, sc);
1952 	if (first_time)
1953 	    device_printf(sc->acpi_dev, "Power Button (fixed)\n");
1954     }
1955     if ((AcpiGbl_FADT.Flags & ACPI_FADT_SLEEP_BUTTON) == 0) {
1956 	AcpiClearEvent(ACPI_EVENT_SLEEP_BUTTON);
1957 	AcpiInstallFixedEventHandler(ACPI_EVENT_SLEEP_BUTTON,
1958 				     acpi_event_sleep_button_sleep, sc);
1959 	if (first_time)
1960 	    device_printf(sc->acpi_dev, "Sleep Button (fixed)\n");
1961     }
1962 
1963     first_time = 0;
1964 }
1965 
1966 /*
1967  * Returns true if the device is actually present and should
1968  * be attached to.  This requires the present, enabled, UI-visible
1969  * and diagnostics-passed bits to be set.
1970  */
1971 BOOLEAN
1972 acpi_DeviceIsPresent(device_t dev)
1973 {
1974     ACPI_HANDLE		h;
1975     UINT32		s;
1976     ACPI_STATUS		status;
1977 
1978     h = acpi_get_handle(dev);
1979     if (h == NULL)
1980 	return (FALSE);
1981     status = acpi_GetInteger(h, "_STA", &s);
1982 
1983     /*
1984      * If no _STA method or if it failed, then assume that
1985      * the device is present.
1986      */
1987     if (ACPI_FAILURE(status))
1988 	return (TRUE);
1989 
1990     return (ACPI_DEVICE_PRESENT(s) ? TRUE : FALSE);
1991 }
1992 
1993 /*
1994  * Returns true if the battery is actually present and inserted.
1995  */
1996 BOOLEAN
1997 acpi_BatteryIsPresent(device_t dev)
1998 {
1999     ACPI_HANDLE		h;
2000     UINT32		s;
2001     ACPI_STATUS		status;
2002 
2003     h = acpi_get_handle(dev);
2004     if (h == NULL)
2005 	return (FALSE);
2006     status = acpi_GetInteger(h, "_STA", &s);
2007 
2008     /*
2009      * If no _STA method or if it failed, then assume that
2010      * the device is present.
2011      */
2012     if (ACPI_FAILURE(status))
2013 	return (TRUE);
2014 
2015     return (ACPI_BATTERY_PRESENT(s) ? TRUE : FALSE);
2016 }
2017 
2018 /*
2019  * Match a HID string against a handle
2020  */
2021 BOOLEAN
2022 acpi_MatchHid(ACPI_HANDLE h, const char *hid)
2023 {
2024     ACPI_DEVICE_INFO	*devinfo;
2025     int			ret, i;
2026 
2027     ret = FALSE;
2028     if (hid == NULL || h == NULL ||
2029 	ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo)))
2030 	return (ret);
2031 
2032     if ((devinfo->Valid & ACPI_VALID_HID) != 0 &&
2033 	strcmp(hid, devinfo->HardwareId.String) == 0)
2034 	    ret = TRUE;
2035     else if ((devinfo->Valid & ACPI_VALID_CID) != 0) {
2036 	for (i = 0; i < devinfo->CompatibleIdList.Count; i++) {
2037 	    if (strcmp(hid, devinfo->CompatibleIdList.Ids[i].String) == 0) {
2038 		ret = TRUE;
2039 		break;
2040 	    }
2041 	}
2042     }
2043 
2044     AcpiOsFree(devinfo);
2045     return (ret);
2046 }
2047 
2048 /*
2049  * Match a UID string against a handle
2050  */
2051 BOOLEAN
2052 acpi_MatchUid(ACPI_HANDLE h, const char *uid)
2053 {
2054     ACPI_DEVICE_INFO	*devinfo;
2055     int			ret;
2056 
2057     ret = FALSE;
2058     if (uid == NULL || h == NULL ||
2059 	ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo)))
2060 	return (ret);
2061 
2062     if ((devinfo->Valid & ACPI_VALID_UID) != 0 &&
2063 	strcmp(uid, devinfo->UniqueId.String) == 0)
2064 	ret = TRUE;
2065 
2066     AcpiOsFree(devinfo);
2067     return (ret);
2068 }
2069 
2070 /*
2071  * Return the handle of a named object within our scope, ie. that of (parent)
2072  * or one if its parents.
2073  */
2074 ACPI_STATUS
2075 acpi_GetHandleInScope(ACPI_HANDLE parent, char *path, ACPI_HANDLE *result)
2076 {
2077     ACPI_HANDLE		r;
2078     ACPI_STATUS		status;
2079 
2080     /* Walk back up the tree to the root */
2081     for (;;) {
2082 	status = AcpiGetHandle(parent, path, &r);
2083 	if (ACPI_SUCCESS(status)) {
2084 	    *result = r;
2085 	    return (AE_OK);
2086 	}
2087 	/* XXX Return error here? */
2088 	if (status != AE_NOT_FOUND)
2089 	    return (AE_OK);
2090 	if (ACPI_FAILURE(AcpiGetParent(parent, &r)))
2091 	    return (AE_NOT_FOUND);
2092 	parent = r;
2093     }
2094 }
2095 
2096 /*
2097  * Allocate a buffer with a preset data size.
2098  */
2099 ACPI_BUFFER *
2100 acpi_AllocBuffer(int size)
2101 {
2102     ACPI_BUFFER	*buf;
2103 
2104     if ((buf = kmalloc(size + sizeof(*buf), M_ACPIDEV, M_NOWAIT)) == NULL)
2105 	return (NULL);
2106     buf->Length = size;
2107     buf->Pointer = (void *)(buf + 1);
2108     return (buf);
2109 }
2110 
2111 ACPI_STATUS
2112 acpi_SetInteger(ACPI_HANDLE handle, char *path, UINT32 number)
2113 {
2114     ACPI_OBJECT arg1;
2115     ACPI_OBJECT_LIST args;
2116 
2117     arg1.Type = ACPI_TYPE_INTEGER;
2118     arg1.Integer.Value = number;
2119     args.Count = 1;
2120     args.Pointer = &arg1;
2121 
2122     return (AcpiEvaluateObject(handle, path, &args, NULL));
2123 }
2124 
2125 /*
2126  * Evaluate a path that should return an integer.
2127  */
2128 ACPI_STATUS
2129 acpi_GetInteger(ACPI_HANDLE handle, char *path, UINT32 *number)
2130 {
2131     ACPI_STATUS	status;
2132     ACPI_BUFFER	buf;
2133     ACPI_OBJECT	param;
2134 
2135     if (handle == NULL)
2136 	handle = ACPI_ROOT_OBJECT;
2137 
2138     /*
2139      * Assume that what we've been pointed at is an Integer object, or
2140      * a method that will return an Integer.
2141      */
2142     buf.Pointer = &param;
2143     buf.Length = sizeof(param);
2144     status = AcpiEvaluateObject(handle, path, NULL, &buf);
2145     if (ACPI_SUCCESS(status)) {
2146 	if (param.Type == ACPI_TYPE_INTEGER)
2147 	    *number = param.Integer.Value;
2148 	else
2149 	    status = AE_TYPE;
2150     }
2151 
2152     /*
2153      * In some applications, a method that's expected to return an Integer
2154      * may instead return a Buffer (probably to simplify some internal
2155      * arithmetic).  We'll try to fetch whatever it is, and if it's a Buffer,
2156      * convert it into an Integer as best we can.
2157      *
2158      * This is a hack.
2159      */
2160     if (status == AE_BUFFER_OVERFLOW) {
2161 	if ((buf.Pointer = AcpiOsAllocate(buf.Length)) == NULL) {
2162 	    status = AE_NO_MEMORY;
2163 	} else {
2164 	    status = AcpiEvaluateObject(handle, path, NULL, &buf);
2165 	    if (ACPI_SUCCESS(status))
2166 		status = acpi_ConvertBufferToInteger(&buf, number);
2167 	    AcpiOsFree(buf.Pointer);
2168 	}
2169     }
2170     return (status);
2171 }
2172 
2173 ACPI_STATUS
2174 acpi_ConvertBufferToInteger(ACPI_BUFFER *bufp, UINT32 *number)
2175 {
2176     ACPI_OBJECT	*p;
2177     UINT8	*val;
2178     int		i;
2179 
2180     p = (ACPI_OBJECT *)bufp->Pointer;
2181     if (p->Type == ACPI_TYPE_INTEGER) {
2182 	*number = p->Integer.Value;
2183 	return (AE_OK);
2184     }
2185     if (p->Type != ACPI_TYPE_BUFFER)
2186 	return (AE_TYPE);
2187     if (p->Buffer.Length > sizeof(int))
2188 	return (AE_BAD_DATA);
2189 
2190     *number = 0;
2191     val = p->Buffer.Pointer;
2192     for (i = 0; i < p->Buffer.Length; i++)
2193 	*number += val[i] << (i * 8);
2194     return (AE_OK);
2195 }
2196 
2197 /*
2198  * Iterate over the elements of an a package object, calling the supplied
2199  * function for each element.
2200  *
2201  * XXX possible enhancement might be to abort traversal on error.
2202  */
2203 ACPI_STATUS
2204 acpi_ForeachPackageObject(ACPI_OBJECT *pkg,
2205 	void (*func)(ACPI_OBJECT *comp, void *arg), void *arg)
2206 {
2207     ACPI_OBJECT	*comp;
2208     int		i;
2209 
2210     if (pkg == NULL || pkg->Type != ACPI_TYPE_PACKAGE)
2211 	return (AE_BAD_PARAMETER);
2212 
2213     /* Iterate over components */
2214     i = 0;
2215     comp = pkg->Package.Elements;
2216     for (; i < pkg->Package.Count; i++, comp++)
2217 	func(comp, arg);
2218 
2219     return (AE_OK);
2220 }
2221 
2222 /*
2223  * Find the (index)th resource object in a set.
2224  */
2225 ACPI_STATUS
2226 acpi_FindIndexedResource(ACPI_BUFFER *buf, int index, ACPI_RESOURCE **resp)
2227 {
2228     ACPI_RESOURCE	*rp;
2229     int			i;
2230 
2231     rp = (ACPI_RESOURCE *)buf->Pointer;
2232     i = index;
2233     while (i-- > 0) {
2234 	/* Range check */
2235 	if (rp > (ACPI_RESOURCE *)((uint8_t *)buf->Pointer + buf->Length))
2236 	    return (AE_BAD_PARAMETER);
2237 
2238 	/* Check for terminator */
2239 	if (rp->Type == ACPI_RESOURCE_TYPE_END_TAG || rp->Length == 0)
2240 	    return (AE_NOT_FOUND);
2241 	rp = ACPI_NEXT_RESOURCE(rp);
2242     }
2243     if (resp != NULL)
2244 	*resp = rp;
2245 
2246     return (AE_OK);
2247 }
2248 
2249 /*
2250  * Append an ACPI_RESOURCE to an ACPI_BUFFER.
2251  *
2252  * Given a pointer to an ACPI_RESOURCE structure, expand the ACPI_BUFFER
2253  * provided to contain it.  If the ACPI_BUFFER is empty, allocate a sensible
2254  * backing block.  If the ACPI_RESOURCE is NULL, return an empty set of
2255  * resources.
2256  */
2257 #define ACPI_INITIAL_RESOURCE_BUFFER_SIZE	512
2258 
2259 ACPI_STATUS
2260 acpi_AppendBufferResource(ACPI_BUFFER *buf, ACPI_RESOURCE *res)
2261 {
2262     ACPI_RESOURCE	*rp;
2263     void		*newp;
2264 
2265     /* Initialise the buffer if necessary. */
2266     if (buf->Pointer == NULL) {
2267 	buf->Length = ACPI_INITIAL_RESOURCE_BUFFER_SIZE;
2268 	if ((buf->Pointer = AcpiOsAllocate(buf->Length)) == NULL)
2269 	    return (AE_NO_MEMORY);
2270 	rp = (ACPI_RESOURCE *)buf->Pointer;
2271 	rp->Type = ACPI_RESOURCE_TYPE_END_TAG;
2272 	rp->Length = ACPI_RS_SIZE_MIN;
2273     }
2274     if (res == NULL)
2275 	return (AE_OK);
2276 
2277     /*
2278      * Scan the current buffer looking for the terminator.
2279      * This will either find the terminator or hit the end
2280      * of the buffer and return an error.
2281      */
2282     rp = (ACPI_RESOURCE *)buf->Pointer;
2283     for (;;) {
2284 	/* Range check, don't go outside the buffer */
2285 	if (rp >= (ACPI_RESOURCE *)((uint8_t *)buf->Pointer + buf->Length))
2286 	    return (AE_BAD_PARAMETER);
2287 	if (rp->Type == ACPI_RESOURCE_TYPE_END_TAG || rp->Length == 0)
2288 	    break;
2289 	rp = ACPI_NEXT_RESOURCE(rp);
2290     }
2291 
2292     /*
2293      * Check the size of the buffer and expand if required.
2294      *
2295      * Required size is:
2296      *	size of existing resources before terminator +
2297      *	size of new resource and header +
2298      * 	size of terminator.
2299      *
2300      * Note that this loop should really only run once, unless
2301      * for some reason we are stuffing a *really* huge resource.
2302      */
2303     while ((((uint8_t *)rp - (uint8_t *)buf->Pointer) +
2304 	    res->Length + ACPI_RS_SIZE_NO_DATA +
2305 	    ACPI_RS_SIZE_MIN) >= buf->Length) {
2306 	if ((newp = AcpiOsAllocate(buf->Length * 2)) == NULL)
2307 	    return (AE_NO_MEMORY);
2308 	bcopy(buf->Pointer, newp, buf->Length);
2309 	rp = (ACPI_RESOURCE *)((uint8_t *)newp +
2310 			       ((uint8_t *)rp - (uint8_t *)buf->Pointer));
2311 	AcpiOsFree(buf->Pointer);
2312 	buf->Pointer = newp;
2313 	buf->Length += buf->Length;
2314     }
2315 
2316     /* Insert the new resource. */
2317     bcopy(res, rp, res->Length + ACPI_RS_SIZE_NO_DATA);
2318 
2319     /* And add the terminator. */
2320     rp = ACPI_NEXT_RESOURCE(rp);
2321     rp->Type = ACPI_RESOURCE_TYPE_END_TAG;
2322     rp->Length = ACPI_RS_SIZE_MIN;
2323 
2324     return (AE_OK);
2325 }
2326 
2327 /*
2328  * Set interrupt model.
2329  */
2330 ACPI_STATUS
2331 acpi_SetIntrModel(int model)
2332 {
2333 
2334     return (acpi_SetInteger(ACPI_ROOT_OBJECT, "_PIC", model));
2335 }
2336 
2337 /*
2338  * DEPRECATED.  This interface has serious deficiencies and will be
2339  * removed.
2340  *
2341  * Immediately enter the sleep state.  In the old model, acpiconf(8) ran
2342  * rc.suspend and rc.resume so we don't have to notify devd(8) to do this.
2343  */
2344 ACPI_STATUS
2345 acpi_SetSleepState(struct acpi_softc *sc, int state)
2346 {
2347     static int once;
2348 
2349     if (!once) {
2350 	device_printf(sc->acpi_dev,
2351 "warning: acpi_SetSleepState() deprecated, need to update your software\n");
2352 	once = 1;
2353     }
2354     return (acpi_EnterSleepState(sc, state));
2355 }
2356 
2357 static void
2358 acpi_sleep_force(void *arg)
2359 {
2360     struct acpi_softc *sc;
2361 
2362     sc = arg;
2363     device_printf(sc->acpi_dev,
2364 	"suspend request timed out, forcing sleep now\n");
2365     if (ACPI_FAILURE(acpi_EnterSleepState(sc, sc->acpi_next_sstate)))
2366 	device_printf(sc->acpi_dev, "force sleep state S%d failed\n",
2367 	    sc->acpi_next_sstate);
2368 }
2369 
2370 /*
2371  * Request that the system enter the given suspend state.  All /dev/apm
2372  * devices and devd(8) will be notified.  Userland then has a chance to
2373  * save state and acknowledge the request.  The system sleeps once all
2374  * acks are in.
2375  */
2376 int
2377 acpi_ReqSleepState(struct acpi_softc *sc, int state)
2378 {
2379 #ifdef notyet
2380     struct apm_clone_data *clone;
2381 #endif
2382 
2383     if (state < ACPI_STATE_S1 || state > ACPI_STATE_S5)
2384 	return (EINVAL);
2385 
2386     /* S5 (soft-off) should be entered directly with no waiting. */
2387     if (state == ACPI_STATE_S5) {
2388 	if (ACPI_SUCCESS(acpi_EnterSleepState(sc, state)))
2389 	    return (0);
2390 	else
2391 	    return (ENXIO);
2392     }
2393 
2394     /* This platform does not support acpi suspend/resume. */
2395     return (EOPNOTSUPP);
2396 
2397     /* If a suspend request is already in progress, just return. */
2398     ACPI_LOCK(acpi);
2399     if (sc->acpi_next_sstate != 0) {
2400 	ACPI_UNLOCK(acpi);
2401 	return (0);
2402     }
2403 
2404     /* Record the pending state and notify all apm devices. */
2405     sc->acpi_next_sstate = state;
2406 #if 0
2407     STAILQ_FOREACH(clone, &sc->apm_cdevs, entries) {
2408 	clone->notify_status = APM_EV_NONE;
2409 	if ((clone->flags & ACPI_EVF_DEVD) == 0) {
2410 	    KNOTE(&clone->sel_read.si_note, 0);
2411 	}
2412     }
2413 #endif
2414 
2415     /* If devd(8) is not running, immediately enter the sleep state. */
2416     if (devctl_process_running() == FALSE) {
2417 	ACPI_UNLOCK(acpi);
2418 	if (ACPI_SUCCESS(acpi_EnterSleepState(sc, sc->acpi_next_sstate))) {
2419 	    return (0);
2420 	} else {
2421 	    return (ENXIO);
2422 	}
2423     }
2424 
2425     /* Now notify devd(8) also. */
2426     acpi_UserNotify("Suspend", ACPI_ROOT_OBJECT, state);
2427 
2428     /*
2429      * Set a timeout to fire if userland doesn't ack the suspend request
2430      * in time.  This way we still eventually go to sleep if we were
2431      * overheating or running low on battery, even if userland is hung.
2432      * We cancel this timeout once all userland acks are in or the
2433      * suspend request is aborted.
2434      */
2435     callout_reset(&sc->susp_force_to, 10 * hz, acpi_sleep_force, sc);
2436     ACPI_UNLOCK(acpi);
2437 
2438     return (0);
2439 }
2440 
2441 /*
2442  * Acknowledge (or reject) a pending sleep state.  The caller has
2443  * prepared for suspend and is now ready for it to proceed.  If the
2444  * error argument is non-zero, it indicates suspend should be cancelled
2445  * and gives an errno value describing why.  Once all votes are in,
2446  * we suspend the system.
2447  */
2448 int
2449 acpi_AckSleepState(struct apm_clone_data *clone, int error)
2450 {
2451     struct acpi_softc *sc;
2452     int ret, sleeping;
2453 
2454     /* This platform does not support acpi suspend/resume. */
2455     return (EOPNOTSUPP);
2456 
2457     /* If no pending sleep state, return an error. */
2458     ACPI_LOCK(acpi);
2459     sc = clone->acpi_sc;
2460     if (sc->acpi_next_sstate == 0) {
2461 	ACPI_UNLOCK(acpi);
2462 	return (ENXIO);
2463     }
2464 
2465     /* Caller wants to abort suspend process. */
2466     if (error) {
2467 	sc->acpi_next_sstate = 0;
2468 	callout_stop(&sc->susp_force_to);
2469 	device_printf(sc->acpi_dev,
2470 	    "listener on %s cancelled the pending suspend\n",
2471 	    devtoname(clone->cdev));
2472 	ACPI_UNLOCK(acpi);
2473 	return (0);
2474     }
2475 
2476     /*
2477      * Mark this device as acking the suspend request.  Then, walk through
2478      * all devices, seeing if they agree yet.  We only count devices that
2479      * are writable since read-only devices couldn't ack the request.
2480      */
2481     clone->notify_status = APM_EV_ACKED;
2482     sleeping = TRUE;
2483     STAILQ_FOREACH(clone, &sc->apm_cdevs, entries) {
2484 	if ((clone->flags & ACPI_EVF_WRITE) != 0 &&
2485 	    clone->notify_status != APM_EV_ACKED) {
2486 	    sleeping = FALSE;
2487 	    break;
2488 	}
2489     }
2490 
2491     /* If all devices have voted "yes", we will suspend now. */
2492     if (sleeping)
2493 	callout_stop(&sc->susp_force_to);
2494     ACPI_UNLOCK(acpi);
2495     ret = 0;
2496     if (sleeping) {
2497 	if (ACPI_FAILURE(acpi_EnterSleepState(sc, sc->acpi_next_sstate)))
2498 		ret = ENODEV;
2499     }
2500 
2501     return (ret);
2502 }
2503 
2504 static void
2505 acpi_sleep_enable(void *arg)
2506 {
2507     ((struct acpi_softc *)arg)->acpi_sleep_disabled = 0;
2508 }
2509 
2510 enum acpi_sleep_state {
2511     ACPI_SS_NONE,
2512     ACPI_SS_GPE_SET,
2513     ACPI_SS_DEV_SUSPEND,
2514     ACPI_SS_SLP_PREP,
2515     ACPI_SS_SLEPT,
2516 };
2517 
2518 /*
2519  * Enter the desired system sleep state.
2520  *
2521  * Currently we support S1-S5 but S4 is only S4BIOS
2522  */
2523 static ACPI_STATUS
2524 acpi_EnterSleepState(struct acpi_softc *sc, int state)
2525 {
2526     ACPI_STATUS	status;
2527     UINT8	TypeA;
2528     UINT8	TypeB;
2529     enum acpi_sleep_state slp_state;
2530 
2531     ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, state);
2532 
2533     /* Re-entry once we're suspending is not allowed. */
2534     status = AE_OK;
2535     ACPI_LOCK(acpi);
2536     if (sc->acpi_sleep_disabled) {
2537 	ACPI_UNLOCK(acpi);
2538 	device_printf(sc->acpi_dev,
2539 	    "suspend request ignored (not ready yet)\n");
2540 	return (AE_ERROR);
2541     }
2542     sc->acpi_sleep_disabled = 1;
2543     ACPI_UNLOCK(acpi);
2544 
2545     /*
2546      * Be sure to hold Giant across DEVICE_SUSPEND/RESUME since non-MPSAFE
2547      * drivers need this.
2548      */
2549     //get_mplock();
2550 
2551     slp_state = ACPI_SS_NONE;
2552     switch (state) {
2553     case ACPI_STATE_S1:
2554     case ACPI_STATE_S2:
2555     case ACPI_STATE_S3:
2556     case ACPI_STATE_S4:
2557 	status = AcpiGetSleepTypeData(state, &TypeA, &TypeB);
2558 	if (status == AE_NOT_FOUND) {
2559 	    device_printf(sc->acpi_dev,
2560 			  "Sleep state S%d not supported by BIOS\n", state);
2561 	    break;
2562 	} else if (ACPI_FAILURE(status)) {
2563 	    device_printf(sc->acpi_dev, "AcpiGetSleepTypeData failed - %s\n",
2564 			  AcpiFormatException(status));
2565 	    break;
2566 	}
2567 
2568 	sc->acpi_sstate = state;
2569 
2570 	/* Enable any GPEs as appropriate and requested by the user. */
2571 	acpi_wake_prep_walk(state);
2572 	slp_state = ACPI_SS_GPE_SET;
2573 
2574 	/*
2575 	 * Inform all devices that we are going to sleep.  If at least one
2576 	 * device fails, DEVICE_SUSPEND() automatically resumes the tree.
2577 	 *
2578 	 * XXX Note that a better two-pass approach with a 'veto' pass
2579 	 * followed by a "real thing" pass would be better, but the current
2580 	 * bus interface does not provide for this.
2581 	 */
2582 	if (DEVICE_SUSPEND(root_bus) != 0) {
2583 	    device_printf(sc->acpi_dev, "device_suspend failed\n");
2584 	    break;
2585 	}
2586 	slp_state = ACPI_SS_DEV_SUSPEND;
2587 
2588 	/* If testing device suspend only, back out of everything here. */
2589 	if (acpi_susp_bounce)
2590 	    break;
2591 
2592 	status = AcpiEnterSleepStatePrep(state);
2593 	if (ACPI_FAILURE(status)) {
2594 	    device_printf(sc->acpi_dev, "AcpiEnterSleepStatePrep failed - %s\n",
2595 			  AcpiFormatException(status));
2596 	    break;
2597 	}
2598 	slp_state = ACPI_SS_SLP_PREP;
2599 
2600 	if (sc->acpi_sleep_delay > 0)
2601 	    DELAY(sc->acpi_sleep_delay * 1000000);
2602 
2603 	if (state != ACPI_STATE_S1) {
2604 	    acpi_sleep_machdep(sc, state);
2605 
2606 	    /* Re-enable ACPI hardware on wakeup from sleep state 4. */
2607 	    if (state == ACPI_STATE_S4)
2608 		AcpiEnable();
2609 	} else {
2610 	    ACPI_DISABLE_IRQS();
2611 	    status = AcpiEnterSleepState(state);
2612 	    if (ACPI_FAILURE(status)) {
2613 		device_printf(sc->acpi_dev, "AcpiEnterSleepState failed - %s\n",
2614 			      AcpiFormatException(status));
2615 		break;
2616 	    }
2617 	}
2618 	slp_state = ACPI_SS_SLEPT;
2619 	break;
2620     case ACPI_STATE_S5:
2621 	/*
2622 	 * Shut down cleanly and power off.  This will call us back through the
2623 	 * shutdown handlers.
2624 	 */
2625 	shutdown_nice(RB_POWEROFF);
2626 	break;
2627     case ACPI_STATE_S0:
2628     default:
2629 	status = AE_BAD_PARAMETER;
2630 	break;
2631     }
2632 
2633     /*
2634      * Back out state according to how far along we got in the suspend
2635      * process.  This handles both the error and success cases.
2636      */
2637     sc->acpi_next_sstate = 0;
2638     if (slp_state >= ACPI_SS_GPE_SET) {
2639 	acpi_wake_prep_walk(state);
2640 	sc->acpi_sstate = ACPI_STATE_S0;
2641     }
2642     if (slp_state >= ACPI_SS_SLP_PREP)
2643 	AcpiLeaveSleepState(state);
2644     if (slp_state >= ACPI_SS_DEV_SUSPEND)
2645 	DEVICE_RESUME(root_bus);
2646     if (slp_state >= ACPI_SS_SLEPT)
2647 	acpi_enable_fixed_events(sc);
2648 
2649     /* Allow another sleep request after a while. */
2650     /* XXX: needs timeout */
2651     if (state != ACPI_STATE_S5)
2652 	      acpi_sleep_enable(sc);
2653 
2654     /* Run /etc/rc.resume after we are back. */
2655     acpi_UserNotify("Resume", ACPI_ROOT_OBJECT, state);
2656 
2657     //rel_mplock();
2658 
2659     return_ACPI_STATUS (status);
2660 }
2661 
2662 /* Enable or disable the device's GPE. */
2663 int
2664 acpi_wake_set_enable(device_t dev, int enable)
2665 {
2666     struct acpi_prw_data prw;
2667     ACPI_STATUS status;
2668     int flags;
2669 
2670     /* Make sure the device supports waking the system and get the GPE. */
2671     if (acpi_parse_prw(acpi_get_handle(dev), &prw) != 0)
2672 	return (ENXIO);
2673 
2674     flags = acpi_get_flags(dev);
2675     if (enable) {
2676 	status = AcpiSetGpeWakeMask(prw.gpe_handle, prw.gpe_bit,
2677                                     ACPI_GPE_ENABLE);
2678 	if (ACPI_FAILURE(status)) {
2679 	    device_printf(dev, "enable wake failed\n");
2680 	    return (ENXIO);
2681 	}
2682 	acpi_set_flags(dev, flags | ACPI_FLAG_WAKE_ENABLED);
2683     } else {
2684 	status = AcpiSetGpeWakeMask(prw.gpe_handle, prw.gpe_bit,
2685                                     ACPI_GPE_DISABLE);
2686 	if (ACPI_FAILURE(status)) {
2687 	    device_printf(dev, "disable wake failed\n");
2688 	    return (ENXIO);
2689 	}
2690 	acpi_set_flags(dev, flags & ~ACPI_FLAG_WAKE_ENABLED);
2691     }
2692 
2693     return (0);
2694 }
2695 
2696 static int
2697 acpi_wake_sleep_prep(ACPI_HANDLE handle, int sstate)
2698 {
2699     struct acpi_prw_data prw;
2700     device_t dev;
2701 
2702     /* Check that this is a wake-capable device and get its GPE. */
2703     if (acpi_parse_prw(handle, &prw) != 0)
2704 	return (ENXIO);
2705     dev = acpi_get_device(handle);
2706 
2707     /*
2708      * The destination sleep state must be less than (i.e., higher power)
2709      * or equal to the value specified by _PRW.  If this GPE cannot be
2710      * enabled for the next sleep state, then disable it.  If it can and
2711      * the user requested it be enabled, turn on any required power resources
2712      * and set _PSW.
2713      */
2714     if (sstate > prw.lowest_wake) {
2715 	AcpiSetGpeWakeMask(prw.gpe_handle, prw.gpe_bit, ACPI_GPE_DISABLE);
2716 	if (bootverbose)
2717 	    device_printf(dev, "wake_prep disabled wake for %s (S%d)\n",
2718 		acpi_name(handle), sstate);
2719     } else if (dev && (acpi_get_flags(dev) & ACPI_FLAG_WAKE_ENABLED) != 0) {
2720 	acpi_pwr_wake_enable(handle, 1);
2721 	acpi_SetInteger(handle, "_PSW", 1);
2722 	if (bootverbose)
2723 	    device_printf(dev, "wake_prep enabled for %s (S%d)\n",
2724 		acpi_name(handle), sstate);
2725     }
2726 
2727     return (0);
2728 }
2729 
2730 static int
2731 acpi_wake_run_prep(ACPI_HANDLE handle, int sstate)
2732 {
2733     struct acpi_prw_data prw;
2734     device_t dev;
2735 
2736     /*
2737      * Check that this is a wake-capable device and get its GPE.  Return
2738      * now if the user didn't enable this device for wake.
2739      */
2740     if (acpi_parse_prw(handle, &prw) != 0)
2741 	return (ENXIO);
2742     dev = acpi_get_device(handle);
2743     if (dev == NULL || (acpi_get_flags(dev) & ACPI_FLAG_WAKE_ENABLED) == 0)
2744 	return (0);
2745 
2746     /*
2747      * If this GPE couldn't be enabled for the previous sleep state, it was
2748      * disabled before going to sleep so re-enable it.  If it was enabled,
2749      * clear _PSW and turn off any power resources it used.
2750      */
2751     if (sstate > prw.lowest_wake) {
2752 	AcpiSetGpeWakeMask(prw.gpe_handle, prw.gpe_bit, ACPI_GPE_ENABLE);
2753 	if (bootverbose)
2754 	    device_printf(dev, "run_prep re-enabled %s\n", acpi_name(handle));
2755     } else {
2756 	acpi_SetInteger(handle, "_PSW", 0);
2757 	acpi_pwr_wake_enable(handle, 0);
2758 	if (bootverbose)
2759 	    device_printf(dev, "run_prep cleaned up for %s\n",
2760 		acpi_name(handle));
2761     }
2762 
2763     return (0);
2764 }
2765 
2766 static ACPI_STATUS
2767 acpi_wake_prep(ACPI_HANDLE handle, UINT32 level, void *context, void **status)
2768 {
2769     int sstate;
2770 
2771     /* If suspending, run the sleep prep function, otherwise wake. */
2772     sstate = *(int *)context;
2773     if (AcpiGbl_SystemAwakeAndRunning)
2774 	acpi_wake_sleep_prep(handle, sstate);
2775     else
2776 	acpi_wake_run_prep(handle, sstate);
2777     return (AE_OK);
2778 }
2779 
2780 /* Walk the tree rooted at acpi0 to prep devices for suspend/resume. */
2781 static int
2782 acpi_wake_prep_walk(int sstate)
2783 {
2784     ACPI_HANDLE sb_handle;
2785 
2786     if (ACPI_SUCCESS(AcpiGetHandle(ACPI_ROOT_OBJECT, "\\_SB_", &sb_handle))) {
2787 	AcpiWalkNamespace(ACPI_TYPE_DEVICE, sb_handle, 100,
2788 	    acpi_wake_prep, NULL, &sstate, NULL);
2789     }
2790     return (0);
2791 }
2792 
2793 /* Walk the tree rooted at acpi0 to attach per-device wake sysctls. */
2794 static int
2795 acpi_wake_sysctl_walk(device_t dev)
2796 {
2797 #ifdef notyet
2798     int error, i, numdevs;
2799     device_t *devlist;
2800     device_t child;
2801     ACPI_STATUS status;
2802 
2803     error = device_get_children(dev, &devlist, &numdevs);
2804     if (error != 0 || numdevs == 0) {
2805 	if (numdevs == 0)
2806 	    kfree(devlist, M_TEMP);
2807 	return (error);
2808     }
2809     for (i = 0; i < numdevs; i++) {
2810 	child = devlist[i];
2811 	acpi_wake_sysctl_walk(child);
2812 	if (!device_is_attached(child))
2813 	    continue;
2814 	status = AcpiEvaluateObject(acpi_get_handle(child), "_PRW", NULL, NULL);
2815 	if (ACPI_SUCCESS(status)) {
2816 	    SYSCTL_ADD_PROC(device_get_sysctl_ctx(child),
2817 		SYSCTL_CHILDREN(device_get_sysctl_tree(child)), OID_AUTO,
2818 		"wake", CTLTYPE_INT | CTLFLAG_RW, child, 0,
2819 		acpi_wake_set_sysctl, "I", "Device set to wake the system");
2820 	}
2821     }
2822     kfree(devlist, M_TEMP);
2823 #endif
2824 
2825     return (0);
2826 }
2827 
2828 #ifdef notyet
2829 /* Enable or disable wake from userland. */
2830 static int
2831 acpi_wake_set_sysctl(SYSCTL_HANDLER_ARGS)
2832 {
2833     int enable, error;
2834     device_t dev;
2835 
2836     dev = (device_t)arg1;
2837     enable = (acpi_get_flags(dev) & ACPI_FLAG_WAKE_ENABLED) ? 1 : 0;
2838 
2839     error = sysctl_handle_int(oidp, &enable, 0, req);
2840     if (error != 0 || req->newptr == NULL)
2841 	return (error);
2842     if (enable != 0 && enable != 1)
2843 	return (EINVAL);
2844 
2845     return (acpi_wake_set_enable(dev, enable));
2846 }
2847 #endif
2848 
2849 /* Parse a device's _PRW into a structure. */
2850 int
2851 acpi_parse_prw(ACPI_HANDLE h, struct acpi_prw_data *prw)
2852 {
2853     ACPI_STATUS			status;
2854     ACPI_BUFFER			prw_buffer;
2855     ACPI_OBJECT			*res, *res2;
2856     int				error, i, power_count;
2857 
2858     if (h == NULL || prw == NULL)
2859 	return (EINVAL);
2860 
2861     /*
2862      * The _PRW object (7.2.9) is only required for devices that have the
2863      * ability to wake the system from a sleeping state.
2864      */
2865     error = EINVAL;
2866     prw_buffer.Pointer = NULL;
2867     prw_buffer.Length = ACPI_ALLOCATE_BUFFER;
2868     status = AcpiEvaluateObject(h, "_PRW", NULL, &prw_buffer);
2869     if (ACPI_FAILURE(status))
2870 	return (ENOENT);
2871     res = (ACPI_OBJECT *)prw_buffer.Pointer;
2872     if (res == NULL)
2873 	return (ENOENT);
2874     if (!ACPI_PKG_VALID(res, 2))
2875 	goto out;
2876 
2877     /*
2878      * Element 1 of the _PRW object:
2879      * The lowest power system sleeping state that can be entered while still
2880      * providing wake functionality.  The sleeping state being entered must
2881      * be less than (i.e., higher power) or equal to this value.
2882      */
2883     if (acpi_PkgInt32(res, 1, &prw->lowest_wake) != 0)
2884 	goto out;
2885 
2886     /*
2887      * Element 0 of the _PRW object:
2888      */
2889     switch (res->Package.Elements[0].Type) {
2890     case ACPI_TYPE_INTEGER:
2891 	/*
2892 	 * If the data type of this package element is numeric, then this
2893 	 * _PRW package element is the bit index in the GPEx_EN, in the
2894 	 * GPE blocks described in the FADT, of the enable bit that is
2895 	 * enabled for the wake event.
2896 	 */
2897 	prw->gpe_handle = NULL;
2898 	prw->gpe_bit = res->Package.Elements[0].Integer.Value;
2899 	error = 0;
2900 	break;
2901     case ACPI_TYPE_PACKAGE:
2902 	/*
2903 	 * If the data type of this package element is a package, then this
2904 	 * _PRW package element is itself a package containing two
2905 	 * elements.  The first is an object reference to the GPE Block
2906 	 * device that contains the GPE that will be triggered by the wake
2907 	 * event.  The second element is numeric and it contains the bit
2908 	 * index in the GPEx_EN, in the GPE Block referenced by the
2909 	 * first element in the package, of the enable bit that is enabled for
2910 	 * the wake event.
2911 	 *
2912 	 * For example, if this field is a package then it is of the form:
2913 	 * Package() {\_SB.PCI0.ISA.GPE, 2}
2914 	 */
2915 	res2 = &res->Package.Elements[0];
2916 	if (!ACPI_PKG_VALID(res2, 2))
2917 	    goto out;
2918 	prw->gpe_handle = acpi_GetReference(NULL, &res2->Package.Elements[0]);
2919 	if (prw->gpe_handle == NULL)
2920 	    goto out;
2921 	if (acpi_PkgInt32(res2, 1, &prw->gpe_bit) != 0)
2922 	    goto out;
2923 	error = 0;
2924 	break;
2925     default:
2926 	goto out;
2927     }
2928 
2929     /* Elements 2 to N of the _PRW object are power resources. */
2930     power_count = res->Package.Count - 2;
2931     if (power_count > ACPI_PRW_MAX_POWERRES) {
2932 	kprintf("ACPI device %s has too many power resources\n", acpi_name(h));
2933 	power_count = 0;
2934     }
2935     prw->power_res_count = power_count;
2936     for (i = 0; i < power_count; i++)
2937 	prw->power_res[i] = res->Package.Elements[i];
2938 
2939 out:
2940     if (prw_buffer.Pointer != NULL)
2941 	AcpiOsFree(prw_buffer.Pointer);
2942     return (error);
2943 }
2944 
2945 /*
2946  * ACPI Event Handlers
2947  */
2948 
2949 /* System Event Handlers (registered by EVENTHANDLER_REGISTER) */
2950 
2951 static void
2952 acpi_system_eventhandler_sleep(void *arg, int state)
2953 {
2954     struct acpi_softc *sc;
2955     int ret;
2956 
2957     ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, state);
2958 
2959     sc = arg;
2960 
2961     /* Check if button action is disabled. */
2962     if (state == ACPI_S_STATES_MAX + 1)
2963 	return;
2964 
2965     /* Request that the system prepare to enter the given suspend state. */
2966     ret = acpi_ReqSleepState((struct acpi_softc *)arg, state);
2967     if (ret != 0)
2968 	device_printf(sc->acpi_dev,
2969 	    "request to enter state S%d failed (err %d)\n", state, ret);
2970 
2971     return_VOID;
2972 }
2973 
2974 static void
2975 acpi_system_eventhandler_wakeup(void *arg, int state)
2976 {
2977 
2978     ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, state);
2979 
2980     /* Currently, nothing to do for wakeup. */
2981 
2982     return_VOID;
2983 }
2984 
2985 /*
2986  * ACPICA Event Handlers (FixedEvent, also called from button notify handler)
2987  */
2988 UINT32
2989 acpi_event_power_button_sleep(void *context)
2990 {
2991     struct acpi_softc	*sc = (struct acpi_softc *)context;
2992 
2993     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
2994 
2995     EVENTHANDLER_INVOKE(acpi_sleep_event, sc->acpi_power_button_sx);
2996 
2997     return_VALUE (ACPI_INTERRUPT_HANDLED);
2998 }
2999 
3000 UINT32
3001 acpi_event_power_button_wake(void *context)
3002 {
3003     struct acpi_softc	*sc = (struct acpi_softc *)context;
3004 
3005     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
3006 
3007     EVENTHANDLER_INVOKE(acpi_wakeup_event, sc->acpi_power_button_sx);
3008 
3009     return_VALUE (ACPI_INTERRUPT_HANDLED);
3010 }
3011 
3012 UINT32
3013 acpi_event_sleep_button_sleep(void *context)
3014 {
3015     struct acpi_softc	*sc = (struct acpi_softc *)context;
3016 
3017     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
3018 
3019     EVENTHANDLER_INVOKE(acpi_sleep_event, sc->acpi_sleep_button_sx);
3020 
3021     return_VALUE (ACPI_INTERRUPT_HANDLED);
3022 }
3023 
3024 UINT32
3025 acpi_event_sleep_button_wake(void *context)
3026 {
3027     struct acpi_softc	*sc = (struct acpi_softc *)context;
3028 
3029     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
3030 
3031     EVENTHANDLER_INVOKE(acpi_wakeup_event, sc->acpi_sleep_button_sx);
3032 
3033     return_VALUE (ACPI_INTERRUPT_HANDLED);
3034 }
3035 
3036 /*
3037  * XXX This static buffer is suboptimal.  There is no locking so only
3038  * use this for single-threaded callers.
3039  */
3040 char *
3041 acpi_name(ACPI_HANDLE handle)
3042 {
3043     ACPI_BUFFER buf;
3044     static char data[256];
3045 
3046     buf.Length = sizeof(data);
3047     buf.Pointer = data;
3048 
3049     if (handle && ACPI_SUCCESS(AcpiGetName(handle, ACPI_FULL_PATHNAME, &buf)))
3050 	return (data);
3051     return ("(unknown)");
3052 }
3053 
3054 /*
3055  * Debugging/bug-avoidance.  Avoid trying to fetch info on various
3056  * parts of the namespace.
3057  */
3058 int
3059 acpi_avoid(ACPI_HANDLE handle)
3060 {
3061     char	*cp, *env, *np;
3062     int		len;
3063 
3064     np = acpi_name(handle);
3065     if (*np == '\\')
3066 	np++;
3067     if ((env = kgetenv("debug.acpi.avoid")) == NULL)
3068 	return (0);
3069 
3070     /* Scan the avoid list checking for a match */
3071     cp = env;
3072     for (;;) {
3073 	while (*cp != 0 && isspace(*cp))
3074 	    cp++;
3075 	if (*cp == 0)
3076 	    break;
3077 	len = 0;
3078 	while (cp[len] != 0 && !isspace(cp[len]))
3079 	    len++;
3080 	if (!strncmp(cp, np, len)) {
3081 	    kfreeenv(env);
3082 	    return(1);
3083 	}
3084 	cp += len;
3085     }
3086     kfreeenv(env);
3087 
3088     return (0);
3089 }
3090 
3091 /*
3092  * Debugging/bug-avoidance.  Disable ACPI subsystem components.
3093  */
3094 int
3095 acpi_disabled(char *subsys)
3096 {
3097     char	*cp, *env;
3098     int		len;
3099 
3100     if ((env = kgetenv("debug.acpi.disabled")) == NULL)
3101 	return (0);
3102     if (strcmp(env, "all") == 0) {
3103 	kfreeenv(env);
3104 	return (1);
3105     }
3106 
3107     /* Scan the disable list, checking for a match. */
3108     cp = env;
3109     for (;;) {
3110 	while (*cp != '\0' && isspace(*cp))
3111 	    cp++;
3112 	if (*cp == '\0')
3113 	    break;
3114 	len = 0;
3115 	while (cp[len] != '\0' && !isspace(cp[len]))
3116 	    len++;
3117 	if (strncmp(cp, subsys, len) == 0) {
3118 	    kfreeenv(env);
3119 	    return (1);
3120 	}
3121 	cp += len;
3122     }
3123     kfreeenv(env);
3124 
3125     return (0);
3126 }
3127 
3128 /*
3129  * Debugging/bug-avoidance.  Enable ACPI subsystem components.  Most
3130  * components are enabled by default.  The ones that are not have to be
3131  * enabled via debug.acpi.enabled.
3132  */
3133 int
3134 acpi_enabled(char *subsys)
3135 {
3136     char        *cp, *env;
3137     int         len;
3138 
3139     if ((env = kgetenv("debug.acpi.enabled")) == NULL)
3140         return (0);
3141     if (strcmp(env, "all") == 0) {
3142         kfreeenv(env);
3143         return (1);
3144     }
3145 
3146     /* Scan the enable list, checking for a match. */
3147     cp = env;
3148     for (;;) {
3149         while (*cp != '\0' && isspace(*cp))
3150             cp++;
3151         if (*cp == '\0')
3152             break;
3153         len = 0;
3154         while (cp[len] != '\0' && !isspace(cp[len]))
3155             len++;
3156         if (strncmp(cp, subsys, len) == 0) {
3157             kfreeenv(env);
3158             return (1);
3159         }
3160         cp += len;
3161     }
3162     kfreeenv(env);
3163 
3164     return (0);
3165 }
3166 
3167 /*
3168  * Control interface.
3169  *
3170  * We multiplex ioctls for all participating ACPI devices here.  Individual
3171  * drivers wanting to be accessible via /dev/acpi should use the
3172  * register/deregister interface to make their handlers visible.
3173  */
3174 struct acpi_ioctl_hook
3175 {
3176     TAILQ_ENTRY(acpi_ioctl_hook) link;
3177     u_long			 cmd;
3178     acpi_ioctl_fn		 fn;
3179     void			 *arg;
3180 };
3181 
3182 static TAILQ_HEAD(,acpi_ioctl_hook)	acpi_ioctl_hooks;
3183 static int				acpi_ioctl_hooks_initted;
3184 
3185 int
3186 acpi_register_ioctl(u_long cmd, acpi_ioctl_fn fn, void *arg)
3187 {
3188     struct acpi_ioctl_hook	*hp;
3189 
3190     if ((hp = kmalloc(sizeof(*hp), M_ACPIDEV, M_NOWAIT)) == NULL)
3191 	return (ENOMEM);
3192     hp->cmd = cmd;
3193     hp->fn = fn;
3194     hp->arg = arg;
3195 
3196     ACPI_LOCK(acpi);
3197     if (acpi_ioctl_hooks_initted == 0) {
3198 	TAILQ_INIT(&acpi_ioctl_hooks);
3199 	acpi_ioctl_hooks_initted = 1;
3200     }
3201     TAILQ_INSERT_TAIL(&acpi_ioctl_hooks, hp, link);
3202     ACPI_UNLOCK(acpi);
3203 
3204     return (0);
3205 }
3206 
3207 void
3208 acpi_deregister_ioctl(u_long cmd, acpi_ioctl_fn fn)
3209 {
3210     struct acpi_ioctl_hook	*hp;
3211 
3212     ACPI_LOCK(acpi);
3213     TAILQ_FOREACH(hp, &acpi_ioctl_hooks, link)
3214 	if (hp->cmd == cmd && hp->fn == fn)
3215 	    break;
3216 
3217     if (hp != NULL) {
3218 	TAILQ_REMOVE(&acpi_ioctl_hooks, hp, link);
3219 	kfree(hp, M_ACPIDEV);
3220     }
3221     ACPI_UNLOCK(acpi);
3222 }
3223 
3224 static int
3225 acpiopen(struct dev_open_args *ap)
3226 {
3227     return (0);
3228 }
3229 
3230 static int
3231 acpiclose(struct dev_close_args *ap)
3232 {
3233     return (0);
3234 }
3235 
3236 static void
3237 acpi_free_object_list(ACPI_OBJECT_LIST *list)
3238 {
3239     for (int i = 0; i < list->Count; i++) {
3240 	switch (list->Pointer[i].Type) {
3241 	case ACPI_TYPE_STRING:
3242 	    AcpiOsFree(list->Pointer[i].String.Pointer);
3243 	    break;
3244 	case ACPI_TYPE_BUFFER:
3245 	    AcpiOsFree(list->Pointer[i].Buffer.Pointer);
3246 	    break;
3247 	default:
3248 	    break;
3249 	}
3250     }
3251     AcpiOsFree(list);
3252 }
3253 
3254 static ACPI_OBJECT_LIST *
3255 acpi_copyin_object_list(ACPI_OBJECT_LIST *src)
3256 {
3257     ACPI_OBJECT_LIST	*dest;
3258     BOOLEAN		failed;
3259 
3260     if (src->Count > 7)
3261 	return NULL;
3262 
3263     dest = AcpiOsAllocate(sizeof(ACPI_OBJECT_LIST) + sizeof(ACPI_OBJECT) * src->Count);
3264     if (!dest)
3265 	return NULL;
3266 
3267     dest->Count = src->Count;
3268     dest->Pointer = (ACPI_OBJECT *)(dest + 1);
3269     if (copyin(src->Pointer, dest->Pointer, sizeof(ACPI_OBJECT) * dest->Count)) {
3270 	AcpiOsFree(dest);
3271 	return NULL;
3272     }
3273 
3274     failed = FALSE;
3275 
3276     for (int i = 0; i < dest->Count; i++) {
3277 	switch (dest->Pointer[i].Type) {
3278 	case ACPI_TYPE_INTEGER:
3279 	    break;
3280 	case ACPI_TYPE_STRING: {
3281 	    void *v = AcpiOsAllocate(dest->Pointer[i].String.Length);
3282 	    if (!v || copyin(dest->Pointer[i].String.Pointer, v, dest->Pointer[i].String.Length))
3283 		failed = TRUE;
3284 	    dest->Pointer[i].String.Pointer = v;
3285 	    break;
3286 	}
3287 	case ACPI_TYPE_BUFFER: {
3288 	    void *v = AcpiOsAllocate(dest->Pointer[i].Buffer.Length);
3289 	    if (!v || copyin(dest->Pointer[i].Buffer.Pointer, v, dest->Pointer[i].Buffer.Length))
3290 		failed = TRUE;
3291 	    dest->Pointer[i].String.Pointer = v;
3292 	    break;
3293 	}
3294 	default:
3295 	    failed = TRUE;
3296 	    break;
3297 	}
3298     }
3299 
3300     if (failed) {
3301 	acpi_free_object_list(dest);
3302 	dest = NULL;
3303     }
3304 
3305     return dest;
3306 }
3307 
3308 static int
3309 acpi_call_ioctl(caddr_t addr)
3310 {
3311     struct acpi_mcall_ioctl_arg *params;
3312     ACPI_OBJECT_LIST	*args;
3313     ACPI_BUFFER		result;
3314     char		path[256];
3315 
3316     result.Length = ACPI_ALLOCATE_BUFFER;
3317     result.Pointer = NULL;
3318 
3319     params = (struct acpi_mcall_ioctl_arg *)addr;
3320     args = acpi_copyin_object_list(&params->args);
3321     if (!args)
3322 	return EINVAL;
3323     if (copyinstr(params->path, path, sizeof(path), NULL))
3324 	return EINVAL;
3325     params->retval = AcpiEvaluateObject(NULL, path, args, &result);
3326     if (ACPI_SUCCESS(params->retval)) {
3327 	if (result.Pointer != NULL) {
3328 	    if (params->result.Pointer != NULL) {
3329 		params->result.Length = min(params->result.Length,
3330 		    result.Length);
3331 		if (result.Length >= sizeof(ACPI_OBJECT)) {
3332 		    acpi_call_fixup_pointers((ACPI_OBJECT *)result.Pointer,
3333 			params->result.Pointer);
3334 		}
3335 		copyout(result.Pointer, params->result.Pointer,
3336 		    params->result.Length);
3337 		params->reslen = result.Length;
3338 	    }
3339 	    AcpiOsFree(result.Pointer);
3340 	}
3341     }
3342     acpi_free_object_list(args);
3343 
3344     return (0);
3345 }
3346 
3347 void
3348 acpi_call_fixup_pointers(ACPI_OBJECT *p, UINT8 *dest)
3349 {
3350     switch (p->Type) {
3351     case ACPI_TYPE_STRING:
3352 	p->String.Pointer += dest - (UINT8 *)p;
3353 	break;
3354     case ACPI_TYPE_BUFFER:
3355 	p->Buffer.Pointer += dest - (UINT8 *)p;
3356 	break;
3357     }
3358 }
3359 
3360 static int
3361 acpiioctl(struct dev_ioctl_args *ap)
3362 {
3363     struct acpi_softc		*sc;
3364     struct acpi_ioctl_hook	*hp;
3365     int				error, state;
3366 
3367     error = 0;
3368     hp = NULL;
3369     sc = ap->a_head.a_dev->si_drv1;
3370 
3371     /*
3372      * Scan the list of registered ioctls, looking for handlers.
3373      */
3374     lwkt_gettoken(&acpi_token);
3375     ACPI_LOCK(acpi);
3376     if (acpi_ioctl_hooks_initted) {
3377 	TAILQ_FOREACH(hp, &acpi_ioctl_hooks, link) {
3378 	    if (hp->cmd == ap->a_cmd)
3379 		break;
3380 	}
3381     }
3382     ACPI_UNLOCK(acpi);
3383     if (hp) {
3384 	error = hp->fn(ap->a_cmd, ap->a_data, hp->arg);
3385 	lwkt_reltoken(&acpi_token);
3386 	return error;
3387     }
3388 
3389     /*
3390      * Core ioctls are not permitted for non-writable user.
3391      * Currently, other ioctls just fetch information.
3392      * Not changing system behavior.
3393      */
3394     if ((ap->a_fflag & FWRITE) == 0) {
3395 	lwkt_reltoken(&acpi_token);
3396 	return (EPERM);
3397     }
3398 
3399     /* Core system ioctls. */
3400     switch (ap->a_cmd) {
3401     case ACPIIO_REQSLPSTATE:
3402 	state = *(int *)ap->a_data;
3403 	if (state != ACPI_STATE_S5)
3404 	    error = acpi_ReqSleepState(sc, state);
3405 	else {
3406 	    device_printf(sc->acpi_dev,
3407 		"power off via acpi ioctl not supported\n");
3408 	    error = ENXIO;
3409 	}
3410 	break;
3411     case ACPIIO_ACKSLPSTATE:
3412 	error = EOPNOTSUPP;
3413 #if 0 /* notyet */
3414 	error = *(int *)ap->a_data;
3415 	error = acpi_AckSleepState(sc->acpi_clone, error);
3416 #endif
3417 	break;
3418     case ACPIIO_SETSLPSTATE:	/* DEPRECATED */
3419 	error = EINVAL;
3420 	state = *(int *)ap->a_data;
3421 	if (state >= ACPI_STATE_S0 && state <= ACPI_S_STATES_MAX)
3422 	    if (ACPI_SUCCESS(acpi_SetSleepState(sc, state)))
3423 		error = 0;
3424 	break;
3425     case ACPIIO_DO_MCALL:
3426 	if (acpi_allow_mcall == 1) {
3427 	    error = acpi_call_ioctl(ap->a_data);
3428 	} else {
3429 	    device_printf(sc->acpi_dev,
3430 		"debug.acpi.allow_method_calls tunable must be set\n");
3431 	    error = ENXIO;
3432 	}
3433 	break;
3434     default:
3435 	error = ENXIO;
3436 	break;
3437     }
3438     lwkt_reltoken(&acpi_token);
3439 
3440     return (error);
3441 }
3442 
3443 static int
3444 acpi_supported_sleep_state_sysctl(SYSCTL_HANDLER_ARGS)
3445 {
3446     int error;
3447     struct sbuf sb;
3448     UINT8 state, TypeA, TypeB;
3449 
3450     sbuf_new(&sb, NULL, 32, SBUF_AUTOEXTEND);
3451     for (state = ACPI_STATE_S1; state < ACPI_S_STATES_MAX + 1; state++)
3452 	if (ACPI_SUCCESS(AcpiGetSleepTypeData(state, &TypeA, &TypeB)))
3453 	    sbuf_printf(&sb, "S%d ", state);
3454     sbuf_trim(&sb);
3455     sbuf_finish(&sb);
3456     error = sysctl_handle_string(oidp, sbuf_data(&sb), sbuf_len(&sb), req);
3457     sbuf_delete(&sb);
3458     return (error);
3459 }
3460 
3461 static int
3462 acpi_sleep_state_sysctl(SYSCTL_HANDLER_ARGS)
3463 {
3464     char sleep_state[10];
3465     int error;
3466     u_int new_state, old_state;
3467 
3468     old_state = *(u_int *)oidp->oid_arg1;
3469     if (old_state > ACPI_S_STATES_MAX + 1)
3470 	strlcpy(sleep_state, "unknown", sizeof(sleep_state));
3471     else
3472 	strlcpy(sleep_state, sleep_state_names[old_state], sizeof(sleep_state));
3473     error = sysctl_handle_string(oidp, sleep_state, sizeof(sleep_state), req);
3474     if (error == 0 && req->newptr != NULL) {
3475 	new_state = ACPI_STATE_S0;
3476 	for (; new_state <= ACPI_S_STATES_MAX + 1; new_state++)
3477 	    if (strcmp(sleep_state, sleep_state_names[new_state]) == 0)
3478 		break;
3479 	if (new_state <= ACPI_S_STATES_MAX + 1) {
3480 	    if (new_state != old_state)
3481 		*(u_int *)oidp->oid_arg1 = new_state;
3482 	} else
3483 	    error = EINVAL;
3484     }
3485 
3486     return (error);
3487 }
3488 
3489 /* Inform devctl(4) when we receive a Notify. */
3490 void
3491 acpi_UserNotify(const char *subsystem, ACPI_HANDLE h, uint8_t notify)
3492 {
3493     char		notify_buf[16];
3494     ACPI_BUFFER		handle_buf;
3495     ACPI_STATUS		status;
3496 
3497     if (subsystem == NULL)
3498 	return;
3499 
3500     handle_buf.Pointer = NULL;
3501     handle_buf.Length = ACPI_ALLOCATE_BUFFER;
3502     status = AcpiNsHandleToPathname(h, &handle_buf, FALSE);
3503     if (ACPI_FAILURE(status))
3504 	return;
3505     ksnprintf(notify_buf, sizeof(notify_buf), "notify=0x%02x", notify);
3506     devctl_notify("ACPI", subsystem, handle_buf.Pointer, notify_buf);
3507     AcpiOsFree(handle_buf.Pointer);
3508 }
3509 
3510 #ifdef ACPI_DEBUG
3511 /*
3512  * Support for parsing debug options from the kernel environment.
3513  *
3514  * Bits may be set in the AcpiDbgLayer and AcpiDbgLevel debug registers
3515  * by specifying the names of the bits in the debug.acpi.layer and
3516  * debug.acpi.level environment variables.  Bits may be unset by
3517  * prefixing the bit name with !.
3518  */
3519 struct debugtag
3520 {
3521     char	*name;
3522     UINT32	value;
3523 };
3524 
3525 static struct debugtag	dbg_layer[] = {
3526     {"ACPI_UTILITIES",		ACPI_UTILITIES},
3527     {"ACPI_HARDWARE",		ACPI_HARDWARE},
3528     {"ACPI_EVENTS",		ACPI_EVENTS},
3529     {"ACPI_TABLES",		ACPI_TABLES},
3530     {"ACPI_NAMESPACE",		ACPI_NAMESPACE},
3531     {"ACPI_PARSER",		ACPI_PARSER},
3532     {"ACPI_DISPATCHER",		ACPI_DISPATCHER},
3533     {"ACPI_EXECUTER",		ACPI_EXECUTER},
3534     {"ACPI_RESOURCES",		ACPI_RESOURCES},
3535     {"ACPI_CA_DEBUGGER",	ACPI_CA_DEBUGGER},
3536     {"ACPI_OS_SERVICES",	ACPI_OS_SERVICES},
3537     {"ACPI_CA_DISASSEMBLER",	ACPI_CA_DISASSEMBLER},
3538     {"ACPI_ALL_COMPONENTS",	ACPI_ALL_COMPONENTS},
3539 
3540     {"ACPI_AC_ADAPTER",		ACPI_AC_ADAPTER},
3541     {"ACPI_BATTERY",		ACPI_BATTERY},
3542     {"ACPI_BUS",		ACPI_BUS},
3543     {"ACPI_BUTTON",		ACPI_BUTTON},
3544     {"ACPI_EC", 		ACPI_EC},
3545     {"ACPI_FAN",		ACPI_FAN},
3546     {"ACPI_POWERRES",		ACPI_POWERRES},
3547     {"ACPI_PROCESSOR",		ACPI_PROCESSOR},
3548     {"ACPI_THERMAL",		ACPI_THERMAL},
3549     {"ACPI_TIMER",		ACPI_TIMER},
3550     {"ACPI_ALL_DRIVERS",	ACPI_ALL_DRIVERS},
3551     {NULL, 0}
3552 };
3553 
3554 static struct debugtag dbg_level[] = {
3555     {"ACPI_LV_INIT",		ACPI_LV_INIT},
3556     {"ACPI_LV_DEBUG_OBJECT",	ACPI_LV_DEBUG_OBJECT},
3557     {"ACPI_LV_INFO",		ACPI_LV_INFO},
3558     {"ACPI_LV_REPAIR",		ACPI_LV_REPAIR},
3559     {"ACPI_LV_ALL_EXCEPTIONS",	ACPI_LV_ALL_EXCEPTIONS},
3560 
3561     /* Trace verbosity level 1 [Standard Trace Level] */
3562     {"ACPI_LV_INIT_NAMES",	ACPI_LV_INIT_NAMES},
3563     {"ACPI_LV_PARSE",		ACPI_LV_PARSE},
3564     {"ACPI_LV_LOAD",		ACPI_LV_LOAD},
3565     {"ACPI_LV_DISPATCH",	ACPI_LV_DISPATCH},
3566     {"ACPI_LV_EXEC",		ACPI_LV_EXEC},
3567     {"ACPI_LV_NAMES",		ACPI_LV_NAMES},
3568     {"ACPI_LV_OPREGION",	ACPI_LV_OPREGION},
3569     {"ACPI_LV_BFIELD",		ACPI_LV_BFIELD},
3570     {"ACPI_LV_TABLES",		ACPI_LV_TABLES},
3571     {"ACPI_LV_VALUES",		ACPI_LV_VALUES},
3572     {"ACPI_LV_OBJECTS",		ACPI_LV_OBJECTS},
3573     {"ACPI_LV_RESOURCES",	ACPI_LV_RESOURCES},
3574     {"ACPI_LV_USER_REQUESTS",	ACPI_LV_USER_REQUESTS},
3575     {"ACPI_LV_PACKAGE",		ACPI_LV_PACKAGE},
3576     {"ACPI_LV_EVALUATION",	ACPI_LV_EVALUATION},
3577     {"ACPI_LV_VERBOSITY1",	ACPI_LV_VERBOSITY1},
3578 
3579     /* Trace verbosity level 2 [Function tracing and memory allocation] */
3580     {"ACPI_LV_ALLOCATIONS",	ACPI_LV_ALLOCATIONS},
3581     {"ACPI_LV_FUNCTIONS",	ACPI_LV_FUNCTIONS},
3582     {"ACPI_LV_OPTIMIZATIONS",	ACPI_LV_OPTIMIZATIONS},
3583     {"ACPI_LV_VERBOSITY2",	ACPI_LV_VERBOSITY2},
3584     {"ACPI_LV_ALL",		ACPI_LV_ALL},
3585 
3586     /* Trace verbosity level 3 [Threading, I/O, and Interrupts] */
3587     {"ACPI_LV_MUTEX",		ACPI_LV_MUTEX},
3588     {"ACPI_LV_THREADS",		ACPI_LV_THREADS},
3589     {"ACPI_LV_IO",		ACPI_LV_IO},
3590     {"ACPI_LV_INTERRUPTS",	ACPI_LV_INTERRUPTS},
3591     {"ACPI_LV_VERBOSITY3",	ACPI_LV_VERBOSITY3},
3592 
3593     /* Exceptionally verbose output -- also used in the global "DebugLevel"  */
3594     {"ACPI_LV_AML_DISASSEMBLE",	ACPI_LV_AML_DISASSEMBLE},
3595     {"ACPI_LV_VERBOSE_INFO",	ACPI_LV_VERBOSE_INFO},
3596     {"ACPI_LV_FULL_TABLES",	ACPI_LV_FULL_TABLES},
3597     {"ACPI_LV_EVENTS",		ACPI_LV_EVENTS},
3598     {"ACPI_LV_VERBOSE",		ACPI_LV_VERBOSE},
3599     {NULL, 0}
3600 };
3601 
3602 static void
3603 acpi_parse_debug(char *cp, struct debugtag *tag, UINT32 *flag)
3604 {
3605     char	*ep;
3606     int		i, l;
3607     int		set;
3608 
3609     while (*cp) {
3610 	if (isspace(*cp)) {
3611 	    cp++;
3612 	    continue;
3613 	}
3614 	ep = cp;
3615 	while (*ep && !isspace(*ep))
3616 	    ep++;
3617 	if (*cp == '!') {
3618 	    set = 0;
3619 	    cp++;
3620 	    if (cp == ep)
3621 		continue;
3622 	} else {
3623 	    set = 1;
3624 	}
3625 	l = ep - cp;
3626 	for (i = 0; tag[i].name != NULL; i++) {
3627 	    if (!strncmp(cp, tag[i].name, l)) {
3628 		if (set)
3629 		    *flag |= tag[i].value;
3630 		else
3631 		    *flag &= ~tag[i].value;
3632 	    }
3633 	}
3634 	cp = ep;
3635     }
3636 }
3637 
3638 static void
3639 acpi_set_debugging(void *junk)
3640 {
3641     char	*layer, *level;
3642 
3643     if (cold) {
3644 	AcpiDbgLayer = 0;
3645 	AcpiDbgLevel = 0;
3646     }
3647 
3648     layer = kgetenv("debug.acpi.layer");
3649     level = kgetenv("debug.acpi.level");
3650     if (layer == NULL && level == NULL)
3651 	return;
3652 
3653     kprintf("ACPI set debug");
3654     if (layer != NULL) {
3655 	if (strcmp("NONE", layer) != 0)
3656 	    kprintf(" layer '%s'", layer);
3657 	acpi_parse_debug(layer, &dbg_layer[0], &AcpiDbgLayer);
3658 	kfreeenv(layer);
3659     }
3660     if (level != NULL) {
3661 	if (strcmp("NONE", level) != 0)
3662 	    kprintf(" level '%s'", level);
3663 	acpi_parse_debug(level, &dbg_level[0], &AcpiDbgLevel);
3664 	kfreeenv(level);
3665     }
3666     kprintf("\n");
3667 }
3668 
3669 SYSINIT(acpi_debugging, SI_BOOT1_TUNABLES, SI_ORDER_ANY, acpi_set_debugging,
3670 	NULL);
3671 
3672 static int
3673 acpi_debug_sysctl(SYSCTL_HANDLER_ARGS)
3674 {
3675     int		 error, *dbg;
3676     struct	 debugtag *tag;
3677     struct	 sbuf sb;
3678 
3679     if (sbuf_new(&sb, NULL, 128, SBUF_AUTOEXTEND) == NULL)
3680 	return (ENOMEM);
3681     if (strcmp(oidp->oid_arg1, "debug.acpi.layer") == 0) {
3682 	tag = &dbg_layer[0];
3683 	dbg = &AcpiDbgLayer;
3684     } else {
3685 	tag = &dbg_level[0];
3686 	dbg = &AcpiDbgLevel;
3687     }
3688 
3689     /* Get old values if this is a get request. */
3690     ACPI_SERIAL_BEGIN(acpi);
3691     if (*dbg == 0) {
3692 	sbuf_cpy(&sb, "NONE");
3693     } else if (req->newptr == NULL) {
3694 	for (; tag->name != NULL; tag++) {
3695 	    if ((*dbg & tag->value) == tag->value)
3696 		sbuf_printf(&sb, "%s ", tag->name);
3697 	}
3698     }
3699     sbuf_trim(&sb);
3700     sbuf_finish(&sb);
3701 
3702     /* Copy out the old values to the user. */
3703     error = SYSCTL_OUT(req, sbuf_data(&sb), sbuf_len(&sb));
3704     sbuf_delete(&sb);
3705 
3706     /* If the user is setting a string, parse it. */
3707     if (error == 0 && req->newptr != NULL) {
3708 	*dbg = 0;
3709 	ksetenv((char *)oidp->oid_arg1, (char *)req->newptr);
3710 	acpi_set_debugging(NULL);
3711     }
3712     ACPI_SERIAL_END(acpi);
3713 
3714     return (error);
3715 }
3716 
3717 SYSCTL_PROC(_debug_acpi, OID_AUTO, layer, CTLFLAG_RW | CTLTYPE_STRING,
3718 	    "debug.acpi.layer", 0, acpi_debug_sysctl, "A", "");
3719 SYSCTL_PROC(_debug_acpi, OID_AUTO, level, CTLFLAG_RW | CTLTYPE_STRING,
3720 	    "debug.acpi.level", 0, acpi_debug_sysctl, "A", "");
3721 #endif /* ACPI_DEBUG */
3722 
3723 static int
3724 acpi_debug_objects_sysctl(SYSCTL_HANDLER_ARGS)
3725 {
3726 	int	error;
3727 	int	old;
3728 
3729 	old = acpi_debug_objects;
3730 	error = sysctl_handle_int(oidp, &acpi_debug_objects, 0, req);
3731 	if (error != 0 || req->newptr == NULL)
3732 		return (error);
3733 	if (old == acpi_debug_objects || (old && acpi_debug_objects))
3734 		return (0);
3735 
3736 	ACPI_SERIAL_BEGIN(acpi);
3737 	AcpiGbl_EnableAmlDebugObject = acpi_debug_objects ? TRUE : FALSE;
3738 	ACPI_SERIAL_END(acpi);
3739 
3740 	return (0);
3741 }
3742 
3743 
3744 static int
3745 acpi_parse_interfaces(char *str, struct acpi_interface *iface)
3746 {
3747 	char *p;
3748 	size_t len;
3749 	int i, j;
3750 
3751 	p = str;
3752 	while (isspace(*p) || *p == ',')
3753 		p++;
3754 	len = strlen(p);
3755 	if (len == 0)
3756 		return (0);
3757 	p = kstrdup(p, M_TEMP);
3758 	for (i = 0; i < len; i++)
3759 		if (p[i] == ',')
3760 			p[i] = '\0';
3761 	i = j = 0;
3762 	while (i < len)
3763 		if (isspace(p[i]) || p[i] == '\0')
3764 			i++;
3765 		else {
3766 			i += strlen(p + i) + 1;
3767 			j++;
3768 		}
3769 	if (j == 0) {
3770 		kfree(p, M_TEMP);
3771 		return (0);
3772 	}
3773 	iface->data = kmalloc(sizeof(*iface->data) * j, M_TEMP, M_WAITOK);
3774 	iface->num = j;
3775 	i = j = 0;
3776 	while (i < len)
3777 		if (isspace(p[i]) || p[i] == '\0')
3778 			i++;
3779 		else {
3780 			iface->data[j] = p + i;
3781 			i += strlen(p + i) + 1;
3782 			j++;
3783 		}
3784 
3785 	return (j);
3786 }
3787 
3788 static void
3789 acpi_free_interfaces(struct acpi_interface *iface)
3790 {
3791 	kfree(iface->data[0], M_TEMP);
3792 	kfree(iface->data, M_TEMP);
3793 }
3794 
3795 static void
3796 acpi_reset_interfaces(device_t dev)
3797 {
3798 	struct acpi_interface list;
3799 	ACPI_STATUS status;
3800 	int i;
3801 
3802 	if (acpi_parse_interfaces(acpi_install_interface, &list) > 0) {
3803 		for (i = 0; i < list.num; i++) {
3804 			status = AcpiInstallInterface(list.data[i]);
3805 			if (ACPI_FAILURE(status))
3806 				device_printf(dev,
3807 				    "failed to install _OSI(\"%s\"): %s\n",
3808 				    list.data[i], AcpiFormatException(status));
3809 			else if (bootverbose)
3810 				device_printf(dev, "installed _OSI(\"%s\")\n",
3811 				    list.data[i]);
3812 		}
3813 		acpi_free_interfaces(&list);
3814 	}
3815 	if (acpi_parse_interfaces(acpi_remove_interface, &list) > 0) {
3816 		for (i = 0; i < list.num; i++) {
3817 			status = AcpiRemoveInterface(list.data[i]);
3818 			if (ACPI_FAILURE(status))
3819 				device_printf(dev,
3820 				    "failed to remove _OSI(\"%s\"): %s\n",
3821 				    list.data[i], AcpiFormatException(status));
3822 			else if (bootverbose)
3823 				device_printf(dev, "removed _OSI(\"%s\")\n",
3824 				    list.data[i]);
3825 		}
3826 		acpi_free_interfaces(&list);
3827 	}
3828 }
3829 
3830 static int
3831 acpi_pm_func(u_long cmd, void *arg, ...)
3832 {
3833 	int	state, acpi_state;
3834 	int	error;
3835 	struct	acpi_softc *sc;
3836 	__va_list ap;
3837 
3838 	error = 0;
3839 	switch (cmd) {
3840 	case POWER_CMD_SUSPEND:
3841 		sc = (struct acpi_softc *)arg;
3842 		if (sc == NULL) {
3843 			error = EINVAL;
3844 			goto out;
3845 		}
3846 
3847 		__va_start(ap, arg);
3848 		state = __va_arg(ap, int);
3849 		__va_end(ap);
3850 
3851 		switch (state) {
3852 		case POWER_SLEEP_STATE_STANDBY:
3853 			acpi_state = sc->acpi_standby_sx;
3854 			break;
3855 		case POWER_SLEEP_STATE_SUSPEND:
3856 			acpi_state = sc->acpi_suspend_sx;
3857 			break;
3858 		case POWER_SLEEP_STATE_HIBERNATE:
3859 			acpi_state = ACPI_STATE_S4;
3860 			break;
3861 		default:
3862 			error = EINVAL;
3863 			goto out;
3864 		}
3865 
3866 		if (ACPI_FAILURE(acpi_EnterSleepState(sc, acpi_state)))
3867 			error = ENXIO;
3868 		break;
3869 	default:
3870 		error = EINVAL;
3871 		goto out;
3872 	}
3873 
3874 out:
3875 	return (error);
3876 }
3877 
3878 static void
3879 acpi_pm_register(void *arg)
3880 {
3881     if (!cold || resource_disabled("acpi", 0))
3882 	return;
3883 
3884     power_pm_register(POWER_PM_TYPE_ACPI, acpi_pm_func, NULL);
3885 }
3886 
3887 SYSINIT(power, SI_BOOT2_KLD, SI_ORDER_ANY, acpi_pm_register, 0);
3888