[mirror_edk2.git] / EdkCompatibilityPkg / Compatibility / FrameworkHiiToUefiHiiThunk / UefiIfrParser.h

/** @file\r
  Function and Macro defintions for IFR parsing. To get the default value from IFR package, the IFR\r
  opcode needs to be parsed. Most of code is taken from MdeModulePkg\Universal\SetupBrowserDxe\IfrParse.c.\r
\r
  Copyright (c) 2008, Intel Corporation\r
  All rights reserved. This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#ifndef _HII_THUNK_UEFI_IFR_PARSER_\r
#define _HII_THUNK_UEFI_IFR_PARSER_\r
\r
#include <PiDxe.h>\r
\r
#include <Protocol/Print.h>\r
#include <Protocol/HiiConfigAccess.h>\r
#include <Protocol/HiiConfigRouting.h>\r
#include <Protocol/HiiDatabase.h>\r
#include <Protocol/HiiString.h>\r
\r
//\r
// IFR relative definition\r
//\r
#define EFI_HII_EXPRESSION_INCONSISTENT_IF   0\r
#define EFI_HII_EXPRESSION_NO_SUBMIT_IF      1\r
#define EFI_HII_EXPRESSION_GRAY_OUT_IF       2\r
#define EFI_HII_EXPRESSION_SUPPRESS_IF       3\r
#define EFI_HII_EXPRESSION_DISABLE_IF        4\r
#define EFI_HII_EXPRESSION_VALUE             5\r
#define EFI_HII_EXPRESSION_RULE              6\r
\r
#define EFI_HII_VARSTORE_BUFFER              0\r
#define EFI_HII_VARSTORE_NAME_VALUE          1\r
#define EFI_HII_VARSTORE_EFI_VARIABLE        2\r
\r
#define FORM_INCONSISTENT_VALIDATION         0\r
#define FORM_NO_SUBMIT_VALIDATION            1\r
\r
extern EFI_GUID  gTianoHiiIfrGuid;\r
\r
\r
typedef struct {\r
  UINT8               Type;\r
  EFI_IFR_TYPE_VALUE  Value;\r
} EFI_HII_VALUE;\r
\r
#define NAME_VALUE_NODE_SIGNATURE  EFI_SIGNATURE_32 ('N', 'V', 'S', 'T')\r
\r
typedef struct {\r
  UINTN            Signature;\r
  LIST_ENTRY       Link;\r
  CHAR16           *Name;\r
  CHAR16           *Value;\r
  CHAR16           *EditValue;\r
} NAME_VALUE_NODE;\r
\r
#define NAME_VALUE_NODE_FROM_LINK(a)  CR (a, NAME_VALUE_NODE, Link, NAME_VALUE_NODE_SIGNATURE)\r
\r
#define FORMSET_STORAGE_SIGNATURE  EFI_SIGNATURE_32 ('F', 'S', 'T', 'G')\r
\r
typedef struct {\r
  UINTN            Signature;\r
  LIST_ENTRY       Link;\r
\r
  UINT8            Type;           // Storage type\r
\r
  UINT16           VarStoreId;\r
  EFI_GUID         Guid;\r
\r
  CHAR16           *Name;          // For EFI_IFR_VARSTORE\r
  UINT16           Size;\r
  UINT8            *Buffer;\r
  UINT8            *EditBuffer;    // Edit copy for Buffer Storage\r
\r
  LIST_ENTRY       NameValueListHead; // List of NAME_VALUE_NODE\r
\r
  UINT32           Attributes;     // For EFI_IFR_VARSTORE_EFI: EFI Variable attribute\r
\r
  CHAR16           *ConfigHdr;     // <ConfigHdr>\r
  CHAR16           *ConfigRequest; // <ConfigRequest> = <ConfigHdr> + <RequestElement>\r
  UINTN            ElementCount;   // Number of <RequestElement> in the <ConfigRequest>\r
  UINTN            SpareStrLen;    // Spare length of ConfigRequest string buffer\r
} FORMSET_STORAGE;\r
\r
#define FORMSET_STORAGE_FROM_LINK(a)  CR (a, FORMSET_STORAGE, Link, FORMSET_STORAGE_SIGNATURE)\r
\r
#define EXPRESSION_OPCODE_SIGNATURE  EFI_SIGNATURE_32 ('E', 'X', 'O', 'P')\r
\r
typedef struct {\r
  UINTN             Signature;\r
  LIST_ENTRY        Link;\r
\r
  UINT8             Operand;\r
\r
  UINT8             Format;      // For EFI_IFR_TO_STRING, EFI_IFR_FIND\r
  UINT8             Flags;       // For EFI_IFR_SPAN\r
  UINT8             RuleId;      // For EFI_IFR_RULE_REF\r
\r
  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\r
\r
  EFI_QUESTION_ID   QuestionId;  // For EFI_IFR_EQ_ID_ID, EFI_IFR_EQ_ID_LIST, EFI_IFR_QUESTION_REF1\r
  EFI_QUESTION_ID   QuestionId2;\r
\r
  UINT16            ListLength;  // For EFI_IFR_EQ_ID_LIST\r
  UINT16            *ValueList;\r
\r
  EFI_STRING_ID     DevicePath;  // For EFI_IFR_QUESTION_REF3_2, EFI_IFR_QUESTION_REF3_3\r
  EFI_GUID          Guid;\r
} EXPRESSION_OPCODE;\r
\r
#define EXPRESSION_OPCODE_FROM_LINK(a)  CR (a, EXPRESSION_OPCODE, Link, EXPRESSION_OPCODE_SIGNATURE)\r
\r
#define FORM_EXPRESSION_SIGNATURE  EFI_SIGNATURE_32 ('F', 'E', 'X', 'P')\r
\r
typedef struct {\r
  UINTN             Signature;\r
  LIST_ENTRY        Link;\r
\r
  UINT8             Type;            // Type for this expression\r
\r
  UINT8             RuleId;          // For EFI_IFR_RULE only\r
  EFI_STRING_ID     Error;           // For EFI_IFR_NO_SUBMIT_IF, EFI_IFR_INCONSISTENT_IF only\r
\r
  EFI_HII_VALUE     Result;          // Expression evaluation result\r
\r
  LIST_ENTRY        OpCodeListHead;  // OpCodes consist of this expression (EXPRESSION_OPCODE)\r
} FORM_EXPRESSION;\r
\r
#define FORM_EXPRESSION_FROM_LINK(a)  CR (a, FORM_EXPRESSION, Link, FORM_EXPRESSION_SIGNATURE)\r
\r
#define QUESTION_DEFAULT_SIGNATURE  EFI_SIGNATURE_32 ('Q', 'D', 'F', 'T')\r
\r
typedef struct {\r
  UINTN               Signature;\r
  LIST_ENTRY          Link;\r
\r
  UINT16              DefaultId;\r
  EFI_HII_VALUE       Value;              // Default value\r
\r
  FORM_EXPRESSION     *ValueExpression;   // Not-NULL indicates default value is provided by EFI_IFR_VALUE\r
} QUESTION_DEFAULT;\r
\r
#define QUESTION_DEFAULT_FROM_LINK(a)  CR (a, QUESTION_DEFAULT, Link, QUESTION_DEFAULT_SIGNATURE)\r
\r
#define QUESTION_OPTION_SIGNATURE  EFI_SIGNATURE_32 ('Q', 'O', 'P', 'T')\r
\r
typedef struct {\r
  UINTN               Signature;\r
  LIST_ENTRY          Link;\r
\r
  EFI_STRING_ID       Text;\r
  UINT8               Flags;\r
  EFI_HII_VALUE       Value;\r
  EFI_IMAGE_ID        ImageId;\r
\r
  FORM_EXPRESSION     *SuppressExpression; // Non-NULL indicates nested inside of SuppressIf\r
} QUESTION_OPTION;\r
\r
#define QUESTION_OPTION_FROM_LINK(a)  CR (a, QUESTION_OPTION, Link, QUESTION_OPTION_SIGNATURE)\r
\r
#define FORM_BROWSER_STATEMENT_SIGNATURE  EFI_SIGNATURE_32 ('F', 'S', 'T', 'A')\r
typedef struct {\r
  UINTN                 Signature;\r
  LIST_ENTRY            Link;\r
\r
  UINT8                 Operand;          // The operand (first byte) of this Statement or Question\r
\r
  //\r
  // Statement Header\r
  //\r
  EFI_STRING_ID         Prompt;\r
  EFI_STRING_ID         Help;\r
  EFI_STRING_ID         TextTwo;          // For EFI_IFR_TEXT\r
\r
  //\r
  // Question Header\r
  //\r
  EFI_QUESTION_ID       QuestionId;       // The value of zero is reserved\r
  EFI_VARSTORE_ID       VarStoreId;       // A value of zero indicates no variable storage\r
  FORMSET_STORAGE       *Storage;\r
  union {\r
    EFI_STRING_ID       VarName;\r
    UINT16              VarOffset;\r
  }  VarStoreInfo;\r
  UINT16                StorageWidth;\r
  UINT8                 QuestionFlags;\r
  CHAR16                *VariableName;    // Name/Value or EFI Variable name\r
  CHAR16                *BlockName;       // Buffer storage block name: "OFFSET=...WIDTH=..."\r
\r
  EFI_HII_VALUE         HiiValue;         // Edit copy for checkbox, numberic, oneof\r
  UINT8                 *BufferValue;     // Edit copy for string, password, orderedlist\r
\r
  //\r
  // OpCode specific members\r
  //\r
  UINT8                 Flags;            // for EFI_IFR_CHECKBOX, EFI_IFR_DATE, EFI_IFR_NUMERIC, EFI_IFR_ONE_OF,\r
                                          // EFI_IFR_ORDERED_LIST, EFI_IFR_STRING,EFI_IFR_SUBTITLE,EFI_IFR_TIME, EFI_IFR_BANNER\r
  UINT8                 MaxContainers;    // for EFI_IFR_ORDERED_LIST\r
\r
  UINT16                BannerLineNumber; // for EFI_IFR_BANNER, 1-based line number\r
  EFI_STRING_ID         QuestionConfig;   // for EFI_IFR_ACTION, if 0 then no configuration string will be processed\r
\r
  UINT64                Minimum;          // for EFI_IFR_ONE_OF/EFI_IFR_NUMERIC, it's Min/Max value\r
  UINT64                Maximum;          // for EFI_IFR_STRING/EFI_IFR_PASSWORD, it's Min/Max length\r
  UINT64                Step;\r
\r
  EFI_DEFAULT_ID        DefaultId;        // for EFI_IFR_RESET_BUTTON\r
  EFI_FORM_ID           RefFormId;        // for EFI_IFR_REF\r
  EFI_QUESTION_ID       RefQuestionId;    // for EFI_IFR_REF2\r
  EFI_GUID              RefFormSetId;     // for EFI_IFR_REF3\r
  EFI_STRING_ID         RefDevicePath;    // for EFI_IFR_REF4\r
\r
  //\r
  // Get from IFR parsing\r
  //\r
  FORM_EXPRESSION       *ValueExpression;    // nested EFI_IFR_VALUE, provide Question value and indicate Question is ReadOnly\r
  LIST_ENTRY            DefaultListHead;     // nested EFI_IFR_DEFAULT list (QUESTION_DEFAULT), provide default values\r
  LIST_ENTRY            OptionListHead;      // nested EFI_IFR_ONE_OF_OPTION list (QUESTION_OPTION)\r
\r
  EFI_IMAGE_ID          ImageId;             // nested EFI_IFR_IMAGE\r
  UINT8                 RefreshInterval;     // nested EFI_IFR_REFRESH, refresh interval(in seconds) for Question value, 0 means no refresh\r
  BOOLEAN               InSubtitle;          // nesting inside of EFI_IFR_SUBTITLE\r
\r
  LIST_ENTRY            InconsistentListHead;// nested inconsistent expression list (FORM_EXPRESSION)\r
  LIST_ENTRY            NoSubmitListHead;    // nested nosubmit expression list (FORM_EXPRESSION)\r
  FORM_EXPRESSION       *GrayOutExpression;  // nesting inside of GrayOutIf\r
  FORM_EXPRESSION       *SuppressExpression; // nesting inside of SuppressIf\r
\r
} FORM_BROWSER_STATEMENT;\r
\r
#define FORM_BROWSER_STATEMENT_FROM_LINK(a)  CR (a, FORM_BROWSER_STATEMENT, Link, FORM_BROWSER_STATEMENT_SIGNATURE)\r
\r
#define FORM_BROWSER_FORM_SIGNATURE  EFI_SIGNATURE_32 ('F', 'F', 'R', 'M')\r
\r
typedef struct {\r
  UINTN             Signature;\r
  LIST_ENTRY        Link;\r
\r
  UINT16            FormId;\r
  EFI_STRING_ID     FormTitle;\r
\r
  EFI_IMAGE_ID      ImageId;\r
\r
  LIST_ENTRY        ExpressionListHead;   // List of Expressions (FORM_EXPRESSION)\r
  LIST_ENTRY        StatementListHead;    // List of Statements and Questions (FORM_BROWSER_STATEMENT)\r
} FORM_BROWSER_FORM;\r
\r
#define FORM_BROWSER_FORM_FROM_LINK(a)  CR (a, FORM_BROWSER_FORM, Link, FORM_BROWSER_FORM_SIGNATURE)\r
\r
#define FORMSET_DEFAULTSTORE_SIGNATURE  EFI_SIGNATURE_32 ('F', 'D', 'F', 'S')\r
\r
typedef struct {\r
  UINTN            Signature;\r
  LIST_ENTRY       Link;\r
\r
  UINT16           DefaultId;\r
  EFI_STRING_ID    DefaultName;\r
} FORMSET_DEFAULTSTORE;\r
\r
#define FORMSET_DEFAULTSTORE_FROM_LINK(a)  CR (a, FORMSET_DEFAULTSTORE, Link, FORMSET_DEFAULTSTORE_SIGNATURE)\r
\r
typedef struct {\r
  EFI_HII_HANDLE                  HiiHandle;\r
  EFI_HANDLE                      DriverHandle;\r
  EFI_HII_CONFIG_ACCESS_PROTOCOL  *ConfigAccess;\r
  EFI_DEVICE_PATH_PROTOCOL        *DevicePath;\r
\r
  UINTN                           IfrBinaryLength;\r
  UINT8                           *IfrBinaryData;\r
\r
  EFI_GUID                        Guid;\r
  EFI_STRING_ID                   FormSetTitle;\r
  EFI_STRING_ID                   Help;\r
  UINT16                          Class;\r
  UINT16                          SubClass;\r
  EFI_IMAGE_ID                    ImageId;\r
\r
  FORM_BROWSER_STATEMENT          *StatementBuffer;     // Buffer for all Statements and Questions\r
  EXPRESSION_OPCODE               *ExpressionBuffer;    // Buffer for all Expression OpCode\r
\r
  LIST_ENTRY                      StorageListHead;      // Storage list (FORMSET_STORAGE)\r
  LIST_ENTRY                      DefaultStoreListHead; // DefaultStore list (FORMSET_DEFAULTSTORE)\r
  LIST_ENTRY                      FormListHead;         // Form list (FORM_BROWSER_FORM)\r
} FORM_BROWSER_FORMSET;\r
\r
\r
EFI_STATUS\r
EvaluateExpression (\r
  IN FORM_BROWSER_FORMSET  *FormSet,\r
  IN FORM_BROWSER_FORM     *Form,\r
  IN OUT FORM_EXPRESSION   *Expression\r
  )\r
;\r
\r
EFI_STATUS\r
ParseOpCodes (\r
  IN FORM_BROWSER_FORMSET              *FormSet\r
  )\r
;\r
\r
VOID\r
DestroyFormSet (\r
  IN OUT FORM_BROWSER_FORMSET  *FormSet\r
  )\r
;\r
\r
#endif\r
\r
Commit	Line	Data
59336178	1	/** @file\r
	2	Function and Macro defintions for IFR parsing. To get the default value from IFR package, the IFR\r
	3	opcode needs to be parsed. Most of code is taken from MdeModulePkg\Universal\SetupBrowserDxe\IfrParse.c.\r
	4	\r
	5	Copyright (c) 2008, Intel Corporation\r
	6	All rights reserved. This program and the accompanying materials\r
	7	are licensed and made available under the terms and conditions of the BSD License\r
	8	which accompanies this distribution. The full text of the license may be found at\r
	9	http://opensource.org/licenses/bsd-license.php\r
	10	\r
	11	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	12	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	13	\r
	14	**/\r
	15	\r
	16	#ifndef _HII_THUNK_UEFI_IFR_PARSER_\r
	17	#define _HII_THUNK_UEFI_IFR_PARSER_\r
	18	\r
	19	#include <PiDxe.h>\r
	20	\r
	21	#include <Protocol/Print.h>\r
59336178	22	#include <Protocol/HiiConfigAccess.h>\r
	23	#include <Protocol/HiiConfigRouting.h>\r
	24	#include <Protocol/HiiDatabase.h>\r
	25	#include <Protocol/HiiString.h>\r
	26	\r
	27	//\r
	28	// IFR relative definition\r
	29	//\r
	30	#define EFI_HII_EXPRESSION_INCONSISTENT_IF 0\r
	31	#define EFI_HII_EXPRESSION_NO_SUBMIT_IF 1\r
	32	#define EFI_HII_EXPRESSION_GRAY_OUT_IF 2\r
	33	#define EFI_HII_EXPRESSION_SUPPRESS_IF 3\r
	34	#define EFI_HII_EXPRESSION_DISABLE_IF 4\r
	35	#define EFI_HII_EXPRESSION_VALUE 5\r
	36	#define EFI_HII_EXPRESSION_RULE 6\r
	37	\r
	38	#define EFI_HII_VARSTORE_BUFFER 0\r
	39	#define EFI_HII_VARSTORE_NAME_VALUE 1\r
	40	#define EFI_HII_VARSTORE_EFI_VARIABLE 2\r
	41	\r
	42	#define FORM_INCONSISTENT_VALIDATION 0\r
	43	#define FORM_NO_SUBMIT_VALIDATION 1\r
	44	\r
0368663f	45	extern EFI_GUID gTianoHiiIfrGuid;\r
0368663f	46	\r
59336178	47	\r
	48	typedef struct {\r
	49	UINT8 Type;\r
	50	EFI_IFR_TYPE_VALUE Value;\r
	51	} EFI_HII_VALUE;\r
	52	\r
	53	#define NAME_VALUE_NODE_SIGNATURE EFI_SIGNATURE_32 ('N', 'V', 'S', 'T')\r
	54	\r
	55	typedef struct {\r
	56	UINTN Signature;\r
	57	LIST_ENTRY Link;\r
	58	CHAR16 *Name;\r
	59	CHAR16 *Value;\r
	60	CHAR16 *EditValue;\r
	61	} NAME_VALUE_NODE;\r
	62	\r
	63	#define NAME_VALUE_NODE_FROM_LINK(a) CR (a, NAME_VALUE_NODE, Link, NAME_VALUE_NODE_SIGNATURE)\r
	64	\r
	65	#define FORMSET_STORAGE_SIGNATURE EFI_SIGNATURE_32 ('F', 'S', 'T', 'G')\r
	66	\r
	67	typedef struct {\r
	68	UINTN Signature;\r
	69	LIST_ENTRY Link;\r
	70	\r
	71	UINT8 Type; // Storage type\r
	72	\r
	73	UINT16 VarStoreId;\r
	74	EFI_GUID Guid;\r
	75	\r
	76	CHAR16 *Name; // For EFI_IFR_VARSTORE\r
	77	UINT16 Size;\r
	78	UINT8 *Buffer;\r
	79	UINT8 *EditBuffer; // Edit copy for Buffer Storage\r
	80	\r
	81	LIST_ENTRY NameValueListHead; // List of NAME_VALUE_NODE\r
	82	\r
	83	UINT32 Attributes; // For EFI_IFR_VARSTORE_EFI: EFI Variable attribute\r
	84	\r
	85	CHAR16 *ConfigHdr; // <ConfigHdr>\r
	86	CHAR16 *ConfigRequest; // <ConfigRequest> = <ConfigHdr> + <RequestElement>\r
	87	UINTN ElementCount; // Number of <RequestElement> in the <ConfigRequest>\r
	88	UINTN SpareStrLen; // Spare length of ConfigRequest string buffer\r
	89	} FORMSET_STORAGE;\r
	90	\r
	91	#define FORMSET_STORAGE_FROM_LINK(a) CR (a, FORMSET_STORAGE, Link, FORMSET_STORAGE_SIGNATURE)\r
	92	\r
	93	#define EXPRESSION_OPCODE_SIGNATURE EFI_SIGNATURE_32 ('E', 'X', 'O', 'P')\r
	94	\r
	95	typedef struct {\r
	96	UINTN Signature;\r
	97	LIST_ENTRY Link;\r
	98	\r
	99	UINT8 Operand;\r
	100	\r
	101	UINT8 Format; // For EFI_IFR_TO_STRING, EFI_IFR_FIND\r
	102	UINT8 Flags; // For EFI_IFR_SPAN\r
	103	UINT8 RuleId; // For EFI_IFR_RULE_REF\r
	104	\r
	105	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\r
	106	\r
	107	EFI_QUESTION_ID QuestionId; // For EFI_IFR_EQ_ID_ID, EFI_IFR_EQ_ID_LIST, EFI_IFR_QUESTION_REF1\r
	108	EFI_QUESTION_ID QuestionId2;\r
	109	\r
	110	UINT16 ListLength; // For EFI_IFR_EQ_ID_LIST\r
111	UINT16 *ValueList;\r
112	\r
113	EFI_STRING_ID DevicePath; // For EFI_IFR_QUESTION_REF3_2, EFI_IFR_QUESTION_REF3_3\r
114	EFI_GUID Guid;\r
115	} EXPRESSION_OPCODE;\r
116	\r
117	#define EXPRESSION_OPCODE_FROM_LINK(a) CR (a, EXPRESSION_OPCODE, Link, EXPRESSION_OPCODE_SIGNATURE)\r
118	\r
119	#define FORM_EXPRESSION_SIGNATURE EFI_SIGNATURE_32 ('F', 'E', 'X', 'P')\r
120	\r
121	typedef struct {\r
122	UINTN Signature;\r
123	LIST_ENTRY Link;\r
124	\r
125	UINT8 Type; // Type for this expression\r
126	\r
127	UINT8 RuleId; // For EFI_IFR_RULE only\r
128	EFI_STRING_ID Error; // For EFI_IFR_NO_SUBMIT_IF, EFI_IFR_INCONSISTENT_IF only\r
129	\r
130	EFI_HII_VALUE Result; // Expression evaluation result\r
131	\r
132	LIST_ENTRY OpCodeListHead; // OpCodes consist of this expression (EXPRESSION_OPCODE)\r
133	} FORM_EXPRESSION;\r
134	\r
135	#define FORM_EXPRESSION_FROM_LINK(a) CR (a, FORM_EXPRESSION, Link, FORM_EXPRESSION_SIGNATURE)\r
136	\r
137	#define QUESTION_DEFAULT_SIGNATURE EFI_SIGNATURE_32 ('Q', 'D', 'F', 'T')\r
138	\r
139	typedef struct {\r
140	UINTN Signature;\r
141	LIST_ENTRY Link;\r
142	\r
143	UINT16 DefaultId;\r
144	EFI_HII_VALUE Value; // Default value\r
145	\r
146	FORM_EXPRESSION *ValueExpression; // Not-NULL indicates default value is provided by EFI_IFR_VALUE\r
147	} QUESTION_DEFAULT;\r
148	\r
149	#define QUESTION_DEFAULT_FROM_LINK(a) CR (a, QUESTION_DEFAULT, Link, QUESTION_DEFAULT_SIGNATURE)\r
150	\r
151	#define QUESTION_OPTION_SIGNATURE EFI_SIGNATURE_32 ('Q', 'O', 'P', 'T')\r
152	\r
153	typedef struct {\r
154	UINTN Signature;\r
155	LIST_ENTRY Link;\r
156	\r
157	EFI_STRING_ID Text;\r
158	UINT8 Flags;\r
159	EFI_HII_VALUE Value;\r
160	EFI_IMAGE_ID ImageId;\r
161	\r
162	FORM_EXPRESSION *SuppressExpression; // Non-NULL indicates nested inside of SuppressIf\r
163	} QUESTION_OPTION;\r
164	\r
165	#define QUESTION_OPTION_FROM_LINK(a) CR (a, QUESTION_OPTION, Link, QUESTION_OPTION_SIGNATURE)\r
166	\r
167	#define FORM_BROWSER_STATEMENT_SIGNATURE EFI_SIGNATURE_32 ('F', 'S', 'T', 'A')\r
168	typedef struct {\r
169	UINTN Signature;\r
170	LIST_ENTRY Link;\r
171	\r
172	UINT8 Operand; // The operand (first byte) of this Statement or Question\r
173	\r
174	//\r
175	// Statement Header\r
176	//\r
177	EFI_STRING_ID Prompt;\r
178	EFI_STRING_ID Help;\r
179	EFI_STRING_ID TextTwo; // For EFI_IFR_TEXT\r
180	\r
181	//\r
182	// Question Header\r
183	//\r
184	EFI_QUESTION_ID QuestionId; // The value of zero is reserved\r
185	EFI_VARSTORE_ID VarStoreId; // A value of zero indicates no variable storage\r
186	FORMSET_STORAGE *Storage;\r
187	union {\r
188	EFI_STRING_ID VarName;\r
189	UINT16 VarOffset;\r
190	} VarStoreInfo;\r
191	UINT16 StorageWidth;\r
192	UINT8 QuestionFlags;\r
193	CHAR16 *VariableName; // Name/Value or EFI Variable name\r
194	CHAR16 *BlockName; // Buffer storage block name: "OFFSET=...WIDTH=..."\r
195	\r
196	EFI_HII_VALUE HiiValue; // Edit copy for checkbox, numberic, oneof\r
197	UINT8 *BufferValue; // Edit copy for string, password, orderedlist\r
198	\r
199	//\r
200	// OpCode specific members\r
201	//\r
202	UINT8 Flags; // for EFI_IFR_CHECKBOX, EFI_IFR_DATE, EFI_IFR_NUMERIC, EFI_IFR_ONE_OF,\r
203	// EFI_IFR_ORDERED_LIST, EFI_IFR_STRING,EFI_IFR_SUBTITLE,EFI_IFR_TIME, EFI_IFR_BANNER\r
204	UINT8 MaxContainers; // for EFI_IFR_ORDERED_LIST\r
205	\r
206	UINT16 BannerLineNumber; // for EFI_IFR_BANNER, 1-based line number\r
207	EFI_STRING_ID QuestionConfig; // for EFI_IFR_ACTION, if 0 then no configuration string will be processed\r
208	\r
209	UINT64 Minimum; // for EFI_IFR_ONE_OF/EFI_IFR_NUMERIC, it's Min/Max value\r
210	UINT64 Maximum; // for EFI_IFR_STRING/EFI_IFR_PASSWORD, it's Min/Max length\r
211	UINT64 Step;\r
212	\r
213	EFI_DEFAULT_ID DefaultId; // for EFI_IFR_RESET_BUTTON\r
214	EFI_FORM_ID RefFormId; // for EFI_IFR_REF\r
215	EFI_QUESTION_ID RefQuestionId; // for EFI_IFR_REF2\r
216	EFI_GUID RefFormSetId; // for EFI_IFR_REF3\r
217	EFI_STRING_ID RefDevicePath; // for EFI_IFR_REF4\r
218	\r
219	//\r
220	// Get from IFR parsing\r
221	//\r
222	FORM_EXPRESSION *ValueExpression; // nested EFI_IFR_VALUE, provide Question value and indicate Question is ReadOnly\r
223	LIST_ENTRY DefaultListHead; // nested EFI_IFR_DEFAULT list (QUESTION_DEFAULT), provide default values\r
224	LIST_ENTRY OptionListHead; // nested EFI_IFR_ONE_OF_OPTION list (QUESTION_OPTION)\r
225	\r
226	EFI_IMAGE_ID ImageId; // nested EFI_IFR_IMAGE\r
227	UINT8 RefreshInterval; // nested EFI_IFR_REFRESH, refresh interval(in seconds) for Question value, 0 means no refresh\r
228	BOOLEAN InSubtitle; // nesting inside of EFI_IFR_SUBTITLE\r
229	\r
230	LIST_ENTRY InconsistentListHead;// nested inconsistent expression list (FORM_EXPRESSION)\r
231	LIST_ENTRY NoSubmitListHead; // nested nosubmit expression list (FORM_EXPRESSION)\r
232	FORM_EXPRESSION *GrayOutExpression; // nesting inside of GrayOutIf\r
233	FORM_EXPRESSION *SuppressExpression; // nesting inside of SuppressIf\r
234	\r
235	} FORM_BROWSER_STATEMENT;\r
236	\r
237	#define FORM_BROWSER_STATEMENT_FROM_LINK(a) CR (a, FORM_BROWSER_STATEMENT, Link, FORM_BROWSER_STATEMENT_SIGNATURE)\r
238	\r
239	#define FORM_BROWSER_FORM_SIGNATURE EFI_SIGNATURE_32 ('F', 'F', 'R', 'M')\r
240	\r
241	typedef struct {\r
242	UINTN Signature;\r
243	LIST_ENTRY Link;\r
244	\r
245	UINT16 FormId;\r
246	EFI_STRING_ID FormTitle;\r
247	\r
248	EFI_IMAGE_ID ImageId;\r
249	\r
250	LIST_ENTRY ExpressionListHead; // List of Expressions (FORM_EXPRESSION)\r
251	LIST_ENTRY StatementListHead; // List of Statements and Questions (FORM_BROWSER_STATEMENT)\r
252	} FORM_BROWSER_FORM;\r
253	\r
254	#define FORM_BROWSER_FORM_FROM_LINK(a) CR (a, FORM_BROWSER_FORM, Link, FORM_BROWSER_FORM_SIGNATURE)\r
255	\r
256	#define FORMSET_DEFAULTSTORE_SIGNATURE EFI_SIGNATURE_32 ('F', 'D', 'F', 'S')\r
257	\r
258	typedef struct {\r
259	UINTN Signature;\r
260	LIST_ENTRY Link;\r
261	\r
262	UINT16 DefaultId;\r
263	EFI_STRING_ID DefaultName;\r
264	} FORMSET_DEFAULTSTORE;\r
265	\r
266	#define FORMSET_DEFAULTSTORE_FROM_LINK(a) CR (a, FORMSET_DEFAULTSTORE, Link, FORMSET_DEFAULTSTORE_SIGNATURE)\r
267	\r
268	typedef struct {\r
269	EFI_HII_HANDLE HiiHandle;\r
270	EFI_HANDLE DriverHandle;\r
271	EFI_HII_CONFIG_ACCESS_PROTOCOL *ConfigAccess;\r
272	EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
273	\r
274	UINTN IfrBinaryLength;\r
275	UINT8 *IfrBinaryData;\r
276	\r
277	EFI_GUID Guid;\r
278	EFI_STRING_ID FormSetTitle;\r
279	EFI_STRING_ID Help;\r
280	UINT16 Class;\r
281	UINT16 SubClass;\r
282	EFI_IMAGE_ID ImageId;\r
283	\r
284	FORM_BROWSER_STATEMENT *StatementBuffer; // Buffer for all Statements and Questions\r
285	EXPRESSION_OPCODE *ExpressionBuffer; // Buffer for all Expression OpCode\r
286	\r
287	LIST_ENTRY StorageListHead; // Storage list (FORMSET_STORAGE)\r
288	LIST_ENTRY DefaultStoreListHead; // DefaultStore list (FORMSET_DEFAULTSTORE)\r
289	LIST_ENTRY FormListHead; // Form list (FORM_BROWSER_FORM)\r
290	} FORM_BROWSER_FORMSET;\r
291	\r
292	\r
293	EFI_STATUS\r
294	EvaluateExpression (\r
295	IN FORM_BROWSER_FORMSET *FormSet,\r
296	IN FORM_BROWSER_FORM *Form,\r
297	IN OUT FORM_EXPRESSION *Expression\r
298	)\r
299	;\r
300	\r
301	EFI_STATUS\r
302	ParseOpCodes (\r
303	IN FORM_BROWSER_FORMSET *FormSet\r
304	)\r
305	;\r
306	\r
307	VOID\r
308	DestroyFormSet (\r
309	IN OUT FORM_BROWSER_FORMSET *FormSet\r
310	)\r
311	;\r
312	\r
313	#endif\r
314	\r