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 static SYSCTL_NODE(_debug_acpi, OID_AUTO, ec, CTLFLAG_RD, NULL, "EC debugging");
183 static int ec_burst_mode;
184 SYSCTL_INT(_debug_acpi_ec, OID_AUTO, burst, CTLFLAG_RWTUN, &ec_burst_mode, 0,
185 "Enable use of burst mode (faster for nearly all systems)");
186 static int ec_polled_mode;
187 SYSCTL_INT(_debug_acpi_ec, OID_AUTO, polled, CTLFLAG_RWTUN, &ec_polled_mode, 0,
188 "Force use of polled mode (only if interrupt mode doesn't work)");
189 static int ec_timeout = EC_TIMEOUT;
190 SYSCTL_INT(_debug_acpi_ec, OID_AUTO, timeout, CTLFLAG_RWTUN, &ec_timeout,
191 EC_TIMEOUT, "Total time spent waiting for a response (poll+sleep)");
194 EcLock(struct acpi_ec_softc *sc)
198 /* If _GLK is non-zero, acquire the global lock. */
201 status = AcpiAcquireGlobalLock(EC_LOCK_TIMEOUT, &sc->ec_glkhandle);
202 if (ACPI_FAILURE(status))
205 ACPI_SERIAL_BEGIN(ec);
210 EcUnlock(struct acpi_ec_softc *sc)
214 AcpiReleaseGlobalLock(sc->ec_glkhandle);
217 static UINT32 EcGpeHandler(ACPI_HANDLE, UINT32, void *);
218 static ACPI_STATUS EcSpaceSetup(ACPI_HANDLE Region, UINT32 Function,
219 void *Context, void **return_Context);
220 static ACPI_STATUS EcSpaceHandler(UINT32 Function,
221 ACPI_PHYSICAL_ADDRESS Address,
222 UINT32 Width, UINT64 *Value,
223 void *Context, void *RegionContext);
224 static ACPI_STATUS EcWaitEvent(struct acpi_ec_softc *sc, EC_EVENT Event,
226 static ACPI_STATUS EcCommand(struct acpi_ec_softc *sc, EC_COMMAND cmd);
227 static ACPI_STATUS EcRead(struct acpi_ec_softc *sc, UINT8 Address,
229 static ACPI_STATUS EcWrite(struct acpi_ec_softc *sc, UINT8 Address,
231 static int acpi_ec_probe(device_t dev);
232 static int acpi_ec_attach(device_t dev);
233 static int acpi_ec_suspend(device_t dev);
234 static int acpi_ec_resume(device_t dev);
235 static int acpi_ec_shutdown(device_t dev);
236 static int acpi_ec_read_method(device_t dev, u_int addr,
237 UINT64 *val, int width);
238 static int acpi_ec_write_method(device_t dev, u_int addr,
239 UINT64 val, int width);
241 static device_method_t acpi_ec_methods[] = {
242 /* Device interface */
243 DEVMETHOD(device_probe, acpi_ec_probe),
244 DEVMETHOD(device_attach, acpi_ec_attach),
245 DEVMETHOD(device_suspend, acpi_ec_suspend),
246 DEVMETHOD(device_resume, acpi_ec_resume),
247 DEVMETHOD(device_shutdown, acpi_ec_shutdown),
249 /* Embedded controller interface */
250 DEVMETHOD(acpi_ec_read, acpi_ec_read_method),
251 DEVMETHOD(acpi_ec_write, acpi_ec_write_method),
256 static driver_t acpi_ec_driver = {
259 sizeof(struct acpi_ec_softc),
262 static devclass_t acpi_ec_devclass;
263 DRIVER_MODULE(acpi_ec, acpi, acpi_ec_driver, acpi_ec_devclass, 0, 0);
264 MODULE_DEPEND(acpi_ec, acpi, 1, 1, 1);
267 * Look for an ECDT and if we find one, set up default GPE and
268 * space handlers to catch attempts to access EC space before
269 * we have a real driver instance in place.
271 * TODO: Some old Gateway laptops need us to fake up an ECDT or
272 * otherwise attach early so that _REG methods can run.
275 acpi_ec_ecdt_probe(device_t parent)
277 ACPI_TABLE_ECDT *ecdt;
281 struct acpi_ec_params *params;
283 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
285 /* Find and validate the ECDT. */
286 status = AcpiGetTable(ACPI_SIG_ECDT, 1, (ACPI_TABLE_HEADER **)&ecdt);
287 if (ACPI_FAILURE(status) ||
288 ecdt->Control.BitWidth != 8 ||
289 ecdt->Data.BitWidth != 8) {
293 /* Create the child device with the given unit number. */
294 child = BUS_ADD_CHILD(parent, 3, "acpi_ec", ecdt->Uid);
296 printf("%s: can't add child\n", __func__);
300 /* Find and save the ACPI handle for this device. */
301 status = AcpiGetHandle(NULL, ecdt->Id, &h);
302 if (ACPI_FAILURE(status)) {
303 device_delete_child(parent, child);
304 printf("%s: can't get handle\n", __func__);
307 acpi_set_handle(child, h);
309 /* Set the data and CSR register addresses. */
310 bus_set_resource(child, SYS_RES_IOPORT, 0, ecdt->Data.Address,
312 bus_set_resource(child, SYS_RES_IOPORT, 1, ecdt->Control.Address,
316 * Store values for the probe/attach routines to use. Store the
317 * ECDT GPE bit and set the global lock flag according to _GLK.
318 * Note that it is not perfectly correct to be evaluating a method
319 * before initializing devices, but in practice this function
320 * should be safe to call at this point.
322 params = malloc(sizeof(struct acpi_ec_params), M_TEMP, M_WAITOK | M_ZERO);
323 params->gpe_handle = NULL;
324 params->gpe_bit = ecdt->Gpe;
325 params->uid = ecdt->Uid;
326 acpi_GetInteger(h, "_GLK", ¶ms->glk);
327 acpi_set_private(child, params);
329 /* Finish the attach process. */
330 if (device_probe_and_attach(child) != 0)
331 device_delete_child(parent, child);
335 acpi_ec_probe(device_t dev)
345 struct acpi_ec_params *params;
346 static char *ec_ids[] = { "PNP0C09", NULL };
350 /* Check that this is a device and that EC is not disabled. */
351 if (acpi_get_type(dev) != ACPI_TYPE_DEVICE || acpi_disabled("ec"))
354 if (device_is_devclass_fixed(dev)) {
356 * If probed via ECDT, set description and continue. Otherwise, we can
357 * access the namespace and make sure this is not a duplicate probe.
360 params = acpi_get_private(dev);
368 ret = ACPI_ID_PROBE(device_get_parent(dev), dev, ec_ids, NULL);
372 params = malloc(sizeof(struct acpi_ec_params), M_TEMP, M_WAITOK | M_ZERO);
375 buf.Length = ACPI_ALLOCATE_BUFFER;
376 h = acpi_get_handle(dev);
379 * Read the unit ID to check for duplicate attach and the global lock value
380 * to see if we should acquire it when accessing the EC.
382 status = acpi_GetInteger(h, "_UID", ¶ms->uid);
383 if (ACPI_FAILURE(status))
387 * Check for a duplicate probe. This can happen when a probe via ECDT
388 * succeeded already. If this is a duplicate, disable this device.
390 * NB: It would seem device_disable would be sufficient to not get
391 * duplicated devices, and ENXIO isn't needed, however, device_probe() only
392 * checks DF_ENABLED at the start and so disabling it here is too late to
393 * prevent device_attach() from being called.
395 peer = devclass_get_device(acpi_ec_devclass, params->uid);
396 if (peer != NULL && device_is_alive(peer)) {
402 status = acpi_GetInteger(h, "_GLK", ¶ms->glk);
403 if (ACPI_FAILURE(status))
407 * Evaluate the _GPE method to find the GPE bit used by the EC to signal
408 * status (SCI). If it's a package, it contains a reference and GPE bit,
411 status = AcpiEvaluateObject(h, "_GPE", NULL, &buf);
412 if (ACPI_FAILURE(status)) {
413 device_printf(dev, "can't evaluate _GPE - %s\n", AcpiFormatException(status));
417 obj = (ACPI_OBJECT *)buf.Pointer;
422 case ACPI_TYPE_INTEGER:
423 params->gpe_handle = NULL;
424 params->gpe_bit = obj->Integer.Value;
426 case ACPI_TYPE_PACKAGE:
427 if (!ACPI_PKG_VALID(obj, 2))
429 params->gpe_handle = acpi_GetReference(NULL, &obj->Package.Elements[0]);
430 if (params->gpe_handle == NULL ||
431 acpi_PkgInt32(obj, 1, ¶ms->gpe_bit) != 0)
435 device_printf(dev, "_GPE has invalid type %d\n", obj->Type);
439 /* Store the values we got from the namespace for attach. */
440 acpi_set_private(dev, params);
443 AcpiOsFree(buf.Pointer);
446 snprintf(desc, sizeof(desc), "Embedded Controller: GPE %#x%s%s",
447 params->gpe_bit, (params->glk) ? ", GLK" : "",
448 ecdt ? ", ECDT" : "");
449 device_set_desc_copy(dev, desc);
451 free(params, M_TEMP);
457 acpi_ec_attach(device_t dev)
459 struct acpi_ec_softc *sc;
460 struct acpi_ec_params *params;
463 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
465 /* Fetch/initialize softc (assumes softc is pre-zeroed). */
466 sc = device_get_softc(dev);
467 params = acpi_get_private(dev);
469 sc->ec_handle = acpi_get_handle(dev);
471 /* Retrieve previously probed values via device ivars. */
472 sc->ec_glk = params->glk;
473 sc->ec_gpebit = params->gpe_bit;
474 sc->ec_gpehandle = params->gpe_handle;
475 sc->ec_uid = params->uid;
476 sc->ec_suspending = FALSE;
477 acpi_set_private(dev, NULL);
478 free(params, M_TEMP);
480 /* Attach bus resources for data and command/status ports. */
482 sc->ec_data_res = bus_alloc_resource_any(sc->ec_dev, SYS_RES_IOPORT,
483 &sc->ec_data_rid, RF_ACTIVE);
484 if (sc->ec_data_res == NULL) {
485 device_printf(dev, "can't allocate data port\n");
488 sc->ec_data_tag = rman_get_bustag(sc->ec_data_res);
489 sc->ec_data_handle = rman_get_bushandle(sc->ec_data_res);
492 sc->ec_csr_res = bus_alloc_resource_any(sc->ec_dev, SYS_RES_IOPORT,
493 &sc->ec_csr_rid, RF_ACTIVE);
494 if (sc->ec_csr_res == NULL) {
495 device_printf(dev, "can't allocate command/status port\n");
498 sc->ec_csr_tag = rman_get_bustag(sc->ec_csr_res);
499 sc->ec_csr_handle = rman_get_bushandle(sc->ec_csr_res);
502 * Install a handler for this EC's GPE bit. We want edge-triggered
505 ACPI_DEBUG_PRINT((ACPI_DB_RESOURCES, "attaching GPE handler\n"));
506 Status = AcpiInstallGpeHandler(sc->ec_gpehandle, sc->ec_gpebit,
507 ACPI_GPE_EDGE_TRIGGERED, EcGpeHandler, sc);
508 if (ACPI_FAILURE(Status)) {
509 device_printf(dev, "can't install GPE handler for %s - %s\n",
510 acpi_name(sc->ec_handle), AcpiFormatException(Status));
515 * Install address space handler
517 ACPI_DEBUG_PRINT((ACPI_DB_RESOURCES, "attaching address space handler\n"));
518 Status = AcpiInstallAddressSpaceHandler(sc->ec_handle, ACPI_ADR_SPACE_EC,
519 &EcSpaceHandler, &EcSpaceSetup, sc);
520 if (ACPI_FAILURE(Status)) {
521 device_printf(dev, "can't install address space handler for %s - %s\n",
522 acpi_name(sc->ec_handle), AcpiFormatException(Status));
526 /* Enable runtime GPEs for the handler. */
527 Status = AcpiEnableGpe(sc->ec_gpehandle, sc->ec_gpebit);
528 if (ACPI_FAILURE(Status)) {
529 device_printf(dev, "AcpiEnableGpe failed: %s\n",
530 AcpiFormatException(Status));
534 ACPI_DEBUG_PRINT((ACPI_DB_RESOURCES, "acpi_ec_attach complete\n"));
538 AcpiRemoveGpeHandler(sc->ec_gpehandle, sc->ec_gpebit, EcGpeHandler);
539 AcpiRemoveAddressSpaceHandler(sc->ec_handle, ACPI_ADR_SPACE_EC,
542 bus_release_resource(sc->ec_dev, SYS_RES_IOPORT, sc->ec_csr_rid,
545 bus_release_resource(sc->ec_dev, SYS_RES_IOPORT, sc->ec_data_rid,
551 acpi_ec_suspend(device_t dev)
553 struct acpi_ec_softc *sc;
555 sc = device_get_softc(dev);
556 sc->ec_suspending = TRUE;
561 acpi_ec_resume(device_t dev)
563 struct acpi_ec_softc *sc;
565 sc = device_get_softc(dev);
566 sc->ec_suspending = FALSE;
571 acpi_ec_shutdown(device_t dev)
573 struct acpi_ec_softc *sc;
575 /* Disable the GPE so we don't get EC events during shutdown. */
576 sc = device_get_softc(dev);
577 AcpiDisableGpe(sc->ec_gpehandle, sc->ec_gpebit);
581 /* Methods to allow other devices (e.g., smbat) to read/write EC space. */
583 acpi_ec_read_method(device_t dev, u_int addr, UINT64 *val, int width)
585 struct acpi_ec_softc *sc;
588 sc = device_get_softc(dev);
589 status = EcSpaceHandler(ACPI_READ, addr, width * 8, val, sc, NULL);
590 if (ACPI_FAILURE(status))
596 acpi_ec_write_method(device_t dev, u_int addr, UINT64 val, int width)
598 struct acpi_ec_softc *sc;
601 sc = device_get_softc(dev);
602 status = EcSpaceHandler(ACPI_WRITE, addr, width * 8, &val, sc, NULL);
603 if (ACPI_FAILURE(status))
609 EcCheckStatus(struct acpi_ec_softc *sc, const char *msg, EC_EVENT event)
614 status = AE_NO_HARDWARE_RESPONSE;
615 ec_status = EC_GET_CSR(sc);
616 if (sc->ec_burstactive && !(ec_status & EC_FLAG_BURST_MODE)) {
617 CTR1(KTR_ACPI, "ec burst disabled in waitevent (%s)", msg);
618 sc->ec_burstactive = FALSE;
620 if (EVENT_READY(event, ec_status)) {
621 CTR2(KTR_ACPI, "ec %s wait ready, status %#x", msg, ec_status);
628 EcGpeQueryHandlerSub(struct acpi_ec_softc *sc)
635 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
637 /* Serialize user access with EcSpaceHandler(). */
639 if (ACPI_FAILURE(Status)) {
640 device_printf(sc->ec_dev, "GpeQuery lock error: %s\n",
641 AcpiFormatException(Status));
646 * Send a query command to the EC to find out which _Qxx call it
647 * wants to make. This command clears the SCI bit and also the
648 * interrupt source since we are edge-triggered. To prevent the GPE
649 * that may arise from running the query from causing another query
650 * to be queued, we clear the pending flag only after running it.
652 for (retry = 0; retry < 2; retry++) {
653 Status = EcCommand(sc, EC_COMMAND_QUERY);
654 if (ACPI_SUCCESS(Status))
656 if (ACPI_FAILURE(EcCheckStatus(sc, "retr_check",
657 EC_EVENT_INPUT_BUFFER_EMPTY)))
660 if (ACPI_FAILURE(Status)) {
662 device_printf(sc->ec_dev, "GPE query failed: %s\n",
663 AcpiFormatException(Status));
666 Data = EC_GET_DATA(sc);
669 * We have to unlock before running the _Qxx method below since that
670 * method may attempt to read/write from EC address space, causing
671 * recursive acquisition of the lock.
675 /* Ignore the value for "no outstanding event". (13.3.5) */
676 CTR2(KTR_ACPI, "ec query ok,%s running _Q%02X", Data ? "" : " not", Data);
680 /* Evaluate _Qxx to respond to the controller. */
681 snprintf(qxx, sizeof(qxx), "_Q%02X", Data);
683 Status = AcpiEvaluateObject(sc->ec_handle, qxx, NULL, NULL);
684 if (ACPI_FAILURE(Status) && Status != AE_NOT_FOUND) {
685 device_printf(sc->ec_dev, "evaluation of query method %s failed: %s\n",
686 qxx, AcpiFormatException(Status));
691 EcGpeQueryHandler(void *Context)
693 struct acpi_ec_softc *sc = (struct acpi_ec_softc *)Context;
696 KASSERT(Context != NULL, ("EcGpeQueryHandler called with NULL"));
699 /* Read the current pending count */
700 pending = atomic_load_acq_int(&sc->ec_sci_pend);
702 /* Call GPE handler function */
703 EcGpeQueryHandlerSub(sc);
706 * Try to reset the pending count to zero. If this fails we
707 * know another GPE event has occurred while handling the
708 * current GPE event and need to loop.
710 } while (!atomic_cmpset_int(&sc->ec_sci_pend, pending, 0));
714 * The GPE handler is called when IBE/OBF or SCI events occur. We are
715 * called from an unknown lock context.
718 EcGpeHandler(ACPI_HANDLE GpeDevice, UINT32 GpeNumber, void *Context)
720 struct acpi_ec_softc *sc = Context;
724 KASSERT(Context != NULL, ("EcGpeHandler called with NULL"));
725 CTR0(KTR_ACPI, "ec gpe handler start");
728 * Notify EcWaitEvent() that the status register is now fresh. If we
729 * didn't do this, it wouldn't be possible to distinguish an old IBE
730 * from a new one, for example when doing a write transaction (writing
731 * address and then data values.)
733 atomic_add_int(&sc->ec_gencount, 1);
737 * If the EC_SCI bit of the status register is set, queue a query handler.
738 * It will run the query and _Qxx method later, under the lock.
740 EcStatus = EC_GET_CSR(sc);
741 if ((EcStatus & EC_EVENT_SCI) &&
742 atomic_fetchadd_int(&sc->ec_sci_pend, 1) == 0) {
743 CTR0(KTR_ACPI, "ec gpe queueing query handler");
744 Status = AcpiOsExecute(OSL_GPE_HANDLER, EcGpeQueryHandler, Context);
745 if (ACPI_FAILURE(Status)) {
746 printf("EcGpeHandler: queuing GPE query handler failed\n");
747 atomic_store_rel_int(&sc->ec_sci_pend, 0);
750 return (ACPI_REENABLE_GPE);
754 EcSpaceSetup(ACPI_HANDLE Region, UINT32 Function, void *Context,
755 void **RegionContext)
758 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
761 * If deactivating a region, always set the output to NULL. Otherwise,
762 * just pass the context through.
764 if (Function == ACPI_REGION_DEACTIVATE)
765 *RegionContext = NULL;
767 *RegionContext = Context;
769 return_ACPI_STATUS (AE_OK);
773 EcSpaceHandler(UINT32 Function, ACPI_PHYSICAL_ADDRESS Address, UINT32 Width,
774 UINT64 *Value, void *Context, void *RegionContext)
776 struct acpi_ec_softc *sc = (struct acpi_ec_softc *)Context;
777 ACPI_PHYSICAL_ADDRESS EcAddr;
781 ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, (UINT32)Address);
783 if (Function != ACPI_READ && Function != ACPI_WRITE)
784 return_ACPI_STATUS (AE_BAD_PARAMETER);
785 if (Width % 8 != 0 || Value == NULL || Context == NULL)
786 return_ACPI_STATUS (AE_BAD_PARAMETER);
787 if (Address + Width / 8 > 256)
788 return_ACPI_STATUS (AE_BAD_ADDRESS);
791 * If booting, check if we need to run the query handler. If so, we
792 * we call it directly here since our thread taskq is not active yet.
794 if (cold || rebooting || sc->ec_suspending) {
795 if ((EC_GET_CSR(sc) & EC_EVENT_SCI) &&
796 atomic_fetchadd_int(&sc->ec_sci_pend, 1) == 0) {
797 CTR0(KTR_ACPI, "ec running gpe handler directly");
798 EcGpeQueryHandler(sc);
802 /* Serialize with EcGpeQueryHandler() at transaction granularity. */
804 if (ACPI_FAILURE(Status))
805 return_ACPI_STATUS (Status);
807 /* If we can't start burst mode, continue anyway. */
808 Status = EcCommand(sc, EC_COMMAND_BURST_ENABLE);
809 if (ACPI_SUCCESS(Status)) {
810 if (EC_GET_DATA(sc) == EC_BURST_ACK) {
811 CTR0(KTR_ACPI, "ec burst enabled");
812 sc->ec_burstactive = TRUE;
816 /* Perform the transaction(s), based on Width. */
818 EcData = (UINT8 *)Value;
819 if (Function == ACPI_READ)
824 Status = EcRead(sc, EcAddr, EcData);
827 Status = EcWrite(sc, EcAddr, *EcData);
830 if (ACPI_FAILURE(Status))
834 } while (EcAddr < Address + Width / 8);
836 if (sc->ec_burstactive) {
837 sc->ec_burstactive = FALSE;
838 if (ACPI_SUCCESS(EcCommand(sc, EC_COMMAND_BURST_DISABLE)))
839 CTR0(KTR_ACPI, "ec disabled burst ok");
843 return_ACPI_STATUS (Status);
847 EcWaitEvent(struct acpi_ec_softc *sc, EC_EVENT Event, u_int gen_count)
849 static int no_intr = 0;
851 int count, i, need_poll, slp_ival;
853 ACPI_SERIAL_ASSERT(ec);
854 Status = AE_NO_HARDWARE_RESPONSE;
855 need_poll = cold || rebooting || ec_polled_mode || sc->ec_suspending;
857 /* Wait for event by polling or GPE (interrupt). */
859 count = (ec_timeout * 1000) / EC_POLL_DELAY;
863 for (i = 0; i < count; i++) {
864 Status = EcCheckStatus(sc, "poll", Event);
865 if (ACPI_SUCCESS(Status))
867 DELAY(EC_POLL_DELAY);
870 slp_ival = hz / 1000;
874 /* hz has less than 1 ms resolution so scale timeout. */
876 count = ec_timeout / (1000 / hz);
880 * Wait for the GPE to signal the status changed, checking the
881 * status register each time we get one. It's possible to get a
882 * GPE for an event we're not interested in here (i.e., SCI for
885 for (i = 0; i < count; i++) {
886 if (gen_count == sc->ec_gencount)
887 tsleep(sc, 0, "ecgpe", slp_ival);
889 * Record new generation count. It's possible the GPE was
890 * just to notify us that a query is needed and we need to
891 * wait for a second GPE to signal the completion of the
892 * event we are actually waiting for.
894 Status = EcCheckStatus(sc, "sleep", Event);
895 if (ACPI_SUCCESS(Status)) {
896 if (gen_count == sc->ec_gencount)
902 gen_count = sc->ec_gencount;
906 * We finished waiting for the GPE and it never arrived. Try to
907 * read the register once and trust whatever value we got. This is
908 * the best we can do at this point.
910 if (ACPI_FAILURE(Status))
911 Status = EcCheckStatus(sc, "sleep_end", Event);
913 if (!need_poll && no_intr > 10) {
914 device_printf(sc->ec_dev,
915 "not getting interrupts, switched to polled mode\n");
918 if (ACPI_FAILURE(Status))
919 CTR0(KTR_ACPI, "error: ec wait timed out");
924 EcCommand(struct acpi_ec_softc *sc, EC_COMMAND cmd)
931 ACPI_SERIAL_ASSERT(ec);
933 /* Don't use burst mode if user disabled it. */
934 if (!ec_burst_mode && cmd == EC_COMMAND_BURST_ENABLE)
937 /* Decide what to wait for based on command type. */
939 case EC_COMMAND_READ:
940 case EC_COMMAND_WRITE:
941 case EC_COMMAND_BURST_DISABLE:
942 event = EC_EVENT_INPUT_BUFFER_EMPTY;
944 case EC_COMMAND_QUERY:
945 case EC_COMMAND_BURST_ENABLE:
946 event = EC_EVENT_OUTPUT_BUFFER_FULL;
949 device_printf(sc->ec_dev, "EcCommand: invalid command %#x\n", cmd);
950 return (AE_BAD_PARAMETER);
954 * Ensure empty input buffer before issuing command.
955 * Use generation count of zero to force a quick check.
957 status = EcWaitEvent(sc, EC_EVENT_INPUT_BUFFER_EMPTY, 0);
958 if (ACPI_FAILURE(status))
961 /* Run the command and wait for the chosen event. */
962 CTR1(KTR_ACPI, "ec running command %#x", cmd);
963 gen_count = sc->ec_gencount;
965 status = EcWaitEvent(sc, event, gen_count);
966 if (ACPI_SUCCESS(status)) {
967 /* If we succeeded, burst flag should now be present. */
968 if (cmd == EC_COMMAND_BURST_ENABLE) {
969 ec_status = EC_GET_CSR(sc);
970 if ((ec_status & EC_FLAG_BURST_MODE) == 0)
974 device_printf(sc->ec_dev, "EcCommand: no response to %#x\n", cmd);
979 EcRead(struct acpi_ec_softc *sc, UINT8 Address, UINT8 *Data)
985 ACPI_SERIAL_ASSERT(ec);
986 CTR1(KTR_ACPI, "ec read from %#x", Address);
988 for (retry = 0; retry < 2; retry++) {
989 status = EcCommand(sc, EC_COMMAND_READ);
990 if (ACPI_FAILURE(status))
993 gen_count = sc->ec_gencount;
994 EC_SET_DATA(sc, Address);
995 status = EcWaitEvent(sc, EC_EVENT_OUTPUT_BUFFER_FULL, gen_count);
996 if (ACPI_SUCCESS(status)) {
997 *Data = EC_GET_DATA(sc);
1000 if (ACPI_FAILURE(EcCheckStatus(sc, "retr_check",
1001 EC_EVENT_INPUT_BUFFER_EMPTY)))
1004 device_printf(sc->ec_dev, "EcRead: failed waiting to get data\n");
1009 EcWrite(struct acpi_ec_softc *sc, UINT8 Address, UINT8 Data)
1014 ACPI_SERIAL_ASSERT(ec);
1015 CTR2(KTR_ACPI, "ec write to %#x, data %#x", Address, Data);
1017 status = EcCommand(sc, EC_COMMAND_WRITE);
1018 if (ACPI_FAILURE(status))
1021 gen_count = sc->ec_gencount;
1022 EC_SET_DATA(sc, Address);
1023 status = EcWaitEvent(sc, EC_EVENT_INPUT_BUFFER_EMPTY, gen_count);
1024 if (ACPI_FAILURE(status)) {
1025 device_printf(sc->ec_dev, "EcWrite: failed waiting for sent address\n");
1029 gen_count = sc->ec_gencount;
1030 EC_SET_DATA(sc, Data);
1031 status = EcWaitEvent(sc, EC_EVENT_INPUT_BUFFER_EMPTY, gen_count);
1032 if (ACPI_FAILURE(status)) {
1033 device_printf(sc->ec_dev, "EcWrite: failed waiting for sent data\n");