]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Universal/HiiDatabaseDxe/HiiDatabase.h
Clean up the private GUID definition in module Level.
[mirror_edk2.git] / MdeModulePkg / Universal / HiiDatabaseDxe / HiiDatabase.h
index ad016c3d44dde4b591a7036bd743da00e0158395..783fc7ecc132e3b9d31172be9960628c12142798 100644 (file)
@@ -1,8 +1,8 @@
 /** @file\r
 Private structures definitions in HiiDatabase.\r
 \r
-Copyright (c) 2007 - 2008, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2007 - 2011, 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
 http://opensource.org/licenses/bsd-license.php\r
@@ -15,9 +15,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #ifndef __HII_DATABASE_PRIVATE_H__\r
 #define __HII_DATABASE_PRIVATE_H__\r
 \r
-#include <PiDxe.h>\r
+#include <Uefi.h>\r
 \r
-#include <Protocol/ConsoleControl.h>\r
 #include <Protocol/DevicePath.h>\r
 #include <Protocol/HiiFont.h>\r
 #include <Protocol/HiiImage.h>\r
@@ -28,6 +27,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include <Protocol/SimpleTextOut.h>\r
 \r
 #include <Guid/HiiKeyBoardLayout.h>\r
+#include <Guid/GlobalVariable.h>\r
 \r
 \r
 #include <Library/DebugLib.h>\r
@@ -37,14 +37,10 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include <Library/BaseLib.h>\r
 #include <Library/DevicePathLib.h>\r
 #include <Library/MemoryAllocationLib.h>\r
-#include <Library/IfrSupportLib.h>\r
-#include <Library/HiiLib.h>\r
+#include <Library/UefiLib.h>\r
 #include <Library/PcdLib.h>\r
-\r
-#define HII_DATABASE_NOTIFY_GUID \\r
-  { \\r
-    0xc1c76, 0xd79e, 0x42fe, {0x86, 0xb, 0x8b, 0xe8, 0x7b, 0x3e, 0x7a, 0x78} \\r
-  }\r
+#include <Library/UefiRuntimeServicesTableLib.h>\r
+#include <Library/PrintLib.h>\r
 \r
 #define MAX_STRING_LENGTH                  1024\r
 #define MAX_FONT_NAME_LEN                  256\r
@@ -60,6 +56,37 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #define BITMAP_LEN_8_BIT(Width, Height)  ((Width) * (Height))\r
 #define BITMAP_LEN_24_BIT(Width, Height) ((Width) * (Height) * 3)\r
 \r
+//\r
+// IFR data structure\r
+//\r
+// BASE_CR (a, IFR_DEFAULT_VALUE_DATA, Entry) to get the whole structure.\r
+\r
+typedef struct {\r
+  LIST_ENTRY          Entry;             // Link to VarStorage\r
+  EFI_GUID            Guid;\r
+  CHAR16              *Name;\r
+  EFI_VARSTORE_ID     VarStoreId;\r
+  UINT16              Size;\r
+  LIST_ENTRY          BlockEntry;        // Link to its Block array\r
+} IFR_VARSTORAGE_DATA;\r
+\r
+typedef struct {\r
+  LIST_ENTRY          Entry;             // Link to Block array\r
+  UINT16              Offset;\r
+  UINT16              Width;\r
+  EFI_QUESTION_ID     QuestionId;\r
+  UINT8               OpCode;\r
+  UINT8               Scope;\r
+  LIST_ENTRY          DefaultValueEntry; // Link to its default value array\r
+} IFR_BLOCK_DATA;\r
+\r
+typedef struct {\r
+  LIST_ENTRY          Entry;\r
+  UINT8               OpCode;\r
+  UINT16              DefaultId;\r
+  UINT64              Value;\r
+} IFR_DEFAULT_DATA;\r
+\r
 //\r
 // Storage types\r
 //\r
@@ -67,7 +94,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #define EFI_HII_VARSTORE_NAME_VALUE        1\r
 #define EFI_HII_VARSTORE_EFI_VARIABLE      2\r
 \r
-#define HII_FORMSET_STORAGE_SIGNATURE           EFI_SIGNATURE_32 ('H', 'S', 'T', 'G')\r
+#define HII_FORMSET_STORAGE_SIGNATURE           SIGNATURE_32 ('H', 'S', 'T', 'G')\r
 typedef struct {\r
   UINTN               Signature;\r
   LIST_ENTRY          Entry;\r
@@ -81,13 +108,11 @@ typedef struct {
   UINT16              Size;\r
 } HII_FORMSET_STORAGE;\r
 \r
-#define HII_FORMSET_STORAGE_FROM_LINK(a)  CR (a, HII_FORMSET_STORAGE, Link, HII_FORMSET_STORAGE_SIGNATURE)\r
-\r
 \r
 //\r
 // String Package definitions\r
 //\r
-#define HII_STRING_PACKAGE_SIGNATURE    EFI_SIGNATURE_32 ('h','i','s','p')\r
+#define HII_STRING_PACKAGE_SIGNATURE    SIGNATURE_32 ('h','i','s','p')\r
 typedef struct _HII_STRING_PACKAGE_INSTANCE {\r
   UINTN                                 Signature;\r
   EFI_HII_STRING_PACKAGE_HDR            *StringPkgHdr;\r
@@ -95,12 +120,13 @@ typedef struct _HII_STRING_PACKAGE_INSTANCE {
   LIST_ENTRY                            StringEntry;\r
   LIST_ENTRY                            FontInfoList;  // local font info list\r
   UINT8                                 FontId;\r
+  EFI_STRING_ID                         MaxStringId;   // record StringId\r
 } HII_STRING_PACKAGE_INSTANCE;\r
 \r
 //\r
 // Form Package definitions\r
 //\r
-#define HII_IFR_PACKAGE_SIGNATURE       EFI_SIGNATURE_32 ('h','f','r','p')\r
+#define HII_IFR_PACKAGE_SIGNATURE       SIGNATURE_32 ('h','f','r','p')\r
 typedef struct _HII_IFR_PACKAGE_INSTANCE {\r
   UINTN                                 Signature;\r
   EFI_HII_PACKAGE_HEADER                FormPkgHdr;\r
@@ -111,7 +137,7 @@ typedef struct _HII_IFR_PACKAGE_INSTANCE {
 //\r
 // Simple Font Package definitions\r
 //\r
-#define HII_S_FONT_PACKAGE_SIGNATURE    EFI_SIGNATURE_32 ('h','s','f','p')\r
+#define HII_S_FONT_PACKAGE_SIGNATURE    SIGNATURE_32 ('h','s','f','p')\r
 typedef struct _HII_SIMPLE_FONT_PACKAGE_INSTANCE {\r
   UINTN                                 Signature;\r
   EFI_HII_SIMPLE_FONT_PACKAGE_HDR       *SimpleFontPkgHdr;\r
@@ -121,16 +147,18 @@ typedef struct _HII_SIMPLE_FONT_PACKAGE_INSTANCE {
 //\r
 // Font Package definitions\r
 //\r
-#define HII_FONT_PACKAGE_SIGNATURE      EFI_SIGNATURE_32 ('h','i','f','p')\r
+#define HII_FONT_PACKAGE_SIGNATURE      SIGNATURE_32 ('h','i','f','p')\r
 typedef struct _HII_FONT_PACKAGE_INSTANCE {\r
   UINTN                                 Signature;\r
   EFI_HII_FONT_PACKAGE_HDR              *FontPkgHdr;\r
+  UINT16                                Height;\r
+  UINT16                                BaseLine;\r
   UINT8                                 *GlyphBlock;\r
   LIST_ENTRY                            FontEntry;\r
   LIST_ENTRY                            GlyphInfoList;\r
 } HII_FONT_PACKAGE_INSTANCE;\r
 \r
-#define HII_GLYPH_INFO_SIGNATURE        EFI_SIGNATURE_32 ('h','g','i','s')\r
+#define HII_GLYPH_INFO_SIGNATURE        SIGNATURE_32 ('h','g','i','s')\r
 typedef struct _HII_GLYPH_INFO {\r
   UINTN                                 Signature;\r
   LIST_ENTRY                            Entry;\r
@@ -138,7 +166,7 @@ typedef struct _HII_GLYPH_INFO {
   EFI_HII_GLYPH_INFO                    Cell;\r
 } HII_GLYPH_INFO;\r
 \r
-#define HII_FONT_INFO_SIGNATURE         EFI_SIGNATURE_32 ('h','l','f','i')\r
+#define HII_FONT_INFO_SIGNATURE         SIGNATURE_32 ('h','l','f','i')\r
 typedef struct _HII_FONT_INFO {\r
   UINTN                                 Signature;\r
   LIST_ENTRY                            Entry;\r
@@ -146,7 +174,7 @@ typedef struct _HII_FONT_INFO {
   UINT8                                 FontId;\r
 } HII_FONT_INFO;\r
 \r
-#define HII_GLOBAL_FONT_INFO_SIGNATURE  EFI_SIGNATURE_32 ('h','g','f','i')\r
+#define HII_GLOBAL_FONT_INFO_SIGNATURE  SIGNATURE_32 ('h','g','f','i')\r
 typedef struct _HII_GLOBAL_FONT_INFO {\r
   UINTN                                 Signature;\r
   LIST_ENTRY                            Entry;\r
@@ -172,7 +200,7 @@ typedef struct _HII_IMAGE_PACKAGE_INSTANCE {
 //\r
 // Keyboard Layout Pacakge definitions\r
 //\r
-#define HII_KB_LAYOUT_PACKAGE_SIGNATURE EFI_SIGNATURE_32 ('h','k','l','p')\r
+#define HII_KB_LAYOUT_PACKAGE_SIGNATURE SIGNATURE_32 ('h','k','l','p')\r
 typedef struct _HII_KEYBOARD_LAYOUT_PACKAGE_INSTANCE {\r
   UINTN                                 Signature;\r
   UINT8                                 *KeyboardPkg;\r
@@ -182,7 +210,7 @@ typedef struct _HII_KEYBOARD_LAYOUT_PACKAGE_INSTANCE {
 //\r
 // Guid Package definitions\r
 //\r
-#define HII_GUID_PACKAGE_SIGNATURE      EFI_SIGNATURE_32 ('h','i','g','p')\r
+#define HII_GUID_PACKAGE_SIGNATURE      SIGNATURE_32 ('h','i','g','p')\r
 typedef struct _HII_GUID_PACKAGE_INSTANCE {\r
   UINTN                                 Signature;\r
   UINT8                                 *GuidPkg;\r
@@ -205,7 +233,7 @@ typedef struct _HII_DATABASE_PACKAGE_LIST_INSTANCE {
   UINT8                                 *DevicePathPkg;\r
 } HII_DATABASE_PACKAGE_LIST_INSTANCE;\r
 \r
-#define HII_HANDLE_SIGNATURE            EFI_SIGNATURE_32 ('h','i','h','l')\r
+#define HII_HANDLE_SIGNATURE            SIGNATURE_32 ('h','i','h','l')\r
 \r
 typedef struct {\r
   UINTN               Signature;\r
@@ -213,7 +241,7 @@ typedef struct {
   UINTN               Key;\r
 } HII_HANDLE;\r
 \r
-#define HII_DATABASE_RECORD_SIGNATURE   EFI_SIGNATURE_32 ('h','i','d','r')\r
+#define HII_DATABASE_RECORD_SIGNATURE   SIGNATURE_32 ('h','i','d','r')\r
 \r
 typedef struct _HII_DATABASE_RECORD {\r
   UINTN                                 Signature;\r
@@ -223,7 +251,7 @@ typedef struct _HII_DATABASE_RECORD {
   LIST_ENTRY                            DatabaseEntry;\r
 } HII_DATABASE_RECORD;\r
 \r
-#define HII_DATABASE_NOTIFY_SIGNATURE   EFI_SIGNATURE_32 ('h','i','d','n')\r
+#define HII_DATABASE_NOTIFY_SIGNATURE   SIGNATURE_32 ('h','i','d','n')\r
 \r
 typedef struct _HII_DATABASE_NOTIFY {\r
   UINTN                                 Signature;\r
@@ -235,7 +263,7 @@ typedef struct _HII_DATABASE_NOTIFY {
   LIST_ENTRY                            DatabaseNotifyEntry;\r
 } HII_DATABASE_NOTIFY;\r
 \r
-#define HII_DATABASE_PRIVATE_DATA_SIGNATURE EFI_SIGNATURE_32 ('H', 'i', 'D', 'p')\r
+#define HII_DATABASE_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('H', 'i', 'D', 'p')\r
 \r
 typedef struct _HII_DATABASE_PRIVATE_DATA {\r
   UINTN                                 Signature;\r
@@ -305,8 +333,7 @@ typedef struct _HII_DATABASE_PRIVATE_DATA {
 BOOLEAN\r
 IsHiiHandleValid (\r
   EFI_HII_HANDLE Handle\r
-  )\r
-;\r
+  );\r
 \r
 \r
 /**\r
@@ -338,10 +365,33 @@ IsFontInfoExisted (
   IN  EFI_FONT_INFO_MASK        *FontInfoMask,   OPTIONAL\r
   IN  EFI_FONT_HANDLE           FontHandle,      OPTIONAL\r
   OUT HII_GLOBAL_FONT_INFO      **GlobalFontInfo OPTIONAL\r
+  );\r
+\r
+/**\r
+\r
+   This function invokes the matching registered function.\r
+    \r
+   @param  Private           HII Database driver private structure.\r
+   @param  NotifyType        The type of change concerning the database.\r
+   @param  PackageInstance   Points to the package referred to by the notification.\r
+   @param  PackageType       Package type\r
+   @param  Handle            The handle of the package list which contains the specified package.\r
+    \r
+   @retval EFI_SUCCESS            Already checked all registered function and invoked \r
+                                  if matched.\r
+   @retval EFI_INVALID_PARAMETER  Any input parameter is not valid.\r
+     \r
+**/\r
+EFI_STATUS\r
+InvokeRegisteredFunction (\r
+  IN HII_DATABASE_PRIVATE_DATA    *Private, \r
+  IN EFI_HII_DATABASE_NOTIFY_TYPE NotifyType,\r
+  IN VOID                         *PackageInstance,\r
+  IN UINT8                        PackageType,\r
+  IN EFI_HII_HANDLE               Handle\r
   )\r
 ;\r
 \r
-\r
 /**\r
   Retrieve system default font and color.\r
 \r
@@ -362,15 +412,15 @@ GetSystemFont (
   IN  HII_DATABASE_PRIVATE_DATA      *Private,\r
   OUT EFI_FONT_DISPLAY_INFO          **FontInfo,\r
   OUT UINTN                          *FontInfoSize OPTIONAL\r
-  )\r
-;\r
+  );\r
 \r
 \r
 /**\r
   Parse all string blocks to find a String block specified by StringId.\r
   If StringId = (EFI_STRING_ID) (-1), find out all EFI_HII_SIBT_FONT blocks\r
-  within this string package and backup its information.\r
-  If StringId = 0, output the string id of last string block (EFI_HII_SIBT_END).\r
+  within this string package and backup its information. If LastStringId is \r
+  specified, the string id of last string block will also be output.\r
+  If StringId = 0, output the string id of last string block (EFI_HII_SIBT_STRING).\r
 \r
   @param  Private                 Hii database private structure.\r
   @param  StringPackage           Hii string package instance.\r
@@ -380,7 +430,8 @@ GetSystemFont (
   @param  StringBlockAddr         Output the block address of found string block.\r
   @param  StringTextOffset        Offset, relative to the found block address, of\r
                                   the  string text information.\r
-  @param  LastStringId            Output the last string id when StringId = 0.\r
+  @param  LastStringId            Output the last string id when StringId = 0 or StringId = -1.\r
+  @param  StartStringId           The first id in the skip block which StringId in the block.\r
 \r
   @retval EFI_SUCCESS             The string text and font is retrieved\r
                                   successfully.\r
@@ -398,9 +449,9 @@ FindStringBlock (
   OUT UINT8                           *BlockType, OPTIONAL\r
   OUT UINT8                           **StringBlockAddr, OPTIONAL\r
   OUT UINTN                           *StringTextOffset, OPTIONAL\r
-  OUT EFI_STRING_ID                   *LastStringId OPTIONAL\r
-  )\r
-;\r
+  OUT EFI_STRING_ID                   *LastStringId, OPTIONAL\r
+  OUT EFI_STRING_ID                   *StartStringId OPTIONAL\r
+  );\r
 \r
 \r
 /**\r
@@ -431,8 +482,35 @@ FindGlyphBlock (
   OUT UINT8                          **GlyphBuffer, OPTIONAL\r
   OUT EFI_HII_GLYPH_INFO             *Cell, OPTIONAL\r
   OUT UINTN                          *GlyphBufferLen OPTIONAL\r
-  )\r
-;\r
+  );\r
+\r
+/**\r
+  This function exports Form packages to a buffer.\r
+  This is a internal function.\r
+\r
+  @param  Private                Hii database private structure.\r
+  @param  Handle                 Identification of a package list.\r
+  @param  PackageList            Pointer to a package list which will be exported.\r
+  @param  UsedSize               The length of buffer be used.\r
+  @param  BufferSize             Length of the Buffer.\r
+  @param  Buffer                 Allocated space for storing exported data.\r
+  @param  ResultSize             The size of the already exported content of  this\r
+                                 package list.\r
+\r
+  @retval EFI_SUCCESS            Form Packages are exported successfully.\r
+  @retval EFI_INVALID_PARAMETER  Any input parameter is invalid.\r
+\r
+**/\r
+EFI_STATUS\r
+ExportFormPackages (\r
+  IN HII_DATABASE_PRIVATE_DATA          *Private,\r
+  IN EFI_HII_HANDLE                     Handle,\r
+  IN HII_DATABASE_PACKAGE_LIST_INSTANCE *PackageList,\r
+  IN UINTN                              UsedSize,\r
+  IN UINTN                              BufferSize,\r
+  IN OUT VOID                           *Buffer,\r
+  IN OUT UINTN                          *ResultSize\r
+  );\r
 \r
 //\r
 // EFI_HII_FONT_PROTOCOL protocol interfaces\r
@@ -506,8 +584,7 @@ HiiStringToImage (
   OUT EFI_HII_ROW_INFO               **RowInfoArray    OPTIONAL,\r
   OUT UINTN                          *RowInfoArraySize OPTIONAL,\r
   OUT UINTN                          *ColumnInfoArray  OPTIONAL\r
-  )\r
-;\r
+  );\r
 \r
 \r
 /**\r
@@ -586,8 +663,7 @@ HiiStringIdToImage (
   OUT EFI_HII_ROW_INFO               **RowInfoArray    OPTIONAL,\r
   OUT UINTN                          *RowInfoArraySize OPTIONAL,\r
   OUT UINTN                          *ColumnInfoArray  OPTIONAL\r
-  )\r
-;\r
+  );\r
 \r
 \r
 /**\r
@@ -620,8 +696,7 @@ HiiGetGlyph (
   IN  CONST EFI_FONT_DISPLAY_INFO    *StringInfo,\r
   OUT EFI_IMAGE_OUTPUT               **Blt,\r
   OUT UINTN                          *Baseline OPTIONAL\r
-  )\r
-;\r
+  );\r
 \r
 \r
 /**\r
@@ -661,8 +736,7 @@ HiiGetFontInfo (
   IN  CONST EFI_FONT_DISPLAY_INFO    *StringInfoIn, OPTIONAL\r
   OUT       EFI_FONT_DISPLAY_INFO    **StringInfoOut,\r
   IN  CONST EFI_STRING               String OPTIONAL\r
-  )\r
-;\r
+  );\r
 \r
 //\r
 // EFI_HII_IMAGE_PROTOCOL interfaces\r
@@ -694,8 +768,7 @@ HiiNewImage (
   IN  EFI_HII_HANDLE                 PackageList,\r
   OUT EFI_IMAGE_ID                   *ImageId,\r
   IN  CONST EFI_IMAGE_INPUT          *Image\r
-  )\r
-;\r
+  );\r
 \r
 \r
 /**\r
@@ -726,8 +799,7 @@ HiiGetImage (
   IN  EFI_HII_HANDLE                 PackageList,\r
   IN  EFI_IMAGE_ID                   ImageId,\r
   OUT EFI_IMAGE_INPUT                *Image\r
-  )\r
-;\r
+  );\r
 \r
 \r
 /**\r
@@ -753,8 +825,7 @@ HiiSetImage (
   IN EFI_HII_HANDLE                  PackageList,\r
   IN EFI_IMAGE_ID                    ImageId,\r
   IN CONST EFI_IMAGE_INPUT           *Image\r
-  )\r
-;\r
+  );\r
 \r
 \r
 /**\r
@@ -795,8 +866,7 @@ HiiDrawImage (
   IN OUT EFI_IMAGE_OUTPUT            **Blt,\r
   IN UINTN                           BltX,\r
   IN UINTN                           BltY\r
-  )\r
-;\r
+  );\r
 \r
 \r
 /**\r
@@ -893,8 +963,7 @@ HiiNewString (
   IN  CONST CHAR16                    *LanguageName, OPTIONAL\r
   IN  CONST EFI_STRING                String,\r
   IN  CONST EFI_FONT_INFO             *StringFontInfo OPTIONAL\r
-  )\r
-;\r
+  );\r
 \r
 \r
 /**\r
@@ -941,8 +1010,7 @@ HiiGetString (
   OUT EFI_STRING                      String,\r
   IN  OUT UINTN                       *StringSize,\r
   OUT EFI_FONT_INFO                   **StringFontInfo OPTIONAL\r
-  )\r
-;\r
+  );\r
 \r
 \r
 /**\r
@@ -976,8 +1044,7 @@ HiiSetString (
   IN CONST CHAR8                      *Language,\r
   IN CONST EFI_STRING                 String,\r
   IN CONST EFI_FONT_INFO              *StringFontInfo OPTIONAL\r
-  )\r
-;\r
+  );\r
 \r
 \r
 /**\r
@@ -987,7 +1054,8 @@ HiiSetString (
   @param  This                    A pointer to the EFI_HII_STRING_PROTOCOL\r
                                   instance.\r
   @param  PackageList             The package list to examine.\r
-  @param  Languages               Points to the buffer to hold the returned string.\r
+  @param  Languages               Points to the buffer to hold the returned\r
+                                  null-terminated ASCII string.\r
   @param  LanguagesSize           On entry, points to the size of the buffer\r
                                   pointed to by  Languages, in bytes. On  return,\r
                                   points to the length of Languages, in bytes.\r
@@ -1008,8 +1076,7 @@ HiiGetLanguages (
   IN EFI_HII_HANDLE                   PackageList,\r
   IN OUT CHAR8                        *Languages,\r
   IN OUT UINTN                        *LanguagesSize\r
-  )\r
-;\r
+  );\r
 \r
 \r
 /**\r
@@ -1020,25 +1087,28 @@ HiiGetLanguages (
   @param  This                    A pointer to the EFI_HII_STRING_PROTOCOL\r
                                   instance.\r
   @param  PackageList             The package list to examine.\r
-  @param  FirstLanguage           Points to the primary language.\r
-  @param  SecondaryLanguages      Points to the buffer to hold the returned list of\r
-                                   secondary languages for the specified\r
-                                  FirstLanguage. If there are no secondary\r
-                                  languages, the function  returns successfully,\r
+  @param  PrimaryLanguage         Points to the null-terminated ASCII string that specifies\r
+                                  the primary language. Languages are specified in the\r
+                                  format specified in Appendix M of the UEFI 2.0 specification.\r
+  @param  SecondaryLanguages      Points to the buffer to hold the returned null-terminated\r
+                                  ASCII string that describes the list of\r
+                                  secondary languages for the specified\r
+                                  PrimaryLanguage. If there are no secondary\r
+                                  languages, the function returns successfully,\r
                                   but this is set to NULL.\r
   @param  SecondaryLanguagesSize  On entry, points to the size of the buffer\r
-                                  pointed to  by SecondLanguages, in bytes. On\r
-                                  return, points to the length of SecondLanguages\r
+                                  pointed to by SecondaryLanguages, in bytes. On\r
+                                  return, points to the length of SecondaryLanguages\r
                                   in bytes.\r
 \r
   @retval EFI_SUCCESS             Secondary languages were correctly returned.\r
-  @retval EFI_INVALID_PARAMETER   FirstLanguage or SecondLanguages or\r
-                                  SecondLanguagesSize was NULL.\r
-  @retval EFI_BUFFER_TOO_SMALL    The buffer specified by SecondLanguagesSize is\r
+  @retval EFI_INVALID_PARAMETER   PrimaryLanguage or SecondaryLanguages or\r
+                                  SecondaryLanguagesSize was NULL.\r
+  @retval EFI_BUFFER_TOO_SMALL    The buffer specified by SecondaryLanguagesSize is\r
                                   too small to hold the returned information.\r
-                                  SecondLanguageSize is updated to hold the size of\r
+                                  SecondaryLanguageSize is updated to hold the size of\r
                                   the buffer required.\r
-  @retval EFI_INVALID_LANGUAGE           The language specified by FirstLanguage is not\r
+  @retval EFI_INVALID_LANGUAGE    The language specified by PrimaryLanguage is not\r
                                   present in the specified package list.\r
   @retval EFI_NOT_FOUND          The specified PackageList is not in the Database.                                \r
 \r
@@ -1048,11 +1118,10 @@ EFIAPI
 HiiGetSecondaryLanguages (\r
   IN CONST EFI_HII_STRING_PROTOCOL   *This,\r
   IN EFI_HII_HANDLE                  PackageList,\r
-  IN CONST CHAR8                     *FirstLanguage,\r
+  IN CONST CHAR8                     *PrimaryLanguage,\r
   IN OUT CHAR8                       *SecondaryLanguages,\r
   IN OUT UINTN                       *SecondaryLanguagesSize\r
-  )\r
-;\r
+  );\r
 \r
 //\r
 // EFI_HII_DATABASE_PROTOCOL protocol interfaces\r
@@ -1069,6 +1138,8 @@ HiiGetSecondaryLanguages (
   @param  PackageList             A pointer to an EFI_HII_PACKAGE_LIST_HEADER\r
                                   structure.\r
   @param  DriverHandle            Associate the package list with this EFI handle.\r
+                                  If a NULL is specified, this data will not be associate\r
+                                  with any drivers and cannot have a callback induced.\r
   @param  Handle                  A pointer to the EFI_HII_HANDLE instance.\r
 \r
   @retval EFI_SUCCESS             The package list associated with the Handle was\r
@@ -1083,10 +1154,9 @@ EFIAPI
 HiiNewPackageList (\r
   IN CONST EFI_HII_DATABASE_PROTOCOL    *This,\r
   IN CONST EFI_HII_PACKAGE_LIST_HEADER  *PackageList,\r
-  IN CONST EFI_HANDLE                   DriverHandle,\r
+  IN CONST EFI_HANDLE                   DriverHandle, OPTIONAL\r
   OUT EFI_HII_HANDLE                    *Handle\r
-  )\r
-;\r
+  );\r
 \r
 \r
 /**\r
@@ -1109,8 +1179,7 @@ EFIAPI
 HiiRemovePackageList (\r
   IN CONST EFI_HII_DATABASE_PROTOCOL    *This,\r
   IN EFI_HII_HANDLE                     Handle\r
-  )\r
-;\r
+  );\r
 \r
 \r
 /**\r
@@ -1137,8 +1206,7 @@ HiiUpdatePackageList (
   IN CONST EFI_HII_DATABASE_PROTOCOL    *This,\r
   IN EFI_HII_HANDLE                     Handle,\r
   IN CONST EFI_HII_PACKAGE_LIST_HEADER  *PackageList\r
-  )\r
-;\r
+  );\r
 \r
 \r
 /**\r
@@ -1183,8 +1251,7 @@ HiiListPackageLists (
   IN  CONST EFI_GUID                    *PackageGuid,\r
   IN  OUT UINTN                         *HandleBufferLength,\r
   OUT EFI_HII_HANDLE                    *Handle\r
-  )\r
-;\r
+  );\r
 \r
 \r
 /**\r
@@ -1221,8 +1288,7 @@ HiiExportPackageLists (
   IN  EFI_HII_HANDLE                    Handle,\r
   IN  OUT UINTN                         *BufferSize,\r
   OUT EFI_HII_PACKAGE_LIST_HEADER       *Buffer\r
-  )\r
-;\r
+  );\r
 \r
 \r
 /**\r
@@ -1270,8 +1336,7 @@ HiiRegisterPackageNotify (
   IN  CONST EFI_HII_DATABASE_NOTIFY     PackageNotifyFn,\r
   IN  EFI_HII_DATABASE_NOTIFY_TYPE      NotifyType,\r
   OUT EFI_HANDLE                        *NotifyHandle\r
-  )\r
-;\r
+  );\r
 \r
 \r
 /**\r
@@ -1292,8 +1357,7 @@ EFIAPI
 HiiUnregisterPackageNotify (\r
   IN CONST EFI_HII_DATABASE_PROTOCOL    *This,\r
   IN EFI_HANDLE                         NotificationHandle\r
-  )\r
-;\r
+  );\r
 \r
 \r
 /**\r
@@ -1325,8 +1389,7 @@ HiiFindKeyboardLayouts (
   IN  CONST EFI_HII_DATABASE_PROTOCOL   *This,\r
   IN  OUT UINT16                        *KeyGuidBufferLength,\r
   OUT EFI_GUID                          *KeyGuidBuffer\r
-  )\r
-;\r
+  );\r
 \r
 \r
 /**\r
@@ -1357,8 +1420,7 @@ HiiGetKeyboardLayout (
   IN  CONST EFI_GUID                          *KeyGuid,\r
   IN OUT UINT16                         *KeyboardLayoutLength,\r
   OUT EFI_HII_KEYBOARD_LAYOUT           *KeyboardLayout\r
-  )\r
-;\r
+  );\r
 \r
 \r
 /**\r
@@ -1383,8 +1445,7 @@ EFIAPI
 HiiSetKeyboardLayout (\r
   IN CONST EFI_HII_DATABASE_PROTOCOL          *This,\r
   IN CONST EFI_GUID                           *KeyGuid\r
-  )\r
-;\r
+  );\r
 \r
 \r
 /**\r
@@ -1409,8 +1470,7 @@ HiiGetPackageListHandle (
   IN  CONST EFI_HII_DATABASE_PROTOCOL         *This,\r
   IN  EFI_HII_HANDLE                    PackageListHandle,\r
   OUT EFI_HANDLE                        *DriverHandle\r
-  )\r
-;\r
+  );\r
 \r
 //\r
 // EFI_HII_CONFIG_ROUTING_PROTOCOL interfaces\r
@@ -1463,8 +1523,7 @@ HiiConfigRoutingExtractConfig (
   IN  CONST EFI_STRING                       Request,\r
   OUT EFI_STRING                             *Progress,\r
   OUT EFI_STRING                             *Results\r
-  )\r
-;\r
+  );\r
 \r
 \r
 /**\r
@@ -1493,8 +1552,7 @@ EFIAPI
 HiiConfigRoutingExportConfig (\r
   IN  CONST EFI_HII_CONFIG_ROUTING_PROTOCOL  *This,\r
   OUT EFI_STRING                             *Results\r
-  )\r
-;\r
+  );\r
 \r
 \r
 /**\r
@@ -1528,8 +1586,7 @@ HiiConfigRoutingRouteConfig (
   IN  CONST EFI_HII_CONFIG_ROUTING_PROTOCOL  *This,\r
   IN  CONST EFI_STRING                       Configuration,\r
   OUT EFI_STRING                             *Progress\r
-  )\r
-;\r
+  );\r
 \r
 \r
 \r
@@ -1581,8 +1638,7 @@ HiiBlockToConfig (
   IN  CONST UINTN                            BlockSize,\r
   OUT EFI_STRING                             *Config,\r
   OUT EFI_STRING                             *Progress\r
-  )\r
-;\r
+  );\r
 \r
 \r
 /**\r
@@ -1639,8 +1695,7 @@ HiiConfigToBlock (
   IN OUT UINT8                                 *Block,\r
   IN OUT UINTN                                 *BlockSize,\r
   OUT    EFI_STRING                            *Progress\r
-  )\r
-;\r
+  );\r
 \r
 \r
 /**\r
@@ -1693,15 +1748,28 @@ HiiGetAltCfg (
   IN  CONST EFI_DEVICE_PATH_PROTOCOL           *DevicePath,\r
   IN  CONST UINT16                             *AltCfgId,\r
   OUT EFI_STRING                               *AltCfgResp\r
+  );\r
+\r
+\r
+/**\r
+  Compare whether two names of languages are identical.\r
+\r
+  @param  Language1              Name of language 1 from StringPackage\r
+  @param  Language2              Name of language 2 to be compared with language 1.\r
+\r
+  @retval TRUE                   same\r
+  @retval FALSE                  not same\r
+\r
+**/\r
+BOOLEAN\r
+HiiCompareLanguage (\r
+  IN  CHAR8  *Language1,\r
+  IN  CHAR8  *Language2\r
   )\r
 ;\r
 \r
-\r
 //\r
 // Global variables\r
 //\r
 extern EFI_EVENT gHiiKeyboardLayoutChanged;\r
-\r
-#include "R8Lib.h"\r
-\r
 #endif\r