2 /******************************************************************************
4 * Module Name: hwgpe - Low level GPE enable/disable/clear functions
6 *****************************************************************************/
9 * Copyright (C) 2000 - 2012, Intel Corp.
10 * All rights reserved.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions, and the following disclaimer,
17 * without modification.
18 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
19 * substantially similar to the "NO WARRANTY" disclaimer below
20 * ("Disclaimer") and any redistribution must be conditioned upon
21 * including a substantially similar Disclaimer requirement for further
22 * binary redistribution.
23 * 3. Neither the names of the above-listed copyright holders nor the names
24 * of any contributors may be used to endorse or promote products derived
25 * from this software without specific prior written permission.
27 * Alternatively, this software may be distributed under the terms of the
28 * GNU General Public License ("GPL") version 2 as published by the Free
29 * Software Foundation.
32 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
33 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
34 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
35 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
36 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
37 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
38 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
39 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
40 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
41 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
42 * POSSIBILITY OF SUCH DAMAGES.
45 #include <acpi/acpi.h>
49 #define _COMPONENT ACPI_HARDWARE
50 ACPI_MODULE_NAME("hwgpe")
51 #if (!ACPI_REDUCED_HARDWARE) /* Entire module */
52 /* Local prototypes */
54 acpi_hw_enable_wakeup_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
55 struct acpi_gpe_block_info *gpe_block,
58 /******************************************************************************
60 * FUNCTION: acpi_hw_get_gpe_register_bit
62 * PARAMETERS: gpe_event_info - Info block for the GPE
64 * RETURN: Register mask with a one in the GPE bit position
66 * DESCRIPTION: Compute the register mask for this GPE. One bit is set in the
67 * correct position for the input GPE.
69 ******************************************************************************/
71 u32 acpi_hw_get_gpe_register_bit(struct acpi_gpe_event_info *gpe_event_info)
73 return (u32)1 << (gpe_event_info->gpe_number -
74 gpe_event_info->register_info->base_gpe_number);
77 /******************************************************************************
79 * FUNCTION: acpi_hw_low_set_gpe
81 * PARAMETERS: gpe_event_info - Info block for the GPE to be disabled
82 * action - Enable or disable
86 * DESCRIPTION: Enable or disable a single GPE in the parent enable register.
88 ******************************************************************************/
91 acpi_hw_low_set_gpe(struct acpi_gpe_event_info *gpe_event_info, u32 action)
93 struct acpi_gpe_register_info *gpe_register_info;
98 ACPI_FUNCTION_ENTRY();
100 /* Get the info block for the entire GPE register */
102 gpe_register_info = gpe_event_info->register_info;
103 if (!gpe_register_info) {
104 return (AE_NOT_EXIST);
107 /* Get current value of the enable register that contains this GPE */
109 status = acpi_hw_read(&enable_mask, &gpe_register_info->enable_address);
110 if (ACPI_FAILURE(status)) {
114 /* Set or clear just the bit that corresponds to this GPE */
116 register_bit = acpi_hw_get_gpe_register_bit(gpe_event_info);
118 case ACPI_GPE_CONDITIONAL_ENABLE:
120 /* Only enable if the enable_for_run bit is set */
122 if (!(register_bit & gpe_register_info->enable_for_run)) {
123 return (AE_BAD_PARAMETER);
126 /*lint -fallthrough */
128 case ACPI_GPE_ENABLE:
129 ACPI_SET_BIT(enable_mask, register_bit);
132 case ACPI_GPE_DISABLE:
133 ACPI_CLEAR_BIT(enable_mask, register_bit);
137 ACPI_ERROR((AE_INFO, "Invalid GPE Action, %u\n", action));
138 return (AE_BAD_PARAMETER);
141 /* Write the updated enable mask */
143 status = acpi_hw_write(enable_mask, &gpe_register_info->enable_address);
147 /******************************************************************************
149 * FUNCTION: acpi_hw_clear_gpe
151 * PARAMETERS: gpe_event_info - Info block for the GPE to be cleared
155 * DESCRIPTION: Clear the status bit for a single GPE.
157 ******************************************************************************/
159 acpi_status acpi_hw_clear_gpe(struct acpi_gpe_event_info * gpe_event_info)
161 struct acpi_gpe_register_info *gpe_register_info;
165 ACPI_FUNCTION_ENTRY();
167 /* Get the info block for the entire GPE register */
169 gpe_register_info = gpe_event_info->register_info;
170 if (!gpe_register_info) {
171 return (AE_NOT_EXIST);
175 * Write a one to the appropriate bit in the status register to
178 register_bit = acpi_hw_get_gpe_register_bit(gpe_event_info);
180 status = acpi_hw_write(register_bit,
181 &gpe_register_info->status_address);
186 /******************************************************************************
188 * FUNCTION: acpi_hw_get_gpe_status
190 * PARAMETERS: gpe_event_info - Info block for the GPE to queried
191 * event_status - Where the GPE status is returned
195 * DESCRIPTION: Return the status of a single GPE.
197 ******************************************************************************/
200 acpi_hw_get_gpe_status(struct acpi_gpe_event_info * gpe_event_info,
201 acpi_event_status * event_status)
205 struct acpi_gpe_register_info *gpe_register_info;
206 acpi_event_status local_event_status = 0;
209 ACPI_FUNCTION_ENTRY();
212 return (AE_BAD_PARAMETER);
215 /* Get the info block for the entire GPE register */
217 gpe_register_info = gpe_event_info->register_info;
219 /* Get the register bitmask for this GPE */
221 register_bit = acpi_hw_get_gpe_register_bit(gpe_event_info);
223 /* GPE currently enabled? (enabled for runtime?) */
225 if (register_bit & gpe_register_info->enable_for_run) {
226 local_event_status |= ACPI_EVENT_FLAG_ENABLED;
229 /* GPE enabled for wake? */
231 if (register_bit & gpe_register_info->enable_for_wake) {
232 local_event_status |= ACPI_EVENT_FLAG_WAKE_ENABLED;
235 /* GPE currently active (status bit == 1)? */
237 status = acpi_hw_read(&in_byte, &gpe_register_info->status_address);
238 if (ACPI_FAILURE(status)) {
242 if (register_bit & in_byte) {
243 local_event_status |= ACPI_EVENT_FLAG_SET;
246 /* Set return value */
248 (*event_status) = local_event_status;
252 /******************************************************************************
254 * FUNCTION: acpi_hw_disable_gpe_block
256 * PARAMETERS: gpe_xrupt_info - GPE Interrupt info
257 * gpe_block - Gpe Block info
261 * DESCRIPTION: Disable all GPEs within a single GPE block
263 ******************************************************************************/
266 acpi_hw_disable_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
267 struct acpi_gpe_block_info *gpe_block, void *context)
272 /* Examine each GPE Register within the block */
274 for (i = 0; i < gpe_block->register_count; i++) {
276 /* Disable all GPEs in this register */
280 &gpe_block->register_info[i].enable_address);
281 if (ACPI_FAILURE(status)) {
289 /******************************************************************************
291 * FUNCTION: acpi_hw_clear_gpe_block
293 * PARAMETERS: gpe_xrupt_info - GPE Interrupt info
294 * gpe_block - Gpe Block info
298 * DESCRIPTION: Clear status bits for all GPEs within a single GPE block
300 ******************************************************************************/
303 acpi_hw_clear_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
304 struct acpi_gpe_block_info *gpe_block, void *context)
309 /* Examine each GPE Register within the block */
311 for (i = 0; i < gpe_block->register_count; i++) {
313 /* Clear status on all GPEs in this register */
317 &gpe_block->register_info[i].status_address);
318 if (ACPI_FAILURE(status)) {
326 /******************************************************************************
328 * FUNCTION: acpi_hw_enable_runtime_gpe_block
330 * PARAMETERS: gpe_xrupt_info - GPE Interrupt info
331 * gpe_block - Gpe Block info
335 * DESCRIPTION: Enable all "runtime" GPEs within a single GPE block. Includes
336 * combination wake/run GPEs.
338 ******************************************************************************/
341 acpi_hw_enable_runtime_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
342 struct acpi_gpe_block_info *gpe_block, void *context)
347 /* NOTE: assumes that all GPEs are currently disabled */
349 /* Examine each GPE Register within the block */
351 for (i = 0; i < gpe_block->register_count; i++) {
352 if (!gpe_block->register_info[i].enable_for_run) {
356 /* Enable all "runtime" GPEs in this register */
359 acpi_hw_write(gpe_block->register_info[i].enable_for_run,
360 &gpe_block->register_info[i].enable_address);
361 if (ACPI_FAILURE(status)) {
369 /******************************************************************************
371 * FUNCTION: acpi_hw_enable_wakeup_gpe_block
373 * PARAMETERS: gpe_xrupt_info - GPE Interrupt info
374 * gpe_block - Gpe Block info
378 * DESCRIPTION: Enable all "wake" GPEs within a single GPE block. Includes
379 * combination wake/run GPEs.
381 ******************************************************************************/
384 acpi_hw_enable_wakeup_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
385 struct acpi_gpe_block_info *gpe_block,
391 /* Examine each GPE Register within the block */
393 for (i = 0; i < gpe_block->register_count; i++) {
394 if (!gpe_block->register_info[i].enable_for_wake) {
398 /* Enable all "wake" GPEs in this register */
401 acpi_hw_write(gpe_block->register_info[i].enable_for_wake,
402 &gpe_block->register_info[i].enable_address);
403 if (ACPI_FAILURE(status)) {
411 /******************************************************************************
413 * FUNCTION: acpi_hw_disable_all_gpes
419 * DESCRIPTION: Disable and clear all GPEs in all GPE blocks
421 ******************************************************************************/
423 acpi_status acpi_hw_disable_all_gpes(void)
427 ACPI_FUNCTION_TRACE(hw_disable_all_gpes);
429 status = acpi_ev_walk_gpe_list(acpi_hw_disable_gpe_block, NULL);
430 status = acpi_ev_walk_gpe_list(acpi_hw_clear_gpe_block, NULL);
431 return_ACPI_STATUS(status);
434 /******************************************************************************
436 * FUNCTION: acpi_hw_enable_all_runtime_gpes
442 * DESCRIPTION: Enable all "runtime" GPEs, in all GPE blocks
444 ******************************************************************************/
446 acpi_status acpi_hw_enable_all_runtime_gpes(void)
450 ACPI_FUNCTION_TRACE(hw_enable_all_runtime_gpes);
452 status = acpi_ev_walk_gpe_list(acpi_hw_enable_runtime_gpe_block, NULL);
453 return_ACPI_STATUS(status);
456 /******************************************************************************
458 * FUNCTION: acpi_hw_enable_all_wakeup_gpes
464 * DESCRIPTION: Enable all "wakeup" GPEs, in all GPE blocks
466 ******************************************************************************/
468 acpi_status acpi_hw_enable_all_wakeup_gpes(void)
472 ACPI_FUNCTION_TRACE(hw_enable_all_wakeup_gpes);
474 status = acpi_ev_walk_gpe_list(acpi_hw_enable_wakeup_gpe_block, NULL);
475 return_ACPI_STATUS(status);
478 #endif /* !ACPI_REDUCED_HARDWARE */