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

  • [アーティクル]

EvtSerCx2SystemDmaReceiveEnableNewDataNotification イベント コールバック関数は、シリアル コントローラー ドライバーが新しいデータを受信したときに SerCx2 に通知できるように、シリアル フレームワーク拡張機能 (SerCx2) のバージョン 2 によって呼び出されます。

構文

EVT_SERCX2_SYSTEM_DMA_RECEIVE_ENABLE_NEW_DATA_NOTIFICATION EvtSercx2SystemDmaReceiveEnableNewDataNotification;

void EvtSercx2SystemDmaReceiveEnableNewDataNotification(
  [in] SERCX2SYSTEMDMARECEIVE SystemDmaReceive
)
{...}

パラメーター

[in] SystemDmaReceive

システム DMA 受信オブジェクトへの SERCX2SYSTEMDMARECEIVE ハンドル。 シリアル コントローラー ドライバーは、以前にこのオブジェクトを作成するために、SerCx2SystemDmaReceiveCreate メソッドを呼び出しました。

戻り値

何一つ

備考

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

EvtSerCx2SystemDmaReceiveEnableNewDataNotification 関数を呼び出して、システム DMA 受信トランザクションの新しいデータ通知を有効にした後、 シリアル コントローラー ドライバーは、SerCx2SystemDmaReceiveNewDataNotification メソッドを呼び出して、受信したデータの 1 つ以上のバイトが転送の準備ができているか、システム DMA コントローラーによって既に転送されていることをドライバーが検出したときに SerCx2 に通知する必要があります。

EvtSerCx2SystemDmaReceiveEnableNewDataNotification 関数によって有効になる新しいデータ通知は、ワンショット通知です。 この関数が呼び出され、シリアル コントローラー ドライバーが SerCx2 に新しいデータ通知を送信した後、SerCx2 が関数を再度呼び出して別の通知を有効にするまで、それ以上の通知は送信されません。

EvtSerCx2SystemDmaReceiveEnableNewDataNotification 関数を使用すると、通常、シリアル コントローラーが周辺機器からデータを受信したときに割り込みをトリガーできます。

一度に保留中の新しいデータ通知は 1 つもできません。 SerCx2 は、EvtSerCx2SystemDmaReceiveEnableNewDataNotification 関数を呼び出して新しいデータ通知を有効にした後、コントローラー ドライバーが SerCx2SystemDmaReceiveNewDataNotification呼び出すまで、この関数を再度呼び出しません。

関連付けられている読み取り要求がタイムアウトになった場合、または取り消された場合は、保留中の新しいデータ通知を取り消すことができます。 システム DMA 受信トランザクションの新しいデータ通知を取り消すために、SerCx2 はイベント コールバック関数 EvtSerCx2SystemDmaReceiveCancelNewDataNotification 呼び出します。 EvtSerCx2SystemDmaReceiveEnableNewDataNotification 関数を実装するドライバーは、EvtSerCx2SystemDmaReceiveCancelNewDataNotification 関数も実装する必要があります。

SerCx2 は、新しいデータ通知を使用して、システム DMA 受信トランザクションとして処理される読み取り要求の処理中に発生する間隔タイムアウトを効率的に管理します。

詳細については、「SerCx2 System-DMA-Receive Transactions」を参照してください。

例

コールバック関数 EvtSerCx2SystemDmaReceiveEnableNewDataNotification コールバック関数を定義するには、まず、定義するコールバック関数の型を識別する関数宣言を指定する必要があります。 Windows には、ドライバーのコールバック関数の種類のセットが用意されています。 コールバック関数の種類を使用して関数を宣言すると、ドライバーのコード分析、静的ドライバー検証ツール (SDV)、およびその他の検証ツールを すると、エラーが検出され、Windows オペレーティング システムのドライバーを記述するための要件になります。

たとえば、という名前のコールバック関数 EvtSerCx2SystemDmaReceiveEnableNewDataNotification を定義するには、次のコード例に示すように、EVT_SERCX2_SYSTEM_DMA_RECEIVE_ENABLE_NEW_DATA_NOTIFICATION 関数型を使用します。

EVT_SERCX2_SYSTEM_DMA_RECEIVE_ENABLE_NEW_DATA_NOTIFICATION  MySystemDmaReceiveEnableNewDataNotification;

次に、次のようにコールバック関数を実装します。

_Use_decl_annotations_
VOID
  MySystemDmaReceiveEnableNewDataNotification(
    SERCX2SYSTEMDMARECEIVE  SystemDmaReceive
    )
  {...}

EVT_SERCX2_SYSTEM_DMA_RECEIVE_ENABLE_NEW_DATA_NOTIFICATION 関数の型は、Sercx.h ヘッダー ファイルで定義されています。 コード分析ツールの実行時にエラーをより正確に識別するには、Use_decl_annotations 注釈を関数定義に追加してください。 Use_decl_annotations 注釈により、ヘッダー ファイル内の EVT_SERCX2_SYSTEM_DMA_RECEIVE_ENABLE_NEW_DATA_NOTIFICATION 関数型に適用される注釈が確実に使用されます。 関数宣言の要件の詳細については、「KMDF ドライバーの関数ロール型を使用して関数を宣言する」を参照してください。 Use_decl_annotationsの詳細については、「関数の動作に注釈を付ける」を参照してください。

必要条件

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

関連項目

DMA_OPERATIONS

EvtSerCx2SystemDmaReceiveCancelNewDataNotification の

EvtSerCx2SystemDmaReceiveCleanupTransaction の

ReadDmaCounter

SERCX2SYSTEMDMARECEIVE

SerCx2SystemDmaReceiveCreate の

SerCx2SystemDmaReceiveNewDataNotification の