2 * Copyright (c) 2003 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.52 2004/06/13 22:52:30 njl Exp $
29 * $DragonFly: src/sys/dev/acpica5/acpi_ec.c,v 1.14 2008/08/27 16:35:19 hasso Exp $
31 /******************************************************************************
35 * Some or all of this work - Copyright (c) 1999, Intel Corp. All rights
40 * 2.1. This is your license from Intel Corp. under its intellectual property
41 * rights. You may have additional license terms from the party that provided
42 * you this software, covering your right to use that party's intellectual
45 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
46 * copy of the source code appearing in this file ("Covered Code") an
47 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
48 * base code distributed originally by Intel ("Original Intel Code") to copy,
49 * make derivatives, distribute, use and display any portion of the Covered
50 * Code in any form, with the right to sublicense such rights; and
52 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
53 * license (with the right to sublicense), under only those claims of Intel
54 * patents that are infringed by the Original Intel Code, to make, use, sell,
55 * offer to sell, and import the Covered Code and derivative works thereof
56 * solely to the minimum extent necessary to exercise the above copyright
57 * license, and in no event shall the patent license extend to any additions
58 * to or modifications of the Original Intel Code. No other license or right
59 * is granted directly or by implication, estoppel or otherwise;
61 * The above copyright and patent license is granted only if the following
66 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
67 * Redistribution of source code of any substantial portion of the Covered
68 * Code or modification with rights to further distribute source must include
69 * the above Copyright Notice, the above License, this list of Conditions,
70 * and the following Disclaimer and Export Compliance provision. In addition,
71 * Licensee must cause all Covered Code to which Licensee contributes to
72 * contain a file documenting the changes Licensee made to create that Covered
73 * Code and the date of any change. Licensee must include in that file the
74 * documentation of any changes made by any predecessor Licensee. Licensee
75 * must include a prominent statement that the modification is derived,
76 * directly or indirectly, from Original Intel Code.
78 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
79 * Redistribution of source code of any substantial portion of the Covered
80 * Code or modification without rights to further distribute source must
81 * include the following Disclaimer and Export Compliance provision in the
82 * documentation and/or other materials provided with distribution. In
83 * addition, Licensee may not authorize further sublicense of source of any
84 * portion of the Covered Code, and must include terms to the effect that the
85 * license from Licensee to its licensee is limited to the intellectual
86 * property embodied in the software Licensee provides to its licensee, and
87 * not to intellectual property embodied in modifications its licensee may
90 * 3.3. Redistribution of Executable. Redistribution in executable form of any
91 * substantial portion of the Covered Code or modification must reproduce the
92 * above Copyright Notice, and the following Disclaimer and Export Compliance
93 * provision in the documentation and/or other materials provided with the
96 * 3.4. Intel retains all right, title, and interest in and to the Original
99 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
100 * Intel shall be used in advertising or otherwise to promote the sale, use or
101 * other dealings in products derived from or relating to the Covered Code
102 * without prior written authorization from Intel.
104 * 4. Disclaimer and Export Compliance
106 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
107 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
108 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
109 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
110 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
111 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
112 * PARTICULAR PURPOSE.
114 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
115 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
116 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
117 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
118 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
119 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
120 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
123 * 4.3. Licensee shall not export, either directly or indirectly, any of this
124 * software or system incorporating such software without first obtaining any
125 * required license or other approval from the U. S. Department of Commerce or
126 * any other agency or department of the United States Government. In the
127 * event Licensee exports any such software from the United States or
128 * re-exports any such software from a foreign destination, Licensee shall
129 * ensure that the distribution and export/re-export of the software is in
130 * compliance with all laws, regulations, orders, or other restrictions of the
131 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
132 * any of its subsidiaries will export/re-export any technical data, process,
133 * software, or service, directly or indirectly, to any country for which the
134 * United States government or any agency thereof requires an export license,
135 * other governmental approval, or letter of assurance, without first obtaining
136 * such license, approval or letter.
138 *****************************************************************************/
140 * $FreeBSD: src/sys/dev/acpica/acpi_ec.c,v 1.52 2004/06/13 22:52:30 njl Exp $
141 * $DragonFly: src/sys/dev/acpica5/acpi_ec.c,v 1.14 2008/08/27 16:35:19 hasso Exp $
145 #include "opt_acpi.h"
146 #include <sys/param.h>
147 #include <sys/kernel.h>
149 #include <sys/thread.h>
150 #include <sys/malloc.h>
151 #include <sys/module.h>
152 #include <sys/lock.h>
153 #include <sys/rman.h>
156 #include <dev/acpica5/acpivar.h>
159 * Hooks for the ACPI CA debugging infrastructure
161 #define _COMPONENT ACPI_EC
162 ACPI_MODULE_NAME("EC")
168 typedef UINT8 EC_COMMAND
;
170 #define EC_COMMAND_UNKNOWN ((EC_COMMAND) 0x00)
171 #define EC_COMMAND_READ ((EC_COMMAND) 0x80)
172 #define EC_COMMAND_WRITE ((EC_COMMAND) 0x81)
173 #define EC_COMMAND_BURST_ENABLE ((EC_COMMAND) 0x82)
174 #define EC_COMMAND_BURST_DISABLE ((EC_COMMAND) 0x83)
175 #define EC_COMMAND_QUERY ((EC_COMMAND) 0x84)
180 * The encoding of the EC status register is illustrated below.
181 * Note that a set bit (1) indicates the property is TRUE
182 * (e.g. if bit 0 is set then the output buffer is full).
187 * | | | | | | | +- Output Buffer Full?
188 * | | | | | | +--- Input Buffer Full?
189 * | | | | | +----- <reserved>
190 * | | | | +------- Data Register is Command Byte?
191 * | | | +--------- Burst Mode Enabled?
192 * | | +----------- SCI Event?
193 * | +------------- SMI Event?
194 * +--------------- <Reserved>
197 typedef UINT8 EC_STATUS
;
199 #define EC_FLAG_OUTPUT_BUFFER ((EC_STATUS) 0x01)
200 #define EC_FLAG_INPUT_BUFFER ((EC_STATUS) 0x02)
201 #define EC_FLAG_BURST_MODE ((EC_STATUS) 0x10)
202 #define EC_FLAG_SCI ((EC_STATUS) 0x20)
208 typedef UINT8 EC_EVENT
;
210 #define EC_EVENT_UNKNOWN ((EC_EVENT) 0x00)
211 #define EC_EVENT_OUTPUT_BUFFER_FULL ((EC_EVENT) 0x01)
212 #define EC_EVENT_INPUT_BUFFER_EMPTY ((EC_EVENT) 0x02)
213 #define EC_EVENT_SCI ((EC_EVENT) 0x20)
216 * Register access primitives
218 #define EC_GET_DATA(sc) \
219 bus_space_read_1((sc)->ec_data_tag, (sc)->ec_data_handle, 0)
221 #define EC_SET_DATA(sc, v) \
222 bus_space_write_1((sc)->ec_data_tag, (sc)->ec_data_handle, 0, (v))
224 #define EC_GET_CSR(sc) \
225 bus_space_read_1((sc)->ec_csr_tag, (sc)->ec_csr_handle, 0)
227 #define EC_SET_CSR(sc, v) \
228 bus_space_write_1((sc)->ec_csr_tag, (sc)->ec_csr_handle, 0, (v))
230 /* Additional params to pass from the probe routine */
231 struct acpi_ec_params
{
234 ACPI_HANDLE gpe_handle
;
238 /* Indicate that this device has already been probed via ECDT. */
239 #define DEV_ECDT(x) (acpi_get_magic(x) == (int)&acpi_ec_devclass)
244 struct acpi_ec_softc
{
246 ACPI_HANDLE ec_handle
;
248 ACPI_HANDLE ec_gpehandle
;
253 struct resource
*ec_data_res
;
254 bus_space_tag_t ec_data_tag
;
255 bus_space_handle_t ec_data_handle
;
258 struct resource
*ec_csr_res
;
259 bus_space_tag_t ec_csr_tag
;
260 bus_space_handle_t ec_csr_handle
;
269 * I couldn't find it in the spec but other implementations also use a
270 * value of 1 ms for the time to acquire global lock.
272 #define EC_LOCK_TIMEOUT 1000
274 /* Default interval in microseconds for the status polling loop. */
275 #define EC_POLL_DELAY 10
277 /* Total time in ms spent in the poll loop waiting for a response. */
278 #define EC_POLL_TIMEOUT 100
280 #define EVENT_READY(event, status) \
281 (((event) == EC_EVENT_OUTPUT_BUFFER_FULL && \
282 ((status) & EC_FLAG_OUTPUT_BUFFER) != 0) || \
283 ((event) == EC_EVENT_INPUT_BUFFER_EMPTY && \
284 ((status) & EC_FLAG_INPUT_BUFFER) == 0))
286 static int ec_poll_timeout
= EC_POLL_TIMEOUT
;
287 TUNABLE_INT("hw.acpi.ec.poll_timeout", &ec_poll_timeout
);
289 static __inline ACPI_STATUS
290 EcLock(struct acpi_ec_softc
*sc
)
292 ACPI_STATUS status
= AE_OK
;
294 /* Always acquire this EC's mutex. */
295 lockmgr(&sc
->ec_lock
, LK_EXCLUSIVE
|LK_RETRY
);
297 /* If _GLK is non-zero, also acquire the global lock. */
299 status
= AcpiAcquireGlobalLock(EC_LOCK_TIMEOUT
, &sc
->ec_glkhandle
);
300 if (ACPI_FAILURE(status
))
301 lockmgr(&sc
->ec_lock
, LK_RELEASE
);
308 EcUnlock(struct acpi_ec_softc
*sc
)
311 AcpiReleaseGlobalLock(sc
->ec_glkhandle
);
312 lockmgr(&sc
->ec_lock
, LK_RELEASE
);
315 static uint32_t EcGpeHandler(void *Context
);
316 static ACPI_STATUS
EcSpaceSetup(ACPI_HANDLE Region
, UINT32 Function
,
317 void *Context
, void **return_Context
);
318 static ACPI_STATUS
EcSpaceHandler(UINT32 Function
,
319 ACPI_PHYSICAL_ADDRESS Address
,
320 UINT32 width
, ACPI_INTEGER
*Value
,
321 void *Context
, void *RegionContext
);
322 static ACPI_STATUS
EcWaitEvent(struct acpi_ec_softc
*sc
, EC_EVENT Event
);
323 static ACPI_STATUS
EcCommand(struct acpi_ec_softc
*sc
, EC_COMMAND cmd
);
324 static ACPI_STATUS
EcRead(struct acpi_ec_softc
*sc
, UINT8 Address
,
326 static ACPI_STATUS
EcWrite(struct acpi_ec_softc
*sc
, UINT8 Address
,
328 static int acpi_ec_probe(device_t dev
);
329 static int acpi_ec_attach(device_t dev
);
330 static int acpi_ec_read_method(device_t dev
, u_int addr
,
331 ACPI_INTEGER
*val
, int width
);
332 static int acpi_ec_write_method(device_t dev
, u_int addr
,
333 ACPI_INTEGER val
, int width
);
335 static device_method_t acpi_ec_methods
[] = {
336 /* Device interface */
337 DEVMETHOD(device_probe
, acpi_ec_probe
),
338 DEVMETHOD(device_attach
, acpi_ec_attach
),
340 /* Embedded controller interface */
341 DEVMETHOD(acpi_ec_read
, acpi_ec_read_method
),
342 DEVMETHOD(acpi_ec_write
, acpi_ec_write_method
),
347 static driver_t acpi_ec_driver
= {
350 sizeof(struct acpi_ec_softc
),
353 static devclass_t acpi_ec_devclass
;
354 DRIVER_MODULE(acpi_ec
, acpi
, acpi_ec_driver
, acpi_ec_devclass
, 0, 0);
355 MODULE_DEPEND(acpi_ec
, acpi
, 1, 1, 1);
358 * Look for an ECDT and if we find one, set up default GPE and
359 * space handlers to catch attempts to access EC space before
360 * we have a real driver instance in place.
361 * TODO: if people report invalid ECDTs, add a tunable to disable them.
364 acpi_ec_ecdt_probe(device_t parent
)
366 ACPI_TABLE_ECDT
*ecdt
;
370 struct acpi_ec_params
*params
;
372 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__
);
374 /* Find and validate the ECDT. */
375 status
= AcpiGetTable(ACPI_SIG_ECDT
, 1, (ACPI_TABLE_HEADER
**)&ecdt
);
376 if (ACPI_FAILURE(status
) ||
377 ecdt
->Control
.BitWidth
!= 8 || ecdt
->Data
.BitWidth
!= 8) {
381 /* Create the child device with the given unit number. */
382 child
= BUS_ADD_CHILD(parent
, parent
, 0, "acpi_ec", ecdt
->Uid
);
384 kprintf("%s: can't add child\n", __func__
);
388 /* Find and save the ACPI handle for this device. */
389 status
= AcpiGetHandle(NULL
, ecdt
->Id
, &h
);
390 if (ACPI_FAILURE(status
)) {
391 device_delete_child(parent
, child
);
392 kprintf("%s: can't get handle\n", __func__
);
395 acpi_set_handle(child
, h
);
397 /* Set the data and CSR register addresses. */
398 bus_set_resource(child
, SYS_RES_IOPORT
, 0, ecdt
->Data
.Address
,
400 bus_set_resource(child
, SYS_RES_IOPORT
, 1, ecdt
->Control
.Address
,
404 * Store values for the probe/attach routines to use. Store the
405 * ECDT GPE bit and set the global lock flag according to _GLK.
406 * Note that it is not perfectly correct to be evaluating a method
407 * before initializing devices, but in practice this function
408 * should be safe to call at this point.
410 params
= kmalloc(sizeof(struct acpi_ec_params
), M_TEMP
, M_WAITOK
| M_ZERO
);
411 params
->gpe_handle
= NULL
;
412 params
->gpe_bit
= ecdt
->Gpe
;
413 params
->uid
= ecdt
->Uid
;
414 acpi_GetInteger(h
, "_GLK", ¶ms
->glk
);
415 acpi_set_private(child
, params
);
416 acpi_set_magic(child
, (int)&acpi_ec_devclass
);
418 /* Finish the attach process. */
419 if (device_probe_and_attach(child
) != 0)
420 device_delete_child(parent
, child
);
424 acpi_ec_probe(device_t dev
)
433 struct acpi_ec_params
*params
;
435 /* Check that this is a device and that EC is not disabled. */
436 if (acpi_get_type(dev
) != ACPI_TYPE_DEVICE
|| acpi_disabled("ec"))
440 * If probed via ECDT, set description and continue. Otherwise,
441 * we can access the namespace and make sure this is not a
447 buf
.Length
= ACPI_ALLOCATE_BUFFER
;
449 params
= acpi_get_private(dev
);
451 } else if (acpi_MatchHid(acpi_get_handle(dev
), "PNP0C09")) {
452 params
= kmalloc(sizeof(struct acpi_ec_params
), M_TEMP
,
454 h
= acpi_get_handle(dev
);
457 * Read the unit ID to check for duplicate attach and the
458 * global lock value to see if we should acquire it when
461 status
= acpi_GetInteger(h
, "_UID", ¶ms
->uid
);
462 if (ACPI_FAILURE(status
))
464 status
= acpi_GetInteger(h
, "_GLK", ¶ms
->glk
);
465 if (ACPI_FAILURE(status
))
469 * Evaluate the _GPE method to find the GPE bit used by the EC to
470 * signal status (SCI). If it's a package, it contains a reference
471 * and GPE bit, similar to _PRW.
473 status
= AcpiEvaluateObject(h
, "_GPE", NULL
, &buf
);
474 if (ACPI_FAILURE(status
)) {
475 device_printf(dev
, "can't evaluate _GPE - %s\n",
476 AcpiFormatException(status
));
479 obj
= (ACPI_OBJECT
*)buf
.Pointer
;
484 case ACPI_TYPE_INTEGER
:
485 params
->gpe_handle
= NULL
;
486 params
->gpe_bit
= obj
->Integer
.Value
;
488 case ACPI_TYPE_PACKAGE
:
489 if (!ACPI_PKG_VALID(obj
, 2))
492 acpi_GetReference(NULL
, &obj
->Package
.Elements
[0]);
493 if (params
->gpe_handle
== NULL
||
494 acpi_PkgInt32(obj
, 1, ¶ms
->gpe_bit
) != 0)
498 device_printf(dev
, "_GPE has invalid type %d\n", obj
->Type
);
502 /* Store the values we got from the namespace for attach. */
503 acpi_set_private(dev
, params
);
506 * Check for a duplicate probe. This can happen when a probe
507 * via ECDT succeeded already. If this is a duplicate, disable
510 peer
= devclass_get_device(acpi_ec_devclass
, params
->uid
);
511 if (peer
== NULL
|| !device_is_alive(peer
))
519 ksnprintf(desc
, sizeof(desc
), "Embedded Controller: GPE %#x%s%s",
520 params
->gpe_bit
, (params
->glk
) ? ", GLK" : "",
521 DEV_ECDT(dev
) ? ", ECDT" : "");
522 device_set_desc_copy(dev
, desc
);
525 if (ret
> 0 && params
)
526 kfree(params
, M_TEMP
);
528 AcpiOsFree(buf
.Pointer
);
533 acpi_ec_attach(device_t dev
)
535 struct acpi_ec_softc
*sc
;
536 struct acpi_ec_params
*params
;
539 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__
);
541 /* Fetch/initialize softc (assumes softc is pre-zeroed). */
542 sc
= device_get_softc(dev
);
543 params
= acpi_get_private(dev
);
545 sc
->ec_handle
= acpi_get_handle(dev
);
546 lockinit(&sc
->ec_lock
, "eclock", 0, 0);
548 /* Retrieve previously probed values via device ivars. */
549 sc
->ec_glk
= params
->glk
;
550 sc
->ec_gpebit
= params
->gpe_bit
;
551 sc
->ec_gpehandle
= params
->gpe_handle
;
552 sc
->ec_uid
= params
->uid
;
553 kfree(params
, M_TEMP
);
555 /* Attach bus resources for data and command/status ports. */
557 sc
->ec_data_res
= bus_alloc_resource_any(sc
->ec_dev
, SYS_RES_IOPORT
,
558 &sc
->ec_data_rid
, RF_ACTIVE
);
559 if (sc
->ec_data_res
== NULL
) {
560 device_printf(dev
, "can't allocate data port\n");
563 sc
->ec_data_tag
= rman_get_bustag(sc
->ec_data_res
);
564 sc
->ec_data_handle
= rman_get_bushandle(sc
->ec_data_res
);
567 sc
->ec_csr_res
= bus_alloc_resource_any(sc
->ec_dev
, SYS_RES_IOPORT
,
568 &sc
->ec_csr_rid
, RF_ACTIVE
);
569 if (sc
->ec_csr_res
== NULL
) {
570 device_printf(dev
, "can't allocate command/status port\n");
573 sc
->ec_csr_tag
= rman_get_bustag(sc
->ec_csr_res
);
574 sc
->ec_csr_handle
= rman_get_bushandle(sc
->ec_csr_res
);
577 * Install a handler for this EC's GPE bit. We want edge-triggered
580 ACPI_DEBUG_PRINT((ACPI_DB_RESOURCES
, "attaching GPE handler\n"));
581 Status
= AcpiInstallGpeHandler(sc
->ec_gpehandle
, sc
->ec_gpebit
,
582 ACPI_GPE_EDGE_TRIGGERED
, &EcGpeHandler
, sc
);
583 if (ACPI_FAILURE(Status
)) {
584 device_printf(dev
, "can't install GPE handler for %s - %s\n",
585 acpi_name(sc
->ec_handle
), AcpiFormatException(Status
));
590 * Install address space handler
592 ACPI_DEBUG_PRINT((ACPI_DB_RESOURCES
, "attaching address space handler\n"));
593 Status
= AcpiInstallAddressSpaceHandler(sc
->ec_handle
, ACPI_ADR_SPACE_EC
,
594 &EcSpaceHandler
, &EcSpaceSetup
, sc
);
595 if (ACPI_FAILURE(Status
)) {
596 device_printf(dev
, "can't install address space handler for %s - %s\n",
597 acpi_name(sc
->ec_handle
), AcpiFormatException(Status
));
601 /* Enable runtime GPEs for the handler. */
602 Status
= AcpiSetGpeType(sc
->ec_gpehandle
, sc
->ec_gpebit
,
603 ACPI_GPE_TYPE_RUNTIME
);
604 if (ACPI_FAILURE(Status
)) {
605 device_printf(dev
, "AcpiSetGpeType failed: %s\n",
606 AcpiFormatException(Status
));
609 Status
= AcpiEnableGpe(sc
->ec_gpehandle
, sc
->ec_gpebit
, ACPI_NOT_ISR
);
610 if (ACPI_FAILURE(Status
)) {
611 device_printf(dev
, "AcpiEnableGpe failed: %s\n",
612 AcpiFormatException(Status
));
616 ACPI_DEBUG_PRINT((ACPI_DB_RESOURCES
, "acpi_ec_attach complete\n"));
620 AcpiRemoveGpeHandler(sc
->ec_gpehandle
, sc
->ec_gpebit
, &EcGpeHandler
);
621 AcpiRemoveAddressSpaceHandler(sc
->ec_handle
, ACPI_ADR_SPACE_EC
,
624 bus_release_resource(sc
->ec_dev
, SYS_RES_IOPORT
, sc
->ec_csr_rid
,
627 bus_release_resource(sc
->ec_dev
, SYS_RES_IOPORT
, sc
->ec_data_rid
,
629 /* mtx_destroy(&sc->ec_mtx); */
633 /* Methods to allow other devices (e.g., smbat) to read/write EC space. */
635 acpi_ec_read_method(device_t dev
, u_int addr
, ACPI_INTEGER
*val
, int width
)
637 struct acpi_ec_softc
*sc
;
640 sc
= device_get_softc(dev
);
641 status
= EcSpaceHandler(ACPI_READ
, addr
, width
* 8, val
, sc
, NULL
);
642 if (ACPI_FAILURE(status
))
648 acpi_ec_write_method(device_t dev
, u_int addr
, ACPI_INTEGER val
, int width
)
650 struct acpi_ec_softc
*sc
;
653 sc
= device_get_softc(dev
);
654 status
= EcSpaceHandler(ACPI_WRITE
, addr
, width
* 8, &val
, sc
, NULL
);
655 if (ACPI_FAILURE(status
))
661 EcGpeQueryHandler(void *Context
)
663 struct acpi_ec_softc
*sc
= (struct acpi_ec_softc
*)Context
;
669 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__
);
670 KASSERT(Context
!= NULL
, ("EcGpeQueryHandler called with NULL"));
673 if (ACPI_FAILURE(Status
)) {
674 ACPI_VPRINT(sc
->ec_dev
, acpi_device_get_parent_softc(sc
->ec_dev
),
675 "GpeQuery lock error: %s\n", AcpiFormatException(Status
));
680 * If the EC_SCI bit of the status register is not set, then pass
681 * it along to any potential waiters as it may be an IBE/OBF event.
683 EcStatus
= EC_GET_CSR(sc
);
684 if ((EcStatus
& EC_EVENT_SCI
) == 0) {
685 sc
->ec_csrvalue
= EcStatus
;
686 wakeup(&sc
->ec_csrvalue
);
692 * Send a query command to the EC to find out which _Qxx call it
693 * wants to make. This command clears the SCI bit and also the
694 * interrupt source since we are edge-triggered.
696 Status
= EcCommand(sc
, EC_COMMAND_QUERY
);
697 if (ACPI_FAILURE(Status
)) {
699 ACPI_VPRINT(sc
->ec_dev
, acpi_device_get_parent_softc(sc
->ec_dev
),
700 "GPE query failed - %s\n", AcpiFormatException(Status
));
703 Data
= EC_GET_DATA(sc
);
706 /* Ignore the value for "no outstanding event". (13.3.5) */
710 /* Evaluate _Qxx to respond to the controller. */
711 ksprintf(qxx
, "_Q%02x", Data
);
713 Status
= AcpiEvaluateObject(sc
->ec_handle
, qxx
, NULL
, NULL
);
714 if (ACPI_FAILURE(Status
) && Status
!= AE_NOT_FOUND
) {
715 ACPI_VPRINT(sc
->ec_dev
, acpi_device_get_parent_softc(sc
->ec_dev
),
716 "evaluation of GPE query method %s failed - %s\n",
717 qxx
, AcpiFormatException(Status
));
721 /* Re-enable the GPE event so we'll get future requests. */
722 Status
= AcpiEnableGpe(sc
->ec_gpehandle
, sc
->ec_gpebit
, ACPI_NOT_ISR
);
723 if (ACPI_FAILURE(Status
))
724 kprintf("EcGpeQueryHandler: AcpiEnableEvent failed\n");
728 * Handle a GPE. Currently we only handle SCI events as others must
729 * be handled by polling in EcWaitEvent(). This is because some ECs
730 * treat events as level when they should be edge-triggered.
733 EcGpeHandler(void *Context
)
735 struct acpi_ec_softc
*sc
= Context
;
738 KASSERT(Context
!= NULL
, ("EcGpeHandler called with NULL"));
740 /* Disable further GPEs while we handle this one. */
741 AcpiDisableGpe(sc
->ec_gpehandle
, sc
->ec_gpebit
, ACPI_ISR
);
743 /* Schedule the GPE query handler. */
744 Status
= AcpiOsExecute(OSL_GPE_HANDLER
, EcGpeQueryHandler
,
746 if (ACPI_FAILURE(Status
)) {
747 kprintf("Queuing GPE query handler failed.\n");
748 Status
= AcpiEnableGpe(sc
->ec_gpehandle
, sc
->ec_gpebit
, ACPI_ISR
);
749 if (ACPI_FAILURE(Status
))
750 kprintf("EcGpeHandler: AcpiEnableEvent failed\n");
757 EcSpaceSetup(ACPI_HANDLE Region
, UINT32 Function
, void *Context
,
758 void **RegionContext
)
761 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__
);
764 * If deactivating a region, always set the output to NULL. Otherwise,
765 * just pass the context through.
767 if (Function
== ACPI_REGION_DEACTIVATE
)
768 *RegionContext
= NULL
;
770 *RegionContext
= Context
;
772 return_ACPI_STATUS (AE_OK
);
776 EcSpaceHandler(UINT32 Function
, ACPI_PHYSICAL_ADDRESS Address
, UINT32 width
,
777 ACPI_INTEGER
*Value
, void *Context
, void *RegionContext
)
779 struct acpi_ec_softc
*sc
= (struct acpi_ec_softc
*)Context
;
781 UINT8 EcAddr
, EcData
;
784 ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__
, (UINT32
)Address
);
786 if (width
% 8 != 0 || Value
== NULL
|| Context
== NULL
)
787 return_ACPI_STATUS (AE_BAD_PARAMETER
);
788 if (Address
+ (width
/ 8) - 1 > 0xFF)
789 return_ACPI_STATUS (AE_BAD_ADDRESS
);
791 if (Function
== ACPI_READ
)
796 /* Perform the transaction(s), based on width. */
797 for (i
= 0; i
< width
; i
+= 8, EcAddr
++) {
799 if (ACPI_FAILURE(Status
))
804 Status
= EcRead(sc
, EcAddr
, &EcData
);
805 if (ACPI_SUCCESS(Status
))
806 *Value
|= ((ACPI_INTEGER
)EcData
) << i
;
809 EcData
= (UINT8
)((*Value
) >> i
);
810 Status
= EcWrite(sc
, EcAddr
, &EcData
);
813 device_printf(sc
->ec_dev
, "invalid EcSpaceHandler function %d\n",
815 Status
= AE_BAD_PARAMETER
;
819 if (ACPI_FAILURE(Status
))
823 return_ACPI_STATUS (Status
);
827 EcWaitEvent(struct acpi_ec_softc
*sc
, EC_EVENT Event
)
831 int count
, i
, period
, retval
, slp_ival
;
832 static int EcDbgMaxDelay
;
834 /* mtx_assert(&sc->ec_mtx, MA_OWNED); */
835 Status
= AE_NO_HARDWARE_RESPONSE
;
838 * Wait for 1 us before checking the CSR. Testing shows about
839 * 50% of requests complete in 1 us and 90% of them complete
845 * Poll the EC status register for up to 1 ms in chunks of 10 us
846 * to detect completion of the last command.
848 for (i
= 0; i
< 1000 / EC_POLL_DELAY
; i
++) {
849 EcStatus
= EC_GET_CSR(sc
);
850 if (EVENT_READY(Event
, EcStatus
)) {
854 AcpiOsStall(EC_POLL_DELAY
);
856 period
= i
* EC_POLL_DELAY
;
859 * If we still don't have a response and we're up and running, wait up
860 * to ec_poll_timeout ms for completion, sleeping for chunks of 10 ms.
863 if (Status
!= AE_OK
) {
865 count
= ec_poll_timeout
/ 10;
871 for (i
= 0; i
< count
; i
++) {
873 EcStatus
= EC_GET_CSR(sc
);
875 EcStatus
= sc
->ec_csrvalue
;
876 if (EVENT_READY(Event
, EcStatus
)) {
881 retval
= tsleep(&sc
->ec_csrvalue
, 0, "ecpoll", slp_ival
);
887 /* Calculate new delay and print it if it exceeds the max. */
890 if (period
> EcDbgMaxDelay
) {
891 EcDbgMaxDelay
= period
;
892 ACPI_VPRINT(sc
->ec_dev
, acpi_device_get_parent_softc(sc
->ec_dev
),
893 "info: new max delay is %d us\n", period
);
900 EcCommand(struct acpi_ec_softc
*sc
, EC_COMMAND cmd
)
905 /*mtx_assert(&sc->ec_mtx, MA_OWNED);*/
907 /* Decide what to wait for based on command type. */
909 case EC_COMMAND_READ
:
910 case EC_COMMAND_WRITE
:
911 case EC_COMMAND_BURST_DISABLE
:
912 Event
= EC_EVENT_INPUT_BUFFER_EMPTY
;
914 case EC_COMMAND_QUERY
:
915 case EC_COMMAND_BURST_ENABLE
:
916 Event
= EC_EVENT_OUTPUT_BUFFER_FULL
;
919 ACPI_VPRINT(sc
->ec_dev
, acpi_device_get_parent_softc(sc
->ec_dev
),
920 "EcCommand: Invalid command %#x\n", cmd
);
921 return (AE_BAD_PARAMETER
);
924 /* Run the command and wait for the chosen event. */
926 Status
= EcWaitEvent(sc
, Event
);
927 if (ACPI_FAILURE(Status
)) {
928 ACPI_VPRINT(sc
->ec_dev
, acpi_device_get_parent_softc(sc
->ec_dev
),
929 "EcCommand: no response to %#x\n", cmd
);
936 EcRead(struct acpi_ec_softc
*sc
, UINT8 Address
, UINT8
*Data
)
940 /*mtx_assert(&sc->ec_mtx, MA_OWNED);*/
943 /* If we can't start burst mode, continue anyway. */
944 EcCommand(sc
, EC_COMMAND_BURST_ENABLE
);
947 Status
= EcCommand(sc
, EC_COMMAND_READ
);
948 if (ACPI_FAILURE(Status
))
951 EC_SET_DATA(sc
, Address
);
952 Status
= EcWaitEvent(sc
, EC_EVENT_OUTPUT_BUFFER_FULL
);
953 if (ACPI_FAILURE(Status
)) {
954 ACPI_VPRINT(sc
->ec_dev
, acpi_device_get_parent_softc(sc
->ec_dev
),
955 "EcRead: Failed waiting for EC to send data.\n");
959 *Data
= EC_GET_DATA(sc
);
962 if (sc
->ec_burstactive
) {
963 Status
= EcCommand(sc
, EC_COMMAND_BURST_DISABLE
);
964 if (ACPI_FAILURE(Status
))
973 EcWrite(struct acpi_ec_softc
*sc
, UINT8 Address
, UINT8
*Data
)
977 /*mtx_assert(&sc->ec_mtx, MA_OWNED);*/
980 /* If we can't start burst mode, continue anyway. */
981 EcCommand(sc
, EC_COMMAND_BURST_ENABLE
);
984 Status
= EcCommand(sc
, EC_COMMAND_WRITE
);
985 if (ACPI_FAILURE(Status
))
988 EC_SET_DATA(sc
, Address
);
989 Status
= EcWaitEvent(sc
, EC_EVENT_INPUT_BUFFER_EMPTY
);
990 if (ACPI_FAILURE(Status
)) {
991 ACPI_VPRINT(sc
->ec_dev
, acpi_device_get_parent_softc(sc
->ec_dev
),
992 "EcRead: Failed waiting for EC to process address\n");
996 EC_SET_DATA(sc
, *Data
);
997 Status
= EcWaitEvent(sc
, EC_EVENT_INPUT_BUFFER_EMPTY
);
998 if (ACPI_FAILURE(Status
)) {
999 ACPI_VPRINT(sc
->ec_dev
, acpi_device_get_parent_softc(sc
->ec_dev
),
1000 "EcWrite: Failed waiting for EC to process data\n");
1005 if (sc
->ec_burstactive
) {
1006 Status
= EcCommand(sc
, EC_COMMAND_BURST_DISABLE
);
1007 if (ACPI_FAILURE(Status
))