GPIO_CLIENT_RESTORE_BANK_HARDWARE_CONTEXT回调函数（gpioclx.h）

项目
02/07/2025

CLIENT_RestoreBankHardwareContext 事件回调函数还原通用 I/O（GPIO）引脚的一组硬件上下文。

语法

GPIO_CLIENT_RESTORE_BANK_HARDWARE_CONTEXT GpioClientRestoreBankHardwareContext;

void GpioClientRestoreBankHardwareContext(
  [in] PVOID Context,
  [in] PGPIO_SAVE_RESTORE_BANK_HARDWARE_CONTEXT_PARAMETERS Parameters
)
{...}

参数

[in] Context

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

[in] Parameters

指向描述要还原的 GPIO 引脚库的 GPIO_SAVE_RESTORE_BANK_HARDWARE_CONTEXT_PARAMETERS 结构的指针。

返回值

没有

言论

如果调用成功，CLIENT_RestoreBankHardwareContext 函数将返回STATUS_SUCCESS。否则，它将返回适当的错误状态代码。

如果 GPIO 引脚的银行支持组件级电源管理，则如果银行处于空闲状态，GpioClx 可以将银行切换到低功率 Fx 状态。如果 GPIO 控制器银行在 Fx 状态下丢失其硬件上下文，GPIO 控制器驱动程序必须在 F0-to-Fx 转换之前保存此上下文，稍后在 Fx 到 F0 转换之后还原上下文。目前，F1 是唯一为使用 GpioClx 的 GPIO 控制器定义的低功率状态。

GpioClx 调用 CLIENT_RestoreBankHardwareContext 函数来还原银行以前保存的硬件上下文。硬件上下文以前由 CLIENT_SaveBankHardwareContext 事件回调函数保存。

某些 GPIO 控制器设备使所选的引脚库能够独立于同一设备中的其他银行打开和关闭。因此，可以通过关闭空闲的银行来节省电源。

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

GpioClx 在 PASSIVE_LEVEL 或 DIRQL 上调用 CLIENT_RestoreBankHardwareContext 回调函数，具体取决于 CLIENT_QueryControllerBasicInformation 回调函数提供给 GpioClx 的设备信息。 CLIENT_QueryControllerBasicInformation 函数以 CLIENT_CONTROLLER_BASIC_INFORMATION 结构的形式提供设备信息。如果在标志成员中设置了 MemoryMappedController 标志位，GpioClx 将在 DIRQL 调用 CLIENT_RestoreBankHardwareContext 函数，这是 GPioClx 中 ISR 运行的 IRQL。否则，会在PASSIVE_LEVEL调用此函数。有关此标志位的详细信息，请参阅可选和必需的 GPIO 回调函数。

例子

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

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

GPIO_CLIENT_RESTORE_BANK_HARDWARE_CONTEXT MyEvtGpioRestoreBankHardwareContext;</pre>

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

_Use_decl_annotations_
NTSTATUS
  MyEvtGpioRestoreBankHardwareContext(
    PVOID Context,
    PGPIO_SAVE_RESTORE_BANK_HARDWARE_CONTEXT_PARAMETERS Parameters
    )
{ ... }

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