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

CLIENT_ConnectIoPins イベント コールバック関数は、汎用 I/O (GPIO) ピンのセットへの論理接続を開き、データの読み取りまたは書き込み操作用にこれらのピンを構成します。

構文

GPIO_CLIENT_CONNECT_IO_PINS GpioClientConnectIoPins;

NTSTATUS GpioClientConnectIoPins(
  [in] PVOID Context,
  [in] PGPIO_CONNECT_IO_PINS_PARAMETERS ConnectParameters
)
{...}

パラメーター

[in] Context

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

[in] ConnectParameters

一連の GPIO ピンへの接続を記述し、これらのピンをデータ入力または出力として構成するかどうかを指定する、GPIO_CONNECT_IO_PINS_PARAMETERS構造体へのポインター。

戻り値

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

注釈

このコールバック関数は、GPIO コントローラー ドライバーによって実装されます。 GPIO フレームワーク拡張機能 (GpioClx) は、この関数を呼び出して、一連の GPIO ピンへの接続を開きます。 これらのピンは、ConnectParameters が指すGPIO_CONNECT_IO_PINS_PARAMETERS構造体の PinNumberTable 配列で指定されます。 この構造体の ConnectMode メンバーは、ピンを入力または出力として構成するかどうかを示します。

接続を閉じるには、GpioClx は CLIENT_DisconnectIoPins コールバック関数を呼び出します。

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

例

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

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

GPIO_CLIENT_CONNECT_IO_PINS MyEvtGpioConnectIoPins;

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

_Use_decl_annotations_
NTSTATUS
  MyEvtGpioConnectIoPins(
    PVOID Context,
    PGPIO_CONNECT_IO_PINS_PARAMETERS ConnectParameters
    )
{ ... }

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

要件

要件	値
サポートされている最小のクライアント	Windows 8 以降でサポートされています。
対象プラットフォーム	デスクトップ
Header	gpioclx.h
IRQL	PASSIVE_LEVELで呼び出されます。

こちらもご覧ください

CLIENT_DisconnectIoPins

GPIO_CLIENT_REGISTRATION_PACKET

GPIO_CLX_RegisterClient