SerCx2CustomReceiveCreate 関数 (sercx.h)

SerCx2CustomReceiveCreate メソッドは、カスタム受信オブジェクトを作成します。このオブジェクトは、シリアル フレームワーク拡張機能 (SerCx2) のバージョン 2 が、カスタム データ転送メカニズムを使用してシリアル コントローラーから受信データを読み取るために使用します。

構文

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を返します。 考えられるエラー戻り値には、次の状態コードが含まれます。

備考

このメソッドは、カスタム受信オブジェクトを作成するためにシリアル コントローラー ドライバーによって呼び出されます。 SerCx2 は、このオブジェクトを使用してカスタム受信トランザクションを実行します。これは、シリアル コントローラーが受信したデータを読み取るためにカスタム データ転送メカニズムを使用するトランザクションです。

シリアル コントローラー ドライバーは、SerCx2CustomReceiveCreate を呼び出す前に、SerCx2PioReceiveCreate メソッドを SerCx2CustomReceiveCreateを正常に呼び出 す必要があります。

SerCx2CustomReceiveCreate呼び出す前に、シリアル コントローラー ドライバーは SERCX2_CUSTOM_RECEIVE_CONFIG_INIT 関数を呼び出して、CustomReceiveConfigが指す SERCX2_CUSTOM_RECEIVE_CONFIG 構造体 初期化する必要があります。 この関数は、構造体の次のメンバーを 0 に設定します。

• 配置
• MinimumTransactionLength
• MaximumTransactionLength
• MinimumTransferUnit の
• 排他