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

CLIENT_StopController イベント コールバック関数は、D0 電源状態を終了するために汎用 I/O (GPIO) コントローラー デバイスを準備するために必要な操作を実行します。

構文

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

ターゲット デバイスの電源状態。 このパラメーターは 、 D0 電源状態を終了したときにデバイスが入力する低電力状態を指定するWDF_POWER_DEVICE_STATE列挙値です。 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構造体へのポインターを受け取ります。

CLIENT_StopControllerコールバック関数は IRQL = PASSIVE_LEVEL で呼び出されますが、この関数をページング可能にしないでください。 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の詳細については、「関数の動作に注釈を付ける」を参照してください。

要件

こちらもご覧ください

GPIO_CLIENT_REGISTRATION_PACKET

GPIO_CLX_RegisterClient