+++ /dev/null
-/** @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
- This parser is simplified from the origianl IfrParser.c in the following way:\r
-\r
- 1) All data structure definition that have nothing to do with IFR Default value scanning (\r
- required to implement Framework HII's GetDefaultImage ()) is removed.\r
- 2) Ignore the IFR opcode which is invalid for Form Package\r
- generated using Framework VFR file.\r
-\r
- Copyright (c) 2008 - 2010, Intel Corporation. All rights reserved.<BR>\r
- 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
-\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
-#define ONE_OF_OPTION_MAP_ENTRY_FROM_LINK(Record) CR(Record, ONE_OF_OPTION_MAP_ENTRY, Link, ONE_OF_OPTION_MAP_ENTRY_SIGNATURE)\r
-#define ONE_OF_OPTION_MAP_ENTRY_SIGNATURE SIGNATURE_32 ('O', 'O', 'M', 'E')\r
-typedef struct {\r
- UINT32 Signature;\r
- LIST_ENTRY Link;\r
-\r
- UINT16 FwKey;\r
- EFI_IFR_TYPE_VALUE Value;\r
- \r
-} ONE_OF_OPTION_MAP_ENTRY;\r
-\r
-\r
-\r
-#define ONE_OF_OPTION_MAP_FROM_LINK(Record) CR(Record, ONE_OF_OPTION_MAP, Link, ONE_OF_OPTION_MAP_SIGNATURE)\r
-#define ONE_OF_OPTION_MAP_SIGNATURE SIGNATURE_32 ('O', 'O', 'O', 'M')\r
-typedef struct {\r
- UINT32 Signature;\r
- LIST_ENTRY Link; \r
-\r
- UINT16 VarStoreId;\r
-\r
- UINT8 ValueType; //EFI_IFR_TYPE_NUM_* \r
-\r
- EFI_QUESTION_ID QuestionId;\r
-\r
- LIST_ENTRY OneOfOptionMapEntryListHead; //ONE_OF_OPTION_MAP_ENTRY\r
-} ONE_OF_OPTION_MAP;\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 SIGNATURE_32 ('N', 'V', 'S', 'T')\r
-\r
-#define FORMSET_STORAGE_SIGNATURE 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
-\r
- UINT32 Attributes; // For EFI_IFR_VARSTORE_EFI: EFI Variable attribute\r
-\r
-} FORMSET_STORAGE;\r
-\r
-#define FORMSET_STORAGE_FROM_LINK(a) CR (a, FORMSET_STORAGE, Link, FORMSET_STORAGE_SIGNATURE)\r
-\r
-#if 0\r
-\r
-#define EXPRESSION_OPCODE_SIGNATURE 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_VAL_LIST, EFI_IFR_QUESTION_REF1\r
- EFI_QUESTION_ID QuestionId2;\r
-\r
- UINT16 ListLength; // For EFI_IFR_EQ_ID_VAL_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 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
-#endif\r
-\r
-#define QUESTION_DEFAULT_SIGNATURE 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
-} QUESTION_DEFAULT;\r
-\r
-#define QUESTION_DEFAULT_FROM_LINK(a) CR (a, QUESTION_DEFAULT, Link, QUESTION_DEFAULT_SIGNATURE)\r
-\r
-#define QUESTION_OPTION_SIGNATURE 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
-} QUESTION_OPTION;\r
-\r
-#define QUESTION_OPTION_FROM_LINK(a) CR (a, QUESTION_OPTION, Link, QUESTION_OPTION_SIGNATURE)\r
-\r
-typedef union {\r
- EFI_STRING_ID VarName;\r
- UINT16 VarOffset;\r
-} VAR_STORE_INFO;\r
-\r
-#define FORM_BROWSER_STATEMENT_SIGNATURE 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
- VAR_STORE_INFO VarStoreInfo;\r
- \r
- UINT16 StorageWidth;\r
- UINT8 QuestionFlags;\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
- 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
-} 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 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
-#if 0\r
- LIST_ENTRY ExpressionListHead; // List of Expressions (FORM_EXPRESSION)\r
-#endif\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 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
-\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
-#if 0\r
- EXPRESSION_OPCODE *ExpressionBuffer; // Buffer for all Expression OpCode\r
-#endif\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
-\r
- LIST_ENTRY OneOfOptionMapListHead; //ONE_OF_OPTION_MAP\r
-\r
- UINT16 MaxQuestionId;\r
-\r
- //\r
- // Added for Framework HII Thunk. \r
- // Default Variable Storage built from a Framework VFR file using UEFI VFR Compiler in Compatibility mode is determined \r
- // by priority rules defined in GetFormsetDefaultVarstoreId (). See the function description for details.\r
- //\r
- EFI_VARSTORE_ID DefaultVarStoreId;\r
- CHAR16 *OriginalDefaultVarStoreName;\r
-\r
- UINTN NumberOfStatement;\r
- \r
-} FORM_BROWSER_FORMSET;\r
-\r
-\r
-/**\r
- Parse opcodes in the formset IFR binary.\r
-\r
- @param FormSet Pointer of the FormSet data structure.\r
-\r
- @retval EFI_SUCCESS Opcode parse success.\r
- @retval Other Opcode parse fail.\r
-\r
-**/\r
-EFI_STATUS\r
-ParseOpCodes (\r
- IN FORM_BROWSER_FORMSET *FormSet\r
- );\r
-\r
-/**\r
- Free resources allocated for a FormSet\r
-\r
- @param FormSet Pointer of the FormSet\r
-\r
- @return None.\r
-\r
-**/\r
-VOID\r
-DestroyFormSet (\r
- IN OUT FORM_BROWSER_FORMSET *FormSet\r
- );\r
-\r
-#endif\r
-\r
projects / mirror_edk2.git / blobdiff