BaseTools: Replace PCD type strings with predefined constant

Cc: Liming Gao <liming.gao@intel.com>
Cc: Yonghong Zhu <yonghong.zhu@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Jaben Carsey <jaben.carsey@intel.com>
Reviewed-by: Yonghong Zhu <yonghong.zhu@intel.com>

11 files changed, 62 insertions, 59 deletions

diff --git a/BaseTools/Source/Python/AutoGen/AutoGen.py b/BaseTools/Source/Python/AutoGen/AutoGen.py
index 86caeacb48..2a6fa05ab8 100644
--- a/BaseTools/Source/Python/AutoGen/AutoGen.py
+++ b/BaseTools/Source/Python/AutoGen/AutoGen.py
@@ -869,8 +869,8 @@ class WorkspaceAutoGen(AutoGen):
     def _CheckPcdDefineAndType(self):

         PcdTypeList = [

             TAB_PCDS_FIXED_AT_BUILD, TAB_PCDS_PATCHABLE_IN_MODULE, TAB_PCDS_FEATURE_FLAG,

-            TAB_PCDS_DYNAMIC, #"DynamicHii", "DynamicVpd",

-            TAB_PCDS_DYNAMIC_EX, # "DynamicExHii", "DynamicExVpd"

+            TAB_PCDS_DYNAMIC, #TAB_PCDS_DYNAMIC_HII, TAB_PCDS_DYNAMIC_VPD,

+            TAB_PCDS_DYNAMIC_EX, # TAB_PCDS_DYNAMIC_EX_HII, TAB_PCDS_DYNAMIC_EX_VPD

         ]

 

         # This dict store PCDs which are not used by any modules with specified arches

diff --git a/BaseTools/Source/Python/AutoGen/GenC.py b/BaseTools/Source/Python/AutoGen/GenC.py
index 806983cb8b..45542ed463 100644
--- a/BaseTools/Source/Python/AutoGen/GenC.py
+++ b/BaseTools/Source/Python/AutoGen/GenC.py
@@ -28,8 +28,8 @@ from IdfClassObject import *
 

 ## PCD type string

 gItemTypeStringDatabase  = {

-    TAB_PCDS_FEATURE_FLAG       :   'FixedAtBuild',

-    TAB_PCDS_FIXED_AT_BUILD     :   'FixedAtBuild',

+    TAB_PCDS_FEATURE_FLAG       :   TAB_PCDS_FIXED_AT_BUILD,

+    TAB_PCDS_FIXED_AT_BUILD     :   TAB_PCDS_FIXED_AT_BUILD,

     TAB_PCDS_PATCHABLE_IN_MODULE:   'BinaryPatch',

     TAB_PCDS_DYNAMIC            :   '',

     TAB_PCDS_DYNAMIC_DEFAULT    :   '',

diff --git a/BaseTools/Source/Python/AutoGen/GenPcdDb.py b/BaseTools/Source/Python/AutoGen/GenPcdDb.py
index e0d1918e98..b48ddcd59e 100644
--- a/BaseTools/Source/Python/AutoGen/GenPcdDb.py
+++ b/BaseTools/Source/Python/AutoGen/GenPcdDb.py
@@ -1217,7 +1217,7 @@ def CreatePcdDatabasePhaseSpecificAutoGen (Platform, DynamicPcdList, Phase):
         Pcd.InitString = 'UNINIT'

 

         if Pcd.DatumType == TAB_VOID:

-            if Pcd.Type not in ["DynamicVpd", "DynamicExVpd"]:

+            if Pcd.Type not in [TAB_PCDS_DYNAMIC_VPD, TAB_PCDS_DYNAMIC_EX_VPD]:

                 Pcd.TokenTypeList = ['PCD_TYPE_STRING']

             else:

                 Pcd.TokenTypeList = []

diff --git a/BaseTools/Source/Python/Common/DataType.py b/BaseTools/Source/Python/Common/DataType.py
index 77d76066f7..2662132e51 100644
--- a/BaseTools/Source/Python/Common/DataType.py
+++ b/BaseTools/Source/Python/Common/DataType.py
@@ -220,6 +220,9 @@ TAB_PCDS_DYNAMIC_HII = 'DynamicHii'
 PCD_DYNAMIC_TYPE_SET = {TAB_PCDS_DYNAMIC, TAB_PCDS_DYNAMIC_DEFAULT, TAB_PCDS_DYNAMIC_VPD, TAB_PCDS_DYNAMIC_HII}

 PCD_DYNAMIC_EX_TYPE_SET = {TAB_PCDS_DYNAMIC_EX, TAB_PCDS_DYNAMIC_EX_DEFAULT, TAB_PCDS_DYNAMIC_EX_VPD, TAB_PCDS_DYNAMIC_EX_HII}

 

+# leave as a list for order

+PCD_TYPE_LIST = [TAB_PCDS_FIXED_AT_BUILD, TAB_PCDS_PATCHABLE_IN_MODULE, TAB_PCDS_FEATURE_FLAG, TAB_PCDS_DYNAMIC, TAB_PCDS_DYNAMIC_EX]

+

 TAB_PCDS_FIXED_AT_BUILD_NULL = TAB_PCDS + TAB_PCDS_FIXED_AT_BUILD

 TAB_PCDS_FIXED_AT_BUILD_COMMON = TAB_PCDS + TAB_PCDS_FIXED_AT_BUILD + TAB_SPLIT + TAB_ARCH_COMMON

 TAB_PCDS_FIXED_AT_BUILD_IA32 = TAB_PCDS + TAB_PCDS_FIXED_AT_BUILD + TAB_SPLIT + TAB_ARCH_IA32

diff --git a/BaseTools/Source/Python/Common/MigrationUtilities.py b/BaseTools/Source/Python/Common/MigrationUtilities.py
index e9f1cabcb7..0c93c72a60 100644
--- a/BaseTools/Source/Python/Common/MigrationUtilities.py
+++ b/BaseTools/Source/Python/Common/MigrationUtilities.py
@@ -34,7 +34,7 @@ def SetCommon(Common, XmlCommon):
     XmlTag = "Usage"

     Common.Usage = XmlAttribute(XmlCommon, XmlTag).split()

 

-    XmlTag = "FeatureFlag"

+    XmlTag = TAB_PCDS_FEATURE_FLAG

     Common.FeatureFlag = XmlAttribute(XmlCommon, XmlTag)

     

     XmlTag = "SupArchList"

diff --git a/BaseTools/Source/Python/GenFds/FfsInfStatement.py b/BaseTools/Source/Python/GenFds/FfsInfStatement.py
index f973cf2f0b..9068157ba6 100644
--- a/BaseTools/Source/Python/GenFds/FfsInfStatement.py
+++ b/BaseTools/Source/Python/GenFds/FfsInfStatement.py
@@ -249,7 +249,7 @@ class FfsInfStatement(FfsInfStatementClassObject):
             Pcd = InfPcds[PcdKey]

             if not hasattr(Pcd, 'Offset'):

                 continue

-            if Pcd.Type != 'PatchableInModule':

+            if Pcd.Type != TAB_PCDS_PATCHABLE_IN_MODULE:

                 continue

             # Override Patchable PCD value by the value from DSC

             PatchPcd = None

diff --git a/BaseTools/Source/Python/GenFds/GenFdsGlobalVariable.py b/BaseTools/Source/Python/GenFds/GenFdsGlobalVariable.py
index 6745a89514..909d043c2a 100644
--- a/BaseTools/Source/Python/GenFds/GenFdsGlobalVariable.py
+++ b/BaseTools/Source/Python/GenFds/GenFdsGlobalVariable.py
@@ -809,7 +809,7 @@ class GenFdsGlobalVariable:
             for Key in PcdDict:

                 PcdObj = PcdDict[Key]

                 if (PcdObj.TokenCName == TokenCName) and (PcdObj.TokenSpaceGuidCName == TokenSpace):

-                    if PcdObj.Type != 'FixedAtBuild':

+                    if PcdObj.Type != DataType.TAB_PCDS_FIXED_AT_BUILD:

                         EdkLogger.error("GenFds", GENFDS_ERROR, "%s is not FixedAtBuild type." % PcdPattern)

                     if PcdObj.DatumType != DataType.TAB_VOID:

                         EdkLogger.error("GenFds", GENFDS_ERROR, "%s is not VOID* datum type." % PcdPattern)

@@ -825,7 +825,7 @@ class GenFdsGlobalVariable:
                 for Key in PcdDict:

                     PcdObj = PcdDict[Key]

                     if (PcdObj.TokenCName == TokenCName) and (PcdObj.TokenSpaceGuidCName == TokenSpace):

-                        if PcdObj.Type != 'FixedAtBuild':

+                        if PcdObj.Type != DataType.TAB_PCDS_FIXED_AT_BUILD:

                             EdkLogger.error("GenFds", GENFDS_ERROR, "%s is not FixedAtBuild type." % PcdPattern)

                         if PcdObj.DatumType != DataType.TAB_VOID:

                             EdkLogger.error("GenFds", GENFDS_ERROR, "%s is not VOID* datum type." % PcdPattern)

diff --git a/BaseTools/Source/Python/Workspace/DecBuildData.py b/BaseTools/Source/Python/Workspace/DecBuildData.py
index 31870e078c..1fbd095f74 100644
--- a/BaseTools/Source/Python/Workspace/DecBuildData.py
+++ b/BaseTools/Source/Python/Workspace/DecBuildData.py
@@ -27,17 +27,17 @@ from Workspace.BuildClassObject import PackageBuildClassObject, StructurePcd, Pc
 class DecBuildData(PackageBuildClassObject):

     # dict used to convert PCD type in database to string used by build tool

     _PCD_TYPE_STRING_ = {

-        MODEL_PCD_FIXED_AT_BUILD        :   "FixedAtBuild",

-        MODEL_PCD_PATCHABLE_IN_MODULE   :   "PatchableInModule",

-        MODEL_PCD_FEATURE_FLAG          :   "FeatureFlag",

-        MODEL_PCD_DYNAMIC               :   "Dynamic",

-        MODEL_PCD_DYNAMIC_DEFAULT       :   "Dynamic",

-        MODEL_PCD_DYNAMIC_HII           :   "DynamicHii",

-        MODEL_PCD_DYNAMIC_VPD           :   "DynamicVpd",

-        MODEL_PCD_DYNAMIC_EX            :   "DynamicEx",

-        MODEL_PCD_DYNAMIC_EX_DEFAULT    :   "DynamicEx",

-        MODEL_PCD_DYNAMIC_EX_HII        :   "DynamicExHii",

-        MODEL_PCD_DYNAMIC_EX_VPD        :   "DynamicExVpd",

+        MODEL_PCD_FIXED_AT_BUILD        :   TAB_PCDS_FIXED_AT_BUILD,

+        MODEL_PCD_PATCHABLE_IN_MODULE   :   TAB_PCDS_PATCHABLE_IN_MODULE,

+        MODEL_PCD_FEATURE_FLAG          :   TAB_PCDS_FEATURE_FLAG,

+        MODEL_PCD_DYNAMIC               :   TAB_PCDS_DYNAMIC,

+        MODEL_PCD_DYNAMIC_DEFAULT       :   TAB_PCDS_DYNAMIC,

+        MODEL_PCD_DYNAMIC_HII           :   TAB_PCDS_DYNAMIC_HII,

+        MODEL_PCD_DYNAMIC_VPD           :   TAB_PCDS_DYNAMIC_VPD,

+        MODEL_PCD_DYNAMIC_EX            :   TAB_PCDS_DYNAMIC_EX,

+        MODEL_PCD_DYNAMIC_EX_DEFAULT    :   TAB_PCDS_DYNAMIC_EX,

+        MODEL_PCD_DYNAMIC_EX_HII        :   TAB_PCDS_DYNAMIC_EX_HII,

+        MODEL_PCD_DYNAMIC_EX_VPD        :   TAB_PCDS_DYNAMIC_EX_VPD,

     }

 

     # dict used to convert part of [Defines] to members of DecBuildData directly

diff --git a/BaseTools/Source/Python/Workspace/DscBuildData.py b/BaseTools/Source/Python/Workspace/DscBuildData.py
index 335267ebc5..49bf5df632 100644
--- a/BaseTools/Source/Python/Workspace/DscBuildData.py
+++ b/BaseTools/Source/Python/Workspace/DscBuildData.py
@@ -158,17 +158,17 @@ def GetDependencyList(FileStack,SearchPathList):
 class DscBuildData(PlatformBuildClassObject):

     # dict used to convert PCD type in database to string used by build tool

     _PCD_TYPE_STRING_ = {

-        MODEL_PCD_FIXED_AT_BUILD        :   "FixedAtBuild",

-        MODEL_PCD_PATCHABLE_IN_MODULE   :   "PatchableInModule",

-        MODEL_PCD_FEATURE_FLAG          :   "FeatureFlag",

-        MODEL_PCD_DYNAMIC               :   "Dynamic",

-        MODEL_PCD_DYNAMIC_DEFAULT       :   "Dynamic",

-        MODEL_PCD_DYNAMIC_HII           :   "DynamicHii",

-        MODEL_PCD_DYNAMIC_VPD           :   "DynamicVpd",

-        MODEL_PCD_DYNAMIC_EX            :   "DynamicEx",

-        MODEL_PCD_DYNAMIC_EX_DEFAULT    :   "DynamicEx",

-        MODEL_PCD_DYNAMIC_EX_HII        :   "DynamicExHii",

-        MODEL_PCD_DYNAMIC_EX_VPD        :   "DynamicExVpd",

+        MODEL_PCD_FIXED_AT_BUILD        :   TAB_PCDS_FIXED_AT_BUILD,

+        MODEL_PCD_PATCHABLE_IN_MODULE   :   TAB_PCDS_PATCHABLE_IN_MODULE,

+        MODEL_PCD_FEATURE_FLAG          :   TAB_PCDS_FEATURE_FLAG,

+        MODEL_PCD_DYNAMIC               :   TAB_PCDS_DYNAMIC,

+        MODEL_PCD_DYNAMIC_DEFAULT       :   TAB_PCDS_DYNAMIC,

+        MODEL_PCD_DYNAMIC_HII           :   TAB_PCDS_DYNAMIC_HII,

+        MODEL_PCD_DYNAMIC_VPD           :   TAB_PCDS_DYNAMIC_VPD,

+        MODEL_PCD_DYNAMIC_EX            :   TAB_PCDS_DYNAMIC_EX,

+        MODEL_PCD_DYNAMIC_EX_DEFAULT    :   TAB_PCDS_DYNAMIC_EX,

+        MODEL_PCD_DYNAMIC_EX_HII        :   TAB_PCDS_DYNAMIC_EX_HII,

+        MODEL_PCD_DYNAMIC_EX_VPD        :   TAB_PCDS_DYNAMIC_EX_VPD,

     }

 

     # dict used to convert part of [Defines] to members of DscBuildData directly

diff --git a/BaseTools/Source/Python/Workspace/InfBuildData.py b/BaseTools/Source/Python/Workspace/InfBuildData.py
index 94f142e8e6..157f7a2d2d 100644
--- a/BaseTools/Source/Python/Workspace/InfBuildData.py
+++ b/BaseTools/Source/Python/Workspace/InfBuildData.py
@@ -28,17 +28,17 @@ from Workspace.BuildClassObject import ModuleBuildClassObject, LibraryClassObjec
 class InfBuildData(ModuleBuildClassObject):

     # dict used to convert PCD type in database to string used by build tool

     _PCD_TYPE_STRING_ = {

-        MODEL_PCD_FIXED_AT_BUILD        :   "FixedAtBuild",

-        MODEL_PCD_PATCHABLE_IN_MODULE   :   "PatchableInModule",

-        MODEL_PCD_FEATURE_FLAG          :   "FeatureFlag",

-        MODEL_PCD_DYNAMIC               :   "Dynamic",

-        MODEL_PCD_DYNAMIC_DEFAULT       :   "Dynamic",

-        MODEL_PCD_DYNAMIC_HII           :   "DynamicHii",

-        MODEL_PCD_DYNAMIC_VPD           :   "DynamicVpd",

-        MODEL_PCD_DYNAMIC_EX            :   "DynamicEx",

-        MODEL_PCD_DYNAMIC_EX_DEFAULT    :   "DynamicEx",

-        MODEL_PCD_DYNAMIC_EX_HII        :   "DynamicExHii",

-        MODEL_PCD_DYNAMIC_EX_VPD        :   "DynamicExVpd",

+        MODEL_PCD_FIXED_AT_BUILD        :   TAB_PCDS_FIXED_AT_BUILD,

+        MODEL_PCD_PATCHABLE_IN_MODULE   :   TAB_PCDS_PATCHABLE_IN_MODULE,

+        MODEL_PCD_FEATURE_FLAG          :   TAB_PCDS_FEATURE_FLAG,

+        MODEL_PCD_DYNAMIC               :   TAB_PCDS_DYNAMIC,

+        MODEL_PCD_DYNAMIC_DEFAULT       :   TAB_PCDS_DYNAMIC,

+        MODEL_PCD_DYNAMIC_HII           :   TAB_PCDS_DYNAMIC_HII,

+        MODEL_PCD_DYNAMIC_VPD           :   TAB_PCDS_DYNAMIC_VPD,

+        MODEL_PCD_DYNAMIC_EX            :   TAB_PCDS_DYNAMIC_EX,

+        MODEL_PCD_DYNAMIC_EX_DEFAULT    :   TAB_PCDS_DYNAMIC_EX,

+        MODEL_PCD_DYNAMIC_EX_HII        :   TAB_PCDS_DYNAMIC_EX_HII,

+        MODEL_PCD_DYNAMIC_EX_VPD        :   TAB_PCDS_DYNAMIC_EX_VPD,

     }

 

     # dict used to convert part of [Defines] to members of InfBuildData directly

@@ -1026,13 +1026,13 @@ class InfBuildData(ModuleBuildClassObject):
                 # if platform doesn't give its type, use 'lowest' one in the

                 # following order, if any

                 #

-                #   "FixedAtBuild", "PatchableInModule", "FeatureFlag", "Dynamic", "DynamicEx"

+                #   TAB_PCDS_FIXED_AT_BUILD, TAB_PCDS_PATCHABLE_IN_MODULE, TAB_PCDS_FEATURE_FLAG, TAB_PCDS_DYNAMIC, TAB_PCDS_DYNAMIC_EX

                 #

                 _GuidDict.update(Package.Guids)

                 PcdType = self._PCD_TYPE_STRING_[Type]

                 if Type == MODEL_PCD_DYNAMIC:

                     Pcd.Pending = True

-                    for T in ["FixedAtBuild", "PatchableInModule", "FeatureFlag", "Dynamic", "DynamicEx"]:

+                    for T in PCD_TYPE_LIST:

                         if (PcdRealName, TokenSpaceGuid) in GlobalData.MixedPcd:

                             for item in GlobalData.MixedPcd[(PcdRealName, TokenSpaceGuid)]:

                                 if str(item[0]).endswith(T) and (item[0], item[1], T) in Package.Pcds:

diff --git a/BaseTools/Source/Python/build/BuildReport.py b/BaseTools/Source/Python/build/BuildReport.py
index b25350e4bf..e68cd7de2c 100644
--- a/BaseTools/Source/Python/build/BuildReport.py
+++ b/BaseTools/Source/Python/build/BuildReport.py
@@ -94,15 +94,15 @@ gSubSectionSep = "-" * gLineMaxLength
 

 ## The look up table to map PCD type to pair of report display type and DEC type

 gPcdTypeMap = {

-  'FixedAtBuild'     : ('FIXED',  'FixedAtBuild'),

-  'PatchableInModule': ('PATCH',  'PatchableInModule'),

-  'FeatureFlag'      : ('FLAG',   'FeatureFlag'),

-  'Dynamic'          : ('DYN',    'Dynamic'),

-  'DynamicHii'       : ('DYNHII', 'Dynamic'),

-  'DynamicVpd'       : ('DYNVPD', 'Dynamic'),

-  'DynamicEx'        : ('DEX',    'DynamicEx'),

-  'DynamicExHii'     : ('DEXHII', 'DynamicEx'),

-  'DynamicExVpd'     : ('DEXVPD', 'DynamicEx'),

+  TAB_PCDS_FIXED_AT_BUILD     : ('FIXED',  TAB_PCDS_FIXED_AT_BUILD),

+  TAB_PCDS_PATCHABLE_IN_MODULE: ('PATCH',  TAB_PCDS_PATCHABLE_IN_MODULE),

+  TAB_PCDS_FEATURE_FLAG       : ('FLAG',   TAB_PCDS_FEATURE_FLAG),

+  TAB_PCDS_DYNAMIC            : ('DYN',    TAB_PCDS_DYNAMIC),

+  TAB_PCDS_DYNAMIC_HII        : ('DYNHII', TAB_PCDS_DYNAMIC),

+  TAB_PCDS_DYNAMIC_VPD        : ('DYNVPD', TAB_PCDS_DYNAMIC),

+  TAB_PCDS_DYNAMIC_EX         : ('DEX',    TAB_PCDS_DYNAMIC_EX),

+  TAB_PCDS_DYNAMIC_EX_HII     : ('DEXHII', TAB_PCDS_DYNAMIC_EX),

+  TAB_PCDS_DYNAMIC_EX_VPD     : ('DEXVPD', TAB_PCDS_DYNAMIC_EX),

   }

 

 ## The look up table to map module type to driver type

@@ -784,7 +784,7 @@ class PcdReport(object):
                 Pcd = Pa.Platform.Pcds[item]

                 if not Pcd.Type:

                     # check the Pcd in FDF file, whether it is used in module first

-                    for T in ["FixedAtBuild", "PatchableInModule", "FeatureFlag", "Dynamic", "DynamicEx"]:

+                    for T in PCD_TYPE_LIST:

                         PcdList = self.AllPcds.setdefault(Pcd.TokenSpaceGuidCName, {}).setdefault(T, [])

                         if Pcd in PcdList:

                             Pcd.Type = T

@@ -792,7 +792,7 @@ class PcdReport(object):
                 if not Pcd.Type:

                     PcdTypeFlag = False

                     for package in Pa.PackageList:

-                        for T in ["FixedAtBuild", "PatchableInModule", "FeatureFlag", "Dynamic", "DynamicEx"]:

+                        for T in PCD_TYPE_LIST:

                             if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, T) in package.Pcds:

                                 Pcd.Type = T

                                 PcdTypeFlag = True

@@ -804,10 +804,10 @@ class PcdReport(object):
                 if not Pcd.DatumType:

                     PcdType = Pcd.Type

                     # Try to remove Hii and Vpd suffix

-                    if PcdType.startswith("DynamicEx"):

-                        PcdType = "DynamicEx"

-                    elif PcdType.startswith("Dynamic"):

-                        PcdType = "Dynamic"

+                    if PcdType.startswith(TAB_PCDS_DYNAMIC_EX):

+                        PcdType = TAB_PCDS_DYNAMIC_EX

+                    elif PcdType.startswith(TAB_PCDS_DYNAMIC):

+                        PcdType = TAB_PCDS_DYNAMIC

                     for package in Pa.PackageList:

                         if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName, PcdType) in package.Pcds:

                             Pcd.DatumType = package.Pcds[(Pcd.TokenCName, Pcd.TokenSpaceGuidCName, PcdType)].DatumType