GPIO_CLIENT_PRE_PROCESS_CONTROLLER_INTERRUPT コールバック関数 (gpioclx.h)

CLIENT_PreProcessControllerInterrupt イベント コールバック関数は、ISR が後で実行されるようにスケジュールされている場合にすぐに実行する必要がある汎用 I/O (GPIO) 割り込みの前処理を実行します。

構文

GPIO_CLIENT_PRE_PROCESS_CONTROLLER_INTERRUPT GpioClientPreProcessControllerInterrupt;

NTSTATUS GpioClientPreProcessControllerInterrupt(
  [in] PVOID Context,
  [in] BANK_ID BankId,
       ULONG64 EnabledMask
)
{...}

パラメーター

[in] Context

GPIO コントローラー ドライバーの デバイス コンテキストへのポインター。

[in] BankId

割り込み GPIO ピンを含むバンク。 N が GPIO コントローラー内のバンクの数である場合、BankId は 0 から N ~ 1 の範囲の整数です。 GPIO フレームワーク拡張機能は、CLIENT_QueryControllerBasicInformation イベント コールバック関数からコントローラー内のバンクの数を以前に取得しました。 詳細については、「CLIENT_CONTROLLER_BASIC_INFORMATIONの解説」を参照してください。

EnabledMask

戻り値

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

備考

このコールバック関数は省略可能です。 GPIO コントローラー ドライバーは、PASSIVE_LEVELで割り込み処理の大部分を実行するが、DIRQL で割り込みの初期処理を行う必要がある場合にのみ、この関数を実装します。

通常、GPIO コントローラー ドライバーは DIRQL でメモリ マップト GPIO コントローラーにアクセスできますが、シリアル接続されている GPIO コントローラーにはPASSIVE_LEVELでのみアクセスできます。 ただし、シリアル接続されている一部の GPIO コントローラーでは、IRQL がPASSIVE_LEVELにドロップするまで割り込み状態ビットのキャプチャを遅延すると、割り込み状態データが失われる可能性があります。 IRQL が後でPASSIVE_LEVELにドロップすると、GPIO フレームワーク拡張機能 (GpioClx) は、ドライバーの CLIENT_QueryActiveInterrupts コールバック関数を呼び出してレジスタの内容を取得できます。

GPIO コントローラー ドライバーは、CLIENT_QueryControllerBasicInformation コールバック中に GpioClx に渡されるデバイス情報のPASSIVE_LEVELで割り込みを処理する必要があるかどうかを示します。 ドライバーが DIRQL でコントローラーのレジスタにアクセスできるように、GPIO コントローラーがメモリ マップされている場合、ドライバーは、ドライバーが GpioClx に渡す CLIENT_CONTROLLER_BASIC_INFORMATION 構造体の メンバーの Flags フラグ ビットに MemoryMappedController を設定します。 それ以外の場合、ドライバー MemoryMappedController = 0 を設定して、ドライバーがPASSIVE_LEVELで割り込みを処理する必要があることを示します。 詳細については、ISR のPassive-Level を参照してください。

ドライバーの CLIENT_PreProcessControllerInterrupt コールバック関数を登録するには、GPIO_CLX_RegisterClient メソッドを呼び出します。 このメソッドは、入力パラメーターとして、CLIENT_PreProcessControllerInterrupt 関数ポインターを含む GPIO_CLIENT_REGISTRATION_PACKET 構造体へのポインターを受け取ります。

例

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

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

GPIO_CLIENT_PRE_PROCESS_CONTROLLER_INTERRUPT MyEvtGpioPreProcessInterrupt;

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

_Use_decl_annotations_
NTSTATUS
  MyEvtGpioPreProcessInterrupt(
    PVOID Context
    )
{ ... }

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

必要条件

関連項目

GPIO_CLIENT_REGISTRATION_PACKET

GPIO_CLX_RegisterClient