Clean up HiiLib.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5481 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/MdePkg/Library/HiiLib/HiiLanguage.c b/MdePkg/Library/HiiLib/HiiLanguage.c
index f5c8f032a926bf6ac04eb54d5b538096fd0548b4..3d9a36d468cba07101387ef315e5b1368030a08a 100644 (file)
--- a/MdePkg/Library/HiiLib/HiiLanguage.c
+++ b/MdePkg/Library/HiiLib/HiiLanguage.c
@@ -124,7 +124,6 @@ HiiLibGetSupportedLanguages (
   UINTN       BufferSize;\r
   CHAR8       *LanguageString;\r
 \r
-  ASSERT (HiiHandle != NULL);\r
   ASSERT (IsHiiHandleRegistered (HiiHandle));\r
   //\r
   // Collect current supported Languages for given HII handle\r
@@ -140,7 +139,7 @@ HiiLibGetSupportedLanguages (
   Status = mHiiStringProt->GetLanguages (mHiiStringProt, HiiHandle, LanguageString, &BufferSize);\r
   \r
   if (Status == EFI_BUFFER_TOO_SMALL) {\r
-    gBS->FreePool (LanguageString);\r
+    FreePool (LanguageString);\r
     LanguageString = AllocateZeroPool (BufferSize);\r
     if (LanguageString == NULL) {\r
       return NULL;\r
@@ -190,7 +189,7 @@ HiiLibGetSupportedLanguageNumber (
     HiiLibGetNextLanguage (&LanguageString, Lang);\r
     LangNumber++;\r
   }\r
-  gBS->FreePool (Languages);\r
+  FreePool (Languages);\r
 \r
   return LangNumber;\r
 }\r
@@ -235,7 +234,7 @@ HiiLibGetSupportedSecondaryLanguages (
   Status = mHiiStringProt->GetSecondaryLanguages (mHiiStringProt, HiiHandle, FirstLanguage, LanguageString, &BufferSize);\r
   \r
   if (Status == EFI_BUFFER_TOO_SMALL) {\r
-    gBS->FreePool (LanguageString);\r
+    FreePool (LanguageString);\r
     LanguageString = AllocateZeroPool (BufferSize);\r
     if (LanguageString == NULL) {\r
       return NULL;\r

diff --git a/MdePkg/Library/HiiLib/HiiLib.c b/MdePkg/Library/HiiLib/HiiLib.c
index 749b004d9f641b7fdcda7dee71d1141401b1f22f..a178012b6e8917fb7837221d069e3639ae74aadb 100644 (file)
--- a/MdePkg/Library/HiiLib/HiiLib.c
+++ b/MdePkg/Library/HiiLib/HiiLib.c
@@ -32,6 +32,9 @@ LocateHiiProtocols (
   EFI_STATUS  Status;\r
 \r
   if (mHiiProtocolsInitialized) {\r
+    //\r
+    // Only need to initialize the protocol instance once.\r
+    //\r
     return;\r
   }\r
 \r
@@ -52,6 +55,13 @@ LocateHiiProtocols (
   package header that defined by UEFI VFR compiler and StringGather\r
   tool.\r
 \r
+  #pragma pack (push, 1)\r
+  typedef struct {\r
+    UINT32                  BinaryLength;\r
+    EFI_HII_PACKAGE_HEADER  PackageHeader;\r
+  } TIANO_AUTOGEN_PACKAGES_HEADER;\r
+  #pragma pack (pop)\r
+\r
   If there is not enough resource for the new package list,\r
   the function will ASSERT.\r
 \r
@@ -86,6 +96,9 @@ InternalHiiLibPreparePackages (
   \r
   for (Index = 0; Index < NumberOfPackages; Index++) {\r
     CopyMem (&PackageLength, VA_ARG (Marker, VOID *), sizeof (UINT32));\r
+    //\r
+    // Do not count the BinaryLength field.\r
+    //\r
     PackageListLength += (PackageLength - sizeof (UINT32));\r
   }\r
 \r
@@ -95,6 +108,7 @@ InternalHiiLibPreparePackages (
   PackageListLength += sizeof (EFI_HII_PACKAGE_HEADER);\r
   PackageListHeader = AllocateZeroPool (PackageListLength);\r
   ASSERT (PackageListHeader != NULL);\r
+  \r
   CopyMem (&PackageListHeader->PackageListGuid, GuidId, sizeof (EFI_GUID));\r
   PackageListHeader->PackageLength = PackageListLength;\r
 \r
@@ -127,11 +141,11 @@ InternalHiiLibPreparePackages (
   If not enough resource to complete the operation, then ASSERT.\r
 \r
   @param  NumberOfPackages       Number of packages.\r
-  @param  GuidId                          Package GUID.\r
-  @param  ...                                Variable argument list for packages to be assembled.\r
+  @param  GuidId                 Package GUID.\r
+  @param  ...                    Variable argument list for packages to be assembled.\r
 \r
   @return EFI_HII_PACKAGE_LIST_HEADER Pointer of EFI_HII_PACKAGE_LIST_HEADER. The function will ASSERT if system has\r
-                                                                not enough resource to complete the operation.\r
+                                      not enough resource to complete the operation.\r
 \r
 **/\r
 EFI_HII_PACKAGE_LIST_HEADER *\r
@@ -222,8 +236,6 @@ HiiLibAddPackages (
   @param  HiiHandle                The handle that was previously registered to the data base that is requested for removal.\r
                                              List later.\r
 \r
-  @return  VOID\r
-\r
 **/\r
 VOID\r
 EFIAPI\r
@@ -232,7 +244,7 @@ HiiLibRemovePackages (
   )\r
 {\r
   EFI_STATUS Status;\r
-  ASSERT (HiiHandle != NULL);\r
+  ASSERT (IsHiiHandleRegistered (HiiHandle));\r
 \r
   LocateHiiProtocols ();\r
 \r
@@ -328,6 +340,7 @@ HiiLibExtractGuidFromHiiHandle (
   EFI_HII_PACKAGE_LIST_HEADER  *HiiPackageList;\r
 \r
   ASSERT (Guid != NULL);\r
+  ASSERT (IsHiiHandleRegistered (Handle));\r
 \r
   //\r
   // Get HII PackageList\r
@@ -355,7 +368,7 @@ HiiLibExtractGuidFromHiiHandle (
   //\r
   CopyMem (Guid, &HiiPackageList->PackageListGuid, sizeof (EFI_GUID));\r
 \r
-  gBS->FreePool (HiiPackageList);\r
+  FreePool (HiiPackageList);\r
 \r
   return EFI_SUCCESS;\r
 }\r
@@ -425,7 +438,7 @@ HiiLibDevicePathToHiiHandle (
       break;\r
     }\r
   }\r
-  gBS->FreePool (Handles);\r
+  FreePool (Handles);\r
 \r
   if (DriverHandle == NULL) {\r
     return NULL;\r
@@ -447,7 +460,7 @@ HiiLibDevicePathToHiiHandle (
                           HiiHandles\r
                           );\r
   if (Status == EFI_BUFFER_TOO_SMALL) {\r
-    gBS->FreePool (HiiHandles);\r
+    FreePool (HiiHandles);\r
     HiiHandles = AllocatePool (BufferSize);\r
     ASSERT (HiiHandles != NULL);\r
 \r
@@ -461,7 +474,7 @@ HiiLibDevicePathToHiiHandle (
   }\r
 \r
   if (EFI_ERROR (Status)) {\r
-    gBS->FreePool (HiiHandles);\r
+    FreePool (HiiHandles);\r
     return NULL;\r
   }\r
 \r
@@ -482,7 +495,7 @@ HiiLibDevicePathToHiiHandle (
     }\r
   }\r
 \r
-  gBS->FreePool (HiiHandles);\r
+  FreePool (HiiHandles);\r
   return HiiHandle;\r
 }\r
 \r

diff --git a/MdePkg/Library/HiiLib/HiiString.c b/MdePkg/Library/HiiLib/HiiString.c
index 05e9aa8b6829b27bb9ed6ea575d7dabad9213d70..0d07ebc68a16410346170990b555480ee1657f2c 100644 (file)
--- a/MdePkg/Library/HiiLib/HiiString.c
+++ b/MdePkg/Library/HiiLib/HiiString.c
@@ -57,6 +57,10 @@ HiiLibNewString (
   while (*LangStrings != 0) {\r
     HiiLibGetNextLanguage (&LangStrings, Lang);\r
 \r
+    //\r
+    // For each language supported by the package,\r
+    // a string token is created.\r
+    //\r
     Status = mHiiStringProt->NewString (\r
                                  mHiiStringProt,\r
                                  PackageList,\r
@@ -119,6 +123,10 @@ HiiLibSetString (
   while (*LangStrings != 0) {\r
     HiiLibGetNextLanguage (&LangStrings, Lang);\r
 \r
+    //\r
+    // For each language supported by the package,\r
+    // the string is updated.\r
+    //\r
     Status = mHiiStringProt->SetString (\r
                                  mHiiStringProt,\r
                                  PackageList,\r
@@ -195,7 +203,7 @@ HiiLibGetStringFromToken (
 \r
 Out:\r
   if (HiiHandleBuffer != NULL) {\r
-    gBS->FreePool (HiiHandleBuffer);\r
+    FreePool (HiiHandleBuffer);\r
   }\r
   return Status;\r
 }\r
@@ -262,7 +270,7 @@ HiiLibGetString (
     \r
     LangStrings = Languages;\r
     HiiLibGetNextLanguage (&LangStrings, Lang);\r
-    gBS->FreePool (Languages);\r
+    FreePool (Languages);\r
 \r
     Status = mHiiStringProt->GetString (\r
                                  mHiiStringProt,\r
@@ -318,7 +326,7 @@ HiiLibGetStringFromHandle (
 \r
   Status = HiiLibGetString (HiiHandle, StringId, *String, &StringSize);\r
   if (Status == EFI_BUFFER_TOO_SMALL) {\r
-    gBS->FreePool (*String);\r
+    FreePool (*String);\r
     *String = AllocateZeroPool (StringSize);\r
     if (*String == NULL) {\r
       return EFI_OUT_OF_RESOURCES;\r
@@ -336,7 +344,7 @@ HiiLibGetStringFromHandle (
 // Each entry is 5 CHAR8 values long.  The first 3 CHAR8 values are the ISO 639-2 code.\r
 // The last 2 CHAR8 values are the ISO 639-1 code.\r
 //\r
-CHAR8 Iso639ToRfc3066ConversionTable[] =\r
+GLOBAL_REMOVE_IF_UNREFERENCED CONST CHAR8 Iso639ToRfc3066ConversionTable[] =\r
 "\\r
 aaraa\\r
 abkab\\r