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>
38 #include <sys/malloc.h>
39 #include <sys/module.h>
42 #include <machine/bus.h>
43 #include <machine/resource.h>
46 #include <contrib/dev/acpica/include/acpi.h>
47 #include <contrib/dev/acpica/include/accommon.h>
49 #include <dev/acpica/acpivar.h>
51 /* Hooks for the ACPI CA debugging infrastructure */
52 #define _COMPONENT ACPI_EC
53 ACPI_MODULE_NAME("EC")
59 typedef UINT8 EC_COMMAND;
61 #define EC_COMMAND_UNKNOWN ((EC_COMMAND) 0x00)
62 #define EC_COMMAND_READ ((EC_COMMAND) 0x80)
63 #define EC_COMMAND_WRITE ((EC_COMMAND) 0x81)
64 #define EC_COMMAND_BURST_ENABLE ((EC_COMMAND) 0x82)
65 #define EC_COMMAND_BURST_DISABLE ((EC_COMMAND) 0x83)
66 #define EC_COMMAND_QUERY ((EC_COMMAND) 0x84)
71 * The encoding of the EC status register is illustrated below.
72 * Note that a set bit (1) indicates the property is TRUE
73 * (e.g. if bit 0 is set then the output buffer is full).
78 * | | | | | | | +- Output Buffer Full?
79 * | | | | | | +--- Input Buffer Full?
80 * | | | | | +----- <reserved>
81 * | | | | +------- Data Register is Command Byte?
82 * | | | +--------- Burst Mode Enabled?
83 * | | +----------- SCI Event?
84 * | +------------- SMI Event?
85 * +--------------- <reserved>
88 typedef UINT8 EC_STATUS;
90 #define EC_FLAG_OUTPUT_BUFFER ((EC_STATUS) 0x01)
91 #define EC_FLAG_INPUT_BUFFER ((EC_STATUS) 0x02)
92 #define EC_FLAG_DATA_IS_CMD ((EC_STATUS) 0x08)
93 #define EC_FLAG_BURST_MODE ((EC_STATUS) 0x10)
99 typedef UINT8 EC_EVENT;
101 #define EC_EVENT_UNKNOWN ((EC_EVENT) 0x00)
102 #define EC_EVENT_OUTPUT_BUFFER_FULL ((EC_EVENT) 0x01)
103 #define EC_EVENT_INPUT_BUFFER_EMPTY ((EC_EVENT) 0x02)
104 #define EC_EVENT_SCI ((EC_EVENT) 0x20)
105 #define EC_EVENT_SMI ((EC_EVENT) 0x40)
107 /* Data byte returned after burst enable indicating it was successful. */
108 #define EC_BURST_ACK 0x90
111 * Register access primitives
113 #define EC_GET_DATA(sc) \
114 bus_space_read_1((sc)->ec_data_tag, (sc)->ec_data_handle, 0)
116 #define EC_SET_DATA(sc, v) \
117 bus_space_write_1((sc)->ec_data_tag, (sc)->ec_data_handle, 0, (v))
119 #define EC_GET_CSR(sc) \
120 bus_space_read_1((sc)->ec_csr_tag, (sc)->ec_csr_handle, 0)
122 #define EC_SET_CSR(sc, v) \
123 bus_space_write_1((sc)->ec_csr_tag, (sc)->ec_csr_handle, 0, (v))
125 /* Additional params to pass from the probe routine */
126 struct acpi_ec_params {
129 ACPI_HANDLE gpe_handle;
136 struct acpi_ec_softc {
138 ACPI_HANDLE ec_handle;
140 ACPI_HANDLE ec_gpehandle;
144 struct resource *ec_data_res;
145 bus_space_tag_t ec_data_tag;
146 bus_space_handle_t ec_data_handle;
149 struct resource *ec_csr_res;
150 bus_space_tag_t ec_csr_tag;
151 bus_space_handle_t ec_csr_handle;
157 volatile u_int ec_gencount;
163 * I couldn't find it in the spec but other implementations also use a
164 * value of 1 ms for the time to acquire global lock.
166 #define EC_LOCK_TIMEOUT 1000
168 /* Default delay in microseconds between each run of the status polling loop. */
169 #define EC_POLL_DELAY 50
171 /* Total time in ms spent waiting for a response from EC. */
172 #define EC_TIMEOUT 750
174 #define EVENT_READY(event, status) \
175 (((event) == EC_EVENT_OUTPUT_BUFFER_FULL && \
176 ((status) & EC_FLAG_OUTPUT_BUFFER) != 0) || \
177 ((event) == EC_EVENT_INPUT_BUFFER_EMPTY && \
178 ((status) & EC_FLAG_INPUT_BUFFER) == 0))
180 ACPI_SERIAL_DECL(ec, "ACPI embedded controller");
182 static SYSCTL_NODE(_debug_acpi, OID_AUTO, ec, CTLFLAG_RD, NULL, "EC debugging");
184 static int ec_burst_mode;
185 SYSCTL_INT(_debug_acpi_ec, OID_AUTO, burst, CTLFLAG_RWTUN, &ec_burst_mode, 0,
186 "Enable use of burst mode (faster for nearly all systems)");
187 static int ec_polled_mode;
188 SYSCTL_INT(_debug_acpi_ec, OID_AUTO, polled, CTLFLAG_RWTUN, &ec_polled_mode, 0,
189 "Force use of polled mode (only if interrupt mode doesn't work)");
190 static int ec_timeout = EC_TIMEOUT;
191 SYSCTL_INT(_debug_acpi_ec, OID_AUTO, timeout, CTLFLAG_RWTUN, &ec_timeout,
192 EC_TIMEOUT, "Total time spent waiting for a response (poll+sleep)");
195 EcLock(struct acpi_ec_softc *sc)
199 /* If _GLK is non-zero, acquire the global lock. */
202 status = AcpiAcquireGlobalLock(EC_LOCK_TIMEOUT, &sc->ec_glkhandle);
203 if (ACPI_FAILURE(status))
206 ACPI_SERIAL_BEGIN(ec);
211 EcUnlock(struct acpi_ec_softc *sc)
215 AcpiReleaseGlobalLock(sc->ec_glkhandle);
218 static UINT32 EcGpeHandler(ACPI_HANDLE, UINT32, void *);
219 static ACPI_STATUS EcSpaceSetup(ACPI_HANDLE Region, UINT32 Function,
220 void *Context, void **return_Context);
221 static ACPI_STATUS EcSpaceHandler(UINT32 Function,
222 ACPI_PHYSICAL_ADDRESS Address,
223 UINT32 Width, UINT64 *Value,
224 void *Context, void *RegionContext);
225 static ACPI_STATUS EcWaitEvent(struct acpi_ec_softc *sc, EC_EVENT Event,
227 static ACPI_STATUS EcCommand(struct acpi_ec_softc *sc, EC_COMMAND cmd);
228 static ACPI_STATUS EcRead(struct acpi_ec_softc *sc, UINT8 Address,
230 static ACPI_STATUS EcWrite(struct acpi_ec_softc *sc, UINT8 Address,
232 static int acpi_ec_probe(device_t dev);
233 static int acpi_ec_attach(device_t dev);
234 static int acpi_ec_suspend(device_t dev);
235 static int acpi_ec_resume(device_t dev);
236 static int acpi_ec_shutdown(device_t dev);
237 static int acpi_ec_read_method(device_t dev, u_int addr,
238 UINT64 *val, int width);
239 static int acpi_ec_write_method(device_t dev, u_int addr,
240 UINT64 val, int width);
242 static device_method_t acpi_ec_methods[] = {
243 /* Device interface */
244 DEVMETHOD(device_probe, acpi_ec_probe),
245 DEVMETHOD(device_attach, acpi_ec_attach),
246 DEVMETHOD(device_suspend, acpi_ec_suspend),
247 DEVMETHOD(device_resume, acpi_ec_resume),
248 DEVMETHOD(device_shutdown, acpi_ec_shutdown),
250 /* Embedded controller interface */
251 DEVMETHOD(acpi_ec_read, acpi_ec_read_method),
252 DEVMETHOD(acpi_ec_write, acpi_ec_write_method),
257 static driver_t acpi_ec_driver = {
260 sizeof(struct acpi_ec_softc),
263 static devclass_t acpi_ec_devclass;
264 DRIVER_MODULE(acpi_ec, acpi, acpi_ec_driver, acpi_ec_devclass, 0, 0);
265 MODULE_DEPEND(acpi_ec, acpi, 1, 1, 1);
268 * Look for an ECDT and if we find one, set up default GPE and
269 * space handlers to catch attempts to access EC space before
270 * we have a real driver instance in place.
272 * TODO: Some old Gateway laptops need us to fake up an ECDT or
273 * otherwise attach early so that _REG methods can run.
276 acpi_ec_ecdt_probe(device_t parent)
278 ACPI_TABLE_ECDT *ecdt;
282 struct acpi_ec_params *params;
284 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
286 /* Find and validate the ECDT. */
287 status = AcpiGetTable(ACPI_SIG_ECDT, 1, (ACPI_TABLE_HEADER **)&ecdt);
288 if (ACPI_FAILURE(status) ||
289 ecdt->Control.BitWidth != 8 ||
290 ecdt->Data.BitWidth != 8) {
294 /* Create the child device with the given unit number. */
295 child = BUS_ADD_CHILD(parent, 3, "acpi_ec", ecdt->Uid);
297 printf("%s: can't add child\n", __func__);
301 /* Find and save the ACPI handle for this device. */
302 status = AcpiGetHandle(NULL, ecdt->Id, &h);
303 if (ACPI_FAILURE(status)) {
304 device_delete_child(parent, child);
305 printf("%s: can't get handle\n", __func__);
308 acpi_set_handle(child, h);
310 /* Set the data and CSR register addresses. */
311 bus_set_resource(child, SYS_RES_IOPORT, 0, ecdt->Data.Address,
313 bus_set_resource(child, SYS_RES_IOPORT, 1, ecdt->Control.Address,
317 * Store values for the probe/attach routines to use. Store the
318 * ECDT GPE bit and set the global lock flag according to _GLK.
319 * Note that it is not perfectly correct to be evaluating a method
320 * before initializing devices, but in practice this function
321 * should be safe to call at this point.
323 params = malloc(sizeof(struct acpi_ec_params), M_TEMP, M_WAITOK | M_ZERO);
324 params->gpe_handle = NULL;
325 params->gpe_bit = ecdt->Gpe;
326 params->uid = ecdt->Uid;
327 acpi_GetInteger(h, "_GLK", ¶ms->glk);
328 acpi_set_private(child, params);
330 /* Finish the attach process. */
331 if (device_probe_and_attach(child) != 0)
332 device_delete_child(parent, child);
336 acpi_ec_probe(device_t dev)
346 struct acpi_ec_params *params;
347 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"))
355 if (device_is_devclass_fixed(dev)) {
357 * If probed via ECDT, set description and continue. Otherwise, we can
358 * access the namespace and make sure this is not a duplicate probe.
361 params = acpi_get_private(dev);
369 ret = ACPI_ID_PROBE(device_get_parent(dev), dev, ec_ids, NULL);
373 params = malloc(sizeof(struct acpi_ec_params), M_TEMP, M_WAITOK | M_ZERO);
376 buf.Length = ACPI_ALLOCATE_BUFFER;
377 h = acpi_get_handle(dev);
380 * Read the unit ID to check for duplicate attach and the global lock value
381 * to see if we should acquire it when accessing the EC.
383 status = acpi_GetInteger(h, "_UID", ¶ms->uid);
384 if (ACPI_FAILURE(status))
388 * Check for a duplicate probe. This can happen when a probe via ECDT
389 * succeeded already. If this is a duplicate, disable this device.
391 * NB: It would seem device_disable would be sufficient to not get
392 * duplicated devices, and ENXIO isn't needed, however, device_probe() only
393 * checks DF_ENABLED at the start and so disabling it here is too late to
394 * prevent device_attach() from being called.
396 peer = devclass_get_device(acpi_ec_devclass, params->uid);
397 if (peer != NULL && device_is_alive(peer)) {
403 status = acpi_GetInteger(h, "_GLK", ¶ms->glk);
404 if (ACPI_FAILURE(status))
408 * Evaluate the _GPE method to find the GPE bit used by the EC to signal
409 * status (SCI). If it's a package, it contains a reference and GPE bit,
412 status = AcpiEvaluateObject(h, "_GPE", NULL, &buf);
413 if (ACPI_FAILURE(status)) {
414 device_printf(dev, "can't evaluate _GPE - %s\n", AcpiFormatException(status));
418 obj = (ACPI_OBJECT *)buf.Pointer;
423 case ACPI_TYPE_INTEGER:
424 params->gpe_handle = NULL;
425 params->gpe_bit = obj->Integer.Value;
427 case ACPI_TYPE_PACKAGE:
428 if (!ACPI_PKG_VALID(obj, 2))
430 params->gpe_handle = acpi_GetReference(NULL, &obj->Package.Elements[0]);
431 if (params->gpe_handle == NULL ||
432 acpi_PkgInt32(obj, 1, ¶ms->gpe_bit) != 0)
436 device_printf(dev, "_GPE has invalid type %d\n", obj->Type);
440 /* Store the values we got from the namespace for attach. */
441 acpi_set_private(dev, params);
444 AcpiOsFree(buf.Pointer);
447 snprintf(desc, sizeof(desc), "Embedded Controller: GPE %#x%s%s",
448 params->gpe_bit, (params->glk) ? ", GLK" : "",
449 ecdt ? ", ECDT" : "");
450 device_set_desc_copy(dev, desc);
452 free(params, M_TEMP);
458 acpi_ec_attach(device_t dev)
460 struct acpi_ec_softc *sc;
461 struct acpi_ec_params *params;
464 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
466 /* Fetch/initialize softc (assumes softc is pre-zeroed). */
467 sc = device_get_softc(dev);
468 params = acpi_get_private(dev);
470 sc->ec_handle = acpi_get_handle(dev);
472 /* Retrieve previously probed values via device ivars. */
473 sc->ec_glk = params->glk;
474 sc->ec_gpebit = params->gpe_bit;
475 sc->ec_gpehandle = params->gpe_handle;
476 sc->ec_uid = params->uid;
477 sc->ec_suspending = FALSE;
478 acpi_set_private(dev, NULL);
479 free(params, M_TEMP);
481 /* Attach bus resources for data and command/status ports. */
483 sc->ec_data_res = bus_alloc_resource_any(sc->ec_dev, SYS_RES_IOPORT,
484 &sc->ec_data_rid, RF_ACTIVE);
485 if (sc->ec_data_res == NULL) {
486 device_printf(dev, "can't allocate data port\n");
489 sc->ec_data_tag = rman_get_bustag(sc->ec_data_res);
490 sc->ec_data_handle = rman_get_bushandle(sc->ec_data_res);
493 sc->ec_csr_res = bus_alloc_resource_any(sc->ec_dev, SYS_RES_IOPORT,
494 &sc->ec_csr_rid, RF_ACTIVE);
495 if (sc->ec_csr_res == NULL) {
496 device_printf(dev, "can't allocate command/status port\n");
499 sc->ec_csr_tag = rman_get_bustag(sc->ec_csr_res);
500 sc->ec_csr_handle = rman_get_bushandle(sc->ec_csr_res);
503 * Install a handler for this EC's GPE bit. We want edge-triggered
506 ACPI_DEBUG_PRINT((ACPI_DB_RESOURCES, "attaching GPE handler\n"));
507 Status = AcpiInstallGpeHandler(sc->ec_gpehandle, sc->ec_gpebit,
508 ACPI_GPE_EDGE_TRIGGERED, EcGpeHandler, sc);
509 if (ACPI_FAILURE(Status)) {
510 device_printf(dev, "can't install GPE handler for %s - %s\n",
511 acpi_name(sc->ec_handle), AcpiFormatException(Status));
516 * Install address space handler
518 ACPI_DEBUG_PRINT((ACPI_DB_RESOURCES, "attaching address space handler\n"));
519 Status = AcpiInstallAddressSpaceHandler(sc->ec_handle, ACPI_ADR_SPACE_EC,
520 &EcSpaceHandler, &EcSpaceSetup, sc);
521 if (ACPI_FAILURE(Status)) {
522 device_printf(dev, "can't install address space handler for %s - %s\n",
523 acpi_name(sc->ec_handle), AcpiFormatException(Status));
527 /* Enable runtime GPEs for the handler. */
528 Status = AcpiEnableGpe(sc->ec_gpehandle, sc->ec_gpebit);
529 if (ACPI_FAILURE(Status)) {
530 device_printf(dev, "AcpiEnableGpe failed: %s\n",
531 AcpiFormatException(Status));
535 ACPI_DEBUG_PRINT((ACPI_DB_RESOURCES, "acpi_ec_attach complete\n"));
539 AcpiRemoveGpeHandler(sc->ec_gpehandle, sc->ec_gpebit, EcGpeHandler);
540 AcpiRemoveAddressSpaceHandler(sc->ec_handle, ACPI_ADR_SPACE_EC,
543 bus_release_resource(sc->ec_dev, SYS_RES_IOPORT, sc->ec_csr_rid,
546 bus_release_resource(sc->ec_dev, SYS_RES_IOPORT, sc->ec_data_rid,
552 acpi_ec_suspend(device_t dev)
554 struct acpi_ec_softc *sc;
556 sc = device_get_softc(dev);
557 sc->ec_suspending = TRUE;
562 acpi_ec_resume(device_t dev)
564 struct acpi_ec_softc *sc;
566 sc = device_get_softc(dev);
567 sc->ec_suspending = FALSE;
572 acpi_ec_shutdown(device_t dev)
574 struct acpi_ec_softc *sc;
576 /* Disable the GPE so we don't get EC events during shutdown. */
577 sc = device_get_softc(dev);
578 AcpiDisableGpe(sc->ec_gpehandle, sc->ec_gpebit);
582 /* Methods to allow other devices (e.g., smbat) to read/write EC space. */
584 acpi_ec_read_method(device_t dev, u_int addr, UINT64 *val, int width)
586 struct acpi_ec_softc *sc;
589 sc = device_get_softc(dev);
590 status = EcSpaceHandler(ACPI_READ, addr, width * 8, val, sc, NULL);
591 if (ACPI_FAILURE(status))
597 acpi_ec_write_method(device_t dev, u_int addr, UINT64 val, int width)
599 struct acpi_ec_softc *sc;
602 sc = device_get_softc(dev);
603 status = EcSpaceHandler(ACPI_WRITE, addr, width * 8, &val, sc, NULL);
604 if (ACPI_FAILURE(status))
610 EcCheckStatus(struct acpi_ec_softc *sc, const char *msg, EC_EVENT event)
615 status = AE_NO_HARDWARE_RESPONSE;
616 ec_status = EC_GET_CSR(sc);
617 if (sc->ec_burstactive && !(ec_status & EC_FLAG_BURST_MODE)) {
618 CTR1(KTR_ACPI, "ec burst disabled in waitevent (%s)", msg);
619 sc->ec_burstactive = FALSE;
621 if (EVENT_READY(event, ec_status)) {
622 CTR2(KTR_ACPI, "ec %s wait ready, status %#x", msg, ec_status);
629 EcGpeQueryHandlerSub(struct acpi_ec_softc *sc)
636 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
638 /* Serialize user access with EcSpaceHandler(). */
640 if (ACPI_FAILURE(Status)) {
641 device_printf(sc->ec_dev, "GpeQuery lock error: %s\n",
642 AcpiFormatException(Status));
647 * Send a query command to the EC to find out which _Qxx call it
648 * wants to make. This command clears the SCI bit and also the
649 * interrupt source since we are edge-triggered. To prevent the GPE
650 * that may arise from running the query from causing another query
651 * to be queued, we clear the pending flag only after running it.
653 for (retry = 0; retry < 2; retry++) {
654 Status = EcCommand(sc, EC_COMMAND_QUERY);
655 if (ACPI_SUCCESS(Status))
657 if (ACPI_FAILURE(EcCheckStatus(sc, "retr_check",
658 EC_EVENT_INPUT_BUFFER_EMPTY)))
661 if (ACPI_FAILURE(Status)) {
663 device_printf(sc->ec_dev, "GPE query failed: %s\n",
664 AcpiFormatException(Status));
667 Data = EC_GET_DATA(sc);
670 * We have to unlock before running the _Qxx method below since that
671 * method may attempt to read/write from EC address space, causing
672 * recursive acquisition of the lock.
676 /* Ignore the value for "no outstanding event". (13.3.5) */
677 CTR2(KTR_ACPI, "ec query ok,%s running _Q%02X", Data ? "" : " not", Data);
681 /* Evaluate _Qxx to respond to the controller. */
682 snprintf(qxx, sizeof(qxx), "_Q%02X", Data);
684 Status = AcpiEvaluateObject(sc->ec_handle, qxx, NULL, NULL);
685 if (ACPI_FAILURE(Status) && Status != AE_NOT_FOUND) {
686 device_printf(sc->ec_dev, "evaluation of query method %s failed: %s\n",
687 qxx, AcpiFormatException(Status));
692 EcGpeQueryHandler(void *Context)
694 struct acpi_ec_softc *sc = (struct acpi_ec_softc *)Context;
697 KASSERT(Context != NULL, ("EcGpeQueryHandler called with NULL"));
700 /* Read the current pending count */
701 pending = atomic_load_acq_int(&sc->ec_sci_pend);
703 /* Call GPE handler function */
704 EcGpeQueryHandlerSub(sc);
707 * Try to reset the pending count to zero. If this fails we
708 * know another GPE event has occurred while handling the
709 * current GPE event and need to loop.
711 } while (!atomic_cmpset_int(&sc->ec_sci_pend, pending, 0));
715 * The GPE handler is called when IBE/OBF or SCI events occur. We are
716 * called from an unknown lock context.
719 EcGpeHandler(ACPI_HANDLE GpeDevice, UINT32 GpeNumber, void *Context)
721 struct acpi_ec_softc *sc = Context;
725 KASSERT(Context != NULL, ("EcGpeHandler called with NULL"));
726 CTR0(KTR_ACPI, "ec gpe handler start");
729 * Notify EcWaitEvent() that the status register is now fresh. If we
730 * didn't do this, it wouldn't be possible to distinguish an old IBE
731 * from a new one, for example when doing a write transaction (writing
732 * address and then data values.)
734 atomic_add_int(&sc->ec_gencount, 1);
738 * If the EC_SCI bit of the status register is set, queue a query handler.
739 * It will run the query and _Qxx method later, under the lock.
741 EcStatus = EC_GET_CSR(sc);
742 if ((EcStatus & EC_EVENT_SCI) &&
743 atomic_fetchadd_int(&sc->ec_sci_pend, 1) == 0) {
744 CTR0(KTR_ACPI, "ec gpe queueing query handler");
745 Status = AcpiOsExecute(OSL_GPE_HANDLER, EcGpeQueryHandler, Context);
746 if (ACPI_FAILURE(Status)) {
747 printf("EcGpeHandler: queuing GPE query handler failed\n");
748 atomic_store_rel_int(&sc->ec_sci_pend, 0);
751 return (ACPI_REENABLE_GPE);
755 EcSpaceSetup(ACPI_HANDLE Region, UINT32 Function, void *Context,
756 void **RegionContext)
759 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
762 * If deactivating a region, always set the output to NULL. Otherwise,
763 * just pass the context through.
765 if (Function == ACPI_REGION_DEACTIVATE)
766 *RegionContext = NULL;
768 *RegionContext = Context;
770 return_ACPI_STATUS (AE_OK);
774 EcSpaceHandler(UINT32 Function, ACPI_PHYSICAL_ADDRESS Address, UINT32 Width,
775 UINT64 *Value, void *Context, void *RegionContext)
777 struct acpi_ec_softc *sc = (struct acpi_ec_softc *)Context;
778 ACPI_PHYSICAL_ADDRESS EcAddr;
782 ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, (UINT32)Address);
784 if (Function != ACPI_READ && Function != ACPI_WRITE)
785 return_ACPI_STATUS (AE_BAD_PARAMETER);
786 if (Width % 8 != 0 || Value == NULL || Context == NULL)
787 return_ACPI_STATUS (AE_BAD_PARAMETER);
788 if (Address + Width / 8 > 256)
789 return_ACPI_STATUS (AE_BAD_ADDRESS);
792 * If booting, check if we need to run the query handler. If so, we
793 * we call it directly here since our thread taskq is not active yet.
795 if (cold || rebooting || sc->ec_suspending) {
796 if ((EC_GET_CSR(sc) & EC_EVENT_SCI) &&
797 atomic_fetchadd_int(&sc->ec_sci_pend, 1) == 0) {
798 CTR0(KTR_ACPI, "ec running gpe handler directly");
799 EcGpeQueryHandler(sc);
803 /* Serialize with EcGpeQueryHandler() at transaction granularity. */
805 if (ACPI_FAILURE(Status))
806 return_ACPI_STATUS (Status);
808 /* If we can't start burst mode, continue anyway. */
809 Status = EcCommand(sc, EC_COMMAND_BURST_ENABLE);
810 if (ACPI_SUCCESS(Status)) {
811 if (EC_GET_DATA(sc) == EC_BURST_ACK) {
812 CTR0(KTR_ACPI, "ec burst enabled");
813 sc->ec_burstactive = TRUE;
817 /* Perform the transaction(s), based on Width. */
819 EcData = (UINT8 *)Value;
820 if (Function == ACPI_READ)
825 Status = EcRead(sc, EcAddr, EcData);
828 Status = EcWrite(sc, EcAddr, *EcData);
831 if (ACPI_FAILURE(Status))
835 } while (EcAddr < Address + Width / 8);
837 if (sc->ec_burstactive) {
838 sc->ec_burstactive = FALSE;
839 if (ACPI_SUCCESS(EcCommand(sc, EC_COMMAND_BURST_DISABLE)))
840 CTR0(KTR_ACPI, "ec disabled burst ok");
844 return_ACPI_STATUS (Status);
848 EcWaitEvent(struct acpi_ec_softc *sc, EC_EVENT Event, u_int gen_count)
850 static int no_intr = 0;
852 int count, i, need_poll, slp_ival;
854 ACPI_SERIAL_ASSERT(ec);
855 Status = AE_NO_HARDWARE_RESPONSE;
856 need_poll = cold || rebooting || ec_polled_mode || sc->ec_suspending;
858 /* Wait for event by polling or GPE (interrupt). */
860 count = (ec_timeout * 1000) / EC_POLL_DELAY;
864 for (i = 0; i < count; i++) {
865 Status = EcCheckStatus(sc, "poll", Event);
866 if (ACPI_SUCCESS(Status))
868 DELAY(EC_POLL_DELAY);
871 slp_ival = hz / 1000;
875 /* hz has less than 1 ms resolution so scale timeout. */
877 count = ec_timeout / (1000 / hz);
881 * Wait for the GPE to signal the status changed, checking the
882 * status register each time we get one. It's possible to get a
883 * GPE for an event we're not interested in here (i.e., SCI for
886 for (i = 0; i < count; i++) {
887 if (gen_count == sc->ec_gencount)
888 tsleep(sc, 0, "ecgpe", slp_ival);
890 * Record new generation count. It's possible the GPE was
891 * just to notify us that a query is needed and we need to
892 * wait for a second GPE to signal the completion of the
893 * event we are actually waiting for.
895 Status = EcCheckStatus(sc, "sleep", Event);
896 if (ACPI_SUCCESS(Status)) {
897 if (gen_count == sc->ec_gencount)
903 gen_count = sc->ec_gencount;
907 * We finished waiting for the GPE and it never arrived. Try to
908 * read the register once and trust whatever value we got. This is
909 * the best we can do at this point.
911 if (ACPI_FAILURE(Status))
912 Status = EcCheckStatus(sc, "sleep_end", Event);
914 if (!need_poll && no_intr > 10) {
915 device_printf(sc->ec_dev,
916 "not getting interrupts, switched to polled mode\n");
919 if (ACPI_FAILURE(Status))
920 CTR0(KTR_ACPI, "error: ec wait timed out");
925 EcCommand(struct acpi_ec_softc *sc, EC_COMMAND cmd)
932 ACPI_SERIAL_ASSERT(ec);
934 /* Don't use burst mode if user disabled it. */
935 if (!ec_burst_mode && cmd == EC_COMMAND_BURST_ENABLE)
938 /* Decide what to wait for based on command type. */
940 case EC_COMMAND_READ:
941 case EC_COMMAND_WRITE:
942 case EC_COMMAND_BURST_DISABLE:
943 event = EC_EVENT_INPUT_BUFFER_EMPTY;
945 case EC_COMMAND_QUERY:
946 case EC_COMMAND_BURST_ENABLE:
947 event = EC_EVENT_OUTPUT_BUFFER_FULL;
950 device_printf(sc->ec_dev, "EcCommand: invalid command %#x\n", cmd);
951 return (AE_BAD_PARAMETER);
955 * Ensure empty input buffer before issuing command.
956 * Use generation count of zero to force a quick check.
958 status = EcWaitEvent(sc, EC_EVENT_INPUT_BUFFER_EMPTY, 0);
959 if (ACPI_FAILURE(status))
962 /* Run the command and wait for the chosen event. */
963 CTR1(KTR_ACPI, "ec running command %#x", cmd);
964 gen_count = sc->ec_gencount;
966 status = EcWaitEvent(sc, event, gen_count);
967 if (ACPI_SUCCESS(status)) {
968 /* If we succeeded, burst flag should now be present. */
969 if (cmd == EC_COMMAND_BURST_ENABLE) {
970 ec_status = EC_GET_CSR(sc);
971 if ((ec_status & EC_FLAG_BURST_MODE) == 0)
975 device_printf(sc->ec_dev, "EcCommand: no response to %#x\n", cmd);
980 EcRead(struct acpi_ec_softc *sc, UINT8 Address, UINT8 *Data)
986 ACPI_SERIAL_ASSERT(ec);
987 CTR1(KTR_ACPI, "ec read from %#x", Address);
989 for (retry = 0; retry < 2; retry++) {
990 status = EcCommand(sc, EC_COMMAND_READ);
991 if (ACPI_FAILURE(status))
994 gen_count = sc->ec_gencount;
995 EC_SET_DATA(sc, Address);
996 status = EcWaitEvent(sc, EC_EVENT_OUTPUT_BUFFER_FULL, gen_count);
997 if (ACPI_SUCCESS(status)) {
998 *Data = EC_GET_DATA(sc);
1001 if (ACPI_FAILURE(EcCheckStatus(sc, "retr_check",
1002 EC_EVENT_INPUT_BUFFER_EMPTY)))
1005 device_printf(sc->ec_dev, "EcRead: failed waiting to get data\n");
1010 EcWrite(struct acpi_ec_softc *sc, UINT8 Address, UINT8 Data)
1015 ACPI_SERIAL_ASSERT(ec);
1016 CTR2(KTR_ACPI, "ec write to %#x, data %#x", Address, Data);
1018 status = EcCommand(sc, EC_COMMAND_WRITE);
1019 if (ACPI_FAILURE(status))
1022 gen_count = sc->ec_gencount;
1023 EC_SET_DATA(sc, Address);
1024 status = EcWaitEvent(sc, EC_EVENT_INPUT_BUFFER_EMPTY, gen_count);
1025 if (ACPI_FAILURE(status)) {
1026 device_printf(sc->ec_dev, "EcWrite: failed waiting for sent address\n");
1030 gen_count = sc->ec_gencount;
1031 EC_SET_DATA(sc, Data);
1032 status = EcWaitEvent(sc, EC_EVENT_INPUT_BUFFER_EMPTY, gen_count);
1033 if (ACPI_FAILURE(status)) {
1034 device_printf(sc->ec_dev, "EcWrite: failed waiting for sent data\n");