sys/dev/acpica/acpi.c

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