通过

GPIO_CLIENT_MASK_INTERRUPTS回调函数 （gpioclx.h）

  • 项目

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 结构的形式提供设备信息。 如果 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的详细信息，请参阅 批注函数行为。

要求

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

另请参阅

CLIENT_CONTROLLER_BASIC_INFORMATION

CLIENT_QueryControllerBasicInformation

GPIO_CLIENT_REGISTRATION_PACKET

GPIO_CLX_RegisterClient

GPIO_MASK_INTERRUPT_PARAMETERS