BaseTools/Source/Python/Common/DataType.py

   1 ## @file
   2 # This file is used to define common static strings used by INF/DEC/DSC files
   3 #
   4 # Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>
   5 # Portions copyright (c) 2011 - 2013, ARM Ltd. All rights reserved.<BR>
   6 # Portions Copyright (c) 2020, Hewlett Packard Enterprise Development LP. All rights reserved.<BR>
   7 # SPDX-License-Identifier: BSD-2-Clause-Patent
   8
   9 ##
  10 # Common Definitions
  11 #
  12 TAB_SPLIT = '.'
  13 TAB_COMMENT_EDK_START = '/*'
  14 TAB_COMMENT_EDK_END = '*/'
  15 TAB_COMMENT_EDK_SPLIT = '//'
  16 TAB_COMMENT_SPLIT = '#'
  17 TAB_SPECIAL_COMMENT = '##'
  18 TAB_EQUAL_SPLIT = '='
  19 TAB_VALUE_SPLIT = '|'
  20 TAB_COMMA_SPLIT = ','
  21 TAB_SPACE_SPLIT = ' '
  22 TAB_SEMI_COLON_SPLIT = ';'
  23 TAB_SECTION_START = '['
  24 TAB_SECTION_END = ']'
  25 TAB_OPTION_START = '<'
  26 TAB_OPTION_END = '>'
  27 TAB_SLASH = '\\'
  28 TAB_BACK_SLASH = '/'
  29 TAB_STAR = '*'
  30 TAB_LINE_BREAK = '\n'
  31 TAB_PRINTCHAR_VT = '\x0b'
  32 TAB_PRINTCHAR_BS = '\b'
  33 TAB_PRINTCHAR_NUL = '\0'
  34 TAB_UINT8 = 'UINT8'
  35 TAB_UINT16 = 'UINT16'
  36 TAB_UINT32 = 'UINT32'
  37 TAB_UINT64 = 'UINT64'
  38 TAB_VOID = 'VOID*'
  39 TAB_GUID = 'GUID'
  40
  41 TAB_PCD_CLEAN_NUMERIC_TYPES = {TAB_UINT8, TAB_UINT16, TAB_UINT32, TAB_UINT64}
  42 TAB_PCD_NUMERIC_TYPES = {TAB_UINT8, TAB_UINT16, TAB_UINT32, TAB_UINT64, 'BOOLEAN'}
  43 TAB_PCD_NUMERIC_TYPES_VOID = {TAB_UINT8, TAB_UINT16, TAB_UINT32, TAB_UINT64, 'BOOLEAN', TAB_VOID}
  44
  45 TAB_WORKSPACE = '$(WORKSPACE)'
  46 TAB_FV_DIRECTORY = 'FV'
  47
  48 TAB_ARCH_NULL = ''
  49 TAB_ARCH_COMMON = 'COMMON'
  50 TAB_ARCH_IA32 = 'IA32'
  51 TAB_ARCH_X64 = 'X64'
  52 TAB_ARCH_ARM = 'ARM'
  53 TAB_ARCH_EBC = 'EBC'
  54 TAB_ARCH_AARCH64 = 'AARCH64'
  55
  56 TAB_ARCH_RISCV64 = 'RISCV64'
  57
  58 ARCH_SET_FULL = {TAB_ARCH_IA32, TAB_ARCH_X64, TAB_ARCH_ARM, TAB_ARCH_EBC, TAB_ARCH_AARCH64, TAB_ARCH_RISCV64, TAB_ARCH_COMMON}
  59
  60 SUP_MODULE_BASE = 'BASE'
  61 SUP_MODULE_SEC = 'SEC'
  62 SUP_MODULE_PEI_CORE = 'PEI_CORE'
  63 SUP_MODULE_PEIM = 'PEIM'
  64 SUP_MODULE_DXE_CORE = 'DXE_CORE'
  65 SUP_MODULE_DXE_DRIVER = 'DXE_DRIVER'
  66 SUP_MODULE_DXE_RUNTIME_DRIVER = 'DXE_RUNTIME_DRIVER'
  67 SUP_MODULE_DXE_SAL_DRIVER = 'DXE_SAL_DRIVER'
  68 SUP_MODULE_DXE_SMM_DRIVER = 'DXE_SMM_DRIVER'
  69 SUP_MODULE_UEFI_DRIVER = 'UEFI_DRIVER'
  70 SUP_MODULE_UEFI_APPLICATION = 'UEFI_APPLICATION'
  71 SUP_MODULE_USER_DEFINED = 'USER_DEFINED'
  72 SUP_MODULE_HOST_APPLICATION = 'HOST_APPLICATION'
  73 SUP_MODULE_SMM_CORE = 'SMM_CORE'
  74 SUP_MODULE_MM_STANDALONE = 'MM_STANDALONE'
  75 SUP_MODULE_MM_CORE_STANDALONE = 'MM_CORE_STANDALONE'
  76
  77 SUP_MODULE_LIST = [SUP_MODULE_BASE, SUP_MODULE_SEC, SUP_MODULE_PEI_CORE, SUP_MODULE_PEIM, SUP_MODULE_DXE_CORE, SUP_MODULE_DXE_DRIVER, \
  78                    SUP_MODULE_DXE_RUNTIME_DRIVER, SUP_MODULE_DXE_SAL_DRIVER, SUP_MODULE_DXE_SMM_DRIVER, SUP_MODULE_UEFI_DRIVER, \
  79                    SUP_MODULE_UEFI_APPLICATION, SUP_MODULE_USER_DEFINED, SUP_MODULE_HOST_APPLICATION, SUP_MODULE_SMM_CORE, SUP_MODULE_MM_STANDALONE, SUP_MODULE_MM_CORE_STANDALONE]
  80 SUP_MODULE_LIST_STRING = TAB_VALUE_SPLIT.join(SUP_MODULE_LIST)
  81 SUP_MODULE_SET_PEI = {SUP_MODULE_PEIM, SUP_MODULE_PEI_CORE}
  82
  83 EDK_COMPONENT_TYPE_LIBRARY = 'LIBRARY'
  84 EDK_COMPONENT_TYPE_SECURITY_CORE = 'SECURITY_CORE'
  85 EDK_COMPONENT_TYPE_PEI_CORE = SUP_MODULE_PEI_CORE
  86 EDK_COMPONENT_TYPE_COMBINED_PEIM_DRIVER = 'COMBINED_PEIM_DRIVER'
  87 EDK_COMPONENT_TYPE_PIC_PEIM = 'PIC_PEIM'
  88 EDK_COMPONENT_TYPE_RELOCATABLE_PEIM = 'RELOCATABLE_PEIM'
  89 EDK_COMPONENT_TYPE_BS_DRIVER = 'BS_DRIVER'
  90 EDK_COMPONENT_TYPE_RT_DRIVER = 'RT_DRIVER'
  91 EDK_COMPONENT_TYPE_SAL_RT_DRIVER = 'SAL_RT_DRIVER'
  92 EDK_COMPONENT_TYPE_APPLICATION = 'APPLICATION'
  93 EDK_NAME = 'EDK'
  94 EDKII_NAME = 'EDKII'
  95 MSG_EDKII_MAIL_ADDR = 'devel@edk2.groups.io'
  96
  97 COMPONENT_TO_MODULE_MAP_DICT = {
  98     EDK_COMPONENT_TYPE_LIBRARY               :   SUP_MODULE_BASE,
  99     EDK_COMPONENT_TYPE_SECURITY_CORE         :   SUP_MODULE_SEC,
 100     EDK_COMPONENT_TYPE_PEI_CORE              :   SUP_MODULE_PEI_CORE,
 101     EDK_COMPONENT_TYPE_COMBINED_PEIM_DRIVER  :   SUP_MODULE_PEIM,
 102     EDK_COMPONENT_TYPE_PIC_PEIM              :   SUP_MODULE_PEIM,
 103     EDK_COMPONENT_TYPE_RELOCATABLE_PEIM      :   SUP_MODULE_PEIM,
 104     "PE32_PEIM"                              :   SUP_MODULE_PEIM,
 105     EDK_COMPONENT_TYPE_BS_DRIVER             :   SUP_MODULE_DXE_DRIVER,
 106     EDK_COMPONENT_TYPE_RT_DRIVER             :   SUP_MODULE_DXE_RUNTIME_DRIVER,
 107     EDK_COMPONENT_TYPE_SAL_RT_DRIVER         :   SUP_MODULE_DXE_SAL_DRIVER,
 108     EDK_COMPONENT_TYPE_APPLICATION           :   SUP_MODULE_UEFI_APPLICATION,
 109     "LOGO"                                   :   SUP_MODULE_BASE,
 110 }
 111
 112 BINARY_FILE_TYPE_FW = 'FW'
 113 BINARY_FILE_TYPE_GUID = 'GUID'
 114 BINARY_FILE_TYPE_PREEFORM = 'PREEFORM'
 115 BINARY_FILE_TYPE_UEFI_APP = 'UEFI_APP'
 116 BINARY_FILE_TYPE_UNI_UI = 'UNI_UI'
 117 BINARY_FILE_TYPE_UNI_VER = 'UNI_VER'
 118 BINARY_FILE_TYPE_LIB = 'LIB'
 119 BINARY_FILE_TYPE_PE32 = 'PE32'
 120 BINARY_FILE_TYPE_PIC = 'PIC'
 121 BINARY_FILE_TYPE_PEI_DEPEX = 'PEI_DEPEX'
 122 BINARY_FILE_TYPE_DXE_DEPEX = 'DXE_DEPEX'
 123 BINARY_FILE_TYPE_SMM_DEPEX = 'SMM_DEPEX'
 124 BINARY_FILE_TYPE_TE = 'TE'
 125 BINARY_FILE_TYPE_VER = 'VER'
 126 BINARY_FILE_TYPE_UI = 'UI'
 127 BINARY_FILE_TYPE_BIN = 'BIN'
 128 BINARY_FILE_TYPE_FV = 'FV'
 129 BINARY_FILE_TYPE_RAW = 'RAW_BINARY'
 130
 131 PLATFORM_COMPONENT_TYPE_LIBRARY_CLASS = 'LIBRARY_CLASS'
 132 PLATFORM_COMPONENT_TYPE_MODULE = 'MODULE'
 133
 134 TAB_SOURCES = 'Sources'
 135 TAB_SOURCES_COMMON = TAB_SOURCES + TAB_SPLIT + TAB_ARCH_COMMON
 136 TAB_SOURCES_IA32 = TAB_SOURCES + TAB_SPLIT + TAB_ARCH_IA32
 137 TAB_SOURCES_X64 = TAB_SOURCES + TAB_SPLIT + TAB_ARCH_X64
 138 TAB_SOURCES_ARM = TAB_SOURCES + TAB_SPLIT + TAB_ARCH_ARM
 139 TAB_SOURCES_EBC = TAB_SOURCES + TAB_SPLIT + TAB_ARCH_EBC
 140 TAB_SOURCES_AARCH64 = TAB_SOURCES + TAB_SPLIT + TAB_ARCH_AARCH64
 141
 142 TAB_BINARIES = 'Binaries'
 143 TAB_BINARIES_COMMON = TAB_BINARIES + TAB_SPLIT + TAB_ARCH_COMMON
 144 TAB_BINARIES_IA32 = TAB_BINARIES + TAB_SPLIT + TAB_ARCH_IA32
 145 TAB_BINARIES_X64 = TAB_BINARIES + TAB_SPLIT + TAB_ARCH_X64
 146 TAB_BINARIES_ARM = TAB_BINARIES + TAB_SPLIT + TAB_ARCH_ARM
 147 TAB_BINARIES_EBC = TAB_BINARIES + TAB_SPLIT + TAB_ARCH_EBC
 148 TAB_BINARIES_AARCH64 = TAB_BINARIES + TAB_SPLIT + TAB_ARCH_AARCH64
 149
 150 TAB_INCLUDES = 'Includes'
 151 TAB_INCLUDES_COMMON = TAB_INCLUDES + TAB_SPLIT + TAB_ARCH_COMMON
 152 TAB_INCLUDES_IA32 = TAB_INCLUDES + TAB_SPLIT + TAB_ARCH_IA32
 153 TAB_INCLUDES_X64 = TAB_INCLUDES + TAB_SPLIT + TAB_ARCH_X64
 154 TAB_INCLUDES_ARM = TAB_INCLUDES + TAB_SPLIT + TAB_ARCH_ARM
 155 TAB_INCLUDES_EBC = TAB_INCLUDES + TAB_SPLIT + TAB_ARCH_EBC
 156 TAB_INCLUDES_AARCH64 = TAB_INCLUDES + TAB_SPLIT + TAB_ARCH_AARCH64
 157
 158 TAB_GUIDS = 'Guids'
 159 TAB_GUIDS_COMMON = TAB_GUIDS + TAB_SPLIT + TAB_ARCH_COMMON
 160 TAB_GUIDS_IA32 = TAB_GUIDS + TAB_SPLIT + TAB_ARCH_IA32
 161 TAB_GUIDS_X64 = TAB_GUIDS + TAB_SPLIT + TAB_ARCH_X64
 162 TAB_GUIDS_ARM = TAB_GUIDS + TAB_SPLIT + TAB_ARCH_ARM
 163 TAB_GUIDS_EBC = TAB_GUIDS + TAB_SPLIT + TAB_ARCH_EBC
 164 TAB_GUIDS_AARCH64 = TAB_GUIDS + TAB_SPLIT + TAB_ARCH_AARCH64
 165
 166 TAB_PROTOCOLS = 'Protocols'
 167 TAB_PROTOCOLS_COMMON = TAB_PROTOCOLS + TAB_SPLIT + TAB_ARCH_COMMON
 168 TAB_PROTOCOLS_IA32 = TAB_PROTOCOLS + TAB_SPLIT + TAB_ARCH_IA32
 169 TAB_PROTOCOLS_X64 = TAB_PROTOCOLS + TAB_SPLIT + TAB_ARCH_X64
 170 TAB_PROTOCOLS_ARM = TAB_PROTOCOLS + TAB_SPLIT + TAB_ARCH_ARM
 171 TAB_PROTOCOLS_EBC = TAB_PROTOCOLS + TAB_SPLIT + TAB_ARCH_EBC
 172 TAB_PROTOCOLS_AARCH64 = TAB_PROTOCOLS + TAB_SPLIT + TAB_ARCH_AARCH64
 173
 174 TAB_PPIS = 'Ppis'
 175 TAB_PPIS_COMMON = TAB_PPIS + TAB_SPLIT + TAB_ARCH_COMMON
 176 TAB_PPIS_IA32 = TAB_PPIS + TAB_SPLIT + TAB_ARCH_IA32
 177 TAB_PPIS_X64 = TAB_PPIS + TAB_SPLIT + TAB_ARCH_X64
 178 TAB_PPIS_ARM = TAB_PPIS + TAB_SPLIT + TAB_ARCH_ARM
 179 TAB_PPIS_EBC = TAB_PPIS + TAB_SPLIT + TAB_ARCH_EBC
 180 TAB_PPIS_AARCH64 = TAB_PPIS + TAB_SPLIT + TAB_ARCH_AARCH64
 181
 182 TAB_LIBRARY_CLASSES = 'LibraryClasses'
 183 TAB_LIBRARY_CLASSES_COMMON = TAB_LIBRARY_CLASSES + TAB_SPLIT + TAB_ARCH_COMMON
 184 TAB_LIBRARY_CLASSES_IA32 = TAB_LIBRARY_CLASSES + TAB_SPLIT + TAB_ARCH_IA32
 185 TAB_LIBRARY_CLASSES_X64 = TAB_LIBRARY_CLASSES + TAB_SPLIT + TAB_ARCH_X64
 186 TAB_LIBRARY_CLASSES_ARM = TAB_LIBRARY_CLASSES + TAB_SPLIT + TAB_ARCH_ARM
 187 TAB_LIBRARY_CLASSES_EBC = TAB_LIBRARY_CLASSES + TAB_SPLIT + TAB_ARCH_EBC
 188 TAB_LIBRARY_CLASSES_AARCH64 = TAB_LIBRARY_CLASSES + TAB_SPLIT + TAB_ARCH_AARCH64
 189
 190 TAB_PACKAGES = 'Packages'
 191 TAB_PACKAGES_COMMON = TAB_PACKAGES + TAB_SPLIT + TAB_ARCH_COMMON
 192 TAB_PACKAGES_IA32 = TAB_PACKAGES + TAB_SPLIT + TAB_ARCH_IA32
 193 TAB_PACKAGES_X64 = TAB_PACKAGES + TAB_SPLIT + TAB_ARCH_X64
 194 TAB_PACKAGES_ARM = TAB_PACKAGES + TAB_SPLIT + TAB_ARCH_ARM
 195 TAB_PACKAGES_EBC = TAB_PACKAGES + TAB_SPLIT + TAB_ARCH_EBC
 196 TAB_PACKAGES_AARCH64 = TAB_PACKAGES + TAB_SPLIT + TAB_ARCH_AARCH64
 197
 198 TAB_PCDS = 'Pcds'
 199 TAB_PCDS_FIXED_AT_BUILD = 'FixedAtBuild'
 200 TAB_PCDS_PATCHABLE_IN_MODULE = 'PatchableInModule'
 201 TAB_PCDS_FEATURE_FLAG = 'FeatureFlag'
 202 TAB_PCDS_DYNAMIC_EX = 'DynamicEx'
 203 TAB_PCDS_DYNAMIC_EX_DEFAULT = 'DynamicExDefault'
 204 TAB_PCDS_DYNAMIC_EX_VPD = 'DynamicExVpd'
 205 TAB_PCDS_DYNAMIC_EX_HII = 'DynamicExHii'
 206 TAB_PCDS_DYNAMIC = 'Dynamic'
 207 TAB_PCDS_DYNAMIC_DEFAULT = 'DynamicDefault'
 208 TAB_PCDS_DYNAMIC_VPD = 'DynamicVpd'
 209 TAB_PCDS_DYNAMIC_HII = 'DynamicHii'
 210
 211 PCD_DYNAMIC_TYPE_SET = {TAB_PCDS_DYNAMIC, TAB_PCDS_DYNAMIC_DEFAULT, TAB_PCDS_DYNAMIC_VPD, TAB_PCDS_DYNAMIC_HII}
 212 PCD_DYNAMIC_EX_TYPE_SET = {TAB_PCDS_DYNAMIC_EX, TAB_PCDS_DYNAMIC_EX_DEFAULT, TAB_PCDS_DYNAMIC_EX_VPD, TAB_PCDS_DYNAMIC_EX_HII}
 213
 214 # leave as a list for order
 215 PCD_TYPE_LIST = [TAB_PCDS_FIXED_AT_BUILD, TAB_PCDS_PATCHABLE_IN_MODULE, TAB_PCDS_FEATURE_FLAG, TAB_PCDS_DYNAMIC, TAB_PCDS_DYNAMIC_EX]
 216
 217 TAB_PCDS_FIXED_AT_BUILD_NULL = TAB_PCDS + TAB_PCDS_FIXED_AT_BUILD
 218 TAB_PCDS_FIXED_AT_BUILD_COMMON = TAB_PCDS + TAB_PCDS_FIXED_AT_BUILD + TAB_SPLIT + TAB_ARCH_COMMON
 219 TAB_PCDS_FIXED_AT_BUILD_IA32 = TAB_PCDS + TAB_PCDS_FIXED_AT_BUILD + TAB_SPLIT + TAB_ARCH_IA32
 220 TAB_PCDS_FIXED_AT_BUILD_X64 = TAB_PCDS + TAB_PCDS_FIXED_AT_BUILD + TAB_SPLIT + TAB_ARCH_X64
 221 TAB_PCDS_FIXED_AT_BUILD_ARM = TAB_PCDS + TAB_PCDS_FIXED_AT_BUILD + TAB_SPLIT + TAB_ARCH_ARM
 222 TAB_PCDS_FIXED_AT_BUILD_EBC = TAB_PCDS + TAB_PCDS_FIXED_AT_BUILD + TAB_SPLIT + TAB_ARCH_EBC
 223 TAB_PCDS_FIXED_AT_BUILD_AARCH64 = TAB_PCDS + TAB_PCDS_FIXED_AT_BUILD + TAB_SPLIT + TAB_ARCH_AARCH64
 224
 225 TAB_PCDS_PATCHABLE_IN_MODULE_NULL = TAB_PCDS + TAB_PCDS_PATCHABLE_IN_MODULE
 226 TAB_PCDS_PATCHABLE_IN_MODULE_COMMON = TAB_PCDS + TAB_PCDS_PATCHABLE_IN_MODULE + TAB_SPLIT + TAB_ARCH_COMMON
 227 TAB_PCDS_PATCHABLE_IN_MODULE_IA32 = TAB_PCDS + TAB_PCDS_PATCHABLE_IN_MODULE + TAB_SPLIT + TAB_ARCH_IA32
 228 TAB_PCDS_PATCHABLE_IN_MODULE_X64 = TAB_PCDS + TAB_PCDS_PATCHABLE_IN_MODULE + TAB_SPLIT + TAB_ARCH_X64
 229 TAB_PCDS_PATCHABLE_IN_MODULE_ARM = TAB_PCDS + TAB_PCDS_PATCHABLE_IN_MODULE + TAB_SPLIT + TAB_ARCH_ARM
 230 TAB_PCDS_PATCHABLE_IN_MODULE_EBC = TAB_PCDS + TAB_PCDS_PATCHABLE_IN_MODULE + TAB_SPLIT + TAB_ARCH_EBC
 231 TAB_PCDS_PATCHABLE_IN_MODULE_AARCH64 = TAB_PCDS + TAB_PCDS_PATCHABLE_IN_MODULE + TAB_SPLIT + TAB_ARCH_AARCH64
 232
 233 TAB_PCDS_FEATURE_FLAG_NULL = TAB_PCDS + TAB_PCDS_FEATURE_FLAG
 234 TAB_PCDS_FEATURE_FLAG_COMMON = TAB_PCDS + TAB_PCDS_FEATURE_FLAG + TAB_SPLIT + TAB_ARCH_COMMON
 235 TAB_PCDS_FEATURE_FLAG_IA32 = TAB_PCDS + TAB_PCDS_FEATURE_FLAG + TAB_SPLIT + TAB_ARCH_IA32
 236 TAB_PCDS_FEATURE_FLAG_X64 = TAB_PCDS + TAB_PCDS_FEATURE_FLAG + TAB_SPLIT + TAB_ARCH_X64
 237 TAB_PCDS_FEATURE_FLAG_ARM = TAB_PCDS + TAB_PCDS_FEATURE_FLAG + TAB_SPLIT + TAB_ARCH_ARM
 238 TAB_PCDS_FEATURE_FLAG_EBC = TAB_PCDS + TAB_PCDS_FEATURE_FLAG + TAB_SPLIT + TAB_ARCH_EBC
 239 TAB_PCDS_FEATURE_FLAG_AARCH64 = TAB_PCDS + TAB_PCDS_FEATURE_FLAG + TAB_SPLIT + TAB_ARCH_AARCH64
 240
 241 TAB_PCDS_DYNAMIC_EX_NULL = TAB_PCDS + TAB_PCDS_DYNAMIC_EX
 242 TAB_PCDS_DYNAMIC_EX_DEFAULT_NULL = TAB_PCDS + TAB_PCDS_DYNAMIC_EX_DEFAULT
 243 TAB_PCDS_DYNAMIC_EX_HII_NULL = TAB_PCDS + TAB_PCDS_DYNAMIC_EX_HII
 244 TAB_PCDS_DYNAMIC_EX_VPD_NULL = TAB_PCDS + TAB_PCDS_DYNAMIC_EX_VPD
 245 TAB_PCDS_DYNAMIC_EX_COMMON = TAB_PCDS + TAB_PCDS_DYNAMIC_EX + TAB_SPLIT + TAB_ARCH_COMMON
 246 TAB_PCDS_DYNAMIC_EX_IA32 = TAB_PCDS + TAB_PCDS_DYNAMIC_EX + TAB_SPLIT + TAB_ARCH_IA32
 247 TAB_PCDS_DYNAMIC_EX_X64 = TAB_PCDS + TAB_PCDS_DYNAMIC_EX + TAB_SPLIT + TAB_ARCH_X64
 248 TAB_PCDS_DYNAMIC_EX_ARM = TAB_PCDS + TAB_PCDS_DYNAMIC_EX + TAB_SPLIT + TAB_ARCH_ARM
 249 TAB_PCDS_DYNAMIC_EX_EBC = TAB_PCDS + TAB_PCDS_DYNAMIC_EX + TAB_SPLIT + TAB_ARCH_EBC
 250 TAB_PCDS_DYNAMIC_EX_AARCH64 = TAB_PCDS + TAB_PCDS_DYNAMIC_EX + TAB_SPLIT + TAB_ARCH_AARCH64
 251
 252 TAB_PCDS_DYNAMIC_NULL = TAB_PCDS + TAB_PCDS_DYNAMIC
 253 TAB_PCDS_DYNAMIC_DEFAULT_NULL = TAB_PCDS + TAB_PCDS_DYNAMIC_DEFAULT
 254 TAB_PCDS_DYNAMIC_HII_NULL = TAB_PCDS + TAB_PCDS_DYNAMIC_HII
 255 TAB_PCDS_DYNAMIC_VPD_NULL = TAB_PCDS + TAB_PCDS_DYNAMIC_VPD
 256 TAB_PCDS_DYNAMIC_COMMON = TAB_PCDS + TAB_PCDS_DYNAMIC + TAB_SPLIT + TAB_ARCH_COMMON
 257 TAB_PCDS_DYNAMIC_IA32 = TAB_PCDS + TAB_PCDS_DYNAMIC + TAB_SPLIT + TAB_ARCH_IA32
 258 TAB_PCDS_DYNAMIC_X64 = TAB_PCDS + TAB_PCDS_DYNAMIC + TAB_SPLIT + TAB_ARCH_X64
 259 TAB_PCDS_DYNAMIC_ARM = TAB_PCDS + TAB_PCDS_DYNAMIC + TAB_SPLIT + TAB_ARCH_ARM
 260 TAB_PCDS_DYNAMIC_EBC = TAB_PCDS + TAB_PCDS_DYNAMIC + TAB_SPLIT + TAB_ARCH_EBC
 261 TAB_PCDS_DYNAMIC_AARCH64 = TAB_PCDS + TAB_PCDS_DYNAMIC + TAB_SPLIT + TAB_ARCH_AARCH64
 262
 263 TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_PEI_PAGE_SIZE = 'PcdLoadFixAddressPeiCodePageNumber'
 264 TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_PEI_PAGE_SIZE_DATA_TYPE = 'UINT32'
 265 TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_DXE_PAGE_SIZE = 'PcdLoadFixAddressBootTimeCodePageNumber'
 266 TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_DXE_PAGE_SIZE_DATA_TYPE = 'UINT32'
 267 TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_RUNTIME_PAGE_SIZE = 'PcdLoadFixAddressRuntimeCodePageNumber'
 268 TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_RUNTIME_PAGE_SIZE_DATA_TYPE = 'UINT32'
 269 TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_SMM_PAGE_SIZE = 'PcdLoadFixAddressSmmCodePageNumber'
 270 TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_SMM_PAGE_SIZE_DATA_TYPE = 'UINT32'
 271 TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_SET =  {TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_PEI_PAGE_SIZE, \
 272                                             TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_DXE_PAGE_SIZE, \
 273                                             TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_RUNTIME_PAGE_SIZE, \
 274                                             TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_SMM_PAGE_SIZE}
 275
 276 ## The mapping dictionary from datum type to its maximum number.
 277 MAX_VAL_TYPE = {"BOOLEAN":0x01, TAB_UINT8:0xFF, TAB_UINT16:0xFFFF, TAB_UINT32:0xFFFFFFFF, TAB_UINT64:0xFFFFFFFFFFFFFFFF}
 278 ## The mapping dictionary from datum type to size string.
 279 MAX_SIZE_TYPE = {"BOOLEAN":1, TAB_UINT8:1, TAB_UINT16:2, TAB_UINT32:4, TAB_UINT64:8}
 280
 281 TAB_DEPEX = 'Depex'
 282 TAB_DEPEX_COMMON = TAB_DEPEX + TAB_SPLIT + TAB_ARCH_COMMON
 283 TAB_DEPEX_IA32 = TAB_DEPEX + TAB_SPLIT + TAB_ARCH_IA32
 284 TAB_DEPEX_X64 = TAB_DEPEX + TAB_SPLIT + TAB_ARCH_X64
 285 TAB_DEPEX_ARM = TAB_DEPEX + TAB_SPLIT + TAB_ARCH_ARM
 286 TAB_DEPEX_EBC = TAB_DEPEX + TAB_SPLIT + TAB_ARCH_EBC
 287 TAB_DEPEX_AARCH64 = TAB_DEPEX + TAB_SPLIT + TAB_ARCH_AARCH64
 288
 289 TAB_SKUIDS = 'SkuIds'
 290 TAB_DEFAULT_STORES = 'DefaultStores'
 291 TAB_DEFAULT_STORES_DEFAULT = 'STANDARD'
 292
 293 TAB_LIBRARIES = 'Libraries'
 294 TAB_LIBRARIES_COMMON = TAB_LIBRARIES + TAB_SPLIT + TAB_ARCH_COMMON
 295 TAB_LIBRARIES_IA32 = TAB_LIBRARIES + TAB_SPLIT + TAB_ARCH_IA32
 296 TAB_LIBRARIES_X64 = TAB_LIBRARIES + TAB_SPLIT + TAB_ARCH_X64
 297 TAB_LIBRARIES_ARM = TAB_LIBRARIES + TAB_SPLIT + TAB_ARCH_ARM
 298 TAB_LIBRARIES_EBC = TAB_LIBRARIES + TAB_SPLIT + TAB_ARCH_EBC
 299 TAB_LIBRARIES_AARCH64 = TAB_LIBRARIES + TAB_SPLIT + TAB_ARCH_AARCH64
 300
 301 TAB_COMPONENTS = 'Components'
 302 TAB_COMPONENTS_COMMON = TAB_COMPONENTS + TAB_SPLIT + TAB_ARCH_COMMON
 303 TAB_COMPONENTS_IA32 = TAB_COMPONENTS + TAB_SPLIT + TAB_ARCH_IA32
 304 TAB_COMPONENTS_X64 = TAB_COMPONENTS + TAB_SPLIT + TAB_ARCH_X64
 305 TAB_COMPONENTS_ARM = TAB_COMPONENTS + TAB_SPLIT + TAB_ARCH_ARM
 306 TAB_COMPONENTS_EBC = TAB_COMPONENTS + TAB_SPLIT + TAB_ARCH_EBC
 307 TAB_COMPONENTS_AARCH64 = TAB_COMPONENTS + TAB_SPLIT + TAB_ARCH_AARCH64
 308
 309 TAB_BUILD_OPTIONS = 'BuildOptions'
 310
 311 TAB_DEFINE = 'DEFINE'
 312 TAB_NMAKE = 'Nmake'
 313 TAB_USER_EXTENSIONS = 'UserExtensions'
 314 TAB_INCLUDE = '!include'
 315 TAB_DEFAULT = 'DEFAULT'
 316 TAB_COMMON = 'COMMON'
 317
 318 #
 319 # Common Define
 320 #
 321 TAB_COMMON_DEFINES = 'Defines'
 322
 323 #
 324 # Inf Definitions
 325 #
 326 TAB_INF_DEFINES = TAB_COMMON_DEFINES
 327 TAB_INF_DEFINES_INF_VERSION = 'INF_VERSION'
 328 TAB_INF_DEFINES_BASE_NAME = 'BASE_NAME'
 329 TAB_INF_DEFINES_FILE_GUID = 'FILE_GUID'
 330 TAB_INF_DEFINES_MODULE_TYPE = 'MODULE_TYPE'
 331 TAB_INF_DEFINES_EFI_SPECIFICATION_VERSION = 'EFI_SPECIFICATION_VERSION'
 332 TAB_INF_DEFINES_UEFI_SPECIFICATION_VERSION = 'UEFI_SPECIFICATION_VERSION'
 333 TAB_INF_DEFINES_PI_SPECIFICATION_VERSION = 'PI_SPECIFICATION_VERSION'
 334 TAB_INF_DEFINES_EDK_RELEASE_VERSION = 'EDK_RELEASE_VERSION'
 335 TAB_INF_DEFINES_BINARY_MODULE = 'BINARY_MODULE'
 336 TAB_INF_DEFINES_LIBRARY_CLASS = 'LIBRARY_CLASS'
 337 TAB_INF_DEFINES_COMPONENT_TYPE = 'COMPONENT_TYPE'
 338 TAB_INF_DEFINES_MAKEFILE_NAME = 'MAKEFILE_NAME'
 339 TAB_INF_DEFINES_DPX_SOURCE = 'DPX_SOURCE'
 340 TAB_INF_DEFINES_BUILD_NUMBER = 'BUILD_NUMBER'
 341 TAB_INF_DEFINES_BUILD_TYPE = 'BUILD_TYPE'
 342 TAB_INF_DEFINES_FFS_EXT = 'FFS_EXT'
 343 TAB_INF_DEFINES_FV_EXT = 'FV_EXT'
 344 TAB_INF_DEFINES_SOURCE_FV = 'SOURCE_FV'
 345 TAB_INF_DEFINES_VERSION_NUMBER = 'VERSION_NUMBER'
 346 TAB_INF_DEFINES_VERSION = 'VERSION'          # for Edk inf, the same as VERSION_NUMBER
 347 TAB_INF_DEFINES_VERSION_STRING = 'VERSION_STRING'
 348 TAB_INF_DEFINES_PCD_IS_DRIVER = 'PCD_IS_DRIVER'
 349 TAB_INF_DEFINES_TIANO_EDK_FLASHMAP_H = 'TIANO_EDK_FLASHMAP_H'
 350 TAB_INF_DEFINES_ENTRY_POINT = 'ENTRY_POINT'
 351 TAB_INF_DEFINES_UNLOAD_IMAGE = 'UNLOAD_IMAGE'
 352 TAB_INF_DEFINES_CONSTRUCTOR = 'CONSTRUCTOR'
 353 TAB_INF_DEFINES_DESTRUCTOR = 'DESTRUCTOR'
 354 TAB_INF_DEFINES_DEFINE = 'DEFINE'
 355 TAB_INF_DEFINES_SPEC = 'SPEC'
 356 TAB_INF_DEFINES_CUSTOM_MAKEFILE = 'CUSTOM_MAKEFILE'
 357 TAB_INF_DEFINES_MACRO = '__MACROS__'
 358 TAB_INF_DEFINES_SHADOW = 'SHADOW'
 359 TAB_INF_FIXED_PCD = 'FixedPcd'
 360 TAB_INF_FEATURE_PCD = 'FeaturePcd'
 361 TAB_INF_PATCH_PCD = 'PatchPcd'
 362 TAB_INF_PCD = 'Pcd'
 363 TAB_INF_PCD_EX = 'PcdEx'
 364 TAB_INF_USAGE_PRO = 'PRODUCES'
 365 TAB_INF_USAGE_SOME_PRO = 'SOMETIMES_PRODUCES'
 366 TAB_INF_USAGE_CON = 'CONSUMES'
 367 TAB_INF_USAGE_SOME_CON = 'SOMETIMES_CONSUMES'
 368 TAB_INF_USAGE_NOTIFY = 'NOTIFY'
 369 TAB_INF_USAGE_TO_START = 'TO_START'
 370 TAB_INF_USAGE_BY_START = 'BY_START'
 371 TAB_INF_GUIDTYPE_EVENT = 'Event'
 372 TAB_INF_GUIDTYPE_FILE = 'File'
 373 TAB_INF_GUIDTYPE_FV = 'FV'
 374 TAB_INF_GUIDTYPE_GUID = 'GUID'
 375 TAB_INF_GUIDTYPE_HII = 'HII'
 376 TAB_INF_GUIDTYPE_HOB = 'HOB'
 377 TAB_INF_GUIDTYPE_ST = 'SystemTable'
 378 TAB_INF_GUIDTYPE_TSG = 'TokenSpaceGuid'
 379 TAB_INF_GUIDTYPE_VAR = 'Variable'
 380 TAB_INF_GUIDTYPE_PROTOCOL = 'PROTOCOL'
 381 TAB_INF_GUIDTYPE_PPI = 'PPI'
 382 TAB_INF_USAGE_UNDEFINED = 'UNDEFINED'
 383
 384 #
 385 # Dec Definitions
 386 #
 387 TAB_DEC_DEFINES = TAB_COMMON_DEFINES
 388 TAB_DEC_DEFINES_DEC_SPECIFICATION = 'DEC_SPECIFICATION'
 389 TAB_DEC_DEFINES_PACKAGE_NAME = 'PACKAGE_NAME'
 390 TAB_DEC_DEFINES_PACKAGE_GUID = 'PACKAGE_GUID'
 391 TAB_DEC_DEFINES_PACKAGE_VERSION = 'PACKAGE_VERSION'
 392 TAB_DEC_DEFINES_PKG_UNI_FILE = 'PKG_UNI_FILE'
 393
 394 #
 395 # Dsc Definitions
 396 #
 397 TAB_DSC_DEFINES = TAB_COMMON_DEFINES
 398 TAB_DSC_DEFINES_PLATFORM_NAME = 'PLATFORM_NAME'
 399 TAB_DSC_DEFINES_PLATFORM_GUID = 'PLATFORM_GUID'
 400 TAB_DSC_DEFINES_PLATFORM_VERSION = 'PLATFORM_VERSION'
 401 TAB_DSC_DEFINES_DSC_SPECIFICATION = 'DSC_SPECIFICATION'
 402 TAB_DSC_DEFINES_OUTPUT_DIRECTORY = 'OUTPUT_DIRECTORY'
 403 TAB_DSC_DEFINES_SUPPORTED_ARCHITECTURES = 'SUPPORTED_ARCHITECTURES'
 404 TAB_DSC_DEFINES_BUILD_TARGETS = 'BUILD_TARGETS'
 405 TAB_DSC_DEFINES_SKUID_IDENTIFIER = 'SKUID_IDENTIFIER'
 406 TAB_DSC_DEFINES_PCD_INFO_GENERATION = 'PCD_INFO_GENERATION'
 407 TAB_DSC_DEFINES_PCD_DYNAMIC_AS_DYNAMICEX = 'PCD_DYNAMIC_AS_DYNAMICEX'
 408 TAB_DSC_DEFINES_PCD_VAR_CHECK_GENERATION = 'PCD_VAR_CHECK_GENERATION'
 409 TAB_DSC_DEFINES_VPD_AUTHENTICATED_VARIABLE_STORE = 'VPD_AUTHENTICATED_VARIABLE_STORE'
 410 TAB_DSC_DEFINES_FLASH_DEFINITION = 'FLASH_DEFINITION'
 411 TAB_DSC_DEFINES_BUILD_NUMBER = 'BUILD_NUMBER'
 412 TAB_DSC_DEFINES_MAKEFILE_NAME = 'MAKEFILE_NAME'
 413 TAB_DSC_DEFINES_BS_BASE_ADDRESS = 'BsBaseAddress'
 414 TAB_DSC_DEFINES_RT_BASE_ADDRESS = 'RtBaseAddress'
 415 TAB_DSC_DEFINES_RFC_LANGUAGES = 'RFC_LANGUAGES'
 416 TAB_DSC_DEFINES_ISO_LANGUAGES = 'ISO_LANGUAGES'
 417 TAB_DSC_DEFINES_DEFINE = 'DEFINE'
 418 TAB_DSC_DEFINES_VPD_TOOL_GUID = 'VPD_TOOL_GUID'
 419 TAB_FIX_LOAD_TOP_MEMORY_ADDRESS = 'FIX_LOAD_TOP_MEMORY_ADDRESS'
 420 TAB_DSC_DEFINES_EDKGLOBAL = 'EDK_GLOBAL'
 421 TAB_DSC_PREBUILD = 'PREBUILD'
 422 TAB_DSC_POSTBUILD = 'POSTBUILD'
 423 #
 424 # TargetTxt Definitions
 425 #
 426 TAB_TAT_DEFINES_ACTIVE_PLATFORM = 'ACTIVE_PLATFORM'
 427 TAB_TAT_DEFINES_ACTIVE_MODULE = 'ACTIVE_MODULE'
 428 TAB_TAT_DEFINES_TOOL_CHAIN_CONF = 'TOOL_CHAIN_CONF'
 429 TAB_TAT_DEFINES_MAX_CONCURRENT_THREAD_NUMBER = 'MAX_CONCURRENT_THREAD_NUMBER'
 430 TAB_TAT_DEFINES_TARGET = 'TARGET'
 431 TAB_TAT_DEFINES_TOOL_CHAIN_TAG = 'TOOL_CHAIN_TAG'
 432 TAB_TAT_DEFINES_TARGET_ARCH = 'TARGET_ARCH'
 433 TAB_TAT_DEFINES_BUILD_RULE_CONF = "BUILD_RULE_CONF"
 434
 435 #
 436 # ToolDef Definitions
 437 #
 438 TAB_TOD_DEFINES_TARGET = 'TARGET'
 439 TAB_TOD_DEFINES_TOOL_CHAIN_TAG = 'TOOL_CHAIN_TAG'
 440 TAB_TOD_DEFINES_TARGET_ARCH = 'TARGET_ARCH'
 441 TAB_TOD_DEFINES_COMMAND_TYPE = 'COMMAND_TYPE'
 442 TAB_TOD_DEFINES_FAMILY = 'FAMILY'
 443 TAB_TOD_DEFINES_BUILDRULEFAMILY = 'BUILDRULEFAMILY'
 444 TAB_TOD_DEFINES_BUILDRULEORDER = 'BUILDRULEORDER'
 445
 446 #
 447 # Conditional Statements
 448 #
 449 TAB_IF = '!if'
 450 TAB_END_IF = '!endif'
 451 TAB_ELSE_IF = '!elseif'
 452 TAB_ELSE = '!else'
 453 TAB_IF_DEF = '!ifdef'
 454 TAB_IF_N_DEF = '!ifndef'
 455 TAB_IF_EXIST = '!if exist'
 456 TAB_ERROR = '!error'
 457
 458 #
 459 # Unknown section
 460 #
 461 TAB_UNKNOWN = 'UNKNOWN'
 462
 463 #
 464 # Build database path
 465 #
 466 DATABASE_PATH = ":memory:" #"BuildDatabase.db"
 467
 468 # used by ECC
 469 MODIFIER_SET = {'IN', 'OUT', 'OPTIONAL', 'UNALIGNED', 'EFI_RUNTIMESERVICE', 'EFI_BOOTSERVICE', 'EFIAPI'}
 470
 471 # Dependency Opcodes
 472 DEPEX_OPCODE_BEFORE = "BEFORE"
 473 DEPEX_OPCODE_AFTER = "AFTER"
 474 DEPEX_OPCODE_PUSH = "PUSH"
 475 DEPEX_OPCODE_AND = "AND"
 476 DEPEX_OPCODE_OR = "OR"
 477 DEPEX_OPCODE_NOT = "NOT"
 478 DEPEX_OPCODE_END = "END"
 479 DEPEX_OPCODE_SOR = "SOR"
 480 DEPEX_OPCODE_TRUE = "TRUE"
 481 DEPEX_OPCODE_FALSE = "FALSE"
 482
 483 # Dependency Expression
 484 DEPEX_SUPPORTED_OPCODE_SET = {"BEFORE", "AFTER", "PUSH", "AND", "OR", "NOT", "END", "SOR", "TRUE", "FALSE", '(', ')'}
 485
 486 TAB_STATIC_LIBRARY = "STATIC-LIBRARY-FILE"
 487 TAB_DYNAMIC_LIBRARY = "DYNAMIC-LIBRARY-FILE"
 488 TAB_FRAMEWORK_IMAGE = "EFI-IMAGE-FILE"
 489 TAB_C_CODE_FILE = "C-CODE-FILE"
 490 TAB_C_HEADER_FILE = "C-HEADER-FILE"
 491 TAB_UNICODE_FILE = "UNICODE-TEXT-FILE"
 492 TAB_IMAGE_FILE = "IMAGE-DEFINITION-FILE"
 493 TAB_DEPENDENCY_EXPRESSION_FILE = "DEPENDENCY-EXPRESSION-FILE"
 494 TAB_UNKNOWN_FILE = "UNKNOWN-TYPE-FILE"
 495 TAB_DEFAULT_BINARY_FILE = "_BINARY_FILE_"
 496 TAB_OBJECT_FILE = "OBJECT-FILE"
 497 TAB_VFR_FILE = 'VISUAL-FORM-REPRESENTATION-FILE'
 498
 499 # used by BRG
 500 TAB_BRG_PCD = 'PCD'
 501 TAB_BRG_LIBRARY = 'Library'
 502
 503 #
 504 # Build Rule File Version Definition
 505 #
 506 TAB_BUILD_RULE_VERSION = "build_rule_version"
 507
 508 # section name for PCDs
 509 PCDS_DYNAMIC_DEFAULT = "PcdsDynamicDefault"
 510 PCDS_DYNAMIC_VPD = "PcdsDynamicVpd"
 511 PCDS_DYNAMIC_HII = "PcdsDynamicHii"
 512 PCDS_DYNAMICEX_DEFAULT = "PcdsDynamicExDefault"
 513 PCDS_DYNAMICEX_VPD = "PcdsDynamicExVpd"
 514 PCDS_DYNAMICEX_HII = "PcdsDynamicExHii"
 515
 516 SECTIONS_HAVE_ITEM_PCD_SET = {PCDS_DYNAMIC_DEFAULT.upper(), PCDS_DYNAMIC_VPD.upper(), PCDS_DYNAMIC_HII.upper(), \
 517                               PCDS_DYNAMICEX_DEFAULT.upper(), PCDS_DYNAMICEX_VPD.upper(), PCDS_DYNAMICEX_HII.upper()}
 518 # Section allowed to have items after arch
 519 SECTIONS_HAVE_ITEM_AFTER_ARCH_SET = {TAB_LIBRARY_CLASSES.upper(), TAB_DEPEX.upper(), TAB_USER_EXTENSIONS.upper(),
 520                                  PCDS_DYNAMIC_DEFAULT.upper(),
 521                                  PCDS_DYNAMIC_VPD.upper(),
 522                                  PCDS_DYNAMIC_HII.upper(),
 523                                  PCDS_DYNAMICEX_DEFAULT.upper(),
 524                                  PCDS_DYNAMICEX_VPD.upper(),
 525                                  PCDS_DYNAMICEX_HII.upper(),
 526                                  TAB_BUILD_OPTIONS.upper(),
 527                                  TAB_PACKAGES.upper(),
 528                                  TAB_INCLUDES.upper()}
 529
 530 #
 531 # pack codes as used in PcdDb and elsewhere
 532 #
 533 PACK_PATTERN_GUID = '=LHHBBBBBBBB'
 534 PACK_CODE_BY_SIZE = {8:'=Q',
 535                      4:'=L',
 536                      2:'=H',
 537                      1:'=B',
 538                      0:'=B',
 539                     16:""}
 540
 541 TAB_COMPILER_MSFT = 'MSFT'