GPIO_SAVE_RESTORE_BANK_HARDWARE_CONTEXT_PARAMETERS structure (gpioclx.h)

The GPIO_SAVE_RESTORE_BANK_HARDWARE_CONTEXT_PARAMETERS structure describes a bank of general-purpose I/O (GPIO) pins whose hardware state is to be saved or restored.

Syntax

typedef struct _GPIO_SAVE_RESTORE_BANK_HARDWARE_CONTEXT_PARAMETERS {
  BANK_ID                                       BankId;
  ULONG                                         State;
  GPIO_SAVE_RESTORE_BANK_HARDWARE_CONTEXT_FLAGS Flags;
} GPIO_SAVE_RESTORE_BANK_HARDWARE_CONTEXT_PARAMETERS, *PGPIO_SAVE_RESTORE_BANK_HARDWARE_CONTEXT_PARAMETERS;

Members

BankId

The identifier for this bank of GPIO pins. If N is the number of banks in the GPIO controller, BankId is an integer in the range 0 to N–1. The GPIO framework extension (GpioClx) previously obtained the number of banks in the controller from the CLIENT_QueryControllerBasicInformation event callback function. For more information, see Remarks in CLIENT_CONTROLLER_BASIC_INFORMATION.

State

The target component power state. A save operation occurs before the specified bank of GPIO pins makes the transition from the F0 (fully on) state to the target component power state, Fx. A restore operation occurs after the bank makes the transition from Fx to F0.

Flags

A set of flags to control bank hardware save and restore operations. If the CriticalTransition flag bit is set, this idle state transition is being done as part of a critical transition in which the power engine plug-in (PEP) puts the system into a low-power state.

Remarks

The Parameters parameter of the CLIENT_SaveBankHardwareContext and CLIENT_RestoreBankHardwareContext event callback functions is a pointer to a caller-allocated GPIO_SAVE_RESTORE_BANK_HARDWARE_CONTEXT_PARAMETERS structure.

Requirements

Requirement	Value
Minimum supported client	Supported starting with Windows 8.
Header	gpioclx.h

See also

CLIENT_CONTROLLER_BASIC_INFORMATION

CLIENT_QueryControllerBasicInformation

CLIENT_RestoreBankHardwareContext

CLIENT_SaveBankHardwareContext