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