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構造の形式でデバイス情報を提供します。 この構造体の Flags メンバーで MemoryMappedController フラグ ビットが設定されている場合、GpioClx は DIRQL で CLIENT_ClearActiveInterrupts 関数を呼び出します。これは、GpioClx の ISR が実行される IRQL です。 それ以外の場合、この関数は PASSIVE_LEVEL で呼び出されます。 このフラグ ビットの詳細については、「 割り込み関連のコールバック」を参照してください。

例

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 以降でサポートされています。
対象プラットフォーム デスクトップ
Header gpioclx.h
IRQL 「解説」を参照してください。

こちらもご覧ください

CLIENT_CONTROLLER_BASIC_INFORMATION

CLIENT_QueryControllerBasicInformation

GPIO_CLEAR_ACTIVE_INTERRUPTS_PARAMETERS

GPIO_CLIENT_REGISTRATION_PACKET

GPIO_CLX_RegisterClient