GPIO_CLIENT_QUERY_ACTIVE_INTERRUPTS コールバック関数 (gpioclx.h)
CLIENT_QueryActiveInterrupts イベント コールバック関数は、割り込み入力として構成されている汎用 I/O (GPIO) ピンのセットの状態を照会します。
構文
GPIO_CLIENT_QUERY_ACTIVE_INTERRUPTS GpioClientQueryActiveInterrupts;
NTSTATUS GpioClientQueryActiveInterrupts(
[in] PVOID Context,
[in, out] PGPIO_QUERY_ACTIVE_INTERRUPTS_PARAMETERS QueryActiveParameters
)
{...}
パラメーター
[in] Context
GPIO コントローラー ドライバーの デバイス コンテキストへのポインター。
[in, out] QueryActiveParameters
エントリ時にクエリを実行する GPIO 割り込みピンを記述し、終了時にこれらのピンのアクティブな割り込み状態と有効な割り込み状態を含む、GPIO_QUERY_ACTIVE_INTERRUPTS_PARAMETERS 構造体へのポインター。
戻り値
CLIENT_QueryActiveInterrupts 関数は、呼び出しが成功した場合にSTATUS_SUCCESSを返します。 それ以外の場合は、適切なエラー コードが返されます。
備考
このコールバック関数は、GPIO コントローラー ドライバーによって実装されます。 GPIO フレームワーク拡張機能 (GpioClx) は、割り込み要求入力として構成されている一連の GPIO ピンに対してクエリを実行するために、この関数を呼び出します。
QueryActiveParameters パラメーターは、呼び出し元によって割り当てられた GPIO_QUERY_ACTIVE_INTERRUPTS_PARAMETERS 構造体を指します。 呼び出し元は、BankId の値を設定し、この構造体のメンバー EnabledMask を します。 CLIENT_QueryActiveInterrupts 関数は、構造体の ActiveMask メンバーに書き込みます。
エントリでは、EnabledMask メンバーに設定されているビットは、バンクで現在有効になっている割り込みのセットと一致する必要があります。 戻り値の場合、ActiveMask メンバーで設定されたビットは、有効とアクティブの両方の割り込みに対応している必要があります。 したがって、EnabledMask ビットが 0 の場合、ActiveMask の対応するビット 0 である必要があります。
ドライバーの CLIENT_QueryActiveInterrupts コールバック関数を登録するには、GPIO_CLX_RegisterClient メソッドを呼び出します。 このメソッドは、入力パラメーターとして、CLIENT_QueryActiveInterrupts 関数ポインターを含む GPIO_CLIENT_REGISTRATION_PACKET 構造体へのポインターを受け取ります。
GpioClx は、CLIENT_QueryControllerBasicInformation コールバック関数が GpioClx に提供するデバイス情報に応じて、PASSIVE_LEVELまたは DIRQL で CLIENT_QueryActiveInterrupts コールバック関数を呼び出します。 CLIENT_QueryControllerBasicInformation 関数は、CLIENT_CONTROLLER_BASIC_INFORMATION 構造体の形式でデバイス情報を提供します。 MemoryMappedController フラグ ビットがこの構造体の Flags メンバーに設定されている場合、GpioClx は DIRQL で CLIENT_QueryActiveInterrupts 関数を呼び出します。これは、GpioClx の ISR が実行される IRQL です。 それ以外の場合、この関数はPASSIVE_LEVELで呼び出されます。 このフラグ ビットの詳細については、「省略可能および必須の GPIO コールバック関数のを参照してください。
例
CLIENT_QueryActiveInterrupts コールバック関数を定義するには、まず、定義するコールバック関数の型を識別する関数宣言を指定する必要があります。 Windows には、ドライバーのコールバック関数の種類のセットが用意されています。 コールバック関数の種類を使用して関数を宣言すると、ドライバー のコード分析、静的ドライバー検証ツール (SDV)、およびその他の検証ツールをすると、エラーが検出され、Windows オペレーティング システムのドライバーを記述するための要件になります。
たとえば、MyEvtGpioQueryActiveInterrupts
という名前の CLIENT_QueryActiveInterrupts コールバック関数を定義するには、次のコード例に示すように、GPIO_CLIENT_QUERY_ACTIVE_INTERRUPTS関数型を使用します。
GPIO_CLIENT_QUERY_ACTIVE_INTERRUPTS MyEvtGpioQueryActiveInterrupts;
次に、次のようにコールバック関数を実装します。
_Use_decl_annotations_
NTSTATUS
MyEvtGpioQueryActiveInterrupts(
PVOID Context,
PGPIO_QUERY_ACTIVE_INTERRUPTS_PARAMETERS QueryActiveParameters
)
{ ... }
GPIO_CLIENT_QUERY_ACTIVE_INTERRUPTS関数の種類は、Gpioclx.h ヘッダー ファイルで定義されています。 コード分析ツールの実行時にエラーをより正確に識別するには、Use_decl_annotations 注釈を関数定義に追加してください。 Use_decl_annotations 注釈を使用すると、ヘッダー ファイル内のGPIO_CLIENT_QUERY_ACTIVE_INTERRUPTS関数型に適用される注釈が使用されます。 関数宣言の要件の詳細については、「KMDF ドライバーの関数ロール型を使用して関数を宣言する」を参照してください。 Use_decl_annotationsの詳細については、「関数の動作に注釈を付ける」を参照してください。
必要条件
要件 | 価値 |
---|---|
サポートされる最小クライアント | Windows 8 以降でサポートされています。 |
ターゲット プラットフォーム の | デスクトップ |
ヘッダー | gpioclx.h |
IRQL | 「解説」を参照してください。 |
関連項目
CLIENT_CONTROLLER_BASIC_INFORMATION
CLIENT_QueryControllerBasicInformation