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