1 /******************************************************************************
3 * Module Name: evxfgpe - External Interfaces for General Purpose Events (GPEs)
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2012, 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);
175 ACPI_EXPORT_SYMBOL(acpi_disable_gpe)
178 /*******************************************************************************
180 * FUNCTION: acpi_setup_gpe_for_wake
182 * PARAMETERS: wake_device - Device associated with the GPE (via _PRW)
183 * gpe_device - Parent GPE Device. NULL for GPE0/GPE1
184 * gpe_number - GPE level within the GPE block
188 * DESCRIPTION: Mark a GPE as having the ability to wake the system. This
189 * interface is intended to be used as the host executes the
190 * _PRW methods (Power Resources for Wake) in the system tables.
191 * Each _PRW appears under a Device Object (The wake_device), and
192 * contains the info for the wake GPE associated with the
195 ******************************************************************************/
197 acpi_setup_gpe_for_wake(acpi_handle wake_device,
198 acpi_handle gpe_device, u32 gpe_number)
201 struct acpi_gpe_event_info *gpe_event_info;
202 struct acpi_namespace_node *device_node;
203 struct acpi_gpe_notify_info *notify;
204 struct acpi_gpe_notify_info *new_notify;
205 acpi_cpu_flags flags;
207 ACPI_FUNCTION_TRACE(acpi_setup_gpe_for_wake);
209 /* Parameter Validation */
213 * By forcing wake_device to be valid, we automatically enable the
214 * implicit notify feature on all hosts.
216 return_ACPI_STATUS(AE_BAD_PARAMETER);
219 /* Handle root object case */
221 if (wake_device == ACPI_ROOT_OBJECT) {
222 device_node = acpi_gbl_root_node;
224 device_node = ACPI_CAST_PTR(struct acpi_namespace_node, wake_device);
227 /* Validate WakeDevice is of type Device */
229 if (device_node->type != ACPI_TYPE_DEVICE) {
230 return_ACPI_STATUS (AE_BAD_PARAMETER);
234 * Allocate a new notify object up front, in case it is needed.
235 * Memory allocation while holding a spinlock is a big no-no
238 new_notify = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_gpe_notify_info));
240 return_ACPI_STATUS(AE_NO_MEMORY);
243 flags = acpi_os_acquire_lock(acpi_gbl_gpe_lock);
245 /* Ensure that we have a valid GPE number */
247 gpe_event_info = acpi_ev_get_gpe_event_info(gpe_device, gpe_number);
248 if (!gpe_event_info) {
249 status = AE_BAD_PARAMETER;
250 goto unlock_and_exit;
254 * If there is no method or handler for this GPE, then the
255 * wake_device will be notified whenever this GPE fires. This is
256 * known as an "implicit notify". Note: The GPE is assumed to be
257 * level-triggered (for windows compatibility).
259 if ((gpe_event_info->flags & ACPI_GPE_DISPATCH_MASK) ==
260 ACPI_GPE_DISPATCH_NONE) {
262 * This is the first device for implicit notify on this GPE.
263 * Just set the flags here, and enter the NOTIFY block below.
265 gpe_event_info->flags =
266 (ACPI_GPE_DISPATCH_NOTIFY | ACPI_GPE_LEVEL_TRIGGERED);
270 * If we already have an implicit notify on this GPE, add
271 * this device to the notify list.
273 if ((gpe_event_info->flags & ACPI_GPE_DISPATCH_MASK) ==
274 ACPI_GPE_DISPATCH_NOTIFY) {
276 /* Ensure that the device is not already in the list */
278 notify = gpe_event_info->dispatch.notify_list;
280 if (notify->device_node == device_node) {
281 status = AE_ALREADY_EXISTS;
282 goto unlock_and_exit;
284 notify = notify->next;
287 /* Add this device to the notify list for this GPE */
289 new_notify->device_node = device_node;
290 new_notify->next = gpe_event_info->dispatch.notify_list;
291 gpe_event_info->dispatch.notify_list = new_notify;
295 /* Mark the GPE as a possible wake event */
297 gpe_event_info->flags |= ACPI_GPE_CAN_WAKE;
301 acpi_os_release_lock(acpi_gbl_gpe_lock, flags);
303 /* Delete the notify object if it was not used above */
306 ACPI_FREE(new_notify);
308 return_ACPI_STATUS(status);
310 ACPI_EXPORT_SYMBOL(acpi_setup_gpe_for_wake)
312 /*******************************************************************************
314 * FUNCTION: acpi_set_gpe_wake_mask
316 * PARAMETERS: gpe_device - Parent GPE Device. NULL for GPE0/GPE1
317 * gpe_number - GPE level within the GPE block
318 * action - Enable or Disable
322 * DESCRIPTION: Set or clear the GPE's wakeup enable mask bit. The GPE must
323 * already be marked as a WAKE GPE.
325 ******************************************************************************/
327 acpi_status acpi_set_gpe_wake_mask(acpi_handle gpe_device, u32 gpe_number, u8 action)
329 acpi_status status = AE_OK;
330 struct acpi_gpe_event_info *gpe_event_info;
331 struct acpi_gpe_register_info *gpe_register_info;
332 acpi_cpu_flags flags;
335 ACPI_FUNCTION_TRACE(acpi_set_gpe_wake_mask);
337 flags = acpi_os_acquire_lock(acpi_gbl_gpe_lock);
340 * Ensure that we have a valid GPE number and that this GPE is in
343 gpe_event_info = acpi_ev_get_gpe_event_info(gpe_device, gpe_number);
344 if (!gpe_event_info) {
345 status = AE_BAD_PARAMETER;
346 goto unlock_and_exit;
349 if (!(gpe_event_info->flags & ACPI_GPE_CAN_WAKE)) {
351 goto unlock_and_exit;
354 gpe_register_info = gpe_event_info->register_info;
355 if (!gpe_register_info) {
356 status = AE_NOT_EXIST;
357 goto unlock_and_exit;
360 register_bit = acpi_hw_get_gpe_register_bit(gpe_event_info);
362 /* Perform the action */
365 case ACPI_GPE_ENABLE:
366 ACPI_SET_BIT(gpe_register_info->enable_for_wake,
370 case ACPI_GPE_DISABLE:
371 ACPI_CLEAR_BIT(gpe_register_info->enable_for_wake,
376 ACPI_ERROR((AE_INFO, "%u, Invalid action", action));
377 status = AE_BAD_PARAMETER;
382 acpi_os_release_lock(acpi_gbl_gpe_lock, flags);
383 return_ACPI_STATUS(status);
386 ACPI_EXPORT_SYMBOL(acpi_set_gpe_wake_mask)
388 /*******************************************************************************
390 * FUNCTION: acpi_clear_gpe
392 * PARAMETERS: gpe_device - Parent GPE Device. NULL for GPE0/GPE1
393 * gpe_number - GPE level within the GPE block
397 * DESCRIPTION: Clear an ACPI event (general purpose)
399 ******************************************************************************/
400 acpi_status acpi_clear_gpe(acpi_handle gpe_device, u32 gpe_number)
402 acpi_status status = AE_OK;
403 struct acpi_gpe_event_info *gpe_event_info;
404 acpi_cpu_flags flags;
406 ACPI_FUNCTION_TRACE(acpi_clear_gpe);
408 flags = acpi_os_acquire_lock(acpi_gbl_gpe_lock);
410 /* Ensure that we have a valid GPE number */
412 gpe_event_info = acpi_ev_get_gpe_event_info(gpe_device, gpe_number);
413 if (!gpe_event_info) {
414 status = AE_BAD_PARAMETER;
415 goto unlock_and_exit;
418 status = acpi_hw_clear_gpe(gpe_event_info);
421 acpi_os_release_lock(acpi_gbl_gpe_lock, flags);
422 return_ACPI_STATUS(status);
425 ACPI_EXPORT_SYMBOL(acpi_clear_gpe)
427 /*******************************************************************************
429 * FUNCTION: acpi_get_gpe_status
431 * PARAMETERS: gpe_device - Parent GPE Device. NULL for GPE0/GPE1
432 * gpe_number - GPE level within the GPE block
433 * event_status - Where the current status of the event will
438 * DESCRIPTION: Get the current status of a GPE (signalled/not_signalled)
440 ******************************************************************************/
442 acpi_get_gpe_status(acpi_handle gpe_device,
443 u32 gpe_number, acpi_event_status *event_status)
445 acpi_status status = AE_OK;
446 struct acpi_gpe_event_info *gpe_event_info;
447 acpi_cpu_flags flags;
449 ACPI_FUNCTION_TRACE(acpi_get_gpe_status);
451 flags = acpi_os_acquire_lock(acpi_gbl_gpe_lock);
453 /* Ensure that we have a valid GPE number */
455 gpe_event_info = acpi_ev_get_gpe_event_info(gpe_device, gpe_number);
456 if (!gpe_event_info) {
457 status = AE_BAD_PARAMETER;
458 goto unlock_and_exit;
461 /* Obtain status on the requested GPE number */
463 status = acpi_hw_get_gpe_status(gpe_event_info, event_status);
465 if (gpe_event_info->flags & ACPI_GPE_DISPATCH_MASK)
466 *event_status |= ACPI_EVENT_FLAG_HANDLE;
469 acpi_os_release_lock(acpi_gbl_gpe_lock, flags);
470 return_ACPI_STATUS(status);
473 ACPI_EXPORT_SYMBOL(acpi_get_gpe_status)
475 /******************************************************************************
477 * FUNCTION: acpi_disable_all_gpes
483 * DESCRIPTION: Disable and clear all GPEs in all GPE blocks
485 ******************************************************************************/
487 acpi_status acpi_disable_all_gpes(void)
491 ACPI_FUNCTION_TRACE(acpi_disable_all_gpes);
493 status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
494 if (ACPI_FAILURE(status)) {
495 return_ACPI_STATUS(status);
498 status = acpi_hw_disable_all_gpes();
499 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS);
501 return_ACPI_STATUS(status);
504 ACPI_EXPORT_SYMBOL(acpi_disable_all_gpes)
506 /******************************************************************************
508 * FUNCTION: acpi_enable_all_runtime_gpes
514 * DESCRIPTION: Enable all "runtime" GPEs, in all GPE blocks
516 ******************************************************************************/
518 acpi_status acpi_enable_all_runtime_gpes(void)
522 ACPI_FUNCTION_TRACE(acpi_enable_all_runtime_gpes);
524 status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
525 if (ACPI_FAILURE(status)) {
526 return_ACPI_STATUS(status);
529 status = acpi_hw_enable_all_runtime_gpes();
530 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS);
532 return_ACPI_STATUS(status);
535 ACPI_EXPORT_SYMBOL(acpi_enable_all_runtime_gpes)
537 /*******************************************************************************
539 * FUNCTION: acpi_install_gpe_block
541 * PARAMETERS: gpe_device - Handle to the parent GPE Block Device
542 * gpe_block_address - Address and space_ID
543 * register_count - Number of GPE register pairs in the block
544 * interrupt_number - H/W interrupt for the block
548 * DESCRIPTION: Create and Install a block of GPE registers. The GPEs are not
551 ******************************************************************************/
553 acpi_install_gpe_block(acpi_handle gpe_device,
554 struct acpi_generic_address *gpe_block_address,
555 u32 register_count, u32 interrupt_number)
558 union acpi_operand_object *obj_desc;
559 struct acpi_namespace_node *node;
560 struct acpi_gpe_block_info *gpe_block;
562 ACPI_FUNCTION_TRACE(acpi_install_gpe_block);
564 if ((!gpe_device) || (!gpe_block_address) || (!register_count)) {
565 return_ACPI_STATUS(AE_BAD_PARAMETER);
568 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
569 if (ACPI_FAILURE(status)) {
573 node = acpi_ns_validate_handle(gpe_device);
575 status = AE_BAD_PARAMETER;
576 goto unlock_and_exit;
580 * For user-installed GPE Block Devices, the gpe_block_base_number
584 acpi_ev_create_gpe_block(node, gpe_block_address, register_count, 0,
585 interrupt_number, &gpe_block);
586 if (ACPI_FAILURE(status)) {
587 goto unlock_and_exit;
590 /* Install block in the device_object attached to the node */
592 obj_desc = acpi_ns_get_attached_object(node);
596 * No object, create a new one (Device nodes do not always have
597 * an attached object)
599 obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_DEVICE);
601 status = AE_NO_MEMORY;
602 goto unlock_and_exit;
606 acpi_ns_attach_object(node, obj_desc, ACPI_TYPE_DEVICE);
608 /* Remove local reference to the object */
610 acpi_ut_remove_reference(obj_desc);
612 if (ACPI_FAILURE(status)) {
613 goto unlock_and_exit;
617 /* Now install the GPE block in the device_object */
619 obj_desc->device.gpe_block = gpe_block;
622 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
623 return_ACPI_STATUS(status);
626 ACPI_EXPORT_SYMBOL(acpi_install_gpe_block)
628 /*******************************************************************************
630 * FUNCTION: acpi_remove_gpe_block
632 * PARAMETERS: gpe_device - Handle to the parent GPE Block Device
636 * DESCRIPTION: Remove a previously installed block of GPE registers
638 ******************************************************************************/
639 acpi_status acpi_remove_gpe_block(acpi_handle gpe_device)
641 union acpi_operand_object *obj_desc;
643 struct acpi_namespace_node *node;
645 ACPI_FUNCTION_TRACE(acpi_remove_gpe_block);
648 return_ACPI_STATUS(AE_BAD_PARAMETER);
651 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
652 if (ACPI_FAILURE(status)) {
656 node = acpi_ns_validate_handle(gpe_device);
658 status = AE_BAD_PARAMETER;
659 goto unlock_and_exit;
662 /* Get the device_object attached to the node */
664 obj_desc = acpi_ns_get_attached_object(node);
665 if (!obj_desc || !obj_desc->device.gpe_block) {
666 return_ACPI_STATUS(AE_NULL_OBJECT);
669 /* Delete the GPE block (but not the device_object) */
671 status = acpi_ev_delete_gpe_block(obj_desc->device.gpe_block);
672 if (ACPI_SUCCESS(status)) {
673 obj_desc->device.gpe_block = NULL;
677 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
678 return_ACPI_STATUS(status);
681 ACPI_EXPORT_SYMBOL(acpi_remove_gpe_block)
683 /*******************************************************************************
685 * FUNCTION: acpi_get_gpe_device
687 * PARAMETERS: index - System GPE index (0-current_gpe_count)
688 * gpe_device - Where the parent GPE Device is returned
692 * DESCRIPTION: Obtain the GPE device associated with the input index. A NULL
693 * gpe device indicates that the gpe number is contained in one of
694 * the FADT-defined gpe blocks. Otherwise, the GPE block device.
696 ******************************************************************************/
698 acpi_get_gpe_device(u32 index, acpi_handle *gpe_device)
700 struct acpi_gpe_device_info info;
703 ACPI_FUNCTION_TRACE(acpi_get_gpe_device);
706 return_ACPI_STATUS(AE_BAD_PARAMETER);
709 if (index >= acpi_current_gpe_count) {
710 return_ACPI_STATUS(AE_NOT_EXIST);
713 /* Setup and walk the GPE list */
716 info.status = AE_NOT_EXIST;
717 info.gpe_device = NULL;
718 info.next_block_base_index = 0;
720 status = acpi_ev_walk_gpe_list(acpi_ev_get_gpe_device, &info);
721 if (ACPI_FAILURE(status)) {
722 return_ACPI_STATUS(status);
725 *gpe_device = ACPI_CAST_PTR(acpi_handle, info.gpe_device);
726 return_ACPI_STATUS(info.status);
729 ACPI_EXPORT_SYMBOL(acpi_get_gpe_device)
730 #endif /* !ACPI_REDUCED_HARDWARE */