EVT_SERCX2_PIO_TRANSMIT_PURGE_FIFO回呼函式 (sercx.h)

發行項
02/26/2024

EvtSerCx2PioTransmitPurgeFifo 事件回呼函式是由序列架構延伸模組的第 2 版所呼叫， (SerCx2) ，捨棄在序列控制器中傳輸 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 事件回呼函式的所有位元組總和，屬於此交易的一部分。

傳回值

無

備註

您的序列控制器驅動程式可以選擇實作此函式。如果實作，驅動程式會在 SerCx2PioTransmitCreate 呼叫中註冊函式，以建立 PIO 傳輸物件。

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

SerCx2 會起始 PIO 傳輸交易，以回應來自用戶端的寫入 (IRP_MJ_WRITE) 要求。如果此要求在完成之前逾時或取消， SerCx2 會呼叫 EvtSerCx2PioTransmitPurgeFifo 函式，如果是實作，則會清除任何可能維持傳輸 FIFO 的未傳送數據。

清除傳輸 FIFO 之後， EvtSerCx2PioTransmitPurgeFifo 函式必須呼叫 SerCx2PioTransmitPurgeFifoComplete 方法，以通知 SerCx2 已清除 FIFO，然後 SerCx2 完成寫入要求。

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

範例

若要定義 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的詳細資訊，請參閱標註函式行為。