GPIO_CLIENT_READ_PINS_MASK回调函数 (gpioclx.h)

项目
02/26/2024

CLIENT_ReadGpioPinsUsingMask 事件回调函数读取一组常规用途 I/O (GPIO) 引脚。

语法

GPIO_CLIENT_READ_PINS_MASK GpioClientReadPinsMask;

NTSTATUS GpioClientReadPinsMask(
  [in]      PVOID Context,
  [in, out] PGPIO_READ_PINS_MASK_PARAMETERS ReadParameters
)
{...}

参数

[in] Context

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

[in, out] ReadParameters

指向 GPIO_READ_PINS_MASK_PARAMETERS 结构的指针，该结构在入口处描述要读取的 GPIO 引脚，并在退出时包含从 GPIO 引脚读取的数据。

返回值

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

注解

此回调函数由 GPIO 控制器驱动程序实现。 GpioClx 调用此函数。

CLIENT_ReadGpioPinsUsingMask回调函数读取一组引脚中所有 GPIO 引脚的值。函数将这些值存储在 GPIO_READ_PINS_MASK_PARAMETERS 结构的 PinValues 成员中。位 0 (此成员的最小有效位) 包含引脚 0 的值，第 1 位包含引脚 1 的值，依此类说。

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

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

示例

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

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

GPIO_CLIENT_READ_PINS_MASK MyEvtGpioReadPinsUsingMask;

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

_Use_decl_annotations_
NTSTATUS
  MyEvtGpioReadPinsUsingMask(
    PVOID Context,
    PGPIO_READ_PINS_MASK_PARAMETERS ReadParameters
    )
{ ... }

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