GPIO_CLIENT_UNMASK_INTERRUPT callback function (gpioclx.h)

The CLIENT_UnmaskInterrupt event callback function unmasks the interrupt on a general-purpose I/O (GPIO) pin that is configured as an interrupt input.

Syntax

GPIO_CLIENT_UNMASK_INTERRUPT GpioClientUnmaskInterrupt;

NTSTATUS GpioClientUnmaskInterrupt(
  [in] PVOID Context,
  [in] PGPIO_ENABLE_INTERRUPT_PARAMETERS InterruptParameters
)
{...}

Parameters

[in] Context

A pointer to the GPIO controller driver's device context.

[in] InterruptParameters

A pointer to a GPIO_ENABLE_INTERRUPT_PARAMETERS structure that specifies a GPIO pin and describes the interrupt attributes of this pin.

Return value

The CLIENT_UnmaskInterrupt function returns STATUS_SUCCESS if the call is successful. Otherwise, it returns an appropriate error code.

Remarks

This callback function is implemented by the GPIO controller driver. The GPIO framework extension (GpioClx) calls this function to unmask interrupts on a GPIO pin that is configured as an interrupt request input. For more information, see GPIO Interrupt Masks.

To register your driver's CLIENT_UnmaskInterrupt callback function, call the GPIO_CLX_RegisterClient method. This method accepts, as an input parameter, a pointer to a GPIO_CLIENT_REGISTRATION_PACKET structure that contains a CLIENT_UnmaskInterrupt function pointer.

The CLIENT_UnmaskInterrupt function is called from the interrupt service routine (ISR) in GpioClx. This ISR runs either at PASSIVE_LEVEL or DIRQL, depending on the device information that the CLIENT_QueryControllerBasicInformation callback function supplies to GpioClx. The CLIENT_QueryControllerBasicInformation function provides device information in the form of a CLIENT_CONTROLLER_BASIC_INFORMATION structure. If the MemoryMappedController flag bit is set in the Flags member of this structure, the GpioClx ISR runs at DIRQL and calls the CLIENT_UnmaskInterrupt function at DIRQL. Otherwise, the ISR runs at PASSIVE_LEVEL and calls the function at PASSIVE_LEVEL. For more information about this flag bit, see Optional and Required GPIO Callback Functions.

Examples

To define a CLIENT_UnmaskInterrupt callback function, you must first provide a function declaration that identifies the type of callback function you're defining. Windows provides a set of callback function types for drivers. Declaring a function using the callback function types helps Code Analysis for Drivers, Static Driver Verifier (SDV), and other verification tools find errors, and it's a requirement for writing drivers for the Windows operating system.

For example, to define a CLIENT_UnmaskInterrupt callback function that is named MyEvtGpioUnmaskInterrupt, use the GPIO_CLIENT_UNMASK_INTERRUPT function type, as shown in this code example:

GPIO_CLIENT_UNMASK_INTERRUPT MyEvtGpioUnmaskInterrupt;

Then, implement your callback function as follows:

_Use_decl_annotations_
NTSTATUS
  MyEvtGpioUnmaskInterrupt(
    PVOID Context,
    PGPIO_ENABLE_INTERRUPT_PARAMETERS InterruptParameters
    )
{ ... }

The GPIO_CLIENT_UNMASK_INTERRUPT function type is defined in the Gpioclx.h header file. To more accurately identify errors when you run the code analysis tools, be sure to add the Use_decl_annotations annotation to your function definition. The Use_decl_annotations annotation ensures that the annotations that are applied to the GPIO_CLIENT_UNMASK_INTERRUPT function type in the header file are used. For more information about the requirements for function declarations, see Declaring Functions by Using Function Role Types for KMDF Drivers. For more information about Use_decl_annotations, see Annotating Function Behavior.

Requirements

See also

GPIO_CLIENT_REGISTRATION_PACKET

GPIO_CLX_RegisterClient

GPIO_ENABLE_INTERRUPT_PARAMETERS