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