GPIO_CLIENT_RESTORE_BANK_HARDWARE_CONTEXT回呼函式 (gpioclx.h)

發行項
02/26/2024

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 到 Fx 轉換之前儲存此內容，之後再還原 Fx 到 F0 轉換之後的內容。目前，F1 是唯一針對使用 GpioClx 之 GPIO 控制器所定義的低電源狀態。

GpioClx 會呼叫 CLIENT_RestoreBankHardwareContext 函式，以還原銀行先前儲存的硬體內容。硬體內容先前是由 CLIENT_SaveBankHardwareContext 事件回呼函式所儲存。

某些 GPIO 控制器裝置可讓選取的針腳銀行與相同裝置中的其他銀行分開開啟和關閉。因此，關閉閑置的銀行，即可儲存電源。

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

GpioClx 會根據CLIENT_QueryControllerBasicInformation 回呼函 式提供給 GpioClx 的裝置資訊，在 PASSIVE_LEVEL 或 DIRQL 呼叫 CLIENT_RestoreBankHardwareContext 回呼函式。 CLIENT_QueryControllerBasicInformation函式會以CLIENT_CONTROLLER_BASIC_INFORMATION結構的形式提供裝置資訊。如果 MemoryMappedController 旗標位是在這個結構的 Flags 成員中設定，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的詳細資訊，請參閱標註函式行為。