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