ACPICA: Update copyright to 2007.
[linux-2.6.git] / drivers / acpi / events / evgpe.c
blobdfac3ecc596ebfd9314148d3a54ba80648c9d8b0
1 /******************************************************************************
3 * Module Name: evgpe - General Purpose Event handling and dispatch
5 *****************************************************************************/
7 /*
8 * Copyright (C) 2000 - 2007, R. Byron Moore
9 * All rights reserved.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
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.
30 * NO WARRANTY
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>
45 #include <acpi/acevents.h>
46 #include <acpi/acnamesp.h>
48 #define _COMPONENT ACPI_EVENTS
49 ACPI_MODULE_NAME("evgpe")
51 /* Local prototypes */
52 static void ACPI_SYSTEM_XFACE acpi_ev_asynch_execute_gpe_method(void *context);
54 /*******************************************************************************
56 * FUNCTION: acpi_ev_set_gpe_type
58 * PARAMETERS: gpe_event_info - GPE to set
59 * Type - New type
61 * RETURN: Status
63 * DESCRIPTION: Sets the new type for the GPE (wake, run, or wake/run)
65 ******************************************************************************/
67 acpi_status
68 acpi_ev_set_gpe_type(struct acpi_gpe_event_info *gpe_event_info, u8 type)
70 acpi_status status;
72 ACPI_FUNCTION_TRACE(ev_set_gpe_type);
74 /* Validate type and update register enable masks */
76 switch (type) {
77 case ACPI_GPE_TYPE_WAKE:
78 case ACPI_GPE_TYPE_RUNTIME:
79 case ACPI_GPE_TYPE_WAKE_RUN:
80 break;
82 default:
83 return_ACPI_STATUS(AE_BAD_PARAMETER);
86 /* Disable the GPE if currently enabled */
88 status = acpi_ev_disable_gpe(gpe_event_info);
90 /* Type was validated above */
92 gpe_event_info->flags &= ~ACPI_GPE_TYPE_MASK; /* Clear type bits */
93 gpe_event_info->flags |= type; /* Insert type */
94 return_ACPI_STATUS(status);
97 /*******************************************************************************
99 * FUNCTION: acpi_ev_update_gpe_enable_masks
101 * PARAMETERS: gpe_event_info - GPE to update
102 * Type - What to do: ACPI_GPE_DISABLE or
103 * ACPI_GPE_ENABLE
105 * RETURN: Status
107 * DESCRIPTION: Updates GPE register enable masks based on the GPE type
109 ******************************************************************************/
111 acpi_status
112 acpi_ev_update_gpe_enable_masks(struct acpi_gpe_event_info *gpe_event_info,
113 u8 type)
115 struct acpi_gpe_register_info *gpe_register_info;
116 u8 register_bit;
118 ACPI_FUNCTION_TRACE(ev_update_gpe_enable_masks);
120 gpe_register_info = gpe_event_info->register_info;
121 if (!gpe_register_info) {
122 return_ACPI_STATUS(AE_NOT_EXIST);
124 register_bit = (u8)
125 (1 <<
126 (gpe_event_info->gpe_number - gpe_register_info->base_gpe_number));
128 /* 1) Disable case. Simply clear all enable bits */
130 if (type == ACPI_GPE_DISABLE) {
131 ACPI_CLEAR_BIT(gpe_register_info->enable_for_wake,
132 register_bit);
133 ACPI_CLEAR_BIT(gpe_register_info->enable_for_run, register_bit);
134 return_ACPI_STATUS(AE_OK);
137 /* 2) Enable case. Set/Clear the appropriate enable bits */
139 switch (gpe_event_info->flags & ACPI_GPE_TYPE_MASK) {
140 case ACPI_GPE_TYPE_WAKE:
141 ACPI_SET_BIT(gpe_register_info->enable_for_wake, register_bit);
142 ACPI_CLEAR_BIT(gpe_register_info->enable_for_run, register_bit);
143 break;
145 case ACPI_GPE_TYPE_RUNTIME:
146 ACPI_CLEAR_BIT(gpe_register_info->enable_for_wake,
147 register_bit);
148 ACPI_SET_BIT(gpe_register_info->enable_for_run, register_bit);
149 break;
151 case ACPI_GPE_TYPE_WAKE_RUN:
152 ACPI_SET_BIT(gpe_register_info->enable_for_wake, register_bit);
153 ACPI_SET_BIT(gpe_register_info->enable_for_run, register_bit);
154 break;
156 default:
157 return_ACPI_STATUS(AE_BAD_PARAMETER);
160 return_ACPI_STATUS(AE_OK);
163 /*******************************************************************************
165 * FUNCTION: acpi_ev_enable_gpe
167 * PARAMETERS: gpe_event_info - GPE to enable
168 * write_to_hardware - Enable now, or just mark data structs
169 * (WAKE GPEs should be deferred)
171 * RETURN: Status
173 * DESCRIPTION: Enable a GPE based on the GPE type
175 ******************************************************************************/
177 acpi_status
178 acpi_ev_enable_gpe(struct acpi_gpe_event_info *gpe_event_info,
179 u8 write_to_hardware)
181 acpi_status status;
183 ACPI_FUNCTION_TRACE(ev_enable_gpe);
185 /* Make sure HW enable masks are updated */
187 status =
188 acpi_ev_update_gpe_enable_masks(gpe_event_info, ACPI_GPE_ENABLE);
189 if (ACPI_FAILURE(status)) {
190 return_ACPI_STATUS(status);
193 /* Mark wake-enabled or HW enable, or both */
195 switch (gpe_event_info->flags & ACPI_GPE_TYPE_MASK) {
196 case ACPI_GPE_TYPE_WAKE:
198 ACPI_SET_BIT(gpe_event_info->flags, ACPI_GPE_WAKE_ENABLED);
199 break;
201 case ACPI_GPE_TYPE_WAKE_RUN:
203 ACPI_SET_BIT(gpe_event_info->flags, ACPI_GPE_WAKE_ENABLED);
205 /*lint -fallthrough */
207 case ACPI_GPE_TYPE_RUNTIME:
209 ACPI_SET_BIT(gpe_event_info->flags, ACPI_GPE_RUN_ENABLED);
211 if (write_to_hardware) {
213 /* Clear the GPE (of stale events), then enable it */
215 status = acpi_hw_clear_gpe(gpe_event_info);
216 if (ACPI_FAILURE(status)) {
217 return_ACPI_STATUS(status);
220 /* Enable the requested runtime GPE */
222 status = acpi_hw_write_gpe_enable_reg(gpe_event_info);
224 break;
226 default:
227 return_ACPI_STATUS(AE_BAD_PARAMETER);
230 return_ACPI_STATUS(AE_OK);
233 /*******************************************************************************
235 * FUNCTION: acpi_ev_disable_gpe
237 * PARAMETERS: gpe_event_info - GPE to disable
239 * RETURN: Status
241 * DESCRIPTION: Disable a GPE based on the GPE type
243 ******************************************************************************/
245 acpi_status acpi_ev_disable_gpe(struct acpi_gpe_event_info *gpe_event_info)
247 acpi_status status;
249 ACPI_FUNCTION_TRACE(ev_disable_gpe);
251 if (!(gpe_event_info->flags & ACPI_GPE_ENABLE_MASK)) {
252 return_ACPI_STATUS(AE_OK);
255 /* Make sure HW enable masks are updated */
257 status =
258 acpi_ev_update_gpe_enable_masks(gpe_event_info, ACPI_GPE_DISABLE);
259 if (ACPI_FAILURE(status)) {
260 return_ACPI_STATUS(status);
263 /* Mark wake-disabled or HW disable, or both */
265 switch (gpe_event_info->flags & ACPI_GPE_TYPE_MASK) {
266 case ACPI_GPE_TYPE_WAKE:
267 ACPI_CLEAR_BIT(gpe_event_info->flags, ACPI_GPE_WAKE_ENABLED);
268 break;
270 case ACPI_GPE_TYPE_WAKE_RUN:
271 ACPI_CLEAR_BIT(gpe_event_info->flags, ACPI_GPE_WAKE_ENABLED);
273 /*lint -fallthrough */
275 case ACPI_GPE_TYPE_RUNTIME:
277 /* Disable the requested runtime GPE */
279 ACPI_CLEAR_BIT(gpe_event_info->flags, ACPI_GPE_RUN_ENABLED);
280 status = acpi_hw_write_gpe_enable_reg(gpe_event_info);
281 break;
283 default:
284 return_ACPI_STATUS(AE_BAD_PARAMETER);
287 return_ACPI_STATUS(AE_OK);
290 /*******************************************************************************
292 * FUNCTION: acpi_ev_get_gpe_event_info
294 * PARAMETERS: gpe_device - Device node. NULL for GPE0/GPE1
295 * gpe_number - Raw GPE number
297 * RETURN: A GPE event_info struct. NULL if not a valid GPE
299 * DESCRIPTION: Returns the event_info struct associated with this GPE.
300 * Validates the gpe_block and the gpe_number
302 * Should be called only when the GPE lists are semaphore locked
303 * and not subject to change.
305 ******************************************************************************/
307 struct acpi_gpe_event_info *acpi_ev_get_gpe_event_info(acpi_handle gpe_device,
308 u32 gpe_number)
310 union acpi_operand_object *obj_desc;
311 struct acpi_gpe_block_info *gpe_block;
312 acpi_native_uint i;
314 ACPI_FUNCTION_ENTRY();
316 /* A NULL gpe_block means use the FADT-defined GPE block(s) */
318 if (!gpe_device) {
320 /* Examine GPE Block 0 and 1 (These blocks are permanent) */
322 for (i = 0; i < ACPI_MAX_GPE_BLOCKS; i++) {
323 gpe_block = acpi_gbl_gpe_fadt_blocks[i];
324 if (gpe_block) {
325 if ((gpe_number >= gpe_block->block_base_number)
326 && (gpe_number <
327 gpe_block->block_base_number +
328 (gpe_block->register_count * 8))) {
329 return (&gpe_block->
330 event_info[gpe_number -
331 gpe_block->
332 block_base_number]);
337 /* The gpe_number was not in the range of either FADT GPE block */
339 return (NULL);
342 /* A Non-NULL gpe_device means this is a GPE Block Device */
344 obj_desc =
345 acpi_ns_get_attached_object((struct acpi_namespace_node *)
346 gpe_device);
347 if (!obj_desc || !obj_desc->device.gpe_block) {
348 return (NULL);
351 gpe_block = obj_desc->device.gpe_block;
353 if ((gpe_number >= gpe_block->block_base_number) &&
354 (gpe_number <
355 gpe_block->block_base_number + (gpe_block->register_count * 8))) {
356 return (&gpe_block->
357 event_info[gpe_number - gpe_block->block_base_number]);
360 return (NULL);
363 /*******************************************************************************
365 * FUNCTION: acpi_ev_gpe_detect
367 * PARAMETERS: gpe_xrupt_list - Interrupt block for this interrupt.
368 * Can have multiple GPE blocks attached.
370 * RETURN: INTERRUPT_HANDLED or INTERRUPT_NOT_HANDLED
372 * DESCRIPTION: Detect if any GP events have occurred. This function is
373 * executed at interrupt level.
375 ******************************************************************************/
377 u32 acpi_ev_gpe_detect(struct acpi_gpe_xrupt_info * gpe_xrupt_list)
379 acpi_status status;
380 struct acpi_gpe_block_info *gpe_block;
381 struct acpi_gpe_register_info *gpe_register_info;
382 u32 int_status = ACPI_INTERRUPT_NOT_HANDLED;
383 u8 enabled_status_byte;
384 u32 status_reg;
385 u32 enable_reg;
386 acpi_cpu_flags flags;
387 acpi_native_uint i;
388 acpi_native_uint j;
390 ACPI_FUNCTION_NAME(ev_gpe_detect);
392 /* Check for the case where there are no GPEs */
394 if (!gpe_xrupt_list) {
395 return (int_status);
399 * We need to obtain the GPE lock for both the data structs and registers
400 * Note: Not necessary to obtain the hardware lock, since the GPE registers
401 * are owned by the gpe_lock.
403 flags = acpi_os_acquire_lock(acpi_gbl_gpe_lock);
405 /* Examine all GPE blocks attached to this interrupt level */
407 gpe_block = gpe_xrupt_list->gpe_block_list_head;
408 while (gpe_block) {
410 * Read all of the 8-bit GPE status and enable registers
411 * in this GPE block, saving all of them.
412 * Find all currently active GP events.
414 for (i = 0; i < gpe_block->register_count; i++) {
416 /* Get the next status/enable pair */
418 gpe_register_info = &gpe_block->register_info[i];
420 /* Read the Status Register */
422 status =
423 acpi_hw_low_level_read(ACPI_GPE_REGISTER_WIDTH,
424 &status_reg,
425 &gpe_register_info->
426 status_address);
427 if (ACPI_FAILURE(status)) {
428 goto unlock_and_exit;
431 /* Read the Enable Register */
433 status =
434 acpi_hw_low_level_read(ACPI_GPE_REGISTER_WIDTH,
435 &enable_reg,
436 &gpe_register_info->
437 enable_address);
438 if (ACPI_FAILURE(status)) {
439 goto unlock_and_exit;
442 ACPI_DEBUG_PRINT((ACPI_DB_INTERRUPTS,
443 "Read GPE Register at GPE%X: Status=%02X, Enable=%02X\n",
444 gpe_register_info->base_gpe_number,
445 status_reg, enable_reg));
447 /* Check if there is anything active at all in this register */
449 enabled_status_byte = (u8) (status_reg & enable_reg);
450 if (!enabled_status_byte) {
452 /* No active GPEs in this register, move on */
454 continue;
457 /* Now look at the individual GPEs in this byte register */
459 for (j = 0; j < ACPI_GPE_REGISTER_WIDTH; j++) {
461 /* Examine one GPE bit */
463 if (enabled_status_byte & (1 << j)) {
465 * Found an active GPE. Dispatch the event to a handler
466 * or method.
468 int_status |=
469 acpi_ev_gpe_dispatch(&gpe_block->
470 event_info[(i *
471 ACPI_GPE_REGISTER_WIDTH)
474 (u32) j +
475 gpe_register_info->
476 base_gpe_number);
481 gpe_block = gpe_block->next;
484 unlock_and_exit:
486 acpi_os_release_lock(acpi_gbl_gpe_lock, flags);
487 return (int_status);
490 /*******************************************************************************
492 * FUNCTION: acpi_ev_asynch_execute_gpe_method
494 * PARAMETERS: Context (gpe_event_info) - Info for this GPE
496 * RETURN: None
498 * DESCRIPTION: Perform the actual execution of a GPE control method. This
499 * function is called from an invocation of acpi_os_execute and
500 * therefore does NOT execute at interrupt level - so that
501 * the control method itself is not executed in the context of
502 * an interrupt handler.
504 ******************************************************************************/
506 static void ACPI_SYSTEM_XFACE acpi_ev_asynch_execute_gpe_method(void *context)
508 struct acpi_gpe_event_info *gpe_event_info = (void *)context;
509 acpi_status status;
510 struct acpi_gpe_event_info local_gpe_event_info;
511 struct acpi_evaluate_info *info;
513 ACPI_FUNCTION_TRACE(ev_asynch_execute_gpe_method);
515 status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
516 if (ACPI_FAILURE(status)) {
517 return_VOID;
520 /* Must revalidate the gpe_number/gpe_block */
522 if (!acpi_ev_valid_gpe_event(gpe_event_info)) {
523 status = acpi_ut_release_mutex(ACPI_MTX_EVENTS);
524 return_VOID;
527 /* Set the GPE flags for return to enabled state */
529 (void)acpi_ev_enable_gpe(gpe_event_info, FALSE);
532 * Take a snapshot of the GPE info for this level - we copy the
533 * info to prevent a race condition with remove_handler/remove_block.
535 ACPI_MEMCPY(&local_gpe_event_info, gpe_event_info,
536 sizeof(struct acpi_gpe_event_info));
538 status = acpi_ut_release_mutex(ACPI_MTX_EVENTS);
539 if (ACPI_FAILURE(status)) {
540 return_VOID;
544 * Must check for control method type dispatch one more
545 * time to avoid race with ev_gpe_install_handler
547 if ((local_gpe_event_info.flags & ACPI_GPE_DISPATCH_MASK) ==
548 ACPI_GPE_DISPATCH_METHOD) {
550 /* Allocate the evaluation information block */
552 info = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_evaluate_info));
553 if (!info) {
554 status = AE_NO_MEMORY;
555 } else {
557 * Invoke the GPE Method (_Lxx, _Exx) i.e., evaluate the _Lxx/_Exx
558 * control method that corresponds to this GPE
560 info->prefix_node =
561 local_gpe_event_info.dispatch.method_node;
562 info->parameters =
563 ACPI_CAST_PTR(union acpi_operand_object *,
564 gpe_event_info);
565 info->parameter_type = ACPI_PARAM_GPE;
566 info->flags = ACPI_IGNORE_RETURN_VALUE;
568 status = acpi_ns_evaluate(info);
569 ACPI_FREE(info);
572 if (ACPI_FAILURE(status)) {
573 ACPI_EXCEPTION((AE_INFO, status,
574 "while evaluating GPE method [%4.4s]",
575 acpi_ut_get_node_name
576 (local_gpe_event_info.dispatch.
577 method_node)));
581 if ((local_gpe_event_info.flags & ACPI_GPE_XRUPT_TYPE_MASK) ==
582 ACPI_GPE_LEVEL_TRIGGERED) {
584 * GPE is level-triggered, we clear the GPE status bit after
585 * handling the event.
587 status = acpi_hw_clear_gpe(&local_gpe_event_info);
588 if (ACPI_FAILURE(status)) {
589 return_VOID;
593 /* Enable this GPE */
595 (void)acpi_hw_write_gpe_enable_reg(&local_gpe_event_info);
596 return_VOID;
599 /*******************************************************************************
601 * FUNCTION: acpi_ev_gpe_dispatch
603 * PARAMETERS: gpe_event_info - Info for this GPE
604 * gpe_number - Number relative to the parent GPE block
606 * RETURN: INTERRUPT_HANDLED or INTERRUPT_NOT_HANDLED
608 * DESCRIPTION: Dispatch a General Purpose Event to either a function (e.g. EC)
609 * or method (e.g. _Lxx/_Exx) handler.
611 * This function executes at interrupt level.
613 ******************************************************************************/
616 acpi_ev_gpe_dispatch(struct acpi_gpe_event_info *gpe_event_info, u32 gpe_number)
618 acpi_status status;
620 ACPI_FUNCTION_TRACE(ev_gpe_dispatch);
622 acpi_gpe_count++;
625 * If edge-triggered, clear the GPE status bit now. Note that
626 * level-triggered events are cleared after the GPE is serviced.
628 if ((gpe_event_info->flags & ACPI_GPE_XRUPT_TYPE_MASK) ==
629 ACPI_GPE_EDGE_TRIGGERED) {
630 status = acpi_hw_clear_gpe(gpe_event_info);
631 if (ACPI_FAILURE(status)) {
632 ACPI_EXCEPTION((AE_INFO, status,
633 "Unable to clear GPE[%2X]",
634 gpe_number));
635 return_UINT32(ACPI_INTERRUPT_NOT_HANDLED);
639 if (!acpi_gbl_system_awake_and_running) {
641 * We just woke up because of a wake GPE. Disable any further GPEs
642 * until we are fully up and running (Only wake GPEs should be enabled
643 * at this time, but we just brute-force disable them all.)
644 * 1) We must disable this particular wake GPE so it won't fire again
645 * 2) We want to disable all wake GPEs, since we are now awake
647 (void)acpi_hw_disable_all_gpes();
651 * Dispatch the GPE to either an installed handler, or the control method
652 * associated with this GPE (_Lxx or _Exx). If a handler exists, we invoke
653 * it and do not attempt to run the method. If there is neither a handler
654 * nor a method, we disable this GPE to prevent further such pointless
655 * events from firing.
657 switch (gpe_event_info->flags & ACPI_GPE_DISPATCH_MASK) {
658 case ACPI_GPE_DISPATCH_HANDLER:
661 * Invoke the installed handler (at interrupt level)
662 * Ignore return status for now. TBD: leave GPE disabled on error?
664 (void)gpe_event_info->dispatch.handler->address(gpe_event_info->
665 dispatch.
666 handler->
667 context);
669 /* It is now safe to clear level-triggered events. */
671 if ((gpe_event_info->flags & ACPI_GPE_XRUPT_TYPE_MASK) ==
672 ACPI_GPE_LEVEL_TRIGGERED) {
673 status = acpi_hw_clear_gpe(gpe_event_info);
674 if (ACPI_FAILURE(status)) {
675 ACPI_EXCEPTION((AE_INFO, status,
676 "Unable to clear GPE[%2X]",
677 gpe_number));
678 return_UINT32(ACPI_INTERRUPT_NOT_HANDLED);
681 break;
683 case ACPI_GPE_DISPATCH_METHOD:
686 * Disable the GPE, so it doesn't keep firing before the method has a
687 * chance to run (it runs asynchronously with interrupts enabled).
689 status = acpi_ev_disable_gpe(gpe_event_info);
690 if (ACPI_FAILURE(status)) {
691 ACPI_EXCEPTION((AE_INFO, status,
692 "Unable to disable GPE[%2X]",
693 gpe_number));
694 return_UINT32(ACPI_INTERRUPT_NOT_HANDLED);
698 * Execute the method associated with the GPE
699 * NOTE: Level-triggered GPEs are cleared after the method completes.
701 status = acpi_os_execute(OSL_GPE_HANDLER,
702 acpi_ev_asynch_execute_gpe_method,
703 gpe_event_info);
704 if (ACPI_FAILURE(status)) {
705 ACPI_EXCEPTION((AE_INFO, status,
706 "Unable to queue handler for GPE[%2X] - event disabled",
707 gpe_number));
709 break;
711 default:
713 /* No handler or method to run! */
715 ACPI_ERROR((AE_INFO,
716 "No handler or method for GPE[%2X], disabling event",
717 gpe_number));
720 * Disable the GPE. The GPE will remain disabled until the ACPI
721 * Core Subsystem is restarted, or a handler is installed.
723 status = acpi_ev_disable_gpe(gpe_event_info);
724 if (ACPI_FAILURE(status)) {
725 ACPI_EXCEPTION((AE_INFO, status,
726 "Unable to disable GPE[%2X]",
727 gpe_number));
728 return_UINT32(ACPI_INTERRUPT_NOT_HANDLED);
730 break;
733 return_UINT32(ACPI_INTERRUPT_HANDLED);