GPIO_CLIENT_MASK_INTERRUPTS コールバック関数 (gpioclx.h)

[アーティクル]
08/07/2023

CLIENT_MaskInterrupts イベントコールバック関数は、割り込み入力として構成されている汎用 I/O (GPIO) ピンのセットで割り込みをマスクします。

構文

GPIO_CLIENT_MASK_INTERRUPTS GpioClientMaskInterrupts;

NTSTATUS GpioClientMaskInterrupts(
  [in]      PVOID Context,
  [in, out] PGPIO_MASK_INTERRUPT_PARAMETERS MaskParameters
)
{...}

パラメーター

[in] Context

GPIO コントローラードライバーのデバイスコンテキストへのポインター。

[in, out] MaskParameters

エントリ時にマスクする GPIO 割り込みピンを記述し、終了時にマスク操作の状態を含む、 GPIO_MASK_INTERRUPT_PARAMETERS 構造体へのポインター。

戻り値

呼び出しが成功した場合、CLIENT_MaskInterrupts関数はSTATUS_SUCCESSを返します。それ以外の場合は、適切なエラーコードを返します。

注釈

このコールバック関数は、GPIO コントローラードライバーによって実装されます。 GPIO フレームワーク拡張機能 (GpioClx) は、割り込み要求入力として構成されている GPIO ピンで割り込みをマスクするために、この関数を呼び出します。詳細については、「 GPIO 割り込みマスク」を参照してください。

ドライバーの CLIENT_MaskInterrupts コールバック関数を登録するには、 GPIO_CLX_RegisterClient メソッドを呼び出します。このメソッドは、入力パラメーターとして、CLIENT_MaskInterrupts関数ポインターを含むGPIO_CLIENT_REGISTRATION_PACKET構造体へのポインターを受け取ります。

CLIENT_MaskInterrupts関数は、GpioClx の割り込みサービスルーチン (ISR) から呼び出されます。この ISR は、CLIENT_QueryControllerBasicInformationコールバック関数が GpioClx に提供するデバイス情報に応じて、 PASSIVE_LEVEL または DIRQL で実行されます。 CLIENT_QueryControllerBasicInformation関数は、CLIENT_CONTROLLER_BASIC_INFORMATION構造の形式でデバイス情報を提供します。 MemoryMappedController フラグビットがこの構造体の Flags メンバーに設定されている場合、GpioClx ISR は DIRQL で実行され、DIRQL でCLIENT_MaskInterrupts関数を呼び出します。それ以外の場合、ISR は PASSIVE_LEVEL で実行され、PASSIVE_LEVELで関数を呼び出します。このフラグビットの詳細については、「省略可能な GPIO コールバック関数」と「必要な GPIO コールバック関数」を参照してください。

割り込みマスクを要求された値に設定できないCLIENT_MaskInterrupts呼び出しでは、GPIO_MASK_INTERRUPT_PARAMETERS構造体の FailedMask メンバーを 0 以外の値に設定し、適切なエラー状態コードを返す必要があります。メモリマップト GPIO コントローラーの CLIENT_MaskInterrupts 関数は、割り込みマスクを要求された値に設定する際に常に成功することが予想されます。ただし、メモリマップされていないコントローラーの CLIENT_MaskInterrupts 関数は、マスクを設定するためにコントローラーに I/O 要求を送信する必要があり、この要求は失敗する可能性があります。要求がマスクの設定に失敗した場合、関数は FailedMask メンバーに書き込む値にこのエラーを示す必要があります。

例

CLIENT_MaskInterruptsコールバック関数を定義するには、まず、定義するコールバック関数の種類を識別する関数宣言を指定する必要があります。 Windows には、ドライバーのコールバック関数型のセットが用意されています。コールバック関数の種類を使用して関数を宣言すると、ドライバーのコード分析、静的ドライバー検証ツール (SDV)、およびその他の検証ツールでエラーが検出され、Windows オペレーティングシステムのドライバーを記述するための要件になります。

たとえば、という名前MyEvtGpioMaskInterruptsのCLIENT_MaskInterruptsコールバック関数を定義するには、次のコード例に示すように、GPIO_CLIENT_MASK_INTERRUPTS関数型を使用します。

GPIO_CLIENT_MASK_INTERRUPTS MyEvtGpioMaskInterrupts;

次に、コールバック関数を次のように実装します。

_Use_decl_annotations_
NTSTATUS
  MyEvtGpioMaskInterrupts(
    PVOID Context,
    PGPIO_MASK_INTERRUPT_PARAMETERS MaskParameters
    )
{ ... }

GPIO_CLIENT_MASK_INTERRUPTS関数の種類は、Gpioclx.h ヘッダーファイルで定義されています。コード分析ツールの実行時にエラーをより正確に識別するには、 Use_decl_annotations 注釈を関数定義に追加してください。 Use_decl_annotations注釈を使用すると、ヘッダーファイル内のGPIO_CLIENT_MASK_INTERRUPTS関数型に適用される注釈が確実に使用されます。関数宣言の要件の詳細については、「 KMDF ドライバーの関数ロール型を使用した関数の宣言」を参照してください。 Use_decl_annotationsの詳細については、「関数の動作に注釈を付ける」を参照してください。

要件

要件	値
サポートされている最小のクライアント	Windows 8 以降でサポートされています。
対象プラットフォーム	デスクトップ
Header	gpioclx.h
IRQL	「解説」を参照してください。