GPIO_CLIENT_QUERY_ENABLED_INTERRUPTS回调函数 (gpioclx.h)

项目
08/07/2023

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 标志位在此结构的 Flags 成员中设置，GpioClx 将在 DIRQL（GPioClx 中的 ISR 运行所在的 IRQL）调用 CLIENT_QueryEnabledInterrupts 函数。否则，会在PASSIVE_LEVEL调用此函数。有关此标志位的详细信息，请参阅可选和必需的 GPIO 回调函数。

示例

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

例如，若要定义名为 MyEvtGpioQueryEnabledInterrupts的CLIENT_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的详细信息，请参阅批注函数行为。