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