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