]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Universal/HiiDatabaseDxe/HiiDatabase.h
Roll back changes to apply GetBestLanguage() in HiiDataBase. Exact language match...
[mirror_edk2.git] / MdeModulePkg / Universal / HiiDatabaseDxe / HiiDatabase.h
index bbddd0369d3116d978ef120255d9dd0d5af1cc11..81f42c5bf2b96e69178e7d0a26775ad1ef0076b1 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
 Private structures definitions in HiiDatabase.\r
 \r
-Copyright (c) 2007 - 2008, Intel Corporation\r
+Copyright (c) 2007 - 2009, Intel Corporation\r
 All rights reserved. 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
@@ -17,7 +17,6 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \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,9 +37,11 @@ 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/UefiLib.h>\r
 #include <Library/PcdLib.h>\r
+#include <Library/UefiRuntimeServicesTableLib.h>\r
+#include <Library/PrintLib.h>\r
+\r
 \r
 #define HII_DATABASE_NOTIFY_GUID \\r
   { \\r
@@ -60,6 +62,38 @@ 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
+  EFI_STRING_ID       DefaultName;\r
+  UINT16              DefaultId;\r
+  UINT64              Value;\r
+} IFR_DEFAULT_DATA;\r
+\r
 //\r
 // Storage types\r
 //\r
@@ -67,7 +101,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 +115,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
@@ -100,7 +132,7 @@ typedef struct _HII_STRING_PACKAGE_INSTANCE {
 //\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 +143,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,7 +153,7 @@ 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
@@ -130,7 +162,7 @@ typedef struct _HII_FONT_PACKAGE_INSTANCE {
   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 +170,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 +178,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 +204,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 +214,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 +237,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 +245,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 +255,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 +267,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
@@ -339,6 +371,30 @@ IsFontInfoExisted (
   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
   Retrieve system default font and color.\r
@@ -429,6 +485,34 @@ FindGlyphBlock (
   OUT UINTN                          *GlyphBufferLen OPTIONAL\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
 //\r
@@ -1662,11 +1746,25 @@ HiiGetAltCfg (
   );\r
 \r
 \r
+/**\r
+  Compare whether two names of languages are identical.\r
+\r
+  @param  Language1              Name of language 1\r
+  @param  Language2              Name of language 2\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
 // Global variables\r
 //\r
 extern EFI_EVENT gHiiKeyboardLayoutChanged;\r
-\r
-#include "R8Lib.h"\r
-\r
 #endif\r