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

SPB コントローラー ドライバーの EvtSpbControllerIoSequence イベント コールバック関数は、指定されたターゲット デバイスとシーケンス要求で提供されるバッファー間のデータ転送のシーケンスを実行します。

構文

EVT_SPB_CONTROLLER_SEQUENCE EvtSpbControllerSequence;

VOID EvtSpbControllerSequence(
  [in] WDFDEVICE Controller,
  [in] SPBTARGET Target,
  [in] SPBREQUEST Request,
  [in] ULONG TransferCount
)
{...}

パラメーター

[in] Controller

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

[in] Target

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

[in] Request

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

[in] TransferCount

この I/O 転送シーケンス内の個々の転送の数。 個々の転送は、単純な読み取りまたは書き込み操作です。

戻り値

何一つ

備考

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

evtSpbControllerIoSequence コールバック は、状態値を返しません。 代わりに、SPB コントローラー ドライバーは、I/O 要求の完了状態でのシーケンス操作の状態を示します。

EvtSpbControllerIoSequence コールバックは非同期です。 つまり、コールバック関数は、要求されたシーケンス (またはシーケンスの最初の部分) 操作を開始してから、操作の完了を待たずに戻る必要があります。 その後、SPB コントローラー ドライバーは、割り込み DPC またはタイマー DPC 中に要求の処理を続行するか、完了します。

SPB コントローラー ドライバーは、I/O 要求からパラメーター値を取得して、シーケンス内の転送の最大長を決定できます。 ドライバーは、この長さを使用して、シーケンス内の転送ごとに再利用できる DMA リソースを割り当てることができます。

SPB コントローラー ドライバーは、SpbRequestGetTransferParameters メソッドを呼び出して、シーケンス内の各転送の制御パラメーターとデータ バッファーを取得できます。 バッファーは、現在の実装では、チェーンされた MDL をカプセル化する WDFMEMORY オブジェクトです。 チェーンされた MDL の詳細については、「MDLの使用」を参照してください。

SPB コントローラーは、シーケンス操作全体でターゲット デバイスを選択したままにする必要があります。 ターゲットがデバイス選択行によって選択されている場合、シーケンス内の最初の転送の開始から最後の転送が終了するまで、その行を連続してアサートできます。 この行は、シーケンスの開始時にロック操作の早い段階でアサートでき、シーケンスの最後のロック解除操作までアサートされたままになります。

シーケンス内の転送ごとに、省略可能な遅延を指定できます。 SPB コントローラー ドライバーは、転送を開始する前に、少なくともそのマイクロ秒の遅延を担当します。 シーケンス内の最初の転送に遅延が関連付けられている場合、ドライバーは最初にアドレスを送信するか、ターゲット デバイスのデバイス選択行をアサートしてから、データ転送を開始する前に指定した時間の遅延をアサートする必要があります。 この遅延の間、ターゲットは選択されたままですが、コントローラーはバス上でクロックを実行しないでください。

ターゲット デバイスがシーケンス内の転送中に NACK を通知すると、SPB コントローラーはシーケンスを停止します。 (つまり、コントローラーは失敗した転送を再試行せず、シーケンス内の残りの転送を実行しようとしません)。この場合、SPB コントローラー ドライバーは、I/O 要求の完了状態を STATUS_SUCCESSに設定し、I/O 状態ブロックの Information フィールドを実際に転送されたバイト数に設定して (NACK を受信した転送で失われたデータをカウントしない)、要求を完了する必要があります。

SPB コントローラー ドライバーは、次のいずれかの条件が発生した場合にのみ、エラー状態コードで I/O 要求を完了する必要があります。

• SPB コントローラーはターゲット デバイスを選択できません (たとえば、I^{2 のターゲット デバイス}C バスは、コントローラーがアドレス バイトを送信するときに NACK を通知します)。
• SPB コントローラー ドライバーは、シーケンス操作の処理中に WDF または WDM サービスへの呼び出しからエラー状態を取得します。

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

例

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

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

EVT_SPB_CONTROLLER_SEQUENCE  MyEvtSpbControllerIoSequence;

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

_Use_decl_annotations_
VOID
  MyEvtSpbControllerIoSequence(
    WDFDEVICE Controller,
    SPBTARGET Target,
    SPBREQUEST Request,
    ULONG TransferCount
    )
{ ... }

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

必要条件

関連項目

• EvtSpbTargetConnect を する
• IOCTL_SPB_EXECUTE_SEQUENCE
• IRP_MJ_READ
• IRP_MJ_WRITE
• SPBREQUEST を する
• SPBTARGET の
• spbDeviceInitialize の
• SpbRequestGetTransferParameters の