структура GPIO_CLIENT_REGISTRATION_PACKET (gpioclx.h)

Статья
08/07/2023

Структура GPIO_CLIENT_REGISTRATION_PACKET содержит сведения о регистрации, которые драйвер контроллера 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. Присвойте этому элементу значение GPIO_CLIENT_VERSION, определенное в файле заголовка Gpioclx.h.

Size

Размер данной структуры (в байтах). Задайте для этого элемента значение sizeof(GPIO_CLIENT_REGISTRATION_PACKET).

Flags

Набор флагов, указывающих, какие параметры регистрации выбраны. В настоящее время для параметров регистрации не определены флаги. Присвойте этому элементу значение ноль.

ControllerContextSize

Требуемый размер контекста устройства в байтах. Метод GPIO_CLX_RegisterClient выделяет контекст устройства такого размера. Когда GpioClx вызывает любую зарегистрированную функцию обратного вызова в структуре GPIO_CLIENT_REGISTRATION_PACKET , GpioClx передает этот контекст устройства в функцию обратного вызова в качестве параметра. Функции обратного вызова используют этот контекст для доступа и обновления сведений драйвера о состоянии устройства контроллера GPIO. Дополнительные сведения см. в разделе Контексты устройств GPIO.

Reserved

Зарезервировано для последующего использования. Присвойте этому элементу значение ноль.

CLIENT_PrepareController

Указатель на функцию обратного вызова события CLIENT_PrepareController драйвера контроллера GPIO.

CLIENT_ReleaseController

Указатель на функцию обратного вызова события CLIENT_ReleaseController драйвера контроллера GPIO.

CLIENT_StartController

Указатель на функцию обратного вызова события CLIENT_StartController драйвера контроллера GPIO.

CLIENT_StopController

Указатель на функцию обратного вызова события CLIENT_StopController драйвера контроллера GPIO.

CLIENT_QueryControllerBasicInformation

Указатель на функцию обратного вызова события CLIENT_QueryControllerBasicInformation драйвера контроллера GPIO.

CLIENT_QuerySetControllerInformation

Указатель на функцию обратного вызова события CLIENT_QuerySetControllerInformation драйвера контроллера GPIO.

CLIENT_EnableInterrupt

Указатель на функцию обратного вызова события CLIENT_EnableInterrupt драйвера контроллера GPIO.

CLIENT_DisableInterrupt

Указатель на функцию обратного вызова события CLIENT_DisableInterrupt драйвера контроллера GPIO.

CLIENT_UnmaskInterrupt

Указатель на функцию обратного вызова события CLIENT_UnmaskInterrupt драйвера контроллера GPIO.

CLIENT_MaskInterrupts

Указатель на функцию обратного вызова события CLIENT_MaskInterrupts драйвера контроллера GPIO.

CLIENT_QueryActiveInterrupts

Указатель на функцию обратного вызова события CLIENT_QueryActiveInterrupts драйвера контроллера GPIO.

CLIENT_ClearActiveInterrupts

Указатель на функцию обратного вызова события CLIENT_ClearActiveInterrupts драйвера контроллера GPIO.

CLIENT_ConnectIoPins

Указатель на функцию обратного вызова события CLIENT_ConnectIoPins драйвера контроллера GPIO.

CLIENT_DisconnectIoPins

Указатель на функцию обратного вызова события CLIENT_DisconnectIoPins драйвера контроллера GPIO.

CLIENT_ReadGpioPins

Указатель на функцию обратного вызова события CLIENT_ReadGpioPins драйвера контроллера GPIO.

CLIENT_ReadGpioPinsUsingMask

Указатель на функцию обратного вызова события CLIENT_ReadGpioPinsUsingMask драйвера контроллера GPIO.

CLIENT_WriteGpioPins

Указатель на функцию обратного вызова события CLIENT_WriteGpioPins драйвера контроллера GPIO.

CLIENT_WriteGpioPinsUsingMask

Указатель на функцию обратного вызова события CLIENT_WriteGpioPinsUsingMask драйвера контроллера GPIO.

CLIENT_SaveBankHardwareContext

Указатель на функцию обратного вызова события CLIENT_SaveBankHardwareContext драйвера контроллера GPIO.

CLIENT_RestoreBankHardwareContext

Указатель на функцию обратного вызова события CLIENT_RestoreBankHardwareContext драйвера контроллера GPIO.

CLIENT_PreProcessControllerInterrupt

Указатель на функцию обратного вызова события CLIENT_PreProcessControllerInterrupt драйвера контроллера GPIO.

CLIENT_ControllerSpecificFunction

Указатель на функцию обратного вызова события CLIENT_ControllerSpecificFunction драйвера контроллера GPIO.

CLIENT_ReconfigureInterrupt

Указатель на функцию обратного вызова события CLIENT_ReconfigureInterrupt драйвера контроллера GPIO.

CLIENT_QueryEnabledInterrupts

Указатель на функцию обратного вызова события CLIENT_QueryEnabledInterrupts драйвера контроллера GPIO. Этот элемент поддерживается, начиная с Windows 8.1.

CLIENT_ConnectFunctionConfigPins

CLIENT_DisconnectFunctionConfigPins

Драйвер контроллера GPIO передает указатель на структуру GPIO_CLIENT_REGISTRATION_PACKET в качестве входного параметра в метод GPIO_CLX_RegisterClient . Этот метод регистрирует драйвер для использования служб, предоставляемых GpioClx. Как правило, драйвер вызывает этот метод из своей подпрограммы DriverEntry .

Структура GPIO_CLIENT_REGISTRATION_PACKET содержит два неименованных объединения. Каждое объединение может содержать указатель на один из двух альтернативных типов функций обратного вызова событий. В каждом случае драйвер контроллера GPIO должен реализовывать тип функции обратного вызова, которая лучше всего подходит для оборудования контроллера GPIO. Функция обратного вызова драйвера контроллера GPIO CLIENT_QueryControllerBasicInformation сообщает GpioClx, какие функции обратного вызова реализованы.

После того как драйвер контроллера GPIO вызывает GPIO_CLX_RegisterClient для регистрации набора обратных вызовов, GpioClx вызывает функцию обратного вызова CLIENT_QueryControllerBasicInformation драйвера для получения структуры CLIENT_CONTROLLER_BASIC_INFORMATION , содержащей аппаратные атрибуты контроллера GPIO и данные конфигурации. GpioClx использует эти сведения для определения функций обратного вызова, реализованных драйвером контроллера GPIO.

Если драйвер контроллера GPIO реализует CLIENT_ReadGpioPins и CLIENT_WriteGpioPins функции обратного вызова, функция обратного вызова CLIENT_QueryControllerBasicInformation должна задать бит флага FormatIoRequestsAsMasks в элементе Flags структуры CLIENT_CONTROLLER_BASIC_INFORMATION значение 0.

Если функция обратного вызова CLIENT_QueryControllerBasicInformation устанавливает бит флага FormatIoRequestsAsMasks равным 1, это значение указывает, что драйвер реализует CLIENT_ReadGpioPinsUsingMask и CLIENT_WriteGpioPinsUsingMask функции обратного вызова.

Для реализации определенных функций обратного вызова GpioClx требуется драйвер контроллера GPIO, но поддержка других функций обратного вызова является необязательной. Дополнительные сведения см. в разделах Необязательные и обязательные функции обратного вызова GPIO.