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

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

CLIENT_WriteGpioPins イベントコールバック関数は、データ出力として構成されている汎用 I/O (GPIO) ピンのセットに書き込みます。

構文

GPIO_CLIENT_WRITE_PINS GpioClientWritePins;

NTSTATUS GpioClientWritePins(
  [in] PVOID Context,
  [in] PGPIO_WRITE_PINS_PARAMETERS WriteParameters
)
{...}

パラメーター

[in] Context

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

[in] WriteParameters

GPIO ピンのバンクを記述し、これらのピンに書き込むデータを含むGPIO_WRITE_PINS_PARAMETERS構造体へのポインター。

戻り値

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

注釈

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

PinNumberTable 配列内のすべてのピンは、BankId パラメーターによって識別される銀行に属します。

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

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

例

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

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

GPIO_CLIENT_WRITE_PINS MyEvtGpioWritePins;

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

_Use_decl_annotations_
NTSTATUS
  MyEvtGpioWritePins(
    PVOID Context,
    PGPIO_WRITE_PINS_MASK_PARAMETERS WriteParameters
    )
{ ... }

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

要件

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