BaseTools: replace string constants used for module types

replace raw strings in the code (note: except UPT) with constants.
SUP_MODULE_BASE was 'BASE'
SUP_MODULE_SEC was 'SEC'
SUP_MODULE_PEI_CORE was 'PEI_CORE'
SUP_MODULE_PEIM was 'PEIM'
SUP_MODULE_DXE_CORE was 'DXE_CORE'
SUP_MODULE_DXE_DRIVER was 'DXE_DRIVER'
SUP_MODULE_DXE_RUNTIME_DRIVER was 'DXE_RUNTIME_DRIVER'
SUP_MODULE_DXE_SAL_DRIVER was 'DXE_SAL_DRIVER'
SUP_MODULE_DXE_SMM_DRIVER was 'DXE_SMM_DRIVER'
SUP_MODULE_UEFI_DRIVER was 'UEFI_DRIVER'
SUP_MODULE_UEFI_APPLICATION was 'UEFI_APPLICATION'
SUP_MODULE_USER_DEFINED was 'USER_DEFINED'
SUP_MODULE_SMM_CORE was 'SMM_CORE'
SUP_MODULE_MM_STANDALONE was 'MM_STANDALONE'
SUP_MODULE_MM_CORE_STANDALONE was 'MM_CORE_STANDALONE'

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>

2 files changed, 33 insertions, 33 deletions

diff --git a/BaseTools/Source/Python/build/BuildReport.py b/BaseTools/Source/Python/build/BuildReport.py
index c4647d068a..b2e5fd6fbf 100644
--- a/BaseTools/Source/Python/build/BuildReport.py
+++ b/BaseTools/Source/Python/build/BuildReport.py
@@ -48,18 +48,18 @@ import collections
 from Common.Expression import *

 

 gComponentType2ModuleType = {

-    "LIBRARY"               :   "BASE",

-    "SECURITY_CORE"         :   "SEC",

-    "PEI_CORE"              :   "PEI_CORE",

-    "COMBINED_PEIM_DRIVER"  :   "PEIM",

-    "PIC_PEIM"              :   "PEIM",

-    "RELOCATABLE_PEIM"      :   "PEIM",

-    "PE32_PEIM"             :   "PEIM",

-    "BS_DRIVER"             :   "DXE_DRIVER",

-    "RT_DRIVER"             :   "DXE_RUNTIME_DRIVER",

-    "SAL_RT_DRIVER"         :   "DXE_SAL_DRIVER",

-    "APPLICATION"           :   "UEFI_APPLICATION",

-    "LOGO"                  :   "BASE",

+    "LIBRARY"               :   SUP_MODULE_BASE,

+    "SECURITY_CORE"         :   SUP_MODULE_SEC,

+    SUP_MODULE_PEI_CORE     :   SUP_MODULE_PEI_CORE,

+    "COMBINED_PEIM_DRIVER"  :   SUP_MODULE_PEIM,

+    "PIC_PEIM"              :   SUP_MODULE_PEIM,

+    "RELOCATABLE_PEIM"      :   SUP_MODULE_PEIM,

+    "PE32_PEIM"             :   SUP_MODULE_PEIM,

+    "BS_DRIVER"             :   SUP_MODULE_DXE_DRIVER,

+    "RT_DRIVER"             :   SUP_MODULE_DXE_RUNTIME_DRIVER,

+    "SAL_RT_DRIVER"         :   SUP_MODULE_DXE_SAL_DRIVER,

+    "APPLICATION"           :   SUP_MODULE_UEFI_APPLICATION,

+    "LOGO"                  :   SUP_MODULE_BASE,

 }

 

 ## Pattern to extract contents in EDK DXS files

@@ -122,20 +122,20 @@ gPcdTypeMap = {
 

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

 gDriverTypeMap = {

-  'SEC'               : '0x3 (SECURITY_CORE)',

-  'PEI_CORE'          : '0x4 (PEI_CORE)',

-  'PEIM'              : '0x6 (PEIM)',

-  'DXE_CORE'          : '0x5 (DXE_CORE)',

-  'DXE_DRIVER'        : '0x7 (DRIVER)',

-  'DXE_SAL_DRIVER'    : '0x7 (DRIVER)',

-  'DXE_SMM_DRIVER'    : '0x7 (DRIVER)',

-  'DXE_RUNTIME_DRIVER': '0x7 (DRIVER)',

-  'UEFI_DRIVER'       : '0x7 (DRIVER)',

-  'UEFI_APPLICATION'  : '0x9 (APPLICATION)',

-  'SMM_CORE'          : '0xD (SMM_CORE)',

+  SUP_MODULE_SEC               : '0x3 (SECURITY_CORE)',

+  SUP_MODULE_PEI_CORE          : '0x4 (PEI_CORE)',

+  SUP_MODULE_PEIM              : '0x6 (PEIM)',

+  SUP_MODULE_DXE_CORE          : '0x5 (DXE_CORE)',

+  SUP_MODULE_DXE_DRIVER        : '0x7 (DRIVER)',

+  SUP_MODULE_DXE_SAL_DRIVER    : '0x7 (DRIVER)',

+  SUP_MODULE_DXE_SMM_DRIVER    : '0x7 (DRIVER)',

+  SUP_MODULE_DXE_RUNTIME_DRIVER: '0x7 (DRIVER)',

+  SUP_MODULE_UEFI_DRIVER       : '0x7 (DRIVER)',

+  SUP_MODULE_UEFI_APPLICATION  : '0x9 (APPLICATION)',

+  SUP_MODULE_SMM_CORE          : '0xD (SMM_CORE)',

   'SMM_DRIVER'        : '0xA (SMM)', # Extension of module type to support PI 1.1 SMM drivers

-  'MM_STANDALONE'     : '0xE (MM_STANDALONE)',

-  'MM_CORE_STANDALONE' : '0xF (MM_CORE_STANDALONE)'

+  SUP_MODULE_MM_STANDALONE     : '0xE (MM_STANDALONE)',

+  SUP_MODULE_MM_CORE_STANDALONE : '0xF (MM_CORE_STANDALONE)'

   }

 

 ## The look up table of the supported opcode in the dependency expression binaries

@@ -424,7 +424,7 @@ class DepexReport(object):
         if not ModuleType:

             ModuleType = gComponentType2ModuleType.get(M.ComponentType, "")

 

-        if ModuleType in ["SEC", "PEI_CORE", "DXE_CORE", "SMM_CORE", "MM_CORE_STANDALONE", "UEFI_APPLICATION"]:

+        if ModuleType in [SUP_MODULE_SEC, SUP_MODULE_PEI_CORE, SUP_MODULE_DXE_CORE, SUP_MODULE_SMM_CORE, SUP_MODULE_MM_CORE_STANDALONE, SUP_MODULE_UEFI_APPLICATION]:

             return

       

         for Source in M.SourceFileList:

@@ -591,7 +591,7 @@ class ModuleReport(object):
             #

             # If a module complies to PI 1.1, promote Module type to "SMM_DRIVER"

             #

-            if ModuleType == "DXE_SMM_DRIVER":

+            if ModuleType == SUP_MODULE_DXE_SMM_DRIVER:

                 PiSpec = M.Module.Specification.get("PI_SPECIFICATION_VERSION", "0x00010000")

                 if int(PiSpec, 0) >= 0x0001000A:

                     ModuleType = "SMM_DRIVER"

@@ -1382,7 +1382,7 @@ class PredictionReport(object):
                 # their source code to find PPI/Protocol produce or consume

                 # information.

                 #

-                if Module.ModuleType == "BASE":

+                if Module.ModuleType == SUP_MODULE_BASE:

                     continue

                 #

                 # Add module referenced source files

diff --git a/BaseTools/Source/Python/build/build.py b/BaseTools/Source/Python/build/build.py
index 36bb1fecf7..81d59dd3ee 100644
--- a/BaseTools/Source/Python/build/build.py
+++ b/BaseTools/Source/Python/build/build.py
@@ -1587,22 +1587,22 @@ class Build():
                     if not ImageClass.IsValid:

                         EdkLogger.error("build", FILE_PARSE_FAILURE, ExtraData=ImageClass.ErrorInfo)

                     ImageInfo = PeImageInfo(Module.Name, Module.Guid, Module.Arch, Module.OutputDir, Module.DebugDir, ImageClass)

-                    if Module.ModuleType in ['PEI_CORE', 'PEIM', 'COMBINED_PEIM_DRIVER', 'PIC_PEIM', 'RELOCATABLE_PEIM', 'DXE_CORE']:

+                    if Module.ModuleType in [SUP_MODULE_PEI_CORE, SUP_MODULE_PEIM, 'COMBINED_PEIM_DRIVER', 'PIC_PEIM', 'RELOCATABLE_PEIM', SUP_MODULE_DXE_CORE]:

                         PeiModuleList[Module.MetaFile] = ImageInfo

                         PeiSize += ImageInfo.Image.Size

-                    elif Module.ModuleType in ['BS_DRIVER', 'DXE_DRIVER', 'UEFI_DRIVER']:

+                    elif Module.ModuleType in ['BS_DRIVER', SUP_MODULE_DXE_DRIVER, SUP_MODULE_UEFI_DRIVER]:

                         BtModuleList[Module.MetaFile] = ImageInfo

                         BtSize += ImageInfo.Image.Size

-                    elif Module.ModuleType in ['DXE_RUNTIME_DRIVER', 'RT_DRIVER', 'DXE_SAL_DRIVER', 'SAL_RT_DRIVER']:

+                    elif Module.ModuleType in [SUP_MODULE_DXE_RUNTIME_DRIVER, 'RT_DRIVER', SUP_MODULE_DXE_SAL_DRIVER, 'SAL_RT_DRIVER']:

                         RtModuleList[Module.MetaFile] = ImageInfo

                         #IPF runtime driver needs to be at 2 page alignment.

                         if IsIpfPlatform and ImageInfo.Image.Size % 0x2000 != 0:

                             ImageInfo.Image.Size = (ImageInfo.Image.Size / 0x2000 + 1) * 0x2000

                         RtSize += ImageInfo.Image.Size

-                    elif Module.ModuleType in ['SMM_CORE', 'DXE_SMM_DRIVER', 'MM_STANDALONE', 'MM_CORE_STANDALONE']:

+                    elif Module.ModuleType in [SUP_MODULE_SMM_CORE, SUP_MODULE_DXE_SMM_DRIVER, SUP_MODULE_MM_STANDALONE, SUP_MODULE_MM_CORE_STANDALONE]:

                         SmmModuleList[Module.MetaFile] = ImageInfo

                         SmmSize += ImageInfo.Image.Size

-                        if Module.ModuleType == 'DXE_SMM_DRIVER':

+                        if Module.ModuleType == SUP_MODULE_DXE_SMM_DRIVER:

                             PiSpecVersion = Module.Module.Specification.get('PI_SPECIFICATION_VERSION', '0x00000000')

                             # for PI specification < PI1.1, DXE_SMM_DRIVER also runs as BOOT time driver.

                             if int(PiSpecVersion, 16) < 0x0001000A: