EVT_SERCX2_PIO_TRANSMIT_ENABLE_READY_NOTIFICATION コールバック関数 (sercx.h)
EvtSerCx2PioTransmitEnableReadyNotification イベント コールバック関数は、シリアル フレームワーク拡張機能 (SerCx2) のバージョン 2 によって呼び出され、シリアル コントローラー ドライバーがシリアル コントローラー内の送信 FIFO でさらに多くのデータを受け入れる準備ができたときに SerCx2 に通知できるようにします。
構文
EVT_SERCX2_PIO_TRANSMIT_ENABLE_READY_NOTIFICATION EvtSercx2PioTransmitEnableReadyNotification;
void EvtSercx2PioTransmitEnableReadyNotification(
[in] SERCX2PIOTRANSMIT PioTransmit
)
{...}
パラメーター
[in] PioTransmit
PIO 送信オブジェクトへの SERCX2PIOTRANSMIT ハンドル。 シリアル コントローラー ドライバーは、このオブジェクトを作成するために SerCx2PioTransmitCreate メソッドを以前に呼び出しました。
戻り値
なし
解説
シリアル コントローラー ドライバーでは、この関数を実装する必要があります。 ドライバーは、PIO-transmit オブジェクトを作成する SerCx2PioTransmitCreate 呼び出しに関数を登録します。
PIO 送信トランザクションの準備完了通知が有効になっている場合、シリアル コントローラー ドライバーは SerCx2PioTransmitReady メソッドを呼び出して、シリアル コントローラー ハードウェアの送信 FIFO が追加のデータを受け入れる準備ができていることをドライバーが検出したときに SerCx2 に通知する必要があります。 準備完了通知が有効になっているときに送信 FIFO がデータを受け入れる準備ができている場合、ドライバーはすぐにこのメソッドを呼び出して SerCx2 に通知します。
PIO 送信トランザクションの準備完了通知は、ワンショット通知です。 SerCx2 に準備完了通知を送信した後、シリアル コントローラー ドライバーは、SerCx2 が EvtSerCx2PioTransmitEnableReadyNotification 関数を呼び出して別の通知を有効にするまで、それ以上の通知を送信しません。
EvtSerCx2PioTransmitWriteBuffer 関数呼び出しは、PIO 送信トランザクションを部分的にしか完了しない可能性があります。これは、より多くのデータを書き込むため、送信 FIFO ですぐに使用できるスペースがないためです。 この場合、SerCx2 は EvtSerCx2PioTransmitEnableReadyNotification 関数を呼び出して準備完了通知を有効にします。この場合、シリアル コントローラー ドライバーは、送信 FIFO にさらに多くのデータの余地があるときに SerCx2 に通知する必要があります。 この通知に応答して、SerCx2 は EvtSerCx2PioTransmitWriteBuffer 関数をもう一度呼び出すことによって、部分的に完了した送信トランザクションを再開します。
通常、 EvtSerCx2PioTransmitEnableReadyNotification 関数を使用すると、シリアル コントローラーの送信 FIFO でさらに多くのデータを受け入れる準備ができたときに発生する割り込みが可能になります。 この割り込みに応答して、シリアル コントローラー ドライバーは SerCx2PioTransmitReady を呼び出します。
一度に保留中の通知は 1 つ以上ありません。 準備完了通知が既に有効になっている場合、 SerCx2 は EvtSerCx2PioTransmitEnableReadyNotification 関数を呼び出しません。
準備完了通知が有効になっている場合、 SerCx2 は EvtSerCx2PioTransmitWriteBuffer 関数を呼び出しません。
関連付けられた書き込み要求がタイムアウトした場合、または取り消された場合は、保留中の準備完了通知を取り消すことができます。 PIO 送信トランザクションの準備完了通知を取り消すために、SerCx2 は EvtSerCx2PioTransmitCancelReadyNotification イベント コールバック関数を呼び出します。
詳細については、「 SerCx2 PIO-Transmit トランザクション」を参照してください。
例
EvtSerCx2PioTransmitEnableReadyNotification コールバック関数を定義するには、まず、定義するコールバック関数の種類を識別する関数宣言を指定する必要があります。 Windows には、ドライバーのコールバック関数の種類のセットが用意されています。 コールバック関数の種類を使用して関数を宣言すると、ドライバー、静的ドライバー検証ツール (SDV)、およびその他の検証ツールのコード分析でエラーが検出され、Windows オペレーティング システム用のドライバーを記述するための要件になります。
たとえば、 という名前MyPioTransmitEnableReadyNotificationの EvtSerCx2PioTransmitEnableReadyNotification コールバック関数を定義するには、次のコード例に示すように、EVT_SERCX2_PIO_TRANSMIT_ENABLE_READY_NOTIFICATION関数型を使用します。
EVT_SERCX2_PIO_TRANSMIT_ENABLE_READY_NOTIFICATION MyPioTransmitEnableReadyNotification;
次に、コールバック関数を次のように実装します。
_Use_decl_annotations_
VOID
MyPioTransmitEnableReadyNotification(
SERCX2PIOTRANSMIT PioTransmit
)
{...}
EVT_SERCX2_PIO_TRANSMIT_ENABLE_READY_NOTIFICATION関数型は、Sercx.h ヘッダー ファイルで定義されています。 コード分析ツールを実行するときにエラーをより正確に識別するには、 Use_decl_annotations 注釈を関数定義に追加してください。 Use_decl_annotations注釈を使用すると、ヘッダー ファイル内のEVT_SERCX2_PIO_TRANSMIT_ENABLE_READY_NOTIFICATION関数型に適用される注釈が確実に使用されます。 関数宣言の要件の詳細については、「 KMDF ドライバーの関数ロール型を使用した関数の宣言」を参照してください。 Use_decl_annotationsの詳細については、「関数の動作に注釈を付ける」を参照してください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows 8.1以降で使用できます。 |
| 対象プラットフォーム | デスクトップ |
| Header | sercx.h |
| IRQL | IRQL <= DISPATCH_LEVELで呼び出されます。 |