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

SPB コントローラー ドライバーの EvtSpbControllerLock イベント コールバック関数は、バス上の単一のターゲット デバイスにアクセスするために SPB コントローラーをロックします。

構文

EVT_SPB_CONTROLLER_LOCK EvtSpbControllerLock;

void EvtSpbControllerLock(
  [in] WDFDEVICE Controller,
  [in] SPBTARGET Target,
  [in] SPBREQUEST LockRequest
)
{...}

パラメーター

[in] Controller

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

[in] Target

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

[in] LockRequest

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

戻り値

なし

解説

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

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

ロックが有効になっている間、コントローラーは LockRequest パラメーターで指定されたターゲット以外のバス上のターゲットへのアクセスを許可してはなりません。

SPB コントローラー ドライバーが通常のターゲット選択メカニズムを一時的にオーバーライドするようにコントローラーのモードを変更する必要がある場合は、 EvtSpbControllerLock コールバック中に変更できます。 このモードの変更に長い遅延が伴う場合、またはドライバーがデバイスの割り込みを待機する必要がある場合、ドライバーはモードの変更を開始し、遅延なくコールバックから戻る必要があります。 その後、ドライバーはタイマー DPC または割り込み DPC でロック操作を完了できます。

ロック操作が DPC で完了した場合、SPB コントローラー ドライバーは、ロック操作に必要なすべてのリソースを以前に割り当てる必要があります。

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

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

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

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

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

例

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

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

EVT_SPB_CONTROLLER_LOCK  MyEvtSpbControllerLock;

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

_Use_decl_annotations_
VOID
  MyEvtSpbControllerLock(
    WDFDEVICE Controller,
    SPBTARGET Target,
    SPBREQUEST LockRequest
    )
{ ... }

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

要件

こちらもご覧ください

• EvtSpbControllerUnlock
• EvtSpbTargetConnect
• IOCTL_SPB_EXECUTE_SEQUENCE
• IOCTL_SPB_LOCK_CONTROLLER
• SPBREQUEST
• SPBTARGET
• SPB_CONTROLLER_CONFIG
• SpbDeviceInitialize