次の方法で共有

EVT_SERCX2_SYSTEM_DMA_RECEIVE_CONFIGURE_DMA_CHANNEL コールバック関数 (sercx.h)

  • [アーティクル]

EvtSerCx2SystemDmaReceiveConfigureDmaChannel イベント コールバック関数は、シリアル フレームワーク拡張機能 (SerCx2) のバージョン 2 によって呼び出され、シリアル コントローラー ドライバーが、システム DMA 受信トランザクションでの各転送の開始前に必要になる可能性がある DMA アダプターのカスタム構成を実行できるようにします。

構文

EVT_SERCX2_SYSTEM_DMA_RECEIVE_CONFIGURE_DMA_CHANNEL EvtSercx2SystemDmaReceiveConfigureDmaChannel;

NTSTATUS EvtSercx2SystemDmaReceiveConfigureDmaChannel(
  [in] SERCX2SYSTEMDMARECEIVE SystemDmaReceive,
  [in] PMDL Mdl,
  [in] ULONG Offset,
  [in] ULONG Length
)
{...}

パラメーター

[in] SystemDmaReceive

システム DMA 受信オブジェクトへの SERCX2SYSTEMDMARECEIVE ハンドル。 シリアル コントローラー ドライバーは、以前にこのオブジェクトを作成するために、SerCx2SystemDmaReceiveCreate メソッドを呼び出しました。

[in] Mdl

システム DMA 受信トランザクションの読み取りバッファーによってスパンされるメモリ ページを記述する MDL へのポインター。 DMA 転送の散布図/収集リストでは、Offset および Length パラメーターで指定されたこのメモリの領域が使用されます。

[in] Offset

データ転送の開始オフセット。 このパラメーターは、MDL によって記述されたバッファー領域の先頭からのバイト オフセットです。 MDL でバッファー領域の合計 N バイトが指定されている場合、Offset の使用可能な値は 0 から N から 1 の範囲になります。

[in] Length

データ転送のサイズ (バイト単位)。 MDL でバッファー領域の N バイトの合計が指定されている場合、Length の使用可能な値は、1 ~ N –オフセットの範囲になります。

戻り値

EvtSerCx2SystemDmaReceiveConfigureDmaChannel 関数は、呼び出しが成功した場合にSTATUS_SUCCESSを返します。 それ以外の場合は、適切なエラー状態コードが返されます。

備考

シリアル コントローラー ドライバーは、オプションとしてこの関数を実装できます。 実装されている場合、ドライバーは、システム DMA 受信オブジェクトを作成する SerCx2SystemDmaReceiveCreate 呼び出しに関数を登録します。

システム DMA 受信トランザクションを開始する前に、SerCx2 が実装されている場合は、EvtSerCx2SystemDmaReceiveConfigureDmaChannel 関数を呼び出します。 この関数は、SerCx2 がシステム DMA 受信トランザクションを開始する前に必要になる可能性があるシステム DMA コントローラーの特別な構成を実行します。

シリアル コントローラー ドライバーは、SerCx2SystemDmaReceiveGetDmaEnabler などのメソッドを呼び出して、システム DMA 受信トランザクションに使用されるシステム DMA コントローラーの DMA イネーブラーを取得できます。

詳細については、「SerCx2 System-DMA-Receive Transactions」を参照してください。

例

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

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

EVT_SERCX2_SYSTEM_DMA_RECEIVE_CONFIGURE_DMA_CHANNEL  MySystemDmaReceiveConfigureDmaChannel;

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

_Use_decl_annotations_
NTSTATUS
  MySystemDmaReceiveConfigureDmaChannel(
    SERCX2SYSTEMDMARECEIVE SystemDmaReceive,
    PMDL Mdl,
    ULONG Offset,
    ULONG Length
    )
  {...}

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

必要条件

要件 価値
サポートされる最小クライアント Windows 8.1 以降で使用できます。
ターゲット プラットフォーム の デスクトップ
ヘッダー sercx.h
IRQL IRQL <= DISPATCH_LEVEL で呼び出されます。

関連項目

MDL を する

SERCX2SYSTEMDMARECEIVE

SerCx2SystemDmaReceiveCreate の

SerCx2SystemDmaReceiveGetDmaEnabler の