GPIO_CLIENT_STOP_CONTROLLER回调函数 (gpioclx.h)

  • 项目

CLIENT_StopController 事件回调函数执行准备常规用途 I/O (GPIO) 控制器设备退出 D0 电源状态所需的操作。

语法

GPIO_CLIENT_STOP_CONTROLLER GpioClientStopController;

NTSTATUS GpioClientStopController(
  [in] PVOID Context,
  [in] BOOLEAN SaveContext,
  [in] WDF_POWER_DEVICE_STATE TargetState
)
{...}

参数

[in] Context

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

[in] SaveContext

客户端驱动程序是否应保存 GPIO 控制器设备的当前硬件上下文。 如果为 TRUE，则应保存硬件上下文。 如果为 FALSE，则不应保存硬件上下文。 有关详细信息，请参阅“备注”。

[in] TargetState

目标设备电源状态。 此参数是一个 WDF_POWER_DEVICE_STATE 枚举值，该值指定设备在退出 D0 电源状态时要进入的低功耗状态。 GPIO 控制器驱动程序可以使用此信息来确定如何在控制器设备离开 D0 之前对其进行配置。

返回值

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

注解

此回调函数由 GPIO 控制器驱动程序实现。 GPIO 框架扩展 (GpioClx) 调用此函数来准备要关闭或转换为低功耗状态的 GPIO 控制器设备。 此回调函数必须在设备进入低功耗状态之前执行任何必要的操作，例如，在设备还原到 D0 电源状态后保存驱动程序稍后需要的任何信息。

通常， CLIENT_StopController 回调函数将 GPIO 引脚配置为特定于平台的初始状态。 例如，此函数可以将所有 GPIO 引脚配置为输入，以防止在 GPIO 控制器设备关闭时发生输出暂时性。

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

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

示例

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

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

GPIO_CLIENT_STOP_CONTROLLER  MyEvtGpioStopController;

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

_Use_decl_annotations_
VOID
  MyEvtGpioStopController(
    PVOID Context,
    BOOLEAN RestoreContext,
    WDF_POWER_DEVICE_STATE TargetState
    )
{ ... }

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

要求

要求 值
最低受支持的客户端 支持从Windows 8开始。
目标平台 桌面
标头 gpioclx.h
IRQL 在 PASSIVE_LEVEL 调用。

另请参阅

GPIO_CLIENT_REGISTRATION_PACKET

GPIO_CLX_RegisterClient