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)
200 acpi_status status = AE_BAD_PARAMETER;
201 struct acpi_gpe_event_info *gpe_event_info;
202 struct acpi_namespace_node *device_node;
203 struct acpi_gpe_notify_object *notify_object;
204 acpi_cpu_flags flags;
205 u8 gpe_dispatch_mask;
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 flags = acpi_os_acquire_lock(acpi_gbl_gpe_lock);
221 /* Ensure that we have a valid GPE number */
223 gpe_event_info = acpi_ev_get_gpe_event_info(gpe_device, gpe_number);
224 if (!gpe_event_info) {
225 goto unlock_and_exit;
228 if (wake_device == ACPI_ROOT_OBJECT) {
233 * If there is no method or handler for this GPE, then the
234 * wake_device will be notified whenever this GPE fires (aka
235 * "implicit notify") Note: The GPE is assumed to be
236 * level-triggered (for windows compatibility).
238 gpe_dispatch_mask = gpe_event_info->flags & ACPI_GPE_DISPATCH_MASK;
239 if (gpe_dispatch_mask != ACPI_GPE_DISPATCH_NONE
240 && gpe_dispatch_mask != ACPI_GPE_DISPATCH_NOTIFY) {
244 /* Validate wake_device is of type Device */
246 device_node = ACPI_CAST_PTR(struct acpi_namespace_node, wake_device);
247 if (device_node->type != ACPI_TYPE_DEVICE) {
248 goto unlock_and_exit;
251 if (gpe_dispatch_mask == ACPI_GPE_DISPATCH_NONE) {
252 gpe_event_info->flags = (ACPI_GPE_DISPATCH_NOTIFY |
253 ACPI_GPE_LEVEL_TRIGGERED);
254 gpe_event_info->dispatch.device.node = device_node;
255 gpe_event_info->dispatch.device.next = NULL;
257 /* There are multiple devices to notify implicitly. */
259 notify_object = ACPI_ALLOCATE_ZEROED(sizeof(*notify_object));
260 if (!notify_object) {
261 status = AE_NO_MEMORY;
262 goto unlock_and_exit;
265 notify_object->node = device_node;
266 notify_object->next = gpe_event_info->dispatch.device.next;
267 gpe_event_info->dispatch.device.next = notify_object;
271 gpe_event_info->flags |= ACPI_GPE_CAN_WAKE;
275 acpi_os_release_lock(acpi_gbl_gpe_lock, flags);
276 return_ACPI_STATUS(status);
278 ACPI_EXPORT_SYMBOL(acpi_setup_gpe_for_wake)
280 /*******************************************************************************
282 * FUNCTION: acpi_set_gpe_wake_mask
284 * PARAMETERS: gpe_device - Parent GPE Device. NULL for GPE0/GPE1
285 * gpe_number - GPE level within the GPE block
286 * Action - Enable or Disable
290 * DESCRIPTION: Set or clear the GPE's wakeup enable mask bit. The GPE must
291 * already be marked as a WAKE GPE.
293 ******************************************************************************/
295 acpi_status acpi_set_gpe_wake_mask(acpi_handle gpe_device, u32 gpe_number, u8 action)
297 acpi_status status = AE_OK;
298 struct acpi_gpe_event_info *gpe_event_info;
299 struct acpi_gpe_register_info *gpe_register_info;
300 acpi_cpu_flags flags;
303 ACPI_FUNCTION_TRACE(acpi_set_gpe_wake_mask);
305 flags = acpi_os_acquire_lock(acpi_gbl_gpe_lock);
308 * Ensure that we have a valid GPE number and that this GPE is in
311 gpe_event_info = acpi_ev_get_gpe_event_info(gpe_device, gpe_number);
312 if (!gpe_event_info) {
313 status = AE_BAD_PARAMETER;
314 goto unlock_and_exit;
317 if (!(gpe_event_info->flags & ACPI_GPE_CAN_WAKE)) {
319 goto unlock_and_exit;
322 gpe_register_info = gpe_event_info->register_info;
323 if (!gpe_register_info) {
324 status = AE_NOT_EXIST;
325 goto unlock_and_exit;
329 acpi_hw_get_gpe_register_bit(gpe_event_info, gpe_register_info);
331 /* Perform the action */
334 case ACPI_GPE_ENABLE:
335 ACPI_SET_BIT(gpe_register_info->enable_for_wake,
339 case ACPI_GPE_DISABLE:
340 ACPI_CLEAR_BIT(gpe_register_info->enable_for_wake,
345 ACPI_ERROR((AE_INFO, "%u, Invalid action", action));
346 status = AE_BAD_PARAMETER;
351 acpi_os_release_lock(acpi_gbl_gpe_lock, flags);
352 return_ACPI_STATUS(status);
355 ACPI_EXPORT_SYMBOL(acpi_set_gpe_wake_mask)
357 /*******************************************************************************
359 * FUNCTION: acpi_clear_gpe
361 * PARAMETERS: gpe_device - Parent GPE Device. NULL for GPE0/GPE1
362 * gpe_number - GPE level within the GPE block
366 * DESCRIPTION: Clear an ACPI event (general purpose)
368 ******************************************************************************/
369 acpi_status acpi_clear_gpe(acpi_handle gpe_device, u32 gpe_number)
371 acpi_status status = AE_OK;
372 struct acpi_gpe_event_info *gpe_event_info;
373 acpi_cpu_flags flags;
375 ACPI_FUNCTION_TRACE(acpi_clear_gpe);
377 flags = acpi_os_acquire_lock(acpi_gbl_gpe_lock);
379 /* Ensure that we have a valid GPE number */
381 gpe_event_info = acpi_ev_get_gpe_event_info(gpe_device, gpe_number);
382 if (!gpe_event_info) {
383 status = AE_BAD_PARAMETER;
384 goto unlock_and_exit;
387 status = acpi_hw_clear_gpe(gpe_event_info);
390 acpi_os_release_lock(acpi_gbl_gpe_lock, flags);
391 return_ACPI_STATUS(status);
394 ACPI_EXPORT_SYMBOL(acpi_clear_gpe)
396 /*******************************************************************************
398 * FUNCTION: acpi_get_gpe_status
400 * PARAMETERS: gpe_device - Parent GPE Device. NULL for GPE0/GPE1
401 * gpe_number - GPE level within the GPE block
402 * event_status - Where the current status of the event will
407 * DESCRIPTION: Get the current status of a GPE (signalled/not_signalled)
409 ******************************************************************************/
411 acpi_get_gpe_status(acpi_handle gpe_device,
412 u32 gpe_number, acpi_event_status *event_status)
414 acpi_status status = AE_OK;
415 struct acpi_gpe_event_info *gpe_event_info;
416 acpi_cpu_flags flags;
418 ACPI_FUNCTION_TRACE(acpi_get_gpe_status);
420 flags = acpi_os_acquire_lock(acpi_gbl_gpe_lock);
422 /* Ensure that we have a valid GPE number */
424 gpe_event_info = acpi_ev_get_gpe_event_info(gpe_device, gpe_number);
425 if (!gpe_event_info) {
426 status = AE_BAD_PARAMETER;
427 goto unlock_and_exit;
430 /* Obtain status on the requested GPE number */
432 status = acpi_hw_get_gpe_status(gpe_event_info, event_status);
434 if (gpe_event_info->flags & ACPI_GPE_DISPATCH_MASK)
435 *event_status |= ACPI_EVENT_FLAG_HANDLE;
438 acpi_os_release_lock(acpi_gbl_gpe_lock, flags);
439 return_ACPI_STATUS(status);
442 ACPI_EXPORT_SYMBOL(acpi_get_gpe_status)
444 /******************************************************************************
446 * FUNCTION: acpi_disable_all_gpes
452 * DESCRIPTION: Disable and clear all GPEs in all GPE blocks
454 ******************************************************************************/
456 acpi_status acpi_disable_all_gpes(void)
460 ACPI_FUNCTION_TRACE(acpi_disable_all_gpes);
462 status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
463 if (ACPI_FAILURE(status)) {
464 return_ACPI_STATUS(status);
467 status = acpi_hw_disable_all_gpes();
468 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS);
470 return_ACPI_STATUS(status);
473 ACPI_EXPORT_SYMBOL(acpi_disable_all_gpes)
475 /******************************************************************************
477 * FUNCTION: acpi_enable_all_runtime_gpes
483 * DESCRIPTION: Enable all "runtime" GPEs, in all GPE blocks
485 ******************************************************************************/
487 acpi_status acpi_enable_all_runtime_gpes(void)
491 ACPI_FUNCTION_TRACE(acpi_enable_all_runtime_gpes);
493 status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
494 if (ACPI_FAILURE(status)) {
495 return_ACPI_STATUS(status);
498 status = acpi_hw_enable_all_runtime_gpes();
499 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS);
501 return_ACPI_STATUS(status);
504 ACPI_EXPORT_SYMBOL(acpi_enable_all_runtime_gpes)
506 /*******************************************************************************
508 * FUNCTION: acpi_install_gpe_block
510 * PARAMETERS: gpe_device - Handle to the parent GPE Block Device
511 * gpe_block_address - Address and space_iD
512 * register_count - Number of GPE register pairs in the block
513 * interrupt_number - H/W interrupt for the block
517 * DESCRIPTION: Create and Install a block of GPE registers. The GPEs are not
520 ******************************************************************************/
522 acpi_install_gpe_block(acpi_handle gpe_device,
523 struct acpi_generic_address *gpe_block_address,
524 u32 register_count, u32 interrupt_number)
527 union acpi_operand_object *obj_desc;
528 struct acpi_namespace_node *node;
529 struct acpi_gpe_block_info *gpe_block;
531 ACPI_FUNCTION_TRACE(acpi_install_gpe_block);
533 if ((!gpe_device) || (!gpe_block_address) || (!register_count)) {
534 return_ACPI_STATUS(AE_BAD_PARAMETER);
537 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
538 if (ACPI_FAILURE(status)) {
542 node = acpi_ns_validate_handle(gpe_device);
544 status = AE_BAD_PARAMETER;
545 goto unlock_and_exit;
549 * For user-installed GPE Block Devices, the gpe_block_base_number
553 acpi_ev_create_gpe_block(node, gpe_block_address, register_count, 0,
554 interrupt_number, &gpe_block);
555 if (ACPI_FAILURE(status)) {
556 goto unlock_and_exit;
559 /* Install block in the device_object attached to the node */
561 obj_desc = acpi_ns_get_attached_object(node);
565 * No object, create a new one (Device nodes do not always have
566 * an attached object)
568 obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_DEVICE);
570 status = AE_NO_MEMORY;
571 goto unlock_and_exit;
575 acpi_ns_attach_object(node, obj_desc, ACPI_TYPE_DEVICE);
577 /* Remove local reference to the object */
579 acpi_ut_remove_reference(obj_desc);
581 if (ACPI_FAILURE(status)) {
582 goto unlock_and_exit;
586 /* Now install the GPE block in the device_object */
588 obj_desc->device.gpe_block = gpe_block;
591 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
592 return_ACPI_STATUS(status);
595 ACPI_EXPORT_SYMBOL(acpi_install_gpe_block)
597 /*******************************************************************************
599 * FUNCTION: acpi_remove_gpe_block
601 * PARAMETERS: gpe_device - Handle to the parent GPE Block Device
605 * DESCRIPTION: Remove a previously installed block of GPE registers
607 ******************************************************************************/
608 acpi_status acpi_remove_gpe_block(acpi_handle gpe_device)
610 union acpi_operand_object *obj_desc;
612 struct acpi_namespace_node *node;
614 ACPI_FUNCTION_TRACE(acpi_remove_gpe_block);
617 return_ACPI_STATUS(AE_BAD_PARAMETER);
620 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
621 if (ACPI_FAILURE(status)) {
625 node = acpi_ns_validate_handle(gpe_device);
627 status = AE_BAD_PARAMETER;
628 goto unlock_and_exit;
631 /* Get the device_object attached to the node */
633 obj_desc = acpi_ns_get_attached_object(node);
634 if (!obj_desc || !obj_desc->device.gpe_block) {
635 return_ACPI_STATUS(AE_NULL_OBJECT);
638 /* Delete the GPE block (but not the device_object) */
640 status = acpi_ev_delete_gpe_block(obj_desc->device.gpe_block);
641 if (ACPI_SUCCESS(status)) {
642 obj_desc->device.gpe_block = NULL;
646 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
647 return_ACPI_STATUS(status);
650 ACPI_EXPORT_SYMBOL(acpi_remove_gpe_block)
652 /*******************************************************************************
654 * FUNCTION: acpi_get_gpe_device
656 * PARAMETERS: Index - System GPE index (0-current_gpe_count)
657 * gpe_device - Where the parent GPE Device is returned
661 * DESCRIPTION: Obtain the GPE device associated with the input index. A NULL
662 * gpe device indicates that the gpe number is contained in one of
663 * the FADT-defined gpe blocks. Otherwise, the GPE block device.
665 ******************************************************************************/
667 acpi_get_gpe_device(u32 index, acpi_handle *gpe_device)
669 struct acpi_gpe_device_info info;
672 ACPI_FUNCTION_TRACE(acpi_get_gpe_device);
675 return_ACPI_STATUS(AE_BAD_PARAMETER);
678 if (index >= acpi_current_gpe_count) {
679 return_ACPI_STATUS(AE_NOT_EXIST);
682 /* Setup and walk the GPE list */
685 info.status = AE_NOT_EXIST;
686 info.gpe_device = NULL;
687 info.next_block_base_index = 0;
689 status = acpi_ev_walk_gpe_list(acpi_ev_get_gpe_device, &info);
690 if (ACPI_FAILURE(status)) {
691 return_ACPI_STATUS(status);
694 *gpe_device = ACPI_CAST_PTR(acpi_handle, info.gpe_device);
695 return_ACPI_STATUS(info.status);
698 ACPI_EXPORT_SYMBOL(acpi_get_gpe_device)
699 #endif /* !ACPI_REDUCED_HARDWARE */