GPIO_CLIENT_SAVE_BANK_HARDWARE_CONTEXT回调函数 (gpioclx.h)

项目
02/29/2024

CLIENT_SaveBankHardwareContext 事件回调函数保存常规用途 I/O (GPIO) 引脚的硬件上下文。

语法

GPIO_CLIENT_SAVE_BANK_HARDWARE_CONTEXT GpioClientSaveBankHardwareContext;

void GpioClientSaveBankHardwareContext(
  [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_SaveBankHardwareContext 函数将返回STATUS_SUCCESS。否则，它将返回相应的错误状态代码。

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

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

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

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

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

示例

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

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

GPIO_CLIENT_SAVE_BANK_HARDWARE_CONTEXT MyEvtGpioSaveBankHardwareContext;

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

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

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