GPIO_CLIENT_WRITE_PINS_MASK コールバック関数 (gpioclx.h)
CLIENT_WriteGpioPinsUsingMask イベント コールバック関数は、データ出力として構成されている汎用 I/O (GPIO) ピンのセットに書き込みます。
構文
GPIO_CLIENT_WRITE_PINS_MASK GpioClientWritePinsMask;
NTSTATUS GpioClientWritePinsMask(
[in] PVOID Context,
[in] PGPIO_WRITE_PINS_MASK_PARAMETERS WriteParameters
)
{...}
パラメーター
[in] Context
GPIO コントローラー ドライバーの デバイス コンテキストへのポインター。
[in] WriteParameters
GPIO ピンのバンク を記述し、これらのピンに書き込むデータを含むGPIO_WRITE_PINS_MASK_PARAMETERS構造体へのポインター。
戻り値
呼び出 しが 成功した場合、CLIENT_WriteGpioPinsUsingMask関数はSTATUS_SUCCESSを返します。 それ以外の場合は、適切なエラー コードを返します。
注釈
このコールバック関数は、GPIO コントローラー ドライバーによって実装されます。 GpioClx は、この関数を呼び出して、指定された GPIO ピンセットに書き込みます。
この関数によって書き込まれる GPIO ピンは、2 つの 64 ビット マスクによって指定されます。 最初のマスクは、1 に設定される GPIO ピンのグループを指定します。対応する GPIO ピンを 1 に設定する場合、このマスクのビットは 1 です。 2 番目のマスクは、0 に設定される GPIO ピンのグループを指定します。対応する GPIO ピンを 0 に設定する場合、このマスクのビットは 1 です。
ドライバーの CLIENT_WriteGpioPinsUsingMask コールバック関数を登録するには、 GPIO_CLX_RegisterClient メソッドを呼び出します。 このメソッドは、入力パラメーターとして、CLIENT_WriteGpioPinsUsingMask関数ポインターを含むGPIO_CLIENT_REGISTRATION_PACKET構造体へのポインターを受け取ります。
CLIENT_WriteGpioPinsUsingMask関数は、GpioClx の割り込みサービス ルーチン (ISR) から呼び出すことができます。 この ISR は、CLIENT_QueryControllerBasicInformationコールバック関数が GpioClx に提供するデバイス情報に応じて、 PASSIVE_LEVEL または DIRQL で実行されます。 CLIENT_QueryControllerBasicInformation関数は、CLIENT_CONTROLLER_BASIC_INFORMATION構造の形式でデバイス情報を提供します。 この構造体の Flags メンバーで MemoryMappedController フラグ ビットが設定されている場合、GpioClx ISR は DIRQL で実行され、DIRQL でCLIENT_WriteGpioPinsUsingMask関数を呼び出します。 それ以外の場合、ISR は PASSIVE_LEVEL で実行され、PASSIVE_LEVELで 関数を呼び出します。 このフラグ ビットの詳細については、「 省略可能な GPIO コールバック関数」と「必須の GPIO コールバック関数」を参照してください。
例
CLIENT_WriteGpioPinsUsingMaskコールバック関数を定義するには、まず、定義するコールバック関数の型を識別する関数宣言を指定する必要があります。 Windows には、ドライバーのコールバック関数の種類のセットが用意されています。 コールバック関数の種類を使用して関数を宣言すると、ドライバー、静的ドライバー検証ツール (SDV)、およびその他の検証ツールのコード分析でエラーが検出され、Windows オペレーティング システム用のドライバーを記述するための要件になります。
たとえば、 という名前MyEvtGpioWriteGpioPinsUsingMask
のCLIENT_WriteGpioPinsUsingMaskコールバック関数を定義するには、次のコード例に示すように、GPIO_CLIENT_WRITE_PINS_MASK関数型を使用します。
GPIO_CLIENT_WRITE_PINS_MASK MyEvtGpioWritePinsUsingMask;
次に、コールバック関数を次のように実装します。
_Use_decl_annotations_
VOID
MyEvtGpioWritePinsUsingMask(
PVOID Context,
PGPIO_WRITE_PINS_MASK_PARAMETERS WriteParameters
)
{ ... }
GPIO_CLIENT_WRITE_PINS_MASK関数型は、Gpioclx.h ヘッダー ファイルで定義されます。 コード分析ツールを実行するときにエラーをより正確に識別するには、 Use_decl_annotations 注釈を関数定義に追加してください。 Use_decl_annotations注釈を使用すると、ヘッダー ファイル内のGPIO_CLIENT_WRITE_PINS_MASK関数型に適用される注釈が確実に使用されます。 関数宣言の要件の詳細については、「 KMDF ドライバーの関数ロール型を使用した関数の宣言」を参照してください。 Use_decl_annotationsの詳細については、「関数の動作に注釈を付ける」を参照してください。
要件
要件 | 値 |
---|---|
サポートされている最小のクライアント | Windows 8 以降でサポートされています。 |
対象プラットフォーム | デスクトップ |
Header | gpioclx.h |
IRQL | 「解説」を参照してください。 |
こちらもご覧ください
CLIENT_CONTROLLER_BASIC_INFORMATION
CLIENT_QueryControllerBasicInformation