次の方法で共有

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

  • [アーティクル]

EvtSerCx2SystemDmaTransmitCancelDrainFifo イベント コールバック関数は、シリアル フレームワーク拡張機能 (SerCx2) のバージョン 2 によって呼び出され、シリアル コントローラー ハードウェアで送信 FIFO をドレインする以前の要求を取り消します。

構文

EVT_SERCX2_SYSTEM_DMA_TRANSMIT_CANCEL_DRAIN_FIFO EvtSercx2SystemDmaTransmitCancelDrainFifo;

BOOLEAN EvtSercx2SystemDmaTransmitCancelDrainFifo(
  [in] SERCX2SYSTEMDMATRANSMIT SystemDmaTransmit
)
{...}

パラメーター

[in] SystemDmaTransmit

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

戻り値

EvtSerCx2SystemDmaTransmitCancelDrainFifo 関数は、保留中のドレイン要求を正常に取り消した場合に TRUE を 返します。シリアル コントローラー ドライバーは、SerCx2SystemDmaTransmitDrainFifoComplete メソッドを呼び出して、FIFO がドレインされたことを SerCx2 に通知しないことを保証できます。 それ以外の場合、この関数は、ドライバーが既 に呼び出されているか、SerCx2SystemDmaTransmitDrainFifoComplete呼び出ししようとしていることを示す FALSE を返します。

備考

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

シリアル コントローラーに送信データを保持するハードウェア FIFO (または同様のバッファリング メカニズム) がある場合、ドライバーは EvtSerCx2SystemDmaTransmitCancelDrainFifo 関数を実装する必要があります。 ドライバーがこの関数を実装する場合は、EvtSerCx2SystemDmaTransmitDrainFifo を実装し、EvtSerCx2SystemDmaTransmitPurgeFifo イベント コールバック関数を する必要もあります。

SerCx2 は、EvtSerCx2SystemDmaTransmitDrainFifo イベント コールバック関数を呼び出してシリアル コントローラー ドライバーが送信 FIFO をドレインするように要求した後、SerCx2 が EvtSerCx2SystemDmaTransmitCancelDrainFifo 関数を呼び出して、FIFO のドレインが終了する前に保留中のドレイン要求をキャンセルする可能性があります。 たとえば、クライアントが保留中の書き込み (IRP_MJ_WRITE) 要求をキャンセルした場合、または書き込み要求がタイムアウトした場合、SerCx2 は EvtSerCx2SystemDmaTransmitCancelDrainFifo 関数を呼び出すことができます。

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

例

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

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

EVT_SERCX2_SYSTEM_DMA_TRANSMIT_CANCEL_DRAIN_FIFO  MySystemDmaTransmitCancelDrainFifo;

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

_Use_decl_annotations_
BOOLEAN
  MySystemDmaTransmitCancelDrainFifo(
    SERCX2SYSTEMDMATRANSMIT  SystemDmaTransmit
    )
  {...}

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

必要条件

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

関連項目

EvtSerCx2SystemDmaTransmitDrainFifo の

EvtSerCx2SystemDmaTransmitPurgeFifo の

IRP_MJ_WRITE

SERCX2SYSTEMDMATRANSMIT

SerCx2SystemDmaTransmitCreate

SerCx2SystemDmaTransmitDrainFifoComplete の