EVT_SERCX2_SYSTEM_DMA_TRANSMIT_PURGE_FIFO回呼函式 (sercx.h)

發行項
03/05/2024

EvtSerCx2SystemDmaTransmitPurgeFifo 事件回呼函式是由序列架構延伸模組的第 2 版所呼叫， (SerCx2) ，捨棄在序列控制器硬體中傳輸 FIFO 中任何未傳送之數據的位元組。

語法

EVT_SERCX2_SYSTEM_DMA_TRANSMIT_PURGE_FIFO EvtSercx2SystemDmaTransmitPurgeFifo;

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

參數

[in] SystemDmaTransmit

system-DMA-transmit 對象的 SERCX2SYSTEMDMATRANSMIT 句柄。序列控制器驅動程式先前呼叫 SerCx2SystemDmaTransmitCreate 方法來建立此物件。

[in] BytesAlreadyTransmittedToHardware

目前 system-DMA-transmit 交易期間已載入傳輸 FIFO 的位元元組數目。

傳回值

無

備註

您的序列控制器驅動程式可以選擇實作此函式。如果實作，驅動程式會在 SerCx2SystemDmaTransmitCreate 呼叫中註冊函式，以建立 system-DMA-transmit 物件。

如果序列控制器具有硬體 FIFO (或類似的緩衝機制，則驅動程式應該實作 EvtSerCx2SystemDmaTransmitPurgeFifo 函式，) 來保存傳輸數據。如果您的驅動程序實作此函式，它也必須實作 EvtSerCx2SystemDmaTransmitDrainFifo 和 EvtSerCx2SystemDmaTransmitCancelDrainFifo 事件回呼函式。

如果擱置的寫入 (IRP_MJ_WRITE) 要求逾時或取消，SerCx2 可能需要在完成之前終止目前的 system-DMA 交易。交易終止之後，如果實作， SerCx2 會呼叫 EvtSerCx2SystemDmaTransmitPurgeFifo 函 式。

EvtSerCx2SystemDmaTransmitPurgeFifo 函式會停止將數據從寫入緩衝區傳輸到傳輸 FIFO，並捨棄任何先前在 FIFO 中傳輸的數據。傳輸交易終止之後，驅動程式必須呼叫 SerCx2SystemDmaTransmitPurgeFifoComplete 方法來通知 SerCx2 已清除 FIFO，然後 SerCx2 完成寫入要求。

如需詳細資訊，請參閱 SerCx2 System-DMA-Transmit Transactions。

範例

若要定義 EvtSerCx2SystemDmaTransmitPurgeFifo 回呼函式，您必須先提供函式宣告來識別您要定義的回呼函式類型。 Windows 提供一組驅動程式的回呼函式類型。使用回呼函式類型宣告函式有助於驅動程式的程式代碼分析、靜態驅動程式驗證器 (SDV) ，以及其他驗證工具尋找錯誤，而且這是撰寫 Windows 操作系統驅動程式的需求。

例如，若要定義名為 MySystemDmaTransmitPurgeFifo的 EvtSerCx2SystemDmaTransmitPurgeFifo 回呼函式，請使用 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的詳細資訊，請參閱標註函式行為。