Share via

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

  • [アーティクル]

SPB コントローラー ドライバーの EvtSpbControllerIoOther イベント コールバック関数は、他のイベント コールバック関数または SPB フレームワーク拡張機能 (SpbCx) によって処理されないデバイス I/O 制御要求を処理します。

構文

EVT_SPB_CONTROLLER_OTHER EvtSpbControllerOther;

void EvtSpbControllerOther(
  [in] WDFDEVICE Controller,
  [in] SPBTARGET Target,
  [in] SPBREQUEST Request,
  [in] size_t OutputBufferLength,
  [in] size_t InputBufferLength,
  [in] ULONG IoControlCode
)
{...}

パラメーター

[in] Controller

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

[in] Target

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

[in] Request

I/O 要求に対する SPBREQUEST ハンドル。 SPB コントローラー ドライバーは、この要求を完了する必要があります。 詳細については、「解説」を参照してください。

[in] OutputBufferLength

出力バッファーが要求と共に指定されている場合の出力バッファーの長さ (バイト単位)。

[in] InputBufferLength

入力バッファーが要求と共に指定されている場合の入力バッファーの長さ (バイト単位)。

[in] IoControlCode

要求の I/O 制御コード (IOCTL)。 この値は、SPB フレームワーク拡張機能 (SpbCx) が認識しない IOCTL です。 詳細については、「解説」を参照してください。

戻り値

なし

解説

SpbCx は、SPB コントローラーの I/O キューを管理します。 SPB コントローラー ドライバーが EvtSpbControllerIoOther コールバック関数を登録する場合、SpbCx は、SpbCx がサポートしていないデバイス I/O 制御要求がコントローラーの I/O キューに到着したときに、この関数を呼び出します。 Request パラメーターの値は、この要求をカプセル化するハンドルです。 SPB コントローラー ドライバーは、要求された操作を実行するか、エラー状態を返すことによって、この要求を完了する必要があります。 ドライバーが指定された IOCTL をサポートしていない場合、ドライバーはSTATUS_NOT_SUPPORTEDエラーの状態を返す必要があります。 SpbCx がサポートする IOCTL の一覧については、「 SpbCx I/O コントロール コード」を参照してください。

EvtSpbControllerIoOther コールバックを使用すると、バス固有またはドライバー固有のコマンドを IOCTL として SPB コントローラー ドライバーにディスパッチできます。 たとえば、クライアント (周辺機器ドライバー) は、これらの IOCTL を使用して、SPI バス上のターゲット デバイスとの全二重データ交換などのバス固有の操作を調整する場合があります。 このような IOCTL は、SpbCx でサポートされている IOCTL と同じフロー制御の対象となります。

EvtSpbControllerIoOther コールバック関数は EvtIoDeviceControl に似ていて、同様の方法で IOCTL を処理します。 WDF ドライバーが I/O 要求を処理する方法の一般的な情報については、「 フレームワーク要求オブジェクト」を参照してください。

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

I/O 要求をすぐに完了できない場合、コールバック関数は、SPB コントローラー ドライバーが要求の処理を完了するのを待たずにを返す必要があります。 SPB コントローラー ドライバーは、後で要求を非同期的に完了できます。

EvtSpbControllerIoOther 関数は、ユーザー モード クライアントから受信する I/O コントロール要求のパラメーター値を検証する必要があります。 EvtSpbControllerIoOther 以外のすべての EvtSpbXxx コールバック関数について、SpbCx は関数を呼び出す前にユーザー モード パラメーターを検証します。

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

例

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

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

EVT_SPB_CONTROLLER_OTHER  MyEvtSpbControllerIoOther;

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

_Use_decl_annotations_
VOID
  MyEvtSpbControllerIoOther(
    WDFDEVICE Controller,
    SPBTARGET Target,
    SPBREQUEST Request,
    size_t OutputBufferLength,
    size_t InputBufferLength,
    ULONG IoControlCode
    )
{ ... }

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

要件

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

こちらもご覧ください

EvtIoDeviceControl

EvtSpbTargetConnect

SPBREQUEST

SPBTARGET

SpbControllerSetIoOther