2 /******************************************************************************
4 * Module Name: hwgpe - Low level GPE enable/disable/clear functions
6 *****************************************************************************/
9 * Copyright (C) 2000 - 2010, 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")
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_gpe_register_bit
62 * PARAMETERS: gpe_event_info - Info block for the GPE
63 * gpe_register_info - Info block for the GPE register
67 * DESCRIPTION: Compute GPE enable mask with one bit corresponding to the given
70 ******************************************************************************/
72 u32 acpi_hw_gpe_register_bit(struct acpi_gpe_event_info *gpe_event_info,
73 struct acpi_gpe_register_info *gpe_register_info)
75 return (u32)1 << (gpe_event_info->gpe_number -
76 gpe_register_info->base_gpe_number);
79 /******************************************************************************
81 * FUNCTION: acpi_hw_low_set_gpe
83 * PARAMETERS: gpe_event_info - Info block for the GPE to be disabled
84 * action - Enable or disable
88 * DESCRIPTION: Enable or disable a single GPE in its enable register.
90 ******************************************************************************/
93 acpi_hw_low_set_gpe(struct acpi_gpe_event_info *gpe_event_info, u8 action)
95 struct acpi_gpe_register_info *gpe_register_info;
100 ACPI_FUNCTION_ENTRY();
102 /* Get the info block for the entire GPE register */
104 gpe_register_info = gpe_event_info->register_info;
105 if (!gpe_register_info) {
106 return (AE_NOT_EXIST);
109 /* Get current value of the enable register that contains this GPE */
111 status = acpi_hw_read(&enable_mask, &gpe_register_info->enable_address);
112 if (ACPI_FAILURE(status)) {
116 /* Set ot clear just the bit that corresponds to this GPE */
118 register_bit = acpi_hw_gpe_register_bit(gpe_event_info,
121 case ACPI_GPE_COND_ENABLE:
122 if (!(register_bit & gpe_register_info->enable_for_run))
123 return (AE_BAD_PARAMETER);
125 case ACPI_GPE_ENABLE:
126 ACPI_SET_BIT(enable_mask, register_bit);
129 case ACPI_GPE_DISABLE:
130 ACPI_CLEAR_BIT(enable_mask, register_bit);
134 ACPI_ERROR((AE_INFO, "Invalid action\n"));
135 return (AE_BAD_PARAMETER);
138 /* Write the updated enable mask */
140 status = acpi_hw_write(enable_mask, &gpe_register_info->enable_address);
144 /******************************************************************************
146 * FUNCTION: acpi_hw_write_gpe_enable_reg
148 * PARAMETERS: gpe_event_info - Info block for the GPE to be enabled
152 * DESCRIPTION: Write a GPE enable register. Note: The bit for this GPE must
153 * already be cleared or set in the parent register
154 * enable_for_run mask.
156 ******************************************************************************/
159 acpi_hw_write_gpe_enable_reg(struct acpi_gpe_event_info * gpe_event_info)
163 ACPI_FUNCTION_ENTRY();
165 status = acpi_hw_low_set_gpe(gpe_event_info, ACPI_GPE_COND_ENABLE);
169 /******************************************************************************
171 * FUNCTION: acpi_hw_clear_gpe
173 * PARAMETERS: gpe_event_info - Info block for the GPE to be cleared
177 * DESCRIPTION: Clear the status bit for a single GPE.
179 ******************************************************************************/
181 acpi_status acpi_hw_clear_gpe(struct acpi_gpe_event_info * gpe_event_info)
183 struct acpi_gpe_register_info *gpe_register_info;
187 ACPI_FUNCTION_ENTRY();
189 /* Get the info block for the entire GPE register */
191 gpe_register_info = gpe_event_info->register_info;
192 if (!gpe_register_info) {
193 return (AE_NOT_EXIST);
196 register_bit = acpi_hw_gpe_register_bit(gpe_event_info,
200 * Write a one to the appropriate bit in the status register to
203 status = acpi_hw_write(register_bit,
204 &gpe_register_info->status_address);
209 /******************************************************************************
211 * FUNCTION: acpi_hw_get_gpe_status
213 * PARAMETERS: gpe_event_info - Info block for the GPE to queried
214 * event_status - Where the GPE status is returned
218 * DESCRIPTION: Return the status of a single GPE.
220 ******************************************************************************/
223 acpi_hw_get_gpe_status(struct acpi_gpe_event_info * gpe_event_info,
224 acpi_event_status * event_status)
228 struct acpi_gpe_register_info *gpe_register_info;
230 acpi_event_status local_event_status = 0;
232 ACPI_FUNCTION_ENTRY();
235 return (AE_BAD_PARAMETER);
238 /* Get the info block for the entire GPE register */
240 gpe_register_info = gpe_event_info->register_info;
242 /* Get the register bitmask for this GPE */
244 register_bit = acpi_hw_gpe_register_bit(gpe_event_info,
247 /* GPE currently enabled? (enabled for runtime?) */
249 if (register_bit & gpe_register_info->enable_for_run) {
250 local_event_status |= ACPI_EVENT_FLAG_ENABLED;
253 /* GPE enabled for wake? */
255 if (register_bit & gpe_register_info->enable_for_wake) {
256 local_event_status |= ACPI_EVENT_FLAG_WAKE_ENABLED;
259 /* GPE currently active (status bit == 1)? */
261 status = acpi_hw_read(&in_byte, &gpe_register_info->status_address);
262 if (ACPI_FAILURE(status)) {
266 if (register_bit & in_byte) {
267 local_event_status |= ACPI_EVENT_FLAG_SET;
270 /* Set return value */
272 (*event_status) = local_event_status;
276 /******************************************************************************
278 * FUNCTION: acpi_hw_disable_gpe_block
280 * PARAMETERS: gpe_xrupt_info - GPE Interrupt info
281 * gpe_block - Gpe Block info
285 * DESCRIPTION: Disable all GPEs within a single GPE block
287 ******************************************************************************/
290 acpi_hw_disable_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
291 struct acpi_gpe_block_info *gpe_block, void *context)
296 /* Examine each GPE Register within the block */
298 for (i = 0; i < gpe_block->register_count; i++) {
300 /* Disable all GPEs in this register */
304 &gpe_block->register_info[i].enable_address);
305 if (ACPI_FAILURE(status)) {
313 /******************************************************************************
315 * FUNCTION: acpi_hw_clear_gpe_block
317 * PARAMETERS: gpe_xrupt_info - GPE Interrupt info
318 * gpe_block - Gpe Block info
322 * DESCRIPTION: Clear status bits for all GPEs within a single GPE block
324 ******************************************************************************/
327 acpi_hw_clear_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
328 struct acpi_gpe_block_info *gpe_block, void *context)
333 /* Examine each GPE Register within the block */
335 for (i = 0; i < gpe_block->register_count; i++) {
337 /* Clear status on all GPEs in this register */
341 &gpe_block->register_info[i].status_address);
342 if (ACPI_FAILURE(status)) {
350 /******************************************************************************
352 * FUNCTION: acpi_hw_enable_runtime_gpe_block
354 * PARAMETERS: gpe_xrupt_info - GPE Interrupt info
355 * gpe_block - Gpe Block info
359 * DESCRIPTION: Enable all "runtime" GPEs within a single GPE block. Includes
360 * combination wake/run GPEs.
362 ******************************************************************************/
365 acpi_hw_enable_runtime_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
366 struct acpi_gpe_block_info *gpe_block, void *context)
371 /* NOTE: assumes that all GPEs are currently disabled */
373 /* Examine each GPE Register within the block */
375 for (i = 0; i < gpe_block->register_count; i++) {
376 if (!gpe_block->register_info[i].enable_for_run) {
380 /* Enable all "runtime" GPEs in this register */
383 acpi_hw_write(gpe_block->register_info[i].enable_for_run,
384 &gpe_block->register_info[i].enable_address);
385 if (ACPI_FAILURE(status)) {
393 /******************************************************************************
395 * FUNCTION: acpi_hw_enable_wakeup_gpe_block
397 * PARAMETERS: gpe_xrupt_info - GPE Interrupt info
398 * gpe_block - Gpe Block info
402 * DESCRIPTION: Enable all "wake" GPEs within a single GPE block. Includes
403 * combination wake/run GPEs.
405 ******************************************************************************/
408 acpi_hw_enable_wakeup_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
409 struct acpi_gpe_block_info *gpe_block,
415 /* Examine each GPE Register within the block */
417 for (i = 0; i < gpe_block->register_count; i++) {
418 if (!gpe_block->register_info[i].enable_for_wake) {
422 /* Enable all "wake" GPEs in this register */
425 acpi_hw_write(gpe_block->register_info[i].enable_for_wake,
426 &gpe_block->register_info[i].enable_address);
427 if (ACPI_FAILURE(status)) {
435 /******************************************************************************
437 * FUNCTION: acpi_hw_disable_all_gpes
443 * DESCRIPTION: Disable and clear all GPEs in all GPE blocks
445 ******************************************************************************/
447 acpi_status acpi_hw_disable_all_gpes(void)
451 ACPI_FUNCTION_TRACE(hw_disable_all_gpes);
453 status = acpi_ev_walk_gpe_list(acpi_hw_disable_gpe_block, NULL);
454 status = acpi_ev_walk_gpe_list(acpi_hw_clear_gpe_block, NULL);
455 return_ACPI_STATUS(status);
458 /******************************************************************************
460 * FUNCTION: acpi_hw_enable_all_runtime_gpes
466 * DESCRIPTION: Enable all "runtime" GPEs, in all GPE blocks
468 ******************************************************************************/
470 acpi_status acpi_hw_enable_all_runtime_gpes(void)
474 ACPI_FUNCTION_TRACE(hw_enable_all_runtime_gpes);
476 status = acpi_ev_walk_gpe_list(acpi_hw_enable_runtime_gpe_block, NULL);
477 return_ACPI_STATUS(status);
480 /******************************************************************************
482 * FUNCTION: acpi_hw_enable_all_wakeup_gpes
488 * DESCRIPTION: Enable all "wakeup" GPEs, in all GPE blocks
490 ******************************************************************************/
492 acpi_status acpi_hw_enable_all_wakeup_gpes(void)
496 ACPI_FUNCTION_TRACE(hw_enable_all_wakeup_gpes);
498 status = acpi_ev_walk_gpe_list(acpi_hw_enable_wakeup_gpe_block, NULL);
499 return_ACPI_STATUS(status);