GPIO_CLIENT_START_CONTROLLER回呼函式 (gpioclx.h)

當一般用途 I/O (GPIO) 控制器裝置進入 D0 電源狀態時， CLIENT_StartController 事件回呼函式會執行所需的作業。

語法

GPIO_CLIENT_START_CONTROLLER GpioClientStartController;

NTSTATUS GpioClientStartController(
  [in] PVOID Context,
  [in] BOOLEAN RestoreContext,
  [in] WDF_POWER_DEVICE_STATE PreviousPowerState
)
{...}

參數

[in] Context

GPIO 控制器驅動程式 裝置內容的指標。

[in] RestoreContext

用戶端驅動程式是否應該將 GPIO 控制器還原到先前儲存的硬體內容。 如果為 TRUE，則應還原硬體內容。 如果為 FALSE，則不應該還原硬體內容。 如需詳細資訊，請參閱＜備註＞。

[in] PreviousPowerState

先前的裝置電源狀態。 此參數是 WDF_POWER_DEVICE_STATE 列舉值，指定裝置進入 D0 電源狀態的低電源狀態。 GPIO 控制器驅動程式可以使用這項資訊來判斷如何設定控制器裝置，使其可供使用。

傳回值

如果呼叫成功， CLIENT_StartController 函式會傳回STATUS_SUCCESS。 否則，它會傳回適當的錯誤碼。

備註

此回呼函式是由 GPIO 控制器驅動程式實作。 GPIO 架構延伸模組 (GpioClx) 呼叫此函式，將 GPIO 控制器裝置置於系統啟動時的已知初始狀態，或當裝置從低電源狀態轉換為工作狀態時。 此回呼函式必須執行裝置從低電源狀態喚醒之後所需的任何作業，例如還原驅動程式在裝置進入 D0 電源狀態之後所需的任何資訊。

一般而言， CLIENT_StartController 回呼函式會將所有 GPIO 針腳設定為其默認狀態。

若要註冊驅動程式 的CLIENT_StartController回呼 函式，請呼叫 GPIO_CLX_RegisterClient 方法。 這個方法接受作為輸入參數的指標，指向包含CLIENT_StartController函式指標的GPIO_CLIENT_REGISTRATION_PACKET結構。

雖然在 IRQL = PASSIVE_LEVEL呼叫CLIENT_StartController 回呼函式，但您不應該將此函式 設為可分頁。 CLIENT_StartController回呼是在硬體平臺中將電源還原到裝置的重要計時路徑中，基於效能考慮，它不應該因為頁面錯誤而延遲。

範例

若要定義 CLIENT_StartController 回呼函式，您必須先提供函式宣告，以識別您要定義的回呼函式類型。 Windows 提供一組驅動程式的回呼函式類型。 使用回呼函式類型宣告函式有助於 驅動程式的程式代碼分析、 靜態驅動程式驗證器 (SDV) ，以及其他驗證工具會尋找錯誤，而且這是撰寫 Windows 操作系統驅動程式的需求。

例如，若要定義名為 MyEvtGpioStartController的CLIENT_StartController回呼函式，請使用 GPIO_CLIENT_START_CONTROLLER 函式類型，如下列程式代碼範例所示：

GPIO_CLIENT_START_CONTROLLER MyEvtGpioStartController;

然後，實作您的回呼函式，如下所示：

_Use_decl_annotations_
VOID
  MyEvtGpioStartController(
    PVOID Context,
    BOOLEAN RestoreContext,
    WDF_POWER_DEVICE_STATE PreviousPowerState
    )
{ ... }

GPIO_CLIENT_START_CONTROLLER函式類型定義於 Gpioclx.h 頭檔中。 若要在執行程式代碼分析工具時更精確地識別錯誤，請務必將 Use_decl_annotations 註釋新增至函式定義。 Use_decl_annotations註釋可確保使用頭檔中套用至GPIO_CLIENT_START_CONTROLLER函式類型的批註。 如需函數宣告需求的詳細資訊，請參閱 使用 KMDF 驅動程式的函式角色類型來宣告函式。 如需 Use_decl_annotations的詳細資訊，請參閱 標註函式行為。

規格需求

需求	值
最低支援的用戶端	從 Windows 8 開始支援。
目標平台	桌面
標頭	gpioclx.h
IRQL	在 PASSIVE_LEVEL (呼叫，請參閱) 。

另請參閱

GPIO_CLIENT_REGISTRATION_PACKET

GPIO_CLX_RegisterClient