GPIO_CLIENT_QUERY_CONTROLLER_BASIC_INFORMATION回调函数 (gpioclx.h)

项目
02/26/2024

CLIENT_QueryControllerBasicInformation 事件回调函数检索常规用途 I/O (GPIO) 控制器的硬件属性。

语法

GPIO_CLIENT_QUERY_CONTROLLER_BASIC_INFORMATION GpioClientQueryControllerBasicInformation;

NTSTATUS GpioClientQueryControllerBasicInformation(
  [in]  PVOID Context,
  [out] PCLIENT_CONTROLLER_BASIC_INFORMATION Information
)
{...}

参数

[in] Context

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

[out] Information

指向调用方分配的CLIENT_CONTROLLER_BASIC_INFORMATION 结构的指针。 CLIENT_QueryControllerBasicInformation 函数将 GPIO 控制器硬件属性和配置信息写入此结构。

返回值

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

注解

此回调函数由 GPIO 控制器驱动程序实现。 gpioClx (GPIO 框架扩展) 调用此函数。

CLIENT_QueryControllerBasicInformation回调函数应设置CLIENT_CONTROLLER_BASIC_INFORMATION结构的所有成员，包括 Version 和 Size 成员。 GpioClx 在调用此函数之前不会初始化 Size 成员，但信息参数指向的缓冲区保证足够大，足以包含 GPIO 控制器驱动程序使用的此结构的版本。

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

示例

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

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

GPIO_CLIENT_QUERY_CONTROLLER_BASIC_INFORMATION MyEvtGpioQueryDeviceInformation;

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

_Use_decl_annotations_
NTSTATUS
  MyEvtGpioQueryDeviceInformation(
    PVOID Context,
    PCLIENT_CONTROLLER_BASIC_INFORMATION Information
    )
{ ... }

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