1 /******************************************************************************
3 * Module Name: evxfgpe - External Interfaces for General Purpose Events (GPEs)
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2013, 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 <linux/export.h>
45 #include <acpi/acpi.h>
50 #define _COMPONENT ACPI_EVENTS
51 ACPI_MODULE_NAME("evxfgpe")
53 #if (!ACPI_REDUCED_HARDWARE) /* Entire module */
54 /*******************************************************************************
56 * FUNCTION: acpi_update_all_gpes
62 * DESCRIPTION: Complete GPE initialization and enable all GPEs that have
63 * associated _Lxx or _Exx methods and are not pointed to by any
64 * device _PRW methods (this indicates that these GPEs are
65 * generally intended for system or device wakeup. Such GPEs
66 * have to be enabled directly when the devices whose _PRW
67 * methods point to them are set up for wakeup signaling.)
69 * NOTE: Should be called after any GPEs are added to the system. Primarily,
70 * after the system _PRW methods have been run, but also after a GPE Block
71 * Device has been added or if any new GPE methods have been added via a
74 ******************************************************************************/
76 acpi_status
acpi_update_all_gpes(void)
80 ACPI_FUNCTION_TRACE(acpi_update_all_gpes
);
82 status
= acpi_ut_acquire_mutex(ACPI_MTX_EVENTS
);
83 if (ACPI_FAILURE(status
)) {
84 return_ACPI_STATUS(status
);
87 if (acpi_gbl_all_gpes_initialized
) {
91 status
= acpi_ev_walk_gpe_list(acpi_ev_initialize_gpe_block
, NULL
);
92 if (ACPI_SUCCESS(status
)) {
93 acpi_gbl_all_gpes_initialized
= TRUE
;
97 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS
);
99 return_ACPI_STATUS(status
);
102 ACPI_EXPORT_SYMBOL(acpi_update_all_gpes
)
104 /*******************************************************************************
106 * FUNCTION: acpi_enable_gpe
108 * PARAMETERS: gpe_device - Parent GPE Device. NULL for GPE0/GPE1
109 * gpe_number - GPE level within the GPE block
113 * DESCRIPTION: Add a reference to a GPE. On the first reference, the GPE is
116 ******************************************************************************/
118 acpi_status
acpi_enable_gpe(acpi_handle gpe_device
, u32 gpe_number
)
120 acpi_status status
= AE_BAD_PARAMETER
;
121 struct acpi_gpe_event_info
*gpe_event_info
;
122 acpi_cpu_flags flags
;
124 ACPI_FUNCTION_TRACE(acpi_enable_gpe
);
126 flags
= acpi_os_acquire_lock(acpi_gbl_gpe_lock
);
128 /* Ensure that we have a valid GPE number */
130 gpe_event_info
= acpi_ev_get_gpe_event_info(gpe_device
, gpe_number
);
131 if (gpe_event_info
) {
132 status
= acpi_ev_add_gpe_reference(gpe_event_info
);
135 acpi_os_release_lock(acpi_gbl_gpe_lock
, flags
);
136 return_ACPI_STATUS(status
);
138 ACPI_EXPORT_SYMBOL(acpi_enable_gpe
)
140 /*******************************************************************************
142 * FUNCTION: acpi_disable_gpe
144 * PARAMETERS: gpe_device - Parent GPE Device. NULL for GPE0/GPE1
145 * gpe_number - GPE level within the GPE block
149 * DESCRIPTION: Remove a reference to a GPE. When the last reference is
150 * removed, only then is the GPE disabled (for runtime GPEs), or
151 * the GPE mask bit disabled (for wake GPEs)
153 ******************************************************************************/
155 acpi_status
acpi_disable_gpe(acpi_handle gpe_device
, u32 gpe_number
)
157 acpi_status status
= AE_BAD_PARAMETER
;
158 struct acpi_gpe_event_info
*gpe_event_info
;
159 acpi_cpu_flags flags
;
161 ACPI_FUNCTION_TRACE(acpi_disable_gpe
);
163 flags
= acpi_os_acquire_lock(acpi_gbl_gpe_lock
);
165 /* Ensure that we have a valid GPE number */
167 gpe_event_info
= acpi_ev_get_gpe_event_info(gpe_device
, gpe_number
);
168 if (gpe_event_info
) {
169 status
= acpi_ev_remove_gpe_reference(gpe_event_info
) ;
172 acpi_os_release_lock(acpi_gbl_gpe_lock
, flags
);
173 return_ACPI_STATUS(status
);
176 ACPI_EXPORT_SYMBOL(acpi_disable_gpe
)
179 /*******************************************************************************
181 * FUNCTION: acpi_setup_gpe_for_wake
183 * PARAMETERS: wake_device - Device associated with the GPE (via _PRW)
184 * gpe_device - Parent GPE Device. NULL for GPE0/GPE1
185 * gpe_number - GPE level within the GPE block
189 * DESCRIPTION: Mark a GPE as having the ability to wake the system. This
190 * interface is intended to be used as the host executes the
191 * _PRW methods (Power Resources for Wake) in the system tables.
192 * Each _PRW appears under a Device Object (The wake_device), and
193 * contains the info for the wake GPE associated with the
196 ******************************************************************************/
198 acpi_setup_gpe_for_wake(acpi_handle wake_device
,
199 acpi_handle gpe_device
, u32 gpe_number
)
202 struct acpi_gpe_event_info
*gpe_event_info
;
203 struct acpi_namespace_node
*device_node
;
204 struct acpi_gpe_notify_info
*notify
;
205 struct acpi_gpe_notify_info
*new_notify
;
206 acpi_cpu_flags flags
;
208 ACPI_FUNCTION_TRACE(acpi_setup_gpe_for_wake
);
210 /* Parameter Validation */
214 * By forcing wake_device to be valid, we automatically enable the
215 * implicit notify feature on all hosts.
217 return_ACPI_STATUS(AE_BAD_PARAMETER
);
220 /* Handle root object case */
222 if (wake_device
== ACPI_ROOT_OBJECT
) {
223 device_node
= acpi_gbl_root_node
;
226 ACPI_CAST_PTR(struct acpi_namespace_node
, wake_device
);
229 /* Validate wake_device is of type Device */
231 if (device_node
->type
!= ACPI_TYPE_DEVICE
) {
232 return_ACPI_STATUS (AE_BAD_PARAMETER
);
236 * Allocate a new notify object up front, in case it is needed.
237 * Memory allocation while holding a spinlock is a big no-no
240 new_notify
= ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_gpe_notify_info
));
242 return_ACPI_STATUS(AE_NO_MEMORY
);
245 flags
= acpi_os_acquire_lock(acpi_gbl_gpe_lock
);
247 /* Ensure that we have a valid GPE number */
249 gpe_event_info
= acpi_ev_get_gpe_event_info(gpe_device
, gpe_number
);
250 if (!gpe_event_info
) {
251 status
= AE_BAD_PARAMETER
;
252 goto unlock_and_exit
;
256 * If there is no method or handler for this GPE, then the
257 * wake_device will be notified whenever this GPE fires. This is
258 * known as an "implicit notify". Note: The GPE is assumed to be
259 * level-triggered (for windows compatibility).
261 if ((gpe_event_info
->flags
& ACPI_GPE_DISPATCH_MASK
) ==
262 ACPI_GPE_DISPATCH_NONE
) {
264 * This is the first device for implicit notify on this GPE.
265 * Just set the flags here, and enter the NOTIFY block below.
267 gpe_event_info
->flags
=
268 (ACPI_GPE_DISPATCH_NOTIFY
| ACPI_GPE_LEVEL_TRIGGERED
);
272 * If we already have an implicit notify on this GPE, add
273 * this device to the notify list.
275 if ((gpe_event_info
->flags
& ACPI_GPE_DISPATCH_MASK
) ==
276 ACPI_GPE_DISPATCH_NOTIFY
) {
278 /* Ensure that the device is not already in the list */
280 notify
= gpe_event_info
->dispatch
.notify_list
;
282 if (notify
->device_node
== device_node
) {
283 status
= AE_ALREADY_EXISTS
;
284 goto unlock_and_exit
;
286 notify
= notify
->next
;
289 /* Add this device to the notify list for this GPE */
291 new_notify
->device_node
= device_node
;
292 new_notify
->next
= gpe_event_info
->dispatch
.notify_list
;
293 gpe_event_info
->dispatch
.notify_list
= new_notify
;
297 /* Mark the GPE as a possible wake event */
299 gpe_event_info
->flags
|= ACPI_GPE_CAN_WAKE
;
303 acpi_os_release_lock(acpi_gbl_gpe_lock
, flags
);
305 /* Delete the notify object if it was not used above */
308 ACPI_FREE(new_notify
);
310 return_ACPI_STATUS(status
);
312 ACPI_EXPORT_SYMBOL(acpi_setup_gpe_for_wake
)
314 /*******************************************************************************
316 * FUNCTION: acpi_set_gpe_wake_mask
318 * PARAMETERS: gpe_device - Parent GPE Device. NULL for GPE0/GPE1
319 * gpe_number - GPE level within the GPE block
320 * action - Enable or Disable
324 * DESCRIPTION: Set or clear the GPE's wakeup enable mask bit. The GPE must
325 * already be marked as a WAKE GPE.
327 ******************************************************************************/
330 acpi_set_gpe_wake_mask(acpi_handle gpe_device
, u32 gpe_number
, u8 action
)
332 acpi_status status
= AE_OK
;
333 struct acpi_gpe_event_info
*gpe_event_info
;
334 struct acpi_gpe_register_info
*gpe_register_info
;
335 acpi_cpu_flags flags
;
338 ACPI_FUNCTION_TRACE(acpi_set_gpe_wake_mask
);
340 flags
= acpi_os_acquire_lock(acpi_gbl_gpe_lock
);
343 * Ensure that we have a valid GPE number and that this GPE is in
346 gpe_event_info
= acpi_ev_get_gpe_event_info(gpe_device
, gpe_number
);
347 if (!gpe_event_info
) {
348 status
= AE_BAD_PARAMETER
;
349 goto unlock_and_exit
;
352 if (!(gpe_event_info
->flags
& ACPI_GPE_CAN_WAKE
)) {
354 goto unlock_and_exit
;
357 gpe_register_info
= gpe_event_info
->register_info
;
358 if (!gpe_register_info
) {
359 status
= AE_NOT_EXIST
;
360 goto unlock_and_exit
;
363 register_bit
= acpi_hw_get_gpe_register_bit(gpe_event_info
);
365 /* Perform the action */
368 case ACPI_GPE_ENABLE
:
370 ACPI_SET_BIT(gpe_register_info
->enable_for_wake
,
374 case ACPI_GPE_DISABLE
:
376 ACPI_CLEAR_BIT(gpe_register_info
->enable_for_wake
,
382 ACPI_ERROR((AE_INFO
, "%u, Invalid action", action
));
383 status
= AE_BAD_PARAMETER
;
388 acpi_os_release_lock(acpi_gbl_gpe_lock
, flags
);
389 return_ACPI_STATUS(status
);
392 ACPI_EXPORT_SYMBOL(acpi_set_gpe_wake_mask
)
394 /*******************************************************************************
396 * FUNCTION: acpi_clear_gpe
398 * PARAMETERS: gpe_device - Parent GPE Device. NULL for GPE0/GPE1
399 * gpe_number - GPE level within the GPE block
403 * DESCRIPTION: Clear an ACPI event (general purpose)
405 ******************************************************************************/
406 acpi_status
acpi_clear_gpe(acpi_handle gpe_device
, u32 gpe_number
)
408 acpi_status status
= AE_OK
;
409 struct acpi_gpe_event_info
*gpe_event_info
;
410 acpi_cpu_flags flags
;
412 ACPI_FUNCTION_TRACE(acpi_clear_gpe
);
414 flags
= acpi_os_acquire_lock(acpi_gbl_gpe_lock
);
416 /* Ensure that we have a valid GPE number */
418 gpe_event_info
= acpi_ev_get_gpe_event_info(gpe_device
, gpe_number
);
419 if (!gpe_event_info
) {
420 status
= AE_BAD_PARAMETER
;
421 goto unlock_and_exit
;
424 status
= acpi_hw_clear_gpe(gpe_event_info
);
427 acpi_os_release_lock(acpi_gbl_gpe_lock
, flags
);
428 return_ACPI_STATUS(status
);
431 ACPI_EXPORT_SYMBOL(acpi_clear_gpe
)
433 /*******************************************************************************
435 * FUNCTION: acpi_get_gpe_status
437 * PARAMETERS: gpe_device - Parent GPE Device. NULL for GPE0/GPE1
438 * gpe_number - GPE level within the GPE block
439 * event_status - Where the current status of the event
444 * DESCRIPTION: Get the current status of a GPE (signalled/not_signalled)
446 ******************************************************************************/
448 acpi_get_gpe_status(acpi_handle gpe_device
,
449 u32 gpe_number
, acpi_event_status
*event_status
)
451 acpi_status status
= AE_OK
;
452 struct acpi_gpe_event_info
*gpe_event_info
;
453 acpi_cpu_flags flags
;
455 ACPI_FUNCTION_TRACE(acpi_get_gpe_status
);
457 flags
= acpi_os_acquire_lock(acpi_gbl_gpe_lock
);
459 /* Ensure that we have a valid GPE number */
461 gpe_event_info
= acpi_ev_get_gpe_event_info(gpe_device
, gpe_number
);
462 if (!gpe_event_info
) {
463 status
= AE_BAD_PARAMETER
;
464 goto unlock_and_exit
;
467 /* Obtain status on the requested GPE number */
469 status
= acpi_hw_get_gpe_status(gpe_event_info
, event_status
);
471 if (gpe_event_info
->flags
& ACPI_GPE_DISPATCH_MASK
)
472 *event_status
|= ACPI_EVENT_FLAG_HANDLE
;
475 acpi_os_release_lock(acpi_gbl_gpe_lock
, flags
);
476 return_ACPI_STATUS(status
);
479 ACPI_EXPORT_SYMBOL(acpi_get_gpe_status
)
481 /******************************************************************************
483 * FUNCTION: acpi_disable_all_gpes
489 * DESCRIPTION: Disable and clear all GPEs in all GPE blocks
491 ******************************************************************************/
493 acpi_status
acpi_disable_all_gpes(void)
497 ACPI_FUNCTION_TRACE(acpi_disable_all_gpes
);
499 status
= acpi_ut_acquire_mutex(ACPI_MTX_EVENTS
);
500 if (ACPI_FAILURE(status
)) {
501 return_ACPI_STATUS(status
);
504 status
= acpi_hw_disable_all_gpes();
505 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS
);
507 return_ACPI_STATUS(status
);
510 ACPI_EXPORT_SYMBOL(acpi_disable_all_gpes
)
512 /******************************************************************************
514 * FUNCTION: acpi_enable_all_runtime_gpes
520 * DESCRIPTION: Enable all "runtime" GPEs, in all GPE blocks
522 ******************************************************************************/
524 acpi_status
acpi_enable_all_runtime_gpes(void)
528 ACPI_FUNCTION_TRACE(acpi_enable_all_runtime_gpes
);
530 status
= acpi_ut_acquire_mutex(ACPI_MTX_EVENTS
);
531 if (ACPI_FAILURE(status
)) {
532 return_ACPI_STATUS(status
);
535 status
= acpi_hw_enable_all_runtime_gpes();
536 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS
);
538 return_ACPI_STATUS(status
);
541 ACPI_EXPORT_SYMBOL(acpi_enable_all_runtime_gpes
)
543 /*******************************************************************************
545 * FUNCTION: acpi_install_gpe_block
547 * PARAMETERS: gpe_device - Handle to the parent GPE Block Device
548 * gpe_block_address - Address and space_ID
549 * register_count - Number of GPE register pairs in the block
550 * interrupt_number - H/W interrupt for the block
554 * DESCRIPTION: Create and Install a block of GPE registers. The GPEs are not
557 ******************************************************************************/
559 acpi_install_gpe_block(acpi_handle gpe_device
,
560 struct acpi_generic_address
*gpe_block_address
,
561 u32 register_count
, u32 interrupt_number
)
564 union acpi_operand_object
*obj_desc
;
565 struct acpi_namespace_node
*node
;
566 struct acpi_gpe_block_info
*gpe_block
;
568 ACPI_FUNCTION_TRACE(acpi_install_gpe_block
);
570 if ((!gpe_device
) || (!gpe_block_address
) || (!register_count
)) {
571 return_ACPI_STATUS(AE_BAD_PARAMETER
);
574 status
= acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE
);
575 if (ACPI_FAILURE(status
)) {
576 return_ACPI_STATUS(status
);
579 node
= acpi_ns_validate_handle(gpe_device
);
581 status
= AE_BAD_PARAMETER
;
582 goto unlock_and_exit
;
586 * For user-installed GPE Block Devices, the gpe_block_base_number
590 acpi_ev_create_gpe_block(node
, gpe_block_address
, register_count
, 0,
591 interrupt_number
, &gpe_block
);
592 if (ACPI_FAILURE(status
)) {
593 goto unlock_and_exit
;
596 /* Install block in the device_object attached to the node */
598 obj_desc
= acpi_ns_get_attached_object(node
);
602 * No object, create a new one (Device nodes do not always have
603 * an attached object)
605 obj_desc
= acpi_ut_create_internal_object(ACPI_TYPE_DEVICE
);
607 status
= AE_NO_MEMORY
;
608 goto unlock_and_exit
;
612 acpi_ns_attach_object(node
, obj_desc
, ACPI_TYPE_DEVICE
);
614 /* Remove local reference to the object */
616 acpi_ut_remove_reference(obj_desc
);
618 if (ACPI_FAILURE(status
)) {
619 goto unlock_and_exit
;
623 /* Now install the GPE block in the device_object */
625 obj_desc
->device
.gpe_block
= gpe_block
;
628 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE
);
629 return_ACPI_STATUS(status
);
632 ACPI_EXPORT_SYMBOL(acpi_install_gpe_block
)
634 /*******************************************************************************
636 * FUNCTION: acpi_remove_gpe_block
638 * PARAMETERS: gpe_device - Handle to the parent GPE Block Device
642 * DESCRIPTION: Remove a previously installed block of GPE registers
644 ******************************************************************************/
645 acpi_status
acpi_remove_gpe_block(acpi_handle gpe_device
)
647 union acpi_operand_object
*obj_desc
;
649 struct acpi_namespace_node
*node
;
651 ACPI_FUNCTION_TRACE(acpi_remove_gpe_block
);
654 return_ACPI_STATUS(AE_BAD_PARAMETER
);
657 status
= acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE
);
658 if (ACPI_FAILURE(status
)) {
659 return_ACPI_STATUS(status
);
662 node
= acpi_ns_validate_handle(gpe_device
);
664 status
= AE_BAD_PARAMETER
;
665 goto unlock_and_exit
;
668 /* Get the device_object attached to the node */
670 obj_desc
= acpi_ns_get_attached_object(node
);
671 if (!obj_desc
|| !obj_desc
->device
.gpe_block
) {
672 return_ACPI_STATUS(AE_NULL_OBJECT
);
675 /* Delete the GPE block (but not the device_object) */
677 status
= acpi_ev_delete_gpe_block(obj_desc
->device
.gpe_block
);
678 if (ACPI_SUCCESS(status
)) {
679 obj_desc
->device
.gpe_block
= NULL
;
683 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE
);
684 return_ACPI_STATUS(status
);
687 ACPI_EXPORT_SYMBOL(acpi_remove_gpe_block
)
689 /*******************************************************************************
691 * FUNCTION: acpi_get_gpe_device
693 * PARAMETERS: index - System GPE index (0-current_gpe_count)
694 * gpe_device - Where the parent GPE Device is returned
698 * DESCRIPTION: Obtain the GPE device associated with the input index. A NULL
699 * gpe device indicates that the gpe number is contained in one of
700 * the FADT-defined gpe blocks. Otherwise, the GPE block device.
702 ******************************************************************************/
703 acpi_status
acpi_get_gpe_device(u32 index
, acpi_handle
* gpe_device
)
705 struct acpi_gpe_device_info info
;
708 ACPI_FUNCTION_TRACE(acpi_get_gpe_device
);
711 return_ACPI_STATUS(AE_BAD_PARAMETER
);
714 if (index
>= acpi_current_gpe_count
) {
715 return_ACPI_STATUS(AE_NOT_EXIST
);
718 /* Setup and walk the GPE list */
721 info
.status
= AE_NOT_EXIST
;
722 info
.gpe_device
= NULL
;
723 info
.next_block_base_index
= 0;
725 status
= acpi_ev_walk_gpe_list(acpi_ev_get_gpe_device
, &info
);
726 if (ACPI_FAILURE(status
)) {
727 return_ACPI_STATUS(status
);
730 *gpe_device
= ACPI_CAST_PTR(acpi_handle
, info
.gpe_device
);
731 return_ACPI_STATUS(info
.status
);
734 ACPI_EXPORT_SYMBOL(acpi_get_gpe_device
)
735 #endif /* !ACPI_REDUCED_HARDWARE */