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