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