GPIO_CLEAR_ACTIVE_INTERRUPTS_PARAMETERS structure (gpioclx.h)

The GPIO_CLEAR_ACTIVE_INTERRUPTS_PARAMETERS structure describes a set of general-purpose I/O (GPIO) interrupt pins to clear.

Syntax

typedef struct _GPIO_CLEAR_ACTIVE_INTERRUPTS_PARAMETERS {
  BANK_ID BankId;
  ULONG64 ClearActiveMask;
  ULONG64 FailedClearMask;
} GPIO_CLEAR_ACTIVE_INTERRUPTS_PARAMETERS, *PGPIO_CLEAR_ACTIVE_INTERRUPTS_PARAMETERS;

Members

BankId

The identifier for the bank of GPIO pins that contains the pins to be cleared. If N is the number of banks in the GPIO controller, BankId is an integer in the range 0 to N–1. The GPIO framework extension (GpioClx) previously obtained the number of banks in the controller from the CLIENT_QueryControllerBasicInformation event callback function. For more information, see Remarks in CLIENT_CONTROLLER_BASIC_INFORMATION.

ClearActiveMask

A 64-bit mask that indicates which interrupts to clear in the specified bank. A bit in the mask that is set to 1 identifies a pin that is configured as an interrupt and that is to be cleared. All other bits in the mask are 0. If N is the number of pins in this bank, the pins are numbered 0 to N–1. Bit 0 (the least significant bit) in the mask represents pin 0, bit 1 represents pin 1, and so on.

FailedClearMask

A 64-bit mask that identifies the GPIO pins that could not be cleared. If the GPIO controller driver fails to clear a bit that is indicated in the ClearActiveMask member, the driver sets the corresponding bit in the FailedClearMask member to mark the failure. If all the bits specified in ClearActiveMask are successfully cleared, the driver sets FailedClearMask to zero.

Remarks

The ClearParameters parameter of the CLIENT_ClearActiveInterrupts event callback function is a pointer to a caller-allocated GPIO_CLEAR_ACTIVE_INTERRUPTS_PARAMETERS structure. This function affects only GPIO pins that are configured as interrupt inputs and that are part of the specified bank of GPIO pins.

Requirements

Requirement Value
Minimum supported client Supported starting with Windows 8.
Header gpioclx.h

See also

CLIENT_CONTROLLER_BASIC_INFORMATION

CLIENT_ClearActiveInterrupts

CLIENT_QueryControllerBasicInformation