GPIO_CLIENT_REGISTRATION_PACKET 構造体 (gpioclx.h)

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

GPIO_CLIENT_REGISTRATION_PACKET構造体には、汎用 I/O (GPIO) コントローラードライバーが GPIO フレームワーク拡張機能 (GpioClx) に渡す登録情報が含まれています。

構文

typedef struct _GPIO_CLIENT_REGISTRATION_PACKET {
  USHORT                                          Version;
  USHORT                                          Size;
  ULONG                                           Flags;
  ULONG                                           ControllerContextSize;
  ULONG64                                         Reserved;
  PGPIO_CLIENT_PREPARE_CONTROLLER                 CLIENT_PrepareController;
  PGPIO_CLIENT_RELEASE_CONTROLLER                 CLIENT_ReleaseController;
  PGPIO_CLIENT_START_CONTROLLER                   CLIENT_StartController;
  PGPIO_CLIENT_STOP_CONTROLLER                    CLIENT_StopController;
  PGPIO_CLIENT_QUERY_CONTROLLER_BASIC_INFORMATION CLIENT_QueryControllerBasicInformation;
  PGPIO_CLIENT_QUERY_SET_CONTROLLER_INFORMATION   CLIENT_QuerySetControllerInformation;
  PGPIO_CLIENT_ENABLE_INTERRUPT                   CLIENT_EnableInterrupt;
  PGPIO_CLIENT_DISABLE_INTERRUPT                  CLIENT_DisableInterrupt;
  PGPIO_CLIENT_UNMASK_INTERRUPT                   CLIENT_UnmaskInterrupt;
  PGPIO_CLIENT_MASK_INTERRUPTS                    CLIENT_MaskInterrupts;
  PGPIO_CLIENT_QUERY_ACTIVE_INTERRUPTS            CLIENT_QueryActiveInterrupts;
  PGPIO_CLIENT_CLEAR_ACTIVE_INTERRUPTS            CLIENT_ClearActiveInterrupts;
  PGPIO_CLIENT_CONNECT_IO_PINS                    CLIENT_ConnectIoPins;
  PGPIO_CLIENT_DISCONNECT_IO_PINS                 CLIENT_DisconnectIoPins;
  union {
    PGPIO_CLIENT_READ_PINS      CLIENT_ReadGpioPins;
    PGPIO_CLIENT_READ_PINS_MASK CLIENT_ReadGpioPinsUsingMask;
  };
  union {
    PGPIO_CLIENT_WRITE_PINS      CLIENT_WriteGpioPins;
    PGPIO_CLIENT_WRITE_PINS_MASK CLIENT_WriteGpioPinsUsingMask;
  };
  PGPIO_CLIENT_SAVE_BANK_HARDWARE_CONTEXT         CLIENT_SaveBankHardwareContext;
  PGPIO_CLIENT_RESTORE_BANK_HARDWARE_CONTEXT      CLIENT_RestoreBankHardwareContext;
  PGPIO_CLIENT_PRE_PROCESS_CONTROLLER_INTERRUPT   CLIENT_PreProcessControllerInterrupt;
  PGPIO_CLIENT_CONTROLLER_SPECIFIC_FUNCTION       CLIENT_ControllerSpecificFunction;
  PGPIO_CLIENT_RECONFIGURE_INTERRUPT              CLIENT_ReconfigureInterrupt;
  PGPIO_CLIENT_QUERY_ENABLED_INTERRUPTS           CLIENT_QueryEnabledInterrupts;
  PGPIO_CLIENT_CONNECT_FUNCTION_CONFIG_PINS       CLIENT_ConnectFunctionConfigPins;
  PGPIO_CLIENT_DISCONNECT_FUNCTION_CONFIG_PINS    CLIENT_DisconnectFunctionConfigPins;
} GPIO_CLIENT_REGISTRATION_PACKET, *PGPIO_CLIENT_REGISTRATION_PACKET;

メンバー

Version

GPIO コントローラードライバーがサポートする GPIO インターフェイスのバージョン番号。このメンバーを、Gpioclx.h ヘッダーファイルで定義されているGPIO_CLIENT_VERSION値に設定します。

Size

この構造体のサイズ (バイト単位)。このメンバーを sizeof(GPIO_CLIENT_REGISTRATION_PACKET) に設定します。

Flags

どの登録オプションが選択されているかを示すフラグのセット。現在、登録オプションにフラグは定義されていません。このメンバーを 0 に設定します。

ControllerContextSize

必要なデバイスコンテキストサイズ (バイト単位)。 GPIO_CLX_RegisterClient メソッドは、このサイズのデバイスコンテキストを割り当てます。 GpioClx が GPIO_CLIENT_REGISTRATION_PACKET 構造体で登録済みのコールバック関数を呼び出すと、GpioClx はこのデバイスコンテキストをパラメーターとしてコールバック関数に渡します。コールバック関数は、このコンテキストを使用して、GPIO コントローラーデバイスの状態に関するドライバーの情報にアクセスして更新します。詳細については、「 GPIO デバイスコンテキスト」を参照してください。

Reserved

将来利用するために予約されています。このメンバーを 0 に設定します。

CLIENT_PrepareController

GPIO コントローラードライバーの CLIENT_PrepareController イベントコールバック関数へのポインター。

CLIENT_ReleaseController

GPIO コントローラードライバーの CLIENT_ReleaseController イベントコールバック関数へのポインター。

CLIENT_StartController

GPIO コントローラードライバーの CLIENT_StartController イベントコールバック関数へのポインター。

CLIENT_StopController

GPIO コントローラードライバーの CLIENT_StopController イベントコールバック関数へのポインター。

CLIENT_QueryControllerBasicInformation

GPIO コントローラードライバーの CLIENT_QueryControllerBasicInformation イベントコールバック関数へのポインター。

CLIENT_QuerySetControllerInformation

GPIO コントローラードライバーの CLIENT_QuerySetControllerInformation イベントコールバック関数へのポインター。

CLIENT_EnableInterrupt

GPIO コントローラードライバーの CLIENT_EnableInterrupt イベントコールバック関数へのポインター。

CLIENT_DisableInterrupt

GPIO コントローラードライバーの CLIENT_DisableInterrupt イベントコールバック関数へのポインター。

CLIENT_UnmaskInterrupt

GPIO コントローラードライバーの CLIENT_UnmaskInterrupt イベントコールバック関数へのポインター。

CLIENT_MaskInterrupts

GPIO コントローラードライバーの CLIENT_MaskInterrupts イベントコールバック関数へのポインター。

CLIENT_QueryActiveInterrupts

GPIO コントローラードライバーの CLIENT_QueryActiveInterrupts イベントコールバック関数へのポインター。

CLIENT_ClearActiveInterrupts

GPIO コントローラードライバーの CLIENT_ClearActiveInterrupts イベントコールバック関数へのポインター。

CLIENT_ConnectIoPins

GPIO コントローラードライバーの CLIENT_ConnectIoPins イベントコールバック関数へのポインター。

CLIENT_DisconnectIoPins

GPIO コントローラードライバーの CLIENT_DisconnectIoPins イベントコールバック関数へのポインター。

CLIENT_ReadGpioPins

GPIO コントローラードライバーの CLIENT_ReadGpioPins イベントコールバック関数へのポインター。

CLIENT_ReadGpioPinsUsingMask

GPIO コントローラードライバーの CLIENT_ReadGpioPinsUsingMask イベントコールバック関数へのポインター。

CLIENT_WriteGpioPins

GPIO コントローラードライバーの CLIENT_WriteGpioPins イベントコールバック関数へのポインター。

CLIENT_WriteGpioPinsUsingMask

GPIO コントローラードライバーの CLIENT_WriteGpioPinsUsingMask イベントコールバック関数へのポインター。

CLIENT_SaveBankHardwareContext

GPIO コントローラードライバーの CLIENT_SaveBankHardwareContext イベントコールバック関数へのポインター。

CLIENT_RestoreBankHardwareContext

GPIO コントローラードライバーの CLIENT_RestoreBankHardwareContext イベントコールバック関数へのポインター。

CLIENT_PreProcessControllerInterrupt

GPIO コントローラードライバーの CLIENT_PreProcessControllerInterrupt イベントコールバック関数へのポインター。

CLIENT_ControllerSpecificFunction

GPIO コントローラードライバーの CLIENT_ControllerSpecificFunction イベントコールバック関数へのポインター。

CLIENT_ReconfigureInterrupt

GPIO コントローラードライバーの CLIENT_ReconfigureInterrupt イベントコールバック関数へのポインター。

CLIENT_QueryEnabledInterrupts

GPIO コントローラードライバーの CLIENT_QueryEnabledInterrupts イベントコールバック関数へのポインター。このメンバーは、Windows 8.1 以降でサポートされています。

CLIENT_ConnectFunctionConfigPins

CLIENT_DisconnectFunctionConfigPins

注釈

GPIO コントローラードライバーは、GPIO_CLX_RegisterClient メソッドへの入力パラメーターとして、GPIO_CLIENT_REGISTRATION_PACKET構造体へのポインターを渡します。このメソッドは、GpioClx によって提供されるサービスを使用するようにドライバーを登録します。通常、ドライバーは DriverEntry ルーチンからこのメソッドを呼び出します。

GPIO_CLIENT_REGISTRATION_PACKET構造体には、2 つの名前のない共用体が含まれています。各共用体には、2 つの代替タイプのイベントコールバック関数のいずれかを指すポインターを含めることができます。いずれの場合も、GPIO コントローラードライバーは、GPIO コントローラーハードウェアに最適なコールバック関数の種類を実装する必要があります。 GPIO コントローラードライバーの CLIENT_QueryControllerBasicInformation コールバック関数は、実装されるコールバック関数を GpioClx に通知します。

GPIO コントローラードライバーが一連のコールバックを登録するために GPIO_CLX_RegisterClient を呼び出した後、GpioClx はドライバーの CLIENT_QueryControllerBasicInformation コールバック関数を呼び出して、GPIO コントローラーのハードウェア属性と構成データを含む CLIENT_CONTROLLER_BASIC_INFORMATION 構造を取得します。 GpioClx はこの情報を使用して、GPIO コントローラードライバーが実装したコールバック関数を決定します。

GPIO コントローラードライバーがCLIENT_ReadGpioPinsおよびCLIENT_WriteGpioPinsコールバック関数を実装する場合、CLIENT_QueryControllerBasicInformationコールバック関数は、このCLIENT_CONTROLLER_BASIC_INFORMATION構造体の Flags メンバーの FormatIoRequestsAsMasks フラグビットを 0 に設定する必要があります。

CLIENT_QueryControllerBasicInformationコールバック関数が FormatIoRequestsAsMasks フラグビットを 1 に設定した場合、この値は、ドライバーがCLIENT_ReadGpioPinsUsingMaskおよびCLIENT_WriteGpioPinsUsingMaskコールバック関数を実装することを示します。

GpioClx では、特定のコールバック関数を実装するために GPIO コントローラードライバーが必要ですが、他のコールバック関数のサポートは省略可能です。詳細については、「省略可能な GPIO コールバック関数」と「必要な GPIO コールバック関数」を参照してください。