次の方法で共有

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

  • [アーティクル]

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

構文

EVT_SERCX2_SYSTEM_DMA_TRANSMIT_PURGE_FIFO EvtSercx2SystemDmaTransmitPurgeFifo;

void EvtSercx2SystemDmaTransmitPurgeFifo(
  [in] SERCX2SYSTEMDMATRANSMIT SystemDmaTransmit,
  [in] ULONG BytesAlreadyTransmittedToHardware
)
{...}

パラメーター

[in] SystemDmaTransmit

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

[in] BytesAlreadyTransmittedToHardware

現在のシステム DMA 送信トランザクション中に送信 FIFO に既に読み込まれているバイト数。

戻り値

何一つ

備考

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

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

保留中の書き込み (IRP_MJ_WRITE) 要求がタイムアウトになった場合、または取り消された場合、SerCx2 は完了する前に現在のシステム DMA トランザクションを終了する必要がある場合があります。 トランザクションが終了した後、SerCx2 は、実装されている場合、EvtSerCx2SystemDmaTransmitPurgeFifo 関数を呼び出します。

EvtSerCx2SystemDmaTransmitPurgeFifo 関数は、書き込みバッファーから送信 FIFO へのデータの転送を停止し、FIFO に残っている以前に転送されたデータをすべて破棄します。 送信トランザクションが終了した後、ドライバーは、SerCx2SystemDmaTransmitPurgeFifoComplete メソッドを呼び出して、FIFO が消去されたことを SerCx2 に通知し、SerCx2 は書き込み要求を完了する必要があります。

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

例

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

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

EVT_SERCX2_SYSTEM_DMA_TRANSMIT_PURGE_FIFO  MySystemDmaTransmitPurgeFifo;

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

_Use_decl_annotations_
VOID
  MySystemDmaTransmitPurgeFifo(
    SERCX2SYSTEMDMATRANSMIT  SystemDmaTransmit,
    ULONG BytesAlreadyTransmittedToHardware
    )
  {...}

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

必要条件

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

関連項目

EvtSerCx2SystemDmaTransmitCancelDrainFifo の

EvtSerCx2SystemDmaTransmitDrainFifo の

IRP_MJ_WRITE

SERCX2SYSTEMDMATRANSMIT

SerCx2SystemDmaTransmitCreate

SerCx2SystemDmaTransmitPurgeFifoComplete