EVT_SERCX2_SYSTEM_DMA_TRANSMIT_DRAIN_FIFO回呼函式 (sercx.h)

發行項
02/26/2024

EvtSerCx2SystemDmaTransmitDrainFifo 事件回呼函式是由序列架構延伸模組的第 2 版呼叫， (SerCx2) 來清空序列控制器硬體中的傳輸 FIFO。

語法

EVT_SERCX2_SYSTEM_DMA_TRANSMIT_DRAIN_FIFO EvtSercx2SystemDmaTransmitDrainFifo;

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

參數

[in] SystemDmaTransmit

系統 DMA 傳輸物件的 SERCX2SYSTEMDMATRANSMIT 句柄。序列控制器驅動程式先前稱為 SerCx2SystemDmaTransmitCreate 方法來建立這個物件。

傳回值

無

備註

您的序列控制器驅動程式可以作為選項來實作此函式。如果您的驅動程序實作此函式，它也必須實作 EvtSerCx2SystemDmaTransmitCancelDrainFifo 和 EvtSerCx2SystemDmaTransmitPurgeFifo 事件回呼函式。實作這些函式的驅動程式會在 SerCx2SystemDmaTransmitCreate 呼叫中註冊這些函式，以建立 system-DMA-transmit 物件。

SerCx2 會呼叫 EvtSerCx2SystemDmaTransmitDrainFifo 函式，如果實作，則會在系統-DMA 傳輸交易結束時清空序列控制器硬體中的傳輸 FIFO。此函式可確保任何保留在 FIFO 中的數據位元組都會傳輸至串行連接的周邊裝置。從 FIFO 傳輸最後一個字節之後， EvtSerCx2SystemDmaTransmitDrainFifo 函式會呼叫 SerCx2SystemDmaTransmitDrainFifoComplete 方法來通知 SerCx2。

如果序列控制器驅動程序實作 EvtSerCx2SystemDmaTransmitDrainFifo 函式，SerCx2 不會完成擱置的寫入 (IRP_MJ_WRITE) 要求，直到驅動程式呼叫 SerCx2SystemDmaTransmitDrainFifoComplete 為止。

如果您的序列控制器具有硬體 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的詳細資訊，請參閱標註函式行為。