HiiUtilityLib.h

Go to the documentation of this file.

 
#ifndef HII_UTILITY_LIB_
#define HII_UTILITY_LIB_
 
#include <Protocol/DisplayProtocol.h>
#include <Protocol/HiiConfigAccess.h>
 
//
// 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.
 
typedef struct {
  UINTN         Signature;
  LIST_ENTRY    Link;
  CHAR16        *Name;
  CHAR16        *Value;
} HII_NAME_VALUE_NODE;
 
#define HII_NAME_VALUE_NODE_SIGNATURE  SIGNATURE_32 ('N', 'V', 'S', 'T')
#define HII_NAME_VALUE_NODE_FROM_LINK(a)  CR (a, HII_NAME_VALUE_NODE, Link, HII_NAME_VALUE_NODE_SIGNATURE)
 
typedef union {
  EFI_STRING_ID    VarName;
  UINT16           VarOffset;
} HII_VAR_STORE_INFO;
 
typedef struct {
  UINTN             Signature;
  LIST_ENTRY        Link;
 
  UINT8             Type;          
  EFI_HII_HANDLE    HiiHandle;     
 
  UINT16            VarStoreId;    
  EFI_GUID          Guid;          
 
  CHAR16            *Name;         
  UINT16            Size;          
  UINT8             *Buffer;       
  UINT8             *EditBuffer;   
 
  UINT32            Attributes;
 
  LIST_ENTRY        NameValueList;  
 
  CHAR16            *ConfigHdr;     
  CHAR16            *ConfigRequest; 
  UINTN             ElementCount;   
  UINTN             SpareStrLen;    
} HII_FORMSET_STORAGE;
 
#define HII_STORAGE_SIGNATURE  SIGNATURE_32 ('B', 'S', 'T', 'G')
#define HII_STORAGE_FROM_LINK(a)  CR (a, HII_FORMSET_STORAGE, Link, HII_STORAGE_SIGNATURE)
 
typedef enum {
  ExpressFalse = 0,
  ExpressGrayOut,
  ExpressSuppress,
  ExpressDisable
} EXPRESS_RESULT;
 
typedef enum {
  ExpressNone = 0,
  ExpressForm,
  ExpressStatement,
  ExpressOption
} EXPRESS_LEVEL;
 
typedef union {
  EFI_HII_VALUE    Value;         
  UINT8            Format;        
  UINT8            Flags;         
  UINT8            RuleId;        
  EFI_GUID         Guid;          
 
  struct {
    EFI_QUESTION_ID    QuestionId;
    EFI_HII_VALUE      Value;
  } EqIdValData;
 
  struct {
    EFI_QUESTION_ID    QuestionId1;
    EFI_QUESTION_ID    QuestionId2;
  } EqIdIdData;
 
  struct {
    EFI_QUESTION_ID    QuestionId; 
    UINT16             ListLength;
    UINT16             *ValueList;
  } EqIdListData;
 
  struct {
    EFI_QUESTION_ID    QuestionId;
  } QuestionRef1Data;
 
  struct {
    EFI_STRING_ID    DevicePath;  
    EFI_GUID         Guid;
  } QuestionRef3Data;
 
  struct {
    HII_FORMSET_STORAGE    *VarStorage;
    HII_VAR_STORE_INFO     VarStoreInfo;
    UINT8                  ValueType;
    UINT8                  ValueWidth;
    CHAR16                 *ValueName;
  } GetSetData;
} HII_EXPRESSION_OPCODE_EXTRA;
 
typedef union _HII_DEPENDENCY_EXPRESSION HII_DEPENDENCY_EXPRESSION;
 
typedef struct {
  UINT8            Operand;
  EFI_HII_VALUE    Value;
} HII_EXPRESSION_CONSTANT;
 
typedef struct {
  UINT8    Operand;
} HII_DEPENDENCY_DUP;
 
typedef struct {
  UINT8              Operand;
  EFI_QUESTION_ID    QuestionId;
  EFI_HII_VALUE      Value;
} HII_DEPENDENCY_EQ_ID_VAL;
 
typedef struct {
  UINT8              Operand;
  EFI_QUESTION_ID    QuestionId1;
  EFI_QUESTION_ID    QuestionId2;
} HII_DEPENDENCY_EQ_ID_ID;
 
typedef struct {
  UINT8              Operand;
  EFI_QUESTION_ID    QuestionId;
  UINT16             ListLength;
  UINT16             *ValueList;
} HII_DEPENDENCY_EQ_ID_VAL_LIST;
 
typedef struct {
  UINT8              Operand;
  EFI_QUESTION_ID    QuestionId;
} HII_DEPENDENCY_QUESTION_REF1;
 
typedef struct {
  UINT8    Operand;
  UINT8    RuleId;
} HII_DEPENDENCY_RULE_REF;
 
typedef struct {
  UINT8            Operand;
  EFI_HII_VALUE    Value;
} HII_DEPENDENCY_STRING_REF1;
 
typedef struct {
  UINT8              Operand;
  EFI_QUESTION_ID    QuestionId;
} HII_DEPENDENCY_THIS;
 
typedef struct {
  UINT8       Operand;
  EFI_GUID    Permissions;
} HII_DEPENDENCY_SECURITY;
 
typedef struct  {
  UINT8                  Operand;
  HII_FORMSET_STORAGE    *VarStorage;
  HII_VAR_STORE_INFO     VarStoreInfo;
  UINT8                  ValueType;
  UINT8                  ValueWidth;
  CHAR16                 *ValueName;
} HII_DEPENDENCY_GET;
 
typedef struct  {
  UINT8                        Operand;
  HII_DEPENDENCY_EXPRESSION    *SubExpression;
} HII_DEPENDENCY_LENGTH;
 
typedef struct  {
  UINT8                        Operand;
  HII_DEPENDENCY_EXPRESSION    *SubExpression;
} HII_DEPENDENCY_BITWISE_NOT;
 
typedef struct  {
  UINT8                        Operand;
  HII_DEPENDENCY_EXPRESSION    *SubExpression;
} HII_DEPENDENCY_STRING_REF2;
 
typedef struct  {
  UINT8                        Operand;
  HII_DEPENDENCY_EXPRESSION    *SubExpression;
} HII_DEPENDENCY_QUESTION_REF2;
 
typedef struct  {
  UINT8                        Operand;
  EFI_STRING_ID                DevicePath;
  EFI_GUID                     Guid;
  HII_DEPENDENCY_EXPRESSION    *SubExpression;
} HII_DEPENDENCY_QUESTION_REF3;
 
typedef struct  {
  UINT8                        Operand;
  HII_DEPENDENCY_EXPRESSION    *SubExpression;
} HII_DEPENDENCY_TO_BOOLEAN;
 
typedef struct  {
  UINT8                        Operand;
  UINT8                        Format;
  HII_DEPENDENCY_EXPRESSION    *SubExpression;
} HII_DEPENDENCY_TO_STRING;
 
typedef struct  {
  UINT8                        Operand;
  HII_DEPENDENCY_EXPRESSION    *SubExpression;
} HII_DEPENDENCY_TO_UINT;
 
typedef struct  {
  UINT8                        Operand;
  HII_DEPENDENCY_EXPRESSION    *SubExpression;
} HII_DEPENDENCY_TO_UPPER;
 
typedef struct  {
  UINT8                        Operand;
  HII_DEPENDENCY_EXPRESSION    *SubExpression;
} HII_DEPENDENCY_TO_LOWER;
 
typedef struct  {
  UINT8                        Operand;
  HII_FORMSET_STORAGE          *VarStorage;
  HII_VAR_STORE_INFO           VarStoreInfo;
  UINT8                        ValueType;
  UINT8                        ValueWidth;
  CHAR16                       *ValueName;
  HII_DEPENDENCY_EXPRESSION    *SubExpression;
} HII_DEPENDENCY_SET;
 
typedef struct {
  UINT8                        Operand;
  HII_DEPENDENCY_EXPRESSION    *SubExpression;
} HII_DEPENDENCY_NOT;
 
typedef struct {
  UINT8                        Operand;
  HII_DEPENDENCY_EXPRESSION    *LeftStringExp;
  HII_DEPENDENCY_EXPRESSION    *RightStringExp;
} HII_DEPENDENCY_CATENATE;
 
typedef struct {
  UINT8                        Operand;
  HII_DEPENDENCY_EXPRESSION    *StringExp;
  HII_DEPENDENCY_EXPRESSION    *PatternExp;
} HII_DEPENDENCY_MATCH;
 
typedef struct {
  UINT8                        Operand;
  EFI_GUID                     SyntaxType;
  HII_DEPENDENCY_EXPRESSION    *StringExp;
  HII_DEPENDENCY_EXPRESSION    *PatternExp;
} HII_DEPENDENCY_MATCH2;
 
typedef struct {
  UINT8                        Operand;
  HII_DEPENDENCY_EXPRESSION    *RightHandExp;
  HII_DEPENDENCY_EXPRESSION    *LeftHandExp;
} HII_DEPENDENCY_MULT;
 
typedef struct {
  UINT8                        Operand;
  HII_DEPENDENCY_EXPRESSION    *RightHandExp;    
  HII_DEPENDENCY_EXPRESSION    *LeftHandExp;     
} HII_DEPENDENCY_DIV;
 
typedef struct {
  UINT8                        Operand;
  HII_DEPENDENCY_EXPRESSION    *RightHandExp;    
  HII_DEPENDENCY_EXPRESSION    *LeftHandExp;     
} HII_DEPENDENCY_MOD;
 
typedef struct {
  UINT8                        Operand;
  HII_DEPENDENCY_EXPRESSION    *RightHandExp;     
  HII_DEPENDENCY_EXPRESSION    *LeftHandExp;      
} HII_DEPENDENCY_ADD;
 
typedef struct {
  UINT8                        Operand;
  HII_DEPENDENCY_EXPRESSION    *RightHandExp;    
  HII_DEPENDENCY_EXPRESSION    *LeftHandExp;     
} HII_DEPENDENCY_SUBTRACT;
 
typedef struct {
  UINT8                        Operand;
  HII_DEPENDENCY_EXPRESSION    *RightHandExp;
  HII_DEPENDENCY_EXPRESSION    *LeftHandExp;
} HII_DEPENDENCY_SHIFT_LEFT;
 
typedef struct {
  UINT8                        Operand;
  HII_DEPENDENCY_EXPRESSION    *RightHandExp;
  HII_DEPENDENCY_EXPRESSION    *LeftHandExp;
} HII_DEPENDENCY_SHIFT_RIGHT;
 
typedef struct {
  UINT8                        Operand;
  HII_DEPENDENCY_EXPRESSION    *RightHandExp;
  HII_DEPENDENCY_EXPRESSION    *LeftHandExp;
} HII_DEPENDENCY_GREATER_THAN;
 
typedef struct {
  UINT8                        Operand;
  HII_DEPENDENCY_EXPRESSION    *RightHandExp;
  HII_DEPENDENCY_EXPRESSION    *LeftHandExp;
} HII_DEPENDENCY_GREATER_EQUAL;
 
typedef struct {
  UINT8                        Operand;
  HII_DEPENDENCY_EXPRESSION    *RightHandExp;
  HII_DEPENDENCY_EXPRESSION    *LeftHandExp;
} HII_DEPENDENCY_LESS_THAN;
 
typedef struct {
  UINT8                        Operand;
  HII_DEPENDENCY_EXPRESSION    *RightHandExp;
  HII_DEPENDENCY_EXPRESSION    *LeftHandExp;
} HII_DEPENDENCY_LESS_EQUAL;
 
typedef struct {
  UINT8                        Operand;
  HII_DEPENDENCY_EXPRESSION    *SubExpression1;
  HII_DEPENDENCY_EXPRESSION    *SubExpression2;
} HII_DEPENDENCY_EQUAL;
 
typedef struct {
  UINT8                        Operand;
  HII_DEPENDENCY_EXPRESSION    *SubExpression1;
  HII_DEPENDENCY_EXPRESSION    *SubExpression2;
} HII_DEPENDENCY_NOT_EQUAL;
 
typedef struct {
  UINT8                        Operand;
  HII_DEPENDENCY_EXPRESSION    *SubExpression1;
  HII_DEPENDENCY_EXPRESSION    *SubExpression2;
} HII_DEPENDENCY_BITWISE_AND;
 
typedef struct {
  UINT8                        Operand;
  HII_DEPENDENCY_EXPRESSION    *SubExpression1;
  HII_DEPENDENCY_EXPRESSION    *SubExpression2;
} HII_DEPENDENCY_BITWISE_OR;
 
typedef struct {
  UINT8                        Operand;
  HII_DEPENDENCY_EXPRESSION    *SubExpression1;
  HII_DEPENDENCY_EXPRESSION    *SubExpression2;
} HII_DEPENDENCY_AND;
 
typedef struct {
  UINT8                        Operand;
  HII_DEPENDENCY_EXPRESSION    *SubExpression1;
  HII_DEPENDENCY_EXPRESSION    *SubExpression2;
} HII_DEPENDENCY_OR;
 
typedef struct  {
  UINT8                        Operand;
  HII_DEPENDENCY_EXPRESSION    *CondTrueValExp;  
  HII_DEPENDENCY_EXPRESSION    *CondFalseValExp; 
  HII_DEPENDENCY_EXPRESSION    *ConditionExp;    
} HII_DEPENDENCY_CONDITIONAL;
 
typedef struct  {
  UINT8                        Operand;
  UINT8                        Format;
  HII_DEPENDENCY_EXPRESSION    *IndexExp;             
  HII_DEPENDENCY_EXPRESSION    *StringToCompWithExp;  
  HII_DEPENDENCY_EXPRESSION    *StringToSearchExp;    
} HII_DEPENDENCY_FIND;
 
typedef struct  {
  UINT8                        Operand;
  HII_DEPENDENCY_EXPRESSION    *LengthExp;         
  HII_DEPENDENCY_EXPRESSION    *IndexExp;          
  HII_DEPENDENCY_EXPRESSION    *StringOrBufferExp; 
} HII_DEPENDENCY_MID;
 
typedef struct  {
  UINT8                        Operand;
  HII_DEPENDENCY_EXPRESSION    *IndexExp;           
  HII_DEPENDENCY_EXPRESSION    *DelimiterExp;       
  HII_DEPENDENCY_EXPRESSION    *StringToSearchExp;  
} HII_DEPENDENCY_TOKEN;
 
typedef struct  {
  UINT8                        Operand;
  UINT8                        Flags;
  HII_DEPENDENCY_EXPRESSION    *IndexExp;            
  HII_DEPENDENCY_EXPRESSION    *CharsetExp;          
  HII_DEPENDENCY_EXPRESSION    *StringToSearchExp;   
} HII_DEPENDENCY_SPAN;
 
typedef struct {
  HII_DEPENDENCY_EXPRESSION    *MatchExp;
  HII_DEPENDENCY_EXPRESSION    *ReturnExp;
} HII_DEPENDENCY_EXPRESSION_PAIR;
 
typedef struct  {
  UINT8                             Operand;
  HII_DEPENDENCY_EXPRESSION         *SubExp;
  HII_DEPENDENCY_EXPRESSION_PAIR    *ExpPair;
  UINT8                             ExpPairNo;
} HII_DEPENDENCY_MAP;
 
union _HII_DEPENDENCY_EXPRESSION {
  HII_EXPRESSION_CONSTANT          ConstantExp;
  HII_DEPENDENCY_DUP               DupExp;
  HII_DEPENDENCY_EQ_ID_VAL         EqIdValExp;
  HII_DEPENDENCY_EQ_ID_ID          EqIdIdExp;
  HII_DEPENDENCY_EQ_ID_VAL_LIST    EqIdListExp;
  HII_DEPENDENCY_QUESTION_REF1     QuestionRef1Exp;
  HII_DEPENDENCY_RULE_REF          RuleRefExp;
  HII_DEPENDENCY_STRING_REF1       StringRef1Exp;
  HII_DEPENDENCY_THIS              ThisExp;
  HII_DEPENDENCY_SECURITY          SecurityExp;
  HII_DEPENDENCY_GET               GetExp;
 
  HII_DEPENDENCY_LENGTH            LengthExp;
  HII_DEPENDENCY_BITWISE_NOT       BitWiseNotExp;
  HII_DEPENDENCY_STRING_REF2       StringRef2Exp;
  HII_DEPENDENCY_QUESTION_REF2     QuestionRef2Exp;
  HII_DEPENDENCY_QUESTION_REF3     QuestionRef3Exp;
  HII_DEPENDENCY_TO_BOOLEAN        ToBooleanExp;
  HII_DEPENDENCY_TO_STRING         ToStringExp;
  HII_DEPENDENCY_TO_UINT           ToUintExp;
  HII_DEPENDENCY_TO_UPPER          ToUpperExp;
  HII_DEPENDENCY_TO_LOWER          ToLowerExp;
  HII_DEPENDENCY_SET               SetExp;
  HII_DEPENDENCY_NOT               NotExp;
 
  HII_DEPENDENCY_CATENATE          CatenateExp;
  HII_DEPENDENCY_MATCH             MatchExp;
  HII_DEPENDENCY_MATCH2            Match2Exp;
  HII_DEPENDENCY_MULT              MultExp;
  HII_DEPENDENCY_DIV               DivExp;
  HII_DEPENDENCY_MOD               ModExp;
  HII_DEPENDENCY_ADD               AddExp;
  HII_DEPENDENCY_SUBTRACT          SubtractExp;
  HII_DEPENDENCY_SHIFT_LEFT        ShiftLeftExp;
  HII_DEPENDENCY_SHIFT_RIGHT       ShiftRightExp;
  HII_DEPENDENCY_GREATER_THAN      GreaterThanExp;
  HII_DEPENDENCY_GREATER_EQUAL     GreaterEqualExp;
  HII_DEPENDENCY_LESS_THAN         LessThanExp;
  HII_DEPENDENCY_LESS_EQUAL        LessEqualExp;
  HII_DEPENDENCY_EQUAL             EqualExp;
  HII_DEPENDENCY_NOT_EQUAL         NotEqualExp;
  HII_DEPENDENCY_BITWISE_AND       BitwiseAndExp;
  HII_DEPENDENCY_BITWISE_OR        BitwiseOrExp;
  HII_DEPENDENCY_AND               AndExp;
  HII_DEPENDENCY_OR                OrExp;
 
  HII_DEPENDENCY_CONDITIONAL       ConditionalExp;
  HII_DEPENDENCY_FIND              FindExp;
  HII_DEPENDENCY_MID               MidExp;
  HII_DEPENDENCY_TOKEN             TokenExp;
  HII_DEPENDENCY_SPAN              SpanExp;
  HII_DEPENDENCY_MAP               MapExp;
};
 
typedef struct {
  UINTN                          Signature;
  LIST_ENTRY                     Link;
  UINT8                          Operand;
  HII_EXPRESSION_OPCODE_EXTRA    ExtraData;
  LIST_ENTRY                     MapExpressionList; 
} HII_EXPRESSION_OPCODE;
 
#define HII_EXPRESSION_OPCODE_SIGNATURE  SIGNATURE_32 ('E', 'X', 'O', 'P')
#define HII_EXPRESSION_OPCODE_FROM_LINK(a)  CR (a, HII_EXPRESSION_OPCODE, Link, HII_EXPRESSION_OPCODE_SIGNATURE)
 
typedef struct {
  EFI_STRING_ID    WarningIfError;
  UINT8            TimeOut;
} HII_WARNING_IF_DATA;
 
typedef union {
  UINT8                  RuleId;      
  EFI_STRING_ID          Error;       
  HII_WARNING_IF_DATA    WarningIfData;
} HII_EXTRA_DATA;
 
typedef struct {
  UINTN                        Signature;
  LIST_ENTRY                   Link;
  UINT8                        Type;               
  EFI_IFR_OP_HEADER            *OpCode;            
  LIST_ENTRY                   OpCodeListHead;     
  HII_DEPENDENCY_EXPRESSION    *RootDependencyExp; 
  HII_EXTRA_DATA               ExtraData;
  EFI_HII_VALUE                Result;             
} HII_EXPRESSION;
 
#define HII_EXPRESSION_SIGNATURE  SIGNATURE_32 ('F', 'E', 'X', 'P')
#define HII_EXPRESSION_FROM_LINK(a)  CR (a, HII_EXPRESSION, Link, HII_EXPRESSION_SIGNATURE)
 
typedef struct {
  UINTN             Signature;
  UINTN             Count;
  HII_EXPRESSION    *Expression[1];    
} HII_EXPRESSION_LIST;
 
#define HII_EXPRESSION_LIST_SIGNATURE  SIGNATURE_32 ('F', 'E', 'X', 'R')
 
typedef struct {
  UINT8                 Type;
  EFI_IFR_TYPE_VALUE    Value;
  UINT8                 *Buffer;
  UINT16                BufferLen;
  UINT8                 BufferValueType; 
} HII_STATEMENT_VALUE;
 
typedef struct {
  UINTN                  Signature;
  LIST_ENTRY             Link;
 
  UINT16                 DefaultId;
  HII_STATEMENT_VALUE    Value;            
 
  HII_EXPRESSION         *ValueExpression; 
} HII_QUESTION_DEFAULT;
 
#define HII_QUESTION_DEFAULT_SIGNATURE  SIGNATURE_32 ('Q', 'D', 'F', 'T')
#define HII_QUESTION_DEFAULT_FROM_LINK(a)  CR (a, HII_QUESTION_DEFAULT, Link, HII_QUESTION_DEFAULT_SIGNATURE)
 
#define HII_QUESTION_OPTION_SIGNATURE  SIGNATURE_32 ('Q', 'O', 'P', 'T')
 
typedef struct {
  UINTN                    Signature;
  LIST_ENTRY               Link;
 
  EFI_IFR_ONE_OF_OPTION    *OpCode;             
 
  EFI_STRING_ID            Text;
  UINT8                    Flags;
  HII_STATEMENT_VALUE      Value;
  EFI_IMAGE_ID             ImageId;
 
  HII_EXPRESSION_LIST      *SuppressExpression; 
} HII_QUESTION_OPTION;
 
#define HII_QUESTION_OPTION_FROM_LINK(a)  CR (a, HII_QUESTION_OPTION, Link, HII_QUESTION_OPTION_SIGNATURE)
 
typedef struct {
  UINTN            Signature;
  LIST_ENTRY       Link;
 
  UINT16           DefaultId;
  EFI_STRING_ID    DefaultName;
} HII_FORMSET_DEFAULTSTORE;
 
#define HII_FORMSET_DEFAULTSTORE_SIGNATURE  SIGNATURE_32 ('F', 'D', 'F', 'S')
#define HII_FORMSET_DEFAULTSTORE_FROM_LINK(a)  CR (a, HII_FORMSET_DEFAULTSTORE, Link, HII_FORMSET_DEFAULTSTORE_SIGNATURE)
 
typedef union {
  UINT8             Flags;
  EFI_STRING_ID     TextTwo;
  EFI_DEFAULT_ID    DefaultId;
  EFI_STRING_ID     QuestionConfig;
  EFI_GUID          Guid;
 
  struct {
    UINT8       Flags;
    UINT64      Minimum;            
    UINT64      Maximum;            
    UINT64      Step;
    EFI_GUID    Guid;
  } NumData;
 
  struct {
    UINT8    Flags;
    UINT8    MaxContainers;         
  } OrderListData;
 
  struct {
    UINT8    Flags;
    UINT8    MinSize;
    UINT8    MaxSize;
  } StrData;
 
  struct {
    UINT16    MinSize;
    UINT16    MaxSize;
  } PwdData;
} HII_STATEMENT_EXTRA;
 
typedef struct _HII_STATEMENT HII_STATEMENT;
struct _HII_STATEMENT {
  UINTN                  Signature;
  LIST_ENTRY             Link;
 
  UINT8                  Operand;         
  EFI_IFR_OP_HEADER      *OpCode;
 
  EFI_STRING_ID          Prompt;
  EFI_STRING_ID          Help;
 
  EFI_QUESTION_ID        QuestionId;      
  EFI_VARSTORE_ID        VarStoreId;      
  HII_VAR_STORE_INFO     VarStoreInfo;    
  UINT8                  QuestionFlags;   
 
  BOOLEAN                QuestionReferToBitField;   
  UINT16                 StorageWidth;              
  UINT16                 BitStorageWidth;           
  UINT16                 BitVarOffset;              
  CHAR16                 *VariableName;             
  CHAR16                 *BlockName;                
 
  HII_FORMSET_STORAGE    *Storage;                  
  HII_STATEMENT_EXTRA    ExtraData;
 
  BOOLEAN                Locked;                    
 
  HII_STATEMENT_VALUE    Value;
 
 
  HII_STATEMENT          *ParentStatement;     
  HII_EXPRESSION_LIST    *ExpressionList;      
  HII_EXPRESSION         *ValueExpression;     
 
  EFI_IMAGE_ID           ImageId;              
  UINT8                  RefreshInterval;      
 
  LIST_ENTRY             DefaultListHead;      
  LIST_ENTRY             OptionListHead;       
  LIST_ENTRY             InconsistentListHead; 
  LIST_ENTRY             NoSubmitListHead;     
  LIST_ENTRY             WarningListHead;      
 
  HII_EXPRESSION         *ReadExpression;       
  HII_EXPRESSION         *WriteExpression;      
};
 
#define HII_STATEMENT_SIGNATURE  SIGNATURE_32 ('H', 'S', 'T', 'A')
#define HII_STATEMENT_FROM_LINK(a)  CR (a, HII_STATEMENT, Link, HII_STATEMENT_SIGNATURE)
 
#define STANDARD_MAP_FORM_TYPE  0x01
 
typedef struct {
  UINTN                  Signature;
  LIST_ENTRY             Link;
 
  UINT16                 FormId;              
  EFI_STRING_ID          FormTitle;           
  UINT16                 FormType;            
 
  EFI_IMAGE_ID           ImageId;             
 
  BOOLEAN                ModalForm;           
  BOOLEAN                Locked;              
  EFI_GUID               RefreshGuid;         
 
  LIST_ENTRY             StatementListHead;   
  LIST_ENTRY             ConfigRequestHead;   
  LIST_ENTRY             RuleListHead;        
  HII_EXPRESSION_LIST    *SuppressExpression; 
} HII_FORM;
 
#define HII_FORM_SIGNATURE  SIGNATURE_32 ('F', 'F', 'R', 'M')
#define HII_FORM_FROM_LINK(a)  CR (a, HII_FORM, Link, HII_FORM_SIGNATURE)
 
typedef struct {
  UINTN                             Signature;
  LIST_ENTRY                        Link;
 
  EFI_HII_HANDLE                    HiiHandle;             
  EFI_HANDLE                        DriverHandle;          
  EFI_HII_CONFIG_ACCESS_PROTOCOL    *ConfigAccess;         
  EFI_DEVICE_PATH_PROTOCOL          *DevicePath;
 
  UINTN                             IfrBinaryLength;       
  UINT8                             *IfrBinaryData;        
 
  EFI_GUID                          Guid;                  
  EFI_STRING_ID                     FormSetTitle;          
  EFI_STRING_ID                     Help;                  
 
  UINT8                             NumberOfClassGuid;     
  EFI_GUID                          ClassGuid[3];          
 
  EFI_IMAGE_ID                      ImageId;               
 
  LIST_ENTRY                        StatementListOSF;      
  LIST_ENTRY                        StorageListHead;       
  LIST_ENTRY                        DefaultStoreListHead;  
  LIST_ENTRY                        FormListHead;          
} HII_FORMSET;
 
#define HII_FORMSET_SIGNATURE  SIGNATURE_32 ('H', 'I', 'F', 'S')
#define HII_FORMSET_FROM_LINK(a)  CR (a, HII_FORMSET, Link, HII_FORMSET_SIGNATURE)
 
typedef enum {
  GetSetValueWithBuffer = 0,       
  GetSetValueWithHiiDriver,        
  GetSetValueWithBoth,             
  GetSetValueWithMax               
} GET_SET_QUESTION_VALUE_WITH;
 
EFI_STATUS
CreateFormSetFromHiiHandle (
  IN     EFI_HII_HANDLE  Handle,
  IN OUT EFI_GUID        *FormSetGuid,
  OUT HII_FORMSET        *FormSet
  );
 
VOID
InitializeFormSet (
  IN OUT HII_FORMSET  *FormSet
  );
 
VOID
DestroyFormSet (
  IN OUT HII_FORMSET  *FormSet
  );
 
EFI_STATUS
SetQuestionValue (
  IN     HII_FORMSET          *FormSet,
  IN     HII_FORM             *Form,
  IN OUT HII_STATEMENT        *Question,
  IN     HII_STATEMENT_VALUE  *QuestionValue
  );
 
HII_STATEMENT_VALUE *
RetrieveQuestion (
  IN     HII_FORMSET    *FormSet,
  IN     HII_FORM       *Form,
  IN OUT HII_STATEMENT  *Question
  );
 
EFI_STATUS
GetQuestionValue (
  IN HII_FORMSET                  *FormSet,
  IN HII_FORM                     *Form,
  IN OUT HII_STATEMENT            *Question,
  IN GET_SET_QUESTION_VALUE_WITH  GetValueFrom
  );
 
EFI_STATUS
SubmitForm (
  IN     HII_FORMSET  *FormSet,
  IN     HII_FORM     *Form
  );
 
EFI_STATUS
EvaluateHiiExpression (
  IN     HII_FORMSET     *FormSet,
  IN     HII_FORM        *Form,
  IN OUT HII_EXPRESSION  *Expression
  );
 
EFI_STATUS
GetHiiExpressionDependency (
  IN HII_EXPRESSION  *Expression
  );
 
EFI_STATUS
GetQuestionDefault (
  IN HII_FORMSET           *FormSet,
  IN HII_FORM              *Form,
  IN HII_STATEMENT         *Question,
  IN UINT16                DefaultId,
  OUT HII_STATEMENT_VALUE  *DefaultValue
  );
 
EXPRESS_RESULT
EvaluateExpressionList (
  IN HII_EXPRESSION_LIST  *ExpList,
  IN BOOLEAN              Evaluate,
  IN HII_FORMSET          *FormSet OPTIONAL,
  IN HII_FORM             *Form OPTIONAL
  );
 
#endif // HII_UTILITY_LIB_