]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Library/ExtendedIfrSupportLib/Form.c
Replace CopyMem() which can be replaced by BaseLib's Read/WriteUnalianedXX() as these...
[mirror_edk2.git] / MdeModulePkg / Library / ExtendedIfrSupportLib / Form.c
index a2891de649aab788b59fb53283f9a77230570741..b9b62b2bacad6a4f9a0828ef100de13b26abd319 100644 (file)
@@ -14,7 +14,22 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 #include "LibraryInternal.h"\r
 \r
-STATIC\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
+  the HiiPackageList. This is an internal function.\r
+\r
+  @param HiiPackageList  The Package List Header.\r
+  @param PackageIndex    The index of the package to get.\r
+  @param BufferLen       The length of the package.\r
+  @param Buffer          The starting address of package.\r
+\r
+  @retval EFI_SUCCESS   This function completes successfully.\r
+  @retval EFI_NOT_FOUND The package is not found.\r
+\r
+**/\r
 EFI_STATUS\r
 GetPackageDataFromPackageList (\r
   IN  EFI_HII_PACKAGE_LIST_HEADER *HiiPackageList,\r
@@ -27,9 +42,12 @@ GetPackageDataFromPackageList (
   EFI_HII_PACKAGE_HEADER        *Package;\r
   UINT32                        Offset;\r
   UINT32                        PackageListLength;\r
-  EFI_HII_PACKAGE_HEADER        PackageHeader = {0, 0};\r
+  EFI_HII_PACKAGE_HEADER        PackageHeader;\r
 \r
-  ASSERT(HiiPackageList != NULL);\r
+  PackageHeader.Length = 0;\r
+  PackageHeader.Type   = 0;\r
+\r
+  ASSERT (HiiPackageList != NULL);\r
 \r
   if ((BufferLen == NULL) || (Buffer == NULL)) {\r
     return EFI_INVALID_PARAMETER;\r
@@ -38,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
@@ -60,11 +78,29 @@ GetPackageDataFromPackageList (
   return EFI_SUCCESS;\r
 }\r
 \r
-STATIC\r
+/**\r
+  This is the internal worker function to update the data in\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 Package         The package header.\r
+  @param PackageLength   The package length.\r
+  @param Label           The label for the update.\r
+  @param Insert          True if inserting opcode to the form.\r
+  @param Data            The data payload.\r
+  @param TempBuffer      The resultant package.\r
+  @param TempBufferSize  The length of the resultant package.\r
+\r
+  @retval EFI_OUT_OF_RESOURCES  If there is not enough memory to complete the operation.\r
+  @retval EFI_INVALID_PARAMETER If TempBuffer or TempBufferSize is NULL.\r
+  @retval EFI_SUCCESS    The function completes successfully.\r
+\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 UpdateFormPackageData (\r
-  IN  EFI_GUID               *FormSetGuid,\r
+  IN  EFI_GUID               *FormSetGuid, OPTIONAL\r
   IN  EFI_FORM_ID            FormId,\r
   IN  EFI_HII_PACKAGE_HEADER *Package,\r
   IN  UINT32                 PackageLength,\r
@@ -142,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 (&((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), &mIfrVendorGuid)) {\r
         //\r
         // Go to the next Op-Code\r
         //\r
@@ -182,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), &mIfrVendorGuid)) {\r
               break;\r
             }\r
           }\r
@@ -230,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
@@ -238,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
@@ -301,7 +382,7 @@ IfrLibUpdateForm (
 \r
     Status = HiiDatabase->ExportPackageLists (HiiDatabase, Handle, &BufferSize, HiiPackageList);\r
     if (EFI_ERROR (Status)) {\r
-      gBS->FreePool (HiiPackageList);\r
+      FreePool (HiiPackageList);\r
       return Status;\r
     }\r
   }\r
@@ -328,7 +409,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
@@ -336,7 +417,7 @@ IfrLibUpdateForm (
           }\r
           CopyMem (UpdateBufferPos, TempBuffer, TempBufferSize);\r
           UpdateBufferPos += TempBufferSize;\r
-          gBS->FreePool (TempBuffer);\r
+          FreePool (TempBuffer);\r
           continue;\r
         }\r
       }\r
@@ -346,7 +427,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
@@ -355,21 +436,28 @@ 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
-\r
-  @param  DefaultId              the ID of default.\r
-  @param  Buffer                 the start address of buffer.\r
-  @param  BufferSize             the size of buffer.\r
-  @param  Number                 the number of the 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
+  @param  Number                 The number of the strings.\r
+  @param  ...                    Variable argument list for default value in <AltResp> format \r
+                                 generated by the tool.\r
 \r
   @retval EFI_BUFFER_TOO_SMALL   the BufferSize is too small to operate.\r
   @retval EFI_INVALID_PARAMETER  Buffer is NULL or BufferSize is 0.\r
@@ -405,13 +493,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