sys/dev/acpica/acpi.c

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