SPB_CONNECTION_PARAMETERS 構造体 (spbcx.h)

[アーティクル]
03/05/2024

SPB_CONNECTION_PARAMETERS構造体には、単純な周辺機器バス上のターゲットデバイスの接続パラメーターが含まれています。

構文

typedef struct _SPB_CONNECTION_PARAMETERS {
  USHORT Size;
  PCWSTR ConnectionTag;
  PVOID  ConnectionParameters;
} SPB_CONNECTION_PARAMETERS, *PSPB_CONNECTION_PARAMETERS;

メンバー

Size

この構造体のサイズ (バイト単位)。 SpbTargetGetConnectionParameters メソッドは、Size 値を使用して、この構造体のどのバージョンが使用されているかを判断します。このメンバーを初期化するには、SPB_CONNECTION_PARAMETERS_INIT 関数を使用します。詳細については、「解説」を参照してください。

ConnectionTag

このターゲットの接続タグへのポインター。接続タグは、ターゲットデバイスからバスへの接続を識別する接続 ID を含む不透明な文字列です。詳細については、「SPB 接続周辺機器の接続 ID」を参照してください。

ConnectionParameters

このターゲットの接続パラメーターへのポインター。このメンバーは、SPB コントローラードライバーがターゲットと通信するために必要なターゲット固有のパラメーターを含むメモリバッファーを指します。詳細については、「解説」を参照してください。

注釈

この構造体には、ターゲットデバイスからバスへの接続に関する情報が含まれています。クライアント (周辺機器ドライバー) がターゲットデバイスへの論理接続を開くと、SPB コントローラードライバーはデバイスの接続設定を取得し、これらの設定を格納します。その後、クライアントからデバイスへの I/O 要求に応答して、SPB コントローラードライバーは接続設定を使用して、バス経由でデバイスにアクセスするようにコントローラーを構成します。

たとえば、I2C バス上のデバイスの接続設定には、次のようなものがあります。

ターゲットデバイスのバス相対アドレス。
ターゲットデバイスへのアクセスに使用するアドレスビットの数。
ターゲットデバイスへのアクセスに使用するバスクロック周波数。

SPB_CONNECTION_PARAMETERS構造体の ConnectionParameters メンバーは、バス上のターゲットデバイスの接続設定を含むバッファーへのポインターです。 ConnectionParameters メンバーを使用してこれらの接続パラメーターを取得するコード例については、「デバイスの接続設定を取得する方法」を参照してください。

SpbTargetGetConnectionParameters メソッドを呼び出して、ターゲットデバイスを表す SPBTARGET ハンドルの接続パラメーターを取得します。このメソッドは、呼び出し元が指定したSPB_CONNECTION_PARAMETERS構造体に接続パラメーターを書き込みます。この構造体を SpbTargetGetConnectionParameters に渡す前に、 SPB_CONNECTION_PARAMETERS_INIT 関数を呼び出して構造体を初期化します。

クライアント (周辺機器ドライバー) の代わりに接続を開くには、SPB フレームワーク拡張機能 (SpbCx) によって、SPB コントローラードライバーの EvtSpbTargetConnect コールバック関数が呼び出されます。接続を閉じるには、SpbCx は SPB コントローラードライバーの EvtSpbTargetDisconnect コールバック関数を呼び出します。通常、SPB コントローラードライバーは、ドライバーの EvtSpbTargetConnect 関数から SpbTargetGetConnectionParameters を呼び出します。