GPIO_CLIENT_CONNECT_IO_PINS回调函数 (gpioclx.h)

项目
02/26/2024

CLIENT_ConnectIoPins 事件回调函数打开与一组常规用途 I/O (GPIO) 引脚的逻辑连接，并为数据读取或写入操作配置这些引脚。

语法

GPIO_CLIENT_CONNECT_IO_PINS GpioClientConnectIoPins;

NTSTATUS GpioClientConnectIoPins(
  [in] PVOID Context,
  [in] PGPIO_CONNECT_IO_PINS_PARAMETERS ConnectParameters
)
{...}

参数

[in] Context

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

[in] ConnectParameters

指向 GPIO_CONNECT_IO_PINS_PARAMETERS 结构的指针，该结构描述与一组 GPIO 引脚的连接，并指定是将这些引脚配置为数据输入还是输出。

返回值

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

注解

此回调函数由 GPIO 控制器驱动程序实现。 GPIO 框架扩展 (GpioClx) 调用此函数以打开与一组 GPIO 引脚的连接。这些引脚在 ConnectParameters 指向的 GPIO_CONNECT_IO_PINS_PARAMETERS 结构的 PinNumberTable 数组中指定。此结构的 ConnectMode 成员指示是将引脚配置为输入还是输出。

为了关闭连接，GpioClx 调用 CLIENT_DisconnectIoPins 回调函数。

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

示例

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

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

GPIO_CLIENT_CONNECT_IO_PINS MyEvtGpioConnectIoPins;

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

_Use_decl_annotations_
NTSTATUS
  MyEvtGpioConnectIoPins(
    PVOID Context,
    PGPIO_CONNECT_IO_PINS_PARAMETERS ConnectParameters
    )
{ ... }

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