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」を参照してください。
ドライバーの CLIENT_PreProcessControllerInterrupt コールバック関数を登録するには、 GPIO_CLX_RegisterClient メソッドを呼び出します。 このメソッドは、入力パラメーターとして、 CLIENT_PreProcessControllerInterrupt 関数ポインターを含む GPIO_CLIENT_REGISTRATION_PACKET 構造体へのポインターを受け取ります。
例
CLIENT_PreProcessControllerInterruptコールバック関数を定義するには、まず、定義するコールバック関数の種類を識別する関数宣言を指定する必要があります。 Windows には、ドライバーのコールバック関数の種類のセットが用意されています。 コールバック関数の種類を使用して関数を宣言すると、ドライバー、静的ドライバー検証ツール (SDV)、およびその他の検証ツールのコード分析でエラーが検出され、Windows オペレーティング システム用のドライバーを記述するための要件になります。
たとえば、 という名前MyEvtGpioPreProcessInterrupt
のCLIENT_PreProcessControllerInterruptコールバック関数を定義するには、次のコード例に示すように、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の詳細については、「関数の動作に注釈を付ける」を参照してください。
要件
要件 | 値 |
---|---|
サポートされている最小のクライアント | Windows 8 以降でサポートされています。 |
対象プラットフォーム | デスクトップ |
Header | gpioclx.h |
IRQL | DIRQL で呼び出されます。 |