sys/dev/acpica5/acpi_ec.c

   1 /*-
   2  * Copyright (c) 2003-2007 Nate Lawson
   3  * Copyright (c) 2000 Michael Smith
   4  * Copyright (c) 2000 BSDi
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  *
  28  * $FreeBSD: src/sys/dev/acpica/acpi_ec.c,v 1.76.2.1.6.1 2009/04/15 03:14:26 kensmith Exp $
  29  */
  30
  31 #include "opt_acpi.h"
  32 #include <sys/param.h>
  33 #include <sys/kernel.h>
  34 #include <sys/bus.h>
  35 #include <sys/lock.h>
  36 #include <sys/malloc.h>
  37 #include <sys/module.h>
  38 #include <sys/rman.h>
  39
  40 #include "acpi.h"
  41 #include <dev/acpica5/acpivar.h>
  42 #include "acutils.h"
  43
  44 /* Hooks for the ACPI CA debugging infrastructure */
  45 #define _COMPONENT      ACPI_EC
  46 ACPI_MODULE_NAME("EC")
  47
  48 #define rebooting 0
  49 #define PZERO 0
  50 /*
  51  * EC_COMMAND:
  52  * -----------
  53  */
  54 typedef UINT8                           EC_COMMAND;
  55
  56 #define EC_COMMAND_UNKNOWN              ((EC_COMMAND) 0x00)
  57 #define EC_COMMAND_READ                 ((EC_COMMAND) 0x80)
  58 #define EC_COMMAND_WRITE                ((EC_COMMAND) 0x81)
  59 #define EC_COMMAND_BURST_ENABLE         ((EC_COMMAND) 0x82)
  60 #define EC_COMMAND_BURST_DISABLE        ((EC_COMMAND) 0x83)
  61 #define EC_COMMAND_QUERY                ((EC_COMMAND) 0x84)
  62
  63 /*
  64  * EC_STATUS:
  65  * ----------
  66  * The encoding of the EC status register is illustrated below.
  67  * Note that a set bit (1) indicates the property is TRUE
  68  * (e.g. if bit 0 is set then the output buffer is full).
  69  * +-+-+-+-+-+-+-+-+
  70  * |7|6|5|4|3|2|1|0|
  71  * +-+-+-+-+-+-+-+-+
  72  *  | | | | | | | |
  73  *  | | | | | | | +- Output Buffer Full?
  74  *  | | | | | | +--- Input Buffer Full?
  75  *  | | | | | +----- <reserved>
  76  *  | | | | +------- Data Register is Command Byte?
  77  *  | | | +--------- Burst Mode Enabled?
  78  *  | | +----------- SCI Event?
  79  *  | +------------- SMI Event?
  80  *  +--------------- <reserved>
  81  *
  82  */
  83 typedef UINT8                           EC_STATUS;
  84
  85 #define EC_FLAG_OUTPUT_BUFFER           ((EC_STATUS) 0x01)
  86 #define EC_FLAG_INPUT_BUFFER            ((EC_STATUS) 0x02)
  87 #define EC_FLAG_DATA_IS_CMD             ((EC_STATUS) 0x08)
  88 #define EC_FLAG_BURST_MODE              ((EC_STATUS) 0x10)
  89
  90 /*
  91  * EC_EVENT:
  92  * ---------
  93  */
  94 typedef UINT8                           EC_EVENT;
  95
  96 #define EC_EVENT_UNKNOWN                ((EC_EVENT) 0x00)
  97 #define EC_EVENT_OUTPUT_BUFFER_FULL     ((EC_EVENT) 0x01)
  98 #define EC_EVENT_INPUT_BUFFER_EMPTY     ((EC_EVENT) 0x02)
  99 #define EC_EVENT_SCI                    ((EC_EVENT) 0x20)
 100 #define EC_EVENT_SMI                    ((EC_EVENT) 0x40)
 101
 102 /* Data byte returned after burst enable indicating it was successful. */
 103 #define EC_BURST_ACK                    0x90
 104
 105 /*
 106  * Register access primitives
 107  */
 108 #define EC_GET_DATA(sc)                                                 \
 109         bus_space_read_1((sc)->ec_data_tag, (sc)->ec_data_handle, 0)
 110
 111 #define EC_SET_DATA(sc, v)                                              \
 112         bus_space_write_1((sc)->ec_data_tag, (sc)->ec_data_handle, 0, (v))
 113
 114 #define EC_GET_CSR(sc)                                                  \
 115         bus_space_read_1((sc)->ec_csr_tag, (sc)->ec_csr_handle, 0)
 116
 117 #define EC_SET_CSR(sc, v)                                               \
 118         bus_space_write_1((sc)->ec_csr_tag, (sc)->ec_csr_handle, 0, (v))
 119
 120 /* Additional params to pass from the probe routine */
 121 struct acpi_ec_params {
 122     int         glk;
 123     int         gpe_bit;
 124     ACPI_HANDLE gpe_handle;
 125     int         uid;
 126 };
 127
 128 /* Indicate that this device has already been probed via ECDT. */
 129 #define DEV_ECDT(x)     (acpi_get_magic(x) == (uintptr_t)&acpi_ec_devclass)
 130
 131 /*
 132  * Driver softc.
 133  */
 134 struct acpi_ec_softc {
 135     device_t            ec_dev;
 136     ACPI_HANDLE         ec_handle;
 137     int                 ec_uid;
 138     ACPI_HANDLE         ec_gpehandle;
 139     UINT8               ec_gpebit;
 140
 141     int                 ec_data_rid;
 142     struct resource     *ec_data_res;
 143     bus_space_tag_t     ec_data_tag;
 144     bus_space_handle_t  ec_data_handle;
 145
 146     int                 ec_csr_rid;
 147     struct resource     *ec_csr_res;
 148     bus_space_tag_t     ec_csr_tag;
 149     bus_space_handle_t  ec_csr_handle;
 150
 151     int                 ec_glk;
 152     int                 ec_glkhandle;
 153     int                 ec_burstactive;
 154     int                 ec_sci_pend;
 155     u_int               ec_gencount;
 156     int                 ec_suspending;
 157 };
 158
 159 /*
 160  * XXX njl
 161  * I couldn't find it in the spec but other implementations also use a
 162  * value of 1 ms for the time to acquire global lock.
 163  */
 164 #define EC_LOCK_TIMEOUT 1000
 165
 166 /* Default delay in microseconds between each run of the status polling loop. */
 167 #define EC_POLL_DELAY   5
 168
 169 /* Total time in ms spent waiting for a response from EC. */
 170 #define EC_TIMEOUT      750
 171
 172 #define EVENT_READY(event, status)                      \
 173         (((event) == EC_EVENT_OUTPUT_BUFFER_FULL &&     \
 174          ((status) & EC_FLAG_OUTPUT_BUFFER) != 0) ||    \
 175          ((event) == EC_EVENT_INPUT_BUFFER_EMPTY &&     \
 176          ((status) & EC_FLAG_INPUT_BUFFER) == 0))
 177
 178 ACPI_SERIAL_DECL(ec, "ACPI embedded controller");
 179
 180 SYSCTL_DECL(_debug_acpi);
 181 SYSCTL_NODE(_debug_acpi, OID_AUTO, ec, CTLFLAG_RD, NULL, "EC debugging");
 182
 183 static int      ec_burst_mode;
 184 TUNABLE_INT("debug.acpi.ec.burst", &ec_burst_mode);
 185 SYSCTL_INT(_debug_acpi_ec, OID_AUTO, burst, CTLFLAG_RW, &ec_burst_mode, 0,
 186     "Enable use of burst mode (faster for nearly all systems)");
 187 static int      ec_polled_mode;
 188 TUNABLE_INT("debug.acpi.ec.polled", &ec_polled_mode);
 189 SYSCTL_INT(_debug_acpi_ec, OID_AUTO, polled, CTLFLAG_RW, &ec_polled_mode, 0,
 190     "Force use of polled mode (only if interrupt mode doesn't work)");
 191 static int      ec_timeout = EC_TIMEOUT;
 192 TUNABLE_INT("debug.acpi.ec.timeout", &ec_timeout);
 193 SYSCTL_INT(_debug_acpi_ec, OID_AUTO, timeout, CTLFLAG_RW, &ec_timeout,
 194     EC_TIMEOUT, "Total time spent waiting for a response (poll+sleep)");
 195
 196 static ACPI_STATUS
 197 EcLock(struct acpi_ec_softc *sc)
 198 {
 199     ACPI_STATUS status;
 200
 201     ACPI_SERIAL_BEGIN(ec);
 202     /* If _GLK is non-zero, acquire the global lock. */
 203     status = AE_OK;
 204     if (sc->ec_glk) {
 205         status = AcpiAcquireGlobalLock(EC_LOCK_TIMEOUT, &sc->ec_glkhandle);
 206         if (ACPI_FAILURE(status))
 207             ACPI_SERIAL_END(ec);
 208     }
 209     return (status);
 210 }
 211
 212 static void
 213 EcUnlock(struct acpi_ec_softc *sc)
 214 {
 215     if (sc->ec_glk)
 216         AcpiReleaseGlobalLock(sc->ec_glkhandle);
 217     ACPI_SERIAL_END(ec);
 218 }
 219
 220 static uint32_t         EcGpeHandler(ACPI_HANDLE GpeDevice,
 221                                  UINT32 GpeNumber, void *Context);
 222 static ACPI_STATUS      EcSpaceSetup(ACPI_HANDLE Region, UINT32 Function,
 223                                 void *Context, void **return_Context);
 224 static ACPI_STATUS      EcSpaceHandler(UINT32 Function,
 225                                 ACPI_PHYSICAL_ADDRESS Address,
 226                                 UINT32 width, ACPI_INTEGER *Value,
 227                                 void *Context, void *RegionContext);
 228 static ACPI_STATUS      EcWaitEvent(struct acpi_ec_softc *sc, EC_EVENT Event,
 229                                 u_int gen_count);
 230 static ACPI_STATUS      EcCommand(struct acpi_ec_softc *sc, EC_COMMAND cmd);
 231 static ACPI_STATUS      EcRead(struct acpi_ec_softc *sc, UINT8 Address,
 232                                 UINT8 *Data);
 233 static ACPI_STATUS      EcWrite(struct acpi_ec_softc *sc, UINT8 Address,
 234                                 UINT8 *Data);
 235 static int              acpi_ec_probe(device_t dev);
 236 static int              acpi_ec_attach(device_t dev);
 237 static int              acpi_ec_suspend(device_t dev);
 238 static int              acpi_ec_resume(device_t dev);
 239 static int              acpi_ec_shutdown(device_t dev);
 240 static int              acpi_ec_read_method(device_t dev, u_int addr,
 241                                 ACPI_INTEGER *val, int width);
 242 static int              acpi_ec_write_method(device_t dev, u_int addr,
 243                                 ACPI_INTEGER val, int width);
 244
 245 static device_method_t acpi_ec_methods[] = {
 246     /* Device interface */
 247     DEVMETHOD(device_probe,     acpi_ec_probe),
 248     DEVMETHOD(device_attach,    acpi_ec_attach),
 249     DEVMETHOD(device_suspend,   acpi_ec_suspend),
 250     DEVMETHOD(device_resume,    acpi_ec_resume),
 251     DEVMETHOD(device_shutdown,  acpi_ec_shutdown),
 252
 253     /* Embedded controller interface */
 254     DEVMETHOD(acpi_ec_read,     acpi_ec_read_method),
 255     DEVMETHOD(acpi_ec_write,    acpi_ec_write_method),
 256
 257     {0, 0}
 258 };
 259
 260 static driver_t acpi_ec_driver = {
 261     "acpi_ec",
 262     acpi_ec_methods,
 263     sizeof(struct acpi_ec_softc),
 264 };
 265
 266 static devclass_t acpi_ec_devclass;
 267 DRIVER_MODULE(acpi_ec, acpi, acpi_ec_driver, acpi_ec_devclass, 0, 0);
 268 MODULE_DEPEND(acpi_ec, acpi, 1, 1, 1);
 269
 270 /*
 271  * Look for an ECDT and if we find one, set up default GPE and
 272  * space handlers to catch attempts to access EC space before
 273  * we have a real driver instance in place.
 274  *
 275  * TODO: Some old Gateway laptops need us to fake up an ECDT or
 276  * otherwise attach early so that _REG methods can run.
 277  */
 278 void
 279 acpi_ec_ecdt_probe(device_t parent)
 280 {
 281     ACPI_TABLE_ECDT *ecdt;
 282     ACPI_STATUS      status;
 283     device_t         child;
 284     ACPI_HANDLE      h;
 285     struct acpi_ec_params *params;
 286
 287     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
 288
 289     /* Find and validate the ECDT. */
 290     status = AcpiGetTable(ACPI_SIG_ECDT, 1, (ACPI_TABLE_HEADER **)&ecdt);
 291     if (ACPI_FAILURE(status) ||
 292         ecdt->Control.BitWidth != 8 ||
 293         ecdt->Data.BitWidth != 8) {
 294         return;
 295     }
 296
 297     /* Create the child device with the given unit number. */
 298     child = BUS_ADD_CHILD(parent, parent, 0, "acpi_ec", ecdt->Uid);
 299     if (child == NULL) {
 300         kprintf("%s: can't add child\n", __func__);
 301         return;
 302     }
 303
 304     /* Find and save the ACPI handle for this device. */
 305     status = AcpiGetHandle(NULL, ecdt->Id, &h);
 306     if (ACPI_FAILURE(status)) {
 307         device_delete_child(parent, child);
 308         kprintf("%s: can't get handle\n", __func__);
 309         return;
 310     }
 311     acpi_set_handle(child, h);
 312
 313     /* Set the data and CSR register addresses. */
 314     bus_set_resource(child, SYS_RES_IOPORT, 0, ecdt->Data.Address,
 315         /*count*/1);
 316     bus_set_resource(child, SYS_RES_IOPORT, 1, ecdt->Control.Address,
 317         /*count*/1);
 318
 319     /*
 320      * Store values for the probe/attach routines to use.  Store the
 321      * ECDT GPE bit and set the global lock flag according to _GLK.
 322      * Note that it is not perfectly correct to be evaluating a method
 323      * before initializing devices, but in practice this function
 324      * should be safe to call at this point.
 325      */
 326     params = kmalloc(sizeof(struct acpi_ec_params), M_TEMP, M_WAITOK | M_ZERO);
 327     params->gpe_handle = NULL;
 328     params->gpe_bit = ecdt->Gpe;
 329     params->uid = ecdt->Uid;
 330     acpi_GetInteger(h, "_GLK", &params->glk);
 331     acpi_set_private(child, params);
 332     acpi_set_magic(child, (uintptr_t)&acpi_ec_devclass);
 333
 334     /* Finish the attach process. */
 335     if (device_probe_and_attach(child) != 0)
 336         device_delete_child(parent, child);
 337 }
 338
 339 static int
 340 acpi_ec_probe(device_t dev)
 341 {
 342     ACPI_BUFFER buf;
 343     ACPI_HANDLE h;
 344     ACPI_OBJECT *obj;
 345     ACPI_STATUS status;
 346     device_t    peer;
 347     char        desc[64];
 348     int         ret;
 349     struct acpi_ec_params *params;
 350     static char *ec_ids[] = { "PNP0C09", NULL };
 351
 352     /* Check that this is a device and that EC is not disabled. */
 353     if (acpi_get_type(dev) != ACPI_TYPE_DEVICE || acpi_disabled("ec"))
 354         return (ENXIO);
 355
 356     /*
 357      * If probed via ECDT, set description and continue.  Otherwise,
 358      * we can access the namespace and make sure this is not a
 359      * duplicate probe.
 360      */
 361     ret = ENXIO;
 362     params = NULL;
 363     buf.Pointer = NULL;
 364     buf.Length = ACPI_ALLOCATE_BUFFER;
 365     if (DEV_ECDT(dev)) {
 366         params = acpi_get_private(dev);
 367         ret = 0;
 368     } else if (!acpi_disabled("ec") &&
 369         ACPI_ID_PROBE(device_get_parent(dev), dev, ec_ids)) {
 370         params = kmalloc(sizeof(struct acpi_ec_params), M_TEMP,
 371                         M_WAITOK | M_ZERO);
 372         h = acpi_get_handle(dev);
 373
 374         /*
 375          * Read the unit ID to check for duplicate attach and the
 376          * global lock value to see if we should acquire it when
 377          * accessing the EC.
 378          */
 379         status = acpi_GetInteger(h, "_UID", &params->uid);
 380         if (ACPI_FAILURE(status))
 381             params->uid = 0;
 382         status = acpi_GetInteger(h, "_GLK", &params->glk);
 383         if (ACPI_FAILURE(status))
 384             params->glk = 0;
 385
 386         /*
 387          * Evaluate the _GPE method to find the GPE bit used by the EC to
 388          * signal status (SCI).  If it's a package, it contains a reference
 389          * and GPE bit, similar to _PRW.
 390          */
 391         status = AcpiEvaluateObject(h, "_GPE", NULL, &buf);
 392         if (ACPI_FAILURE(status)) {
 393             device_printf(dev, "can't evaluate _GPE - %s\n",
 394                           AcpiFormatException(status));
 395             goto out;
 396         }
 397         obj = (ACPI_OBJECT *)buf.Pointer;
 398         if (obj == NULL)
 399             goto out;
 400
 401         switch (obj->Type) {
 402         case ACPI_TYPE_INTEGER:
 403             params->gpe_handle = NULL;
 404             params->gpe_bit = obj->Integer.Value;
 405             break;
 406         case ACPI_TYPE_PACKAGE:
 407             if (!ACPI_PKG_VALID(obj, 2))
 408                 goto out;
 409             params->gpe_handle =
 410                 acpi_GetReference(NULL, &obj->Package.Elements[0]);
 411             if (params->gpe_handle == NULL ||
 412                 acpi_PkgInt32(obj, 1, &params->gpe_bit) != 0)
 413                 goto out;
 414             break;
 415         default:
 416             device_printf(dev, "_GPE has invalid type %d\n", obj->Type);
 417             goto out;
 418         }
 419
 420         /* Store the values we got from the namespace for attach. */
 421         acpi_set_private(dev, params);
 422
 423         /*
 424          * Check for a duplicate probe.  This can happen when a probe
 425          * via ECDT succeeded already.  If this is a duplicate, disable
 426          * this device.
 427          */
 428         peer = devclass_get_device(acpi_ec_devclass, params->uid);
 429         if (peer == NULL || !device_is_alive(peer))
 430             ret = 0;
 431         else
 432             device_disable(dev);
 433     }
 434
 435 out:
 436     if (ret == 0) {
 437         ksnprintf(desc, sizeof(desc), "Embedded Controller: GPE %#x%s%s",
 438                  params->gpe_bit, (params->glk) ? ", GLK" : "",
 439                  DEV_ECDT(dev) ? ", ECDT" : "");
 440         device_set_desc_copy(dev, desc);
 441     }
 442
 443     if (ret > 0 && params)
 444         kfree(params, M_TEMP);
 445     if (buf.Pointer)
 446         AcpiOsFree(buf.Pointer);
 447     return (ret);
 448 }
 449
 450 static int
 451 acpi_ec_attach(device_t dev)
 452 {
 453     struct acpi_ec_softc        *sc;
 454     struct acpi_ec_params       *params;
 455     ACPI_STATUS                 Status;
 456
 457     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
 458
 459     /* Fetch/initialize softc (assumes softc is pre-zeroed). */
 460     sc = device_get_softc(dev);
 461     params = acpi_get_private(dev);
 462     sc->ec_dev = dev;
 463     sc->ec_handle = acpi_get_handle(dev);
 464     ACPI_SERIAL_INIT(ec);
 465
 466     /* Retrieve previously probed values via device ivars. */
 467     sc->ec_glk = params->glk;
 468     sc->ec_gpebit = params->gpe_bit;
 469     sc->ec_gpehandle = params->gpe_handle;
 470     sc->ec_uid = params->uid;
 471     sc->ec_suspending = FALSE;
 472     kfree(params, M_TEMP);
 473
 474     /* Attach bus resources for data and command/status ports. */
 475     sc->ec_data_rid = 0;
 476     sc->ec_data_res = bus_alloc_resource_any(sc->ec_dev, SYS_RES_IOPORT,
 477                         &sc->ec_data_rid, RF_ACTIVE);
 478     if (sc->ec_data_res == NULL) {
 479         device_printf(dev, "can't allocate data port\n");
 480         goto error;
 481     }
 482     sc->ec_data_tag = rman_get_bustag(sc->ec_data_res);
 483     sc->ec_data_handle = rman_get_bushandle(sc->ec_data_res);
 484
 485     sc->ec_csr_rid = 1;
 486     sc->ec_csr_res = bus_alloc_resource_any(sc->ec_dev, SYS_RES_IOPORT,
 487                         &sc->ec_csr_rid, RF_ACTIVE);
 488     if (sc->ec_csr_res == NULL) {
 489         device_printf(dev, "can't allocate command/status port\n");
 490         goto error;
 491     }
 492     sc->ec_csr_tag = rman_get_bustag(sc->ec_csr_res);
 493     sc->ec_csr_handle = rman_get_bushandle(sc->ec_csr_res);
 494
 495     /*
 496      * Install a handler for this EC's GPE bit.  We want edge-triggered
 497      * behavior.
 498      */
 499     ACPI_DEBUG_PRINT((ACPI_DB_RESOURCES, "attaching GPE handler\n"));
 500     Status = AcpiInstallGpeHandler(sc->ec_gpehandle, sc->ec_gpebit,
 501                 ACPI_GPE_EDGE_TRIGGERED, &EcGpeHandler, sc);
 502     if (ACPI_FAILURE(Status)) {
 503         device_printf(dev, "can't install GPE handler for %s - %s\n",
 504                       acpi_name(sc->ec_handle), AcpiFormatException(Status));
 505         goto error;
 506     }
 507
 508     /*
 509      * Install address space handler
 510      */
 511     ACPI_DEBUG_PRINT((ACPI_DB_RESOURCES, "attaching address space handler\n"));
 512     Status = AcpiInstallAddressSpaceHandler(sc->ec_handle, ACPI_ADR_SPACE_EC,
 513                 &EcSpaceHandler, &EcSpaceSetup, sc);
 514     if (ACPI_FAILURE(Status)) {
 515         device_printf(dev, "can't install address space handler for %s - %s\n",
 516                       acpi_name(sc->ec_handle), AcpiFormatException(Status));
 517         goto error;
 518     }
 519
 520     /* Enable runtime GPEs done internally by AcpiEnableGpe() */
 521
 522     Status = AcpiEnableGpe(sc->ec_gpehandle, sc->ec_gpebit);
 523     if (ACPI_FAILURE(Status)) {
 524         device_printf(dev, "AcpiEnableGpe failed: %s\n",
 525                       AcpiFormatException(Status));
 526         goto error;
 527     }
 528
 529     ACPI_DEBUG_PRINT((ACPI_DB_RESOURCES, "acpi_ec_attach complete\n"));
 530     return (0);
 531
 532 error:
 533     AcpiRemoveGpeHandler(sc->ec_gpehandle, sc->ec_gpebit, &EcGpeHandler);
 534     AcpiRemoveAddressSpaceHandler(sc->ec_handle, ACPI_ADR_SPACE_EC,
 535         EcSpaceHandler);
 536     if (sc->ec_csr_res)
 537         bus_release_resource(sc->ec_dev, SYS_RES_IOPORT, sc->ec_csr_rid,
 538                              sc->ec_csr_res);
 539     if (sc->ec_data_res)
 540         bus_release_resource(sc->ec_dev, SYS_RES_IOPORT, sc->ec_data_rid,
 541                              sc->ec_data_res);
 542     return (ENXIO);
 543 }
 544
 545 static int
 546 acpi_ec_suspend(device_t dev)
 547 {
 548     struct acpi_ec_softc        *sc;
 549
 550     sc = device_get_softc(dev);
 551     sc->ec_suspending = TRUE;
 552     return (0);
 553 }
 554
 555 static int
 556 acpi_ec_resume(device_t dev)
 557 {
 558     struct acpi_ec_softc        *sc;
 559
 560     sc = device_get_softc(dev);
 561     sc->ec_suspending = FALSE;
 562     return (0);
 563 }
 564
 565 static int
 566 acpi_ec_shutdown(device_t dev)
 567 {
 568     struct acpi_ec_softc        *sc;
 569
 570     /* Disable the GPE so we don't get EC events during shutdown. */
 571     sc = device_get_softc(dev);
 572     AcpiDisableGpe(sc->ec_gpehandle, sc->ec_gpebit);
 573     return (0);
 574 }
 575
 576 /* Methods to allow other devices (e.g., smbat) to read/write EC space. */
 577 static int
 578 acpi_ec_read_method(device_t dev, u_int addr, ACPI_INTEGER *val, int width)
 579 {
 580     struct acpi_ec_softc *sc;
 581     ACPI_STATUS status;
 582
 583     sc = device_get_softc(dev);
 584     status = EcSpaceHandler(ACPI_READ, addr, width * 8, val, sc, NULL);
 585     if (ACPI_FAILURE(status))
 586         return (ENXIO);
 587     return (0);
 588 }
 589
 590 static int
 591 acpi_ec_write_method(device_t dev, u_int addr, ACPI_INTEGER val, int width)
 592 {
 593     struct acpi_ec_softc *sc;
 594     ACPI_STATUS status;
 595
 596     sc = device_get_softc(dev);
 597     status = EcSpaceHandler(ACPI_WRITE, addr, width * 8, &val, sc, NULL);
 598     if (ACPI_FAILURE(status))
 599         return (ENXIO);
 600     return (0);
 601 }
 602
 603 static void
 604 EcGpeQueryHandler(void *Context)
 605 {
 606     struct acpi_ec_softc        *sc = (struct acpi_ec_softc *)Context;
 607     UINT8                       Data;
 608     ACPI_STATUS                 Status;
 609     char                        qxx[5];
 610
 611     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
 612     KASSERT(Context != NULL, ("EcGpeQueryHandler called with NULL"));
 613
 614     /* Serialize user access with EcSpaceHandler(). */
 615     Status = EcLock(sc);
 616     if (ACPI_FAILURE(Status)) {
 617         device_printf(sc->ec_dev, "GpeQuery lock error: %s\n",
 618             AcpiFormatException(Status));
 619         return;
 620     }
 621
 622     /*
 623      * Send a query command to the EC to find out which _Qxx call it
 624      * wants to make.  This command clears the SCI bit and also the
 625      * interrupt source since we are edge-triggered.  To prevent the GPE
 626      * that may arise from running the query from causing another query
 627      * to be queued, we clear the pending flag only after running it.
 628      */
 629     Status = EcCommand(sc, EC_COMMAND_QUERY);
 630     sc->ec_sci_pend = FALSE;
 631     if (ACPI_FAILURE(Status)) {
 632         EcUnlock(sc);
 633         device_printf(sc->ec_dev, "GPE query failed: %s\n",
 634             AcpiFormatException(Status));
 635         return;
 636     }
 637     Data = EC_GET_DATA(sc);
 638
 639     /*
 640      * We have to unlock before running the _Qxx method below since that
 641      * method may attempt to read/write from EC address space, causing
 642      * recursive acquisition of the lock.
 643      */
 644     EcUnlock(sc);
 645
 646     /* Ignore the value for "no outstanding event". (13.3.5) */
 647 #if 0
 648     CTR2(KTR_ACPI, "ec query ok,%s running _Q%02X", Data ? "" : " not", Data);
 649 #endif
 650     if (Data == 0)
 651         return;
 652
 653     /* Evaluate _Qxx to respond to the controller. */
 654     ksnprintf(qxx, sizeof(qxx), "_Q%02X", Data);
 655     AcpiUtStrupr(qxx);
 656     Status = AcpiEvaluateObject(sc->ec_handle, qxx, NULL, NULL);
 657     if (ACPI_FAILURE(Status) && Status != AE_NOT_FOUND) {
 658         device_printf(sc->ec_dev, "evaluation of query method %s failed: %s\n",
 659             qxx, AcpiFormatException(Status));
 660     }
 661
 662     /* Reenable runtime GPE if its execution was deferred. */
 663     if (sc->ec_sci_pend) {
 664         Status = AcpiFinishGpe(sc->ec_gpehandle, sc->ec_gpebit);
 665         if (ACPI_FAILURE(Status)) {
 666             device_printf(sc->ec_dev, "reenabling runtime GPE failed: %s\n",
 667                 AcpiFormatException(Status));
 668         }
 669     }
 670 }
 671
 672 /*
 673  * The GPE handler is called when IBE/OBF or SCI events occur.  We are
 674  * called from an unknown lock context.
 675  */
 676 static uint32_t
 677 EcGpeHandler(ACPI_HANDLE GpeDevice, UINT32 GpeNumber, void *Context)
 678 {
 679     struct acpi_ec_softc *sc = Context;
 680     ACPI_STATUS                Status;
 681     EC_STATUS                  EcStatus;
 682
 683     KASSERT(Context != NULL, ("EcGpeHandler called with NULL"));
 684 #if 0
 685     CTR0(KTR_ACPI, "ec gpe handler start");
 686 #endif
 687     /*
 688      * Notify EcWaitEvent() that the status register is now fresh.  If we
 689      * didn't do this, it wouldn't be possible to distinguish an old IBE
 690      * from a new one, for example when doing a write transaction (writing
 691      * address and then data values.)
 692      */
 693     atomic_add_int(&sc->ec_gencount, 1);
 694     wakeup(&sc->ec_gencount);
 695
 696     /*
 697      * If the EC_SCI bit of the status register is set, queue a query handler.
 698      * It will run the query and _Qxx method later, under the lock.
 699      */
 700     EcStatus = EC_GET_CSR(sc);
 701     if ((EcStatus & EC_EVENT_SCI) && !sc->ec_sci_pend) {
 702 #if 0
 703         CTR0(KTR_ACPI, "ec gpe queueing query handler");
 704 #endif
 705         Status = AcpiOsExecute(OSL_GPE_HANDLER, EcGpeQueryHandler, Context);
 706         if (ACPI_SUCCESS(Status))
 707             sc->ec_sci_pend = TRUE;
 708         else
 709             kprintf("EcGpeHandler: queuing GPE query handler failed\n");
 710     }
 711     return (0);
 712 }
 713
 714 static ACPI_STATUS
 715 EcSpaceSetup(ACPI_HANDLE Region, UINT32 Function, void *Context,
 716              void **RegionContext)
 717 {
 718
 719     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
 720
 721     /*
 722      * If deactivating a region, always set the output to NULL.  Otherwise,
 723      * just pass the context through.
 724      */
 725     if (Function == ACPI_REGION_DEACTIVATE)
 726         *RegionContext = NULL;
 727     else
 728         *RegionContext = Context;
 729
 730     return_ACPI_STATUS (AE_OK);
 731 }
 732
 733 static ACPI_STATUS
 734 EcSpaceHandler(UINT32 Function, ACPI_PHYSICAL_ADDRESS Address, UINT32 width,
 735                ACPI_INTEGER *Value, void *Context, void *RegionContext)
 736 {
 737     struct acpi_ec_softc        *sc = (struct acpi_ec_softc *)Context;
 738     ACPI_STATUS                 Status;
 739     UINT8                       EcAddr, EcData;
 740     int                         i;
 741
 742     ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, (UINT32)Address);
 743
 744     if (width % 8 != 0 || Value == NULL || Context == NULL)
 745         return_ACPI_STATUS (AE_BAD_PARAMETER);
 746     if (Address + (width / 8) - 1 > 0xFF)
 747         return_ACPI_STATUS (AE_BAD_ADDRESS);
 748
 749     if (Function == ACPI_READ)
 750         *Value = 0;
 751     EcAddr = Address;
 752     Status = AE_ERROR;
 753
 754     /*
 755      * If booting, check if we need to run the query handler.  If so, we
 756      * we call it directly here since our thread taskq is not active yet.
 757      */
 758     if (cold || rebooting) {
 759         if ((EC_GET_CSR(sc) & EC_EVENT_SCI)) {
 760 #if 0
 761             CTR0(KTR_ACPI, "ec running gpe handler directly");
 762 #endif
 763             EcGpeQueryHandler(sc);
 764         }
 765     }
 766
 767     /* Serialize with EcGpeQueryHandler() at transaction granularity. */
 768     Status = EcLock(sc);
 769     if (ACPI_FAILURE(Status)) {
 770         return_ACPI_STATUS (Status);
 771     }
 772
 773     /* Perform the transaction(s), based on width. */
 774     for (i = 0; i < width; i += 8, EcAddr++) {
 775         switch (Function) {
 776         case ACPI_READ:
 777             Status = EcRead(sc, EcAddr, &EcData);
 778             if (ACPI_SUCCESS(Status))
 779                 *Value |= ((ACPI_INTEGER)EcData) << i;
 780             break;
 781         case ACPI_WRITE:
 782             EcData = (UINT8)((*Value) >> i);
 783             Status = EcWrite(sc, EcAddr, &EcData);
 784             break;
 785         default:
 786             device_printf(sc->ec_dev, "invalid EcSpaceHandler function %d\n",
 787                           Function);
 788             Status = AE_BAD_PARAMETER;
 789             break;
 790         }
 791         if (ACPI_FAILURE(Status))
 792             break;
 793     }
 794
 795     EcUnlock(sc);
 796     return_ACPI_STATUS (Status);
 797 }
 798
 799 static ACPI_STATUS
 800 EcCheckStatus(struct acpi_ec_softc *sc, const char *msg, EC_EVENT event)
 801 {
 802     ACPI_STATUS status;
 803     EC_STATUS ec_status;
 804
 805     status = AE_NO_HARDWARE_RESPONSE;
 806     ec_status = EC_GET_CSR(sc);
 807     if (sc->ec_burstactive && !(ec_status & EC_FLAG_BURST_MODE)) {
 808 #if 0
 809         CTR1(KTR_ACPI, "ec burst disabled in waitevent (%s)", msg);
 810 #endif
 811         sc->ec_burstactive = FALSE;
 812     }
 813     if (EVENT_READY(event, ec_status)) {
 814 #if 0
 815         CTR2(KTR_ACPI, "ec %s wait ready, status %#x", msg, ec_status);
 816 #endif
 817         status = AE_OK;
 818     }
 819     return (status);
 820 }
 821
 822 static ACPI_STATUS
 823 EcWaitEvent(struct acpi_ec_softc *sc, EC_EVENT Event, u_int gen_count)
 824 {
 825     ACPI_STATUS Status;
 826     int         count, i, slp_ival;
 827
 828     ACPI_SERIAL_ASSERT(ec);
 829     Status = AE_NO_HARDWARE_RESPONSE;
 830     int need_poll = cold || rebooting || ec_polled_mode || sc->ec_suspending;
 831     /*
 832      * The main CPU should be much faster than the EC.  So the status should
 833      * be "not ready" when we start waiting.  But if the main CPU is really
 834      * slow, it's possible we see the current "ready" response.  Since that
 835      * can't be distinguished from the previous response in polled mode,
 836      * this is a potential issue.  We really should have interrupts enabled
 837      * during boot so there is no ambiguity in polled mode.
 838      *
 839      * If this occurs, we add an additional delay before actually entering
 840      * the status checking loop, hopefully to allow the EC to go to work
 841      * and produce a non-stale status.
 842      */
 843     if (need_poll) {
 844         static int      once;
 845
 846         if (EcCheckStatus(sc, "pre-check", Event) == AE_OK) {
 847             if (!once) {
 848                 device_printf(sc->ec_dev,
 849                     "warning: EC done before starting event wait\n");
 850                 once = 1;
 851             }
 852             AcpiOsStall(10);
 853         }
 854     }
 855
 856     /* Wait for event by polling or GPE (interrupt). */
 857     if (need_poll) {
 858         count = (ec_timeout * 1000) / EC_POLL_DELAY;
 859         if (count == 0)
 860             count = 1;
 861         for (i = 0; i < count; i++) {
 862             Status = EcCheckStatus(sc, "poll", Event);
 863             if (Status == AE_OK)
 864                 break;
 865             AcpiOsStall(EC_POLL_DELAY);
 866         }
 867     } else {
 868         slp_ival = hz / 1000;
 869         if (slp_ival != 0) {
 870             count = ec_timeout;
 871         } else {
 872             /* hz has less than 1 ms resolution so scale timeout. */
 873             slp_ival = 1;
 874             count = ec_timeout / (1000 / hz);
 875         }
 876
 877         /*
 878          * Wait for the GPE to signal the status changed, checking the
 879          * status register each time we get one.  It's possible to get a
 880          * GPE for an event we're not interested in here (i.e., SCI for
 881          * EC query).
 882          */
 883         for (i = 0; i < count; i++) {
 884             if (gen_count != sc->ec_gencount) {
 885                 /*
 886                  * Record new generation count.  It's possible the GPE was
 887                  * just to notify us that a query is needed and we need to
 888                  * wait for a second GPE to signal the completion of the
 889                  * event we are actually waiting for.
 890                  */
 891                 gen_count = sc->ec_gencount;
 892                 Status = EcCheckStatus(sc, "sleep", Event);
 893                 if (Status == AE_OK)
 894                     break;
 895             }
 896             tsleep(&sc->ec_gencount, PZERO, "ecgpe", slp_ival);
 897         }
 898
 899         /*
 900          * We finished waiting for the GPE and it never arrived.  Try to
 901          * read the register once and trust whatever value we got.  This is
 902          * the best we can do at this point.  Then, force polled mode on
 903          * since this system doesn't appear to generate GPEs.
 904          */
 905         if (Status != AE_OK) {
 906             Status = EcCheckStatus(sc, "sleep_end", Event);
 907             device_printf(sc->ec_dev,
 908                 "wait timed out (%sresponse), forcing polled mode\n",
 909                 Status == AE_OK ? "" : "no ");
 910             ec_polled_mode = TRUE;
 911         }
 912     }
 913 #if 0
 914     if (Status != AE_OK)
 915             CTR0(KTR_ACPI, "error: ec wait timed out");
 916 #endif
 917     return (Status);
 918 }
 919
 920 static ACPI_STATUS
 921 EcCommand(struct acpi_ec_softc *sc, EC_COMMAND cmd)
 922 {
 923     ACPI_STATUS status;
 924     EC_EVENT    event;
 925     EC_STATUS   ec_status;
 926     u_int       gen_count;
 927
 928     ACPI_SERIAL_ASSERT(ec);
 929
 930     /* Don't use burst mode if user disabled it. */
 931     if (!ec_burst_mode && cmd == EC_COMMAND_BURST_ENABLE)
 932         return (AE_ERROR);
 933
 934     /* Decide what to wait for based on command type. */
 935     switch (cmd) {
 936     case EC_COMMAND_READ:
 937     case EC_COMMAND_WRITE:
 938     case EC_COMMAND_BURST_DISABLE:
 939         event = EC_EVENT_INPUT_BUFFER_EMPTY;
 940         break;
 941     case EC_COMMAND_QUERY:
 942     case EC_COMMAND_BURST_ENABLE:
 943         event = EC_EVENT_OUTPUT_BUFFER_FULL;
 944         break;
 945     default:
 946         device_printf(sc->ec_dev, "EcCommand: invalid command %#x\n", cmd);
 947         return (AE_BAD_PARAMETER);
 948     }
 949
 950     /* Run the command and wait for the chosen event. */
 951 #if 0
 952     CTR1(KTR_ACPI, "ec running command %#x", cmd);
 953 #endif
 954     gen_count = sc->ec_gencount;
 955     EC_SET_CSR(sc, cmd);
 956     status = EcWaitEvent(sc, event, gen_count);
 957     if (ACPI_SUCCESS(status)) {
 958         /* If we succeeded, burst flag should now be present. */
 959         if (cmd == EC_COMMAND_BURST_ENABLE) {
 960             ec_status = EC_GET_CSR(sc);
 961             if ((ec_status & EC_FLAG_BURST_MODE) == 0)
 962                 status = AE_ERROR;
 963         }
 964     } else
 965         device_printf(sc->ec_dev, "EcCommand: no response to %#x\n", cmd);
 966     return (status);
 967 }
 968
 969 static ACPI_STATUS
 970 EcRead(struct acpi_ec_softc *sc, UINT8 Address, UINT8 *Data)
 971 {
 972     ACPI_STATUS status;
 973     UINT8 data;
 974     u_int gen_count;
 975
 976     ACPI_SERIAL_ASSERT(ec);
 977 #if 0
 978     CTR1(KTR_ACPI, "ec read from %#x", Address);
 979 #endif
 980     /* If we can't start burst mode, continue anyway. */
 981     status = EcCommand(sc, EC_COMMAND_BURST_ENABLE);
 982     if (status == AE_OK) {
 983         data = EC_GET_DATA(sc);
 984         if (data == EC_BURST_ACK) {
 985 #if 0
 986             CTR0(KTR_ACPI, "ec burst enabled");
 987 #endif
 988             sc->ec_burstactive = TRUE;
 989         }
 990     }
 991
 992     status = EcCommand(sc, EC_COMMAND_READ);
 993     if (ACPI_FAILURE(status))
 994         return (status);
 995
 996     gen_count = sc->ec_gencount;
 997     EC_SET_DATA(sc, Address);
 998     status = EcWaitEvent(sc, EC_EVENT_OUTPUT_BUFFER_FULL, gen_count);
 999     if (ACPI_FAILURE(status)) {
1000         device_printf(sc->ec_dev, "EcRead: failed waiting to get data\n");
1001         return (status);
1002     }
1003     *Data = EC_GET_DATA(sc);
1004
1005     if (sc->ec_burstactive) {
1006         sc->ec_burstactive = FALSE;
1007         status = EcCommand(sc, EC_COMMAND_BURST_DISABLE);
1008         if (ACPI_FAILURE(status))
1009             return (status);
1010 #if 0
1011         CTR0(KTR_ACPI, "ec disabled burst ok");
1012 #endif
1013     }
1014
1015     return (AE_OK);
1016 }
1017
1018 static ACPI_STATUS
1019 EcWrite(struct acpi_ec_softc *sc, UINT8 Address, UINT8 *Data)
1020 {
1021     ACPI_STATUS status;
1022     UINT8 data;
1023     u_int gen_count;
1024
1025     ACPI_SERIAL_ASSERT(ec);
1026 #if 0
1027     CTR2(KTR_ACPI, "ec write to %#x, data %#x", Address, *Data);
1028 #endif
1029
1030     /* If we can't start burst mode, continue anyway. */
1031     status = EcCommand(sc, EC_COMMAND_BURST_ENABLE);
1032     if (status == AE_OK) {
1033         data = EC_GET_DATA(sc);
1034         if (data == EC_BURST_ACK) {
1035 #if 0
1036             CTR0(KTR_ACPI, "ec burst enabled");
1037 #endif
1038             sc->ec_burstactive = TRUE;
1039         }
1040     }
1041
1042     status = EcCommand(sc, EC_COMMAND_WRITE);
1043     if (ACPI_FAILURE(status))
1044         return (status);
1045
1046     gen_count = sc->ec_gencount;
1047     EC_SET_DATA(sc, Address);
1048     status = EcWaitEvent(sc, EC_EVENT_INPUT_BUFFER_EMPTY, gen_count);
1049     if (ACPI_FAILURE(status)) {
1050         device_printf(sc->ec_dev, "EcRead: failed waiting for sent address\n");
1051         return (status);
1052     }
1053
1054     gen_count = sc->ec_gencount;
1055     EC_SET_DATA(sc, *Data);
1056     status = EcWaitEvent(sc, EC_EVENT_INPUT_BUFFER_EMPTY, gen_count);
1057     if (ACPI_FAILURE(status)) {
1058         device_printf(sc->ec_dev, "EcWrite: failed waiting for sent data\n");
1059         return (status);
1060     }
1061
1062     if (sc->ec_burstactive) {
1063         sc->ec_burstactive = FALSE;
1064         status = EcCommand(sc, EC_COMMAND_BURST_DISABLE);
1065         if (ACPI_FAILURE(status))
1066             return (status);
1067 #if 0
1068         CTR0(KTR_ACPI, "ec disabled burst ok");
1069 #endif
1070     }
1071
1072     return (AE_OK);
1073 }