次の方法で共有


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

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

構文

EVT_SERCX2_PIO_RECEIVE_ENABLE_READY_NOTIFICATION EvtSercx2PioReceiveEnableReadyNotification;

void EvtSercx2PioReceiveEnableReadyNotification(
  [in] SERCX2PIORECEIVE PioReceive
)
{...}

パラメーター

[in] PioReceive

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

戻り値

何一つ

備考

シリアル コントローラー ドライバーでは、この関数を実装する必要があります。 ドライバーは、PIO 受信オブジェクトを作成する SerCx2PioReceiveCreate 呼び出しに関数を登録します。

PIO 受信トランザクションの準備完了通知を有効にするために、EvtSerCx2PioReceiveEnableReadyNotification 関数を呼び出した後、シリアル コントローラー ドライバーは、シリアル コントローラー ハードウェアの受信 FIFO から 1 バイト以上のデータが読み取り可能であることを検出したときに SerCx2 に通知するために、SerCx2PioReceiveReady メソッドを呼び出す必要があります。 準備完了通知が有効になっているときに受信 FIFO でデータが既に使用可能な場合、ドライバーはすぐにこのメソッドを呼び出して SerCx2 に通知します。

PIO 受信トランザクションの準備完了通知は、1 回の通知です。 SerCx2 に準備完了通知を送信した後、シリアル コントローラー ドライバーは、SerCx2 が EvtSerCx2PioReceiveEnableReadyNotification 関数を呼び出して別の通知を有効にするまで、それ以上通知を送信しません。

EvtSerCx2PioReceiveReadBuffer イベント コールバック関数呼び出し 、受信 FIFO からすぐに読み取ることができるデータがなくなったため、PIO 受信トランザクションを部分的にしか完了できない場合があります。 この場合、SerCx2 は、EvtSerCx2PioReceiveEnableReadyNotification 関数を呼び出して準備完了通知を有効にします。この場合、シリアル コントローラー ドライバーは、受信 FIFO にさらに多くのデータが含まれている場合に SerCx2 に通知する必要があります。 この通知に応答して、SerCx2 は、EvtSerCx2PioReceiveReadBuffer 関数をもう一度呼び出すことによって、部分的に完了した受信トランザクションを再開します。

通常、EvtSerCx2PioReceiveEnableReadyNotification 関数を使用すると、シリアル コントローラーで読み取り可能なデータが増えたときに発生する割り込みが可能になります。 この割り込みに応答して、シリアル コントローラー ドライバーは SerCx2PioReceiveReadyを呼び出します。

一度に保留中の通知は複数ありません。 SerCx2 が EvtSerCx2PioReceiveEnableReadyNotification 関数を呼び出して準備完了通知を有効にした後、SerCx2 は、コントローラー ドライバーが SerCx2PioReceiveReady呼び出すまで、この関数を再度呼び出しません。

SerCx2 は、準備完了通知が有効になっているときに、EvtSerCx2PioReceiveReadBuffer 関数を呼び出すことはありません。

関連付けられている読み取り要求がタイムアウトになった場合、または取り消された場合、保留中の準備完了通知を取り消すことができます。 PIO 受信トランザクションの準備完了通知を取り消すために、SerCx2 はイベント コールバック関数 EvtSerCx2PioReceiveCancelReadyNotification 呼び出します。

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

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

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

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

EVT_SERCX2_PIO_RECEIVE_ENABLE_READY_NOTIFICATION  MyPioReceiveEnableReadyNotification;

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

_Use_decl_annotations_
VOID
  MyPioReceiveEnableReadyNotification(
    SERCX2PIORECEIVE  PioReceive
    )
  {...}

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

必要条件

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

関連項目

EvtSerCx2PioReceiveCancelReadyNotification

EvtSerCx2PioReceiveCleanupTransaction

IRP_MJ_READ

SERCX2PIORECEIVE

SerCx2PioReceiveCreate

SerCx2PioReceiveReady