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