GPIO_CLIENT_SAVE_BANK_HARDWARE_CONTEXT コールバック関数 (gpioclx.h)

[アーティクル]
02/07/2025

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 コントローラードライバーは、F0to-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 は、CLIENT_QueryControllerBasicInformation コールバック関数が GpioClx に提供するデバイス情報に応じて、PASSIVE_LEVEL または DIRQL で CLIENT_SaveBankHardwareContext コールバック関数を呼び出します。 CLIENT_QueryControllerBasicInformation 関数は、CLIENT_CONTROLLER_BASIC_INFORMATION 構造体の形式でデバイス情報を提供します。 MemoryMappedController フラグビットがこの構造体の Flags メンバーに設定されている場合、GpioClx は DIRQL で CLIENT_SaveBankHardwareContext 関数を呼び出します。これは、GpioClx の ISR が実行される IRQL です。このフラグビットの詳細については、「省略可能および必須の 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の詳細については、「関数の動作に注釈を付ける」を参照してください。

必要条件

要件	価値
サポートされる最小クライアント	Windows 8 以降でサポートされています。
ターゲットプラットフォームの	デスクトップ
ヘッダー	gpioclx.h
IRQL	「解説」を参照してください。

次の方法で共有

GPIO_CLIENT_SAVE_BANK_HARDWARE_CONTEXT コールバック関数 (gpioclx.h)

構文

パラメーター

戻り値

備考

例

必要条件

関連項目

フィードバック

その他のリソース