GPIO_CLIENT_QUERY_ENABLED_INTERRUPTS回调函数 (gpioclx.h)

CLIENT_QueryEnabledInterrupts 事件回调函数查询一组常规用途 I/O (GPIO) 引脚的状态,以确定哪些引脚都配置为中断输入,并为中断启用。

语法

GPIO_CLIENT_QUERY_ENABLED_INTERRUPTS GpioClientQueryEnabledInterrupts;

NTSTATUS GpioClientQueryEnabledInterrupts(
  [in] PVOID Context,
  [in] PGPIO_QUERY_ENABLED_INTERRUPTS_PARAMETERS QueryEnabledParameters
)
{...}

参数

[in] Context

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

[in] QueryEnabledParameters

指向调用方分配 GPIO_QUERY_ENABLED_INTERRUPTS_PARAMETERS 结构的指针。 在调用此函数之前,调用方会将银行 ID 写入到此结构的 BankId 成员,以指定要查询的 GPIO 引脚。 如果成功,该函数会将掩码值写入到此结构的 EnabledMask 成员,以指示指定银行中启用了哪些中断。

返回值

如果调用成功,CLIENT_QueryEnabledInterrupts 函数将返回STATUS_SUCCESS。 否则,它将返回适当的错误代码。

言论

从 Windows 8.1 开始,GPIO 控制器驱动程序可以根据需要实现 CLIENT_QueryEnabledInterrupts 回调函数。 如果实现,GPIO 框架扩展(GpioClx)将调用此函数,以确定在 GPIO 引脚的银行中启用哪些中断。

QueryEnabledParameters 参数指向调用方分配 GPIO_QUERY_ENABLED_INTERRUPTS_PARAMETERS 结构。 调用方设置此结构的 BankId 成员的值。 CLIENT_QueryEnabledInterrupts 函数写入结构的 EnabledMask 成员。

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

CLIENT_QueryEnabledInterrupts 函数是可选的。 如果驱动程序未实现此函数,请将 GPIO_CLIENT_REGISTRATION_PACKET 结构的 CLIENT_QueryEnabledInterrupts 成员设置为 NULL

如果实现了 CLIENT_QueryEnabledInterrupts 函数,GpioClx 将使用此函数来提高驱动程序可靠性和诊断。 GpioClx 调用此函数,以验证 GPIO 控制器中启用的中断集是否与 GpioClx 的预期匹配。 通常,不匹配表示可能导致中断风暴的驱动程序 bug。 GpioClx 使用此函数在检查的(调试)版本中执行更广泛的状态验证,并减少免费(零售)版本中对此函数的调用数,以避免影响性能。 如果实现,此函数必须直接读取硬件状态,而不是读取缓存或软件维护的状态版本。

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

例子

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

例如,若要定义名为 MyEvtGpioQueryEnabledInterruptsCLIENT_QueryEnabledInterrupts 回调函数,请使用GPIO_CLIENT_QUERY_ENABLED_INTERRUPTS函数类型,如以下代码示例所示:

GPIO_CLIENT_QUERY_ENABLED_INTERRUPTS MyEvtGpioQueryEnabledInterrupts;

然后,按如下所示实现回调函数:

_Use_decl_annotations_
NTSTATUS
  MyEvtGpioQueryEnabledInterrupts(
    PVOID Context,
    PGPIO_QUERY_ENABLED_INTERRUPTS_PARAMETERS QueryEnabledParameters
    )
{ ... }

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

要求

要求 价值
最低支持的客户端 从 Windows 8.1 开始支持。
目标平台 桌面
标头 gpioclx.h
IRQL 请参阅“备注”。

另请参阅

CLIENT_CONTROLLER_BASIC_INFORMATION

CLIENT_QueryControllerBasicInformation

GPIO_CLIENT_REGISTRATION_PACKET

GPIO_CLX_RegisterClient

GPIO_QUERY_ENABLED_INTERRUPTS_PARAMETERS