2 * Copyright (c) 2003 Nate Lawson
3 * Copyright (c) 2000 Michael Smith
4 * Copyright (c) 2000 BSDi
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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.
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
28 * $FreeBSD: src/sys/dev/acpica/acpi_ec.c,v 1.51 2004/05/30 20:08:23 phk Exp $
29 * $DragonFly: src/sys/dev/acpica5/acpi_ec.c,v 1.6 2005/10/30 04:41:15 dillon Exp $
31 /******************************************************************************
35 * Some or all of this work - Copyright (c) 1999, Intel Corp. All rights
40 * 2.1. This is your license from Intel Corp. under its intellectual property
41 * rights. You may have additional license terms from the party that provided
42 * you this software, covering your right to use that party's intellectual
45 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
46 * copy of the source code appearing in this file ("Covered Code") an
47 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
48 * base code distributed originally by Intel ("Original Intel Code") to copy,
49 * make derivatives, distribute, use and display any portion of the Covered
50 * Code in any form, with the right to sublicense such rights; and
52 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
53 * license (with the right to sublicense), under only those claims of Intel
54 * patents that are infringed by the Original Intel Code, to make, use, sell,
55 * offer to sell, and import the Covered Code and derivative works thereof
56 * solely to the minimum extent necessary to exercise the above copyright
57 * license, and in no event shall the patent license extend to any additions
58 * to or modifications of the Original Intel Code. No other license or right
59 * is granted directly or by implication, estoppel or otherwise;
61 * The above copyright and patent license is granted only if the following
66 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
67 * Redistribution of source code of any substantial portion of the Covered
68 * Code or modification with rights to further distribute source must include
69 * the above Copyright Notice, the above License, this list of Conditions,
70 * and the following Disclaimer and Export Compliance provision. In addition,
71 * Licensee must cause all Covered Code to which Licensee contributes to
72 * contain a file documenting the changes Licensee made to create that Covered
73 * Code and the date of any change. Licensee must include in that file the
74 * documentation of any changes made by any predecessor Licensee. Licensee
75 * must include a prominent statement that the modification is derived,
76 * directly or indirectly, from Original Intel Code.
78 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
79 * Redistribution of source code of any substantial portion of the Covered
80 * Code or modification without rights to further distribute source must
81 * include the following Disclaimer and Export Compliance provision in the
82 * documentation and/or other materials provided with distribution. In
83 * addition, Licensee may not authorize further sublicense of source of any
84 * portion of the Covered Code, and must include terms to the effect that the
85 * license from Licensee to its licensee is limited to the intellectual
86 * property embodied in the software Licensee provides to its licensee, and
87 * not to intellectual property embodied in modifications its licensee may
90 * 3.3. Redistribution of Executable. Redistribution in executable form of any
91 * substantial portion of the Covered Code or modification must reproduce the
92 * above Copyright Notice, and the following Disclaimer and Export Compliance
93 * provision in the documentation and/or other materials provided with the
96 * 3.4. Intel retains all right, title, and interest in and to the Original
99 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
100 * Intel shall be used in advertising or otherwise to promote the sale, use or
101 * other dealings in products derived from or relating to the Covered Code
102 * without prior written authorization from Intel.
104 * 4. Disclaimer and Export Compliance
106 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
107 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
108 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
109 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
110 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
111 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
112 * PARTICULAR PURPOSE.
114 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
115 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
116 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
117 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
118 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
119 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
120 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
123 * 4.3. Licensee shall not export, either directly or indirectly, any of this
124 * software or system incorporating such software without first obtaining any
125 * required license or other approval from the U. S. Department of Commerce or
126 * any other agency or department of the United States Government. In the
127 * event Licensee exports any such software from the United States or
128 * re-exports any such software from a foreign destination, Licensee shall
129 * ensure that the distribution and export/re-export of the software is in
130 * compliance with all laws, regulations, orders, or other restrictions of the
131 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
132 * any of its subsidiaries will export/re-export any technical data, process,
133 * software, or service, directly or indirectly, to any country for which the
134 * United States government or any agency thereof requires an export license,
135 * other governmental approval, or letter of assurance, without first obtaining
136 * such license, approval or letter.
138 *****************************************************************************/
140 * $FreeBSD: src/sys/dev/acpica/acpi_ec.c,v 1.51 2004/05/30 20:08:23 phk Exp $
141 * $DragonFly: src/sys/dev/acpica5/acpi_ec.c,v 1.6 2005/10/30 04:41:15 dillon Exp $
145 #include "opt_acpi.h"
146 #include <sys/param.h>
147 #include <sys/kernel.h>
149 #include <sys/thread.h>
150 #include <sys/malloc.h>
151 #include <sys/module.h>
153 #include <machine/bus.h>
154 #include <machine/resource.h>
155 #include <sys/rman.h>
158 #include <dev/acpica5/acpivar.h>
161 * Hooks for the ACPI CA debugging infrastructure
163 #define _COMPONENT ACPI_EC
164 ACPI_MODULE_NAME("EC")
170 typedef UINT8 EC_COMMAND;
172 #define EC_COMMAND_UNKNOWN ((EC_COMMAND) 0x00)
173 #define EC_COMMAND_READ ((EC_COMMAND) 0x80)
174 #define EC_COMMAND_WRITE ((EC_COMMAND) 0x81)
175 #define EC_COMMAND_BURST_ENABLE ((EC_COMMAND) 0x82)
176 #define EC_COMMAND_BURST_DISABLE ((EC_COMMAND) 0x83)
177 #define EC_COMMAND_QUERY ((EC_COMMAND) 0x84)
182 * The encoding of the EC status register is illustrated below.
183 * Note that a set bit (1) indicates the property is TRUE
184 * (e.g. if bit 0 is set then the output buffer is full).
189 * | | | | | | | +- Output Buffer Full?
190 * | | | | | | +--- Input Buffer Full?
191 * | | | | | +----- <reserved>
192 * | | | | +------- Data Register is Command Byte?
193 * | | | +--------- Burst Mode Enabled?
194 * | | +----------- SCI Event?
195 * | +------------- SMI Event?
196 * +--------------- <Reserved>
199 typedef UINT8 EC_STATUS;
201 #define EC_FLAG_OUTPUT_BUFFER ((EC_STATUS) 0x01)
202 #define EC_FLAG_INPUT_BUFFER ((EC_STATUS) 0x02)
203 #define EC_FLAG_BURST_MODE ((EC_STATUS) 0x10)
204 #define EC_FLAG_SCI ((EC_STATUS) 0x20)
210 typedef UINT8 EC_EVENT;
212 #define EC_EVENT_UNKNOWN ((EC_EVENT) 0x00)
213 #define EC_EVENT_OUTPUT_BUFFER_FULL ((EC_EVENT) 0x01)
214 #define EC_EVENT_INPUT_BUFFER_EMPTY ((EC_EVENT) 0x02)
215 #define EC_EVENT_SCI ((EC_EVENT) 0x20)
218 * Register access primitives
220 #define EC_GET_DATA(sc) \
221 bus_space_read_1((sc)->ec_data_tag, (sc)->ec_data_handle, 0)
223 #define EC_SET_DATA(sc, v) \
224 bus_space_write_1((sc)->ec_data_tag, (sc)->ec_data_handle, 0, (v))
226 #define EC_GET_CSR(sc) \
227 bus_space_read_1((sc)->ec_csr_tag, (sc)->ec_csr_handle, 0)
229 #define EC_SET_CSR(sc, v) \
230 bus_space_write_1((sc)->ec_csr_tag, (sc)->ec_csr_handle, 0, (v))
232 /* Embedded Controller Boot Resources Table (ECDT) */
234 ACPI_TABLE_HEADER header;
235 ACPI_GENERIC_ADDRESS control;
236 ACPI_GENERIC_ADDRESS data;
242 /* Additional params to pass from the probe routine */
243 struct acpi_ec_params {
246 ACPI_HANDLE gpe_handle;
250 /* Indicate that this device has already been probed via ECDT. */
251 #define DEV_ECDT(x) (acpi_get_magic(x) == (int)&acpi_ec_devclass)
256 struct acpi_ec_softc {
258 ACPI_HANDLE ec_handle;
260 ACPI_HANDLE ec_gpehandle;
265 struct resource *ec_data_res;
266 bus_space_tag_t ec_data_tag;
267 bus_space_handle_t ec_data_handle;
270 struct resource *ec_csr_res;
271 bus_space_tag_t ec_csr_tag;
272 bus_space_handle_t ec_csr_handle;
276 struct lwkt_rwlock ec_rwlock;
281 * I couldn't find it in the spec but other implementations also use a
282 * value of 1 ms for the time to acquire global lock.
284 #define EC_LOCK_TIMEOUT 1000
286 /* Default interval in microseconds for the status polling loop. */
287 #define EC_POLL_DELAY 10
289 /* Total time in ms spent in the poll loop waiting for a response. */
290 #define EC_POLL_TIMEOUT 100
292 #define EVENT_READY(event, status) \
293 (((event) == EC_EVENT_OUTPUT_BUFFER_FULL && \
294 ((status) & EC_FLAG_OUTPUT_BUFFER) != 0) || \
295 ((event) == EC_EVENT_INPUT_BUFFER_EMPTY && \
296 ((status) & EC_FLAG_INPUT_BUFFER) == 0))
298 static int ec_poll_timeout = EC_POLL_TIMEOUT;
299 TUNABLE_INT("hw.acpi.ec.poll_timeout", &ec_poll_timeout);
301 static __inline ACPI_STATUS
302 EcLock(struct acpi_ec_softc *sc)
304 ACPI_STATUS status = AE_OK;
306 /* Always acquire this EC's mutex. */
307 lwkt_exlock(&sc->ec_rwlock, "acpi2");
309 /* If _GLK is non-zero, also acquire the global lock. */
311 status = AcpiAcquireGlobalLock(EC_LOCK_TIMEOUT, &sc->ec_glkhandle);
312 if (ACPI_FAILURE(status))
313 lwkt_exunlock(&sc->ec_rwlock);
320 EcUnlock(struct acpi_ec_softc *sc)
323 AcpiReleaseGlobalLock(sc->ec_glkhandle);
324 lwkt_exunlock(&sc->ec_rwlock);
327 static uint32_t EcGpeHandler(void *Context);
328 static ACPI_STATUS EcSpaceSetup(ACPI_HANDLE Region, UINT32 Function,
329 void *Context, void **return_Context);
330 static ACPI_STATUS EcSpaceHandler(UINT32 Function,
331 ACPI_PHYSICAL_ADDRESS Address,
332 UINT32 width, ACPI_INTEGER *Value,
333 void *Context, void *RegionContext);
334 static ACPI_STATUS EcWaitEvent(struct acpi_ec_softc *sc, EC_EVENT Event);
335 static ACPI_STATUS EcCommand(struct acpi_ec_softc *sc, EC_COMMAND cmd);
336 static ACPI_STATUS EcRead(struct acpi_ec_softc *sc, UINT8 Address,
338 static ACPI_STATUS EcWrite(struct acpi_ec_softc *sc, UINT8 Address,
340 static int acpi_ec_probe(device_t dev);
341 static int acpi_ec_attach(device_t dev);
343 static device_method_t acpi_ec_methods[] = {
344 /* Device interface */
345 DEVMETHOD(device_probe, acpi_ec_probe),
346 DEVMETHOD(device_attach, acpi_ec_attach),
351 static driver_t acpi_ec_driver = {
354 sizeof(struct acpi_ec_softc),
357 static devclass_t acpi_ec_devclass;
358 DRIVER_MODULE(acpi_ec, acpi, acpi_ec_driver, acpi_ec_devclass, 0, 0);
359 MODULE_DEPEND(acpi_ec, acpi, 1, 1, 1);
362 * Look for an ECDT and if we find one, set up default GPE and
363 * space handlers to catch attempts to access EC space before
364 * we have a real driver instance in place.
365 * TODO: if people report invalid ECDTs, add a tunable to disable them.
368 acpi_ec_ecdt_probe(device_t parent)
370 ACPI_TABLE_ECDT *ecdt;
374 struct acpi_ec_params *params;
376 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
378 /* Find and validate the ECDT. */
379 status = AcpiGetFirmwareTable("ECDT", 1, ACPI_LOGICAL_ADDRESSING,
380 (ACPI_TABLE_HEADER **)&ecdt);
381 if (ACPI_FAILURE(status) ||
382 ecdt->control.RegisterBitWidth != 8 ||
383 ecdt->data.RegisterBitWidth != 8) {
387 /* Create the child device with the given unit number. */
388 child = BUS_ADD_CHILD(parent, parent, 0, "acpi_ec", ecdt->uid);
390 printf("%s: can't add child\n", __func__);
394 /* Find and save the ACPI handle for this device. */
395 status = AcpiGetHandle(NULL, ecdt->ec_id, &h);
396 if (ACPI_FAILURE(status)) {
397 device_delete_child(parent, child);
398 printf("%s: can't get handle\n", __func__);
401 acpi_set_handle(child, h);
403 /* Set the data and CSR register addresses. */
404 bus_set_resource(child, SYS_RES_IOPORT, 0, ecdt->data.Address,
406 bus_set_resource(child, SYS_RES_IOPORT, 1, ecdt->control.Address,
410 * Store values for the probe/attach routines to use. Store the
411 * ECDT GPE bit and set the global lock flag according to _GLK.
412 * Note that it is not perfectly correct to be evaluating a method
413 * before initializing devices, but in practice this function
414 * should be safe to call at this point.
416 params = malloc(sizeof(struct acpi_ec_params), M_TEMP, M_WAITOK | M_ZERO);
417 params->gpe_handle = NULL;
418 params->gpe_bit = ecdt->gpe_bit;
419 params->uid = ecdt->uid;
420 acpi_GetInteger(h, "_GLK", ¶ms->glk);
421 acpi_set_private(child, params);
422 acpi_set_magic(child, (int)&acpi_ec_devclass);
424 /* Finish the attach process. */
425 if (device_probe_and_attach(child) != 0)
426 device_delete_child(parent, child);
430 acpi_ec_probe(device_t dev)
439 struct acpi_ec_params *params;
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"))
446 * If probed via ECDT, set description and continue. Otherwise,
447 * we can access the namespace and make sure this is not a
453 buf.Length = ACPI_ALLOCATE_BUFFER;
455 params = acpi_get_private(dev);
457 } else if (acpi_MatchHid(dev, "PNP0C09")) {
458 params = malloc(sizeof(struct acpi_ec_params), M_TEMP,
460 h = acpi_get_handle(dev);
463 * Read the unit ID to check for duplicate attach and the
464 * global lock value to see if we should acquire it when
467 status = acpi_GetInteger(h, "_UID", ¶ms->uid);
468 if (ACPI_FAILURE(status))
470 status = acpi_GetInteger(h, "_GLK", ¶ms->glk);
471 if (ACPI_FAILURE(status))
475 * Evaluate the _GPE method to find the GPE bit used by the EC to
476 * signal status (SCI). If it's a package, it contains a reference
477 * and GPE bit, similar to _PRW.
479 status = AcpiEvaluateObject(h, "_GPE", NULL, &buf);
480 if (ACPI_FAILURE(status)) {
481 device_printf(dev, "can't evaluate _GPE - %s\n",
482 AcpiFormatException(status));
485 obj = (ACPI_OBJECT *)buf.Pointer;
490 case ACPI_TYPE_INTEGER:
491 params->gpe_handle = NULL;
492 params->gpe_bit = obj->Integer.Value;
494 case ACPI_TYPE_PACKAGE:
495 if (!ACPI_PKG_VALID(obj, 2))
498 acpi_GetReference(NULL, &obj->Package.Elements[0]);
499 if (params->gpe_handle == NULL ||
500 acpi_PkgInt32(obj, 1, ¶ms->gpe_bit) != 0)
504 device_printf(dev, "_GPE has invalid type %d\n", obj->Type);
508 /* Store the values we got from the namespace for attach. */
509 acpi_set_private(dev, params);
512 * Check for a duplicate probe. This can happen when a probe
513 * via ECDT succeeded already. If this is a duplicate, disable
516 peer = devclass_get_device(acpi_ec_devclass, params->uid);
517 if (peer == NULL || !device_is_alive(peer))
525 snprintf(desc, sizeof(desc), "Embedded Controller: GPE %#x%s%s",
526 params->gpe_bit, (params->glk) ? ", GLK" : "",
527 DEV_ECDT(dev) ? ", ECDT" : "");
528 device_set_desc_copy(dev, desc);
531 if (ret > 0 && params)
532 free(params, M_TEMP);
534 AcpiOsFree(buf.Pointer);
539 acpi_ec_attach(device_t dev)
541 struct acpi_ec_softc *sc;
542 struct acpi_ec_params *params;
545 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
547 /* Fetch/initialize softc (assumes softc is pre-zeroed). */
548 sc = device_get_softc(dev);
549 params = acpi_get_private(dev);
551 sc->ec_handle = acpi_get_handle(dev);
552 lwkt_rwlock_init(&sc->ec_rwlock);
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);
561 /* Attach bus resources for data and command/status ports. */
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");
569 sc->ec_data_tag = rman_get_bustag(sc->ec_data_res);
570 sc->ec_data_handle = rman_get_bushandle(sc->ec_data_res);
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");
579 sc->ec_csr_tag = rman_get_bustag(sc->ec_csr_res);
580 sc->ec_csr_handle = rman_get_bushandle(sc->ec_csr_res);
583 * Install a handler for this EC's GPE bit. We want edge-triggered
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));
596 * Install address space handler
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));
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));
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));
622 ACPI_DEBUG_PRINT((ACPI_DB_RESOURCES, "acpi_ec_attach complete\n"));
626 AcpiRemoveGpeHandler(sc->ec_gpehandle, sc->ec_gpebit, &EcGpeHandler);
627 AcpiRemoveAddressSpaceHandler(sc->ec_handle, ACPI_ADR_SPACE_EC,
630 bus_release_resource(sc->ec_dev, SYS_RES_IOPORT, sc->ec_csr_rid,
633 bus_release_resource(sc->ec_dev, SYS_RES_IOPORT, sc->ec_data_rid,
635 /* mtx_destroy(&sc->ec_mtx); */
640 EcGpeQueryHandler(void *Context)
642 struct acpi_ec_softc *sc = (struct acpi_ec_softc *)Context;
648 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
649 KASSERT(Context != NULL, ("EcGpeQueryHandler called with NULL"));
652 if (ACPI_FAILURE(Status)) {
653 ACPI_VPRINT(sc->ec_dev, acpi_device_get_parent_softc(sc->ec_dev),
654 "GpeQuery lock error: %s\n", AcpiFormatException(Status));
659 * If the EC_SCI bit of the status register is not set, then pass
660 * it along to any potential waiters as it may be an IBE/OBF event.
662 EcStatus = EC_GET_CSR(sc);
663 if ((EcStatus & EC_EVENT_SCI) == 0) {
664 sc->ec_csrvalue = EcStatus;
665 wakeup(&sc->ec_csrvalue);
671 * Send a query command to the EC to find out which _Qxx call it
672 * wants to make. This command clears the SCI bit and also the
673 * interrupt source since we are edge-triggered.
675 Status = EcCommand(sc, EC_COMMAND_QUERY);
676 if (ACPI_FAILURE(Status)) {
678 ACPI_VPRINT(sc->ec_dev, acpi_device_get_parent_softc(sc->ec_dev),
679 "GPE query failed - %s\n", AcpiFormatException(Status));
682 Data = EC_GET_DATA(sc);
685 /* Ignore the value for "no outstanding event". (13.3.5) */
689 /* Evaluate _Qxx to respond to the controller. */
690 sprintf(qxx, "_Q%02x", Data);
692 Status = AcpiEvaluateObject(sc->ec_handle, qxx, NULL, NULL);
693 if (ACPI_FAILURE(Status) && Status != AE_NOT_FOUND) {
694 ACPI_VPRINT(sc->ec_dev, acpi_device_get_parent_softc(sc->ec_dev),
695 "evaluation of GPE query method %s failed - %s\n",
696 qxx, AcpiFormatException(Status));
700 /* Re-enable the GPE event so we'll get future requests. */
701 Status = AcpiEnableGpe(sc->ec_gpehandle, sc->ec_gpebit, ACPI_NOT_ISR);
702 if (ACPI_FAILURE(Status))
703 printf("EcGpeQueryHandler: AcpiEnableEvent failed\n");
707 * Handle a GPE. Currently we only handle SCI events as others must
708 * be handled by polling in EcWaitEvent(). This is because some ECs
709 * treat events as level when they should be edge-triggered.
712 EcGpeHandler(void *Context)
714 struct acpi_ec_softc *sc = Context;
717 KASSERT(Context != NULL, ("EcGpeHandler called with NULL"));
719 /* Disable further GPEs while we handle this one. */
720 AcpiDisableGpe(sc->ec_gpehandle, sc->ec_gpebit, ACPI_NOT_ISR);
722 /* Schedule the GPE query handler. */
723 Status = AcpiOsQueueForExecution(OSD_PRIORITY_GPE, EcGpeQueryHandler,
725 if (ACPI_FAILURE(Status)) {
726 printf("Queuing GPE query handler failed.\n");
727 Status = AcpiEnableGpe(sc->ec_gpehandle, sc->ec_gpebit, ACPI_NOT_ISR);
728 if (ACPI_FAILURE(Status))
729 printf("EcGpeHandler: AcpiEnableEvent failed\n");
736 EcSpaceSetup(ACPI_HANDLE Region, UINT32 Function, void *Context,
737 void **RegionContext)
740 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
743 * If deactivating a region, always set the output to NULL. Otherwise,
744 * just pass the context through.
746 if (Function == ACPI_REGION_DEACTIVATE)
747 *RegionContext = NULL;
749 *RegionContext = Context;
751 return_ACPI_STATUS (AE_OK);
755 EcSpaceHandler(UINT32 Function, ACPI_PHYSICAL_ADDRESS Address, UINT32 width,
756 ACPI_INTEGER *Value, void *Context, void *RegionContext)
758 struct acpi_ec_softc *sc = (struct acpi_ec_softc *)Context;
760 UINT8 EcAddr, EcData;
763 ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, (UINT32)Address);
765 if (width % 8 != 0 || Value == NULL || Context == NULL)
766 return_ACPI_STATUS (AE_BAD_PARAMETER);
767 if (Address + (width / 8) - 1 > 0xFF)
768 return_ACPI_STATUS (AE_BAD_ADDRESS);
770 if (Function == ACPI_READ)
775 /* Perform the transaction(s), based on width. */
776 for (i = 0; i < width; i += 8, EcAddr++) {
778 if (ACPI_FAILURE(Status))
783 Status = EcRead(sc, EcAddr, &EcData);
784 if (ACPI_SUCCESS(Status))
785 *Value |= ((ACPI_INTEGER)EcData) << i;
788 EcData = (UINT8)((*Value) >> i);
789 Status = EcWrite(sc, EcAddr, &EcData);
792 device_printf(sc->ec_dev, "invalid EcSpaceHandler function %d\n",
794 Status = AE_BAD_PARAMETER;
798 if (ACPI_FAILURE(Status))
802 return_ACPI_STATUS (Status);
806 EcWaitEvent(struct acpi_ec_softc *sc, EC_EVENT Event)
810 int count, i, period, retval, slp_ival;
811 static int EcDbgMaxDelay;
813 /* mtx_assert(&sc->ec_mtx, MA_OWNED); */
814 Status = AE_NO_HARDWARE_RESPONSE;
817 * Wait for 1 us before checking the CSR. Testing shows about
818 * 50% of requests complete in 1 us and 90% of them complete
824 * Poll the EC status register for up to 1 ms in chunks of 10 us
825 * to detect completion of the last command.
827 for (i = 0; i < 1000 / EC_POLL_DELAY; i++) {
828 EcStatus = EC_GET_CSR(sc);
829 if (EVENT_READY(Event, EcStatus)) {
833 AcpiOsStall(EC_POLL_DELAY);
835 period = i * EC_POLL_DELAY;
838 * If we still don't have a response and we're up and running, wait up
839 * to ec_poll_timeout ms for completion, sleeping for chunks of 10 ms.
842 if (Status != AE_OK) {
844 count = ec_poll_timeout / 10;
850 for (i = 0; i < count; i++) {
852 EcStatus = EC_GET_CSR(sc);
854 EcStatus = sc->ec_csrvalue;
855 if (EVENT_READY(Event, EcStatus)) {
860 retval = tsleep(&sc->ec_csrvalue, 0, "ecpoll", slp_ival);
866 /* Calculate new delay and print it if it exceeds the max. */
869 if (period > EcDbgMaxDelay) {
870 EcDbgMaxDelay = period;
871 ACPI_VPRINT(sc->ec_dev, acpi_device_get_parent_softc(sc->ec_dev),
872 "info: new max delay is %d us\n", period);
879 EcCommand(struct acpi_ec_softc *sc, EC_COMMAND cmd)
884 /*mtx_assert(&sc->ec_mtx, MA_OWNED);*/
886 /* Decide what to wait for based on command type. */
888 case EC_COMMAND_READ:
889 case EC_COMMAND_WRITE:
890 case EC_COMMAND_BURST_DISABLE:
891 Event = EC_EVENT_INPUT_BUFFER_EMPTY;
893 case EC_COMMAND_QUERY:
894 case EC_COMMAND_BURST_ENABLE:
895 Event = EC_EVENT_OUTPUT_BUFFER_FULL;
898 ACPI_VPRINT(sc->ec_dev, acpi_device_get_parent_softc(sc->ec_dev),
899 "EcCommand: Invalid command %#x\n", cmd);
900 return (AE_BAD_PARAMETER);
903 /* Run the command and wait for the chosen event. */
905 Status = EcWaitEvent(sc, Event);
906 if (ACPI_FAILURE(Status)) {
907 ACPI_VPRINT(sc->ec_dev, acpi_device_get_parent_softc(sc->ec_dev),
908 "EcCommand: no response to %#x\n", cmd);
915 EcRead(struct acpi_ec_softc *sc, UINT8 Address, UINT8 *Data)
919 /*mtx_assert(&sc->ec_mtx, MA_OWNED);*/
922 /* If we can't start burst mode, continue anyway. */
923 EcCommand(sc, EC_COMMAND_BURST_ENABLE);
926 Status = EcCommand(sc, EC_COMMAND_READ);
927 if (ACPI_FAILURE(Status))
930 EC_SET_DATA(sc, Address);
931 Status = EcWaitEvent(sc, EC_EVENT_OUTPUT_BUFFER_FULL);
932 if (ACPI_FAILURE(Status)) {
933 ACPI_VPRINT(sc->ec_dev, acpi_device_get_parent_softc(sc->ec_dev),
934 "EcRead: Failed waiting for EC to send data.\n");
938 *Data = EC_GET_DATA(sc);
941 if (sc->ec_burstactive) {
942 Status = EcCommand(sc, EC_COMMAND_BURST_DISABLE);
943 if (ACPI_FAILURE(Status))
952 EcWrite(struct acpi_ec_softc *sc, UINT8 Address, UINT8 *Data)
956 /*mtx_assert(&sc->ec_mtx, MA_OWNED);*/
959 /* If we can't start burst mode, continue anyway. */
960 EcCommand(sc, EC_COMMAND_BURST_ENABLE);
963 Status = EcCommand(sc, EC_COMMAND_WRITE);
964 if (ACPI_FAILURE(Status))
967 EC_SET_DATA(sc, Address);
968 Status = EcWaitEvent(sc, EC_EVENT_INPUT_BUFFER_EMPTY);
969 if (ACPI_FAILURE(Status)) {
970 ACPI_VPRINT(sc->ec_dev, acpi_device_get_parent_softc(sc->ec_dev),
971 "EcRead: Failed waiting for EC to process address\n");
975 EC_SET_DATA(sc, *Data);
976 Status = EcWaitEvent(sc, EC_EVENT_INPUT_BUFFER_EMPTY);
977 if (ACPI_FAILURE(Status)) {
978 ACPI_VPRINT(sc->ec_dev, acpi_device_get_parent_softc(sc->ec_dev),
979 "EcWrite: Failed waiting for EC to process data\n");
984 if (sc->ec_burstactive) {
985 Status = EcCommand(sc, EC_COMMAND_BURST_DISABLE);
986 if (ACPI_FAILURE(Status))