GPIO_CLIENT_CLEAR_ACTIVE_INTERRUPTS回调函数 (gpioclx.h)

项目
08/07/2023

CLIENT_ClearActiveInterrupts事件回调函数清除配置为中断输入的一组常规用途 I/O (GPIO) 引脚上的活动中断。

语法

GPIO_CLIENT_CLEAR_ACTIVE_INTERRUPTS GpioClientClearActiveInterrupts;

NTSTATUS GpioClientClearActiveInterrupts(
  [in]      PVOID Context,
  [in, out] PGPIO_CLEAR_ACTIVE_INTERRUPTS_PARAMETERS ClearParameters
)
{...}

参数

[in] Context

指向 GPIO 控制器驱动程序的设备上下文的指针。

[in, out] ClearParameters

指向 GPIO_CLEAR_ACTIVE_INTERRUPTS_PARAMETERS 结构的指针，该结构在入口处描述要清除的 GPIO 中断引脚，并在退出时包含清除操作的状态。

返回值

如果调用成功， CLIENT_ClearActiveInterrupts 函数将返回STATUS_SUCCESS。否则，它将返回相应的错误代码。

注解

此回调函数由常规用途 I/O (GPIO) 控制器驱动程序实现。 GPIO 框架扩展 (GpioClx) 调用此函数以清除配置为中断请求输入的 GPIO 引脚上的活动中断。

此回调函数是可选的。如果 GPIO 控制器硬件在读取时自动清除活动中断状态位，则驱动程序不应注册 CLIENT_ClearActiveInterrupts 回调函数。有关详细信息，请参阅可选和必需的 GPIO 回调函数。

若要注册驱动程序 的 CLIENT_ClearActiveInterrupts 回调函数，请调用 GPIO_CLX_RegisterClient 方法。此方法接受指向包含CLIENT_ClearActiveInterrupts函数指针的GPIO_CLIENT_REGISTRATION_PACKET结构的指针作为输入参数。

GpioClx 在 PASSIVE_LEVEL 或 DIRQL 处调用CLIENT_ClearActiveInterrupts回调函数，具体取决于 CLIENT_QueryControllerBasicInformation 回调函数提供给 GpioClx 的设备信息。 CLIENT_QueryControllerBasicInformation函数以CLIENT_CONTROLLER_BASIC_INFORMATION结构的形式提供设备信息。如果在此结构的 Flags 成员中设置了 MemoryMappedController 标志位，GpioClx 将在 DIRQL（GPioClx 中的 ISR 运行所在的 IRQL）调用 CLIENT_ClearActiveInterrupts 函数。否则，在 PASSIVE_LEVEL 调用此函数。有关此标志位的详细信息，请参阅与中断相关的回调。

示例

若要定义 CLIENT_ClearActiveInterrupts 回调函数，必须首先提供一个函数声明，用于标识要定义的回调函数的类型。 Windows 为驱动程序提供一组回调函数类型。使用回调函数类型声明函数有助于驱动程序代码分析、静态驱动程序验证程序 (SDV) 和其他验证工具查找错误，并且这是编写适用于 Windows 操作系统的驱动程序的要求。

例如，若要定义名为 MyEvtGpioClearActiveInterrupts的CLIENT_ClearActiveInterrupts回调函数，请使用 GPIO_CLIENT_CLEAR_ACTIVE_INTERRUPTS 函数类型，如以下代码示例所示：

GPIO_CLIENT_CLEAR_ACTIVE_INTERRUPTS MyEvtGpioClearActiveInterrupts;

然后，按如下所示实现回调函数：

_Use_decl_annotations_
NTSTATUS
  MyEvtGpioClearActiveInterrupts(
    PVOID Context,
    PGPIO_CLEAR_ACTIVE_INTERRUPTS_PARAMETERS ClearParameters
    )
{ ... }

GPIO_CLIENT_CLEAR_ACTIVE_INTERRUPTS函数类型在 Gpioclx.h 头文件中定义。若要在运行代码分析工具时更准确地识别错误，请务必将 Use_decl_annotations 注释添加到函数定义。 Use_decl_annotations批注可确保使用应用于头文件中GPIO_CLIENT_CLEAR_ACTIVE_INTERRUPTS函数类型的注释。有关函数声明要求的详细信息，请参阅使用 KMDF 驱动程序的函数角色类型声明函数。有关 Use_decl_annotations的详细信息，请参阅批注函数行为。