共用方式為

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 方法。 這個方法接受做為輸入參數的GPIO_CLIENT_REGISTRATION_PACKET結構指標，其中包含CLIENT_StopController函式指標。

雖然在 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