1 /******************************************************************************
3 * Module Name: hwgpe - Low level GPE enable/disable/clear functions
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2014, 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>
48 #define _COMPONENT ACPI_HARDWARE
49 ACPI_MODULE_NAME("hwgpe")
50 #if (!ACPI_REDUCED_HARDWARE) /* Entire module */
51 /* Local prototypes */
53 acpi_hw_enable_wakeup_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
54 struct acpi_gpe_block_info *gpe_block,
57 /******************************************************************************
59 * FUNCTION: acpi_hw_get_gpe_register_bit
61 * PARAMETERS: gpe_event_info - Info block for the GPE
63 * RETURN: Register mask with a one in the GPE bit position
65 * DESCRIPTION: Compute the register mask for this GPE. One bit is set in the
66 * correct position for the input GPE.
68 ******************************************************************************/
70 u32 acpi_hw_get_gpe_register_bit(struct acpi_gpe_event_info *gpe_event_info)
74 (gpe_event_info->gpe_number -
75 gpe_event_info->register_info->base_gpe_number));
78 /******************************************************************************
80 * FUNCTION: acpi_hw_low_set_gpe
82 * PARAMETERS: gpe_event_info - Info block for the GPE to be disabled
83 * action - Enable or disable
87 * DESCRIPTION: Enable or disable a single GPE in the parent enable register.
89 ******************************************************************************/
92 acpi_hw_low_set_gpe(struct acpi_gpe_event_info *gpe_event_info, u32 action)
94 struct acpi_gpe_register_info *gpe_register_info;
99 ACPI_FUNCTION_ENTRY();
101 /* Get the info block for the entire GPE register */
103 gpe_register_info = gpe_event_info->register_info;
104 if (!gpe_register_info) {
105 return (AE_NOT_EXIST);
108 /* Get current value of the enable register that contains this GPE */
110 status = acpi_hw_read(&enable_mask, &gpe_register_info->enable_address);
111 if (ACPI_FAILURE(status)) {
115 /* Set or clear just the bit that corresponds to this GPE */
117 register_bit = acpi_hw_get_gpe_register_bit(gpe_event_info);
119 case ACPI_GPE_CONDITIONAL_ENABLE:
121 /* Only enable if the enable_for_run bit is set */
123 if (!(register_bit & gpe_register_info->enable_for_run)) {
124 return (AE_BAD_PARAMETER);
127 /*lint -fallthrough */
129 case ACPI_GPE_ENABLE:
131 ACPI_SET_BIT(enable_mask, register_bit);
134 case ACPI_GPE_DISABLE:
136 ACPI_CLEAR_BIT(enable_mask, register_bit);
141 ACPI_ERROR((AE_INFO, "Invalid GPE Action, %u", action));
142 return (AE_BAD_PARAMETER);
145 /* Write the updated enable mask */
147 status = acpi_hw_write(enable_mask, &gpe_register_info->enable_address);
151 /******************************************************************************
153 * FUNCTION: acpi_hw_clear_gpe
155 * PARAMETERS: gpe_event_info - Info block for the GPE to be cleared
159 * DESCRIPTION: Clear the status bit for a single GPE.
161 ******************************************************************************/
163 acpi_status acpi_hw_clear_gpe(struct acpi_gpe_event_info * gpe_event_info)
165 struct acpi_gpe_register_info *gpe_register_info;
169 ACPI_FUNCTION_ENTRY();
171 /* Get the info block for the entire GPE register */
173 gpe_register_info = gpe_event_info->register_info;
174 if (!gpe_register_info) {
175 return (AE_NOT_EXIST);
179 * Write a one to the appropriate bit in the status register to
182 register_bit = acpi_hw_get_gpe_register_bit(gpe_event_info);
184 status = acpi_hw_write(register_bit,
185 &gpe_register_info->status_address);
190 /******************************************************************************
192 * FUNCTION: acpi_hw_get_gpe_status
194 * PARAMETERS: gpe_event_info - Info block for the GPE to queried
195 * event_status - Where the GPE status is returned
199 * DESCRIPTION: Return the status of a single GPE.
201 ******************************************************************************/
204 acpi_hw_get_gpe_status(struct acpi_gpe_event_info * gpe_event_info,
205 acpi_event_status *event_status)
209 struct acpi_gpe_register_info *gpe_register_info;
210 acpi_event_status local_event_status = 0;
213 ACPI_FUNCTION_ENTRY();
216 return (AE_BAD_PARAMETER);
219 /* GPE currently handled? */
221 if ((gpe_event_info->flags & ACPI_GPE_DISPATCH_MASK) !=
222 ACPI_GPE_DISPATCH_NONE) {
223 local_event_status |= ACPI_EVENT_FLAG_HAS_HANDLER;
226 /* Get the info block for the entire GPE register */
228 gpe_register_info = gpe_event_info->register_info;
230 /* Get the register bitmask for this GPE */
232 register_bit = acpi_hw_get_gpe_register_bit(gpe_event_info);
234 /* GPE currently enabled? (enabled for runtime?) */
236 if (register_bit & gpe_register_info->enable_for_run) {
237 local_event_status |= ACPI_EVENT_FLAG_ENABLED;
240 /* GPE enabled for wake? */
242 if (register_bit & gpe_register_info->enable_for_wake) {
243 local_event_status |= ACPI_EVENT_FLAG_WAKE_ENABLED;
246 /* GPE currently active (status bit == 1)? */
248 status = acpi_hw_read(&in_byte, &gpe_register_info->status_address);
249 if (ACPI_FAILURE(status)) {
253 if (register_bit & in_byte) {
254 local_event_status |= ACPI_EVENT_FLAG_SET;
257 /* Set return value */
259 (*event_status) = local_event_status;
263 /******************************************************************************
265 * FUNCTION: acpi_hw_disable_gpe_block
267 * PARAMETERS: gpe_xrupt_info - GPE Interrupt info
268 * gpe_block - Gpe Block info
272 * DESCRIPTION: Disable all GPEs within a single GPE block
274 ******************************************************************************/
277 acpi_hw_disable_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
278 struct acpi_gpe_block_info *gpe_block, void *context)
283 /* Examine each GPE Register within the block */
285 for (i = 0; i < gpe_block->register_count; i++) {
287 /* Disable all GPEs in this register */
291 &gpe_block->register_info[i].enable_address);
292 if (ACPI_FAILURE(status)) {
300 /******************************************************************************
302 * FUNCTION: acpi_hw_clear_gpe_block
304 * PARAMETERS: gpe_xrupt_info - GPE Interrupt info
305 * gpe_block - Gpe Block info
309 * DESCRIPTION: Clear status bits for all GPEs within a single GPE block
311 ******************************************************************************/
314 acpi_hw_clear_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
315 struct acpi_gpe_block_info *gpe_block, void *context)
320 /* Examine each GPE Register within the block */
322 for (i = 0; i < gpe_block->register_count; i++) {
324 /* Clear status on all GPEs in this register */
328 &gpe_block->register_info[i].status_address);
329 if (ACPI_FAILURE(status)) {
337 /******************************************************************************
339 * FUNCTION: acpi_hw_enable_runtime_gpe_block
341 * PARAMETERS: gpe_xrupt_info - GPE Interrupt info
342 * gpe_block - Gpe Block info
346 * DESCRIPTION: Enable all "runtime" GPEs within a single GPE block. Includes
347 * combination wake/run GPEs.
349 ******************************************************************************/
352 acpi_hw_enable_runtime_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
353 struct acpi_gpe_block_info * gpe_block,
359 /* NOTE: assumes that all GPEs are currently disabled */
361 /* Examine each GPE Register within the block */
363 for (i = 0; i < gpe_block->register_count; i++) {
364 if (!gpe_block->register_info[i].enable_for_run) {
368 /* Enable all "runtime" GPEs in this register */
371 acpi_hw_write(gpe_block->register_info[i].enable_for_run,
372 &gpe_block->register_info[i].enable_address);
373 if (ACPI_FAILURE(status)) {
381 /******************************************************************************
383 * FUNCTION: acpi_hw_enable_wakeup_gpe_block
385 * PARAMETERS: gpe_xrupt_info - GPE Interrupt info
386 * gpe_block - Gpe Block info
390 * DESCRIPTION: Enable all "wake" GPEs within a single GPE block. Includes
391 * combination wake/run GPEs.
393 ******************************************************************************/
396 acpi_hw_enable_wakeup_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
397 struct acpi_gpe_block_info *gpe_block,
403 /* Examine each GPE Register within the block */
405 for (i = 0; i < gpe_block->register_count; i++) {
408 * Enable all "wake" GPEs in this register and disable the
413 acpi_hw_write(gpe_block->register_info[i].enable_for_wake,
414 &gpe_block->register_info[i].enable_address);
415 if (ACPI_FAILURE(status)) {
423 /******************************************************************************
425 * FUNCTION: acpi_hw_disable_all_gpes
431 * DESCRIPTION: Disable and clear all GPEs in all GPE blocks
433 ******************************************************************************/
435 acpi_status acpi_hw_disable_all_gpes(void)
439 ACPI_FUNCTION_TRACE(hw_disable_all_gpes);
441 status = acpi_ev_walk_gpe_list(acpi_hw_disable_gpe_block, NULL);
442 status = acpi_ev_walk_gpe_list(acpi_hw_clear_gpe_block, NULL);
443 return_ACPI_STATUS(status);
446 /******************************************************************************
448 * FUNCTION: acpi_hw_enable_all_runtime_gpes
454 * DESCRIPTION: Enable all "runtime" GPEs, in all GPE blocks
456 ******************************************************************************/
458 acpi_status acpi_hw_enable_all_runtime_gpes(void)
462 ACPI_FUNCTION_TRACE(hw_enable_all_runtime_gpes);
464 status = acpi_ev_walk_gpe_list(acpi_hw_enable_runtime_gpe_block, NULL);
465 return_ACPI_STATUS(status);
468 /******************************************************************************
470 * FUNCTION: acpi_hw_enable_all_wakeup_gpes
476 * DESCRIPTION: Enable all "wakeup" GPEs, in all GPE blocks
478 ******************************************************************************/
480 acpi_status acpi_hw_enable_all_wakeup_gpes(void)
484 ACPI_FUNCTION_TRACE(hw_enable_all_wakeup_gpes);
486 status = acpi_ev_walk_gpe_list(acpi_hw_enable_wakeup_gpe_block, NULL);
487 return_ACPI_STATUS(status);
490 #endif /* !ACPI_REDUCED_HARDWARE */