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