TianoCore EDK2 master
Loading...
Searching...
No Matches
Setup.h File Reference

Go to the source code of this file.

Data Structures

struct  SETUP_DRIVER_PRIVATE_DATA
 
struct  NAME_VALUE_NODE
 
struct  BROWSER_STORAGE
 
struct  FORMSET_STORAGE
 
union  VAR_STORE_INFO
 
struct  EXPRESSION_OPCODE
 
struct  FORM_EXPRESSION
 
struct  FORM_EXPRESSION_LIST
 
struct  QUESTION_DEFAULT
 
struct  QUESTION_OPTION
 
struct  _FORM_BROWSER_STATEMENT
 
struct  FORM_BROWSER_CONFIG_REQUEST
 
struct  FORM_BROWSER_FORM
 
struct  FORMSET_DEFAULTSTORE
 
struct  FORM_BROWSER_FORMSET
 
struct  FORM_BROWSER_REFRESH_EVENT_NODE
 
struct  UI_MENU_SELECTION
 
struct  BROWSER_CONTEXT
 

Macros

#define UI_ACTION_NONE   0
 
#define UI_ACTION_REFRESH_FORM   1
 
#define UI_ACTION_REFRESH_FORMSET   2
 
#define UI_ACTION_EXIT   3
 
#define ONE_SECOND   10000000
 
#define CONFIG_REQUEST_STRING_INCREMENTAL   1024
 
#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')
 
#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
 
#define EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER   3
 
#define FORM_INCONSISTENT_VALIDATION   0
 
#define FORM_NO_SUBMIT_VALIDATION   1
 
#define NAME_VALUE_NODE_SIGNATURE   SIGNATURE_32 ('N', 'V', 'S', 'T')
 
#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')
 
#define BROWSER_STORAGE_FROM_LINK(a)   CR (a, BROWSER_STORAGE, Link, BROWSER_STORAGE_SIGNATURE)
 
#define FORMSET_STORAGE_SIGNATURE   SIGNATURE_32 ('F', 'S', 'T', 'G')
 
#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)
 
#define EXPRESSION_OPCODE_SIGNATURE   SIGNATURE_32 ('E', 'X', 'O', 'P')
 
#define EXPRESSION_OPCODE_FROM_LINK(a)   CR (a, EXPRESSION_OPCODE, Link, EXPRESSION_OPCODE_SIGNATURE)
 
#define FORM_EXPRESSION_SIGNATURE   SIGNATURE_32 ('F', 'E', 'X', 'P')
 
#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')
 
#define QUESTION_DEFAULT_SIGNATURE   SIGNATURE_32 ('Q', 'D', 'F', 'T')
 
#define QUESTION_DEFAULT_FROM_LINK(a)   CR (a, QUESTION_DEFAULT, Link, QUESTION_DEFAULT_SIGNATURE)
 
#define QUESTION_OPTION_SIGNATURE   SIGNATURE_32 ('Q', 'O', 'P', 'T')
 
#define QUESTION_OPTION_FROM_LINK(a)   CR (a, QUESTION_OPTION, Link, QUESTION_OPTION_SIGNATURE)
 
#define FORM_BROWSER_STATEMENT_SIGNATURE   SIGNATURE_32 ('F', 'S', 'T', 'A')
 
#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')
 
#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
 
#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')
 
#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')
 
#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)
 
#define FORM_BROWSER_REFRESH_EVENT_FROM_LINK(a)   BASE_CR (a, FORM_BROWSER_REFRESH_EVENT_NODE, Link)
 
#define BROWSER_CONTEXT_SIGNATURE   SIGNATURE_32 ('B', 'C', 'T', 'X')
 
#define BROWSER_CONTEXT_FROM_LINK(a)   CR (a, BROWSER_CONTEXT, Link, BROWSER_CONTEXT_SIGNATURE)
 

Typedefs

typedef struct _FORM_BROWSER_STATEMENT FORM_BROWSER_STATEMENT
 

Enumerations

enum  EXPRESS_RESULT {
  ExpressFalse = 0 , ExpressGrayOut , ExpressSuppress , ExpressDisable ,
  ExpressFalse = 0 , ExpressGrayOut , ExpressSuppress , ExpressDisable
}
 
enum  EXPRESS_LEVEL {
  ExpressNone = 0 , ExpressForm , ExpressStatement , ExpressOption ,
  ExpressNone = 0 , ExpressForm , ExpressStatement , ExpressOption
}
 
enum  BROWSER_GET_DEFAULT_VALUE { GetDefaultForNoStorage , GetDefaultForStorage , GetDefaultForAll , GetDefaultForMax }
 
enum  GET_SET_QUESTION_VALUE_WITH {
  GetSetValueWithEditBuffer = 0 , GetSetValueWithBuffer , GetSetValueWithHiiDriver , GetSetValueWithBothBuffer ,
  GetSetValueWithMax , GetSetValueWithBuffer = 0 , GetSetValueWithHiiDriver , GetSetValueWithBoth ,
  GetSetValueWithMax
}
 

Functions

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_FORMSETGetFormSetFromHiiHandle (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_KEYGetHotKeyFromRegisterList (IN EFI_INPUT_KEY *KeyData)
 
FORM_BROWSER_STATEMENTGetBrowserStatement (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_INFOUiAddMenuList (IN EFI_HII_HANDLE HiiHandle, IN EFI_GUID *FormSetGuid, IN UINT16 FormId, IN UINT16 QuestionId)
 
FORM_ENTRY_INFOUiFindMenuList (IN EFI_HII_HANDLE HiiHandle, IN EFI_GUID *FormSetGuid, IN UINT16 FormId)
 
VOID UiFreeMenuList (LIST_ENTRY *MenuListHead)
 
FORM_ENTRY_INFOUiFindParentMenu (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_OPTIONValueToOption (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)
 
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_STORAGEGetFstStgFromVarId (IN FORM_BROWSER_FORMSET *FormSet, IN EFI_VARSTORE_ID VarStoreId)
 
FORMSET_STORAGEGetFstStgFromBrsStg (IN BROWSER_STORAGE *Storage)
 
BOOLEAN ReconnectController (IN EFI_HANDLE DriverHandle)
 
VOID EFIAPI HiiToLower (IN EFI_STRING ConfigString)
 

Variables

EFI_HII_DATABASE_PROTOCOLmHiiDatabase
 
EFI_HII_CONFIG_ROUTING_PROTOCOLmHiiConfigRouting
 
EFI_DEVICE_PATH_FROM_TEXT_PROTOCOLmPathFromText
 
EDKII_FORM_DISPLAY_ENGINE_PROTOCOLmFormDisplay
 
BOOLEAN gCallbackReconnect
 
BOOLEAN gFlagReconnect
 
BOOLEAN gResetRequiredFormLevel
 
BOOLEAN gResetRequiredSystemLevel
 
BOOLEAN gExitRequired
 
LIST_ENTRY gBrowserFormSetList
 
LIST_ENTRY gBrowserHotKeyList
 
BROWSER_SETTING_SCOPE gBrowserSettingScope
 
EXIT_HANDLER ExitHandlerFunction
 
EFI_HII_HANDLE mCurrentHiiHandle
 
SETUP_DRIVER_PRIVATE_DATA mPrivateData
 
CHAR16 * gEmptyString
 
UI_MENU_SELECTIONgCurrentSelection
 
BOOLEAN mHiiPackageListUpdated
 
UINT16 mCurFakeQestId
 
BOOLEAN mFinishRetrieveCall
 

Detailed Description

Private MACRO, structure and function definitions for Setup Browser module.

Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file Setup.h.

Macro Definition Documentation

◆ BROWSER_CONTEXT_FROM_LINK

#define BROWSER_CONTEXT_FROM_LINK (   a)    CR (a, BROWSER_CONTEXT, Link, BROWSER_CONTEXT_SIGNATURE)

Definition at line 545 of file Setup.h.

◆ BROWSER_CONTEXT_SIGNATURE

#define BROWSER_CONTEXT_SIGNATURE   SIGNATURE_32 ('B', 'C', 'T', 'X')

Definition at line 520 of file Setup.h.

◆ BROWSER_STORAGE_FROM_LINK

#define BROWSER_STORAGE_FROM_LINK (   a)    CR (a, BROWSER_STORAGE, Link, BROWSER_STORAGE_SIGNATURE)

Definition at line 150 of file Setup.h.

◆ BROWSER_STORAGE_SIGNATURE

#define BROWSER_STORAGE_SIGNATURE   SIGNATURE_32 ('B', 'S', 'T', 'G')

Definition at line 123 of file Setup.h.

◆ CONFIG_REQUEST_STRING_INCREMENTAL

#define CONFIG_REQUEST_STRING_INCREMENTAL   1024

Definition at line 65 of file Setup.h.

◆ EFI_HII_EXPRESSION_DISABLE_IF

#define EFI_HII_EXPRESSION_DISABLE_IF   4

Definition at line 96 of file Setup.h.

◆ EFI_HII_EXPRESSION_GRAY_OUT_IF

#define EFI_HII_EXPRESSION_GRAY_OUT_IF   2

Definition at line 94 of file Setup.h.

◆ EFI_HII_EXPRESSION_INCONSISTENT_IF

#define EFI_HII_EXPRESSION_INCONSISTENT_IF   0

Definition at line 92 of file Setup.h.

◆ EFI_HII_EXPRESSION_NO_SUBMIT_IF

#define EFI_HII_EXPRESSION_NO_SUBMIT_IF   1

Definition at line 93 of file Setup.h.

◆ EFI_HII_EXPRESSION_READ

#define EFI_HII_EXPRESSION_READ   7

Definition at line 99 of file Setup.h.

◆ EFI_HII_EXPRESSION_RULE

#define EFI_HII_EXPRESSION_RULE   6

Definition at line 98 of file Setup.h.

◆ EFI_HII_EXPRESSION_SUPPRESS_IF

#define EFI_HII_EXPRESSION_SUPPRESS_IF   3

Definition at line 95 of file Setup.h.

◆ EFI_HII_EXPRESSION_VALUE

#define EFI_HII_EXPRESSION_VALUE   5

Definition at line 97 of file Setup.h.

◆ EFI_HII_EXPRESSION_WARNING_IF

#define EFI_HII_EXPRESSION_WARNING_IF   9

Definition at line 101 of file Setup.h.

◆ EFI_HII_EXPRESSION_WRITE

#define EFI_HII_EXPRESSION_WRITE   8

Definition at line 100 of file Setup.h.

◆ EFI_HII_VARSTORE_BUFFER

#define EFI_HII_VARSTORE_BUFFER   0

Definition at line 103 of file Setup.h.

◆ EFI_HII_VARSTORE_EFI_VARIABLE

#define EFI_HII_VARSTORE_EFI_VARIABLE   2

Definition at line 105 of file Setup.h.

◆ EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER

#define EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER   3

Definition at line 106 of file Setup.h.

◆ EFI_HII_VARSTORE_NAME_VALUE

#define EFI_HII_VARSTORE_NAME_VALUE   1

Definition at line 104 of file Setup.h.

◆ EFI_IFR_SPECIFICATION_VERSION

#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))

Definition at line 72 of file Setup.h.

◆ EXPRESSION_OPCODE_FROM_LINK

#define EXPRESSION_OPCODE_FROM_LINK (   a)    CR (a, EXPRESSION_OPCODE, Link, EXPRESSION_OPCODE_SIGNATURE)

Definition at line 214 of file Setup.h.

◆ EXPRESSION_OPCODE_SIGNATURE

#define EXPRESSION_OPCODE_SIGNATURE   SIGNATURE_32 ('E', 'X', 'O', 'P')

Definition at line 183 of file Setup.h.

◆ EXPRESSION_STACK_SIZE_INCREMENT

#define EXPRESSION_STACK_SIZE_INCREMENT   0x100

Definition at line 70 of file Setup.h.

◆ FORM_BROWSER_CONFIG_REQUEST_FROM_LINK

#define FORM_BROWSER_CONFIG_REQUEST_FROM_LINK (   a)    CR (a, FORM_BROWSER_CONFIG_REQUEST, Link, FORM_BROWSER_CONFIG_REQUEST_SIGNATURE)

Definition at line 390 of file Setup.h.

◆ FORM_BROWSER_CONFIG_REQUEST_FROM_SAVE_FAIL_LINK

#define FORM_BROWSER_CONFIG_REQUEST_FROM_SAVE_FAIL_LINK (   a)    CR (a, FORM_BROWSER_CONFIG_REQUEST, SaveFailLink, FORM_BROWSER_CONFIG_REQUEST_SIGNATURE)

Definition at line 391 of file Setup.h.

◆ FORM_BROWSER_CONFIG_REQUEST_SIGNATURE

#define FORM_BROWSER_CONFIG_REQUEST_SIGNATURE   SIGNATURE_32 ('F', 'C', 'R', 'S')

Definition at line 374 of file Setup.h.

◆ FORM_BROWSER_FORM_FROM_LINK

#define FORM_BROWSER_FORM_FROM_LINK (   a)    CR (a, FORM_BROWSER_FORM, Link, FORM_BROWSER_FORM_SIGNATURE)

Definition at line 417 of file Setup.h.

◆ FORM_BROWSER_FORM_SIGNATURE

#define FORM_BROWSER_FORM_SIGNATURE   SIGNATURE_32 ('F', 'F', 'R', 'M')

Definition at line 393 of file Setup.h.

◆ FORM_BROWSER_FORMSET_FROM_LINK

#define FORM_BROWSER_FORMSET_FROM_LINK (   a)    CR (a, FORM_BROWSER_FORMSET, Link, FORM_BROWSER_FORMSET_SIGNATURE)

Definition at line 469 of file Setup.h.

◆ FORM_BROWSER_FORMSET_FROM_SAVE_FAIL_LINK

#define FORM_BROWSER_FORMSET_FROM_SAVE_FAIL_LINK (   a)    CR (a, FORM_BROWSER_FORMSET, SaveFailLink, FORM_BROWSER_FORMSET_SIGNATURE)

Definition at line 471 of file Setup.h.

◆ FORM_BROWSER_FORMSET_SIGNATURE

#define FORM_BROWSER_FORMSET_SIGNATURE   SIGNATURE_32 ('F', 'B', 'F', 'S')

Definition at line 431 of file Setup.h.

◆ FORM_BROWSER_REFRESH_EVENT_FROM_LINK

#define FORM_BROWSER_REFRESH_EVENT_FROM_LINK (   a)    BASE_CR (a, FORM_BROWSER_REFRESH_EVENT_NODE, Link)

Definition at line 478 of file Setup.h.

◆ FORM_BROWSER_STATEMENT_FROM_LINK

#define FORM_BROWSER_STATEMENT_FROM_LINK (   a)    CR (a, FORM_BROWSER_STATEMENT, Link, FORM_BROWSER_STATEMENT_SIGNATURE)

Definition at line 372 of file Setup.h.

◆ FORM_BROWSER_STATEMENT_SIGNATURE

#define FORM_BROWSER_STATEMENT_SIGNATURE   SIGNATURE_32 ('F', 'S', 'T', 'A')

Definition at line 293 of file Setup.h.

◆ FORM_EXPRESSION_FROM_LINK

#define FORM_EXPRESSION_FROM_LINK (   a)    CR (a, FORM_EXPRESSION, Link, FORM_EXPRESSION_SIGNATURE)

Definition at line 235 of file Setup.h.

◆ FORM_EXPRESSION_LIST_SIGNATURE

#define FORM_EXPRESSION_LIST_SIGNATURE   SIGNATURE_32 ('F', 'E', 'X', 'R')

Definition at line 237 of file Setup.h.

◆ FORM_EXPRESSION_SIGNATURE

#define FORM_EXPRESSION_SIGNATURE   SIGNATURE_32 ('F', 'E', 'X', 'P')

Definition at line 216 of file Setup.h.

◆ FORM_INCONSISTENT_VALIDATION

#define FORM_INCONSISTENT_VALIDATION   0

Definition at line 108 of file Setup.h.

◆ FORM_NO_SUBMIT_VALIDATION

#define FORM_NO_SUBMIT_VALIDATION   1

Definition at line 109 of file Setup.h.

◆ FORMSET_DEFAULTSTORE_FROM_LINK

#define FORMSET_DEFAULTSTORE_FROM_LINK (   a)    CR (a, FORMSET_DEFAULTSTORE, Link, FORMSET_DEFAULTSTORE_SIGNATURE)

Definition at line 429 of file Setup.h.

◆ FORMSET_DEFAULTSTORE_SIGNATURE

#define FORMSET_DEFAULTSTORE_SIGNATURE   SIGNATURE_32 ('F', 'D', 'F', 'S')

Definition at line 419 of file Setup.h.

◆ FORMSET_STORAGE_FROM_LINK

#define FORMSET_STORAGE_FROM_LINK (   a)    CR (a, FORMSET_STORAGE, Link, FORMSET_STORAGE_SIGNATURE)

Definition at line 175 of file Setup.h.

◆ FORMSET_STORAGE_FROM_SAVE_FAIL_LINK

#define FORMSET_STORAGE_FROM_SAVE_FAIL_LINK (   a)    CR (a, FORMSET_STORAGE, SaveFailLink, FORMSET_STORAGE_SIGNATURE)

Definition at line 176 of file Setup.h.

◆ FORMSET_STORAGE_SIGNATURE

#define FORMSET_STORAGE_SIGNATURE   SIGNATURE_32 ('F', 'S', 'T', 'G')

Definition at line 152 of file Setup.h.

◆ NAME_VALUE_NODE_FROM_LINK

#define NAME_VALUE_NODE_FROM_LINK (   a)    CR (a, NAME_VALUE_NODE, Link, NAME_VALUE_NODE_SIGNATURE)

Definition at line 121 of file Setup.h.

◆ NAME_VALUE_NODE_SIGNATURE

#define NAME_VALUE_NODE_SIGNATURE   SIGNATURE_32 ('N', 'V', 'S', 'T')

Definition at line 111 of file Setup.h.

◆ ONE_SECOND

#define ONE_SECOND   10000000

Definition at line 61 of file Setup.h.

◆ QUESTION_DEFAULT_FROM_LINK

#define QUESTION_DEFAULT_FROM_LINK (   a)    CR (a, QUESTION_DEFAULT, Link, QUESTION_DEFAULT_SIGNATURE)

Definition at line 257 of file Setup.h.

◆ QUESTION_DEFAULT_SIGNATURE

#define QUESTION_DEFAULT_SIGNATURE   SIGNATURE_32 ('Q', 'D', 'F', 'T')

Definition at line 245 of file Setup.h.

◆ QUESTION_OPTION_FROM_LINK

#define QUESTION_OPTION_FROM_LINK (   a)    CR (a, QUESTION_OPTION, Link, QUESTION_OPTION_SIGNATURE)

Definition at line 275 of file Setup.h.

◆ QUESTION_OPTION_SIGNATURE

#define QUESTION_OPTION_SIGNATURE   SIGNATURE_32 ('Q', 'O', 'P', 'T')

Definition at line 259 of file Setup.h.

◆ SETUP_DRIVER_SIGNATURE

#define SETUP_DRIVER_SIGNATURE   SIGNATURE_32 ('F', 'B', 'D', 'V')

Definition at line 74 of file Setup.h.

◆ STANDARD_MAP_FORM_TYPE

#define STANDARD_MAP_FORM_TYPE   0x01

Definition at line 394 of file Setup.h.

◆ UI_ACTION_EXIT

#define UI_ACTION_EXIT   3

Definition at line 55 of file Setup.h.

◆ UI_ACTION_NONE

#define UI_ACTION_NONE   0

Definition at line 52 of file Setup.h.

◆ UI_ACTION_REFRESH_FORM

#define UI_ACTION_REFRESH_FORM   1

Definition at line 53 of file Setup.h.

◆ UI_ACTION_REFRESH_FORMSET

#define UI_ACTION_REFRESH_FORMSET   2

Definition at line 54 of file Setup.h.

Typedef Documentation

◆ FORM_BROWSER_STATEMENT

Definition at line 291 of file Setup.h.

Enumeration Type Documentation

◆ BROWSER_GET_DEFAULT_VALUE

enum BROWSER_GET_DEFAULT_VALUE

Definition at line 550 of file Setup.h.

◆ EXPRESS_LEVEL

enum EXPRESS_LEVEL

Definition at line 284 of file Setup.h.

◆ EXPRESS_RESULT

enum EXPRESS_RESULT

Definition at line 277 of file Setup.h.

◆ GET_SET_QUESTION_VALUE_WITH

Enumerator
GetSetValueWithBuffer 

Get/Set question value from/to buffer in the storage.

GetSetValueWithHiiDriver 

Get/Set question value from/to hii driver.

GetSetValueWithBoth 

Compare the editbuffer with buffer for this question, not use the question value.

GetSetValueWithMax 

Invalid value.

Definition at line 560 of file Setup.h.

Function Documentation

◆ BrowserCallback()

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 
)

This function is called by a callback handler to retrieve uncommitted state data from the browser.

Parameters
ThisA pointer to the EFI_FORM_BROWSER2_PROTOCOL instance.
ResultsDataSizeA pointer to the size of the buffer associated with ResultsData.
ResultsDataA string returned from an IFR browser or equivalent. The results string will have no routing information in them.
RetrieveDataA BOOLEAN field which allows an agent to retrieve (if RetrieveData = TRUE) data from the uncommitted browser state information or set (if RetrieveData = FALSE) data in the uncommitted browser state information.
VariableGuidAn optional field to indicate the target variable GUID name to use.
VariableNameAn optional field to indicate the target human-readable variable name.
Return values
EFI_SUCCESSThe results have been distributed or are awaiting distribution.
EFI_BUFFER_TOO_SMALLThe ResultsDataSize specified was too small to contain the results data.

This routine called this service in the browser to retrieve or set certain uncommitted state information that resides in the open formsets.

Parameters
ThisA pointer to the EFI_FORM_BROWSER2_PROTOCOL instance.
ResultsDataSizeA pointer to the size of the buffer associated with ResultsData.
ResultsDataA string returned from an IFR browser or equivalent. The results string will have no routing information in them.
RetrieveDataA BOOLEAN field which allows an agent to retrieve (if RetrieveData = TRUE) data from the uncommitted browser state information or set (if RetrieveData = FALSE) data in the uncommitted browser state information.
VariableGuidAn optional field to indicate the target variable GUID name to use.
VariableNameAn optional field to indicate the target human-readable variable name.
Return values
EFI_SUCCESSThe results have been distributed or are awaiting distribution.
EFI_BUFFER_TOO_SMALLThe ResultsDataSize specified was too small to contain the results data.

Definition at line 728 of file Setup.c.

◆ CleanBrowserStorage()

VOID CleanBrowserStorage ( IN OUT FORM_BROWSER_FORMSET FormSet)

Base on the current formset info, clean the ConfigRequest string in browser storage.

Parameters
FormSetPointer of the FormSet

Definition at line 5339 of file Setup.c.

◆ CompareHiiValue()

EFI_STATUS CompareHiiValue ( IN EFI_HII_VALUE Value1,
IN EFI_HII_VALUE Value2,
OUT INTN Result,
IN EFI_HII_HANDLE HiiHandle  OPTIONAL 
)

Compare two Hii value.

Parameters
Value1Expression value to compare on left-hand.
Value2Expression value to compare on right-hand.
ResultReturn value after compare. retval 0 Two operators equal. return Positive value if Value1 is greater than Value2. retval Negative value if Value1 is less than Value2.
HiiHandleOnly required for string compare.
Return values
otherCould not perform compare on two values.
EFI_SUCCESSCompare the value success.

Compare two Hii value.

Parameters
[in]Value1Expression value to compare on left-hand.
[in]Value2Expression value to compare on right-hand.
[out]ResultReturn value after compare. retval 0 Two operators equal. return Positive value if Value1 is greater than Value2. retval Negative value if Value1 is less than Value2.
[in]HiiHandleOnly required for string compare.
Return values
otherCould not perform compare on two values.
EFI_SUCCESSCompare the value success.
EFI_INVALID_PARAMETERValue1, Value2 or Result is NULL.

Definition at line 214 of file ProcessOptions.c.

◆ ConfigRequestAdjust()

BOOLEAN ConfigRequestAdjust ( IN BROWSER_STORAGE Storage,
IN CHAR16 *  Request,
IN BOOLEAN  RespString 
)

Adjust the config request info, remove the request elements which already in AllConfigRequest string.

Parameters
StorageForm set Storage.
RequestThe input request string.
RespStringWhether the input is ConfigRequest or ConfigResp format.
Return values
TRUEHas element not covered by current used elements, need to continue to call ExtractConfig
FALSEAll elements covered by current used elements.

Definition at line 5449 of file Setup.c.

◆ ConfigRespToStorage()

EFI_STATUS ConfigRespToStorage ( IN BROWSER_STORAGE Storage,
IN CHAR16 *  ConfigResp 
)

Convert <ConfigResp> to settings in Buffer Storage or NameValue Storage.

Parameters
StorageThe Storage to receive the settings.
ConfigRespThe <ConfigResp> to be converted.
Return values
EFI_SUCCESSConvert success.
EFI_INVALID_PARAMETERIncorrect storage type.

Definition at line 1304 of file Setup.c.

◆ DeleteString()

EFI_STATUS DeleteString ( IN EFI_STRING_ID  StringId,
IN EFI_HII_HANDLE  HiiHandle 
)

Delete a string from HII Package List.

Parameters
StringIdId of the string in HII database.
HiiHandleThe HII package list handle.
Return values
EFI_SUCCESSThe string was deleted successfully.

Delete a string from HII Package List.

Parameters
[in]StringIdId of the string in HII database.
[in]HiiHandleThe HII package list handle.
Return values
EFI_SUCCESSThe string was deleted successfully.

Definition at line 1004 of file Setup.c.

◆ DestroyFormSet()

VOID DestroyFormSet ( IN OUT FORM_BROWSER_FORMSET FormSet)

Free resources allocated for a FormSet.

Parameters
FormSetPointer of the FormSet

Definition at line 943 of file IfrParse.c.

◆ DevicePathToHiiHandle()

EFI_HII_HANDLE DevicePathToHiiHandle ( IN EFI_DEVICE_PATH_PROTOCOL DevicePath,
IN EFI_GUID FormsetGuid 
)

Find HII Handle in the HII database associated with given Device Path.

If DevicePath is NULL, then ASSERT.

Parameters
DevicePathDevice Path associated with the HII package list handle.
FormsetGuidThe formset guid for this formset.
Return values
HandleHII package list Handle associated with the Device Path.
NULLHii Package list handle is not found.

Find HII Handle in the HII database associated with given Device Path.

If DevicePath is NULL, then ASSERT.

Parameters
[in]DevicePathDevice Path associated with the HII package list handle.
[in]FormsetGuidThe formset guid for this formset.
Return values
HandleHII package list Handle associated with the Device Path.
NULLHii Package list handle is not found.

Definition at line 1165 of file Presentation.c.

◆ DiscardForm()

EFI_STATUS DiscardForm ( IN FORM_BROWSER_FORMSET FormSet,
IN FORM_BROWSER_FORM Form,
IN BROWSER_SETTING_SCOPE  SettingScope 
)

Discard data based on the input setting scope (Form, FormSet or System).

Parameters
FormSetFormSet data structure.
FormForm data structure.
SettingScopeSetting Scope for Discard action.
Return values
EFI_SUCCESSThe function completed successfully.
EFI_UNSUPPORTEDUnsupport SettingScope.

Definition at line 3208 of file Setup.c.

◆ ExecuteAction()

EFI_STATUS EFIAPI ExecuteAction ( IN UINT32  Action,
IN UINT16  DefaultId 
)

Execute the action requested by the Action parameter.

Parameters
[in]ActionExecute the request action.
[in]DefaultIdThe default Id info when need to load default value.
Return values
EFI_SUCCESSExecute the request action succss.
EFI_INVALID_PARAMETERThe input action value is invalid.

Execute the action requested by the Action parameter.

Parameters
[in]ActionExecute the request action.
[in]DefaultIdThe default Id info when need to load default value. Only used when Action is BROWSER_ACTION_DEFAULT.
Return values
EFI_SUCCESSExecute the request action succss.
EFI_INVALID_PARAMETERThe input action value is invalid.

Definition at line 6592 of file Setup.c.

◆ ExtractDefault()

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 
)

Reset Questions to their initial value or default value in a Form, Formset or System.

GetDefaultValueScope parameter decides which questions will reset to its default value.

Parameters
FormSetFormSet data structure.
FormForm data structure.
DefaultIdThe Class of the default.
SettingScopeSetting Scope for Default action.
GetDefaultValueScopeGet default value scope.
StorageGet default value only for this storage.
RetrieveValueFirstWhether call the retrieve call back to get the initial value before get default value.
SkipGetAltCfgWhether skip the get altcfg string process.
Return values
EFI_SUCCESSThe function completed successfully.
EFI_UNSUPPORTEDUnsupport SettingScope.

◆ FindNextMenu()

BOOLEAN FindNextMenu ( IN OUT UI_MENU_SELECTION Selection,
IN BROWSER_SETTING_SCOPE  SettingLevel 
)

Find menu which will show next time.

Parameters
SelectionOn input, Selection tell setup browser the information about the Selection, form and formset to be displayed. On output, Selection return the screen item that is selected by user.
SettingLevelInput Settting level, if it is FormLevel, just exit current form. else, we need to exit current formset.
Return values
TRUEExit current form.
FALSEUser press ESC and keep in current form.

Definition at line 1878 of file Presentation.c.

◆ FreeBrowserStrings()

VOID FreeBrowserStrings ( VOID  )

Free up the resource allocated for all strings required by Setup Browser.

◆ GetArrayData()

UINT64 GetArrayData ( IN VOID *  Array,
IN UINT8  Type,
IN UINTN  Index 
)

Return data element in an Array by its Index.

Parameters
ArrayThe data array.
TypeType of the data in this array.
IndexZero based index for data in this array.
Return values
ValueThe data to be returned

Definition at line 354 of file ProcessOptions.c.

◆ GetBrowserStatement()

FORM_BROWSER_STATEMENT * GetBrowserStatement ( IN FORM_DISPLAY_ENGINE_STATEMENT DisplayStatement)

Get FORM_BROWSER_STATEMENT from FORM_DISPLAY_ENGINE_STATEMENT based on the OpCode info.

Parameters
DisplayStatementThe input FORM_DISPLAY_ENGINE_STATEMENT.
Return values
FORM_BROWSER_STATEMENTThe return FORM_BROWSER_STATEMENT info.

Definition at line 878 of file Presentation.c.

◆ GetFormSetFromHiiHandle()

FORM_BROWSER_FORMSET * GetFormSetFromHiiHandle ( EFI_HII_HANDLE  Handle)

Find the matched FormSet context in the backup maintain list based on HiiHandle.

Parameters
HandleThe Hii Handle.
Returns
the found FormSet context. If no found, NULL will return.

Definition at line 6212 of file Setup.c.

◆ GetFstStgFromBrsStg()

FORMSET_STORAGE * GetFstStgFromBrsStg ( IN BROWSER_STORAGE Storage)

Get Formset_storage base on the input browser storage.

More than one formsets may share the same browser storage, this function just get the first formset storage which share the browser storage.

Parameters
Storagebrowser storage info.
Returns
Pointer to a FORMSET_STORAGE data structure.

Definition at line 510 of file IfrParse.c.

◆ GetFstStgFromVarId()

FORMSET_STORAGE * GetFstStgFromVarId ( IN FORM_BROWSER_FORMSET FormSet,
IN EFI_VARSTORE_ID  VarStoreId 
)

Get Formset_storage base on the input varstoreid info.

Parameters
FormSetPointer of the current FormSet.
VarStoreIdVarstore ID info.
Returns
Pointer to a FORMSET_STORAGE data structure.

Definition at line 467 of file IfrParse.c.

◆ GetHotKeyFromRegisterList()

BROWSER_HOT_KEY * GetHotKeyFromRegisterList ( IN EFI_INPUT_KEY KeyData)

Find the registered HotKey based on KeyData.

Parameters
[in]KeyDataA pointer to a buffer that describes the keystroke information for the hot key.
Returns
The registered HotKey context. If no found, NULL will return.

Definition at line 1360 of file FormDisplay.c.

◆ GetIfrBinaryData()

EFI_STATUS GetIfrBinaryData ( IN EFI_HII_HANDLE  Handle,
IN OUT EFI_GUID FormSetGuid,
OUT UINTN BinaryLength,
OUT UINT8 **  BinaryData 
)

Fetch the Ifr binary data of a FormSet.

Parameters
HandlePackageList Handle
FormSetGuidGUID of a formset. If not specified (NULL or zero GUID), take the first FormSet found in package list.
BinaryLengthThe length of the FormSet IFR binary.
BinaryDataThe buffer designed to receive the FormSet.
Return values
EFI_SUCCESSBuffer filled with the requested FormSet. BufferLength was updated.
EFI_INVALID_PARAMETERThe handle is unknown.
EFI_NOT_FOUNDA form or FormSet on the requested handle cannot be found with the requested FormId.

Fetch the Ifr binary data of a FormSet.

Parameters
HandlePackageList Handle
FormSetGuidOn input, GUID or class GUID of a formset. If not specified (NULL or zero GUID), take the first FormSet with class GUID EFI_HII_PLATFORM_SETUP_FORMSET_GUID found in package list. On output, GUID of the formset found(if not NULL).
BinaryLengthThe length of the FormSet IFR binary.
BinaryDataThe buffer designed to receive the FormSet.
Return values
EFI_SUCCESSBuffer filled with the requested FormSet. BufferLength was updated.
EFI_INVALID_PARAMETERThe handle is unknown.
EFI_NOT_FOUNDA form or FormSet on the requested handle cannot be found with the requested FormId.

Fetch the Ifr binary data of a FormSet.

Parameters
[in]HandlePackageList Handle
[in,out]FormSetGuidOn input, GUID or class GUID of a formset. If not specified (NULL or zero GUID), take the first FormSet with class GUID EFI_HII_PLATFORM_SETUP_FORMSET_GUID found in package list. On output, GUID of the formset found(if not NULL).
[out]BinaryLengthThe length of the FormSet IFR binary.
[out]BinaryDataThe buffer designed to receive the FormSet.
Return values
EFI_SUCCESSBuffer filled with the requested FormSet. BufferLength was updated.
EFI_INVALID_PARAMETERThe handle is unknown.
EFI_NOT_FOUNDA form or FormSet on the requested handle cannot be found with the requested FormId.

Definition at line 5843 of file Setup.c.

◆ GetQuestionDefault()

EFI_STATUS GetQuestionDefault ( IN FORM_BROWSER_FORMSET FormSet,
IN FORM_BROWSER_FORM Form,
IN FORM_BROWSER_STATEMENT Question,
IN UINT16  DefaultId 
)

Reset Question to its default value.

Parameters
FormSetThe form set.
FormThe form.
QuestionThe question.
DefaultIdThe Class of the default.
Return values
EFI_SUCCESSQuestion is reset to default value.

Definition at line 4233 of file Setup.c.

◆ GetQuestionValue()

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 
)

Get Question's current Value.

Parameters
FormSetFormSet data structure.
FormForm data structure.
QuestionQuestion to be initialized.
GetValueFromWhere to get value, may from editbuffer, buffer or hii driver.
Return values
EFI_SUCCESSThe function completed successfully.

Definition at line 1581 of file Setup.c.

◆ GetToken()

CHAR16 * GetToken ( IN EFI_STRING_ID  Token,
IN EFI_HII_HANDLE  HiiHandle 
)

Get the string based on the StringId and HII Package List Handle.

Parameters
TokenThe String's ID.
HiiHandleThe package list in the HII database to search for the specified string.
Returns
The output string.

Definition at line 191 of file FormDisplay.c.

◆ GetValueByName()

EFI_STATUS GetValueByName ( IN BROWSER_STORAGE Storage,
IN CHAR16 *  Name,
IN OUT CHAR16 **  Value,
IN GET_SET_QUESTION_VALUE_WITH  GetValueFrom 
)

Get Value for given Name from a NameValue Storage.

Parameters
StorageThe NameValue Storage.
NameThe Name.
ValueThe retured Value.
GetValueFromWhere to get source value, from EditValue or Value.
Return values
EFI_SUCCESSValue found for given Name.
EFI_NOT_FOUNDNo such Name found in NameValue storage.

Definition at line 1113 of file Setup.c.

◆ HiiToLower()

VOID EFIAPI HiiToLower ( IN EFI_STRING  ConfigString)

Converts the unicode character of the string from uppercase to lowercase. This is a internal function.

Parameters
ConfigStringString to be converted

Definition at line 454 of file BootMaintenance.c.

◆ InitializeBrowserStrings()

VOID InitializeBrowserStrings ( VOID  )

Initialize the HII String Token to the correct values.

◆ InitializeCurrentSetting()

VOID InitializeCurrentSetting ( IN OUT FORM_BROWSER_FORMSET FormSet)

Get current setting of Questions.

Parameters
FormSetFormSet data structure.

Definition at line 5784 of file Setup.c.

◆ InitializeDisplayFormData()

VOID InitializeDisplayFormData ( VOID  )

Initialize the Display form structure data.

Definition at line 727 of file Presentation.c.

◆ InitializeFormSet()

EFI_STATUS InitializeFormSet ( IN EFI_HII_HANDLE  Handle,
IN OUT EFI_GUID FormSetGuid,
OUT FORM_BROWSER_FORMSET FormSet 
)

Initialize the internal data structure of a FormSet.

Parameters
HandlePackageList Handle
FormSetGuidGUID of a formset. If not specified (NULL or zero GUID), take the first FormSet found in package list.
FormSetFormSet data structure.
Return values
EFI_SUCCESSThe function completed successfully.
EFI_NOT_FOUNDThe specified FormSet could not be found.

Initialize the internal data structure of a FormSet.

Parameters
HandlePackageList Handle
FormSetGuidOn input, GUID or class GUID of a formset. If not specified (NULL or zero GUID), take the first FormSet with class GUID EFI_HII_PLATFORM_SETUP_FORMSET_GUID found in package list. On output, GUID of the formset found(if not NULL).
FormSetFormSet data structure.
Return values
EFI_SUCCESSThe function completed successfully.
EFI_NOT_FOUNDThe specified FormSet could not be found.

Definition at line 6011 of file Setup.c.

◆ IsBrowserDataModified()

BOOLEAN EFIAPI IsBrowserDataModified ( VOID  )

Check whether the browser data has been modified.

Return values
TRUEBrowser data is changed.
FALSENo browser data is changed.

Check whether the browser data has been modified.

Return values
TRUEBrowser data is modified.
FALSENo browser data is modified.

Definition at line 6536 of file Setup.c.

◆ IsHiiHandleInBrowserContext()

BOOLEAN IsHiiHandleInBrowserContext ( EFI_HII_HANDLE  Handle)

Check whether the input HII handle is the FormSet that is being used.

Parameters
HandleThe Hii Handle.
Return values
TRUEHII handle is being used.
FALSEHII handle is not being used.

Definition at line 6245 of file Setup.c.

◆ IsNvUpdateRequiredForForm()

BOOLEAN IsNvUpdateRequiredForForm ( IN FORM_BROWSER_FORM Form)

check whether the form need to update the NV.

Parameters
FormForm data structure.
Return values
TRUENeed to update the NV.
FALSENo need to update the NV.

Update the NvUpdateRequired flag for a form.

Parameters
FormForm data structure.

Definition at line 1843 of file Presentation.c.

◆ IsNvUpdateRequiredForFormSet()

BOOLEAN IsNvUpdateRequiredForFormSet ( IN FORM_BROWSER_FORMSET FormSet)

check whether the formset need to update the NV.

Parameters
FormSetFormSet data structure.
Return values
TRUENeed to update the NV.
FALSENo need to update the NV.

Update the NV flag info for this form set.

Parameters
FormSetFormSet data structure.

Definition at line 1804 of file Presentation.c.

◆ IsQuestionValueChanged()

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 
)

Validate whether this question's value has changed.

Parameters
FormSetFormSet data structure.
FormForm data structure.
QuestionQuestion to be initialized.
GetValueFromWhere to get value, may from editbuffer, buffer or hii driver.
Return values
TRUEQuestion's value has changed.
FALSEQuestion's value has not changed

Definition at line 5011 of file Setup.c.

◆ IsResetRequired()

BOOLEAN EFIAPI IsResetRequired ( VOID  )

Check whether the Reset Required for the browser

Return values
TRUEBrowser required to reset after exit.
FALSEBrowser not need to reset after exit.

Check if user changed any option setting which needs a system reset to be effective.

Definition at line 1072 of file FrontPage.c.

◆ IsTrue()

BOOLEAN IsTrue ( IN EFI_HII_VALUE Result)

Check whether the result is TRUE or FALSE.

For the EFI_HII_VALUE value type is numeric, return TRUE if the value is not 0.

Parameters
ResultInput the result data.
Return values
TRUEThe result is TRUE.
FALSEThe result is FALSE.

Definition at line 3692 of file Expression.c.

◆ LoadFormConfig()

EFI_STATUS LoadFormConfig ( IN OUT UI_MENU_SELECTION Selection,
IN FORM_BROWSER_FORMSET FormSet,
IN FORM_BROWSER_FORM Form 
)

Initialize Question's Edit copy from Storage.

Parameters
SelectionSelection contains the information about the Selection, form and formset to be displayed. Selection action may be updated in retrieve callback. If Selection is NULL, only initialize Question value.
FormSetFormSet data structure.
FormForm data structure.
Return values
EFI_SUCCESSThe function completed successfully.

Definition at line 5131 of file Setup.c.

◆ LoadFormSetConfig()

EFI_STATUS LoadFormSetConfig ( IN OUT UI_MENU_SELECTION Selection,
IN FORM_BROWSER_FORMSET FormSet 
)

Initialize Question's Edit copy from Storage for the whole Formset.

Parameters
SelectionSelection contains the information about the Selection, form and formset to be displayed. Selection action may be updated in retrieve callback. If Selection is NULL, only initialize Question value.
FormSetFormSet data structure.
Return values
EFI_SUCCESSThe function completed successfully.

Definition at line 5181 of file Setup.c.

◆ LoadStorage()

VOID LoadStorage ( IN FORM_BROWSER_FORMSET FormSet,
IN FORMSET_STORAGE Storage 
)

Fill storage's edit copy with settings requested from Configuration Driver.

Parameters
FormSetFormSet data structure.
StorageBuffer Storage.

Definition at line 5567 of file Setup.c.

◆ NewString()

EFI_STRING_ID NewString ( IN CHAR16 *  String,
IN EFI_HII_HANDLE  HiiHandle 
)

Create a new string in HII Package List.

Parameters
StringThe String to be added
HiiHandleThe package list in the HII database to insert the specified string.
Returns
The output string.

Definition at line 981 of file Setup.c.

◆ ParseOpCodes()

EFI_STATUS ParseOpCodes ( IN FORM_BROWSER_FORMSET FormSet)

Parse opcodes in the formset IFR binary.

Parameters
FormSetPointer of the FormSet data structure.
Return values
EFI_SUCCESSOpcode parse success.
OtherOpcode parse fail.

Definition at line 1161 of file IfrParse.c.

◆ PasswordCallback()

EFI_STATUS PasswordCallback ( IN UI_MENU_SELECTION Selection,
IN FORM_BROWSER_STATEMENT Question,
IN CHAR16 *  String 
)

Password may be stored as encrypted by Configuration Driver. When change a password, user will be challenged with old password. To validate user input old password, we will send the clear text to Configuration Driver via Callback(). Configuration driver is responsible to check the passed in password and return the validation result. If validation pass, state machine in password Callback() will transit from BROWSER_STATE_VALIDATE_PASSWORD to BROWSER_STATE_SET_PASSWORD. After user type in new password twice, Callback() will be invoked to send the new password to Configuration Driver.

Parameters
SelectionPointer to UI_MENU_SELECTION.
MenuOptionThe MenuOption for this password Question.
StringThe clear text of password.
Return values
EFI_NOT_AVAILABLE_YETCallback() request to terminate password input.
Returns
In state of BROWSER_STATE_VALIDATE_PASSWORD:
Return values
EFI_SUCCESSPassword correct, Browser will prompt for new password.
EFI_NOT_READYPassword incorrect, Browser will show error message.
OtherBrowser will do nothing.
Returns
In state of BROWSER_STATE_SET_PASSWORD:
Return values
EFI_SUCCESSSet password success.
OtherSet password failed.

◆ PasswordCheck()

EFI_STATUS EFIAPI PasswordCheck ( IN FORM_DISPLAY_ENGINE_FORM Form,
IN FORM_DISPLAY_ENGINE_STATEMENT Statement,
IN EFI_STRING PasswordString  OPTIONAL 
)

Perform Password check. Passwork may be encrypted by driver that requires the specific check.

Parameters
FormForm where Password Statement is in.
StatementPassword statement
PasswordStringPassword string to be checked. It may be NULL. NULL means to restore password. "" string can be used to checked whether old password does exist.
Returns
Status Status of Password check.

Definition at line 6292 of file Setup.c.

◆ PasswordInvalid()

VOID PasswordInvalid ( VOID  )

Display error message for invalid password.

Definition at line 758 of file ProcessOptions.c.

◆ PopupErrorMessage()

UINT32 PopupErrorMessage ( IN UINT32  BrowserStatus,
IN EFI_HII_HANDLE  HiiHandle,
IN EFI_IFR_OP_HEADER *OpCode  OPTIONAL,
IN CHAR16 *  ErrorString 
)

Pop up the error info.

Parameters
BrowserStatusThe input browser status.
HiiHandleThe HiiHandle for this error opcode.
OpCodeThe opcode use to get the erro info and timeout value.
ErrorStringError string used by BROWSER_NO_SUBMIT_IF.

Pop up the error info.

Parameters
BrowserStatusThe input browser status.
HiiHandleThe Hiihandle for this opcode.
OpCodeThe opcode use to get the erro info and timeout value.
ErrorStringError string used by BROWSER_NO_SUBMIT_IF.

Definition at line 399 of file Setup.c.

◆ ProcessCallBackFunction()

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 
)

Call the call back function for the question and process the return action.

Parameters
SelectionOn input, Selection tell setup browser the information about the Selection, form and formset to be displayed. On output, Selection return the screen item that is selected by user.
FormSetThe formset this question belong to.
FormThe form this question belong to.
QuestionThe Question which need to call.
ActionThe action request.
SkipSaveOrDiscardWhether skip save or discard action.
Return values
EFI_SUCCESSThe call back function executes successfully.
Returns
Other value if the call back function failed to execute.

Definition at line 1987 of file Presentation.c.

◆ ProcessRetrieveForQuestion()

EFI_STATUS ProcessRetrieveForQuestion ( IN EFI_HII_CONFIG_ACCESS_PROTOCOL ConfigAccess,
IN FORM_BROWSER_STATEMENT Statement,
IN FORM_BROWSER_FORMSET FormSet 
)

Call the retrieve type call back function for one question to get the initialize data.

This function only used when in the initialize stage, because in this stage, the Selection->Form is not ready. For other case, use the ProcessCallBackFunction instead.

Parameters
ConfigAccessThe config access protocol produced by the hii driver.
StatementThe Question which need to call.
FormSetThe formset this question belong to.
Return values
EFI_SUCCESSThe call back function executes successfully.
Returns
Other value if the call back function failed to execute.

Definition at line 2310 of file Presentation.c.

◆ ReconnectController()

BOOLEAN ReconnectController ( IN EFI_HANDLE  DriverHandle)

Reconnect the controller.

Parameters
DriverHandleThe controller handle which need to be reconnect.
Return values
TRUEdo the reconnect behavior success.
FALSEdo the reconnect behavior failed.

Definition at line 1956 of file Presentation.c.

◆ RegiserExitHandler()

VOID EFIAPI RegiserExitHandler ( IN EXIT_HANDLER  Handler)

Register Exit handler function. When more than one handler function is registered, the latter one will override the previous one. When NULL handler is specified, the previous Exit handler will be unregistered.

Parameters
[in]HandlerPointer to handler function.

Definition at line 6519 of file Setup.c.

◆ RegisterHotKey()

EFI_STATUS EFIAPI RegisterHotKey ( IN EFI_INPUT_KEY KeyData,
IN UINT32  Action,
IN UINT16  DefaultId,
IN EFI_STRING HelpString  OPTIONAL 
)

Register the hot key with its browser action, or unregistered the hot key. Only support hot key that is not printable character (control key, function key, etc.). If the action value is zero, the hot key will be unregistered if it has been registered. If the same hot key has been registered, the new action and help string will override the previous ones.

Parameters
[in]KeyDataA pointer to a buffer that describes the keystroke information for the hot key. Its type is EFI_INPUT_KEY to be supported by all ConsoleIn devices.
[in]ActionAction value that describes what action will be trigged when the hot key is pressed.
[in]DefaultIdSpecifies the type of defaults to retrieve, which is only for DEFAULT action.
[in]HelpStringHelp string that describes the hot key information. Its value may be NULL for the unregistered hot key.
Return values
EFI_SUCCESSHot key is registered or unregistered.
EFI_INVALID_PARAMETERKeyData is NULL.
EFI_NOT_FOUNDKeyData is not found to be unregistered.
EFI_UNSUPPORTEDKey represents a printable character. It is conflicted with Browser.
EFI_ALREADY_STARTEDKey already been registered for one hot key.

Register the hot key with its browser action, or unregistered the hot key. Only support hot key that is not printable character (control key, function key, etc.). If the action value is zero, the hot key will be unregistered if it has been registered. If the same hot key has been registered, the new action and help string will override the previous ones.

Parameters
[in]KeyDataA pointer to a buffer that describes the keystroke information for the hot key. Its type is EFI_INPUT_KEY to be supported by all ConsoleIn devices.
[in]ActionAction value that describes what action will be trigged when the hot key is pressed.
[in]DefaultIdSpecifies the type of defaults to retrieve, which is only for DEFAULT action.
[in]HelpStringHelp string that describes the hot key information. Its value may be NULL for the unregistered hot key.
Return values
EFI_SUCCESSHot key is registered or unregistered.
EFI_INVALID_PARAMETERKeyData is NULL or HelpString is NULL on register.
EFI_NOT_FOUNDKeyData is not found to be unregistered.
EFI_UNSUPPORTEDKey represents a printable character. It is conflicted with Browser.
EFI_ALREADY_STARTEDKey already been registered for one hot key.

Definition at line 6438 of file Setup.c.

◆ RestoreBrowserContext()

VOID RestoreBrowserContext ( VOID  )

Restore globals used by previous call to SendForm().

Definition at line 6137 of file Setup.c.

◆ SaveBrowserContext()

VOID SaveBrowserContext ( VOID  )

Save globals used by previous call to SendForm(). SendForm() may be called from HiiConfigAccess.Callback(), this will cause SendForm() be reentried. So, save globals of previous call to SendForm() and restore them upon exit.

Definition at line 6067 of file Setup.c.

◆ SaveReminder()

UINT32 EFIAPI SaveReminder ( VOID  )

Create reminder to let user to choose save or discard the changed browser data. Caller can use it to actively check the changed browser data.

Return values
BROWSER_NO_CHANGESNo browser data is changed.
BROWSER_SAVE_CHANGESThe changed browser data is saved.
BROWSER_DISCARD_CHANGESThe changed browser data is discard.
BROWSER_KEEP_CURRENTBrowser keep current changes.

Definition at line 6682 of file Setup.c.

◆ SendForm()

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 
)

This is the routine which an external caller uses to direct the browser where to obtain it's information.

Parameters
ThisThe Form Browser protocol instanse.
HandlesA pointer to an array of Handles. If HandleCount > 1 we display a list of the formsets for the handles specified.
HandleCountThe number of Handles specified in Handle.
FormSetGuidThis field points to the EFI_GUID which must match the Guid field in the EFI_IFR_FORM_SET op-code for the specified forms-based package. If FormSetGuid is NULL, then this function will display the first found forms package.
FormIdThis field specifies which EFI_IFR_FORM to render as the first displayable page. If this field has a value of 0x0000, then the forms browser will render the specified forms in their encoded order. ScreenDimenions - This allows the browser to be called so that it occupies a portion of the physical screen instead of dynamically determining the screen dimensions. ActionRequest - Points to the action recommended by the form.
ScreenDimensionsPoints to recommended form dimensions, including any non-content area, in characters.
ActionRequestPoints to the action recommended by the form.
Return values
EFI_SUCCESSThe function completed successfully.
EFI_INVALID_PARAMETEROne of the parameters has an invalid value.
EFI_NOT_FOUNDNo valid forms could be found to display.

This is the routine which an external caller uses to direct the browser where to obtain it's information.

Parameters
ThisThe Form Browser protocol instanse.
HandlesA pointer to an array of Handles. If HandleCount > 1 we display a list of the formsets for the handles specified.
HandleCountThe number of Handles specified in Handle.
FormSetGuidThis field points to the EFI_GUID which must match the Guid field in the EFI_IFR_FORM_SET op-code for the specified forms-based package. If FormSetGuid is NULL, then this function will display the first found forms package.
FormIdThis field specifies which EFI_IFR_FORM to render as the first displayable page. If this field has a value of 0x0000, then the forms browser will render the specified forms in their encoded order.
ScreenDimensionsPoints to recommended form dimensions, including any non-content area, in characters.
ActionRequestPoints to the action recommended by the form.
Return values
EFI_SUCCESSThe function completed successfully.
EFI_INVALID_PARAMETEROne of the parameters has an invalid value.
EFI_NOT_FOUNDNo valid forms could be found to display.

Definition at line 468 of file Setup.c.

◆ SetArrayData()

VOID SetArrayData ( IN VOID *  Array,
IN UINT8  Type,
IN UINTN  Index,
IN UINT64  Value 
)

Set value of a data element in an Array by its Index.

Parameters
ArrayThe data array.
TypeType of the data in this array.
IndexZero based index for data in this array.
ValueThe value to be set.

Set value of a data element in an Array by its Index.

Parameters
[in]ArrayThe data array.
[in]TypeType of the data in this array.
[in]IndexZero based index for data in this array.
[in]ValueThe value to be set.

Definition at line 399 of file ProcessOptions.c.

◆ SetQuestionValue()

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 
)

Save Question Value to edit copy(cached) or Storage(uncached).

Parameters
FormSetFormSet data structure.
FormForm data structure.
QuestionPointer to the Question.
SetValueToUpdate the question value to editbuffer , buffer or hii driver.
Return values
EFI_SUCCESSThe function completed successfully.

Definition at line 1913 of file Setup.c.

◆ SetScope()

EFI_STATUS EFIAPI SetScope ( IN BROWSER_SETTING_SCOPE  Scope)

Configure what scope the hot key will impact. All hot keys have the same scope. The mixed hot keys with the different level are not supported. If no scope is set, the default scope will be FormSet level. After all registered hot keys are removed, previous Scope can reset to another level.

Parameters
[in]ScopeScope level to be set.
Return values
EFI_SUCCESSScope is set correctly.
EFI_INVALID_PARAMETERScope is not the valid value specified in BROWSER_SETTING_SCOPE.
EFI_UNSPPORTEDScope level is different from current one that the registered hot keys have.

Definition at line 6394 of file Setup.c.

◆ SetupBrowser()

EFI_STATUS SetupBrowser ( IN OUT UI_MENU_SELECTION Selection)

The worker function that send the displays to the screen. On output, the selection made by user is returned.

Parameters
SelectionOn input, Selection tell setup browser the information about the Selection, form and formset to be displayed. On output, Selection return the screen item that is selected by user.
Return values
EFI_SUCCESSThe page is displayed successfully.
Returns
Other value if the page failed to be diplayed.

Definition at line 2379 of file Presentation.c.

◆ SetValueByName()

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 
)

Set Value of given Name in a NameValue Storage.

Parameters
StorageThe NameValue Storage.
NameThe Name.
ValueThe Value to set.
SetValueToWhether update editValue or Value.
ReturnNodeThe node use the input name.
Return values
EFI_SUCCESSValue found for given Name.
EFI_NOT_FOUNDNo such Name found in NameValue storage.

Definition at line 1163 of file Setup.c.

◆ StorageToConfigResp()

EFI_STATUS StorageToConfigResp ( IN BROWSER_STORAGE Storage,
IN CHAR16 **  ConfigResp,
IN CHAR16 *  ConfigRequest,
IN BOOLEAN  GetEditBuf 
)

Convert setting of Buffer Storage or NameValue Storage to <ConfigResp>.

Parameters
StorageThe Storage to be conveted.
ConfigRespThe returned <ConfigResp>.
ConfigRequestThe ConfigRequest string.
GetEditBufGet the data from editbuffer or buffer.
Return values
EFI_SUCCESSConvert success.
EFI_INVALID_PARAMETERIncorrect storage type.

Definition at line 1228 of file Setup.c.

◆ SubmitForm()

EFI_STATUS SubmitForm ( IN FORM_BROWSER_FORMSET FormSet,
IN FORM_BROWSER_FORM Form,
IN BROWSER_SETTING_SCOPE  SettingScope 
)

Submit data based on the input Setting level (Form, FormSet or System).

Parameters
FormSetFormSet data structure.
FormForm data structure.
SettingScopeSetting Scope for Submit action.
Return values
EFI_SUCCESSThe function completed successfully.
EFI_UNSUPPORTEDUnsupport SettingScope.

Definition at line 3859 of file Setup.c.

◆ UiAddMenuList()

FORM_ENTRY_INFO * UiAddMenuList ( IN EFI_HII_HANDLE  HiiHandle,
IN EFI_GUID FormSetGuid,
IN UINT16  FormId,
IN UINT16  QuestionId 
)

Create a menu with specified formset GUID and form ID, and add it as a child of the given parent menu.

Parameters
HiiHandleHii handle related to this formset.
FormSetGuidThe Formset Guid of menu to be added.
FormIdThe Form ID of menu to be added.
QuestionIdThe question id of this menu to be added.
Returns
A pointer to the newly added menu or NULL if memory is insufficient.

Definition at line 85 of file Setup.c.

◆ UiCopyMenuList()

VOID UiCopyMenuList ( OUT LIST_ENTRY NewMenuListHead,
IN LIST_ENTRY CurrentMenuListHead 
)

Copy current Menu list to the new menu list.

Parameters
NewMenuListHeadNew create Menu list.
CurrentMenuListHeadCurrent Menu list.

Definition at line 289 of file Setup.c.

◆ UiFindMenuList()

FORM_ENTRY_INFO * UiFindMenuList ( IN EFI_HII_HANDLE  HiiHandle,
IN EFI_GUID FormSetGuid,
IN UINT16  FormId 
)

Search Menu with given FormSetGuid and FormId in all cached menu list.

Parameters
HiiHandleHiiHandle for FormSet.
FormSetGuidThe Formset GUID of the menu to search.
FormIdThe Form ID of menu to search.
Returns
A pointer to menu found or NULL if not found.

Definition at line 149 of file Setup.c.

◆ UiFindParentMenu()

FORM_ENTRY_INFO * UiFindParentMenu ( IN FORM_ENTRY_INFO CurrentMenu,
IN BROWSER_SETTING_SCOPE  SettingLevel 
)

Find parent menu for current menu.

Parameters
CurrentMenuCurrent Menu
SettingLevelWhether find parent menu in Form Level or Formset level. In form level, just find the parent menu; In formset level, find the parent menu which has different formset guid value.
Return values
Theparent menu for current menu.

Definition at line 213 of file Setup.c.

◆ UiFreeMenuList()

VOID UiFreeMenuList ( LIST_ENTRY MenuListHead)

Free Menu list linked list.

Parameters
MenuListHeadOne Menu list point in the menu list.

Definition at line 267 of file Setup.c.

◆ UpdateStatementStatus()

VOID UpdateStatementStatus ( IN FORM_BROWSER_FORMSET FormSet,
IN FORM_BROWSER_FORM Form,
IN BROWSER_SETTING_SCOPE  SettingScope 
)

Update the ValueChanged status for questions.

Parameters
FormSetFormSet data structure.
FormForm data structure.
SettingScopeSetting Scope for Default action.

Definition at line 963 of file Presentation.c.

◆ ValidateFormSet()

BOOLEAN ValidateFormSet ( FORM_BROWSER_FORMSET FormSet)

Validate the FormSet. If the formset is not validate, remove it from the list.

Parameters
FormSetThe input FormSet which need to validate.
Return values
TRUEThe handle is validate.
FALSEThe handle is invalidate.

Definition at line 2751 of file Setup.c.

◆ ValidateHiiHandle()

BOOLEAN ValidateHiiHandle ( EFI_HII_HANDLE  HiiHandle)

Validate the HiiHandle.

Parameters
HiiHandleThe input HiiHandle which need to validate.
Return values
TRUEThe handle is validate.
FALSEThe handle is invalidate.

Definition at line 2712 of file Setup.c.

◆ ValidateQuestion()

EFI_STATUS ValidateQuestion ( IN FORM_BROWSER_FORMSET FormSet,
IN FORM_BROWSER_FORM Form,
IN FORM_BROWSER_STATEMENT Question,
IN UINTN  Type 
)

Perform inconsistent check for a Form.

Parameters
FormSetFormSet data structure.
FormForm data structure.
QuestionThe Question to be validated.
TypeValidation type: InConsistent or NoSubmit
Return values
EFI_SUCCESSForm validation pass.
otherForm validation failed.

Perform nosubmitif check for a Form.

Parameters
FormSetFormSet data structure.
FormForm data structure.
QuestionThe Question to be validated.
TypeValidation type: NoSubmit
Return values
EFI_SUCCESSForm validation pass.
otherForm validation failed.

Definition at line 2250 of file Setup.c.

◆ ValueChangedValidation()

EFI_STATUS ValueChangedValidation ( IN FORM_BROWSER_FORMSET FormSet,
IN FORM_BROWSER_FORM Form,
IN FORM_BROWSER_STATEMENT Question 
)

Perform question check.

If one question has more than one check, process form high priority to low.

Parameters
FormSetFormSet data structure.
FormForm data structure.
QuestionThe Question to be validated.
Return values
EFI_SUCCESSForm validation pass.
otherForm validation failed.

Perform question check.

If one question has more than one check, process form high priority to low. Only one error info will be popup.

Parameters
FormSetFormSet data structure.
FormForm data structure.
QuestionThe Question to be validated.
Return values
EFI_SUCCESSForm validation pass.
otherForm validation failed.

Definition at line 2364 of file Setup.c.

◆ ValueToOption()

QUESTION_OPTION * ValueToOption ( IN FORM_BROWSER_STATEMENT Question,
IN EFI_HII_VALUE OptionValue 
)

Search an Option of a Question by its value.

Parameters
QuestionThe Question
OptionValueValue for Option to be searched.
Return values
PointerPointer to the found Option.
NULLOption not found.

Definition at line 4191 of file Setup.c.

Variable Documentation

◆ ExitHandlerFunction

EXIT_HANDLER ExitHandlerFunction
extern

Definition at line 58 of file Setup.c.

◆ gBrowserFormSetList

LIST_ENTRY gBrowserFormSetList
extern

Definition at line 45 of file Setup.c.

◆ gBrowserHotKeyList

LIST_ENTRY gBrowserHotKeyList
extern

Definition at line 46 of file Setup.c.

◆ gBrowserSettingScope

BROWSER_SETTING_SCOPE gBrowserSettingScope
extern

Definition at line 56 of file Setup.c.

◆ gCallbackReconnect

BOOLEAN gCallbackReconnect
extern

Definition at line 55 of file Setup.c.

◆ gCurrentSelection

UI_MENU_SELECTION* gCurrentSelection
extern

Definition at line 13 of file Presentation.c.

◆ gEmptyString

CHAR16* gEmptyString
extern

Definition at line 131 of file FormDisplay.c.

◆ gExitRequired

BOOLEAN gExitRequired
extern

Definition at line 53 of file Setup.c.

◆ gFlagReconnect

BOOLEAN gFlagReconnect
extern

Definition at line 54 of file Setup.c.

◆ gResetRequiredFormLevel

BOOLEAN gResetRequiredFormLevel
extern

Definition at line 51 of file Setup.c.

◆ gResetRequiredSystemLevel

BOOLEAN gResetRequiredSystemLevel
extern

Definition at line 52 of file Setup.c.

◆ mCurFakeQestId

UINT16 mCurFakeQestId
extern

Definition at line 21 of file Presentation.c.

◆ mCurrentHiiHandle

EFI_HII_HANDLE mCurrentHiiHandle
extern

Definition at line 14 of file Presentation.c.

◆ mFinishRetrieveCall

BOOLEAN mFinishRetrieveCall
extern

Definition at line 23 of file Presentation.c.

◆ mFormDisplay

EDKII_FORM_DISPLAY_ENGINE_PROTOCOL* mFormDisplay
extern

Definition at line 41 of file Setup.c.

◆ mHiiConfigRouting

EFI_HII_CONFIG_ROUTING_PROTOCOL* mHiiConfigRouting
extern

Definition at line 39 of file Setup.c.

◆ mHiiDatabase

EFI_HII_DATABASE_PROTOCOL* mHiiDatabase
extern

Definition at line 54 of file GraphicsConsole.c.

◆ mHiiPackageListUpdated

BOOLEAN mHiiPackageListUpdated
extern

Definition at line 12 of file Presentation.c.

◆ mPathFromText

EFI_DEVICE_PATH_FROM_TEXT_PROTOCOL* mPathFromText
extern

Definition at line 40 of file Setup.c.

◆ mPrivateData

SETUP_DRIVER_PRIVATE_DATA mPrivateData
extern

Definition at line 12 of file FatLiteApi.c.