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