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