1 /******************************************************************************
3 * Module Name: evgpe - General Purpose Event handling and dispatch
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2011, 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 static void ACPI_SYSTEM_XFACE acpi_ev_asynch_enable_gpe(void *context);
57 /*******************************************************************************
59 * FUNCTION: acpi_ev_update_gpe_enable_mask
61 * PARAMETERS: gpe_event_info - GPE to update
65 * DESCRIPTION: Updates GPE register enable mask based upon whether there are
66 * runtime references to this GPE
68 ******************************************************************************/
71 acpi_ev_update_gpe_enable_mask(struct acpi_gpe_event_info *gpe_event_info)
73 struct acpi_gpe_register_info *gpe_register_info;
76 ACPI_FUNCTION_TRACE(ev_update_gpe_enable_mask);
78 gpe_register_info = gpe_event_info->register_info;
79 if (!gpe_register_info) {
80 return_ACPI_STATUS(AE_NOT_EXIST);
83 register_bit = acpi_hw_get_gpe_register_bit(gpe_event_info,
86 /* Clear the run bit up front */
88 ACPI_CLEAR_BIT(gpe_register_info->enable_for_run, register_bit);
90 /* Set the mask bit only if there are references to this GPE */
92 if (gpe_event_info->runtime_count) {
93 ACPI_SET_BIT(gpe_register_info->enable_for_run, (u8)register_bit);
96 return_ACPI_STATUS(AE_OK);
99 /*******************************************************************************
101 * FUNCTION: acpi_ev_enable_gpe
103 * PARAMETERS: gpe_event_info - GPE to enable
107 * DESCRIPTION: Clear a GPE of stale events and enable it.
109 ******************************************************************************/
111 acpi_ev_enable_gpe(struct acpi_gpe_event_info *gpe_event_info)
115 ACPI_FUNCTION_TRACE(ev_enable_gpe);
118 * We will only allow a GPE to be enabled if it has either an associated
119 * method (_Lxx/_Exx) or a handler, or is using the implicit notify
120 * feature. Otherwise, the GPE will be immediately disabled by
121 * acpi_ev_gpe_dispatch the first time it fires.
123 if ((gpe_event_info->flags & ACPI_GPE_DISPATCH_MASK) ==
124 ACPI_GPE_DISPATCH_NONE) {
125 return_ACPI_STATUS(AE_NO_HANDLER);
128 /* Clear the GPE (of stale events) */
129 status = acpi_hw_clear_gpe(gpe_event_info);
130 if (ACPI_FAILURE(status)) {
131 return_ACPI_STATUS(status);
134 /* Enable the requested GPE */
135 status = acpi_hw_low_set_gpe(gpe_event_info, ACPI_GPE_ENABLE);
137 return_ACPI_STATUS(status);
141 /*******************************************************************************
143 * FUNCTION: acpi_ev_add_gpe_reference
145 * PARAMETERS: gpe_event_info - Add a reference to this GPE
149 * DESCRIPTION: Add a reference to a GPE. On the first reference, the GPE is
152 ******************************************************************************/
154 acpi_status acpi_ev_add_gpe_reference(struct acpi_gpe_event_info *gpe_event_info)
156 acpi_status status = AE_OK;
158 ACPI_FUNCTION_TRACE(ev_add_gpe_reference);
160 if (gpe_event_info->runtime_count == ACPI_UINT8_MAX) {
161 return_ACPI_STATUS(AE_LIMIT);
164 gpe_event_info->runtime_count++;
165 if (gpe_event_info->runtime_count == 1) {
167 /* Enable on first reference */
169 status = acpi_ev_update_gpe_enable_mask(gpe_event_info);
170 if (ACPI_SUCCESS(status)) {
171 status = acpi_ev_enable_gpe(gpe_event_info);
174 if (ACPI_FAILURE(status)) {
175 gpe_event_info->runtime_count--;
179 return_ACPI_STATUS(status);
182 /*******************************************************************************
184 * FUNCTION: acpi_ev_remove_gpe_reference
186 * PARAMETERS: gpe_event_info - Remove a reference to this GPE
190 * DESCRIPTION: Remove a reference to a GPE. When the last reference is
191 * removed, the GPE is hardware-disabled.
193 ******************************************************************************/
195 acpi_status acpi_ev_remove_gpe_reference(struct acpi_gpe_event_info *gpe_event_info)
197 acpi_status status = AE_OK;
199 ACPI_FUNCTION_TRACE(ev_remove_gpe_reference);
201 if (!gpe_event_info->runtime_count) {
202 return_ACPI_STATUS(AE_LIMIT);
205 gpe_event_info->runtime_count--;
206 if (!gpe_event_info->runtime_count) {
208 /* Disable on last reference */
210 status = acpi_ev_update_gpe_enable_mask(gpe_event_info);
211 if (ACPI_SUCCESS(status)) {
212 status = acpi_hw_low_set_gpe(gpe_event_info,
216 if (ACPI_FAILURE(status)) {
217 gpe_event_info->runtime_count++;
221 return_ACPI_STATUS(status);
224 /*******************************************************************************
226 * FUNCTION: acpi_ev_low_get_gpe_info
228 * PARAMETERS: gpe_number - Raw GPE number
229 * gpe_block - A GPE info block
231 * RETURN: A GPE event_info struct. NULL if not a valid GPE (The gpe_number
232 * is not within the specified GPE block)
234 * DESCRIPTION: Returns the event_info struct associated with this GPE. This is
235 * the low-level implementation of ev_get_gpe_event_info.
237 ******************************************************************************/
239 struct acpi_gpe_event_info *acpi_ev_low_get_gpe_info(u32 gpe_number,
240 struct acpi_gpe_block_info
246 * Validate that the gpe_number is within the specified gpe_block.
249 if (!gpe_block || (gpe_number < gpe_block->block_base_number)) {
253 gpe_index = gpe_number - gpe_block->block_base_number;
254 if (gpe_index >= gpe_block->gpe_count) {
258 return (&gpe_block->event_info[gpe_index]);
262 /*******************************************************************************
264 * FUNCTION: acpi_ev_get_gpe_event_info
266 * PARAMETERS: gpe_device - Device node. NULL for GPE0/GPE1
267 * gpe_number - Raw GPE number
269 * RETURN: A GPE event_info struct. NULL if not a valid GPE
271 * DESCRIPTION: Returns the event_info struct associated with this GPE.
272 * Validates the gpe_block and the gpe_number
274 * Should be called only when the GPE lists are semaphore locked
275 * and not subject to change.
277 ******************************************************************************/
279 struct acpi_gpe_event_info *acpi_ev_get_gpe_event_info(acpi_handle gpe_device,
282 union acpi_operand_object *obj_desc;
283 struct acpi_gpe_event_info *gpe_info;
286 ACPI_FUNCTION_ENTRY();
288 /* A NULL gpe_device means use the FADT-defined GPE block(s) */
292 /* Examine GPE Block 0 and 1 (These blocks are permanent) */
294 for (i = 0; i < ACPI_MAX_GPE_BLOCKS; i++) {
295 gpe_info = acpi_ev_low_get_gpe_info(gpe_number,
296 acpi_gbl_gpe_fadt_blocks
303 /* The gpe_number was not in the range of either FADT GPE block */
308 /* A Non-NULL gpe_device means this is a GPE Block Device */
310 obj_desc = acpi_ns_get_attached_object((struct acpi_namespace_node *)
312 if (!obj_desc || !obj_desc->device.gpe_block) {
316 return (acpi_ev_low_get_gpe_info
317 (gpe_number, obj_desc->device.gpe_block));
320 /*******************************************************************************
322 * FUNCTION: acpi_ev_gpe_detect
324 * PARAMETERS: gpe_xrupt_list - Interrupt block for this interrupt.
325 * Can have multiple GPE blocks attached.
327 * RETURN: INTERRUPT_HANDLED or INTERRUPT_NOT_HANDLED
329 * DESCRIPTION: Detect if any GP events have occurred. This function is
330 * executed at interrupt level.
332 ******************************************************************************/
334 u32 acpi_ev_gpe_detect(struct acpi_gpe_xrupt_info * gpe_xrupt_list)
337 struct acpi_gpe_block_info *gpe_block;
338 struct acpi_gpe_register_info *gpe_register_info;
339 u32 int_status = ACPI_INTERRUPT_NOT_HANDLED;
340 u8 enabled_status_byte;
343 acpi_cpu_flags flags;
347 ACPI_FUNCTION_NAME(ev_gpe_detect);
349 /* Check for the case where there are no GPEs */
351 if (!gpe_xrupt_list) {
356 * We need to obtain the GPE lock for both the data structs and registers
357 * Note: Not necessary to obtain the hardware lock, since the GPE
358 * registers are owned by the gpe_lock.
360 flags = acpi_os_acquire_lock(acpi_gbl_gpe_lock);
362 /* Examine all GPE blocks attached to this interrupt level */
364 gpe_block = gpe_xrupt_list->gpe_block_list_head;
367 * Read all of the 8-bit GPE status and enable registers in this GPE
368 * block, saving all of them. Find all currently active GP events.
370 for (i = 0; i < gpe_block->register_count; i++) {
372 /* Get the next status/enable pair */
374 gpe_register_info = &gpe_block->register_info[i];
377 * Optimization: If there are no GPEs enabled within this
378 * register, we can safely ignore the entire register.
380 if (!(gpe_register_info->enable_for_run |
381 gpe_register_info->enable_for_wake)) {
385 /* Read the Status Register */
388 acpi_hw_read(&status_reg,
389 &gpe_register_info->status_address);
390 if (ACPI_FAILURE(status)) {
391 goto unlock_and_exit;
394 /* Read the Enable Register */
397 acpi_hw_read(&enable_reg,
398 &gpe_register_info->enable_address);
399 if (ACPI_FAILURE(status)) {
400 goto unlock_and_exit;
403 ACPI_DEBUG_PRINT((ACPI_DB_INTERRUPTS,
404 "Read GPE Register at GPE%02X: Status=%02X, Enable=%02X\n",
405 gpe_register_info->base_gpe_number,
406 status_reg, enable_reg));
408 /* Check if there is anything active at all in this register */
410 enabled_status_byte = (u8) (status_reg & enable_reg);
411 if (!enabled_status_byte) {
413 /* No active GPEs in this register, move on */
418 /* Now look at the individual GPEs in this byte register */
420 for (j = 0; j < ACPI_GPE_REGISTER_WIDTH; j++) {
422 /* Examine one GPE bit */
424 if (enabled_status_byte & (1 << j)) {
426 * Found an active GPE. Dispatch the event to a handler
430 acpi_ev_gpe_dispatch(gpe_block->
433 event_info[((acpi_size) i * ACPI_GPE_REGISTER_WIDTH) + j], j + gpe_register_info->base_gpe_number);
438 gpe_block = gpe_block->next;
443 acpi_os_release_lock(acpi_gbl_gpe_lock, flags);
447 /*******************************************************************************
449 * FUNCTION: acpi_ev_asynch_execute_gpe_method
451 * PARAMETERS: Context (gpe_event_info) - Info for this GPE
455 * DESCRIPTION: Perform the actual execution of a GPE control method. This
456 * function is called from an invocation of acpi_os_execute and
457 * therefore does NOT execute at interrupt level - so that
458 * the control method itself is not executed in the context of
459 * an interrupt handler.
461 ******************************************************************************/
463 static void ACPI_SYSTEM_XFACE acpi_ev_asynch_execute_gpe_method(void *context)
465 struct acpi_gpe_event_info *gpe_event_info = context;
467 struct acpi_gpe_event_info *local_gpe_event_info;
468 struct acpi_evaluate_info *info;
469 struct acpi_gpe_notify_object *notify_object;
471 ACPI_FUNCTION_TRACE(ev_asynch_execute_gpe_method);
473 /* Allocate a local GPE block */
475 local_gpe_event_info =
476 ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_gpe_event_info));
477 if (!local_gpe_event_info) {
478 ACPI_EXCEPTION((AE_INFO, AE_NO_MEMORY, "while handling a GPE"));
482 status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
483 if (ACPI_FAILURE(status)) {
484 ACPI_FREE(local_gpe_event_info);
488 /* Must revalidate the gpe_number/gpe_block */
490 if (!acpi_ev_valid_gpe_event(gpe_event_info)) {
491 status = acpi_ut_release_mutex(ACPI_MTX_EVENTS);
492 ACPI_FREE(local_gpe_event_info);
497 * Take a snapshot of the GPE info for this level - we copy the info to
498 * prevent a race condition with remove_handler/remove_block.
500 ACPI_MEMCPY(local_gpe_event_info, gpe_event_info,
501 sizeof(struct acpi_gpe_event_info));
503 status = acpi_ut_release_mutex(ACPI_MTX_EVENTS);
504 if (ACPI_FAILURE(status)) {
508 /* Do the correct dispatch - normal method or implicit notify */
510 switch (local_gpe_event_info->flags & ACPI_GPE_DISPATCH_MASK) {
511 case ACPI_GPE_DISPATCH_NOTIFY:
515 * Dispatch a DEVICE_WAKE notify to the appropriate handler.
516 * NOTE: the request is queued for execution after this method
517 * completes. The notify handlers are NOT invoked synchronously
518 * from this thread -- because handlers may in turn run other
521 status = acpi_ev_queue_notify_request(
522 local_gpe_event_info->dispatch.device.node,
523 ACPI_NOTIFY_DEVICE_WAKE);
525 notify_object = local_gpe_event_info->dispatch.device.next;
526 while (ACPI_SUCCESS(status) && notify_object) {
527 status = acpi_ev_queue_notify_request(
529 ACPI_NOTIFY_DEVICE_WAKE);
530 notify_object = notify_object->next;
535 case ACPI_GPE_DISPATCH_METHOD:
537 /* Allocate the evaluation information block */
539 info = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_evaluate_info));
541 status = AE_NO_MEMORY;
544 * Invoke the GPE Method (_Lxx, _Exx) i.e., evaluate the _Lxx/_Exx
545 * control method that corresponds to this GPE
548 local_gpe_event_info->dispatch.method_node;
549 info->flags = ACPI_IGNORE_RETURN_VALUE;
551 status = acpi_ns_evaluate(info);
555 if (ACPI_FAILURE(status)) {
556 ACPI_EXCEPTION((AE_INFO, status,
557 "while evaluating GPE method [%4.4s]",
558 acpi_ut_get_node_name
559 (local_gpe_event_info->dispatch.
566 return_VOID; /* Should never happen */
569 /* Defer enabling of GPE until all notify handlers are done */
571 status = acpi_os_execute(OSL_NOTIFY_HANDLER,
572 acpi_ev_asynch_enable_gpe,
573 local_gpe_event_info);
574 if (ACPI_FAILURE(status)) {
575 ACPI_FREE(local_gpe_event_info);
581 /*******************************************************************************
583 * FUNCTION: acpi_ev_asynch_enable_gpe
585 * PARAMETERS: Context (gpe_event_info) - Info for this GPE
586 * Callback from acpi_os_execute
590 * DESCRIPTION: Asynchronous clear/enable for GPE. This allows the GPE to
591 * complete (i.e., finish execution of Notify)
593 ******************************************************************************/
595 static void ACPI_SYSTEM_XFACE acpi_ev_asynch_enable_gpe(void *context)
597 struct acpi_gpe_event_info *gpe_event_info = context;
599 (void)acpi_ev_finish_gpe(gpe_event_info);
601 ACPI_FREE(gpe_event_info);
606 /*******************************************************************************
608 * FUNCTION: acpi_ev_finish_gpe
610 * PARAMETERS: gpe_event_info - Info for this GPE
614 * DESCRIPTION: Clear/Enable a GPE. Common code that is used after execution
615 * of a GPE method or a synchronous or asynchronous GPE handler.
617 ******************************************************************************/
619 acpi_status acpi_ev_finish_gpe(struct acpi_gpe_event_info *gpe_event_info)
623 if ((gpe_event_info->flags & ACPI_GPE_XRUPT_TYPE_MASK) ==
624 ACPI_GPE_LEVEL_TRIGGERED) {
626 * GPE is level-triggered, we clear the GPE status bit after
627 * handling the event.
629 status = acpi_hw_clear_gpe(gpe_event_info);
630 if (ACPI_FAILURE(status)) {
636 * Enable this GPE, conditionally. This means that the GPE will
637 * only be physically enabled if the enable_for_run bit is set
640 (void)acpi_hw_low_set_gpe(gpe_event_info, ACPI_GPE_CONDITIONAL_ENABLE);
645 /*******************************************************************************
647 * FUNCTION: acpi_ev_gpe_dispatch
649 * PARAMETERS: gpe_device - Device node. NULL for GPE0/GPE1
650 * gpe_event_info - Info for this GPE
651 * gpe_number - Number relative to the parent GPE block
653 * RETURN: INTERRUPT_HANDLED or INTERRUPT_NOT_HANDLED
655 * DESCRIPTION: Dispatch a General Purpose Event to either a function (e.g. EC)
656 * or method (e.g. _Lxx/_Exx) handler.
658 * This function executes at interrupt level.
660 ******************************************************************************/
663 acpi_ev_gpe_dispatch(struct acpi_namespace_node *gpe_device,
664 struct acpi_gpe_event_info *gpe_event_info, u32 gpe_number)
669 ACPI_FUNCTION_TRACE(ev_gpe_dispatch);
671 /* Invoke global event handler if present */
674 if (acpi_gbl_global_event_handler) {
675 acpi_gbl_global_event_handler(ACPI_EVENT_TYPE_GPE, gpe_device,
677 acpi_gbl_global_event_handler_context);
681 * If edge-triggered, clear the GPE status bit now. Note that
682 * level-triggered events are cleared after the GPE is serviced.
684 if ((gpe_event_info->flags & ACPI_GPE_XRUPT_TYPE_MASK) ==
685 ACPI_GPE_EDGE_TRIGGERED) {
686 status = acpi_hw_clear_gpe(gpe_event_info);
687 if (ACPI_FAILURE(status)) {
688 ACPI_EXCEPTION((AE_INFO, status,
689 "Unable to clear GPE%02X", gpe_number));
690 return_UINT32(ACPI_INTERRUPT_NOT_HANDLED);
695 * Always disable the GPE so that it does not keep firing before
696 * any asynchronous activity completes (either from the execution
697 * of a GPE method or an asynchronous GPE handler.)
699 * If there is no handler or method to run, just disable the
700 * GPE and leave it disabled permanently to prevent further such
701 * pointless events from firing.
703 status = acpi_hw_low_set_gpe(gpe_event_info, ACPI_GPE_DISABLE);
704 if (ACPI_FAILURE(status)) {
705 ACPI_EXCEPTION((AE_INFO, status,
706 "Unable to disable GPE%02X", gpe_number));
707 return_UINT32(ACPI_INTERRUPT_NOT_HANDLED);
711 * Dispatch the GPE to either an installed handler or the control
712 * method associated with this GPE (_Lxx or _Exx). If a handler
713 * exists, we invoke it and do not attempt to run the method.
714 * If there is neither a handler nor a method, leave the GPE
717 switch (gpe_event_info->flags & ACPI_GPE_DISPATCH_MASK) {
718 case ACPI_GPE_DISPATCH_HANDLER:
720 /* Invoke the installed handler (at interrupt level) */
723 gpe_event_info->dispatch.handler->address(gpe_device,
729 /* If requested, clear (if level-triggered) and reenable the GPE */
731 if (return_value & ACPI_REENABLE_GPE) {
732 (void)acpi_ev_finish_gpe(gpe_event_info);
736 case ACPI_GPE_DISPATCH_METHOD:
737 case ACPI_GPE_DISPATCH_NOTIFY:
740 * Execute the method associated with the GPE
741 * NOTE: Level-triggered GPEs are cleared after the method completes.
743 status = acpi_os_execute(OSL_GPE_HANDLER,
744 acpi_ev_asynch_execute_gpe_method,
746 if (ACPI_FAILURE(status)) {
747 ACPI_EXCEPTION((AE_INFO, status,
748 "Unable to queue handler for GPE%2X - event disabled",
756 * No handler or method to run!
757 * 03/2010: This case should no longer be possible. We will not allow
758 * a GPE to be enabled if it has no handler or method.
761 "No handler or method for GPE%02X, disabling event",
767 return_UINT32(ACPI_INTERRUPT_HANDLED);