1 /******************************************************************************
3 * Module Name: hwgpe - Low level GPE enable/disable/clear functions
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2016, 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,
58 acpi_hw_gpe_enable_write(u8 enable_mask,
59 struct acpi_gpe_register_info *gpe_register_info);
61 /******************************************************************************
63 * FUNCTION: acpi_hw_get_gpe_register_bit
65 * PARAMETERS: gpe_event_info - Info block for the GPE
67 * RETURN: Register mask with a one in the GPE bit position
69 * DESCRIPTION: Compute the register mask for this GPE. One bit is set in the
70 * correct position for the input GPE.
72 ******************************************************************************/
74 u32 acpi_hw_get_gpe_register_bit(struct acpi_gpe_event_info *gpe_event_info)
78 (gpe_event_info->gpe_number -
79 gpe_event_info->register_info->base_gpe_number));
82 /******************************************************************************
84 * FUNCTION: acpi_hw_low_set_gpe
86 * PARAMETERS: gpe_event_info - Info block for the GPE to be disabled
87 * action - Enable or disable
91 * DESCRIPTION: Enable or disable a single GPE in the parent enable register.
92 * The enable_mask field of the involved GPE register must be
93 * updated by the caller if necessary.
95 ******************************************************************************/
98 acpi_hw_low_set_gpe(struct acpi_gpe_event_info *gpe_event_info, u32 action)
100 struct acpi_gpe_register_info *gpe_register_info;
101 acpi_status status = AE_OK;
105 ACPI_FUNCTION_ENTRY();
107 /* Get the info block for the entire GPE register */
109 gpe_register_info = gpe_event_info->register_info;
110 if (!gpe_register_info) {
111 return (AE_NOT_EXIST);
114 /* Get current value of the enable register that contains this GPE */
116 status = acpi_hw_read(&enable_mask, &gpe_register_info->enable_address);
117 if (ACPI_FAILURE(status)) {
121 /* Set or clear just the bit that corresponds to this GPE */
123 register_bit = acpi_hw_get_gpe_register_bit(gpe_event_info);
125 case ACPI_GPE_CONDITIONAL_ENABLE:
127 /* Only enable if the corresponding enable_mask bit is set */
129 if (!(register_bit & gpe_register_info->enable_mask)) {
130 return (AE_BAD_PARAMETER);
133 /*lint -fallthrough */
135 case ACPI_GPE_ENABLE:
137 ACPI_SET_BIT(enable_mask, register_bit);
140 case ACPI_GPE_DISABLE:
142 ACPI_CLEAR_BIT(enable_mask, register_bit);
147 ACPI_ERROR((AE_INFO, "Invalid GPE Action, %u", action));
148 return (AE_BAD_PARAMETER);
151 if (!(register_bit & gpe_register_info->mask_for_run)) {
153 /* Write the updated enable mask */
156 acpi_hw_write(enable_mask,
157 &gpe_register_info->enable_address);
162 /******************************************************************************
164 * FUNCTION: acpi_hw_clear_gpe
166 * PARAMETERS: gpe_event_info - Info block for the GPE to be cleared
170 * DESCRIPTION: Clear the status bit for a single GPE.
172 ******************************************************************************/
174 acpi_status acpi_hw_clear_gpe(struct acpi_gpe_event_info *gpe_event_info)
176 struct acpi_gpe_register_info *gpe_register_info;
180 ACPI_FUNCTION_ENTRY();
182 /* Get the info block for the entire GPE register */
184 gpe_register_info = gpe_event_info->register_info;
185 if (!gpe_register_info) {
186 return (AE_NOT_EXIST);
190 * Write a one to the appropriate bit in the status register to
193 register_bit = acpi_hw_get_gpe_register_bit(gpe_event_info);
196 acpi_hw_write(register_bit, &gpe_register_info->status_address);
200 /******************************************************************************
202 * FUNCTION: acpi_hw_get_gpe_status
204 * PARAMETERS: gpe_event_info - Info block for the GPE to queried
205 * event_status - Where the GPE status is returned
209 * DESCRIPTION: Return the status of a single GPE.
211 ******************************************************************************/
214 acpi_hw_get_gpe_status(struct acpi_gpe_event_info *gpe_event_info,
215 acpi_event_status *event_status)
219 struct acpi_gpe_register_info *gpe_register_info;
220 acpi_event_status local_event_status = 0;
223 ACPI_FUNCTION_ENTRY();
226 return (AE_BAD_PARAMETER);
229 /* GPE currently handled? */
231 if (ACPI_GPE_DISPATCH_TYPE(gpe_event_info->flags) !=
232 ACPI_GPE_DISPATCH_NONE) {
233 local_event_status |= ACPI_EVENT_FLAG_HAS_HANDLER;
236 /* Get the info block for the entire GPE register */
238 gpe_register_info = gpe_event_info->register_info;
240 /* Get the register bitmask for this GPE */
242 register_bit = acpi_hw_get_gpe_register_bit(gpe_event_info);
244 /* GPE currently enabled? (enabled for runtime?) */
246 if (register_bit & gpe_register_info->enable_for_run) {
247 local_event_status |= ACPI_EVENT_FLAG_ENABLED;
250 /* GPE currently masked? (masked for runtime?) */
252 if (register_bit & gpe_register_info->mask_for_run) {
253 local_event_status |= ACPI_EVENT_FLAG_MASKED;
256 /* GPE enabled for wake? */
258 if (register_bit & gpe_register_info->enable_for_wake) {
259 local_event_status |= ACPI_EVENT_FLAG_WAKE_ENABLED;
262 /* GPE currently enabled (enable bit == 1)? */
264 status = acpi_hw_read(&in_byte, &gpe_register_info->enable_address);
265 if (ACPI_FAILURE(status)) {
269 if (register_bit & in_byte) {
270 local_event_status |= ACPI_EVENT_FLAG_ENABLE_SET;
273 /* GPE currently active (status bit == 1)? */
275 status = acpi_hw_read(&in_byte, &gpe_register_info->status_address);
276 if (ACPI_FAILURE(status)) {
280 if (register_bit & in_byte) {
281 local_event_status |= ACPI_EVENT_FLAG_STATUS_SET;
284 /* Set return value */
286 (*event_status) = local_event_status;
290 /******************************************************************************
292 * FUNCTION: acpi_hw_gpe_enable_write
294 * PARAMETERS: enable_mask - Bit mask to write to the GPE register
295 * gpe_register_info - Gpe Register info
299 * DESCRIPTION: Write the enable mask byte to the given GPE register.
301 ******************************************************************************/
304 acpi_hw_gpe_enable_write(u8 enable_mask,
305 struct acpi_gpe_register_info *gpe_register_info)
309 gpe_register_info->enable_mask = enable_mask;
311 status = acpi_hw_write(enable_mask, &gpe_register_info->enable_address);
315 /******************************************************************************
317 * FUNCTION: acpi_hw_disable_gpe_block
319 * PARAMETERS: gpe_xrupt_info - GPE Interrupt info
320 * gpe_block - Gpe Block info
324 * DESCRIPTION: Disable all GPEs within a single GPE block
326 ******************************************************************************/
329 acpi_hw_disable_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
330 struct acpi_gpe_block_info *gpe_block, void *context)
335 /* Examine each GPE Register within the block */
337 for (i = 0; i < gpe_block->register_count; i++) {
339 /* Disable all GPEs in this register */
342 acpi_hw_gpe_enable_write(0x00,
343 &gpe_block->register_info[i]);
344 if (ACPI_FAILURE(status)) {
352 /******************************************************************************
354 * FUNCTION: acpi_hw_clear_gpe_block
356 * PARAMETERS: gpe_xrupt_info - GPE Interrupt info
357 * gpe_block - Gpe Block info
361 * DESCRIPTION: Clear status bits for all GPEs within a single GPE block
363 ******************************************************************************/
366 acpi_hw_clear_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
367 struct acpi_gpe_block_info *gpe_block, void *context)
372 /* Examine each GPE Register within the block */
374 for (i = 0; i < gpe_block->register_count; i++) {
376 /* Clear status on all GPEs in this register */
380 &gpe_block->register_info[i].status_address);
381 if (ACPI_FAILURE(status)) {
389 /******************************************************************************
391 * FUNCTION: acpi_hw_enable_runtime_gpe_block
393 * PARAMETERS: gpe_xrupt_info - GPE Interrupt info
394 * gpe_block - Gpe Block info
398 * DESCRIPTION: Enable all "runtime" GPEs within a single GPE block. Includes
399 * combination wake/run GPEs.
401 ******************************************************************************/
404 acpi_hw_enable_runtime_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
405 struct acpi_gpe_block_info *gpe_block,
410 struct acpi_gpe_register_info *gpe_register_info;
413 /* NOTE: assumes that all GPEs are currently disabled */
415 /* Examine each GPE Register within the block */
417 for (i = 0; i < gpe_block->register_count; i++) {
418 gpe_register_info = &gpe_block->register_info[i];
419 if (!gpe_register_info->enable_for_run) {
423 /* Enable all "runtime" GPEs in this register */
425 enable_mask = gpe_register_info->enable_for_run &
426 ~gpe_register_info->mask_for_run;
428 acpi_hw_gpe_enable_write(enable_mask, gpe_register_info);
429 if (ACPI_FAILURE(status)) {
437 /******************************************************************************
439 * FUNCTION: acpi_hw_enable_wakeup_gpe_block
441 * PARAMETERS: gpe_xrupt_info - GPE Interrupt info
442 * gpe_block - Gpe Block info
446 * DESCRIPTION: Enable all "wake" GPEs within a single GPE block. Includes
447 * combination wake/run GPEs.
449 ******************************************************************************/
452 acpi_hw_enable_wakeup_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
453 struct acpi_gpe_block_info *gpe_block,
458 struct acpi_gpe_register_info *gpe_register_info;
460 /* Examine each GPE Register within the block */
462 for (i = 0; i < gpe_block->register_count; i++) {
463 gpe_register_info = &gpe_block->register_info[i];
466 * Enable all "wake" GPEs in this register and disable the
471 acpi_hw_gpe_enable_write(gpe_register_info->enable_for_wake,
473 if (ACPI_FAILURE(status)) {
481 /******************************************************************************
483 * FUNCTION: acpi_hw_disable_all_gpes
489 * DESCRIPTION: Disable and clear all GPEs in all GPE blocks
491 ******************************************************************************/
493 acpi_status acpi_hw_disable_all_gpes(void)
497 ACPI_FUNCTION_TRACE(hw_disable_all_gpes);
499 status = acpi_ev_walk_gpe_list(acpi_hw_disable_gpe_block, NULL);
500 status = acpi_ev_walk_gpe_list(acpi_hw_clear_gpe_block, NULL);
501 return_ACPI_STATUS(status);
504 /******************************************************************************
506 * FUNCTION: acpi_hw_enable_all_runtime_gpes
512 * DESCRIPTION: Enable all "runtime" GPEs, in all GPE blocks
514 ******************************************************************************/
516 acpi_status acpi_hw_enable_all_runtime_gpes(void)
520 ACPI_FUNCTION_TRACE(hw_enable_all_runtime_gpes);
522 status = acpi_ev_walk_gpe_list(acpi_hw_enable_runtime_gpe_block, NULL);
523 return_ACPI_STATUS(status);
526 /******************************************************************************
528 * FUNCTION: acpi_hw_enable_all_wakeup_gpes
534 * DESCRIPTION: Enable all "wakeup" GPEs, in all GPE blocks
536 ******************************************************************************/
538 acpi_status acpi_hw_enable_all_wakeup_gpes(void)
542 ACPI_FUNCTION_TRACE(hw_enable_all_wakeup_gpes);
544 status = acpi_ev_walk_gpe_list(acpi_hw_enable_wakeup_gpe_block, NULL);
545 return_ACPI_STATUS(status);
548 #endif /* !ACPI_REDUCED_HARDWARE */