GPIO_CLIENT_QUERY_ACTIVE_INTERRUPTS回调函数 (gpioclx.h)

项目
08/07/2023

CLIENT_QueryActiveInterrupts 事件回调函数查询配置为中断输入的一组常规用途 I/O (GPIO) 引脚的状态。

语法

GPIO_CLIENT_QUERY_ACTIVE_INTERRUPTS GpioClientQueryActiveInterrupts;

NTSTATUS GpioClientQueryActiveInterrupts(
  [in]      PVOID Context,
  [in, out] PGPIO_QUERY_ACTIVE_INTERRUPTS_PARAMETERS QueryActiveParameters
)
{...}

参数

[in] Context

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

[in, out] QueryActiveParameters

指向 GPIO_QUERY_ACTIVE_INTERRUPTS_PARAMETERS 结构的指针，该结构在输入时描述要查询的 GPIO 中断引脚，并在退出时包含这些引脚的活动和已启用中断状态。

返回值

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

注解

此回调函数由 GPIO 控制器驱动程序实现。 GPIO 框架扩展 (GpioClx) 调用此函数来查询配置为中断请求输入的一组 GPIO 引脚。

QueryActiveParameters 参数指向调用方分配的GPIO_QUERY_ACTIVE_INTERRUPTS_PARAMETERS结构。调用方设置此结构的 BankId 和 EnabledMask 成员的值。 CLIENT_QueryActiveInterrupts 函数写入结构的 ActiveMask 成员。

输入时， EnabledMask 成员中设置的位应与库中当前启用的中断集匹配。返回时， ActiveMask 成员中设置的位应对应于同时启用和活动状态的中断。因此，如果 EnabledMask 中的位为零， ActiveMask 中的相应位必须为零。

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

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

示例

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

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

GPIO_CLIENT_QUERY_ACTIVE_INTERRUPTS MyEvtGpioQueryActiveInterrupts;

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

_Use_decl_annotations_
NTSTATUS
  MyEvtGpioQueryActiveInterrupts(
    PVOID Context,
    PGPIO_QUERY_ACTIVE_INTERRUPTS_PARAMETERS QueryActiveParameters
    )
{ ... }

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