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);
118 switch (action & ~ACPI_GPE_SAVE_MASK) {
119 case ACPI_GPE_CONDITIONAL_ENABLE:
121 /* Only enable if the corresponding enable_mask bit is set */
123 if (!(register_bit & gpe_register_info->enable_mask)) {
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);
148 if (ACPI_SUCCESS(status) && (action & ACPI_GPE_SAVE_MASK)) {
149 gpe_register_info->enable_mask = enable_mask;
154 /******************************************************************************
156 * FUNCTION: acpi_hw_clear_gpe
158 * PARAMETERS: gpe_event_info - Info block for the GPE to be cleared
162 * DESCRIPTION: Clear the status bit for a single GPE.
164 ******************************************************************************/
166 acpi_status acpi_hw_clear_gpe(struct acpi_gpe_event_info * gpe_event_info)
168 struct acpi_gpe_register_info *gpe_register_info;
172 ACPI_FUNCTION_ENTRY();
174 /* Get the info block for the entire GPE register */
176 gpe_register_info = gpe_event_info->register_info;
177 if (!gpe_register_info) {
178 return (AE_NOT_EXIST);
182 * Write a one to the appropriate bit in the status register to
185 register_bit = acpi_hw_get_gpe_register_bit(gpe_event_info);
187 status = acpi_hw_write(register_bit,
188 &gpe_register_info->status_address);
193 /******************************************************************************
195 * FUNCTION: acpi_hw_get_gpe_status
197 * PARAMETERS: gpe_event_info - Info block for the GPE to queried
198 * event_status - Where the GPE status is returned
202 * DESCRIPTION: Return the status of a single GPE.
204 ******************************************************************************/
207 acpi_hw_get_gpe_status(struct acpi_gpe_event_info * gpe_event_info,
208 acpi_event_status *event_status)
212 struct acpi_gpe_register_info *gpe_register_info;
213 acpi_event_status local_event_status = 0;
216 ACPI_FUNCTION_ENTRY();
219 return (AE_BAD_PARAMETER);
222 /* GPE currently handled? */
224 if ((gpe_event_info->flags & ACPI_GPE_DISPATCH_MASK) !=
225 ACPI_GPE_DISPATCH_NONE) {
226 local_event_status |= ACPI_EVENT_FLAG_HAS_HANDLER;
229 /* Get the info block for the entire GPE register */
231 gpe_register_info = gpe_event_info->register_info;
233 /* Get the register bitmask for this GPE */
235 register_bit = acpi_hw_get_gpe_register_bit(gpe_event_info);
237 /* GPE currently enabled? (enabled for runtime?) */
239 if (register_bit & gpe_register_info->enable_for_run) {
240 local_event_status |= ACPI_EVENT_FLAG_ENABLED;
243 /* GPE enabled for wake? */
245 if (register_bit & gpe_register_info->enable_for_wake) {
246 local_event_status |= ACPI_EVENT_FLAG_WAKE_ENABLED;
249 /* GPE currently active (status bit == 1)? */
251 status = acpi_hw_read(&in_byte, &gpe_register_info->status_address);
252 if (ACPI_FAILURE(status)) {
256 if (register_bit & in_byte) {
257 local_event_status |= ACPI_EVENT_FLAG_SET;
260 /* Set return value */
262 (*event_status) = local_event_status;
266 /******************************************************************************
268 * FUNCTION: acpi_hw_gpe_enable_write
270 * PARAMETERS: enable_mask - Bit mask to write to the GPE register
271 * gpe_register_info - Gpe Register info
275 * DESCRIPTION: Write the enable mask byte to the given GPE register.
277 ******************************************************************************/
280 acpi_hw_gpe_enable_write(u8 enable_mask,
281 struct acpi_gpe_register_info *gpe_register_info)
285 status = acpi_hw_write(enable_mask, &gpe_register_info->enable_address);
286 if (ACPI_SUCCESS(status)) {
287 gpe_register_info->enable_mask = enable_mask;
292 /******************************************************************************
294 * FUNCTION: acpi_hw_disable_gpe_block
296 * PARAMETERS: gpe_xrupt_info - GPE Interrupt info
297 * gpe_block - Gpe Block info
301 * DESCRIPTION: Disable all GPEs within a single GPE block
303 ******************************************************************************/
306 acpi_hw_disable_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
307 struct acpi_gpe_block_info *gpe_block, void *context)
312 /* Examine each GPE Register within the block */
314 for (i = 0; i < gpe_block->register_count; i++) {
316 /* Disable all GPEs in this register */
319 acpi_hw_gpe_enable_write(0x00,
320 &gpe_block->register_info[i]);
321 if (ACPI_FAILURE(status)) {
329 /******************************************************************************
331 * FUNCTION: acpi_hw_clear_gpe_block
333 * PARAMETERS: gpe_xrupt_info - GPE Interrupt info
334 * gpe_block - Gpe Block info
338 * DESCRIPTION: Clear status bits for all GPEs within a single GPE block
340 ******************************************************************************/
343 acpi_hw_clear_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
344 struct acpi_gpe_block_info *gpe_block, void *context)
349 /* Examine each GPE Register within the block */
351 for (i = 0; i < gpe_block->register_count; i++) {
353 /* Clear status on all GPEs in this register */
357 &gpe_block->register_info[i].status_address);
358 if (ACPI_FAILURE(status)) {
366 /******************************************************************************
368 * FUNCTION: acpi_hw_enable_runtime_gpe_block
370 * PARAMETERS: gpe_xrupt_info - GPE Interrupt info
371 * gpe_block - Gpe Block info
375 * DESCRIPTION: Enable all "runtime" GPEs within a single GPE block. Includes
376 * combination wake/run GPEs.
378 ******************************************************************************/
381 acpi_hw_enable_runtime_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
382 struct acpi_gpe_block_info * gpe_block,
387 struct acpi_gpe_register_info *gpe_register_info;
389 /* NOTE: assumes that all GPEs are currently disabled */
391 /* Examine each GPE Register within the block */
393 for (i = 0; i < gpe_block->register_count; i++) {
394 gpe_register_info = &gpe_block->register_info[i];
395 if (!gpe_register_info->enable_for_run) {
399 /* Enable all "runtime" GPEs in this register */
402 acpi_hw_gpe_enable_write(gpe_register_info->enable_for_run,
404 if (ACPI_FAILURE(status)) {
412 /******************************************************************************
414 * FUNCTION: acpi_hw_enable_wakeup_gpe_block
416 * PARAMETERS: gpe_xrupt_info - GPE Interrupt info
417 * gpe_block - Gpe Block info
421 * DESCRIPTION: Enable all "wake" GPEs within a single GPE block. Includes
422 * combination wake/run GPEs.
424 ******************************************************************************/
427 acpi_hw_enable_wakeup_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
428 struct acpi_gpe_block_info *gpe_block,
433 struct acpi_gpe_register_info *gpe_register_info;
435 /* Examine each GPE Register within the block */
437 for (i = 0; i < gpe_block->register_count; i++) {
438 gpe_register_info = &gpe_block->register_info[i];
441 * Enable all "wake" GPEs in this register and disable the
446 acpi_hw_gpe_enable_write(gpe_register_info->enable_for_wake,
448 if (ACPI_FAILURE(status)) {
456 /******************************************************************************
458 * FUNCTION: acpi_hw_disable_all_gpes
464 * DESCRIPTION: Disable and clear all GPEs in all GPE blocks
466 ******************************************************************************/
468 acpi_status acpi_hw_disable_all_gpes(void)
472 ACPI_FUNCTION_TRACE(hw_disable_all_gpes);
474 status = acpi_ev_walk_gpe_list(acpi_hw_disable_gpe_block, NULL);
475 status = acpi_ev_walk_gpe_list(acpi_hw_clear_gpe_block, NULL);
476 return_ACPI_STATUS(status);
479 /******************************************************************************
481 * FUNCTION: acpi_hw_enable_all_runtime_gpes
487 * DESCRIPTION: Enable all "runtime" GPEs, in all GPE blocks
489 ******************************************************************************/
491 acpi_status acpi_hw_enable_all_runtime_gpes(void)
495 ACPI_FUNCTION_TRACE(hw_enable_all_runtime_gpes);
497 status = acpi_ev_walk_gpe_list(acpi_hw_enable_runtime_gpe_block, NULL);
498 return_ACPI_STATUS(status);
501 /******************************************************************************
503 * FUNCTION: acpi_hw_enable_all_wakeup_gpes
509 * DESCRIPTION: Enable all "wakeup" GPEs, in all GPE blocks
511 ******************************************************************************/
513 acpi_status acpi_hw_enable_all_wakeup_gpes(void)
517 ACPI_FUNCTION_TRACE(hw_enable_all_wakeup_gpes);
519 status = acpi_ev_walk_gpe_list(acpi_hw_enable_wakeup_gpe_block, NULL);
520 return_ACPI_STATUS(status);
523 #endif /* !ACPI_REDUCED_HARDWARE */