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