--- /dev/null
+/** @file\r
+Parser for IFR binary encoding.\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
+#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
+#include <Library/BaseLib.h>\r
+#include <Library/BaseMemoryLib.h>\r
+#include <Library/DebugLib.h>\r
+#include <Library/HiiLib.h>\r
+#include <Library/IfrSupportLib.h>\r
+#include <Library/MemoryAllocationLib.h>\r
+#include <Library/PrintLib.h>\r
+#include <Library/UefiBootServicesTableLib.h>\r
+\r
+#include <MdeModuleHii.h>\r
+\r
+#include "UefiIfrParser.h"\r
+\r
+#include "UefiIfrParserExpression.h"\r
+\r
+UINT16 mStatementIndex;\r
+\r
+BOOLEAN mInScopeSubtitle;\r
+BOOLEAN mInScopeSuppress;\r
+BOOLEAN mInScopeGrayOut;\r
+\r
+EFI_GUID mFrameworkHiiCompatibilityGuid = EFI_IFR_FRAMEWORK_GUID;\r
+extern EFI_GUID mTianoHiiIfrGuid;\r
+\r
+LIST_ENTRY *\r
+GetOneOfOptionMapEntryListHead (\r
+ IN CONST FORM_BROWSER_FORMSET *FormSet,\r
+ IN UINT16 QuestionId\r
+ )\r
+{\r
+ LIST_ENTRY *Link;\r
+ ONE_OF_OPTION_MAP *Map;\r
+\r
+ Link = GetFirstNode (&FormSet->OneOfOptionMapListHead);\r
+\r
+ while (!IsNull (&FormSet->OneOfOptionMapListHead, Link)) {\r
+ Map = ONE_OF_OPTION_MAP_FROM_LINK (Link);\r
+ if (QuestionId == Map->QuestionId) {\r
+ return &Map->OneOfOptionMapEntryListHead;\r
+ }\r
+ Link = GetNextNode (&FormSet->OneOfOptionMapListHead, Link);\r
+ }\r
+ \r
+ return NULL;\r
+}\r
+\r
+VOID\r
+DestoryOneOfOptionMap (\r
+ IN LIST_ENTRY *OneOfOptionMapListHead\r
+ )\r
+{\r
+ ONE_OF_OPTION_MAP *Map;\r
+ ONE_OF_OPTION_MAP_ENTRY *MapEntry;\r
+ LIST_ENTRY *Link;\r
+ LIST_ENTRY *Link2;\r
+\r
+ while (!IsListEmpty (OneOfOptionMapListHead)) {\r
+ Link = GetFirstNode (OneOfOptionMapListHead);\r
+ \r
+ Map = ONE_OF_OPTION_MAP_FROM_LINK (Link);\r
+\r
+ while (!IsListEmpty (&Map->OneOfOptionMapEntryListHead)) {\r
+ Link2 = GetFirstNode (&Map->OneOfOptionMapEntryListHead);\r
+ \r
+ MapEntry = ONE_OF_OPTION_MAP_ENTRY_FROM_LINK (Link2);\r
+\r
+ RemoveEntryList (Link2);\r
+\r
+ FreePool (MapEntry);\r
+ }\r
+\r
+ RemoveEntryList (Link);\r
+ FreePool (Map);\r
+ }\r
+}\r
+\r
+\r
+/**\r
+ Initialize Statement header members.\r
+\r
+ @param OpCodeData Pointer of the raw OpCode data.\r
+ @param FormSet Pointer of the current FormSe.\r
+ @param Form Pointer of the current Form.\r
+\r
+ @return The Statement.\r
+\r
+**/\r
+FORM_BROWSER_STATEMENT *\r
+CreateStatement (\r
+ IN UINT8 *OpCodeData,\r
+ IN OUT FORM_BROWSER_FORMSET *FormSet,\r
+ IN OUT FORM_BROWSER_FORM *Form\r
+ )\r
+{\r
+ FORM_BROWSER_STATEMENT *Statement;\r
+ EFI_IFR_STATEMENT_HEADER *StatementHdr;\r
+\r
+ if (Form == NULL) {\r
+ //\r
+ // We are currently not in a Form Scope, so just skip this Statement\r
+ //\r
+ return NULL;\r
+ }\r
+\r
+ Statement = &FormSet->StatementBuffer[mStatementIndex];\r
+ mStatementIndex++;\r
+\r
+ InitializeListHead (&Statement->DefaultListHead);\r
+ InitializeListHead (&Statement->OptionListHead);\r
+\r
+ Statement->Signature = FORM_BROWSER_STATEMENT_SIGNATURE;\r
+\r
+ Statement->Operand = ((EFI_IFR_OP_HEADER *) OpCodeData)->OpCode;\r
+\r
+ StatementHdr = (EFI_IFR_STATEMENT_HEADER *) (OpCodeData + sizeof (EFI_IFR_OP_HEADER));\r
+ CopyMem (&Statement->Prompt, &StatementHdr->Prompt, sizeof (EFI_STRING_ID));\r
+ CopyMem (&Statement->Help, &StatementHdr->Help, sizeof (EFI_STRING_ID));\r
+\r
+ Statement->InSubtitle = mInScopeSubtitle;\r
+\r
+ //\r
+ // Insert this Statement into current Form\r
+ //\r
+ InsertTailList (&Form->StatementListHead, &Statement->Link);\r
+\r
+ return Statement;\r
+}\r
+\r
+/**\r
+ Initialize Question's members.\r
+\r
+ @param OpCodeData Pointer of the raw OpCode data.\r
+ @param FormSet Pointer of the current FormSet.\r
+ @param Form Pointer of the current Form.\r
+\r
+ @return The Question.\r
+\r
+**/\r
+FORM_BROWSER_STATEMENT *\r
+CreateQuestion (\r
+ IN UINT8 *OpCodeData,\r
+ IN OUT FORM_BROWSER_FORMSET *FormSet,\r
+ IN OUT FORM_BROWSER_FORM *Form\r
+ )\r
+{\r
+ FORM_BROWSER_STATEMENT *Statement;\r
+ EFI_IFR_QUESTION_HEADER *QuestionHdr;\r
+ LIST_ENTRY *Link;\r
+ FORMSET_STORAGE *Storage;\r
+\r
+ Statement = CreateStatement (OpCodeData, FormSet, Form);\r
+ if (Statement == NULL) {\r
+ return NULL;\r
+ }\r
+\r
+ QuestionHdr = (EFI_IFR_QUESTION_HEADER *) (OpCodeData + sizeof (EFI_IFR_OP_HEADER));\r
+ CopyMem (&Statement->QuestionId, &QuestionHdr->QuestionId, sizeof (EFI_QUESTION_ID));\r
+ CopyMem (&Statement->VarStoreId, &QuestionHdr->VarStoreId, sizeof (EFI_VARSTORE_ID));\r
+ CopyMem (&Statement->VarStoreInfo.VarOffset, &QuestionHdr->VarStoreInfo.VarOffset, sizeof (UINT16));\r
+\r
+ if (FormSet->MaxQuestionId < QuestionHdr->QuestionId) {\r
+ FormSet->MaxQuestionId = QuestionHdr->QuestionId;\r
+ }\r
+\r
+ Statement->QuestionFlags = QuestionHdr->Flags;\r
+\r
+ if (Statement->VarStoreId == 0) {\r
+ //\r
+ // VarStoreId of zero indicates no variable storage\r
+ //\r
+ return Statement;\r
+ }\r
+\r
+ //\r
+ // Find Storage for this Question\r
+ //\r
+ Link = GetFirstNode (&FormSet->StorageListHead);\r
+ while (!IsNull (&FormSet->StorageListHead, Link)) {\r
+ Storage = FORMSET_STORAGE_FROM_LINK (Link);\r
+\r
+ if (Storage->VarStoreId == Statement->VarStoreId) {\r
+ Statement->Storage = Storage;\r
+ break;\r
+ }\r
+\r
+ Link = GetNextNode (&FormSet->StorageListHead, Link);\r
+ }\r
+ ASSERT (Statement->Storage != NULL);\r
+\r
+ return Statement;\r
+}\r
+\r
+/**\r
+ Allocate a FORMSET_STORAGE data structure and insert to FormSet Storage List.\r
+\r
+ @param FormSet Pointer of the current FormSet\r
+\r
+ @return Pointer to a FORMSET_STORAGE data structure.\r
+\r
+**/\r
+FORMSET_STORAGE *\r
+CreateStorage (\r
+ IN FORM_BROWSER_FORMSET *FormSet\r
+ )\r
+{\r
+ FORMSET_STORAGE *Storage;\r
+\r
+ Storage = AllocateZeroPool (sizeof (FORMSET_STORAGE));\r
+ Storage->Signature = FORMSET_STORAGE_SIGNATURE;\r
+ InsertTailList (&FormSet->StorageListHead, &Storage->Link);\r
+\r
+ return Storage;\r
+}\r
+\r
+/**\r
+ Free resources of a storage\r
+\r
+ @param Storage Pointer of the storage\r
+\r
+ @return None.\r
+\r
+**/\r
+VOID\r
+DestroyStorage (\r
+ IN FORMSET_STORAGE *Storage\r
+ )\r
+{\r
+ if (Storage == NULL) {\r
+ return;\r
+ }\r
+\r
+ if (Storage->Name!= NULL) {\r
+ FreePool (Storage->Name);\r
+ }\r
+\r
+ FreePool (Storage);\r
+}\r
+\r
+\r
+/**\r
+ Free resources of a Statement\r
+\r
+ @param Statement Pointer of the Statement\r
+\r
+ @return None.\r
+\r
+**/\r
+VOID\r
+DestroyStatement (\r
+ IN OUT FORM_BROWSER_STATEMENT *Statement\r
+ )\r
+{\r
+ LIST_ENTRY *Link;\r
+ QUESTION_DEFAULT *Default;\r
+ QUESTION_OPTION *Option;\r
+\r
+ //\r
+ // Free Default value List\r
+ //\r
+ while (!IsListEmpty (&Statement->DefaultListHead)) {\r
+ Link = GetFirstNode (&Statement->DefaultListHead);\r
+ Default = QUESTION_DEFAULT_FROM_LINK (Link);\r
+ RemoveEntryList (&Default->Link);\r
+\r
+ gBS->FreePool (Default);\r
+ }\r
+\r
+ //\r
+ // Free Options List\r
+ //\r
+ while (!IsListEmpty (&Statement->OptionListHead)) {\r
+ Link = GetFirstNode (&Statement->OptionListHead);\r
+ Option = QUESTION_OPTION_FROM_LINK (Link);\r
+ RemoveEntryList (&Option->Link);\r
+\r
+ gBS->FreePool (Option);\r
+ }\r
+\r
+}\r
+\r
+\r
+\r
+/**\r
+ Free resources of a Form\r
+\r
+ @param Form Pointer of the Form\r
+\r
+ @return None.\r
+\r
+**/\r
+VOID\r
+DestroyForm (\r
+ IN OUT FORM_BROWSER_FORM *Form\r
+ )\r
+{\r
+ LIST_ENTRY *Link;\r
+ FORM_BROWSER_STATEMENT *Statement;\r
+\r
+ //\r
+ // Free Statements/Questions\r
+ //\r
+ while (!IsListEmpty (&Form->StatementListHead)) {\r
+ Link = GetFirstNode (&Form->StatementListHead);\r
+ Statement = FORM_BROWSER_STATEMENT_FROM_LINK (Link);\r
+ RemoveEntryList (&Statement->Link);\r
+\r
+ DestroyStatement (Statement);\r
+ }\r
+\r
+ //\r
+ // Free this Form\r
+ //\r
+ gBS->FreePool (Form);\r
+}\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
+ LIST_ENTRY *Link;\r
+ FORMSET_STORAGE *Storage;\r
+ FORMSET_DEFAULTSTORE *DefaultStore;\r
+ FORM_BROWSER_FORM *Form;\r
+\r
+ //\r
+ // Free IFR binary buffer\r
+ //\r
+ FreePool (FormSet->IfrBinaryData);\r
+\r
+ //\r
+ // Free FormSet Storage\r
+ //\r
+ if (FormSet->StorageListHead.ForwardLink != NULL) {\r
+ while (!IsListEmpty (&FormSet->StorageListHead)) {\r
+ Link = GetFirstNode (&FormSet->StorageListHead);\r
+ Storage = FORMSET_STORAGE_FROM_LINK (Link);\r
+ RemoveEntryList (&Storage->Link);\r
+\r
+ DestroyStorage (Storage);\r
+ }\r
+ }\r
+\r
+ //\r
+ // Free FormSet Default Store\r
+ //\r
+ if (FormSet->DefaultStoreListHead.ForwardLink != NULL) {\r
+ while (!IsListEmpty (&FormSet->DefaultStoreListHead)) {\r
+ Link = GetFirstNode (&FormSet->DefaultStoreListHead);\r
+ DefaultStore = FORMSET_DEFAULTSTORE_FROM_LINK (Link);\r
+ RemoveEntryList (&DefaultStore->Link);\r
+\r
+ gBS->FreePool (DefaultStore);\r
+ }\r
+ }\r
+\r
+ //\r
+ // Free Forms\r
+ //\r
+ if (FormSet->FormListHead.ForwardLink != NULL) {\r
+ while (!IsListEmpty (&FormSet->FormListHead)) {\r
+ Link = GetFirstNode (&FormSet->FormListHead);\r
+ Form = FORM_BROWSER_FORM_FROM_LINK (Link);\r
+ RemoveEntryList (&Form->Link);\r
+\r
+ DestroyForm (Form);\r
+ }\r
+ }\r
+\r
+ if (FormSet->StatementBuffer != NULL) {\r
+ FreePool (FormSet->StatementBuffer);\r
+ }\r
+\r
+ DestoryOneOfOptionMap (&FormSet->OneOfOptionMapListHead);\r
+\r
+ if (FormSet->OriginalDefaultVarStoreName != NULL) {\r
+ FreePool (FormSet->OriginalDefaultVarStoreName);\r
+ }\r
+ \r
+ FreePool (FormSet);\r
+}\r
+\r
+\r
+/**\r
+ Tell whether this Operand is an Expression OpCode or not\r
+\r
+ @param Operand Operand of an IFR OpCode.\r
+\r
+ @retval TRUE This is an Expression OpCode.\r
+ @retval FALSE Not an Expression OpCode.\r
+\r
+**/\r
+BOOLEAN\r
+IsExpressionOpCode (\r
+ IN UINT8 Operand\r
+ )\r
+{\r
+ if (((Operand >= EFI_IFR_EQ_ID_VAL_OP) && (Operand <= EFI_IFR_NOT_OP)) ||\r
+ ((Operand >= EFI_IFR_MATCH_OP) && (Operand <= EFI_IFR_SPAN_OP)) ||\r
+ (Operand == EFI_IFR_CATENATE_OP)\r
+ ) {\r
+ return TRUE;\r
+ } else {\r
+ return FALSE;\r
+ }\r
+}\r
+\r
+\r
+/**\r
+ Calculate number of Statemens(Questions) and Expression OpCodes.\r
+\r
+ @param FormSet The FormSet to be counted.\r
+ @param NumberOfStatement Number of Statemens(Questions)\r
+ @param NumberOfExpression Number of Expression OpCodes\r
+\r
+ @return None.\r
+\r
+**/\r
+VOID\r
+CountOpCodes (\r
+ IN FORM_BROWSER_FORMSET *FormSet,\r
+ IN OUT UINT16 *NumberOfStatement,\r
+ IN OUT UINT16 *NumberOfExpression\r
+ )\r
+{\r
+ UINT16 StatementCount;\r
+ UINT16 ExpressionCount;\r
+ UINT8 *OpCodeData;\r
+ UINTN Offset;\r
+ UINTN OpCodeLen;\r
+\r
+ Offset = 0;\r
+ StatementCount = 0;\r
+ ExpressionCount = 0;\r
+\r
+ while (Offset < FormSet->IfrBinaryLength) {\r
+ OpCodeData = FormSet->IfrBinaryData + Offset;\r
+ OpCodeLen = ((EFI_IFR_OP_HEADER *) OpCodeData)->Length;\r
+ Offset += OpCodeLen;\r
+\r
+ if (IsExpressionOpCode (((EFI_IFR_OP_HEADER *) OpCodeData)->OpCode)) {\r
+ ExpressionCount++;\r
+ } else {\r
+ StatementCount++;\r
+ }\r
+ }\r
+\r
+ *NumberOfStatement = StatementCount;\r
+ *NumberOfExpression = ExpressionCount;\r
+}\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
+ EFI_STATUS Status;\r
+ UINT16 Index;\r
+ FORM_BROWSER_FORM *CurrentForm;\r
+ FORM_BROWSER_STATEMENT *CurrentStatement;\r
+ UINT8 Operand;\r
+ UINT8 Scope;\r
+ UINTN OpCodeOffset;\r
+ UINTN OpCodeLength;\r
+ UINT8 *OpCodeData;\r
+ UINT8 ScopeOpCode;\r
+ FORMSET_STORAGE *Storage;\r
+ FORMSET_DEFAULTSTORE *DefaultStore;\r
+ QUESTION_DEFAULT *CurrentDefault;\r
+ QUESTION_OPTION *CurrentOption;\r
+ CHAR8 *AsciiString;\r
+ UINT16 NumberOfStatement;\r
+ UINT16 NumberOfExpression;\r
+ EFI_IMAGE_ID *ImageId;\r
+ EFI_HII_VALUE *Value;\r
+ LIST_ENTRY *OneOfOptinMapEntryListHead;\r
+ EFI_IFR_GUID_OPTIONKEY *OptionMap;\r
+ ONE_OF_OPTION_MAP *OneOfOptionMap;\r
+ ONE_OF_OPTION_MAP_ENTRY *OneOfOptionMapEntry;\r
+ UINT8 OneOfType;\r
+ EFI_IFR_ONE_OF *OneOfOpcode;\r
+\r
+ mInScopeSubtitle = FALSE;\r
+ mInScopeSuppress = FALSE;\r
+ mInScopeGrayOut = FALSE;\r
+ CurrentDefault = NULL;\r
+ CurrentOption = NULL;\r
+\r
+ //\r
+ // Set to a invalid value.\r
+ //\r
+ OneOfType = (UINT8) -1;\r
+\r
+ //\r
+ // Get the number of Statements and Expressions\r
+ //\r
+ CountOpCodes (FormSet, &NumberOfStatement, &NumberOfExpression);\r
+ FormSet->NumberOfStatement = NumberOfStatement;\r
+\r
+ mStatementIndex = 0;\r
+ FormSet->StatementBuffer = AllocateZeroPool (NumberOfStatement * sizeof (FORM_BROWSER_STATEMENT));\r
+ if (FormSet->StatementBuffer == NULL) {\r
+ return EFI_OUT_OF_RESOURCES;\r
+ }\r
+\r
+ InitializeListHead (&FormSet->StorageListHead);\r
+ InitializeListHead (&FormSet->DefaultStoreListHead);\r
+ InitializeListHead (&FormSet->FormListHead);\r
+ InitializeListHead (&FormSet->OneOfOptionMapListHead);\r
+\r
+ CurrentForm = NULL;\r
+ CurrentStatement = NULL;\r
+\r
+ ResetScopeStack ();\r
+\r
+ OpCodeOffset = 0;\r
+ while (OpCodeOffset < FormSet->IfrBinaryLength) {\r
+ OpCodeData = FormSet->IfrBinaryData + OpCodeOffset;\r
+\r
+ OpCodeLength = ((EFI_IFR_OP_HEADER *) OpCodeData)->Length;\r
+ OpCodeOffset += OpCodeLength;\r
+ Operand = ((EFI_IFR_OP_HEADER *) OpCodeData)->OpCode;\r
+ Scope = ((EFI_IFR_OP_HEADER *) OpCodeData)->Scope;\r
+\r
+ //\r
+ // If scope bit set, push onto scope stack\r
+ //\r
+ if (Scope) {\r
+ PushScope (Operand);\r
+ }\r
+\r
+ if (IsExpressionOpCode (Operand)) {\r
+ continue;\r
+ }\r
+\r
+ //\r
+ // Parse the Opcode\r
+ //\r
+ switch (Operand) {\r
+\r
+ case EFI_IFR_FORM_SET_OP:\r
+ //\r
+ // check the formset GUID\r
+ //\r
+ if (!CompareGuid ((EFI_GUID *)(VOID *)&FormSet->Guid, (EFI_GUID *)(VOID *)&((EFI_IFR_FORM_SET *) OpCodeData)->Guid)) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
+ CopyMem (&FormSet->FormSetTitle, &((EFI_IFR_FORM_SET *) OpCodeData)->FormSetTitle, sizeof (EFI_STRING_ID));\r
+ CopyMem (&FormSet->Help, &((EFI_IFR_FORM_SET *) OpCodeData)->Help, sizeof (EFI_STRING_ID));\r
+ break;\r
+\r
+ case EFI_IFR_FORM_OP:\r
+ //\r
+ // Create a new Form for this FormSet\r
+ //\r
+ CurrentForm = AllocateZeroPool (sizeof (FORM_BROWSER_FORM));\r
+ CurrentForm->Signature = FORM_BROWSER_FORM_SIGNATURE;\r
+\r
+ InitializeListHead (&CurrentForm->StatementListHead);\r
+\r
+ CopyMem (&CurrentForm->FormId, &((EFI_IFR_FORM *) OpCodeData)->FormId, sizeof (UINT16));\r
+ CopyMem (&CurrentForm->FormTitle, &((EFI_IFR_FORM *) OpCodeData)->FormTitle, sizeof (EFI_STRING_ID));\r
+\r
+ //\r
+ // Insert into Form list of this FormSet\r
+ //\r
+ InsertTailList (&FormSet->FormListHead, &CurrentForm->Link);\r
+ break;\r
+\r
+ //\r
+ // Storage\r
+ //\r
+ case EFI_IFR_VARSTORE_OP:\r
+ //\r
+ // Create a buffer Storage for this FormSet\r
+ //\r
+ Storage = CreateStorage (FormSet);\r
+ Storage->Type = EFI_HII_VARSTORE_BUFFER;\r
+\r
+ CopyMem (&Storage->VarStoreId, &((EFI_IFR_VARSTORE *) OpCodeData)->VarStoreId, sizeof (EFI_VARSTORE_ID));\r
+ CopyMem (&Storage->Guid, &((EFI_IFR_VARSTORE *) OpCodeData)->Guid, sizeof (EFI_GUID));\r
+ CopyMem (&Storage->Size, &((EFI_IFR_VARSTORE *) OpCodeData)->Size, sizeof (UINT16));\r
+\r
+ AsciiString = (CHAR8 *) ((EFI_IFR_VARSTORE *) OpCodeData)->Name;\r
+ Storage->Name = AllocateZeroPool (AsciiStrSize (AsciiString) * 2);\r
+ ASSERT (Storage->Name != NULL);\r
+ for (Index = 0; AsciiString[Index] != 0; Index++) {\r
+ Storage->Name[Index] = (CHAR16) AsciiString[Index];\r
+ }\r
+\r
+ break;\r
+\r
+ case EFI_IFR_VARSTORE_NAME_VALUE_OP:\r
+ ASSERT (FALSE);\r
+\r
+ break;\r
+\r
+ case EFI_IFR_VARSTORE_EFI_OP:\r
+ //\r
+ // Create a EFI variable Storage for this FormSet\r
+ //\r
+ Storage = CreateStorage (FormSet);\r
+ Storage->Type = EFI_HII_VARSTORE_EFI_VARIABLE;\r
+\r
+ CopyMem (&Storage->VarStoreId, &((EFI_IFR_VARSTORE_EFI *) OpCodeData)->VarStoreId, sizeof (EFI_VARSTORE_ID));\r
+ CopyMem (&Storage->Guid, &((EFI_IFR_VARSTORE_EFI *) OpCodeData)->Guid, sizeof (EFI_GUID));\r
+ CopyMem (&Storage->Attributes, &((EFI_IFR_VARSTORE_EFI *) OpCodeData)->Attributes, sizeof (UINT32));\r
+ break;\r
+\r
+ //\r
+ // DefaultStore\r
+ //\r
+ case EFI_IFR_DEFAULTSTORE_OP:\r
+ DefaultStore = AllocateZeroPool (sizeof (FORMSET_DEFAULTSTORE));\r
+ DefaultStore->Signature = FORMSET_DEFAULTSTORE_SIGNATURE;\r
+\r
+ CopyMem (&DefaultStore->DefaultId, &((EFI_IFR_DEFAULTSTORE *) OpCodeData)->DefaultId, sizeof (UINT16));\r
+ CopyMem (&DefaultStore->DefaultName, &((EFI_IFR_DEFAULTSTORE *) OpCodeData)->DefaultName, sizeof (EFI_STRING_ID));\r
+\r
+ //\r
+ // Insert to DefaultStore list of this Formset\r
+ //\r
+ InsertTailList (&FormSet->DefaultStoreListHead, &DefaultStore->Link);\r
+ break;\r
+\r
+ //\r
+ // Statements\r
+ //\r
+ case EFI_IFR_SUBTITLE_OP:\r
+ CurrentStatement = CreateStatement (OpCodeData, FormSet, CurrentForm);\r
+ CurrentStatement->Flags = ((EFI_IFR_SUBTITLE *) OpCodeData)->Flags;\r
+\r
+ if (Scope) {\r
+ mInScopeSubtitle = TRUE;\r
+ }\r
+ break;\r
+\r
+ case EFI_IFR_TEXT_OP:\r
+ CurrentStatement = CreateStatement (OpCodeData, FormSet, CurrentForm);\r
+\r
+ CopyMem (&CurrentStatement->TextTwo, &((EFI_IFR_TEXT *) OpCodeData)->TextTwo, sizeof (EFI_STRING_ID));\r
+ break;\r
+\r
+ //\r
+ // Questions\r
+ //\r
+ case EFI_IFR_ACTION_OP:\r
+ CurrentStatement = CreateQuestion (OpCodeData, FormSet, CurrentForm);\r
+\r
+ if (OpCodeLength == sizeof (EFI_IFR_ACTION_1)) {\r
+ //\r
+ // No QuestionConfig present, so no configuration string will be processed\r
+ //\r
+ CurrentStatement->QuestionConfig = 0;\r
+ } else {\r
+ CopyMem (&CurrentStatement->QuestionConfig, &((EFI_IFR_ACTION *) OpCodeData)->QuestionConfig, sizeof (EFI_STRING_ID));\r
+ }\r
+ break;\r
+\r
+ case EFI_IFR_RESET_BUTTON_OP:\r
+ CurrentStatement = CreateQuestion (OpCodeData, FormSet, CurrentForm);\r
+\r
+ CopyMem (&CurrentStatement->DefaultId, &((EFI_IFR_RESET_BUTTON *) OpCodeData)->DefaultId, sizeof (EFI_DEFAULT_ID));\r
+ break;\r
+\r
+ case EFI_IFR_REF_OP:\r
+ CurrentStatement = CreateQuestion (OpCodeData, FormSet, CurrentForm);\r
+\r
+ CopyMem (&CurrentStatement->RefFormId, &((EFI_IFR_REF *) OpCodeData)->FormId, sizeof (EFI_FORM_ID));\r
+ if (OpCodeLength >= sizeof (EFI_IFR_REF2)) {\r
+ CopyMem (&CurrentStatement->RefQuestionId, &((EFI_IFR_REF2 *) OpCodeData)->QuestionId, sizeof (EFI_QUESTION_ID));\r
+\r
+ if (OpCodeLength >= sizeof (EFI_IFR_REF3)) {\r
+ CopyMem (&CurrentStatement->RefFormSetId, &((EFI_IFR_REF3 *) OpCodeData)->FormSetId, sizeof (EFI_GUID));\r
+\r
+ if (OpCodeLength >= sizeof (EFI_IFR_REF4)) {\r
+ CopyMem (&CurrentStatement->RefDevicePath, &((EFI_IFR_REF4 *) OpCodeData)->DevicePath, sizeof (EFI_STRING_ID));\r
+ }\r
+ }\r
+ }\r
+ break;\r
+\r
+ case EFI_IFR_ONE_OF_OP:\r
+ case EFI_IFR_NUMERIC_OP:\r
+ CurrentStatement = CreateQuestion (OpCodeData, FormSet, CurrentForm);\r
+\r
+ CurrentStatement->Flags = ((EFI_IFR_ONE_OF *) OpCodeData)->Flags;\r
+ Value = &CurrentStatement->HiiValue;\r
+\r
+ switch (CurrentStatement->Flags & EFI_IFR_NUMERIC_SIZE) {\r
+ case EFI_IFR_NUMERIC_SIZE_1:\r
+ CurrentStatement->Minimum = ((EFI_IFR_NUMERIC *) OpCodeData)->data.u8.MinValue;\r
+ CurrentStatement->Maximum = ((EFI_IFR_NUMERIC *) OpCodeData)->data.u8.MaxValue;\r
+ CurrentStatement->Step = ((EFI_IFR_NUMERIC *) OpCodeData)->data.u8.Step;\r
+ CurrentStatement->StorageWidth = sizeof (UINT8);\r
+ Value->Type = EFI_IFR_TYPE_NUM_SIZE_8;\r
+ break;\r
+\r
+ case EFI_IFR_NUMERIC_SIZE_2:\r
+ CopyMem (&CurrentStatement->Minimum, &((EFI_IFR_NUMERIC *) OpCodeData)->data.u16.MinValue, sizeof (UINT16));\r
+ CopyMem (&CurrentStatement->Maximum, &((EFI_IFR_NUMERIC *) OpCodeData)->data.u16.MaxValue, sizeof (UINT16));\r
+ CopyMem (&CurrentStatement->Step, &((EFI_IFR_NUMERIC *) OpCodeData)->data.u16.Step, sizeof (UINT16));\r
+ CurrentStatement->StorageWidth = sizeof (UINT16);\r
+ Value->Type = EFI_IFR_TYPE_NUM_SIZE_16;\r
+ break;\r
+\r
+ case EFI_IFR_NUMERIC_SIZE_4:\r
+ CopyMem (&CurrentStatement->Minimum, &((EFI_IFR_NUMERIC *) OpCodeData)->data.u32.MinValue, sizeof (UINT32));\r
+ CopyMem (&CurrentStatement->Maximum, &((EFI_IFR_NUMERIC *) OpCodeData)->data.u32.MaxValue, sizeof (UINT32));\r
+ CopyMem (&CurrentStatement->Step, &((EFI_IFR_NUMERIC *) OpCodeData)->data.u32.Step, sizeof (UINT32));\r
+ CurrentStatement->StorageWidth = sizeof (UINT32);\r
+ Value->Type = EFI_IFR_TYPE_NUM_SIZE_32;\r
+ break;\r
+\r
+ case EFI_IFR_NUMERIC_SIZE_8:\r
+ CopyMem (&CurrentStatement->Minimum, &((EFI_IFR_NUMERIC *) OpCodeData)->data.u64.MinValue, sizeof (UINT64));\r
+ CopyMem (&CurrentStatement->Maximum, &((EFI_IFR_NUMERIC *) OpCodeData)->data.u64.MaxValue, sizeof (UINT64));\r
+ CopyMem (&CurrentStatement->Step, &((EFI_IFR_NUMERIC *) OpCodeData)->data.u64.Step, sizeof (UINT64));\r
+ CurrentStatement->StorageWidth = sizeof (UINT64);\r
+ Value->Type = EFI_IFR_TYPE_NUM_SIZE_64;\r
+ break;\r
+\r
+ default:\r
+ break;\r
+ }\r
+\r
+ if (Operand == EFI_IFR_ONE_OF_OP) {\r
+ OneOfOpcode = (EFI_IFR_ONE_OF *) OpCodeData;\r
+ OneOfType = (UINT8) (OneOfOpcode->Flags & EFI_IFR_NUMERIC_SIZE);\r
+ }\r
+ break;\r
+\r
+ case EFI_IFR_ORDERED_LIST_OP:\r
+ CurrentStatement = CreateQuestion (OpCodeData, FormSet, CurrentForm);\r
+\r
+ CurrentStatement->Flags = ((EFI_IFR_ORDERED_LIST *) OpCodeData)->Flags;\r
+ CurrentStatement->MaxContainers = ((EFI_IFR_ORDERED_LIST *) OpCodeData)->MaxContainers;\r
+ CurrentStatement->StorageWidth = (UINT16)(CurrentStatement->MaxContainers * sizeof (UINT8));\r
+\r
+ //\r
+ // No buffer type is defined in EFI_IFR_TYPE_VALUE, so a Configuration Driver\r
+ // has to use FormBrowser2.Callback() to retrieve the uncommited data for\r
+ // an interactive orderedlist (i.e. with EFI_IFR_FLAG_CALLBACK flag set).\r
+ //\r
+ CurrentStatement->HiiValue.Type = EFI_IFR_TYPE_OTHER;\r
+ CurrentStatement->BufferValue = AllocateZeroPool (CurrentStatement->StorageWidth);\r
+\r
+ break;\r
+\r
+ case EFI_IFR_CHECKBOX_OP:\r
+ CurrentStatement = CreateQuestion (OpCodeData, FormSet, CurrentForm);\r
+\r
+ CurrentStatement->Flags = ((EFI_IFR_CHECKBOX *) OpCodeData)->Flags;\r
+ CurrentStatement->StorageWidth = sizeof (BOOLEAN);\r
+ CurrentStatement->HiiValue.Type = EFI_IFR_TYPE_BOOLEAN;\r
+\r
+ break;\r
+\r
+ case EFI_IFR_STRING_OP:\r
+ CurrentStatement = CreateQuestion (OpCodeData, FormSet, CurrentForm);\r
+\r
+ //\r
+ // MinSize is the minimum number of characters that can be accepted for this opcode,\r
+ // MaxSize is the maximum number of characters that can be accepted for this opcode.\r
+ // The characters are stored as Unicode, so the storage width should multiply 2.\r
+ //\r
+ CurrentStatement->Minimum = ((EFI_IFR_STRING *) OpCodeData)->MinSize;\r
+ CurrentStatement->Maximum = ((EFI_IFR_STRING *) OpCodeData)->MaxSize;\r
+ CurrentStatement->StorageWidth = (UINT16)((UINTN) CurrentStatement->Maximum * sizeof (UINT16));\r
+ CurrentStatement->Flags = ((EFI_IFR_STRING *) OpCodeData)->Flags;\r
+\r
+ CurrentStatement->HiiValue.Type = EFI_IFR_TYPE_STRING;\r
+ CurrentStatement->BufferValue = AllocateZeroPool (CurrentStatement->StorageWidth);\r
+\r
+ break;\r
+\r
+ case EFI_IFR_PASSWORD_OP:\r
+ CurrentStatement = CreateQuestion (OpCodeData, FormSet, CurrentForm);\r
+\r
+ //\r
+ // MinSize is the minimum number of characters that can be accepted for this opcode,\r
+ // MaxSize is the maximum number of characters that can be accepted for this opcode.\r
+ // The characters are stored as Unicode, so the storage width should multiply 2.\r
+ //\r
+ CopyMem (&CurrentStatement->Minimum, &((EFI_IFR_PASSWORD *) OpCodeData)->MinSize, sizeof (UINT16));\r
+ CopyMem (&CurrentStatement->Maximum, &((EFI_IFR_PASSWORD *) OpCodeData)->MaxSize, sizeof (UINT16));\r
+ CurrentStatement->StorageWidth = (UINT16)((UINTN) CurrentStatement->Maximum * sizeof (UINT16));\r
+\r
+ CurrentStatement->HiiValue.Type = EFI_IFR_TYPE_STRING;\r
+ CurrentStatement->BufferValue = AllocateZeroPool (CurrentStatement->StorageWidth);\r
+\r
+ break;\r
+\r
+ case EFI_IFR_DATE_OP:\r
+ CurrentStatement = CreateQuestion (OpCodeData, FormSet, CurrentForm);\r
+\r
+ CurrentStatement->Flags = ((EFI_IFR_DATE *) OpCodeData)->Flags;\r
+ CurrentStatement->HiiValue.Type = EFI_IFR_TYPE_DATE;\r
+\r
+ break;\r
+\r
+ case EFI_IFR_TIME_OP:\r
+ CurrentStatement = CreateQuestion (OpCodeData, FormSet, CurrentForm);\r
+\r
+ CurrentStatement->Flags = ((EFI_IFR_TIME *) OpCodeData)->Flags;\r
+ CurrentStatement->HiiValue.Type = EFI_IFR_TYPE_TIME;\r
+\r
+ break;\r
+\r
+ //\r
+ // Default\r
+ //\r
+ case EFI_IFR_DEFAULT_OP:\r
+ //\r
+ // EFI_IFR_DEFAULT appear in scope of a Question,\r
+ // It creates a default value for the current question.\r
+ // A Question may have more than one Default value which have different default types.\r
+ //\r
+ CurrentDefault = AllocateZeroPool (sizeof (QUESTION_DEFAULT));\r
+ CurrentDefault->Signature = QUESTION_DEFAULT_SIGNATURE;\r
+\r
+ CurrentDefault->Value.Type = ((EFI_IFR_DEFAULT *) OpCodeData)->Type;\r
+ CopyMem (&CurrentDefault->DefaultId, &((EFI_IFR_DEFAULT *) OpCodeData)->DefaultId, sizeof (UINT16));\r
+ CopyMem (&CurrentDefault->Value.Value, &((EFI_IFR_DEFAULT *) OpCodeData)->Value, sizeof (EFI_IFR_TYPE_VALUE));\r
+ ExtendValueToU64 (&CurrentDefault->Value);\r
+\r
+ //\r
+ // Insert to Default Value list of current Question\r
+ //\r
+ InsertTailList (&CurrentStatement->DefaultListHead, &CurrentDefault->Link);\r
+\r
+ break;\r
+\r
+ //\r
+ // Option\r
+ //\r
+ case EFI_IFR_ONE_OF_OPTION_OP:\r
+ //\r
+ // EFI_IFR_ONE_OF_OPTION appear in scope of a Question.\r
+ // It create a selection for use in current Question.\r
+ //\r
+ CurrentOption = AllocateZeroPool (sizeof (QUESTION_OPTION));\r
+ CurrentOption->Signature = QUESTION_OPTION_SIGNATURE;\r
+\r
+ CurrentOption->Flags = ((EFI_IFR_ONE_OF_OPTION *) OpCodeData)->Flags;\r
+ CurrentOption->Value.Type = ((EFI_IFR_ONE_OF_OPTION *) OpCodeData)->Type;\r
+ CopyMem (&CurrentOption->Text, &((EFI_IFR_ONE_OF_OPTION *) OpCodeData)->Option, sizeof (EFI_STRING_ID));\r
+ CopyMem (&CurrentOption->Value.Value, &((EFI_IFR_ONE_OF_OPTION *) OpCodeData)->Value, sizeof (EFI_IFR_TYPE_VALUE));\r
+ ExtendValueToU64 (&CurrentOption->Value);\r
+\r
+ //\r
+ // Insert to Option list of current Question\r
+ //\r
+ InsertTailList (&CurrentStatement->OptionListHead, &CurrentOption->Link);\r
+ break;\r
+\r
+ //\r
+ // Conditional\r
+ //\r
+ case EFI_IFR_NO_SUBMIT_IF_OP:\r
+ case EFI_IFR_INCONSISTENT_IF_OP:\r
+ break;\r
+\r
+ case EFI_IFR_SUPPRESS_IF_OP:\r
+ break;\r
+\r
+ case EFI_IFR_GRAY_OUT_IF_OP:\r
+ break;\r
+\r
+ case EFI_IFR_DISABLE_IF_OP:\r
+ ASSERT (FALSE);\r
+\r
+\r
+ //\r
+ // Expression\r
+ //\r
+ case EFI_IFR_VALUE_OP:\r
+ break;\r
+\r
+ case EFI_IFR_RULE_OP:\r
+ break;\r
+\r
+ //\r
+ // Image\r
+ //\r
+ case EFI_IFR_IMAGE_OP:\r
+ //\r
+ // Get ScopeOpcode from top of stack\r
+ //\r
+ PopScope (&ScopeOpCode);\r
+ PushScope (ScopeOpCode);\r
+\r
+ switch (ScopeOpCode) {\r
+ case EFI_IFR_FORM_SET_OP:\r
+ ImageId = &FormSet->ImageId;\r
+ break;\r
+\r
+ case EFI_IFR_FORM_OP:\r
+ ImageId = &CurrentForm->ImageId;\r
+ break;\r
+\r
+ case EFI_IFR_ONE_OF_OPTION_OP:\r
+ ImageId = &CurrentOption->ImageId;\r
+ break;\r
+\r
+ default:\r
+ ImageId = &CurrentStatement->ImageId;\r
+ break;\r
+ }\r
+\r
+ CopyMem (ImageId, &((EFI_IFR_IMAGE *) OpCodeData)->Id, sizeof (EFI_IMAGE_ID));\r
+ break;\r
+\r
+ //\r
+ // Refresh\r
+ //\r
+ case EFI_IFR_REFRESH_OP:\r
+ CurrentStatement->RefreshInterval = ((EFI_IFR_REFRESH *) OpCodeData)->RefreshInterval;\r
+ break;\r
+\r
+ //\r
+ // Vendor specific\r
+ //\r
+ case EFI_IFR_GUID_OP:\r
+ OptionMap = (EFI_IFR_GUID_OPTIONKEY *) OpCodeData;\r
+ \r
+ if (CompareGuid (&mTianoHiiIfrGuid, (EFI_GUID *)(OpCodeData + sizeof (EFI_IFR_OP_HEADER)))) {\r
+ //\r
+ // Tiano specific GUIDed opcodes\r
+ //\r
+ switch (((EFI_IFR_GUID_LABEL *) OpCodeData)->ExtendOpCode) {\r
+ case EFI_IFR_EXTEND_OP_LABEL:\r
+ //\r
+ // just ignore label\r
+ //\r
+ break;\r
+\r
+\r
+ case EFI_IFR_EXTEND_OP_CLASS:\r
+ CopyMem (&FormSet->Class, &((EFI_IFR_GUID_CLASS *) OpCodeData)->Class, sizeof (UINT16));\r
+ break;\r
+\r
+ case EFI_IFR_EXTEND_OP_SUBCLASS:\r
+ CopyMem (&FormSet->SubClass, &((EFI_IFR_GUID_SUBCLASS *) OpCodeData)->SubClass, sizeof (UINT16));\r
+ break;\r
+\r
+ default:\r
+ break;\r
+ }\r
+ } \r
+ else if (CompareGuid ((EFI_GUID *)(VOID *)&OptionMap->Guid, &mFrameworkHiiCompatibilityGuid)) {\r
+ if (OptionMap->ExtendOpCode == EFI_IFR_EXTEND_OP_OPTIONKEY) {\r
+ OneOfOptinMapEntryListHead = GetOneOfOptionMapEntryListHead (FormSet, OptionMap->QuestionId);\r
+ if (OneOfOptinMapEntryListHead == NULL) {\r
+ OneOfOptionMap = AllocateZeroPool (sizeof (ONE_OF_OPTION_MAP));\r
+ ASSERT (OneOfOptionMap != NULL);\r
+\r
+ OneOfOptionMap->Signature = ONE_OF_OPTION_MAP_SIGNATURE;\r
+ OneOfOptionMap->QuestionId = OptionMap->QuestionId;\r
+\r
+ //\r
+ // Make sure OneOfType is initialized.\r
+ //\r
+ ASSERT (OneOfType != (UINT8) -1);\r
+ OneOfOptionMap->ValueType = OneOfType;\r
+ InitializeListHead (&OneOfOptionMap->OneOfOptionMapEntryListHead);\r
+ OneOfOptinMapEntryListHead = &OneOfOptionMap->OneOfOptionMapEntryListHead;\r
+ InsertTailList (&FormSet->OneOfOptionMapListHead, &OneOfOptionMap->Link);\r
+ }\r
+ OneOfOptionMapEntry = AllocateZeroPool (sizeof (ONE_OF_OPTION_MAP_ENTRY));\r
+ ASSERT (OneOfOptionMapEntry != NULL);\r
+\r
+ OneOfOptionMapEntry->Signature = ONE_OF_OPTION_MAP_ENTRY_SIGNATURE;\r
+ OneOfOptionMapEntry->FwKey = OptionMap->KeyValue;\r
+ CopyMem (&OneOfOptionMapEntry->Value, &OptionMap->OptionValue, sizeof (EFI_IFR_TYPE_VALUE));\r
+ \r
+ InsertTailList (OneOfOptinMapEntryListHead, &OneOfOptionMapEntry->Link);\r
+ }\r
+ }\r
+ break;\r
+\r
+ //\r
+ // Scope End\r
+ //\r
+ case EFI_IFR_END_OP:\r
+ Status = PopScope (&ScopeOpCode);\r
+ if (EFI_ERROR (Status)) {\r
+ ResetScopeStack ();\r
+ return Status;\r
+ }\r
+\r
+ switch (ScopeOpCode) {\r
+ case EFI_IFR_FORM_SET_OP:\r
+ //\r
+ // End of FormSet, update FormSet IFR binary length\r
+ // to stop parsing substantial OpCodes\r
+ //\r
+ FormSet->IfrBinaryLength = OpCodeOffset;\r
+ break;\r
+\r
+ case EFI_IFR_FORM_OP:\r
+ //\r
+ // End of Form\r
+ //\r
+ CurrentForm = NULL;\r
+ break;\r
+\r
+ case EFI_IFR_ONE_OF_OPTION_OP:\r
+ //\r
+ // End of Option\r
+ //\r
+ CurrentOption = NULL;\r
+ break;\r
+\r
+ case EFI_IFR_SUBTITLE_OP:\r
+ mInScopeSubtitle = FALSE;\r
+ break;\r
+\r
+ case EFI_IFR_NO_SUBMIT_IF_OP:\r
+ case EFI_IFR_INCONSISTENT_IF_OP:\r
+ //\r
+ // Ignore end of EFI_IFR_NO_SUBMIT_IF and EFI_IFR_INCONSISTENT_IF\r
+ //\r
+ break;\r
+\r
+ case EFI_IFR_GRAY_OUT_IF_OP:\r
+ mInScopeGrayOut = FALSE;\r
+ break;\r
+\r
+ default:\r
+ if (IsExpressionOpCode (ScopeOpCode)) {\r
+ }\r
+ break;\r
+ }\r
+ break;\r
+\r
+ default:\r
+ break;\r
+ }\r
+ }\r
+\r
+ return EFI_SUCCESS;\r
+}\r
+\r
+\r
+\r
+\r