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

[アーティクル]
08/07/2023

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

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

[in] Request

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

[in] TransferCount

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

戻り値

なし

解説

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

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

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

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

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

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

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

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

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

SPB コントローラーはターゲットデバイスを選択できません (たとえば、I²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の詳細については、「関数の動作に注釈を付ける」を参照してください。

要件

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

Share via

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

構文

パラメーター

戻り値

解説

例

要件

こちらもご覧ください

フィードバック

フィードバック

その他のリソース