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

[アーティクル]
03/05/2024

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

構文

EVT_SERCX2_SYSTEM_DMA_TRANSMIT_DRAIN_FIFO EvtSercx2SystemDmaTransmitDrainFifo;

void EvtSercx2SystemDmaTransmitDrainFifo(
  [in] SERCX2SYSTEMDMATRANSMIT SystemDmaTransmit
)
{...}

パラメーター

[in] SystemDmaTransmit

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

戻り値

なし

解説

シリアルコントローラードライバーでは、オプションとしてこの関数を実装できます。ドライバーがこの関数を実装する場合は、 EvtSerCx2SystemDmaTransmitCancelDrainFifo および EvtSerCx2SystemDmaTransmitPurgeFifo イベントコールバック関数も実装する必要があります。これらの関数を実装するドライバーは、それらをシステム DMA 送信オブジェクトを作成する SerCx2SystemDmaTransmitCreate 呼び出しに登録します。

SerCx2 は EvtSerCx2SystemDmaTransmitDrainFifo 関数を呼び出し、実装されている場合は、システム DMA 送信トランザクションの最後にシリアルコントローラーハードウェアで送信 FIFO をドレインします。この機能により、FIFO に残っているデータバイトが、シリアル接続された周辺機器に確実に送信されます。 FIFO から最後のバイトが送信された後、 EvtSerCx2SystemDmaTransmitDrainFifo 関数は SerCx2SystemDmaTransmitDrainFifoComplete メソッドを呼び出して SerCx2 に通知します。

シリアルコントローラードライバーが EvtSerCx2SystemDmaTransmitDrainFifo 関数を実装している場合、SerCx2 は、ドライバーが SerCx2SystemDmaTransmitDrainFifoComplete を呼び出すまで、保留中の書き込み (IRP_MJ_WRITE) 要求を完了しません。

シリアルコントローラーに送信データを保持するためのハードウェア FIFO (または同様のバッファリングメカニズム) がある場合、ドライバーは EvtSerCx2SystemDmaTransmitDrainFifo 関数を実装する必要があります。それ以外の場合、SerCx2 は、保留中の書き込み要求が完了する前に送信 FIFO がドレインされたことを確認できません。代わりに、SerCx2 は、書き込みバッファー内の最後のバイトが送信 FIFO に書き込まれた後に、この要求を完了します。送信 FIFO に書き込まれたデータが大幅な遅延なしで送信される保証はありません。書き込み要求が完了した後に FIFO に残っているデータは、シリアル接続された周辺機器に送信される前に失われる可能性があります。正常に完了した書き込み要求でこの予期しないデータが失われると、周辺機器ドライバーの信頼性の問題が発生する可能性があります。

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

例

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

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

EVT_SERCX2_SYSTEM_DMA_TRANSMIT_DRAIN_FIFO  MySystemDmaTransmitDrainFifo;

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

_Use_decl_annotations_
VOID
  MySystemDmaTransmitDrainFifo(
    SERCX2SYSTEMDMATRANSMIT  SystemDmaTransmit
    )
  {...}

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

要件

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