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