BaseTools: Add a keyword FvNameString in FDF

The keyword with value TRUE OR FALSE is used to
indicate whether the FV UI name is included in
FV EXT header as a entry or not.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Yingke Liu <yingke.d.liu@intel.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>

git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@18090 6f19259b-4bc3-4df7-8a09-765794883524

BaseTools/Source/Python/CommonDataClass/FdfClass.py

@@ -58,6 +58,7 @@ class FvClassObject:
         # FvAttributeDict[attribute] = TRUE/FALSE (1/0)
         self.FvAttributeDict = {}
         self.FvNameGuid = None
+        self.FvNameString = None
         self.AprioriSectionList = []
         self.FfsList = []
         self.BsBaseAddress = None

BaseTools/Source/Python/GenFds/FdfParser.py

@@ -2068,9 +2068,12 @@ class FdfParser:
             if not (self.__GetBlockStatement(FvObj) or self.__GetFvBaseAddress(FvObj) or 
                 self.__GetFvForceRebase(FvObj) or self.__GetFvAlignment(FvObj) or 
                 self.__GetFvAttributes(FvObj) or self.__GetFvNameGuid(FvObj) or 
-                self.__GetFvExtEntryStatement(FvObj)):
+                self.__GetFvExtEntryStatement(FvObj) or self.__GetFvNameString(FvObj)):
                 break
 
+        if FvObj.FvNameString == 'TRUE' and not FvObj.FvNameGuid:
+            raise Warning("FvNameString found but FvNameGuid was not found", self.FileName, self.CurrentLineNumber)
+
         self.__GetAprioriSection(FvObj, FvObj.DefineVarDict.copy())
         self.__GetAprioriSection(FvObj, FvObj.DefineVarDict.copy())
 
@@ -2225,6 +2228,21 @@ class FdfParser:
 
         return True
 
+    def __GetFvNameString(self, FvObj):
+
+        if not self.__IsKeyword( "FvNameString"):
+            return False
+
+        if not self.__IsToken( "="):
+            raise Warning("expected '='", self.FileName, self.CurrentLineNumber)
+
+        if not self.__GetNextToken() or self.__Token not in ('TRUE', 'FALSE'):
+            raise Warning("expected TRUE or FALSE for FvNameString", self.FileName, self.CurrentLineNumber)
+
+        FvObj.FvNameString = self.__Token
+
+        return True
+
     def __GetFvExtEntryStatement(self, FvObj):
 
         if not self.__IsKeyword( "FV_EXT_ENTRY"):

BaseTools/Source/Python/GenFds/Fv.py

@@ -296,6 +296,7 @@ class FV (FvClassObject):
         if self.FvNameGuid <> None and self.FvNameGuid <> '':
             TotalSize = 16 + 4
             Buffer = ''
+            if self.FvNameString == 'TRUE':
                 #
                 # Create EXT entry for FV UI name
                 # This GUID is used: A67DF1FA-8DE8-4E98-AF09-4BDF2EFFBC7C