SerCx2CustomReceiveCreate 函式（sercx.h）

發行項
10/30/2024

SerCx2CustomReceiveCreate 方法會建立自定義接收物件，而第 2 版的序列架構延伸模組（SerCx2）會透過自定義數據傳輸機制從序列控制器讀取接收數據。

語法

NTSTATUS SerCx2CustomReceiveCreate(
  [in]  WDFDEVICE                     Device,
  [in]  PSERCX2_CUSTOM_RECEIVE_CONFIG CustomReceiveConfig,
  [in]  PWDF_OBJECT_ATTRIBUTES        Attributes,
  [out] SERCX2CUSTOMRECEIVE           *CustomReceive
);

參數

[in] Device

代表序列控制器之架構裝置物件的WDFDEVICE句柄。序列控制器驅動程式會在其 EvtDriverDeviceAdd 回呼函式中建立這個物件。如需詳細資訊，請參閱 SerCx2InitializeDevice。

[in] CustomReceiveConfig

SERCX2_CUSTOM_RECEIVE_CONFIG 結構的指標。呼叫此方法之前，呼叫端必須呼叫 SERCX2_CUSTOM_RECEIVE_CONFIG_INIT 函式來初始化結構。此結構包含序列控制器驅動程式所實作之一組事件回呼例程的指標。 SerCx2 會呼叫這些函式來執行自定義接收交易。

[in] Attributes

WDF_OBJECT_ATTRIBUTES 結構的指標，描述要指派給新自定義接收對象的屬性。呼叫此方法之前，呼叫端必須呼叫 WDF_OBJECT_ATTRIBUTES_INIT 函式來初始化結構。此參數是選擇性的，如果序列控制器驅動程式不需要將屬性指派給物件，則可以指定為WDF_NO_OBJECT_ATTRIBUTES。如需詳細資訊，請參閱。

[out] CustomReceive

這個方法將 SERCX2CUSTOMRECEIVE 句柄寫入新建立之自定義接收物件的位置指標。 SerCx2 和序列控制器驅動程式會在後續呼叫中使用這個句柄來參考這個物件。

傳回值

如果呼叫成功，這個方法會傳回STATUS_SUCCESS。可能的錯誤傳回值包括下列狀態代碼。

傳回碼	描述
STATUS_INVALID_DEVICE_REQUEST	自定義接收物件已存在於先前 SerCx2CustomReceiveCreate 呼叫中;或先前 SerCx2CustomReceiveCreate 呼叫中的 system-DMA-receive 物件存在;或來自先前 SerCx2CustomTransmitCreate 呼叫的系統 DMA 傳輸物件存在;或 SerCx2PioReceiveCreate 尚未呼叫來建立 PIO 接收物件。
STATUS_INVALID_PARAMETER	參數值無效。
STATUS_INFO_LENGTH_MISMATCH	ConfigSize 值不等於sizeof （SERCX2_CUSTOM_RECEIVE_CONFIG）。
STATUS_INSUFFICIENT_RESOURCES	資源不足，無法建立自定義接收物件。

言論

串行控制器驅動程式會呼叫這個方法，以建立自定義接收物件。 SerCx2 會使用此物件來執行自定義接收交易，這些交易是使用自定義數據傳輸機制來讀取序列控制器所接收的數據的交易。

序列控制器驅動程式必須先成功呼叫 SerCx2InitializeDevice 和 SerCx2PioReceiveCreate 方法，才能呼叫 SerCx2CustomReceiveCreate。

在呼叫 SerCx2CustomReceiveCreate之前，序列控制器驅動程式必須呼叫 SERCX2_CUSTOM_RECEIVE_CONFIG_INIT 函式，以初始化 customReceiveConfig 所指向的 SERCX2_CUSTOM_RECEIVE_CONFIG 結構。此函式會將結構的下列成員設定為零：