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