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