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