BaseTools: Fix typos in comments and variables

[mirror_edk2.git] / BaseTools / Source / C / VfrCompile / VfrUtilityLib.h

diff --git a/BaseTools/Source/C/VfrCompile/VfrUtilityLib.h b/BaseTools/Source/C/VfrCompile/VfrUtilityLib.h
index 9facce81499a91c7d9c761ab465d95578c051089..5faa1f40fdcfdfb480bfaba6d0fa1f01ad7eb916 100644 (file)
--- a/BaseTools/Source/C/VfrCompile/VfrUtilityLib.h
+++ b/BaseTools/Source/C/VfrCompile/VfrUtilityLib.h
@@ -2,7 +2,7 @@
   \r
   Vfr common library functions.\r
 \r
-Copyright (c) 2004 - 2011, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2004 - 2016, 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
@@ -57,13 +57,14 @@ struct SConfigInfo {
 \r
 struct SConfigItem {\r
   CHAR8         *mName;         // varstore name\r
-  CHAR8         *mId;           // varstore ID\r
+  EFI_GUID      *mGuid;         // varstore guid, varstore name + guid deside one varstore\r
+  CHAR8         *mId;           // default ID\r
   SConfigInfo   *mInfoStrList;  // list of Offset/Value in the varstore\r
   SConfigItem   *mNext;\r
 \r
 public:\r
-  SConfigItem (IN CHAR8 *, IN CHAR8 *);\r
-  SConfigItem (IN CHAR8 *, IN CHAR8 *, IN UINT8, IN UINT16, IN UINT16, IN EFI_IFR_TYPE_VALUE);\r
+  SConfigItem (IN CHAR8 *, IN EFI_GUID *, IN CHAR8 *);\r
+  SConfigItem (IN CHAR8 *, IN EFI_GUID *, IN CHAR8 *, IN UINT8, IN UINT16, IN UINT16, IN EFI_IFR_TYPE_VALUE);\r
   virtual ~SConfigItem ();\r
 };\r
 \r
@@ -77,11 +78,11 @@ public:
   CVfrBufferConfig (VOID);\r
   virtual ~CVfrBufferConfig (VOID);\r
 \r
-  virtual UINT8   Register (IN CHAR8 *, IN CHAR8 *Info = NULL);\r
+  virtual UINT8   Register (IN CHAR8 *, IN EFI_GUID *,IN CHAR8 *Info = NULL);\r
   virtual VOID    Open (VOID);\r
   virtual BOOLEAN Eof(VOID);\r
-  virtual UINT8   Select (IN CHAR8 *, IN CHAR8 *Info = NULL);\r
-  virtual UINT8   Write (IN CONST CHAR8, IN CHAR8 *, IN CHAR8 *, IN UINT8, IN UINT16, IN UINT32, IN EFI_IFR_TYPE_VALUE);\r
+  virtual UINT8   Select (IN CHAR8 *, IN EFI_GUID *, IN CHAR8 *Info = NULL);\r
+  virtual UINT8   Write (IN CONST CHAR8, IN CHAR8 *, IN EFI_GUID *, IN CHAR8 *, IN UINT8, IN UINT16, IN UINT32, IN EFI_IFR_TYPE_VALUE);\r
 #if 0\r
   virtual UINT8   Read (OUT CHAR8 **, OUT CHAR8 **, OUT CHAR8 **, OUT CHAR8 **, OUT CHAR8 **);\r
 #endif\r
@@ -264,6 +265,14 @@ struct EFI_VARSTORE_INFO {
   BOOLEAN operator == (IN EFI_VARSTORE_INFO *);\r
 };\r
 \r
+struct BufferVarStoreFieldInfoNode {\r
+  EFI_VARSTORE_INFO  mVarStoreInfo;\r
+  struct BufferVarStoreFieldInfoNode *mNext;\r
+\r
+  BufferVarStoreFieldInfoNode( IN EFI_VARSTORE_INFO  *Info );\r
+  ~BufferVarStoreFieldInfoNode ();\r
+};\r
+\r
 #define EFI_VARSTORE_ID_MAX              0xFFFF\r
 #define EFI_FREE_VARSTORE_ID_BITMAP_SIZE ((EFI_VARSTORE_ID_MAX + 1) / EFI_BITS_PER_UINT32)\r
 \r
@@ -277,6 +286,8 @@ private:
 \r
   struct SVfrVarStorageNode *mCurrVarStorageNode;\r
   struct SVfrVarStorageNode *mNewVarStorageNode;\r
+  BufferVarStoreFieldInfoNode    *mBufferFieldInfoListHead;\r
+  BufferVarStoreFieldInfoNode    *mBufferFieldInfoListTail;\r
 \r
 private:\r
 \r
@@ -284,6 +295,10 @@ private:
   BOOLEAN         ChekVarStoreIdFree (IN EFI_VARSTORE_ID);\r
   VOID            MarkVarStoreIdUsed (IN EFI_VARSTORE_ID);\r
   VOID            MarkVarStoreIdUnused (IN EFI_VARSTORE_ID);\r
+  EFI_VARSTORE_ID CheckGuidField (IN SVfrVarStorageNode *, \r
+                                  IN EFI_GUID *, \r
+                                  IN BOOLEAN *, \r
+                                  OUT EFI_VFR_RETURN_CODE *);\r
 \r
 public:\r
   CVfrDataStorage ();\r
@@ -295,7 +310,7 @@ public:
   SVfrVarStorageNode * GetEfiVarStoreList () {\r
     return mEfiVarStoreList;\r
   }\r
-  EFI_VFR_RETURN_CODE DeclareNameVarStoreBegin (CHAR8 *);\r
+  EFI_VFR_RETURN_CODE DeclareNameVarStoreBegin (CHAR8 *, EFI_VARSTORE_ID);\r
   EFI_VFR_RETURN_CODE NameTableAddItem (EFI_STRING_ID);\r
   EFI_VFR_RETURN_CODE DeclareNameVarStoreEnd (EFI_GUID *);\r
 \r
@@ -303,19 +318,21 @@ public:
 \r
   EFI_VFR_RETURN_CODE DeclareBufferVarStore (IN CHAR8 *, IN EFI_GUID *, IN CVfrVarDataTypeDB *, IN CHAR8 *, IN EFI_VARSTORE_ID, IN BOOLEAN Flag = TRUE);\r
 \r
-  EFI_VFR_RETURN_CODE GetVarStoreId (IN CHAR8 *, OUT EFI_VARSTORE_ID *);\r
-  EFI_VFR_RETURN_CODE GetVarStoreType (IN CHAR8 *, OUT EFI_VFR_VARSTORE_TYPE &);\r
+  EFI_VFR_RETURN_CODE GetVarStoreId (IN CHAR8 *, OUT EFI_VARSTORE_ID *, IN EFI_GUID *VarGuid = NULL);\r
   EFI_VFR_VARSTORE_TYPE GetVarStoreType (IN EFI_VARSTORE_ID);\r
+  EFI_GUID *          GetVarStoreGuid (IN  EFI_VARSTORE_ID);\r
   EFI_VFR_RETURN_CODE GetVarStoreName (IN EFI_VARSTORE_ID, OUT CHAR8 **);\r
-  EFI_VFR_RETURN_CODE GetVarStoreByDataType (IN CHAR8 *, OUT SVfrVarStorageNode **);\r
+  EFI_VFR_RETURN_CODE GetVarStoreByDataType (IN CHAR8 *, OUT SVfrVarStorageNode **, IN EFI_GUID *VarGuid = NULL);\r
 \r
-  EFI_VFR_RETURN_CODE GetBufferVarStoreDataTypeName (IN CHAR8 *, OUT CHAR8 **);\r
+  EFI_VFR_RETURN_CODE GetBufferVarStoreDataTypeName (IN EFI_VARSTORE_ID, OUT CHAR8 **);\r
   EFI_VFR_RETURN_CODE GetEfiVarStoreInfo (IN EFI_VARSTORE_INFO *);\r
   EFI_VFR_RETURN_CODE GetNameVarStoreInfo (IN EFI_VARSTORE_INFO *, IN UINT32);\r
-\r
-  EFI_VFR_RETURN_CODE BufferVarStoreRequestElementAdd (IN CHAR8 *, IN EFI_VARSTORE_INFO &);\r
+  EFI_VFR_RETURN_CODE AddBufferVarStoreFieldInfo (IN EFI_VARSTORE_INFO *);\r
+  EFI_VFR_RETURN_CODE GetBufferVarStoreFieldInfo (IN OUT EFI_VARSTORE_INFO *);\r
 };\r
 \r
+extern CVfrDataStorage gCVfrDataStorage;\r
+\r
 #define EFI_QUESTION_ID_MAX              0xFFFF\r
 #define EFI_FREE_QUESTION_ID_BITMAP_SIZE ((EFI_QUESTION_ID_MAX + 1) / EFI_BITS_PER_UINT32)\r
 #define EFI_QUESTION_ID_INVALID          0x0\r
@@ -396,9 +413,11 @@ public:
   EFI_VFR_RETURN_CODE ReRegisterDefaultStoreById (IN UINT16, IN CHAR8 *, IN EFI_STRING_ID);\r
   BOOLEAN             DefaultIdRegistered (IN UINT16);\r
   EFI_VFR_RETURN_CODE GetDefaultId (IN CHAR8 *, OUT UINT16 *);\r
-  EFI_VFR_RETURN_CODE BufferVarStoreAltConfigAdd (IN EFI_VARSTORE_ID, IN EFI_VARSTORE_INFO &, IN CHAR8 *, IN UINT8, IN EFI_IFR_TYPE_VALUE);\r
+  EFI_VFR_RETURN_CODE BufferVarStoreAltConfigAdd (IN EFI_VARSTORE_ID, IN EFI_VARSTORE_INFO &, IN CHAR8 *, IN EFI_GUID *, IN UINT8, IN EFI_IFR_TYPE_VALUE);\r
 };\r
 \r
+extern CVfrDefaultStore gCVfrDefaultStore;\r
+\r
 #define EFI_RULE_ID_START    0x01\r
 #define EFI_RULE_ID_INVALID  0x00\r
 \r
@@ -438,6 +457,11 @@ private:
   UINT32 GetUnicodeStringTextSize (\r
     IN  UINT8            *StringSrc\r
     );\r
+    \r
+  BOOLEAN GetBestLanguage (\r
+    IN CONST CHAR8  *SupportedLanguages,\r
+    IN CHAR8        *Language\r
+    );\r
 \r
 public:\r
   CVfrStringDB ();\r