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
28 * $FreeBSD: src/sys/dev/acpica/acpi_ec.c,v 1.76.2.1.6.1 2009/04/15 03:14:26 kensmith Exp $
32 #include <sys/param.h>
33 #include <sys/kernel.h>
36 #include <sys/malloc.h>
37 #include <sys/module.h>
41 #include <dev/acpica/acpivar.h>
44 /* Hooks for the ACPI CA debugging infrastructure */
45 #define _COMPONENT ACPI_EC
46 ACPI_MODULE_NAME("EC")
54 typedef UINT8 EC_COMMAND
;
56 #define EC_COMMAND_UNKNOWN ((EC_COMMAND) 0x00)
57 #define EC_COMMAND_READ ((EC_COMMAND) 0x80)
58 #define EC_COMMAND_WRITE ((EC_COMMAND) 0x81)
59 #define EC_COMMAND_BURST_ENABLE ((EC_COMMAND) 0x82)
60 #define EC_COMMAND_BURST_DISABLE ((EC_COMMAND) 0x83)
61 #define EC_COMMAND_QUERY ((EC_COMMAND) 0x84)
66 * The encoding of the EC status register is illustrated below.
67 * Note that a set bit (1) indicates the property is TRUE
68 * (e.g. if bit 0 is set then the output buffer is full).
73 * | | | | | | | +- Output Buffer Full?
74 * | | | | | | +--- Input Buffer Full?
75 * | | | | | +----- <reserved>
76 * | | | | +------- Data Register is Command Byte?
77 * | | | +--------- Burst Mode Enabled?
78 * | | +----------- SCI Event?
79 * | +------------- SMI Event?
80 * +--------------- <reserved>
83 typedef UINT8 EC_STATUS
;
85 #define EC_FLAG_OUTPUT_BUFFER ((EC_STATUS) 0x01)
86 #define EC_FLAG_INPUT_BUFFER ((EC_STATUS) 0x02)
87 #define EC_FLAG_DATA_IS_CMD ((EC_STATUS) 0x08)
88 #define EC_FLAG_BURST_MODE ((EC_STATUS) 0x10)
94 typedef UINT8 EC_EVENT
;
96 #define EC_EVENT_UNKNOWN ((EC_EVENT) 0x00)
97 #define EC_EVENT_OUTPUT_BUFFER_FULL ((EC_EVENT) 0x01)
98 #define EC_EVENT_INPUT_BUFFER_EMPTY ((EC_EVENT) 0x02)
99 #define EC_EVENT_SCI ((EC_EVENT) 0x20)
100 #define EC_EVENT_SMI ((EC_EVENT) 0x40)
102 /* Data byte returned after burst enable indicating it was successful. */
103 #define EC_BURST_ACK 0x90
106 * Register access primitives
108 #define EC_GET_DATA(sc) \
109 bus_space_read_1((sc)->ec_data_tag, (sc)->ec_data_handle, 0)
111 #define EC_SET_DATA(sc, v) \
112 bus_space_write_1((sc)->ec_data_tag, (sc)->ec_data_handle, 0, (v))
114 #define EC_GET_CSR(sc) \
115 bus_space_read_1((sc)->ec_csr_tag, (sc)->ec_csr_handle, 0)
117 #define EC_SET_CSR(sc, v) \
118 bus_space_write_1((sc)->ec_csr_tag, (sc)->ec_csr_handle, 0, (v))
120 /* Additional params to pass from the probe routine */
121 struct acpi_ec_params
{
124 ACPI_HANDLE gpe_handle
;
131 struct acpi_ec_softc
{
133 ACPI_HANDLE ec_handle
;
135 ACPI_HANDLE ec_gpehandle
;
139 struct resource
*ec_data_res
;
140 bus_space_tag_t ec_data_tag
;
141 bus_space_handle_t ec_data_handle
;
144 struct resource
*ec_csr_res
;
145 bus_space_tag_t ec_csr_tag
;
146 bus_space_handle_t ec_csr_handle
;
152 volatile u_int ec_gencount
;
158 * I couldn't find it in the spec but other implementations also use a
159 * value of 1 ms for the time to acquire global lock.
161 #define EC_LOCK_TIMEOUT 1000
163 /* Default delay in microseconds between each run of the status polling loop. */
164 #define EC_POLL_DELAY 50
166 /* Total time in ms spent waiting for a response from EC. */
167 #define EC_TIMEOUT 750
169 #define EVENT_READY(event, status) \
170 (((event) == EC_EVENT_OUTPUT_BUFFER_FULL && \
171 ((status) & EC_FLAG_OUTPUT_BUFFER) != 0) || \
172 ((event) == EC_EVENT_INPUT_BUFFER_EMPTY && \
173 ((status) & EC_FLAG_INPUT_BUFFER) == 0))
175 ACPI_SERIAL_DECL(ec
, "ACPI embedded controller");
177 SYSCTL_NODE(_debug_acpi
, OID_AUTO
, ec
, CTLFLAG_RD
, NULL
, "EC debugging");
179 static int ec_burst_mode
;
180 TUNABLE_INT("debug.acpi.ec.burst", &ec_burst_mode
);
181 SYSCTL_INT(_debug_acpi_ec
, OID_AUTO
, burst
, CTLFLAG_RW
, &ec_burst_mode
, 0,
182 "Enable use of burst mode (faster for nearly all systems)");
183 static int ec_polled_mode
;
184 TUNABLE_INT("debug.acpi.ec.polled", &ec_polled_mode
);
185 SYSCTL_INT(_debug_acpi_ec
, OID_AUTO
, polled
, CTLFLAG_RW
, &ec_polled_mode
, 0,
186 "Force use of polled mode (only if interrupt mode doesn't work)");
187 static int ec_timeout
= EC_TIMEOUT
;
188 TUNABLE_INT("debug.acpi.ec.timeout", &ec_timeout
);
189 SYSCTL_INT(_debug_acpi_ec
, OID_AUTO
, timeout
, CTLFLAG_RW
, &ec_timeout
,
190 EC_TIMEOUT
, "Total time spent waiting for a response (poll+sleep)");
193 EcLock(struct acpi_ec_softc
*sc
)
197 ACPI_SERIAL_BEGIN(ec
);
198 /* If _GLK is non-zero, acquire the global lock. */
201 status
= AcpiAcquireGlobalLock(EC_LOCK_TIMEOUT
, &sc
->ec_glkhandle
);
202 if (ACPI_FAILURE(status
))
209 EcUnlock(struct acpi_ec_softc
*sc
)
212 AcpiReleaseGlobalLock(sc
->ec_glkhandle
);
216 static uint32_t EcGpeHandler(ACPI_HANDLE GpeDevice
,
217 UINT32 GpeNumber
, void *Context
);
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
, NULL
, NULL
);
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
, parent
, 0, "acpi_ec", ecdt
->Uid
);
296 kprintf("%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 kprintf("%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
= kmalloc(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
};
348 /* Check that this is a device and that EC is not disabled. */
349 if (acpi_get_type(dev
) != ACPI_TYPE_DEVICE
|| acpi_disabled("ec"))
353 * If probed via ECDT, set description and continue. Otherwise,
354 * we can access the namespace and make sure this is not a
360 buf
.Length
= ACPI_ALLOCATE_BUFFER
;
361 params
= acpi_get_private(dev
);
362 if (params
!= NULL
) {
365 } else if (ACPI_ID_PROBE(device_get_parent(dev
), dev
, ec_ids
)) {
366 params
= kmalloc(sizeof(struct acpi_ec_params
), M_TEMP
,
368 h
= acpi_get_handle(dev
);
371 * Read the unit ID to check for duplicate attach and the
372 * global lock value to see if we should acquire it when
375 status
= acpi_GetInteger(h
, "_UID", ¶ms
->uid
);
376 if (ACPI_FAILURE(status
))
378 status
= acpi_GetInteger(h
, "_GLK", ¶ms
->glk
);
379 if (ACPI_FAILURE(status
))
383 * Evaluate the _GPE method to find the GPE bit used by the EC to
384 * signal status (SCI). If it's a package, it contains a reference
385 * and GPE bit, similar to _PRW.
387 status
= AcpiEvaluateObject(h
, "_GPE", NULL
, &buf
);
388 if (ACPI_FAILURE(status
)) {
389 device_printf(dev
, "can't evaluate _GPE - %s\n",
390 AcpiFormatException(status
));
393 obj
= (ACPI_OBJECT
*)buf
.Pointer
;
398 case ACPI_TYPE_INTEGER
:
399 params
->gpe_handle
= NULL
;
400 params
->gpe_bit
= obj
->Integer
.Value
;
402 case ACPI_TYPE_PACKAGE
:
403 if (!ACPI_PKG_VALID(obj
, 2))
406 acpi_GetReference(NULL
, &obj
->Package
.Elements
[0]);
407 if (params
->gpe_handle
== NULL
||
408 acpi_PkgInt32(obj
, 1, ¶ms
->gpe_bit
) != 0)
412 device_printf(dev
, "_GPE has invalid type %d\n", obj
->Type
);
416 /* Store the values we got from the namespace for attach. */
417 acpi_set_private(dev
, params
);
420 * Check for a duplicate probe. This can happen when a probe
421 * via ECDT succeeded already. If this is a duplicate, disable
424 peer
= devclass_get_device(acpi_ec_devclass
, params
->uid
);
425 if (peer
== NULL
|| !device_is_alive(peer
))
433 ksnprintf(desc
, sizeof(desc
), "Embedded Controller: GPE %#x%s%s",
434 params
->gpe_bit
, (params
->glk
) ? ", GLK" : "",
435 ecdt
? ", ECDT" : "");
436 device_set_desc_copy(dev
, desc
);
439 if (ret
> 0 && params
)
440 kfree(params
, M_TEMP
);
442 AcpiOsFree(buf
.Pointer
);
447 acpi_ec_attach(device_t dev
)
449 struct acpi_ec_softc
*sc
;
450 struct acpi_ec_params
*params
;
453 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__
);
455 /* Fetch/initialize softc (assumes softc is pre-zeroed). */
456 sc
= device_get_softc(dev
);
457 params
= acpi_get_private(dev
);
459 sc
->ec_handle
= acpi_get_handle(dev
);
460 ACPI_SERIAL_INIT(ec
);
462 /* Retrieve previously probed values via device ivars. */
463 sc
->ec_glk
= params
->glk
;
464 sc
->ec_gpebit
= params
->gpe_bit
;
465 sc
->ec_gpehandle
= params
->gpe_handle
;
466 sc
->ec_uid
= params
->uid
;
467 sc
->ec_suspending
= FALSE
;
468 acpi_set_private(dev
, NULL
);
469 kfree(params
, M_TEMP
);
471 /* Attach bus resources for data and command/status ports. */
473 sc
->ec_data_res
= bus_alloc_resource_any(sc
->ec_dev
, SYS_RES_IOPORT
,
474 &sc
->ec_data_rid
, RF_ACTIVE
);
475 if (sc
->ec_data_res
== NULL
) {
476 device_printf(dev
, "can't allocate data port\n");
479 sc
->ec_data_tag
= rman_get_bustag(sc
->ec_data_res
);
480 sc
->ec_data_handle
= rman_get_bushandle(sc
->ec_data_res
);
483 sc
->ec_csr_res
= bus_alloc_resource_any(sc
->ec_dev
, SYS_RES_IOPORT
,
484 &sc
->ec_csr_rid
, RF_ACTIVE
);
485 if (sc
->ec_csr_res
== NULL
) {
486 device_printf(dev
, "can't allocate command/status port\n");
489 sc
->ec_csr_tag
= rman_get_bustag(sc
->ec_csr_res
);
490 sc
->ec_csr_handle
= rman_get_bushandle(sc
->ec_csr_res
);
493 * Install a handler for this EC's GPE bit. We want edge-triggered
496 ACPI_DEBUG_PRINT((ACPI_DB_RESOURCES
, "attaching GPE handler\n"));
497 Status
= AcpiInstallGpeHandler(sc
->ec_gpehandle
, sc
->ec_gpebit
,
498 ACPI_GPE_EDGE_TRIGGERED
, &EcGpeHandler
, sc
);
499 if (ACPI_FAILURE(Status
)) {
500 device_printf(dev
, "can't install GPE handler for %s - %s\n",
501 acpi_name(sc
->ec_handle
), AcpiFormatException(Status
));
506 * Install address space handler
508 ACPI_DEBUG_PRINT((ACPI_DB_RESOURCES
, "attaching address space handler\n"));
509 Status
= AcpiInstallAddressSpaceHandler(sc
->ec_handle
, ACPI_ADR_SPACE_EC
,
510 &EcSpaceHandler
, &EcSpaceSetup
, sc
);
511 if (ACPI_FAILURE(Status
)) {
512 device_printf(dev
, "can't install address space handler for %s - %s\n",
513 acpi_name(sc
->ec_handle
), AcpiFormatException(Status
));
517 /* Enable runtime GPEs for the handler */
518 Status
= AcpiEnableGpe(sc
->ec_gpehandle
, sc
->ec_gpebit
);
519 if (ACPI_FAILURE(Status
)) {
520 device_printf(dev
, "AcpiEnableGpe failed: %s\n",
521 AcpiFormatException(Status
));
525 ACPI_DEBUG_PRINT((ACPI_DB_RESOURCES
, "acpi_ec_attach complete\n"));
529 AcpiRemoveGpeHandler(sc
->ec_gpehandle
, sc
->ec_gpebit
, &EcGpeHandler
);
530 AcpiRemoveAddressSpaceHandler(sc
->ec_handle
, ACPI_ADR_SPACE_EC
,
533 bus_release_resource(sc
->ec_dev
, SYS_RES_IOPORT
, sc
->ec_csr_rid
,
536 bus_release_resource(sc
->ec_dev
, SYS_RES_IOPORT
, sc
->ec_data_rid
,
542 acpi_ec_suspend(device_t dev
)
544 struct acpi_ec_softc
*sc
;
546 sc
= device_get_softc(dev
);
547 sc
->ec_suspending
= TRUE
;
552 acpi_ec_resume(device_t dev
)
554 struct acpi_ec_softc
*sc
;
556 sc
= device_get_softc(dev
);
557 sc
->ec_suspending
= FALSE
;
562 acpi_ec_shutdown(device_t dev
)
564 struct acpi_ec_softc
*sc
;
566 /* Disable the GPE so we don't get EC events during shutdown. */
567 sc
= device_get_softc(dev
);
568 AcpiDisableGpe(sc
->ec_gpehandle
, sc
->ec_gpebit
);
572 /* Methods to allow other devices (e.g., smbat) to read/write EC space. */
574 acpi_ec_read_method(device_t dev
, u_int addr
, UINT64
*val
, int width
)
576 struct acpi_ec_softc
*sc
;
579 sc
= device_get_softc(dev
);
580 status
= EcSpaceHandler(ACPI_READ
, addr
, width
* 8, val
, sc
, NULL
);
581 if (ACPI_FAILURE(status
))
587 acpi_ec_write_method(device_t dev
, u_int addr
, UINT64 val
, int width
)
589 struct acpi_ec_softc
*sc
;
592 sc
= device_get_softc(dev
);
593 status
= EcSpaceHandler(ACPI_WRITE
, addr
, width
* 8, &val
, sc
, NULL
);
594 if (ACPI_FAILURE(status
))
600 EcCheckStatus(struct acpi_ec_softc
*sc
, const char *msg
, EC_EVENT event
)
605 status
= AE_NO_HARDWARE_RESPONSE
;
606 ec_status
= EC_GET_CSR(sc
);
607 if (sc
->ec_burstactive
&& !(ec_status
& EC_FLAG_BURST_MODE
)) {
608 sc
->ec_burstactive
= FALSE
;
610 if (EVENT_READY(event
, ec_status
)) {
617 EcGpeQueryHandler(void *Context
)
619 struct acpi_ec_softc
*sc
= (struct acpi_ec_softc
*)Context
;
622 int retry
, sci_enqueued
;
625 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__
);
626 KASSERT(Context
!= NULL
, ("EcGpeQueryHandler called with NULL"));
628 /* Serialize user access with EcSpaceHandler(). */
630 if (ACPI_FAILURE(Status
)) {
631 device_printf(sc
->ec_dev
, "GpeQuery lock error: %s\n",
632 AcpiFormatException(Status
));
637 * Send a query command to the EC to find out which _Qxx call it
638 * wants to make. This command clears the SCI bit and also the
639 * interrupt source since we are edge-triggered. To prevent the GPE
640 * that may arise from running the query from causing another query
641 * to be queued, we clear the pending flag only after running it.
643 sci_enqueued
= sc
->ec_sci_pend
;
644 for (retry
= 0; retry
< 2; retry
++) {
645 Status
= EcCommand(sc
, EC_COMMAND_QUERY
);
646 if (ACPI_SUCCESS(Status
))
648 if (EcCheckStatus(sc
, "retr_check",
649 EC_EVENT_INPUT_BUFFER_EMPTY
) == AE_OK
)
654 sc
->ec_sci_pend
= FALSE
;
655 if (ACPI_FAILURE(Status
)) {
657 device_printf(sc
->ec_dev
, "GPE query failed: %s\n",
658 AcpiFormatException(Status
));
661 Data
= EC_GET_DATA(sc
);
664 * We have to unlock before running the _Qxx method below since that
665 * method may attempt to read/write from EC address space, causing
666 * recursive acquisition of the lock.
670 /* Ignore the value for "no outstanding event". (13.3.5) */
674 /* Evaluate _Qxx to respond to the controller. */
675 ksnprintf(qxx
, sizeof(qxx
), "_Q%02X", Data
);
677 Status
= AcpiEvaluateObject(sc
->ec_handle
, qxx
, NULL
, NULL
);
678 if (ACPI_FAILURE(Status
) && Status
!= AE_NOT_FOUND
) {
679 device_printf(sc
->ec_dev
, "evaluation of query method %s failed: %s\n",
680 qxx
, AcpiFormatException(Status
));
683 /* Reenable runtime GPE if its execution was deferred. */
685 Status
= AcpiFinishGpe(sc
->ec_gpehandle
, sc
->ec_gpebit
);
686 if (ACPI_FAILURE(Status
))
687 device_printf(sc
->ec_dev
, "reenabling runtime GPE failed: %s\n",
688 AcpiFormatException(Status
));
693 * The GPE handler is called when IBE/OBF or SCI events occur. We are
694 * called from an unknown lock context.
697 EcGpeHandler(ACPI_HANDLE GpeDevice
, UINT32 GpeNumber
, void *Context
)
699 struct acpi_ec_softc
*sc
= Context
;
703 KASSERT(Context
!= NULL
, ("EcGpeHandler called with NULL"));
705 * Notify EcWaitEvent() that the status register is now fresh. If we
706 * didn't do this, it wouldn't be possible to distinguish an old IBE
707 * from a new one, for example when doing a write transaction (writing
708 * address and then data values.)
710 atomic_add_int(&sc
->ec_gencount
, 1);
714 * If the EC_SCI bit of the status register is set, queue a query handler.
715 * It will run the query and _Qxx method later, under the lock.
717 EcStatus
= EC_GET_CSR(sc
);
718 if ((EcStatus
& EC_EVENT_SCI
) && !sc
->ec_sci_pend
) {
719 Status
= AcpiOsExecute(OSL_GPE_HANDLER
, EcGpeQueryHandler
, Context
);
720 if (ACPI_SUCCESS(Status
)) {
721 sc
->ec_sci_pend
= TRUE
;
724 kprintf("EcGpeHandler: queuing GPE query handler failed\n");
727 return (ACPI_REENABLE_GPE
);
731 EcSpaceSetup(ACPI_HANDLE Region
, UINT32 Function
, void *Context
,
732 void **RegionContext
)
735 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__
);
738 * If deactivating a region, always set the output to NULL. Otherwise,
739 * just pass the context through.
741 if (Function
== ACPI_REGION_DEACTIVATE
)
742 *RegionContext
= NULL
;
744 *RegionContext
= Context
;
746 return_ACPI_STATUS (AE_OK
);
750 EcSpaceHandler(UINT32 Function
, ACPI_PHYSICAL_ADDRESS Address
, UINT32 Width
,
751 UINT64
*Value
, void *Context
, void *RegionContext
)
753 struct acpi_ec_softc
*sc
= (struct acpi_ec_softc
*)Context
;
754 ACPI_PHYSICAL_ADDRESS EcAddr
;
758 ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__
, (UINT32
)Address
);
760 if (Function
!= ACPI_READ
&& Function
!= ACPI_WRITE
)
761 return_ACPI_STATUS (AE_BAD_PARAMETER
);
762 if (Width
% 8 != 0 || Value
== NULL
|| Context
== NULL
)
763 return_ACPI_STATUS (AE_BAD_PARAMETER
);
764 if (Address
+ Width
/ 8 > 256)
765 return_ACPI_STATUS (AE_BAD_ADDRESS
);
768 * If booting, check if we need to run the query handler. If so, we
769 * we call it directly here since our thread taskq is not active yet.
771 if (cold
|| rebooting
|| sc
->ec_suspending
) {
772 if ((EC_GET_CSR(sc
) & EC_EVENT_SCI
)) {
773 EcGpeQueryHandler(sc
);
777 /* Serialize with EcGpeQueryHandler() at transaction granularity. */
779 if (ACPI_FAILURE(Status
))
780 return_ACPI_STATUS (Status
);
782 /* If we can't start burst mode, continue anyway. */
783 Status
= EcCommand(sc
, EC_COMMAND_BURST_ENABLE
);
784 if (ACPI_SUCCESS(Status
)) {
785 if (EC_GET_DATA(sc
) == EC_BURST_ACK
) {
786 sc
->ec_burstactive
= TRUE
;
790 /* Perform the transaction(s), based on Width. */
792 EcData
= (UINT8
*)Value
;
793 if (Function
== ACPI_READ
)
798 Status
= EcRead(sc
, EcAddr
, EcData
);
801 Status
= EcWrite(sc
, EcAddr
, *EcData
);
804 if (ACPI_FAILURE(Status
))
808 } while (EcAddr
< Address
+ Width
/ 8);
810 if (sc
->ec_burstactive
) {
811 sc
->ec_burstactive
= FALSE
;
812 if (ACPI_SUCCESS(EcCommand(sc
, EC_COMMAND_BURST_DISABLE
))) {
817 return_ACPI_STATUS (Status
);
821 EcWaitEvent(struct acpi_ec_softc
*sc
, EC_EVENT Event
, u_int gen_count
)
823 static int no_intr
= 0;
825 int count
, i
, need_poll
, slp_ival
;
827 ACPI_SERIAL_ASSERT(ec
);
828 Status
= AE_NO_HARDWARE_RESPONSE
;
829 need_poll
= cold
|| rebooting
|| ec_polled_mode
|| sc
->ec_suspending
;
831 /* Wait for event by polling or GPE (interrupt). */
833 count
= (ec_timeout
* 1000) / EC_POLL_DELAY
;
837 for (i
= 0; i
< count
; i
++) {
838 Status
= EcCheckStatus(sc
, "poll", Event
);
841 DELAY(EC_POLL_DELAY
);
844 slp_ival
= hz
/ 1000;
848 /* hz has less than 1 ms resolution so scale timeout. */
850 count
= ec_timeout
/ (1000 / hz
);
854 * Wait for the GPE to signal the status changed, checking the
855 * status register each time we get one. It's possible to get a
856 * GPE for an event we're not interested in here (i.e., SCI for
859 for (i
= 0; i
< count
; i
++) {
860 if (gen_count
== sc
->ec_gencount
)
861 tsleep(sc
, 0, "ecgpe", slp_ival
);
863 * Record new generation count. It's possible the GPE was
864 * just to notify us that a query is needed and we need to
865 * wait for a second GPE to signal the completion of the
866 * event we are actually waiting for.
868 Status
= EcCheckStatus(sc
, "sleep", Event
);
869 if (Status
== AE_OK
) {
870 if (gen_count
== sc
->ec_gencount
)
876 gen_count
= sc
->ec_gencount
;
880 * We finished waiting for the GPE and it never arrived. Try to
881 * read the register once and trust whatever value we got. This is
882 * the best we can do at this point.
885 Status
= EcCheckStatus(sc
, "sleep_end", Event
);
887 if (!need_poll
&& no_intr
> 10) {
888 device_printf(sc
->ec_dev
,
889 "not getting interrupts, switched to polled mode\n");
896 EcCommand(struct acpi_ec_softc
*sc
, EC_COMMAND cmd
)
903 ACPI_SERIAL_ASSERT(ec
);
905 /* Don't use burst mode if user disabled it. */
906 if (!ec_burst_mode
&& cmd
== EC_COMMAND_BURST_ENABLE
)
909 /* Decide what to wait for based on command type. */
911 case EC_COMMAND_READ
:
912 case EC_COMMAND_WRITE
:
913 case EC_COMMAND_BURST_DISABLE
:
914 event
= EC_EVENT_INPUT_BUFFER_EMPTY
;
916 case EC_COMMAND_QUERY
:
917 case EC_COMMAND_BURST_ENABLE
:
918 event
= EC_EVENT_OUTPUT_BUFFER_FULL
;
921 device_printf(sc
->ec_dev
, "EcCommand: invalid command %#x\n", cmd
);
922 return (AE_BAD_PARAMETER
);
926 * Ensure empty input buffer before issuing command.
927 * Use generation count of zero to force a quick check.
929 status
= EcWaitEvent(sc
, EC_EVENT_INPUT_BUFFER_EMPTY
, 0);
930 if (ACPI_FAILURE(status
))
933 /* Run the command and wait for the chosen event. */
934 gen_count
= sc
->ec_gencount
;
936 status
= EcWaitEvent(sc
, event
, gen_count
);
937 if (ACPI_SUCCESS(status
)) {
938 /* If we succeeded, burst flag should now be present. */
939 if (cmd
== EC_COMMAND_BURST_ENABLE
) {
940 ec_status
= EC_GET_CSR(sc
);
941 if ((ec_status
& EC_FLAG_BURST_MODE
) == 0)
945 device_printf(sc
->ec_dev
, "EcCommand: no response to %#x\n", cmd
);
950 EcRead(struct acpi_ec_softc
*sc
, UINT8 Address
, UINT8
*Data
)
956 ACPI_SERIAL_ASSERT(ec
);
958 for (retry
= 0; retry
< 2; retry
++) {
959 status
= EcCommand(sc
, EC_COMMAND_READ
);
960 if (ACPI_FAILURE(status
))
963 gen_count
= sc
->ec_gencount
;
964 EC_SET_DATA(sc
, Address
);
965 status
= EcWaitEvent(sc
, EC_EVENT_OUTPUT_BUFFER_FULL
, gen_count
);
966 if (ACPI_FAILURE(status
)) {
967 if (EcCheckStatus(sc
, "retr_check",
968 EC_EVENT_INPUT_BUFFER_EMPTY
) == AE_OK
)
973 *Data
= EC_GET_DATA(sc
);
976 device_printf(sc
->ec_dev
, "EcRead: failed waiting to get data\n");
981 EcWrite(struct acpi_ec_softc
*sc
, UINT8 Address
, UINT8 Data
)
986 ACPI_SERIAL_ASSERT(ec
);
988 status
= EcCommand(sc
, EC_COMMAND_WRITE
);
989 if (ACPI_FAILURE(status
))
992 gen_count
= sc
->ec_gencount
;
993 EC_SET_DATA(sc
, Address
);
994 status
= EcWaitEvent(sc
, EC_EVENT_INPUT_BUFFER_EMPTY
, gen_count
);
995 if (ACPI_FAILURE(status
)) {
996 device_printf(sc
->ec_dev
, "EcWrite: failed waiting for sent address\n");
1000 gen_count
= sc
->ec_gencount
;
1001 EC_SET_DATA(sc
, Data
);
1002 status
= EcWaitEvent(sc
, EC_EVENT_INPUT_BUFFER_EMPTY
, gen_count
);
1003 if (ACPI_FAILURE(status
)) {
1004 device_printf(sc
->ec_dev
, "EcWrite: failed waiting for sent data\n");