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

EvtSerCxReceive イベント コールバック関数は、シリアル コントローラー デバイス (UART) が読み取り (受信) 操作を実行するように準備します。

構文

EVT_SERCX_RECEIVE EvtSercxReceive;

NTSTATUS EvtSercxReceive(
  [in] WDFDEVICE Device,
  [in] size_t Length
)
{...}

パラメーター

[in] Device

シリアル コントローラーを表すフレームワーク デバイス オブジェクトへの WDFDEVICE ハンドル。

[in] Length

受信するバイト数。 コントローラー ドライバーは、PIO または DMA を使用してデータ転送を実行するかどうかを決定するためのヒントとしてこの値を使用できます。

戻り値

EvtSerCxReceive 関数は、呼び出しが成功した場合STATUS_SUCCESSを返します。 それ以外の場合は、適切なエラー状態コードを返します。

注釈

シリアル フレームワーク拡張機能 (SerCx) は、この関数を呼び出して、データを受信するようにコントローラー ハードウェアを構成します。 必要に応じて、 EvtSerCxReceive 関数で割り込みを有効にすることができます。

EvtSerCxReceive 関数は、必ずしも受信 FIFO バッファーから入力データを読み取るわけではありません。 シリアル コントローラーのハードウェアまたは転送の種類によっては、この関数は、データを読み取る DMA 操作を設定する場合や、データを読み取る送信/受信 DPC 関数をスケジュールする場合があります。 シリアル コントローラー ドライバーは、この DPC 関数を実装して、コントローラーからデータを受信し、シリアル コントローラーにデータを送信します。 DPC の間に、DPC 関数はデータを受信できるかどうかを判断し、その場合は PIO を使用してシリアル コントローラーの受信 FIFO からデータを読み取ります。

シリアルコントローラの受信FIFOが空であるか、ほぼ空で、FIFOのハイウォーターマーク割り込みが有効になっている場合、DPCルーチンは単に戻ることができます。 その後、コントローラー ドライバーの ISR は DPC ルーチンの実行をスケジュールでき、このルーチンは受信 FIFO からさらに多くのデータを読み取ることができます。

EvtSerCxReceive コールバック関数を登録するために、コントローラー ドライバーは、EvtDriverDeviceAdd コールバック中に SerCxInitialize メソッドを呼び出します。

例

このコールバックの関数型は、次のように Sercx.h で宣言されています。

typedef NTSTATUS
  EVT_SERCX_RECEIVE(
    __in WDFDEVICE Device
    );

という名前MyEvtSerCxReceiveの EvtSerCxReceive コールバック関数を定義するには、まず、静的ドライバー検証ツール (SDV) やその他の検証ツールで必要な関数宣言を次のように指定する必要があります。

EVT_SERCX_RECEIVE MyEvtSerCxReceive;

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

NTSTATUS
  MyEvtSerCxReceive(
    __in WDFDEVICE Device
    )
{ ... }

関数宣言の SDV 要件の詳細については、「 KMDF ドライバーの関数ロール型を使用した関数の宣言」を参照してください。

要件

こちらもご覧ください

EvtDriverDeviceAdd

SerCxInitialize

WdfDpcEnqueue