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.52 2004/06/13 22:52:30 njl Exp $
29 * $DragonFly: src/sys/dev/acpica5/acpi_ec.c,v 1.14 2008/08/27 16:35:19 hasso 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.52 2004/06/13 22:52:30 njl Exp $
141 * $DragonFly: src/sys/dev/acpica5/acpi_ec.c,v 1.14 2008/08/27 16:35:19 hasso 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>
153 #include <sys/rman.h>
156 #include "accommon.h"
157 #include <dev/acpica5/acpivar.h>
160 * Hooks for the ACPI CA debugging infrastructure
162 #define _COMPONENT ACPI_EC
163 ACPI_MODULE_NAME("EC")
169 typedef UINT8 EC_COMMAND;
171 #define EC_COMMAND_UNKNOWN ((EC_COMMAND) 0x00)
172 #define EC_COMMAND_READ ((EC_COMMAND) 0x80)
173 #define EC_COMMAND_WRITE ((EC_COMMAND) 0x81)
174 #define EC_COMMAND_BURST_ENABLE ((EC_COMMAND) 0x82)
175 #define EC_COMMAND_BURST_DISABLE ((EC_COMMAND) 0x83)
176 #define EC_COMMAND_QUERY ((EC_COMMAND) 0x84)
181 * The encoding of the EC status register is illustrated below.
182 * Note that a set bit (1) indicates the property is TRUE
183 * (e.g. if bit 0 is set then the output buffer is full).
188 * | | | | | | | +- Output Buffer Full?
189 * | | | | | | +--- Input Buffer Full?
190 * | | | | | +----- <reserved>
191 * | | | | +------- Data Register is Command Byte?
192 * | | | +--------- Burst Mode Enabled?
193 * | | +----------- SCI Event?
194 * | +------------- SMI Event?
195 * +--------------- <Reserved>
198 typedef UINT8 EC_STATUS;
200 #define EC_FLAG_OUTPUT_BUFFER ((EC_STATUS) 0x01)
201 #define EC_FLAG_INPUT_BUFFER ((EC_STATUS) 0x02)
202 #define EC_FLAG_BURST_MODE ((EC_STATUS) 0x10)
203 #define EC_FLAG_SCI ((EC_STATUS) 0x20)
209 typedef UINT8 EC_EVENT;
211 #define EC_EVENT_UNKNOWN ((EC_EVENT) 0x00)
212 #define EC_EVENT_OUTPUT_BUFFER_FULL ((EC_EVENT) 0x01)
213 #define EC_EVENT_INPUT_BUFFER_EMPTY ((EC_EVENT) 0x02)
214 #define EC_EVENT_SCI ((EC_EVENT) 0x20)
217 * Register access primitives
219 #define EC_GET_DATA(sc) \
220 bus_space_read_1((sc)->ec_data_tag, (sc)->ec_data_handle, 0)
222 #define EC_SET_DATA(sc, v) \
223 bus_space_write_1((sc)->ec_data_tag, (sc)->ec_data_handle, 0, (v))
225 #define EC_GET_CSR(sc) \
226 bus_space_read_1((sc)->ec_csr_tag, (sc)->ec_csr_handle, 0)
228 #define EC_SET_CSR(sc, v) \
229 bus_space_write_1((sc)->ec_csr_tag, (sc)->ec_csr_handle, 0, (v))
231 /* Additional params to pass from the probe routine */
232 struct acpi_ec_params {
235 ACPI_HANDLE gpe_handle;
239 /* Indicate that this device has already been probed via ECDT. */
240 #define DEV_ECDT(x) (acpi_get_magic(x) == (int)&acpi_ec_devclass)
245 struct acpi_ec_softc {
247 ACPI_HANDLE ec_handle;
249 ACPI_HANDLE ec_gpehandle;
254 struct resource *ec_data_res;
255 bus_space_tag_t ec_data_tag;
256 bus_space_handle_t ec_data_handle;
259 struct resource *ec_csr_res;
260 bus_space_tag_t ec_csr_tag;
261 bus_space_handle_t ec_csr_handle;
270 * I couldn't find it in the spec but other implementations also use a
271 * value of 1 ms for the time to acquire global lock.
273 #define EC_LOCK_TIMEOUT 1000
275 /* Default interval in microseconds for the status polling loop. */
276 #define EC_POLL_DELAY 10
278 /* Total time in ms spent in the poll loop waiting for a response. */
279 #define EC_POLL_TIMEOUT 100
281 #define EVENT_READY(event, status) \
282 (((event) == EC_EVENT_OUTPUT_BUFFER_FULL && \
283 ((status) & EC_FLAG_OUTPUT_BUFFER) != 0) || \
284 ((event) == EC_EVENT_INPUT_BUFFER_EMPTY && \
285 ((status) & EC_FLAG_INPUT_BUFFER) == 0))
287 static int ec_poll_timeout = EC_POLL_TIMEOUT;
288 TUNABLE_INT("hw.acpi.ec.poll_timeout", &ec_poll_timeout);
290 static __inline ACPI_STATUS
291 EcLock(struct acpi_ec_softc *sc)
293 ACPI_STATUS status = AE_OK;
295 /* Always acquire this EC's mutex. */
296 lockmgr(&sc->ec_lock, LK_EXCLUSIVE|LK_RETRY);
298 /* If _GLK is non-zero, also acquire the global lock. */
300 status = AcpiAcquireGlobalLock(EC_LOCK_TIMEOUT, &sc->ec_glkhandle);
301 if (ACPI_FAILURE(status))
302 lockmgr(&sc->ec_lock, LK_RELEASE);
309 EcUnlock(struct acpi_ec_softc *sc)
312 AcpiReleaseGlobalLock(sc->ec_glkhandle);
313 lockmgr(&sc->ec_lock, LK_RELEASE);
316 static uint32_t EcGpeHandler(void *Context);
317 static ACPI_STATUS EcSpaceSetup(ACPI_HANDLE Region, UINT32 Function,
318 void *Context, void **return_Context);
319 static ACPI_STATUS EcSpaceHandler(UINT32 Function,
320 ACPI_PHYSICAL_ADDRESS Address,
321 UINT32 width, ACPI_INTEGER *Value,
322 void *Context, void *RegionContext);
323 static ACPI_STATUS EcWaitEvent(struct acpi_ec_softc *sc, EC_EVENT Event);
324 static ACPI_STATUS EcCommand(struct acpi_ec_softc *sc, EC_COMMAND cmd);
325 static ACPI_STATUS EcRead(struct acpi_ec_softc *sc, UINT8 Address,
327 static ACPI_STATUS EcWrite(struct acpi_ec_softc *sc, UINT8 Address,
329 static int acpi_ec_probe(device_t dev);
330 static int acpi_ec_attach(device_t dev);
331 static int acpi_ec_read_method(device_t dev, u_int addr,
332 ACPI_INTEGER *val, int width);
333 static int acpi_ec_write_method(device_t dev, u_int addr,
334 ACPI_INTEGER val, int width);
336 static device_method_t acpi_ec_methods[] = {
337 /* Device interface */
338 DEVMETHOD(device_probe, acpi_ec_probe),
339 DEVMETHOD(device_attach, acpi_ec_attach),
341 /* Embedded controller interface */
342 DEVMETHOD(acpi_ec_read, acpi_ec_read_method),
343 DEVMETHOD(acpi_ec_write, acpi_ec_write_method),
348 static driver_t acpi_ec_driver = {
351 sizeof(struct acpi_ec_softc),
354 static devclass_t acpi_ec_devclass;
355 DRIVER_MODULE(acpi_ec, acpi, acpi_ec_driver, acpi_ec_devclass, 0, 0);
356 MODULE_DEPEND(acpi_ec, acpi, 1, 1, 1);
359 * Look for an ECDT and if we find one, set up default GPE and
360 * space handlers to catch attempts to access EC space before
361 * we have a real driver instance in place.
362 * TODO: if people report invalid ECDTs, add a tunable to disable them.
365 acpi_ec_ecdt_probe(device_t parent)
367 ACPI_TABLE_ECDT *ecdt;
371 struct acpi_ec_params *params;
373 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
375 /* Find and validate the ECDT. */
376 status = AcpiGetTable(ACPI_SIG_ECDT, 1, (ACPI_TABLE_HEADER **)&ecdt);
377 if (ACPI_FAILURE(status) ||
378 ecdt->Control.BitWidth != 8 || ecdt->Data.BitWidth != 8) {
382 /* Create the child device with the given unit number. */
383 child = BUS_ADD_CHILD(parent, parent, 0, "acpi_ec", ecdt->Uid);
385 kprintf("%s: can't add child\n", __func__);
389 /* Find and save the ACPI handle for this device. */
390 status = AcpiGetHandle(NULL, ecdt->Id, &h);
391 if (ACPI_FAILURE(status)) {
392 device_delete_child(parent, child);
393 kprintf("%s: can't get handle\n", __func__);
396 acpi_set_handle(child, h);
398 /* Set the data and CSR register addresses. */
399 bus_set_resource(child, SYS_RES_IOPORT, 0, ecdt->Data.Address,
401 bus_set_resource(child, SYS_RES_IOPORT, 1, ecdt->Control.Address,
405 * Store values for the probe/attach routines to use. Store the
406 * ECDT GPE bit and set the global lock flag according to _GLK.
407 * Note that it is not perfectly correct to be evaluating a method
408 * before initializing devices, but in practice this function
409 * should be safe to call at this point.
411 params = kmalloc(sizeof(struct acpi_ec_params), M_TEMP, M_WAITOK | M_ZERO);
412 params->gpe_handle = NULL;
413 params->gpe_bit = ecdt->Gpe;
414 params->uid = ecdt->Uid;
415 acpi_GetInteger(h, "_GLK", ¶ms->glk);
416 acpi_set_private(child, params);
417 acpi_set_magic(child, (int)&acpi_ec_devclass);
419 /* Finish the attach process. */
420 if (device_probe_and_attach(child) != 0)
421 device_delete_child(parent, child);
425 acpi_ec_probe(device_t dev)
434 struct acpi_ec_params *params;
436 /* Check that this is a device and that EC is not disabled. */
437 if (acpi_get_type(dev) != ACPI_TYPE_DEVICE || acpi_disabled("ec"))
441 * If probed via ECDT, set description and continue. Otherwise,
442 * we can access the namespace and make sure this is not a
448 buf.Length = ACPI_ALLOCATE_BUFFER;
450 params = acpi_get_private(dev);
452 } else if (acpi_MatchHid(acpi_get_handle(dev), "PNP0C09")) {
453 params = kmalloc(sizeof(struct acpi_ec_params), M_TEMP,
455 h = acpi_get_handle(dev);
458 * Read the unit ID to check for duplicate attach and the
459 * global lock value to see if we should acquire it when
462 status = acpi_GetInteger(h, "_UID", ¶ms->uid);
463 if (ACPI_FAILURE(status))
465 status = acpi_GetInteger(h, "_GLK", ¶ms->glk);
466 if (ACPI_FAILURE(status))
470 * Evaluate the _GPE method to find the GPE bit used by the EC to
471 * signal status (SCI). If it's a package, it contains a reference
472 * and GPE bit, similar to _PRW.
474 status = AcpiEvaluateObject(h, "_GPE", NULL, &buf);
475 if (ACPI_FAILURE(status)) {
476 device_printf(dev, "can't evaluate _GPE - %s\n",
477 AcpiFormatException(status));
480 obj = (ACPI_OBJECT *)buf.Pointer;
485 case ACPI_TYPE_INTEGER:
486 params->gpe_handle = NULL;
487 params->gpe_bit = obj->Integer.Value;
489 case ACPI_TYPE_PACKAGE:
490 if (!ACPI_PKG_VALID(obj, 2))
493 acpi_GetReference(NULL, &obj->Package.Elements[0]);
494 if (params->gpe_handle == NULL ||
495 acpi_PkgInt32(obj, 1, ¶ms->gpe_bit) != 0)
499 device_printf(dev, "_GPE has invalid type %d\n", obj->Type);
503 /* Store the values we got from the namespace for attach. */
504 acpi_set_private(dev, params);
507 * Check for a duplicate probe. This can happen when a probe
508 * via ECDT succeeded already. If this is a duplicate, disable
511 peer = devclass_get_device(acpi_ec_devclass, params->uid);
512 if (peer == NULL || !device_is_alive(peer))
520 ksnprintf(desc, sizeof(desc), "Embedded Controller: GPE %#x%s%s",
521 params->gpe_bit, (params->glk) ? ", GLK" : "",
522 DEV_ECDT(dev) ? ", ECDT" : "");
523 device_set_desc_copy(dev, desc);
526 if (ret > 0 && params)
527 kfree(params, M_TEMP);
529 AcpiOsFree(buf.Pointer);
534 acpi_ec_attach(device_t dev)
536 struct acpi_ec_softc *sc;
537 struct acpi_ec_params *params;
540 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
542 /* Fetch/initialize softc (assumes softc is pre-zeroed). */
543 sc = device_get_softc(dev);
544 params = acpi_get_private(dev);
546 sc->ec_handle = acpi_get_handle(dev);
547 lockinit(&sc->ec_lock, "eclock", 0, 0);
549 /* Retrieve previously probed values via device ivars. */
550 sc->ec_glk = params->glk;
551 sc->ec_gpebit = params->gpe_bit;
552 sc->ec_gpehandle = params->gpe_handle;
553 sc->ec_uid = params->uid;
554 kfree(params, M_TEMP);
556 /* Attach bus resources for data and command/status ports. */
558 sc->ec_data_res = bus_alloc_resource_any(sc->ec_dev, SYS_RES_IOPORT,
559 &sc->ec_data_rid, RF_ACTIVE);
560 if (sc->ec_data_res == NULL) {
561 device_printf(dev, "can't allocate data port\n");
564 sc->ec_data_tag = rman_get_bustag(sc->ec_data_res);
565 sc->ec_data_handle = rman_get_bushandle(sc->ec_data_res);
568 sc->ec_csr_res = bus_alloc_resource_any(sc->ec_dev, SYS_RES_IOPORT,
569 &sc->ec_csr_rid, RF_ACTIVE);
570 if (sc->ec_csr_res == NULL) {
571 device_printf(dev, "can't allocate command/status port\n");
574 sc->ec_csr_tag = rman_get_bustag(sc->ec_csr_res);
575 sc->ec_csr_handle = rman_get_bushandle(sc->ec_csr_res);
578 * Install a handler for this EC's GPE bit. We want edge-triggered
581 ACPI_DEBUG_PRINT((ACPI_DB_RESOURCES, "attaching GPE handler\n"));
582 Status = AcpiInstallGpeHandler(sc->ec_gpehandle, sc->ec_gpebit,
583 ACPI_GPE_EDGE_TRIGGERED, &EcGpeHandler, sc);
584 if (ACPI_FAILURE(Status)) {
585 device_printf(dev, "can't install GPE handler for %s - %s\n",
586 acpi_name(sc->ec_handle), AcpiFormatException(Status));
591 * Install address space handler
593 ACPI_DEBUG_PRINT((ACPI_DB_RESOURCES, "attaching address space handler\n"));
594 Status = AcpiInstallAddressSpaceHandler(sc->ec_handle, ACPI_ADR_SPACE_EC,
595 &EcSpaceHandler, &EcSpaceSetup, sc);
596 if (ACPI_FAILURE(Status)) {
597 device_printf(dev, "can't install address space handler for %s - %s\n",
598 acpi_name(sc->ec_handle), AcpiFormatException(Status));
602 /* Enable runtime GPEs for the handler. */
603 Status = AcpiSetGpeType(sc->ec_gpehandle, sc->ec_gpebit,
604 ACPI_GPE_TYPE_RUNTIME);
605 if (ACPI_FAILURE(Status)) {
606 device_printf(dev, "AcpiSetGpeType failed: %s\n",
607 AcpiFormatException(Status));
610 Status = AcpiEnableGpe(sc->ec_gpehandle, sc->ec_gpebit, ACPI_NOT_ISR);
611 if (ACPI_FAILURE(Status)) {
612 device_printf(dev, "AcpiEnableGpe failed: %s\n",
613 AcpiFormatException(Status));
617 ACPI_DEBUG_PRINT((ACPI_DB_RESOURCES, "acpi_ec_attach complete\n"));
621 AcpiRemoveGpeHandler(sc->ec_gpehandle, sc->ec_gpebit, &EcGpeHandler);
622 AcpiRemoveAddressSpaceHandler(sc->ec_handle, ACPI_ADR_SPACE_EC,
625 bus_release_resource(sc->ec_dev, SYS_RES_IOPORT, sc->ec_csr_rid,
628 bus_release_resource(sc->ec_dev, SYS_RES_IOPORT, sc->ec_data_rid,
630 /* mtx_destroy(&sc->ec_mtx); */
634 /* Methods to allow other devices (e.g., smbat) to read/write EC space. */
636 acpi_ec_read_method(device_t dev, u_int addr, ACPI_INTEGER *val, int width)
638 struct acpi_ec_softc *sc;
641 sc = device_get_softc(dev);
642 status = EcSpaceHandler(ACPI_READ, addr, width * 8, val, sc, NULL);
643 if (ACPI_FAILURE(status))
649 acpi_ec_write_method(device_t dev, u_int addr, ACPI_INTEGER val, int width)
651 struct acpi_ec_softc *sc;
654 sc = device_get_softc(dev);
655 status = EcSpaceHandler(ACPI_WRITE, addr, width * 8, &val, sc, NULL);
656 if (ACPI_FAILURE(status))
662 EcGpeQueryHandler(void *Context)
664 struct acpi_ec_softc *sc = (struct acpi_ec_softc *)Context;
670 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
671 KASSERT(Context != NULL, ("EcGpeQueryHandler called with NULL"));
674 if (ACPI_FAILURE(Status)) {
675 ACPI_VPRINT(sc->ec_dev, acpi_device_get_parent_softc(sc->ec_dev),
676 "GpeQuery lock error: %s\n", AcpiFormatException(Status));
681 * If the EC_SCI bit of the status register is not set, then pass
682 * it along to any potential waiters as it may be an IBE/OBF event.
684 EcStatus = EC_GET_CSR(sc);
685 if ((EcStatus & EC_EVENT_SCI) == 0) {
686 sc->ec_csrvalue = EcStatus;
687 wakeup(&sc->ec_csrvalue);
693 * Send a query command to the EC to find out which _Qxx call it
694 * wants to make. This command clears the SCI bit and also the
695 * interrupt source since we are edge-triggered.
697 Status = EcCommand(sc, EC_COMMAND_QUERY);
698 if (ACPI_FAILURE(Status)) {
700 ACPI_VPRINT(sc->ec_dev, acpi_device_get_parent_softc(sc->ec_dev),
701 "GPE query failed - %s\n", AcpiFormatException(Status));
704 Data = EC_GET_DATA(sc);
707 /* Ignore the value for "no outstanding event". (13.3.5) */
711 /* Evaluate _Qxx to respond to the controller. */
712 ksprintf(qxx, "_Q%02x", Data);
714 Status = AcpiEvaluateObject(sc->ec_handle, qxx, NULL, NULL);
715 if (ACPI_FAILURE(Status) && Status != AE_NOT_FOUND) {
716 ACPI_VPRINT(sc->ec_dev, acpi_device_get_parent_softc(sc->ec_dev),
717 "evaluation of GPE query method %s failed - %s\n",
718 qxx, AcpiFormatException(Status));
722 /* Re-enable the GPE event so we'll get future requests. */
723 Status = AcpiEnableGpe(sc->ec_gpehandle, sc->ec_gpebit, ACPI_NOT_ISR);
724 if (ACPI_FAILURE(Status))
725 kprintf("EcGpeQueryHandler: AcpiEnableEvent failed\n");
729 * Handle a GPE. Currently we only handle SCI events as others must
730 * be handled by polling in EcWaitEvent(). This is because some ECs
731 * treat events as level when they should be edge-triggered.
734 EcGpeHandler(void *Context)
736 struct acpi_ec_softc *sc = Context;
739 KASSERT(Context != NULL, ("EcGpeHandler called with NULL"));
741 /* Disable further GPEs while we handle this one. */
742 AcpiDisableGpe(sc->ec_gpehandle, sc->ec_gpebit, ACPI_ISR);
744 /* Schedule the GPE query handler. */
745 Status = AcpiOsExecute(OSL_GPE_HANDLER, EcGpeQueryHandler,
747 if (ACPI_FAILURE(Status)) {
748 kprintf("Queuing GPE query handler failed.\n");
749 Status = AcpiEnableGpe(sc->ec_gpehandle, sc->ec_gpebit, ACPI_ISR);
750 if (ACPI_FAILURE(Status))
751 kprintf("EcGpeHandler: AcpiEnableEvent failed\n");
758 EcSpaceSetup(ACPI_HANDLE Region, UINT32 Function, void *Context,
759 void **RegionContext)
762 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
765 * If deactivating a region, always set the output to NULL. Otherwise,
766 * just pass the context through.
768 if (Function == ACPI_REGION_DEACTIVATE)
769 *RegionContext = NULL;
771 *RegionContext = Context;
773 return_ACPI_STATUS (AE_OK);
777 EcSpaceHandler(UINT32 Function, ACPI_PHYSICAL_ADDRESS Address, UINT32 width,
778 ACPI_INTEGER *Value, void *Context, void *RegionContext)
780 struct acpi_ec_softc *sc = (struct acpi_ec_softc *)Context;
782 UINT8 EcAddr, EcData;
785 ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, (UINT32)Address);
787 if (width % 8 != 0 || Value == NULL || Context == NULL)
788 return_ACPI_STATUS (AE_BAD_PARAMETER);
789 if (Address + (width / 8) - 1 > 0xFF)
790 return_ACPI_STATUS (AE_BAD_ADDRESS);
792 if (Function == ACPI_READ)
797 /* Perform the transaction(s), based on width. */
798 for (i = 0; i < width; i += 8, EcAddr++) {
800 if (ACPI_FAILURE(Status))
805 Status = EcRead(sc, EcAddr, &EcData);
806 if (ACPI_SUCCESS(Status))
807 *Value |= ((ACPI_INTEGER)EcData) << i;
810 EcData = (UINT8)((*Value) >> i);
811 Status = EcWrite(sc, EcAddr, &EcData);
814 device_printf(sc->ec_dev, "invalid EcSpaceHandler function %d\n",
816 Status = AE_BAD_PARAMETER;
820 if (ACPI_FAILURE(Status))
824 return_ACPI_STATUS (Status);
828 EcWaitEvent(struct acpi_ec_softc *sc, EC_EVENT Event)
832 int count, i, period, retval, slp_ival;
833 static int EcDbgMaxDelay;
835 /* mtx_assert(&sc->ec_mtx, MA_OWNED); */
836 Status = AE_NO_HARDWARE_RESPONSE;
839 * Wait for 1 us before checking the CSR. Testing shows about
840 * 50% of requests complete in 1 us and 90% of them complete
846 * Poll the EC status register for up to 1 ms in chunks of 10 us
847 * to detect completion of the last command.
849 for (i = 0; i < 1000 / EC_POLL_DELAY; i++) {
850 EcStatus = EC_GET_CSR(sc);
851 if (EVENT_READY(Event, EcStatus)) {
855 AcpiOsStall(EC_POLL_DELAY);
857 period = i * EC_POLL_DELAY;
860 * If we still don't have a response and we're up and running, wait up
861 * to ec_poll_timeout ms for completion, sleeping for chunks of 10 ms.
864 if (Status != AE_OK) {
866 count = ec_poll_timeout / 10;
872 for (i = 0; i < count; i++) {
874 EcStatus = EC_GET_CSR(sc);
876 EcStatus = sc->ec_csrvalue;
877 if (EVENT_READY(Event, EcStatus)) {
882 retval = tsleep(&sc->ec_csrvalue, 0, "ecpoll", slp_ival);
888 /* Calculate new delay and print it if it exceeds the max. */
891 if (period > EcDbgMaxDelay) {
892 EcDbgMaxDelay = period;
893 ACPI_VPRINT(sc->ec_dev, acpi_device_get_parent_softc(sc->ec_dev),
894 "info: new max delay is %d us\n", period);
901 EcCommand(struct acpi_ec_softc *sc, EC_COMMAND cmd)
906 /*mtx_assert(&sc->ec_mtx, MA_OWNED);*/
908 /* Decide what to wait for based on command type. */
910 case EC_COMMAND_READ:
911 case EC_COMMAND_WRITE:
912 case EC_COMMAND_BURST_DISABLE:
913 Event = EC_EVENT_INPUT_BUFFER_EMPTY;
915 case EC_COMMAND_QUERY:
916 case EC_COMMAND_BURST_ENABLE:
917 Event = EC_EVENT_OUTPUT_BUFFER_FULL;
920 ACPI_VPRINT(sc->ec_dev, acpi_device_get_parent_softc(sc->ec_dev),
921 "EcCommand: Invalid command %#x\n", cmd);
922 return (AE_BAD_PARAMETER);
925 /* Run the command and wait for the chosen event. */
927 Status = EcWaitEvent(sc, Event);
928 if (ACPI_FAILURE(Status)) {
929 ACPI_VPRINT(sc->ec_dev, acpi_device_get_parent_softc(sc->ec_dev),
930 "EcCommand: no response to %#x\n", cmd);
937 EcRead(struct acpi_ec_softc *sc, UINT8 Address, UINT8 *Data)
941 /*mtx_assert(&sc->ec_mtx, MA_OWNED);*/
944 /* If we can't start burst mode, continue anyway. */
945 EcCommand(sc, EC_COMMAND_BURST_ENABLE);
948 Status = EcCommand(sc, EC_COMMAND_READ);
949 if (ACPI_FAILURE(Status))
952 EC_SET_DATA(sc, Address);
953 Status = EcWaitEvent(sc, EC_EVENT_OUTPUT_BUFFER_FULL);
954 if (ACPI_FAILURE(Status)) {
955 ACPI_VPRINT(sc->ec_dev, acpi_device_get_parent_softc(sc->ec_dev),
956 "EcRead: Failed waiting for EC to send data.\n");
960 *Data = EC_GET_DATA(sc);
963 if (sc->ec_burstactive) {
964 Status = EcCommand(sc, EC_COMMAND_BURST_DISABLE);
965 if (ACPI_FAILURE(Status))
974 EcWrite(struct acpi_ec_softc *sc, UINT8 Address, UINT8 *Data)
978 /*mtx_assert(&sc->ec_mtx, MA_OWNED);*/
981 /* If we can't start burst mode, continue anyway. */
982 EcCommand(sc, EC_COMMAND_BURST_ENABLE);
985 Status = EcCommand(sc, EC_COMMAND_WRITE);
986 if (ACPI_FAILURE(Status))
989 EC_SET_DATA(sc, Address);
990 Status = EcWaitEvent(sc, EC_EVENT_INPUT_BUFFER_EMPTY);
991 if (ACPI_FAILURE(Status)) {
992 ACPI_VPRINT(sc->ec_dev, acpi_device_get_parent_softc(sc->ec_dev),
993 "EcRead: Failed waiting for EC to process address\n");
997 EC_SET_DATA(sc, *Data);
998 Status = EcWaitEvent(sc, EC_EVENT_INPUT_BUFFER_EMPTY);
999 if (ACPI_FAILURE(Status)) {
1000 ACPI_VPRINT(sc->ec_dev, acpi_device_get_parent_softc(sc->ec_dev),
1001 "EcWrite: Failed waiting for EC to process data\n");
1006 if (sc->ec_burstactive) {
1007 Status = EcCommand(sc, EC_COMMAND_BURST_DISABLE);
1008 if (ACPI_FAILURE(Status))