sys/dev/acpica5/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  *      $FreeBSD: src/sys/dev/acpica/acpi.c,v 1.157 2004/06/05 09:56:04 njl Exp $
  30  *      $DragonFly: src/sys/dev/acpica5/acpi.c,v 1.19 2005/12/11 01:54:07 swildner Exp $
  31  */
  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/bus.h>
  40 #include <sys/conf.h>
  41 #include <sys/ioccom.h>
  42 #include <sys/reboot.h>
  43 #include <sys/sysctl.h>
  44 #include <sys/ctype.h>
  45 #include <sys/linker.h>
  46 #include <sys/power.h>
  47 #include <sys/sbuf.h>
  48 #include <sys/thread2.h>
  49
  50 #include <machine/clock.h>
  51 #include <machine/globaldata.h>
  52 #include <machine/resource.h>
  53 #include <machine/bus.h>
  54 #include <sys/rman.h>
  55 #include <bus/isa/isavar.h>
  56
  57 #include "acpi.h"
  58 #include <dev/acpica5/acpivar.h>
  59 #include <dev/acpica5/acpiio.h>
  60 #include <acnamesp.h>
  61
  62 MALLOC_DEFINE(M_ACPIDEV, "acpidev", "ACPI devices");
  63
  64 /* Hooks for the ACPI CA debugging infrastructure */
  65 #define _COMPONENT      ACPI_BUS
  66 ACPI_MODULE_NAME("ACPI")
  67
  68 static d_open_t         acpiopen;
  69 static d_close_t        acpiclose;
  70 static d_ioctl_t        acpiioctl;
  71
  72 #define CDEV_MAJOR 152
  73 static struct cdevsw acpi_cdevsw = {
  74         .d_name = "acpi",
  75         .d_maj  = CDEV_MAJOR,
  76         .d_flags = 0,
  77         .d_port = NULL,
  78         .d_clone = NULL,
  79         .old_open = acpiopen,
  80         .old_close = acpiclose,
  81         .old_ioctl = acpiioctl
  82 };
  83
  84 #if __FreeBSD_version >= 500000
  85 struct mtx      acpi_mutex;
  86 #endif
  87
  88 struct acpi_quirks {
  89     char        *OemId;
  90     uint32_t    OemRevision;
  91     char        *value;
  92 };
  93
  94 #define ACPI_OEM_REV_ANY        0
  95
  96 static struct acpi_quirks acpi_quirks_table[] = {
  97 #ifdef notyet
  98     /* Bad PCI routing table.  Used on some SuperMicro boards. */
  99     { "PTLTD ", 0x06040000, "pci_link" },
 100 #endif
 101
 102     { NULL, 0, NULL }
 103 };
 104
 105 static int      acpi_modevent(struct module *mod, int event, void *junk);
 106 static int      acpi_identify(driver_t *driver, device_t parent);
 107 static int      acpi_probe(device_t dev);
 108 static int      acpi_attach(device_t dev);
 109 static int      acpi_shutdown(device_t dev);
 110 static void     acpi_quirks_set(void);
 111 static device_t acpi_add_child(device_t bus, device_t parent, int order,
 112                         const char *name, int unit);
 113 static int      acpi_print_child(device_t bus, device_t child);
 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 int      acpi_set_resource(device_t dev, device_t child, int type,
 119                         int rid, u_long start, u_long count);
 120 static int      acpi_get_resource(device_t dev, device_t child, int type,
 121                         int rid, u_long *startp, u_long *countp);
 122 static struct resource *acpi_alloc_resource(device_t bus, device_t child,
 123                         int type, int *rid, u_long start, u_long end,
 124                         u_long count, u_int flags);
 125 static int      acpi_release_resource(device_t bus, device_t child, int type,
 126                         int rid, struct resource *r);
 127 static uint32_t acpi_isa_get_logicalid(device_t dev);
 128 static int      acpi_isa_get_compatid(device_t dev, uint32_t *cids, int count);
 129 static int      acpi_isa_pnp_probe(device_t bus, device_t child,
 130                         struct isa_pnp_id *ids);
 131 static void     acpi_probe_children(device_t bus);
 132 static ACPI_STATUS acpi_probe_child(ACPI_HANDLE handle, UINT32 level,
 133                         void *context, void **status);
 134 static void     acpi_shutdown_pre_sync(void *arg, int howto);
 135 static void     acpi_shutdown_final(void *arg, int howto);
 136 static void     acpi_shutdown_poweroff(void *arg);
 137 static void     acpi_enable_fixed_events(struct acpi_softc *sc);
 138 static int      acpi_parse_prw(ACPI_HANDLE h, struct acpi_prw_data *prw);
 139 static ACPI_STATUS acpi_wake_limit(ACPI_HANDLE h, UINT32 level, void *context,
 140                     void **status);
 141 static int      acpi_wake_limit_walk(int sstate);
 142 static int      acpi_wake_sysctl_walk(device_t dev);
 143 #ifdef dfly_notyet
 144 static int      acpi_wake_set_sysctl(SYSCTL_HANDLER_ARGS);
 145 #endif
 146 static void     acpi_system_eventhandler_sleep(void *arg, int state);
 147 static void     acpi_system_eventhandler_wakeup(void *arg, int state);
 148 static int      acpi_supported_sleep_state_sysctl(SYSCTL_HANDLER_ARGS);
 149 static int      acpi_sleep_state_sysctl(SYSCTL_HANDLER_ARGS);
 150 static int      acpi_pm_func(u_long cmd, void *arg, ...);
 151 static int      acpi_child_location_str_method(device_t acdev, device_t child,
 152                                                char *buf, size_t buflen);
 153 static int      acpi_child_pnpinfo_str_method(device_t acdev, device_t child,
 154                                               char *buf, size_t buflen);
 155
 156 static device_method_t acpi_methods[] = {
 157     /* Device interface */
 158     DEVMETHOD(device_identify,          acpi_identify),
 159     DEVMETHOD(device_probe,             acpi_probe),
 160     DEVMETHOD(device_attach,            acpi_attach),
 161     DEVMETHOD(device_shutdown,          acpi_shutdown),
 162     DEVMETHOD(device_detach,            bus_generic_detach),
 163     DEVMETHOD(device_suspend,           bus_generic_suspend),
 164     DEVMETHOD(device_resume,            bus_generic_resume),
 165
 166     /* Bus interface */
 167     DEVMETHOD(bus_add_child,            acpi_add_child),
 168     DEVMETHOD(bus_print_child,          acpi_print_child),
 169     DEVMETHOD(bus_read_ivar,            acpi_read_ivar),
 170     DEVMETHOD(bus_write_ivar,           acpi_write_ivar),
 171     DEVMETHOD(bus_set_resource,         acpi_set_resource),
 172     DEVMETHOD(bus_get_resource,         acpi_get_resource),
 173     DEVMETHOD(bus_alloc_resource,       acpi_alloc_resource),
 174     DEVMETHOD(bus_release_resource,     acpi_release_resource),
 175     DEVMETHOD(bus_child_pnpinfo_str,    acpi_child_pnpinfo_str_method),
 176     DEVMETHOD(bus_child_location_str,   acpi_child_location_str_method),
 177     DEVMETHOD(bus_driver_added,         bus_generic_driver_added),
 178     DEVMETHOD(bus_activate_resource,    bus_generic_activate_resource),
 179     DEVMETHOD(bus_deactivate_resource,  bus_generic_deactivate_resource),
 180     DEVMETHOD(bus_setup_intr,           bus_generic_setup_intr),
 181     DEVMETHOD(bus_teardown_intr,        bus_generic_teardown_intr),
 182
 183     /* ISA emulation */
 184     DEVMETHOD(isa_pnp_probe,            acpi_isa_pnp_probe),
 185
 186     {0, 0}
 187 };
 188
 189 static driver_t acpi_driver = {
 190     "acpi",
 191     acpi_methods,
 192     sizeof(struct acpi_softc),
 193 };
 194
 195 static devclass_t acpi_devclass;
 196 DRIVER_MODULE(acpi, nexus, acpi_driver, acpi_devclass, acpi_modevent, 0);
 197 MODULE_VERSION(acpi, 1);
 198
 199 static const char* sleep_state_names[] = {
 200     "S0", "S1", "S2", "S3", "S4", "S5", "NONE"};
 201
 202 SYSCTL_NODE(_debug, OID_AUTO, acpi, CTLFLAG_RW, NULL, "ACPI debugging");
 203 static char acpi_ca_version[12];
 204 SYSCTL_STRING(_debug_acpi, OID_AUTO, acpi_ca_version, CTLFLAG_RD,
 205               acpi_ca_version, 0, "Version of Intel ACPI-CA");
 206
 207 /*
 208  * Allow override of whether methods execute in parallel or not.
 209  * Enable this for serial behavior, which fixes "AE_ALREADY_EXISTS"
 210  * errors for AML that really can't handle parallel method execution.
 211  * It is off by default since this breaks recursive methods and
 212  * some IBMs use such code.
 213  */
 214 static int acpi_serialize_methods;
 215 TUNABLE_INT("hw.acpi.serialize_methods", &acpi_serialize_methods);
 216
 217 /*
 218  * ACPI can only be loaded as a module by the loader; activating it after
 219  * system bootstrap time is not useful, and can be fatal to the system.
 220  * It also cannot be unloaded, since the entire system bus heirarchy hangs
 221  * off it.
 222  */
 223 static int
 224 acpi_modevent(struct module *mod, int event, void *junk)
 225 {
 226     switch(event) {
 227     case MOD_LOAD:
 228         if (!cold) {
 229             printf("The ACPI driver cannot be loaded after boot.\n");
 230             return (EPERM);
 231         }
 232         break;
 233     case MOD_UNLOAD:
 234         if (!cold && power_pm_get_type() == POWER_PM_TYPE_ACPI)
 235             return (EBUSY);
 236         break;
 237     default:
 238         break;
 239     }
 240     return (0);
 241 }
 242
 243 /*
 244  * Perform early initialization.
 245  */
 246 ACPI_STATUS
 247 acpi_Startup(void)
 248 {
 249 #ifdef ACPI_DEBUGGER
 250     char *debugpoint;
 251 #endif
 252     static int error, started = 0;
 253
 254     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
 255
 256     if (started)
 257         return_VALUE (error);
 258     started = 1;
 259
 260 #if __FreeBSD_version >= 500000
 261     /* Initialise the ACPI mutex */
 262     mtx_init(&acpi_mutex, "ACPI global lock", NULL, MTX_DEF);
 263 #endif
 264
 265     /*
 266      * Set the globals from our tunables.  This is needed because ACPI-CA
 267      * uses UINT8 for some values and we have no tunable_byte.
 268      */
 269     AcpiGbl_AllMethodsSerialized = (UINT8)acpi_serialize_methods;
 270
 271     /* Start up the ACPI CA subsystem. */
 272 #ifdef ACPI_DEBUGGER
 273     debugpoint = getenv("debug.acpi.debugger");
 274     if (debugpoint) {
 275         if (!strcmp(debugpoint, "init"))
 276             acpi_EnterDebugger();
 277         freeenv(debugpoint);
 278     }
 279 #endif
 280     if (ACPI_FAILURE(error = AcpiInitializeSubsystem())) {
 281         printf("ACPI: initialisation failed: %s\n", AcpiFormatException(error));
 282         return_VALUE (error);
 283     }
 284 #ifdef ACPI_DEBUGGER
 285     debugpoint = getenv("debug.acpi.debugger");
 286     if (debugpoint) {
 287         if (!strcmp(debugpoint, "tables"))
 288             acpi_EnterDebugger();
 289         freeenv(debugpoint);
 290     }
 291 #endif
 292
 293     if (ACPI_FAILURE(error = AcpiLoadTables())) {
 294         printf("ACPI: table load failed: %s\n", AcpiFormatException(error));
 295         return_VALUE(error);
 296     }
 297
 298     /* Set up any quirks we have for this XSDT. */
 299     acpi_quirks_set();
 300     if (acpi_disabled("acpi"))
 301         return_VALUE (AE_ERROR);
 302
 303     return_VALUE (AE_OK);
 304 }
 305
 306 /*
 307  * Detect ACPI, perform early initialisation
 308  */
 309 static int
 310 acpi_identify(driver_t *driver, device_t parent)
 311 {
 312     device_t    child;
 313
 314     /*
 315      * No sense rescanning an ACPI 'bus'.
 316      */
 317     if (device_get_state(parent) == DS_ATTACHED)
 318         return(0);
 319
 320     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
 321
 322     if (!cold)
 323         return (ENXIO);
 324
 325     /* Check that we haven't been disabled with a hint. */
 326     if (resource_disabled("acpi", 0))
 327         return (ENXIO);
 328
 329     /* Make sure we're not being doubly invoked. */
 330     if (device_find_child(parent, "acpi", 0) != NULL)
 331         return (ENXIO);
 332
 333     /* Initialize ACPI-CA. */
 334     if (ACPI_FAILURE(acpi_Startup()))
 335         return (ENXIO);
 336
 337     snprintf(acpi_ca_version, sizeof(acpi_ca_version), "%#x", ACPI_CA_VERSION);
 338
 339     /* Attach the actual ACPI device. */
 340     if ((child = BUS_ADD_CHILD(parent, parent, 0, "acpi", 0)) == NULL) {
 341         device_printf(parent, "ACPI: could not attach\n");
 342         return (ENXIO);
 343     }
 344     return (0);
 345 }
 346
 347 /*
 348  * Fetch some descriptive data from ACPI to put in our attach message
 349  */
 350 static int
 351 acpi_probe(device_t dev)
 352 {
 353     ACPI_TABLE_HEADER   th;
 354     char                buf[20];
 355     int                 error;
 356     struct sbuf         sb;
 357     ACPI_STATUS         status;
 358     ACPI_LOCK_DECL;
 359
 360     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
 361
 362     if (power_pm_get_type() != POWER_PM_TYPE_NONE &&
 363         power_pm_get_type() != POWER_PM_TYPE_ACPI) {
 364
 365         device_printf(dev, "Other PM system enabled.\n");
 366         return_VALUE(ENXIO);
 367     }
 368
 369     ACPI_LOCK;
 370
 371     if (ACPI_FAILURE(status = AcpiGetTableHeader(ACPI_TABLE_XSDT, 1, &th))) {
 372         device_printf(dev, "couldn't get XSDT header: %s\n",
 373                       AcpiFormatException(status));
 374         error = ENXIO;
 375     } else {
 376         sbuf_new(&sb, buf, sizeof(buf), SBUF_FIXEDLEN);
 377         sbuf_bcat(&sb, th.OemId, 6);
 378         sbuf_trim(&sb);
 379         sbuf_putc(&sb, ' ');
 380         sbuf_bcat(&sb, th.OemTableId, 8);
 381         sbuf_trim(&sb);
 382         sbuf_finish(&sb);
 383         device_set_desc_copy(dev, sbuf_data(&sb));
 384         sbuf_delete(&sb);
 385         error = 0;
 386     }
 387     ACPI_UNLOCK;
 388     return_VALUE(error);
 389 }
 390
 391 static int
 392 acpi_attach(device_t dev)
 393 {
 394     struct acpi_softc   *sc;
 395     ACPI_STATUS         status;
 396     int                 error, state;
 397     UINT32              flags;
 398     UINT8               TypeA, TypeB;
 399     char                *env;
 400 #ifdef ACPI_DEBUGGER
 401     char                *debugpoint;
 402 #endif
 403     ACPI_LOCK_DECL;
 404
 405     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
 406     ACPI_LOCK;
 407     sc = device_get_softc(dev);
 408     bzero(sc, sizeof(*sc));
 409     sc->acpi_dev = dev;
 410     callout_init(&sc->acpi_sleep_timer);
 411
 412 #ifdef ACPI_DEBUGGER
 413     debugpoint = getenv("debug.acpi.debugger");
 414     if (debugpoint) {
 415         if (!strcmp(debugpoint, "spaces"))
 416             acpi_EnterDebugger();
 417         freeenv(debugpoint);
 418     }
 419 #endif
 420
 421     /* Install the default address space handlers. */
 422     error = ENXIO;
 423     status = AcpiInstallAddressSpaceHandler(ACPI_ROOT_OBJECT,
 424                 ACPI_ADR_SPACE_SYSTEM_MEMORY, ACPI_DEFAULT_HANDLER, NULL, NULL);
 425     if (ACPI_FAILURE(status)) {
 426         device_printf(dev, "Could not initialise SystemMemory handler: %s\n",
 427                       AcpiFormatException(status));
 428         goto out;
 429     }
 430     status = AcpiInstallAddressSpaceHandler(ACPI_ROOT_OBJECT,
 431                 ACPI_ADR_SPACE_SYSTEM_IO, ACPI_DEFAULT_HANDLER, NULL, NULL);
 432     if (ACPI_FAILURE(status)) {
 433         device_printf(dev, "Could not initialise SystemIO handler: %s\n",
 434                       AcpiFormatException(status));
 435         goto out;
 436     }
 437     status = AcpiInstallAddressSpaceHandler(ACPI_ROOT_OBJECT,
 438                 ACPI_ADR_SPACE_PCI_CONFIG, ACPI_DEFAULT_HANDLER, NULL, NULL);
 439     if (ACPI_FAILURE(status)) {
 440         device_printf(dev, "could not initialise PciConfig handler: %s\n",
 441                       AcpiFormatException(status));
 442         goto out;
 443     }
 444
 445     /*
 446      * Bring ACPI fully online.
 447      *
 448      * Note that some systems (specifically, those with namespace evaluation
 449      * issues that require the avoidance of parts of the namespace) must
 450      * avoid running _INI and _STA on everything, as well as dodging the final
 451      * object init pass.
 452      *
 453      * For these devices, we set ACPI_NO_DEVICE_INIT and ACPI_NO_OBJECT_INIT).
 454      * For avoiding portions of the namespace without totally disabling _INI
 455      * and _STA, use "debug.acpi.avoid.paths".
 456      *
 457      * XXX We should arrange for the object init pass after we have attached
 458      *     all our child devices, but on many systems it works here.
 459      */
 460 #ifdef ACPI_DEBUGGER
 461     debugpoint = getenv("debug.acpi.debugger");
 462     if (debugpoint) {
 463         if (!strcmp(debugpoint, "enable"))
 464             acpi_EnterDebugger();
 465         freeenv(debugpoint);
 466     }
 467 #endif
 468     flags = 0;
 469     if (testenv("debug.acpi.avoid"))
 470         flags = ACPI_NO_DEVICE_INIT | ACPI_NO_OBJECT_INIT;
 471     if (ACPI_FAILURE(status = AcpiEnableSubsystem(flags))) {
 472         device_printf(dev, "Could not enable ACPI: %s\n",
 473                       AcpiFormatException(status));
 474         goto out;
 475     }
 476
 477     /*
 478      * Call the ECDT probe function to provide EC functionality before
 479      * the namespace has been evaluated.
 480      */
 481     acpi_ec_ecdt_probe(dev);
 482
 483     if (ACPI_FAILURE(status = AcpiInitializeObjects(flags))) {
 484         device_printf(dev, "Could not initialize ACPI objects: %s\n",
 485                       AcpiFormatException(status));
 486         goto out;
 487     }
 488
 489     /*
 490      * Setup our sysctl tree.
 491      *
 492      * XXX: This doesn't check to make sure that none of these fail.
 493      */
 494     sysctl_ctx_init(&sc->acpi_sysctl_ctx);
 495     sc->acpi_sysctl_tree = SYSCTL_ADD_NODE(&sc->acpi_sysctl_ctx,
 496                                SYSCTL_STATIC_CHILDREN(_hw), OID_AUTO,
 497                                device_get_name(dev), CTLFLAG_RD, 0, "");
 498     SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
 499         OID_AUTO, "supported_sleep_state", CTLTYPE_STRING | CTLFLAG_RD,
 500         0, 0, acpi_supported_sleep_state_sysctl, "A", "");
 501     SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
 502         OID_AUTO, "power_button_state", CTLTYPE_STRING | CTLFLAG_RW,
 503         &sc->acpi_power_button_sx, 0, acpi_sleep_state_sysctl, "A", "");
 504     SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
 505         OID_AUTO, "sleep_button_state", CTLTYPE_STRING | CTLFLAG_RW,
 506         &sc->acpi_sleep_button_sx, 0, acpi_sleep_state_sysctl, "A", "");
 507     SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
 508         OID_AUTO, "lid_switch_state", CTLTYPE_STRING | CTLFLAG_RW,
 509         &sc->acpi_lid_switch_sx, 0, acpi_sleep_state_sysctl, "A", "");
 510     SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
 511         OID_AUTO, "standby_state", CTLTYPE_STRING | CTLFLAG_RW,
 512         &sc->acpi_standby_sx, 0, acpi_sleep_state_sysctl, "A", "");
 513     SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
 514         OID_AUTO, "suspend_state", CTLTYPE_STRING | CTLFLAG_RW,
 515         &sc->acpi_suspend_sx, 0, acpi_sleep_state_sysctl, "A", "");
 516     SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
 517         OID_AUTO, "sleep_delay", CTLFLAG_RD | CTLFLAG_RW,
 518         &sc->acpi_sleep_delay, 0, "sleep delay");
 519     SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
 520         OID_AUTO, "s4bios", CTLFLAG_RD | CTLFLAG_RW,
 521         &sc->acpi_s4bios, 0, "S4BIOS mode");
 522     SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
 523         OID_AUTO, "verbose", CTLFLAG_RD | CTLFLAG_RW,
 524         &sc->acpi_verbose, 0, "verbose mode");
 525     SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
 526         OID_AUTO, "disable_on_poweroff", CTLFLAG_RD | CTLFLAG_RW,
 527         &sc->acpi_disable_on_poweroff, 0, "ACPI subsystem disable on poweroff");
 528
 529     /*
 530      * Default to 1 second before sleeping to give some machines time to
 531      * stabilize.
 532      */
 533     sc->acpi_sleep_delay = 1;
 534     sc->acpi_disable_on_poweroff = 0;
 535     if (bootverbose)
 536         sc->acpi_verbose = 1;
 537     if ((env = getenv("hw.acpi.verbose")) && strcmp(env, "0")) {
 538         sc->acpi_verbose = 1;
 539         freeenv(env);
 540     }
 541
 542     /* Only enable S4BIOS by default if the FACS says it is available. */
 543     if (AcpiGbl_FACS->S4Bios_f != 0)
 544             sc->acpi_s4bios = 1;
 545
 546     /*
 547      * Dispatch the default sleep state to devices.  The lid switch is set
 548      * to NONE by default to avoid surprising users.
 549      */
 550     sc->acpi_power_button_sx = ACPI_STATE_S5;
 551     sc->acpi_lid_switch_sx = ACPI_S_STATES_MAX + 1;
 552     sc->acpi_standby_sx = ACPI_STATE_S1;
 553     sc->acpi_suspend_sx = ACPI_STATE_S3;
 554
 555     /* Pick the first valid sleep state for the sleep button default. */
 556     sc->acpi_sleep_button_sx = ACPI_S_STATES_MAX + 1;
 557     for (state = ACPI_STATE_S1; state < ACPI_STATE_S5; state++)
 558         if (ACPI_SUCCESS(AcpiGetSleepTypeData(state, &TypeA, &TypeB))) {
 559             sc->acpi_sleep_button_sx = state;
 560             break;
 561         }
 562
 563     acpi_enable_fixed_events(sc);
 564
 565     /*
 566      * Scan the namespace and attach/initialise children.
 567      */
 568 #ifdef ACPI_DEBUGGER
 569     debugpoint = getenv("debug.acpi.debugger");
 570     if (debugpoint) {
 571         if (!strcmp(debugpoint, "probe"))
 572             acpi_EnterDebugger();
 573         freeenv(debugpoint);
 574     }
 575 #endif
 576
 577     /* Register our shutdown handlers */
 578     EVENTHANDLER_REGISTER(shutdown_pre_sync, acpi_shutdown_pre_sync, sc,
 579         SHUTDOWN_PRI_LAST);
 580     EVENTHANDLER_REGISTER(shutdown_final, acpi_shutdown_final, sc,
 581         SHUTDOWN_PRI_LAST);
 582
 583     /*
 584      * Register our acpi event handlers.
 585      * XXX should be configurable eg. via userland policy manager.
 586      */
 587     EVENTHANDLER_REGISTER(acpi_sleep_event, acpi_system_eventhandler_sleep,
 588         sc, ACPI_EVENT_PRI_LAST);
 589     EVENTHANDLER_REGISTER(acpi_wakeup_event, acpi_system_eventhandler_wakeup,
 590         sc, ACPI_EVENT_PRI_LAST);
 591
 592     /* Flag our initial states. */
 593     sc->acpi_enabled = 1;
 594     sc->acpi_sstate = ACPI_STATE_S0;
 595     sc->acpi_sleep_disabled = 0;
 596
 597     /* Create the control device */
 598     cdevsw_add(&acpi_cdevsw, 0, 0);
 599     sc->acpi_dev_t = make_dev(&acpi_cdevsw, 0, UID_ROOT, GID_WHEEL, 0644,
 600                               "acpi");
 601     sc->acpi_dev_t->si_drv1 = sc;
 602
 603 #ifdef ACPI_DEBUGGER
 604     debugpoint = getenv("debug.acpi.debugger");
 605     if (debugpoint) {
 606         if (strcmp(debugpoint, "running") == 0)
 607             acpi_EnterDebugger();
 608         freeenv(debugpoint);
 609     }
 610 #endif
 611
 612     if ((error = acpi_task_thread_init()))
 613         goto out;
 614
 615     if ((error = acpi_machdep_init(dev)))
 616         goto out;
 617
 618     /* Register ACPI again to pass the correct argument of pm_func. */
 619     power_pm_register(POWER_PM_TYPE_ACPI, acpi_pm_func, sc);
 620
 621     if (!acpi_disabled("bus"))
 622         acpi_probe_children(dev);
 623
 624     error = 0;
 625
 626  out:
 627     ACPI_UNLOCK;
 628     return_VALUE (error);
 629 }
 630
 631 static int
 632 acpi_shutdown(device_t dev)
 633 {
 634     /* Allow children to shutdown first. */
 635     bus_generic_shutdown(dev);
 636
 637     /* Disable all wake GPEs not appropriate for reboot/poweroff. */
 638     acpi_wake_limit_walk(ACPI_STATE_S5);
 639     return (0);
 640 }
 641
 642 static void
 643 acpi_quirks_set(void)
 644 {
 645     XSDT_DESCRIPTOR *xsdt;
 646     struct acpi_quirks *quirk;
 647     char *env, *tmp;
 648     int len;
 649
 650     /*
 651      * If the user loaded a custom table or disabled "quirks", leave
 652      * the settings alone.
 653      */
 654     len = 0;
 655     if ((env = getenv("acpi_dsdt_load")) != NULL) {
 656         /* XXX No strcasecmp but this is good enough. */
 657         if (*env == 'Y' || *env == 'y')
 658             goto out;
 659         freeenv(env);
 660     }
 661     if ((env = getenv("debug.acpi.disabled")) != NULL) {
 662         if (strstr("quirks", env) != NULL)
 663             goto out;
 664         len = strlen(env);
 665     }
 666
 667     /*
 668      * Search through our quirk table and concatenate the disabled
 669      * values with whatever we find.
 670      */
 671     xsdt = AcpiGbl_XSDT;
 672     for (quirk = acpi_quirks_table; quirk->OemId; quirk++) {
 673         if (!strncmp(xsdt->OemId, quirk->OemId, strlen(quirk->OemId)) &&
 674             (xsdt->OemRevision == quirk->OemRevision ||
 675             quirk->OemRevision == ACPI_OEM_REV_ANY)) {
 676                 len += strlen(quirk->value) + 2;
 677                 if ((tmp = malloc(len, M_TEMP, M_NOWAIT)) == NULL)
 678                     goto out;
 679                 sprintf(tmp, "%s %s", env ? env : "", quirk->value);
 680 #ifdef notyet
 681                 setenv("debug.acpi.disabled", tmp);
 682 #endif /* notyet */
 683                 free(tmp, M_TEMP);
 684                 break;
 685         }
 686     }
 687
 688 out:
 689     if (env)
 690         freeenv(env);
 691 }
 692
 693 /*
 694  * Handle a new device being added
 695  */
 696 static device_t
 697 acpi_add_child(device_t bus, device_t parent, int order,
 698                 const char *name, int unit)
 699 {
 700     struct acpi_device  *ad;
 701     device_t            child;
 702
 703     ad = malloc(sizeof(*ad), M_ACPIDEV, M_INTWAIT | M_ZERO);
 704
 705     resource_list_init(&ad->ad_rl);
 706
 707     child = device_add_child_ordered(parent, order, name, unit);
 708     if (child != NULL)
 709         device_set_ivars(child, ad);
 710     return (child);
 711 }
 712
 713 static int
 714 acpi_print_child(device_t bus, device_t child)
 715 {
 716     struct acpi_device   *adev = device_get_ivars(child);
 717     struct resource_list *rl = &adev->ad_rl;
 718     int retval = 0;
 719
 720     retval += bus_print_child_header(bus, child);
 721     retval += resource_list_print_type(rl, "port",  SYS_RES_IOPORT, "%#lx");
 722     retval += resource_list_print_type(rl, "iomem", SYS_RES_MEMORY, "%#lx");
 723     retval += resource_list_print_type(rl, "irq",   SYS_RES_IRQ,    "%ld");
 724     retval += resource_list_print_type(rl, "drq",   SYS_RES_DRQ,    "%ld");
 725     retval += bus_print_child_footer(bus, child);
 726
 727     return (retval);
 728 }
 729
 730 /* Location hint for devctl(8) */
 731 static int
 732 acpi_child_location_str_method(device_t cbdev, device_t child, char *buf,
 733     size_t buflen)
 734 {
 735     struct acpi_device *dinfo = device_get_ivars(child);
 736
 737     if (dinfo->ad_handle)
 738         snprintf(buf, buflen, "path=%s", acpi_name(dinfo->ad_handle));
 739     else
 740         snprintf(buf, buflen, "magic=unknown");
 741     return (0);
 742 }
 743
 744 /* PnP information for devctl(8) */
 745 static int
 746 acpi_child_pnpinfo_str_method(device_t cbdev, device_t child, char *buf,
 747     size_t buflen)
 748 {
 749     ACPI_BUFFER adbuf = {ACPI_ALLOCATE_BUFFER, NULL};
 750     ACPI_DEVICE_INFO *adinfo;
 751     struct acpi_device *dinfo = device_get_ivars(child);
 752     char *end;
 753     int error;
 754
 755     error = AcpiGetObjectInfo(dinfo->ad_handle, &adbuf);
 756     adinfo = (ACPI_DEVICE_INFO *) adbuf.Pointer;
 757
 758     if (error)
 759         snprintf(buf, buflen, "Unknown");
 760     else
 761         snprintf(buf, buflen, "_HID=%s _UID=%lu",
 762                 (adinfo->Valid & ACPI_VALID_HID) ?
 763                 adinfo->HardwareId.Value : "UNKNOWN",
 764                 (adinfo->Valid & ACPI_VALID_UID) ?
 765                 strtoul(adinfo->UniqueId.Value, &end, 10) : 0);
 766
 767     if (adinfo)
 768         AcpiOsFree(adinfo);
 769
 770     return (0);
 771 }
 772
 773 /*
 774  * Handle per-device ivars
 775  */
 776 static int
 777 acpi_read_ivar(device_t dev, device_t child, int index, uintptr_t *result)
 778 {
 779     struct acpi_device  *ad;
 780
 781     if ((ad = device_get_ivars(child)) == NULL) {
 782         printf("device has no ivars\n");
 783         return (ENOENT);
 784     }
 785
 786     /* ACPI and ISA compatibility ivars */
 787     switch(index) {
 788     case ACPI_IVAR_HANDLE:
 789         *(ACPI_HANDLE *)result = ad->ad_handle;
 790         break;
 791     case ACPI_IVAR_MAGIC:
 792         *(int *)result = ad->ad_magic;
 793         break;
 794     case ACPI_IVAR_PRIVATE:
 795         *(void **)result = ad->ad_private;
 796         break;
 797     case ISA_IVAR_VENDORID:
 798     case ISA_IVAR_SERIAL:
 799     case ISA_IVAR_COMPATID:
 800         *(int *)result = -1;
 801         break;
 802     case ISA_IVAR_LOGICALID:
 803         *(int *)result = acpi_isa_get_logicalid(child);
 804         break;
 805     default:
 806         return (ENOENT);
 807     }
 808
 809     return (0);
 810 }
 811
 812 static int
 813 acpi_write_ivar(device_t dev, device_t child, int index, uintptr_t value)
 814 {
 815     struct acpi_device  *ad;
 816
 817     if ((ad = device_get_ivars(child)) == NULL) {
 818         printf("device has no ivars\n");
 819         return (ENOENT);
 820     }
 821
 822     switch(index) {
 823     case ACPI_IVAR_HANDLE:
 824         ad->ad_handle = (ACPI_HANDLE)value;
 825         break;
 826     case ACPI_IVAR_MAGIC:
 827         ad->ad_magic = (int)value;
 828         break;
 829     case ACPI_IVAR_PRIVATE:
 830         ad->ad_private = (void *)value;
 831         break;
 832     default:
 833         panic("bad ivar write request (%d)", index);
 834         return (ENOENT);
 835     }
 836
 837     return (0);
 838 }
 839
 840 /*
 841  * Handle child resource allocation/removal
 842  */
 843 static int
 844 acpi_set_resource(device_t dev, device_t child, int type, int rid,
 845                   u_long start, u_long count)
 846 {
 847     struct acpi_device          *ad = device_get_ivars(child);
 848     struct resource_list        *rl = &ad->ad_rl;
 849
 850     resource_list_add(rl, type, rid, start, start + count -1, count);
 851
 852     return(0);
 853 }
 854
 855 static int
 856 acpi_get_resource(device_t dev, device_t child, int type, int rid,
 857                   u_long *startp, u_long *countp)
 858 {
 859     struct acpi_device          *ad = device_get_ivars(child);
 860     struct resource_list        *rl = &ad->ad_rl;
 861     struct resource_list_entry  *rle;
 862
 863     rle = resource_list_find(rl, type, rid);
 864     if (!rle)
 865         return(ENOENT);
 866
 867     if (startp)
 868         *startp = rle->start;
 869     if (countp)
 870         *countp = rle->count;
 871
 872     return (0);
 873 }
 874
 875 static struct resource *
 876 acpi_alloc_resource(device_t bus, device_t child, int type, int *rid,
 877                     u_long start, u_long end, u_long count, u_int flags)
 878 {
 879     struct acpi_device *ad = device_get_ivars(child);
 880     struct resource_list *rl = &ad->ad_rl;
 881
 882     return (resource_list_alloc(rl, bus, child, type, rid, start, end, count,
 883             flags));
 884 }
 885
 886 static int
 887 acpi_release_resource(device_t bus, device_t child, int type, int rid, struct resource *r)
 888 {
 889     struct acpi_device *ad = device_get_ivars(child);
 890     struct resource_list *rl = &ad->ad_rl;
 891
 892     return (resource_list_release(rl, bus, child, type, rid, r));
 893 }
 894
 895 /* Allocate an IO port or memory resource, given its GAS. */
 896 struct resource *
 897 acpi_bus_alloc_gas(device_t dev, int *rid, ACPI_GENERIC_ADDRESS *gas)
 898 {
 899     int type;
 900
 901     if (gas == NULL || !ACPI_VALID_ADDRESS(gas->Address) ||
 902         gas->RegisterBitWidth < 8)
 903         return (NULL);
 904
 905     switch (gas->AddressSpaceId) {
 906     case ACPI_ADR_SPACE_SYSTEM_MEMORY:
 907         type = SYS_RES_MEMORY;
 908         break;
 909     case ACPI_ADR_SPACE_SYSTEM_IO:
 910         type = SYS_RES_IOPORT;
 911         break;
 912     default:
 913         return (NULL);
 914     }
 915
 916     bus_set_resource(dev, type, *rid, gas->Address, gas->RegisterBitWidth / 8);
 917     return (bus_alloc_resource_any(dev, type, rid, RF_ACTIVE));
 918 }
 919
 920 /*
 921  * Handle ISA-like devices probing for a PnP ID to match.
 922  */
 923 #define PNP_EISAID(s)                           \
 924         ((((s[0] - '@') & 0x1f) << 2)           \
 925          | (((s[1] - '@') & 0x18) >> 3)         \
 926          | (((s[1] - '@') & 0x07) << 13)        \
 927          | (((s[2] - '@') & 0x1f) << 8)         \
 928          | (PNP_HEXTONUM(s[4]) << 16)           \
 929          | (PNP_HEXTONUM(s[3]) << 20)           \
 930          | (PNP_HEXTONUM(s[6]) << 24)           \
 931          | (PNP_HEXTONUM(s[5]) << 28))
 932
 933 static uint32_t
 934 acpi_isa_get_logicalid(device_t dev)
 935 {
 936     ACPI_DEVICE_INFO    *devinfo;
 937     ACPI_BUFFER         buf;
 938     ACPI_HANDLE         h;
 939     ACPI_STATUS         error;
 940     u_int32_t           pnpid;
 941     ACPI_LOCK_DECL;
 942
 943     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
 944
 945     pnpid = 0;
 946     buf.Pointer = NULL;
 947     buf.Length = ACPI_ALLOCATE_BUFFER;
 948
 949     ACPI_LOCK;
 950
 951     /* Fetch and validate the HID. */
 952     if ((h = acpi_get_handle(dev)) == NULL)
 953         goto out;
 954     error = AcpiGetObjectInfo(h, &buf);
 955     if (ACPI_FAILURE(error))
 956         goto out;
 957     devinfo = (ACPI_DEVICE_INFO *)buf.Pointer;
 958
 959     if ((devinfo->Valid & ACPI_VALID_HID) != 0)
 960         pnpid = PNP_EISAID(devinfo->HardwareId.Value);
 961
 962 out:
 963     if (buf.Pointer != NULL)
 964         AcpiOsFree(buf.Pointer);
 965     ACPI_UNLOCK;
 966     return_VALUE (pnpid);
 967 }
 968
 969 static int
 970 acpi_isa_get_compatid(device_t dev, uint32_t *cids, int count)
 971 {
 972     ACPI_DEVICE_INFO    *devinfo;
 973     ACPI_BUFFER         buf;
 974     ACPI_HANDLE         h;
 975     ACPI_STATUS         error;
 976     uint32_t            *pnpid;
 977     int                 valid, i;
 978     ACPI_LOCK_DECL;
 979
 980     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
 981
 982     pnpid = cids;
 983     valid = 0;
 984     buf.Pointer = NULL;
 985     buf.Length = ACPI_ALLOCATE_BUFFER;
 986
 987     ACPI_LOCK;
 988
 989     /* Fetch and validate the CID */
 990     if ((h = acpi_get_handle(dev)) == NULL)
 991         goto out;
 992     error = AcpiGetObjectInfo(h, &buf);
 993     if (ACPI_FAILURE(error))
 994         goto out;
 995     devinfo = (ACPI_DEVICE_INFO *)buf.Pointer;
 996     if ((devinfo->Valid & ACPI_VALID_CID) == 0)
 997         goto out;
 998
 999     if (devinfo->CompatibilityId.Count < count)
1000         count = devinfo->CompatibilityId.Count;
1001     for (i = 0; i < count; i++) {
1002         if (strncmp(devinfo->CompatibilityId.Id[i].Value, "PNP", 3) != 0)
1003             continue;
1004         *pnpid++ = PNP_EISAID(devinfo->CompatibilityId.Id[i].Value);
1005         valid++;
1006     }
1007
1008 out:
1009     if (buf.Pointer != NULL)
1010         AcpiOsFree(buf.Pointer);
1011     ACPI_UNLOCK;
1012     return_VALUE (valid);
1013 }
1014
1015 static int
1016 acpi_isa_pnp_probe(device_t bus, device_t child, struct isa_pnp_id *ids)
1017 {
1018     int                 result, cid_count, i;
1019     uint32_t            lid, cids[8];
1020
1021     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1022
1023     /*
1024      * ISA-style drivers attached to ACPI may persist and
1025      * probe manually if we return ENOENT.  We never want
1026      * that to happen, so don't ever return it.
1027      */
1028     result = ENXIO;
1029
1030     /* Scan the supplied IDs for a match */
1031     lid = acpi_isa_get_logicalid(child);
1032     cid_count = acpi_isa_get_compatid(child, cids, 8);
1033     while (ids && ids->ip_id) {
1034         if (lid == ids->ip_id) {
1035             result = 0;
1036             goto out;
1037         }
1038         for (i = 0; i < cid_count; i++) {
1039             if (cids[i] == ids->ip_id) {
1040                 result = 0;
1041                 goto out;
1042             }
1043         }
1044         ids++;
1045     }
1046
1047  out:
1048     return_VALUE (result);
1049 }
1050
1051 /*
1052  * Scan relevant portions of the ACPI namespace and attach child devices.
1053  *
1054  * Note that we only expect to find devices in the \_PR_, \_TZ_, \_SI_ and
1055  * \_SB_ scopes, and \_PR_ and \_TZ_ become obsolete in the ACPI 2.0 spec.
1056  */
1057 static void
1058 acpi_probe_children(device_t bus)
1059 {
1060     ACPI_HANDLE parent;
1061     ACPI_STATUS status;
1062     static char *scopes[] = {"\\_PR_", "\\_TZ_", "\\_SI", "\\_SB_", NULL};
1063     int         i;
1064
1065     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1066     ACPI_ASSERTLOCK;
1067
1068     /* Create any static children by calling device identify methods. */
1069     ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "device identify routines\n"));
1070     bus_generic_probe(bus);
1071
1072     /*
1073      * Scan the namespace and insert placeholders for all the devices that
1074      * we find.
1075      *
1076      * Note that we use AcpiWalkNamespace rather than AcpiGetDevices because
1077      * we want to create nodes for all devices, not just those that are
1078      * currently present. (This assumes that we don't want to create/remove
1079      * devices as they appear, which might be smarter.)
1080      */
1081     ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "namespace scan\n"));
1082     for (i = 0; scopes[i] != NULL; i++) {
1083         status = AcpiGetHandle(ACPI_ROOT_OBJECT, scopes[i], &parent);
1084         if (ACPI_SUCCESS(status)) {
1085             AcpiWalkNamespace(ACPI_TYPE_ANY, parent, 100, acpi_probe_child,
1086                               bus, NULL);
1087         }
1088     }
1089
1090     /*
1091      * Scan all of the child devices we have created and let them probe/attach.
1092      */
1093     ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "first bus_generic_attach\n"));
1094     bus_generic_attach(bus);
1095
1096     /*
1097      * Some of these children may have attached others as part of their attach
1098      * process (eg. the root PCI bus driver), so rescan.
1099      */
1100     ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "second bus_generic_attach\n"));
1101     bus_generic_attach(bus);
1102
1103     /* Attach wake sysctls. */
1104     acpi_wake_sysctl_walk(bus);
1105
1106     ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "done attaching children\n"));
1107     return_VOID;
1108 }
1109
1110 /*
1111  * Evaluate a child device and determine whether we might attach a device to
1112  * it.
1113  */
1114 static ACPI_STATUS
1115 acpi_probe_child(ACPI_HANDLE handle, UINT32 level, void *context, void **status)
1116 {
1117     ACPI_OBJECT_TYPE    type;
1118     device_t            child, bus = (device_t)context;
1119
1120     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1121
1122     /* Skip this device if we think we'll have trouble with it. */
1123     if (acpi_avoid(handle)) {
1124         ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "not scanning '%s'\n",
1125                          acpi_name(handle)));
1126         return_ACPI_STATUS (AE_OK);
1127     }
1128
1129     if (ACPI_SUCCESS(AcpiGetType(handle, &type))) {
1130         switch(type) {
1131         case ACPI_TYPE_DEVICE:
1132         case ACPI_TYPE_PROCESSOR:
1133         case ACPI_TYPE_THERMAL:
1134         case ACPI_TYPE_POWER:
1135             if (acpi_disabled("children"))
1136                 break;
1137
1138             /*
1139              * Create a placeholder device for this node.  Sort the placeholder
1140              * so that the probe/attach passes will run breadth-first.
1141              */
1142             ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "scanning '%s'\n",
1143                              acpi_name(handle)));
1144             child = BUS_ADD_CHILD(bus, bus, level * 10, NULL, -1);
1145             if (child == NULL)
1146                 break;
1147             acpi_set_handle(child, handle);
1148
1149             /* Check if the device can generate wake events. */
1150             if (ACPI_SUCCESS(AcpiEvaluateObject(handle, "_PRW", NULL, NULL)))
1151                 device_set_flags(child, ACPI_FLAG_WAKE_CAPABLE);
1152
1153             /*
1154              * Check that the device is present.  If it's not present,
1155              * leave it disabled (so that we have a device_t attached to
1156              * the handle, but we don't probe it).
1157              */
1158             if (type == ACPI_TYPE_DEVICE && !acpi_DeviceIsPresent(child)) {
1159                 device_disable(child);
1160                 break;
1161             }
1162
1163             /*
1164              * Get the device's resource settings and attach them.
1165              * Note that if the device has _PRS but no _CRS, we need
1166              * to decide when it's appropriate to try to configure the
1167              * device.  Ignore the return value here; it's OK for the
1168              * device not to have any resources.
1169              */
1170             acpi_parse_resources(child, handle, &acpi_res_parse_set, NULL);
1171
1172             /* If we're debugging, probe/attach now rather than later */
1173             ACPI_DEBUG_EXEC(device_probe_and_attach(child));
1174             break;
1175         }
1176     }
1177
1178     return_ACPI_STATUS (AE_OK);
1179 }
1180
1181 static void
1182 acpi_shutdown_pre_sync(void *arg, int howto)
1183 {
1184     struct acpi_softc *sc = arg;
1185
1186     ACPI_ASSERTLOCK;
1187
1188     /*
1189      * Disable all ACPI events before soft off, otherwise the system
1190      * will be turned on again on some laptops.
1191      *
1192      * XXX this should probably be restricted to masking some events just
1193      *     before powering down, since we may still need ACPI during the
1194      *     shutdown process.
1195      */
1196     if (sc->acpi_disable_on_poweroff)
1197         acpi_Disable(sc);
1198 }
1199
1200 static void
1201 acpi_shutdown_final(void *arg, int howto)
1202 {
1203     ACPI_STATUS status;
1204     ACPI_ASSERTLOCK;
1205
1206     /*
1207      * If powering off, run the actual shutdown code on each processor.
1208      * It will only perform the shutdown on the BSP.  Some chipsets do
1209      * not power off the system correctly if called from an AP.
1210      */
1211     if ((howto & RB_POWEROFF) != 0) {
1212         status = AcpiEnterSleepStatePrep(ACPI_STATE_S5);
1213         if (ACPI_FAILURE(status)) {
1214             printf("AcpiEnterSleepStatePrep failed - %s\n",
1215                    AcpiFormatException(status));
1216             return;
1217         }
1218         printf("Powering system off using ACPI\n");
1219         acpi_shutdown_poweroff(NULL);
1220     } else {
1221         printf("Shutting down ACPI\n");
1222         AcpiTerminate();
1223     }
1224 }
1225
1226 /*
1227  * Since this function may be called with locks held or in an unknown
1228  * context, it cannot allocate memory, acquire locks, sleep, etc.
1229  */
1230 static void
1231 acpi_shutdown_poweroff(void *arg)
1232 {
1233     ACPI_STATUS status;
1234
1235     ACPI_ASSERTLOCK;
1236
1237     /* Only attempt to power off if this is the BSP (cpuid 0). */
1238     if (mdcpu->mi.gd_cpuid != 0)
1239         return;
1240
1241     ACPI_DISABLE_IRQS();
1242     status = AcpiEnterSleepState(ACPI_STATE_S5);
1243     if (ACPI_FAILURE(status)) {
1244         printf("ACPI power-off failed - %s\n", AcpiFormatException(status));
1245     } else {
1246         DELAY(1000000);
1247         printf("ACPI power-off failed - timeout\n");
1248     }
1249 }
1250
1251 static void
1252 acpi_enable_fixed_events(struct acpi_softc *sc)
1253 {
1254     static int  first_time = 1;
1255
1256     ACPI_ASSERTLOCK;
1257
1258     /* Enable and clear fixed events and install handlers. */
1259     if (AcpiGbl_FADT != NULL && AcpiGbl_FADT->PwrButton == 0) {
1260         AcpiClearEvent(ACPI_EVENT_POWER_BUTTON);
1261         AcpiInstallFixedEventHandler(ACPI_EVENT_POWER_BUTTON,
1262                                      acpi_event_power_button_sleep, sc);
1263         if (first_time)
1264             device_printf(sc->acpi_dev, "Power Button (fixed)\n");
1265     }
1266     if (AcpiGbl_FADT != NULL && AcpiGbl_FADT->SleepButton == 0) {
1267         AcpiClearEvent(ACPI_EVENT_SLEEP_BUTTON);
1268         AcpiInstallFixedEventHandler(ACPI_EVENT_SLEEP_BUTTON,
1269                                      acpi_event_sleep_button_sleep, sc);
1270         if (first_time)
1271             device_printf(sc->acpi_dev, "Sleep Button (fixed)\n");
1272     }
1273
1274     first_time = 0;
1275 }
1276
1277 /*
1278  * Returns true if the device is actually present and should
1279  * be attached to.  This requires the present, enabled, UI-visible
1280  * and diagnostics-passed bits to be set.
1281  */
1282 BOOLEAN
1283 acpi_DeviceIsPresent(device_t dev)
1284 {
1285     ACPI_DEVICE_INFO    *devinfo;
1286     ACPI_HANDLE         h;
1287     ACPI_BUFFER         buf;
1288     ACPI_STATUS         error;
1289     int                 ret;
1290
1291     ACPI_ASSERTLOCK;
1292
1293     ret = FALSE;
1294     if ((h = acpi_get_handle(dev)) == NULL)
1295         return (FALSE);
1296     buf.Pointer = NULL;
1297     buf.Length = ACPI_ALLOCATE_BUFFER;
1298     error = AcpiGetObjectInfo(h, &buf);
1299     if (ACPI_FAILURE(error))
1300         return (FALSE);
1301     devinfo = (ACPI_DEVICE_INFO *)buf.Pointer;
1302
1303     /* If no _STA method, must be present */
1304     if ((devinfo->Valid & ACPI_VALID_STA) == 0)
1305         ret = TRUE;
1306
1307     /* Return true for 'present' and 'functioning' */
1308     if ((devinfo->CurrentStatus & 0x9) == 0x9)
1309         ret = TRUE;
1310
1311     AcpiOsFree(buf.Pointer);
1312     return (ret);
1313 }
1314
1315 /*
1316  * Returns true if the battery is actually present and inserted.
1317  */
1318 BOOLEAN
1319 acpi_BatteryIsPresent(device_t dev)
1320 {
1321     ACPI_DEVICE_INFO    *devinfo;
1322     ACPI_HANDLE         h;
1323     ACPI_BUFFER         buf;
1324     ACPI_STATUS         error;
1325     int                 ret;
1326
1327     ACPI_ASSERTLOCK;
1328
1329     ret = FALSE;
1330     if ((h = acpi_get_handle(dev)) == NULL)
1331         return (FALSE);
1332     buf.Pointer = NULL;
1333     buf.Length = ACPI_ALLOCATE_BUFFER;
1334     error = AcpiGetObjectInfo(h, &buf);
1335     if (ACPI_FAILURE(error))
1336         return (FALSE);
1337     devinfo = (ACPI_DEVICE_INFO *)buf.Pointer;
1338
1339     /* If no _STA method, must be present */
1340     if ((devinfo->Valid & ACPI_VALID_STA) == 0)
1341         ret = TRUE;
1342
1343     /* Return true for 'present' and 'functioning' */
1344     if ((devinfo->CurrentStatus & 0x19) == 0x19)
1345         ret = TRUE;
1346
1347     AcpiOsFree(buf.Pointer);
1348     return (ret);
1349 }
1350
1351 /*
1352  * Match a HID string against a device
1353  */
1354 BOOLEAN
1355 acpi_MatchHid(device_t dev, char *hid)
1356 {
1357     ACPI_DEVICE_INFO    *devinfo;
1358     ACPI_HANDLE         h;
1359     ACPI_BUFFER         buf;
1360     ACPI_STATUS         error;
1361     int                 ret, i;
1362
1363     ACPI_ASSERTLOCK;
1364
1365     ret = FALSE;
1366     if (hid == NULL)
1367         return (FALSE);
1368     if ((h = acpi_get_handle(dev)) == NULL)
1369         return (FALSE);
1370     buf.Pointer = NULL;
1371     buf.Length = ACPI_ALLOCATE_BUFFER;
1372     error = AcpiGetObjectInfo(h, &buf);
1373     if (ACPI_FAILURE(error))
1374         return (FALSE);
1375     devinfo = (ACPI_DEVICE_INFO *)buf.Pointer;
1376
1377     if ((devinfo->Valid & ACPI_VALID_HID) != 0 &&
1378         strcmp(hid, devinfo->HardwareId.Value) == 0)
1379             ret = TRUE;
1380     else if ((devinfo->Valid & ACPI_VALID_CID) != 0) {
1381         for (i = 0; i < devinfo->CompatibilityId.Count; i++) {
1382             if (strcmp(hid, devinfo->CompatibilityId.Id[i].Value) == 0) {
1383                 ret = TRUE;
1384                 break;
1385             }
1386         }
1387     }
1388
1389     AcpiOsFree(buf.Pointer);
1390     return (ret);
1391 }
1392
1393 /*
1394  * Return the handle of a named object within our scope, ie. that of (parent)
1395  * or one if its parents.
1396  */
1397 ACPI_STATUS
1398 acpi_GetHandleInScope(ACPI_HANDLE parent, char *path, ACPI_HANDLE *result)
1399 {
1400     ACPI_HANDLE         r;
1401     ACPI_STATUS         status;
1402
1403     ACPI_ASSERTLOCK;
1404
1405     /* Walk back up the tree to the root */
1406     for (;;) {
1407         status = AcpiGetHandle(parent, path, &r);
1408         if (ACPI_SUCCESS(status)) {
1409             *result = r;
1410             return (AE_OK);
1411         }
1412         if (status != AE_NOT_FOUND)
1413             return (AE_OK);
1414         if (ACPI_FAILURE(AcpiGetParent(parent, &r)))
1415             return (AE_NOT_FOUND);
1416         parent = r;
1417     }
1418 }
1419
1420 /* Find the difference between two PM tick counts. */
1421 uint32_t
1422 acpi_TimerDelta(uint32_t end, uint32_t start)
1423 {
1424     uint32_t delta;
1425
1426     if (end >= start)
1427         delta = end - start;
1428     else if (AcpiGbl_FADT->TmrValExt == 0)
1429         delta = ((0x00FFFFFF - start) + end + 1) & 0x00FFFFFF;
1430     else
1431         delta = ((0xFFFFFFFF - start) + end + 1);
1432     return (delta);
1433 }
1434
1435 /*
1436  * Allocate a buffer with a preset data size.
1437  */
1438 ACPI_BUFFER *
1439 acpi_AllocBuffer(int size)
1440 {
1441     ACPI_BUFFER *buf;
1442
1443     buf = malloc(size + sizeof(*buf), M_ACPIDEV, M_INTWAIT);
1444     buf->Length = size;
1445     buf->Pointer = (void *)(buf + 1);
1446     return (buf);
1447 }
1448
1449 ACPI_STATUS
1450 acpi_SetInteger(ACPI_HANDLE handle, char *path, UINT32 number)
1451 {
1452     ACPI_OBJECT arg1;
1453     ACPI_OBJECT_LIST args;
1454
1455     ACPI_ASSERTLOCK;
1456
1457     arg1.Type = ACPI_TYPE_INTEGER;
1458     arg1.Integer.Value = number;
1459     args.Count = 1;
1460     args.Pointer = &arg1;
1461
1462     return (AcpiEvaluateObject(handle, path, &args, NULL));
1463 }
1464
1465 /*
1466  * Evaluate a path that should return an integer.
1467  */
1468 ACPI_STATUS
1469 acpi_GetInteger(ACPI_HANDLE handle, char *path, UINT32 *number)
1470 {
1471     ACPI_STATUS status;
1472     ACPI_BUFFER buf;
1473     ACPI_OBJECT param;
1474
1475     ACPI_ASSERTLOCK;
1476
1477     if (handle == NULL)
1478         handle = ACPI_ROOT_OBJECT;
1479
1480     /*
1481      * Assume that what we've been pointed at is an Integer object, or
1482      * a method that will return an Integer.
1483      */
1484     buf.Pointer = &param;
1485     buf.Length = sizeof(param);
1486     status = AcpiEvaluateObject(handle, path, NULL, &buf);
1487     if (ACPI_SUCCESS(status)) {
1488         if (param.Type == ACPI_TYPE_INTEGER)
1489             *number = param.Integer.Value;
1490         else
1491             status = AE_TYPE;
1492     }
1493
1494     /*
1495      * In some applications, a method that's expected to return an Integer
1496      * may instead return a Buffer (probably to simplify some internal
1497      * arithmetic).  We'll try to fetch whatever it is, and if it's a Buffer,
1498      * convert it into an Integer as best we can.
1499      *
1500      * This is a hack.
1501      */
1502     if (status == AE_BUFFER_OVERFLOW) {
1503         if ((buf.Pointer = AcpiOsAllocate(buf.Length)) == NULL) {
1504             status = AE_NO_MEMORY;
1505         } else {
1506             status = AcpiEvaluateObject(handle, path, NULL, &buf);
1507             if (ACPI_SUCCESS(status))
1508                 status = acpi_ConvertBufferToInteger(&buf, number);
1509             AcpiOsFree(buf.Pointer);
1510         }
1511     }
1512     return (status);
1513 }
1514
1515 ACPI_STATUS
1516 acpi_ConvertBufferToInteger(ACPI_BUFFER *bufp, UINT32 *number)
1517 {
1518     ACPI_OBJECT *p;
1519     UINT8       *val;
1520     int         i;
1521
1522     p = (ACPI_OBJECT *)bufp->Pointer;
1523     if (p->Type == ACPI_TYPE_INTEGER) {
1524         *number = p->Integer.Value;
1525         return (AE_OK);
1526     }
1527     if (p->Type != ACPI_TYPE_BUFFER)
1528         return (AE_TYPE);
1529     if (p->Buffer.Length > sizeof(int))
1530         return (AE_BAD_DATA);
1531
1532     *number = 0;
1533     val = p->Buffer.Pointer;
1534     for (i = 0; i < p->Buffer.Length; i++)
1535         *number += val[i] << (i * 8);
1536     return (AE_OK);
1537 }
1538
1539 /*
1540  * Iterate over the elements of an a package object, calling the supplied
1541  * function for each element.
1542  *
1543  * XXX possible enhancement might be to abort traversal on error.
1544  */
1545 ACPI_STATUS
1546 acpi_ForeachPackageObject(ACPI_OBJECT *pkg,
1547         void (*func)(ACPI_OBJECT *comp, void *arg), void *arg)
1548 {
1549     ACPI_OBJECT *comp;
1550     int         i;
1551
1552     if (pkg == NULL || pkg->Type != ACPI_TYPE_PACKAGE)
1553         return (AE_BAD_PARAMETER);
1554
1555     /* Iterate over components */
1556     i = 0;
1557     comp = pkg->Package.Elements;
1558     for (; i < pkg->Package.Count; i++, comp++)
1559         func(comp, arg);
1560
1561     return (AE_OK);
1562 }
1563
1564 /*
1565  * Find the (index)th resource object in a set.
1566  */
1567 ACPI_STATUS
1568 acpi_FindIndexedResource(ACPI_BUFFER *buf, int index, ACPI_RESOURCE **resp)
1569 {
1570     ACPI_RESOURCE       *rp;
1571     int                 i;
1572
1573     rp = (ACPI_RESOURCE *)buf->Pointer;
1574     i = index;
1575     while (i-- > 0) {
1576         /* Range check */
1577         if (rp > (ACPI_RESOURCE *)((u_int8_t *)buf->Pointer + buf->Length))
1578             return (AE_BAD_PARAMETER);
1579
1580         /* Check for terminator */
1581         if (rp->Id == ACPI_RSTYPE_END_TAG || rp->Length == 0)
1582             return (AE_NOT_FOUND);
1583         rp = ACPI_NEXT_RESOURCE(rp);
1584     }
1585     if (resp != NULL)
1586         *resp = rp;
1587
1588     return (AE_OK);
1589 }
1590
1591 /*
1592  * Append an ACPI_RESOURCE to an ACPI_BUFFER.
1593  *
1594  * Given a pointer to an ACPI_RESOURCE structure, expand the ACPI_BUFFER
1595  * provided to contain it.  If the ACPI_BUFFER is empty, allocate a sensible
1596  * backing block.  If the ACPI_RESOURCE is NULL, return an empty set of
1597  * resources.
1598  */
1599 #define ACPI_INITIAL_RESOURCE_BUFFER_SIZE       512
1600
1601 ACPI_STATUS
1602 acpi_AppendBufferResource(ACPI_BUFFER *buf, ACPI_RESOURCE *res)
1603 {
1604     ACPI_RESOURCE       *rp;
1605     void                *newp;
1606
1607     /* Initialise the buffer if necessary. */
1608     if (buf->Pointer == NULL) {
1609         buf->Length = ACPI_INITIAL_RESOURCE_BUFFER_SIZE;
1610         if ((buf->Pointer = AcpiOsAllocate(buf->Length)) == NULL)
1611             return (AE_NO_MEMORY);
1612         rp = (ACPI_RESOURCE *)buf->Pointer;
1613         rp->Id = ACPI_RSTYPE_END_TAG;
1614         rp->Length = 0;
1615     }
1616     if (res == NULL)
1617         return (AE_OK);
1618
1619     /*
1620      * Scan the current buffer looking for the terminator.
1621      * This will either find the terminator or hit the end
1622      * of the buffer and return an error.
1623      */
1624     rp = (ACPI_RESOURCE *)buf->Pointer;
1625     for (;;) {
1626         /* Range check, don't go outside the buffer */
1627         if (rp >= (ACPI_RESOURCE *)((u_int8_t *)buf->Pointer + buf->Length))
1628             return (AE_BAD_PARAMETER);
1629         if (rp->Id == ACPI_RSTYPE_END_TAG || rp->Length == 0)
1630             break;
1631         rp = ACPI_NEXT_RESOURCE(rp);
1632     }
1633
1634     /*
1635      * Check the size of the buffer and expand if required.
1636      *
1637      * Required size is:
1638      *  size of existing resources before terminator +
1639      *  size of new resource and header +
1640      *  size of terminator.
1641      *
1642      * Note that this loop should really only run once, unless
1643      * for some reason we are stuffing a *really* huge resource.
1644      */
1645     while ((((u_int8_t *)rp - (u_int8_t *)buf->Pointer) +
1646             res->Length + ACPI_RESOURCE_LENGTH_NO_DATA +
1647             ACPI_RESOURCE_LENGTH) >= buf->Length) {
1648         if ((newp = AcpiOsAllocate(buf->Length * 2)) == NULL)
1649             return (AE_NO_MEMORY);
1650         bcopy(buf->Pointer, newp, buf->Length);
1651         rp = (ACPI_RESOURCE *)((u_int8_t *)newp +
1652                                ((u_int8_t *)rp - (u_int8_t *)buf->Pointer));
1653         AcpiOsFree(buf->Pointer);
1654         buf->Pointer = newp;
1655         buf->Length += buf->Length;
1656     }
1657
1658     /* Insert the new resource. */
1659     bcopy(res, rp, res->Length + ACPI_RESOURCE_LENGTH_NO_DATA);
1660
1661     /* And add the terminator. */
1662     rp = ACPI_NEXT_RESOURCE(rp);
1663     rp->Id = ACPI_RSTYPE_END_TAG;
1664     rp->Length = 0;
1665
1666     return (AE_OK);
1667 }
1668
1669 /*
1670  * Set interrupt model.
1671  */
1672 ACPI_STATUS
1673 acpi_SetIntrModel(int model)
1674 {
1675     return (acpi_SetInteger(ACPI_ROOT_OBJECT, "_PIC", model));
1676 }
1677
1678 #define ACPI_MINIMUM_AWAKETIME  5
1679
1680 static void
1681 acpi_sleep_enable(void *arg)
1682 {
1683     ((struct acpi_softc *)arg)->acpi_sleep_disabled = 0;
1684 }
1685
1686 /*
1687  * Set the system sleep state
1688  *
1689  * Currently we support S1-S5 but S4 is only S4BIOS
1690  */
1691 ACPI_STATUS
1692 acpi_SetSleepState(struct acpi_softc *sc, int state)
1693 {
1694     ACPI_STATUS status = AE_OK;
1695     UINT8       TypeA;
1696     UINT8       TypeB;
1697
1698     ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, state);
1699     ACPI_ASSERTLOCK;
1700
1701     /* Avoid reentry if already attempting to suspend. */
1702     if (sc->acpi_sstate != ACPI_STATE_S0)
1703         return_ACPI_STATUS (AE_BAD_PARAMETER);
1704
1705     /* We recently woke up so don't suspend again for a while. */
1706     if (sc->acpi_sleep_disabled)
1707         return_ACPI_STATUS (AE_OK);
1708
1709     switch (state) {
1710     case ACPI_STATE_S1:
1711     case ACPI_STATE_S2:
1712     case ACPI_STATE_S3:
1713     case ACPI_STATE_S4:
1714         status = AcpiGetSleepTypeData((UINT8)state, &TypeA, &TypeB);
1715         if (status == AE_NOT_FOUND) {
1716             device_printf(sc->acpi_dev,
1717                           "Sleep state S%d not supported by BIOS\n", state);
1718             break;
1719         } else if (ACPI_FAILURE(status)) {
1720             device_printf(sc->acpi_dev, "AcpiGetSleepTypeData failed - %s\n",
1721                           AcpiFormatException(status));
1722             break;
1723         }
1724
1725         sc->acpi_sstate = state;
1726         sc->acpi_sleep_disabled = 1;
1727
1728         /* Disable all wake GPEs not appropriate for this state. */
1729         acpi_wake_limit_walk(state);
1730
1731         /* Inform all devices that we are going to sleep. */
1732         if (DEVICE_SUSPEND(root_bus) != 0) {
1733             /*
1734              * Re-wake the system.
1735              *
1736              * XXX note that a better two-pass approach with a 'veto' pass
1737              *     followed by a "real thing" pass would be better, but the
1738              *     current bus interface does not provide for this.
1739              */
1740             DEVICE_RESUME(root_bus);
1741             return_ACPI_STATUS (AE_ERROR);
1742         }
1743
1744         status = AcpiEnterSleepStatePrep(state);
1745         if (ACPI_FAILURE(status)) {
1746             device_printf(sc->acpi_dev, "AcpiEnterSleepStatePrep failed - %s\n",
1747                           AcpiFormatException(status));
1748             break;
1749         }
1750
1751         if (sc->acpi_sleep_delay > 0)
1752             DELAY(sc->acpi_sleep_delay * 1000000);
1753
1754         if (state != ACPI_STATE_S1) {
1755             acpi_sleep_machdep(sc, state);
1756
1757             /* AcpiEnterSleepState() may be incomplete, unlock if locked. */
1758             if (AcpiGbl_MutexInfo[ACPI_MTX_HARDWARE].OwnerId !=
1759                 ACPI_MUTEX_NOT_ACQUIRED) {
1760
1761                 AcpiUtReleaseMutex(ACPI_MTX_HARDWARE);
1762             }
1763
1764             /* Re-enable ACPI hardware on wakeup from sleep state 4. */
1765             if (state == ACPI_STATE_S4)
1766                 AcpiEnable();
1767         } else {
1768             status = AcpiEnterSleepState((UINT8)state);
1769             if (ACPI_FAILURE(status)) {
1770                 device_printf(sc->acpi_dev, "AcpiEnterSleepState failed - %s\n",
1771                               AcpiFormatException(status));
1772                 break;
1773             }
1774         }
1775         AcpiLeaveSleepState((UINT8)state);
1776         DEVICE_RESUME(root_bus);
1777         sc->acpi_sstate = ACPI_STATE_S0;
1778         acpi_enable_fixed_events(sc);
1779         break;
1780     case ACPI_STATE_S5:
1781         /*
1782          * Shut down cleanly and power off.  This will call us back through the
1783          * shutdown handlers.
1784          */
1785         shutdown_nice(RB_POWEROFF);
1786         break;
1787     case ACPI_STATE_S0:
1788     default:
1789         status = AE_BAD_PARAMETER;
1790         break;
1791     }
1792
1793     /* Disable a second sleep request for a short period */
1794     if (sc->acpi_sleep_disabled)
1795         callout_reset(&sc->acpi_sleep_timer, hz * ACPI_MINIMUM_AWAKETIME,
1796                       acpi_sleep_enable, sc);
1797
1798     return_ACPI_STATUS (status);
1799 }
1800
1801 /* Initialize a device's wake GPE. */
1802 int
1803 acpi_wake_init(device_t dev, int type)
1804 {
1805     struct acpi_prw_data prw;
1806
1807     /* Check that the device can wake the system. */
1808     if ((device_get_flags(dev) & ACPI_FLAG_WAKE_CAPABLE) == 0)
1809         return (ENXIO);
1810
1811     /* Evaluate _PRW to find the GPE. */
1812     if (acpi_parse_prw(acpi_get_handle(dev), &prw) != 0)
1813         return (ENXIO);
1814
1815     /* Set the requested type for the GPE (runtime, wake, or both). */
1816     if (ACPI_FAILURE(AcpiSetGpeType(prw.gpe_handle, prw.gpe_bit, type))) {
1817         device_printf(dev, "set GPE type failed\n");
1818         return (ENXIO);
1819     }
1820
1821     return (0);
1822 }
1823
1824 /* Enable or disable the device's wake GPE. */
1825 int
1826 acpi_wake_set_enable(device_t dev, int enable)
1827 {
1828     struct acpi_prw_data prw;
1829     ACPI_HANDLE handle;
1830     ACPI_STATUS status;
1831     int flags;
1832
1833     /* Make sure the device supports waking the system. */
1834     flags = device_get_flags(dev);
1835     handle = acpi_get_handle(dev);
1836     if ((flags & ACPI_FLAG_WAKE_CAPABLE) == 0 || handle == NULL)
1837         return (ENXIO);
1838
1839     /* Evaluate _PRW to find the GPE. */
1840     if (acpi_parse_prw(handle, &prw) != 0)
1841         return (ENXIO);
1842
1843     if (enable) {
1844         status = AcpiEnableGpe(prw.gpe_handle, prw.gpe_bit, ACPI_NOT_ISR);
1845         if (ACPI_FAILURE(status)) {
1846             device_printf(dev, "enable wake failed\n");
1847             return (ENXIO);
1848         }
1849         device_set_flags(dev, flags | ACPI_FLAG_WAKE_ENABLED);
1850     } else {
1851         status = AcpiDisableGpe(prw.gpe_handle, prw.gpe_bit, ACPI_NOT_ISR);
1852         if (ACPI_FAILURE(status)) {
1853             device_printf(dev, "disable wake failed\n");
1854             return (ENXIO);
1855         }
1856         device_set_flags(dev, flags & ~ACPI_FLAG_WAKE_ENABLED);
1857     }
1858
1859     return (0);
1860 }
1861
1862 /* Configure a device's GPE appropriately for the new sleep state. */
1863 int
1864 acpi_wake_sleep_prep(device_t dev, int sstate)
1865 {
1866     struct acpi_prw_data prw;
1867     ACPI_HANDLE handle;
1868     int flags;
1869
1870     /* Check that this is an ACPI device and get its GPE. */
1871     flags = device_get_flags(dev);
1872     handle = acpi_get_handle(dev);
1873     if ((flags & ACPI_FLAG_WAKE_CAPABLE) == 0 || handle == NULL)
1874         return (ENXIO);
1875
1876     /* Evaluate _PRW to find the GPE. */
1877     if (acpi_parse_prw(handle, &prw) != 0)
1878         return (ENXIO);
1879
1880     /*
1881      * TBD: All Power Resources referenced by elements 2 through N
1882      *      of the _PRW object are put into the ON state.
1883      */
1884
1885     /*
1886      * If the user requested that this device wake the system and the next
1887      * sleep state is valid for this GPE, enable it and the device's wake
1888      * capability.  The sleep state must be less than (i.e., higher power)
1889      * or equal to the value specified by _PRW.  Return early, leaving
1890      * the appropriate power resources enabled.
1891      */
1892     if ((flags & ACPI_FLAG_WAKE_ENABLED) != 0 &&
1893         sstate <= prw.lowest_wake) {
1894         if (bootverbose)
1895             device_printf(dev, "wake_prep enabled gpe %#x for state %d\n",
1896                 prw.gpe_bit, sstate);
1897         AcpiEnableGpe(prw.gpe_handle, prw.gpe_bit, ACPI_NOT_ISR);
1898         acpi_SetInteger(handle, "_PSW", 1);
1899         return (0);
1900     }
1901
1902     /*
1903      * If the device wake was disabled or this sleep state is too low for
1904      * this device, disable its wake capability and GPE.
1905      */
1906     AcpiDisableGpe(prw.gpe_handle, prw.gpe_bit, ACPI_NOT_ISR);
1907     acpi_SetInteger(handle, "_PSW", 0);
1908     if (bootverbose)
1909         device_printf(dev, "wake_prep disabled gpe %#x for state %d\n",
1910             prw.gpe_bit, sstate);
1911
1912     /*
1913      * TBD: All Power Resources referenced by elements 2 through N
1914      *      of the _PRW object are put into the OFF state.
1915      */
1916
1917     return (0);
1918 }
1919
1920 /* Re-enable GPEs after wake. */
1921 int
1922 acpi_wake_run_prep(device_t dev)
1923 {
1924     struct acpi_prw_data prw;
1925     ACPI_HANDLE handle;
1926     int flags;
1927
1928     /* Check that this is an ACPI device and get its GPE. */
1929     flags = device_get_flags(dev);
1930     handle = acpi_get_handle(dev);
1931     if ((flags & ACPI_FLAG_WAKE_CAPABLE) == 0 || handle == NULL)
1932         return (ENXIO);
1933
1934     /* Evaluate _PRW to find the GPE. */
1935     if (acpi_parse_prw(handle, &prw) != 0)
1936         return (ENXIO);
1937
1938     /*
1939      * TBD: Be sure all Power Resources referenced by elements 2 through N
1940      *      of the _PRW object are in the ON state.
1941      */
1942
1943     /* Disable wake capability and if the user requested, enable the GPE. */
1944     acpi_SetInteger(handle, "_PSW", 0);
1945     if ((flags & ACPI_FLAG_WAKE_ENABLED) != 0)
1946         AcpiEnableGpe(prw.gpe_handle, prw.gpe_bit, ACPI_NOT_ISR);
1947     return (0);
1948 }
1949
1950 static ACPI_STATUS
1951 acpi_wake_limit(ACPI_HANDLE h, UINT32 level, void *context, void **status)
1952 {
1953     struct acpi_prw_data prw;
1954     int *sstate;
1955
1956     /* It's ok not to have _PRW if the device can't wake the system. */
1957     if (acpi_parse_prw(h, &prw) != 0)
1958         return (AE_OK);
1959
1960     sstate = (int *)context;
1961     if (*sstate > prw.lowest_wake)
1962         AcpiDisableGpe(prw.gpe_handle, prw.gpe_bit, ACPI_NOT_ISR);
1963
1964     return (AE_OK);
1965 }
1966
1967 /* Walk all system devices, disabling them if necessary for sstate. */
1968 static int
1969 acpi_wake_limit_walk(int sstate)
1970 {
1971     ACPI_HANDLE sb_handle;
1972
1973     if (ACPI_SUCCESS(AcpiGetHandle(ACPI_ROOT_OBJECT, "\\_SB_", &sb_handle)))
1974         AcpiWalkNamespace(ACPI_TYPE_ANY, sb_handle, 100,
1975             acpi_wake_limit, &sstate, NULL);
1976     return (0);
1977 }
1978
1979 /* Walk the tree rooted at acpi0 to attach per-device wake sysctls. */
1980 static int
1981 acpi_wake_sysctl_walk(device_t dev)
1982 {
1983     int error, i, numdevs;
1984     device_t *devlist;
1985     device_t child;
1986
1987     error = device_get_children(dev, &devlist, &numdevs);
1988     if (error != 0 || numdevs == 0)
1989         return (error);
1990     for (i = 0; i < numdevs; i++) {
1991         child = devlist[i];
1992         if (!device_is_attached(child))
1993             continue;
1994         if (device_get_flags(child) & ACPI_FLAG_WAKE_CAPABLE) {
1995 #ifdef dfly_notyet
1996             SYSCTL_ADD_PROC(device_get_sysctl_ctx(child),
1997                 SYSCTL_CHILDREN(device_get_sysctl_tree(child)), OID_AUTO,
1998                 "wake", CTLTYPE_INT | CTLFLAG_RW, child, 0,
1999                 acpi_wake_set_sysctl, "I", "Device set to wake the system");
2000 #endif /* dfly_notyet */
2001         }
2002         acpi_wake_sysctl_walk(child);
2003     }
2004     free(devlist, M_TEMP);
2005
2006     return (0);
2007 }
2008
2009 #ifdef dfly_notyet
2010 /* Enable or disable wake from userland. */
2011 static int
2012 acpi_wake_set_sysctl(SYSCTL_HANDLER_ARGS)
2013 {
2014     int enable, error;
2015     device_t dev;
2016
2017     dev = (device_t)arg1;
2018     enable = (device_get_flags(dev) & ACPI_FLAG_WAKE_ENABLED) ? 1 : 0;
2019
2020     error = sysctl_handle_int(oidp, &enable, 0, req);
2021     if (error != 0 || req->newptr == NULL)
2022         return (error);
2023     if (enable != 0 && enable != 1)
2024         return (EINVAL);
2025
2026     return (acpi_wake_set_enable(dev, enable));
2027 }
2028 #endif /* dfly_notyet */
2029
2030 /* Parse a device's _PRW into a structure. */
2031 static int
2032 acpi_parse_prw(ACPI_HANDLE h, struct acpi_prw_data *prw)
2033 {
2034     ACPI_STATUS                 status;
2035     ACPI_BUFFER                 prw_buffer;
2036     ACPI_OBJECT                 *res, *res2;
2037     int error;
2038
2039     if (h == NULL || prw == NULL)
2040         return (EINVAL);
2041
2042     /*
2043      * The _PRW object (7.2.9) is only required for devices that have the
2044      * ability to wake the system from a sleeping state.
2045      */
2046     error = EINVAL;
2047     prw_buffer.Pointer = NULL;
2048     prw_buffer.Length = ACPI_ALLOCATE_BUFFER;
2049     status = AcpiEvaluateObject(h, "_PRW", NULL, &prw_buffer);
2050     if (ACPI_FAILURE(status))
2051         return (ENOENT);
2052     res = (ACPI_OBJECT *)prw_buffer.Pointer;
2053     if (res == NULL)
2054         return (ENOENT);
2055     if (!ACPI_PKG_VALID(res, 2))
2056         goto out;
2057
2058     /*
2059      * Element 1 of the _PRW object:
2060      * The lowest power system sleeping state that can be entered while still
2061      * providing wake functionality.  The sleeping state being entered must
2062      * be less than (i.e., higher power) or equal to this value.
2063      */
2064     if (acpi_PkgInt32(res, 1, &prw->lowest_wake) != 0)
2065         goto out;
2066
2067     /*
2068      * Element 0 of the _PRW object:
2069      */
2070     switch (res->Package.Elements[0].Type) {
2071     case ACPI_TYPE_INTEGER:
2072         /*
2073          * If the data type of this package element is numeric, then this
2074          * _PRW package element is the bit index in the GPEx_EN, in the
2075          * GPE blocks described in the FADT, of the enable bit that is
2076          * enabled for the wake event.
2077          */
2078         prw->gpe_handle = NULL;
2079         prw->gpe_bit = res->Package.Elements[0].Integer.Value;
2080         error = 0;
2081         break;
2082     case ACPI_TYPE_PACKAGE:
2083         /*
2084          * If the data type of this package element is a package, then this
2085          * _PRW package element is itself a package containing two
2086          * elements.  The first is an object reference to the GPE Block
2087          * device that contains the GPE that will be triggered by the wake
2088          * event.  The second element is numeric and it contains the bit
2089          * index in the GPEx_EN, in the GPE Block referenced by the
2090          * first element in the package, of the enable bit that is enabled for
2091          * the wake event.
2092          *
2093          * For example, if this field is a package then it is of the form:
2094          * Package() {\_SB.PCI0.ISA.GPE, 2}
2095          */
2096         res2 = &res->Package.Elements[0];
2097         if (!ACPI_PKG_VALID(res2, 2))
2098             goto out;
2099         prw->gpe_handle = acpi_GetReference(NULL, &res2->Package.Elements[0]);
2100         if (prw->gpe_handle == NULL)
2101             goto out;
2102         if (acpi_PkgInt32(res2, 1, &prw->gpe_bit) != 0)
2103             goto out;
2104         error = 0;
2105         break;
2106     default:
2107         goto out;
2108     }
2109
2110     /* XXX No power resource handling yet. */
2111     prw->power_res = NULL;
2112
2113 out:
2114     if (prw_buffer.Pointer != NULL)
2115         AcpiOsFree(prw_buffer.Pointer);
2116     return (error);
2117 }
2118
2119 /*
2120  * Enable/Disable ACPI
2121  */
2122 ACPI_STATUS
2123 acpi_Enable(struct acpi_softc *sc)
2124 {
2125     ACPI_STATUS status;
2126     u_int32_t   flags;
2127
2128     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
2129     ACPI_ASSERTLOCK;
2130
2131     flags = ACPI_NO_ADDRESS_SPACE_INIT | ACPI_NO_HARDWARE_INIT |
2132             ACPI_NO_DEVICE_INIT | ACPI_NO_OBJECT_INIT;
2133     if (!sc->acpi_enabled)
2134         status = AcpiEnableSubsystem(flags);
2135     else
2136         status = AE_OK;
2137
2138     if (status == AE_OK)
2139         sc->acpi_enabled = 1;
2140
2141     return_ACPI_STATUS (status);
2142 }
2143
2144 ACPI_STATUS
2145 acpi_Disable(struct acpi_softc *sc)
2146 {
2147     ACPI_STATUS status;
2148
2149     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
2150     ACPI_ASSERTLOCK;
2151
2152     if (sc->acpi_enabled)
2153         status = AcpiDisable();
2154     else
2155         status = AE_OK;
2156
2157     if (status == AE_OK)
2158         sc->acpi_enabled = 0;
2159
2160     return_ACPI_STATUS (status);
2161 }
2162
2163 /*
2164  * ACPI Event Handlers
2165  */
2166
2167 /* System Event Handlers (registered by EVENTHANDLER_REGISTER) */
2168
2169 static void
2170 acpi_system_eventhandler_sleep(void *arg, int state)
2171 {
2172     ACPI_LOCK_DECL;
2173     ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, state);
2174
2175     ACPI_LOCK;
2176     if (state >= ACPI_STATE_S0 && state <= ACPI_S_STATES_MAX)
2177         acpi_SetSleepState((struct acpi_softc *)arg, state);
2178     ACPI_UNLOCK;
2179     return_VOID;
2180 }
2181
2182 static void
2183 acpi_system_eventhandler_wakeup(void *arg, int state)
2184 {
2185     ACPI_LOCK_DECL;
2186     ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, state);
2187
2188     /* Well, what to do? :-) */
2189
2190     ACPI_LOCK;
2191     ACPI_UNLOCK;
2192
2193     return_VOID;
2194 }
2195
2196 /*
2197  * ACPICA Event Handlers (FixedEvent, also called from button notify handler)
2198  */
2199 UINT32
2200 acpi_event_power_button_sleep(void *context)
2201 {
2202     struct acpi_softc   *sc = (struct acpi_softc *)context;
2203
2204     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
2205
2206     EVENTHANDLER_INVOKE(acpi_sleep_event, sc->acpi_power_button_sx);
2207
2208     return_VALUE (ACPI_INTERRUPT_HANDLED);
2209 }
2210
2211 UINT32
2212 acpi_event_power_button_wake(void *context)
2213 {
2214     struct acpi_softc   *sc = (struct acpi_softc *)context;
2215
2216     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
2217
2218     EVENTHANDLER_INVOKE(acpi_wakeup_event, sc->acpi_power_button_sx);
2219
2220     return_VALUE (ACPI_INTERRUPT_HANDLED);
2221 }
2222
2223 UINT32
2224 acpi_event_sleep_button_sleep(void *context)
2225 {
2226     struct acpi_softc   *sc = (struct acpi_softc *)context;
2227
2228     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
2229
2230     EVENTHANDLER_INVOKE(acpi_sleep_event, sc->acpi_sleep_button_sx);
2231
2232     return_VALUE (ACPI_INTERRUPT_HANDLED);
2233 }
2234
2235 UINT32
2236 acpi_event_sleep_button_wake(void *context)
2237 {
2238     struct acpi_softc   *sc = (struct acpi_softc *)context;
2239
2240     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
2241
2242     EVENTHANDLER_INVOKE(acpi_wakeup_event, sc->acpi_sleep_button_sx);
2243
2244     return_VALUE (ACPI_INTERRUPT_HANDLED);
2245 }
2246
2247 /*
2248  * XXX This is kinda ugly, and should not be here.
2249  */
2250 struct acpi_staticbuf {
2251     ACPI_BUFFER buffer;
2252     char        data[512];
2253 };
2254
2255 char *
2256 acpi_name(ACPI_HANDLE handle)
2257 {
2258     static struct acpi_staticbuf        buf;
2259
2260     ACPI_ASSERTLOCK;
2261
2262     buf.buffer.Length = 512;
2263     buf.buffer.Pointer = &buf.data[0];
2264
2265     if (ACPI_SUCCESS(AcpiGetName(handle, ACPI_FULL_PATHNAME, &buf.buffer)))
2266         return (buf.buffer.Pointer);
2267
2268     return ("(unknown path)");
2269 }
2270
2271 /*
2272  * Debugging/bug-avoidance.  Avoid trying to fetch info on various
2273  * parts of the namespace.
2274  */
2275 int
2276 acpi_avoid(ACPI_HANDLE handle)
2277 {
2278     char        *cp, *env, *np;
2279     int         len;
2280
2281     np = acpi_name(handle);
2282     if (*np == '\\')
2283         np++;
2284     if ((env = getenv("debug.acpi.avoid.paths")) == NULL &&
2285         (env = getenv("debug.acpi.avoid")) == NULL)
2286         return (0);
2287
2288     /* Scan the avoid list checking for a match */
2289     cp = env;
2290     for (;;) {
2291         while ((*cp != 0) && isspace(*cp))
2292             cp++;
2293         if (*cp == 0)
2294             break;
2295         len = 0;
2296         while ((cp[len] != 0) && !isspace(cp[len]))
2297             len++;
2298         if (!strncmp(cp, np, len)) {
2299             freeenv(env);
2300             return(1);
2301         }
2302         cp += len;
2303     }
2304     freeenv(env);
2305
2306     return (0);
2307 }
2308
2309 /*
2310  * Debugging/bug-avoidance.  Disable ACPI subsystem components.   Note that
2311  * some components may be disabled by default and can only be enabled
2312  * via acpi_enabled() (debug.acpi.enabled).
2313  */
2314 int
2315 acpi_disabled(char *subsys)
2316 {
2317     char        *cp, *env;
2318     int         len;
2319
2320     if ((env = getenv("debug.acpi.disabled")) == NULL)
2321         return (0);
2322     if (strcmp(env, "all") == 0) {
2323         freeenv(env);
2324         return (1);
2325     }
2326
2327     /* Scan the disable list, checking for a match. */
2328     cp = env;
2329     for (;;) {
2330         while (*cp != '\0' && isspace(*cp))
2331             cp++;
2332         if (*cp == '\0')
2333             break;
2334         len = 0;
2335         while (cp[len] != '\0' && !isspace(cp[len]))
2336             len++;
2337         if (strncmp(cp, subsys, len) == 0) {
2338             freeenv(env);
2339             return (1);
2340         }
2341         cp += len;
2342     }
2343     freeenv(env);
2344
2345     return (0);
2346 }
2347
2348 /*
2349  * Debugging/bug-avoidance.  Enable ACPI subsystem components.  Most
2350  * components are enabled by default.  The ones that are not have to be
2351  * enabled via debug.acpi.enabled.
2352  */
2353 int
2354 acpi_enabled(char *subsys)
2355 {
2356     char        *cp, *env;
2357     int         len;
2358
2359     if ((env = getenv("debug.acpi.enabled")) == NULL)
2360         return (0);
2361     if (strcmp(env, "all") == 0) {
2362         freeenv(env);
2363         return (1);
2364     }
2365
2366     /* Scan the enable list, checking for a match. */
2367     cp = env;
2368     for (;;) {
2369         while (*cp != '\0' && isspace(*cp))
2370             cp++;
2371         if (*cp == '\0')
2372             break;
2373         len = 0;
2374         while (cp[len] != '\0' && !isspace(cp[len]))
2375             len++;
2376         if (strncmp(cp, subsys, len) == 0) {
2377             freeenv(env);
2378             return (1);
2379         }
2380         cp += len;
2381     }
2382     freeenv(env);
2383
2384     return (0);
2385 }
2386
2387 /*
2388  * Control interface.
2389  *
2390  * We multiplex ioctls for all participating ACPI devices here.  Individual
2391  * drivers wanting to be accessible via /dev/acpi should use the
2392  * register/deregister interface to make their handlers visible.
2393  */
2394 struct acpi_ioctl_hook
2395 {
2396     TAILQ_ENTRY(acpi_ioctl_hook) link;
2397     u_long                       cmd;
2398     acpi_ioctl_fn                fn;
2399     void                         *arg;
2400 };
2401
2402 static TAILQ_HEAD(,acpi_ioctl_hook)     acpi_ioctl_hooks;
2403 static int                              acpi_ioctl_hooks_initted;
2404
2405 /*
2406  * Register an ioctl handler.
2407  */
2408 int
2409 acpi_register_ioctl(u_long cmd, acpi_ioctl_fn fn, void *arg)
2410 {
2411     struct acpi_ioctl_hook      *hp;
2412
2413     hp = malloc(sizeof(*hp), M_ACPIDEV, M_INTWAIT);
2414     hp->cmd = cmd;
2415     hp->fn = fn;
2416     hp->arg = arg;
2417     if (acpi_ioctl_hooks_initted == 0) {
2418         TAILQ_INIT(&acpi_ioctl_hooks);
2419         acpi_ioctl_hooks_initted = 1;
2420     }
2421     TAILQ_INSERT_TAIL(&acpi_ioctl_hooks, hp, link);
2422     return (0);
2423 }
2424
2425 /*
2426  * Deregister an ioctl handler.
2427  */
2428 void
2429 acpi_deregister_ioctl(u_long cmd, acpi_ioctl_fn fn)
2430 {
2431     struct acpi_ioctl_hook      *hp;
2432
2433     TAILQ_FOREACH(hp, &acpi_ioctl_hooks, link)
2434         if ((hp->cmd == cmd) && (hp->fn == fn))
2435             break;
2436
2437     if (hp != NULL) {
2438         TAILQ_REMOVE(&acpi_ioctl_hooks, hp, link);
2439         free(hp, M_ACPIDEV);
2440     }
2441 }
2442
2443 static int
2444 acpiopen(dev_t dev, int flag, int fmt, d_thread_t *td)
2445 {
2446     return (0);
2447 }
2448
2449 static int
2450 acpiclose(dev_t dev, int flag, int fmt, d_thread_t *td)
2451 {
2452     return (0);
2453 }
2454
2455 static int
2456 acpiioctl(dev_t dev, u_long cmd, caddr_t addr, int flag, d_thread_t *td)
2457 {
2458     struct acpi_softc           *sc;
2459     struct acpi_ioctl_hook      *hp;
2460     int                         error, xerror, state;
2461     ACPI_LOCK_DECL;
2462
2463     ACPI_LOCK;
2464
2465     error = state = 0;
2466     sc = dev->si_drv1;
2467
2468     /*
2469      * Scan the list of registered ioctls, looking for handlers.
2470      */
2471     if (acpi_ioctl_hooks_initted) {
2472         TAILQ_FOREACH(hp, &acpi_ioctl_hooks, link) {
2473             if (hp->cmd == cmd) {
2474                 xerror = hp->fn(cmd, addr, hp->arg);
2475                 if (xerror != 0)
2476                     error = xerror;
2477                 goto out;
2478             }
2479         }
2480     }
2481
2482     /*
2483      * Core ioctls are not permitted for non-writable user.
2484      * Currently, other ioctls just fetch information.
2485      * Not changing system behavior.
2486      */
2487     if((flag & FWRITE) == 0)
2488         return (EPERM);
2489
2490     /* Core system ioctls. */
2491     switch (cmd) {
2492     case ACPIIO_ENABLE:
2493         if (ACPI_FAILURE(acpi_Enable(sc)))
2494             error = ENXIO;
2495         break;
2496     case ACPIIO_DISABLE:
2497         if (ACPI_FAILURE(acpi_Disable(sc)))
2498             error = ENXIO;
2499         break;
2500     case ACPIIO_SETSLPSTATE:
2501         if (!sc->acpi_enabled) {
2502             error = ENXIO;
2503             break;
2504         }
2505         state = *(int *)addr;
2506         if (state >= ACPI_STATE_S0  && state <= ACPI_S_STATES_MAX) {
2507             if (ACPI_FAILURE(acpi_SetSleepState(sc, state)))
2508                 error = EINVAL;
2509         } else {
2510             error = EINVAL;
2511         }
2512         break;
2513     default:
2514         if (error == 0)
2515             error = EINVAL;
2516         break;
2517     }
2518
2519 out:
2520     ACPI_UNLOCK;
2521     return (error);
2522 }
2523
2524 static int
2525 acpi_supported_sleep_state_sysctl(SYSCTL_HANDLER_ARGS)
2526 {
2527     char sleep_state[4];
2528     char buf[16];
2529     int error;
2530     UINT8 state, TypeA, TypeB;
2531
2532     buf[0] = '\0';
2533     for (state = ACPI_STATE_S1; state < ACPI_S_STATES_MAX + 1; state++) {
2534         if (ACPI_SUCCESS(AcpiGetSleepTypeData(state, &TypeA, &TypeB))) {
2535             sprintf(sleep_state, "S%d ", state);
2536             strcat(buf, sleep_state);
2537         }
2538     }
2539     error = sysctl_handle_string(oidp, buf, sizeof(buf), req);
2540     return (error);
2541 }
2542
2543 static int
2544 acpi_sleep_state_sysctl(SYSCTL_HANDLER_ARGS)
2545 {
2546     char sleep_state[10];
2547     int error;
2548     u_int new_state, old_state;
2549
2550     old_state = *(u_int *)oidp->oid_arg1;
2551     if (old_state > ACPI_S_STATES_MAX + 1) {
2552         strcpy(sleep_state, "unknown");
2553     } else {
2554         bzero(sleep_state, sizeof(sleep_state));
2555         strncpy(sleep_state, sleep_state_names[old_state],
2556                 sizeof(sleep_state_names[old_state]));
2557     }
2558     error = sysctl_handle_string(oidp, sleep_state, sizeof(sleep_state), req);
2559     if (error == 0 && req->newptr != NULL) {
2560         new_state = ACPI_STATE_S0;
2561         for (; new_state <= ACPI_S_STATES_MAX + 1; new_state++) {
2562             if (strncmp(sleep_state, sleep_state_names[new_state],
2563                         sizeof(sleep_state)) == 0)
2564                 break;
2565         }
2566         if (new_state <= ACPI_S_STATES_MAX + 1) {
2567             if (new_state != old_state)
2568                 *(u_int *)oidp->oid_arg1 = new_state;
2569         } else {
2570             error = EINVAL;
2571         }
2572     }
2573
2574     return (error);
2575 }
2576
2577 /* Inform devctl(4) when we receive a Notify. */
2578 void
2579 acpi_UserNotify(const char *subsystem, ACPI_HANDLE h, uint8_t notify)
2580 {
2581     char                notify_buf[16];
2582     ACPI_BUFFER         handle_buf;
2583     ACPI_STATUS         status;
2584
2585     if (subsystem == NULL)
2586         return;
2587
2588     handle_buf.Pointer = NULL;
2589     handle_buf.Length = ACPI_ALLOCATE_BUFFER;
2590     status = AcpiNsHandleToPathname(h, &handle_buf);
2591     if (ACPI_FAILURE(status))
2592         return;
2593     snprintf(notify_buf, sizeof(notify_buf), "notify=0x%02x", notify);
2594 #if 0
2595     devctl_notify("ACPI", subsystem, handle_buf.Pointer, notify_buf);
2596 #endif
2597     AcpiOsFree(handle_buf.Pointer);
2598 }
2599
2600 #ifdef ACPI_DEBUG
2601 /*
2602  * Support for parsing debug options from the kernel environment.
2603  *
2604  * Bits may be set in the AcpiDbgLayer and AcpiDbgLevel debug registers
2605  * by specifying the names of the bits in the debug.acpi.layer and
2606  * debug.acpi.level environment variables.  Bits may be unset by
2607  * prefixing the bit name with !.
2608  */
2609 struct debugtag
2610 {
2611     char        *name;
2612     UINT32      value;
2613 };
2614
2615 static struct debugtag  dbg_layer[] = {
2616     {"ACPI_UTILITIES",          ACPI_UTILITIES},
2617     {"ACPI_HARDWARE",           ACPI_HARDWARE},
2618     {"ACPI_EVENTS",             ACPI_EVENTS},
2619     {"ACPI_TABLES",             ACPI_TABLES},
2620     {"ACPI_NAMESPACE",          ACPI_NAMESPACE},
2621     {"ACPI_PARSER",             ACPI_PARSER},
2622     {"ACPI_DISPATCHER",         ACPI_DISPATCHER},
2623     {"ACPI_EXECUTER",           ACPI_EXECUTER},
2624     {"ACPI_RESOURCES",          ACPI_RESOURCES},
2625     {"ACPI_CA_DEBUGGER",        ACPI_CA_DEBUGGER},
2626     {"ACPI_OS_SERVICES",        ACPI_OS_SERVICES},
2627     {"ACPI_CA_DISASSEMBLER",    ACPI_CA_DISASSEMBLER},
2628     {"ACPI_ALL_COMPONENTS",     ACPI_ALL_COMPONENTS},
2629
2630     {"ACPI_AC_ADAPTER",         ACPI_AC_ADAPTER},
2631     {"ACPI_BATTERY",            ACPI_BATTERY},
2632     {"ACPI_BUS",                ACPI_BUS},
2633     {"ACPI_BUTTON",             ACPI_BUTTON},
2634     {"ACPI_EC",                 ACPI_EC},
2635     {"ACPI_FAN",                ACPI_FAN},
2636     {"ACPI_POWERRES",           ACPI_POWERRES},
2637     {"ACPI_PROCESSOR",          ACPI_PROCESSOR},
2638     {"ACPI_THERMAL",            ACPI_THERMAL},
2639     {"ACPI_TIMER",              ACPI_TIMER},
2640     {"ACPI_ALL_DRIVERS",        ACPI_ALL_DRIVERS},
2641     {NULL, 0}
2642 };
2643
2644 static struct debugtag dbg_level[] = {
2645     {"ACPI_LV_ERROR",           ACPI_LV_ERROR},
2646     {"ACPI_LV_WARN",            ACPI_LV_WARN},
2647     {"ACPI_LV_INIT",            ACPI_LV_INIT},
2648     {"ACPI_LV_DEBUG_OBJECT",    ACPI_LV_DEBUG_OBJECT},
2649     {"ACPI_LV_INFO",            ACPI_LV_INFO},
2650     {"ACPI_LV_ALL_EXCEPTIONS",  ACPI_LV_ALL_EXCEPTIONS},
2651
2652     /* Trace verbosity level 1 [Standard Trace Level] */
2653     {"ACPI_LV_INIT_NAMES",      ACPI_LV_INIT_NAMES},
2654     {"ACPI_LV_PARSE",           ACPI_LV_PARSE},
2655     {"ACPI_LV_LOAD",            ACPI_LV_LOAD},
2656     {"ACPI_LV_DISPATCH",        ACPI_LV_DISPATCH},
2657     {"ACPI_LV_EXEC",            ACPI_LV_EXEC},
2658     {"ACPI_LV_NAMES",           ACPI_LV_NAMES},
2659     {"ACPI_LV_OPREGION",        ACPI_LV_OPREGION},
2660     {"ACPI_LV_BFIELD",          ACPI_LV_BFIELD},
2661     {"ACPI_LV_TABLES",          ACPI_LV_TABLES},
2662     {"ACPI_LV_VALUES",          ACPI_LV_VALUES},
2663     {"ACPI_LV_OBJECTS",         ACPI_LV_OBJECTS},
2664     {"ACPI_LV_RESOURCES",       ACPI_LV_RESOURCES},
2665     {"ACPI_LV_USER_REQUESTS",   ACPI_LV_USER_REQUESTS},
2666     {"ACPI_LV_PACKAGE",         ACPI_LV_PACKAGE},
2667     {"ACPI_LV_VERBOSITY1",      ACPI_LV_VERBOSITY1},
2668
2669     /* Trace verbosity level 2 [Function tracing and memory allocation] */
2670     {"ACPI_LV_ALLOCATIONS",     ACPI_LV_ALLOCATIONS},
2671     {"ACPI_LV_FUNCTIONS",       ACPI_LV_FUNCTIONS},
2672     {"ACPI_LV_OPTIMIZATIONS",   ACPI_LV_OPTIMIZATIONS},
2673     {"ACPI_LV_VERBOSITY2",      ACPI_LV_VERBOSITY2},
2674     {"ACPI_LV_ALL",             ACPI_LV_ALL},
2675
2676     /* Trace verbosity level 3 [Threading, I/O, and Interrupts] */
2677     {"ACPI_LV_MUTEX",           ACPI_LV_MUTEX},
2678     {"ACPI_LV_THREADS",         ACPI_LV_THREADS},
2679     {"ACPI_LV_IO",              ACPI_LV_IO},
2680     {"ACPI_LV_INTERRUPTS",      ACPI_LV_INTERRUPTS},
2681     {"ACPI_LV_VERBOSITY3",      ACPI_LV_VERBOSITY3},
2682
2683     /* Exceptionally verbose output -- also used in the global "DebugLevel"  */
2684     {"ACPI_LV_AML_DISASSEMBLE", ACPI_LV_AML_DISASSEMBLE},
2685     {"ACPI_LV_VERBOSE_INFO",    ACPI_LV_VERBOSE_INFO},
2686     {"ACPI_LV_FULL_TABLES",     ACPI_LV_FULL_TABLES},
2687     {"ACPI_LV_EVENTS",          ACPI_LV_EVENTS},
2688     {"ACPI_LV_VERBOSE",         ACPI_LV_VERBOSE},
2689     {NULL, 0}
2690 };
2691
2692 static void
2693 acpi_parse_debug(char *cp, struct debugtag *tag, UINT32 *flag)
2694 {
2695     char        *ep;
2696     int         i, l;
2697     int         set;
2698
2699     while (*cp) {
2700         if (isspace(*cp)) {
2701             cp++;
2702             continue;
2703         }
2704         ep = cp;
2705         while (*ep && !isspace(*ep))
2706             ep++;
2707         if (*cp == '!') {
2708             set = 0;
2709             cp++;
2710             if (cp == ep)
2711                 continue;
2712         } else {
2713             set = 1;
2714         }
2715         l = ep - cp;
2716         for (i = 0; tag[i].name != NULL; i++) {
2717             if (!strncmp(cp, tag[i].name, l)) {
2718                 if (set)
2719                     *flag |= tag[i].value;
2720                 else
2721                     *flag &= ~tag[i].value;
2722             }
2723         }
2724         cp = ep;
2725     }
2726 }
2727
2728 static void
2729 acpi_set_debugging(void *junk)
2730 {
2731     char        *layer, *level;
2732
2733     if (cold) {
2734         AcpiDbgLayer = 0;
2735         AcpiDbgLevel = 0;
2736     }
2737
2738     layer = getenv("debug.acpi.layer");
2739     level = getenv("debug.acpi.level");
2740     if (layer == NULL && level == NULL)
2741         return;
2742
2743     printf("ACPI set debug");
2744     if (layer != NULL) {
2745         if (strcmp("NONE", layer) != 0)
2746             printf(" layer '%s'", layer);
2747         acpi_parse_debug(layer, &dbg_layer[0], &AcpiDbgLayer);
2748         freeenv(layer);
2749     }
2750     if (level != NULL) {
2751         if (strcmp("NONE", level) != 0)
2752             printf(" level '%s'", level);
2753         acpi_parse_debug(level, &dbg_level[0], &AcpiDbgLevel);
2754         freeenv(level);
2755     }
2756     printf("\n");
2757 }
2758 SYSINIT(acpi_debugging, SI_SUB_TUNABLES, SI_ORDER_ANY, acpi_set_debugging,
2759         NULL);
2760
2761 static int
2762 acpi_debug_sysctl(SYSCTL_HANDLER_ARGS)
2763 {
2764     int          error, *dbg;
2765     struct       debugtag *tag;
2766     struct       sbuf sb;
2767
2768     if (sbuf_new(&sb, NULL, 128, SBUF_AUTOEXTEND) == NULL)
2769         return (ENOMEM);
2770     if (strcmp(oidp->oid_arg1, "debug.acpi.layer") == 0) {
2771         tag = &dbg_layer[0];
2772         dbg = &AcpiDbgLayer;
2773     } else {
2774         tag = &dbg_level[0];
2775         dbg = &AcpiDbgLevel;
2776     }
2777
2778     /* Get old values if this is a get request. */
2779     if (*dbg == 0) {
2780         sbuf_cpy(&sb, "NONE");
2781     } else if (req->newptr == NULL) {
2782         for (; tag->name != NULL; tag++) {
2783             if ((*dbg & tag->value) == tag->value)
2784                 sbuf_printf(&sb, "%s ", tag->name);
2785         }
2786     }
2787     sbuf_trim(&sb);
2788     sbuf_finish(&sb);
2789
2790     /* Copy out the old values to the user. */
2791     error = SYSCTL_OUT(req, sbuf_data(&sb), sbuf_len(&sb));
2792     sbuf_delete(&sb);
2793
2794     /* If the user is setting a string, parse it. */
2795     if (error == 0 && req->newptr != NULL) {
2796         *dbg = 0;
2797         /* XXX setenv((char *)oidp->oid_arg1, (char *)req->newptr); */
2798         acpi_set_debugging(NULL);
2799     }
2800
2801     return (error);
2802 }
2803 SYSCTL_PROC(_debug_acpi, OID_AUTO, layer, CTLFLAG_RW | CTLTYPE_STRING,
2804             "debug.acpi.layer", 0, acpi_debug_sysctl, "A", "");
2805 SYSCTL_PROC(_debug_acpi, OID_AUTO, level, CTLFLAG_RW | CTLTYPE_STRING,
2806             "debug.acpi.level", 0, acpi_debug_sysctl, "A", "");
2807 #endif
2808
2809 static int
2810 acpi_pm_func(u_long cmd, void *arg, ...)
2811 {
2812         int     state, acpi_state;
2813         int     error;
2814         struct  acpi_softc *sc;
2815         va_list ap;
2816
2817         error = 0;
2818         switch (cmd) {
2819         case POWER_CMD_SUSPEND:
2820                 sc = (struct acpi_softc *)arg;
2821                 if (sc == NULL) {
2822                         error = EINVAL;
2823                         goto out;
2824                 }
2825
2826                 va_start(ap, arg);
2827                 state = va_arg(ap, int);
2828                 va_end(ap);
2829
2830                 switch (state) {
2831                 case POWER_SLEEP_STATE_STANDBY:
2832                         acpi_state = sc->acpi_standby_sx;
2833                         break;
2834                 case POWER_SLEEP_STATE_SUSPEND:
2835                         acpi_state = sc->acpi_suspend_sx;
2836                         break;
2837                 case POWER_SLEEP_STATE_HIBERNATE:
2838                         acpi_state = ACPI_STATE_S4;
2839                         break;
2840                 default:
2841                         error = EINVAL;
2842                         goto out;
2843                 }
2844
2845                 acpi_SetSleepState(sc, acpi_state);
2846                 break;
2847         default:
2848                 error = EINVAL;
2849                 goto out;
2850         }
2851
2852 out:
2853         return (error);
2854 }
2855
2856 static void
2857 acpi_pm_register(void *arg)
2858 {
2859     if (!cold || resource_disabled("acpi", 0))
2860         return;
2861
2862     power_pm_register(POWER_PM_TYPE_ACPI, acpi_pm_func, NULL);
2863 }
2864
2865 SYSINIT(power, SI_SUB_KLD, SI_ORDER_ANY, acpi_pm_register, 0);