2 * Copyright (c) 2003-2007 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
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
33 #include <sys/param.h>
34 #include <sys/kernel.h>
37 #include <sys/malloc.h>
38 #include <sys/module.h>
41 #include <machine/bus.h>
42 #include <machine/resource.h>
45 #include <contrib/dev/acpica/include/acpi.h>
46 #include <contrib/dev/acpica/include/accommon.h>
48 #include <dev/acpica/acpivar.h>
50 /* Hooks for the ACPI CA debugging infrastructure */
51 #define _COMPONENT ACPI_EC
52 ACPI_MODULE_NAME("EC")
58 typedef UINT8 EC_COMMAND;
60 #define EC_COMMAND_UNKNOWN ((EC_COMMAND) 0x00)
61 #define EC_COMMAND_READ ((EC_COMMAND) 0x80)
62 #define EC_COMMAND_WRITE ((EC_COMMAND) 0x81)
63 #define EC_COMMAND_BURST_ENABLE ((EC_COMMAND) 0x82)
64 #define EC_COMMAND_BURST_DISABLE ((EC_COMMAND) 0x83)
65 #define EC_COMMAND_QUERY ((EC_COMMAND) 0x84)
70 * The encoding of the EC status register is illustrated below.
71 * Note that a set bit (1) indicates the property is TRUE
72 * (e.g. if bit 0 is set then the output buffer is full).
77 * | | | | | | | +- Output Buffer Full?
78 * | | | | | | +--- Input Buffer Full?
79 * | | | | | +----- <reserved>
80 * | | | | +------- Data Register is Command Byte?
81 * | | | +--------- Burst Mode Enabled?
82 * | | +----------- SCI Event?
83 * | +------------- SMI Event?
84 * +--------------- <reserved>
87 typedef UINT8 EC_STATUS;
89 #define EC_FLAG_OUTPUT_BUFFER ((EC_STATUS) 0x01)
90 #define EC_FLAG_INPUT_BUFFER ((EC_STATUS) 0x02)
91 #define EC_FLAG_DATA_IS_CMD ((EC_STATUS) 0x08)
92 #define EC_FLAG_BURST_MODE ((EC_STATUS) 0x10)
98 typedef UINT8 EC_EVENT;
100 #define EC_EVENT_UNKNOWN ((EC_EVENT) 0x00)
101 #define EC_EVENT_OUTPUT_BUFFER_FULL ((EC_EVENT) 0x01)
102 #define EC_EVENT_INPUT_BUFFER_EMPTY ((EC_EVENT) 0x02)
103 #define EC_EVENT_SCI ((EC_EVENT) 0x20)
104 #define EC_EVENT_SMI ((EC_EVENT) 0x40)
106 /* Data byte returned after burst enable indicating it was successful. */
107 #define EC_BURST_ACK 0x90
110 * Register access primitives
112 #define EC_GET_DATA(sc) \
113 bus_space_read_1((sc)->ec_data_tag, (sc)->ec_data_handle, 0)
115 #define EC_SET_DATA(sc, v) \
116 bus_space_write_1((sc)->ec_data_tag, (sc)->ec_data_handle, 0, (v))
118 #define EC_GET_CSR(sc) \
119 bus_space_read_1((sc)->ec_csr_tag, (sc)->ec_csr_handle, 0)
121 #define EC_SET_CSR(sc, v) \
122 bus_space_write_1((sc)->ec_csr_tag, (sc)->ec_csr_handle, 0, (v))
124 /* Additional params to pass from the probe routine */
125 struct acpi_ec_params {
128 ACPI_HANDLE gpe_handle;
135 struct acpi_ec_softc {
137 ACPI_HANDLE ec_handle;
139 ACPI_HANDLE ec_gpehandle;
143 struct resource *ec_data_res;
144 bus_space_tag_t ec_data_tag;
145 bus_space_handle_t ec_data_handle;
148 struct resource *ec_csr_res;
149 bus_space_tag_t ec_csr_tag;
150 bus_space_handle_t ec_csr_handle;
156 volatile u_int ec_gencount;
162 * I couldn't find it in the spec but other implementations also use a
163 * value of 1 ms for the time to acquire global lock.
165 #define EC_LOCK_TIMEOUT 1000
167 /* Default delay in microseconds between each run of the status polling loop. */
168 #define EC_POLL_DELAY 50
170 /* Total time in ms spent waiting for a response from EC. */
171 #define EC_TIMEOUT 750
173 #define EVENT_READY(event, status) \
174 (((event) == EC_EVENT_OUTPUT_BUFFER_FULL && \
175 ((status) & EC_FLAG_OUTPUT_BUFFER) != 0) || \
176 ((event) == EC_EVENT_INPUT_BUFFER_EMPTY && \
177 ((status) & EC_FLAG_INPUT_BUFFER) == 0))
179 ACPI_SERIAL_DECL(ec, "ACPI embedded controller");
181 SYSCTL_NODE(_debug_acpi, OID_AUTO, ec, CTLFLAG_RD, NULL, "EC debugging");
183 static int ec_burst_mode;
184 TUNABLE_INT("debug.acpi.ec.burst", &ec_burst_mode);
185 SYSCTL_INT(_debug_acpi_ec, OID_AUTO, burst, CTLFLAG_RW, &ec_burst_mode, 0,
186 "Enable use of burst mode (faster for nearly all systems)");
187 static int ec_polled_mode;
188 TUNABLE_INT("debug.acpi.ec.polled", &ec_polled_mode);
189 SYSCTL_INT(_debug_acpi_ec, OID_AUTO, polled, CTLFLAG_RW, &ec_polled_mode, 0,
190 "Force use of polled mode (only if interrupt mode doesn't work)");
191 static int ec_timeout = EC_TIMEOUT;
192 TUNABLE_INT("debug.acpi.ec.timeout", &ec_timeout);
193 SYSCTL_INT(_debug_acpi_ec, OID_AUTO, timeout, CTLFLAG_RW, &ec_timeout,
194 EC_TIMEOUT, "Total time spent waiting for a response (poll+sleep)");
197 EcLock(struct acpi_ec_softc *sc)
201 /* If _GLK is non-zero, acquire the global lock. */
204 status = AcpiAcquireGlobalLock(EC_LOCK_TIMEOUT, &sc->ec_glkhandle);
205 if (ACPI_FAILURE(status))
208 ACPI_SERIAL_BEGIN(ec);
213 EcUnlock(struct acpi_ec_softc *sc)
217 AcpiReleaseGlobalLock(sc->ec_glkhandle);
220 static uint32_t EcGpeHandler(void *Context);
221 static ACPI_STATUS EcSpaceSetup(ACPI_HANDLE Region, UINT32 Function,
222 void *Context, void **return_Context);
223 static ACPI_STATUS EcSpaceHandler(UINT32 Function,
224 ACPI_PHYSICAL_ADDRESS Address,
225 UINT32 Width, UINT64 *Value,
226 void *Context, void *RegionContext);
227 static ACPI_STATUS EcWaitEvent(struct acpi_ec_softc *sc, EC_EVENT Event,
229 static ACPI_STATUS EcCommand(struct acpi_ec_softc *sc, EC_COMMAND cmd);
230 static ACPI_STATUS EcRead(struct acpi_ec_softc *sc, UINT8 Address,
232 static ACPI_STATUS EcWrite(struct acpi_ec_softc *sc, UINT8 Address,
234 static int acpi_ec_probe(device_t dev);
235 static int acpi_ec_attach(device_t dev);
236 static int acpi_ec_suspend(device_t dev);
237 static int acpi_ec_resume(device_t dev);
238 static int acpi_ec_shutdown(device_t dev);
239 static int acpi_ec_read_method(device_t dev, u_int addr,
240 UINT64 *val, int width);
241 static int acpi_ec_write_method(device_t dev, u_int addr,
242 UINT64 val, int width);
244 static device_method_t acpi_ec_methods[] = {
245 /* Device interface */
246 DEVMETHOD(device_probe, acpi_ec_probe),
247 DEVMETHOD(device_attach, acpi_ec_attach),
248 DEVMETHOD(device_suspend, acpi_ec_suspend),
249 DEVMETHOD(device_resume, acpi_ec_resume),
250 DEVMETHOD(device_shutdown, acpi_ec_shutdown),
252 /* Embedded controller interface */
253 DEVMETHOD(acpi_ec_read, acpi_ec_read_method),
254 DEVMETHOD(acpi_ec_write, acpi_ec_write_method),
259 static driver_t acpi_ec_driver = {
262 sizeof(struct acpi_ec_softc),
265 static devclass_t acpi_ec_devclass;
266 DRIVER_MODULE(acpi_ec, acpi, acpi_ec_driver, acpi_ec_devclass, 0, 0);
267 MODULE_DEPEND(acpi_ec, acpi, 1, 1, 1);
270 * Look for an ECDT and if we find one, set up default GPE and
271 * space handlers to catch attempts to access EC space before
272 * we have a real driver instance in place.
274 * TODO: Some old Gateway laptops need us to fake up an ECDT or
275 * otherwise attach early so that _REG methods can run.
278 acpi_ec_ecdt_probe(device_t parent)
280 ACPI_TABLE_ECDT *ecdt;
284 struct acpi_ec_params *params;
286 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
288 /* Find and validate the ECDT. */
289 status = AcpiGetTable(ACPI_SIG_ECDT, 1, (ACPI_TABLE_HEADER **)&ecdt);
290 if (ACPI_FAILURE(status) ||
291 ecdt->Control.BitWidth != 8 ||
292 ecdt->Data.BitWidth != 8) {
296 /* Create the child device with the given unit number. */
297 child = BUS_ADD_CHILD(parent, 0, "acpi_ec", ecdt->Uid);
299 printf("%s: can't add child\n", __func__);
303 /* Find and save the ACPI handle for this device. */
304 status = AcpiGetHandle(NULL, ecdt->Id, &h);
305 if (ACPI_FAILURE(status)) {
306 device_delete_child(parent, child);
307 printf("%s: can't get handle\n", __func__);
310 acpi_set_handle(child, h);
312 /* Set the data and CSR register addresses. */
313 bus_set_resource(child, SYS_RES_IOPORT, 0, ecdt->Data.Address,
315 bus_set_resource(child, SYS_RES_IOPORT, 1, ecdt->Control.Address,
319 * Store values for the probe/attach routines to use. Store the
320 * ECDT GPE bit and set the global lock flag according to _GLK.
321 * Note that it is not perfectly correct to be evaluating a method
322 * before initializing devices, but in practice this function
323 * should be safe to call at this point.
325 params = malloc(sizeof(struct acpi_ec_params), M_TEMP, M_WAITOK | M_ZERO);
326 params->gpe_handle = NULL;
327 params->gpe_bit = ecdt->Gpe;
328 params->uid = ecdt->Uid;
329 acpi_GetInteger(h, "_GLK", ¶ms->glk);
330 acpi_set_private(child, params);
332 /* Finish the attach process. */
333 if (device_probe_and_attach(child) != 0)
334 device_delete_child(parent, child);
338 acpi_ec_probe(device_t dev)
348 struct acpi_ec_params *params;
349 static char *ec_ids[] = { "PNP0C09", NULL };
351 /* Check that this is a device and that EC is not disabled. */
352 if (acpi_get_type(dev) != ACPI_TYPE_DEVICE || acpi_disabled("ec"))
356 * If probed via ECDT, set description and continue. Otherwise,
357 * we can access the namespace and make sure this is not a
363 buf.Length = ACPI_ALLOCATE_BUFFER;
364 params = acpi_get_private(dev);
365 if (params != NULL) {
368 } else if (ACPI_ID_PROBE(device_get_parent(dev), dev, ec_ids)) {
369 params = malloc(sizeof(struct acpi_ec_params), M_TEMP,
371 h = acpi_get_handle(dev);
374 * Read the unit ID to check for duplicate attach and the
375 * global lock value to see if we should acquire it when
378 status = acpi_GetInteger(h, "_UID", ¶ms->uid);
379 if (ACPI_FAILURE(status))
381 status = acpi_GetInteger(h, "_GLK", ¶ms->glk);
382 if (ACPI_FAILURE(status))
386 * Evaluate the _GPE method to find the GPE bit used by the EC to
387 * signal status (SCI). If it's a package, it contains a reference
388 * and GPE bit, similar to _PRW.
390 status = AcpiEvaluateObject(h, "_GPE", NULL, &buf);
391 if (ACPI_FAILURE(status)) {
392 device_printf(dev, "can't evaluate _GPE - %s\n",
393 AcpiFormatException(status));
396 obj = (ACPI_OBJECT *)buf.Pointer;
401 case ACPI_TYPE_INTEGER:
402 params->gpe_handle = NULL;
403 params->gpe_bit = obj->Integer.Value;
405 case ACPI_TYPE_PACKAGE:
406 if (!ACPI_PKG_VALID(obj, 2))
409 acpi_GetReference(NULL, &obj->Package.Elements[0]);
410 if (params->gpe_handle == NULL ||
411 acpi_PkgInt32(obj, 1, ¶ms->gpe_bit) != 0)
415 device_printf(dev, "_GPE has invalid type %d\n", obj->Type);
419 /* Store the values we got from the namespace for attach. */
420 acpi_set_private(dev, params);
423 * Check for a duplicate probe. This can happen when a probe
424 * via ECDT succeeded already. If this is a duplicate, disable
427 peer = devclass_get_device(acpi_ec_devclass, params->uid);
428 if (peer == NULL || !device_is_alive(peer))
436 snprintf(desc, sizeof(desc), "Embedded Controller: GPE %#x%s%s",
437 params->gpe_bit, (params->glk) ? ", GLK" : "",
438 ecdt ? ", ECDT" : "");
439 device_set_desc_copy(dev, desc);
442 if (ret > 0 && params)
443 free(params, M_TEMP);
445 AcpiOsFree(buf.Pointer);
450 acpi_ec_attach(device_t dev)
452 struct acpi_ec_softc *sc;
453 struct acpi_ec_params *params;
456 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
458 /* Fetch/initialize softc (assumes softc is pre-zeroed). */
459 sc = device_get_softc(dev);
460 params = acpi_get_private(dev);
462 sc->ec_handle = acpi_get_handle(dev);
464 /* Retrieve previously probed values via device ivars. */
465 sc->ec_glk = params->glk;
466 sc->ec_gpebit = params->gpe_bit;
467 sc->ec_gpehandle = params->gpe_handle;
468 sc->ec_uid = params->uid;
469 sc->ec_suspending = FALSE;
470 acpi_set_private(dev, NULL);
471 free(params, M_TEMP);
473 /* Attach bus resources for data and command/status ports. */
475 sc->ec_data_res = bus_alloc_resource_any(sc->ec_dev, SYS_RES_IOPORT,
476 &sc->ec_data_rid, RF_ACTIVE);
477 if (sc->ec_data_res == NULL) {
478 device_printf(dev, "can't allocate data port\n");
481 sc->ec_data_tag = rman_get_bustag(sc->ec_data_res);
482 sc->ec_data_handle = rman_get_bushandle(sc->ec_data_res);
485 sc->ec_csr_res = bus_alloc_resource_any(sc->ec_dev, SYS_RES_IOPORT,
486 &sc->ec_csr_rid, RF_ACTIVE);
487 if (sc->ec_csr_res == NULL) {
488 device_printf(dev, "can't allocate command/status port\n");
491 sc->ec_csr_tag = rman_get_bustag(sc->ec_csr_res);
492 sc->ec_csr_handle = rman_get_bushandle(sc->ec_csr_res);
495 * Install a handler for this EC's GPE bit. We want edge-triggered
498 ACPI_DEBUG_PRINT((ACPI_DB_RESOURCES, "attaching GPE handler\n"));
499 Status = AcpiInstallGpeHandler(sc->ec_gpehandle, sc->ec_gpebit,
500 ACPI_GPE_EDGE_TRIGGERED, &EcGpeHandler, sc);
501 if (ACPI_FAILURE(Status)) {
502 device_printf(dev, "can't install GPE handler for %s - %s\n",
503 acpi_name(sc->ec_handle), AcpiFormatException(Status));
508 * Install address space handler
510 ACPI_DEBUG_PRINT((ACPI_DB_RESOURCES, "attaching address space handler\n"));
511 Status = AcpiInstallAddressSpaceHandler(sc->ec_handle, ACPI_ADR_SPACE_EC,
512 &EcSpaceHandler, &EcSpaceSetup, sc);
513 if (ACPI_FAILURE(Status)) {
514 device_printf(dev, "can't install address space handler for %s - %s\n",
515 acpi_name(sc->ec_handle), AcpiFormatException(Status));
519 /* Enable runtime GPEs for the handler. */
520 Status = AcpiEnableGpe(sc->ec_gpehandle, sc->ec_gpebit);
521 if (ACPI_FAILURE(Status)) {
522 device_printf(dev, "AcpiEnableGpe failed: %s\n",
523 AcpiFormatException(Status));
527 ACPI_DEBUG_PRINT((ACPI_DB_RESOURCES, "acpi_ec_attach complete\n"));
531 AcpiRemoveGpeHandler(sc->ec_gpehandle, sc->ec_gpebit, &EcGpeHandler);
532 AcpiRemoveAddressSpaceHandler(sc->ec_handle, ACPI_ADR_SPACE_EC,
535 bus_release_resource(sc->ec_dev, SYS_RES_IOPORT, sc->ec_csr_rid,
538 bus_release_resource(sc->ec_dev, SYS_RES_IOPORT, sc->ec_data_rid,
544 acpi_ec_suspend(device_t dev)
546 struct acpi_ec_softc *sc;
548 sc = device_get_softc(dev);
549 sc->ec_suspending = TRUE;
554 acpi_ec_resume(device_t dev)
556 struct acpi_ec_softc *sc;
558 sc = device_get_softc(dev);
559 sc->ec_suspending = FALSE;
564 acpi_ec_shutdown(device_t dev)
566 struct acpi_ec_softc *sc;
568 /* Disable the GPE so we don't get EC events during shutdown. */
569 sc = device_get_softc(dev);
570 AcpiDisableGpe(sc->ec_gpehandle, sc->ec_gpebit);
574 /* Methods to allow other devices (e.g., smbat) to read/write EC space. */
576 acpi_ec_read_method(device_t dev, u_int addr, UINT64 *val, int width)
578 struct acpi_ec_softc *sc;
581 sc = device_get_softc(dev);
582 status = EcSpaceHandler(ACPI_READ, addr, width * 8, val, sc, NULL);
583 if (ACPI_FAILURE(status))
589 acpi_ec_write_method(device_t dev, u_int addr, UINT64 val, int width)
591 struct acpi_ec_softc *sc;
594 sc = device_get_softc(dev);
595 status = EcSpaceHandler(ACPI_WRITE, addr, width * 8, &val, sc, NULL);
596 if (ACPI_FAILURE(status))
602 EcCheckStatus(struct acpi_ec_softc *sc, const char *msg, EC_EVENT event)
607 status = AE_NO_HARDWARE_RESPONSE;
608 ec_status = EC_GET_CSR(sc);
609 if (sc->ec_burstactive && !(ec_status & EC_FLAG_BURST_MODE)) {
610 CTR1(KTR_ACPI, "ec burst disabled in waitevent (%s)", msg);
611 sc->ec_burstactive = FALSE;
613 if (EVENT_READY(event, ec_status)) {
614 CTR2(KTR_ACPI, "ec %s wait ready, status %#x", msg, ec_status);
621 EcGpeQueryHandler(void *Context)
623 struct acpi_ec_softc *sc = (struct acpi_ec_softc *)Context;
629 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
630 KASSERT(Context != NULL, ("EcGpeQueryHandler called with NULL"));
632 /* Serialize user access with EcSpaceHandler(). */
634 if (ACPI_FAILURE(Status)) {
635 device_printf(sc->ec_dev, "GpeQuery lock error: %s\n",
636 AcpiFormatException(Status));
641 * Send a query command to the EC to find out which _Qxx call it
642 * wants to make. This command clears the SCI bit and also the
643 * interrupt source since we are edge-triggered. To prevent the GPE
644 * that may arise from running the query from causing another query
645 * to be queued, we clear the pending flag only after running it.
647 for (retry = 0; retry < 2; retry++) {
648 Status = EcCommand(sc, EC_COMMAND_QUERY);
649 if (ACPI_SUCCESS(Status))
651 if (EcCheckStatus(sc, "retr_check",
652 EC_EVENT_INPUT_BUFFER_EMPTY) == AE_OK)
657 sc->ec_sci_pend = FALSE;
658 if (ACPI_FAILURE(Status)) {
660 device_printf(sc->ec_dev, "GPE query failed: %s\n",
661 AcpiFormatException(Status));
664 Data = EC_GET_DATA(sc);
667 * We have to unlock before running the _Qxx method below since that
668 * method may attempt to read/write from EC address space, causing
669 * recursive acquisition of the lock.
673 /* Ignore the value for "no outstanding event". (13.3.5) */
674 CTR2(KTR_ACPI, "ec query ok,%s running _Q%02X", Data ? "" : " not", Data);
678 /* Evaluate _Qxx to respond to the controller. */
679 snprintf(qxx, sizeof(qxx), "_Q%02X", Data);
681 Status = AcpiEvaluateObject(sc->ec_handle, qxx, NULL, NULL);
682 if (ACPI_FAILURE(Status) && Status != AE_NOT_FOUND) {
683 device_printf(sc->ec_dev, "evaluation of query method %s failed: %s\n",
684 qxx, AcpiFormatException(Status));
689 * The GPE handler is called when IBE/OBF or SCI events occur. We are
690 * called from an unknown lock context.
693 EcGpeHandler(void *Context)
695 struct acpi_ec_softc *sc = Context;
699 KASSERT(Context != NULL, ("EcGpeHandler called with NULL"));
700 CTR0(KTR_ACPI, "ec gpe handler start");
703 * Notify EcWaitEvent() that the status register is now fresh. If we
704 * didn't do this, it wouldn't be possible to distinguish an old IBE
705 * from a new one, for example when doing a write transaction (writing
706 * address and then data values.)
708 atomic_add_int(&sc->ec_gencount, 1);
712 * If the EC_SCI bit of the status register is set, queue a query handler.
713 * It will run the query and _Qxx method later, under the lock.
715 EcStatus = EC_GET_CSR(sc);
716 if ((EcStatus & EC_EVENT_SCI) && !sc->ec_sci_pend) {
717 CTR0(KTR_ACPI, "ec gpe queueing query handler");
718 Status = AcpiOsExecute(OSL_GPE_HANDLER, EcGpeQueryHandler, Context);
719 if (ACPI_SUCCESS(Status))
720 sc->ec_sci_pend = TRUE;
722 printf("EcGpeHandler: queuing GPE query handler failed\n");
728 EcSpaceSetup(ACPI_HANDLE Region, UINT32 Function, void *Context,
729 void **RegionContext)
732 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
735 * If deactivating a region, always set the output to NULL. Otherwise,
736 * just pass the context through.
738 if (Function == ACPI_REGION_DEACTIVATE)
739 *RegionContext = NULL;
741 *RegionContext = Context;
743 return_ACPI_STATUS (AE_OK);
747 EcSpaceHandler(UINT32 Function, ACPI_PHYSICAL_ADDRESS Address, UINT32 Width,
748 UINT64 *Value, void *Context, void *RegionContext)
750 struct acpi_ec_softc *sc = (struct acpi_ec_softc *)Context;
751 ACPI_PHYSICAL_ADDRESS EcAddr;
755 ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, (UINT32)Address);
757 if (Function != ACPI_READ && Function != ACPI_WRITE)
758 return_ACPI_STATUS (AE_BAD_PARAMETER);
759 if (Width % 8 != 0 || Value == NULL || Context == NULL)
760 return_ACPI_STATUS (AE_BAD_PARAMETER);
761 if (Address + Width / 8 > 256)
762 return_ACPI_STATUS (AE_BAD_ADDRESS);
765 * If booting, check if we need to run the query handler. If so, we
766 * we call it directly here since our thread taskq is not active yet.
768 if (cold || rebooting || sc->ec_suspending) {
769 if ((EC_GET_CSR(sc) & EC_EVENT_SCI)) {
770 CTR0(KTR_ACPI, "ec running gpe handler directly");
771 EcGpeQueryHandler(sc);
775 /* Serialize with EcGpeQueryHandler() at transaction granularity. */
777 if (ACPI_FAILURE(Status))
778 return_ACPI_STATUS (Status);
780 /* If we can't start burst mode, continue anyway. */
781 Status = EcCommand(sc, EC_COMMAND_BURST_ENABLE);
782 if (ACPI_SUCCESS(Status)) {
783 if (EC_GET_DATA(sc) == EC_BURST_ACK) {
784 CTR0(KTR_ACPI, "ec burst enabled");
785 sc->ec_burstactive = TRUE;
789 /* Perform the transaction(s), based on Width. */
791 EcData = (UINT8 *)Value;
792 if (Function == ACPI_READ)
797 Status = EcRead(sc, EcAddr, EcData);
800 Status = EcWrite(sc, EcAddr, *EcData);
803 if (ACPI_FAILURE(Status))
807 } while (EcAddr < Address + Width / 8);
809 if (sc->ec_burstactive) {
810 sc->ec_burstactive = FALSE;
811 if (ACPI_SUCCESS(EcCommand(sc, EC_COMMAND_BURST_DISABLE)))
812 CTR0(KTR_ACPI, "ec disabled burst ok");
816 return_ACPI_STATUS (Status);
820 EcWaitEvent(struct acpi_ec_softc *sc, EC_EVENT Event, u_int gen_count)
822 static int no_intr = 0;
824 int count, i, need_poll, slp_ival;
826 ACPI_SERIAL_ASSERT(ec);
827 Status = AE_NO_HARDWARE_RESPONSE;
828 need_poll = cold || rebooting || ec_polled_mode || sc->ec_suspending;
830 /* Wait for event by polling or GPE (interrupt). */
832 count = (ec_timeout * 1000) / EC_POLL_DELAY;
836 for (i = 0; i < count; i++) {
837 Status = EcCheckStatus(sc, "poll", Event);
840 DELAY(EC_POLL_DELAY);
843 slp_ival = hz / 1000;
847 /* hz has less than 1 ms resolution so scale timeout. */
849 count = ec_timeout / (1000 / hz);
853 * Wait for the GPE to signal the status changed, checking the
854 * status register each time we get one. It's possible to get a
855 * GPE for an event we're not interested in here (i.e., SCI for
858 for (i = 0; i < count; i++) {
859 if (gen_count == sc->ec_gencount)
860 tsleep(sc, 0, "ecgpe", slp_ival);
862 * Record new generation count. It's possible the GPE was
863 * just to notify us that a query is needed and we need to
864 * wait for a second GPE to signal the completion of the
865 * event we are actually waiting for.
867 Status = EcCheckStatus(sc, "sleep", Event);
868 if (Status == AE_OK) {
869 if (gen_count == sc->ec_gencount)
875 gen_count = sc->ec_gencount;
879 * We finished waiting for the GPE and it never arrived. Try to
880 * read the register once and trust whatever value we got. This is
881 * the best we can do at this point.
884 Status = EcCheckStatus(sc, "sleep_end", Event);
886 if (!need_poll && no_intr > 10) {
887 device_printf(sc->ec_dev,
888 "not getting interrupts, switched to polled mode\n");
892 CTR0(KTR_ACPI, "error: ec wait timed out");
897 EcCommand(struct acpi_ec_softc *sc, EC_COMMAND cmd)
904 ACPI_SERIAL_ASSERT(ec);
906 /* Don't use burst mode if user disabled it. */
907 if (!ec_burst_mode && cmd == EC_COMMAND_BURST_ENABLE)
910 /* Decide what to wait for based on command type. */
912 case EC_COMMAND_READ:
913 case EC_COMMAND_WRITE:
914 case EC_COMMAND_BURST_DISABLE:
915 event = EC_EVENT_INPUT_BUFFER_EMPTY;
917 case EC_COMMAND_QUERY:
918 case EC_COMMAND_BURST_ENABLE:
919 event = EC_EVENT_OUTPUT_BUFFER_FULL;
922 device_printf(sc->ec_dev, "EcCommand: invalid command %#x\n", cmd);
923 return (AE_BAD_PARAMETER);
927 * Ensure empty input buffer before issuing command.
928 * Use generation count of zero to force a quick check.
930 status = EcWaitEvent(sc, EC_EVENT_INPUT_BUFFER_EMPTY, 0);
931 if (ACPI_FAILURE(status))
934 /* Run the command and wait for the chosen event. */
935 CTR1(KTR_ACPI, "ec running command %#x", cmd);
936 gen_count = sc->ec_gencount;
938 status = EcWaitEvent(sc, event, gen_count);
939 if (ACPI_SUCCESS(status)) {
940 /* If we succeeded, burst flag should now be present. */
941 if (cmd == EC_COMMAND_BURST_ENABLE) {
942 ec_status = EC_GET_CSR(sc);
943 if ((ec_status & EC_FLAG_BURST_MODE) == 0)
947 device_printf(sc->ec_dev, "EcCommand: no response to %#x\n", cmd);
952 EcRead(struct acpi_ec_softc *sc, UINT8 Address, UINT8 *Data)
958 ACPI_SERIAL_ASSERT(ec);
959 CTR1(KTR_ACPI, "ec read from %#x", Address);
961 for (retry = 0; retry < 2; retry++) {
962 status = EcCommand(sc, EC_COMMAND_READ);
963 if (ACPI_FAILURE(status))
966 gen_count = sc->ec_gencount;
967 EC_SET_DATA(sc, Address);
968 status = EcWaitEvent(sc, EC_EVENT_OUTPUT_BUFFER_FULL, gen_count);
969 if (ACPI_FAILURE(status)) {
970 if (EcCheckStatus(sc, "retr_check",
971 EC_EVENT_INPUT_BUFFER_EMPTY) == AE_OK)
976 *Data = EC_GET_DATA(sc);
979 device_printf(sc->ec_dev, "EcRead: failed waiting to get data\n");
984 EcWrite(struct acpi_ec_softc *sc, UINT8 Address, UINT8 Data)
989 ACPI_SERIAL_ASSERT(ec);
990 CTR2(KTR_ACPI, "ec write to %#x, data %#x", Address, Data);
992 status = EcCommand(sc, EC_COMMAND_WRITE);
993 if (ACPI_FAILURE(status))
996 gen_count = sc->ec_gencount;
997 EC_SET_DATA(sc, Address);
998 status = EcWaitEvent(sc, EC_EVENT_INPUT_BUFFER_EMPTY, gen_count);
999 if (ACPI_FAILURE(status)) {
1000 device_printf(sc->ec_dev, "EcWrite: failed waiting for sent address\n");
1004 gen_count = sc->ec_gencount;
1005 EC_SET_DATA(sc, Data);
1006 status = EcWaitEvent(sc, EC_EVENT_INPUT_BUFFER_EMPTY, gen_count);
1007 if (ACPI_FAILURE(status)) {
1008 device_printf(sc->ec_dev, "EcWrite: failed waiting for sent data\n");