BaseTools/Source/Python/UPT/Library/DataType.py

   1 ## @file
   2 # This file is used to define class for data type structure
   3 #
   4 # Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>
   5 #
   6 # This program and the accompanying materials are licensed and made available
   7 # under the terms and conditions of the BSD License which accompanies this
   8 # 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 DataType
  16 '''
  17
  18 ##
  19 # Module List Items
  20 #
  21 MODULE_LIST = ["BASE",
  22                "SEC",
  23                "PEI_CORE",
  24                "PEIM",
  25                "DXE_CORE",
  26                "DXE_DRIVER",
  27                "SMM_CORE",
  28                "DXE_RUNTIME_DRIVER",
  29                "DXE_SAL_DRIVER",
  30                "DXE_SMM_DRIVER",
  31                "UEFI_DRIVER",
  32                "UEFI_APPLICATION",
  33                "USER_DEFINED"]
  34
  35 VALID_DEPEX_MODULE_TYPE_LIST = ["PEIM",
  36                                 "DXE_DRIVER",
  37                                 "DXE_SMM_DRIVER",
  38                                 "DXE_RUNTIME_DRIVER",
  39                                 "DXE_SAL_DRIVER",
  40                                 "UEFI_DRIVER",
  41                                 ]
  42 ##
  43 # Usage List Items
  44 #
  45 USAGE_LIST = ["CONSUMES",
  46               "SOMETIMES_CONSUMES",
  47               "PRODUCES",
  48               "SOMETIMES_PRODUCES"]
  49
  50 TAB_LANGUAGE_EN_US = 'en-US'
  51 TAB_LANGUAGE_ENG   = 'eng'
  52 TAB_LANGUAGE_EN    = 'en'
  53 TAB_LANGUAGE_EN_X  = 'en-x-tianocore'
  54
  55 USAGE_ITEM_PRODUCES           = 'PRODUCES'
  56 USAGE_ITEM_SOMETIMES_PRODUCES = 'SOMETIMES_PRODUCES'
  57 USAGE_ITEM_CONSUMES           = 'CONSUMES'
  58 USAGE_ITEM_SOMETIMES_CONSUMES = 'SOMETIMES_CONSUMES'
  59 USAGE_ITEM_TO_START           = 'TO_START'
  60 USAGE_ITEM_BY_START           = 'BY_START'
  61 USAGE_ITEM_NOTIFY             = 'NOTIFY'
  62 USAGE_ITEM_UNDEFINED          = 'UNDEFINED'
  63
  64 USAGE_CONSUMES_LIST = [USAGE_ITEM_CONSUMES,
  65                        'CONSUMED',
  66                        'ALWAYS_CONSUMED',
  67                        'ALWAYS_CONSUMES'
  68                        ]
  69
  70 USAGE_PRODUCES_LIST = [USAGE_ITEM_PRODUCES,
  71                        'PRODUCED',
  72                        'ALWAYS_PRODUCED',
  73                        'ALWAYS_PRODUCES'
  74                        ]
  75
  76 USAGE_SOMETIMES_PRODUCES_LIST = [USAGE_ITEM_SOMETIMES_PRODUCES,
  77                                  'SOMETIMES_PRODUCED'
  78                                  ]
  79
  80 USAGE_SOMETIMES_CONSUMES_LIST = [USAGE_ITEM_SOMETIMES_CONSUMES,
  81                                  'SOMETIMES_CONSUMED'
  82                                  ]
  83
  84 ITEM_UNDEFINED = 'UNDEFINED'
  85
  86 TAB_PCD_VALIDRANGE = '@ValidRange'
  87 TAB_PCD_VALIDLIST = '@ValidList'
  88 TAB_PCD_EXPRESSION = '@Expression'
  89 TAB_PCD_PROMPT = '@Prompt'
  90 TAB_STR_TOKENCNAME = 'STR'
  91 TAB_STR_TOKENPROMPT = 'PROMPT'
  92 TAB_STR_TOKENHELP = 'HELP'
  93 TAB_STR_TOKENERR = 'ERR'
  94
  95 #
  96 # Dictionary of usage tokens and their synonmys
  97 #
  98 ALL_USAGE_TOKENS = {
  99   "PRODUCES"           : "PRODUCES",
 100   "PRODUCED"           : "PRODUCES",
 101   "ALWAYS_PRODUCES"    : "PRODUCES",
 102   "ALWAYS_PRODUCED"    : "PRODUCES",
 103   "SOMETIMES_PRODUCES" : "SOMETIMES_PRODUCES",
 104   "SOMETIMES_PRODUCED" : "SOMETIMES_PRODUCES",
 105   "CONSUMES"           : "CONSUMES",
 106   "CONSUMED"           : "CONSUMES",
 107   "ALWAYS_CONSUMES"    : "CONSUMES",
 108   "ALWAYS_CONSUMED"    : "CONSUMES",
 109   "SOMETIMES_CONSUMES" : "SOMETIMES_CONSUMES",
 110   "SOMETIMES_CONSUMED" : "SOMETIMES_CONSUMES",
 111   "SOMETIME_CONSUMES"  : "SOMETIMES_CONSUMES",
 112   "UNDEFINED"          : "UNDEFINED"
 113   }
 114
 115 PROTOCOL_USAGE_TOKENS = {
 116   "TO_START"           : "TO_START",
 117   "BY_START"           : "BY_START"
 118   }
 119
 120 PROTOCOL_USAGE_TOKENS.update (ALL_USAGE_TOKENS)
 121
 122 #
 123 # Dictionary of GUID type tokens
 124 #
 125 GUID_TYPE_TOKENS = {
 126   "Event"          : "Event",
 127   "File"           : "File",
 128   "FV"             : "FV",
 129   "GUID"           : "GUID",
 130   "Guid"           : "GUID",
 131   "HII"            : "HII",
 132   "HOB"            : "HOB",
 133   "Hob"            : "HOB",
 134   "Hob:"           : "HOB",
 135   "SystemTable"    : "SystemTable",
 136   "TokenSpaceGuid" : "TokenSpaceGuid",
 137   "UNDEFINED"      : "UNDEFINED"
 138   }
 139
 140 #
 141 # Dictionary of Protocol Notify tokens and their synonyms
 142 #
 143 PROTOCOL_NOTIFY_TOKENS = {
 144   "NOTIFY"          : "NOTIFY",
 145   "PROTOCOL_NOTIFY" : "NOTIFY",
 146   "UNDEFINED"       : "UNDEFINED"
 147   }
 148
 149 #
 150 # Dictionary of PPI Notify tokens and their synonyms
 151 #
 152 PPI_NOTIFY_TOKENS = {
 153   "NOTIFY"     : "NOTIFY",
 154   "PPI_NOTIFY" : "NOTIFY",
 155   "UNDEFINED"  : "UNDEFINED"
 156   }
 157
 158 EVENT_TOKENS = {
 159   "EVENT_TYPE_PERIODIC_TIMER" : "EVENT_TYPE_PERIODIC_TIMER",
 160   "EVENT_TYPE_RELATIVE_TIMER" : "EVENT_TYPE_RELATIVE_TIMER",
 161   "UNDEFINED"                 : "UNDEFINED"
 162   }
 163
 164 BOOTMODE_TOKENS = {
 165   "FULL"                  : "FULL",
 166   "MINIMAL"               : "MINIMAL",
 167   "NO_CHANGE"             : "NO_CHANGE",
 168   "DIAGNOSTICS"           : "DIAGNOSTICS",
 169   "DEFAULT"               : "DEFAULT",
 170   "S2_RESUME"             : "S2_RESUME",
 171   "S3_RESUME"             : "S3_RESUME",
 172   "S4_RESUME"             : "S4_RESUME",
 173   "S5_RESUME"             : "S5_RESUME",
 174   "FLASH_UPDATE"          : "FLASH_UPDATE",
 175   "RECOVERY_FULL"         : "RECOVERY_FULL",
 176   "RECOVERY_MINIMAL"      : "RECOVERY_MINIMAL",
 177   "RECOVERY_NO_CHANGE"    : "RECOVERY_NO_CHANGE",
 178   "RECOVERY_DIAGNOSTICS"  : "RECOVERY_DIAGNOSTICS",
 179   "RECOVERY_DEFAULT"      : "RECOVERY_DEFAULT",
 180   "RECOVERY_S2_RESUME"    : "RECOVERY_S2_RESUME",
 181   "RECOVERY_S3_RESUME"    : "RECOVERY_S3_RESUME",
 182   "RECOVERY_S4_RESUME"    : "RECOVERY_S4_RESUME",
 183   "RECOVERY_S5_RESUME"    : "RECOVERY_S5_RESUME",
 184   "RECOVERY_FLASH_UPDATE" : "RECOVERY_FLASH_UPDATE",
 185   "UNDEFINED"             : "UNDEFINED"
 186   }
 187
 188 HOB_TOKENS = {
 189   "PHIT"                : "PHIT",
 190   "MEMORY_ALLOCATION"   : "MEMORY_ALLOCATION",
 191   "LOAD_PEIM"           : "LOAD_PEIM",
 192   "RESOURCE_DESCRIPTOR" : "RESOURCE_DESCRIPTOR",
 193   "FIRMWARE_VOLUME"     : "FIRMWARE_VOLUME",
 194   "UNDEFINED"           : "UNDEFINED"
 195   }
 196
 197 ##
 198 # Usage List Items for Protocol
 199 #
 200 PROTOCOL_USAGE_LIST = USAGE_LIST + ["TO_START", "BY_START"]
 201
 202 ##
 203 # End of Line
 204 # Use this but not os.linesep for os.linesep has bug in it.
 205 #
 206 END_OF_LINE = '\n'
 207
 208 ##
 209 # Arch List Items
 210 #
 211 ARCH_LIST = ["IA32",
 212              "X64",
 213              "IPF",
 214              "EBC",
 215              "COMMON"]
 216 ##
 217 # PCD driver type list items
 218 #
 219 PCD_DIRVER_TYPE_LIST = ["PEI_PCD_DRIVER", "DXE_PCD_DRIVER"]
 220
 221 ##
 222 # Boot Mode List Items
 223 #
 224 BOOT_MODE_LIST = ["FULL",
 225                   "MINIMAL",
 226                   "NO_CHANGE",
 227                   "DIAGNOSTICS",
 228                   "DEFAULT",
 229                   "S2_RESUME",
 230                   "S3_RESUME",
 231                   "S4_RESUME",
 232                   "S5_RESUME",
 233                   "FLASH_UPDATE",
 234                   "RECOVERY_FULL",
 235                   "RECOVERY_MINIMAL",
 236                   "RECOVERY_NO_CHANGE",
 237                   "RECOVERY_DIAGNOSTICS",
 238                   "RECOVERY_DEFAULT",
 239                   "RECOVERY_S2_RESUME",
 240                   "RECOVERY_S3_RESUME",
 241                   "RECOVERY_S4_RESUME",
 242                   "RECOVERY_S5_RESUME",
 243                   "RECOVERY_FLASH_UPDATE"]
 244
 245 ##
 246 # Event Type List Items
 247 #
 248 EVENT_TYPE_LIST = ["EVENT_TYPE_PERIODIC_TIMER",
 249                    "EVENT_TYPE_RELATIVE_TIMER"]
 250
 251 ##
 252 # Hob Type List Items
 253 #
 254 HOB_TYPE_LIST = ["PHIT",
 255                  "MEMORY_ALLOCATION",
 256                  "RESOURCE_DESCRIPTOR",
 257                  "FIRMWARE_VOLUME",
 258                  "LOAD_PEIM"]
 259
 260 ##
 261 # GUID_TYPE_LIST
 262 #
 263 GUID_TYPE_LIST = ["Event", "File", "FV", "GUID", "HII", "HOB",
 264                   "SystemTable", "TokenSpaceGuid", "Variable"]
 265 ##
 266 # PCD Usage Type List of Package
 267 #
 268 PCD_USAGE_TYPE_LIST_OF_PACKAGE = ["FeatureFlag", "PatchableInModule",
 269                              "FixedAtBuild", "Dynamic", "DynamicEx"]
 270
 271 ##
 272 # PCD Usage Type List of Module
 273 #
 274 PCD_USAGE_TYPE_LIST_OF_MODULE = ["FEATUREPCD", "PATCHPCD", "FIXEDPCD", "PCD", "PCDEX"]
 275 ##
 276 # PCD Usage Type List of UPT
 277 #
 278 PCD_USAGE_TYPE_LIST_OF_UPT = PCD_USAGE_TYPE_LIST_OF_MODULE
 279
 280 ##
 281 # Binary File Type List
 282 #
 283 BINARY_FILE_TYPE_LIST = ["PE32", "PIC", "TE", "DXE_DEPEX", "VER", "UI", "COMPAT16", "FV", "BIN", "RAW",
 284                          "ACPI", "ASL",
 285                          "PEI_DEPEX",
 286                          "SMM_DEPEX",
 287                          "SUBTYPE_GUID",
 288                          "DISPOSABLE"
 289                          ]
 290 BINARY_FILE_TYPE_LIST_IN_UDP = \
 291                         ["GUID", "FREEFORM",
 292                          "UEFI_IMAGE", "PE32", "PIC",
 293                          "PEI_DEPEX",
 294                          "DXE_DEPEX",
 295                          "SMM_DEPEX",
 296                          "FV", "TE",
 297                          "BIN", "VER", "UI"
 298                          ]
 299
 300 SUBTYPE_GUID_BINARY_FILE_TYPE = "FREEFORM"
 301 ##
 302 # Possible values for COMPONENT_TYPE, and their descriptions, are listed in
 303 # the table,
 304 # "Component (module) Types." For each component, the BASE_NAME and
 305 # COMPONENT_TYPE
 306 # are required. The COMPONENT_TYPE definition is case sensitive.
 307 #
 308 COMPONENT_TYPE_LIST = [
 309                        "APPLICATION",
 310                        "ACPITABLE",
 311                        "APRIORI",
 312                        "BINARY",
 313                        "BS_DRIVER",
 314                        "CONFIG",
 315                        "FILE",
 316                        "FVIMAGEFILE",
 317                        "LIBRARY",
 318                        "LOGO",
 319                        "LEGACY16",
 320                        "MICROCODE",
 321                        "PE32_PEIM",
 322                        "PEI_CORE",
 323                        "RAWFILE",
 324                        "RT_DRIVER",
 325                        "SAL_RT_DRIVER",
 326                        "SECURITY_CORE",
 327                        "COMBINED_PEIM_DRIVER",
 328                        "PIC_PEIM",
 329                        "RELOCATABLE_PEIM"
 330                        ]
 331
 332 ##
 333 # Common Definitions
 334 #
 335 TAB_SPLIT = '.'
 336 TAB_COMMENT_EDK1_START = '/*'
 337 TAB_COMMENT_EDK1_END = '*/'
 338 TAB_COMMENT_EDK1_SPLIT = '//'
 339 TAB_COMMENT_SPLIT = '#'
 340 TAB_EQUAL_SPLIT = '='
 341 TAB_DEQUAL_SPLIT = '=='
 342 TAB_VALUE_SPLIT = '|'
 343 TAB_COMMA_SPLIT = ','
 344 TAB_HORIZON_LINE_SPLIT = '-'
 345 TAB_SPACE_SPLIT = ' '
 346 TAB_UNDERLINE_SPLIT = '_'
 347 TAB_SEMI_COLON_SPLIT = ';'
 348 TAB_COLON_SPLIT = ':'
 349 TAB_SECTION_START = '['
 350 TAB_SECTION_END = ']'
 351 TAB_OPTION_START = '<'
 352 TAB_OPTION_END  = '>'
 353 TAB_SLASH = '\\'
 354 TAB_BACK_SLASH = '/'
 355 TAB_SPECIAL_COMMENT = '##'
 356 TAB_HEADER_COMMENT = '@file'
 357 TAB_BINARY_HEADER_COMMENT = '@BinaryHeader'
 358 TAB_STAR = '*'
 359 TAB_ENCODING_UTF16LE = 'utf_16_le'
 360 TAB_CAPHEX_START = '0X'
 361 TAB_HEX_START = '0x'
 362 TAB_PCD_ERROR = 'Error'
 363 TAB_PCD_ERROR_SECTION_COMMENT = 'Error message section'
 364 TAB_UNI_FILE_SUFFIXS = ['.uni', '.UNI', '.Uni']
 365
 366 TAB_EDK_SOURCE = '$(EDK_SOURCE)'
 367 TAB_EFI_SOURCE = '$(EFI_SOURCE)'
 368 TAB_WORKSPACE = '$(WORKSPACE)'
 369
 370 TAB_ARCH_NULL = ''
 371 TAB_ARCH_COMMON = 'COMMON'
 372 TAB_ARCH_IA32 = 'IA32'
 373 TAB_ARCH_X64 = 'X64'
 374 TAB_ARCH_IPF = 'IPF'
 375 TAB_ARCH_ARM = 'ARM'
 376 TAB_ARCH_EBC = 'EBC'
 377
 378 ARCH_LIST = \
 379 [TAB_ARCH_IA32, TAB_ARCH_X64, TAB_ARCH_IPF, TAB_ARCH_ARM, TAB_ARCH_EBC]
 380
 381 SUP_MODULE_BASE = 'BASE'
 382 SUP_MODULE_SEC = 'SEC'
 383 SUP_MODULE_PEI_CORE = 'PEI_CORE'
 384 SUP_MODULE_PEIM = 'PEIM'
 385 SUP_MODULE_DXE_CORE = 'DXE_CORE'
 386 SUP_MODULE_DXE_DRIVER = 'DXE_DRIVER'
 387 SUP_MODULE_DXE_RUNTIME_DRIVER = 'DXE_RUNTIME_DRIVER'
 388 SUP_MODULE_DXE_SAL_DRIVER = 'DXE_SAL_DRIVER'
 389 SUP_MODULE_DXE_SMM_DRIVER = 'DXE_SMM_DRIVER'
 390 SUP_MODULE_UEFI_DRIVER = 'UEFI_DRIVER'
 391 SUP_MODULE_UEFI_APPLICATION = 'UEFI_APPLICATION'
 392 SUP_MODULE_USER_DEFINED = 'USER_DEFINED'
 393 SUP_MODULE_SMM_CORE = 'SMM_CORE'
 394
 395 SUP_MODULE_LIST = \
 396 [SUP_MODULE_BASE, SUP_MODULE_SEC, SUP_MODULE_PEI_CORE, SUP_MODULE_PEIM, \
 397 SUP_MODULE_DXE_CORE, SUP_MODULE_DXE_DRIVER, \
 398                    SUP_MODULE_DXE_RUNTIME_DRIVER, SUP_MODULE_DXE_SAL_DRIVER, \
 399                    SUP_MODULE_DXE_SMM_DRIVER, SUP_MODULE_UEFI_DRIVER, \
 400                    SUP_MODULE_UEFI_APPLICATION, SUP_MODULE_USER_DEFINED, \
 401                    SUP_MODULE_SMM_CORE]
 402 SUP_MODULE_LIST_STRING = TAB_VALUE_SPLIT.join(l for l in SUP_MODULE_LIST)
 403
 404 EDK_COMPONENT_TYPE_LIBRARY = 'LIBRARY'
 405 EDK_COMPONENT_TYPE_SECUARITY_CORE = 'SECUARITY_CORE'
 406 EDK_COMPONENT_TYPE_PEI_CORE = 'PEI_CORE'
 407 EDK_COMPONENT_TYPE_COMBINED_PEIM_DRIVER = 'COMBINED_PEIM_DRIVER'
 408 EDK_COMPONENT_TYPE_PIC_PEIM = 'PIC_PEIM'
 409 EDK_COMPONENT_TYPE_RELOCATABLE_PEIM = 'RELOCATABLE_PEIM'
 410 EDK_COMPONENT_TYPE_BS_DRIVER = 'BS_DRIVER'
 411 EDK_COMPONENT_TYPE_RT_DRIVER = 'RT_DRIVER'
 412 EDK_COMPONENT_TYPE_SAL_RT_DRIVER = 'SAL_RT_DRIVER'
 413 EDK_COMPONENT_TYPE_APPLICATION = 'APPLICATION'
 414 EDK_NAME   = 'EDK'
 415 EDKII_NAME = 'EDKII'
 416
 417 BINARY_FILE_TYPE_FW = 'FW'
 418 BINARY_FILE_TYPE_GUID = 'GUID'
 419 BINARY_FILE_TYPE_PREEFORM = 'PREEFORM'
 420 BINARY_FILE_TYPE_UEFI_APP = 'UEFI_APP'
 421 BINARY_FILE_TYPE_UNI_UI = 'UNI_UI'
 422 BINARY_FILE_TYPE_SEC_UI = 'SEC_UI'
 423 BINARY_FILE_TYPE_UNI_VER = 'UNI_VER'
 424 BINARY_FILE_TYPE_SEC_VER = 'SEC_VER'
 425 BINARY_FILE_TYPE_LIB = 'LIB'
 426 BINARY_FILE_TYPE_PE32 = 'PE32'
 427 BINARY_FILE_TYPE_PIC = 'PIC'
 428 BINARY_FILE_TYPE_PEI_DEPEX = 'PEI_DEPEX'
 429 BINARY_FILE_TYPE_DXE_DEPEX = 'DXE_DEPEX'
 430 BINARY_FILE_TYPE_SMM_DEPEX = 'SMM_DEPEX'
 431 BINARY_FILE_TYPE_TE = 'TE'
 432 BINARY_FILE_TYPE_VER = 'VER'
 433 BINARY_FILE_TYPE_UI = 'UI'
 434 BINARY_FILE_TYPE_BIN = 'BIN'
 435 BINARY_FILE_TYPE_FV = 'FV'
 436 BINARY_FILE_TYPE_UI_LIST = [BINARY_FILE_TYPE_UNI_UI,
 437                             BINARY_FILE_TYPE_SEC_UI,
 438                             BINARY_FILE_TYPE_UI
 439                             ]
 440 BINARY_FILE_TYPE_VER_LIST = [BINARY_FILE_TYPE_UNI_VER,
 441                             BINARY_FILE_TYPE_SEC_VER,
 442                             BINARY_FILE_TYPE_VER
 443                             ]
 444
 445 DEPEX_SECTION_LIST = ['<PEI_DEPEX>',
 446                       '<DXE_DEPEX>',
 447                       '<SMM_DEPEX>'
 448                       ]
 449
 450 PLATFORM_COMPONENT_TYPE_LIBRARY = 'LIBRARY'
 451 PLATFORM_COMPONENT_TYPE_LIBRARY_CLASS = 'LIBRARY_CLASS'
 452 PLATFORM_COMPONENT_TYPE_MODULE = 'MODULE'
 453
 454 TAB_LIBRARIES = 'Libraries'
 455
 456 TAB_SOURCE = 'Source'
 457 TAB_SOURCES = 'Sources'
 458 TAB_SOURCES_COMMON = TAB_SOURCES + TAB_SPLIT + TAB_ARCH_COMMON
 459 TAB_SOURCES_IA32 = TAB_SOURCES + TAB_SPLIT + TAB_ARCH_IA32
 460 TAB_SOURCES_X64 = TAB_SOURCES + TAB_SPLIT + TAB_ARCH_X64
 461 TAB_SOURCES_IPF = TAB_SOURCES + TAB_SPLIT + TAB_ARCH_IPF
 462 TAB_SOURCES_ARM = TAB_SOURCES + TAB_SPLIT + TAB_ARCH_ARM
 463 TAB_SOURCES_EBC = TAB_SOURCES + TAB_SPLIT + TAB_ARCH_EBC
 464
 465 TAB_BINARIES = 'Binaries'
 466 TAB_BINARIES_COMMON = TAB_BINARIES + TAB_SPLIT + TAB_ARCH_COMMON
 467 TAB_BINARIES_IA32 = TAB_BINARIES + TAB_SPLIT + TAB_ARCH_IA32
 468 TAB_BINARIES_X64 = TAB_BINARIES + TAB_SPLIT + TAB_ARCH_X64
 469 TAB_BINARIES_IPF = TAB_BINARIES + TAB_SPLIT + TAB_ARCH_IPF
 470 TAB_BINARIES_ARM = TAB_BINARIES + TAB_SPLIT + TAB_ARCH_ARM
 471 TAB_BINARIES_EBC = TAB_BINARIES + TAB_SPLIT + TAB_ARCH_EBC
 472
 473 TAB_INCLUDES = 'Includes'
 474 TAB_INCLUDES_COMMON = TAB_INCLUDES + TAB_SPLIT + TAB_ARCH_COMMON
 475 TAB_INCLUDES_IA32 = TAB_INCLUDES + TAB_SPLIT + TAB_ARCH_IA32
 476 TAB_INCLUDES_X64 = TAB_INCLUDES + TAB_SPLIT + TAB_ARCH_X64
 477 TAB_INCLUDES_IPF = TAB_INCLUDES + TAB_SPLIT + TAB_ARCH_IPF
 478 TAB_INCLUDES_ARM = TAB_INCLUDES + TAB_SPLIT + TAB_ARCH_ARM
 479 TAB_INCLUDES_EBC = TAB_INCLUDES + TAB_SPLIT + TAB_ARCH_EBC
 480
 481 TAB_GUIDS = 'Guids'
 482 TAB_GUIDS_COMMON = TAB_GUIDS + TAB_SPLIT + TAB_ARCH_COMMON
 483 TAB_GUIDS_IA32 = TAB_GUIDS + TAB_SPLIT + TAB_ARCH_IA32
 484 TAB_GUIDS_X64 = TAB_GUIDS + TAB_SPLIT + TAB_ARCH_X64
 485 TAB_GUIDS_IPF = TAB_GUIDS + TAB_SPLIT + TAB_ARCH_IPF
 486 TAB_GUIDS_ARM = TAB_GUIDS + TAB_SPLIT + TAB_ARCH_ARM
 487 TAB_GUIDS_EBC = TAB_GUIDS + TAB_SPLIT + TAB_ARCH_EBC
 488
 489 TAB_PROTOCOLS = 'Protocols'
 490 TAB_PROTOCOLS_COMMON = TAB_PROTOCOLS + TAB_SPLIT + TAB_ARCH_COMMON
 491 TAB_PROTOCOLS_IA32 = TAB_PROTOCOLS + TAB_SPLIT + TAB_ARCH_IA32
 492 TAB_PROTOCOLS_X64 = TAB_PROTOCOLS + TAB_SPLIT + TAB_ARCH_X64
 493 TAB_PROTOCOLS_IPF = TAB_PROTOCOLS + TAB_SPLIT + TAB_ARCH_IPF
 494 TAB_PROTOCOLS_ARM = TAB_PROTOCOLS + TAB_SPLIT + TAB_ARCH_ARM
 495 TAB_PROTOCOLS_EBC = TAB_PROTOCOLS + TAB_SPLIT + TAB_ARCH_EBC
 496
 497 TAB_PPIS = 'Ppis'
 498 TAB_PPIS_COMMON = TAB_PPIS + TAB_SPLIT + TAB_ARCH_COMMON
 499 TAB_PPIS_IA32 = TAB_PPIS + TAB_SPLIT + TAB_ARCH_IA32
 500 TAB_PPIS_X64 = TAB_PPIS + TAB_SPLIT + TAB_ARCH_X64
 501 TAB_PPIS_IPF = TAB_PPIS + TAB_SPLIT + TAB_ARCH_IPF
 502 TAB_PPIS_ARM = TAB_PPIS + TAB_SPLIT + TAB_ARCH_ARM
 503 TAB_PPIS_EBC = TAB_PPIS + TAB_SPLIT + TAB_ARCH_EBC
 504
 505 TAB_LIBRARY_CLASSES = 'LibraryClasses'
 506 TAB_LIBRARY_CLASSES_COMMON = TAB_LIBRARY_CLASSES + TAB_SPLIT + TAB_ARCH_COMMON
 507 TAB_LIBRARY_CLASSES_IA32 = TAB_LIBRARY_CLASSES + TAB_SPLIT + TAB_ARCH_IA32
 508 TAB_LIBRARY_CLASSES_X64 = TAB_LIBRARY_CLASSES + TAB_SPLIT + TAB_ARCH_X64
 509 TAB_LIBRARY_CLASSES_IPF = TAB_LIBRARY_CLASSES + TAB_SPLIT + TAB_ARCH_IPF
 510 TAB_LIBRARY_CLASSES_ARM = TAB_LIBRARY_CLASSES + TAB_SPLIT + TAB_ARCH_ARM
 511 TAB_LIBRARY_CLASSES_EBC = TAB_LIBRARY_CLASSES + TAB_SPLIT + TAB_ARCH_EBC
 512
 513 TAB_PACKAGES = 'Packages'
 514 TAB_PACKAGES_COMMON = TAB_PACKAGES + TAB_SPLIT + TAB_ARCH_COMMON
 515 TAB_PACKAGES_IA32 = TAB_PACKAGES + TAB_SPLIT + TAB_ARCH_IA32
 516 TAB_PACKAGES_X64 = TAB_PACKAGES + TAB_SPLIT + TAB_ARCH_X64
 517 TAB_PACKAGES_IPF = TAB_PACKAGES + TAB_SPLIT + TAB_ARCH_IPF
 518 TAB_PACKAGES_ARM = TAB_PACKAGES + TAB_SPLIT + TAB_ARCH_ARM
 519 TAB_PACKAGES_EBC = TAB_PACKAGES + TAB_SPLIT + TAB_ARCH_EBC
 520
 521 TAB_PCDS = 'Pcds'
 522 TAB_PCDS_FIXED_AT_BUILD = 'FixedAtBuild'
 523 TAB_PCDS_PATCHABLE_IN_MODULE = 'PatchableInModule'
 524 TAB_PCDS_FEATURE_FLAG = 'FeatureFlag'
 525 TAB_PCDS_DYNAMIC_EX = 'DynamicEx'
 526 TAB_PCDS_DYNAMIC_EX_DEFAULT = 'DynamicExDefault'
 527 TAB_PCDS_DYNAMIC_EX_VPD = 'DynamicExVpd'
 528 TAB_PCDS_DYNAMIC_EX_HII = 'DynamicExHii'
 529 TAB_PCDS_DYNAMIC = 'Dynamic'
 530 TAB_PCDS_DYNAMIC_DEFAULT = 'DynamicDefault'
 531 TAB_PCDS_DYNAMIC_VPD = 'DynamicVpd'
 532 TAB_PCDS_DYNAMIC_HII = 'DynamicHii'
 533
 534 TAB_PTR_TYPE_PCD = 'VOID*'
 535
 536 PCD_DYNAMIC_TYPE_LIST = [TAB_PCDS_DYNAMIC, TAB_PCDS_DYNAMIC_DEFAULT, \
 537                          TAB_PCDS_DYNAMIC_VPD, TAB_PCDS_DYNAMIC_HII]
 538 PCD_DYNAMIC_EX_TYPE_LIST = [TAB_PCDS_DYNAMIC_EX, TAB_PCDS_DYNAMIC_EX_DEFAULT, \
 539                             TAB_PCDS_DYNAMIC_EX_VPD, TAB_PCDS_DYNAMIC_EX_HII]
 540
 541 ## Dynamic-ex PCD types
 542 #
 543 gDYNAMIC_EX_PCD = [TAB_PCDS_DYNAMIC_EX, TAB_PCDS_DYNAMIC_EX_DEFAULT, \
 544                  TAB_PCDS_DYNAMIC_EX_VPD, TAB_PCDS_DYNAMIC_EX_HII]
 545
 546 TAB_PCDS_FIXED_AT_BUILD_NULL = TAB_PCDS + TAB_PCDS_FIXED_AT_BUILD
 547 TAB_PCDS_FIXED_AT_BUILD_COMMON = TAB_PCDS + TAB_PCDS_FIXED_AT_BUILD + \
 548 TAB_SPLIT + TAB_ARCH_COMMON
 549 TAB_PCDS_FIXED_AT_BUILD_IA32 = TAB_PCDS + TAB_PCDS_FIXED_AT_BUILD + \
 550 TAB_SPLIT + TAB_ARCH_IA32
 551 TAB_PCDS_FIXED_AT_BUILD_X64 = TAB_PCDS + TAB_PCDS_FIXED_AT_BUILD + \
 552 TAB_SPLIT + TAB_ARCH_X64
 553 TAB_PCDS_FIXED_AT_BUILD_IPF = TAB_PCDS + TAB_PCDS_FIXED_AT_BUILD + \
 554 TAB_SPLIT + TAB_ARCH_IPF
 555 TAB_PCDS_FIXED_AT_BUILD_ARM = TAB_PCDS + TAB_PCDS_FIXED_AT_BUILD + \
 556 TAB_SPLIT + TAB_ARCH_ARM
 557 TAB_PCDS_FIXED_AT_BUILD_EBC = TAB_PCDS + TAB_PCDS_FIXED_AT_BUILD + \
 558 TAB_SPLIT + TAB_ARCH_EBC
 559
 560 TAB_PCDS_PATCHABLE_IN_MODULE_NULL = TAB_PCDS + TAB_PCDS_PATCHABLE_IN_MODULE
 561 TAB_PCDS_PATCHABLE_IN_MODULE_COMMON = TAB_PCDS + TAB_PCDS_PATCHABLE_IN_MODULE \
 562 + TAB_SPLIT + TAB_ARCH_COMMON
 563 TAB_PCDS_PATCHABLE_IN_MODULE_IA32 = TAB_PCDS + TAB_PCDS_PATCHABLE_IN_MODULE + \
 564 TAB_SPLIT + TAB_ARCH_IA32
 565 TAB_PCDS_PATCHABLE_IN_MODULE_X64 = TAB_PCDS + TAB_PCDS_PATCHABLE_IN_MODULE + \
 566 TAB_SPLIT + TAB_ARCH_X64
 567 TAB_PCDS_PATCHABLE_IN_MODULE_IPF = TAB_PCDS + TAB_PCDS_PATCHABLE_IN_MODULE + \
 568 TAB_SPLIT + TAB_ARCH_IPF
 569 TAB_PCDS_PATCHABLE_IN_MODULE_ARM = TAB_PCDS + TAB_PCDS_PATCHABLE_IN_MODULE + \
 570 TAB_SPLIT + TAB_ARCH_ARM
 571 TAB_PCDS_PATCHABLE_IN_MODULE_EBC = TAB_PCDS + TAB_PCDS_PATCHABLE_IN_MODULE + \
 572 TAB_SPLIT + TAB_ARCH_EBC
 573
 574 TAB_PCDS_FEATURE_FLAG_NULL = TAB_PCDS + TAB_PCDS_FEATURE_FLAG
 575 TAB_PCDS_FEATURE_FLAG_COMMON = TAB_PCDS + TAB_PCDS_FEATURE_FLAG + TAB_SPLIT \
 576 + TAB_ARCH_COMMON
 577 TAB_PCDS_FEATURE_FLAG_IA32 = TAB_PCDS + TAB_PCDS_FEATURE_FLAG + TAB_SPLIT + \
 578 TAB_ARCH_IA32
 579 TAB_PCDS_FEATURE_FLAG_X64 = TAB_PCDS + TAB_PCDS_FEATURE_FLAG + TAB_SPLIT + \
 580 TAB_ARCH_X64
 581 TAB_PCDS_FEATURE_FLAG_IPF = TAB_PCDS + TAB_PCDS_FEATURE_FLAG + TAB_SPLIT + \
 582 TAB_ARCH_IPF
 583 TAB_PCDS_FEATURE_FLAG_ARM = TAB_PCDS + TAB_PCDS_FEATURE_FLAG + TAB_SPLIT + \
 584 TAB_ARCH_ARM
 585 TAB_PCDS_FEATURE_FLAG_EBC = TAB_PCDS + TAB_PCDS_FEATURE_FLAG + TAB_SPLIT + \
 586 TAB_ARCH_EBC
 587
 588 TAB_PCDS_DYNAMIC_EX_NULL = TAB_PCDS + TAB_PCDS_DYNAMIC_EX
 589 TAB_PCDS_DYNAMIC_EX_DEFAULT_NULL = TAB_PCDS + TAB_PCDS_DYNAMIC_EX_DEFAULT
 590 TAB_PCDS_DYNAMIC_EX_HII_NULL = TAB_PCDS + TAB_PCDS_DYNAMIC_EX_HII
 591 TAB_PCDS_DYNAMIC_EX_VPD_NULL = TAB_PCDS + TAB_PCDS_DYNAMIC_EX_VPD
 592 TAB_PCDS_DYNAMIC_EX_COMMON = TAB_PCDS + TAB_PCDS_DYNAMIC_EX + TAB_SPLIT + \
 593 TAB_ARCH_COMMON
 594 TAB_PCDS_DYNAMIC_EX_IA32 = TAB_PCDS + TAB_PCDS_DYNAMIC_EX + TAB_SPLIT + \
 595 TAB_ARCH_IA32
 596 TAB_PCDS_DYNAMIC_EX_X64 = TAB_PCDS + TAB_PCDS_DYNAMIC_EX + TAB_SPLIT + \
 597 TAB_ARCH_X64
 598 TAB_PCDS_DYNAMIC_EX_IPF = TAB_PCDS + TAB_PCDS_DYNAMIC_EX + TAB_SPLIT + \
 599 TAB_ARCH_IPF
 600 TAB_PCDS_DYNAMIC_EX_ARM = TAB_PCDS + TAB_PCDS_DYNAMIC_EX + TAB_SPLIT + \
 601 TAB_ARCH_ARM
 602 TAB_PCDS_DYNAMIC_EX_EBC = TAB_PCDS + TAB_PCDS_DYNAMIC_EX + TAB_SPLIT + \
 603 TAB_ARCH_EBC
 604
 605 TAB_PCDS_DYNAMIC_NULL = TAB_PCDS + TAB_PCDS_DYNAMIC
 606 TAB_PCDS_DYNAMIC_DEFAULT_NULL = TAB_PCDS + TAB_PCDS_DYNAMIC_DEFAULT
 607 TAB_PCDS_DYNAMIC_HII_NULL = TAB_PCDS + TAB_PCDS_DYNAMIC_HII
 608 TAB_PCDS_DYNAMIC_VPD_NULL = TAB_PCDS + TAB_PCDS_DYNAMIC_VPD
 609 TAB_PCDS_DYNAMIC_COMMON = TAB_PCDS + TAB_PCDS_DYNAMIC + TAB_SPLIT + \
 610 TAB_ARCH_COMMON
 611 TAB_PCDS_DYNAMIC_IA32 = TAB_PCDS + TAB_PCDS_DYNAMIC + TAB_SPLIT + TAB_ARCH_IA32
 612 TAB_PCDS_DYNAMIC_X64 = TAB_PCDS + TAB_PCDS_DYNAMIC + TAB_SPLIT + TAB_ARCH_X64
 613 TAB_PCDS_DYNAMIC_IPF = TAB_PCDS + TAB_PCDS_DYNAMIC + TAB_SPLIT + TAB_ARCH_IPF
 614 TAB_PCDS_DYNAMIC_ARM = TAB_PCDS + TAB_PCDS_DYNAMIC + TAB_SPLIT + TAB_ARCH_ARM
 615 TAB_PCDS_DYNAMIC_EBC = TAB_PCDS + TAB_PCDS_DYNAMIC + TAB_SPLIT + TAB_ARCH_EBC
 616
 617 TAB_PCD_DYNAMIC_TYPE_LIST = [TAB_PCDS_DYNAMIC_DEFAULT_NULL, \
 618                              TAB_PCDS_DYNAMIC_VPD_NULL, \
 619                              TAB_PCDS_DYNAMIC_HII_NULL]
 620 TAB_PCD_DYNAMIC_EX_TYPE_LIST = [TAB_PCDS_DYNAMIC_EX_DEFAULT_NULL, \
 621                                 TAB_PCDS_DYNAMIC_EX_VPD_NULL, \
 622                                 TAB_PCDS_DYNAMIC_EX_HII_NULL]
 623
 624 TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_PEI_PAGE_SIZE = \
 625 'PcdLoadFixAddressPeiCodePageNumber'
 626 TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_PEI_PAGE_SIZE_DATA_TYPE = 'UINT32'
 627 TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_DXE_PAGE_SIZE = \
 628 'PcdLoadFixAddressBootTimeCodePageNumber'
 629 TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_DXE_PAGE_SIZE_DATA_TYPE = 'UINT32'
 630 TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_RUNTIME_PAGE_SIZE = \
 631 'PcdLoadFixAddressRuntimeCodePageNumber'
 632 TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_RUNTIME_PAGE_SIZE_DATA_TYPE = 'UINT32'
 633 TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_SMM_PAGE_SIZE = \
 634 'PcdLoadFixAddressSmmCodePageNumber'
 635 TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_SMM_PAGE_SIZE_DATA_TYPE = 'UINT32'
 636 TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_LIST = \
 637 [TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_PEI_PAGE_SIZE, \
 638 TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_DXE_PAGE_SIZE, \
 639 TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_RUNTIME_PAGE_SIZE, \
 640 TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_SMM_PAGE_SIZE]
 641 PCD_SECTION_LIST = [TAB_PCDS_FIXED_AT_BUILD_NULL.upper(), \
 642                     TAB_PCDS_PATCHABLE_IN_MODULE_NULL.upper(), \
 643                     TAB_PCDS_FEATURE_FLAG_NULL.upper(), \
 644                     TAB_PCDS_DYNAMIC_EX_NULL.upper(), \
 645                     TAB_PCDS_DYNAMIC_NULL.upper()]
 646 INF_PCD_SECTION_LIST = ["FixedPcd".upper(), "FeaturePcd".upper(), \
 647                         "PatchPcd".upper(), "Pcd".upper(), "PcdEx".upper()]
 648
 649 TAB_DEPEX = 'Depex'
 650 TAB_DEPEX_COMMON = TAB_DEPEX + TAB_SPLIT + TAB_ARCH_COMMON
 651 TAB_DEPEX_IA32 = TAB_DEPEX + TAB_SPLIT + TAB_ARCH_IA32
 652 TAB_DEPEX_X64 = TAB_DEPEX + TAB_SPLIT + TAB_ARCH_X64
 653 TAB_DEPEX_IPF = TAB_DEPEX + TAB_SPLIT + TAB_ARCH_IPF
 654 TAB_DEPEX_ARM = TAB_DEPEX + TAB_SPLIT + TAB_ARCH_ARM
 655 TAB_DEPEX_EBC = TAB_DEPEX + TAB_SPLIT + TAB_ARCH_EBC
 656
 657 TAB_SKUIDS = 'SkuIds'
 658
 659 TAB_LIBRARIES = 'Libraries'
 660 TAB_LIBRARIES_COMMON = TAB_LIBRARIES + TAB_SPLIT + TAB_ARCH_COMMON
 661 TAB_LIBRARIES_IA32 = TAB_LIBRARIES + TAB_SPLIT + TAB_ARCH_IA32
 662 TAB_LIBRARIES_X64 = TAB_LIBRARIES + TAB_SPLIT + TAB_ARCH_X64
 663 TAB_LIBRARIES_IPF = TAB_LIBRARIES + TAB_SPLIT + TAB_ARCH_IPF
 664 TAB_LIBRARIES_ARM = TAB_LIBRARIES + TAB_SPLIT + TAB_ARCH_ARM
 665 TAB_LIBRARIES_EBC = TAB_LIBRARIES + TAB_SPLIT + TAB_ARCH_EBC
 666
 667 TAB_COMPONENTS = 'Components'
 668 TAB_COMPONENTS_COMMON = TAB_COMPONENTS + TAB_SPLIT + TAB_ARCH_COMMON
 669 TAB_COMPONENTS_IA32 = TAB_COMPONENTS + TAB_SPLIT + TAB_ARCH_IA32
 670 TAB_COMPONENTS_X64 = TAB_COMPONENTS + TAB_SPLIT + TAB_ARCH_X64
 671 TAB_COMPONENTS_IPF = TAB_COMPONENTS + TAB_SPLIT + TAB_ARCH_IPF
 672 TAB_COMPONENTS_ARM = TAB_COMPONENTS + TAB_SPLIT + TAB_ARCH_ARM
 673 TAB_COMPONENTS_EBC = TAB_COMPONENTS + TAB_SPLIT + TAB_ARCH_EBC
 674
 675 TAB_COMPONENTS_SOURCE_OVERRIDE_PATH = 'SOURCE_OVERRIDE_PATH'
 676
 677 TAB_BUILD_OPTIONS = 'BuildOptions'
 678
 679 TAB_DEFINE = 'DEFINE'
 680 TAB_NMAKE = 'Nmake'
 681 TAB_USER_EXTENSIONS = 'UserExtensions'
 682 TAB_INCLUDE = '!include'
 683 TAB_PRIVATE = 'Private'
 684 TAB_INTEL = 'Intel'
 685
 686 #
 687 # Common Define
 688 #
 689 TAB_COMMON_DEFINES = 'Defines'
 690
 691 #
 692 # Inf Definitions
 693 #
 694 TAB_INF_DEFINES = TAB_COMMON_DEFINES
 695 TAB_INF_DEFINES_INF_VERSION = 'INF_VERSION'
 696 TAB_INF_DEFINES_BASE_NAME = 'BASE_NAME'
 697 TAB_INF_DEFINES_FILE_GUID = 'FILE_GUID'
 698 TAB_INF_DEFINES_MODULE_TYPE = 'MODULE_TYPE'
 699 TAB_INF_DEFINES_EFI_SPECIFICATION_VERSION = 'EFI_SPECIFICATION_VERSION'
 700 TAB_INF_DEFINES_UEFI_SPECIFICATION_VERSION = 'UEFI_SPECIFICATION_VERSION'
 701 TAB_INF_DEFINES_PI_SPECIFICATION_VERSION = 'PI_SPECIFICATION_VERSION'
 702 TAB_INF_DEFINES_EDK_RELEASE_VERSION = 'EDK_RELEASE_VERSION'
 703 TAB_INF_DEFINES_MODULE_UNI_FILE    = 'MODULE_UNI_FILE'
 704 TAB_INF_DEFINES_BINARY_MODULE = 'BINARY_MODULE'
 705 TAB_INF_DEFINES_LIBRARY_CLASS = 'LIBRARY_CLASS'
 706 TAB_INF_DEFINES_COMPONENT_TYPE = 'COMPONENT_TYPE'
 707 TAB_INF_DEFINES_MAKEFILE_NAME = 'MAKEFILE_NAME'
 708 TAB_INF_DEFINES_BUILD_NUMBER = 'BUILD_NUMBER'
 709 TAB_INF_DEFINES_BUILD_TYPE = 'BUILD_TYPE'
 710 TAB_INF_DEFINES_FFS_EXT = 'FFS_EXT'
 711 TAB_INF_DEFINES_FV_EXT = 'FV_EXT'
 712 TAB_INF_DEFINES_SOURCE_FV = 'SOURCE_FV'
 713 TAB_INF_DEFINES_PACKAGE   = 'PACKAGE'
 714 TAB_INF_DEFINES_VERSION_NUMBER = 'VERSION_NUMBER'
 715 TAB_INF_DEFINES_VERSION = 'VERSION'
 716 TAB_INF_DEFINES_VERSION_STRING = 'VERSION_STRING'
 717 TAB_INF_DEFINES_PCD_IS_DRIVER = 'PCD_IS_DRIVER'
 718 TAB_INF_DEFINES_TIANO_EDK1_FLASHMAP_H = 'TIANO_EDK1_FLASHMAP_H'
 719 TAB_INF_DEFINES_ENTRY_POINT = 'ENTRY_POINT'
 720 TAB_INF_DEFINES_UNLOAD_IMAGE = 'UNLOAD_IMAGE'
 721 TAB_INF_DEFINES_CONSTRUCTOR = 'CONSTRUCTOR'
 722 TAB_INF_DEFINES_DESTRUCTOR = 'DESTRUCTOR'
 723 TAB_INF_DEFINES_PCI_VENDOR_ID  = 'PCI_VENDOR_ID'
 724 TAB_INF_DEFINES_PCI_DEVICE_ID  = 'PCI_DEVICE_ID'
 725 TAB_INF_DEFINES_PCI_CLASS_CODE = 'PCI_CLASS_CODE'
 726 TAB_INF_DEFINES_PCI_REVISION   = 'PCI_REVISION'
 727 TAB_INF_DEFINES_PCI_COMPRESS   = 'PCI_COMPRESS'
 728 TAB_INF_DEFINES_DEFINE = 'DEFINE'
 729 TAB_INF_DEFINES_SPEC = 'SPEC'
 730 TAB_INF_DEFINES_UEFI_HII_RESOURCE_SECTION = 'UEFI_HII_RESOURCE_SECTION'
 731 TAB_INF_DEFINES_CUSTOM_MAKEFILE = 'CUSTOM_MAKEFILE'
 732 TAB_INF_DEFINES_MACRO = '__MACROS__'
 733 TAB_INF_DEFINES_SHADOW = 'SHADOW'
 734 TAB_INF_DEFINES_DPX_SOURCE = 'DPX_SOURCE'
 735 TAB_INF_FIXED_PCD = 'FixedPcd'
 736 TAB_INF_FEATURE_PCD = 'FeaturePcd'
 737 TAB_INF_PATCH_PCD = 'PatchPcd'
 738 TAB_INF_PCD = 'Pcd'
 739 TAB_INF_PCD_EX = 'PcdEx'
 740 TAB_INF_GUIDTYPE_VAR = 'Variable'
 741 TAB_INF_ABSTRACT = 'STR_MODULE_ABSTRACT'
 742 TAB_INF_DESCRIPTION = 'STR_MODULE_DESCRIPTION'
 743 TAB_INF_LICENSE = 'STR_MODULE_LICENSE'
 744 TAB_INF_BINARY_ABSTRACT = 'STR_MODULE_BINARY_ABSTRACT'
 745 TAB_INF_BINARY_DESCRIPTION = 'STR_MODULE_BINARY_DESCRIPTION'
 746 TAB_INF_BINARY_LICENSE = 'STR_MODULE_BINARY_LICENSE'
 747 #
 748 # Dec Definitions
 749 #
 750 TAB_DEC_DEFINES = TAB_COMMON_DEFINES
 751 TAB_DEC_DEFINES_DEC_SPECIFICATION = 'DEC_SPECIFICATION'
 752 TAB_DEC_DEFINES_PACKAGE_NAME = 'PACKAGE_NAME'
 753 TAB_DEC_DEFINES_PACKAGE_GUID = 'PACKAGE_GUID'
 754 TAB_DEC_DEFINES_PACKAGE_VERSION = 'PACKAGE_VERSION'
 755 TAB_DEC_DEFINES_PKG_UNI_FILE    = 'PACKAGE_UNI_FILE'
 756 TAB_DEC_PACKAGE_ABSTRACT = 'STR_PACKAGE_ABSTRACT'
 757 TAB_DEC_PACKAGE_DESCRIPTION = 'STR_PACKAGE_DESCRIPTION'
 758 TAB_DEC_PACKAGE_LICENSE = 'STR_PACKAGE_LICENSE'
 759 TAB_DEC_BINARY_ABSTRACT = 'STR_PACKAGE_BINARY_ABSTRACT'
 760 TAB_DEC_BINARY_DESCRIPTION = 'STR_PACKAGE_BINARY_DESCRIPTION'
 761 TAB_DEC_BINARY_LICENSE = 'STR_PACKAGE_ASBUILT_LICENSE'
 762 #
 763 # Dsc Definitions
 764 #
 765 TAB_DSC_DEFINES = TAB_COMMON_DEFINES
 766 TAB_DSC_DEFINES_PLATFORM_NAME = 'PLATFORM_NAME'
 767 TAB_DSC_DEFINES_PLATFORM_GUID = 'PLATFORM_GUID'
 768 TAB_DSC_DEFINES_PLATFORM_VERSION = 'PLATFORM_VERSION'
 769 TAB_DSC_DEFINES_DSC_SPECIFICATION = 'DSC_SPECIFICATION'
 770 TAB_DSC_DEFINES_OUTPUT_DIRECTORY = 'OUTPUT_DIRECTORY'
 771 TAB_DSC_DEFINES_SUPPORTED_ARCHITECTURES = 'SUPPORTED_ARCHITECTURES'
 772 TAB_DSC_DEFINES_BUILD_TARGETS = 'BUILD_TARGETS'
 773 TAB_DSC_DEFINES_SKUID_IDENTIFIER = 'SKUID_IDENTIFIER'
 774 TAB_DSC_DEFINES_FLASH_DEFINITION = 'FLASH_DEFINITION'
 775 TAB_DSC_DEFINES_BUILD_NUMBER = 'BUILD_NUMBER'
 776 TAB_DSC_DEFINES_MAKEFILE_NAME = 'MAKEFILE_NAME'
 777 TAB_DSC_DEFINES_BS_BASE_ADDRESS = 'BsBaseAddress'
 778 TAB_DSC_DEFINES_RT_BASE_ADDRESS = 'RtBaseAddress'
 779 TAB_DSC_DEFINES_DEFINE = 'DEFINE'
 780 TAB_FIX_LOAD_TOP_MEMORY_ADDRESS = 'FIX_LOAD_TOP_MEMORY_ADDRESS'
 781
 782 #
 783 # TargetTxt Definitions
 784 #
 785 TAB_TAT_DEFINES_ACTIVE_PLATFORM = 'ACTIVE_PLATFORM'
 786 TAB_TAT_DEFINES_ACTIVE_MODULE = 'ACTIVE_MODULE'
 787 TAB_TAT_DEFINES_TOOL_CHAIN_CONF = 'TOOL_CHAIN_CONF'
 788 TAB_TAT_DEFINES_MULTIPLE_THREAD = 'MULTIPLE_THREAD'
 789 TAB_TAT_DEFINES_MAX_CONCURRENT_THREAD_NUMBER = 'MAX_CONCURRENT_THREAD_NUMBER'
 790 TAB_TAT_DEFINES_TARGET = 'TARGET'
 791 TAB_TAT_DEFINES_TOOL_CHAIN_TAG = 'TOOL_CHAIN_TAG'
 792 TAB_TAT_DEFINES_TARGET_ARCH = 'TARGET_ARCH'
 793 TAB_TAT_DEFINES_BUILD_RULE_CONF = "BUILD_RULE_CONF"
 794
 795 #
 796 # ToolDef Definitions
 797 #
 798 TAB_TOD_DEFINES_TARGET = 'TARGET'
 799 TAB_TOD_DEFINES_TOOL_CHAIN_TAG = 'TOOL_CHAIN_TAG'
 800 TAB_TOD_DEFINES_TARGET_ARCH = 'TARGET_ARCH'
 801 TAB_TOD_DEFINES_COMMAND_TYPE = 'COMMAND_TYPE'
 802 TAB_TOD_DEFINES_FAMILY = 'FAMILY'
 803 TAB_TOD_DEFINES_BUILDRULEFAMILY = 'BUILDRULEFAMILY'
 804
 805 #
 806 # Conditional Statements
 807 #
 808 TAB_IF = '!if'
 809 TAB_END_IF = '!endif'
 810 TAB_ELSE_IF = '!elseif'
 811 TAB_ELSE = '!else'
 812 TAB_IF_DEF = '!ifdef'
 813 TAB_IF_N_DEF = '!ifndef'
 814 TAB_IF_EXIST = '!if exist'
 815
 816 #
 817 # Unknown section
 818 #
 819 TAB_UNKNOWN = 'UNKNOWN'
 820
 821 #
 822 # Header section (virtual section for abstract, description, copyright,
 823 # license)
 824 #
 825 TAB_HEADER = 'Header'
 826 TAB_HEADER_ABSTRACT = 'Abstract'
 827 TAB_HEADER_DESCRIPTION = 'Description'
 828 TAB_HEADER_COPYRIGHT = 'Copyright'
 829 TAB_HEADER_LICENSE = 'License'
 830 TAB_BINARY_HEADER_IDENTIFIER = 'BinaryHeader'
 831 TAB_BINARY_HEADER_USERID = 'TianoCore'
 832
 833 #
 834 # Build database path
 835 #
 836 DATABASE_PATH = ":memory:"
 837 #
 838 # used by ECC
 839 #
 840 MODIFIER_LIST = ['IN', 'OUT', 'OPTIONAL', 'UNALIGNED', 'EFI_RUNTIMESERVICE', \
 841                  'EFI_BOOTSERVICE', 'EFIAPI']
 842 #
 843 # Dependency Expression
 844 #
 845 DEPEX_SUPPORTED_OPCODE = ["BEFORE", "AFTER", "PUSH", "AND", "OR", "NOT", \
 846                           "END", "SOR", "TRUE", "FALSE", '(', ')']
 847
 848 TAB_STATIC_LIBRARY = "STATIC-LIBRARY-FILE"
 849 TAB_DYNAMIC_LIBRARY = "DYNAMIC-LIBRARY-FILE"
 850 TAB_FRAMEWORK_IMAGE = "EFI-IMAGE-FILE"
 851 TAB_C_CODE_FILE = "C-CODE-FILE"
 852 TAB_C_HEADER_FILE = "C-HEADER-FILE"
 853 TAB_UNICODE_FILE = "UNICODE-TEXT-FILE"
 854 TAB_DEPENDENCY_EXPRESSION_FILE = "DEPENDENCY-EXPRESSION-FILE"
 855 TAB_UNKNOWN_FILE = "UNKNOWN-TYPE-FILE"
 856 TAB_DEFAULT_BINARY_FILE = "_BINARY_FILE_"
 857 #
 858 # used to indicate the state of processing header comment section of dec,
 859 # inf files
 860 #
 861 HEADER_COMMENT_NOT_STARTED = -1
 862 HEADER_COMMENT_STARTED     = 0
 863 HEADER_COMMENT_FILE        = 1
 864 HEADER_COMMENT_ABSTRACT    = 2
 865 HEADER_COMMENT_DESCRIPTION = 3
 866 HEADER_COMMENT_COPYRIGHT   = 4
 867 HEADER_COMMENT_LICENSE     = 5
 868 HEADER_COMMENT_END         = 6
 869
 870 #
 871 # Static values for data models
 872 #
 873 MODEL_UNKNOWN = 0
 874
 875 MODEL_FILE_C = 1001
 876 MODEL_FILE_H = 1002
 877 MODEL_FILE_ASM = 1003
 878 MODEL_FILE_INF = 1011
 879 MODEL_FILE_DEC = 1012
 880 MODEL_FILE_DSC = 1013
 881 MODEL_FILE_FDF = 1014
 882 MODEL_FILE_INC = 1015
 883 MODEL_FILE_CIF = 1016
 884
 885 MODEL_IDENTIFIER_FILE_HEADER = 2001
 886 MODEL_IDENTIFIER_FUNCTION_HEADER = 2002
 887 MODEL_IDENTIFIER_COMMENT = 2003
 888 MODEL_IDENTIFIER_PARAMETER = 2004
 889 MODEL_IDENTIFIER_STRUCTURE = 2005
 890 MODEL_IDENTIFIER_VARIABLE = 2006
 891 MODEL_IDENTIFIER_INCLUDE = 2007
 892 MODEL_IDENTIFIER_PREDICATE_EXPRESSION = 2008
 893 MODEL_IDENTIFIER_ENUMERATE = 2009
 894 MODEL_IDENTIFIER_PCD = 2010
 895 MODEL_IDENTIFIER_UNION = 2011
 896 MODEL_IDENTIFIER_MACRO_IFDEF = 2012
 897 MODEL_IDENTIFIER_MACRO_IFNDEF = 2013
 898 MODEL_IDENTIFIER_MACRO_DEFINE = 2014
 899 MODEL_IDENTIFIER_MACRO_ENDIF = 2015
 900 MODEL_IDENTIFIER_MACRO_PROGMA = 2016
 901 MODEL_IDENTIFIER_FUNCTION_CALLING = 2018
 902 MODEL_IDENTIFIER_TYPEDEF = 2017
 903 MODEL_IDENTIFIER_FUNCTION_DECLARATION = 2019
 904 MODEL_IDENTIFIER_ASSIGNMENT_EXPRESSION = 2020
 905
 906 MODEL_EFI_PROTOCOL = 3001
 907 MODEL_EFI_PPI = 3002
 908 MODEL_EFI_GUID = 3003
 909 MODEL_EFI_LIBRARY_CLASS = 3004
 910 MODEL_EFI_LIBRARY_INSTANCE = 3005
 911 MODEL_EFI_PCD = 3006
 912 MODEL_EFI_SOURCE_FILE = 3007
 913 MODEL_EFI_BINARY_FILE = 3008
 914 MODEL_EFI_SKU_ID = 3009
 915 MODEL_EFI_INCLUDE = 3010
 916 MODEL_EFI_DEPEX = 3011
 917
 918 MODEL_PCD = 4000
 919 MODEL_PCD_FIXED_AT_BUILD = 4001
 920 MODEL_PCD_PATCHABLE_IN_MODULE = 4002
 921 MODEL_PCD_FEATURE_FLAG = 4003
 922 MODEL_PCD_DYNAMIC_EX = 4004
 923 MODEL_PCD_DYNAMIC_EX_DEFAULT = 4005
 924 MODEL_PCD_DYNAMIC_EX_VPD = 4006
 925 MODEL_PCD_DYNAMIC_EX_HII = 4007
 926 MODEL_PCD_DYNAMIC = 4008
 927 MODEL_PCD_DYNAMIC_DEFAULT = 4009
 928 MODEL_PCD_DYNAMIC_VPD = 4010
 929 MODEL_PCD_DYNAMIC_HII = 4011
 930
 931 MODEL_META_DATA_FILE_HEADER = 5000
 932 MODEL_META_DATA_HEADER = 5001
 933 MODEL_META_DATA_INCLUDE = 5002
 934 MODEL_META_DATA_DEFINE = 5003
 935 MODEL_META_DATA_CONDITIONAL_STATEMENT_IF = 5004
 936 MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSE = 5005
 937 MODEL_META_DATA_CONDITIONAL_STATEMENT_IFDEF = 5006
 938 MODEL_META_DATA_CONDITIONAL_STATEMENT_IFNDEF = 5007
 939 MODEL_META_DATA_BUILD_OPTION = 5008
 940 MODEL_META_DATA_COMPONENT = 5009
 941 MODEL_META_DATA_USER_EXTENSION = 5010
 942 MODEL_META_DATA_PACKAGE = 5011
 943 MODEL_META_DATA_NMAKE = 5012
 944 MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSEIF = 50013
 945 MODEL_META_DATA_CONDITIONAL_STATEMENT_ENDIF = 5014
 946 MODEL_META_DATA_COMPONENT_SOURCE_OVERRIDE_PATH = 5015
 947
 948 TOOL_FAMILY_LIST = ["MSFT",
 949                     "INTEL",
 950                     "GCC",
 951                     "RVCT"
 952                     ]
 953
 954 TYPE_HOB_SECTION = 'HOB'
 955 TYPE_EVENT_SECTION = 'EVENT'
 956 TYPE_BOOTMODE_SECTION = 'BOOTMODE'
 957
 958 PCD_ERR_CODE_MAX_SIZE = 4294967295