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

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

CLIENT_ReadGpioPinsUsingMask イベントコールバック関数は、汎用 I/O (GPIO) ピンのバンクを読み取ります。

構文

GPIO_CLIENT_READ_PINS_MASK GpioClientReadPinsMask;

NTSTATUS GpioClientReadPinsMask(
  [in]      PVOID Context,
  [in, out] PGPIO_READ_PINS_MASK_PARAMETERS ReadParameters
)
{...}

パラメーター

[in] Context

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

[in, out] ReadParameters

入力時に読み取る GPIO ピンを記述し、終了時には GPIO ピンから読み取られたデータを含む、GPIO_READ_PINS_MASK_PARAMETERS構造体へのポインター。

戻り値

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

注釈

このコールバック関数は、GPIO コントローラードライバーによって実装されます。 GpioClx は、この関数を呼び出します。

CLIENT_ReadGpioPinsUsingMaskコールバック関数は、ピンのバンク内のすべての GPIO ピンの値を読み取ります。関数は、これらの値を GPIO_READ_PINS_MASK_PARAMETERS 構造体の PinValues メンバーに格納します。このメンバーのビット 0 (最上位ビット) にはピン 0 の値が含まれており、ビット 1 にはピン 1 の値が含まれます。

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

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

例

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

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

GPIO_CLIENT_READ_PINS_MASK MyEvtGpioReadPinsUsingMask;

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

_Use_decl_annotations_
NTSTATUS
  MyEvtGpioReadPinsUsingMask(
    PVOID Context,
    PGPIO_READ_PINS_MASK_PARAMETERS ReadParameters
    )
{ ... }

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

要件

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