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
27 * __FBSDID("$FreeBSD: src/sys/dev/acpica/acpi_ec.c,v 1.76.2.1.6.1 2009/04/15 03:14:26 kensmith Exp $");
30 #include <sys/cdefs.h>
33 #include <sys/param.h>
34 #include <sys/kernel.h>
37 #include <sys/malloc.h>
38 #include <sys/module.h>
42 #include <dev/acpica5/acpivar.h>
45 /* Hooks for the ACPI CA debugging infrastructure */
46 #define _COMPONENT ACPI_EC
47 ACPI_MODULE_NAME("EC")
55 typedef UINT8 EC_COMMAND
;
57 #define EC_COMMAND_UNKNOWN ((EC_COMMAND) 0x00)
58 #define EC_COMMAND_READ ((EC_COMMAND) 0x80)
59 #define EC_COMMAND_WRITE ((EC_COMMAND) 0x81)
60 #define EC_COMMAND_BURST_ENABLE ((EC_COMMAND) 0x82)
61 #define EC_COMMAND_BURST_DISABLE ((EC_COMMAND) 0x83)
62 #define EC_COMMAND_QUERY ((EC_COMMAND) 0x84)
67 * The encoding of the EC status register is illustrated below.
68 * Note that a set bit (1) indicates the property is TRUE
69 * (e.g. if bit 0 is set then the output buffer is full).
74 * | | | | | | | +- Output Buffer Full?
75 * | | | | | | +--- Input Buffer Full?
76 * | | | | | +----- <reserved>
77 * | | | | +------- Data Register is Command Byte?
78 * | | | +--------- Burst Mode Enabled?
79 * | | +----------- SCI Event?
80 * | +------------- SMI Event?
81 * +--------------- <reserved>
84 typedef UINT8 EC_STATUS
;
86 #define EC_FLAG_OUTPUT_BUFFER ((EC_STATUS) 0x01)
87 #define EC_FLAG_INPUT_BUFFER ((EC_STATUS) 0x02)
88 #define EC_FLAG_DATA_IS_CMD ((EC_STATUS) 0x08)
89 #define EC_FLAG_BURST_MODE ((EC_STATUS) 0x10)
95 typedef UINT8 EC_EVENT
;
97 #define EC_EVENT_UNKNOWN ((EC_EVENT) 0x00)
98 #define EC_EVENT_OUTPUT_BUFFER_FULL ((EC_EVENT) 0x01)
99 #define EC_EVENT_INPUT_BUFFER_EMPTY ((EC_EVENT) 0x02)
100 #define EC_EVENT_SCI ((EC_EVENT) 0x20)
101 #define EC_EVENT_SMI ((EC_EVENT) 0x40)
103 /* Data byte returned after burst enable indicating it was successful. */
104 #define EC_BURST_ACK 0x90
107 * Register access primitives
109 #define EC_GET_DATA(sc) \
110 bus_space_read_1((sc)->ec_data_tag, (sc)->ec_data_handle, 0)
112 #define EC_SET_DATA(sc, v) \
113 bus_space_write_1((sc)->ec_data_tag, (sc)->ec_data_handle, 0, (v))
115 #define EC_GET_CSR(sc) \
116 bus_space_read_1((sc)->ec_csr_tag, (sc)->ec_csr_handle, 0)
118 #define EC_SET_CSR(sc, v) \
119 bus_space_write_1((sc)->ec_csr_tag, (sc)->ec_csr_handle, 0, (v))
121 /* Additional params to pass from the probe routine */
122 struct acpi_ec_params
{
125 ACPI_HANDLE gpe_handle
;
129 /* Indicate that this device has already been probed via ECDT. */
130 #define DEV_ECDT(x) (acpi_get_magic(x) == (uintptr_t)&acpi_ec_devclass)
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
;
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 5
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_DECL(_debug_acpi
);
182 SYSCTL_NODE(_debug_acpi
, OID_AUTO
, ec
, CTLFLAG_RD
, NULL
, "EC debugging");
184 static int ec_burst_mode
;
185 TUNABLE_INT("debug.acpi.ec.burst", &ec_burst_mode
);
186 SYSCTL_INT(_debug_acpi_ec
, OID_AUTO
, burst
, CTLFLAG_RW
, &ec_burst_mode
, 0,
187 "Enable use of burst mode (faster for nearly all systems)");
188 static int ec_polled_mode
;
189 TUNABLE_INT("debug.acpi.ec.polled", &ec_polled_mode
);
190 SYSCTL_INT(_debug_acpi_ec
, OID_AUTO
, polled
, CTLFLAG_RW
, &ec_polled_mode
, 0,
191 "Force use of polled mode (only if interrupt mode doesn't work)");
192 static int ec_timeout
= EC_TIMEOUT
;
193 TUNABLE_INT("debug.acpi.ec.timeout", &ec_timeout
);
194 SYSCTL_INT(_debug_acpi_ec
, OID_AUTO
, timeout
, CTLFLAG_RW
, &ec_timeout
,
195 EC_TIMEOUT
, "Total time spent waiting for a response (poll+sleep)");
198 EcLock(struct acpi_ec_softc
*sc
)
202 /* If _GLK is non-zero, acquire the global lock. */
205 status
= AcpiAcquireGlobalLock(EC_LOCK_TIMEOUT
, &sc
->ec_glkhandle
);
206 if (ACPI_FAILURE(status
))
209 ACPI_SERIAL_BEGIN(ec
);
214 EcUnlock(struct acpi_ec_softc
*sc
)
218 AcpiReleaseGlobalLock(sc
->ec_glkhandle
);
221 static uint32_t EcGpeHandler(void *Context
);
222 static ACPI_STATUS
EcSpaceSetup(ACPI_HANDLE Region
, UINT32 Function
,
223 void *Context
, void **return_Context
);
224 static ACPI_STATUS
EcSpaceHandler(UINT32 Function
,
225 ACPI_PHYSICAL_ADDRESS Address
,
226 UINT32 width
, ACPI_INTEGER
*Value
,
227 void *Context
, void *RegionContext
);
228 static ACPI_STATUS
EcWaitEvent(struct acpi_ec_softc
*sc
, EC_EVENT Event
,
230 static ACPI_STATUS
EcCommand(struct acpi_ec_softc
*sc
, EC_COMMAND cmd
);
231 static ACPI_STATUS
EcRead(struct acpi_ec_softc
*sc
, UINT8 Address
,
233 static ACPI_STATUS
EcWrite(struct acpi_ec_softc
*sc
, UINT8 Address
,
235 static int acpi_ec_probe(device_t dev
);
236 static int acpi_ec_attach(device_t dev
);
237 static int acpi_ec_suspend(device_t dev
);
238 static int acpi_ec_resume(device_t dev
);
239 static int acpi_ec_shutdown(device_t dev
);
240 static int acpi_ec_read_method(device_t dev
, u_int addr
,
241 ACPI_INTEGER
*val
, int width
);
242 static int acpi_ec_write_method(device_t dev
, u_int addr
,
243 ACPI_INTEGER val
, int width
);
245 static device_method_t acpi_ec_methods
[] = {
246 /* Device interface */
247 DEVMETHOD(device_probe
, acpi_ec_probe
),
248 DEVMETHOD(device_attach
, acpi_ec_attach
),
249 DEVMETHOD(device_suspend
, acpi_ec_suspend
),
250 DEVMETHOD(device_resume
, acpi_ec_resume
),
251 DEVMETHOD(device_shutdown
, acpi_ec_shutdown
),
253 /* Embedded controller interface */
254 DEVMETHOD(acpi_ec_read
, acpi_ec_read_method
),
255 DEVMETHOD(acpi_ec_write
, acpi_ec_write_method
),
260 static driver_t acpi_ec_driver
= {
263 sizeof(struct acpi_ec_softc
),
266 static devclass_t acpi_ec_devclass
;
267 DRIVER_MODULE(acpi_ec
, acpi
, acpi_ec_driver
, acpi_ec_devclass
, 0, 0);
268 MODULE_DEPEND(acpi_ec
, acpi
, 1, 1, 1);
271 * Look for an ECDT and if we find one, set up default GPE and
272 * space handlers to catch attempts to access EC space before
273 * we have a real driver instance in place.
275 * TODO: Some old Gateway laptops need us to fake up an ECDT or
276 * otherwise attach early so that _REG methods can run.
279 acpi_ec_ecdt_probe(device_t parent
)
281 ACPI_TABLE_ECDT
*ecdt
;
285 struct acpi_ec_params
*params
;
287 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__
);
289 /* Find and validate the ECDT. */
290 status
= AcpiGetTable(ACPI_SIG_ECDT
, 1, (ACPI_TABLE_HEADER
**)&ecdt
);
291 if (ACPI_FAILURE(status
) ||
292 ecdt
->Control
.BitWidth
!= 8 ||
293 ecdt
->Data
.BitWidth
!= 8) {
297 /* Create the child device with the given unit number. */
298 child
= BUS_ADD_CHILD(parent
, parent
, 0, "acpi_ec", ecdt
->Uid
);
300 kprintf("%s: can't add child\n", __func__
);
304 /* Find and save the ACPI handle for this device. */
305 status
= AcpiGetHandle(NULL
, ecdt
->Id
, &h
);
306 if (ACPI_FAILURE(status
)) {
307 device_delete_child(parent
, child
);
308 kprintf("%s: can't get handle\n", __func__
);
311 acpi_set_handle(child
, h
);
313 /* Set the data and CSR register addresses. */
314 bus_set_resource(child
, SYS_RES_IOPORT
, 0, ecdt
->Data
.Address
,
316 bus_set_resource(child
, SYS_RES_IOPORT
, 1, ecdt
->Control
.Address
,
320 * Store values for the probe/attach routines to use. Store the
321 * ECDT GPE bit and set the global lock flag according to _GLK.
322 * Note that it is not perfectly correct to be evaluating a method
323 * before initializing devices, but in practice this function
324 * should be safe to call at this point.
326 params
= kmalloc(sizeof(struct acpi_ec_params
), M_TEMP
, M_WAITOK
| M_ZERO
);
327 params
->gpe_handle
= NULL
;
328 params
->gpe_bit
= ecdt
->Gpe
;
329 params
->uid
= ecdt
->Uid
;
330 acpi_GetInteger(h
, "_GLK", ¶ms
->glk
);
331 acpi_set_private(child
, params
);
332 acpi_set_magic(child
, (uintptr_t)&acpi_ec_devclass
);
334 /* Finish the attach process. */
335 if (device_probe_and_attach(child
) != 0)
336 device_delete_child(parent
, child
);
340 acpi_ec_probe(device_t dev
)
349 struct acpi_ec_params
*params
;
350 static char *ec_ids
[] = { "PNP0C09", NULL
};
352 /* Check that this is a device and that EC is not disabled. */
353 if (acpi_get_type(dev
) != ACPI_TYPE_DEVICE
|| acpi_disabled("ec"))
357 * If probed via ECDT, set description and continue. Otherwise,
358 * we can access the namespace and make sure this is not a
364 buf
.Length
= ACPI_ALLOCATE_BUFFER
;
366 params
= acpi_get_private(dev
);
368 } else if (!acpi_disabled("ec") &&
369 ACPI_ID_PROBE(device_get_parent(dev
), dev
, ec_ids
)) {
370 params
= kmalloc(sizeof(struct acpi_ec_params
), M_TEMP
,
372 h
= acpi_get_handle(dev
);
375 * Read the unit ID to check for duplicate attach and the
376 * global lock value to see if we should acquire it when
379 status
= acpi_GetInteger(h
, "_UID", ¶ms
->uid
);
380 if (ACPI_FAILURE(status
))
382 status
= acpi_GetInteger(h
, "_GLK", ¶ms
->glk
);
383 if (ACPI_FAILURE(status
))
387 * Evaluate the _GPE method to find the GPE bit used by the EC to
388 * signal status (SCI). If it's a package, it contains a reference
389 * and GPE bit, similar to _PRW.
391 status
= AcpiEvaluateObject(h
, "_GPE", NULL
, &buf
);
392 if (ACPI_FAILURE(status
)) {
393 device_printf(dev
, "can't evaluate _GPE - %s\n",
394 AcpiFormatException(status
));
397 obj
= (ACPI_OBJECT
*)buf
.Pointer
;
402 case ACPI_TYPE_INTEGER
:
403 params
->gpe_handle
= NULL
;
404 params
->gpe_bit
= obj
->Integer
.Value
;
406 case ACPI_TYPE_PACKAGE
:
407 if (!ACPI_PKG_VALID(obj
, 2))
410 acpi_GetReference(NULL
, &obj
->Package
.Elements
[0]);
411 if (params
->gpe_handle
== NULL
||
412 acpi_PkgInt32(obj
, 1, ¶ms
->gpe_bit
) != 0)
416 device_printf(dev
, "_GPE has invalid type %d\n", obj
->Type
);
420 /* Store the values we got from the namespace for attach. */
421 acpi_set_private(dev
, params
);
424 * Check for a duplicate probe. This can happen when a probe
425 * via ECDT succeeded already. If this is a duplicate, disable
428 peer
= devclass_get_device(acpi_ec_devclass
, params
->uid
);
429 if (peer
== NULL
|| !device_is_alive(peer
))
437 ksnprintf(desc
, sizeof(desc
), "Embedded Controller: GPE %#x%s%s",
438 params
->gpe_bit
, (params
->glk
) ? ", GLK" : "",
439 DEV_ECDT(dev
) ? ", ECDT" : "");
440 device_set_desc_copy(dev
, desc
);
443 if (ret
> 0 && params
)
444 kfree(params
, M_TEMP
);
446 AcpiOsFree(buf
.Pointer
);
451 acpi_ec_attach(device_t dev
)
453 struct acpi_ec_softc
*sc
;
454 struct acpi_ec_params
*params
;
457 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__
);
459 /* Fetch/initialize softc (assumes softc is pre-zeroed). */
460 sc
= device_get_softc(dev
);
461 params
= acpi_get_private(dev
);
463 sc
->ec_handle
= acpi_get_handle(dev
);
465 /* Retrieve previously probed values via device ivars. */
466 sc
->ec_glk
= params
->glk
;
467 sc
->ec_gpebit
= params
->gpe_bit
;
468 sc
->ec_gpehandle
= params
->gpe_handle
;
469 sc
->ec_uid
= params
->uid
;
470 sc
->ec_suspending
= FALSE
;
471 kfree(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
= AcpiSetGpeType(sc
->ec_gpehandle
, sc
->ec_gpebit
,
521 ACPI_GPE_TYPE_RUNTIME
);
522 if (ACPI_FAILURE(Status
)) {
523 device_printf(dev
, "AcpiSetGpeType failed: %s\n",
524 AcpiFormatException(Status
));
527 Status
= AcpiEnableGpe(sc
->ec_gpehandle
, sc
->ec_gpebit
, ACPI_NOT_ISR
);
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
, ACPI_NOT_ISR
);
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
, ACPI_INTEGER
*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
, ACPI_INTEGER 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 EcGpeQueryHandler(void *Context
)
611 struct acpi_ec_softc
*sc
= (struct acpi_ec_softc
*)Context
;
616 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__
);
617 KASSERT(Context
!= NULL
, ("EcGpeQueryHandler called with NULL"));
619 /* Serialize user access with EcSpaceHandler(). */
621 if (ACPI_FAILURE(Status
)) {
622 device_printf(sc
->ec_dev
, "GpeQuery lock error: %s\n",
623 AcpiFormatException(Status
));
628 * Send a query command to the EC to find out which _Qxx call it
629 * wants to make. This command clears the SCI bit and also the
630 * interrupt source since we are edge-triggered. To prevent the GPE
631 * that may arise from running the query from causing another query
632 * to be queued, we clear the pending flag only after running it.
634 Status
= EcCommand(sc
, EC_COMMAND_QUERY
);
635 sc
->ec_sci_pend
= FALSE
;
636 if (ACPI_FAILURE(Status
)) {
638 device_printf(sc
->ec_dev
, "GPE query failed: %s\n",
639 AcpiFormatException(Status
));
642 Data
= EC_GET_DATA(sc
);
645 * We have to unlock before running the _Qxx method below since that
646 * method may attempt to read/write from EC address space, causing
647 * recursive acquisition of the lock.
651 /* Ignore the value for "no outstanding event". (13.3.5) */
653 CTR2(KTR_ACPI
, "ec query ok,%s running _Q%02X", Data
? "" : " not", Data
);
658 /* Evaluate _Qxx to respond to the controller. */
659 ksnprintf(qxx
, sizeof(qxx
), "_Q%02X", Data
);
661 Status
= AcpiEvaluateObject(sc
->ec_handle
, qxx
, NULL
, NULL
);
662 if (ACPI_FAILURE(Status
) && Status
!= AE_NOT_FOUND
) {
663 device_printf(sc
->ec_dev
, "evaluation of query method %s failed: %s\n",
664 qxx
, AcpiFormatException(Status
));
669 * The GPE handler is called when IBE/OBF or SCI events occur. We are
670 * called from an unknown lock context.
673 EcGpeHandler(void *Context
)
675 struct acpi_ec_softc
*sc
= Context
;
679 KASSERT(Context
!= NULL
, ("EcGpeHandler called with NULL"));
681 CTR0(KTR_ACPI
, "ec gpe handler start");
684 * Notify EcWaitEvent() that the status register is now fresh. If we
685 * didn't do this, it wouldn't be possible to distinguish an old IBE
686 * from a new one, for example when doing a write transaction (writing
687 * address and then data values.)
689 atomic_add_int(&sc
->ec_gencount
, 1);
690 wakeup(&sc
->ec_gencount
);
693 * If the EC_SCI bit of the status register is set, queue a query handler.
694 * It will run the query and _Qxx method later, under the lock.
696 EcStatus
= EC_GET_CSR(sc
);
697 if ((EcStatus
& EC_EVENT_SCI
) && !sc
->ec_sci_pend
) {
699 CTR0(KTR_ACPI
, "ec gpe queueing query handler");
701 Status
= AcpiOsExecute(OSL_GPE_HANDLER
, EcGpeQueryHandler
, Context
);
702 if (ACPI_SUCCESS(Status
))
703 sc
->ec_sci_pend
= TRUE
;
705 kprintf("EcGpeHandler: queuing GPE query handler failed\n");
711 EcSpaceSetup(ACPI_HANDLE Region
, UINT32 Function
, void *Context
,
712 void **RegionContext
)
715 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__
);
718 * If deactivating a region, always set the output to NULL. Otherwise,
719 * just pass the context through.
721 if (Function
== ACPI_REGION_DEACTIVATE
)
722 *RegionContext
= NULL
;
724 *RegionContext
= Context
;
726 return_ACPI_STATUS (AE_OK
);
730 EcSpaceHandler(UINT32 Function
, ACPI_PHYSICAL_ADDRESS Address
, UINT32 width
,
731 ACPI_INTEGER
*Value
, void *Context
, void *RegionContext
)
733 struct acpi_ec_softc
*sc
= (struct acpi_ec_softc
*)Context
;
735 UINT8 EcAddr
, EcData
;
738 ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__
, (UINT32
)Address
);
740 if (width
% 8 != 0 || Value
== NULL
|| Context
== NULL
)
741 return_ACPI_STATUS (AE_BAD_PARAMETER
);
742 if (Address
+ (width
/ 8) - 1 > 0xFF)
743 return_ACPI_STATUS (AE_BAD_ADDRESS
);
745 if (Function
== ACPI_READ
)
751 * If booting, check if we need to run the query handler. If so, we
752 * we call it directly here since our thread taskq is not active yet.
754 if (cold
|| rebooting
) {
755 if ((EC_GET_CSR(sc
) & EC_EVENT_SCI
)) {
757 CTR0(KTR_ACPI
, "ec running gpe handler directly");
759 EcGpeQueryHandler(sc
);
763 /* Serialize with EcGpeQueryHandler() at transaction granularity. */
765 if (ACPI_FAILURE(Status
))
766 return_ACPI_STATUS (Status
);
768 /* Perform the transaction(s), based on width. */
769 for (i
= 0; i
< width
; i
+= 8, EcAddr
++) {
772 Status
= EcRead(sc
, EcAddr
, &EcData
);
773 if (ACPI_SUCCESS(Status
))
774 *Value
|= ((ACPI_INTEGER
)EcData
) << i
;
777 EcData
= (UINT8
)((*Value
) >> i
);
778 Status
= EcWrite(sc
, EcAddr
, &EcData
);
781 device_printf(sc
->ec_dev
, "invalid EcSpaceHandler function %d\n",
783 Status
= AE_BAD_PARAMETER
;
786 if (ACPI_FAILURE(Status
))
791 return_ACPI_STATUS (Status
);
795 EcCheckStatus(struct acpi_ec_softc
*sc
, const char *msg
, EC_EVENT event
)
800 status
= AE_NO_HARDWARE_RESPONSE
;
801 ec_status
= EC_GET_CSR(sc
);
802 if (sc
->ec_burstactive
&& !(ec_status
& EC_FLAG_BURST_MODE
)) {
804 CTR1(KTR_ACPI
, "ec burst disabled in waitevent (%s)", msg
);
806 sc
->ec_burstactive
= FALSE
;
808 if (EVENT_READY(event
, ec_status
)) {
810 CTR2(KTR_ACPI
, "ec %s wait ready, status %#x", msg
, ec_status
);
818 EcWaitEvent(struct acpi_ec_softc
*sc
, EC_EVENT Event
, u_int gen_count
)
821 int count
, i
, slp_ival
;
823 ACPI_SERIAL_ASSERT(ec
);
824 Status
= AE_NO_HARDWARE_RESPONSE
;
825 int need_poll
= cold
|| rebooting
|| ec_polled_mode
|| sc
->ec_suspending
;
827 * The main CPU should be much faster than the EC. So the status should
828 * be "not ready" when we start waiting. But if the main CPU is really
829 * slow, it's possible we see the current "ready" response. Since that
830 * can't be distinguished from the previous response in polled mode,
831 * this is a potential issue. We really should have interrupts enabled
832 * during boot so there is no ambiguity in polled mode.
834 * If this occurs, we add an additional delay before actually entering
835 * the status checking loop, hopefully to allow the EC to go to work
836 * and produce a non-stale status.
841 if (EcCheckStatus(sc
, "pre-check", Event
) == AE_OK
) {
843 device_printf(sc
->ec_dev
,
844 "warning: EC done before starting event wait\n");
851 /* Wait for event by polling or GPE (interrupt). */
853 count
= (ec_timeout
* 1000) / EC_POLL_DELAY
;
856 for (i
= 0; i
< count
; i
++) {
857 Status
= EcCheckStatus(sc
, "poll", Event
);
860 AcpiOsStall(EC_POLL_DELAY
);
863 slp_ival
= hz
/ 1000;
867 /* hz has less than 1 ms resolution so scale timeout. */
869 count
= ec_timeout
/ (1000 / hz
);
873 * Wait for the GPE to signal the status changed, checking the
874 * status register each time we get one. It's possible to get a
875 * GPE for an event we're not interested in here (i.e., SCI for
878 for (i
= 0; i
< count
; i
++) {
879 if (gen_count
!= sc
->ec_gencount
) {
881 * Record new generation count. It's possible the GPE was
882 * just to notify us that a query is needed and we need to
883 * wait for a second GPE to signal the completion of the
884 * event we are actually waiting for.
886 gen_count
= sc
->ec_gencount
;
887 Status
= EcCheckStatus(sc
, "sleep", Event
);
891 tsleep(&sc
->ec_gencount
, PZERO
, "ecgpe", slp_ival
);
895 * We finished waiting for the GPE and it never arrived. Try to
896 * read the register once and trust whatever value we got. This is
897 * the best we can do at this point. Then, force polled mode on
898 * since this system doesn't appear to generate GPEs.
900 if (Status
!= AE_OK
) {
901 Status
= EcCheckStatus(sc
, "sleep_end", Event
);
902 device_printf(sc
->ec_dev
,
903 "wait timed out (%sresponse), forcing polled mode\n",
904 Status
== AE_OK
? "" : "no ");
905 ec_polled_mode
= TRUE
;
910 CTR0(KTR_ACPI
, "error: ec wait timed out");
916 EcCommand(struct acpi_ec_softc
*sc
, EC_COMMAND cmd
)
923 ACPI_SERIAL_ASSERT(ec
);
925 /* Don't use burst mode if user disabled it. */
926 if (!ec_burst_mode
&& cmd
== EC_COMMAND_BURST_ENABLE
)
929 /* Decide what to wait for based on command type. */
931 case EC_COMMAND_READ
:
932 case EC_COMMAND_WRITE
:
933 case EC_COMMAND_BURST_DISABLE
:
934 event
= EC_EVENT_INPUT_BUFFER_EMPTY
;
936 case EC_COMMAND_QUERY
:
937 case EC_COMMAND_BURST_ENABLE
:
938 event
= EC_EVENT_OUTPUT_BUFFER_FULL
;
941 device_printf(sc
->ec_dev
, "EcCommand: invalid command %#x\n", cmd
);
942 return (AE_BAD_PARAMETER
);
945 /* Run the command and wait for the chosen event. */
947 CTR1(KTR_ACPI
, "ec running command %#x", cmd
);
949 gen_count
= sc
->ec_gencount
;
951 status
= EcWaitEvent(sc
, event
, gen_count
);
952 if (ACPI_SUCCESS(status
)) {
953 /* If we succeeded, burst flag should now be present. */
954 if (cmd
== EC_COMMAND_BURST_ENABLE
) {
955 ec_status
= EC_GET_CSR(sc
);
956 if ((ec_status
& EC_FLAG_BURST_MODE
) == 0)
960 device_printf(sc
->ec_dev
, "EcCommand: no response to %#x\n", cmd
);
965 EcRead(struct acpi_ec_softc
*sc
, UINT8 Address
, UINT8
*Data
)
971 ACPI_SERIAL_ASSERT(ec
);
973 CTR1(KTR_ACPI
, "ec read from %#x", Address
);
975 /* If we can't start burst mode, continue anyway. */
976 status
= EcCommand(sc
, EC_COMMAND_BURST_ENABLE
);
977 if (status
== AE_OK
) {
978 data
= EC_GET_DATA(sc
);
979 if (data
== EC_BURST_ACK
) {
981 CTR0(KTR_ACPI
, "ec burst enabled");
983 sc
->ec_burstactive
= TRUE
;
987 status
= EcCommand(sc
, EC_COMMAND_READ
);
988 if (ACPI_FAILURE(status
))
991 gen_count
= sc
->ec_gencount
;
992 EC_SET_DATA(sc
, Address
);
993 status
= EcWaitEvent(sc
, EC_EVENT_OUTPUT_BUFFER_FULL
, gen_count
);
994 if (ACPI_FAILURE(status
)) {
995 device_printf(sc
->ec_dev
, "EcRead: failed waiting to get data\n");
998 *Data
= EC_GET_DATA(sc
);
1000 if (sc
->ec_burstactive
) {
1001 sc
->ec_burstactive
= FALSE
;
1002 status
= EcCommand(sc
, EC_COMMAND_BURST_DISABLE
);
1003 if (ACPI_FAILURE(status
))
1006 CTR0(KTR_ACPI
, "ec disabled burst ok");
1014 EcWrite(struct acpi_ec_softc
*sc
, UINT8 Address
, UINT8
*Data
)
1020 ACPI_SERIAL_ASSERT(ec
);
1022 CTR2(KTR_ACPI
, "ec write to %#x, data %#x", Address
, *Data
);
1025 /* If we can't start burst mode, continue anyway. */
1026 status
= EcCommand(sc
, EC_COMMAND_BURST_ENABLE
);
1027 if (status
== AE_OK
) {
1028 data
= EC_GET_DATA(sc
);
1029 if (data
== EC_BURST_ACK
) {
1031 CTR0(KTR_ACPI
, "ec burst enabled");
1033 sc
->ec_burstactive
= TRUE
;
1037 status
= EcCommand(sc
, EC_COMMAND_WRITE
);
1038 if (ACPI_FAILURE(status
))
1041 gen_count
= sc
->ec_gencount
;
1042 EC_SET_DATA(sc
, Address
);
1043 status
= EcWaitEvent(sc
, EC_EVENT_INPUT_BUFFER_EMPTY
, gen_count
);
1044 if (ACPI_FAILURE(status
)) {
1045 device_printf(sc
->ec_dev
, "EcRead: failed waiting for sent address\n");
1049 gen_count
= sc
->ec_gencount
;
1050 EC_SET_DATA(sc
, *Data
);
1051 status
= EcWaitEvent(sc
, EC_EVENT_INPUT_BUFFER_EMPTY
, gen_count
);
1052 if (ACPI_FAILURE(status
)) {
1053 device_printf(sc
->ec_dev
, "EcWrite: failed waiting for sent data\n");
1057 if (sc
->ec_burstactive
) {
1058 sc
->ec_burstactive
= FALSE
;
1059 status
= EcCommand(sc
, EC_COMMAND_BURST_DISABLE
);
1060 if (ACPI_FAILURE(status
))
1063 CTR0(KTR_ACPI
, "ec disabled burst ok");