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