GPIO_CLIENT_PREPARE_CONTROLLER回调函数 (gpioclx.h)

项目
02/29/2024

CLIENT_PrepareController 事件回调函数执行使常规用途 I/O (GPIO) 控制器准备好供 GPIO 控制器驱动程序访问所需的任何操作。

语法

GPIO_CLIENT_PREPARE_CONTROLLER GpioClientPrepareController;

NTSTATUS GpioClientPrepareController(
  [in] WDFDEVICE Device,
  [in] PVOID Context,
  [in] WDFCMRESLIST ResourcesRaw,
  [in] WDFCMRESLIST ResourcesTranslated
)
{...}

参数

[in] Device

表示 GPIO 控制器的框架设备对象的 WDFDEVICE 句柄。

[in] Context

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

[in] ResourcesRaw

框架资源对象集合的 WDFCMRESLIST 句柄。此集合标识即插即用 (PnP) 管理器分配给 GPIO 控制器设备的原始 (总线相对) 硬件资源。

[in] ResourcesTranslated

框架资源对象集合的 WDFCMRESLIST 句柄。此集合标识 PnP 管理器分配给 GPIO 控制器设备的已转换 (系统物理) 硬件资源。

返回值

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

注解

此回调函数由 GPIO 控制器驱动程序实现。 GPIO 框架扩展 (GpioClx) 调用此函数来初始化 GPIO 控制器驱动程序所需的硬件资源，以便它可以访问 GPIO 控制器设备。

ResourcesRaw 和 ResourcesTranslated 参数是原始资源和已翻译资源列表的句柄。这些列表描述了 PnP 管理器分配给由 Device 参数指定的 GPIO 控制器设备的硬件资源。有关详细信息，请参阅原始资源和已翻译的资源。

在 CLIENT_PrepareController 回调期间，GPIO 控制器驱动程序可以从 ResourcesRaw 或 ResourcesTranslated 列表中获取所需的硬件资源。如果 GPIO 控制器设备是内存映射的，驱动程序应将分配给设备硬件寄存器的总线相对内存地址范围或范围映射到系统虚拟地址。有关详细信息，请参阅将 Bus-Relative 地址映射到虚拟地址。

如果 GPIO 控制器未进行内存映射，则驱动程序的硬件资源包含连接 ID 而不是内存范围。驱动程序使用此 ID 打开与 GPIO 控制器的逻辑连接，并通过此连接发送 I/O 请求以访问控制器的寄存器。

GpioClx 连接到 (，然后从 PnP 管理器分配给 GPIO 控制器的任何中断资源) 断开连接。如果 GpioClx 收到此类中断资源，则它不会从传递给 CLIENT_PrepareController 回调函数的资源列表中删除此中断资源。但是，GPIO 控制器驱动程序不应尝试连接到 (或更高版本，) 在这些列表中找到的任何中断资源断开连接。

CLIENT_ReleaseController事件回调函数执行 GPIO 控制器设备不可再访问时所需的操作。在此回调期间，GPIO 控制器驱动程序应释放在上一 个CLIENT_PrepareController 回调期间获取的任何硬件资源。

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

尽管在 IRQL = PASSIVE_LEVEL 调用 CLIENT_PrepareController 回调函数，但不应使此函数可分页。 CLIENT_PrepareController回调位于关键计时路径中，用于将电源还原到硬件平台中的设备，出于性能原因，不应因页面故障而延迟。

示例

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

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

GPIO_CLIENT_PREPARE_CONTROLLER MyEvtGpioPrepareController;

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

_Use_decl_annotations_
NTSTATUS
  MyEvtGpioPrepareController(
    WDFDEVICE Device,
    PVOID Context,
    WDFCMRESLIST ResourcesRaw,
    WDFCMRESLIST ResourcesTranslated
)
{ ... }

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