acpi.c revision 182071
1133833Sdwmalone/*-
2133833Sdwmalone * Copyright (c) 2000 Takanori Watanabe <takawata@jp.freebsd.org>
3133833Sdwmalone * Copyright (c) 2000 Mitsuru IWASAKI <iwasaki@jp.freebsd.org>
4133833Sdwmalone * Copyright (c) 2000, 2001 Michael Smith
5133833Sdwmalone * Copyright (c) 2000 BSDi
6133833Sdwmalone * All rights reserved.
7133833Sdwmalone *
8133833Sdwmalone * Redistribution and use in source and binary forms, with or without
9133833Sdwmalone * modification, are permitted provided that the following conditions
10133833Sdwmalone * are met:
11133833Sdwmalone * 1. Redistributions of source code must retain the above copyright
12133833Sdwmalone *    notice, this list of conditions and the following disclaimer.
13133833Sdwmalone * 2. Redistributions in binary form must reproduce the above copyright
14133833Sdwmalone *    notice, this list of conditions and the following disclaimer in the
15133833Sdwmalone *    documentation and/or other materials provided with the distribution.
16133833Sdwmalone *
17133833Sdwmalone * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18133833Sdwmalone * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19133833Sdwmalone * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20133833Sdwmalone * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21133833Sdwmalone * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22133833Sdwmalone * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23133833Sdwmalone * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24133833Sdwmalone * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25133833Sdwmalone * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26133833Sdwmalone * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27133833Sdwmalone * SUCH DAMAGE.
28133833Sdwmalone */
29133833Sdwmalone
30133833Sdwmalone#include <sys/cdefs.h>
31133833Sdwmalone__FBSDID("$FreeBSD: head/sys/dev/acpica/acpi.c 182071 2008-08-23 16:38:20Z imp $");
32133833Sdwmalone
33133833Sdwmalone#include "opt_acpi.h"
34133833Sdwmalone#include <sys/param.h>
35133833Sdwmalone#include <sys/kernel.h>
36133833Sdwmalone#include <sys/proc.h>
37133833Sdwmalone#include <sys/fcntl.h>
38133833Sdwmalone#include <sys/malloc.h>
39133833Sdwmalone#include <sys/module.h>
40133833Sdwmalone#include <sys/bus.h>
41133833Sdwmalone#include <sys/conf.h>
42133833Sdwmalone#include <sys/ioccom.h>
43133833Sdwmalone#include <sys/reboot.h>
44133833Sdwmalone#include <sys/sysctl.h>
45133833Sdwmalone#include <sys/ctype.h>
46133833Sdwmalone#include <sys/linker.h>
47133833Sdwmalone#include <sys/power.h>
48133833Sdwmalone#include <sys/sbuf.h>
49133833Sdwmalone#include <sys/smp.h>
50133833Sdwmalone
51133833Sdwmalone#if defined(__i386__) || defined(__amd64__)
52133833Sdwmalone#include <machine/pci_cfgreg.h>
53133833Sdwmalone#endif
54133833Sdwmalone#include <machine/resource.h>
55133833Sdwmalone#include <machine/bus.h>
56133833Sdwmalone#include <sys/rman.h>
57133833Sdwmalone#include <isa/isavar.h>
58133833Sdwmalone#include <isa/pnpvar.h>
59133833Sdwmalone
60133833Sdwmalone#include <contrib/dev/acpica/acpi.h>
61133833Sdwmalone#include <dev/acpica/acpivar.h>
62133833Sdwmalone#include <dev/acpica/acpiio.h>
63133833Sdwmalone#include <contrib/dev/acpica/achware.h>
64133833Sdwmalone#include <contrib/dev/acpica/acnamesp.h>
65133833Sdwmalone
66133833Sdwmalone#include "pci_if.h"
67133833Sdwmalone#include <dev/pci/pcivar.h>
68133833Sdwmalone#include <dev/pci/pci_private.h>
69133833Sdwmalone
70133833Sdwmalone#include <vm/vm_param.h>
71133833Sdwmalone
72133833SdwmaloneMALLOC_DEFINE(M_ACPIDEV, "acpidev", "ACPI devices");
73133833Sdwmalone
74133833Sdwmalone/* Hooks for the ACPI CA debugging infrastructure */
75133833Sdwmalone#define _COMPONENT	ACPI_BUS
76133833SdwmaloneACPI_MODULE_NAME("ACPI")
77133833Sdwmalone
78133833Sdwmalonestatic d_open_t		acpiopen;
79133833Sdwmalonestatic d_close_t	acpiclose;
80133833Sdwmalonestatic d_ioctl_t	acpiioctl;
81133833Sdwmalone
82133833Sdwmalonestatic struct cdevsw acpi_cdevsw = {
83133833Sdwmalone	.d_version =	D_VERSION,
84133833Sdwmalone	.d_open =	acpiopen,
85133833Sdwmalone	.d_close =	acpiclose,
86133833Sdwmalone	.d_ioctl =	acpiioctl,
87133833Sdwmalone	.d_name =	"acpi",
88133833Sdwmalone};
89133833Sdwmalone
90133833Sdwmalone/* Global mutex for locking access to the ACPI subsystem. */
91133833Sdwmalonestruct mtx	acpi_mutex;
92133833Sdwmalone
93133833Sdwmalone/* Bitmap of device quirks. */
94133833Sdwmaloneint		acpi_quirks;
95133833Sdwmalone
96133833Sdwmalonestatic int	acpi_modevent(struct module *mod, int event, void *junk);
97133833Sdwmalonestatic int	acpi_probe(device_t dev);
98133833Sdwmalonestatic int	acpi_attach(device_t dev);
99133833Sdwmalonestatic int	acpi_suspend(device_t dev);
100133833Sdwmalonestatic int	acpi_resume(device_t dev);
101133833Sdwmalonestatic int	acpi_shutdown(device_t dev);
102133833Sdwmalonestatic device_t	acpi_add_child(device_t bus, int order, const char *name,
103133833Sdwmalone			int unit);
104133833Sdwmalonestatic int	acpi_print_child(device_t bus, device_t child);
105133833Sdwmalonestatic void	acpi_probe_nomatch(device_t bus, device_t child);
106133833Sdwmalonestatic void	acpi_driver_added(device_t dev, driver_t *driver);
107133833Sdwmalonestatic int	acpi_read_ivar(device_t dev, device_t child, int index,
108133833Sdwmalone			uintptr_t *result);
109133833Sdwmalonestatic int	acpi_write_ivar(device_t dev, device_t child, int index,
110133833Sdwmalone			uintptr_t value);
111133833Sdwmalonestatic struct resource_list *acpi_get_rlist(device_t dev, device_t child);
112133833Sdwmalonestatic int	acpi_sysres_alloc(device_t dev);
113133833Sdwmalonestatic struct resource *acpi_alloc_resource(device_t bus, device_t child,
114133833Sdwmalone			int type, int *rid, u_long start, u_long end,
115133833Sdwmalone			u_long count, u_int flags);
116133833Sdwmalonestatic int	acpi_release_resource(device_t bus, device_t child, int type,
117133833Sdwmalone			int rid, struct resource *r);
118133833Sdwmalonestatic void	acpi_delete_resource(device_t bus, device_t child, int type,
119133833Sdwmalone		    int rid);
120133833Sdwmalonestatic uint32_t	acpi_isa_get_logicalid(device_t dev);
121133833Sdwmalonestatic int	acpi_isa_get_compatid(device_t dev, uint32_t *cids, int count);
122133833Sdwmalonestatic char	*acpi_device_id_probe(device_t bus, device_t dev, char **ids);
123133833Sdwmalonestatic ACPI_STATUS acpi_device_eval_obj(device_t bus, device_t dev,
124133833Sdwmalone		    ACPI_STRING pathname, ACPI_OBJECT_LIST *parameters,
125133833Sdwmalone		    ACPI_BUFFER *ret);
126133833Sdwmalonestatic int	acpi_device_pwr_for_sleep(device_t bus, device_t dev,
127133833Sdwmalone		    int *dstate);
128133833Sdwmalonestatic ACPI_STATUS acpi_device_scan_cb(ACPI_HANDLE h, UINT32 level,
129133833Sdwmalone		    void *context, void **retval);
130133833Sdwmalonestatic ACPI_STATUS acpi_device_scan_children(device_t bus, device_t dev,
131133833Sdwmalone		    int max_depth, acpi_scan_cb_t user_fn, void *arg);
132133833Sdwmalonestatic int	acpi_set_powerstate_method(device_t bus, device_t child,
133133833Sdwmalone		    int state);
134133833Sdwmalonestatic int	acpi_isa_pnp_probe(device_t bus, device_t child,
135133833Sdwmalone		    struct isa_pnp_id *ids);
136133833Sdwmalonestatic void	acpi_probe_children(device_t bus);
137133833Sdwmalonestatic void	acpi_probe_order(ACPI_HANDLE handle, int *order);
138133833Sdwmalonestatic ACPI_STATUS acpi_probe_child(ACPI_HANDLE handle, UINT32 level,
139133833Sdwmalone		    void *context, void **status);
140133833Sdwmalonestatic BOOLEAN	acpi_MatchHid(ACPI_HANDLE h, const char *hid);
141133833Sdwmalonestatic ACPI_STATUS acpi_EnterSleepState(struct acpi_softc *sc, int state);
142133833Sdwmalonestatic void	acpi_shutdown_final(void *arg, int howto);
143133833Sdwmalonestatic void	acpi_enable_fixed_events(struct acpi_softc *sc);
144133833Sdwmalonestatic int	acpi_wake_sleep_prep(ACPI_HANDLE handle, int sstate);
145133833Sdwmalonestatic int	acpi_wake_run_prep(ACPI_HANDLE handle, int sstate);
146133833Sdwmalonestatic int	acpi_wake_prep_walk(int sstate);
147133833Sdwmalonestatic int	acpi_wake_sysctl_walk(device_t dev);
148133833Sdwmalonestatic int	acpi_wake_set_sysctl(SYSCTL_HANDLER_ARGS);
149133833Sdwmalonestatic void	acpi_system_eventhandler_sleep(void *arg, int state);
150133833Sdwmalonestatic void	acpi_system_eventhandler_wakeup(void *arg, int state);
151133833Sdwmalonestatic int	acpi_supported_sleep_state_sysctl(SYSCTL_HANDLER_ARGS);
152133833Sdwmalonestatic int	acpi_sleep_state_sysctl(SYSCTL_HANDLER_ARGS);
153133833Sdwmalonestatic int	acpi_pm_func(u_long cmd, void *arg, ...);
154133833Sdwmalonestatic int	acpi_child_location_str_method(device_t acdev, device_t child,
155133833Sdwmalone					       char *buf, size_t buflen);
156133833Sdwmalonestatic int	acpi_child_pnpinfo_str_method(device_t acdev, device_t child,
157133833Sdwmalone					      char *buf, size_t buflen);
158133833Sdwmalone#if defined(__i386__) || defined(__amd64__)
159133833Sdwmalonestatic void	acpi_enable_pcie(void);
160133833Sdwmalone#endif
161133833Sdwmalone
162133833Sdwmalonestatic device_method_t acpi_methods[] = {
163133833Sdwmalone    /* Device interface */
164133833Sdwmalone    DEVMETHOD(device_probe,		acpi_probe),
165133833Sdwmalone    DEVMETHOD(device_attach,		acpi_attach),
166133833Sdwmalone    DEVMETHOD(device_shutdown,		acpi_shutdown),
167133833Sdwmalone    DEVMETHOD(device_detach,		bus_generic_detach),
168133833Sdwmalone    DEVMETHOD(device_suspend,		acpi_suspend),
169133833Sdwmalone    DEVMETHOD(device_resume,		acpi_resume),
170133833Sdwmalone
171133833Sdwmalone    /* Bus interface */
172133833Sdwmalone    DEVMETHOD(bus_add_child,		acpi_add_child),
173133833Sdwmalone    DEVMETHOD(bus_print_child,		acpi_print_child),
174133833Sdwmalone    DEVMETHOD(bus_probe_nomatch,	acpi_probe_nomatch),
175133833Sdwmalone    DEVMETHOD(bus_driver_added,		acpi_driver_added),
176133833Sdwmalone    DEVMETHOD(bus_read_ivar,		acpi_read_ivar),
177133833Sdwmalone    DEVMETHOD(bus_write_ivar,		acpi_write_ivar),
178133833Sdwmalone    DEVMETHOD(bus_get_resource_list,	acpi_get_rlist),
179133833Sdwmalone    DEVMETHOD(bus_set_resource,		bus_generic_rl_set_resource),
180133833Sdwmalone    DEVMETHOD(bus_get_resource,		bus_generic_rl_get_resource),
181133833Sdwmalone    DEVMETHOD(bus_alloc_resource,	acpi_alloc_resource),
182133833Sdwmalone    DEVMETHOD(bus_release_resource,	acpi_release_resource),
183133833Sdwmalone    DEVMETHOD(bus_delete_resource,	acpi_delete_resource),
184133833Sdwmalone    DEVMETHOD(bus_child_pnpinfo_str,	acpi_child_pnpinfo_str_method),
185133833Sdwmalone    DEVMETHOD(bus_child_location_str,	acpi_child_location_str_method),
186133833Sdwmalone    DEVMETHOD(bus_activate_resource,	bus_generic_activate_resource),
187133833Sdwmalone    DEVMETHOD(bus_deactivate_resource,	bus_generic_deactivate_resource),
188133833Sdwmalone    DEVMETHOD(bus_setup_intr,		bus_generic_setup_intr),
189133833Sdwmalone    DEVMETHOD(bus_teardown_intr,	bus_generic_teardown_intr),
190133833Sdwmalone
191133833Sdwmalone    /* ACPI bus */
192133833Sdwmalone    DEVMETHOD(acpi_id_probe,		acpi_device_id_probe),
193133833Sdwmalone    DEVMETHOD(acpi_evaluate_object,	acpi_device_eval_obj),
194133833Sdwmalone    DEVMETHOD(acpi_pwr_for_sleep,	acpi_device_pwr_for_sleep),
195133833Sdwmalone    DEVMETHOD(acpi_scan_children,	acpi_device_scan_children),
196133833Sdwmalone
197133833Sdwmalone    /* PCI emulation */
198133833Sdwmalone    DEVMETHOD(pci_set_powerstate,	acpi_set_powerstate_method),
199133833Sdwmalone
200133833Sdwmalone    /* ISA emulation */
201133833Sdwmalone    DEVMETHOD(isa_pnp_probe,		acpi_isa_pnp_probe),
202133833Sdwmalone
203133833Sdwmalone    {0, 0}
204133833Sdwmalone};
205133833Sdwmalone
206133833Sdwmalonestatic driver_t acpi_driver = {
207133833Sdwmalone    "acpi",
208133833Sdwmalone    acpi_methods,
209133833Sdwmalone    sizeof(struct acpi_softc),
210133833Sdwmalone};
211133833Sdwmalone
212133833Sdwmalonestatic devclass_t acpi_devclass;
213133833SdwmaloneDRIVER_MODULE(acpi, nexus, acpi_driver, acpi_devclass, acpi_modevent, 0);
214133833SdwmaloneMODULE_VERSION(acpi, 1);
215133833Sdwmalone
216133833SdwmaloneACPI_SERIAL_DECL(acpi, "ACPI root bus");
217133833Sdwmalone
218133833Sdwmalone/* Local pools for managing system resources for ACPI child devices. */
219133833Sdwmalonestatic struct rman acpi_rman_io, acpi_rman_mem;
220133833Sdwmalone
221133833Sdwmalone#define ACPI_MINIMUM_AWAKETIME	5
222133833Sdwmalone
223133833Sdwmalonestatic const char* sleep_state_names[] = {
224133833Sdwmalone    "S0", "S1", "S2", "S3", "S4", "S5", "NONE"};
225133833Sdwmalone
226133833Sdwmalone/* Holds the description of the acpi0 device. */
227133833Sdwmalonestatic char acpi_desc[ACPI_OEM_ID_SIZE + ACPI_OEM_TABLE_ID_SIZE + 2];
228133833Sdwmalone
229133833SdwmaloneSYSCTL_NODE(_debug, OID_AUTO, acpi, CTLFLAG_RD, NULL, "ACPI debugging");
230133833Sdwmalonestatic char acpi_ca_version[12];
231133833SdwmaloneSYSCTL_STRING(_debug_acpi, OID_AUTO, acpi_ca_version, CTLFLAG_RD,
232133833Sdwmalone	      acpi_ca_version, 0, "Version of Intel ACPI-CA");
233133833Sdwmalone
234133833Sdwmalone/*
235133833Sdwmalone * Allow override of whether methods execute in parallel or not.
236133833Sdwmalone * Enable this for serial behavior, which fixes "AE_ALREADY_EXISTS"
237133833Sdwmalone * errors for AML that really can't handle parallel method execution.
238133833Sdwmalone * It is off by default since this breaks recursive methods and
239133833Sdwmalone * some IBMs use such code.
240133833Sdwmalone */
241133833Sdwmalonestatic int acpi_serialize_methods;
242133833SdwmaloneTUNABLE_INT("hw.acpi.serialize_methods", &acpi_serialize_methods);
243133833Sdwmalone
244133833Sdwmalone/* Power devices off and on in suspend and resume.  XXX Remove once tested. */
245133833Sdwmalonestatic int acpi_do_powerstate = 1;
246133833SdwmaloneTUNABLE_INT("debug.acpi.do_powerstate", &acpi_do_powerstate);
247133833SdwmaloneSYSCTL_INT(_debug_acpi, OID_AUTO, do_powerstate, CTLFLAG_RW,
248133833Sdwmalone    &acpi_do_powerstate, 1, "Turn off devices when suspending.");
249133833Sdwmalone
250133833Sdwmalone/* Allow users to override quirks. */
251133833SdwmaloneTUNABLE_INT("debug.acpi.quirks", &acpi_quirks);
252133833Sdwmalone
253133833Sdwmalonestatic int acpi_susp_bounce;
254133833SdwmaloneSYSCTL_INT(_debug_acpi, OID_AUTO, suspend_bounce, CTLFLAG_RW,
255133833Sdwmalone    &acpi_susp_bounce, 0, "Don't actually suspend, just test devices.");
256133833Sdwmalone
257133833Sdwmalone/*
258133833Sdwmalone * ACPI can only be loaded as a module by the loader; activating it after
259133833Sdwmalone * system bootstrap time is not useful, and can be fatal to the system.
260133833Sdwmalone * It also cannot be unloaded, since the entire system bus hierarchy hangs
261133833Sdwmalone * off it.
262133833Sdwmalone */
263133833Sdwmalonestatic int
264133833Sdwmaloneacpi_modevent(struct module *mod, int event, void *junk)
265133833Sdwmalone{
266133833Sdwmalone    switch (event) {
267133833Sdwmalone    case MOD_LOAD:
268133833Sdwmalone	if (!cold) {
269133833Sdwmalone	    printf("The ACPI driver cannot be loaded after boot.\n");
270133833Sdwmalone	    return (EPERM);
271133833Sdwmalone	}
272133833Sdwmalone	break;
273133833Sdwmalone    case MOD_UNLOAD:
274133833Sdwmalone	if (!cold && power_pm_get_type() == POWER_PM_TYPE_ACPI)
275133833Sdwmalone	    return (EBUSY);
276133833Sdwmalone	break;
277133833Sdwmalone    default:
278133833Sdwmalone	break;
279133833Sdwmalone    }
280133833Sdwmalone    return (0);
281133833Sdwmalone}
282133833Sdwmalone
283133833Sdwmalone/*
284133833Sdwmalone * Perform early initialization.
285133833Sdwmalone */
286133833SdwmaloneACPI_STATUS
287133833Sdwmaloneacpi_Startup(void)
288133833Sdwmalone{
289133833Sdwmalone    static int started = 0;
290133833Sdwmalone    ACPI_STATUS status;
291133833Sdwmalone    int val;
292133833Sdwmalone
293133833Sdwmalone    ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
294133833Sdwmalone
295133833Sdwmalone    /* Only run the startup code once.  The MADT driver also calls this. */
296133833Sdwmalone    if (started)
297133833Sdwmalone	return_VALUE (AE_OK);
298133833Sdwmalone    started = 1;
299133833Sdwmalone
300133833Sdwmalone    /*
301133833Sdwmalone     * Pre-allocate space for RSDT/XSDT and DSDT tables and allow resizing
302133833Sdwmalone     * if more tables exist.
303133833Sdwmalone     */
304133833Sdwmalone    if (ACPI_FAILURE(status = AcpiInitializeTables(NULL, 2, TRUE))) {
305133833Sdwmalone	printf("ACPI: Table initialisation failed: %s\n",
306133833Sdwmalone	    AcpiFormatException(status));
307133833Sdwmalone	return_VALUE (status);
308133833Sdwmalone    }
309133833Sdwmalone
310133833Sdwmalone    /* Set up any quirks we have for this system. */
311133833Sdwmalone    if (acpi_quirks == ACPI_Q_OK)
312133833Sdwmalone	acpi_table_quirks(&acpi_quirks);
313133833Sdwmalone
314133833Sdwmalone    /* If the user manually set the disabled hint to 0, force-enable ACPI. */
315133833Sdwmalone    if (resource_int_value("acpi", 0, "disabled", &val) == 0 && val == 0)
316133833Sdwmalone	acpi_quirks &= ~ACPI_Q_BROKEN;
317133833Sdwmalone    if (acpi_quirks & ACPI_Q_BROKEN) {
318133833Sdwmalone	printf("ACPI disabled by blacklist.  Contact your BIOS vendor.\n");
319133833Sdwmalone	status = AE_SUPPORT;
320133833Sdwmalone    }
321133833Sdwmalone
322133833Sdwmalone    return_VALUE (status);
323133833Sdwmalone}
324133833Sdwmalone
325133833Sdwmalone/*
326133833Sdwmalone * Detect ACPI and perform early initialisation.
327133833Sdwmalone */
328133833Sdwmaloneint
329133833Sdwmaloneacpi_identify(void)
330133833Sdwmalone{
331133833Sdwmalone    ACPI_TABLE_RSDP	*rsdp;
332133833Sdwmalone    ACPI_TABLE_HEADER	*rsdt;
333133833Sdwmalone    ACPI_PHYSICAL_ADDRESS paddr;
334133833Sdwmalone    struct sbuf		sb;
335133833Sdwmalone
336133833Sdwmalone    ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
337133833Sdwmalone
338133833Sdwmalone    if (!cold)
339133833Sdwmalone	return (ENXIO);
340133833Sdwmalone
341133833Sdwmalone    /* Check that we haven't been disabled with a hint. */
342133833Sdwmalone    if (resource_disabled("acpi", 0))
343133833Sdwmalone	return (ENXIO);
344133833Sdwmalone
345133833Sdwmalone    /* Check for other PM systems. */
346133833Sdwmalone    if (power_pm_get_type() != POWER_PM_TYPE_NONE &&
347133833Sdwmalone	power_pm_get_type() != POWER_PM_TYPE_ACPI) {
348133833Sdwmalone	printf("ACPI identify failed, other PM system enabled.\n");
349133833Sdwmalone	return (ENXIO);
350133833Sdwmalone    }
351133833Sdwmalone
352133833Sdwmalone    /* Initialize root tables. */
353133833Sdwmalone    if (ACPI_FAILURE(acpi_Startup())) {
354133833Sdwmalone	printf("ACPI: Try disabling either ACPI or apic support.\n");
355133833Sdwmalone	return (ENXIO);
356133833Sdwmalone    }
357133833Sdwmalone
358133833Sdwmalone    if ((paddr = AcpiOsGetRootPointer()) == 0 ||
359133833Sdwmalone	(rsdp = AcpiOsMapMemory(paddr, sizeof(ACPI_TABLE_RSDP))) == NULL)
360133833Sdwmalone	return (ENXIO);
361133833Sdwmalone    if (rsdp->Revision > 1 && rsdp->XsdtPhysicalAddress != 0)
362133833Sdwmalone	paddr = (ACPI_PHYSICAL_ADDRESS)rsdp->XsdtPhysicalAddress;
363133833Sdwmalone    else
364133833Sdwmalone	paddr = (ACPI_PHYSICAL_ADDRESS)rsdp->RsdtPhysicalAddress;
365133833Sdwmalone    AcpiOsUnmapMemory(rsdp, sizeof(ACPI_TABLE_RSDP));
366133833Sdwmalone
367133833Sdwmalone    if ((rsdt = AcpiOsMapMemory(paddr, sizeof(ACPI_TABLE_HEADER))) == NULL)
368133833Sdwmalone	return (ENXIO);
369133833Sdwmalone    sbuf_new(&sb, acpi_desc, sizeof(acpi_desc), SBUF_FIXEDLEN);
370133833Sdwmalone    sbuf_bcat(&sb, rsdt->OemId, ACPI_OEM_ID_SIZE);
371133833Sdwmalone    sbuf_trim(&sb);
372133833Sdwmalone    sbuf_putc(&sb, ' ');
373133833Sdwmalone    sbuf_bcat(&sb, rsdt->OemTableId, ACPI_OEM_TABLE_ID_SIZE);
374133833Sdwmalone    sbuf_trim(&sb);
375133833Sdwmalone    sbuf_finish(&sb);
376133833Sdwmalone    sbuf_delete(&sb);
377133833Sdwmalone    AcpiOsUnmapMemory(rsdt, sizeof(ACPI_TABLE_HEADER));
378133833Sdwmalone
379133833Sdwmalone    snprintf(acpi_ca_version, sizeof(acpi_ca_version), "%x", ACPI_CA_VERSION);
380133833Sdwmalone
381133833Sdwmalone    return (0);
382133833Sdwmalone}
383133833Sdwmalone
384133833Sdwmalone/*
385133833Sdwmalone * Fetch some descriptive data from ACPI to put in our attach message.
386133833Sdwmalone */
387static int
388acpi_probe(device_t dev)
389{
390
391    ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
392
393    device_set_desc(dev, acpi_desc);
394
395    return_VALUE (0);
396}
397
398static int
399acpi_attach(device_t dev)
400{
401    struct acpi_softc	*sc;
402    ACPI_TABLE_FACS	*facs;
403    ACPI_STATUS		status;
404    int			error, state;
405    UINT32		flags;
406    UINT8		TypeA, TypeB;
407    char		*env;
408
409    ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
410
411    sc = device_get_softc(dev);
412    sc->acpi_dev = dev;
413    callout_init(&sc->susp_force_to, TRUE);
414
415    error = ENXIO;
416
417    /* Initialize resource manager. */
418    acpi_rman_io.rm_type = RMAN_ARRAY;
419    acpi_rman_io.rm_start = 0;
420    acpi_rman_io.rm_end = 0xffff;
421    acpi_rman_io.rm_descr = "ACPI I/O ports";
422    if (rman_init(&acpi_rman_io) != 0)
423	panic("acpi rman_init IO ports failed");
424    acpi_rman_mem.rm_type = RMAN_ARRAY;
425    acpi_rman_mem.rm_start = 0;
426    acpi_rman_mem.rm_end = ~0ul;
427    acpi_rman_mem.rm_descr = "ACPI I/O memory addresses";
428    if (rman_init(&acpi_rman_mem) != 0)
429	panic("acpi rman_init memory failed");
430
431    /* Initialise the ACPI mutex */
432    mtx_init(&acpi_mutex, "ACPI global lock", NULL, MTX_DEF);
433
434    /*
435     * Set the globals from our tunables.  This is needed because ACPI-CA
436     * uses UINT8 for some values and we have no tunable_byte.
437     */
438    AcpiGbl_AllMethodsSerialized = acpi_serialize_methods;
439    AcpiGbl_EnableInterpreterSlack = TRUE;
440
441    /* Start up the ACPI CA subsystem. */
442    status = AcpiInitializeSubsystem();
443    if (ACPI_FAILURE(status)) {
444	device_printf(dev, "Could not initialize Subsystem: %s\n",
445		      AcpiFormatException(status));
446	goto out;
447    }
448
449    /* Load ACPI name space. */
450    status = AcpiLoadTables();
451    if (ACPI_FAILURE(status)) {
452	device_printf(dev, "Could not load Namespace: %s\n",
453		      AcpiFormatException(status));
454	goto out;
455    }
456
457#if defined(__i386__) || defined(__amd64__)
458    /* Handle MCFG table if present. */
459    acpi_enable_pcie();
460#endif
461
462    /* Install the default address space handlers. */
463    status = AcpiInstallAddressSpaceHandler(ACPI_ROOT_OBJECT,
464		ACPI_ADR_SPACE_SYSTEM_MEMORY, ACPI_DEFAULT_HANDLER, NULL, NULL);
465    if (ACPI_FAILURE(status)) {
466	device_printf(dev, "Could not initialise SystemMemory handler: %s\n",
467		      AcpiFormatException(status));
468	goto out;
469    }
470    status = AcpiInstallAddressSpaceHandler(ACPI_ROOT_OBJECT,
471		ACPI_ADR_SPACE_SYSTEM_IO, ACPI_DEFAULT_HANDLER, NULL, NULL);
472    if (ACPI_FAILURE(status)) {
473	device_printf(dev, "Could not initialise SystemIO handler: %s\n",
474		      AcpiFormatException(status));
475	goto out;
476    }
477    status = AcpiInstallAddressSpaceHandler(ACPI_ROOT_OBJECT,
478		ACPI_ADR_SPACE_PCI_CONFIG, ACPI_DEFAULT_HANDLER, NULL, NULL);
479    if (ACPI_FAILURE(status)) {
480	device_printf(dev, "could not initialise PciConfig handler: %s\n",
481		      AcpiFormatException(status));
482	goto out;
483    }
484
485    /*
486     * Note that some systems (specifically, those with namespace evaluation
487     * issues that require the avoidance of parts of the namespace) must
488     * avoid running _INI and _STA on everything, as well as dodging the final
489     * object init pass.
490     *
491     * For these devices, we set ACPI_NO_DEVICE_INIT and ACPI_NO_OBJECT_INIT).
492     *
493     * XXX We should arrange for the object init pass after we have attached
494     *     all our child devices, but on many systems it works here.
495     */
496    flags = 0;
497    if (testenv("debug.acpi.avoid"))
498	flags = ACPI_NO_DEVICE_INIT | ACPI_NO_OBJECT_INIT;
499
500    /* Bring the hardware and basic handlers online. */
501    if (ACPI_FAILURE(status = AcpiEnableSubsystem(flags))) {
502	device_printf(dev, "Could not enable ACPI: %s\n",
503		      AcpiFormatException(status));
504	goto out;
505    }
506
507    /*
508     * Call the ECDT probe function to provide EC functionality before
509     * the namespace has been evaluated.
510     *
511     * XXX This happens before the sysresource devices have been probed and
512     * attached so its resources come from nexus0.  In practice, this isn't
513     * a problem but should be addressed eventually.
514     */
515    acpi_ec_ecdt_probe(dev);
516
517    /* Bring device objects and regions online. */
518    if (ACPI_FAILURE(status = AcpiInitializeObjects(flags))) {
519	device_printf(dev, "Could not initialize ACPI objects: %s\n",
520		      AcpiFormatException(status));
521	goto out;
522    }
523
524    /*
525     * Setup our sysctl tree.
526     *
527     * XXX: This doesn't check to make sure that none of these fail.
528     */
529    sysctl_ctx_init(&sc->acpi_sysctl_ctx);
530    sc->acpi_sysctl_tree = SYSCTL_ADD_NODE(&sc->acpi_sysctl_ctx,
531			       SYSCTL_STATIC_CHILDREN(_hw), OID_AUTO,
532			       device_get_name(dev), CTLFLAG_RD, 0, "");
533    SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
534	OID_AUTO, "supported_sleep_state", CTLTYPE_STRING | CTLFLAG_RD,
535	0, 0, acpi_supported_sleep_state_sysctl, "A", "");
536    SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
537	OID_AUTO, "power_button_state", CTLTYPE_STRING | CTLFLAG_RW,
538	&sc->acpi_power_button_sx, 0, acpi_sleep_state_sysctl, "A", "");
539    SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
540	OID_AUTO, "sleep_button_state", CTLTYPE_STRING | CTLFLAG_RW,
541	&sc->acpi_sleep_button_sx, 0, acpi_sleep_state_sysctl, "A", "");
542    SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
543	OID_AUTO, "lid_switch_state", CTLTYPE_STRING | CTLFLAG_RW,
544	&sc->acpi_lid_switch_sx, 0, acpi_sleep_state_sysctl, "A", "");
545    SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
546	OID_AUTO, "standby_state", CTLTYPE_STRING | CTLFLAG_RW,
547	&sc->acpi_standby_sx, 0, acpi_sleep_state_sysctl, "A", "");
548    SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
549	OID_AUTO, "suspend_state", CTLTYPE_STRING | CTLFLAG_RW,
550	&sc->acpi_suspend_sx, 0, acpi_sleep_state_sysctl, "A", "");
551    SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
552	OID_AUTO, "sleep_delay", CTLFLAG_RW, &sc->acpi_sleep_delay, 0,
553	"sleep delay");
554    SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
555	OID_AUTO, "s4bios", CTLFLAG_RW, &sc->acpi_s4bios, 0, "S4BIOS mode");
556    SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
557	OID_AUTO, "verbose", CTLFLAG_RW, &sc->acpi_verbose, 0, "verbose mode");
558    SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
559	OID_AUTO, "disable_on_reboot", CTLFLAG_RW,
560	&sc->acpi_do_disable, 0, "Disable ACPI when rebooting/halting system");
561    SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
562	OID_AUTO, "handle_reboot", CTLFLAG_RW,
563	&sc->acpi_handle_reboot, 0, "Use ACPI Reset Register to reboot");
564
565    /*
566     * Default to 1 second before sleeping to give some machines time to
567     * stabilize.
568     */
569    sc->acpi_sleep_delay = 1;
570    if (bootverbose)
571	sc->acpi_verbose = 1;
572    if ((env = getenv("hw.acpi.verbose")) != NULL) {
573	if (strcmp(env, "0") != 0)
574	    sc->acpi_verbose = 1;
575	freeenv(env);
576    }
577
578    /* Only enable S4BIOS by default if the FACS says it is available. */
579    status = AcpiGetTable(ACPI_SIG_FACS, 0, (ACPI_TABLE_HEADER **)&facs);
580    if (ACPI_FAILURE(status)) {
581	device_printf(dev, "couldn't get FACS: %s\n",
582		      AcpiFormatException(status));
583	error = ENXIO;
584	goto out;
585    }
586    if (facs->Flags & ACPI_FACS_S4_BIOS_PRESENT)
587	sc->acpi_s4bios = 1;
588
589    /*
590     * Dispatch the default sleep state to devices.  The lid switch is set
591     * to NONE by default to avoid surprising users.
592     */
593    sc->acpi_power_button_sx = ACPI_STATE_S5;
594    sc->acpi_lid_switch_sx = ACPI_S_STATES_MAX + 1;
595    sc->acpi_standby_sx = ACPI_STATE_S1;
596    sc->acpi_suspend_sx = ACPI_STATE_S3;
597
598    /* Pick the first valid sleep state for the sleep button default. */
599    sc->acpi_sleep_button_sx = ACPI_S_STATES_MAX + 1;
600    for (state = ACPI_STATE_S1; state <= ACPI_STATE_S4; state++)
601	if (ACPI_SUCCESS(AcpiGetSleepTypeData(state, &TypeA, &TypeB))) {
602	    sc->acpi_sleep_button_sx = state;
603	    break;
604	}
605
606    acpi_enable_fixed_events(sc);
607
608    /*
609     * Scan the namespace and attach/initialise children.
610     */
611
612    /* Register our shutdown handler. */
613    EVENTHANDLER_REGISTER(shutdown_final, acpi_shutdown_final, sc,
614	SHUTDOWN_PRI_LAST);
615
616    /*
617     * Register our acpi event handlers.
618     * XXX should be configurable eg. via userland policy manager.
619     */
620    EVENTHANDLER_REGISTER(acpi_sleep_event, acpi_system_eventhandler_sleep,
621	sc, ACPI_EVENT_PRI_LAST);
622    EVENTHANDLER_REGISTER(acpi_wakeup_event, acpi_system_eventhandler_wakeup,
623	sc, ACPI_EVENT_PRI_LAST);
624
625    /* Flag our initial states. */
626    sc->acpi_enabled = 1;
627    sc->acpi_sstate = ACPI_STATE_S0;
628    sc->acpi_sleep_disabled = 0;
629
630    /* Create the control device */
631    sc->acpi_dev_t = make_dev(&acpi_cdevsw, 0, UID_ROOT, GID_WHEEL, 0644,
632			      "acpi");
633    sc->acpi_dev_t->si_drv1 = sc;
634
635    if ((error = acpi_machdep_init(dev)))
636	goto out;
637
638    /* Register ACPI again to pass the correct argument of pm_func. */
639    power_pm_register(POWER_PM_TYPE_ACPI, acpi_pm_func, sc);
640
641    if (!acpi_disabled("bus"))
642	acpi_probe_children(dev);
643
644    error = 0;
645
646 out:
647    return_VALUE (error);
648}
649
650static int
651acpi_suspend(device_t dev)
652{
653    device_t child, *devlist;
654    int error, i, numdevs, pstate;
655
656    GIANT_REQUIRED;
657
658    /* First give child devices a chance to suspend. */
659    error = bus_generic_suspend(dev);
660    if (error)
661	return (error);
662
663    /*
664     * Now, set them into the appropriate power state, usually D3.  If the
665     * device has an _SxD method for the next sleep state, use that power
666     * state instead.
667     */
668    error = device_get_children(dev, &devlist, &numdevs);
669    if (error)
670	return (error);
671    for (i = 0; i < numdevs; i++) {
672	/* If the device is not attached, we've powered it down elsewhere. */
673	child = devlist[i];
674	if (!device_is_attached(child))
675	    continue;
676
677	/*
678	 * Default to D3 for all sleep states.  The _SxD method is optional
679	 * so set the powerstate even if it's absent.
680	 */
681	pstate = PCI_POWERSTATE_D3;
682	error = acpi_device_pwr_for_sleep(device_get_parent(child),
683	    child, &pstate);
684	if ((error == 0 || error == ESRCH) && acpi_do_powerstate)
685	    pci_set_powerstate(child, pstate);
686    }
687    free(devlist, M_TEMP);
688    error = 0;
689
690    return (error);
691}
692
693static int
694acpi_resume(device_t dev)
695{
696    ACPI_HANDLE handle;
697    int i, numdevs, error;
698    device_t child, *devlist;
699
700    GIANT_REQUIRED;
701
702    /*
703     * Put all devices in D0 before resuming them.  Call _S0D on each one
704     * since some systems expect this.
705     */
706    error = device_get_children(dev, &devlist, &numdevs);
707    if (error)
708	return (error);
709    for (i = 0; i < numdevs; i++) {
710	child = devlist[i];
711	handle = acpi_get_handle(child);
712	if (handle)
713	    AcpiEvaluateObject(handle, "_S0D", NULL, NULL);
714	if (device_is_attached(child) && acpi_do_powerstate)
715	    pci_set_powerstate(child, PCI_POWERSTATE_D0);
716    }
717    free(devlist, M_TEMP);
718
719    return (bus_generic_resume(dev));
720}
721
722static int
723acpi_shutdown(device_t dev)
724{
725
726    GIANT_REQUIRED;
727
728    /* Allow children to shutdown first. */
729    bus_generic_shutdown(dev);
730
731    /*
732     * Enable any GPEs that are able to power-on the system (i.e., RTC).
733     * Also, disable any that are not valid for this state (most).
734     */
735    acpi_wake_prep_walk(ACPI_STATE_S5);
736
737    return (0);
738}
739
740/*
741 * Handle a new device being added
742 */
743static device_t
744acpi_add_child(device_t bus, int order, const char *name, int unit)
745{
746    struct acpi_device	*ad;
747    device_t		child;
748
749    if ((ad = malloc(sizeof(*ad), M_ACPIDEV, M_NOWAIT | M_ZERO)) == NULL)
750	return (NULL);
751
752    resource_list_init(&ad->ad_rl);
753
754    child = device_add_child_ordered(bus, order, name, unit);
755    if (child != NULL)
756	device_set_ivars(child, ad);
757    else
758	free(ad, M_ACPIDEV);
759    return (child);
760}
761
762static int
763acpi_print_child(device_t bus, device_t child)
764{
765    struct acpi_device	 *adev = device_get_ivars(child);
766    struct resource_list *rl = &adev->ad_rl;
767    int retval = 0;
768
769    retval += bus_print_child_header(bus, child);
770    retval += resource_list_print_type(rl, "port",  SYS_RES_IOPORT, "%#lx");
771    retval += resource_list_print_type(rl, "iomem", SYS_RES_MEMORY, "%#lx");
772    retval += resource_list_print_type(rl, "irq",   SYS_RES_IRQ,    "%ld");
773    retval += resource_list_print_type(rl, "drq",   SYS_RES_DRQ,    "%ld");
774    if (device_get_flags(child))
775	retval += printf(" flags %#x", device_get_flags(child));
776    retval += bus_print_child_footer(bus, child);
777
778    return (retval);
779}
780
781/*
782 * If this device is an ACPI child but no one claimed it, attempt
783 * to power it off.  We'll power it back up when a driver is added.
784 *
785 * XXX Disabled for now since many necessary devices (like fdc and
786 * ATA) don't claim the devices we created for them but still expect
787 * them to be powered up.
788 */
789static void
790acpi_probe_nomatch(device_t bus, device_t child)
791{
792
793    /* pci_set_powerstate(child, PCI_POWERSTATE_D3); */
794}
795
796/*
797 * If a new driver has a chance to probe a child, first power it up.
798 *
799 * XXX Disabled for now (see acpi_probe_nomatch for details).
800 */
801static void
802acpi_driver_added(device_t dev, driver_t *driver)
803{
804    device_t child, *devlist;
805    int i, numdevs;
806
807    DEVICE_IDENTIFY(driver, dev);
808    if (device_get_children(dev, &devlist, &numdevs))
809	    return;
810    for (i = 0; i < numdevs; i++) {
811	child = devlist[i];
812	if (device_get_state(child) == DS_NOTPRESENT) {
813	    /* pci_set_powerstate(child, PCI_POWERSTATE_D0); */
814	    if (device_probe_and_attach(child) != 0)
815		; /* pci_set_powerstate(child, PCI_POWERSTATE_D3); */
816	}
817    }
818    free(devlist, M_TEMP);
819}
820
821/* Location hint for devctl(8) */
822static int
823acpi_child_location_str_method(device_t cbdev, device_t child, char *buf,
824    size_t buflen)
825{
826    struct acpi_device *dinfo = device_get_ivars(child);
827
828    if (dinfo->ad_handle)
829	snprintf(buf, buflen, "handle=%s", acpi_name(dinfo->ad_handle));
830    else
831	snprintf(buf, buflen, "unknown");
832    return (0);
833}
834
835/* PnP information for devctl(8) */
836static int
837acpi_child_pnpinfo_str_method(device_t cbdev, device_t child, char *buf,
838    size_t buflen)
839{
840    ACPI_BUFFER adbuf = {ACPI_ALLOCATE_BUFFER, NULL};
841    ACPI_DEVICE_INFO *adinfo;
842    struct acpi_device *dinfo = device_get_ivars(child);
843    char *end;
844    int error;
845
846    error = AcpiGetObjectInfo(dinfo->ad_handle, &adbuf);
847    adinfo = (ACPI_DEVICE_INFO *) adbuf.Pointer;
848    if (error)
849	snprintf(buf, buflen, "unknown");
850    else
851	snprintf(buf, buflen, "_HID=%s _UID=%lu",
852		 (adinfo->Valid & ACPI_VALID_HID) ?
853		 adinfo->HardwareId.Value : "none",
854		 (adinfo->Valid & ACPI_VALID_UID) ?
855		 strtoul(adinfo->UniqueId.Value, &end, 10) : 0);
856    if (adinfo)
857	AcpiOsFree(adinfo);
858
859    return (0);
860}
861
862/*
863 * Handle per-device ivars
864 */
865static int
866acpi_read_ivar(device_t dev, device_t child, int index, uintptr_t *result)
867{
868    struct acpi_device	*ad;
869
870    if ((ad = device_get_ivars(child)) == NULL) {
871	printf("device has no ivars\n");
872	return (ENOENT);
873    }
874
875    /* ACPI and ISA compatibility ivars */
876    switch(index) {
877    case ACPI_IVAR_HANDLE:
878	*(ACPI_HANDLE *)result = ad->ad_handle;
879	break;
880    case ACPI_IVAR_MAGIC:
881	*(uintptr_t *)result = ad->ad_magic;
882	break;
883    case ACPI_IVAR_PRIVATE:
884	*(void **)result = ad->ad_private;
885	break;
886    case ACPI_IVAR_FLAGS:
887	*(int *)result = ad->ad_flags;
888	break;
889    case ISA_IVAR_VENDORID:
890    case ISA_IVAR_SERIAL:
891    case ISA_IVAR_COMPATID:
892	*(int *)result = -1;
893	break;
894    case ISA_IVAR_LOGICALID:
895	*(int *)result = acpi_isa_get_logicalid(child);
896	break;
897    default:
898	return (ENOENT);
899    }
900
901    return (0);
902}
903
904static int
905acpi_write_ivar(device_t dev, device_t child, int index, uintptr_t value)
906{
907    struct acpi_device	*ad;
908
909    if ((ad = device_get_ivars(child)) == NULL) {
910	printf("device has no ivars\n");
911	return (ENOENT);
912    }
913
914    switch(index) {
915    case ACPI_IVAR_HANDLE:
916	ad->ad_handle = (ACPI_HANDLE)value;
917	break;
918    case ACPI_IVAR_MAGIC:
919	ad->ad_magic = (uintptr_t)value;
920	break;
921    case ACPI_IVAR_PRIVATE:
922	ad->ad_private = (void *)value;
923	break;
924    case ACPI_IVAR_FLAGS:
925	ad->ad_flags = (int)value;
926	break;
927    default:
928	panic("bad ivar write request (%d)", index);
929	return (ENOENT);
930    }
931
932    return (0);
933}
934
935/*
936 * Handle child resource allocation/removal
937 */
938static struct resource_list *
939acpi_get_rlist(device_t dev, device_t child)
940{
941    struct acpi_device		*ad;
942
943    ad = device_get_ivars(child);
944    return (&ad->ad_rl);
945}
946
947/*
948 * Pre-allocate/manage all memory and IO resources.  Since rman can't handle
949 * duplicates, we merge any in the sysresource attach routine.
950 */
951static int
952acpi_sysres_alloc(device_t dev)
953{
954    struct resource *res;
955    struct resource_list *rl;
956    struct resource_list_entry *rle;
957    struct rman *rm;
958    char *sysres_ids[] = { "PNP0C01", "PNP0C02", NULL };
959    device_t *children;
960    int child_count, i;
961
962    /*
963     * Probe/attach any sysresource devices.  This would be unnecessary if we
964     * had multi-pass probe/attach.
965     */
966    if (device_get_children(dev, &children, &child_count) != 0)
967	return (ENXIO);
968    for (i = 0; i < child_count; i++) {
969	if (ACPI_ID_PROBE(dev, children[i], sysres_ids) != NULL)
970	    device_probe_and_attach(children[i]);
971    }
972    free(children, M_TEMP);
973
974    rl = BUS_GET_RESOURCE_LIST(device_get_parent(dev), dev);
975    STAILQ_FOREACH(rle, rl, link) {
976	if (rle->res != NULL) {
977	    device_printf(dev, "duplicate resource for %lx\n", rle->start);
978	    continue;
979	}
980
981	/* Only memory and IO resources are valid here. */
982	switch (rle->type) {
983	case SYS_RES_IOPORT:
984	    rm = &acpi_rman_io;
985	    break;
986	case SYS_RES_MEMORY:
987	    rm = &acpi_rman_mem;
988	    break;
989	default:
990	    continue;
991	}
992
993	/* Pre-allocate resource and add to our rman pool. */
994	res = BUS_ALLOC_RESOURCE(device_get_parent(dev), dev, rle->type,
995	    &rle->rid, rle->start, rle->start + rle->count - 1, rle->count, 0);
996	if (res != NULL) {
997	    rman_manage_region(rm, rman_get_start(res), rman_get_end(res));
998	    rle->res = res;
999	} else
1000	    device_printf(dev, "reservation of %lx, %lx (%d) failed\n",
1001		rle->start, rle->count, rle->type);
1002    }
1003    return (0);
1004}
1005
1006static struct resource *
1007acpi_alloc_resource(device_t bus, device_t child, int type, int *rid,
1008    u_long start, u_long end, u_long count, u_int flags)
1009{
1010    ACPI_RESOURCE ares;
1011    struct acpi_device *ad = device_get_ivars(child);
1012    struct resource_list *rl = &ad->ad_rl;
1013    struct resource_list_entry *rle;
1014    struct resource *res;
1015    struct rman *rm;
1016
1017    res = NULL;
1018
1019    /* We only handle memory and IO resources through rman. */
1020    switch (type) {
1021    case SYS_RES_IOPORT:
1022	rm = &acpi_rman_io;
1023	break;
1024    case SYS_RES_MEMORY:
1025	rm = &acpi_rman_mem;
1026	break;
1027    default:
1028	rm = NULL;
1029    }
1030
1031    ACPI_SERIAL_BEGIN(acpi);
1032
1033    /*
1034     * If this is an allocation of the "default" range for a given RID, and
1035     * we know what the resources for this device are (i.e., they're on the
1036     * child's resource list), use those start/end values.
1037     */
1038    if (bus == device_get_parent(child) && start == 0UL && end == ~0UL) {
1039	rle = resource_list_find(rl, type, *rid);
1040	if (rle == NULL)
1041	    goto out;
1042	start = rle->start;
1043	end = rle->end;
1044	count = rle->count;
1045    }
1046
1047    /*
1048     * If this is an allocation of a specific range, see if we can satisfy
1049     * the request from our system resource regions.  If we can't, pass the
1050     * request up to the parent.
1051     */
1052    if (start + count - 1 == end && rm != NULL)
1053	res = rman_reserve_resource(rm, start, end, count, flags & ~RF_ACTIVE,
1054	    child);
1055    if (res == NULL) {
1056	res = BUS_ALLOC_RESOURCE(device_get_parent(bus), child, type, rid,
1057	    start, end, count, flags);
1058    } else {
1059	rman_set_rid(res, *rid);
1060
1061	/* If requested, activate the resource using the parent's method. */
1062	if (flags & RF_ACTIVE)
1063	    if (bus_activate_resource(child, type, *rid, res) != 0) {
1064		rman_release_resource(res);
1065		res = NULL;
1066		goto out;
1067	    }
1068    }
1069
1070    if (res != NULL && device_get_parent(child) == bus)
1071	switch (type) {
1072	case SYS_RES_IRQ:
1073	    /*
1074	     * Since bus_config_intr() takes immediate effect, we cannot
1075	     * configure the interrupt associated with a device when we
1076	     * parse the resources but have to defer it until a driver
1077	     * actually allocates the interrupt via bus_alloc_resource().
1078	     *
1079	     * XXX: Should we handle the lookup failing?
1080	     */
1081	    if (ACPI_SUCCESS(acpi_lookup_irq_resource(child, *rid, res, &ares)))
1082		acpi_config_intr(child, &ares);
1083	    break;
1084	}
1085
1086out:
1087    ACPI_SERIAL_END(acpi);
1088    return (res);
1089}
1090
1091static int
1092acpi_release_resource(device_t bus, device_t child, int type, int rid,
1093    struct resource *r)
1094{
1095    struct rman *rm;
1096    int ret;
1097
1098    /* We only handle memory and IO resources through rman. */
1099    switch (type) {
1100    case SYS_RES_IOPORT:
1101	rm = &acpi_rman_io;
1102	break;
1103    case SYS_RES_MEMORY:
1104	rm = &acpi_rman_mem;
1105	break;
1106    default:
1107	rm = NULL;
1108    }
1109
1110    ACPI_SERIAL_BEGIN(acpi);
1111
1112    /*
1113     * If this resource belongs to one of our internal managers,
1114     * deactivate it and release it to the local pool.  If it doesn't,
1115     * pass this request up to the parent.
1116     */
1117    if (rm != NULL && rman_is_region_manager(r, rm)) {
1118	if (rman_get_flags(r) & RF_ACTIVE) {
1119	    ret = bus_deactivate_resource(child, type, rid, r);
1120	    if (ret != 0)
1121		goto out;
1122	}
1123	ret = rman_release_resource(r);
1124    } else
1125	ret = BUS_RELEASE_RESOURCE(device_get_parent(bus), child, type, rid, r);
1126
1127out:
1128    ACPI_SERIAL_END(acpi);
1129    return (ret);
1130}
1131
1132static void
1133acpi_delete_resource(device_t bus, device_t child, int type, int rid)
1134{
1135    struct resource_list *rl;
1136
1137    rl = acpi_get_rlist(bus, child);
1138    resource_list_delete(rl, type, rid);
1139}
1140
1141/* Allocate an IO port or memory resource, given its GAS. */
1142int
1143acpi_bus_alloc_gas(device_t dev, int *type, int *rid, ACPI_GENERIC_ADDRESS *gas,
1144    struct resource **res, u_int flags)
1145{
1146    int error, res_type;
1147
1148    error = ENOMEM;
1149    if (type == NULL || rid == NULL || gas == NULL || res == NULL)
1150	return (EINVAL);
1151
1152    /* We only support memory and IO spaces. */
1153    switch (gas->SpaceId) {
1154    case ACPI_ADR_SPACE_SYSTEM_MEMORY:
1155	res_type = SYS_RES_MEMORY;
1156	break;
1157    case ACPI_ADR_SPACE_SYSTEM_IO:
1158	res_type = SYS_RES_IOPORT;
1159	break;
1160    default:
1161	return (EOPNOTSUPP);
1162    }
1163
1164    /*
1165     * If the register width is less than 8, assume the BIOS author means
1166     * it is a bit field and just allocate a byte.
1167     */
1168    if (gas->BitWidth && gas->BitWidth < 8)
1169	gas->BitWidth = 8;
1170
1171    /* Validate the address after we're sure we support the space. */
1172    if (gas->Address == 0 || gas->BitWidth == 0)
1173	return (EINVAL);
1174
1175    bus_set_resource(dev, res_type, *rid, gas->Address,
1176	gas->BitWidth / 8);
1177    *res = bus_alloc_resource_any(dev, res_type, rid, RF_ACTIVE | flags);
1178    if (*res != NULL) {
1179	*type = res_type;
1180	error = 0;
1181    } else
1182	bus_delete_resource(dev, res_type, *rid);
1183
1184    return (error);
1185}
1186
1187/* Probe _HID and _CID for compatible ISA PNP ids. */
1188static uint32_t
1189acpi_isa_get_logicalid(device_t dev)
1190{
1191    ACPI_DEVICE_INFO	*devinfo;
1192    ACPI_BUFFER		buf;
1193    ACPI_HANDLE		h;
1194    ACPI_STATUS		error;
1195    u_int32_t		pnpid;
1196
1197    ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1198
1199    pnpid = 0;
1200    buf.Pointer = NULL;
1201    buf.Length = ACPI_ALLOCATE_BUFFER;
1202
1203    /* Fetch and validate the HID. */
1204    if ((h = acpi_get_handle(dev)) == NULL)
1205	goto out;
1206    error = AcpiGetObjectInfo(h, &buf);
1207    if (ACPI_FAILURE(error))
1208	goto out;
1209    devinfo = (ACPI_DEVICE_INFO *)buf.Pointer;
1210
1211    if ((devinfo->Valid & ACPI_VALID_HID) != 0)
1212	pnpid = PNP_EISAID(devinfo->HardwareId.Value);
1213
1214out:
1215    if (buf.Pointer != NULL)
1216	AcpiOsFree(buf.Pointer);
1217    return_VALUE (pnpid);
1218}
1219
1220static int
1221acpi_isa_get_compatid(device_t dev, uint32_t *cids, int count)
1222{
1223    ACPI_DEVICE_INFO	*devinfo;
1224    ACPI_BUFFER		buf;
1225    ACPI_HANDLE		h;
1226    ACPI_STATUS		error;
1227    uint32_t		*pnpid;
1228    int			valid, i;
1229
1230    ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1231
1232    pnpid = cids;
1233    valid = 0;
1234    buf.Pointer = NULL;
1235    buf.Length = ACPI_ALLOCATE_BUFFER;
1236
1237    /* Fetch and validate the CID */
1238    if ((h = acpi_get_handle(dev)) == NULL)
1239	goto out;
1240    error = AcpiGetObjectInfo(h, &buf);
1241    if (ACPI_FAILURE(error))
1242	goto out;
1243    devinfo = (ACPI_DEVICE_INFO *)buf.Pointer;
1244    if ((devinfo->Valid & ACPI_VALID_CID) == 0)
1245	goto out;
1246
1247    if (devinfo->CompatibilityId.Count < count)
1248	count = devinfo->CompatibilityId.Count;
1249    for (i = 0; i < count; i++) {
1250	if (strncmp(devinfo->CompatibilityId.Id[i].Value, "PNP", 3) != 0)
1251	    continue;
1252	*pnpid++ = PNP_EISAID(devinfo->CompatibilityId.Id[i].Value);
1253	valid++;
1254    }
1255
1256out:
1257    if (buf.Pointer != NULL)
1258	AcpiOsFree(buf.Pointer);
1259    return_VALUE (valid);
1260}
1261
1262static char *
1263acpi_device_id_probe(device_t bus, device_t dev, char **ids)
1264{
1265    ACPI_HANDLE h;
1266    int i;
1267
1268    h = acpi_get_handle(dev);
1269    if (ids == NULL || h == NULL || acpi_get_type(dev) != ACPI_TYPE_DEVICE)
1270	return (NULL);
1271
1272    /* Try to match one of the array of IDs with a HID or CID. */
1273    for (i = 0; ids[i] != NULL; i++) {
1274	if (acpi_MatchHid(h, ids[i]))
1275	    return (ids[i]);
1276    }
1277    return (NULL);
1278}
1279
1280static ACPI_STATUS
1281acpi_device_eval_obj(device_t bus, device_t dev, ACPI_STRING pathname,
1282    ACPI_OBJECT_LIST *parameters, ACPI_BUFFER *ret)
1283{
1284    ACPI_HANDLE h;
1285
1286    if (dev == NULL)
1287	h = ACPI_ROOT_OBJECT;
1288    else if ((h = acpi_get_handle(dev)) == NULL)
1289	return (AE_BAD_PARAMETER);
1290    return (AcpiEvaluateObject(h, pathname, parameters, ret));
1291}
1292
1293static int
1294acpi_device_pwr_for_sleep(device_t bus, device_t dev, int *dstate)
1295{
1296    struct acpi_softc *sc;
1297    ACPI_HANDLE handle;
1298    ACPI_STATUS status;
1299    char sxd[8];
1300    int error;
1301
1302    sc = device_get_softc(bus);
1303    handle = acpi_get_handle(dev);
1304
1305    /*
1306     * XXX If we find these devices, don't try to power them down.
1307     * The serial and IRDA ports on my T23 hang the system when
1308     * set to D3 and it appears that such legacy devices may
1309     * need special handling in their drivers.
1310     */
1311    if (handle == NULL ||
1312	acpi_MatchHid(handle, "PNP0500") ||
1313	acpi_MatchHid(handle, "PNP0501") ||
1314	acpi_MatchHid(handle, "PNP0502") ||
1315	acpi_MatchHid(handle, "PNP0510") ||
1316	acpi_MatchHid(handle, "PNP0511"))
1317	return (ENXIO);
1318
1319    /*
1320     * Override next state with the value from _SxD, if present.  If no
1321     * dstate argument was provided, don't fetch the return value.
1322     */
1323    snprintf(sxd, sizeof(sxd), "_S%dD", sc->acpi_sstate);
1324    if (dstate)
1325	status = acpi_GetInteger(handle, sxd, dstate);
1326    else
1327	status = AcpiEvaluateObject(handle, sxd, NULL, NULL);
1328
1329    switch (status) {
1330    case AE_OK:
1331	error = 0;
1332	break;
1333    case AE_NOT_FOUND:
1334	error = ESRCH;
1335	break;
1336    default:
1337	error = ENXIO;
1338	break;
1339    }
1340
1341    return (error);
1342}
1343
1344/* Callback arg for our implementation of walking the namespace. */
1345struct acpi_device_scan_ctx {
1346    acpi_scan_cb_t	user_fn;
1347    void		*arg;
1348    ACPI_HANDLE		parent;
1349};
1350
1351static ACPI_STATUS
1352acpi_device_scan_cb(ACPI_HANDLE h, UINT32 level, void *arg, void **retval)
1353{
1354    struct acpi_device_scan_ctx *ctx;
1355    device_t dev, old_dev;
1356    ACPI_STATUS status;
1357    ACPI_OBJECT_TYPE type;
1358
1359    /*
1360     * Skip this device if we think we'll have trouble with it or it is
1361     * the parent where the scan began.
1362     */
1363    ctx = (struct acpi_device_scan_ctx *)arg;
1364    if (acpi_avoid(h) || h == ctx->parent)
1365	return (AE_OK);
1366
1367    /* If this is not a valid device type (e.g., a method), skip it. */
1368    if (ACPI_FAILURE(AcpiGetType(h, &type)))
1369	return (AE_OK);
1370    if (type != ACPI_TYPE_DEVICE && type != ACPI_TYPE_PROCESSOR &&
1371	type != ACPI_TYPE_THERMAL && type != ACPI_TYPE_POWER)
1372	return (AE_OK);
1373
1374    /*
1375     * Call the user function with the current device.  If it is unchanged
1376     * afterwards, return.  Otherwise, we update the handle to the new dev.
1377     */
1378    old_dev = acpi_get_device(h);
1379    dev = old_dev;
1380    status = ctx->user_fn(h, &dev, level, ctx->arg);
1381    if (ACPI_FAILURE(status) || old_dev == dev)
1382	return (status);
1383
1384    /* Remove the old child and its connection to the handle. */
1385    if (old_dev != NULL) {
1386	device_delete_child(device_get_parent(old_dev), old_dev);
1387	AcpiDetachData(h, acpi_fake_objhandler);
1388    }
1389
1390    /* Recreate the handle association if the user created a device. */
1391    if (dev != NULL)
1392	AcpiAttachData(h, acpi_fake_objhandler, dev);
1393
1394    return (AE_OK);
1395}
1396
1397static ACPI_STATUS
1398acpi_device_scan_children(device_t bus, device_t dev, int max_depth,
1399    acpi_scan_cb_t user_fn, void *arg)
1400{
1401    ACPI_HANDLE h;
1402    struct acpi_device_scan_ctx ctx;
1403
1404    if (acpi_disabled("children"))
1405	return (AE_OK);
1406
1407    if (dev == NULL)
1408	h = ACPI_ROOT_OBJECT;
1409    else if ((h = acpi_get_handle(dev)) == NULL)
1410	return (AE_BAD_PARAMETER);
1411    ctx.user_fn = user_fn;
1412    ctx.arg = arg;
1413    ctx.parent = h;
1414    return (AcpiWalkNamespace(ACPI_TYPE_ANY, h, max_depth,
1415	acpi_device_scan_cb, &ctx, NULL));
1416}
1417
1418/*
1419 * Even though ACPI devices are not PCI, we use the PCI approach for setting
1420 * device power states since it's close enough to ACPI.
1421 */
1422static int
1423acpi_set_powerstate_method(device_t bus, device_t child, int state)
1424{
1425    ACPI_HANDLE h;
1426    ACPI_STATUS status;
1427    int error;
1428
1429    error = 0;
1430    h = acpi_get_handle(child);
1431    if (state < ACPI_STATE_D0 || state > ACPI_STATE_D3)
1432	return (EINVAL);
1433    if (h == NULL)
1434	return (0);
1435
1436    /* Ignore errors if the power methods aren't present. */
1437    status = acpi_pwr_switch_consumer(h, state);
1438    if (ACPI_FAILURE(status) && status != AE_NOT_FOUND
1439	&& status != AE_BAD_PARAMETER)
1440	device_printf(bus, "failed to set ACPI power state D%d on %s: %s\n",
1441	    state, acpi_name(h), AcpiFormatException(status));
1442
1443    return (error);
1444}
1445
1446static int
1447acpi_isa_pnp_probe(device_t bus, device_t child, struct isa_pnp_id *ids)
1448{
1449    int			result, cid_count, i;
1450    uint32_t		lid, cids[8];
1451
1452    ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1453
1454    /*
1455     * ISA-style drivers attached to ACPI may persist and
1456     * probe manually if we return ENOENT.  We never want
1457     * that to happen, so don't ever return it.
1458     */
1459    result = ENXIO;
1460
1461    /* Scan the supplied IDs for a match */
1462    lid = acpi_isa_get_logicalid(child);
1463    cid_count = acpi_isa_get_compatid(child, cids, 8);
1464    while (ids && ids->ip_id) {
1465	if (lid == ids->ip_id) {
1466	    result = 0;
1467	    goto out;
1468	}
1469	for (i = 0; i < cid_count; i++) {
1470	    if (cids[i] == ids->ip_id) {
1471		result = 0;
1472		goto out;
1473	    }
1474	}
1475	ids++;
1476    }
1477
1478 out:
1479    if (result == 0 && ids->ip_desc)
1480	device_set_desc(child, ids->ip_desc);
1481
1482    return_VALUE (result);
1483}
1484
1485#if defined(__i386__) || defined(__amd64__)
1486/*
1487 * Look for a MCFG table.  If it is present, use the settings for
1488 * domain (segment) 0 to setup PCI config space access via the memory
1489 * map.
1490 */
1491static void
1492acpi_enable_pcie(void)
1493{
1494	ACPI_TABLE_HEADER *hdr;
1495	ACPI_MCFG_ALLOCATION *alloc, *end;
1496	ACPI_STATUS status;
1497
1498	status = AcpiGetTable(ACPI_SIG_MCFG, 1, &hdr);
1499	if (ACPI_FAILURE(status))
1500		return;
1501
1502	end = (ACPI_MCFG_ALLOCATION *)((char *)hdr + hdr->Length);
1503	alloc = (ACPI_MCFG_ALLOCATION *)((ACPI_TABLE_MCFG *)hdr + 1);
1504	while (alloc < end) {
1505		if (alloc->PciSegment == 0) {
1506			pcie_cfgregopen(alloc->Address, alloc->StartBusNumber,
1507			    alloc->EndBusNumber);
1508			return;
1509		}
1510		alloc++;
1511	}
1512}
1513#endif
1514
1515/*
1516 * Scan all of the ACPI namespace and attach child devices.
1517 *
1518 * We should only expect to find devices in the \_PR, \_TZ, \_SI, and
1519 * \_SB scopes, and \_PR and \_TZ became obsolete in the ACPI 2.0 spec.
1520 * However, in violation of the spec, some systems place their PCI link
1521 * devices in \, so we have to walk the whole namespace.  We check the
1522 * type of namespace nodes, so this should be ok.
1523 */
1524static void
1525acpi_probe_children(device_t bus)
1526{
1527
1528    ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1529
1530    /*
1531     * Scan the namespace and insert placeholders for all the devices that
1532     * we find.  We also probe/attach any early devices.
1533     *
1534     * Note that we use AcpiWalkNamespace rather than AcpiGetDevices because
1535     * we want to create nodes for all devices, not just those that are
1536     * currently present. (This assumes that we don't want to create/remove
1537     * devices as they appear, which might be smarter.)
1538     */
1539    ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "namespace scan\n"));
1540    AcpiWalkNamespace(ACPI_TYPE_ANY, ACPI_ROOT_OBJECT, 100, acpi_probe_child,
1541	bus, NULL);
1542
1543    /* Pre-allocate resources for our rman from any sysresource devices. */
1544    acpi_sysres_alloc(bus);
1545
1546    /* Create any static children by calling device identify methods. */
1547    ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "device identify routines\n"));
1548    bus_generic_probe(bus);
1549
1550    /* Probe/attach all children, created staticly and from the namespace. */
1551    ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "first bus_generic_attach\n"));
1552    bus_generic_attach(bus);
1553
1554    /*
1555     * Some of these children may have attached others as part of their attach
1556     * process (eg. the root PCI bus driver), so rescan.
1557     */
1558    ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "second bus_generic_attach\n"));
1559    bus_generic_attach(bus);
1560
1561    /* Attach wake sysctls. */
1562    acpi_wake_sysctl_walk(bus);
1563
1564    ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "done attaching children\n"));
1565    return_VOID;
1566}
1567
1568/*
1569 * Determine the probe order for a given device.
1570 */
1571static void
1572acpi_probe_order(ACPI_HANDLE handle, int *order)
1573{
1574    ACPI_OBJECT_TYPE type;
1575
1576    /*
1577     * 1. I/O port and memory system resource holders
1578     * 2. Embedded controllers (to handle early accesses)
1579     * 3. PCI Link Devices
1580     * 100000. CPUs
1581     */
1582    AcpiGetType(handle, &type);
1583    if (acpi_MatchHid(handle, "PNP0C01") || acpi_MatchHid(handle, "PNP0C02"))
1584	*order = 1;
1585    else if (acpi_MatchHid(handle, "PNP0C09"))
1586	*order = 2;
1587    else if (acpi_MatchHid(handle, "PNP0C0F"))
1588	*order = 3;
1589    else if (type == ACPI_TYPE_PROCESSOR)
1590	*order = 100000;
1591}
1592
1593/*
1594 * Evaluate a child device and determine whether we might attach a device to
1595 * it.
1596 */
1597static ACPI_STATUS
1598acpi_probe_child(ACPI_HANDLE handle, UINT32 level, void *context, void **status)
1599{
1600    ACPI_OBJECT_TYPE type;
1601    ACPI_HANDLE h;
1602    device_t bus, child;
1603    int order;
1604    char *handle_str, **search;
1605    static char *scopes[] = {"\\_PR_", "\\_TZ_", "\\_SI_", "\\_SB_", NULL};
1606
1607    ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1608
1609    /* Skip this device if we think we'll have trouble with it. */
1610    if (acpi_avoid(handle))
1611	return_ACPI_STATUS (AE_OK);
1612
1613    bus = (device_t)context;
1614    if (ACPI_SUCCESS(AcpiGetType(handle, &type))) {
1615	switch (type) {
1616	case ACPI_TYPE_DEVICE:
1617	case ACPI_TYPE_PROCESSOR:
1618	case ACPI_TYPE_THERMAL:
1619	case ACPI_TYPE_POWER:
1620	    if (acpi_disabled("children"))
1621		break;
1622
1623	    /*
1624	     * Since we scan from \, be sure to skip system scope objects.
1625	     * At least \_SB and \_TZ are detected as devices (ACPI-CA bug?)
1626	     */
1627	    handle_str = acpi_name(handle);
1628	    for (search = scopes; *search != NULL; search++) {
1629		if (strcmp(handle_str, *search) == 0)
1630		    break;
1631	    }
1632	    if (*search != NULL)
1633		break;
1634
1635	    /*
1636	     * Create a placeholder device for this node.  Sort the
1637	     * placeholder so that the probe/attach passes will run
1638	     * breadth-first.  Orders less than ACPI_DEV_BASE_ORDER
1639	     * are reserved for special objects (i.e., system
1640	     * resources).  CPU devices have a very high order to
1641	     * ensure they are probed after other devices.
1642	     */
1643	    ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "scanning '%s'\n", handle_str));
1644	    order = level * 10 + 100;
1645	    acpi_probe_order(handle, &order);
1646	    child = BUS_ADD_CHILD(bus, order, NULL, -1);
1647	    if (child == NULL)
1648		break;
1649
1650	    /* Associate the handle with the device_t and vice versa. */
1651	    acpi_set_handle(child, handle);
1652	    AcpiAttachData(handle, acpi_fake_objhandler, child);
1653
1654	    /*
1655	     * Check that the device is present.  If it's not present,
1656	     * leave it disabled (so that we have a device_t attached to
1657	     * the handle, but we don't probe it).
1658	     *
1659	     * XXX PCI link devices sometimes report "present" but not
1660	     * "functional" (i.e. if disabled).  Go ahead and probe them
1661	     * anyway since we may enable them later.
1662	     */
1663	    if (type == ACPI_TYPE_DEVICE && !acpi_DeviceIsPresent(child)) {
1664		/* Never disable PCI link devices. */
1665		if (acpi_MatchHid(handle, "PNP0C0F"))
1666		    break;
1667		/*
1668		 * Docking stations should remain enabled since the system
1669		 * may be undocked at boot.
1670		 */
1671		if (ACPI_SUCCESS(AcpiGetHandle(handle, "_DCK", &h)))
1672		    break;
1673
1674		device_disable(child);
1675		break;
1676	    }
1677
1678	    /*
1679	     * Get the device's resource settings and attach them.
1680	     * Note that if the device has _PRS but no _CRS, we need
1681	     * to decide when it's appropriate to try to configure the
1682	     * device.  Ignore the return value here; it's OK for the
1683	     * device not to have any resources.
1684	     */
1685	    acpi_parse_resources(child, handle, &acpi_res_parse_set, NULL);
1686	    break;
1687	}
1688    }
1689
1690    return_ACPI_STATUS (AE_OK);
1691}
1692
1693/*
1694 * AcpiAttachData() requires an object handler but never uses it.  This is a
1695 * placeholder object handler so we can store a device_t in an ACPI_HANDLE.
1696 */
1697void
1698acpi_fake_objhandler(ACPI_HANDLE h, UINT32 fn, void *data)
1699{
1700}
1701
1702static void
1703acpi_shutdown_final(void *arg, int howto)
1704{
1705    struct acpi_softc *sc;
1706    ACPI_STATUS status;
1707
1708    /*
1709     * XXX Shutdown code should only run on the BSP (cpuid 0).
1710     * Some chipsets do not power off the system correctly if called from
1711     * an AP.
1712     */
1713    sc = arg;
1714    if ((howto & RB_POWEROFF) != 0) {
1715	status = AcpiEnterSleepStatePrep(ACPI_STATE_S5);
1716	if (ACPI_FAILURE(status)) {
1717	    printf("AcpiEnterSleepStatePrep failed - %s\n",
1718		   AcpiFormatException(status));
1719	    return;
1720	}
1721	printf("Powering system off using ACPI\n");
1722	ACPI_DISABLE_IRQS();
1723	status = AcpiEnterSleepState(ACPI_STATE_S5);
1724	if (ACPI_FAILURE(status)) {
1725	    printf("ACPI power-off failed - %s\n", AcpiFormatException(status));
1726	} else {
1727	    DELAY(1000000);
1728	    printf("ACPI power-off failed - timeout\n");
1729	}
1730    } else if ((howto & RB_HALT) == 0 &&
1731	(AcpiGbl_FADT.Flags & ACPI_FADT_RESET_REGISTER) &&
1732	sc->acpi_handle_reboot) {
1733	/* Reboot using the reset register. */
1734	status = AcpiHwLowLevelWrite(
1735	    AcpiGbl_FADT.ResetRegister.BitWidth,
1736	    AcpiGbl_FADT.ResetValue, &AcpiGbl_FADT.ResetRegister);
1737	if (ACPI_FAILURE(status)) {
1738	    printf("ACPI reset failed - %s\n", AcpiFormatException(status));
1739	} else {
1740	    DELAY(1000000);
1741	    printf("ACPI reset failed - timeout\n");
1742	}
1743    } else if (sc->acpi_do_disable && panicstr == NULL) {
1744	/*
1745	 * Only disable ACPI if the user requested.  On some systems, writing
1746	 * the disable value to SMI_CMD hangs the system.
1747	 */
1748	printf("Shutting down ACPI\n");
1749	AcpiTerminate();
1750    }
1751}
1752
1753static void
1754acpi_enable_fixed_events(struct acpi_softc *sc)
1755{
1756    static int	first_time = 1;
1757
1758    /* Enable and clear fixed events and install handlers. */
1759    if ((AcpiGbl_FADT.Flags & ACPI_FADT_POWER_BUTTON) == 0) {
1760	AcpiClearEvent(ACPI_EVENT_POWER_BUTTON);
1761	AcpiInstallFixedEventHandler(ACPI_EVENT_POWER_BUTTON,
1762				     acpi_event_power_button_sleep, sc);
1763	if (first_time)
1764	    device_printf(sc->acpi_dev, "Power Button (fixed)\n");
1765    }
1766    if ((AcpiGbl_FADT.Flags & ACPI_FADT_SLEEP_BUTTON) == 0) {
1767	AcpiClearEvent(ACPI_EVENT_SLEEP_BUTTON);
1768	AcpiInstallFixedEventHandler(ACPI_EVENT_SLEEP_BUTTON,
1769				     acpi_event_sleep_button_sleep, sc);
1770	if (first_time)
1771	    device_printf(sc->acpi_dev, "Sleep Button (fixed)\n");
1772    }
1773
1774    first_time = 0;
1775}
1776
1777/*
1778 * Returns true if the device is actually present and should
1779 * be attached to.  This requires the present, enabled, UI-visible
1780 * and diagnostics-passed bits to be set.
1781 */
1782BOOLEAN
1783acpi_DeviceIsPresent(device_t dev)
1784{
1785    ACPI_DEVICE_INFO	*devinfo;
1786    ACPI_HANDLE		h;
1787    ACPI_BUFFER		buf;
1788    ACPI_STATUS		error;
1789    int			ret;
1790
1791    ret = FALSE;
1792    if ((h = acpi_get_handle(dev)) == NULL)
1793	return (FALSE);
1794    buf.Pointer = NULL;
1795    buf.Length = ACPI_ALLOCATE_BUFFER;
1796    error = AcpiGetObjectInfo(h, &buf);
1797    if (ACPI_FAILURE(error))
1798	return (FALSE);
1799    devinfo = (ACPI_DEVICE_INFO *)buf.Pointer;
1800
1801    /* If no _STA method, must be present */
1802    if ((devinfo->Valid & ACPI_VALID_STA) == 0)
1803	ret = TRUE;
1804
1805    /* Return true for 'present' and 'functioning' */
1806    if (ACPI_DEVICE_PRESENT(devinfo->CurrentStatus))
1807	ret = TRUE;
1808
1809    AcpiOsFree(buf.Pointer);
1810    return (ret);
1811}
1812
1813/*
1814 * Returns true if the battery is actually present and inserted.
1815 */
1816BOOLEAN
1817acpi_BatteryIsPresent(device_t dev)
1818{
1819    ACPI_DEVICE_INFO	*devinfo;
1820    ACPI_HANDLE		h;
1821    ACPI_BUFFER		buf;
1822    ACPI_STATUS		error;
1823    int			ret;
1824
1825    ret = FALSE;
1826    if ((h = acpi_get_handle(dev)) == NULL)
1827	return (FALSE);
1828    buf.Pointer = NULL;
1829    buf.Length = ACPI_ALLOCATE_BUFFER;
1830    error = AcpiGetObjectInfo(h, &buf);
1831    if (ACPI_FAILURE(error))
1832	return (FALSE);
1833    devinfo = (ACPI_DEVICE_INFO *)buf.Pointer;
1834
1835    /* If no _STA method, must be present */
1836    if ((devinfo->Valid & ACPI_VALID_STA) == 0)
1837	ret = TRUE;
1838
1839    /* Return true for 'present', 'battery present', and 'functioning' */
1840    if (ACPI_BATTERY_PRESENT(devinfo->CurrentStatus))
1841	ret = TRUE;
1842
1843    AcpiOsFree(buf.Pointer);
1844    return (ret);
1845}
1846
1847/*
1848 * Match a HID string against a handle
1849 */
1850static BOOLEAN
1851acpi_MatchHid(ACPI_HANDLE h, const char *hid)
1852{
1853    ACPI_DEVICE_INFO	*devinfo;
1854    ACPI_BUFFER		buf;
1855    ACPI_STATUS		error;
1856    int			ret, i;
1857
1858    ret = FALSE;
1859    if (hid == NULL || h == NULL)
1860	return (ret);
1861    buf.Pointer = NULL;
1862    buf.Length = ACPI_ALLOCATE_BUFFER;
1863    error = AcpiGetObjectInfo(h, &buf);
1864    if (ACPI_FAILURE(error))
1865	return (ret);
1866    devinfo = (ACPI_DEVICE_INFO *)buf.Pointer;
1867
1868    if ((devinfo->Valid & ACPI_VALID_HID) != 0 &&
1869	strcmp(hid, devinfo->HardwareId.Value) == 0)
1870	    ret = TRUE;
1871    else if ((devinfo->Valid & ACPI_VALID_CID) != 0) {
1872	for (i = 0; i < devinfo->CompatibilityId.Count; i++) {
1873	    if (strcmp(hid, devinfo->CompatibilityId.Id[i].Value) == 0) {
1874		ret = TRUE;
1875		break;
1876	    }
1877	}
1878    }
1879
1880    AcpiOsFree(buf.Pointer);
1881    return (ret);
1882}
1883
1884/*
1885 * Return the handle of a named object within our scope, ie. that of (parent)
1886 * or one if its parents.
1887 */
1888ACPI_STATUS
1889acpi_GetHandleInScope(ACPI_HANDLE parent, char *path, ACPI_HANDLE *result)
1890{
1891    ACPI_HANDLE		r;
1892    ACPI_STATUS		status;
1893
1894    /* Walk back up the tree to the root */
1895    for (;;) {
1896	status = AcpiGetHandle(parent, path, &r);
1897	if (ACPI_SUCCESS(status)) {
1898	    *result = r;
1899	    return (AE_OK);
1900	}
1901	/* XXX Return error here? */
1902	if (status != AE_NOT_FOUND)
1903	    return (AE_OK);
1904	if (ACPI_FAILURE(AcpiGetParent(parent, &r)))
1905	    return (AE_NOT_FOUND);
1906	parent = r;
1907    }
1908}
1909
1910/* Find the difference between two PM tick counts. */
1911uint32_t
1912acpi_TimerDelta(uint32_t end, uint32_t start)
1913{
1914    uint32_t delta;
1915
1916    if (end >= start)
1917	delta = end - start;
1918    else if (AcpiGbl_FADT.Flags & ACPI_FADT_32BIT_TIMER)
1919	delta = ((0xFFFFFFFF - start) + end + 1);
1920    else
1921	delta = ((0x00FFFFFF - start) + end + 1) & 0x00FFFFFF;
1922    return (delta);
1923}
1924
1925/*
1926 * Allocate a buffer with a preset data size.
1927 */
1928ACPI_BUFFER *
1929acpi_AllocBuffer(int size)
1930{
1931    ACPI_BUFFER	*buf;
1932
1933    if ((buf = malloc(size + sizeof(*buf), M_ACPIDEV, M_NOWAIT)) == NULL)
1934	return (NULL);
1935    buf->Length = size;
1936    buf->Pointer = (void *)(buf + 1);
1937    return (buf);
1938}
1939
1940ACPI_STATUS
1941acpi_SetInteger(ACPI_HANDLE handle, char *path, UINT32 number)
1942{
1943    ACPI_OBJECT arg1;
1944    ACPI_OBJECT_LIST args;
1945
1946    arg1.Type = ACPI_TYPE_INTEGER;
1947    arg1.Integer.Value = number;
1948    args.Count = 1;
1949    args.Pointer = &arg1;
1950
1951    return (AcpiEvaluateObject(handle, path, &args, NULL));
1952}
1953
1954/*
1955 * Evaluate a path that should return an integer.
1956 */
1957ACPI_STATUS
1958acpi_GetInteger(ACPI_HANDLE handle, char *path, UINT32 *number)
1959{
1960    ACPI_STATUS	status;
1961    ACPI_BUFFER	buf;
1962    ACPI_OBJECT	param;
1963
1964    if (handle == NULL)
1965	handle = ACPI_ROOT_OBJECT;
1966
1967    /*
1968     * Assume that what we've been pointed at is an Integer object, or
1969     * a method that will return an Integer.
1970     */
1971    buf.Pointer = &param;
1972    buf.Length = sizeof(param);
1973    status = AcpiEvaluateObject(handle, path, NULL, &buf);
1974    if (ACPI_SUCCESS(status)) {
1975	if (param.Type == ACPI_TYPE_INTEGER)
1976	    *number = param.Integer.Value;
1977	else
1978	    status = AE_TYPE;
1979    }
1980
1981    /*
1982     * In some applications, a method that's expected to return an Integer
1983     * may instead return a Buffer (probably to simplify some internal
1984     * arithmetic).  We'll try to fetch whatever it is, and if it's a Buffer,
1985     * convert it into an Integer as best we can.
1986     *
1987     * This is a hack.
1988     */
1989    if (status == AE_BUFFER_OVERFLOW) {
1990	if ((buf.Pointer = AcpiOsAllocate(buf.Length)) == NULL) {
1991	    status = AE_NO_MEMORY;
1992	} else {
1993	    status = AcpiEvaluateObject(handle, path, NULL, &buf);
1994	    if (ACPI_SUCCESS(status))
1995		status = acpi_ConvertBufferToInteger(&buf, number);
1996	    AcpiOsFree(buf.Pointer);
1997	}
1998    }
1999    return (status);
2000}
2001
2002ACPI_STATUS
2003acpi_ConvertBufferToInteger(ACPI_BUFFER *bufp, UINT32 *number)
2004{
2005    ACPI_OBJECT	*p;
2006    UINT8	*val;
2007    int		i;
2008
2009    p = (ACPI_OBJECT *)bufp->Pointer;
2010    if (p->Type == ACPI_TYPE_INTEGER) {
2011	*number = p->Integer.Value;
2012	return (AE_OK);
2013    }
2014    if (p->Type != ACPI_TYPE_BUFFER)
2015	return (AE_TYPE);
2016    if (p->Buffer.Length > sizeof(int))
2017	return (AE_BAD_DATA);
2018
2019    *number = 0;
2020    val = p->Buffer.Pointer;
2021    for (i = 0; i < p->Buffer.Length; i++)
2022	*number += val[i] << (i * 8);
2023    return (AE_OK);
2024}
2025
2026/*
2027 * Iterate over the elements of an a package object, calling the supplied
2028 * function for each element.
2029 *
2030 * XXX possible enhancement might be to abort traversal on error.
2031 */
2032ACPI_STATUS
2033acpi_ForeachPackageObject(ACPI_OBJECT *pkg,
2034	void (*func)(ACPI_OBJECT *comp, void *arg), void *arg)
2035{
2036    ACPI_OBJECT	*comp;
2037    int		i;
2038
2039    if (pkg == NULL || pkg->Type != ACPI_TYPE_PACKAGE)
2040	return (AE_BAD_PARAMETER);
2041
2042    /* Iterate over components */
2043    i = 0;
2044    comp = pkg->Package.Elements;
2045    for (; i < pkg->Package.Count; i++, comp++)
2046	func(comp, arg);
2047
2048    return (AE_OK);
2049}
2050
2051/*
2052 * Find the (index)th resource object in a set.
2053 */
2054ACPI_STATUS
2055acpi_FindIndexedResource(ACPI_BUFFER *buf, int index, ACPI_RESOURCE **resp)
2056{
2057    ACPI_RESOURCE	*rp;
2058    int			i;
2059
2060    rp = (ACPI_RESOURCE *)buf->Pointer;
2061    i = index;
2062    while (i-- > 0) {
2063	/* Range check */
2064	if (rp > (ACPI_RESOURCE *)((u_int8_t *)buf->Pointer + buf->Length))
2065	    return (AE_BAD_PARAMETER);
2066
2067	/* Check for terminator */
2068	if (rp->Type == ACPI_RESOURCE_TYPE_END_TAG || rp->Length == 0)
2069	    return (AE_NOT_FOUND);
2070	rp = ACPI_NEXT_RESOURCE(rp);
2071    }
2072    if (resp != NULL)
2073	*resp = rp;
2074
2075    return (AE_OK);
2076}
2077
2078/*
2079 * Append an ACPI_RESOURCE to an ACPI_BUFFER.
2080 *
2081 * Given a pointer to an ACPI_RESOURCE structure, expand the ACPI_BUFFER
2082 * provided to contain it.  If the ACPI_BUFFER is empty, allocate a sensible
2083 * backing block.  If the ACPI_RESOURCE is NULL, return an empty set of
2084 * resources.
2085 */
2086#define ACPI_INITIAL_RESOURCE_BUFFER_SIZE	512
2087
2088ACPI_STATUS
2089acpi_AppendBufferResource(ACPI_BUFFER *buf, ACPI_RESOURCE *res)
2090{
2091    ACPI_RESOURCE	*rp;
2092    void		*newp;
2093
2094    /* Initialise the buffer if necessary. */
2095    if (buf->Pointer == NULL) {
2096	buf->Length = ACPI_INITIAL_RESOURCE_BUFFER_SIZE;
2097	if ((buf->Pointer = AcpiOsAllocate(buf->Length)) == NULL)
2098	    return (AE_NO_MEMORY);
2099	rp = (ACPI_RESOURCE *)buf->Pointer;
2100	rp->Type = ACPI_RESOURCE_TYPE_END_TAG;
2101	rp->Length = 0;
2102    }
2103    if (res == NULL)
2104	return (AE_OK);
2105
2106    /*
2107     * Scan the current buffer looking for the terminator.
2108     * This will either find the terminator or hit the end
2109     * of the buffer and return an error.
2110     */
2111    rp = (ACPI_RESOURCE *)buf->Pointer;
2112    for (;;) {
2113	/* Range check, don't go outside the buffer */
2114	if (rp >= (ACPI_RESOURCE *)((u_int8_t *)buf->Pointer + buf->Length))
2115	    return (AE_BAD_PARAMETER);
2116	if (rp->Type == ACPI_RESOURCE_TYPE_END_TAG || rp->Length == 0)
2117	    break;
2118	rp = ACPI_NEXT_RESOURCE(rp);
2119    }
2120
2121    /*
2122     * Check the size of the buffer and expand if required.
2123     *
2124     * Required size is:
2125     *	size of existing resources before terminator +
2126     *	size of new resource and header +
2127     * 	size of terminator.
2128     *
2129     * Note that this loop should really only run once, unless
2130     * for some reason we are stuffing a *really* huge resource.
2131     */
2132    while ((((u_int8_t *)rp - (u_int8_t *)buf->Pointer) +
2133	    res->Length + ACPI_RS_SIZE_NO_DATA +
2134	    ACPI_RS_SIZE_MIN) >= buf->Length) {
2135	if ((newp = AcpiOsAllocate(buf->Length * 2)) == NULL)
2136	    return (AE_NO_MEMORY);
2137	bcopy(buf->Pointer, newp, buf->Length);
2138	rp = (ACPI_RESOURCE *)((u_int8_t *)newp +
2139			       ((u_int8_t *)rp - (u_int8_t *)buf->Pointer));
2140	AcpiOsFree(buf->Pointer);
2141	buf->Pointer = newp;
2142	buf->Length += buf->Length;
2143    }
2144
2145    /* Insert the new resource. */
2146    bcopy(res, rp, res->Length + ACPI_RS_SIZE_NO_DATA);
2147
2148    /* And add the terminator. */
2149    rp = ACPI_NEXT_RESOURCE(rp);
2150    rp->Type = ACPI_RESOURCE_TYPE_END_TAG;
2151    rp->Length = 0;
2152
2153    return (AE_OK);
2154}
2155
2156/*
2157 * Set interrupt model.
2158 */
2159ACPI_STATUS
2160acpi_SetIntrModel(int model)
2161{
2162
2163    return (acpi_SetInteger(ACPI_ROOT_OBJECT, "_PIC", model));
2164}
2165
2166/*
2167 * DEPRECATED.  This interface has serious deficiencies and will be
2168 * removed.
2169 *
2170 * Immediately enter the sleep state.  In the old model, acpiconf(8) ran
2171 * rc.suspend and rc.resume so we don't have to notify devd(8) to do this.
2172 */
2173ACPI_STATUS
2174acpi_SetSleepState(struct acpi_softc *sc, int state)
2175{
2176    static int once;
2177
2178    if (!once) {
2179	printf(
2180"warning: acpi_SetSleepState() deprecated, need to update your software\n");
2181	once = 1;
2182    }
2183    return (acpi_EnterSleepState(sc, state));
2184}
2185
2186static void
2187acpi_sleep_force(void *arg)
2188{
2189    struct acpi_softc *sc;
2190
2191    printf("acpi: suspend request timed out, forcing sleep now\n");
2192    sc = arg;
2193    if (ACPI_FAILURE(acpi_EnterSleepState(sc, sc->acpi_next_sstate)))
2194	printf("acpi: force sleep state S%d failed\n", sc->acpi_next_sstate);
2195}
2196
2197/*
2198 * Request that the system enter the given suspend state.  All /dev/apm
2199 * devices and devd(8) will be notified.  Userland then has a chance to
2200 * save state and acknowledge the request.  The system sleeps once all
2201 * acks are in.
2202 */
2203int
2204acpi_ReqSleepState(struct acpi_softc *sc, int state)
2205{
2206    struct apm_clone_data *clone;
2207
2208    if (state < ACPI_STATE_S1 || state > ACPI_STATE_S5)
2209	return (EINVAL);
2210
2211    /* S5 (soft-off) should be entered directly with no waiting. */
2212    if (state == ACPI_STATE_S5) {
2213	if (ACPI_SUCCESS(acpi_EnterSleepState(sc, state)))
2214	    return (0);
2215	else
2216	    return (ENXIO);
2217    }
2218
2219#if !defined(__i386__)
2220    /* This platform does not support acpi suspend/resume. */
2221    return (EOPNOTSUPP);
2222#endif
2223
2224    /* If a suspend request is already in progress, just return. */
2225    ACPI_LOCK(acpi);
2226    if (sc->acpi_next_sstate != 0) {
2227    	ACPI_UNLOCK(acpi);
2228	return (0);
2229    }
2230
2231    /* Record the pending state and notify all apm devices. */
2232    sc->acpi_next_sstate = state;
2233    STAILQ_FOREACH(clone, &sc->apm_cdevs, entries) {
2234	clone->notify_status = APM_EV_NONE;
2235	if ((clone->flags & ACPI_EVF_DEVD) == 0) {
2236	    selwakeuppri(&clone->sel_read, PZERO);
2237	    KNOTE_UNLOCKED(&clone->sel_read.si_note, 0);
2238	}
2239    }
2240
2241    /* If devd(8) is not running, immediately enter the sleep state. */
2242    if (devctl_process_running() == FALSE) {
2243	ACPI_UNLOCK(acpi);
2244	if (ACPI_SUCCESS(acpi_EnterSleepState(sc, sc->acpi_next_sstate))) {
2245	    return (0);
2246	} else {
2247	    return (ENXIO);
2248	}
2249    }
2250
2251    /* Now notify devd(8) also. */
2252    acpi_UserNotify("Suspend", ACPI_ROOT_OBJECT, state);
2253
2254    /*
2255     * Set a timeout to fire if userland doesn't ack the suspend request
2256     * in time.  This way we still eventually go to sleep if we were
2257     * overheating or running low on battery, even if userland is hung.
2258     * We cancel this timeout once all userland acks are in or the
2259     * suspend request is aborted.
2260     */
2261    callout_reset(&sc->susp_force_to, 10 * hz, acpi_sleep_force, sc);
2262    ACPI_UNLOCK(acpi);
2263    return (0);
2264}
2265
2266/*
2267 * Acknowledge (or reject) a pending sleep state.  The caller has
2268 * prepared for suspend and is now ready for it to proceed.  If the
2269 * error argument is non-zero, it indicates suspend should be cancelled
2270 * and gives an errno value describing why.  Once all votes are in,
2271 * we suspend the system.
2272 */
2273int
2274acpi_AckSleepState(struct apm_clone_data *clone, int error)
2275{
2276    struct acpi_softc *sc;
2277    int ret, sleeping;
2278
2279#if !defined(__i386__)
2280    /* This platform does not support acpi suspend/resume. */
2281    return (EOPNOTSUPP);
2282#endif
2283
2284    /* If no pending sleep state, return an error. */
2285    ACPI_LOCK(acpi);
2286    sc = clone->acpi_sc;
2287    if (sc->acpi_next_sstate == 0) {
2288    	ACPI_UNLOCK(acpi);
2289	return (ENXIO);
2290    }
2291
2292    /* Caller wants to abort suspend process. */
2293    if (error) {
2294	sc->acpi_next_sstate = 0;
2295	callout_stop(&sc->susp_force_to);
2296	printf("acpi: listener on %s cancelled the pending suspend\n",
2297	    devtoname(clone->cdev));
2298    	ACPI_UNLOCK(acpi);
2299	return (0);
2300    }
2301
2302    /*
2303     * Mark this device as acking the suspend request.  Then, walk through
2304     * all devices, seeing if they agree yet.  We only count devices that
2305     * are writable since read-only devices couldn't ack the request.
2306     */
2307    clone->notify_status = APM_EV_ACKED;
2308    sleeping = TRUE;
2309    STAILQ_FOREACH(clone, &sc->apm_cdevs, entries) {
2310	if ((clone->flags & ACPI_EVF_WRITE) != 0 &&
2311	    clone->notify_status != APM_EV_ACKED) {
2312	    sleeping = FALSE;
2313	    break;
2314	}
2315    }
2316
2317    /* If all devices have voted "yes", we will suspend now. */
2318    if (sleeping)
2319	callout_stop(&sc->susp_force_to);
2320    ACPI_UNLOCK(acpi);
2321    ret = 0;
2322    if (sleeping) {
2323	if (ACPI_FAILURE(acpi_EnterSleepState(sc, sc->acpi_next_sstate)))
2324		ret = ENODEV;
2325    }
2326
2327    return (ret);
2328}
2329
2330static void
2331acpi_sleep_enable(void *arg)
2332{
2333
2334    ((struct acpi_softc *)arg)->acpi_sleep_disabled = 0;
2335}
2336
2337enum acpi_sleep_state {
2338    ACPI_SS_NONE,
2339    ACPI_SS_GPE_SET,
2340    ACPI_SS_DEV_SUSPEND,
2341    ACPI_SS_SLP_PREP,
2342    ACPI_SS_SLEPT,
2343};
2344
2345/*
2346 * Enter the desired system sleep state.
2347 *
2348 * Currently we support S1-S5 but S4 is only S4BIOS
2349 */
2350static ACPI_STATUS
2351acpi_EnterSleepState(struct acpi_softc *sc, int state)
2352{
2353    ACPI_STATUS	status;
2354    UINT8	TypeA;
2355    UINT8	TypeB;
2356    enum acpi_sleep_state slp_state;
2357
2358    ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, state);
2359
2360    /* Re-entry once we're suspending is not allowed. */
2361    status = AE_OK;
2362    ACPI_LOCK(acpi);
2363    if (sc->acpi_sleep_disabled) {
2364	ACPI_UNLOCK(acpi);
2365	printf("acpi: suspend request ignored (not ready yet)\n");
2366	return (AE_ERROR);
2367    }
2368    sc->acpi_sleep_disabled = 1;
2369    ACPI_UNLOCK(acpi);
2370
2371    /*
2372     * Be sure to hold Giant across DEVICE_SUSPEND/RESUME since non-MPSAFE
2373     * drivers need this.
2374     */
2375    mtx_lock(&Giant);
2376    slp_state = ACPI_SS_NONE;
2377    switch (state) {
2378    case ACPI_STATE_S1:
2379    case ACPI_STATE_S2:
2380    case ACPI_STATE_S3:
2381    case ACPI_STATE_S4:
2382	status = AcpiGetSleepTypeData(state, &TypeA, &TypeB);
2383	if (status == AE_NOT_FOUND) {
2384	    device_printf(sc->acpi_dev,
2385			  "Sleep state S%d not supported by BIOS\n", state);
2386	    break;
2387	} else if (ACPI_FAILURE(status)) {
2388	    device_printf(sc->acpi_dev, "AcpiGetSleepTypeData failed - %s\n",
2389			  AcpiFormatException(status));
2390	    break;
2391	}
2392
2393	sc->acpi_sstate = state;
2394
2395	/* Enable any GPEs as appropriate and requested by the user. */
2396	acpi_wake_prep_walk(state);
2397	slp_state = ACPI_SS_GPE_SET;
2398
2399	/*
2400	 * Inform all devices that we are going to sleep.  If at least one
2401	 * device fails, DEVICE_SUSPEND() automatically resumes the tree.
2402	 *
2403	 * XXX Note that a better two-pass approach with a 'veto' pass
2404	 * followed by a "real thing" pass would be better, but the current
2405	 * bus interface does not provide for this.
2406	 */
2407	if (DEVICE_SUSPEND(root_bus) != 0) {
2408	    device_printf(sc->acpi_dev, "device_suspend failed\n");
2409	    break;
2410	}
2411	slp_state = ACPI_SS_DEV_SUSPEND;
2412
2413	/* If testing device suspend only, back out of everything here. */
2414	if (acpi_susp_bounce)
2415	    break;
2416
2417	status = AcpiEnterSleepStatePrep(state);
2418	if (ACPI_FAILURE(status)) {
2419	    device_printf(sc->acpi_dev, "AcpiEnterSleepStatePrep failed - %s\n",
2420			  AcpiFormatException(status));
2421	    break;
2422	}
2423	slp_state = ACPI_SS_SLP_PREP;
2424
2425	if (sc->acpi_sleep_delay > 0)
2426	    DELAY(sc->acpi_sleep_delay * 1000000);
2427
2428	if (state != ACPI_STATE_S1) {
2429	    acpi_sleep_machdep(sc, state);
2430
2431	    /* Re-enable ACPI hardware on wakeup from sleep state 4. */
2432	    if (state == ACPI_STATE_S4)
2433		AcpiEnable();
2434	} else {
2435	    ACPI_DISABLE_IRQS();
2436	    status = AcpiEnterSleepState(state);
2437	    if (ACPI_FAILURE(status)) {
2438		device_printf(sc->acpi_dev, "AcpiEnterSleepState failed - %s\n",
2439			      AcpiFormatException(status));
2440		break;
2441	    }
2442	}
2443	slp_state = ACPI_SS_SLEPT;
2444	break;
2445    case ACPI_STATE_S5:
2446	/*
2447	 * Shut down cleanly and power off.  This will call us back through the
2448	 * shutdown handlers.
2449	 */
2450	shutdown_nice(RB_POWEROFF);
2451	break;
2452    case ACPI_STATE_S0:
2453    default:
2454	status = AE_BAD_PARAMETER;
2455	break;
2456    }
2457
2458    /*
2459     * Back out state according to how far along we got in the suspend
2460     * process.  This handles both the error and success cases.
2461     */
2462    sc->acpi_next_sstate = 0;
2463    if (slp_state >= ACPI_SS_GPE_SET) {
2464	acpi_wake_prep_walk(state);
2465	sc->acpi_sstate = ACPI_STATE_S0;
2466    }
2467    if (slp_state >= ACPI_SS_SLP_PREP)
2468	AcpiLeaveSleepState(state);
2469    if (slp_state >= ACPI_SS_DEV_SUSPEND)
2470	DEVICE_RESUME(root_bus);
2471    if (slp_state >= ACPI_SS_SLEPT)
2472	acpi_enable_fixed_events(sc);
2473
2474    /* Allow another sleep request after a while. */
2475    if (state != ACPI_STATE_S5)
2476	timeout(acpi_sleep_enable, sc, hz * ACPI_MINIMUM_AWAKETIME);
2477
2478    /* Run /etc/rc.resume after we are back. */
2479    acpi_UserNotify("Resume", ACPI_ROOT_OBJECT, state);
2480
2481    mtx_unlock(&Giant);
2482    return_ACPI_STATUS (status);
2483}
2484
2485/* Initialize a device's wake GPE. */
2486int
2487acpi_wake_init(device_t dev, int type)
2488{
2489    struct acpi_prw_data prw;
2490
2491    /* Evaluate _PRW to find the GPE. */
2492    if (acpi_parse_prw(acpi_get_handle(dev), &prw) != 0)
2493	return (ENXIO);
2494
2495    /* Set the requested type for the GPE (runtime, wake, or both). */
2496    if (ACPI_FAILURE(AcpiSetGpeType(prw.gpe_handle, prw.gpe_bit, type))) {
2497	device_printf(dev, "set GPE type failed\n");
2498	return (ENXIO);
2499    }
2500
2501    return (0);
2502}
2503
2504/* Enable or disable the device's wake GPE. */
2505int
2506acpi_wake_set_enable(device_t dev, int enable)
2507{
2508    struct acpi_prw_data prw;
2509    ACPI_STATUS status;
2510    int flags;
2511
2512    /* Make sure the device supports waking the system and get the GPE. */
2513    if (acpi_parse_prw(acpi_get_handle(dev), &prw) != 0)
2514	return (ENXIO);
2515
2516    flags = acpi_get_flags(dev);
2517    if (enable) {
2518	status = AcpiEnableGpe(prw.gpe_handle, prw.gpe_bit, ACPI_NOT_ISR);
2519	if (ACPI_FAILURE(status)) {
2520	    device_printf(dev, "enable wake failed\n");
2521	    return (ENXIO);
2522	}
2523	acpi_set_flags(dev, flags | ACPI_FLAG_WAKE_ENABLED);
2524    } else {
2525	status = AcpiDisableGpe(prw.gpe_handle, prw.gpe_bit, ACPI_NOT_ISR);
2526	if (ACPI_FAILURE(status)) {
2527	    device_printf(dev, "disable wake failed\n");
2528	    return (ENXIO);
2529	}
2530	acpi_set_flags(dev, flags & ~ACPI_FLAG_WAKE_ENABLED);
2531    }
2532
2533    return (0);
2534}
2535
2536static int
2537acpi_wake_sleep_prep(ACPI_HANDLE handle, int sstate)
2538{
2539    struct acpi_prw_data prw;
2540    device_t dev;
2541
2542    /* Check that this is a wake-capable device and get its GPE. */
2543    if (acpi_parse_prw(handle, &prw) != 0)
2544	return (ENXIO);
2545    dev = acpi_get_device(handle);
2546
2547    /*
2548     * The destination sleep state must be less than (i.e., higher power)
2549     * or equal to the value specified by _PRW.  If this GPE cannot be
2550     * enabled for the next sleep state, then disable it.  If it can and
2551     * the user requested it be enabled, turn on any required power resources
2552     * and set _PSW.
2553     */
2554    if (sstate > prw.lowest_wake) {
2555	AcpiDisableGpe(prw.gpe_handle, prw.gpe_bit, ACPI_NOT_ISR);
2556	if (bootverbose)
2557	    device_printf(dev, "wake_prep disabled wake for %s (S%d)\n",
2558		acpi_name(handle), sstate);
2559    } else if (dev && (acpi_get_flags(dev) & ACPI_FLAG_WAKE_ENABLED) != 0) {
2560	acpi_pwr_wake_enable(handle, 1);
2561	acpi_SetInteger(handle, "_PSW", 1);
2562	if (bootverbose)
2563	    device_printf(dev, "wake_prep enabled for %s (S%d)\n",
2564		acpi_name(handle), sstate);
2565    }
2566
2567    return (0);
2568}
2569
2570static int
2571acpi_wake_run_prep(ACPI_HANDLE handle, int sstate)
2572{
2573    struct acpi_prw_data prw;
2574    device_t dev;
2575
2576    /*
2577     * Check that this is a wake-capable device and get its GPE.  Return
2578     * now if the user didn't enable this device for wake.
2579     */
2580    if (acpi_parse_prw(handle, &prw) != 0)
2581	return (ENXIO);
2582    dev = acpi_get_device(handle);
2583    if (dev == NULL || (acpi_get_flags(dev) & ACPI_FLAG_WAKE_ENABLED) == 0)
2584	return (0);
2585
2586    /*
2587     * If this GPE couldn't be enabled for the previous sleep state, it was
2588     * disabled before going to sleep so re-enable it.  If it was enabled,
2589     * clear _PSW and turn off any power resources it used.
2590     */
2591    if (sstate > prw.lowest_wake) {
2592	AcpiEnableGpe(prw.gpe_handle, prw.gpe_bit, ACPI_NOT_ISR);
2593	if (bootverbose)
2594	    device_printf(dev, "run_prep re-enabled %s\n", acpi_name(handle));
2595    } else {
2596	acpi_SetInteger(handle, "_PSW", 0);
2597	acpi_pwr_wake_enable(handle, 0);
2598	if (bootverbose)
2599	    device_printf(dev, "run_prep cleaned up for %s\n",
2600		acpi_name(handle));
2601    }
2602
2603    return (0);
2604}
2605
2606static ACPI_STATUS
2607acpi_wake_prep(ACPI_HANDLE handle, UINT32 level, void *context, void **status)
2608{
2609    int sstate;
2610
2611    /* If suspending, run the sleep prep function, otherwise wake. */
2612    sstate = *(int *)context;
2613    if (AcpiGbl_SystemAwakeAndRunning)
2614	acpi_wake_sleep_prep(handle, sstate);
2615    else
2616	acpi_wake_run_prep(handle, sstate);
2617    return (AE_OK);
2618}
2619
2620/* Walk the tree rooted at acpi0 to prep devices for suspend/resume. */
2621static int
2622acpi_wake_prep_walk(int sstate)
2623{
2624    ACPI_HANDLE sb_handle;
2625
2626    if (ACPI_SUCCESS(AcpiGetHandle(ACPI_ROOT_OBJECT, "\\_SB_", &sb_handle)))
2627	AcpiWalkNamespace(ACPI_TYPE_DEVICE, sb_handle, 100,
2628	    acpi_wake_prep, &sstate, NULL);
2629    return (0);
2630}
2631
2632/* Walk the tree rooted at acpi0 to attach per-device wake sysctls. */
2633static int
2634acpi_wake_sysctl_walk(device_t dev)
2635{
2636    int error, i, numdevs;
2637    device_t *devlist;
2638    device_t child;
2639    ACPI_STATUS status;
2640
2641    error = device_get_children(dev, &devlist, &numdevs);
2642    if (error != 0 || numdevs == 0) {
2643	if (numdevs == 0)
2644	    free(devlist, M_TEMP);
2645	return (error);
2646    }
2647    for (i = 0; i < numdevs; i++) {
2648	child = devlist[i];
2649	acpi_wake_sysctl_walk(child);
2650	if (!device_is_attached(child))
2651	    continue;
2652	status = AcpiEvaluateObject(acpi_get_handle(child), "_PRW", NULL, NULL);
2653	if (ACPI_SUCCESS(status)) {
2654	    SYSCTL_ADD_PROC(device_get_sysctl_ctx(child),
2655		SYSCTL_CHILDREN(device_get_sysctl_tree(child)), OID_AUTO,
2656		"wake", CTLTYPE_INT | CTLFLAG_RW, child, 0,
2657		acpi_wake_set_sysctl, "I", "Device set to wake the system");
2658	}
2659    }
2660    free(devlist, M_TEMP);
2661
2662    return (0);
2663}
2664
2665/* Enable or disable wake from userland. */
2666static int
2667acpi_wake_set_sysctl(SYSCTL_HANDLER_ARGS)
2668{
2669    int enable, error;
2670    device_t dev;
2671
2672    dev = (device_t)arg1;
2673    enable = (acpi_get_flags(dev) & ACPI_FLAG_WAKE_ENABLED) ? 1 : 0;
2674
2675    error = sysctl_handle_int(oidp, &enable, 0, req);
2676    if (error != 0 || req->newptr == NULL)
2677	return (error);
2678    if (enable != 0 && enable != 1)
2679	return (EINVAL);
2680
2681    return (acpi_wake_set_enable(dev, enable));
2682}
2683
2684/* Parse a device's _PRW into a structure. */
2685int
2686acpi_parse_prw(ACPI_HANDLE h, struct acpi_prw_data *prw)
2687{
2688    ACPI_STATUS			status;
2689    ACPI_BUFFER			prw_buffer;
2690    ACPI_OBJECT			*res, *res2;
2691    int				error, i, power_count;
2692
2693    if (h == NULL || prw == NULL)
2694	return (EINVAL);
2695
2696    /*
2697     * The _PRW object (7.2.9) is only required for devices that have the
2698     * ability to wake the system from a sleeping state.
2699     */
2700    error = EINVAL;
2701    prw_buffer.Pointer = NULL;
2702    prw_buffer.Length = ACPI_ALLOCATE_BUFFER;
2703    status = AcpiEvaluateObject(h, "_PRW", NULL, &prw_buffer);
2704    if (ACPI_FAILURE(status))
2705	return (ENOENT);
2706    res = (ACPI_OBJECT *)prw_buffer.Pointer;
2707    if (res == NULL)
2708	return (ENOENT);
2709    if (!ACPI_PKG_VALID(res, 2))
2710	goto out;
2711
2712    /*
2713     * Element 1 of the _PRW object:
2714     * The lowest power system sleeping state that can be entered while still
2715     * providing wake functionality.  The sleeping state being entered must
2716     * be less than (i.e., higher power) or equal to this value.
2717     */
2718    if (acpi_PkgInt32(res, 1, &prw->lowest_wake) != 0)
2719	goto out;
2720
2721    /*
2722     * Element 0 of the _PRW object:
2723     */
2724    switch (res->Package.Elements[0].Type) {
2725    case ACPI_TYPE_INTEGER:
2726	/*
2727	 * If the data type of this package element is numeric, then this
2728	 * _PRW package element is the bit index in the GPEx_EN, in the
2729	 * GPE blocks described in the FADT, of the enable bit that is
2730	 * enabled for the wake event.
2731	 */
2732	prw->gpe_handle = NULL;
2733	prw->gpe_bit = res->Package.Elements[0].Integer.Value;
2734	error = 0;
2735	break;
2736    case ACPI_TYPE_PACKAGE:
2737	/*
2738	 * If the data type of this package element is a package, then this
2739	 * _PRW package element is itself a package containing two
2740	 * elements.  The first is an object reference to the GPE Block
2741	 * device that contains the GPE that will be triggered by the wake
2742	 * event.  The second element is numeric and it contains the bit
2743	 * index in the GPEx_EN, in the GPE Block referenced by the
2744	 * first element in the package, of the enable bit that is enabled for
2745	 * the wake event.
2746	 *
2747	 * For example, if this field is a package then it is of the form:
2748	 * Package() {\_SB.PCI0.ISA.GPE, 2}
2749	 */
2750	res2 = &res->Package.Elements[0];
2751	if (!ACPI_PKG_VALID(res2, 2))
2752	    goto out;
2753	prw->gpe_handle = acpi_GetReference(NULL, &res2->Package.Elements[0]);
2754	if (prw->gpe_handle == NULL)
2755	    goto out;
2756	if (acpi_PkgInt32(res2, 1, &prw->gpe_bit) != 0)
2757	    goto out;
2758	error = 0;
2759	break;
2760    default:
2761	goto out;
2762    }
2763
2764    /* Elements 2 to N of the _PRW object are power resources. */
2765    power_count = res->Package.Count - 2;
2766    if (power_count > ACPI_PRW_MAX_POWERRES) {
2767	printf("ACPI device %s has too many power resources\n", acpi_name(h));
2768	power_count = 0;
2769    }
2770    prw->power_res_count = power_count;
2771    for (i = 0; i < power_count; i++)
2772	prw->power_res[i] = res->Package.Elements[i];
2773
2774out:
2775    if (prw_buffer.Pointer != NULL)
2776	AcpiOsFree(prw_buffer.Pointer);
2777    return (error);
2778}
2779
2780/*
2781 * ACPI Event Handlers
2782 */
2783
2784/* System Event Handlers (registered by EVENTHANDLER_REGISTER) */
2785
2786static void
2787acpi_system_eventhandler_sleep(void *arg, int state)
2788{
2789    int ret;
2790
2791    ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, state);
2792
2793    /* Check if button action is disabled. */
2794    if (state == ACPI_S_STATES_MAX + 1)
2795	return;
2796
2797    /* Request that the system prepare to enter the given suspend state. */
2798    ret = acpi_ReqSleepState((struct acpi_softc *)arg, state);
2799    if (ret != 0)
2800	printf("acpi: request to enter state S%d failed (err %d)\n",
2801	    state, ret);
2802
2803    return_VOID;
2804}
2805
2806static void
2807acpi_system_eventhandler_wakeup(void *arg, int state)
2808{
2809
2810    ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, state);
2811
2812    /* Currently, nothing to do for wakeup. */
2813
2814    return_VOID;
2815}
2816
2817/*
2818 * ACPICA Event Handlers (FixedEvent, also called from button notify handler)
2819 */
2820UINT32
2821acpi_event_power_button_sleep(void *context)
2822{
2823    struct acpi_softc	*sc = (struct acpi_softc *)context;
2824
2825    ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
2826
2827    EVENTHANDLER_INVOKE(acpi_sleep_event, sc->acpi_power_button_sx);
2828
2829    return_VALUE (ACPI_INTERRUPT_HANDLED);
2830}
2831
2832UINT32
2833acpi_event_power_button_wake(void *context)
2834{
2835    struct acpi_softc	*sc = (struct acpi_softc *)context;
2836
2837    ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
2838
2839    EVENTHANDLER_INVOKE(acpi_wakeup_event, sc->acpi_power_button_sx);
2840
2841    return_VALUE (ACPI_INTERRUPT_HANDLED);
2842}
2843
2844UINT32
2845acpi_event_sleep_button_sleep(void *context)
2846{
2847    struct acpi_softc	*sc = (struct acpi_softc *)context;
2848
2849    ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
2850
2851    EVENTHANDLER_INVOKE(acpi_sleep_event, sc->acpi_sleep_button_sx);
2852
2853    return_VALUE (ACPI_INTERRUPT_HANDLED);
2854}
2855
2856UINT32
2857acpi_event_sleep_button_wake(void *context)
2858{
2859    struct acpi_softc	*sc = (struct acpi_softc *)context;
2860
2861    ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
2862
2863    EVENTHANDLER_INVOKE(acpi_wakeup_event, sc->acpi_sleep_button_sx);
2864
2865    return_VALUE (ACPI_INTERRUPT_HANDLED);
2866}
2867
2868/*
2869 * XXX This static buffer is suboptimal.  There is no locking so only
2870 * use this for single-threaded callers.
2871 */
2872char *
2873acpi_name(ACPI_HANDLE handle)
2874{
2875    ACPI_BUFFER buf;
2876    static char data[256];
2877
2878    buf.Length = sizeof(data);
2879    buf.Pointer = data;
2880
2881    if (handle && ACPI_SUCCESS(AcpiGetName(handle, ACPI_FULL_PATHNAME, &buf)))
2882	return (data);
2883    return ("(unknown)");
2884}
2885
2886/*
2887 * Debugging/bug-avoidance.  Avoid trying to fetch info on various
2888 * parts of the namespace.
2889 */
2890int
2891acpi_avoid(ACPI_HANDLE handle)
2892{
2893    char	*cp, *env, *np;
2894    int		len;
2895
2896    np = acpi_name(handle);
2897    if (*np == '\\')
2898	np++;
2899    if ((env = getenv("debug.acpi.avoid")) == NULL)
2900	return (0);
2901
2902    /* Scan the avoid list checking for a match */
2903    cp = env;
2904    for (;;) {
2905	while (*cp != 0 && isspace(*cp))
2906	    cp++;
2907	if (*cp == 0)
2908	    break;
2909	len = 0;
2910	while (cp[len] != 0 && !isspace(cp[len]))
2911	    len++;
2912	if (!strncmp(cp, np, len)) {
2913	    freeenv(env);
2914	    return(1);
2915	}
2916	cp += len;
2917    }
2918    freeenv(env);
2919
2920    return (0);
2921}
2922
2923/*
2924 * Debugging/bug-avoidance.  Disable ACPI subsystem components.
2925 */
2926int
2927acpi_disabled(char *subsys)
2928{
2929    char	*cp, *env;
2930    int		len;
2931
2932    if ((env = getenv("debug.acpi.disabled")) == NULL)
2933	return (0);
2934    if (strcmp(env, "all") == 0) {
2935	freeenv(env);
2936	return (1);
2937    }
2938
2939    /* Scan the disable list, checking for a match. */
2940    cp = env;
2941    for (;;) {
2942	while (*cp != '\0' && isspace(*cp))
2943	    cp++;
2944	if (*cp == '\0')
2945	    break;
2946	len = 0;
2947	while (cp[len] != '\0' && !isspace(cp[len]))
2948	    len++;
2949	if (strncmp(cp, subsys, len) == 0) {
2950	    freeenv(env);
2951	    return (1);
2952	}
2953	cp += len;
2954    }
2955    freeenv(env);
2956
2957    return (0);
2958}
2959
2960/*
2961 * Control interface.
2962 *
2963 * We multiplex ioctls for all participating ACPI devices here.  Individual
2964 * drivers wanting to be accessible via /dev/acpi should use the
2965 * register/deregister interface to make their handlers visible.
2966 */
2967struct acpi_ioctl_hook
2968{
2969    TAILQ_ENTRY(acpi_ioctl_hook) link;
2970    u_long			 cmd;
2971    acpi_ioctl_fn		 fn;
2972    void			 *arg;
2973};
2974
2975static TAILQ_HEAD(,acpi_ioctl_hook)	acpi_ioctl_hooks;
2976static int				acpi_ioctl_hooks_initted;
2977
2978int
2979acpi_register_ioctl(u_long cmd, acpi_ioctl_fn fn, void *arg)
2980{
2981    struct acpi_ioctl_hook	*hp;
2982
2983    if ((hp = malloc(sizeof(*hp), M_ACPIDEV, M_NOWAIT)) == NULL)
2984	return (ENOMEM);
2985    hp->cmd = cmd;
2986    hp->fn = fn;
2987    hp->arg = arg;
2988
2989    ACPI_LOCK(acpi);
2990    if (acpi_ioctl_hooks_initted == 0) {
2991	TAILQ_INIT(&acpi_ioctl_hooks);
2992	acpi_ioctl_hooks_initted = 1;
2993    }
2994    TAILQ_INSERT_TAIL(&acpi_ioctl_hooks, hp, link);
2995    ACPI_UNLOCK(acpi);
2996
2997    return (0);
2998}
2999
3000void
3001acpi_deregister_ioctl(u_long cmd, acpi_ioctl_fn fn)
3002{
3003    struct acpi_ioctl_hook	*hp;
3004
3005    ACPI_LOCK(acpi);
3006    TAILQ_FOREACH(hp, &acpi_ioctl_hooks, link)
3007	if (hp->cmd == cmd && hp->fn == fn)
3008	    break;
3009
3010    if (hp != NULL) {
3011	TAILQ_REMOVE(&acpi_ioctl_hooks, hp, link);
3012	free(hp, M_ACPIDEV);
3013    }
3014    ACPI_UNLOCK(acpi);
3015}
3016
3017static int
3018acpiopen(struct cdev *dev, int flag, int fmt, d_thread_t *td)
3019{
3020    return (0);
3021}
3022
3023static int
3024acpiclose(struct cdev *dev, int flag, int fmt, d_thread_t *td)
3025{
3026    return (0);
3027}
3028
3029static int
3030acpiioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag, d_thread_t *td)
3031{
3032    struct acpi_softc		*sc;
3033    struct acpi_ioctl_hook	*hp;
3034    int				error, state;
3035
3036    error = 0;
3037    hp = NULL;
3038    sc = dev->si_drv1;
3039
3040    /*
3041     * Scan the list of registered ioctls, looking for handlers.
3042     */
3043    ACPI_LOCK(acpi);
3044    if (acpi_ioctl_hooks_initted)
3045	TAILQ_FOREACH(hp, &acpi_ioctl_hooks, link) {
3046	    if (hp->cmd == cmd)
3047		break;
3048	}
3049    ACPI_UNLOCK(acpi);
3050    if (hp)
3051	return (hp->fn(cmd, addr, hp->arg));
3052
3053    /*
3054     * Core ioctls are not permitted for non-writable user.
3055     * Currently, other ioctls just fetch information.
3056     * Not changing system behavior.
3057     */
3058    if ((flag & FWRITE) == 0)
3059	return (EPERM);
3060
3061    /* Core system ioctls. */
3062    switch (cmd) {
3063    case ACPIIO_REQSLPSTATE:
3064	state = *(int *)addr;
3065	if (state != ACPI_STATE_S5)
3066	    error = acpi_ReqSleepState(sc, state);
3067	else {
3068	    printf("power off via acpi ioctl not supported\n");
3069	    error = ENXIO;
3070	}
3071	break;
3072    case ACPIIO_ACKSLPSTATE:
3073	error = *(int *)addr;
3074	error = acpi_AckSleepState(sc->acpi_clone, error);
3075	break;
3076    case ACPIIO_SETSLPSTATE:	/* DEPRECATED */
3077	error = EINVAL;
3078	state = *(int *)addr;
3079	if (state >= ACPI_STATE_S0 && state <= ACPI_S_STATES_MAX)
3080	    if (ACPI_SUCCESS(acpi_SetSleepState(sc, state)))
3081		error = 0;
3082	break;
3083    default:
3084	error = ENXIO;
3085	break;
3086    }
3087
3088    return (error);
3089}
3090
3091static int
3092acpi_supported_sleep_state_sysctl(SYSCTL_HANDLER_ARGS)
3093{
3094    int error;
3095    struct sbuf sb;
3096    UINT8 state, TypeA, TypeB;
3097
3098    sbuf_new(&sb, NULL, 32, SBUF_AUTOEXTEND);
3099    for (state = ACPI_STATE_S1; state < ACPI_S_STATES_MAX + 1; state++)
3100	if (ACPI_SUCCESS(AcpiGetSleepTypeData(state, &TypeA, &TypeB)))
3101	    sbuf_printf(&sb, "S%d ", state);
3102    sbuf_trim(&sb);
3103    sbuf_finish(&sb);
3104    error = sysctl_handle_string(oidp, sbuf_data(&sb), sbuf_len(&sb), req);
3105    sbuf_delete(&sb);
3106    return (error);
3107}
3108
3109static int
3110acpi_sleep_state_sysctl(SYSCTL_HANDLER_ARGS)
3111{
3112    char sleep_state[10];
3113    int error;
3114    u_int new_state, old_state;
3115
3116    old_state = *(u_int *)oidp->oid_arg1;
3117    if (old_state > ACPI_S_STATES_MAX + 1)
3118	strlcpy(sleep_state, "unknown", sizeof(sleep_state));
3119    else
3120	strlcpy(sleep_state, sleep_state_names[old_state], sizeof(sleep_state));
3121    error = sysctl_handle_string(oidp, sleep_state, sizeof(sleep_state), req);
3122    if (error == 0 && req->newptr != NULL) {
3123	new_state = ACPI_STATE_S0;
3124	for (; new_state <= ACPI_S_STATES_MAX + 1; new_state++)
3125	    if (strcmp(sleep_state, sleep_state_names[new_state]) == 0)
3126		break;
3127	if (new_state <= ACPI_S_STATES_MAX + 1) {
3128	    if (new_state != old_state)
3129		*(u_int *)oidp->oid_arg1 = new_state;
3130	} else
3131	    error = EINVAL;
3132    }
3133
3134    return (error);
3135}
3136
3137/* Inform devctl(4) when we receive a Notify. */
3138void
3139acpi_UserNotify(const char *subsystem, ACPI_HANDLE h, uint8_t notify)
3140{
3141    char		notify_buf[16];
3142    ACPI_BUFFER		handle_buf;
3143    ACPI_STATUS		status;
3144
3145    if (subsystem == NULL)
3146	return;
3147
3148    handle_buf.Pointer = NULL;
3149    handle_buf.Length = ACPI_ALLOCATE_BUFFER;
3150    status = AcpiNsHandleToPathname(h, &handle_buf);
3151    if (ACPI_FAILURE(status))
3152	return;
3153    snprintf(notify_buf, sizeof(notify_buf), "notify=0x%02x", notify);
3154    devctl_notify("ACPI", subsystem, handle_buf.Pointer, notify_buf);
3155    AcpiOsFree(handle_buf.Pointer);
3156}
3157
3158#ifdef ACPI_DEBUG
3159/*
3160 * Support for parsing debug options from the kernel environment.
3161 *
3162 * Bits may be set in the AcpiDbgLayer and AcpiDbgLevel debug registers
3163 * by specifying the names of the bits in the debug.acpi.layer and
3164 * debug.acpi.level environment variables.  Bits may be unset by
3165 * prefixing the bit name with !.
3166 */
3167struct debugtag
3168{
3169    char	*name;
3170    UINT32	value;
3171};
3172
3173static struct debugtag	dbg_layer[] = {
3174    {"ACPI_UTILITIES",		ACPI_UTILITIES},
3175    {"ACPI_HARDWARE",		ACPI_HARDWARE},
3176    {"ACPI_EVENTS",		ACPI_EVENTS},
3177    {"ACPI_TABLES",		ACPI_TABLES},
3178    {"ACPI_NAMESPACE",		ACPI_NAMESPACE},
3179    {"ACPI_PARSER",		ACPI_PARSER},
3180    {"ACPI_DISPATCHER",		ACPI_DISPATCHER},
3181    {"ACPI_EXECUTER",		ACPI_EXECUTER},
3182    {"ACPI_RESOURCES",		ACPI_RESOURCES},
3183    {"ACPI_CA_DEBUGGER",	ACPI_CA_DEBUGGER},
3184    {"ACPI_OS_SERVICES",	ACPI_OS_SERVICES},
3185    {"ACPI_CA_DISASSEMBLER",	ACPI_CA_DISASSEMBLER},
3186    {"ACPI_ALL_COMPONENTS",	ACPI_ALL_COMPONENTS},
3187
3188    {"ACPI_AC_ADAPTER",		ACPI_AC_ADAPTER},
3189    {"ACPI_BATTERY",		ACPI_BATTERY},
3190    {"ACPI_BUS",		ACPI_BUS},
3191    {"ACPI_BUTTON",		ACPI_BUTTON},
3192    {"ACPI_EC", 		ACPI_EC},
3193    {"ACPI_FAN",		ACPI_FAN},
3194    {"ACPI_POWERRES",		ACPI_POWERRES},
3195    {"ACPI_PROCESSOR",		ACPI_PROCESSOR},
3196    {"ACPI_THERMAL",		ACPI_THERMAL},
3197    {"ACPI_TIMER",		ACPI_TIMER},
3198    {"ACPI_ALL_DRIVERS",	ACPI_ALL_DRIVERS},
3199    {NULL, 0}
3200};
3201
3202static struct debugtag dbg_level[] = {
3203    {"ACPI_LV_ERROR",		ACPI_LV_ERROR},
3204    {"ACPI_LV_WARN",		ACPI_LV_WARN},
3205    {"ACPI_LV_INIT",		ACPI_LV_INIT},
3206    {"ACPI_LV_DEBUG_OBJECT",	ACPI_LV_DEBUG_OBJECT},
3207    {"ACPI_LV_INFO",		ACPI_LV_INFO},
3208    {"ACPI_LV_ALL_EXCEPTIONS",	ACPI_LV_ALL_EXCEPTIONS},
3209
3210    /* Trace verbosity level 1 [Standard Trace Level] */
3211    {"ACPI_LV_INIT_NAMES",	ACPI_LV_INIT_NAMES},
3212    {"ACPI_LV_PARSE",		ACPI_LV_PARSE},
3213    {"ACPI_LV_LOAD",		ACPI_LV_LOAD},
3214    {"ACPI_LV_DISPATCH",	ACPI_LV_DISPATCH},
3215    {"ACPI_LV_EXEC",		ACPI_LV_EXEC},
3216    {"ACPI_LV_NAMES",		ACPI_LV_NAMES},
3217    {"ACPI_LV_OPREGION",	ACPI_LV_OPREGION},
3218    {"ACPI_LV_BFIELD",		ACPI_LV_BFIELD},
3219    {"ACPI_LV_TABLES",		ACPI_LV_TABLES},
3220    {"ACPI_LV_VALUES",		ACPI_LV_VALUES},
3221    {"ACPI_LV_OBJECTS",		ACPI_LV_OBJECTS},
3222    {"ACPI_LV_RESOURCES",	ACPI_LV_RESOURCES},
3223    {"ACPI_LV_USER_REQUESTS",	ACPI_LV_USER_REQUESTS},
3224    {"ACPI_LV_PACKAGE",		ACPI_LV_PACKAGE},
3225    {"ACPI_LV_VERBOSITY1",	ACPI_LV_VERBOSITY1},
3226
3227    /* Trace verbosity level 2 [Function tracing and memory allocation] */
3228    {"ACPI_LV_ALLOCATIONS",	ACPI_LV_ALLOCATIONS},
3229    {"ACPI_LV_FUNCTIONS",	ACPI_LV_FUNCTIONS},
3230    {"ACPI_LV_OPTIMIZATIONS",	ACPI_LV_OPTIMIZATIONS},
3231    {"ACPI_LV_VERBOSITY2",	ACPI_LV_VERBOSITY2},
3232    {"ACPI_LV_ALL",		ACPI_LV_ALL},
3233
3234    /* Trace verbosity level 3 [Threading, I/O, and Interrupts] */
3235    {"ACPI_LV_MUTEX",		ACPI_LV_MUTEX},
3236    {"ACPI_LV_THREADS",		ACPI_LV_THREADS},
3237    {"ACPI_LV_IO",		ACPI_LV_IO},
3238    {"ACPI_LV_INTERRUPTS",	ACPI_LV_INTERRUPTS},
3239    {"ACPI_LV_VERBOSITY3",	ACPI_LV_VERBOSITY3},
3240
3241    /* Exceptionally verbose output -- also used in the global "DebugLevel"  */
3242    {"ACPI_LV_AML_DISASSEMBLE",	ACPI_LV_AML_DISASSEMBLE},
3243    {"ACPI_LV_VERBOSE_INFO",	ACPI_LV_VERBOSE_INFO},
3244    {"ACPI_LV_FULL_TABLES",	ACPI_LV_FULL_TABLES},
3245    {"ACPI_LV_EVENTS",		ACPI_LV_EVENTS},
3246    {"ACPI_LV_VERBOSE",		ACPI_LV_VERBOSE},
3247    {NULL, 0}
3248};
3249
3250static void
3251acpi_parse_debug(char *cp, struct debugtag *tag, UINT32 *flag)
3252{
3253    char	*ep;
3254    int		i, l;
3255    int		set;
3256
3257    while (*cp) {
3258	if (isspace(*cp)) {
3259	    cp++;
3260	    continue;
3261	}
3262	ep = cp;
3263	while (*ep && !isspace(*ep))
3264	    ep++;
3265	if (*cp == '!') {
3266	    set = 0;
3267	    cp++;
3268	    if (cp == ep)
3269		continue;
3270	} else {
3271	    set = 1;
3272	}
3273	l = ep - cp;
3274	for (i = 0; tag[i].name != NULL; i++) {
3275	    if (!strncmp(cp, tag[i].name, l)) {
3276		if (set)
3277		    *flag |= tag[i].value;
3278		else
3279		    *flag &= ~tag[i].value;
3280	    }
3281	}
3282	cp = ep;
3283    }
3284}
3285
3286static void
3287acpi_set_debugging(void *junk)
3288{
3289    char	*layer, *level;
3290
3291    if (cold) {
3292	AcpiDbgLayer = 0;
3293	AcpiDbgLevel = 0;
3294    }
3295
3296    layer = getenv("debug.acpi.layer");
3297    level = getenv("debug.acpi.level");
3298    if (layer == NULL && level == NULL)
3299	return;
3300
3301    printf("ACPI set debug");
3302    if (layer != NULL) {
3303	if (strcmp("NONE", layer) != 0)
3304	    printf(" layer '%s'", layer);
3305	acpi_parse_debug(layer, &dbg_layer[0], &AcpiDbgLayer);
3306	freeenv(layer);
3307    }
3308    if (level != NULL) {
3309	if (strcmp("NONE", level) != 0)
3310	    printf(" level '%s'", level);
3311	acpi_parse_debug(level, &dbg_level[0], &AcpiDbgLevel);
3312	freeenv(level);
3313    }
3314    printf("\n");
3315}
3316
3317SYSINIT(acpi_debugging, SI_SUB_TUNABLES, SI_ORDER_ANY, acpi_set_debugging,
3318	NULL);
3319
3320static int
3321acpi_debug_sysctl(SYSCTL_HANDLER_ARGS)
3322{
3323    int		 error, *dbg;
3324    struct	 debugtag *tag;
3325    struct	 sbuf sb;
3326
3327    if (sbuf_new(&sb, NULL, 128, SBUF_AUTOEXTEND) == NULL)
3328	return (ENOMEM);
3329    if (strcmp(oidp->oid_arg1, "debug.acpi.layer") == 0) {
3330	tag = &dbg_layer[0];
3331	dbg = &AcpiDbgLayer;
3332    } else {
3333	tag = &dbg_level[0];
3334	dbg = &AcpiDbgLevel;
3335    }
3336
3337    /* Get old values if this is a get request. */
3338    ACPI_SERIAL_BEGIN(acpi);
3339    if (*dbg == 0) {
3340	sbuf_cpy(&sb, "NONE");
3341    } else if (req->newptr == NULL) {
3342	for (; tag->name != NULL; tag++) {
3343	    if ((*dbg & tag->value) == tag->value)
3344		sbuf_printf(&sb, "%s ", tag->name);
3345	}
3346    }
3347    sbuf_trim(&sb);
3348    sbuf_finish(&sb);
3349
3350    /* Copy out the old values to the user. */
3351    error = SYSCTL_OUT(req, sbuf_data(&sb), sbuf_len(&sb));
3352    sbuf_delete(&sb);
3353
3354    /* If the user is setting a string, parse it. */
3355    if (error == 0 && req->newptr != NULL) {
3356	*dbg = 0;
3357	setenv((char *)oidp->oid_arg1, (char *)req->newptr);
3358	acpi_set_debugging(NULL);
3359    }
3360    ACPI_SERIAL_END(acpi);
3361
3362    return (error);
3363}
3364
3365SYSCTL_PROC(_debug_acpi, OID_AUTO, layer, CTLFLAG_RW | CTLTYPE_STRING,
3366	    "debug.acpi.layer", 0, acpi_debug_sysctl, "A", "");
3367SYSCTL_PROC(_debug_acpi, OID_AUTO, level, CTLFLAG_RW | CTLTYPE_STRING,
3368	    "debug.acpi.level", 0, acpi_debug_sysctl, "A", "");
3369#endif /* ACPI_DEBUG */
3370
3371static int
3372acpi_pm_func(u_long cmd, void *arg, ...)
3373{
3374	int	state, acpi_state;
3375	int	error;
3376	struct	acpi_softc *sc;
3377	va_list	ap;
3378
3379	error = 0;
3380	switch (cmd) {
3381	case POWER_CMD_SUSPEND:
3382		sc = (struct acpi_softc *)arg;
3383		if (sc == NULL) {
3384			error = EINVAL;
3385			goto out;
3386		}
3387
3388		va_start(ap, arg);
3389		state = va_arg(ap, int);
3390		va_end(ap);
3391
3392		switch (state) {
3393		case POWER_SLEEP_STATE_STANDBY:
3394			acpi_state = sc->acpi_standby_sx;
3395			break;
3396		case POWER_SLEEP_STATE_SUSPEND:
3397			acpi_state = sc->acpi_suspend_sx;
3398			break;
3399		case POWER_SLEEP_STATE_HIBERNATE:
3400			acpi_state = ACPI_STATE_S4;
3401			break;
3402		default:
3403			error = EINVAL;
3404			goto out;
3405		}
3406
3407		if (ACPI_FAILURE(acpi_EnterSleepState(sc, acpi_state)))
3408			error = ENXIO;
3409		break;
3410	default:
3411		error = EINVAL;
3412		goto out;
3413	}
3414
3415out:
3416	return (error);
3417}
3418
3419static void
3420acpi_pm_register(void *arg)
3421{
3422    if (!cold || resource_disabled("acpi", 0))
3423	return;
3424
3425    power_pm_register(POWER_PM_TYPE_ACPI, acpi_pm_func, NULL);
3426}
3427
3428SYSINIT(power, SI_SUB_KLD, SI_ORDER_ANY, acpi_pm_register, 0);
3429