]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Library/ExtendedIfrSupportLib/Form.c
Move MdeModuleHii.h into Include\Guid directory
[mirror_edk2.git] / MdeModulePkg / Library / ExtendedIfrSupportLib / Form.c
index ea9079ea0f082128fe9cc2fe330d60382dcfdb4b..4524a4e71820c103f556366aec95dfc4b6c0ba00 100644 (file)
@@ -14,6 +14,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 #include "LibraryInternal.h"\r
 \r
+extern EFI_HII_DATABASE_PROTOCOL *gIfrLibHiiDatabase;\r
+\r
 /**\r
   Get the specified package from a package list based on an index.\r
   The Buffer on output is updated to point to a package header in\r
@@ -45,7 +47,7 @@ GetPackageDataFromPackageList (
   PackageHeader.Length = 0;\r
   PackageHeader.Type   = 0;\r
 \r
-  ASSERT(HiiPackageList != NULL);\r
+  ASSERT (HiiPackageList != NULL);\r
 \r
   if ((BufferLen == NULL) || (Buffer == NULL)) {\r
     return EFI_INVALID_PARAMETER;\r
@@ -54,7 +56,7 @@ GetPackageDataFromPackageList (
   Package = NULL;\r
   Index   = 0;\r
   Offset  = sizeof (EFI_HII_PACKAGE_LIST_HEADER);\r
-  CopyMem (&PackageListLength, &HiiPackageList->PackageLength, sizeof (UINT32));\r
+  PackageListLength = ReadUnaligned32 (&HiiPackageList->PackageLength);\r
   while (Offset < PackageListLength) {\r
     Package = (EFI_HII_PACKAGE_HEADER *) (((UINT8 *) HiiPackageList) + Offset);\r
     CopyMem (&PackageHeader, Package, sizeof (EFI_HII_PACKAGE_HEADER));\r
@@ -78,10 +80,10 @@ GetPackageDataFromPackageList (
 \r
 /**\r
   This is the internal worker function to update the data in\r
-  a form specified by FormSetGuid, \r
+  a form specified by FormSetGuid, FormId and Label.\r
 \r
   @param FormSetGuid     The optional Formset GUID.\r
-  @param FormId          The form ID>\r
+  @param FormId          The Form ID.\r
   @param Package         The package header.\r
   @param PackageLength   The package length.\r
   @param Label           The label for the update.\r
@@ -153,7 +155,7 @@ UpdateFormPackageData (
     switch (IfrOpHdr->OpCode) {\r
     case EFI_IFR_FORM_SET_OP :\r
       if (FormSetGuid != NULL) {\r
-        if (CompareMem (&((EFI_IFR_FORM_SET *) IfrOpHdr)->Guid, FormSetGuid, sizeof (EFI_GUID)) == 0) {\r
+        if (CompareGuid((GUID *)(VOID *)&((EFI_IFR_FORM_SET *) IfrOpHdr)->Guid, FormSetGuid)) {\r
           GetFormSet = TRUE;\r
         }\r
       }\r
@@ -176,8 +178,9 @@ UpdateFormPackageData (
       }\r
 \r
       ExtendOpCode = ((EFI_IFR_GUID_LABEL *) IfrOpHdr)->ExtendOpCode;\r
-      CopyMem (&LabelNumber, &((EFI_IFR_GUID_LABEL *)IfrOpHdr)->Number, sizeof (UINT16));\r
-      if ((ExtendOpCode != EFI_IFR_EXTEND_OP_LABEL) || (LabelNumber != Label)) {\r
+      LabelNumber = ReadUnaligned16 ((UINT16 *)(VOID *)&((EFI_IFR_GUID_LABEL *)IfrOpHdr)->Number);\r
+      if ((ExtendOpCode != EFI_IFR_EXTEND_OP_LABEL) || (LabelNumber != Label) \r
+          || !CompareGuid ((EFI_GUID *)(UINTN)(&((EFI_IFR_GUID_LABEL *)IfrOpHdr)->Guid), &gEfiIfrTianoGuid)) {\r
         //\r
         // Go to the next Op-Code\r
         //\r
@@ -216,7 +219,7 @@ UpdateFormPackageData (
           IfrOpHdr = (EFI_IFR_OP_HEADER *) ((CHAR8 *) (IfrOpHdr) + IfrOpHdr->Length);\r
           if (IfrOpHdr->OpCode == EFI_IFR_GUID_OP) {\r
             ExtendOpCode = ((EFI_IFR_GUID_LABEL *) IfrOpHdr)->ExtendOpCode;\r
-            if (ExtendOpCode == EFI_IFR_EXTEND_OP_LABEL) {\r
+            if ((ExtendOpCode == EFI_IFR_EXTEND_OP_LABEL) && CompareGuid ((EFI_GUID *)(UINTN)(&((EFI_IFR_GUID_LABEL *)IfrOpHdr)->Guid), &gEfiIfrTianoGuid)) {\r
               break;\r
             }\r
           }\r
@@ -264,7 +267,7 @@ UpdateFormPackageData (
 \r
 Fail:\r
   if (!Updated) {\r
-    gBS->FreePool (*TempBuffer);\r
+    FreePool (*TempBuffer);\r
     *TempBufferSize = 0;\r
     return EFI_NOT_FOUND;\r
   }\r
@@ -272,6 +275,50 @@ Fail:
   return EFI_SUCCESS;\r
 }\r
 \r
+/**\r
+  This function initialize the data structure for dynamic opcode.\r
+\r
+  @param UpdateData     The adding data;\r
+  @param BufferSize     Length of the buffer to fill dynamic opcodes.\r
+\r
+  @retval EFI_SUCCESS           Update data is initialized.\r
+  @retval EFI_INVALID_PARAMETER UpdateData is NULL.\r
+  @retval EFI_OUT_OF_RESOURCES  No enough memory to allocate.\r
+\r
+**/\r
+EFI_STATUS\r
+IfrLibInitUpdateData (\r
+  IN OUT EFI_HII_UPDATE_DATA   *UpdateData,\r
+  IN UINT32                    BufferSize\r
+  )\r
+{\r
+  ASSERT (UpdateData != NULL);\r
+\r
+  UpdateData->BufferSize = BufferSize;\r
+  UpdateData->Offset = 0;\r
+  UpdateData->Data = AllocatePool (BufferSize);\r
+\r
+  return (UpdateData->Data != NULL) ? EFI_SUCCESS : EFI_OUT_OF_RESOURCES;\r
+}\r
+\r
+/**\r
+\r
+  This function free the resource of update data.\r
+\r
+  @param UpdateData      The adding data;\r
+\r
+**/\r
+VOID\r
+IfrLibFreeUpdateData (\r
+  IN EFI_HII_UPDATE_DATA       *UpdateData\r
+  )\r
+{\r
+  ASSERT (UpdateData != NULL);\r
+  \r
+  FreePool (UpdateData->Data);\r
+  UpdateData->Data = NULL;\r
+\r
+}\r
 \r
 /**\r
   This function allows the caller to update a form that has\r
@@ -329,15 +376,21 @@ IfrLibUpdateForm (
   BufferSize = 0;\r
   HiiPackageList   = NULL;\r
   Status = HiiDatabase->ExportPackageLists (HiiDatabase, Handle, &BufferSize, HiiPackageList);\r
-  if (Status == EFI_BUFFER_TOO_SMALL) {\r
-    HiiPackageList = AllocatePool (BufferSize);\r
-    ASSERT (HiiPackageList != NULL);\r
+  //\r
+  // Handle is a invalid handle. Check if Handle is corrupted.\r
+  //\r
+  ASSERT (Status != EFI_NOT_FOUND);\r
+  //\r
+  // The return status should always be EFI_BUFFER_TOO_SMALL as input buffer's size is 0.\r
+  //\r
+  ASSERT (Status == EFI_BUFFER_TOO_SMALL);\r
+  HiiPackageList = AllocatePool (BufferSize);\r
+  ASSERT (HiiPackageList != NULL);\r
 \r
-    Status = HiiDatabase->ExportPackageLists (HiiDatabase, Handle, &BufferSize, HiiPackageList);\r
-    if (EFI_ERROR (Status)) {\r
-      gBS->FreePool (HiiPackageList);\r
-      return Status;\r
-    }\r
+  Status = HiiDatabase->ExportPackageLists (HiiDatabase, Handle, &BufferSize, HiiPackageList);\r
+  if (EFI_ERROR (Status)) {\r
+    FreePool (HiiPackageList);\r
+    return Status;\r
   }\r
 \r
   //\r
@@ -362,7 +415,7 @@ IfrLibUpdateForm (
     Status = GetPackageDataFromPackageList (HiiPackageList, Index, &PackageLength, &Package);\r
     if (Status == EFI_SUCCESS) {\r
       CopyMem (&PackageHeader, Package, sizeof (EFI_HII_PACKAGE_HEADER));\r
-      if ((PackageHeader.Type == EFI_HII_PACKAGE_FORM) && !Updated) {\r
+      if ((PackageHeader.Type == EFI_HII_PACKAGE_FORMS) && !Updated) {\r
         Status = UpdateFormPackageData (FormSetGuid, FormId, Package, PackageLength, Label, Insert, Data, (UINT8 **)&TempBuffer, &TempBufferSize);\r
         if (!EFI_ERROR(Status)) {\r
           if (FormSetGuid == NULL) {\r
@@ -370,7 +423,7 @@ IfrLibUpdateForm (
           }\r
           CopyMem (UpdateBufferPos, TempBuffer, TempBufferSize);\r
           UpdateBufferPos += TempBufferSize;\r
-          gBS->FreePool (TempBuffer);\r
+          FreePool (TempBuffer);\r
           continue;\r
         }\r
       }\r
@@ -380,7 +433,7 @@ IfrLibUpdateForm (
     } else if (Status == EFI_NOT_FOUND) {\r
       break;\r
     } else {\r
-      gBS->FreePool (HiiPackageList);\r
+      FreePool (HiiPackageList);\r
       return Status;\r
     }\r
   }\r
@@ -389,16 +442,22 @@ IfrLibUpdateForm (
   // Update package list length\r
   //\r
   BufferSize = UpdateBufferPos - (UINT8 *) UpdateBuffer;\r
-  CopyMem (&UpdateBuffer->PackageLength, &BufferSize, sizeof (UINT32));\r
+  WriteUnaligned32 (&UpdateBuffer->PackageLength, (UINT32)BufferSize);\r
 \r
-  gBS->FreePool (HiiPackageList);\r
+  FreePool (HiiPackageList);\r
 \r
   return HiiDatabase->UpdatePackageList (HiiDatabase, Handle, UpdateBuffer);\r
 }\r
 \r
 \r
 /**\r
-  Configure the buffer accrording to ConfigBody strings.\r
+  Configure the buffer accrording to ConfigBody strings in the format of\r
+  <Length:4 bytes>, <Offset: 2 bytes>, <Width:2 bytes>, <Data:n bytes>.\r
+  This ConfigBody strings is generated by UEFI VfrCompiler for the default\r
+  values in a Form Set. The name of the ConfigBody strings is VfrMyIfrNVDataDefault0000\r
+  constructed following this rule: \r
+   "Vfr" + varstore.name + "Default" + defaultstore.attributes.\r
+  Check the generated C file in Output for details.\r
 \r
   @param  Buffer                 The start address of buffer.\r
   @param  BufferSize             The size of buffer.\r
@@ -440,13 +499,13 @@ IfrLibExtractDefault(
   VA_START (Args, Number);\r
   for (Index = 0; Index < Number; Index++) {\r
     BufCfgArray = (UINT8 *) VA_ARG (Args, VOID *);\r
-    CopyMem (&TotalLen, BufCfgArray, sizeof (UINT32));\r
+    TotalLen = ReadUnaligned32 ((UINT32 *)BufCfgArray);\r
     BufferPos = BufCfgArray + sizeof (UINT32);\r
 \r
     while ((UINT32)(BufferPos - BufCfgArray) < TotalLen) {\r
-      CopyMem (&Offset, BufferPos, sizeof (UINT16));\r
+      Offset = ReadUnaligned16 ((UINT16 *)BufferPos);\r
       BufferPos += sizeof (UINT16);\r
-      CopyMem (&Width, BufferPos, sizeof (UINT16));\r
+      Width = ReadUnaligned16 ((UINT16 *)BufferPos);\r
       BufferPos += sizeof (UINT16);\r
       Value = BufferPos;\r
       BufferPos += Width;\r