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