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