SerCx2CustomTransmitCreate 函式（sercx.h）

發行項
12/22/2024

SerCx2CustomTransmitCreate 方法會建立自定義傳輸物件，此物件是串行架構延伸模組（SerCx2）第 2 版用來透過自定義數據傳輸機制將數據寫入序列控制器。

語法

NTSTATUS SerCx2CustomTransmitCreate(
  [in]  WDFDEVICE                      Device,
  [in]  PSERCX2_CUSTOM_TRANSMIT_CONFIG CustomTransmitConfig,
  [in]  PWDF_OBJECT_ATTRIBUTES         Attributes,
  [out] SERCX2CUSTOMTRANSMIT           *CustomTransmit
);

參數

[in] Device

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

[in] CustomTransmitConfig

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

[in] Attributes

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

[out] CustomTransmit

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

傳回值

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

傳回碼	描述
STATUS_INVALID_DEVICE_REQUEST	自定義傳輸物件已存在於先前 SerCx2CustomTransmitCreate 呼叫中;或來自先前 SerCx2SystemDmaTransmitCreate 呼叫的系統-DMA 傳輸物件存在;或先前 SerCx2SystemDmaTransmitCreate 呼叫中的 system-DMA-transmit 物件存在;或 SerCx2PioTransmitCreate 尚未呼叫以建立 PIO 傳輸物件。
STATUS_INVALID_PARAMETER	參數值無效。
STATUS_INFO_LENGTH_MISMATCH	Config->Size 值不等於 sizeof（SERCX2_CUSTOM_TRANSMIT_CONFIG）。
STATUS_INSUFFICIENT_RESOURCES	資源不足，無法建立自定義傳輸物件。

言論

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

序列控制器驅動程式必須在呼叫 SerCx2CustomTransmitCreate之前，成功呼叫 SerCx2InitializeDevice 和 SerCx2PioTransmitCre ate 方法。

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