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

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

SPB コントローラードライバーの EvtSpbControllerIoRead イベントコールバック関数は、指定されたターゲットデバイスから読み取り要求で提供されるバッファーにデータを読み取ります。

構文

EVT_SPB_CONTROLLER_READ EvtSpbControllerRead;

void EvtSpbControllerRead(
  [in] WDFDEVICE Controller,
  [in] SPBTARGET Target,
  [in] SPBREQUEST Request,
  [in] size_t Length
)
{...}

パラメーター

[in] Controller

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

[in] Target

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

[in] Request

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

[in] Length

ターゲットデバイスから読み取るバイト数。

戻り値

なし

解説

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

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

EvtSpbControllerIoRead コールバックは非同期です。つまり、コールバック関数は要求された読み取り操作を開始してから、操作の完了を待たずにを返す必要があります。その後、SPB コントローラードライバーは、割り込み DPC またはタイマー DPC 中に読み取り要求を完了します。

読み取り操作が完全に完了した場合、SPB コントローラードライバーは完了状態をSTATUS_SUCCESSに設定する必要があります。ターゲットデバイスが、要求されたすべてのデータを提供できることを示している場合、SPB コントローラードライバーは、使用可能な限り多くのデータを取得し、取得したデータバイト数を指定し、I/O 要求の完了状態をSTATUS_SUCCESSに設定する必要があります。このような部分的に完了した読み取り操作は、SPI または I²C バスでは実行できませんが、別の種類のバスで発生する可能性があります。

行ノイズ、コントローラーハードウェアエラー、またはドライバーエラーが原因で読み取り操作が失敗した場合、SPB コントローラードライバーは、I/O 要求の完了状態を適切なエラーコードに設定する必要があります。すべてのバスに、トランスポートエラーまたは部分的に完了した転送を報告するメカニズムがターゲットデバイスに用意されているわけではありません。また、すべてのコントローラーがこれらの条件を検出できるわけではありません。

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

例

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

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

EVT_SPB_CONTROLLER_READ  MyEvtSpbControllerIoRead;

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

_Use_decl_annotations_
VOID
  MyEvtSpbControllerIoRead(
    WDFDEVICE Controller,
    SPBTARGET Target,
    SPBREQUEST Request,
    size_t Length
    )
{ ... }

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

要件

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

Share via

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

構文

パラメーター

戻り値

解説

例

要件

こちらもご覧ください

フィードバック

フィードバック

その他のリソース