EVT_SERCX2_CUSTOM_RECEIVE_TRANSACTION_INITIALIZE回呼函式 (sercx.h)

發行項
02/26/2024

EvtSerCx2CustomReceiveTransactionInitialize 事件回呼函式是由序列架構延伸模組的第 2 版呼叫， (SerCx2) ，以準備序列控制器硬體來執行新的自定義接收交易。

語法

EVT_SERCX2_CUSTOM_RECEIVE_TRANSACTION_INITIALIZE EvtSercx2CustomReceiveTransactionInitialize;

void EvtSercx2CustomReceiveTransactionInitialize(
  [in] SERCX2CUSTOMRECEIVETRANSACTION CustomReceiveTransaction,
  [in] PMDL Mdl,
  [in] ULONG Offset,
  [in] ULONG Length
)
{...}

參數

[in] CustomReceiveTransaction

自訂接收交易物件的 SERCX2CUSTOMRECEIVETRANSACTION 句柄。序列控制器驅動程式先前稱為 SerCx2CustomReceiveTransactionCreate 方法來建立這個物件。

[in] Mdl

MDL 的指標，描述自定義接收交易讀取緩衝區所跨越的記憶體頁面。 DMA 傳輸的散佈/收集清單會使用位移和長度參數所指定的此記憶體區域。

[in] Offset

數據傳輸的起始位移。此參數是 MDL 所描述緩衝區區域開頭的位移。如果 MDL 指定緩衝區空間的 N 個字節總數， 則 Offset 的可能值範圍介於 0 到 N–1 之間。

[in] Length

數據傳輸的大小，以位元組為單位。如果 MDL 指定緩衝區空間的 N 個字節總數，則 Length 的可能值介於 1 到 N 位移的範圍內。

傳回值

無

備註

您的序列控制器驅動程式可以作為選項來實作此函式。如果實作，驅動程式會在 SerCx2CustomReceiveTransactionCreate 呼叫中註冊函式，以建立 custom-receive 物件。

如果您的驅動程式需要初始化序列控制器和相關硬體，以準備新的自定義接收交易，則應該實作 EvtSerCx2CustomReceiveTransactionInitialize 函式。 SerCx2 會在啟動自定義接收交易之前，先呼叫此函式。為了回應此呼叫，序列控制器驅動程序必須呼叫 SerCx2CustomReceiveTransactionInitializeComplete 方法，以在初始化完成後通知 SerCx2。

如需詳細資訊，請參閱 SerCx2 Custom-Receive Transactions。

範例

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

例如，若要定義名為 MyCustomReceiveTransactionInitialize的 EvtSerCx2CustomReceiveTransactionInitialize 回呼函式，請使用 EVT_SERCX2_CUSTOM_RECEIVE_TRANSACTION_INITIALIZE 函式類型，如下列程式代碼範例所示：

EVT_SERCX2_CUSTOM_RECEIVE_TRANSACTION_INITIALIZE  MyCustomReceiveTransactionInitialize;

然後，實作您的回呼函式，如下所示：

_Use_decl_annotations_
VOID
  MyCustomReceiveTransactionInitialize(
    SERCX2CUSTOMRECEIVETRANSACTION  CustomReceiveTransaction,
    WDFREQUEST  Request,
    PMDL  Mdl,
    ULONG  Offset,
    ULONG  Length
    )
  {...}

EVT_SERCX2_CUSTOM_RECEIVE_TRANSACTION_INITIALIZE函式類型定義於 Sercx.h 頭檔中。若要在執行程式代碼分析工具時更精確地識別錯誤，請務必將 Use_decl_annotations 註釋新增至函式定義。 Use_decl_annotations註釋可確保使用頭檔中套用至EVT_SERCX2_CUSTOM_RECEIVE_TRANSACTION_INITIALIZE函式類型的批註。如需函數宣告需求的詳細資訊，請參閱使用 KMDF 驅動程式的函式角色類型來宣告函式。如需 Use_decl_annotations的詳細資訊，請參閱標註函式行為。