EVT_SERCX2_CUSTOM_RECEIVE_TRANSACTION_INITIALIZE コールバック関数 (sercx.h)

[アーティクル]
02/29/2024

EvtSerCx2CustomReceiveTransactionInitialize イベントコールバック関数は、シリアルフレームワーク拡張機能 (SerCx2) のバージョン 2 によって呼び出され、新しいカスタム受信トランザクションを実行するようにシリアルコントローラーハードウェアを準備します。

構文

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 転送の散布/収集リストでは、 Offset パラメーターと Length パラメーターで指定されたこのメモリの領域が使用されます。

[in] Offset

データ転送の開始オフセット。このパラメーターは、MDL によって記述されたバッファー領域の先頭からのバイトオフセットです。 MDL でバッファー領域の合計 N バイトが指定されている場合、 Offset の使用可能な値は 0 から N から 1 の範囲です。

[in] Length

データ転送のサイズ (バイト単位)。 MDL でバッファー領域の合計 N バイトが指定されている場合、 Length の使用可能な値は 1 から N–Offset の範囲です。

戻り値

なし

解説

シリアルコントローラードライバーでは、オプションとしてこの関数を実装できます。実装されている場合、ドライバーは、カスタム受信オブジェクトを作成する SerCx2CustomReceiveTransactionCreate 呼び出しに関数を登録します。

新しいカスタム受信トランザクションに備えてシリアルコントローラーと関連ハードウェアを初期化する必要がある場合、ドライバーは EvtSerCx2CustomReceiveTransactionInitialize 関数を実装する必要があります。 SerCx2 は、カスタム受信トランザクションを開始する前に、実装されている場合にこの関数を呼び出します。この呼び出しに応答して、シリアルコントローラードライバーは、初期化が完了した後に SerCx2 に通知する SerCx2CustomReceiveTransactionInitializeComplete メソッドを呼び出す必要があります。

詳細については、「 SerCx2 Custom-Receive トランザクション」を参照してください。

例

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の詳細については、「関数の動作に注釈を付ける」を参照してください。

要件

要件	値
サポートされている最小のクライアント	Windows 8.1以降で使用できます。
対象プラットフォーム	デスクトップ
Header	sercx.h
IRQL	IRQL <= DISPATCH_LEVELで呼び出されます。