xref: /dragonfly/sys/dev/acpica/acpi.c (revision a1626531)
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 	if (adinfo)
920 	    AcpiOsFree(adinfo);
921     }
922     return (0);
923 }
924 
925 /*
926  * Handle per-device ivars
927  */
928 static int
929 acpi_read_ivar(device_t dev, device_t child, int index, uintptr_t *result)
930 {
931     struct acpi_device	*ad;
932 
933     if ((ad = device_get_ivars(child)) == NULL) {
934 	device_printf(child, "device has no ivars\n");
935 	return (ENOENT);
936     }
937 
938     /* ACPI and ISA compatibility ivars */
939     switch(index) {
940     case ACPI_IVAR_HANDLE:
941 	*(ACPI_HANDLE *)result = ad->ad_handle;
942 	break;
943     case ACPI_IVAR_MAGIC:
944 	*result = ad->ad_magic;
945 	break;
946     case ACPI_IVAR_PRIVATE:
947 	*(void **)result = ad->ad_private;
948 	break;
949     case ACPI_IVAR_FLAGS:
950 	*(int *)result = ad->ad_flags;
951 	break;
952     case ACPI_IVAR_RECHECK:
953 	*(int *)result = ad->ad_recheck;
954 	break;
955     case ISA_IVAR_VENDORID:
956     case ISA_IVAR_SERIAL:
957     case ISA_IVAR_COMPATID:
958 	*(int *)result = -1;
959 	break;
960     case ISA_IVAR_LOGICALID:
961 	*(int *)result = acpi_isa_get_logicalid(child);
962 	break;
963     default:
964 	return (ENOENT);
965     }
966 
967     return (0);
968 }
969 
970 static int
971 acpi_write_ivar(device_t dev, device_t child, int index, uintptr_t value)
972 {
973     struct acpi_device	*ad;
974 
975     if ((ad = device_get_ivars(child)) == NULL) {
976 	device_printf(child, "device has no ivars\n");
977 	return (ENOENT);
978     }
979 
980     switch(index) {
981     case ACPI_IVAR_HANDLE:
982 	ad->ad_handle = (ACPI_HANDLE)value;
983 	break;
984     case ACPI_IVAR_MAGIC:
985 	ad->ad_magic = value;
986 	break;
987     case ACPI_IVAR_PRIVATE:
988 	ad->ad_private = (void *)value;
989 	break;
990     case ACPI_IVAR_FLAGS:
991 	ad->ad_flags = (int)value;
992 	break;
993     case ACPI_IVAR_RECHECK:
994 	ad->ad_recheck = (int)value;
995 	break;
996     default:
997 	panic("bad ivar write request (%d)", index);
998 	return (ENOENT);
999     }
1000 
1001     return (0);
1002 }
1003 
1004 /*
1005  * Handle child resource allocation/removal
1006  */
1007 static struct resource_list *
1008 acpi_get_rlist(device_t dev, device_t child)
1009 {
1010     struct acpi_device		*ad;
1011 
1012     ad = device_get_ivars(child);
1013     return (&ad->ad_rl);
1014 }
1015 
1016 /*
1017  * Pre-allocate/manage all memory and IO resources.  Since rman can't handle
1018  * duplicates, we merge any in the sysresource attach routine.
1019  */
1020 static int
1021 acpi_sysres_alloc(device_t dev)
1022 {
1023     struct resource *res;
1024     struct resource_list *rl;
1025     struct resource_list_entry *rle;
1026     struct rman *rm;
1027     char *sysres_ids[] = { "PNP0C01", "PNP0C02", NULL };
1028     device_t *children;
1029     int child_count, i;
1030     /*
1031      * Probe/attach any sysresource devices.  This would be unnecessary if we
1032      * had multi-pass probe/attach.
1033      */
1034     if (device_get_children(dev, &children, &child_count) != 0)
1035 	return (ENXIO);
1036     for (i = 0; i < child_count; i++) {
1037 	if (ACPI_ID_PROBE(dev, children[i], sysres_ids) != NULL)
1038 	    device_probe_and_attach(children[i]);
1039     }
1040     kfree(children, M_TEMP);
1041 
1042     rl = BUS_GET_RESOURCE_LIST(device_get_parent(dev), dev);
1043     if(!rl)
1044 	return 0;
1045     SLIST_FOREACH(rle, rl, link) {
1046 	if (rle->res != NULL) {
1047 	    device_printf(dev, "duplicate resource for %lx\n", rle->start);
1048 	    continue;
1049 	}
1050 
1051 	/* Only memory and IO resources are valid here. */
1052 	switch (rle->type) {
1053 	case SYS_RES_IOPORT:
1054 	    rm = &acpi_rman_io;
1055 	    break;
1056 	case SYS_RES_MEMORY:
1057 	    rm = &acpi_rman_mem;
1058 	    break;
1059 	default:
1060 	    continue;
1061 	}
1062 
1063 	/* Pre-allocate resource and add to our rman pool. */
1064 	res = BUS_ALLOC_RESOURCE(device_get_parent(dev), dev, rle->type,
1065 	    &rle->rid, rle->start, rle->start + rle->count - 1, rle->count,
1066 	    0, -1);
1067 	if (res != NULL) {
1068 	    rman_manage_region(rm, rman_get_start(res), rman_get_end(res));
1069 	    rle->res = res;
1070 	} else
1071 	    device_printf(dev, "reservation of %lx, %lx (%d) failed\n",
1072 		rle->start, rle->count, rle->type);
1073     }
1074     return (0);
1075 }
1076 
1077 static struct resource *
1078 acpi_alloc_resource(device_t bus, device_t child, int type, int *rid,
1079     u_long start, u_long end, u_long count, u_int flags, int cpuid)
1080 {
1081     ACPI_RESOURCE ares;
1082     struct acpi_device *ad = device_get_ivars(child);
1083     struct resource_list *rl = &ad->ad_rl;
1084     struct resource_list_entry *rle;
1085     struct resource *res;
1086     struct rman *rm;
1087 
1088     res = NULL;
1089 
1090     /* We only handle memory and IO resources through rman. */
1091     switch (type) {
1092     case SYS_RES_IOPORT:
1093 	rm = &acpi_rman_io;
1094 	break;
1095     case SYS_RES_MEMORY:
1096 	rm = &acpi_rman_mem;
1097 	break;
1098     default:
1099 	rm = NULL;
1100     }
1101 
1102     ACPI_SERIAL_BEGIN(acpi);
1103 
1104     /*
1105      * If this is an allocation of the "default" range for a given RID, and
1106      * we know what the resources for this device are (i.e., they're on the
1107      * child's resource list), use those start/end values.
1108      */
1109     if (bus == device_get_parent(child) && start == 0UL && end == ~0UL) {
1110 	rle = resource_list_find(rl, type, *rid);
1111 	if (rle == NULL)
1112 	    goto out;
1113 	start = rle->start;
1114 	end = rle->end;
1115 	count = rle->count;
1116 	cpuid = rle->cpuid;
1117     }
1118 
1119     /*
1120      * If this is an allocation of a specific range, see if we can satisfy
1121      * the request from our system resource regions.  If we can't, pass the
1122      * request up to the parent.
1123      */
1124     if (start + count - 1 == end && rm != NULL)
1125 	res = rman_reserve_resource(rm, start, end, count, flags & ~RF_ACTIVE,
1126 	    child);
1127     if (res == NULL) {
1128 	res = BUS_ALLOC_RESOURCE(device_get_parent(bus), child, type, rid,
1129 	    start, end, count, flags, cpuid);
1130     } else {
1131 	rman_set_rid(res, *rid);
1132 
1133 	/* If requested, activate the resource using the parent's method. */
1134 	if (flags & RF_ACTIVE)
1135 	    if (bus_activate_resource(child, type, *rid, res) != 0) {
1136 		rman_release_resource(res);
1137 		res = NULL;
1138 		goto out;
1139 	    }
1140     }
1141 
1142     if (res != NULL && device_get_parent(child) == bus)
1143 	switch (type) {
1144 	case SYS_RES_IRQ:
1145 	    /*
1146 	     * Since bus_config_intr() takes immediate effect, we cannot
1147 	     * configure the interrupt associated with a device when we
1148 	     * parse the resources but have to defer it until a driver
1149 	     * actually allocates the interrupt via bus_alloc_resource().
1150 	     *
1151 	     * NB: Lookup failure is fine, since the device may add its
1152 	     * own interrupt resources, e.g. MSI or MSI-X.
1153 	     */
1154 	    if (ACPI_SUCCESS(
1155 		    acpi_lookup_irq_resource(child, *rid, res, &ares))) {
1156 		acpi_config_intr(child, &ares);
1157 	    } else {
1158 		kprintf("irq resource not found\n");
1159 	    }
1160 	    break;
1161 	}
1162 
1163 out:
1164     ACPI_SERIAL_END(acpi);
1165     return (res);
1166 }
1167 
1168 static int
1169 acpi_release_resource(device_t bus, device_t child, int type, int rid,
1170     struct resource *r)
1171 {
1172     struct rman *rm;
1173     int ret;
1174 
1175     /* We only handle memory and IO resources through rman. */
1176     switch (type) {
1177     case SYS_RES_IOPORT:
1178 	rm = &acpi_rman_io;
1179 	break;
1180     case SYS_RES_MEMORY:
1181 	rm = &acpi_rman_mem;
1182 	break;
1183     default:
1184 	rm = NULL;
1185     }
1186 
1187     ACPI_SERIAL_BEGIN(acpi);
1188 
1189     /*
1190      * If this resource belongs to one of our internal managers,
1191      * deactivate it and release it to the local pool.  If it doesn't,
1192      * pass this request up to the parent.
1193      */
1194     if (rm != NULL && rman_is_region_manager(r, rm)) {
1195 	if (rman_get_flags(r) & RF_ACTIVE) {
1196 	    ret = bus_deactivate_resource(child, type, rid, r);
1197 	    if (ret != 0)
1198 		goto out;
1199 	}
1200 	ret = rman_release_resource(r);
1201     } else
1202 	ret = BUS_RELEASE_RESOURCE(device_get_parent(bus), child, type, rid, r);
1203 
1204 out:
1205     ACPI_SERIAL_END(acpi);
1206     return (ret);
1207 }
1208 
1209 static void
1210 acpi_delete_resource(device_t bus, device_t child, int type, int rid)
1211 {
1212     struct resource_list *rl;
1213 
1214     rl = acpi_get_rlist(bus, child);
1215     resource_list_delete(rl, type, rid);
1216 }
1217 
1218 /* Allocate an IO port or memory resource, given its GAS. */
1219 int
1220 acpi_bus_alloc_gas(device_t dev, int *type, int *rid, ACPI_GENERIC_ADDRESS *gas,
1221     struct resource **res, u_int flags)
1222 {
1223     int error, res_type;
1224 
1225     error = ENOMEM;
1226     if (type == NULL || rid == NULL || gas == NULL || res == NULL)
1227 	return (EINVAL);
1228 
1229     /* We only support memory and IO spaces. */
1230     switch (gas->SpaceId) {
1231     case ACPI_ADR_SPACE_SYSTEM_MEMORY:
1232 	res_type = SYS_RES_MEMORY;
1233 	break;
1234     case ACPI_ADR_SPACE_SYSTEM_IO:
1235 	res_type = SYS_RES_IOPORT;
1236 	break;
1237     default:
1238 	return (EOPNOTSUPP);
1239     }
1240 
1241     /*
1242      * If the register width is less than 8, assume the BIOS author means
1243      * it is a bit field and just allocate a byte.
1244      */
1245     if (gas->BitWidth && gas->BitWidth < 8)
1246 	gas->BitWidth = 8;
1247 
1248     /* Validate the address after we're sure we support the space. */
1249     if (gas->Address == 0 || gas->BitWidth == 0)
1250 	return (EINVAL);
1251 
1252     bus_set_resource(dev, res_type, *rid, gas->Address,
1253 	gas->BitWidth / 8, -1);
1254     *res = bus_alloc_resource_any(dev, res_type, rid, RF_ACTIVE | flags);
1255     if (*res != NULL) {
1256 	*type = res_type;
1257 	error = 0;
1258     } else
1259 	bus_delete_resource(dev, res_type, *rid);
1260 
1261     return (error);
1262 }
1263 
1264 ACPI_STATUS
1265 acpi_eval_osc(device_t dev, ACPI_HANDLE handle, const char *uuidstr,
1266     int revision, uint32_t *buf, int count)
1267 {
1268     ACPI_BUFFER		retbuf = { ACPI_ALLOCATE_BUFFER, NULL };
1269     ACPI_OBJECT_LIST	arglist;
1270     ACPI_OBJECT		arg[4];
1271     ACPI_OBJECT		*retobj;
1272     ACPI_STATUS		status;
1273     struct uuid		uuid;
1274     uint32_t		error;
1275     uint8_t		oscuuid[ACPI_UUID_LENGTH];
1276     int			i;
1277 
1278     if (parse_uuid(uuidstr, &uuid) != 0)
1279 	    return (AE_ERROR);
1280     le_uuid_enc(oscuuid, &uuid);
1281 
1282     arglist.Pointer = arg;
1283     arglist.Count = 4;
1284     arg[0].Type = ACPI_TYPE_BUFFER;
1285     arg[0].Buffer.Length = ACPI_UUID_LENGTH;
1286     arg[0].Buffer.Pointer = oscuuid;		/* UUID */
1287     arg[1].Type = ACPI_TYPE_INTEGER;
1288     arg[1].Integer.Value = revision;		/* revision */
1289     arg[2].Type = ACPI_TYPE_INTEGER;
1290     arg[2].Integer.Value = count;		/* # of cap integers */
1291     arg[3].Type = ACPI_TYPE_BUFFER;
1292     arg[3].Buffer.Length = count * sizeof(uint32_t); /* capabilities buffer */
1293     arg[3].Buffer.Pointer = (uint8_t *)buf;
1294 
1295     status = AcpiEvaluateObject(handle, "_OSC", &arglist, &retbuf);
1296     if (ACPI_FAILURE(status))
1297 	goto done;
1298     retobj = retbuf.Pointer;
1299     error = ((uint32_t *)retobj->Buffer.Pointer)[0] & ACPI_OSC_ERRMASK;
1300     if (error == 0)
1301 	goto done;
1302     status = AE_ERROR;
1303     if (error & ACPI_OSCERR_FAILURE)
1304 	device_printf(dev, "_OSC unable to process request\n");
1305     if (error & ACPI_OSCERR_BADUUID)
1306 	device_printf(dev, "_OSC unrecognized UUID (%s)\n", uuidstr);
1307     if (error & ACPI_OSCERR_BADREV)
1308 	device_printf(dev, "_OSC unrecognized revision ID (%d)\n", revision);
1309     if (error & ACPI_OSCERR_CAPSMASKED) {
1310 	if ((buf[0] & ACPI_OSC_QUERY_SUPPORT) == 0) {
1311 	    for (i = 1; i < count; i++) {
1312 		device_printf(dev,
1313 		    "_OSC capabilities have been masked: buf[%d]:%#x\n",
1314 		    i, buf[i] & ~((uint32_t *)retobj->Buffer.Pointer)[i]);
1315 	    }
1316 	    status = AE_SUPPORT;
1317 	} else {
1318 	    status = AE_OK;
1319 	}
1320     }
1321     if (buf[0] & ACPI_OSC_QUERY_SUPPORT) {
1322 	for (i = 0; i < count; i++)
1323 	    buf[i] = ((uint32_t *)retobj->Buffer.Pointer)[i];
1324     }
1325 
1326 done:
1327     if (retbuf.Pointer != NULL)
1328 	AcpiOsFree(retbuf.Pointer);
1329     return (status);
1330 }
1331 
1332 /* Probe _HID and _CID for compatible ISA PNP ids. */
1333 static uint32_t
1334 acpi_isa_get_logicalid(device_t dev)
1335 {
1336     ACPI_DEVICE_INFO	*devinfo;
1337     ACPI_HANDLE		h;
1338     uint32_t		pnpid;
1339 
1340     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1341 
1342     devinfo = NULL;
1343     pnpid = 0;
1344 
1345     /* Fetch and validate the HID. */
1346     if ((h = acpi_get_handle(dev)) == NULL ||
1347 	ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo)))
1348 	goto out;
1349 
1350     if ((devinfo->Valid & ACPI_VALID_HID) != 0)
1351 	pnpid = PNP_EISAID(devinfo->HardwareId.String);
1352 
1353 out:
1354     if (devinfo)
1355 	AcpiOsFree(devinfo);
1356     return_VALUE (pnpid);
1357 }
1358 
1359 static int
1360 acpi_isa_get_compatid(device_t dev, uint32_t *cids, int count)
1361 {
1362     ACPI_DEVICE_INFO	*devinfo;
1363     ACPI_HANDLE		h;
1364     uint32_t		*pnpid;
1365     int			valid, i;
1366 
1367     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1368 
1369     devinfo = NULL;
1370     pnpid = cids;
1371     valid = 0;
1372 
1373     /* Fetch and validate the CID */
1374     if ((h = acpi_get_handle(dev)) == NULL ||
1375 	ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo)) ||
1376 	(devinfo->Valid & ACPI_VALID_CID) == 0)
1377 	goto out;
1378 
1379     if (devinfo->CompatibleIdList.Count < count)
1380 	count = devinfo->CompatibleIdList.Count;
1381     for (i = 0; i < count; i++) {
1382 	if (strncmp(devinfo->CompatibleIdList.Ids[i].String, "PNP", 3) != 0)
1383 	    continue;
1384 	*pnpid++ = PNP_EISAID(devinfo->CompatibleIdList.Ids[i].String);
1385 	valid++;
1386     }
1387 
1388 out:
1389     if (devinfo)
1390 	AcpiOsFree(devinfo);
1391     return_VALUE (valid);
1392 }
1393 
1394 static char *
1395 acpi_device_id_probe(device_t bus, device_t dev, char **ids)
1396 {
1397     ACPI_HANDLE h;
1398     int i;
1399 
1400     h = acpi_get_handle(dev);
1401     if (ids == NULL || h == NULL || acpi_get_type(dev) != ACPI_TYPE_DEVICE)
1402 	return (NULL);
1403 
1404     /* Try to match one of the array of IDs with a HID or CID. */
1405     for (i = 0; ids[i] != NULL; i++) {
1406 	if (acpi_MatchHid(h, ids[i]))
1407 	    return (ids[i]);
1408     }
1409     return (NULL);
1410 }
1411 
1412 static ACPI_STATUS
1413 acpi_device_eval_obj(device_t bus, device_t dev, ACPI_STRING pathname,
1414     ACPI_OBJECT_LIST *parameters, ACPI_BUFFER *ret)
1415 {
1416     ACPI_HANDLE h;
1417 
1418     if (dev == NULL)
1419 	h = ACPI_ROOT_OBJECT;
1420     else if ((h = acpi_get_handle(dev)) == NULL)
1421 	return (AE_BAD_PARAMETER);
1422     return (AcpiEvaluateObject(h, pathname, parameters, ret));
1423 }
1424 
1425 static int
1426 acpi_device_pwr_for_sleep(device_t bus, device_t dev, int *dstate)
1427 {
1428     struct acpi_softc *sc;
1429     ACPI_HANDLE handle;
1430     ACPI_STATUS status;
1431     char sxd[8];
1432     int error;
1433 
1434     sc = device_get_softc(bus);
1435     handle = acpi_get_handle(dev);
1436 
1437     /*
1438      * XXX If we find these devices, don't try to power them down.
1439      * The serial and IRDA ports on my T23 hang the system when
1440      * set to D3 and it appears that such legacy devices may
1441      * need special handling in their drivers.
1442      */
1443     if (handle == NULL ||
1444 	acpi_MatchHid(handle, "PNP0500") ||
1445 	acpi_MatchHid(handle, "PNP0501") ||
1446 	acpi_MatchHid(handle, "PNP0502") ||
1447 	acpi_MatchHid(handle, "PNP0510") ||
1448 	acpi_MatchHid(handle, "PNP0511"))
1449 	return (ENXIO);
1450 
1451     /*
1452      * Override next state with the value from _SxD, if present.  If no
1453      * dstate argument was provided, don't fetch the return value.
1454      */
1455     ksnprintf(sxd, sizeof(sxd), "_S%dD", sc->acpi_sstate);
1456     if (dstate)
1457 	status = acpi_GetInteger(handle, sxd, dstate);
1458     else
1459 	status = AcpiEvaluateObject(handle, sxd, NULL, NULL);
1460 
1461     switch (status) {
1462     case AE_OK:
1463 	error = 0;
1464 	break;
1465     case AE_NOT_FOUND:
1466 	error = ESRCH;
1467 	break;
1468     default:
1469 	error = ENXIO;
1470 	break;
1471     }
1472 
1473     return (error);
1474 }
1475 
1476 /* Callback arg for our implementation of walking the namespace. */
1477 struct acpi_device_scan_ctx {
1478     acpi_scan_cb_t	user_fn;
1479     void		*arg;
1480     ACPI_HANDLE		parent;
1481 };
1482 
1483 static ACPI_STATUS
1484 acpi_device_scan_cb(ACPI_HANDLE h, UINT32 level, void *arg, void **retval)
1485 {
1486     struct acpi_device_scan_ctx *ctx;
1487     device_t dev, old_dev;
1488     ACPI_STATUS status;
1489     ACPI_OBJECT_TYPE type;
1490 
1491     /*
1492      * Skip this device if we think we'll have trouble with it or it is
1493      * the parent where the scan began.
1494      */
1495     ctx = (struct acpi_device_scan_ctx *)arg;
1496     if (acpi_avoid(h) || h == ctx->parent)
1497 	return (AE_OK);
1498 
1499     /* If this is not a valid device type (e.g., a method), skip it. */
1500     if (ACPI_FAILURE(AcpiGetType(h, &type)))
1501 	return (AE_OK);
1502     if (type != ACPI_TYPE_DEVICE && type != ACPI_TYPE_PROCESSOR &&
1503 	type != ACPI_TYPE_THERMAL && type != ACPI_TYPE_POWER)
1504 	return (AE_OK);
1505 
1506     /*
1507      * Call the user function with the current device.  If it is unchanged
1508      * afterwards, return.  Otherwise, we update the handle to the new dev.
1509      */
1510     old_dev = acpi_get_device(h);
1511     dev = old_dev;
1512     status = ctx->user_fn(h, &dev, level, ctx->arg);
1513     if (ACPI_FAILURE(status) || old_dev == dev)
1514 	return (status);
1515 
1516     /* Remove the old child and its connection to the handle. */
1517     if (old_dev != NULL) {
1518 	device_delete_child(device_get_parent(old_dev), old_dev);
1519 	AcpiDetachData(h, acpi_fake_objhandler);
1520     }
1521 
1522     /* Recreate the handle association if the user created a device. */
1523     if (dev != NULL)
1524 	AcpiAttachData(h, acpi_fake_objhandler, dev);
1525 
1526     return (AE_OK);
1527 }
1528 
1529 static ACPI_STATUS
1530 acpi_device_scan_children(device_t bus, device_t dev, int max_depth,
1531     acpi_scan_cb_t user_fn, void *arg)
1532 {
1533     ACPI_HANDLE h;
1534     struct acpi_device_scan_ctx ctx;
1535 
1536     if (acpi_disabled("children"))
1537 	return (AE_OK);
1538 
1539     if (dev == NULL)
1540 	h = ACPI_ROOT_OBJECT;
1541     else if ((h = acpi_get_handle(dev)) == NULL)
1542 	return (AE_BAD_PARAMETER);
1543     ctx.user_fn = user_fn;
1544     ctx.arg = arg;
1545     ctx.parent = h;
1546     return (AcpiWalkNamespace(ACPI_TYPE_ANY, h, max_depth,
1547 	acpi_device_scan_cb, NULL, &ctx, NULL));
1548 }
1549 
1550 /*
1551  * Even though ACPI devices are not PCI, we use the PCI approach for setting
1552  * device power states since it's close enough to ACPI.
1553  */
1554 static int
1555 acpi_set_powerstate_method(device_t bus, device_t child, int state)
1556 {
1557     ACPI_HANDLE h;
1558     ACPI_STATUS status;
1559     int error;
1560 
1561     error = 0;
1562     h = acpi_get_handle(child);
1563     if (state < ACPI_STATE_D0 || state > ACPI_STATE_D3)
1564 	return (EINVAL);
1565     if (h == NULL)
1566 	return (0);
1567 
1568     /* Ignore errors if the power methods aren't present. */
1569     status = acpi_pwr_switch_consumer(h, state);
1570     if (ACPI_FAILURE(status) && status != AE_NOT_FOUND
1571 	&& status != AE_BAD_PARAMETER)
1572 	device_printf(bus, "failed to set ACPI power state D%d on %s: %s\n",
1573 	    state, acpi_name(h), AcpiFormatException(status));
1574 
1575     return (error);
1576 }
1577 
1578 static int
1579 acpi_isa_pnp_probe(device_t bus, device_t child, struct isa_pnp_id *ids)
1580 {
1581     int			result, cid_count, i;
1582     uint32_t		lid, cids[8];
1583 
1584     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1585 
1586     /*
1587      * ISA-style drivers attached to ACPI may persist and
1588      * probe manually if we return ENOENT.  We never want
1589      * that to happen, so don't ever return it.
1590      */
1591     result = ENXIO;
1592 
1593     /* Scan the supplied IDs for a match */
1594     lid = acpi_isa_get_logicalid(child);
1595     cid_count = acpi_isa_get_compatid(child, cids, 8);
1596     while (ids && ids->ip_id) {
1597 	if (lid == ids->ip_id) {
1598 	    result = 0;
1599 	    goto out;
1600 	}
1601 	for (i = 0; i < cid_count; i++) {
1602 	    if (cids[i] == ids->ip_id) {
1603 		result = 0;
1604 		goto out;
1605 	    }
1606 	}
1607 	ids++;
1608     }
1609 
1610  out:
1611     if (result == 0 && ids->ip_desc)
1612 	device_set_desc(child, ids->ip_desc);
1613 
1614     return_VALUE (result);
1615 }
1616 
1617 /*
1618  * Look for a MCFG table.  If it is present, use the settings for
1619  * domain (segment) 0 to setup PCI config space access via the memory
1620  * map.
1621  */
1622 static void
1623 acpi_enable_pcie(void)
1624 {
1625 	ACPI_TABLE_HEADER *hdr;
1626 	ACPI_MCFG_ALLOCATION *alloc, *end;
1627 	ACPI_STATUS status;
1628 
1629 	status = AcpiGetTable(ACPI_SIG_MCFG, 1, &hdr);
1630 	if (ACPI_FAILURE(status))
1631 		return;
1632 
1633 	end = (ACPI_MCFG_ALLOCATION *)((char *)hdr + hdr->Length);
1634 	alloc = (ACPI_MCFG_ALLOCATION *)((ACPI_TABLE_MCFG *)hdr + 1);
1635 	while (alloc < end) {
1636 		if (alloc->PciSegment == 0) {
1637 			pcie_cfgregopen(alloc->Address, alloc->StartBusNumber,
1638 			    alloc->EndBusNumber);
1639 			return;
1640 		}
1641 		alloc++;
1642 	}
1643 }
1644 
1645 /*
1646  * Scan all of the ACPI namespace and attach child devices.
1647  *
1648  * We should only expect to find devices in the \_PR, \_TZ, \_SI, and
1649  * \_SB scopes, and \_PR and \_TZ became obsolete in the ACPI 2.0 spec.
1650  * However, in violation of the spec, some systems place their PCI link
1651  * devices in \, so we have to walk the whole namespace.  We check the
1652  * type of namespace nodes, so this should be ok.
1653  */
1654 static void
1655 acpi_probe_children(device_t bus)
1656 {
1657     device_t *children;
1658     int cnt;
1659 
1660     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1661 
1662     /*
1663      * Scan the namespace and insert placeholders for all the devices that
1664      * we find.  We also probe/attach any early devices.
1665      *
1666      * Note that we use AcpiWalkNamespace rather than AcpiGetDevices because
1667      * we want to create nodes for all devices, not just those that are
1668      * currently present. (This assumes that we don't want to create/remove
1669      * devices as they appear, which might be smarter.)
1670      */
1671     ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "namespace scan\n"));
1672     AcpiWalkNamespace(ACPI_TYPE_ANY, ACPI_ROOT_OBJECT, 100,
1673 	acpi_probe_child, NULL, bus, NULL);
1674     /* This gets us all the children that we added from the ACPI namespace. */
1675     device_get_children(bus, &children, &cnt);
1676 
1677     /* Pre-allocate resources for our rman from any sysresource devices. */
1678     acpi_sysres_alloc(bus);
1679     /* Create any static children by calling device identify methods. */
1680     ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "device identify routines\n"));
1681     bus_generic_probe(bus);
1682 
1683     /* Probe/attach all children, created staticly and from the namespace. */
1684     ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "first bus_generic_attach\n"));
1685     bus_generic_attach_gpri(bus, KOBJ_GPRI_ACPI+2);
1686     ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "second bus_generic_attach\n"));
1687     bus_generic_attach_gpri(bus, KOBJ_GPRI_ACPI+1);
1688     /* Re-check device presence for previously disabled devices. */
1689     acpi_reprobe_children(bus, children, cnt);
1690     kfree(children, M_TEMP);
1691     ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "third bus_generic_attach\n"));
1692     bus_generic_attach_gpri(bus, KOBJ_GPRI_ACPI);
1693     ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "fourth bus_generic_attach\n"));
1694     bus_generic_attach_gpri(bus, KOBJ_GPRI_ACPI);
1695 
1696     /*
1697      * Some of these children may have attached others as part of their attach
1698      * process (eg. the root PCI bus driver), so rescan.
1699      */
1700     ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "fifth bus_generic_attach\n"));
1701     bus_generic_attach(bus);
1702 
1703     ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "sixth bus_generic_attach\n"));
1704     bus_generic_attach(bus);
1705 
1706     /* Attach wake sysctls. */
1707     acpi_wake_sysctl_walk(bus);
1708 
1709     ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "done attaching children\n"));
1710     return_VOID;
1711 }
1712 
1713 /*
1714  * Determine the probe order for a given device.
1715  */
1716 static void
1717 acpi_probe_order(ACPI_HANDLE handle, int *order)
1718 {
1719     ACPI_OBJECT_TYPE type;
1720 
1721     /*
1722      * 1. I/O port and memory system resource holders
1723      * 2. Embedded controllers (to handle early accesses)
1724      * 3. PCI Link Devices
1725      * 100000. CPUs
1726      */
1727     AcpiGetType(handle, &type);
1728     if (acpi_MatchHid(handle, "PNP0C01") || acpi_MatchHid(handle, "PNP0C02"))
1729 	*order = 1;
1730     else if (acpi_MatchHid(handle, "PNP0C09"))
1731 	*order = 2;
1732     else if (acpi_MatchHid(handle, "PNP0C0F"))
1733 	*order = 3;
1734     else if (type == ACPI_TYPE_PROCESSOR)
1735 	*order = 100000;
1736 }
1737 
1738 /*
1739  * Flag a device as disabled, because it isn't present according to the
1740  * _STA method. We set the recheck instance-variable, to make sure that we
1741  * recheck the device presence at a later point.
1742  */
1743 static void
1744 acpi_disable_not_present(device_t child)
1745 {
1746 	device_disable(child);
1747 	acpi_set_recheck(child, 1);
1748 }
1749 
1750 /*
1751  * This rechecks the device presence for all the devices which were disabled
1752  * using acpi_disable_not_present().
1753  */
1754 static void
1755 acpi_reprobe_children(device_t bus, device_t *children, int cnt)
1756 {
1757 	int i;
1758 
1759 	for (i = 0; i < cnt; i++) {
1760 		device_t dev = children[i];
1761 
1762 		if (device_is_enabled(dev))
1763 			continue;
1764 
1765 		if (acpi_get_recheck(dev)) {
1766 			if (acpi_DeviceIsPresent(dev)) {
1767 				acpi_set_recheck(dev, 0);
1768 				device_enable(dev);
1769 				/*
1770 				 * Currently we parse the resources for every
1771 				 * device at the first time, when we see
1772 				 * that it is present.
1773 				 */
1774 				acpi_parse_resources(dev, acpi_get_handle(dev),
1775 				    &acpi_res_parse_set, NULL);
1776 			}
1777 		}
1778 	}
1779 }
1780 
1781 /*
1782  * Evaluate a child device and determine whether we might attach a device to
1783  * it.
1784  */
1785 static ACPI_STATUS
1786 acpi_probe_child(ACPI_HANDLE handle, UINT32 level, void *context, void **status)
1787 {
1788     struct acpi_prw_data prw;
1789     ACPI_OBJECT_TYPE type;
1790     ACPI_HANDLE h;
1791     device_t bus, child;
1792     int order;
1793     char *handle_str;
1794 
1795     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1796 
1797     if (acpi_disabled("children"))
1798 	return_ACPI_STATUS (AE_OK);
1799 
1800     /* Skip this device if we think we'll have trouble with it. */
1801     if (acpi_avoid(handle))
1802 	return_ACPI_STATUS (AE_OK);
1803 
1804     bus = (device_t)context;
1805     if (ACPI_SUCCESS(AcpiGetType(handle, &type))) {
1806 	handle_str = acpi_name(handle);
1807 	switch (type) {
1808 	case ACPI_TYPE_DEVICE:
1809 	    /*
1810 	     * Since we scan from \, be sure to skip system scope objects.
1811 	     * \_SB_ and \_TZ_ are defined in ACPICA as devices to work around
1812 	     * BIOS bugs.  For example, \_SB_ is to allow \_SB_._INI to be run
1813 	     * during the intialization and \_TZ_ is to support Notify() on it.
1814 	     */
1815 	    if (strcmp(handle_str, "\\_SB_") == 0 ||
1816 		strcmp(handle_str, "\\_TZ_") == 0)
1817 		break;
1818 
1819 	    if (acpi_parse_prw(handle, &prw) == 0)
1820 		AcpiSetupGpeForWake(handle, prw.gpe_handle, prw.gpe_bit);
1821 
1822 	    /* FALLTHROUGH */
1823 	case ACPI_TYPE_PROCESSOR:
1824 	case ACPI_TYPE_THERMAL:
1825 	case ACPI_TYPE_POWER:
1826 	    /*
1827 	     * Create a placeholder device for this node.  Sort the
1828 	     * placeholder so that the probe/attach passes will run
1829 	     * breadth-first.  Orders less than ACPI_DEV_BASE_ORDER
1830 	     * are reserved for special objects (i.e., system
1831 	     * resources).  CPU devices have a very high order to
1832 	     * ensure they are probed after other devices.
1833 	     */
1834 	    ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "scanning '%s'\n", handle_str));
1835 	    order = level * 10 + 100;
1836 	    acpi_probe_order(handle, &order);
1837 	    child = BUS_ADD_CHILD(bus, bus, order, NULL, -1);
1838 	    if (child == NULL)
1839 		break;
1840 
1841 	    /* Associate the handle with the device_t and vice versa. */
1842 	    acpi_set_handle(child, handle);
1843 	    AcpiAttachData(handle, acpi_fake_objhandler, child);
1844 
1845 	    /*
1846 	     * Check that the device is present.  If it's not present,
1847 	     * leave it disabled (so that we have a device_t attached to
1848 	     * the handle, but we don't probe it).
1849 	     *
1850 	     * XXX PCI link devices sometimes report "present" but not
1851 	     * "functional" (i.e. if disabled).  Go ahead and probe them
1852 	     * anyway since we may enable them later.
1853 	     */
1854 	    if (type == ACPI_TYPE_DEVICE && !acpi_DeviceIsPresent(child)) {
1855 		/* Never disable PCI link devices. */
1856 		if (acpi_MatchHid(handle, "PNP0C0F"))
1857 		    break;
1858 		/*
1859 		 * Docking stations should remain enabled since the system
1860 		 * may be undocked at boot.
1861 		 */
1862 		if (ACPI_SUCCESS(AcpiGetHandle(handle, "_DCK", &h)))
1863 		    break;
1864 
1865 		acpi_disable_not_present(child);
1866 		break;
1867 	    }
1868 
1869 	    /*
1870 	     * Get the device's resource settings and attach them.
1871 	     * Note that if the device has _PRS but no _CRS, we need
1872 	     * to decide when it's appropriate to try to configure the
1873 	     * device.  Ignore the return value here; it's OK for the
1874 	     * device not to have any resources.
1875 	     */
1876 	    acpi_parse_resources(child, handle, &acpi_res_parse_set, NULL);
1877 	    break;
1878 	}
1879     }
1880 
1881     return_ACPI_STATUS (AE_OK);
1882 }
1883 
1884 /*
1885  * AcpiAttachData() requires an object handler but never uses it.  This is a
1886  * placeholder object handler so we can store a device_t in an ACPI_HANDLE.
1887  */
1888 void
1889 acpi_fake_objhandler(ACPI_HANDLE h, void *data)
1890 {
1891 }
1892 
1893 static void
1894 acpi_shutdown_final(void *arg, int howto)
1895 {
1896     struct acpi_softc *sc;
1897     ACPI_STATUS status;
1898 
1899     /*
1900      * XXX Shutdown code should only run on the BSP (cpuid 0).
1901      * Some chipsets do not power off the system correctly if called from
1902      * an AP.
1903      */
1904     sc = arg;
1905     if ((howto & RB_POWEROFF) != 0) {
1906 	status = AcpiEnterSleepStatePrep(ACPI_STATE_S5);
1907 	if (ACPI_FAILURE(status)) {
1908 	    device_printf(sc->acpi_dev, "AcpiEnterSleepStatePrep failed - %s\n",
1909 		   AcpiFormatException(status));
1910 	    return;
1911 	}
1912 	device_printf(sc->acpi_dev, "Powering system off\n");
1913 	ACPI_DISABLE_IRQS();
1914 	status = AcpiEnterSleepState(ACPI_STATE_S5);
1915 	if (ACPI_FAILURE(status)) {
1916 	    device_printf(sc->acpi_dev, "power-off failed - %s\n",
1917 		AcpiFormatException(status));
1918 	} else {
1919 	    DELAY(1000000);
1920 	    device_printf(sc->acpi_dev, "power-off failed - timeout\n");
1921 	}
1922     } else if ((howto & RB_HALT) == 0 && sc->acpi_handle_reboot) {
1923 	/* Reboot using the reset register. */
1924 	status = AcpiReset();
1925 	if (ACPI_FAILURE(status)) {
1926 	    if (status != AE_NOT_EXIST)
1927 		    device_printf(sc->acpi_dev, "reset failed - %s\n",
1928 			AcpiFormatException(status));
1929 	} else {
1930 	    DELAY(1000000);
1931 	    device_printf(sc->acpi_dev, "reset failed - timeout\n");
1932 	}
1933     } else if (sc->acpi_do_disable && panicstr == NULL) {
1934 	/*
1935 	 * Only disable ACPI if the user requested.  On some systems, writing
1936 	 * the disable value to SMI_CMD hangs the system.
1937 	 */
1938 	device_printf(sc->acpi_dev, "Shutting down\n");
1939 	AcpiTerminate();
1940     }
1941 }
1942 
1943 static void
1944 acpi_enable_fixed_events(struct acpi_softc *sc)
1945 {
1946     static int	first_time = 1;
1947 
1948     /* Enable and clear fixed events and install handlers. */
1949     if ((AcpiGbl_FADT.Flags & ACPI_FADT_POWER_BUTTON) == 0) {
1950 	AcpiClearEvent(ACPI_EVENT_POWER_BUTTON);
1951 	AcpiInstallFixedEventHandler(ACPI_EVENT_POWER_BUTTON,
1952 				     acpi_event_power_button_sleep, sc);
1953 	if (first_time)
1954 	    device_printf(sc->acpi_dev, "Power Button (fixed)\n");
1955     }
1956     if ((AcpiGbl_FADT.Flags & ACPI_FADT_SLEEP_BUTTON) == 0) {
1957 	AcpiClearEvent(ACPI_EVENT_SLEEP_BUTTON);
1958 	AcpiInstallFixedEventHandler(ACPI_EVENT_SLEEP_BUTTON,
1959 				     acpi_event_sleep_button_sleep, sc);
1960 	if (first_time)
1961 	    device_printf(sc->acpi_dev, "Sleep Button (fixed)\n");
1962     }
1963 
1964     first_time = 0;
1965 }
1966 
1967 /*
1968  * Returns true if the device is actually present and should
1969  * be attached to.  This requires the present, enabled, UI-visible
1970  * and diagnostics-passed bits to be set.
1971  */
1972 BOOLEAN
1973 acpi_DeviceIsPresent(device_t dev)
1974 {
1975     ACPI_HANDLE		h;
1976     UINT32		s;
1977     ACPI_STATUS		status;
1978 
1979     h = acpi_get_handle(dev);
1980     if (h == NULL)
1981 	return (FALSE);
1982     status = acpi_GetInteger(h, "_STA", &s);
1983 
1984     /*
1985      * If no _STA method or if it failed, then assume that
1986      * the device is present.
1987      */
1988     if (ACPI_FAILURE(status))
1989 	return (TRUE);
1990 
1991     return (ACPI_DEVICE_PRESENT(s) ? TRUE : FALSE);
1992 }
1993 
1994 /*
1995  * Returns true if the battery is actually present and inserted.
1996  */
1997 BOOLEAN
1998 acpi_BatteryIsPresent(device_t dev)
1999 {
2000     ACPI_HANDLE		h;
2001     UINT32		s;
2002     ACPI_STATUS		status;
2003 
2004     h = acpi_get_handle(dev);
2005     if (h == NULL)
2006 	return (FALSE);
2007     status = acpi_GetInteger(h, "_STA", &s);
2008 
2009     /*
2010      * If no _STA method or if it failed, then assume that
2011      * the device is present.
2012      */
2013     if (ACPI_FAILURE(status))
2014 	return (TRUE);
2015 
2016     return (ACPI_BATTERY_PRESENT(s) ? TRUE : FALSE);
2017 }
2018 
2019 /*
2020  * Match a HID string against a handle
2021  */
2022 BOOLEAN
2023 acpi_MatchHid(ACPI_HANDLE h, const char *hid)
2024 {
2025     ACPI_DEVICE_INFO	*devinfo;
2026     int			ret, i;
2027 
2028     ret = FALSE;
2029     if (hid == NULL || h == NULL ||
2030 	ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo)))
2031 	return (ret);
2032 
2033     if ((devinfo->Valid & ACPI_VALID_HID) != 0 &&
2034 	strcmp(hid, devinfo->HardwareId.String) == 0)
2035 	    ret = TRUE;
2036     else if ((devinfo->Valid & ACPI_VALID_CID) != 0) {
2037 	for (i = 0; i < devinfo->CompatibleIdList.Count; i++) {
2038 	    if (strcmp(hid, devinfo->CompatibleIdList.Ids[i].String) == 0) {
2039 		ret = TRUE;
2040 		break;
2041 	    }
2042 	}
2043     }
2044 
2045     AcpiOsFree(devinfo);
2046     return (ret);
2047 }
2048 
2049 /*
2050  * Match a UID string against a handle
2051  */
2052 BOOLEAN
2053 acpi_MatchUid(ACPI_HANDLE h, const char *uid)
2054 {
2055     ACPI_DEVICE_INFO	*devinfo;
2056     int			ret;
2057 
2058     ret = FALSE;
2059     if (uid == NULL || h == NULL ||
2060 	ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo)))
2061 	return (ret);
2062 
2063     if ((devinfo->Valid & ACPI_VALID_UID) != 0 &&
2064 	strcmp(uid, devinfo->UniqueId.String) == 0)
2065 	ret = TRUE;
2066 
2067     AcpiOsFree(devinfo);
2068     return (ret);
2069 }
2070 
2071 /*
2072  * Return the handle of a named object within our scope, ie. that of (parent)
2073  * or one if its parents.
2074  */
2075 ACPI_STATUS
2076 acpi_GetHandleInScope(ACPI_HANDLE parent, char *path, ACPI_HANDLE *result)
2077 {
2078     ACPI_HANDLE		r;
2079     ACPI_STATUS		status;
2080 
2081     /* Walk back up the tree to the root */
2082     for (;;) {
2083 	status = AcpiGetHandle(parent, path, &r);
2084 	if (ACPI_SUCCESS(status)) {
2085 	    *result = r;
2086 	    return (AE_OK);
2087 	}
2088 	/* XXX Return error here? */
2089 	if (status != AE_NOT_FOUND)
2090 	    return (AE_OK);
2091 	if (ACPI_FAILURE(AcpiGetParent(parent, &r)))
2092 	    return (AE_NOT_FOUND);
2093 	parent = r;
2094     }
2095 }
2096 
2097 /*
2098  * Allocate a buffer with a preset data size.
2099  */
2100 ACPI_BUFFER *
2101 acpi_AllocBuffer(int size)
2102 {
2103     ACPI_BUFFER	*buf;
2104 
2105     if ((buf = kmalloc(size + sizeof(*buf), M_ACPIDEV, M_NOWAIT)) == NULL)
2106 	return (NULL);
2107     buf->Length = size;
2108     buf->Pointer = (void *)(buf + 1);
2109     return (buf);
2110 }
2111 
2112 ACPI_STATUS
2113 acpi_SetInteger(ACPI_HANDLE handle, char *path, UINT32 number)
2114 {
2115     ACPI_OBJECT arg1;
2116     ACPI_OBJECT_LIST args;
2117 
2118     arg1.Type = ACPI_TYPE_INTEGER;
2119     arg1.Integer.Value = number;
2120     args.Count = 1;
2121     args.Pointer = &arg1;
2122 
2123     return (AcpiEvaluateObject(handle, path, &args, NULL));
2124 }
2125 
2126 /*
2127  * Evaluate a path that should return an integer.
2128  */
2129 ACPI_STATUS
2130 acpi_GetInteger(ACPI_HANDLE handle, char *path, UINT32 *number)
2131 {
2132     ACPI_STATUS	status;
2133     ACPI_BUFFER	buf;
2134     ACPI_OBJECT	param;
2135 
2136     if (handle == NULL)
2137 	handle = ACPI_ROOT_OBJECT;
2138 
2139     /*
2140      * Assume that what we've been pointed at is an Integer object, or
2141      * a method that will return an Integer.
2142      */
2143     buf.Pointer = &param;
2144     buf.Length = sizeof(param);
2145     status = AcpiEvaluateObject(handle, path, NULL, &buf);
2146     if (ACPI_SUCCESS(status)) {
2147 	if (param.Type == ACPI_TYPE_INTEGER)
2148 	    *number = param.Integer.Value;
2149 	else
2150 	    status = AE_TYPE;
2151     }
2152 
2153     /*
2154      * In some applications, a method that's expected to return an Integer
2155      * may instead return a Buffer (probably to simplify some internal
2156      * arithmetic).  We'll try to fetch whatever it is, and if it's a Buffer,
2157      * convert it into an Integer as best we can.
2158      *
2159      * This is a hack.
2160      */
2161     if (status == AE_BUFFER_OVERFLOW) {
2162 	if ((buf.Pointer = AcpiOsAllocate(buf.Length)) == NULL) {
2163 	    status = AE_NO_MEMORY;
2164 	} else {
2165 	    status = AcpiEvaluateObject(handle, path, NULL, &buf);
2166 	    if (ACPI_SUCCESS(status))
2167 		status = acpi_ConvertBufferToInteger(&buf, number);
2168 	    AcpiOsFree(buf.Pointer);
2169 	}
2170     }
2171     return (status);
2172 }
2173 
2174 ACPI_STATUS
2175 acpi_ConvertBufferToInteger(ACPI_BUFFER *bufp, UINT32 *number)
2176 {
2177     ACPI_OBJECT	*p;
2178     UINT8	*val;
2179     int		i;
2180 
2181     p = (ACPI_OBJECT *)bufp->Pointer;
2182     if (p->Type == ACPI_TYPE_INTEGER) {
2183 	*number = p->Integer.Value;
2184 	return (AE_OK);
2185     }
2186     if (p->Type != ACPI_TYPE_BUFFER)
2187 	return (AE_TYPE);
2188     if (p->Buffer.Length > sizeof(int))
2189 	return (AE_BAD_DATA);
2190 
2191     *number = 0;
2192     val = p->Buffer.Pointer;
2193     for (i = 0; i < p->Buffer.Length; i++)
2194 	*number += val[i] << (i * 8);
2195     return (AE_OK);
2196 }
2197 
2198 /*
2199  * Iterate over the elements of an a package object, calling the supplied
2200  * function for each element.
2201  *
2202  * XXX possible enhancement might be to abort traversal on error.
2203  */
2204 ACPI_STATUS
2205 acpi_ForeachPackageObject(ACPI_OBJECT *pkg,
2206 	void (*func)(ACPI_OBJECT *comp, void *arg), void *arg)
2207 {
2208     ACPI_OBJECT	*comp;
2209     int		i;
2210 
2211     if (pkg == NULL || pkg->Type != ACPI_TYPE_PACKAGE)
2212 	return (AE_BAD_PARAMETER);
2213 
2214     /* Iterate over components */
2215     i = 0;
2216     comp = pkg->Package.Elements;
2217     for (; i < pkg->Package.Count; i++, comp++)
2218 	func(comp, arg);
2219 
2220     return (AE_OK);
2221 }
2222 
2223 /*
2224  * Find the (index)th resource object in a set.
2225  */
2226 ACPI_STATUS
2227 acpi_FindIndexedResource(ACPI_BUFFER *buf, int index, ACPI_RESOURCE **resp)
2228 {
2229     ACPI_RESOURCE	*rp;
2230     int			i;
2231 
2232     rp = (ACPI_RESOURCE *)buf->Pointer;
2233     i = index;
2234     while (i-- > 0) {
2235 	/* Range check */
2236 	if (rp > (ACPI_RESOURCE *)((uint8_t *)buf->Pointer + buf->Length))
2237 	    return (AE_BAD_PARAMETER);
2238 
2239 	/* Check for terminator */
2240 	if (rp->Type == ACPI_RESOURCE_TYPE_END_TAG || rp->Length == 0)
2241 	    return (AE_NOT_FOUND);
2242 	rp = ACPI_NEXT_RESOURCE(rp);
2243     }
2244     if (resp != NULL)
2245 	*resp = rp;
2246 
2247     return (AE_OK);
2248 }
2249 
2250 /*
2251  * Append an ACPI_RESOURCE to an ACPI_BUFFER.
2252  *
2253  * Given a pointer to an ACPI_RESOURCE structure, expand the ACPI_BUFFER
2254  * provided to contain it.  If the ACPI_BUFFER is empty, allocate a sensible
2255  * backing block.  If the ACPI_RESOURCE is NULL, return an empty set of
2256  * resources.
2257  */
2258 #define ACPI_INITIAL_RESOURCE_BUFFER_SIZE	512
2259 
2260 ACPI_STATUS
2261 acpi_AppendBufferResource(ACPI_BUFFER *buf, ACPI_RESOURCE *res)
2262 {
2263     ACPI_RESOURCE	*rp;
2264     void		*newp;
2265 
2266     /* Initialise the buffer if necessary. */
2267     if (buf->Pointer == NULL) {
2268 	buf->Length = ACPI_INITIAL_RESOURCE_BUFFER_SIZE;
2269 	if ((buf->Pointer = AcpiOsAllocate(buf->Length)) == NULL)
2270 	    return (AE_NO_MEMORY);
2271 	rp = (ACPI_RESOURCE *)buf->Pointer;
2272 	rp->Type = ACPI_RESOURCE_TYPE_END_TAG;
2273 	rp->Length = ACPI_RS_SIZE_MIN;
2274     }
2275     if (res == NULL)
2276 	return (AE_OK);
2277 
2278     /*
2279      * Scan the current buffer looking for the terminator.
2280      * This will either find the terminator or hit the end
2281      * of the buffer and return an error.
2282      */
2283     rp = (ACPI_RESOURCE *)buf->Pointer;
2284     for (;;) {
2285 	/* Range check, don't go outside the buffer */
2286 	if (rp >= (ACPI_RESOURCE *)((uint8_t *)buf->Pointer + buf->Length))
2287 	    return (AE_BAD_PARAMETER);
2288 	if (rp->Type == ACPI_RESOURCE_TYPE_END_TAG || rp->Length == 0)
2289 	    break;
2290 	rp = ACPI_NEXT_RESOURCE(rp);
2291     }
2292 
2293     /*
2294      * Check the size of the buffer and expand if required.
2295      *
2296      * Required size is:
2297      *	size of existing resources before terminator +
2298      *	size of new resource and header +
2299      * 	size of terminator.
2300      *
2301      * Note that this loop should really only run once, unless
2302      * for some reason we are stuffing a *really* huge resource.
2303      */
2304     while ((((uint8_t *)rp - (uint8_t *)buf->Pointer) +
2305 	    res->Length + ACPI_RS_SIZE_NO_DATA +
2306 	    ACPI_RS_SIZE_MIN) >= buf->Length) {
2307 	if ((newp = AcpiOsAllocate(buf->Length * 2)) == NULL)
2308 	    return (AE_NO_MEMORY);
2309 	bcopy(buf->Pointer, newp, buf->Length);
2310 	rp = (ACPI_RESOURCE *)((uint8_t *)newp +
2311 			       ((uint8_t *)rp - (uint8_t *)buf->Pointer));
2312 	AcpiOsFree(buf->Pointer);
2313 	buf->Pointer = newp;
2314 	buf->Length += buf->Length;
2315     }
2316 
2317     /* Insert the new resource. */
2318     bcopy(res, rp, res->Length + ACPI_RS_SIZE_NO_DATA);
2319 
2320     /* And add the terminator. */
2321     rp = ACPI_NEXT_RESOURCE(rp);
2322     rp->Type = ACPI_RESOURCE_TYPE_END_TAG;
2323     rp->Length = ACPI_RS_SIZE_MIN;
2324 
2325     return (AE_OK);
2326 }
2327 
2328 /*
2329  * Set interrupt model.
2330  */
2331 ACPI_STATUS
2332 acpi_SetIntrModel(int model)
2333 {
2334 
2335     return (acpi_SetInteger(ACPI_ROOT_OBJECT, "_PIC", model));
2336 }
2337 
2338 /*
2339  * DEPRECATED.  This interface has serious deficiencies and will be
2340  * removed.
2341  *
2342  * Immediately enter the sleep state.  In the old model, acpiconf(8) ran
2343  * rc.suspend and rc.resume so we don't have to notify devd(8) to do this.
2344  */
2345 ACPI_STATUS
2346 acpi_SetSleepState(struct acpi_softc *sc, int state)
2347 {
2348     static int once;
2349 
2350     if (!once) {
2351 	device_printf(sc->acpi_dev,
2352 "warning: acpi_SetSleepState() deprecated, need to update your software\n");
2353 	once = 1;
2354     }
2355     return (acpi_EnterSleepState(sc, state));
2356 }
2357 
2358 static void
2359 acpi_sleep_force(void *arg)
2360 {
2361     struct acpi_softc *sc;
2362 
2363     sc = arg;
2364     device_printf(sc->acpi_dev,
2365 	"suspend request timed out, forcing sleep now\n");
2366     if (ACPI_FAILURE(acpi_EnterSleepState(sc, sc->acpi_next_sstate)))
2367 	device_printf(sc->acpi_dev, "force sleep state S%d failed\n",
2368 	    sc->acpi_next_sstate);
2369 }
2370 
2371 /*
2372  * Request that the system enter the given suspend state.  All /dev/apm
2373  * devices and devd(8) will be notified.  Userland then has a chance to
2374  * save state and acknowledge the request.  The system sleeps once all
2375  * acks are in.
2376  */
2377 int
2378 acpi_ReqSleepState(struct acpi_softc *sc, int state)
2379 {
2380 #ifdef notyet
2381     struct apm_clone_data *clone;
2382 #endif
2383 
2384     if (state < ACPI_STATE_S1 || state > ACPI_STATE_S5)
2385 	return (EINVAL);
2386 
2387     /* S5 (soft-off) should be entered directly with no waiting. */
2388     if (state == ACPI_STATE_S5) {
2389 	if (ACPI_SUCCESS(acpi_EnterSleepState(sc, state)))
2390 	    return (0);
2391 	else
2392 	    return (ENXIO);
2393     }
2394 
2395     /* This platform does not support acpi suspend/resume. */
2396     return (EOPNOTSUPP);
2397 
2398     /* If a suspend request is already in progress, just return. */
2399     ACPI_LOCK(acpi);
2400     if (sc->acpi_next_sstate != 0) {
2401 	ACPI_UNLOCK(acpi);
2402 	return (0);
2403     }
2404 
2405     /* Record the pending state and notify all apm devices. */
2406     sc->acpi_next_sstate = state;
2407 #if 0
2408     STAILQ_FOREACH(clone, &sc->apm_cdevs, entries) {
2409 	clone->notify_status = APM_EV_NONE;
2410 	if ((clone->flags & ACPI_EVF_DEVD) == 0) {
2411 	    KNOTE(&clone->sel_read.si_note, 0);
2412 	}
2413     }
2414 #endif
2415 
2416     /* If devd(8) is not running, immediately enter the sleep state. */
2417     if (devctl_process_running() == FALSE) {
2418 	ACPI_UNLOCK(acpi);
2419 	if (ACPI_SUCCESS(acpi_EnterSleepState(sc, sc->acpi_next_sstate))) {
2420 	    return (0);
2421 	} else {
2422 	    return (ENXIO);
2423 	}
2424     }
2425 
2426     /* Now notify devd(8) also. */
2427     acpi_UserNotify("Suspend", ACPI_ROOT_OBJECT, state);
2428 
2429     /*
2430      * Set a timeout to fire if userland doesn't ack the suspend request
2431      * in time.  This way we still eventually go to sleep if we were
2432      * overheating or running low on battery, even if userland is hung.
2433      * We cancel this timeout once all userland acks are in or the
2434      * suspend request is aborted.
2435      */
2436     callout_reset(&sc->susp_force_to, 10 * hz, acpi_sleep_force, sc);
2437     ACPI_UNLOCK(acpi);
2438 
2439     return (0);
2440 }
2441 
2442 /*
2443  * Acknowledge (or reject) a pending sleep state.  The caller has
2444  * prepared for suspend and is now ready for it to proceed.  If the
2445  * error argument is non-zero, it indicates suspend should be cancelled
2446  * and gives an errno value describing why.  Once all votes are in,
2447  * we suspend the system.
2448  */
2449 int
2450 acpi_AckSleepState(struct apm_clone_data *clone, int error)
2451 {
2452     struct acpi_softc *sc;
2453     int ret, sleeping;
2454 
2455     /* This platform does not support acpi suspend/resume. */
2456     return (EOPNOTSUPP);
2457 
2458     /* If no pending sleep state, return an error. */
2459     ACPI_LOCK(acpi);
2460     sc = clone->acpi_sc;
2461     if (sc->acpi_next_sstate == 0) {
2462 	ACPI_UNLOCK(acpi);
2463 	return (ENXIO);
2464     }
2465 
2466     /* Caller wants to abort suspend process. */
2467     if (error) {
2468 	sc->acpi_next_sstate = 0;
2469 	callout_stop(&sc->susp_force_to);
2470 	device_printf(sc->acpi_dev,
2471 	    "listener on %s cancelled the pending suspend\n",
2472 	    devtoname(clone->cdev));
2473 	ACPI_UNLOCK(acpi);
2474 	return (0);
2475     }
2476 
2477     /*
2478      * Mark this device as acking the suspend request.  Then, walk through
2479      * all devices, seeing if they agree yet.  We only count devices that
2480      * are writable since read-only devices couldn't ack the request.
2481      */
2482     clone->notify_status = APM_EV_ACKED;
2483     sleeping = TRUE;
2484     STAILQ_FOREACH(clone, &sc->apm_cdevs, entries) {
2485 	if ((clone->flags & ACPI_EVF_WRITE) != 0 &&
2486 	    clone->notify_status != APM_EV_ACKED) {
2487 	    sleeping = FALSE;
2488 	    break;
2489 	}
2490     }
2491 
2492     /* If all devices have voted "yes", we will suspend now. */
2493     if (sleeping)
2494 	callout_stop(&sc->susp_force_to);
2495     ACPI_UNLOCK(acpi);
2496     ret = 0;
2497     if (sleeping) {
2498 	if (ACPI_FAILURE(acpi_EnterSleepState(sc, sc->acpi_next_sstate)))
2499 		ret = ENODEV;
2500     }
2501 
2502     return (ret);
2503 }
2504 
2505 static void
2506 acpi_sleep_enable(void *arg)
2507 {
2508     ((struct acpi_softc *)arg)->acpi_sleep_disabled = 0;
2509 }
2510 
2511 enum acpi_sleep_state {
2512     ACPI_SS_NONE,
2513     ACPI_SS_GPE_SET,
2514     ACPI_SS_DEV_SUSPEND,
2515     ACPI_SS_SLP_PREP,
2516     ACPI_SS_SLEPT,
2517 };
2518 
2519 /*
2520  * Enter the desired system sleep state.
2521  *
2522  * Currently we support S1-S5 but S4 is only S4BIOS
2523  */
2524 static ACPI_STATUS
2525 acpi_EnterSleepState(struct acpi_softc *sc, int state)
2526 {
2527     ACPI_STATUS	status;
2528     UINT8	TypeA;
2529     UINT8	TypeB;
2530     enum acpi_sleep_state slp_state;
2531 
2532     ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, state);
2533 
2534     /* Re-entry once we're suspending is not allowed. */
2535     status = AE_OK;
2536     ACPI_LOCK(acpi);
2537     if (sc->acpi_sleep_disabled) {
2538 	ACPI_UNLOCK(acpi);
2539 	device_printf(sc->acpi_dev,
2540 	    "suspend request ignored (not ready yet)\n");
2541 	return (AE_ERROR);
2542     }
2543     sc->acpi_sleep_disabled = 1;
2544     ACPI_UNLOCK(acpi);
2545 
2546     /*
2547      * Be sure to hold Giant across DEVICE_SUSPEND/RESUME since non-MPSAFE
2548      * drivers need this.
2549      */
2550     //get_mplock();
2551 
2552     slp_state = ACPI_SS_NONE;
2553     switch (state) {
2554     case ACPI_STATE_S1:
2555     case ACPI_STATE_S2:
2556     case ACPI_STATE_S3:
2557     case ACPI_STATE_S4:
2558 	status = AcpiGetSleepTypeData(state, &TypeA, &TypeB);
2559 	if (status == AE_NOT_FOUND) {
2560 	    device_printf(sc->acpi_dev,
2561 			  "Sleep state S%d not supported by BIOS\n", state);
2562 	    break;
2563 	} else if (ACPI_FAILURE(status)) {
2564 	    device_printf(sc->acpi_dev, "AcpiGetSleepTypeData failed - %s\n",
2565 			  AcpiFormatException(status));
2566 	    break;
2567 	}
2568 
2569 	sc->acpi_sstate = state;
2570 
2571 	/* Enable any GPEs as appropriate and requested by the user. */
2572 	acpi_wake_prep_walk(state);
2573 	slp_state = ACPI_SS_GPE_SET;
2574 
2575 	/*
2576 	 * Inform all devices that we are going to sleep.  If at least one
2577 	 * device fails, DEVICE_SUSPEND() automatically resumes the tree.
2578 	 *
2579 	 * XXX Note that a better two-pass approach with a 'veto' pass
2580 	 * followed by a "real thing" pass would be better, but the current
2581 	 * bus interface does not provide for this.
2582 	 */
2583 	if (DEVICE_SUSPEND(root_bus) != 0) {
2584 	    device_printf(sc->acpi_dev, "device_suspend failed\n");
2585 	    break;
2586 	}
2587 	slp_state = ACPI_SS_DEV_SUSPEND;
2588 
2589 	/* If testing device suspend only, back out of everything here. */
2590 	if (acpi_susp_bounce)
2591 	    break;
2592 
2593 	status = AcpiEnterSleepStatePrep(state);
2594 	if (ACPI_FAILURE(status)) {
2595 	    device_printf(sc->acpi_dev, "AcpiEnterSleepStatePrep failed - %s\n",
2596 			  AcpiFormatException(status));
2597 	    break;
2598 	}
2599 	slp_state = ACPI_SS_SLP_PREP;
2600 
2601 	if (sc->acpi_sleep_delay > 0)
2602 	    DELAY(sc->acpi_sleep_delay * 1000000);
2603 
2604 	if (state != ACPI_STATE_S1) {
2605 	    acpi_sleep_machdep(sc, state);
2606 
2607 	    /* Re-enable ACPI hardware on wakeup from sleep state 4. */
2608 	    if (state == ACPI_STATE_S4)
2609 		AcpiEnable();
2610 	} else {
2611 	    ACPI_DISABLE_IRQS();
2612 	    status = AcpiEnterSleepState(state);
2613 	    if (ACPI_FAILURE(status)) {
2614 		device_printf(sc->acpi_dev, "AcpiEnterSleepState failed - %s\n",
2615 			      AcpiFormatException(status));
2616 		break;
2617 	    }
2618 	}
2619 	slp_state = ACPI_SS_SLEPT;
2620 	break;
2621     case ACPI_STATE_S5:
2622 	/*
2623 	 * Shut down cleanly and power off.  This will call us back through the
2624 	 * shutdown handlers.
2625 	 */
2626 	shutdown_nice(RB_POWEROFF);
2627 	break;
2628     case ACPI_STATE_S0:
2629     default:
2630 	status = AE_BAD_PARAMETER;
2631 	break;
2632     }
2633 
2634     /*
2635      * Back out state according to how far along we got in the suspend
2636      * process.  This handles both the error and success cases.
2637      */
2638     sc->acpi_next_sstate = 0;
2639     if (slp_state >= ACPI_SS_GPE_SET) {
2640 	acpi_wake_prep_walk(state);
2641 	sc->acpi_sstate = ACPI_STATE_S0;
2642     }
2643     if (slp_state >= ACPI_SS_SLP_PREP)
2644 	AcpiLeaveSleepState(state);
2645     if (slp_state >= ACPI_SS_DEV_SUSPEND)
2646 	DEVICE_RESUME(root_bus);
2647     if (slp_state >= ACPI_SS_SLEPT)
2648 	acpi_enable_fixed_events(sc);
2649 
2650     /* Allow another sleep request after a while. */
2651     /* XXX: needs timeout */
2652     if (state != ACPI_STATE_S5)
2653 	      acpi_sleep_enable(sc);
2654 
2655     /* Run /etc/rc.resume after we are back. */
2656     acpi_UserNotify("Resume", ACPI_ROOT_OBJECT, state);
2657 
2658     //rel_mplock();
2659 
2660     return_ACPI_STATUS (status);
2661 }
2662 
2663 /* Enable or disable the device's GPE. */
2664 int
2665 acpi_wake_set_enable(device_t dev, int enable)
2666 {
2667     struct acpi_prw_data prw;
2668     ACPI_STATUS status;
2669     int flags;
2670 
2671     /* Make sure the device supports waking the system and get the GPE. */
2672     if (acpi_parse_prw(acpi_get_handle(dev), &prw) != 0)
2673 	return (ENXIO);
2674 
2675     flags = acpi_get_flags(dev);
2676     if (enable) {
2677 	status = AcpiSetGpeWakeMask(prw.gpe_handle, prw.gpe_bit,
2678                                     ACPI_GPE_ENABLE);
2679 	if (ACPI_FAILURE(status)) {
2680 	    device_printf(dev, "enable wake failed\n");
2681 	    return (ENXIO);
2682 	}
2683 	acpi_set_flags(dev, flags | ACPI_FLAG_WAKE_ENABLED);
2684     } else {
2685 	status = AcpiSetGpeWakeMask(prw.gpe_handle, prw.gpe_bit,
2686                                     ACPI_GPE_DISABLE);
2687 	if (ACPI_FAILURE(status)) {
2688 	    device_printf(dev, "disable wake failed\n");
2689 	    return (ENXIO);
2690 	}
2691 	acpi_set_flags(dev, flags & ~ACPI_FLAG_WAKE_ENABLED);
2692     }
2693 
2694     return (0);
2695 }
2696 
2697 static int
2698 acpi_wake_sleep_prep(ACPI_HANDLE handle, int sstate)
2699 {
2700     struct acpi_prw_data prw;
2701     device_t dev;
2702 
2703     /* Check that this is a wake-capable device and get its GPE. */
2704     if (acpi_parse_prw(handle, &prw) != 0)
2705 	return (ENXIO);
2706     dev = acpi_get_device(handle);
2707 
2708     /*
2709      * The destination sleep state must be less than (i.e., higher power)
2710      * or equal to the value specified by _PRW.  If this GPE cannot be
2711      * enabled for the next sleep state, then disable it.  If it can and
2712      * the user requested it be enabled, turn on any required power resources
2713      * and set _PSW.
2714      */
2715     if (sstate > prw.lowest_wake) {
2716 	AcpiSetGpeWakeMask(prw.gpe_handle, prw.gpe_bit, ACPI_GPE_DISABLE);
2717 	if (bootverbose)
2718 	    device_printf(dev, "wake_prep disabled wake for %s (S%d)\n",
2719 		acpi_name(handle), sstate);
2720     } else if (dev && (acpi_get_flags(dev) & ACPI_FLAG_WAKE_ENABLED) != 0) {
2721 	acpi_pwr_wake_enable(handle, 1);
2722 	acpi_SetInteger(handle, "_PSW", 1);
2723 	if (bootverbose)
2724 	    device_printf(dev, "wake_prep enabled for %s (S%d)\n",
2725 		acpi_name(handle), sstate);
2726     }
2727 
2728     return (0);
2729 }
2730 
2731 static int
2732 acpi_wake_run_prep(ACPI_HANDLE handle, int sstate)
2733 {
2734     struct acpi_prw_data prw;
2735     device_t dev;
2736 
2737     /*
2738      * Check that this is a wake-capable device and get its GPE.  Return
2739      * now if the user didn't enable this device for wake.
2740      */
2741     if (acpi_parse_prw(handle, &prw) != 0)
2742 	return (ENXIO);
2743     dev = acpi_get_device(handle);
2744     if (dev == NULL || (acpi_get_flags(dev) & ACPI_FLAG_WAKE_ENABLED) == 0)
2745 	return (0);
2746 
2747     /*
2748      * If this GPE couldn't be enabled for the previous sleep state, it was
2749      * disabled before going to sleep so re-enable it.  If it was enabled,
2750      * clear _PSW and turn off any power resources it used.
2751      */
2752     if (sstate > prw.lowest_wake) {
2753 	AcpiSetGpeWakeMask(prw.gpe_handle, prw.gpe_bit, ACPI_GPE_ENABLE);
2754 	if (bootverbose)
2755 	    device_printf(dev, "run_prep re-enabled %s\n", acpi_name(handle));
2756     } else {
2757 	acpi_SetInteger(handle, "_PSW", 0);
2758 	acpi_pwr_wake_enable(handle, 0);
2759 	if (bootverbose)
2760 	    device_printf(dev, "run_prep cleaned up for %s\n",
2761 		acpi_name(handle));
2762     }
2763 
2764     return (0);
2765 }
2766 
2767 static ACPI_STATUS
2768 acpi_wake_prep(ACPI_HANDLE handle, UINT32 level, void *context, void **status)
2769 {
2770     int sstate;
2771 
2772     /* If suspending, run the sleep prep function, otherwise wake. */
2773     sstate = *(int *)context;
2774     if (AcpiGbl_SystemAwakeAndRunning)
2775 	acpi_wake_sleep_prep(handle, sstate);
2776     else
2777 	acpi_wake_run_prep(handle, sstate);
2778     return (AE_OK);
2779 }
2780 
2781 /* Walk the tree rooted at acpi0 to prep devices for suspend/resume. */
2782 static int
2783 acpi_wake_prep_walk(int sstate)
2784 {
2785     ACPI_HANDLE sb_handle;
2786 
2787     if (ACPI_SUCCESS(AcpiGetHandle(ACPI_ROOT_OBJECT, "\\_SB_", &sb_handle))) {
2788 	AcpiWalkNamespace(ACPI_TYPE_DEVICE, sb_handle, 100,
2789 	    acpi_wake_prep, NULL, &sstate, NULL);
2790     }
2791     return (0);
2792 }
2793 
2794 /* Walk the tree rooted at acpi0 to attach per-device wake sysctls. */
2795 static int
2796 acpi_wake_sysctl_walk(device_t dev)
2797 {
2798 #ifdef notyet
2799     int error, i, numdevs;
2800     device_t *devlist;
2801     device_t child;
2802     ACPI_STATUS status;
2803 
2804     error = device_get_children(dev, &devlist, &numdevs);
2805     if (error != 0 || numdevs == 0) {
2806 	if (numdevs == 0)
2807 	    kfree(devlist, M_TEMP);
2808 	return (error);
2809     }
2810     for (i = 0; i < numdevs; i++) {
2811 	child = devlist[i];
2812 	acpi_wake_sysctl_walk(child);
2813 	if (!device_is_attached(child))
2814 	    continue;
2815 	status = AcpiEvaluateObject(acpi_get_handle(child), "_PRW", NULL, NULL);
2816 	if (ACPI_SUCCESS(status)) {
2817 	    SYSCTL_ADD_PROC(device_get_sysctl_ctx(child),
2818 		SYSCTL_CHILDREN(device_get_sysctl_tree(child)), OID_AUTO,
2819 		"wake", CTLTYPE_INT | CTLFLAG_RW, child, 0,
2820 		acpi_wake_set_sysctl, "I", "Device set to wake the system");
2821 	}
2822     }
2823     kfree(devlist, M_TEMP);
2824 #endif
2825 
2826     return (0);
2827 }
2828 
2829 #ifdef notyet
2830 /* Enable or disable wake from userland. */
2831 static int
2832 acpi_wake_set_sysctl(SYSCTL_HANDLER_ARGS)
2833 {
2834     int enable, error;
2835     device_t dev;
2836 
2837     dev = (device_t)arg1;
2838     enable = (acpi_get_flags(dev) & ACPI_FLAG_WAKE_ENABLED) ? 1 : 0;
2839 
2840     error = sysctl_handle_int(oidp, &enable, 0, req);
2841     if (error != 0 || req->newptr == NULL)
2842 	return (error);
2843     if (enable != 0 && enable != 1)
2844 	return (EINVAL);
2845 
2846     return (acpi_wake_set_enable(dev, enable));
2847 }
2848 #endif
2849 
2850 /* Parse a device's _PRW into a structure. */
2851 int
2852 acpi_parse_prw(ACPI_HANDLE h, struct acpi_prw_data *prw)
2853 {
2854     ACPI_STATUS			status;
2855     ACPI_BUFFER			prw_buffer;
2856     ACPI_OBJECT			*res, *res2;
2857     int				error, i, power_count;
2858 
2859     if (h == NULL || prw == NULL)
2860 	return (EINVAL);
2861 
2862     /*
2863      * The _PRW object (7.2.9) is only required for devices that have the
2864      * ability to wake the system from a sleeping state.
2865      */
2866     error = EINVAL;
2867     prw_buffer.Pointer = NULL;
2868     prw_buffer.Length = ACPI_ALLOCATE_BUFFER;
2869     status = AcpiEvaluateObject(h, "_PRW", NULL, &prw_buffer);
2870     if (ACPI_FAILURE(status))
2871 	return (ENOENT);
2872     res = (ACPI_OBJECT *)prw_buffer.Pointer;
2873     if (res == NULL)
2874 	return (ENOENT);
2875     if (!ACPI_PKG_VALID(res, 2))
2876 	goto out;
2877 
2878     /*
2879      * Element 1 of the _PRW object:
2880      * The lowest power system sleeping state that can be entered while still
2881      * providing wake functionality.  The sleeping state being entered must
2882      * be less than (i.e., higher power) or equal to this value.
2883      */
2884     if (acpi_PkgInt32(res, 1, &prw->lowest_wake) != 0)
2885 	goto out;
2886 
2887     /*
2888      * Element 0 of the _PRW object:
2889      */
2890     switch (res->Package.Elements[0].Type) {
2891     case ACPI_TYPE_INTEGER:
2892 	/*
2893 	 * If the data type of this package element is numeric, then this
2894 	 * _PRW package element is the bit index in the GPEx_EN, in the
2895 	 * GPE blocks described in the FADT, of the enable bit that is
2896 	 * enabled for the wake event.
2897 	 */
2898 	prw->gpe_handle = NULL;
2899 	prw->gpe_bit = res->Package.Elements[0].Integer.Value;
2900 	error = 0;
2901 	break;
2902     case ACPI_TYPE_PACKAGE:
2903 	/*
2904 	 * If the data type of this package element is a package, then this
2905 	 * _PRW package element is itself a package containing two
2906 	 * elements.  The first is an object reference to the GPE Block
2907 	 * device that contains the GPE that will be triggered by the wake
2908 	 * event.  The second element is numeric and it contains the bit
2909 	 * index in the GPEx_EN, in the GPE Block referenced by the
2910 	 * first element in the package, of the enable bit that is enabled for
2911 	 * the wake event.
2912 	 *
2913 	 * For example, if this field is a package then it is of the form:
2914 	 * Package() {\_SB.PCI0.ISA.GPE, 2}
2915 	 */
2916 	res2 = &res->Package.Elements[0];
2917 	if (!ACPI_PKG_VALID(res2, 2))
2918 	    goto out;
2919 	prw->gpe_handle = acpi_GetReference(NULL, &res2->Package.Elements[0]);
2920 	if (prw->gpe_handle == NULL)
2921 	    goto out;
2922 	if (acpi_PkgInt32(res2, 1, &prw->gpe_bit) != 0)
2923 	    goto out;
2924 	error = 0;
2925 	break;
2926     default:
2927 	goto out;
2928     }
2929 
2930     /* Elements 2 to N of the _PRW object are power resources. */
2931     power_count = res->Package.Count - 2;
2932     if (power_count > ACPI_PRW_MAX_POWERRES) {
2933 	kprintf("ACPI device %s has too many power resources\n", acpi_name(h));
2934 	power_count = 0;
2935     }
2936     prw->power_res_count = power_count;
2937     for (i = 0; i < power_count; i++)
2938 	prw->power_res[i] = res->Package.Elements[i];
2939 
2940 out:
2941     if (prw_buffer.Pointer != NULL)
2942 	AcpiOsFree(prw_buffer.Pointer);
2943     return (error);
2944 }
2945 
2946 /*
2947  * ACPI Event Handlers
2948  */
2949 
2950 /* System Event Handlers (registered by EVENTHANDLER_REGISTER) */
2951 
2952 static void
2953 acpi_system_eventhandler_sleep(void *arg, int state)
2954 {
2955     struct acpi_softc *sc;
2956     int ret;
2957 
2958     ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, state);
2959 
2960     sc = arg;
2961 
2962     /* Check if button action is disabled. */
2963     if (state == ACPI_S_STATES_MAX + 1)
2964 	return;
2965 
2966     /* Request that the system prepare to enter the given suspend state. */
2967     ret = acpi_ReqSleepState((struct acpi_softc *)arg, state);
2968     if (ret != 0)
2969 	device_printf(sc->acpi_dev,
2970 	    "request to enter state S%d failed (err %d)\n", state, ret);
2971 
2972     return_VOID;
2973 }
2974 
2975 static void
2976 acpi_system_eventhandler_wakeup(void *arg, int state)
2977 {
2978 
2979     ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, state);
2980 
2981     /* Currently, nothing to do for wakeup. */
2982 
2983     return_VOID;
2984 }
2985 
2986 /*
2987  * ACPICA Event Handlers (FixedEvent, also called from button notify handler)
2988  */
2989 UINT32
2990 acpi_event_power_button_sleep(void *context)
2991 {
2992     struct acpi_softc	*sc = (struct acpi_softc *)context;
2993 
2994     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
2995 
2996     EVENTHANDLER_INVOKE(acpi_sleep_event, sc->acpi_power_button_sx);
2997 
2998     return_VALUE (ACPI_INTERRUPT_HANDLED);
2999 }
3000 
3001 UINT32
3002 acpi_event_power_button_wake(void *context)
3003 {
3004     struct acpi_softc	*sc = (struct acpi_softc *)context;
3005 
3006     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
3007 
3008     EVENTHANDLER_INVOKE(acpi_wakeup_event, sc->acpi_power_button_sx);
3009 
3010     return_VALUE (ACPI_INTERRUPT_HANDLED);
3011 }
3012 
3013 UINT32
3014 acpi_event_sleep_button_sleep(void *context)
3015 {
3016     struct acpi_softc	*sc = (struct acpi_softc *)context;
3017 
3018     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
3019 
3020     EVENTHANDLER_INVOKE(acpi_sleep_event, sc->acpi_sleep_button_sx);
3021 
3022     return_VALUE (ACPI_INTERRUPT_HANDLED);
3023 }
3024 
3025 UINT32
3026 acpi_event_sleep_button_wake(void *context)
3027 {
3028     struct acpi_softc	*sc = (struct acpi_softc *)context;
3029 
3030     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
3031 
3032     EVENTHANDLER_INVOKE(acpi_wakeup_event, sc->acpi_sleep_button_sx);
3033 
3034     return_VALUE (ACPI_INTERRUPT_HANDLED);
3035 }
3036 
3037 /*
3038  * XXX This static buffer is suboptimal.  There is no locking so only
3039  * use this for single-threaded callers.
3040  */
3041 char *
3042 acpi_name(ACPI_HANDLE handle)
3043 {
3044     ACPI_BUFFER buf;
3045     static char data[256];
3046 
3047     buf.Length = sizeof(data);
3048     buf.Pointer = data;
3049 
3050     if (handle && ACPI_SUCCESS(AcpiGetName(handle, ACPI_FULL_PATHNAME, &buf)))
3051 	return (data);
3052     return ("(unknown)");
3053 }
3054 
3055 /*
3056  * Debugging/bug-avoidance.  Avoid trying to fetch info on various
3057  * parts of the namespace.
3058  */
3059 int
3060 acpi_avoid(ACPI_HANDLE handle)
3061 {
3062     char	*cp, *env, *np;
3063     int		len;
3064 
3065     np = acpi_name(handle);
3066     if (*np == '\\')
3067 	np++;
3068     if ((env = kgetenv("debug.acpi.avoid")) == NULL)
3069 	return (0);
3070 
3071     /* Scan the avoid list checking for a match */
3072     cp = env;
3073     for (;;) {
3074 	while (*cp != 0 && isspace(*cp))
3075 	    cp++;
3076 	if (*cp == 0)
3077 	    break;
3078 	len = 0;
3079 	while (cp[len] != 0 && !isspace(cp[len]))
3080 	    len++;
3081 	if (!strncmp(cp, np, len)) {
3082 	    kfreeenv(env);
3083 	    return(1);
3084 	}
3085 	cp += len;
3086     }
3087     kfreeenv(env);
3088 
3089     return (0);
3090 }
3091 
3092 /*
3093  * Debugging/bug-avoidance.  Disable ACPI subsystem components.
3094  */
3095 int
3096 acpi_disabled(char *subsys)
3097 {
3098     char	*cp, *env;
3099     int		len;
3100 
3101     if ((env = kgetenv("debug.acpi.disabled")) == NULL)
3102 	return (0);
3103     if (strcmp(env, "all") == 0) {
3104 	kfreeenv(env);
3105 	return (1);
3106     }
3107 
3108     /* Scan the disable list, checking for a match. */
3109     cp = env;
3110     for (;;) {
3111 	while (*cp != '\0' && isspace(*cp))
3112 	    cp++;
3113 	if (*cp == '\0')
3114 	    break;
3115 	len = 0;
3116 	while (cp[len] != '\0' && !isspace(cp[len]))
3117 	    len++;
3118 	if (strncmp(cp, subsys, len) == 0) {
3119 	    kfreeenv(env);
3120 	    return (1);
3121 	}
3122 	cp += len;
3123     }
3124     kfreeenv(env);
3125 
3126     return (0);
3127 }
3128 
3129 /*
3130  * Debugging/bug-avoidance.  Enable ACPI subsystem components.  Most
3131  * components are enabled by default.  The ones that are not have to be
3132  * enabled via debug.acpi.enabled.
3133  */
3134 int
3135 acpi_enabled(char *subsys)
3136 {
3137     char        *cp, *env;
3138     int         len;
3139 
3140     if ((env = kgetenv("debug.acpi.enabled")) == NULL)
3141         return (0);
3142     if (strcmp(env, "all") == 0) {
3143         kfreeenv(env);
3144         return (1);
3145     }
3146 
3147     /* Scan the enable list, checking for a match. */
3148     cp = env;
3149     for (;;) {
3150         while (*cp != '\0' && isspace(*cp))
3151             cp++;
3152         if (*cp == '\0')
3153             break;
3154         len = 0;
3155         while (cp[len] != '\0' && !isspace(cp[len]))
3156             len++;
3157         if (strncmp(cp, subsys, len) == 0) {
3158             kfreeenv(env);
3159             return (1);
3160         }
3161         cp += len;
3162     }
3163     kfreeenv(env);
3164 
3165     return (0);
3166 }
3167 
3168 /*
3169  * Control interface.
3170  *
3171  * We multiplex ioctls for all participating ACPI devices here.  Individual
3172  * drivers wanting to be accessible via /dev/acpi should use the
3173  * register/deregister interface to make their handlers visible.
3174  */
3175 struct acpi_ioctl_hook
3176 {
3177     TAILQ_ENTRY(acpi_ioctl_hook) link;
3178     u_long			 cmd;
3179     acpi_ioctl_fn		 fn;
3180     void			 *arg;
3181 };
3182 
3183 static TAILQ_HEAD(,acpi_ioctl_hook)	acpi_ioctl_hooks;
3184 static int				acpi_ioctl_hooks_initted;
3185 
3186 int
3187 acpi_register_ioctl(u_long cmd, acpi_ioctl_fn fn, void *arg)
3188 {
3189     struct acpi_ioctl_hook	*hp;
3190 
3191     if ((hp = kmalloc(sizeof(*hp), M_ACPIDEV, M_NOWAIT)) == NULL)
3192 	return (ENOMEM);
3193     hp->cmd = cmd;
3194     hp->fn = fn;
3195     hp->arg = arg;
3196 
3197     ACPI_LOCK(acpi);
3198     if (acpi_ioctl_hooks_initted == 0) {
3199 	TAILQ_INIT(&acpi_ioctl_hooks);
3200 	acpi_ioctl_hooks_initted = 1;
3201     }
3202     TAILQ_INSERT_TAIL(&acpi_ioctl_hooks, hp, link);
3203     ACPI_UNLOCK(acpi);
3204 
3205     return (0);
3206 }
3207 
3208 void
3209 acpi_deregister_ioctl(u_long cmd, acpi_ioctl_fn fn)
3210 {
3211     struct acpi_ioctl_hook	*hp;
3212 
3213     ACPI_LOCK(acpi);
3214     TAILQ_FOREACH(hp, &acpi_ioctl_hooks, link)
3215 	if (hp->cmd == cmd && hp->fn == fn)
3216 	    break;
3217 
3218     if (hp != NULL) {
3219 	TAILQ_REMOVE(&acpi_ioctl_hooks, hp, link);
3220 	kfree(hp, M_ACPIDEV);
3221     }
3222     ACPI_UNLOCK(acpi);
3223 }
3224 
3225 static int
3226 acpiopen(struct dev_open_args *ap)
3227 {
3228     return (0);
3229 }
3230 
3231 static int
3232 acpiclose(struct dev_close_args *ap)
3233 {
3234     return (0);
3235 }
3236 
3237 static void
3238 acpi_free_object_list(ACPI_OBJECT_LIST *list)
3239 {
3240     for (int i = 0; i < list->Count; i++) {
3241 	switch (list->Pointer[i].Type) {
3242 	case ACPI_TYPE_STRING:
3243 	    AcpiOsFree(list->Pointer[i].String.Pointer);
3244 	    break;
3245 	case ACPI_TYPE_BUFFER:
3246 	    AcpiOsFree(list->Pointer[i].Buffer.Pointer);
3247 	    break;
3248 	default:
3249 	    break;
3250 	}
3251     }
3252     AcpiOsFree(list);
3253 }
3254 
3255 static ACPI_OBJECT_LIST *
3256 acpi_copyin_object_list(ACPI_OBJECT_LIST *src)
3257 {
3258     ACPI_OBJECT_LIST	*dest;
3259     BOOLEAN		failed;
3260 
3261     if (src->Count > 7)
3262 	return NULL;
3263 
3264     dest = AcpiOsAllocate(sizeof(ACPI_OBJECT_LIST) + sizeof(ACPI_OBJECT) * src->Count);
3265     if (!dest)
3266 	return NULL;
3267 
3268     dest->Count = src->Count;
3269     dest->Pointer = (ACPI_OBJECT *)(dest + 1);
3270     if (copyin(src->Pointer, dest->Pointer, sizeof(ACPI_OBJECT) * dest->Count)) {
3271 	AcpiOsFree(dest);
3272 	return NULL;
3273     }
3274 
3275     failed = FALSE;
3276 
3277     for (int i = 0; i < dest->Count; i++) {
3278 	switch (dest->Pointer[i].Type) {
3279 	case ACPI_TYPE_INTEGER:
3280 	    break;
3281 	case ACPI_TYPE_STRING: {
3282 	    void *v = AcpiOsAllocate(dest->Pointer[i].String.Length);
3283 	    if (!v || copyin(dest->Pointer[i].String.Pointer, v, dest->Pointer[i].String.Length))
3284 		failed = TRUE;
3285 	    dest->Pointer[i].String.Pointer = v;
3286 	    break;
3287 	}
3288 	case ACPI_TYPE_BUFFER: {
3289 	    void *v = AcpiOsAllocate(dest->Pointer[i].Buffer.Length);
3290 	    if (!v || copyin(dest->Pointer[i].Buffer.Pointer, v, dest->Pointer[i].Buffer.Length))
3291 		failed = TRUE;
3292 	    dest->Pointer[i].String.Pointer = v;
3293 	    break;
3294 	}
3295 	default:
3296 	    failed = TRUE;
3297 	    break;
3298 	}
3299     }
3300 
3301     if (failed) {
3302 	acpi_free_object_list(dest);
3303 	dest = NULL;
3304     }
3305 
3306     return dest;
3307 }
3308 
3309 static int
3310 acpi_call_ioctl(caddr_t addr)
3311 {
3312     struct acpi_mcall_ioctl_arg *params;
3313     ACPI_OBJECT_LIST	*args;
3314     ACPI_BUFFER		result;
3315     char		path[256];
3316 
3317     result.Length = ACPI_ALLOCATE_BUFFER;
3318     result.Pointer = NULL;
3319 
3320     params = (struct acpi_mcall_ioctl_arg *)addr;
3321     args = acpi_copyin_object_list(&params->args);
3322     if (!args)
3323 	return EINVAL;
3324     if (copyinstr(params->path, path, sizeof(path), NULL))
3325 	return EINVAL;
3326     params->retval = AcpiEvaluateObject(NULL, path, args, &result);
3327     if (ACPI_SUCCESS(params->retval)) {
3328 	if (result.Pointer != NULL) {
3329 	    if (params->result.Pointer != NULL) {
3330 		params->result.Length = min(params->result.Length,
3331 		    result.Length);
3332 		if (result.Length >= sizeof(ACPI_OBJECT)) {
3333 		    acpi_call_fixup_pointers((ACPI_OBJECT *)result.Pointer,
3334 			params->result.Pointer);
3335 		}
3336 		copyout(result.Pointer, params->result.Pointer,
3337 		    params->result.Length);
3338 		params->reslen = result.Length;
3339 	    }
3340 	    AcpiOsFree(result.Pointer);
3341 	}
3342     }
3343     acpi_free_object_list(args);
3344 
3345     return (0);
3346 }
3347 
3348 void
3349 acpi_call_fixup_pointers(ACPI_OBJECT *p, UINT8 *dest)
3350 {
3351     switch (p->Type) {
3352     case ACPI_TYPE_STRING:
3353 	p->String.Pointer += dest - (UINT8 *)p;
3354 	break;
3355     case ACPI_TYPE_BUFFER:
3356 	p->Buffer.Pointer += dest - (UINT8 *)p;
3357 	break;
3358     }
3359 }
3360 
3361 static int
3362 acpiioctl(struct dev_ioctl_args *ap)
3363 {
3364     struct acpi_softc		*sc;
3365     struct acpi_ioctl_hook	*hp;
3366     int				error, state;
3367 
3368     error = 0;
3369     hp = NULL;
3370     sc = ap->a_head.a_dev->si_drv1;
3371 
3372     /*
3373      * Scan the list of registered ioctls, looking for handlers.
3374      */
3375     lwkt_gettoken(&acpi_token);
3376     ACPI_LOCK(acpi);
3377     if (acpi_ioctl_hooks_initted) {
3378 	TAILQ_FOREACH(hp, &acpi_ioctl_hooks, link) {
3379 	    if (hp->cmd == ap->a_cmd)
3380 		break;
3381 	}
3382     }
3383     ACPI_UNLOCK(acpi);
3384     if (hp) {
3385 	error = hp->fn(ap->a_cmd, ap->a_data, hp->arg);
3386 	lwkt_reltoken(&acpi_token);
3387 	return error;
3388     }
3389 
3390     /*
3391      * Core ioctls are not permitted for non-writable user.
3392      * Currently, other ioctls just fetch information.
3393      * Not changing system behavior.
3394      */
3395     if ((ap->a_fflag & FWRITE) == 0) {
3396 	lwkt_reltoken(&acpi_token);
3397 	return (EPERM);
3398     }
3399 
3400     /* Core system ioctls. */
3401     switch (ap->a_cmd) {
3402     case ACPIIO_REQSLPSTATE:
3403 	state = *(int *)ap->a_data;
3404 	if (state != ACPI_STATE_S5)
3405 	    error = acpi_ReqSleepState(sc, state);
3406 	else {
3407 	    device_printf(sc->acpi_dev,
3408 		"power off via acpi ioctl not supported\n");
3409 	    error = ENXIO;
3410 	}
3411 	break;
3412     case ACPIIO_ACKSLPSTATE:
3413 	error = EOPNOTSUPP;
3414 #if 0 /* notyet */
3415 	error = *(int *)ap->a_data;
3416 	error = acpi_AckSleepState(sc->acpi_clone, error);
3417 #endif
3418 	break;
3419     case ACPIIO_SETSLPSTATE:	/* DEPRECATED */
3420 	error = EINVAL;
3421 	state = *(int *)ap->a_data;
3422 	if (state >= ACPI_STATE_S0 && state <= ACPI_S_STATES_MAX)
3423 	    if (ACPI_SUCCESS(acpi_SetSleepState(sc, state)))
3424 		error = 0;
3425 	break;
3426     case ACPIIO_DO_MCALL:
3427 	if (acpi_allow_mcall == 1) {
3428 	    error = acpi_call_ioctl(ap->a_data);
3429 	} else {
3430 	    device_printf(sc->acpi_dev,
3431 		"debug.acpi.allow_method_calls must be set\n");
3432 	    error = ENXIO;
3433 	}
3434 	break;
3435     default:
3436 	error = ENXIO;
3437 	break;
3438     }
3439     lwkt_reltoken(&acpi_token);
3440 
3441     return (error);
3442 }
3443 
3444 static int
3445 acpi_supported_sleep_state_sysctl(SYSCTL_HANDLER_ARGS)
3446 {
3447     int error;
3448     struct sbuf sb;
3449     UINT8 state, TypeA, TypeB;
3450 
3451     sbuf_new(&sb, NULL, 32, SBUF_AUTOEXTEND);
3452     for (state = ACPI_STATE_S1; state < ACPI_S_STATES_MAX + 1; state++)
3453 	if (ACPI_SUCCESS(AcpiGetSleepTypeData(state, &TypeA, &TypeB)))
3454 	    sbuf_printf(&sb, "S%d ", state);
3455     sbuf_trim(&sb);
3456     sbuf_finish(&sb);
3457     error = sysctl_handle_string(oidp, sbuf_data(&sb), sbuf_len(&sb), req);
3458     sbuf_delete(&sb);
3459     return (error);
3460 }
3461 
3462 static int
3463 acpi_sleep_state_sysctl(SYSCTL_HANDLER_ARGS)
3464 {
3465     char sleep_state[10];
3466     int error;
3467     u_int new_state, old_state;
3468 
3469     old_state = *(u_int *)oidp->oid_arg1;
3470     if (old_state > ACPI_S_STATES_MAX + 1)
3471 	strlcpy(sleep_state, "unknown", sizeof(sleep_state));
3472     else
3473 	strlcpy(sleep_state, sleep_state_names[old_state], sizeof(sleep_state));
3474     error = sysctl_handle_string(oidp, sleep_state, sizeof(sleep_state), req);
3475     if (error == 0 && req->newptr != NULL) {
3476 	new_state = ACPI_STATE_S0;
3477 	for (; new_state <= ACPI_S_STATES_MAX + 1; new_state++)
3478 	    if (strcmp(sleep_state, sleep_state_names[new_state]) == 0)
3479 		break;
3480 	if (new_state <= ACPI_S_STATES_MAX + 1) {
3481 	    if (new_state != old_state)
3482 		*(u_int *)oidp->oid_arg1 = new_state;
3483 	} else
3484 	    error = EINVAL;
3485     }
3486 
3487     return (error);
3488 }
3489 
3490 /* Inform devctl(4) when we receive a Notify. */
3491 void
3492 acpi_UserNotify(const char *subsystem, ACPI_HANDLE h, uint8_t notify)
3493 {
3494     char		notify_buf[16];
3495     ACPI_BUFFER		handle_buf;
3496     ACPI_STATUS		status;
3497 
3498     if (subsystem == NULL)
3499 	return;
3500 
3501     handle_buf.Pointer = NULL;
3502     handle_buf.Length = ACPI_ALLOCATE_BUFFER;
3503     status = AcpiNsHandleToPathname(h, &handle_buf, FALSE);
3504     if (ACPI_FAILURE(status))
3505 	return;
3506     ksnprintf(notify_buf, sizeof(notify_buf), "notify=0x%02x", notify);
3507     devctl_notify("ACPI", subsystem, handle_buf.Pointer, notify_buf);
3508     AcpiOsFree(handle_buf.Pointer);
3509 }
3510 
3511 #ifdef ACPI_DEBUG
3512 /*
3513  * Support for parsing debug options from the kernel environment.
3514  *
3515  * Bits may be set in the AcpiDbgLayer and AcpiDbgLevel debug registers
3516  * by specifying the names of the bits in the debug.acpi.layer and
3517  * debug.acpi.level environment variables.  Bits may be unset by
3518  * prefixing the bit name with !.
3519  */
3520 struct debugtag
3521 {
3522     char	*name;
3523     UINT32	value;
3524 };
3525 
3526 static struct debugtag	dbg_layer[] = {
3527     {"ACPI_UTILITIES",		ACPI_UTILITIES},
3528     {"ACPI_HARDWARE",		ACPI_HARDWARE},
3529     {"ACPI_EVENTS",		ACPI_EVENTS},
3530     {"ACPI_TABLES",		ACPI_TABLES},
3531     {"ACPI_NAMESPACE",		ACPI_NAMESPACE},
3532     {"ACPI_PARSER",		ACPI_PARSER},
3533     {"ACPI_DISPATCHER",		ACPI_DISPATCHER},
3534     {"ACPI_EXECUTER",		ACPI_EXECUTER},
3535     {"ACPI_RESOURCES",		ACPI_RESOURCES},
3536     {"ACPI_CA_DEBUGGER",	ACPI_CA_DEBUGGER},
3537     {"ACPI_OS_SERVICES",	ACPI_OS_SERVICES},
3538     {"ACPI_CA_DISASSEMBLER",	ACPI_CA_DISASSEMBLER},
3539     {"ACPI_ALL_COMPONENTS",	ACPI_ALL_COMPONENTS},
3540 
3541     {"ACPI_AC_ADAPTER",		ACPI_AC_ADAPTER},
3542     {"ACPI_BATTERY",		ACPI_BATTERY},
3543     {"ACPI_BUS",		ACPI_BUS},
3544     {"ACPI_BUTTON",		ACPI_BUTTON},
3545     {"ACPI_EC", 		ACPI_EC},
3546     {"ACPI_FAN",		ACPI_FAN},
3547     {"ACPI_POWERRES",		ACPI_POWERRES},
3548     {"ACPI_PROCESSOR",		ACPI_PROCESSOR},
3549     {"ACPI_THERMAL",		ACPI_THERMAL},
3550     {"ACPI_TIMER",		ACPI_TIMER},
3551     {"ACPI_ALL_DRIVERS",	ACPI_ALL_DRIVERS},
3552     {NULL, 0}
3553 };
3554 
3555 static struct debugtag dbg_level[] = {
3556     {"ACPI_LV_INIT",		ACPI_LV_INIT},
3557     {"ACPI_LV_DEBUG_OBJECT",	ACPI_LV_DEBUG_OBJECT},
3558     {"ACPI_LV_INFO",		ACPI_LV_INFO},
3559     {"ACPI_LV_REPAIR",		ACPI_LV_REPAIR},
3560     {"ACPI_LV_ALL_EXCEPTIONS",	ACPI_LV_ALL_EXCEPTIONS},
3561 
3562     /* Trace verbosity level 1 [Standard Trace Level] */
3563     {"ACPI_LV_INIT_NAMES",	ACPI_LV_INIT_NAMES},
3564     {"ACPI_LV_PARSE",		ACPI_LV_PARSE},
3565     {"ACPI_LV_LOAD",		ACPI_LV_LOAD},
3566     {"ACPI_LV_DISPATCH",	ACPI_LV_DISPATCH},
3567     {"ACPI_LV_EXEC",		ACPI_LV_EXEC},
3568     {"ACPI_LV_NAMES",		ACPI_LV_NAMES},
3569     {"ACPI_LV_OPREGION",	ACPI_LV_OPREGION},
3570     {"ACPI_LV_BFIELD",		ACPI_LV_BFIELD},
3571     {"ACPI_LV_TABLES",		ACPI_LV_TABLES},
3572     {"ACPI_LV_VALUES",		ACPI_LV_VALUES},
3573     {"ACPI_LV_OBJECTS",		ACPI_LV_OBJECTS},
3574     {"ACPI_LV_RESOURCES",	ACPI_LV_RESOURCES},
3575     {"ACPI_LV_USER_REQUESTS",	ACPI_LV_USER_REQUESTS},
3576     {"ACPI_LV_PACKAGE",		ACPI_LV_PACKAGE},
3577     {"ACPI_LV_EVALUATION",	ACPI_LV_EVALUATION},
3578     {"ACPI_LV_VERBOSITY1",	ACPI_LV_VERBOSITY1},
3579 
3580     /* Trace verbosity level 2 [Function tracing and memory allocation] */
3581     {"ACPI_LV_ALLOCATIONS",	ACPI_LV_ALLOCATIONS},
3582     {"ACPI_LV_FUNCTIONS",	ACPI_LV_FUNCTIONS},
3583     {"ACPI_LV_OPTIMIZATIONS",	ACPI_LV_OPTIMIZATIONS},
3584     {"ACPI_LV_VERBOSITY2",	ACPI_LV_VERBOSITY2},
3585     {"ACPI_LV_ALL",		ACPI_LV_ALL},
3586 
3587     /* Trace verbosity level 3 [Threading, I/O, and Interrupts] */
3588     {"ACPI_LV_MUTEX",		ACPI_LV_MUTEX},
3589     {"ACPI_LV_THREADS",		ACPI_LV_THREADS},
3590     {"ACPI_LV_IO",		ACPI_LV_IO},
3591     {"ACPI_LV_INTERRUPTS",	ACPI_LV_INTERRUPTS},
3592     {"ACPI_LV_VERBOSITY3",	ACPI_LV_VERBOSITY3},
3593 
3594     /* Exceptionally verbose output -- also used in the global "DebugLevel"  */
3595     {"ACPI_LV_AML_DISASSEMBLE",	ACPI_LV_AML_DISASSEMBLE},
3596     {"ACPI_LV_VERBOSE_INFO",	ACPI_LV_VERBOSE_INFO},
3597     {"ACPI_LV_FULL_TABLES",	ACPI_LV_FULL_TABLES},
3598     {"ACPI_LV_EVENTS",		ACPI_LV_EVENTS},
3599     {"ACPI_LV_VERBOSE",		ACPI_LV_VERBOSE},
3600     {NULL, 0}
3601 };
3602 
3603 static void
3604 acpi_parse_debug(char *cp, struct debugtag *tag, UINT32 *flag)
3605 {
3606     char	*ep;
3607     int		i, l;
3608     int		set;
3609 
3610     while (*cp) {
3611 	if (isspace(*cp)) {
3612 	    cp++;
3613 	    continue;
3614 	}
3615 	ep = cp;
3616 	while (*ep && !isspace(*ep))
3617 	    ep++;
3618 	if (*cp == '!') {
3619 	    set = 0;
3620 	    cp++;
3621 	    if (cp == ep)
3622 		continue;
3623 	} else {
3624 	    set = 1;
3625 	}
3626 	l = ep - cp;
3627 	for (i = 0; tag[i].name != NULL; i++) {
3628 	    if (!strncmp(cp, tag[i].name, l)) {
3629 		if (set)
3630 		    *flag |= tag[i].value;
3631 		else
3632 		    *flag &= ~tag[i].value;
3633 	    }
3634 	}
3635 	cp = ep;
3636     }
3637 }
3638 
3639 static void
3640 acpi_set_debugging(void *junk)
3641 {
3642     char	*layer, *level;
3643 
3644     if (cold) {
3645 	AcpiDbgLayer = 0;
3646 	AcpiDbgLevel = 0;
3647     }
3648 
3649     layer = kgetenv("debug.acpi.layer");
3650     level = kgetenv("debug.acpi.level");
3651     if (layer == NULL && level == NULL)
3652 	return;
3653 
3654     kprintf("ACPI set debug");
3655     if (layer != NULL) {
3656 	if (strcmp("NONE", layer) != 0)
3657 	    kprintf(" layer '%s'", layer);
3658 	acpi_parse_debug(layer, &dbg_layer[0], &AcpiDbgLayer);
3659 	kfreeenv(layer);
3660     }
3661     if (level != NULL) {
3662 	if (strcmp("NONE", level) != 0)
3663 	    kprintf(" level '%s'", level);
3664 	acpi_parse_debug(level, &dbg_level[0], &AcpiDbgLevel);
3665 	kfreeenv(level);
3666     }
3667     kprintf("\n");
3668 }
3669 
3670 SYSINIT(acpi_debugging, SI_BOOT1_TUNABLES, SI_ORDER_ANY, acpi_set_debugging,
3671 	NULL);
3672 
3673 static int
3674 acpi_debug_sysctl(SYSCTL_HANDLER_ARGS)
3675 {
3676     int		 error, *dbg;
3677     struct	 debugtag *tag;
3678     struct	 sbuf sb;
3679 
3680     if (sbuf_new(&sb, NULL, 128, SBUF_AUTOEXTEND) == NULL)
3681 	return (ENOMEM);
3682     if (strcmp(oidp->oid_arg1, "debug.acpi.layer") == 0) {
3683 	tag = &dbg_layer[0];
3684 	dbg = &AcpiDbgLayer;
3685     } else {
3686 	tag = &dbg_level[0];
3687 	dbg = &AcpiDbgLevel;
3688     }
3689 
3690     /* Get old values if this is a get request. */
3691     ACPI_SERIAL_BEGIN(acpi);
3692     if (*dbg == 0) {
3693 	sbuf_cpy(&sb, "NONE");
3694     } else if (req->newptr == NULL) {
3695 	for (; tag->name != NULL; tag++) {
3696 	    if ((*dbg & tag->value) == tag->value)
3697 		sbuf_printf(&sb, "%s ", tag->name);
3698 	}
3699     }
3700     sbuf_trim(&sb);
3701     sbuf_finish(&sb);
3702 
3703     /* Copy out the old values to the user. */
3704     error = SYSCTL_OUT(req, sbuf_data(&sb), sbuf_len(&sb));
3705     sbuf_delete(&sb);
3706 
3707     /* If the user is setting a string, parse it. */
3708     if (error == 0 && req->newptr != NULL) {
3709 	*dbg = 0;
3710 	ksetenv((char *)oidp->oid_arg1, (char *)req->newptr);
3711 	acpi_set_debugging(NULL);
3712     }
3713     ACPI_SERIAL_END(acpi);
3714 
3715     return (error);
3716 }
3717 
3718 SYSCTL_PROC(_debug_acpi, OID_AUTO, layer, CTLFLAG_RW | CTLTYPE_STRING,
3719 	    "debug.acpi.layer", 0, acpi_debug_sysctl, "A", "");
3720 SYSCTL_PROC(_debug_acpi, OID_AUTO, level, CTLFLAG_RW | CTLTYPE_STRING,
3721 	    "debug.acpi.level", 0, acpi_debug_sysctl, "A", "");
3722 #endif /* ACPI_DEBUG */
3723 
3724 static int
3725 acpi_debug_objects_sysctl(SYSCTL_HANDLER_ARGS)
3726 {
3727 	int	error;
3728 	int	old;
3729 
3730 	old = acpi_debug_objects;
3731 	error = sysctl_handle_int(oidp, &acpi_debug_objects, 0, req);
3732 	if (error != 0 || req->newptr == NULL)
3733 		return (error);
3734 	if (old == acpi_debug_objects || (old && acpi_debug_objects))
3735 		return (0);
3736 
3737 	ACPI_SERIAL_BEGIN(acpi);
3738 	AcpiGbl_EnableAmlDebugObject = acpi_debug_objects ? TRUE : FALSE;
3739 	ACPI_SERIAL_END(acpi);
3740 
3741 	return (0);
3742 }
3743 
3744 
3745 static int
3746 acpi_parse_interfaces(char *str, struct acpi_interface *iface)
3747 {
3748 	char *p;
3749 	size_t len;
3750 	int i, j;
3751 
3752 	p = str;
3753 	while (isspace(*p) || *p == ',')
3754 		p++;
3755 	len = strlen(p);
3756 	if (len == 0)
3757 		return (0);
3758 	p = kstrdup(p, M_TEMP);
3759 	for (i = 0; i < len; i++)
3760 		if (p[i] == ',')
3761 			p[i] = '\0';
3762 	i = j = 0;
3763 	while (i < len)
3764 		if (isspace(p[i]) || p[i] == '\0')
3765 			i++;
3766 		else {
3767 			i += strlen(p + i) + 1;
3768 			j++;
3769 		}
3770 	if (j == 0) {
3771 		kfree(p, M_TEMP);
3772 		return (0);
3773 	}
3774 	iface->data = kmalloc(sizeof(*iface->data) * j, M_TEMP, M_WAITOK);
3775 	iface->num = j;
3776 	i = j = 0;
3777 	while (i < len)
3778 		if (isspace(p[i]) || p[i] == '\0')
3779 			i++;
3780 		else {
3781 			iface->data[j] = p + i;
3782 			i += strlen(p + i) + 1;
3783 			j++;
3784 		}
3785 
3786 	return (j);
3787 }
3788 
3789 static void
3790 acpi_free_interfaces(struct acpi_interface *iface)
3791 {
3792 	kfree(iface->data[0], M_TEMP);
3793 	kfree(iface->data, M_TEMP);
3794 }
3795 
3796 static void
3797 acpi_reset_interfaces(device_t dev)
3798 {
3799 	struct acpi_interface list;
3800 	ACPI_STATUS status;
3801 	int i;
3802 
3803 	if (acpi_parse_interfaces(acpi_install_interface, &list) > 0) {
3804 		for (i = 0; i < list.num; i++) {
3805 			status = AcpiInstallInterface(list.data[i]);
3806 			if (ACPI_FAILURE(status))
3807 				device_printf(dev,
3808 				    "failed to install _OSI(\"%s\"): %s\n",
3809 				    list.data[i], AcpiFormatException(status));
3810 			else if (bootverbose)
3811 				device_printf(dev, "installed _OSI(\"%s\")\n",
3812 				    list.data[i]);
3813 		}
3814 		acpi_free_interfaces(&list);
3815 	}
3816 	if (acpi_parse_interfaces(acpi_remove_interface, &list) > 0) {
3817 		for (i = 0; i < list.num; i++) {
3818 			status = AcpiRemoveInterface(list.data[i]);
3819 			if (ACPI_FAILURE(status))
3820 				device_printf(dev,
3821 				    "failed to remove _OSI(\"%s\"): %s\n",
3822 				    list.data[i], AcpiFormatException(status));
3823 			else if (bootverbose)
3824 				device_printf(dev, "removed _OSI(\"%s\")\n",
3825 				    list.data[i]);
3826 		}
3827 		acpi_free_interfaces(&list);
3828 	}
3829 }
3830 
3831 static int
3832 acpi_pm_func(u_long cmd, void *arg, ...)
3833 {
3834 	int	state, acpi_state;
3835 	int	error;
3836 	struct	acpi_softc *sc;
3837 	__va_list ap;
3838 
3839 	error = 0;
3840 	switch (cmd) {
3841 	case POWER_CMD_SUSPEND:
3842 		sc = (struct acpi_softc *)arg;
3843 		if (sc == NULL) {
3844 			error = EINVAL;
3845 			goto out;
3846 		}
3847 
3848 		__va_start(ap, arg);
3849 		state = __va_arg(ap, int);
3850 		__va_end(ap);
3851 
3852 		switch (state) {
3853 		case POWER_SLEEP_STATE_STANDBY:
3854 			acpi_state = sc->acpi_standby_sx;
3855 			break;
3856 		case POWER_SLEEP_STATE_SUSPEND:
3857 			acpi_state = sc->acpi_suspend_sx;
3858 			break;
3859 		case POWER_SLEEP_STATE_HIBERNATE:
3860 			acpi_state = ACPI_STATE_S4;
3861 			break;
3862 		default:
3863 			error = EINVAL;
3864 			goto out;
3865 		}
3866 
3867 		if (ACPI_FAILURE(acpi_EnterSleepState(sc, acpi_state)))
3868 			error = ENXIO;
3869 		break;
3870 	default:
3871 		error = EINVAL;
3872 		goto out;
3873 	}
3874 
3875 out:
3876 	return (error);
3877 }
3878 
3879 static void
3880 acpi_pm_register(void *arg)
3881 {
3882     if (!cold || resource_disabled("acpi", 0))
3883 	return;
3884 
3885     power_pm_register(POWER_PM_TYPE_ACPI, acpi_pm_func, NULL);
3886 }
3887 
3888 SYSINIT(power, SI_BOOT2_KLD, SI_ORDER_ANY, acpi_pm_register, 0);
3889