1 // SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0
2 /******************************************************************************
4 * Module Name: hwgpe - Low level GPE enable/disable/clear functions
6 * Copyright (C) 2000 - 2020, Intel Corp.
8 *****************************************************************************/
10 #include <acpi/acpi.h>
14 #define _COMPONENT ACPI_HARDWARE
15 ACPI_MODULE_NAME("hwgpe")
16 #if (!ACPI_REDUCED_HARDWARE) /* Entire module */
17 /* Local prototypes */
19 acpi_hw_enable_wakeup_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
20 struct acpi_gpe_block_info *gpe_block,
24 acpi_hw_gpe_enable_write(u8 enable_mask,
25 struct acpi_gpe_register_info *gpe_register_info);
27 /******************************************************************************
29 * FUNCTION: acpi_hw_get_gpe_register_bit
31 * PARAMETERS: gpe_event_info - Info block for the GPE
33 * RETURN: Register mask with a one in the GPE bit position
35 * DESCRIPTION: Compute the register mask for this GPE. One bit is set in the
36 * correct position for the input GPE.
38 ******************************************************************************/
40 u32 acpi_hw_get_gpe_register_bit(struct acpi_gpe_event_info *gpe_event_info)
44 (gpe_event_info->gpe_number -
45 gpe_event_info->register_info->base_gpe_number));
48 /******************************************************************************
50 * FUNCTION: acpi_hw_low_set_gpe
52 * PARAMETERS: gpe_event_info - Info block for the GPE to be disabled
53 * action - Enable or disable
57 * DESCRIPTION: Enable or disable a single GPE in the parent enable register.
58 * The enable_mask field of the involved GPE register must be
59 * updated by the caller if necessary.
61 ******************************************************************************/
64 acpi_hw_low_set_gpe(struct acpi_gpe_event_info *gpe_event_info, u32 action)
66 struct acpi_gpe_register_info *gpe_register_info;
67 acpi_status status = AE_OK;
71 ACPI_FUNCTION_ENTRY();
73 /* Get the info block for the entire GPE register */
75 gpe_register_info = gpe_event_info->register_info;
76 if (!gpe_register_info) {
77 return (AE_NOT_EXIST);
80 /* Get current value of the enable register that contains this GPE */
82 status = acpi_hw_read(&enable_mask, &gpe_register_info->enable_address);
83 if (ACPI_FAILURE(status)) {
87 /* Set or clear just the bit that corresponds to this GPE */
89 register_bit = acpi_hw_get_gpe_register_bit(gpe_event_info);
91 case ACPI_GPE_CONDITIONAL_ENABLE:
93 /* Only enable if the corresponding enable_mask bit is set */
95 if (!(register_bit & gpe_register_info->enable_mask)) {
96 return (AE_BAD_PARAMETER);
99 /*lint -fallthrough */
101 case ACPI_GPE_ENABLE:
103 ACPI_SET_BIT(enable_mask, register_bit);
106 case ACPI_GPE_DISABLE:
108 ACPI_CLEAR_BIT(enable_mask, register_bit);
113 ACPI_ERROR((AE_INFO, "Invalid GPE Action, %u", action));
114 return (AE_BAD_PARAMETER);
117 if (!(register_bit & gpe_register_info->mask_for_run)) {
119 /* Write the updated enable mask */
122 acpi_hw_write(enable_mask,
123 &gpe_register_info->enable_address);
128 /******************************************************************************
130 * FUNCTION: acpi_hw_clear_gpe
132 * PARAMETERS: gpe_event_info - Info block for the GPE to be cleared
136 * DESCRIPTION: Clear the status bit for a single GPE.
138 ******************************************************************************/
140 acpi_status acpi_hw_clear_gpe(struct acpi_gpe_event_info *gpe_event_info)
142 struct acpi_gpe_register_info *gpe_register_info;
146 ACPI_FUNCTION_ENTRY();
148 /* Get the info block for the entire GPE register */
150 gpe_register_info = gpe_event_info->register_info;
151 if (!gpe_register_info) {
152 return (AE_NOT_EXIST);
156 * Write a one to the appropriate bit in the status register to
159 register_bit = acpi_hw_get_gpe_register_bit(gpe_event_info);
162 acpi_hw_write(register_bit, &gpe_register_info->status_address);
166 /******************************************************************************
168 * FUNCTION: acpi_hw_get_gpe_status
170 * PARAMETERS: gpe_event_info - Info block for the GPE to queried
171 * event_status - Where the GPE status is returned
175 * DESCRIPTION: Return the status of a single GPE.
177 ******************************************************************************/
180 acpi_hw_get_gpe_status(struct acpi_gpe_event_info *gpe_event_info,
181 acpi_event_status *event_status)
185 struct acpi_gpe_register_info *gpe_register_info;
186 acpi_event_status local_event_status = 0;
189 ACPI_FUNCTION_ENTRY();
192 return (AE_BAD_PARAMETER);
195 /* GPE currently handled? */
197 if (ACPI_GPE_DISPATCH_TYPE(gpe_event_info->flags) !=
198 ACPI_GPE_DISPATCH_NONE) {
199 local_event_status |= ACPI_EVENT_FLAG_HAS_HANDLER;
202 /* Get the info block for the entire GPE register */
204 gpe_register_info = gpe_event_info->register_info;
206 /* Get the register bitmask for this GPE */
208 register_bit = acpi_hw_get_gpe_register_bit(gpe_event_info);
210 /* GPE currently enabled? (enabled for runtime?) */
212 if (register_bit & gpe_register_info->enable_for_run) {
213 local_event_status |= ACPI_EVENT_FLAG_ENABLED;
216 /* GPE currently masked? (masked for runtime?) */
218 if (register_bit & gpe_register_info->mask_for_run) {
219 local_event_status |= ACPI_EVENT_FLAG_MASKED;
222 /* GPE enabled for wake? */
224 if (register_bit & gpe_register_info->enable_for_wake) {
225 local_event_status |= ACPI_EVENT_FLAG_WAKE_ENABLED;
228 /* GPE currently enabled (enable bit == 1)? */
230 status = acpi_hw_read(&in_byte, &gpe_register_info->enable_address);
231 if (ACPI_FAILURE(status)) {
235 if (register_bit & in_byte) {
236 local_event_status |= ACPI_EVENT_FLAG_ENABLE_SET;
239 /* GPE currently active (status bit == 1)? */
241 status = acpi_hw_read(&in_byte, &gpe_register_info->status_address);
242 if (ACPI_FAILURE(status)) {
246 if (register_bit & in_byte) {
247 local_event_status |= ACPI_EVENT_FLAG_STATUS_SET;
250 /* Set return value */
252 (*event_status) = local_event_status;
256 /******************************************************************************
258 * FUNCTION: acpi_hw_gpe_enable_write
260 * PARAMETERS: enable_mask - Bit mask to write to the GPE register
261 * gpe_register_info - Gpe Register info
265 * DESCRIPTION: Write the enable mask byte to the given GPE register.
267 ******************************************************************************/
270 acpi_hw_gpe_enable_write(u8 enable_mask,
271 struct acpi_gpe_register_info *gpe_register_info)
275 gpe_register_info->enable_mask = enable_mask;
277 status = acpi_hw_write(enable_mask, &gpe_register_info->enable_address);
281 /******************************************************************************
283 * FUNCTION: acpi_hw_disable_gpe_block
285 * PARAMETERS: gpe_xrupt_info - GPE Interrupt info
286 * gpe_block - Gpe Block info
290 * DESCRIPTION: Disable all GPEs within a single GPE block
292 ******************************************************************************/
295 acpi_hw_disable_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
296 struct acpi_gpe_block_info *gpe_block, void *context)
301 /* Examine each GPE Register within the block */
303 for (i = 0; i < gpe_block->register_count; i++) {
305 /* Disable all GPEs in this register */
308 acpi_hw_gpe_enable_write(0x00,
309 &gpe_block->register_info[i]);
310 if (ACPI_FAILURE(status)) {
318 /******************************************************************************
320 * FUNCTION: acpi_hw_clear_gpe_block
322 * PARAMETERS: gpe_xrupt_info - GPE Interrupt info
323 * gpe_block - Gpe Block info
327 * DESCRIPTION: Clear status bits for all GPEs within a single GPE block
329 ******************************************************************************/
332 acpi_hw_clear_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
333 struct acpi_gpe_block_info *gpe_block, void *context)
338 /* Examine each GPE Register within the block */
340 for (i = 0; i < gpe_block->register_count; i++) {
342 /* Clear status on all GPEs in this register */
346 &gpe_block->register_info[i].status_address);
347 if (ACPI_FAILURE(status)) {
355 /******************************************************************************
357 * FUNCTION: acpi_hw_enable_runtime_gpe_block
359 * PARAMETERS: gpe_xrupt_info - GPE Interrupt info
360 * gpe_block - Gpe Block info
364 * DESCRIPTION: Enable all "runtime" GPEs within a single GPE block. Includes
365 * combination wake/run GPEs.
367 ******************************************************************************/
370 acpi_hw_enable_runtime_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
371 struct acpi_gpe_block_info *gpe_block,
376 struct acpi_gpe_register_info *gpe_register_info;
379 /* NOTE: assumes that all GPEs are currently disabled */
381 /* Examine each GPE Register within the block */
383 for (i = 0; i < gpe_block->register_count; i++) {
384 gpe_register_info = &gpe_block->register_info[i];
385 if (!gpe_register_info->enable_for_run) {
389 /* Enable all "runtime" GPEs in this register */
391 enable_mask = gpe_register_info->enable_for_run &
392 ~gpe_register_info->mask_for_run;
394 acpi_hw_gpe_enable_write(enable_mask, gpe_register_info);
395 if (ACPI_FAILURE(status)) {
403 /******************************************************************************
405 * FUNCTION: acpi_hw_enable_wakeup_gpe_block
407 * PARAMETERS: gpe_xrupt_info - GPE Interrupt info
408 * gpe_block - Gpe Block info
412 * DESCRIPTION: Enable all "wake" GPEs within a single GPE block. Includes
413 * combination wake/run GPEs.
415 ******************************************************************************/
418 acpi_hw_enable_wakeup_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
419 struct acpi_gpe_block_info *gpe_block,
424 struct acpi_gpe_register_info *gpe_register_info;
426 /* Examine each GPE Register within the block */
428 for (i = 0; i < gpe_block->register_count; i++) {
429 gpe_register_info = &gpe_block->register_info[i];
432 * Enable all "wake" GPEs in this register and disable the
437 acpi_hw_gpe_enable_write(gpe_register_info->enable_for_wake,
439 if (ACPI_FAILURE(status)) {
447 struct acpi_gpe_block_status_context {
448 struct acpi_gpe_register_info *gpe_skip_register_info;
453 /******************************************************************************
455 * FUNCTION: acpi_hw_get_gpe_block_status
457 * PARAMETERS: gpe_xrupt_info - GPE Interrupt info
458 * gpe_block - Gpe Block info
459 * context - GPE list walk context data
463 * DESCRIPTION: Produce a combined GPE status bits mask for the given block.
465 ******************************************************************************/
468 acpi_hw_get_gpe_block_status(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
469 struct acpi_gpe_block_info *gpe_block,
472 struct acpi_gpe_block_status_context *c = context;
473 struct acpi_gpe_register_info *gpe_register_info;
474 u64 in_enable, in_status;
479 /* Examine each GPE Register within the block */
481 for (i = 0; i < gpe_block->register_count; i++) {
482 gpe_register_info = &gpe_block->register_info[i];
484 status = acpi_hw_read(&in_enable,
485 &gpe_register_info->enable_address);
486 if (ACPI_FAILURE(status)) {
490 status = acpi_hw_read(&in_status,
491 &gpe_register_info->status_address);
492 if (ACPI_FAILURE(status)) {
496 ret_mask = in_enable & in_status;
497 if (ret_mask && c->gpe_skip_register_info == gpe_register_info) {
498 ret_mask &= ~c->gpe_skip_mask;
500 c->retval |= ret_mask;
506 /******************************************************************************
508 * FUNCTION: acpi_hw_disable_all_gpes
514 * DESCRIPTION: Disable and clear all GPEs in all GPE blocks
516 ******************************************************************************/
518 acpi_status acpi_hw_disable_all_gpes(void)
522 ACPI_FUNCTION_TRACE(hw_disable_all_gpes);
524 status = acpi_ev_walk_gpe_list(acpi_hw_disable_gpe_block, NULL);
525 return_ACPI_STATUS(status);
528 /******************************************************************************
530 * FUNCTION: acpi_hw_enable_all_runtime_gpes
536 * DESCRIPTION: Enable all "runtime" GPEs, in all GPE blocks
538 ******************************************************************************/
540 acpi_status acpi_hw_enable_all_runtime_gpes(void)
544 ACPI_FUNCTION_TRACE(hw_enable_all_runtime_gpes);
546 status = acpi_ev_walk_gpe_list(acpi_hw_enable_runtime_gpe_block, NULL);
547 return_ACPI_STATUS(status);
550 /******************************************************************************
552 * FUNCTION: acpi_hw_enable_all_wakeup_gpes
558 * DESCRIPTION: Enable all "wakeup" GPEs, in all GPE blocks
560 ******************************************************************************/
562 acpi_status acpi_hw_enable_all_wakeup_gpes(void)
566 ACPI_FUNCTION_TRACE(hw_enable_all_wakeup_gpes);
568 status = acpi_ev_walk_gpe_list(acpi_hw_enable_wakeup_gpe_block, NULL);
569 return_ACPI_STATUS(status);
572 /******************************************************************************
574 * FUNCTION: acpi_hw_check_all_gpes
576 * PARAMETERS: gpe_skip_device - GPE devoce of the GPE to skip
577 * gpe_skip_number - Number of the GPE to skip
579 * RETURN: Combined status of all GPEs
581 * DESCRIPTION: Check all enabled GPEs in all GPE blocks, except for the one
582 * represented by the "skip" arguments, and return TRUE if the
583 * status bit is set for at least one of them of FALSE otherwise.
585 ******************************************************************************/
587 u8 acpi_hw_check_all_gpes(acpi_handle gpe_skip_device, u32 gpe_skip_number)
589 struct acpi_gpe_block_status_context context = {
590 .gpe_skip_register_info = NULL,
593 struct acpi_gpe_event_info *gpe_event_info;
594 acpi_cpu_flags flags;
596 ACPI_FUNCTION_TRACE(acpi_hw_check_all_gpes);
598 flags = acpi_os_acquire_lock(acpi_gbl_gpe_lock);
600 gpe_event_info = acpi_ev_get_gpe_event_info(gpe_skip_device,
602 if (gpe_event_info) {
603 context.gpe_skip_register_info = gpe_event_info->register_info;
604 context.gpe_skip_mask = acpi_hw_get_gpe_register_bit(gpe_event_info);
607 acpi_os_release_lock(acpi_gbl_gpe_lock, flags);
609 (void)acpi_ev_walk_gpe_list(acpi_hw_get_gpe_block_status, &context);
610 return (context.retval != 0);
613 #endif /* !ACPI_REDUCED_HARDWARE */