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

[アーティクル]
02/26/2024

EvtSerCx2PioTransmitPurgeFifo イベントコールバック関数は、シリアルフレームワーク拡張機能 (SerCx2) のバージョン 2 によって呼び出され、シリアルコントローラーの送信 FIFO に残っている未送信データのバイトを破棄します。

構文

EVT_SERCX2_PIO_TRANSMIT_PURGE_FIFO EvtSercx2PioTransmitPurgeFifo;

void EvtSercx2PioTransmitPurgeFifo(
  [in] SERCX2PIOTRANSMIT PioTransmit,
  [in] ULONG BytesAlreadyTransmittedToHardware
)
{...}

パラメーター

[in] PioTransmit

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

[in] BytesAlreadyTransmittedToHardware

現在の PIO 送信トランザクション中に送信 FIFO に既に読み込まれているバイト数。このパラメーターは、このトランザクションの一部である EvtSerCx2PioTransmitWriteBuffer イベントコールバック関数の以前の呼び出しで転送されたすべてのバイトの合計です。

戻り値

なし

解説

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

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

SerCx2 は、クライアントからの書き込み (IRP_MJ_WRITE) 要求に応答して PIO 送信トランザクションを開始します。この要求がタイムアウトするか、完了する前に取り消された場合、SerCx2 は EvtSerCx2PioTransmitPurgeFifo 関数を呼び出し、実装されている場合は、送信 FIFO のままの可能性がある未送信データを消去します。

送信 FIFO が消去された後、 EvtSerCx2PioTransmitPurgeFifo 関数は SerCx2PioTransmitPurgeFifoComplete メソッドを呼び出して、FIFO が消去されたことを SerCx2 に通知し、SerCx2 が書き込み要求を完了する必要があります。

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

例

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

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

EVT_SERCX2_PIO_TRANSMIT_PURGE_FIFO  MyPioTransmitPurgeFifo;

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

_Use_decl_annotations_
VOID
  MyPioTransmitPurgeFifo(
    SERCX2PIOTRANSMIT  PioTransmit,
    ULONG  BytesAlreadyTransmittedToHardware

    )
  {...}

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

要件

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