]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Universal/SetupBrowserDxe/IfrParse.c
MdeModulePkg: Add match2 opcode support in SetupBrowserDxe and sample code in DriverS...
[mirror_edk2.git] / MdeModulePkg / Universal / SetupBrowserDxe / IfrParse.c
index b4f045df601ae543f46ae214729fce4d54bedfc9..8ddc449e69b63c00b5aea2a20c364b5b1c0efa5e 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
 Parser for IFR binary encoding.\r
 \r
-Copyright (c) 2007 - 2013, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2007 - 2015, 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
@@ -320,20 +320,20 @@ CreateExpression (
 EFI_STATUS\r
 InitializeConfigHdr (\r
   IN FORM_BROWSER_FORMSET  *FormSet,\r
-  IN OUT BROWSER_STORAGE   *Storage\r
+  IN OUT FORMSET_STORAGE   *Storage\r
   )\r
 {\r
   CHAR16      *Name;\r
 \r
-  if (Storage->Type == EFI_HII_VARSTORE_BUFFER || \r
-      Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER) {\r
-    Name = Storage->Name;\r
+  if (Storage->BrowserStorage->Type == EFI_HII_VARSTORE_BUFFER || \r
+      Storage->BrowserStorage->Type == EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER) {\r
+    Name = Storage->BrowserStorage->Name;\r
   } else {\r
     Name = NULL;\r
   }\r
 \r
   Storage->ConfigHdr = HiiConstructConfigHdr (\r
-                         &Storage->Guid,\r
+                         &Storage->BrowserStorage->Guid,\r
                          Name,\r
                          FormSet->DriverHandle\r
                          );\r
@@ -451,6 +451,40 @@ IntializeBrowserStorage (
   }\r
 }\r
 \r
+/**\r
+  Check whether exist device path info in the ConfigHdr string.\r
+\r
+  @param  String                 UEFI configuration string\r
+\r
+  @retval TRUE                   Device Path exist.\r
+  @retval FALSE                  Not exist device path info.\r
+\r
+**/\r
+BOOLEAN\r
+IsDevicePathExist (\r
+  IN  EFI_STRING                   String\r
+  )\r
+{\r
+  UINTN                    Length;\r
+\r
+  for (; (*String != 0 && StrnCmp (String, L"PATH=", StrLen (L"PATH=")) != 0); String++);\r
+  if (*String == 0) {\r
+    return FALSE;\r
+  }\r
+\r
+  String += StrLen (L"PATH=");\r
+  if (*String == 0) {\r
+    return FALSE;\r
+  }\r
+\r
+  for (Length = 0; *String != 0 && *String != L'&'; String++, Length++);\r
+  if (((Length + 1) / 2) < sizeof (EFI_DEVICE_PATH_PROTOCOL)) {\r
+    return FALSE;\r
+  }\r
+\r
+  return TRUE;\r
+}\r
+\r
 /**\r
   Allocate a FORMSET_STORAGE data structure and insert to FormSet Storage List.\r
 \r
@@ -525,18 +559,108 @@ CreateStorage (
     }\r
 \r
     BrowserStorage->HiiHandle = FormSet->HiiHandle;\r
-    InitializeConfigHdr (FormSet, BrowserStorage);\r
 \r
     BrowserStorage->Initialized = FALSE;\r
   }\r
 \r
   Storage->BrowserStorage = BrowserStorage;\r
-  Storage->ConfigRequest = AllocateCopyPool (StrSize (BrowserStorage->ConfigHdr), BrowserStorage->ConfigHdr);\r
+  InitializeConfigHdr (FormSet, Storage);\r
+  Storage->ConfigRequest = AllocateCopyPool (StrSize (Storage->ConfigHdr), Storage->ConfigHdr);\r
   Storage->SpareStrLen = 0;\r
 \r
   return Storage;\r
 }\r
 \r
+/**\r
+  Get Formset_storage base on the input varstoreid info.\r
+\r
+  @param  FormSet                Pointer of the current FormSet.\r
+  @param  VarStoreId             Varstore ID info.\r
+\r
+  @return Pointer to a FORMSET_STORAGE data structure.\r
+\r
+**/\r
+FORMSET_STORAGE *\r
+GetFstStgFromVarId (\r
+  IN FORM_BROWSER_FORMSET  *FormSet,\r
+  IN EFI_VARSTORE_ID       VarStoreId\r
+  )\r
+{\r
+  FORMSET_STORAGE  *FormsetStorage;\r
+  LIST_ENTRY       *Link;\r
+  BOOLEAN          Found;\r
+\r
+  Found = FALSE;\r
+  FormsetStorage = NULL;\r
+  //\r
+  // Find Formset Storage for this Question\r
+  //\r
+  Link = GetFirstNode (&FormSet->StorageListHead);\r
+  while (!IsNull (&FormSet->StorageListHead, Link)) {\r
+    FormsetStorage = FORMSET_STORAGE_FROM_LINK (Link);\r
+\r
+    if (FormsetStorage->VarStoreId == VarStoreId) {\r
+      Found = TRUE;\r
+      break;\r
+    }\r
+\r
+    Link = GetNextNode (&FormSet->StorageListHead, Link);\r
+  }\r
+\r
+  return Found ? FormsetStorage : NULL;\r
+}\r
+\r
+/**\r
+  Get Formset_storage base on the input browser storage.\r
+\r
+  More than one formsets may share the same browser storage,\r
+  this function just get the first formset storage which\r
+  share the browser storage.\r
+\r
+  @param  Storage              browser storage info.\r
+\r
+  @return Pointer to a FORMSET_STORAGE data structure.\r
+  \r
+\r
+**/\r
+FORMSET_STORAGE *\r
+GetFstStgFromBrsStg (\r
+  IN BROWSER_STORAGE       *Storage\r
+  )\r
+{\r
+  FORMSET_STORAGE      *FormsetStorage;\r
+  LIST_ENTRY           *Link;\r
+  LIST_ENTRY           *FormsetLink;\r
+  FORM_BROWSER_FORMSET *FormSet;\r
+  BOOLEAN              Found;\r
+\r
+  Found = FALSE;\r
+  FormsetStorage = NULL;\r
+\r
+  FormsetLink = GetFirstNode (&gBrowserFormSetList);\r
+  while (!IsNull (&gBrowserFormSetList, FormsetLink)) {\r
+    FormSet = FORM_BROWSER_FORMSET_FROM_LINK (FormsetLink);\r
+    FormsetLink = GetNextNode (&gBrowserFormSetList, FormsetLink);\r
+\r
+    Link = GetFirstNode (&FormSet->StorageListHead);\r
+    while (!IsNull (&FormSet->StorageListHead, Link)) {\r
+      FormsetStorage = FORMSET_STORAGE_FROM_LINK (Link);\r
+      Link = GetNextNode (&FormSet->StorageListHead, Link);\r
+\r
+      if (FormsetStorage->BrowserStorage == Storage) {\r
+        Found = TRUE;\r
+        break;\r
+      }\r
+    }\r
+\r
+    if (Found) {\r
+      break;\r
+    }\r
+  }\r
+\r
+  return Found ? FormsetStorage : NULL;\r
+}\r
+\r
 /**\r
   Initialize Request Element of a Question. <RequestElement> ::= '&'<BlockName> | '&'<Label>\r
 \r
@@ -586,7 +710,7 @@ InitializeRequestElement (
     StrLen = UnicodeSPrint (\r
                RequestElement,\r
                30 * sizeof (CHAR16),\r
-               L"&OFFSET=%x&WIDTH=%x",\r
+               L"&OFFSET=%04x&WIDTH=%04x",\r
                Question->VarStoreInfo.VarOffset,\r
                Question->StorageWidth\r
                );\r
@@ -606,17 +730,7 @@ InitializeRequestElement (
   //\r
   // Find Formset Storage for this Question\r
   //\r
-  FormsetStorage = NULL;\r
-  Link = GetFirstNode (&FormSet->StorageListHead);\r
-  while (!IsNull (&FormSet->StorageListHead, Link)) {\r
-    FormsetStorage = FORMSET_STORAGE_FROM_LINK (Link);\r
-\r
-    if (FormsetStorage->VarStoreId == Question->VarStoreId) {\r
-      break;\r
-    }\r
-\r
-    Link = GetNextNode (&FormSet->StorageListHead, Link);\r
-  }\r
+  FormsetStorage = GetFstStgFromVarId(FormSet, Question->VarStoreId);\r
   ASSERT (FormsetStorage != NULL);\r
 \r
   //\r
@@ -650,7 +764,7 @@ InitializeRequestElement (
   while (!IsNull (&Form->ConfigRequestHead, Link)) {\r
     ConfigInfo = FORM_BROWSER_CONFIG_REQUEST_FROM_LINK (Link);\r
 \r
-    if (ConfigInfo != NULL && ConfigInfo->Storage == Storage) {\r
+    if (ConfigInfo != NULL && ConfigInfo->Storage == FormsetStorage->BrowserStorage) {\r
       Find = TRUE;\r
       break;\r
     }\r
@@ -662,9 +776,10 @@ InitializeRequestElement (
     ConfigInfo = AllocateZeroPool(sizeof (FORM_BROWSER_CONFIG_REQUEST));\r
     ASSERT (ConfigInfo != NULL);\r
     ConfigInfo->Signature     = FORM_BROWSER_CONFIG_REQUEST_SIGNATURE;\r
-    ConfigInfo->ConfigRequest = AllocateCopyPool (StrSize (Storage->ConfigHdr), Storage->ConfigHdr);\r
+    ConfigInfo->ConfigRequest = AllocateCopyPool (StrSize (FormsetStorage->ConfigHdr), FormsetStorage->ConfigHdr);\r
+    ASSERT (ConfigInfo->ConfigRequest != NULL);\r
     ConfigInfo->SpareStrLen   = 0;\r
-    ConfigInfo->Storage       = Storage;\r
+    ConfigInfo->Storage       = FormsetStorage->BrowserStorage;\r
     InsertTailList(&Form->ConfigRequestHead, &ConfigInfo->Link);\r
   }\r
 \r
@@ -787,6 +902,9 @@ DestroyStatement (
     Default = QUESTION_DEFAULT_FROM_LINK (Link);\r
     RemoveEntryList (&Default->Link);\r
 \r
+    if (Default->Value.Buffer != NULL) {\r
+      FreePool (Default->Value.Buffer);\r
+    }\r
     FreePool (Default);\r
   }\r
 \r
@@ -912,6 +1030,8 @@ DestroyForm (
     FreePool (Form->SuppressExpression);\r
   }\r
 \r
+  UiFreeMenuList (&Form->FormViewListHead);\r
+\r
   //\r
   // Free this Form\r
   //\r
@@ -1032,7 +1152,8 @@ IsExpressionOpCode (
       (Operand == EFI_IFR_TO_UPPER_OP) ||\r
       (Operand == EFI_IFR_MAP_OP)      ||\r
       (Operand == EFI_IFR_VERSION_OP)  ||\r
-      (Operand == EFI_IFR_SECURITY_OP)) {\r
+      (Operand == EFI_IFR_SECURITY_OP) ||\r
+      (Operand == EFI_IFR_MATCH2_OP)) {\r
     return TRUE;\r
   } else {\r
     return FALSE;\r
@@ -1073,6 +1194,23 @@ IsStatementOpCode (
   }\r
 }\r
 \r
+/**\r
+  Tell whether this Operand is an known OpCode.\r
+\r
+  @param  Operand                Operand of an IFR OpCode.\r
+\r
+  @retval TRUE                   This is an Statement OpCode.\r
+  @retval FALSE                  Not an Statement OpCode.\r
+\r
+**/\r
+BOOLEAN\r
+IsUnKnownOpCode (\r
+  IN UINT8              Operand\r
+  )\r
+{\r
+  return Operand > EFI_IFR_MATCH2_OP ? TRUE : FALSE;\r
+}\r
+\r
 /**\r
   Calculate number of Statemens(Questions) and Expression OpCodes.\r
 \r
@@ -1165,6 +1303,8 @@ ParseOpCodes (
   EFI_VARSTORE_ID         TempVarstoreId;\r
   BOOLEAN                 InScopeDisable;\r
   INTN                    ConditionalExprCount;\r
+  BOOLEAN                 InUnknownScope;\r
+  UINT8                   UnknownDepth;\r
 \r
   SuppressForQuestion      = FALSE;\r
   SuppressForOption        = FALSE;\r
@@ -1184,6 +1324,8 @@ ParseOpCodes (
   MapExpressionList        = NULL;\r
   TempVarstoreId           = 0;\r
   ConditionalExprCount     = 0;\r
+  InUnknownScope           = FALSE;\r
+  UnknownDepth             = 0;\r
 \r
   //\r
   // Get the number of Statements and Expressions\r
@@ -1205,6 +1347,7 @@ ParseOpCodes (
 \r
   InitializeListHead (&FormSet->StatementListOSF);\r
   InitializeListHead (&FormSet->StorageListHead);\r
+  InitializeListHead (&FormSet->SaveFailStorageListHead);\r
   InitializeListHead (&FormSet->DefaultStoreListHead);\r
   InitializeListHead (&FormSet->FormListHead);\r
   InitializeListHead (&FormSet->ExpressionListHead);\r
@@ -1226,6 +1369,31 @@ ParseOpCodes (
     Operand = ((EFI_IFR_OP_HEADER *) OpCodeData)->OpCode;\r
     Scope = ((EFI_IFR_OP_HEADER *) OpCodeData)->Scope;\r
 \r
+    if (InUnknownScope) {\r
+      if (Operand == EFI_IFR_END_OP) {\r
+        UnknownDepth --;\r
+\r
+        if (UnknownDepth == 0) {\r
+          InUnknownScope = FALSE;\r
+        }\r
+      } else {\r
+        if (Scope != 0) {\r
+          UnknownDepth ++;\r
+        }\r
+      }\r
+\r
+      continue;\r
+    }\r
+\r
+    if (IsUnKnownOpCode(Operand)) {\r
+      if (Scope != 0) {\r
+        InUnknownScope = TRUE;\r
+        UnknownDepth ++;\r
+      }\r
+\r
+      continue;\r
+    }\r
+\r
     //\r
     // If scope bit set, push onto scope stack\r
     //\r
@@ -1312,6 +1480,10 @@ ParseOpCodes (
         CopyMem (&ExpressionOpCode->Guid, &((EFI_IFR_SECURITY *) OpCodeData)->Permissions, sizeof (EFI_GUID));\r
         break;\r
 \r
+      case EFI_IFR_MATCH2_OP:\r
+        CopyMem (&ExpressionOpCode->Guid, &((EFI_IFR_MATCH2 *) OpCodeData)->SyntaxType, sizeof (EFI_GUID));\r
+        break;\r
+\r
       case EFI_IFR_GET_OP:\r
       case EFI_IFR_SET_OP:\r
         CopyMem (&TempVarstoreId, &((EFI_IFR_GET *) OpCodeData)->VarStoreId, sizeof (TempVarstoreId));\r
@@ -1513,11 +1685,7 @@ ParseOpCodes (
             return Status;\r
           }\r
 \r
-          if (CurrentExpression->Result.Type != EFI_IFR_TYPE_BOOLEAN) {\r
-            return EFI_INVALID_PARAMETER;\r
-          }\r
-\r
-          OpCodeDisabled = CurrentExpression->Result.Value.b;\r
+          OpCodeDisabled = IsTrue(&CurrentExpression->Result);\r
         }\r
 \r
         CurrentExpression = NULL;\r
@@ -1561,6 +1729,7 @@ ParseOpCodes (
       InitializeListHead (&CurrentForm->ExpressionListHead);\r
       InitializeListHead (&CurrentForm->StatementListHead);\r
       InitializeListHead (&CurrentForm->ConfigRequestHead);\r
+      InitializeListHead (&CurrentForm->FormViewListHead);\r
 \r
       CurrentForm->FormType = STANDARD_MAP_FORM_TYPE;\r
       CopyMem (&CurrentForm->FormId,    &((EFI_IFR_FORM *) OpCodeData)->FormId,    sizeof (UINT16));\r
@@ -1602,6 +1771,8 @@ ParseOpCodes (
       InitializeListHead (&CurrentForm->ExpressionListHead);\r
       InitializeListHead (&CurrentForm->StatementListHead);\r
       InitializeListHead (&CurrentForm->ConfigRequestHead);\r
+      InitializeListHead (&CurrentForm->FormViewListHead);\r
+\r
       CopyMem (&CurrentForm->FormId, &((EFI_IFR_FORM *) OpCodeData)->FormId, sizeof (UINT16));\r
 \r
       MapMethod = (EFI_IFR_FORM_MAP_METHOD *) (OpCodeData + sizeof (EFI_IFR_FORM_MAP));\r
@@ -1950,7 +2121,11 @@ ParseOpCodes (
 \r
       CurrentDefault->Value.Type = ((EFI_IFR_DEFAULT *) OpCodeData)->Type;\r
       CopyMem (&CurrentDefault->DefaultId, &((EFI_IFR_DEFAULT *) OpCodeData)->DefaultId, sizeof (UINT16));\r
-      if (OpCodeLength > OFFSET_OF (EFI_IFR_DEFAULT, Value)) {\r
+      if (CurrentDefault->Value.Type == EFI_IFR_TYPE_BUFFER) {\r
+        CurrentDefault->Value.BufferLen = (UINT16) (OpCodeLength - OFFSET_OF (EFI_IFR_DEFAULT, Value));\r
+        CurrentDefault->Value.Buffer = AllocateCopyPool (CurrentDefault->Value.BufferLen, &((EFI_IFR_DEFAULT *) OpCodeData)->Value);\r
+        ASSERT (CurrentDefault->Value.Buffer != NULL);\r
+      } else {\r
         CopyMem (&CurrentDefault->Value.Value, &((EFI_IFR_DEFAULT *) OpCodeData)->Value, OpCodeLength - OFFSET_OF (EFI_IFR_DEFAULT, Value));\r
         ExtendValueToU64 (&CurrentDefault->Value);\r
       }\r
@@ -1969,6 +2144,32 @@ ParseOpCodes (
     // Option\r
     //\r
     case EFI_IFR_ONE_OF_OPTION_OP:\r
+      if (ParentStatement->Operand == EFI_IFR_ORDERED_LIST_OP && ((((EFI_IFR_ONE_OF_OPTION *) OpCodeData)->Flags & (EFI_IFR_OPTION_DEFAULT | EFI_IFR_OPTION_DEFAULT_MFG)) != 0)) {\r
+        //\r
+        // It's keep the default value for ordered list opcode.\r
+        //\r
+        CurrentDefault = AllocateZeroPool (sizeof (QUESTION_DEFAULT));\r
+        ASSERT (CurrentDefault != NULL);\r
+        CurrentDefault->Signature = QUESTION_DEFAULT_SIGNATURE;\r
+\r
+        CurrentDefault->Value.Type = EFI_IFR_TYPE_BUFFER;\r
+        if ((((EFI_IFR_ONE_OF_OPTION *) OpCodeData)->Flags & EFI_IFR_OPTION_DEFAULT) != 0) {\r
+          CurrentDefault->DefaultId = EFI_HII_DEFAULT_CLASS_STANDARD;\r
+        } else {\r
+          CurrentDefault->DefaultId = EFI_HII_DEFAULT_CLASS_MANUFACTURING;\r
+        }\r
+\r
+        CurrentDefault->Value.BufferLen = (UINT16) (OpCodeLength - OFFSET_OF (EFI_IFR_ONE_OF_OPTION, Value));\r
+        CurrentDefault->Value.Buffer = AllocateCopyPool (CurrentDefault->Value.BufferLen, &((EFI_IFR_ONE_OF_OPTION *) OpCodeData)->Value);\r
+        ASSERT (CurrentDefault->Value.Buffer != NULL);\r
+\r
+        //\r
+        // Insert to Default Value list of current Question\r
+        //\r
+        InsertTailList (&ParentStatement->DefaultListHead, &CurrentDefault->Link);\r
+        break;\r
+      }\r
+\r
       //\r
       // EFI_IFR_ONE_OF_OPTION appear in scope of a Question.\r
       // It create a selection for use in current Question.\r
@@ -2285,6 +2486,7 @@ ParseOpCodes (
         break;\r
 \r
       case EFI_IFR_ONE_OF_OPTION_OP:\r
+        ASSERT (CurrentOption != NULL);\r
         ImageId = &CurrentOption->ImageId;\r
         break;\r
 \r
@@ -2315,8 +2517,24 @@ ParseOpCodes (
     // Refresh guid.\r
     //\r
     case EFI_IFR_REFRESH_ID_OP:\r
-      ASSERT (ParentStatement != NULL);\r
-      CopyMem (&ParentStatement->RefreshGuid, &((EFI_IFR_REFRESH_ID *) OpCodeData)->RefreshEventGroupId, sizeof (EFI_GUID));\r
+      //\r
+      // Get ScopeOpcode from top of stack\r
+      //\r
+      PopScope (&ScopeOpCode);\r
+      PushScope (ScopeOpCode);\r
+\r
+      switch (ScopeOpCode) {\r
+      case EFI_IFR_FORM_OP:\r
+      case EFI_IFR_FORM_MAP_OP:\r
+        ASSERT (CurrentForm != NULL);\r
+        CopyMem (&CurrentForm->RefreshGuid, &((EFI_IFR_REFRESH_ID *) OpCodeData)->RefreshEventGroupId, sizeof (EFI_GUID));\r
+        break;\r
+\r
+      default:\r
+        ASSERT (ParentStatement != NULL);\r
+        CopyMem (&ParentStatement->RefreshGuid, &((EFI_IFR_REFRESH_ID *) OpCodeData)->RefreshEventGroupId, sizeof (EFI_GUID));\r
+        break;\r
+      }\r
       break;\r
 \r
     //\r
@@ -2466,11 +2684,8 @@ ParseOpCodes (
               return Status;\r
             }\r
 \r
-            if (CurrentExpression->Result.Type != EFI_IFR_TYPE_BOOLEAN) {\r
-              return EFI_INVALID_PARAMETER;\r
-            }\r
+            OpCodeDisabled = IsTrue (&CurrentExpression->Result);\r
 \r
-            OpCodeDisabled = CurrentExpression->Result.Value.b;\r
             //\r
             // DisableIf Expression is only used once and not queued, free it\r
             //\r