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

CLIENT_ReleaseController イベント コールバック関数は、汎用 I/O (GPIO) コントローラー デバイスにアクセスできなくなった場合に必要な操作を実行します。

構文

GPIO_CLIENT_RELEASE_CONTROLLER GpioClientReleaseController;

NTSTATUS GpioClientReleaseController(
  [in] WDFDEVICE Device,
  [in] PVOID Context
)
{...}

パラメーター

[in] Device

GPIO コントローラーを表すフレームワーク デバイス オブジェクトへの WDFDEVICE ハンドル。

[in] Context

GPIO コントローラー ドライバーの デバイス コンテキストへのポインター。

戻り値

呼び出 しが 成功した場合、CLIENT_ReleaseController関数はSTATUS_SUCCESSを返します。 それ以外の場合は、適切なエラー コードを返します。

注釈

このコールバック関数は、GPIO コントローラー ドライバーによって実装されます。 GPIO フレームワーク拡張機能 (GpioClx) は、GPIO コントローラー デバイスにアクセスできなくなった後にこの関数を呼び出します。

CLIENT_ReleaseControllerコールバック中に、GPIO コントローラー ドライバーは、前にCLIENT_PrepareControllerコールバック関数を呼び出した結果として取得したすべてのハードウェア リソースを解放する必要があります。 メモリ マップされた GPIO コントローラー デバイスの場合、ドライバーは、ハードウェア レジスタに割り当てられているメモリ アドレス範囲または範囲のマップを解除する必要があります。 メモリ マップされていないコントローラーの場合、ドライバーは、以前に開いたコントローラーへの論理接続を閉じる必要があります。

ドライバーの CLIENT_ReleaseController コールバック関数を登録するには、 GPIO_CLX_RegisterClient メソッドを呼び出します。 このメソッドは、入力パラメーターとして、CLIENT_ReleaseController関数ポインターを含むGPIO_CLIENT_REGISTRATION_PACKET構造体へのポインターを受け取ります。

CLIENT_ReleaseControllerコールバック関数は IRQL = PASSIVE_LEVEL で呼び出されますが、この関数をページング可能にしないでください。 CLIENT_ReleaseController コールバックは、ハードウェア プラットフォーム内のデバイスに電源を復元するための重要なタイミング パスにあり、パフォーマンス上の理由から、ページ フォールトによって遅延しないようにする必要があります。

例

CLIENT_ReleaseControllerコールバック関数を定義するには、まず、定義するコールバック関数の種類を識別する関数宣言を指定する必要があります。 Windows には、ドライバーのコールバック関数型のセットが用意されています。 コールバック関数の種類を使用して関数を宣言すると、 ドライバーのコード分析、 静的ドライバー検証ツール (SDV)、およびその他の検証ツールでエラーが検出され、Windows オペレーティング システムのドライバーを記述するための要件になります。

たとえば、 という名前MyEvtGpioReleaseControllerのCLIENT_ReleaseControllerコールバック関数を定義するには、次のコード例に示すように、GPIO_CLIENT_RELEASE_CONTROLLER関数型を使用します。

GPIO_CLIENT_RELEASE_CONTROLLER  MyEvtGpioReleaseController;

次に、コールバック関数を次のように実装します。

_Use_decl_annotations_
NTSTATUS
  MyEvtGpioReleaseController(
    WDFDEVICE Device,
    PVOID Context
)
{ ... }

GPIO_CLIENT_RELEASE_CONTROLLER関数の種類は、Gpioclx.h ヘッダー ファイルで定義されています。 コード分析ツールの実行時にエラーをより正確に識別するには、 Use_decl_annotations 注釈を関数定義に追加してください。 Use_decl_annotations注釈を使用すると、ヘッダー ファイル内のGPIO_CLIENT_RELEASE_CONTROLLER関数型に適用される注釈が確実に使用されます。 関数宣言の要件の詳細については、「 KMDF ドライバーの関数ロール型を使用した関数の宣言」を参照してください。 Use_decl_annotationsの詳細については、「関数の動作に注釈を付ける」を参照してください。

要件

要件	値
サポートされている最小のクライアント	Windows 8 以降でサポートされています。
対象プラットフォーム	デスクトップ
Header	gpioclx.h
IRQL	PASSIVE_LEVELで呼び出されます。

こちらもご覧ください

GPIO_CLIENT_REGISTRATION_PACKET

GPIO_CLX_RegisterClient