EVT_SPB_CONTROLLER_UNLOCK コールバック関数 (spbcx.h)

SPB コントローラー ドライバーの EvtSpbControllerUnlock イベント コールバック関数は、イベント コールバック関数 EvtSpbControllerLock への以前の呼び出しによってロックされていた SPB コントローラーのロックを解除します。

構文

EVT_SPB_CONTROLLER_UNLOCK EvtSpbControllerUnlock;

VOID EvtSpbControllerUnlock(
  [in] WDFDEVICE Controller,
  [in] SPBTARGET Target,
  [in] SPBREQUEST UnlockRequest
)
{...}

パラメーター

[in] Controller

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

[in] Target

SPBTARGET この I/O 要求のターゲットへのハンドルです。 ターゲットは、バスに接続されている周辺機器またはポートです。 SPB フレームワーク拡張機能 (SpbCx) は、ターゲットへの接続を開いた EvtSpbTargetConnect コールバックでターゲットにこのハンドルを割り当てていました。

[in] UnlockRequest

SPBREQUEST、コントローラーのロックを解除するための I/O 制御要求を処理します。 SPB コントローラー ドライバーは、要求された操作を実行するか、エラー状態を返すことによって、この要求を完了する必要があります。 詳細については、「解説」を参照してください。

戻り値

何一つ

備考

SpbCx は、SPB コントローラーの I/O キューを管理します。 SpbCx は、コントローラーのクライアント (周辺機器ドライバー) がバス上のターゲットに IOCTL_SPB_UNLOCK_CONTROLLER 要求を送信するときに、この関数を呼び出します。 UnlockRequest パラメーター値は、この要求をカプセル化するハンドルです。

EvtSpbControllerLock 関数と EvtSpbControllerUnlock 関数は、補完的な操作を実行します。 どちらの関数も省略可能です。 SPB コントローラー ドライバーが EvtSpbControllerUnlock 関数を実装している場合、ドライバーは EvtSpbControllerLock 関数を実装する必要はありませんが、その可能性があります。 ただし、SPB コントローラー ドライバーが EvtSpbControllerLock 関数 実装する場合は、EvtSpbControllerUnlock 関数も実装する必要があります。 詳細については、「SPB_CONTROLLER_CONFIGの解説」を参照してください。

SPB コントローラー ドライバーは、通常のターゲットの選択を復元するコント ローラーのモードを変更する必要がある場合は、EvtSpbControllerUnlock コールバック中にこれを行うことができます。 このモードの変更に長い遅延が伴う場合、またはドライバーがデバイスの割り込みを待機する必要がある場合、ドライバーはモードの変更を開始し、遅延なくコールバックから戻る必要があります。 その後、ドライバーは割り込み DPC またはタイマー DPC でロック解除要求を完了できます。

EvtSpbControllerUnlock コールバックは、ロック解除要求の失敗を回避する必要があります。 ドライバー検証ツールの が有効になっている場合、このようなエラーによって検証ツール トラップがトリガーされ、コントローラーが失敗したことをプラグ アンド プレイ マネージャーに報告します。 SpbCx はロック解除要求の失敗を無視し、エラーの処理や軽減を試みません。

EvtSpbControllerUnlock 関数は値を返しません。 代わりに、SPB コントローラー ドライバーは、UnlockRequest パラメーターによって識別される I/O 要求の完了状態でのロック解除操作の状態を示します。 完了状態をSTATUS_SUCCESSに設定します。

EvtSpbControllerUnlock コールバック関数を登録するには、SpbDeviceInitialize メソッドを呼び出します。

EvtSpbControllerUnlock 関数の詳細については、「Client-Implemented シーケンスの処理」を参照してください。

例

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

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

EVT_SPB_CONTROLLER_UNLOCK  MyEvtSpbControllerUnlock;

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

_Use_decl_annotations_
VOID
  MyEvtSpbControllerUnlock(
    WDFDEVICE Controller,
    SPBTARGET Target,
    SPBREQUEST UnlockRequest
    )
{ ... }

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

必要条件

関連項目

• EvtSpbControllerLock の
• EvtSpbTargetConnect を する
• IOCTL_SPB_UNLOCK_CONTROLLER
• SPBTARGET の
• SPB_CONTROLLER_CONFIG
• spbDeviceInitialize の