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