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

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

構文

EVT_SERCX2_SYSTEM_DMA_TRANSMIT_CONFIGURE_DMA_CHANNEL EvtSercx2SystemDmaTransmitConfigureDmaChannel;

NTSTATUS EvtSercx2SystemDmaTransmitConfigureDmaChannel(
  [in] SERCX2SYSTEMDMATRANSMIT SystemDmaTransmit,
  [in] PMDL Mdl,
  [in] ULONG Offset,
  [in] ULONG Length
)
{...}

パラメーター

[in] SystemDmaTransmit

system-DMA-transmit オブジェクトへの SERCX2SYSTEMDMATRANSMIT ハンドル。 シリアル コントローラー ドライバーは、このオブジェクトを作成するために SerCx2SystemDmaTransmitCreate メソッドを以前に呼び出しました。

[in] Mdl

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

[in] Offset

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

[in] Length

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

戻り値

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

注釈

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

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

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

詳細については、「 SerCx2 System-DMA-Transmit トランザクション」を参照してください。

例

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

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

EVT_SERCX2_SYSTEM_DMA_TRANSMIT_CONFIGURE_DMA_CHANNEL  MySystemDmaTransmitConfigureDmaChannel;

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

_Use_decl_annotations_
NTSTATUS
  MySystemDmaTransmitConfigureDmaChannel(
    SERCX2SYSTEMDMATRANSMIT SystemDmaTransmit,
    PMDL Mdl,
    ULONG Offset,
    ULONG Length
    )
  {...}

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

要件

こちらもご覧ください

Mdl

SERCX2SYSTEMDMATRANSMIT

SerCx2SystemDmaTransmitCreate

SerCx2SystemDmaTransmitGetDmaEnabler