sys/dev/acpica/acpi_ec.c

   1 /*-
   2  * Copyright (c) 2003 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 /*-
  29  ******************************************************************************
  30  *
  31  * 1. Copyright Notice
  32  *
  33  * Some or all of this work - Copyright (c) 1999, Intel Corp.  All rights
  34  * reserved.
  35  *
  36  * 2. License
  37  *
  38  * 2.1. This is your license from Intel Corp. under its intellectual property
  39  * rights.  You may have additional license terms from the party that provided
  40  * you this software, covering your right to use that party's intellectual
  41  * property rights.
  42  *
  43  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  44  * copy of the source code appearing in this file ("Covered Code") an
  45  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  46  * base code distributed originally by Intel ("Original Intel Code") to copy,
  47  * make derivatives, distribute, use and display any portion of the Covered
  48  * Code in any form, with the right to sublicense such rights; and
  49  *
  50  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  51  * license (with the right to sublicense), under only those claims of Intel
  52  * patents that are infringed by the Original Intel Code, to make, use, sell,
  53  * offer to sell, and import the Covered Code and derivative works thereof
  54  * solely to the minimum extent necessary to exercise the above copyright
  55  * license, and in no event shall the patent license extend to any additions
  56  * to or modifications of the Original Intel Code.  No other license or right
  57  * is granted directly or by implication, estoppel or otherwise;
  58  *
  59  * The above copyright and patent license is granted only if the following
  60  * conditions are met:
  61  *
  62  * 3. Conditions
  63  *
  64  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  65  * Redistribution of source code of any substantial portion of the Covered
  66  * Code or modification with rights to further distribute source must include
  67  * the above Copyright Notice, the above License, this list of Conditions,
  68  * and the following Disclaimer and Export Compliance provision.  In addition,
  69  * Licensee must cause all Covered Code to which Licensee contributes to
  70  * contain a file documenting the changes Licensee made to create that Covered
  71  * Code and the date of any change.  Licensee must include in that file the
  72  * documentation of any changes made by any predecessor Licensee.  Licensee
  73  * must include a prominent statement that the modification is derived,
  74  * directly or indirectly, from Original Intel Code.
  75  *
  76  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  77  * Redistribution of source code of any substantial portion of the Covered
  78  * Code or modification without rights to further distribute source must
  79  * include the following Disclaimer and Export Compliance provision in the
  80  * documentation and/or other materials provided with distribution.  In
  81  * addition, Licensee may not authorize further sublicense of source of any
  82  * portion of the Covered Code, and must include terms to the effect that the
  83  * license from Licensee to its licensee is limited to the intellectual
  84  * property embodied in the software Licensee provides to its licensee, and
  85  * not to intellectual property embodied in modifications its licensee may
  86  * make.
  87  *
  88  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  89  * substantial portion of the Covered Code or modification must reproduce the
  90  * above Copyright Notice, and the following Disclaimer and Export Compliance
  91  * provision in the documentation and/or other materials provided with the
  92  * distribution.
  93  *
  94  * 3.4. Intel retains all right, title, and interest in and to the Original
  95  * Intel Code.
  96  *
  97  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  98  * Intel shall be used in advertising or otherwise to promote the sale, use or
  99  * other dealings in products derived from or relating to the Covered Code
 100  * without prior written authorization from Intel.
 101  *
 102  * 4. Disclaimer and Export Compliance
 103  *
 104  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
 105  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
 106  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
 107  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
 108  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
 109  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
 110  * PARTICULAR PURPOSE.
 111  *
 112  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
 113  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
 114  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
 115  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
 116  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
 117  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
 118  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
 119  * LIMITED REMEDY.
 120  *
 121  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 122  * software or system incorporating such software without first obtaining any
 123  * required license or other approval from the U. S. Department of Commerce or
 124  * any other agency or department of the United States Government.  In the
 125  * event Licensee exports any such software from the United States or
 126  * re-exports any such software from a foreign destination, Licensee shall
 127  * ensure that the distribution and export/re-export of the software is in
 128  * compliance with all laws, regulations, orders, or other restrictions of the
 129  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 130  * any of its subsidiaries will export/re-export any technical data, process,
 131  * software, or service, directly or indirectly, to any country for which the
 132  * United States government or any agency thereof requires an export license,
 133  * other governmental approval, or letter of assurance, without first obtaining
 134  * such license, approval or letter.
 135  *
 136  *****************************************************************************/
 137
 138 #include <sys/cdefs.h>
 139 __FBSDID("$FreeBSD$");
 140
 141 #include "opt_acpi.h"
 142 #include <sys/param.h>
 143 #include <sys/kernel.h>
 144 #include <sys/bus.h>
 145 #include <sys/malloc.h>
 146 #include <sys/module.h>
 147 #include <sys/sx.h>
 148
 149 #include <machine/bus.h>
 150 #include <machine/resource.h>
 151 #include <sys/rman.h>
 152
 153 #include "acpi.h"
 154 #include <dev/acpica/acpivar.h>
 155
 156 /* Hooks for the ACPI CA debugging infrastructure */
 157 #define _COMPONENT      ACPI_EC
 158 ACPI_MODULE_NAME("EC")
 159
 160 /*
 161  * EC_COMMAND:
 162  * -----------
 163  */
 164 typedef UINT8                           EC_COMMAND;
 165
 166 #define EC_COMMAND_UNKNOWN              ((EC_COMMAND) 0x00)
 167 #define EC_COMMAND_READ                 ((EC_COMMAND) 0x80)
 168 #define EC_COMMAND_WRITE                ((EC_COMMAND) 0x81)
 169 #define EC_COMMAND_BURST_ENABLE         ((EC_COMMAND) 0x82)
 170 #define EC_COMMAND_BURST_DISABLE        ((EC_COMMAND) 0x83)
 171 #define EC_COMMAND_QUERY                ((EC_COMMAND) 0x84)
 172
 173 /*
 174  * EC_STATUS:
 175  * ----------
 176  * The encoding of the EC status register is illustrated below.
 177  * Note that a set bit (1) indicates the property is TRUE
 178  * (e.g. if bit 0 is set then the output buffer is full).
 179  * +-+-+-+-+-+-+-+-+
 180  * |7|6|5|4|3|2|1|0|
 181  * +-+-+-+-+-+-+-+-+
 182  *  | | | | | | | |
 183  *  | | | | | | | +- Output Buffer Full?
 184  *  | | | | | | +--- Input Buffer Full?
 185  *  | | | | | +----- <reserved>
 186  *  | | | | +------- Data Register is Command Byte?
 187  *  | | | +--------- Burst Mode Enabled?
 188  *  | | +----------- SCI Event?
 189  *  | +------------- SMI Event?
 190  *  +--------------- <Reserved>
 191  *
 192  */
 193 typedef UINT8                           EC_STATUS;
 194
 195 #define EC_FLAG_OUTPUT_BUFFER           ((EC_STATUS) 0x01)
 196 #define EC_FLAG_INPUT_BUFFER            ((EC_STATUS) 0x02)
 197 #define EC_FLAG_BURST_MODE              ((EC_STATUS) 0x10)
 198 #define EC_FLAG_SCI                     ((EC_STATUS) 0x20)
 199
 200 /*
 201  * EC_EVENT:
 202  * ---------
 203  */
 204 typedef UINT8                           EC_EVENT;
 205
 206 #define EC_EVENT_UNKNOWN                ((EC_EVENT) 0x00)
 207 #define EC_EVENT_OUTPUT_BUFFER_FULL     ((EC_EVENT) 0x01)
 208 #define EC_EVENT_INPUT_BUFFER_EMPTY     ((EC_EVENT) 0x02)
 209 #define EC_EVENT_SCI                    ((EC_EVENT) 0x20)
 210
 211 /*
 212  * Register access primitives
 213  */
 214 #define EC_GET_DATA(sc)                                                 \
 215         bus_space_read_1((sc)->ec_data_tag, (sc)->ec_data_handle, 0)
 216
 217 #define EC_SET_DATA(sc, v)                                              \
 218         bus_space_write_1((sc)->ec_data_tag, (sc)->ec_data_handle, 0, (v))
 219
 220 #define EC_GET_CSR(sc)                                                  \
 221         bus_space_read_1((sc)->ec_csr_tag, (sc)->ec_csr_handle, 0)
 222
 223 #define EC_SET_CSR(sc, v)                                               \
 224         bus_space_write_1((sc)->ec_csr_tag, (sc)->ec_csr_handle, 0, (v))
 225
 226 /* Embedded Controller Boot Resources Table (ECDT) */
 227 typedef struct {
 228     ACPI_TABLE_HEADER           header;
 229     ACPI_GENERIC_ADDRESS        control;
 230     ACPI_GENERIC_ADDRESS        data;
 231     UINT32                      uid;
 232     UINT8                       gpe_bit;
 233     char                        ec_id[0];
 234 } ACPI_TABLE_ECDT;
 235
 236 /* Additional params to pass from the probe routine */
 237 struct acpi_ec_params {
 238     int         glk;
 239     int         gpe_bit;
 240     ACPI_HANDLE gpe_handle;
 241     int         uid;
 242 };
 243
 244 /* Indicate that this device has already been probed via ECDT. */
 245 #define DEV_ECDT(x)             (acpi_get_magic(x) == (int)&acpi_ec_devclass)
 246
 247 /*
 248  * Driver softc.
 249  */
 250 struct acpi_ec_softc {
 251     device_t            ec_dev;
 252     ACPI_HANDLE         ec_handle;
 253     int                 ec_uid;
 254     ACPI_HANDLE         ec_gpehandle;
 255     UINT8               ec_gpebit;
 256     UINT8               ec_csrvalue;
 257
 258     int                 ec_data_rid;
 259     struct resource     *ec_data_res;
 260     bus_space_tag_t     ec_data_tag;
 261     bus_space_handle_t  ec_data_handle;
 262
 263     int                 ec_csr_rid;
 264     struct resource     *ec_csr_res;
 265     bus_space_tag_t     ec_csr_tag;
 266     bus_space_handle_t  ec_csr_handle;
 267
 268     int                 ec_glk;
 269     int                 ec_glkhandle;
 270 };
 271
 272 /*
 273  * XXX njl
 274  * I couldn't find it in the spec but other implementations also use a
 275  * value of 1 ms for the time to acquire global lock.
 276  */
 277 #define EC_LOCK_TIMEOUT 1000
 278
 279 /* Default interval in microseconds for the status polling loop. */
 280 #define EC_POLL_DELAY   10
 281
 282 /* Total time in ms spent in the poll loop waiting for a response. */
 283 #define EC_POLL_TIMEOUT 100
 284
 285 #define EVENT_READY(event, status)                      \
 286         (((event) == EC_EVENT_OUTPUT_BUFFER_FULL &&     \
 287          ((status) & EC_FLAG_OUTPUT_BUFFER) != 0) ||    \
 288          ((event) == EC_EVENT_INPUT_BUFFER_EMPTY &&     \
 289          ((status) & EC_FLAG_INPUT_BUFFER) == 0))
 290
 291 static int      ec_poll_timeout = EC_POLL_TIMEOUT;
 292 TUNABLE_INT("hw.acpi.ec.poll_timeout", &ec_poll_timeout);
 293
 294 ACPI_SERIAL_DECL(ec, "ACPI embedded controller");
 295
 296 static __inline ACPI_STATUS
 297 EcLock(struct acpi_ec_softc *sc)
 298 {
 299     ACPI_STATUS status;
 300
 301     /* Always acquire the exclusive lock. */
 302     status = AE_OK;
 303     ACPI_SERIAL_BEGIN(ec);
 304
 305     /* If _GLK is non-zero, also acquire the global lock. */
 306     if (sc->ec_glk) {
 307         status = AcpiAcquireGlobalLock(EC_LOCK_TIMEOUT, &sc->ec_glkhandle);
 308         if (ACPI_FAILURE(status))
 309             ACPI_SERIAL_END(ec);
 310     }
 311
 312     return (status);
 313 }
 314
 315 static __inline void
 316 EcUnlock(struct acpi_ec_softc *sc)
 317 {
 318     if (sc->ec_glk)
 319         AcpiReleaseGlobalLock(sc->ec_glkhandle);
 320     ACPI_SERIAL_END(ec);
 321 }
 322
 323 static uint32_t         EcGpeHandler(void *Context);
 324 static ACPI_STATUS      EcSpaceSetup(ACPI_HANDLE Region, UINT32 Function,
 325                                 void *Context, void **return_Context);
 326 static ACPI_STATUS      EcSpaceHandler(UINT32 Function,
 327                                 ACPI_PHYSICAL_ADDRESS Address,
 328                                 UINT32 width, ACPI_INTEGER *Value,
 329                                 void *Context, void *RegionContext);
 330 static ACPI_STATUS      EcWaitEvent(struct acpi_ec_softc *sc, EC_EVENT Event);
 331 static ACPI_STATUS      EcCommand(struct acpi_ec_softc *sc, EC_COMMAND cmd);
 332 static ACPI_STATUS      EcRead(struct acpi_ec_softc *sc, UINT8 Address,
 333                                 UINT8 *Data);
 334 static ACPI_STATUS      EcWrite(struct acpi_ec_softc *sc, UINT8 Address,
 335                                 UINT8 *Data);
 336 static int              acpi_ec_probe(device_t dev);
 337 static int              acpi_ec_attach(device_t dev);
 338 static int              acpi_ec_shutdown(device_t dev);
 339
 340 static device_method_t acpi_ec_methods[] = {
 341     /* Device interface */
 342     DEVMETHOD(device_probe,     acpi_ec_probe),
 343     DEVMETHOD(device_attach,    acpi_ec_attach),
 344     DEVMETHOD(device_shutdown,  acpi_ec_shutdown),
 345
 346     {0, 0}
 347 };
 348
 349 static driver_t acpi_ec_driver = {
 350     "acpi_ec",
 351     acpi_ec_methods,
 352     sizeof(struct acpi_ec_softc),
 353 };
 354
 355 static devclass_t acpi_ec_devclass;
 356 DRIVER_MODULE(acpi_ec, acpi, acpi_ec_driver, acpi_ec_devclass, 0, 0);
 357 MODULE_DEPEND(acpi_ec, acpi, 1, 1, 1);
 358
 359 /*
 360  * Look for an ECDT and if we find one, set up default GPE and
 361  * space handlers to catch attempts to access EC space before
 362  * we have a real driver instance in place.
 363  * TODO: if people report invalid ECDTs, add a tunable to disable them.
 364  */
 365 void
 366 acpi_ec_ecdt_probe(device_t parent)
 367 {
 368     ACPI_TABLE_ECDT *ecdt;
 369     ACPI_TABLE_HEADER *hdr;
 370     ACPI_STATUS      status;
 371     device_t         child;
 372     ACPI_HANDLE      h;
 373     struct acpi_ec_params *params;
 374
 375     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
 376
 377     /* Find and validate the ECDT. */
 378     status = AcpiGetFirmwareTable("ECDT", 1, ACPI_LOGICAL_ADDRESSING, &hdr);
 379     ecdt = (ACPI_TABLE_ECDT *)hdr;
 380     if (ACPI_FAILURE(status) ||
 381         ecdt->control.RegisterBitWidth != 8 ||
 382         ecdt->data.RegisterBitWidth != 8) {
 383         return;
 384     }
 385
 386     /* Create the child device with the given unit number. */
 387     child = BUS_ADD_CHILD(parent, 0, "acpi_ec", ecdt->uid);
 388     if (child == NULL) {
 389         printf("%s: can't add child\n", __func__);
 390         return;
 391     }
 392
 393     /* Find and save the ACPI handle for this device. */
 394     status = AcpiGetHandle(NULL, ecdt->ec_id, &h);
 395     if (ACPI_FAILURE(status)) {
 396         device_delete_child(parent, child);
 397         printf("%s: can't get handle\n", __func__);
 398         return;
 399     }
 400     acpi_set_handle(child, h);
 401
 402     /* Set the data and CSR register addresses. */
 403     bus_set_resource(child, SYS_RES_IOPORT, 0, ecdt->data.Address,
 404         /*count*/1);
 405     bus_set_resource(child, SYS_RES_IOPORT, 1, ecdt->control.Address,
 406         /*count*/1);
 407
 408     /*
 409      * Store values for the probe/attach routines to use.  Store the
 410      * ECDT GPE bit and set the global lock flag according to _GLK.
 411      * Note that it is not perfectly correct to be evaluating a method
 412      * before initializing devices, but in practice this function
 413      * should be safe to call at this point.
 414      */
 415     params = malloc(sizeof(struct acpi_ec_params), M_TEMP, M_WAITOK | M_ZERO);
 416     params->gpe_handle = NULL;
 417     params->gpe_bit = ecdt->gpe_bit;
 418     params->uid = ecdt->uid;
 419     acpi_GetInteger(h, "_GLK", &params->glk);
 420     acpi_set_private(child, params);
 421     acpi_set_magic(child, (int)&acpi_ec_devclass);
 422
 423     /* Finish the attach process. */
 424     if (device_probe_and_attach(child) != 0)
 425         device_delete_child(parent, child);
 426 }
 427
 428 static int
 429 acpi_ec_probe(device_t dev)
 430 {
 431     ACPI_BUFFER buf;
 432     ACPI_HANDLE h;
 433     ACPI_OBJECT *obj;
 434     ACPI_STATUS status;
 435     device_t    peer;
 436     char        desc[64];
 437     int         ret;
 438     struct acpi_ec_params *params;
 439     static char *ec_ids[] = { "PNP0C09", NULL };
 440
 441     /* Check that this is a device and that EC is not disabled. */
 442     if (acpi_get_type(dev) != ACPI_TYPE_DEVICE || acpi_disabled("ec"))
 443         return (ENXIO);
 444
 445     /*
 446      * If probed via ECDT, set description and continue.  Otherwise,
 447      * we can access the namespace and make sure this is not a
 448      * duplicate probe.
 449      */
 450     ret = ENXIO;
 451     params = NULL;
 452     buf.Pointer = NULL;
 453     buf.Length = ACPI_ALLOCATE_BUFFER;
 454     if (DEV_ECDT(dev)) {
 455         params = acpi_get_private(dev);
 456         ret = 0;
 457     } else if (!acpi_disabled("ec") &&
 458         ACPI_ID_PROBE(device_get_parent(dev), dev, ec_ids)) {
 459         params = malloc(sizeof(struct acpi_ec_params), M_TEMP,
 460                         M_WAITOK | M_ZERO);
 461         h = acpi_get_handle(dev);
 462
 463         /*
 464          * Read the unit ID to check for duplicate attach and the
 465          * global lock value to see if we should acquire it when
 466          * accessing the EC.
 467          */
 468         status = acpi_GetInteger(h, "_UID", &params->uid);
 469         if (ACPI_FAILURE(status))
 470             params->uid = 0;
 471         status = acpi_GetInteger(h, "_GLK", &params->glk);
 472         if (ACPI_FAILURE(status))
 473             params->glk = 0;
 474
 475         /*
 476          * Evaluate the _GPE method to find the GPE bit used by the EC to
 477          * signal status (SCI).  If it's a package, it contains a reference
 478          * and GPE bit, similar to _PRW.
 479          */
 480         status = AcpiEvaluateObject(h, "_GPE", NULL, &buf);
 481         if (ACPI_FAILURE(status)) {
 482             device_printf(dev, "can't evaluate _GPE - %s\n",
 483                           AcpiFormatException(status));
 484             return (ENXIO);
 485         }
 486         obj = (ACPI_OBJECT *)buf.Pointer;
 487         if (obj == NULL)
 488             return (ENXIO);
 489
 490         switch (obj->Type) {
 491         case ACPI_TYPE_INTEGER:
 492             params->gpe_handle = NULL;
 493             params->gpe_bit = obj->Integer.Value;
 494             break;
 495         case ACPI_TYPE_PACKAGE:
 496             if (!ACPI_PKG_VALID(obj, 2))
 497                 goto out;
 498             params->gpe_handle =
 499                 acpi_GetReference(NULL, &obj->Package.Elements[0]);
 500             if (params->gpe_handle == NULL ||
 501                 acpi_PkgInt32(obj, 1, &params->gpe_bit) != 0)
 502                 goto out;
 503             break;
 504         default:
 505             device_printf(dev, "_GPE has invalid type %d\n", obj->Type);
 506             goto out;
 507         }
 508
 509         /* Store the values we got from the namespace for attach. */
 510         acpi_set_private(dev, params);
 511
 512         /*
 513          * Check for a duplicate probe.  This can happen when a probe
 514          * via ECDT succeeded already.  If this is a duplicate, disable
 515          * this device.
 516          */
 517         peer = devclass_get_device(acpi_ec_devclass, params->uid);
 518         if (peer == NULL || !device_is_alive(peer))
 519             ret = 0;
 520         else
 521             device_disable(dev);
 522     }
 523
 524 out:
 525     if (ret == 0) {
 526         snprintf(desc, sizeof(desc), "Embedded Controller: GPE %#x%s%s",
 527                  params->gpe_bit, (params->glk) ? ", GLK" : "",
 528                  DEV_ECDT(dev) ? ", ECDT" : "");
 529         device_set_desc_copy(dev, desc);
 530     }
 531
 532     if (ret > 0 && params)
 533         free(params, M_TEMP);
 534     if (buf.Pointer)
 535         AcpiOsFree(buf.Pointer);
 536     return (ret);
 537 }
 538
 539 static int
 540 acpi_ec_attach(device_t dev)
 541 {
 542     struct acpi_ec_softc        *sc;
 543     struct acpi_ec_params       *params;
 544     ACPI_STATUS                 Status;
 545
 546     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
 547
 548     /* Fetch/initialize softc (assumes softc is pre-zeroed). */
 549     sc = device_get_softc(dev);
 550     params = acpi_get_private(dev);
 551     sc->ec_dev = dev;
 552     sc->ec_handle = acpi_get_handle(dev);
 553
 554     /* Retrieve previously probed values via device ivars. */
 555     sc->ec_glk = params->glk;
 556     sc->ec_gpebit = params->gpe_bit;
 557     sc->ec_gpehandle = params->gpe_handle;
 558     sc->ec_uid = params->uid;
 559     free(params, M_TEMP);
 560
 561     /* Attach bus resources for data and command/status ports. */
 562     sc->ec_data_rid = 0;
 563     sc->ec_data_res = bus_alloc_resource_any(sc->ec_dev, SYS_RES_IOPORT,
 564                         &sc->ec_data_rid, RF_ACTIVE);
 565     if (sc->ec_data_res == NULL) {
 566         device_printf(dev, "can't allocate data port\n");
 567         goto error;
 568     }
 569     sc->ec_data_tag = rman_get_bustag(sc->ec_data_res);
 570     sc->ec_data_handle = rman_get_bushandle(sc->ec_data_res);
 571
 572     sc->ec_csr_rid = 1;
 573     sc->ec_csr_res = bus_alloc_resource_any(sc->ec_dev, SYS_RES_IOPORT,
 574                         &sc->ec_csr_rid, RF_ACTIVE);
 575     if (sc->ec_csr_res == NULL) {
 576         device_printf(dev, "can't allocate command/status port\n");
 577         goto error;
 578     }
 579     sc->ec_csr_tag = rman_get_bustag(sc->ec_csr_res);
 580     sc->ec_csr_handle = rman_get_bushandle(sc->ec_csr_res);
 581
 582     /*
 583      * Install a handler for this EC's GPE bit.  We want edge-triggered
 584      * behavior.
 585      */
 586     ACPI_DEBUG_PRINT((ACPI_DB_RESOURCES, "attaching GPE handler\n"));
 587     Status = AcpiInstallGpeHandler(sc->ec_gpehandle, sc->ec_gpebit,
 588                 ACPI_GPE_EDGE_TRIGGERED, &EcGpeHandler, sc);
 589     if (ACPI_FAILURE(Status)) {
 590         device_printf(dev, "can't install GPE handler for %s - %s\n",
 591                       acpi_name(sc->ec_handle), AcpiFormatException(Status));
 592         goto error;
 593     }
 594
 595     /*
 596      * Install address space handler
 597      */
 598     ACPI_DEBUG_PRINT((ACPI_DB_RESOURCES, "attaching address space handler\n"));
 599     Status = AcpiInstallAddressSpaceHandler(sc->ec_handle, ACPI_ADR_SPACE_EC,
 600                 &EcSpaceHandler, &EcSpaceSetup, sc);
 601     if (ACPI_FAILURE(Status)) {
 602         device_printf(dev, "can't install address space handler for %s - %s\n",
 603                       acpi_name(sc->ec_handle), AcpiFormatException(Status));
 604         goto error;
 605     }
 606
 607     /* Enable runtime GPEs for the handler. */
 608     Status = AcpiSetGpeType(sc->ec_gpehandle, sc->ec_gpebit,
 609                             ACPI_GPE_TYPE_RUNTIME);
 610     if (ACPI_FAILURE(Status)) {
 611         device_printf(dev, "AcpiSetGpeType failed: %s\n",
 612                       AcpiFormatException(Status));
 613         goto error;
 614     }
 615     Status = AcpiEnableGpe(sc->ec_gpehandle, sc->ec_gpebit, ACPI_NOT_ISR);
 616     if (ACPI_FAILURE(Status)) {
 617         device_printf(dev, "AcpiEnableGpe failed: %s\n",
 618                       AcpiFormatException(Status));
 619         goto error;
 620     }
 621
 622     ACPI_DEBUG_PRINT((ACPI_DB_RESOURCES, "acpi_ec_attach complete\n"));
 623     return (0);
 624
 625 error:
 626     AcpiRemoveGpeHandler(sc->ec_gpehandle, sc->ec_gpebit, &EcGpeHandler);
 627     AcpiRemoveAddressSpaceHandler(sc->ec_handle, ACPI_ADR_SPACE_EC,
 628         EcSpaceHandler);
 629     if (sc->ec_csr_res)
 630         bus_release_resource(sc->ec_dev, SYS_RES_IOPORT, sc->ec_csr_rid,
 631                              sc->ec_csr_res);
 632     if (sc->ec_data_res)
 633         bus_release_resource(sc->ec_dev, SYS_RES_IOPORT, sc->ec_data_rid,
 634                              sc->ec_data_res);
 635     return (ENXIO);
 636 }
 637
 638 static int
 639 acpi_ec_shutdown(device_t dev)
 640 {
 641     struct acpi_ec_softc        *sc;
 642
 643     /* Disable the GPE so we don't get EC events during shutdown. */
 644     sc = device_get_softc(dev);
 645     AcpiDisableGpe(sc->ec_gpehandle, sc->ec_gpebit, ACPI_NOT_ISR);
 646     return (0);
 647 }
 648
 649 static void
 650 EcGpeQueryHandler(void *Context)
 651 {
 652     struct acpi_ec_softc        *sc = (struct acpi_ec_softc *)Context;
 653     UINT8                       Data;
 654     ACPI_STATUS                 Status;
 655     EC_STATUS                   EcStatus;
 656     char                        qxx[5];
 657
 658     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
 659     KASSERT(Context != NULL, ("EcGpeQueryHandler called with NULL"));
 660
 661     Status = EcLock(sc);
 662     if (ACPI_FAILURE(Status)) {
 663         ACPI_VPRINT(sc->ec_dev, acpi_device_get_parent_softc(sc->ec_dev),
 664                     "GpeQuery lock error: %s\n", AcpiFormatException(Status));
 665         return;
 666     }
 667
 668     /*
 669      * If the EC_SCI bit of the status register is not set, then pass
 670      * it along to any potential waiters as it may be an IBE/OBF event.
 671      */
 672     EcStatus = EC_GET_CSR(sc);
 673     if ((EcStatus & EC_EVENT_SCI) == 0) {
 674         sc->ec_csrvalue = EcStatus;
 675         wakeup(&sc->ec_csrvalue);
 676         EcUnlock(sc);
 677         goto re_enable;
 678     }
 679
 680     /*
 681      * Send a query command to the EC to find out which _Qxx call it
 682      * wants to make.  This command clears the SCI bit and also the
 683      * interrupt source since we are edge-triggered.
 684      */
 685     Status = EcCommand(sc, EC_COMMAND_QUERY);
 686     if (ACPI_FAILURE(Status)) {
 687         EcUnlock(sc);
 688         ACPI_VPRINT(sc->ec_dev, acpi_device_get_parent_softc(sc->ec_dev),
 689                     "GPE query failed - %s\n", AcpiFormatException(Status));
 690         goto re_enable;
 691     }
 692     Data = EC_GET_DATA(sc);
 693     EcUnlock(sc);
 694
 695     /* Ignore the value for "no outstanding event". (13.3.5) */
 696     if (Data == 0)
 697         goto re_enable;
 698
 699     /* Evaluate _Qxx to respond to the controller. */
 700     sprintf(qxx, "_Q%02x", Data);
 701     strupr(qxx);
 702     Status = AcpiEvaluateObject(sc->ec_handle, qxx, NULL, NULL);
 703     if (ACPI_FAILURE(Status) && Status != AE_NOT_FOUND) {
 704         ACPI_VPRINT(sc->ec_dev, acpi_device_get_parent_softc(sc->ec_dev),
 705                     "evaluation of GPE query method %s failed - %s\n",
 706                     qxx, AcpiFormatException(Status));
 707     }
 708
 709 re_enable:
 710     /* Re-enable the GPE event so we'll get future requests. */
 711     Status = AcpiEnableGpe(sc->ec_gpehandle, sc->ec_gpebit, ACPI_NOT_ISR);
 712     if (ACPI_FAILURE(Status))
 713         printf("EcGpeQueryHandler: AcpiEnableEvent failed\n");
 714 }
 715
 716 /*
 717  * Handle a GPE.  Currently we only handle SCI events as others must
 718  * be handled by polling in EcWaitEvent().  This is because some ECs
 719  * treat events as level when they should be edge-triggered.
 720  */
 721 static uint32_t
 722 EcGpeHandler(void *Context)
 723 {
 724     struct acpi_ec_softc *sc = Context;
 725     ACPI_STATUS                Status;
 726
 727     KASSERT(Context != NULL, ("EcGpeHandler called with NULL"));
 728
 729     /*
 730      * Disable further GPEs while we handle this one.  Since we are directly
 731      * called by ACPI-CA and it may have unknown locks held, we specify the
 732      * ACPI_ISR flag to keep it from acquiring any more mutexes (which could
 733      * potentially sleep.)
 734      */
 735     AcpiDisableGpe(sc->ec_gpehandle, sc->ec_gpebit, ACPI_ISR);
 736
 737     /* Schedule the GPE query handler. */
 738     Status = AcpiOsQueueForExecution(OSD_PRIORITY_GPE, EcGpeQueryHandler,
 739                 Context);
 740     if (ACPI_FAILURE(Status)) {
 741         printf("Queuing GPE query handler failed.\n");
 742         Status = AcpiEnableGpe(sc->ec_gpehandle, sc->ec_gpebit, ACPI_ISR);
 743         if (ACPI_FAILURE(Status))
 744             printf("EcGpeHandler: AcpiEnableEvent failed\n");
 745     }
 746
 747     return (0);
 748 }
 749
 750 static ACPI_STATUS
 751 EcSpaceSetup(ACPI_HANDLE Region, UINT32 Function, void *Context,
 752              void **RegionContext)
 753 {
 754
 755     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
 756
 757     /*
 758      * If deactivating a region, always set the output to NULL.  Otherwise,
 759      * just pass the context through.
 760      */
 761     if (Function == ACPI_REGION_DEACTIVATE)
 762         *RegionContext = NULL;
 763     else
 764         *RegionContext = Context;
 765
 766     return_ACPI_STATUS (AE_OK);
 767 }
 768
 769 static ACPI_STATUS
 770 EcSpaceHandler(UINT32 Function, ACPI_PHYSICAL_ADDRESS Address, UINT32 width,
 771                ACPI_INTEGER *Value, void *Context, void *RegionContext)
 772 {
 773     struct acpi_ec_softc        *sc = (struct acpi_ec_softc *)Context;
 774     ACPI_STATUS                 Status;
 775     UINT8                       EcAddr, EcData;
 776     int                         i;
 777
 778     ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, (UINT32)Address);
 779
 780     if (width % 8 != 0 || Value == NULL || Context == NULL)
 781         return_ACPI_STATUS (AE_BAD_PARAMETER);
 782     if (Address + (width / 8) - 1 > 0xFF)
 783         return_ACPI_STATUS (AE_BAD_ADDRESS);
 784
 785     if (Function == ACPI_READ)
 786         *Value = 0;
 787     EcAddr = Address;
 788     Status = AE_ERROR;
 789
 790     Status = EcLock(sc);
 791     if (ACPI_FAILURE(Status))
 792         return_ACPI_STATUS (Status);
 793
 794     /* Perform the transaction(s), based on width. */
 795     for (i = 0; i < width; i += 8, EcAddr++) {
 796         switch (Function) {
 797         case ACPI_READ:
 798             Status = EcRead(sc, EcAddr, &EcData);
 799             if (ACPI_SUCCESS(Status))
 800                 *Value |= ((ACPI_INTEGER)EcData) << i;
 801             break;
 802         case ACPI_WRITE:
 803             EcData = (UINT8)((*Value) >> i);
 804             Status = EcWrite(sc, EcAddr, &EcData);
 805             break;
 806         default:
 807             device_printf(sc->ec_dev, "invalid EcSpaceHandler function %d\n",
 808                           Function);
 809             Status = AE_BAD_PARAMETER;
 810             break;
 811         }
 812         if (ACPI_FAILURE(Status))
 813             break;
 814     }
 815
 816     EcUnlock(sc);
 817     return_ACPI_STATUS (Status);
 818 }
 819
 820 static ACPI_STATUS
 821 EcWaitEvent(struct acpi_ec_softc *sc, EC_EVENT Event)
 822 {
 823     EC_STATUS   EcStatus;
 824     ACPI_STATUS Status;
 825     int         count, i, period, retval, slp_ival;
 826     static int  EcDbgMaxDelay;
 827
 828     ACPI_SERIAL_ASSERT(ec);
 829     Status = AE_NO_HARDWARE_RESPONSE;
 830
 831     /*
 832      * Wait for 1 us before checking the CSR.  Testing shows about
 833      * 50% of requests complete in 1 us and 90% of them complete
 834      * in 5 us or less.
 835      */
 836     AcpiOsStall(1);
 837
 838     /*
 839      * Poll the EC status register for up to 1 ms in chunks of 10 us
 840      * to detect completion of the last command.
 841      */
 842     for (i = 0; i < 1000 / EC_POLL_DELAY; i++) {
 843         EcStatus = EC_GET_CSR(sc);
 844         if (EVENT_READY(Event, EcStatus)) {
 845             Status = AE_OK;
 846             break;
 847         }
 848         AcpiOsStall(EC_POLL_DELAY);
 849     }
 850     period = i * EC_POLL_DELAY;
 851
 852     /*
 853      * If we still don't have a response and we're up and running, wait up
 854      * to ec_poll_timeout ms for completion, sleeping for chunks of 10 ms.
 855      */
 856     slp_ival = 0;
 857     if (Status != AE_OK) {
 858         retval = ENXIO;
 859         count = ec_poll_timeout / 10;
 860         if (count == 0)
 861             count = 1;
 862         slp_ival = hz / 100;
 863         if (slp_ival == 0)
 864             slp_ival = 1;
 865         for (i = 0; i < count; i++) {
 866             if (retval != 0)
 867                 EcStatus = EC_GET_CSR(sc);
 868             else
 869                 EcStatus = sc->ec_csrvalue;
 870             if (EVENT_READY(Event, EcStatus)) {
 871                 Status = AE_OK;
 872                 break;
 873             }
 874             if (!cold)
 875                 retval = tsleep(&sc->ec_csrvalue, PZERO, "ecpoll", slp_ival);
 876             else
 877                 AcpiOsStall(10000);
 878         }
 879     }
 880
 881     /* Calculate new delay and print it if it exceeds the max. */
 882     if (slp_ival > 0)
 883         period += i * 10000;
 884     if (period > EcDbgMaxDelay) {
 885         EcDbgMaxDelay = period;
 886         ACPI_VPRINT(sc->ec_dev, acpi_device_get_parent_softc(sc->ec_dev),
 887                     "info: new max delay is %d us\n", period);
 888     }
 889
 890     return (Status);
 891 }
 892
 893 static ACPI_STATUS
 894 EcCommand(struct acpi_ec_softc *sc, EC_COMMAND cmd)
 895 {
 896     ACPI_STATUS Status;
 897     EC_EVENT    Event;
 898
 899     ACPI_SERIAL_ASSERT(ec);
 900
 901     /* Decide what to wait for based on command type. */
 902     switch (cmd) {
 903     case EC_COMMAND_READ:
 904     case EC_COMMAND_WRITE:
 905     case EC_COMMAND_BURST_DISABLE:
 906         Event = EC_EVENT_INPUT_BUFFER_EMPTY;
 907         break;
 908     case EC_COMMAND_QUERY:
 909     case EC_COMMAND_BURST_ENABLE:
 910         Event = EC_EVENT_OUTPUT_BUFFER_FULL;
 911         break;
 912     default:
 913         ACPI_VPRINT(sc->ec_dev, acpi_device_get_parent_softc(sc->ec_dev),
 914                     "EcCommand: Invalid command %#x\n", cmd);
 915         return (AE_BAD_PARAMETER);
 916     }
 917
 918     /* Run the command and wait for the chosen event. */
 919     EC_SET_CSR(sc, cmd);
 920     Status = EcWaitEvent(sc, Event);
 921     if (ACPI_FAILURE(Status)) {
 922         ACPI_VPRINT(sc->ec_dev, acpi_device_get_parent_softc(sc->ec_dev),
 923                     "EcCommand: no response to %#x\n", cmd);
 924     }
 925
 926     return (Status);
 927 }
 928
 929 static ACPI_STATUS
 930 EcRead(struct acpi_ec_softc *sc, UINT8 Address, UINT8 *Data)
 931 {
 932     ACPI_STATUS Status;
 933
 934     ACPI_SERIAL_ASSERT(ec);
 935
 936 #ifdef notyet
 937     /* If we can't start burst mode, continue anyway. */
 938     EcCommand(sc, EC_COMMAND_BURST_ENABLE);
 939 #endif
 940
 941     Status = EcCommand(sc, EC_COMMAND_READ);
 942     if (ACPI_FAILURE(Status))
 943         return (Status);
 944
 945     EC_SET_DATA(sc, Address);
 946     Status = EcWaitEvent(sc, EC_EVENT_OUTPUT_BUFFER_FULL);
 947     if (ACPI_FAILURE(Status)) {
 948         ACPI_VPRINT(sc->ec_dev, acpi_device_get_parent_softc(sc->ec_dev),
 949                     "EcRead: Failed waiting for EC to send data.\n");
 950         return (Status);
 951     }
 952
 953     *Data = EC_GET_DATA(sc);
 954
 955 #ifdef notyet
 956     if (sc->ec_burstactive) {
 957         Status = EcCommand(sc, EC_COMMAND_BURST_DISABLE);
 958         if (ACPI_FAILURE(Status))
 959             return (Status);
 960     }
 961 #endif
 962
 963     return (AE_OK);
 964 }
 965
 966 static ACPI_STATUS
 967 EcWrite(struct acpi_ec_softc *sc, UINT8 Address, UINT8 *Data)
 968 {
 969     ACPI_STATUS Status;
 970
 971     ACPI_SERIAL_ASSERT(ec);
 972
 973 #ifdef notyet
 974     /* If we can't start burst mode, continue anyway. */
 975     EcCommand(sc, EC_COMMAND_BURST_ENABLE);
 976 #endif
 977
 978     Status = EcCommand(sc, EC_COMMAND_WRITE);
 979     if (ACPI_FAILURE(Status))
 980         return (Status);
 981
 982     EC_SET_DATA(sc, Address);
 983     Status = EcWaitEvent(sc, EC_EVENT_INPUT_BUFFER_EMPTY);
 984     if (ACPI_FAILURE(Status)) {
 985         ACPI_VPRINT(sc->ec_dev, acpi_device_get_parent_softc(sc->ec_dev),
 986                     "EcRead: Failed waiting for EC to process address\n");
 987         return (Status);
 988     }
 989
 990     EC_SET_DATA(sc, *Data);
 991     Status = EcWaitEvent(sc, EC_EVENT_INPUT_BUFFER_EMPTY);
 992     if (ACPI_FAILURE(Status)) {
 993         ACPI_VPRINT(sc->ec_dev, acpi_device_get_parent_softc(sc->ec_dev),
 994                     "EcWrite: Failed waiting for EC to process data\n");
 995         return (Status);
 996     }
 997
 998 #ifdef notyet
 999     if (sc->ec_burstactive) {
1000         Status = EcCommand(sc, EC_COMMAND_BURST_DISABLE);
1001         if (ACPI_FAILURE(Status))
1002             return (Status);
1003     }
1004 #endif
1005
1006     return (AE_OK);
1007 }