Setup.h

Go to the documentation of this file.

 
#ifndef _SETUP_H_
#define _SETUP_H_
 
#include <PiDxe.h>
 
#include <Protocol/SimpleTextOut.h>
#include <Protocol/SimpleTextIn.h>
#include <Protocol/FormBrowser2.h>
#include <Protocol/FormBrowserEx2.h>
#include <Protocol/DisplayProtocol.h>
#include <Protocol/DevicePath.h>
#include <Protocol/UnicodeCollation.h>
#include <Protocol/HiiConfigAccess.h>
#include <Protocol/HiiConfigRouting.h>
#include <Protocol/HiiDatabase.h>
#include <Protocol/HiiString.h>
#include <Protocol/UserManager.h>
#include <Protocol/DevicePathFromText.h>
#include <Protocol/RegularExpressionProtocol.h>
 
#include <Guid/MdeModuleHii.h>
#include <Guid/HiiPlatformSetupFormset.h>
#include <Guid/HiiFormMapMethodGuid.h>
#include <Guid/ZeroGuid.h>
 
#include <Library/PrintLib.h>
#include <Library/DebugLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/UefiRuntimeServicesTableLib.h>
#include <Library/UefiDriverEntryPoint.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/BaseLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/HiiLib.h>
#include <Library/PcdLib.h>
#include <Library/DevicePathLib.h>
#include <Library/UefiLib.h>
 
//
// This is the generated header file which includes whatever needs to be exported (strings + IFR)
//
 
#define UI_ACTION_NONE             0
#define UI_ACTION_REFRESH_FORM     1
#define UI_ACTION_REFRESH_FORMSET  2
#define UI_ACTION_EXIT             3
 
//
//
// Time definitions
//
#define ONE_SECOND  10000000
 
// Incremental string lenght of ConfigRequest
//
#define CONFIG_REQUEST_STRING_INCREMENTAL  1024
 
//
// Incremental size of stack for expression
//
#define EXPRESSION_STACK_SIZE_INCREMENT  0x100
 
#define EFI_IFR_SPECIFICATION_VERSION  (UINT16) (((EFI_SYSTEM_TABLE_REVISION >> 16) << 8) | (((EFI_SYSTEM_TABLE_REVISION & 0xFFFF) / 10) << 4) | ((EFI_SYSTEM_TABLE_REVISION & 0xFFFF) % 10))
 
#define SETUP_DRIVER_SIGNATURE  SIGNATURE_32 ('F', 'B', 'D', 'V')
typedef struct {
  UINT32                                    Signature;
 
  EFI_HANDLE                                Handle;
 
  //
  // Produced protocol
  //
  EFI_FORM_BROWSER2_PROTOCOL                FormBrowser2;
  EDKII_FORM_BROWSER_EXTENSION_PROTOCOL     FormBrowserEx;
 
  EDKII_FORM_BROWSER_EXTENSION2_PROTOCOL    FormBrowserEx2;
} SETUP_DRIVER_PRIVATE_DATA;
 
//
// IFR relative definition
//
#define EFI_HII_EXPRESSION_INCONSISTENT_IF  0
#define EFI_HII_EXPRESSION_NO_SUBMIT_IF     1
#define EFI_HII_EXPRESSION_GRAY_OUT_IF      2
#define EFI_HII_EXPRESSION_SUPPRESS_IF      3
#define EFI_HII_EXPRESSION_DISABLE_IF       4
#define EFI_HII_EXPRESSION_VALUE            5
#define EFI_HII_EXPRESSION_RULE             6
#define EFI_HII_EXPRESSION_READ             7
#define EFI_HII_EXPRESSION_WRITE            8
#define EFI_HII_EXPRESSION_WARNING_IF       9
 
#define EFI_HII_VARSTORE_BUFFER               0
#define EFI_HII_VARSTORE_NAME_VALUE           1
#define EFI_HII_VARSTORE_EFI_VARIABLE         2   // EFI Varstore type follow UEFI spec before 2.3.1.
#define EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER  3   // EFI varstore type follow UEFI spec 2.3.1 and later.
 
#define FORM_INCONSISTENT_VALIDATION  0
#define FORM_NO_SUBMIT_VALIDATION     1
 
#define NAME_VALUE_NODE_SIGNATURE  SIGNATURE_32 ('N', 'V', 'S', 'T')
 
typedef struct {
  UINTN         Signature;
  LIST_ENTRY    Link;
  CHAR16        *Name;
  CHAR16        *Value;
  CHAR16        *EditValue;
} NAME_VALUE_NODE;
 
#define NAME_VALUE_NODE_FROM_LINK(a)  CR (a, NAME_VALUE_NODE, Link, NAME_VALUE_NODE_SIGNATURE)
 
#define BROWSER_STORAGE_SIGNATURE  SIGNATURE_32 ('B', 'S', 'T', 'G')
 
typedef struct {
  UINTN             Signature;
  LIST_ENTRY        Link;
 
  UINT8             Type;          // Storage type
 
  BOOLEAN           Initialized;   // Whether this varstore is initialized, efi varstore not used.
 
  EFI_HII_HANDLE    HiiHandle;     // HiiHandle for this varstore, efi varstore not used.
  EFI_GUID          Guid;
 
  CHAR16            *Name;         // For EFI_IFR_VARSTORE
  UINT16            Size;
  UINT8             *Buffer;
  UINT8             *EditBuffer;   // Edit copy for Buffer Storage
 
  LIST_ENTRY        NameValueListHead; // List of NAME_VALUE_NODE
 
  UINT32            Attributes;    // For EFI_IFR_VARSTORE_EFI: EFI Variable attribute
 
  CHAR16            *ConfigRequest; // <ConfigRequest> = <ConfigHdr> + <RequestElement>
                                    // <RequestElement> includes all fields which is used by current form sets.
  UINTN             SpareStrLen;    // Spare length of ConfigRequest string buffer
} BROWSER_STORAGE;
 
#define BROWSER_STORAGE_FROM_LINK(a)  CR (a, BROWSER_STORAGE, Link, BROWSER_STORAGE_SIGNATURE)
 
#define FORMSET_STORAGE_SIGNATURE  SIGNATURE_32 ('F', 'S', 'T', 'G')
 
typedef struct {
  UINTN              Signature;
  LIST_ENTRY         Link;
 
  LIST_ENTRY         SaveFailLink;
 
  UINT16             VarStoreId;
 
  BROWSER_STORAGE    *BrowserStorage;
 
  CHAR16             *ConfigHdr;   // <ConfigHdr>
 
  CHAR16             *ConfigRequest;        // <ConfigRequest> = <ConfigHdr> + <RequestElement>
  CHAR16             *ConfigAltResp;        // Alt config response string for this ConfigRequest.
  BOOLEAN            HasCallAltCfg;         // Flag to show whether browser has call ExtractConfig to get Altcfg string.
  UINTN              ElementCount;          // Number of <RequestElement> in the <ConfigRequest>
  UINTN              SpareStrLen;           // Spare length of ConfigRequest string buffer
  CHAR16             *RestoreConfigRequest; // When submit formset fail, the element need to be restored
  CHAR16             *SyncConfigRequest;    // When submit formset fail, the element need to be synced
} FORMSET_STORAGE;
 
#define FORMSET_STORAGE_FROM_LINK(a)            CR (a, FORMSET_STORAGE, Link, FORMSET_STORAGE_SIGNATURE)
#define FORMSET_STORAGE_FROM_SAVE_FAIL_LINK(a)  CR (a, FORMSET_STORAGE, SaveFailLink, FORMSET_STORAGE_SIGNATURE)
 
typedef union {
  EFI_STRING_ID    VarName;
  UINT16           VarOffset;
} VAR_STORE_INFO;
 
#define EXPRESSION_OPCODE_SIGNATURE  SIGNATURE_32 ('E', 'X', 'O', 'P')
 
typedef struct {
  UINTN              Signature;
  LIST_ENTRY         Link;
 
  UINT8              Operand;
 
  UINT8              Format;     // For EFI_IFR_TO_STRING, EFI_IFR_FIND
  UINT8              Flags;      // For EFI_IFR_SPAN
  UINT8              RuleId;     // For EFI_IFR_RULE_REF
 
  EFI_HII_VALUE      Value;      // For EFI_IFR_EQ_ID_VAL, EFI_IFR_UINT64, EFI_IFR_UINT32, EFI_IFR_UINT16, EFI_IFR_UINT8, EFI_IFR_STRING_REF1
 
  EFI_QUESTION_ID    QuestionId; // For EFI_IFR_EQ_ID_ID, EFI_IFR_EQ_ID_VAL_LIST, EFI_IFR_QUESTION_REF1
  EFI_QUESTION_ID    QuestionId2;
 
  UINT16             ListLength; // For EFI_IFR_EQ_ID_VAL_LIST
  UINT16             *ValueList;
 
  EFI_STRING_ID      DevicePath; // For EFI_IFR_QUESTION_REF3_2, EFI_IFR_QUESTION_REF3_3
  EFI_GUID           Guid;
 
  BROWSER_STORAGE    *VarStorage;       // For EFI_IFR_SET, EFI_IFR_GET
  VAR_STORE_INFO     VarStoreInfo;      // For EFI_IFR_SET, EFI_IFR_GET
  UINT8              ValueType;         // For EFI_IFR_SET, EFI_IFR_GET
  UINT8              ValueWidth;        // For EFI_IFR_SET, EFI_IFR_GET
  CHAR16             *ValueName;        // For EFI_IFR_SET, EFI_IFR_GET
  LIST_ENTRY         MapExpressionList; // nested expressions inside of Map opcode.
} EXPRESSION_OPCODE;
 
#define EXPRESSION_OPCODE_FROM_LINK(a)  CR (a, EXPRESSION_OPCODE, Link, EXPRESSION_OPCODE_SIGNATURE)
 
#define FORM_EXPRESSION_SIGNATURE  SIGNATURE_32 ('F', 'E', 'X', 'P')
 
typedef struct {
  UINTN                Signature;
  LIST_ENTRY           Link;
 
  UINT8                Type;         // Type for this expression
 
  UINT8                RuleId;       // For EFI_IFR_RULE only
  EFI_STRING_ID        Error;        // For EFI_IFR_NO_SUBMIT_IF, EFI_IFR_INCONSISTENT_IF only
 
  EFI_HII_VALUE        Result;       // Expression evaluation result
 
  UINT8                TimeOut;      // For EFI_IFR_WARNING_IF
  EFI_IFR_OP_HEADER    *OpCode;      // Save the opcode buffer.
 
  LIST_ENTRY           OpCodeListHead; // OpCodes consist of this expression (EXPRESSION_OPCODE)
} FORM_EXPRESSION;
 
#define FORM_EXPRESSION_FROM_LINK(a)  CR (a, FORM_EXPRESSION, Link, FORM_EXPRESSION_SIGNATURE)
 
#define FORM_EXPRESSION_LIST_SIGNATURE  SIGNATURE_32 ('F', 'E', 'X', 'R')
 
typedef struct {
  UINTN              Signature;
  UINTN              Count;
  FORM_EXPRESSION    *Expression[1];     // Array[Count] of expressions
} FORM_EXPRESSION_LIST;
 
#define QUESTION_DEFAULT_SIGNATURE  SIGNATURE_32 ('Q', 'D', 'F', 'T')
 
typedef struct {
  UINTN              Signature;
  LIST_ENTRY         Link;
 
  UINT16             DefaultId;
  EFI_HII_VALUE      Value;               // Default value
 
  FORM_EXPRESSION    *ValueExpression;    // Not-NULL indicates default value is provided by EFI_IFR_VALUE
} QUESTION_DEFAULT;
 
#define QUESTION_DEFAULT_FROM_LINK(a)  CR (a, QUESTION_DEFAULT, Link, QUESTION_DEFAULT_SIGNATURE)
 
#define QUESTION_OPTION_SIGNATURE  SIGNATURE_32 ('Q', 'O', 'P', 'T')
 
typedef struct {
  UINTN                    Signature;
  LIST_ENTRY               Link;
 
  EFI_IFR_ONE_OF_OPTION    *OpCode; // OneOfOption Data
 
  EFI_STRING_ID            Text;
  UINT8                    Flags;
  EFI_HII_VALUE            Value;
  EFI_IMAGE_ID             ImageId;
 
  FORM_EXPRESSION_LIST     *SuppressExpression; // Non-NULL indicates nested inside of SuppressIf
} QUESTION_OPTION;
 
#define QUESTION_OPTION_FROM_LINK(a)  CR (a, QUESTION_OPTION, Link, QUESTION_OPTION_SIGNATURE)
 
typedef enum {
  ExpressFalse = 0,
  ExpressGrayOut,
  ExpressSuppress,
  ExpressDisable
} EXPRESS_RESULT;
 
typedef enum {
  ExpressNone = 0,
  ExpressForm,
  ExpressStatement,
  ExpressOption
} EXPRESS_LEVEL;
 
typedef struct _FORM_BROWSER_STATEMENT FORM_BROWSER_STATEMENT;
 
#define FORM_BROWSER_STATEMENT_SIGNATURE  SIGNATURE_32 ('F', 'S', 'T', 'A')
 
struct _FORM_BROWSER_STATEMENT {
  UINTN                     Signature;
  LIST_ENTRY                Link;
 
  UINT8                     Operand;      // The operand (first byte) of this Statement or Question
  EFI_IFR_OP_HEADER         *OpCode;
 
  //
  // Statement Header
  //
  EFI_STRING_ID             Prompt;
  EFI_STRING_ID             Help;
  EFI_STRING_ID             TextTwo;      // For EFI_IFR_TEXT
 
  //
  // Fake Question Id, used for statement not has true QuestionId.
  //
  EFI_QUESTION_ID           FakeQuestionId;
 
  //
  // Question Header
  //
  EFI_QUESTION_ID           QuestionId;   // The value of zero is reserved
  EFI_VARSTORE_ID           VarStoreId;   // A value of zero indicates no variable storage
  BROWSER_STORAGE           *Storage;
  VAR_STORE_INFO            VarStoreInfo;
  UINT16                    StorageWidth;
  UINT16                    BitStorageWidth;
  UINT16                    BitVarOffset;
  UINT8                     QuestionFlags;
  BOOLEAN                   QuestionReferToBitField; // Whether the question is stored in a bit field.
  CHAR16                    *VariableName;           // Name/Value or EFI Variable name
  CHAR16                    *BlockName;              // Buffer storage block name: "OFFSET=...WIDTH=..."
 
  EFI_HII_VALUE             HiiValue;     // Edit copy for checkbox, numberic, oneof
  UINT8                     *BufferValue; // Edit copy for string, password, orderedlist
  UINT8                     ValueType;    // Data type for orderedlist value array
 
  //
  // OpCode specific members
  //
  UINT8                     Flags;         // for EFI_IFR_CHECKBOX, EFI_IFR_DATE, EFI_IFR_NUMERIC, EFI_IFR_ONE_OF,
                                           // EFI_IFR_ORDERED_LIST, EFI_IFR_STRING,EFI_IFR_SUBTITLE,EFI_IFR_TIME, EFI_IFR_BANNER
  UINT8                     MaxContainers; // for EFI_IFR_ORDERED_LIST
 
  UINT16                    BannerLineNumber; // for EFI_IFR_BANNER, 1-based line number
  EFI_STRING_ID             QuestionConfig;   // for EFI_IFR_ACTION, if 0 then no configuration string will be processed
 
  UINT64                    Minimum;      // for EFI_IFR_ONE_OF/EFI_IFR_NUMERIC, it's Min/Max value
  UINT64                    Maximum;      // for EFI_IFR_STRING/EFI_IFR_PASSWORD, it's Min/Max length
  UINT64                    Step;
 
  EFI_DEFAULT_ID            DefaultId;    // for EFI_IFR_RESET_BUTTON
  EFI_GUID                  RefreshGuid;  // for EFI_IFR_REFRESH_ID
  BOOLEAN                   Locked;       // Whether this statement is locked.
  BOOLEAN                   ValueChanged; // Whether this statement's value is changed.
  //
  // Get from IFR parsing
  //
  FORM_EXPRESSION           *ValueExpression; // nested EFI_IFR_VALUE, provide Question value and indicate Question is ReadOnly
  LIST_ENTRY                DefaultListHead;  // nested EFI_IFR_DEFAULT list (QUESTION_DEFAULT), provide default values
  LIST_ENTRY                OptionListHead;   // nested EFI_IFR_ONE_OF_OPTION list (QUESTION_OPTION)
 
  EFI_IMAGE_ID              ImageId;         // nested EFI_IFR_IMAGE
  UINT8                     RefreshInterval; // nested EFI_IFR_REFRESH, refresh interval(in seconds) for Question value, 0 means no refresh
 
  FORM_BROWSER_STATEMENT    *ParentStatement;
 
  LIST_ENTRY                InconsistentListHead; // nested inconsistent expression list (FORM_EXPRESSION)
  LIST_ENTRY                NoSubmitListHead;     // nested nosubmit expression list (FORM_EXPRESSION)
  LIST_ENTRY                WarningListHead;      // nested warning expression list (FORM_EXPRESSION)
  FORM_EXPRESSION_LIST      *Expression;          // nesting inside of GrayOutIf/DisableIf/SuppressIf
 
  FORM_EXPRESSION           *ReadExpression;  // nested EFI_IFR_READ, provide this question value by read expression.
  FORM_EXPRESSION           *WriteExpression; // nested EFI_IFR_WRITE, evaluate write expression after this question value is set.
};
 
#define FORM_BROWSER_STATEMENT_FROM_LINK(a)  CR (a, FORM_BROWSER_STATEMENT, Link, FORM_BROWSER_STATEMENT_SIGNATURE)
 
#define FORM_BROWSER_CONFIG_REQUEST_SIGNATURE  SIGNATURE_32 ('F', 'C', 'R', 'S')
typedef struct {
  UINTN              Signature;
  LIST_ENTRY         Link;
 
  LIST_ENTRY         SaveFailLink;
 
  CHAR16             *ConfigRequest;    // <ConfigRequest> = <ConfigHdr> + <RequestElement>
  CHAR16             *ConfigAltResp;    // Alt config response string for this ConfigRequest.
  UINTN              ElementCount;      // Number of <RequestElement> in the <ConfigRequest>
  UINTN              SpareStrLen;
  CHAR16             *RestoreConfigRequest;    // When submit form fail, the element need to be restored
  CHAR16             *SyncConfigRequest;       // When submit form fail, the element need to be synced
 
  BROWSER_STORAGE    *Storage;
} FORM_BROWSER_CONFIG_REQUEST;
#define FORM_BROWSER_CONFIG_REQUEST_FROM_LINK(a)            CR (a, FORM_BROWSER_CONFIG_REQUEST, Link, FORM_BROWSER_CONFIG_REQUEST_SIGNATURE)
#define FORM_BROWSER_CONFIG_REQUEST_FROM_SAVE_FAIL_LINK(a)  CR (a, FORM_BROWSER_CONFIG_REQUEST, SaveFailLink, FORM_BROWSER_CONFIG_REQUEST_SIGNATURE)
 
#define FORM_BROWSER_FORM_SIGNATURE  SIGNATURE_32 ('F', 'F', 'R', 'M')
#define STANDARD_MAP_FORM_TYPE       0x01
 
typedef struct {
  UINTN                   Signature;
  LIST_ENTRY              Link;
 
  UINT16                  FormId;            // FormId of normal form or formmap form.
  EFI_STRING_ID           FormTitle;         // FormTile of normal form, or FormMapMethod title of formmap form.
  UINT16                  FormType;          // Specific form type for the different form.
 
  EFI_IMAGE_ID            ImageId;
 
  BOOLEAN                 ModalForm;         // Whether this is a modal form.
  BOOLEAN                 Locked;            // Whether this form is locked.
  EFI_GUID                RefreshGuid;       // Form refresh event guid.
 
  LIST_ENTRY              FormViewListHead;    // List of type FORMID_INFO is Browser View Form History List.
  LIST_ENTRY              ExpressionListHead;  // List of Expressions (FORM_EXPRESSION)
  LIST_ENTRY              StatementListHead;   // List of Statements and Questions (FORM_BROWSER_STATEMENT)
  LIST_ENTRY              ConfigRequestHead;   // List of configreques for all storage.
  FORM_EXPRESSION_LIST    *SuppressExpression; // nesting inside of SuppressIf
} FORM_BROWSER_FORM;
 
#define FORM_BROWSER_FORM_FROM_LINK(a)  CR (a, FORM_BROWSER_FORM, Link, FORM_BROWSER_FORM_SIGNATURE)
 
#define FORMSET_DEFAULTSTORE_SIGNATURE  SIGNATURE_32 ('F', 'D', 'F', 'S')
 
typedef struct {
  UINTN            Signature;
  LIST_ENTRY       Link;
 
  UINT16           DefaultId;
  EFI_STRING_ID    DefaultName;
} FORMSET_DEFAULTSTORE;
 
#define FORMSET_DEFAULTSTORE_FROM_LINK(a)  CR (a, FORMSET_DEFAULTSTORE, Link, FORMSET_DEFAULTSTORE_SIGNATURE)
 
#define FORM_BROWSER_FORMSET_SIGNATURE  SIGNATURE_32 ('F', 'B', 'F', 'S')
 
typedef struct {
  UINTN                             Signature;
  LIST_ENTRY                        Link;
  LIST_ENTRY                        SaveFailLink;
 
  EFI_HII_HANDLE                    HiiHandle;    // unique id for formset.
  EFI_HANDLE                        DriverHandle;
  EFI_HII_CONFIG_ACCESS_PROTOCOL    *ConfigAccess;
  EFI_DEVICE_PATH_PROTOCOL          *DevicePath;
 
  UINTN                             IfrBinaryLength;
  UINT8                             *IfrBinaryData;
 
  BOOLEAN                           QuestionInited; // Have finished question initilization?
  EFI_GUID                          Guid;
  EFI_STRING_ID                     FormSetTitle;
  EFI_STRING_ID                     Help;
  UINT8                             NumberOfClassGuid;
  EFI_GUID                          ClassGuid[3];       // Up to three ClassGuid
  UINT16                            Class;              // Tiano extended Class code
  UINT16                            SubClass;           // Tiano extended Subclass code
  EFI_IMAGE_ID                      ImageId;
  EFI_IFR_OP_HEADER                 *OpCode;            // mainly for formset op to get ClassGuid
 
  FORM_BROWSER_STATEMENT            *StatementBuffer;   // Buffer for all Statements and Questions
  EXPRESSION_OPCODE                 *ExpressionBuffer;  // Buffer for all Expression OpCode
  FORM_BROWSER_FORM                 *SaveFailForm;      // The form which failed to save.
  FORM_BROWSER_STATEMENT            *SaveFailStatement; // The Statement which failed to save.
 
  LIST_ENTRY                        StatementListOSF;        // Statement list out side of the form.
  LIST_ENTRY                        StorageListHead;         // Storage list (FORMSET_STORAGE)
  LIST_ENTRY                        SaveFailStorageListHead; // Storage list for the save fail storage.
  LIST_ENTRY                        DefaultStoreListHead;    // DefaultStore list (FORMSET_DEFAULTSTORE)
  LIST_ENTRY                        FormListHead;            // Form list (FORM_BROWSER_FORM)
  LIST_ENTRY                        ExpressionListHead;      // List of Expressions (FORM_EXPRESSION)
} FORM_BROWSER_FORMSET;
#define FORM_BROWSER_FORMSET_FROM_LINK(a)  CR (a, FORM_BROWSER_FORMSET, Link, FORM_BROWSER_FORMSET_SIGNATURE)
 
#define FORM_BROWSER_FORMSET_FROM_SAVE_FAIL_LINK(a)  CR (a, FORM_BROWSER_FORMSET, SaveFailLink, FORM_BROWSER_FORMSET_SIGNATURE)
 
typedef struct {
  LIST_ENTRY    Link;
  EFI_EVENT     RefreshEvent;
} FORM_BROWSER_REFRESH_EVENT_NODE;
 
#define FORM_BROWSER_REFRESH_EVENT_FROM_LINK(a)  BASE_CR (a, FORM_BROWSER_REFRESH_EVENT_NODE, Link)
 
typedef struct {
  EFI_HII_HANDLE            Handle;
 
  //
  // Target formset/form/Question information
  //
  EFI_GUID                  FormSetGuid;
  UINT16                    FormId;
  UINT16                    QuestionId;
  UINTN                     Sequence; // used for time/date only.
 
  UINTN                     TopRow;
  UINTN                     BottomRow;
  UINTN                     PromptCol;
  UINTN                     OptionCol;
  UINTN                     CurrentRow;
 
  //
  // Ation for Browser to taken:
  //   UI_ACTION_NONE            - navigation inside a form
  //   UI_ACTION_REFRESH_FORM    - re-evaluate expressions and repaint form
  //   UI_ACTION_REFRESH_FORMSET - re-parse formset IFR binary
  //
  UINTN                     Action;
 
  //
  // Current selected fomset/form/Question
  //
  FORM_BROWSER_FORMSET      *FormSet;
  FORM_BROWSER_FORM         *Form;
  FORM_BROWSER_STATEMENT    *Statement;
 
  //
  // Whether the Form is editable
  //
  BOOLEAN                   FormEditable;
 
  FORM_ENTRY_INFO           *CurrentMenu;
} UI_MENU_SELECTION;
 
#define BROWSER_CONTEXT_SIGNATURE  SIGNATURE_32 ('B', 'C', 'T', 'X')
 
typedef struct {
  UINTN                   Signature;
  LIST_ENTRY              Link;
 
  //
  // Globals defined in Setup.c
  //
  BOOLEAN                 FlagReconnect;
  BOOLEAN                 CallbackReconnect;
  BOOLEAN                 ResetRequired;
  BOOLEAN                 ExitRequired;
  EFI_HII_HANDLE          HiiHandle;
  EFI_GUID                FormSetGuid;
  EFI_FORM_ID             FormId;
  UI_MENU_SELECTION       *Selection;
  FORM_BROWSER_FORMSET    *SystemLevelFormSet;
  EFI_QUESTION_ID         CurFakeQestId;
  BOOLEAN                 HiiPackageListUpdated;
  BOOLEAN                 FinishRetrieveCall;
  LIST_ENTRY              FormHistoryList;
  LIST_ENTRY              FormSetList;
} BROWSER_CONTEXT;
 
#define BROWSER_CONTEXT_FROM_LINK(a)  CR (a, BROWSER_CONTEXT, Link, BROWSER_CONTEXT_SIGNATURE)
 
//
// Scope for get defaut value. It may be GetDefaultForNoStorage, GetDefaultForStorage or GetDefaultForAll.
//
typedef enum {
  GetDefaultForNoStorage,       // Get default value for question which not has storage.
  GetDefaultForStorage,         // Get default value for question which has storage.
  GetDefaultForAll,             // Get default value for all questions.
  GetDefaultForMax              // Invalid value.
} BROWSER_GET_DEFAULT_VALUE;
 
//
// Get/set question value from/to.
//
typedef enum {
  GetSetValueWithEditBuffer = 0,   // Get/Set question value from/to editbuffer in the storage.
  GetSetValueWithBuffer,           // Get/Set question value from/to buffer in the storage.
  GetSetValueWithHiiDriver,        // Get/Set question value from/to hii driver.
  GetSetValueWithBothBuffer,       // Compare the editbuffer with buffer for this question, not use the question value.
  GetSetValueWithMax               // Invalid value.
} GET_SET_QUESTION_VALUE_WITH;
 
extern EFI_HII_DATABASE_PROTOCOL           *mHiiDatabase;
extern EFI_HII_CONFIG_ROUTING_PROTOCOL     *mHiiConfigRouting;
extern EFI_DEVICE_PATH_FROM_TEXT_PROTOCOL  *mPathFromText;
extern EDKII_FORM_DISPLAY_ENGINE_PROTOCOL  *mFormDisplay;
 
extern BOOLEAN                    gCallbackReconnect;
extern BOOLEAN                    gFlagReconnect;
extern BOOLEAN                    gResetRequiredFormLevel;
extern BOOLEAN                    gResetRequiredSystemLevel;
extern BOOLEAN                    gExitRequired;
extern LIST_ENTRY                 gBrowserFormSetList;
extern LIST_ENTRY                 gBrowserHotKeyList;
extern BROWSER_SETTING_SCOPE      gBrowserSettingScope;
extern EXIT_HANDLER               ExitHandlerFunction;
extern EFI_HII_HANDLE             mCurrentHiiHandle;
extern SETUP_DRIVER_PRIVATE_DATA  mPrivateData;
//
// Browser Global Strings
//
extern CHAR16  *gEmptyString;
 
extern UI_MENU_SELECTION  *gCurrentSelection;
extern BOOLEAN            mHiiPackageListUpdated;
extern UINT16             mCurFakeQestId;
extern BOOLEAN            mFinishRetrieveCall;
 
//
// Global Procedure Defines
//
#include "Expression.h"
 
VOID
InitializeBrowserStrings (
  VOID
  );
 
EFI_STATUS
ParseOpCodes (
  IN FORM_BROWSER_FORMSET  *FormSet
  );
 
VOID
DestroyFormSet (
  IN OUT FORM_BROWSER_FORMSET  *FormSet
  );
 
EFI_STRING_ID
NewString (
  IN  CHAR16          *String,
  IN  EFI_HII_HANDLE  HiiHandle
  );
 
EFI_STATUS
DeleteString (
  IN  EFI_STRING_ID   StringId,
  IN  EFI_HII_HANDLE  HiiHandle
  );
 
CHAR16 *
GetToken (
  IN  EFI_STRING_ID   Token,
  IN  EFI_HII_HANDLE  HiiHandle
  );
 
EFI_STATUS
GetValueByName (
  IN BROWSER_STORAGE              *Storage,
  IN CHAR16                       *Name,
  IN OUT CHAR16                   **Value,
  IN GET_SET_QUESTION_VALUE_WITH  GetValueFrom
  );
 
EFI_STATUS
SetValueByName (
  IN  BROWSER_STORAGE              *Storage,
  IN  CHAR16                       *Name,
  IN  CHAR16                       *Value,
  IN  GET_SET_QUESTION_VALUE_WITH  SetValueTo,
  OUT NAME_VALUE_NODE              **ReturnNode
  );
 
BOOLEAN
IsQuestionValueChanged (
  IN FORM_BROWSER_FORMSET         *FormSet,
  IN FORM_BROWSER_FORM            *Form,
  IN OUT FORM_BROWSER_STATEMENT   *Question,
  IN GET_SET_QUESTION_VALUE_WITH  GetValueFrom
  );
 
BOOLEAN
ValidateFormSet (
  FORM_BROWSER_FORMSET  *FormSet
  );
 
VOID
UpdateStatementStatus (
  IN FORM_BROWSER_FORMSET   *FormSet,
  IN FORM_BROWSER_FORM      *Form,
  IN BROWSER_SETTING_SCOPE  SettingScope
  );
 
EFI_STATUS
GetQuestionValue (
  IN FORM_BROWSER_FORMSET         *FormSet,
  IN FORM_BROWSER_FORM            *Form,
  IN OUT FORM_BROWSER_STATEMENT   *Question,
  IN GET_SET_QUESTION_VALUE_WITH  GetValueFrom
  );
 
EFI_STATUS
SetQuestionValue (
  IN FORM_BROWSER_FORMSET         *FormSet,
  IN FORM_BROWSER_FORM            *Form,
  IN OUT FORM_BROWSER_STATEMENT   *Question,
  IN GET_SET_QUESTION_VALUE_WITH  SetValueTo
  );
 
EFI_STATUS
ValidateQuestion (
  IN  FORM_BROWSER_FORMSET    *FormSet,
  IN  FORM_BROWSER_FORM       *Form,
  IN  FORM_BROWSER_STATEMENT  *Question,
  IN  UINTN                   Type
  );
 
EFI_STATUS
DiscardForm (
  IN FORM_BROWSER_FORMSET   *FormSet,
  IN FORM_BROWSER_FORM      *Form,
  IN BROWSER_SETTING_SCOPE  SettingScope
  );
 
EFI_STATUS
SubmitForm (
  IN FORM_BROWSER_FORMSET   *FormSet,
  IN FORM_BROWSER_FORM      *Form,
  IN BROWSER_SETTING_SCOPE  SettingScope
  );
 
EFI_STATUS
GetQuestionDefault (
  IN FORM_BROWSER_FORMSET    *FormSet,
  IN FORM_BROWSER_FORM       *Form,
  IN FORM_BROWSER_STATEMENT  *Question,
  IN UINT16                  DefaultId
  );
 
VOID
InitializeCurrentSetting (
  IN OUT FORM_BROWSER_FORMSET  *FormSet
  );
 
EFI_STATUS
InitializeFormSet (
  IN  EFI_HII_HANDLE        Handle,
  IN OUT EFI_GUID           *FormSetGuid,
  OUT FORM_BROWSER_FORMSET  *FormSet
  );
 
EFI_STATUS
ExtractDefault (
  IN FORM_BROWSER_FORMSET       *FormSet,
  IN FORM_BROWSER_FORM          *Form,
  IN UINT16                     DefaultId,
  IN BROWSER_SETTING_SCOPE      SettingScope,
  IN BROWSER_GET_DEFAULT_VALUE  GetDefaultValueScope,
  IN BROWSER_STORAGE            *Storage,
  IN BOOLEAN                    RetrieveValueFirst,
  IN BOOLEAN                    SkipGetAltCfg
  );
 
EFI_STATUS
LoadFormConfig (
  IN OUT UI_MENU_SELECTION  *Selection,
  IN FORM_BROWSER_FORMSET   *FormSet,
  IN FORM_BROWSER_FORM      *Form
  );
 
EFI_STATUS
LoadFormSetConfig (
  IN OUT UI_MENU_SELECTION     *Selection,
  IN     FORM_BROWSER_FORMSET  *FormSet
  );
 
EFI_STATUS
StorageToConfigResp (
  IN BROWSER_STORAGE  *Storage,
  IN CHAR16           **ConfigResp,
  IN CHAR16           *ConfigRequest,
  IN BOOLEAN          GetEditBuf
  );
 
EFI_STATUS
ConfigRespToStorage (
  IN BROWSER_STORAGE  *Storage,
  IN CHAR16           *ConfigResp
  );
 
VOID
LoadStorage (
  IN FORM_BROWSER_FORMSET  *FormSet,
  IN FORMSET_STORAGE       *Storage
  );
 
EFI_STATUS
GetIfrBinaryData (
  IN  EFI_HII_HANDLE  Handle,
  IN OUT EFI_GUID     *FormSetGuid,
  OUT UINTN           *BinaryLength,
  OUT UINT8           **BinaryData
  );
 
VOID
SaveBrowserContext (
  VOID
  );
 
VOID
RestoreBrowserContext (
  VOID
  );
 
EFI_STATUS
EFIAPI
SendForm (
  IN  CONST EFI_FORM_BROWSER2_PROTOCOL  *This,
  IN  EFI_HII_HANDLE                    *Handles,
  IN  UINTN                             HandleCount,
  IN  EFI_GUID                          *FormSetGuid  OPTIONAL,
  IN  UINT16                            FormId  OPTIONAL,
  IN  CONST EFI_SCREEN_DESCRIPTOR       *ScreenDimensions  OPTIONAL,
  OUT EFI_BROWSER_ACTION_REQUEST        *ActionRequest  OPTIONAL
  );
 
EFI_STATUS
EFIAPI
BrowserCallback (
  IN CONST EFI_FORM_BROWSER2_PROTOCOL  *This,
  IN OUT UINTN                         *ResultsDataSize,
  IN OUT EFI_STRING                    ResultsData,
  IN BOOLEAN                           RetrieveData,
  IN CONST EFI_GUID                    *VariableGuid  OPTIONAL,
  IN CONST CHAR16                      *VariableName  OPTIONAL
  );
 
BOOLEAN
FindNextMenu (
  IN OUT UI_MENU_SELECTION        *Selection,
  IN       BROWSER_SETTING_SCOPE  SettingLevel
  );
 
BOOLEAN
IsNvUpdateRequiredForForm (
  IN FORM_BROWSER_FORM  *Form
  );
 
BOOLEAN
IsNvUpdateRequiredForFormSet (
  IN FORM_BROWSER_FORMSET  *FormSet
  );
 
EFI_STATUS
ProcessCallBackFunction (
  IN OUT UI_MENU_SELECTION       *Selection,
  IN     FORM_BROWSER_FORMSET    *FormSet,
  IN     FORM_BROWSER_FORM       *Form,
  IN     FORM_BROWSER_STATEMENT  *Question,
  IN     EFI_BROWSER_ACTION      Action,
  IN     BOOLEAN                 SkipSaveOrDiscard
  );
 
EFI_STATUS
ProcessRetrieveForQuestion (
  IN     EFI_HII_CONFIG_ACCESS_PROTOCOL  *ConfigAccess,
  IN     FORM_BROWSER_STATEMENT          *Statement,
  IN     FORM_BROWSER_FORMSET            *FormSet
  );
 
FORM_BROWSER_FORMSET *
GetFormSetFromHiiHandle (
  EFI_HII_HANDLE  Handle
  );
 
BOOLEAN
IsHiiHandleInBrowserContext (
  EFI_HII_HANDLE  Handle
  );
 
EFI_STATUS
EFIAPI
SetScope (
  IN BROWSER_SETTING_SCOPE  Scope
  );
 
EFI_STATUS
EFIAPI
RegisterHotKey (
  IN EFI_INPUT_KEY  *KeyData,
  IN UINT32         Action,
  IN UINT16         DefaultId,
  IN EFI_STRING     HelpString OPTIONAL
  );
 
VOID
EFIAPI
RegiserExitHandler (
  IN EXIT_HANDLER  Handler
  );
 
BOOLEAN
EFIAPI
IsBrowserDataModified (
  VOID
  );
 
EFI_STATUS
EFIAPI
ExecuteAction (
  IN UINT32  Action,
  IN UINT16  DefaultId
  );
 
UINT32
EFIAPI
SaveReminder (
  VOID
  );
 
BOOLEAN
EFIAPI
IsResetRequired (
  VOID
  );
 
BROWSER_HOT_KEY *
GetHotKeyFromRegisterList (
  IN EFI_INPUT_KEY  *KeyData
  );
 
FORM_BROWSER_STATEMENT *
GetBrowserStatement (
  IN FORM_DISPLAY_ENGINE_STATEMENT  *DisplayStatement
  );
 
EFI_STATUS
PasswordCallback (
  IN  UI_MENU_SELECTION       *Selection,
  IN  FORM_BROWSER_STATEMENT  *Question,
  IN  CHAR16                  *String
  );
 
VOID
PasswordInvalid (
  VOID
  );
 
EFI_STATUS
SetupBrowser (
  IN OUT UI_MENU_SELECTION  *Selection
  );
 
VOID
FreeBrowserStrings (
  VOID
  );
 
FORM_ENTRY_INFO *
UiAddMenuList (
  IN EFI_HII_HANDLE  HiiHandle,
  IN EFI_GUID        *FormSetGuid,
  IN UINT16          FormId,
  IN UINT16          QuestionId
  );
 
FORM_ENTRY_INFO *
UiFindMenuList (
  IN EFI_HII_HANDLE  HiiHandle,
  IN EFI_GUID        *FormSetGuid,
  IN UINT16          FormId
  );
 
VOID
UiFreeMenuList (
  LIST_ENTRY  *MenuListHead
  );
 
FORM_ENTRY_INFO *
UiFindParentMenu (
  IN FORM_ENTRY_INFO        *CurrentMenu,
  IN BROWSER_SETTING_SCOPE  SettingLevel
  );
 
BOOLEAN
ValidateHiiHandle (
  EFI_HII_HANDLE  HiiHandle
  );
 
VOID
UiCopyMenuList (
  OUT LIST_ENTRY  *NewMenuListHead,
  IN  LIST_ENTRY  *CurrentMenuListHead
  );
 
QUESTION_OPTION *
ValueToOption (
  IN FORM_BROWSER_STATEMENT  *Question,
  IN EFI_HII_VALUE           *OptionValue
  );
 
UINT64
GetArrayData (
  IN VOID   *Array,
  IN UINT8  Type,
  IN UINTN  Index
  );
 
VOID
SetArrayData (
  IN VOID    *Array,
  IN UINT8   Type,
  IN UINTN   Index,
  IN UINT64  Value
  );
 
EFI_STATUS
CompareHiiValue (
  IN  EFI_HII_VALUE   *Value1,
  IN  EFI_HII_VALUE   *Value2,
  OUT INTN            *Result,
  IN  EFI_HII_HANDLE  HiiHandle OPTIONAL
  );
 
EFI_STATUS
EFIAPI
PasswordCheck (
  IN FORM_DISPLAY_ENGINE_FORM       *Form,
  IN FORM_DISPLAY_ENGINE_STATEMENT  *Statement,
  IN EFI_STRING                     PasswordString  OPTIONAL
  );
 
FORM_BROWSER_STATEMENT *
GetBrowserStatement (
  IN FORM_DISPLAY_ENGINE_STATEMENT  *DisplayStatement
  );
 
VOID
InitializeDisplayFormData (
  VOID
  );
 
VOID
CleanBrowserStorage (
  IN OUT FORM_BROWSER_FORMSET  *FormSet
  );
 
EFI_HII_HANDLE
DevicePathToHiiHandle (
  IN EFI_DEVICE_PATH_PROTOCOL  *DevicePath,
  IN EFI_GUID                  *FormsetGuid
  );
 
BOOLEAN
ConfigRequestAdjust (
  IN  BROWSER_STORAGE  *Storage,
  IN  CHAR16           *Request,
  IN  BOOLEAN          RespString
  );
 
EFI_STATUS
ValueChangedValidation (
  IN  FORM_BROWSER_FORMSET    *FormSet,
  IN  FORM_BROWSER_FORM       *Form,
  IN  FORM_BROWSER_STATEMENT  *Question
  );
 
UINT32
PopupErrorMessage (
  IN UINT32             BrowserStatus,
  IN EFI_HII_HANDLE     HiiHandle,
  IN EFI_IFR_OP_HEADER  *OpCode  OPTIONAL,
  IN CHAR16             *ErrorString
  );
 
BOOLEAN
IsTrue (
  IN EFI_HII_VALUE  *Result
  );
 
FORMSET_STORAGE *
GetFstStgFromVarId (
  IN FORM_BROWSER_FORMSET  *FormSet,
  IN EFI_VARSTORE_ID       VarStoreId
  );
 
FORMSET_STORAGE *
GetFstStgFromBrsStg (
  IN BROWSER_STORAGE  *Storage
  );
 
BOOLEAN
ReconnectController (
  IN EFI_HANDLE  DriverHandle
  );
 
VOID
EFIAPI
HiiToLower (
  IN EFI_STRING  ConfigString
  );
 
#endif