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