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.8 2006/09/05 00:55:36 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.8 2006/09/05 00:55:36 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>
152 #include <sys/lock.h>
154 #include <machine/bus.h>
155 #include <machine/resource.h>
156 #include <sys/rman.h>
159 #include <dev/acpica5/acpivar.h>
162 * Hooks for the ACPI CA debugging infrastructure
164 #define _COMPONENT ACPI_EC
165 ACPI_MODULE_NAME("EC")
171 typedef UINT8 EC_COMMAND;
173 #define EC_COMMAND_UNKNOWN ((EC_COMMAND) 0x00)
174 #define EC_COMMAND_READ ((EC_COMMAND) 0x80)
175 #define EC_COMMAND_WRITE ((EC_COMMAND) 0x81)
176 #define EC_COMMAND_BURST_ENABLE ((EC_COMMAND) 0x82)
177 #define EC_COMMAND_BURST_DISABLE ((EC_COMMAND) 0x83)
178 #define EC_COMMAND_QUERY ((EC_COMMAND) 0x84)
183 * The encoding of the EC status register is illustrated below.
184 * Note that a set bit (1) indicates the property is TRUE
185 * (e.g. if bit 0 is set then the output buffer is full).
190 * | | | | | | | +- Output Buffer Full?
191 * | | | | | | +--- Input Buffer Full?
192 * | | | | | +----- <reserved>
193 * | | | | +------- Data Register is Command Byte?
194 * | | | +--------- Burst Mode Enabled?
195 * | | +----------- SCI Event?
196 * | +------------- SMI Event?
197 * +--------------- <Reserved>
200 typedef UINT8 EC_STATUS;
202 #define EC_FLAG_OUTPUT_BUFFER ((EC_STATUS) 0x01)
203 #define EC_FLAG_INPUT_BUFFER ((EC_STATUS) 0x02)
204 #define EC_FLAG_BURST_MODE ((EC_STATUS) 0x10)
205 #define EC_FLAG_SCI ((EC_STATUS) 0x20)
211 typedef UINT8 EC_EVENT;
213 #define EC_EVENT_UNKNOWN ((EC_EVENT) 0x00)
214 #define EC_EVENT_OUTPUT_BUFFER_FULL ((EC_EVENT) 0x01)
215 #define EC_EVENT_INPUT_BUFFER_EMPTY ((EC_EVENT) 0x02)
216 #define EC_EVENT_SCI ((EC_EVENT) 0x20)
219 * Register access primitives
221 #define EC_GET_DATA(sc) \
222 bus_space_read_1((sc)->ec_data_tag, (sc)->ec_data_handle, 0)
224 #define EC_SET_DATA(sc, v) \
225 bus_space_write_1((sc)->ec_data_tag, (sc)->ec_data_handle, 0, (v))
227 #define EC_GET_CSR(sc) \
228 bus_space_read_1((sc)->ec_csr_tag, (sc)->ec_csr_handle, 0)
230 #define EC_SET_CSR(sc, v) \
231 bus_space_write_1((sc)->ec_csr_tag, (sc)->ec_csr_handle, 0, (v))
233 /* Embedded Controller Boot Resources Table (ECDT) */
235 ACPI_TABLE_HEADER header;
236 ACPI_GENERIC_ADDRESS control;
237 ACPI_GENERIC_ADDRESS data;
243 /* Additional params to pass from the probe routine */
244 struct acpi_ec_params {
247 ACPI_HANDLE gpe_handle;
251 /* Indicate that this device has already been probed via ECDT. */
252 #define DEV_ECDT(x) (acpi_get_magic(x) == (int)&acpi_ec_devclass)
257 struct acpi_ec_softc {
259 ACPI_HANDLE ec_handle;
261 ACPI_HANDLE ec_gpehandle;
266 struct resource *ec_data_res;
267 bus_space_tag_t ec_data_tag;
268 bus_space_handle_t ec_data_handle;
271 struct resource *ec_csr_res;
272 bus_space_tag_t ec_csr_tag;
273 bus_space_handle_t ec_csr_handle;
282 * I couldn't find it in the spec but other implementations also use a
283 * value of 1 ms for the time to acquire global lock.
285 #define EC_LOCK_TIMEOUT 1000
287 /* Default interval in microseconds for the status polling loop. */
288 #define EC_POLL_DELAY 10
290 /* Total time in ms spent in the poll loop waiting for a response. */
291 #define EC_POLL_TIMEOUT 100
293 #define EVENT_READY(event, status) \
294 (((event) == EC_EVENT_OUTPUT_BUFFER_FULL && \
295 ((status) & EC_FLAG_OUTPUT_BUFFER) != 0) || \
296 ((event) == EC_EVENT_INPUT_BUFFER_EMPTY && \
297 ((status) & EC_FLAG_INPUT_BUFFER) == 0))
299 static int ec_poll_timeout = EC_POLL_TIMEOUT;
300 TUNABLE_INT("hw.acpi.ec.poll_timeout", &ec_poll_timeout);
302 static __inline ACPI_STATUS
303 EcLock(struct acpi_ec_softc *sc)
305 ACPI_STATUS status = AE_OK;
307 /* Always acquire this EC's mutex. */
308 lockmgr(&sc->ec_lock, LK_EXCLUSIVE|LK_RETRY);
310 /* If _GLK is non-zero, also acquire the global lock. */
312 status = AcpiAcquireGlobalLock(EC_LOCK_TIMEOUT, &sc->ec_glkhandle);
313 if (ACPI_FAILURE(status))
314 lockmgr(&sc->ec_lock, LK_RELEASE);
321 EcUnlock(struct acpi_ec_softc *sc)
324 AcpiReleaseGlobalLock(sc->ec_glkhandle);
325 lockmgr(&sc->ec_lock, LK_RELEASE);
328 static uint32_t EcGpeHandler(void *Context);
329 static ACPI_STATUS EcSpaceSetup(ACPI_HANDLE Region, UINT32 Function,
330 void *Context, void **return_Context);
331 static ACPI_STATUS EcSpaceHandler(UINT32 Function,
332 ACPI_PHYSICAL_ADDRESS Address,
333 UINT32 width, ACPI_INTEGER *Value,
334 void *Context, void *RegionContext);
335 static ACPI_STATUS EcWaitEvent(struct acpi_ec_softc *sc, EC_EVENT Event);
336 static ACPI_STATUS EcCommand(struct acpi_ec_softc *sc, EC_COMMAND cmd);
337 static ACPI_STATUS EcRead(struct acpi_ec_softc *sc, UINT8 Address,
339 static ACPI_STATUS EcWrite(struct acpi_ec_softc *sc, UINT8 Address,
341 static int acpi_ec_probe(device_t dev);
342 static int acpi_ec_attach(device_t dev);
344 static device_method_t acpi_ec_methods[] = {
345 /* Device interface */
346 DEVMETHOD(device_probe, acpi_ec_probe),
347 DEVMETHOD(device_attach, acpi_ec_attach),
352 static driver_t acpi_ec_driver = {
355 sizeof(struct acpi_ec_softc),
358 static devclass_t acpi_ec_devclass;
359 DRIVER_MODULE(acpi_ec, acpi, acpi_ec_driver, acpi_ec_devclass, 0, 0);
360 MODULE_DEPEND(acpi_ec, acpi, 1, 1, 1);
363 * Look for an ECDT and if we find one, set up default GPE and
364 * space handlers to catch attempts to access EC space before
365 * we have a real driver instance in place.
366 * TODO: if people report invalid ECDTs, add a tunable to disable them.
369 acpi_ec_ecdt_probe(device_t parent)
371 ACPI_TABLE_ECDT *ecdt;
375 struct acpi_ec_params *params;
377 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
379 /* Find and validate the ECDT. */
380 status = AcpiGetFirmwareTable("ECDT", 1, ACPI_LOGICAL_ADDRESSING,
381 (ACPI_TABLE_HEADER **)&ecdt);
382 if (ACPI_FAILURE(status) ||
383 ecdt->control.RegisterBitWidth != 8 ||
384 ecdt->data.RegisterBitWidth != 8) {
388 /* Create the child device with the given unit number. */
389 child = BUS_ADD_CHILD(parent, parent, 0, "acpi_ec", ecdt->uid);
391 printf("%s: can't add child\n", __func__);
395 /* Find and save the ACPI handle for this device. */
396 status = AcpiGetHandle(NULL, ecdt->ec_id, &h);
397 if (ACPI_FAILURE(status)) {
398 device_delete_child(parent, child);
399 printf("%s: can't get handle\n", __func__);
402 acpi_set_handle(child, h);
404 /* Set the data and CSR register addresses. */
405 bus_set_resource(child, SYS_RES_IOPORT, 0, ecdt->data.Address,
407 bus_set_resource(child, SYS_RES_IOPORT, 1, ecdt->control.Address,
411 * Store values for the probe/attach routines to use. Store the
412 * ECDT GPE bit and set the global lock flag according to _GLK.
413 * Note that it is not perfectly correct to be evaluating a method
414 * before initializing devices, but in practice this function
415 * should be safe to call at this point.
417 params = kmalloc(sizeof(struct acpi_ec_params), M_TEMP, M_WAITOK | M_ZERO);
418 params->gpe_handle = NULL;
419 params->gpe_bit = ecdt->gpe_bit;
420 params->uid = ecdt->uid;
421 acpi_GetInteger(h, "_GLK", ¶ms->glk);
422 acpi_set_private(child, params);
423 acpi_set_magic(child, (int)&acpi_ec_devclass);
425 /* Finish the attach process. */
426 if (device_probe_and_attach(child) != 0)
427 device_delete_child(parent, child);
431 acpi_ec_probe(device_t dev)
440 struct acpi_ec_params *params;
442 /* Check that this is a device and that EC is not disabled. */
443 if (acpi_get_type(dev) != ACPI_TYPE_DEVICE || acpi_disabled("ec"))
447 * If probed via ECDT, set description and continue. Otherwise,
448 * we can access the namespace and make sure this is not a
454 buf.Length = ACPI_ALLOCATE_BUFFER;
456 params = acpi_get_private(dev);
458 } else if (acpi_MatchHid(dev, "PNP0C09")) {
459 params = kmalloc(sizeof(struct acpi_ec_params), M_TEMP,
461 h = acpi_get_handle(dev);
464 * Read the unit ID to check for duplicate attach and the
465 * global lock value to see if we should acquire it when
468 status = acpi_GetInteger(h, "_UID", ¶ms->uid);
469 if (ACPI_FAILURE(status))
471 status = acpi_GetInteger(h, "_GLK", ¶ms->glk);
472 if (ACPI_FAILURE(status))
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.
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));
486 obj = (ACPI_OBJECT *)buf.Pointer;
491 case ACPI_TYPE_INTEGER:
492 params->gpe_handle = NULL;
493 params->gpe_bit = obj->Integer.Value;
495 case ACPI_TYPE_PACKAGE:
496 if (!ACPI_PKG_VALID(obj, 2))
499 acpi_GetReference(NULL, &obj->Package.Elements[0]);
500 if (params->gpe_handle == NULL ||
501 acpi_PkgInt32(obj, 1, ¶ms->gpe_bit) != 0)
505 device_printf(dev, "_GPE has invalid type %d\n", obj->Type);
509 /* Store the values we got from the namespace for attach. */
510 acpi_set_private(dev, params);
513 * Check for a duplicate probe. This can happen when a probe
514 * via ECDT succeeded already. If this is a duplicate, disable
517 peer = devclass_get_device(acpi_ec_devclass, params->uid);
518 if (peer == NULL || !device_is_alive(peer))
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);
532 if (ret > 0 && params)
533 kfree(params, M_TEMP);
535 AcpiOsFree(buf.Pointer);
540 acpi_ec_attach(device_t dev)
542 struct acpi_ec_softc *sc;
543 struct acpi_ec_params *params;
546 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
548 /* Fetch/initialize softc (assumes softc is pre-zeroed). */
549 sc = device_get_softc(dev);
550 params = acpi_get_private(dev);
552 sc->ec_handle = acpi_get_handle(dev);
553 lockinit(&sc->ec_lock, "eclock", 0, 0);
555 /* Retrieve previously probed values via device ivars. */
556 sc->ec_glk = params->glk;
557 sc->ec_gpebit = params->gpe_bit;
558 sc->ec_gpehandle = params->gpe_handle;
559 sc->ec_uid = params->uid;
560 kfree(params, M_TEMP);
562 /* Attach bus resources for data and command/status ports. */
564 sc->ec_data_res = bus_alloc_resource_any(sc->ec_dev, SYS_RES_IOPORT,
565 &sc->ec_data_rid, RF_ACTIVE);
566 if (sc->ec_data_res == NULL) {
567 device_printf(dev, "can't allocate data port\n");
570 sc->ec_data_tag = rman_get_bustag(sc->ec_data_res);
571 sc->ec_data_handle = rman_get_bushandle(sc->ec_data_res);
574 sc->ec_csr_res = bus_alloc_resource_any(sc->ec_dev, SYS_RES_IOPORT,
575 &sc->ec_csr_rid, RF_ACTIVE);
576 if (sc->ec_csr_res == NULL) {
577 device_printf(dev, "can't allocate command/status port\n");
580 sc->ec_csr_tag = rman_get_bustag(sc->ec_csr_res);
581 sc->ec_csr_handle = rman_get_bushandle(sc->ec_csr_res);
584 * Install a handler for this EC's GPE bit. We want edge-triggered
587 ACPI_DEBUG_PRINT((ACPI_DB_RESOURCES, "attaching GPE handler\n"));
588 Status = AcpiInstallGpeHandler(sc->ec_gpehandle, sc->ec_gpebit,
589 ACPI_GPE_EDGE_TRIGGERED, &EcGpeHandler, sc);
590 if (ACPI_FAILURE(Status)) {
591 device_printf(dev, "can't install GPE handler for %s - %s\n",
592 acpi_name(sc->ec_handle), AcpiFormatException(Status));
597 * Install address space handler
599 ACPI_DEBUG_PRINT((ACPI_DB_RESOURCES, "attaching address space handler\n"));
600 Status = AcpiInstallAddressSpaceHandler(sc->ec_handle, ACPI_ADR_SPACE_EC,
601 &EcSpaceHandler, &EcSpaceSetup, sc);
602 if (ACPI_FAILURE(Status)) {
603 device_printf(dev, "can't install address space handler for %s - %s\n",
604 acpi_name(sc->ec_handle), AcpiFormatException(Status));
608 /* Enable runtime GPEs for the handler. */
609 Status = AcpiSetGpeType(sc->ec_gpehandle, sc->ec_gpebit,
610 ACPI_GPE_TYPE_RUNTIME);
611 if (ACPI_FAILURE(Status)) {
612 device_printf(dev, "AcpiSetGpeType failed: %s\n",
613 AcpiFormatException(Status));
616 Status = AcpiEnableGpe(sc->ec_gpehandle, sc->ec_gpebit, ACPI_NOT_ISR);
617 if (ACPI_FAILURE(Status)) {
618 device_printf(dev, "AcpiEnableGpe failed: %s\n",
619 AcpiFormatException(Status));
623 ACPI_DEBUG_PRINT((ACPI_DB_RESOURCES, "acpi_ec_attach complete\n"));
627 AcpiRemoveGpeHandler(sc->ec_gpehandle, sc->ec_gpebit, &EcGpeHandler);
628 AcpiRemoveAddressSpaceHandler(sc->ec_handle, ACPI_ADR_SPACE_EC,
631 bus_release_resource(sc->ec_dev, SYS_RES_IOPORT, sc->ec_csr_rid,
634 bus_release_resource(sc->ec_dev, SYS_RES_IOPORT, sc->ec_data_rid,
636 /* mtx_destroy(&sc->ec_mtx); */
641 EcGpeQueryHandler(void *Context)
643 struct acpi_ec_softc *sc = (struct acpi_ec_softc *)Context;
649 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
650 KASSERT(Context != NULL, ("EcGpeQueryHandler called with NULL"));
653 if (ACPI_FAILURE(Status)) {
654 ACPI_VPRINT(sc->ec_dev, acpi_device_get_parent_softc(sc->ec_dev),
655 "GpeQuery lock error: %s\n", AcpiFormatException(Status));
660 * If the EC_SCI bit of the status register is not set, then pass
661 * it along to any potential waiters as it may be an IBE/OBF event.
663 EcStatus = EC_GET_CSR(sc);
664 if ((EcStatus & EC_EVENT_SCI) == 0) {
665 sc->ec_csrvalue = EcStatus;
666 wakeup(&sc->ec_csrvalue);
672 * Send a query command to the EC to find out which _Qxx call it
673 * wants to make. This command clears the SCI bit and also the
674 * interrupt source since we are edge-triggered.
676 Status = EcCommand(sc, EC_COMMAND_QUERY);
677 if (ACPI_FAILURE(Status)) {
679 ACPI_VPRINT(sc->ec_dev, acpi_device_get_parent_softc(sc->ec_dev),
680 "GPE query failed - %s\n", AcpiFormatException(Status));
683 Data = EC_GET_DATA(sc);
686 /* Ignore the value for "no outstanding event". (13.3.5) */
690 /* Evaluate _Qxx to respond to the controller. */
691 sprintf(qxx, "_Q%02x", Data);
693 Status = AcpiEvaluateObject(sc->ec_handle, qxx, NULL, NULL);
694 if (ACPI_FAILURE(Status) && Status != AE_NOT_FOUND) {
695 ACPI_VPRINT(sc->ec_dev, acpi_device_get_parent_softc(sc->ec_dev),
696 "evaluation of GPE query method %s failed - %s\n",
697 qxx, AcpiFormatException(Status));
701 /* Re-enable the GPE event so we'll get future requests. */
702 Status = AcpiEnableGpe(sc->ec_gpehandle, sc->ec_gpebit, ACPI_NOT_ISR);
703 if (ACPI_FAILURE(Status))
704 printf("EcGpeQueryHandler: AcpiEnableEvent failed\n");
708 * Handle a GPE. Currently we only handle SCI events as others must
709 * be handled by polling in EcWaitEvent(). This is because some ECs
710 * treat events as level when they should be edge-triggered.
713 EcGpeHandler(void *Context)
715 struct acpi_ec_softc *sc = Context;
718 KASSERT(Context != NULL, ("EcGpeHandler called with NULL"));
720 /* Disable further GPEs while we handle this one. */
721 AcpiDisableGpe(sc->ec_gpehandle, sc->ec_gpebit, ACPI_NOT_ISR);
723 /* Schedule the GPE query handler. */
724 Status = AcpiOsQueueForExecution(OSD_PRIORITY_GPE, EcGpeQueryHandler,
726 if (ACPI_FAILURE(Status)) {
727 printf("Queuing GPE query handler failed.\n");
728 Status = AcpiEnableGpe(sc->ec_gpehandle, sc->ec_gpebit, ACPI_NOT_ISR);
729 if (ACPI_FAILURE(Status))
730 printf("EcGpeHandler: AcpiEnableEvent failed\n");
737 EcSpaceSetup(ACPI_HANDLE Region, UINT32 Function, void *Context,
738 void **RegionContext)
741 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
744 * If deactivating a region, always set the output to NULL. Otherwise,
745 * just pass the context through.
747 if (Function == ACPI_REGION_DEACTIVATE)
748 *RegionContext = NULL;
750 *RegionContext = Context;
752 return_ACPI_STATUS (AE_OK);
756 EcSpaceHandler(UINT32 Function, ACPI_PHYSICAL_ADDRESS Address, UINT32 width,
757 ACPI_INTEGER *Value, void *Context, void *RegionContext)
759 struct acpi_ec_softc *sc = (struct acpi_ec_softc *)Context;
761 UINT8 EcAddr, EcData;
764 ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, (UINT32)Address);
766 if (width % 8 != 0 || Value == NULL || Context == NULL)
767 return_ACPI_STATUS (AE_BAD_PARAMETER);
768 if (Address + (width / 8) - 1 > 0xFF)
769 return_ACPI_STATUS (AE_BAD_ADDRESS);
771 if (Function == ACPI_READ)
776 /* Perform the transaction(s), based on width. */
777 for (i = 0; i < width; i += 8, EcAddr++) {
779 if (ACPI_FAILURE(Status))
784 Status = EcRead(sc, EcAddr, &EcData);
785 if (ACPI_SUCCESS(Status))
786 *Value |= ((ACPI_INTEGER)EcData) << i;
789 EcData = (UINT8)((*Value) >> i);
790 Status = EcWrite(sc, EcAddr, &EcData);
793 device_printf(sc->ec_dev, "invalid EcSpaceHandler function %d\n",
795 Status = AE_BAD_PARAMETER;
799 if (ACPI_FAILURE(Status))
803 return_ACPI_STATUS (Status);
807 EcWaitEvent(struct acpi_ec_softc *sc, EC_EVENT Event)
811 int count, i, period, retval, slp_ival;
812 static int EcDbgMaxDelay;
814 /* mtx_assert(&sc->ec_mtx, MA_OWNED); */
815 Status = AE_NO_HARDWARE_RESPONSE;
818 * Wait for 1 us before checking the CSR. Testing shows about
819 * 50% of requests complete in 1 us and 90% of them complete
825 * Poll the EC status register for up to 1 ms in chunks of 10 us
826 * to detect completion of the last command.
828 for (i = 0; i < 1000 / EC_POLL_DELAY; i++) {
829 EcStatus = EC_GET_CSR(sc);
830 if (EVENT_READY(Event, EcStatus)) {
834 AcpiOsStall(EC_POLL_DELAY);
836 period = i * EC_POLL_DELAY;
839 * If we still don't have a response and we're up and running, wait up
840 * to ec_poll_timeout ms for completion, sleeping for chunks of 10 ms.
843 if (Status != AE_OK) {
845 count = ec_poll_timeout / 10;
851 for (i = 0; i < count; i++) {
853 EcStatus = EC_GET_CSR(sc);
855 EcStatus = sc->ec_csrvalue;
856 if (EVENT_READY(Event, EcStatus)) {
861 retval = tsleep(&sc->ec_csrvalue, 0, "ecpoll", slp_ival);
867 /* Calculate new delay and print it if it exceeds the max. */
870 if (period > EcDbgMaxDelay) {
871 EcDbgMaxDelay = period;
872 ACPI_VPRINT(sc->ec_dev, acpi_device_get_parent_softc(sc->ec_dev),
873 "info: new max delay is %d us\n", period);
880 EcCommand(struct acpi_ec_softc *sc, EC_COMMAND cmd)
885 /*mtx_assert(&sc->ec_mtx, MA_OWNED);*/
887 /* Decide what to wait for based on command type. */
889 case EC_COMMAND_READ:
890 case EC_COMMAND_WRITE:
891 case EC_COMMAND_BURST_DISABLE:
892 Event = EC_EVENT_INPUT_BUFFER_EMPTY;
894 case EC_COMMAND_QUERY:
895 case EC_COMMAND_BURST_ENABLE:
896 Event = EC_EVENT_OUTPUT_BUFFER_FULL;
899 ACPI_VPRINT(sc->ec_dev, acpi_device_get_parent_softc(sc->ec_dev),
900 "EcCommand: Invalid command %#x\n", cmd);
901 return (AE_BAD_PARAMETER);
904 /* Run the command and wait for the chosen event. */
906 Status = EcWaitEvent(sc, Event);
907 if (ACPI_FAILURE(Status)) {
908 ACPI_VPRINT(sc->ec_dev, acpi_device_get_parent_softc(sc->ec_dev),
909 "EcCommand: no response to %#x\n", cmd);
916 EcRead(struct acpi_ec_softc *sc, UINT8 Address, UINT8 *Data)
920 /*mtx_assert(&sc->ec_mtx, MA_OWNED);*/
923 /* If we can't start burst mode, continue anyway. */
924 EcCommand(sc, EC_COMMAND_BURST_ENABLE);
927 Status = EcCommand(sc, EC_COMMAND_READ);
928 if (ACPI_FAILURE(Status))
931 EC_SET_DATA(sc, Address);
932 Status = EcWaitEvent(sc, EC_EVENT_OUTPUT_BUFFER_FULL);
933 if (ACPI_FAILURE(Status)) {
934 ACPI_VPRINT(sc->ec_dev, acpi_device_get_parent_softc(sc->ec_dev),
935 "EcRead: Failed waiting for EC to send data.\n");
939 *Data = EC_GET_DATA(sc);
942 if (sc->ec_burstactive) {
943 Status = EcCommand(sc, EC_COMMAND_BURST_DISABLE);
944 if (ACPI_FAILURE(Status))
953 EcWrite(struct acpi_ec_softc *sc, UINT8 Address, UINT8 *Data)
957 /*mtx_assert(&sc->ec_mtx, MA_OWNED);*/
960 /* If we can't start burst mode, continue anyway. */
961 EcCommand(sc, EC_COMMAND_BURST_ENABLE);
964 Status = EcCommand(sc, EC_COMMAND_WRITE);
965 if (ACPI_FAILURE(Status))
968 EC_SET_DATA(sc, Address);
969 Status = EcWaitEvent(sc, EC_EVENT_INPUT_BUFFER_EMPTY);
970 if (ACPI_FAILURE(Status)) {
971 ACPI_VPRINT(sc->ec_dev, acpi_device_get_parent_softc(sc->ec_dev),
972 "EcRead: Failed waiting for EC to process address\n");
976 EC_SET_DATA(sc, *Data);
977 Status = EcWaitEvent(sc, EC_EVENT_INPUT_BUFFER_EMPTY);
978 if (ACPI_FAILURE(Status)) {
979 ACPI_VPRINT(sc->ec_dev, acpi_device_get_parent_softc(sc->ec_dev),
980 "EcWrite: Failed waiting for EC to process data\n");
985 if (sc->ec_burstactive) {
986 Status = EcCommand(sc, EC_COMMAND_BURST_DISABLE);
987 if (ACPI_FAILURE(Status))