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