GPIO_CLIENT_MASK_INTERRUPTS回调函数 (gpioclx.h)

项目
02/26/2024

CLIENT_MaskInterrupts事件回调函数可屏蔽配置为中断输入的一组常规用途 I/O (GPIO) 引脚上的中断。

语法

GPIO_CLIENT_MASK_INTERRUPTS GpioClientMaskInterrupts;

NTSTATUS GpioClientMaskInterrupts(
  [in]      PVOID Context,
  [in, out] PGPIO_MASK_INTERRUPT_PARAMETERS MaskParameters
)
{...}

参数

[in] Context

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

[in, out] MaskParameters

指向 GPIO_MASK_INTERRUPT_PARAMETERS 结构的指针，该结构在输入时描述要掩码的 GPIO 中断引脚，并在退出时包含掩码操作的状态。

返回值

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

注解

此回调函数由 GPIO 控制器驱动程序实现。 GPIO 框架扩展 (GpioClx) 调用此函数来屏蔽配置为中断请求输入的 GPIO 引脚上的中断。有关详细信息，请参阅 GPIO 中断掩码。

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

CLIENT_MaskInterrupts函数是从 gpioClx 中 ISR) (中断服务例程调用的。此 ISR 在 PASSIVE_LEVEL 或 DIRQL 上运行，具体取决于 CLIENT_QueryControllerBasicInformation 回调函数提供给 GpioClx 的设备信息。 CLIENT_QueryControllerBasicInformation 函数以CLIENT_CONTROLLER_BASIC_INFORMATION结构的形式提供设备信息。如果在此结构的 Flags 成员中设置了 MemoryMappedController 标志位，则 GpioClx ISR 在 DIRQL 中运行，并在 DIRQL 中调用 CLIENT_MaskInterrupts 函数。否则，ISR 在 PASSIVE_LEVEL 运行，并在 PASSIVE_LEVEL 调用函数。有关此标志位的详细信息，请参阅可选和必需的 GPIO 回调函数。

未能将中断掩码设置为请求值的CLIENT_MaskInterrupts调用必须将 GPIO_MASK_INTERRUPT_PARAMETERS 结构的 FailedMask 成员设置为非零值，并返回相应的错误状态代码。内存映射 GPIO 控制器的 CLIENT_MaskInterrupts 函数应始终成功将中断掩码设置为请求的值。但是，非内存映射的控制器 的 CLIENT_MaskInterrupts 函数必须向控制器发送 I/O 请求以设置掩码，并且此请求可能会失败。如果请求未能设置掩码，函数必须在它写入 到 FailedMask 成员的值中指示此失败。

示例

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

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

GPIO_CLIENT_MASK_INTERRUPTS MyEvtGpioMaskInterrupts;

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

_Use_decl_annotations_
NTSTATUS
  MyEvtGpioMaskInterrupts(
    PVOID Context,
    PGPIO_MASK_INTERRUPT_PARAMETERS MaskParameters
    )
{ ... }

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