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

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

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

構文

EVT_SERCX2_SYSTEM_DMA_TRANSMIT_CANCEL_DRAIN_FIFO EvtSercx2SystemDmaTransmitCancelDrainFifo;

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

パラメーター

[in] SystemDmaTransmit

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

戻り値

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

注釈

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

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

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

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

例

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

たとえば、という名前MySystemDmaTransmitCancelDrainFifoの EvtSerCx2SystemDmaTransmitCancelDrainFifo コールバック関数を定義するには、次のコード例に示すように、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以降で使用できます。
対象プラットフォーム	デスクトップ
Header	sercx.h
IRQL	IRQL <= DISPATCH_LEVELで呼び出されます。