195857638SErik Schmauss // SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0
23fe50208SBob Moore /******************************************************************************
33fe50208SBob Moore *
43fe50208SBob Moore * Module Name: evgpeutil - GPE utilities
53fe50208SBob Moore *
6*612c2932SBob Moore * Copyright (C) 2000 - 2023, Intel Corp.
73fe50208SBob Moore *
895857638SErik Schmauss *****************************************************************************/
93fe50208SBob Moore
103fe50208SBob Moore #include <acpi/acpi.h>
113fe50208SBob Moore #include "accommon.h"
123fe50208SBob Moore #include "acevents.h"
133fe50208SBob Moore
143fe50208SBob Moore #define _COMPONENT ACPI_EVENTS
153fe50208SBob Moore ACPI_MODULE_NAME("evgpeutil")
163fe50208SBob Moore
1733620c54SBob Moore #if (!ACPI_REDUCED_HARDWARE) /* Entire module */
183fe50208SBob Moore /*******************************************************************************
193fe50208SBob Moore *
203fe50208SBob Moore * FUNCTION: acpi_ev_walk_gpe_list
213fe50208SBob Moore *
223fe50208SBob Moore * PARAMETERS: gpe_walk_callback - Routine called for each GPE block
23ba494beeSBob Moore * context - Value passed to callback
243fe50208SBob Moore *
253fe50208SBob Moore * RETURN: Status
263fe50208SBob Moore *
273fe50208SBob Moore * DESCRIPTION: Walk the GPE lists.
283fe50208SBob Moore *
293fe50208SBob Moore ******************************************************************************/
303fe50208SBob Moore acpi_status
acpi_ev_walk_gpe_list(acpi_gpe_callback gpe_walk_callback,void * context)313fe50208SBob Moore acpi_ev_walk_gpe_list(acpi_gpe_callback gpe_walk_callback, void *context)
323fe50208SBob Moore {
333fe50208SBob Moore struct acpi_gpe_block_info *gpe_block;
343fe50208SBob Moore struct acpi_gpe_xrupt_info *gpe_xrupt_info;
353fe50208SBob Moore acpi_status status = AE_OK;
363fe50208SBob Moore acpi_cpu_flags flags;
373fe50208SBob Moore
383fe50208SBob Moore ACPI_FUNCTION_TRACE(ev_walk_gpe_list);
393fe50208SBob Moore
403fe50208SBob Moore flags = acpi_os_acquire_lock(acpi_gbl_gpe_lock);
413fe50208SBob Moore
423fe50208SBob Moore /* Walk the interrupt level descriptor list */
433fe50208SBob Moore
443fe50208SBob Moore gpe_xrupt_info = acpi_gbl_gpe_xrupt_list_head;
453fe50208SBob Moore while (gpe_xrupt_info) {
463fe50208SBob Moore
473fe50208SBob Moore /* Walk all Gpe Blocks attached to this interrupt level */
483fe50208SBob Moore
493fe50208SBob Moore gpe_block = gpe_xrupt_info->gpe_block_list_head;
503fe50208SBob Moore while (gpe_block) {
513fe50208SBob Moore
523fe50208SBob Moore /* One callback per GPE block */
533fe50208SBob Moore
543fe50208SBob Moore status =
553fe50208SBob Moore gpe_walk_callback(gpe_xrupt_info, gpe_block,
563fe50208SBob Moore context);
573fe50208SBob Moore if (ACPI_FAILURE(status)) {
583fe50208SBob Moore if (status == AE_CTRL_END) { /* Callback abort */
593fe50208SBob Moore status = AE_OK;
603fe50208SBob Moore }
613fe50208SBob Moore goto unlock_and_exit;
623fe50208SBob Moore }
633fe50208SBob Moore
643fe50208SBob Moore gpe_block = gpe_block->next;
653fe50208SBob Moore }
663fe50208SBob Moore
673fe50208SBob Moore gpe_xrupt_info = gpe_xrupt_info->next;
683fe50208SBob Moore }
693fe50208SBob Moore
703fe50208SBob Moore unlock_and_exit:
713fe50208SBob Moore acpi_os_release_lock(acpi_gbl_gpe_lock, flags);
723fe50208SBob Moore return_ACPI_STATUS(status);
733fe50208SBob Moore }
743fe50208SBob Moore
753fe50208SBob Moore /*******************************************************************************
763fe50208SBob Moore *
773cfd53d5SLin Ming * FUNCTION: acpi_ev_get_gpe_device
783cfd53d5SLin Ming *
793cfd53d5SLin Ming * PARAMETERS: GPE_WALK_CALLBACK
803cfd53d5SLin Ming *
813cfd53d5SLin Ming * RETURN: Status
823cfd53d5SLin Ming *
833cfd53d5SLin Ming * DESCRIPTION: Matches the input GPE index (0-current_gpe_count) with a GPE
843cfd53d5SLin Ming * block device. NULL if the GPE is one of the FADT-defined GPEs.
853cfd53d5SLin Ming *
863cfd53d5SLin Ming ******************************************************************************/
873cfd53d5SLin Ming
883cfd53d5SLin Ming acpi_status
acpi_ev_get_gpe_device(struct acpi_gpe_xrupt_info * gpe_xrupt_info,struct acpi_gpe_block_info * gpe_block,void * context)893cfd53d5SLin Ming acpi_ev_get_gpe_device(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
903cfd53d5SLin Ming struct acpi_gpe_block_info *gpe_block, void *context)
913cfd53d5SLin Ming {
923cfd53d5SLin Ming struct acpi_gpe_device_info *info = context;
933cfd53d5SLin Ming
943cfd53d5SLin Ming /* Increment Index by the number of GPEs in this block */
953cfd53d5SLin Ming
963cfd53d5SLin Ming info->next_block_base_index += gpe_block->gpe_count;
973cfd53d5SLin Ming
983cfd53d5SLin Ming if (info->index < info->next_block_base_index) {
993cfd53d5SLin Ming /*
1003cfd53d5SLin Ming * The GPE index is within this block, get the node. Leave the node
1013cfd53d5SLin Ming * NULL for the FADT-defined GPEs
1023cfd53d5SLin Ming */
1033cfd53d5SLin Ming if ((gpe_block->node)->type == ACPI_TYPE_DEVICE) {
1043cfd53d5SLin Ming info->gpe_device = gpe_block->node;
1053cfd53d5SLin Ming }
1063cfd53d5SLin Ming
1073cfd53d5SLin Ming info->status = AE_OK;
1083cfd53d5SLin Ming return (AE_CTRL_END);
1093cfd53d5SLin Ming }
1103cfd53d5SLin Ming
1113cfd53d5SLin Ming return (AE_OK);
1123cfd53d5SLin Ming }
1133cfd53d5SLin Ming
1143cfd53d5SLin Ming /*******************************************************************************
1153cfd53d5SLin Ming *
1163fe50208SBob Moore * FUNCTION: acpi_ev_get_gpe_xrupt_block
1173fe50208SBob Moore *
1183fe50208SBob Moore * PARAMETERS: interrupt_number - Interrupt for a GPE block
1194bec3d80SBob Moore * gpe_xrupt_block - Where the block is returned
1203fe50208SBob Moore *
1214bec3d80SBob Moore * RETURN: Status
1223fe50208SBob Moore *
1233fe50208SBob Moore * DESCRIPTION: Get or Create a GPE interrupt block. There is one interrupt
1243fe50208SBob Moore * block per unique interrupt level used for GPEs. Should be
1253fe50208SBob Moore * called only when the GPE lists are semaphore locked and not
1263fe50208SBob Moore * subject to change.
1273fe50208SBob Moore *
1283fe50208SBob Moore ******************************************************************************/
1293fe50208SBob Moore
1304bec3d80SBob Moore acpi_status
acpi_ev_get_gpe_xrupt_block(u32 interrupt_number,struct acpi_gpe_xrupt_info ** gpe_xrupt_block)1314bec3d80SBob Moore acpi_ev_get_gpe_xrupt_block(u32 interrupt_number,
1324bec3d80SBob Moore struct acpi_gpe_xrupt_info **gpe_xrupt_block)
1333fe50208SBob Moore {
1343fe50208SBob Moore struct acpi_gpe_xrupt_info *next_gpe_xrupt;
1353fe50208SBob Moore struct acpi_gpe_xrupt_info *gpe_xrupt;
1363fe50208SBob Moore acpi_status status;
1373fe50208SBob Moore acpi_cpu_flags flags;
1383fe50208SBob Moore
1393fe50208SBob Moore ACPI_FUNCTION_TRACE(ev_get_gpe_xrupt_block);
1403fe50208SBob Moore
1413fe50208SBob Moore /* No need for lock since we are not changing any list elements here */
1423fe50208SBob Moore
1433fe50208SBob Moore next_gpe_xrupt = acpi_gbl_gpe_xrupt_list_head;
1443fe50208SBob Moore while (next_gpe_xrupt) {
1453fe50208SBob Moore if (next_gpe_xrupt->interrupt_number == interrupt_number) {
1464bec3d80SBob Moore *gpe_xrupt_block = next_gpe_xrupt;
1474bec3d80SBob Moore return_ACPI_STATUS(AE_OK);
1483fe50208SBob Moore }
1493fe50208SBob Moore
1503fe50208SBob Moore next_gpe_xrupt = next_gpe_xrupt->next;
1513fe50208SBob Moore }
1523fe50208SBob Moore
1533fe50208SBob Moore /* Not found, must allocate a new xrupt descriptor */
1543fe50208SBob Moore
1553fe50208SBob Moore gpe_xrupt = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_gpe_xrupt_info));
1563fe50208SBob Moore if (!gpe_xrupt) {
1574bec3d80SBob Moore return_ACPI_STATUS(AE_NO_MEMORY);
1583fe50208SBob Moore }
1593fe50208SBob Moore
1603fe50208SBob Moore gpe_xrupt->interrupt_number = interrupt_number;
1613fe50208SBob Moore
1623fe50208SBob Moore /* Install new interrupt descriptor with spin lock */
1633fe50208SBob Moore
1643fe50208SBob Moore flags = acpi_os_acquire_lock(acpi_gbl_gpe_lock);
1653fe50208SBob Moore if (acpi_gbl_gpe_xrupt_list_head) {
1663fe50208SBob Moore next_gpe_xrupt = acpi_gbl_gpe_xrupt_list_head;
1673fe50208SBob Moore while (next_gpe_xrupt->next) {
1683fe50208SBob Moore next_gpe_xrupt = next_gpe_xrupt->next;
1693fe50208SBob Moore }
1703fe50208SBob Moore
1713fe50208SBob Moore next_gpe_xrupt->next = gpe_xrupt;
1723fe50208SBob Moore gpe_xrupt->previous = next_gpe_xrupt;
1733fe50208SBob Moore } else {
1743fe50208SBob Moore acpi_gbl_gpe_xrupt_list_head = gpe_xrupt;
1753fe50208SBob Moore }
1764bec3d80SBob Moore
1773fe50208SBob Moore acpi_os_release_lock(acpi_gbl_gpe_lock, flags);
1783fe50208SBob Moore
1793fe50208SBob Moore /* Install new interrupt handler if not SCI_INT */
1803fe50208SBob Moore
1813fe50208SBob Moore if (interrupt_number != acpi_gbl_FADT.sci_interrupt) {
1823fe50208SBob Moore status = acpi_os_install_interrupt_handler(interrupt_number,
1833fe50208SBob Moore acpi_ev_gpe_xrupt_handler,
1843fe50208SBob Moore gpe_xrupt);
1853fe50208SBob Moore if (ACPI_FAILURE(status)) {
1864bec3d80SBob Moore ACPI_EXCEPTION((AE_INFO, status,
1873fe50208SBob Moore "Could not install GPE interrupt handler at level 0x%X",
1883fe50208SBob Moore interrupt_number));
1894bec3d80SBob Moore return_ACPI_STATUS(status);
1903fe50208SBob Moore }
1913fe50208SBob Moore }
1923fe50208SBob Moore
1934bec3d80SBob Moore *gpe_xrupt_block = gpe_xrupt;
1944bec3d80SBob Moore return_ACPI_STATUS(AE_OK);
1953fe50208SBob Moore }
1963fe50208SBob Moore
1973fe50208SBob Moore /*******************************************************************************
1983fe50208SBob Moore *
1993fe50208SBob Moore * FUNCTION: acpi_ev_delete_gpe_xrupt
2003fe50208SBob Moore *
2013fe50208SBob Moore * PARAMETERS: gpe_xrupt - A GPE interrupt info block
2023fe50208SBob Moore *
2033fe50208SBob Moore * RETURN: Status
2043fe50208SBob Moore *
2053fe50208SBob Moore * DESCRIPTION: Remove and free a gpe_xrupt block. Remove an associated
2063fe50208SBob Moore * interrupt handler if not the SCI interrupt.
2073fe50208SBob Moore *
2083fe50208SBob Moore ******************************************************************************/
2093fe50208SBob Moore
acpi_ev_delete_gpe_xrupt(struct acpi_gpe_xrupt_info * gpe_xrupt)2103fe50208SBob Moore acpi_status acpi_ev_delete_gpe_xrupt(struct acpi_gpe_xrupt_info *gpe_xrupt)
2113fe50208SBob Moore {
2123fe50208SBob Moore acpi_status status;
2133fe50208SBob Moore acpi_cpu_flags flags;
2143fe50208SBob Moore
2153fe50208SBob Moore ACPI_FUNCTION_TRACE(ev_delete_gpe_xrupt);
2163fe50208SBob Moore
2173fe50208SBob Moore /* We never want to remove the SCI interrupt handler */
2183fe50208SBob Moore
2193fe50208SBob Moore if (gpe_xrupt->interrupt_number == acpi_gbl_FADT.sci_interrupt) {
2203fe50208SBob Moore gpe_xrupt->gpe_block_list_head = NULL;
2213fe50208SBob Moore return_ACPI_STATUS(AE_OK);
2223fe50208SBob Moore }
2233fe50208SBob Moore
2243fe50208SBob Moore /* Disable this interrupt */
2253fe50208SBob Moore
2263fe50208SBob Moore status =
2273fe50208SBob Moore acpi_os_remove_interrupt_handler(gpe_xrupt->interrupt_number,
2283fe50208SBob Moore acpi_ev_gpe_xrupt_handler);
2293fe50208SBob Moore if (ACPI_FAILURE(status)) {
2303fe50208SBob Moore return_ACPI_STATUS(status);
2313fe50208SBob Moore }
2323fe50208SBob Moore
2333fe50208SBob Moore /* Unlink the interrupt block with lock */
2343fe50208SBob Moore
2353fe50208SBob Moore flags = acpi_os_acquire_lock(acpi_gbl_gpe_lock);
2363fe50208SBob Moore if (gpe_xrupt->previous) {
2373fe50208SBob Moore gpe_xrupt->previous->next = gpe_xrupt->next;
2383fe50208SBob Moore } else {
2393fe50208SBob Moore /* No previous, update list head */
2403fe50208SBob Moore
2413fe50208SBob Moore acpi_gbl_gpe_xrupt_list_head = gpe_xrupt->next;
2423fe50208SBob Moore }
2433fe50208SBob Moore
2443fe50208SBob Moore if (gpe_xrupt->next) {
2453fe50208SBob Moore gpe_xrupt->next->previous = gpe_xrupt->previous;
2463fe50208SBob Moore }
2473fe50208SBob Moore acpi_os_release_lock(acpi_gbl_gpe_lock, flags);
2483fe50208SBob Moore
2493fe50208SBob Moore /* Free the block */
2503fe50208SBob Moore
2513fe50208SBob Moore ACPI_FREE(gpe_xrupt);
2523fe50208SBob Moore return_ACPI_STATUS(AE_OK);
2533fe50208SBob Moore }
2543fe50208SBob Moore
2553fe50208SBob Moore /*******************************************************************************
2563fe50208SBob Moore *
2573fe50208SBob Moore * FUNCTION: acpi_ev_delete_gpe_handlers
2583fe50208SBob Moore *
2593fe50208SBob Moore * PARAMETERS: gpe_xrupt_info - GPE Interrupt info
2603fe50208SBob Moore * gpe_block - Gpe Block info
2613fe50208SBob Moore *
2623fe50208SBob Moore * RETURN: Status
2633fe50208SBob Moore *
2643fe50208SBob Moore * DESCRIPTION: Delete all Handler objects found in the GPE data structs.
2653fe50208SBob Moore * Used only prior to termination.
2663fe50208SBob Moore *
2673fe50208SBob Moore ******************************************************************************/
2683fe50208SBob Moore
2693fe50208SBob Moore acpi_status
acpi_ev_delete_gpe_handlers(struct acpi_gpe_xrupt_info * gpe_xrupt_info,struct acpi_gpe_block_info * gpe_block,void * context)2703fe50208SBob Moore acpi_ev_delete_gpe_handlers(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
2713fe50208SBob Moore struct acpi_gpe_block_info *gpe_block,
2723fe50208SBob Moore void *context)
2733fe50208SBob Moore {
2743fe50208SBob Moore struct acpi_gpe_event_info *gpe_event_info;
2755816b343SBob Moore struct acpi_gpe_notify_info *notify;
2765816b343SBob Moore struct acpi_gpe_notify_info *next;
2773fe50208SBob Moore u32 i;
2783fe50208SBob Moore u32 j;
2793fe50208SBob Moore
2803fe50208SBob Moore ACPI_FUNCTION_TRACE(ev_delete_gpe_handlers);
2813fe50208SBob Moore
2823fe50208SBob Moore /* Examine each GPE Register within the block */
2833fe50208SBob Moore
2843fe50208SBob Moore for (i = 0; i < gpe_block->register_count; i++) {
2853fe50208SBob Moore
2863fe50208SBob Moore /* Now look at the individual GPEs in this byte register */
2873fe50208SBob Moore
2883fe50208SBob Moore for (j = 0; j < ACPI_GPE_REGISTER_WIDTH; j++) {
2893fe50208SBob Moore gpe_event_info = &gpe_block->event_info[((acpi_size)i *
2903fe50208SBob Moore ACPI_GPE_REGISTER_WIDTH)
2913fe50208SBob Moore + j];
2923fe50208SBob Moore
2930d0988afSLv Zheng if ((ACPI_GPE_DISPATCH_TYPE(gpe_event_info->flags) ==
2940d0988afSLv Zheng ACPI_GPE_DISPATCH_HANDLER) ||
2950d0988afSLv Zheng (ACPI_GPE_DISPATCH_TYPE(gpe_event_info->flags) ==
2960d0988afSLv Zheng ACPI_GPE_DISPATCH_RAW_HANDLER)) {
2975816b343SBob Moore
2985816b343SBob Moore /* Delete an installed handler block */
2995816b343SBob Moore
3003fe50208SBob Moore ACPI_FREE(gpe_event_info->dispatch.handler);
3013fe50208SBob Moore gpe_event_info->dispatch.handler = NULL;
3023fe50208SBob Moore gpe_event_info->flags &=
3033fe50208SBob Moore ~ACPI_GPE_DISPATCH_MASK;
3047c43312aSLv Zheng } else if (ACPI_GPE_DISPATCH_TYPE(gpe_event_info->flags)
3057c43312aSLv Zheng == ACPI_GPE_DISPATCH_NOTIFY) {
3065816b343SBob Moore
3075816b343SBob Moore /* Delete the implicit notification device list */
3085816b343SBob Moore
3095816b343SBob Moore notify = gpe_event_info->dispatch.notify_list;
3105816b343SBob Moore while (notify) {
3115816b343SBob Moore next = notify->next;
3125816b343SBob Moore ACPI_FREE(notify);
3135816b343SBob Moore notify = next;
3145816b343SBob Moore }
3151fad8738SBob Moore
3165816b343SBob Moore gpe_event_info->dispatch.notify_list = NULL;
3175816b343SBob Moore gpe_event_info->flags &=
3185816b343SBob Moore ~ACPI_GPE_DISPATCH_MASK;
3193fe50208SBob Moore }
3203fe50208SBob Moore }
3213fe50208SBob Moore }
3223fe50208SBob Moore
3233fe50208SBob Moore return_ACPI_STATUS(AE_OK);
3243fe50208SBob Moore }
32533620c54SBob Moore
32633620c54SBob Moore #endif /* !ACPI_REDUCED_HARDWARE */
327