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

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

構文

EVT_SERCX2_PIO_TRANSMIT_DRAIN_FIFO EvtSercx2PioTransmitDrainFifo;

void EvtSercx2PioTransmitDrainFifo(
  [in] SERCX2PIOTRANSMIT PioTransmit
)
{...}

パラメーター

[in] PioTransmit

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

戻り値

何一つ

備考

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

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

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

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

たとえば、周辺機器ドライバーは、周辺機器が接続されているシリアル ポートに書き込み要求を送信することがあります。 未処理の書き込み要求がすべて完了するまで、このドライバーは IOCTL の送信を遅らせ、シリアル ポートがデータを送信するボー レートを変更する必要があります。 ただし、EvtSerCx2PioTransmitDrainFifo 関数 実装されていない場合は、100 バイトのデータを送信するための書き込み要求が完了し、50 データ バイトが送信 FIFO に残っている可能性があります。 その後、周辺機器ドライバーが IOCTL を送信して新しいボー レートを設定すると、FIFO の残りのバイトの一部が新しいボー レートで送信され、エラーが発生する可能性があります。

同様に、50 データ バイトがまだ送信 FIFO に残っている間に 100 バイトのデータを送信する書き込み要求が完了し、シリアル コントローラーが D0 を終了して、FIFO の残りのバイトを送信する前に低電力デバイスの状態に入った場合、周辺機器ドライバーはこれらのバイトが失われることを認識しません。

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

例

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

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

EVT_SERCX2_PIO_TRANSMIT_DRAIN_FIFO  MyPioTransmitDrainFifo;

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

_Use_decl_annotations_
VOID
  MyPioTransmitDrainFifo(
    SERCX2PIOTRANSMIT  PioTransmit
    )
  {...}

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

必要条件

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

関連項目

EvtSerCx2PioTransmitCancelDrainFifo を する

EvtSerCx2PioTransmitPurgeFifo の

IRP_MJ_WRITE

SERCX2PIOTRANSMIT

SerCx2PioTransmitCreate を する

SerCx2PioTransmitDrainFifoComplete を する