1 /******************************************************************************
3 * Module Name: evgpe - General Purpose Event handling and dispatch
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2010, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
44 #include <acpi/acpi.h>
49 #define _COMPONENT ACPI_EVENTS
50 ACPI_MODULE_NAME("evgpe")
52 /* Local prototypes */
53 static void ACPI_SYSTEM_XFACE acpi_ev_asynch_execute_gpe_method(void *context);
55 /*******************************************************************************
57 * FUNCTION: acpi_ev_update_gpe_enable_masks
59 * PARAMETERS: gpe_event_info - GPE to update
63 * DESCRIPTION: Updates GPE register enable masks based on the GPE type
65 ******************************************************************************/
68 acpi_ev_update_gpe_enable_masks(struct acpi_gpe_event_info *gpe_event_info)
70 struct acpi_gpe_register_info *gpe_register_info;
73 ACPI_FUNCTION_TRACE(ev_update_gpe_enable_masks);
75 gpe_register_info = gpe_event_info->register_info;
76 if (!gpe_register_info) {
77 return_ACPI_STATUS(AE_NOT_EXIST);
82 (gpe_event_info->gpe_number - gpe_register_info->base_gpe_number));
84 ACPI_CLEAR_BIT(gpe_register_info->enable_for_wake, register_bit);
85 ACPI_CLEAR_BIT(gpe_register_info->enable_for_run, register_bit);
87 if (gpe_event_info->runtime_count)
88 ACPI_SET_BIT(gpe_register_info->enable_for_run, register_bit);
90 if (gpe_event_info->wakeup_count)
91 ACPI_SET_BIT(gpe_register_info->enable_for_wake, register_bit);
93 return_ACPI_STATUS(AE_OK);
96 /*******************************************************************************
98 * FUNCTION: acpi_ev_enable_gpe
100 * PARAMETERS: gpe_event_info - GPE to enable
104 * DESCRIPTION: Enable a GPE based on the GPE type
106 ******************************************************************************/
108 acpi_status acpi_ev_enable_gpe(struct acpi_gpe_event_info *gpe_event_info)
112 ACPI_FUNCTION_TRACE(ev_enable_gpe);
114 /* Make sure HW enable masks are updated */
116 status = acpi_ev_update_gpe_enable_masks(gpe_event_info);
117 if (ACPI_FAILURE(status))
118 return_ACPI_STATUS(status);
120 /* Mark wake-enabled or HW enable, or both */
122 if (gpe_event_info->runtime_count) {
123 /* Clear the GPE (of stale events), then enable it */
124 status = acpi_hw_clear_gpe(gpe_event_info);
125 if (ACPI_FAILURE(status))
126 return_ACPI_STATUS(status);
128 /* Enable the requested runtime GPE */
129 status = acpi_hw_write_gpe_enable_reg(gpe_event_info);
132 return_ACPI_STATUS(AE_OK);
135 /*******************************************************************************
137 * FUNCTION: acpi_ev_disable_gpe
139 * PARAMETERS: gpe_event_info - GPE to disable
143 * DESCRIPTION: Disable a GPE based on the GPE type
145 ******************************************************************************/
147 acpi_status acpi_ev_disable_gpe(struct acpi_gpe_event_info *gpe_event_info)
151 ACPI_FUNCTION_TRACE(ev_disable_gpe);
153 /* Make sure HW enable masks are updated */
155 status = acpi_ev_update_gpe_enable_masks(gpe_event_info);
156 if (ACPI_FAILURE(status))
157 return_ACPI_STATUS(status);
160 * Even if we don't know the GPE type, make sure that we always
161 * disable it. low_disable_gpe will just clear the enable bit for this
162 * GPE and write it. It will not write out the current GPE enable mask,
163 * since this may inadvertently enable GPEs too early, if a rogue GPE has
164 * come in during ACPICA initialization - possibly as a result of AML or
165 * other code that has enabled the GPE.
167 status = acpi_hw_low_disable_gpe(gpe_event_info);
168 return_ACPI_STATUS(status);
171 /*******************************************************************************
173 * FUNCTION: acpi_ev_get_gpe_event_info
175 * PARAMETERS: gpe_device - Device node. NULL for GPE0/GPE1
176 * gpe_number - Raw GPE number
178 * RETURN: A GPE event_info struct. NULL if not a valid GPE
180 * DESCRIPTION: Returns the event_info struct associated with this GPE.
181 * Validates the gpe_block and the gpe_number
183 * Should be called only when the GPE lists are semaphore locked
184 * and not subject to change.
186 ******************************************************************************/
188 struct acpi_gpe_event_info *acpi_ev_get_gpe_event_info(acpi_handle gpe_device,
191 union acpi_operand_object *obj_desc;
192 struct acpi_gpe_block_info *gpe_block;
195 ACPI_FUNCTION_ENTRY();
197 /* A NULL gpe_block means use the FADT-defined GPE block(s) */
201 /* Examine GPE Block 0 and 1 (These blocks are permanent) */
203 for (i = 0; i < ACPI_MAX_GPE_BLOCKS; i++) {
204 gpe_block = acpi_gbl_gpe_fadt_blocks[i];
206 if ((gpe_number >= gpe_block->block_base_number)
208 gpe_block->block_base_number +
209 (gpe_block->register_count * 8))) {
211 event_info[gpe_number -
218 /* The gpe_number was not in the range of either FADT GPE block */
223 /* A Non-NULL gpe_device means this is a GPE Block Device */
225 obj_desc = acpi_ns_get_attached_object((struct acpi_namespace_node *)
227 if (!obj_desc || !obj_desc->device.gpe_block) {
231 gpe_block = obj_desc->device.gpe_block;
233 if ((gpe_number >= gpe_block->block_base_number) &&
235 gpe_block->block_base_number + (gpe_block->register_count * 8))) {
237 event_info[gpe_number - gpe_block->block_base_number]);
243 /*******************************************************************************
245 * FUNCTION: acpi_ev_gpe_detect
247 * PARAMETERS: gpe_xrupt_list - Interrupt block for this interrupt.
248 * Can have multiple GPE blocks attached.
250 * RETURN: INTERRUPT_HANDLED or INTERRUPT_NOT_HANDLED
252 * DESCRIPTION: Detect if any GP events have occurred. This function is
253 * executed at interrupt level.
255 ******************************************************************************/
257 u32 acpi_ev_gpe_detect(struct acpi_gpe_xrupt_info * gpe_xrupt_list)
260 struct acpi_gpe_block_info *gpe_block;
261 struct acpi_gpe_register_info *gpe_register_info;
262 u32 int_status = ACPI_INTERRUPT_NOT_HANDLED;
263 u8 enabled_status_byte;
266 acpi_cpu_flags flags;
270 ACPI_FUNCTION_NAME(ev_gpe_detect);
272 /* Check for the case where there are no GPEs */
274 if (!gpe_xrupt_list) {
279 * We need to obtain the GPE lock for both the data structs and registers
280 * Note: Not necessary to obtain the hardware lock, since the GPE
281 * registers are owned by the gpe_lock.
283 flags = acpi_os_acquire_lock(acpi_gbl_gpe_lock);
285 /* Examine all GPE blocks attached to this interrupt level */
287 gpe_block = gpe_xrupt_list->gpe_block_list_head;
290 * Read all of the 8-bit GPE status and enable registers in this GPE
291 * block, saving all of them. Find all currently active GP events.
293 for (i = 0; i < gpe_block->register_count; i++) {
295 /* Get the next status/enable pair */
297 gpe_register_info = &gpe_block->register_info[i];
299 /* Read the Status Register */
302 acpi_hw_read(&status_reg,
303 &gpe_register_info->status_address);
304 if (ACPI_FAILURE(status)) {
305 goto unlock_and_exit;
308 /* Read the Enable Register */
311 acpi_hw_read(&enable_reg,
312 &gpe_register_info->enable_address);
313 if (ACPI_FAILURE(status)) {
314 goto unlock_and_exit;
317 ACPI_DEBUG_PRINT((ACPI_DB_INTERRUPTS,
318 "Read GPE Register at GPE%X: Status=%02X, Enable=%02X\n",
319 gpe_register_info->base_gpe_number,
320 status_reg, enable_reg));
322 /* Check if there is anything active at all in this register */
324 enabled_status_byte = (u8) (status_reg & enable_reg);
325 if (!enabled_status_byte) {
327 /* No active GPEs in this register, move on */
332 /* Now look at the individual GPEs in this byte register */
334 for (j = 0; j < ACPI_GPE_REGISTER_WIDTH; j++) {
336 /* Examine one GPE bit */
338 if (enabled_status_byte & (1 << j)) {
340 * Found an active GPE. Dispatch the event to a handler
344 acpi_ev_gpe_dispatch(&gpe_block->
345 event_info[((acpi_size) i * ACPI_GPE_REGISTER_WIDTH) + j], j + gpe_register_info->base_gpe_number);
350 gpe_block = gpe_block->next;
355 acpi_os_release_lock(acpi_gbl_gpe_lock, flags);
359 /*******************************************************************************
361 * FUNCTION: acpi_ev_asynch_execute_gpe_method
363 * PARAMETERS: Context (gpe_event_info) - Info for this GPE
367 * DESCRIPTION: Perform the actual execution of a GPE control method. This
368 * function is called from an invocation of acpi_os_execute and
369 * therefore does NOT execute at interrupt level - so that
370 * the control method itself is not executed in the context of
371 * an interrupt handler.
373 ******************************************************************************/
374 static void acpi_ev_asynch_enable_gpe(void *context);
376 static void ACPI_SYSTEM_XFACE acpi_ev_asynch_execute_gpe_method(void *context)
378 struct acpi_gpe_event_info *gpe_event_info = (void *)context;
380 struct acpi_gpe_event_info local_gpe_event_info;
381 struct acpi_evaluate_info *info;
383 ACPI_FUNCTION_TRACE(ev_asynch_execute_gpe_method);
385 status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
386 if (ACPI_FAILURE(status)) {
390 /* Must revalidate the gpe_number/gpe_block */
392 if (!acpi_ev_valid_gpe_event(gpe_event_info)) {
393 status = acpi_ut_release_mutex(ACPI_MTX_EVENTS);
397 /* Set the GPE flags for return to enabled state */
399 (void)acpi_ev_update_gpe_enable_masks(gpe_event_info);
402 * Take a snapshot of the GPE info for this level - we copy the info to
403 * prevent a race condition with remove_handler/remove_block.
405 ACPI_MEMCPY(&local_gpe_event_info, gpe_event_info,
406 sizeof(struct acpi_gpe_event_info));
408 status = acpi_ut_release_mutex(ACPI_MTX_EVENTS);
409 if (ACPI_FAILURE(status)) {
414 * Must check for control method type dispatch one more time to avoid a
415 * race with ev_gpe_install_handler
417 if ((local_gpe_event_info.flags & ACPI_GPE_DISPATCH_MASK) ==
418 ACPI_GPE_DISPATCH_METHOD) {
420 /* Allocate the evaluation information block */
422 info = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_evaluate_info));
424 status = AE_NO_MEMORY;
427 * Invoke the GPE Method (_Lxx, _Exx) i.e., evaluate the _Lxx/_Exx
428 * control method that corresponds to this GPE
431 local_gpe_event_info.dispatch.method_node;
432 info->flags = ACPI_IGNORE_RETURN_VALUE;
434 status = acpi_ns_evaluate(info);
438 if (ACPI_FAILURE(status)) {
439 ACPI_EXCEPTION((AE_INFO, status,
440 "while evaluating GPE method [%4.4s]",
441 acpi_ut_get_node_name
442 (local_gpe_event_info.dispatch.
446 /* Defer enabling of GPE until all notify handlers are done */
447 acpi_os_execute(OSL_NOTIFY_HANDLER, acpi_ev_asynch_enable_gpe,
452 static void acpi_ev_asynch_enable_gpe(void *context)
454 struct acpi_gpe_event_info *gpe_event_info = context;
456 if ((gpe_event_info->flags & ACPI_GPE_XRUPT_TYPE_MASK) ==
457 ACPI_GPE_LEVEL_TRIGGERED) {
459 * GPE is level-triggered, we clear the GPE status bit after handling
462 status = acpi_hw_clear_gpe(gpe_event_info);
463 if (ACPI_FAILURE(status)) {
468 /* Enable this GPE */
469 (void)acpi_hw_write_gpe_enable_reg(gpe_event_info);
473 /*******************************************************************************
475 * FUNCTION: acpi_ev_gpe_dispatch
477 * PARAMETERS: gpe_event_info - Info for this GPE
478 * gpe_number - Number relative to the parent GPE block
480 * RETURN: INTERRUPT_HANDLED or INTERRUPT_NOT_HANDLED
482 * DESCRIPTION: Dispatch a General Purpose Event to either a function (e.g. EC)
483 * or method (e.g. _Lxx/_Exx) handler.
485 * This function executes at interrupt level.
487 ******************************************************************************/
490 acpi_ev_gpe_dispatch(struct acpi_gpe_event_info *gpe_event_info, u32 gpe_number)
494 ACPI_FUNCTION_TRACE(ev_gpe_dispatch);
496 acpi_os_gpe_count(gpe_number);
499 * If edge-triggered, clear the GPE status bit now. Note that
500 * level-triggered events are cleared after the GPE is serviced.
502 if ((gpe_event_info->flags & ACPI_GPE_XRUPT_TYPE_MASK) ==
503 ACPI_GPE_EDGE_TRIGGERED) {
504 status = acpi_hw_clear_gpe(gpe_event_info);
505 if (ACPI_FAILURE(status)) {
506 ACPI_EXCEPTION((AE_INFO, status,
507 "Unable to clear GPE[%2X]",
509 return_UINT32(ACPI_INTERRUPT_NOT_HANDLED);
514 * Dispatch the GPE to either an installed handler, or the control method
515 * associated with this GPE (_Lxx or _Exx). If a handler exists, we invoke
516 * it and do not attempt to run the method. If there is neither a handler
517 * nor a method, we disable this GPE to prevent further such pointless
518 * events from firing.
520 switch (gpe_event_info->flags & ACPI_GPE_DISPATCH_MASK) {
521 case ACPI_GPE_DISPATCH_HANDLER:
524 * Invoke the installed handler (at interrupt level)
525 * Ignore return status for now.
526 * TBD: leave GPE disabled on error?
528 (void)gpe_event_info->dispatch.handler->address(gpe_event_info->
533 /* It is now safe to clear level-triggered events. */
535 if ((gpe_event_info->flags & ACPI_GPE_XRUPT_TYPE_MASK) ==
536 ACPI_GPE_LEVEL_TRIGGERED) {
537 status = acpi_hw_clear_gpe(gpe_event_info);
538 if (ACPI_FAILURE(status)) {
539 ACPI_EXCEPTION((AE_INFO, status,
540 "Unable to clear GPE[%2X]",
542 return_UINT32(ACPI_INTERRUPT_NOT_HANDLED);
547 case ACPI_GPE_DISPATCH_METHOD:
550 * Disable the GPE, so it doesn't keep firing before the method has a
551 * chance to run (it runs asynchronously with interrupts enabled).
553 status = acpi_ev_disable_gpe(gpe_event_info);
554 if (ACPI_FAILURE(status)) {
555 ACPI_EXCEPTION((AE_INFO, status,
556 "Unable to disable GPE[%2X]",
558 return_UINT32(ACPI_INTERRUPT_NOT_HANDLED);
562 * Execute the method associated with the GPE
563 * NOTE: Level-triggered GPEs are cleared after the method completes.
565 status = acpi_os_execute(OSL_GPE_HANDLER,
566 acpi_ev_asynch_execute_gpe_method,
568 if (ACPI_FAILURE(status)) {
569 ACPI_EXCEPTION((AE_INFO, status,
570 "Unable to queue handler for GPE[%2X] - event disabled",
577 /* No handler or method to run! */
580 "No handler or method for GPE[%2X], disabling event",
584 * Disable the GPE. The GPE will remain disabled until the ACPICA
585 * Core Subsystem is restarted, or a handler is installed.
587 status = acpi_ev_disable_gpe(gpe_event_info);
588 if (ACPI_FAILURE(status)) {
589 ACPI_EXCEPTION((AE_INFO, status,
590 "Unable to disable GPE[%2X]",
592 return_UINT32(ACPI_INTERRUPT_NOT_HANDLED);
597 return_UINT32(ACPI_INTERRUPT_HANDLED);