次の方法で共有

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

  • [アーティクル]

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 コールバック関数のを参照してください。

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

例

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

たとえば、という名前の MyEvtGpioMaskInterrupts コールバック関数を定義するには、次のコード例に示すように、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 以降でサポートされています。
ターゲット プラットフォーム の デスクトップ
ヘッダー gpioclx.h
IRQL 「解説」を参照してください。

関連項目

CLIENT_CONTROLLER_BASIC_INFORMATION

CLIENT_QueryControllerBasicInformation

GPIO_CLIENT_REGISTRATION_PACKET

GPIO_CLX_RegisterClient

GPIO_MASK_INTERRUPT_PARAMETERS