GPIO_CLIENT_ENABLE_INTERRUPT コールバック関数 (gpioclx.h)
CLIENT_EnableInterrupt イベント コールバック関数は、割り込み入力として構成されている汎用 I/O (GPIO) ピンで割り込みを有効にします。
構文
GPIO_CLIENT_ENABLE_INTERRUPT GpioClientEnableInterrupt;
NTSTATUS GpioClientEnableInterrupt(
[in] PVOID Context,
[in] PGPIO_ENABLE_INTERRUPT_PARAMETERS EnableParameters
)
{...}
パラメーター
[in] Context
GPIO コントローラー ドライバーの デバイス コンテキストへのポインター。
[in] EnableParameters
GPIO ピンを指定し、このピンの割り込み属性を記述する GPIO_ENABLE_INTERRUPT_PARAMETERS 構造体へのポインター。
戻り値
CLIENT_EnableInterrupt 関数は、呼び出しが成功した場合にSTATUS_SUCCESSを返します。 それ以外の場合は、適切なエラー コードが返されます。
備考
このコールバック関数は、GPIO コントローラー ドライバーによって実装されます。 GPIO フレームワーク拡張機能 (GpioClx) はこの関数を呼び出して、割り込み要求入力として構成された GPIO ピンで割り込みを有効にします。
ドライバーの CLIENT_EnableInterrupt コールバック関数を登録するには、GPIO_CLX_RegisterClient メソッドを呼び出します。 このメソッドは、入力パラメーターとして、CLIENT_EnableInterrupt 関数ポインターを含む GPIO_CLIENT_REGISTRATION_PACKET 構造体へのポインターを受け入れます。
GpioClx は常に、IRQL = PASSIVE_LEVEL で CLIENT_EnableInterrupt および CLIENT_DisableInterrupt コールバック関数を呼び出します。 ただし、GPIO レジスタがメモリ マップされている場合、GpioClx は DIRQL の ISR から他の割り込み関連コールバック関数を呼び出します。 この場合、CLIENT_EnableInterrupt 関数と CLIENT_DisableInterrupt 関数は、割り込み関連の操作を ISR に同期するために GPIO 割り込みロックを使用する必要があります。 詳細については、「GPIO コントローラー ドライバーの 割り込み同期」を参照してください。
例
CLIENT_EnableInterrupt コールバック関数を定義するには、まず、定義するコールバック関数の型を識別する関数宣言を指定する必要があります。 Windows には、ドライバーのコールバック関数の種類のセットが用意されています。 コールバック関数の種類を使用して関数を宣言すると、ドライバー のコード分析、静的ドライバー検証ツール (SDV)、およびその他の検証ツールをすると、エラーが検出され、Windows オペレーティング システムのドライバーを記述するための要件になります。
たとえば、MyEvtGpioEnableInterruptという名前の CLIENT_EnableInterrupt コールバック関数を定義するには、次のコード例に示すように、GPIO_CLIENT_ENABLE_INTERRUPT関数型を使用します。
GPIO_CLIENT_ENABLE_INTERRUPT MyEvtGpioEnableInterrupt;
次に、次のようにコールバック関数を実装します。
_Use_decl_annotations_
NTSTATUS
MyEvtGpioEnableInterrupt(
PVOID Context,
PGPIO_ENABLE_INTERRUPT_PARAMETERS InterruptParameters
)
{ ... }
GPIO_CLIENT_ENABLE_INTERRUPT関数の種類は、Gpioclx.h ヘッダー ファイルで定義されています。 コード分析ツールの実行時にエラーをより正確に識別するには、Use_decl_annotations 注釈を関数定義に追加してください。 Use_decl_annotations 注釈により、ヘッダー ファイル内のGPIO_CLIENT_ENABLE_INTERRUPT関数型に適用される注釈が確実に使用されます。 関数宣言の要件の詳細については、「KMDF ドライバーの関数ロール型を使用して関数を宣言する」を参照してください。 Use_decl_annotationsの詳細については、「関数の動作に注釈を付ける」を参照してください。
必要条件
| 要件 | 価値 |
|---|---|
| サポートされる最小クライアント | Windows 8 以降でサポートされています。 |
| ターゲット プラットフォーム の | デスクトップ |
| ヘッダー | gpioclx.h |
| IRQL | PASSIVE_LEVELで呼び出されます。 |