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
この I/O 要求のターゲットに対する SPBTARGET ハンドル。 ターゲットは、バスに接続されている周辺機器またはポートです。 SPB フレームワーク拡張機能 (SpbCx) は、ターゲットへの接続を開いた EvtSpbTargetConnect コールバックで、このハンドルをターゲットに割り当てていました。
[in] UnlockRequest
コントローラーのロックを解除するための I/O 制御要求に対する SPBREQUEST ハンドル。 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の詳細については、「関数の動作に注釈を付ける」を参照してください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows 8 以降でサポートされています。 |
| 対象プラットフォーム | デスクトップ |
| Header | spbcx.h |
| IRQL | IRQL <= DISPATCH_LEVELで呼び出されます。 |