GPIO_CLIENT_DISABLE_INTERRUPT回调函数 (gpioclx.h)

项目
02/29/2024

CLIENT_DisableInterrupt事件回调函数在配置为中断输入的常规用途 I/O (GPIO) 引脚上禁用中断。

语法

GPIO_CLIENT_DISABLE_INTERRUPT GpioClientDisableInterrupt;

NTSTATUS GpioClientDisableInterrupt(
  [in] PVOID Context,
  [in] PGPIO_DISABLE_INTERRUPT_PARAMETERS DisableParameters
)
{...}

参数

[in] Context

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

[in] DisableParameters

指向描述 GPIO 中断引脚的GPIO_DISABLE_INTERRUPT_PARAMETERS 结构的指针。

返回值

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

注解

此回调函数由 GPIO 控制器驱动程序实现。 GpioClx 调用此函数来禁用配置为中断请求输入的 GPIO 引脚上的中断。

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

GpioClx 始终在 IRQL = PASSIVE_LEVEL 调用CLIENT_EnableInterrupt和CLIENT_DisableInterrupt回调函数。但是，如果 GPIO 寄存器是内存映射的，GpioClx 会从其位于 DIRQL 的 ISR 调用其他与中断相关的回调函数。在这种情况下， CLIENT_EnableInterrupt 和 CLIENT_DisableInterrupt 函数应使用 GPIO 中断锁将其与中断相关的操作同步到 ISR。有关详细信息，请参阅 GPIO 控制器驱动程序的中断同步。

示例

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

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

GPIO_CLIENT_DISABLE_INTERRUPT MyEvtGpioDisableInterrupt;

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

_Use_decl_annotations_
VOID
  MyEvtGpioDisableInterrupt(
    PVOID Context,
    PGPIO_DISABLE_INTERRUPT_PARAMETERS DisableParameters
    )
{ ... }

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