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