[mirror_edk2.git] / BaseTools / Source / Python / Common / DataType.py

## @file\r
# This file is used to define common static strings used by INF/DEC/DSC files\r
#\r
# Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
# Portions copyright (c) 2011 - 2013, ARM Ltd. All rights reserved.<BR>\r
# This program and the accompanying materials\r
# are licensed and made available under the terms and conditions of the BSD License\r
# which accompanies this distribution.  The full text of the license may be found at\r
# http://opensource.org/licenses/bsd-license.php\r
#\r
# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
##\r
# Common Definitions\r
#\r
TAB_SPLIT = '.'\r
TAB_COMMENT_EDK_START = '/*'\r
TAB_COMMENT_EDK_END = '*/'\r
TAB_COMMENT_EDK_SPLIT = '//'\r
TAB_COMMENT_SPLIT = '#'\r
TAB_SPECIAL_COMMENT = '##'\r
TAB_EQUAL_SPLIT = '='\r
TAB_VALUE_SPLIT = '|'\r
TAB_COMMA_SPLIT = ','\r
TAB_SPACE_SPLIT = ' '\r
TAB_SEMI_COLON_SPLIT = ';'\r
TAB_SECTION_START = '['\r
TAB_SECTION_END = ']'\r
TAB_OPTION_START = '<'\r
TAB_OPTION_END = '>'\r
TAB_SLASH = '\\'\r
TAB_BACK_SLASH = '/'\r
TAB_LINE_BREAK = '\n'\r
TAB_PRINTCHAR_VT = '\x0b'\r
TAB_PRINTCHAR_BS = '\b'\r
TAB_PRINTCHAR_NUL = '\0'\r
TAB_UINT8 = 'UINT8'\r
TAB_UINT16 = 'UINT16'\r
TAB_UINT32 = 'UINT32'\r
TAB_UINT64 = 'UINT64'\r
TAB_VOID = 'VOID*'\r
\r
TAB_PCD_CLEAN_NUMERIC_TYPES = {TAB_UINT8, TAB_UINT16, TAB_UINT32, TAB_UINT64}\r
TAB_PCD_NUMERIC_TYPES = {TAB_UINT8, TAB_UINT16, TAB_UINT32, TAB_UINT64, 'BOOLEAN'}\r
TAB_PCD_NUMERIC_TYPES_VOID = {TAB_UINT8, TAB_UINT16, TAB_UINT32, TAB_UINT64, 'BOOLEAN', TAB_VOID}\r
\r
TAB_EDK_SOURCE = '$(EDK_SOURCE)'\r
TAB_EFI_SOURCE = '$(EFI_SOURCE)'\r
TAB_WORKSPACE = '$(WORKSPACE)'\r
\r
TAB_ARCH_NULL = ''\r
TAB_ARCH_COMMON = 'COMMON'\r
TAB_ARCH_IA32 = 'IA32'\r
TAB_ARCH_X64 = 'X64'\r
TAB_ARCH_IPF = 'IPF'\r
TAB_ARCH_ARM = 'ARM'\r
TAB_ARCH_EBC = 'EBC'\r
TAB_ARCH_AARCH64 = 'AARCH64'\r
\r
ARCH_LIST = [TAB_ARCH_IA32, TAB_ARCH_X64, TAB_ARCH_IPF, TAB_ARCH_ARM, TAB_ARCH_EBC, TAB_ARCH_AARCH64]\r
ARCH_LIST_FULL = [TAB_ARCH_COMMON] + ARCH_LIST\r
\r
SUP_MODULE_BASE = 'BASE'\r
SUP_MODULE_SEC = 'SEC'\r
SUP_MODULE_PEI_CORE = 'PEI_CORE'\r
SUP_MODULE_PEIM = 'PEIM'\r
SUP_MODULE_DXE_CORE = 'DXE_CORE'\r
SUP_MODULE_DXE_DRIVER = 'DXE_DRIVER'\r
SUP_MODULE_DXE_RUNTIME_DRIVER = 'DXE_RUNTIME_DRIVER'\r
SUP_MODULE_DXE_SAL_DRIVER = 'DXE_SAL_DRIVER'\r
SUP_MODULE_DXE_SMM_DRIVER = 'DXE_SMM_DRIVER'\r
SUP_MODULE_UEFI_DRIVER = 'UEFI_DRIVER'\r
SUP_MODULE_UEFI_APPLICATION = 'UEFI_APPLICATION'\r
SUP_MODULE_USER_DEFINED = 'USER_DEFINED'\r
SUP_MODULE_SMM_CORE = 'SMM_CORE'\r
SUP_MODULE_MM_STANDALONE = 'MM_STANDALONE'\r
SUP_MODULE_MM_CORE_STANDALONE = 'MM_CORE_STANDALONE'\r
\r
SUP_MODULE_LIST = [SUP_MODULE_BASE, SUP_MODULE_SEC, SUP_MODULE_PEI_CORE, SUP_MODULE_PEIM, SUP_MODULE_DXE_CORE, SUP_MODULE_DXE_DRIVER, \\r
                   SUP_MODULE_DXE_RUNTIME_DRIVER, SUP_MODULE_DXE_SAL_DRIVER, SUP_MODULE_DXE_SMM_DRIVER, SUP_MODULE_UEFI_DRIVER, \\r
                   SUP_MODULE_UEFI_APPLICATION, SUP_MODULE_USER_DEFINED, SUP_MODULE_SMM_CORE, SUP_MODULE_MM_STANDALONE, SUP_MODULE_MM_CORE_STANDALONE]\r
SUP_MODULE_LIST_STRING = TAB_VALUE_SPLIT.join(SUP_MODULE_LIST)\r
SUP_MODULE_SET_PEI = {SUP_MODULE_PEIM, SUP_MODULE_PEI_CORE}\r
\r
EDK_COMPONENT_TYPE_LIBRARY = 'LIBRARY'\r
EDK_COMPONENT_TYPE_SECUARITY_CORE = 'SECUARITY_CORE'\r
EDK_COMPONENT_TYPE_PEI_CORE = SUP_MODULE_PEI_CORE\r
EDK_COMPONENT_TYPE_COMBINED_PEIM_DRIVER = 'COMBINED_PEIM_DRIVER'\r
EDK_COMPONENT_TYPE_PIC_PEIM = 'PIC_PEIM'\r
EDK_COMPONENT_TYPE_RELOCATABLE_PEIM = 'RELOCATABLE_PEIM'\r
EDK_COMPONENT_TYPE_BS_DRIVER = 'BS_DRIVER'\r
EDK_COMPONENT_TYPE_RT_DRIVER = 'RT_DRIVER'\r
EDK_COMPONENT_TYPE_SAL_RT_DRIVER = 'SAL_RT_DRIVER'\r
EDK_COMPONENT_TYPE_APPLICATION = 'APPLICATION'\r
EDK_NAME = 'EDK'\r
EDKII_NAME = 'EDKII'\r
\r
BINARY_FILE_TYPE_FW = 'FW'\r
BINARY_FILE_TYPE_GUID = 'GUID'\r
BINARY_FILE_TYPE_PREEFORM = 'PREEFORM'\r
BINARY_FILE_TYPE_UEFI_APP = 'UEFI_APP'\r
BINARY_FILE_TYPE_UNI_UI = 'UNI_UI'\r
BINARY_FILE_TYPE_UNI_VER = 'UNI_VER'\r
BINARY_FILE_TYPE_LIB = 'LIB'\r
BINARY_FILE_TYPE_PE32 = 'PE32'\r
BINARY_FILE_TYPE_PIC = 'PIC'\r
BINARY_FILE_TYPE_PEI_DEPEX = 'PEI_DEPEX'\r
BINARY_FILE_TYPE_DXE_DEPEX = 'DXE_DEPEX'\r
BINARY_FILE_TYPE_SMM_DEPEX = 'SMM_DEPEX'\r
BINARY_FILE_TYPE_TE = 'TE'\r
BINARY_FILE_TYPE_VER = 'VER'\r
BINARY_FILE_TYPE_UI = 'UI'\r
BINARY_FILE_TYPE_BIN = 'BIN'\r
BINARY_FILE_TYPE_FV = 'FV'\r
\r
PLATFORM_COMPONENT_TYPE_LIBRARY = 'LIBRARY'\r
PLATFORM_COMPONENT_TYPE_LIBRARY_CLASS = 'LIBRARY_CLASS'\r
PLATFORM_COMPONENT_TYPE_MODULE = 'MODULE'\r
\r
TAB_SOURCES = 'Sources'\r
TAB_SOURCES_COMMON = TAB_SOURCES + TAB_SPLIT + TAB_ARCH_COMMON\r
TAB_SOURCES_IA32 = TAB_SOURCES + TAB_SPLIT + TAB_ARCH_IA32\r
TAB_SOURCES_X64 = TAB_SOURCES + TAB_SPLIT + TAB_ARCH_X64\r
TAB_SOURCES_IPF = TAB_SOURCES + TAB_SPLIT + TAB_ARCH_IPF\r
TAB_SOURCES_ARM = TAB_SOURCES + TAB_SPLIT + TAB_ARCH_ARM\r
TAB_SOURCES_EBC = TAB_SOURCES + TAB_SPLIT + TAB_ARCH_EBC\r
TAB_SOURCES_AARCH64 = TAB_SOURCES + TAB_SPLIT + TAB_ARCH_AARCH64\r
\r
TAB_BINARIES = 'Binaries'\r
TAB_BINARIES_COMMON = TAB_BINARIES + TAB_SPLIT + TAB_ARCH_COMMON\r
TAB_BINARIES_IA32 = TAB_BINARIES + TAB_SPLIT + TAB_ARCH_IA32\r
TAB_BINARIES_X64 = TAB_BINARIES + TAB_SPLIT + TAB_ARCH_X64\r
TAB_BINARIES_IPF = TAB_BINARIES + TAB_SPLIT + TAB_ARCH_IPF\r
TAB_BINARIES_ARM = TAB_BINARIES + TAB_SPLIT + TAB_ARCH_ARM\r
TAB_BINARIES_EBC = TAB_BINARIES + TAB_SPLIT + TAB_ARCH_EBC\r
TAB_BINARIES_AARCH64 = TAB_BINARIES + TAB_SPLIT + TAB_ARCH_AARCH64\r
\r
TAB_INCLUDES = 'Includes'\r
TAB_INCLUDES_COMMON = TAB_INCLUDES + TAB_SPLIT + TAB_ARCH_COMMON\r
TAB_INCLUDES_IA32 = TAB_INCLUDES + TAB_SPLIT + TAB_ARCH_IA32\r
TAB_INCLUDES_X64 = TAB_INCLUDES + TAB_SPLIT + TAB_ARCH_X64\r
TAB_INCLUDES_IPF = TAB_INCLUDES + TAB_SPLIT + TAB_ARCH_IPF\r
TAB_INCLUDES_ARM = TAB_INCLUDES + TAB_SPLIT + TAB_ARCH_ARM\r
TAB_INCLUDES_EBC = TAB_INCLUDES + TAB_SPLIT + TAB_ARCH_EBC\r
TAB_INCLUDES_AARCH64 = TAB_INCLUDES + TAB_SPLIT + TAB_ARCH_AARCH64\r
\r
TAB_GUIDS = 'Guids'\r
TAB_GUIDS_COMMON = TAB_GUIDS + TAB_SPLIT + TAB_ARCH_COMMON\r
TAB_GUIDS_IA32 = TAB_GUIDS + TAB_SPLIT + TAB_ARCH_IA32\r
TAB_GUIDS_X64 = TAB_GUIDS + TAB_SPLIT + TAB_ARCH_X64\r
TAB_GUIDS_IPF = TAB_GUIDS + TAB_SPLIT + TAB_ARCH_IPF\r
TAB_GUIDS_ARM = TAB_GUIDS + TAB_SPLIT + TAB_ARCH_ARM\r
TAB_GUIDS_EBC = TAB_GUIDS + TAB_SPLIT + TAB_ARCH_EBC\r
TAB_GUIDS_AARCH64 = TAB_GUIDS + TAB_SPLIT + TAB_ARCH_AARCH64\r
\r
TAB_PROTOCOLS = 'Protocols'\r
TAB_PROTOCOLS_COMMON = TAB_PROTOCOLS + TAB_SPLIT + TAB_ARCH_COMMON\r
TAB_PROTOCOLS_IA32 = TAB_PROTOCOLS + TAB_SPLIT + TAB_ARCH_IA32\r
TAB_PROTOCOLS_X64 = TAB_PROTOCOLS + TAB_SPLIT + TAB_ARCH_X64\r
TAB_PROTOCOLS_IPF = TAB_PROTOCOLS + TAB_SPLIT + TAB_ARCH_IPF\r
TAB_PROTOCOLS_ARM = TAB_PROTOCOLS + TAB_SPLIT + TAB_ARCH_ARM\r
TAB_PROTOCOLS_EBC = TAB_PROTOCOLS + TAB_SPLIT + TAB_ARCH_EBC\r
TAB_PROTOCOLS_AARCH64 = TAB_PROTOCOLS + TAB_SPLIT + TAB_ARCH_AARCH64\r
\r
TAB_PPIS = 'Ppis'\r
TAB_PPIS_COMMON = TAB_PPIS + TAB_SPLIT + TAB_ARCH_COMMON\r
TAB_PPIS_IA32 = TAB_PPIS + TAB_SPLIT + TAB_ARCH_IA32\r
TAB_PPIS_X64 = TAB_PPIS + TAB_SPLIT + TAB_ARCH_X64\r
TAB_PPIS_IPF = TAB_PPIS + TAB_SPLIT + TAB_ARCH_IPF\r
TAB_PPIS_ARM = TAB_PPIS + TAB_SPLIT + TAB_ARCH_ARM\r
TAB_PPIS_EBC = TAB_PPIS + TAB_SPLIT + TAB_ARCH_EBC\r
TAB_PPIS_AARCH64 = TAB_PPIS + TAB_SPLIT + TAB_ARCH_AARCH64\r
\r
TAB_LIBRARY_CLASSES = 'LibraryClasses'\r
TAB_LIBRARY_CLASSES_COMMON = TAB_LIBRARY_CLASSES + TAB_SPLIT + TAB_ARCH_COMMON\r
TAB_LIBRARY_CLASSES_IA32 = TAB_LIBRARY_CLASSES + TAB_SPLIT + TAB_ARCH_IA32\r
TAB_LIBRARY_CLASSES_X64 = TAB_LIBRARY_CLASSES + TAB_SPLIT + TAB_ARCH_X64\r
TAB_LIBRARY_CLASSES_IPF = TAB_LIBRARY_CLASSES + TAB_SPLIT + TAB_ARCH_IPF\r
TAB_LIBRARY_CLASSES_ARM = TAB_LIBRARY_CLASSES + TAB_SPLIT + TAB_ARCH_ARM\r
TAB_LIBRARY_CLASSES_EBC = TAB_LIBRARY_CLASSES + TAB_SPLIT + TAB_ARCH_EBC\r
TAB_LIBRARY_CLASSES_AARCH64 = TAB_LIBRARY_CLASSES + TAB_SPLIT + TAB_ARCH_AARCH64\r
\r
TAB_PACKAGES = 'Packages'\r
TAB_PACKAGES_COMMON = TAB_PACKAGES + TAB_SPLIT + TAB_ARCH_COMMON\r
TAB_PACKAGES_IA32 = TAB_PACKAGES + TAB_SPLIT + TAB_ARCH_IA32\r
TAB_PACKAGES_X64 = TAB_PACKAGES + TAB_SPLIT + TAB_ARCH_X64\r
TAB_PACKAGES_IPF = TAB_PACKAGES + TAB_SPLIT + TAB_ARCH_IPF\r
TAB_PACKAGES_ARM = TAB_PACKAGES + TAB_SPLIT + TAB_ARCH_ARM\r
TAB_PACKAGES_EBC = TAB_PACKAGES + TAB_SPLIT + TAB_ARCH_EBC\r
TAB_PACKAGES_AARCH64 = TAB_PACKAGES + TAB_SPLIT + TAB_ARCH_AARCH64\r
\r
TAB_PCDS = 'Pcds'\r
TAB_PCDS_FIXED_AT_BUILD = 'FixedAtBuild'\r
TAB_PCDS_PATCHABLE_IN_MODULE = 'PatchableInModule'\r
TAB_PCDS_FEATURE_FLAG = 'FeatureFlag'\r
TAB_PCDS_DYNAMIC_EX = 'DynamicEx'\r
TAB_PCDS_DYNAMIC_EX_DEFAULT = 'DynamicExDefault'\r
TAB_PCDS_DYNAMIC_EX_VPD = 'DynamicExVpd'\r
TAB_PCDS_DYNAMIC_EX_HII = 'DynamicExHii'\r
TAB_PCDS_DYNAMIC = 'Dynamic'\r
TAB_PCDS_DYNAMIC_DEFAULT = 'DynamicDefault'\r
TAB_PCDS_DYNAMIC_VPD = 'DynamicVpd'\r
TAB_PCDS_DYNAMIC_HII = 'DynamicHii'\r
\r
PCD_DYNAMIC_TYPE_LIST = [TAB_PCDS_DYNAMIC, TAB_PCDS_DYNAMIC_DEFAULT, TAB_PCDS_DYNAMIC_VPD, TAB_PCDS_DYNAMIC_HII]\r
PCD_DYNAMIC_EX_TYPE_LIST = [TAB_PCDS_DYNAMIC_EX, TAB_PCDS_DYNAMIC_EX_DEFAULT, TAB_PCDS_DYNAMIC_EX_VPD, TAB_PCDS_DYNAMIC_EX_HII]\r
\r
## Dynamic-ex PCD types\r
gDynamicExPcd = [TAB_PCDS_DYNAMIC_EX, TAB_PCDS_DYNAMIC_EX_DEFAULT, TAB_PCDS_DYNAMIC_EX_VPD, TAB_PCDS_DYNAMIC_EX_HII]\r
\r
TAB_PCDS_FIXED_AT_BUILD_NULL = TAB_PCDS + TAB_PCDS_FIXED_AT_BUILD\r
TAB_PCDS_FIXED_AT_BUILD_COMMON = TAB_PCDS + TAB_PCDS_FIXED_AT_BUILD + TAB_SPLIT + TAB_ARCH_COMMON\r
TAB_PCDS_FIXED_AT_BUILD_IA32 = TAB_PCDS + TAB_PCDS_FIXED_AT_BUILD + TAB_SPLIT + TAB_ARCH_IA32\r
TAB_PCDS_FIXED_AT_BUILD_X64 = TAB_PCDS + TAB_PCDS_FIXED_AT_BUILD + TAB_SPLIT + TAB_ARCH_X64\r
TAB_PCDS_FIXED_AT_BUILD_IPF = TAB_PCDS + TAB_PCDS_FIXED_AT_BUILD + TAB_SPLIT + TAB_ARCH_IPF\r
TAB_PCDS_FIXED_AT_BUILD_ARM = TAB_PCDS + TAB_PCDS_FIXED_AT_BUILD + TAB_SPLIT + TAB_ARCH_ARM\r
TAB_PCDS_FIXED_AT_BUILD_EBC = TAB_PCDS + TAB_PCDS_FIXED_AT_BUILD + TAB_SPLIT + TAB_ARCH_EBC\r
TAB_PCDS_FIXED_AT_BUILD_AARCH64 = TAB_PCDS + TAB_PCDS_FIXED_AT_BUILD + TAB_SPLIT + TAB_ARCH_AARCH64\r
\r
TAB_PCDS_PATCHABLE_IN_MODULE_NULL = TAB_PCDS + TAB_PCDS_PATCHABLE_IN_MODULE\r
TAB_PCDS_PATCHABLE_IN_MODULE_COMMON = TAB_PCDS + TAB_PCDS_PATCHABLE_IN_MODULE + TAB_SPLIT + TAB_ARCH_COMMON\r
TAB_PCDS_PATCHABLE_IN_MODULE_IA32 = TAB_PCDS + TAB_PCDS_PATCHABLE_IN_MODULE + TAB_SPLIT + TAB_ARCH_IA32\r
TAB_PCDS_PATCHABLE_IN_MODULE_X64 = TAB_PCDS + TAB_PCDS_PATCHABLE_IN_MODULE + TAB_SPLIT + TAB_ARCH_X64\r
TAB_PCDS_PATCHABLE_IN_MODULE_IPF = TAB_PCDS + TAB_PCDS_PATCHABLE_IN_MODULE + TAB_SPLIT + TAB_ARCH_IPF\r
TAB_PCDS_PATCHABLE_IN_MODULE_ARM = TAB_PCDS + TAB_PCDS_PATCHABLE_IN_MODULE + TAB_SPLIT + TAB_ARCH_ARM\r
TAB_PCDS_PATCHABLE_IN_MODULE_EBC = TAB_PCDS + TAB_PCDS_PATCHABLE_IN_MODULE + TAB_SPLIT + TAB_ARCH_EBC\r
TAB_PCDS_PATCHABLE_IN_MODULE_AARCH64 = TAB_PCDS + TAB_PCDS_PATCHABLE_IN_MODULE + TAB_SPLIT + TAB_ARCH_AARCH64\r
\r
TAB_PCDS_FEATURE_FLAG_NULL = TAB_PCDS + TAB_PCDS_FEATURE_FLAG\r
TAB_PCDS_FEATURE_FLAG_COMMON = TAB_PCDS + TAB_PCDS_FEATURE_FLAG + TAB_SPLIT + TAB_ARCH_COMMON\r
TAB_PCDS_FEATURE_FLAG_IA32 = TAB_PCDS + TAB_PCDS_FEATURE_FLAG + TAB_SPLIT + TAB_ARCH_IA32\r
TAB_PCDS_FEATURE_FLAG_X64 = TAB_PCDS + TAB_PCDS_FEATURE_FLAG + TAB_SPLIT + TAB_ARCH_X64\r
TAB_PCDS_FEATURE_FLAG_IPF = TAB_PCDS + TAB_PCDS_FEATURE_FLAG + TAB_SPLIT + TAB_ARCH_IPF\r
TAB_PCDS_FEATURE_FLAG_ARM = TAB_PCDS + TAB_PCDS_FEATURE_FLAG + TAB_SPLIT + TAB_ARCH_ARM\r
TAB_PCDS_FEATURE_FLAG_EBC = TAB_PCDS + TAB_PCDS_FEATURE_FLAG + TAB_SPLIT + TAB_ARCH_EBC\r
TAB_PCDS_FEATURE_FLAG_AARCH64 = TAB_PCDS + TAB_PCDS_FEATURE_FLAG + TAB_SPLIT + TAB_ARCH_AARCH64\r
\r
TAB_PCDS_DYNAMIC_EX_NULL = TAB_PCDS + TAB_PCDS_DYNAMIC_EX\r
TAB_PCDS_DYNAMIC_EX_DEFAULT_NULL = TAB_PCDS + TAB_PCDS_DYNAMIC_EX_DEFAULT\r
TAB_PCDS_DYNAMIC_EX_HII_NULL = TAB_PCDS + TAB_PCDS_DYNAMIC_EX_HII\r
TAB_PCDS_DYNAMIC_EX_VPD_NULL = TAB_PCDS + TAB_PCDS_DYNAMIC_EX_VPD\r
TAB_PCDS_DYNAMIC_EX_COMMON = TAB_PCDS + TAB_PCDS_DYNAMIC_EX + TAB_SPLIT + TAB_ARCH_COMMON\r
TAB_PCDS_DYNAMIC_EX_IA32 = TAB_PCDS + TAB_PCDS_DYNAMIC_EX + TAB_SPLIT + TAB_ARCH_IA32\r
TAB_PCDS_DYNAMIC_EX_X64 = TAB_PCDS + TAB_PCDS_DYNAMIC_EX + TAB_SPLIT + TAB_ARCH_X64\r
TAB_PCDS_DYNAMIC_EX_IPF = TAB_PCDS + TAB_PCDS_DYNAMIC_EX + TAB_SPLIT + TAB_ARCH_IPF\r
TAB_PCDS_DYNAMIC_EX_ARM = TAB_PCDS + TAB_PCDS_DYNAMIC_EX + TAB_SPLIT + TAB_ARCH_ARM\r
TAB_PCDS_DYNAMIC_EX_EBC = TAB_PCDS + TAB_PCDS_DYNAMIC_EX + TAB_SPLIT + TAB_ARCH_EBC\r
TAB_PCDS_DYNAMIC_EX_AARCH64 = TAB_PCDS + TAB_PCDS_DYNAMIC_EX + TAB_SPLIT + TAB_ARCH_AARCH64\r
\r
TAB_PCDS_DYNAMIC_NULL = TAB_PCDS + TAB_PCDS_DYNAMIC\r
TAB_PCDS_DYNAMIC_DEFAULT_NULL = TAB_PCDS + TAB_PCDS_DYNAMIC_DEFAULT\r
TAB_PCDS_DYNAMIC_HII_NULL = TAB_PCDS + TAB_PCDS_DYNAMIC_HII\r
TAB_PCDS_DYNAMIC_VPD_NULL = TAB_PCDS + TAB_PCDS_DYNAMIC_VPD\r
TAB_PCDS_DYNAMIC_COMMON = TAB_PCDS + TAB_PCDS_DYNAMIC + TAB_SPLIT + TAB_ARCH_COMMON\r
TAB_PCDS_DYNAMIC_IA32 = TAB_PCDS + TAB_PCDS_DYNAMIC + TAB_SPLIT + TAB_ARCH_IA32\r
TAB_PCDS_DYNAMIC_X64 = TAB_PCDS + TAB_PCDS_DYNAMIC + TAB_SPLIT + TAB_ARCH_X64\r
TAB_PCDS_DYNAMIC_IPF = TAB_PCDS + TAB_PCDS_DYNAMIC + TAB_SPLIT + TAB_ARCH_IPF\r
TAB_PCDS_DYNAMIC_ARM = TAB_PCDS + TAB_PCDS_DYNAMIC + TAB_SPLIT + TAB_ARCH_ARM\r
TAB_PCDS_DYNAMIC_EBC = TAB_PCDS + TAB_PCDS_DYNAMIC + TAB_SPLIT + TAB_ARCH_EBC\r
TAB_PCDS_DYNAMIC_AARCH64 = TAB_PCDS + TAB_PCDS_DYNAMIC + TAB_SPLIT + TAB_ARCH_AARCH64\r
\r
TAB_PCD_DYNAMIC_TYPE_LIST = [TAB_PCDS_DYNAMIC_DEFAULT_NULL, TAB_PCDS_DYNAMIC_VPD_NULL, TAB_PCDS_DYNAMIC_HII_NULL]\r
TAB_PCD_DYNAMIC_EX_TYPE_LIST = [TAB_PCDS_DYNAMIC_EX_DEFAULT_NULL, TAB_PCDS_DYNAMIC_EX_VPD_NULL, TAB_PCDS_DYNAMIC_EX_HII_NULL]\r
\r
TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_PEI_PAGE_SIZE = 'PcdLoadFixAddressPeiCodePageNumber'\r
TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_PEI_PAGE_SIZE_DATA_TYPE = 'UINT32'\r
TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_DXE_PAGE_SIZE = 'PcdLoadFixAddressBootTimeCodePageNumber'\r
TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_DXE_PAGE_SIZE_DATA_TYPE = 'UINT32'\r
TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_RUNTIME_PAGE_SIZE = 'PcdLoadFixAddressRuntimeCodePageNumber'\r
TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_RUNTIME_PAGE_SIZE_DATA_TYPE = 'UINT32'\r
TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_SMM_PAGE_SIZE = 'PcdLoadFixAddressSmmCodePageNumber'\r
TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_SMM_PAGE_SIZE_DATA_TYPE = 'UINT32'\r
TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_LIST = [TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_PEI_PAGE_SIZE, \\r
                                            TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_DXE_PAGE_SIZE, \\r
                                            TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_RUNTIME_PAGE_SIZE, \\r
                                            TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_SMM_PAGE_SIZE]\r
\r
## The mapping dictionary from datum type to its maximum number.\r
MAX_VAL_TYPE = {"BOOLEAN":0x01, TAB_UINT8:0xFF, TAB_UINT16:0xFFFF, TAB_UINT32:0xFFFFFFFF, TAB_UINT64:0xFFFFFFFFFFFFFFFF}\r
## The mapping dictionary from datum type to size string.\r
MAX_SIZE_TYPE = {"BOOLEAN":"1", TAB_UINT8:"1", TAB_UINT16:"2", TAB_UINT32:"4", TAB_UINT64:"8"}\r
\r
TAB_DEPEX = 'Depex'\r
TAB_DEPEX_COMMON = TAB_DEPEX + TAB_SPLIT + TAB_ARCH_COMMON\r
TAB_DEPEX_IA32 = TAB_DEPEX + TAB_SPLIT + TAB_ARCH_IA32\r
TAB_DEPEX_X64 = TAB_DEPEX + TAB_SPLIT + TAB_ARCH_X64\r
TAB_DEPEX_IPF = TAB_DEPEX + TAB_SPLIT + TAB_ARCH_IPF\r
TAB_DEPEX_ARM = TAB_DEPEX + TAB_SPLIT + TAB_ARCH_ARM\r
TAB_DEPEX_EBC = TAB_DEPEX + TAB_SPLIT + TAB_ARCH_EBC\r
TAB_DEPEX_AARCH64 = TAB_DEPEX + TAB_SPLIT + TAB_ARCH_AARCH64\r
\r
TAB_SKUIDS = 'SkuIds'\r
TAB_DEFAULT_STORES = 'DefaultStores'\r
TAB_DEFAULT_STORES_DEFAULT = 'STANDARD'\r
\r
TAB_LIBRARIES = 'Libraries'\r
TAB_LIBRARIES_COMMON = TAB_LIBRARIES + TAB_SPLIT + TAB_ARCH_COMMON\r
TAB_LIBRARIES_IA32 = TAB_LIBRARIES + TAB_SPLIT + TAB_ARCH_IA32\r
TAB_LIBRARIES_X64 = TAB_LIBRARIES + TAB_SPLIT + TAB_ARCH_X64\r
TAB_LIBRARIES_IPF = TAB_LIBRARIES + TAB_SPLIT + TAB_ARCH_IPF\r
TAB_LIBRARIES_ARM = TAB_LIBRARIES + TAB_SPLIT + TAB_ARCH_ARM\r
TAB_LIBRARIES_EBC = TAB_LIBRARIES + TAB_SPLIT + TAB_ARCH_EBC\r
TAB_LIBRARIES_AARCH64 = TAB_LIBRARIES + TAB_SPLIT + TAB_ARCH_AARCH64\r
\r
TAB_COMPONENTS = 'Components'\r
TAB_COMPONENTS_COMMON = TAB_COMPONENTS + TAB_SPLIT + TAB_ARCH_COMMON\r
TAB_COMPONENTS_IA32 = TAB_COMPONENTS + TAB_SPLIT + TAB_ARCH_IA32\r
TAB_COMPONENTS_X64 = TAB_COMPONENTS + TAB_SPLIT + TAB_ARCH_X64\r
TAB_COMPONENTS_IPF = TAB_COMPONENTS + TAB_SPLIT + TAB_ARCH_IPF\r
TAB_COMPONENTS_ARM = TAB_COMPONENTS + TAB_SPLIT + TAB_ARCH_ARM\r
TAB_COMPONENTS_EBC = TAB_COMPONENTS + TAB_SPLIT + TAB_ARCH_EBC\r
TAB_COMPONENTS_AARCH64 = TAB_COMPONENTS + TAB_SPLIT + TAB_ARCH_AARCH64\r
\r
TAB_COMPONENTS_SOURCE_OVERRIDE_PATH = 'SOURCE_OVERRIDE_PATH'\r
\r
TAB_BUILD_OPTIONS = 'BuildOptions'\r
\r
TAB_DEFINE = 'DEFINE'\r
TAB_NMAKE = 'Nmake'\r
TAB_USER_EXTENSIONS = 'UserExtensions'\r
TAB_INCLUDE = '!include'\r
TAB_DEFAULT = 'DEFAULT'\r
TAB_COMMON = 'COMMON'\r
\r
#\r
# Common Define\r
#\r
TAB_COMMON_DEFINES = 'Defines'\r
\r
#\r
# Inf Definitions\r
#\r
TAB_INF_DEFINES = TAB_COMMON_DEFINES\r
TAB_INF_DEFINES_INF_VERSION = 'INF_VERSION'\r
TAB_INF_DEFINES_BASE_NAME = 'BASE_NAME'\r
TAB_INF_DEFINES_FILE_GUID = 'FILE_GUID'\r
TAB_INF_DEFINES_MODULE_TYPE = 'MODULE_TYPE'\r
TAB_INF_DEFINES_EFI_SPECIFICATION_VERSION = 'EFI_SPECIFICATION_VERSION'\r
TAB_INF_DEFINES_UEFI_SPECIFICATION_VERSION = 'UEFI_SPECIFICATION_VERSION'\r
TAB_INF_DEFINES_PI_SPECIFICATION_VERSION = 'PI_SPECIFICATION_VERSION'\r
TAB_INF_DEFINES_EDK_RELEASE_VERSION = 'EDK_RELEASE_VERSION'\r
TAB_INF_DEFINES_BINARY_MODULE = 'BINARY_MODULE'\r
TAB_INF_DEFINES_LIBRARY_CLASS = 'LIBRARY_CLASS'\r
TAB_INF_DEFINES_COMPONENT_TYPE = 'COMPONENT_TYPE'\r
TAB_INF_DEFINES_MAKEFILE_NAME = 'MAKEFILE_NAME'\r
TAB_INF_DEFINES_DPX_SOURCE = 'DPX_SOURCE'\r
TAB_INF_DEFINES_BUILD_NUMBER = 'BUILD_NUMBER'\r
TAB_INF_DEFINES_BUILD_TYPE = 'BUILD_TYPE'\r
TAB_INF_DEFINES_FFS_EXT = 'FFS_EXT'\r
TAB_INF_DEFINES_FV_EXT = 'FV_EXT'\r
TAB_INF_DEFINES_SOURCE_FV = 'SOURCE_FV'\r
TAB_INF_DEFINES_VERSION_NUMBER = 'VERSION_NUMBER'\r
TAB_INF_DEFINES_VERSION = 'VERSION'          # for Edk inf, the same as VERSION_NUMBER\r
TAB_INF_DEFINES_VERSION_STRING = 'VERSION_STRING'\r
TAB_INF_DEFINES_PCD_IS_DRIVER = 'PCD_IS_DRIVER'\r
TAB_INF_DEFINES_TIANO_EDK_FLASHMAP_H = 'TIANO_EDK_FLASHMAP_H'\r
TAB_INF_DEFINES_ENTRY_POINT = 'ENTRY_POINT'\r
TAB_INF_DEFINES_UNLOAD_IMAGE = 'UNLOAD_IMAGE'\r
TAB_INF_DEFINES_CONSTRUCTOR = 'CONSTRUCTOR'\r
TAB_INF_DEFINES_DESTRUCTOR = 'DESTRUCTOR'\r
TAB_INF_DEFINES_DEFINE = 'DEFINE'\r
TAB_INF_DEFINES_SPEC = 'SPEC'\r
TAB_INF_DEFINES_CUSTOM_MAKEFILE = 'CUSTOM_MAKEFILE'\r
TAB_INF_DEFINES_MACRO = '__MACROS__'\r
TAB_INF_DEFINES_SHADOW = 'SHADOW'\r
TAB_INF_FIXED_PCD = 'FixedPcd'\r
TAB_INF_FEATURE_PCD = 'FeaturePcd'\r
TAB_INF_PATCH_PCD = 'PatchPcd'\r
TAB_INF_PCD = 'Pcd'\r
TAB_INF_PCD_EX = 'PcdEx'\r
TAB_INF_USAGE_PRO = 'PRODUCES'\r
TAB_INF_USAGE_SOME_PRO = 'SOMETIMES_PRODUCES'\r
TAB_INF_USAGE_CON = 'CONSUMES'\r
TAB_INF_USAGE_SOME_CON = 'SOMETIMES_CONSUMES'\r
TAB_INF_USAGE_NOTIFY = 'NOTIFY'\r
TAB_INF_USAGE_TO_START = 'TO_START'\r
TAB_INF_USAGE_BY_START = 'BY_START'\r
TAB_INF_GUIDTYPE_EVENT = 'Event'\r
TAB_INF_GUIDTYPE_FILE = 'File'\r
TAB_INF_GUIDTYPE_FV = 'FV'\r
TAB_INF_GUIDTYPE_GUID = 'GUID'\r
TAB_INF_GUIDTYPE_HII = 'HII'\r
TAB_INF_GUIDTYPE_HOB = 'HOB'\r
TAB_INF_GUIDTYPE_ST = 'SystemTable'\r
TAB_INF_GUIDTYPE_TSG = 'TokenSpaceGuid'\r
TAB_INF_GUIDTYPE_VAR = 'Variable'\r
TAB_INF_GUIDTYPE_PROTOCOL = 'PROTOCOL'\r
TAB_INF_GUIDTYPE_PPI = 'PPI'\r
TAB_INF_USAGE_UNDEFINED = 'UNDEFINED'\r
\r
#\r
# Dec Definitions\r
#\r
TAB_DEC_DEFINES = TAB_COMMON_DEFINES\r
TAB_DEC_DEFINES_DEC_SPECIFICATION = 'DEC_SPECIFICATION'\r
TAB_DEC_DEFINES_PACKAGE_NAME = 'PACKAGE_NAME'\r
TAB_DEC_DEFINES_PACKAGE_GUID = 'PACKAGE_GUID'\r
TAB_DEC_DEFINES_PACKAGE_VERSION = 'PACKAGE_VERSION'\r
TAB_DEC_DEFINES_PKG_UNI_FILE = 'PKG_UNI_FILE'\r
\r
#\r
# Dsc Definitions\r
#\r
TAB_DSC_DEFINES = TAB_COMMON_DEFINES\r
TAB_DSC_DEFINES_PLATFORM_NAME = 'PLATFORM_NAME'\r
TAB_DSC_DEFINES_PLATFORM_GUID = 'PLATFORM_GUID'\r
TAB_DSC_DEFINES_PLATFORM_VERSION = 'PLATFORM_VERSION'\r
TAB_DSC_DEFINES_DSC_SPECIFICATION = 'DSC_SPECIFICATION'\r
TAB_DSC_DEFINES_OUTPUT_DIRECTORY = 'OUTPUT_DIRECTORY'\r
TAB_DSC_DEFINES_SUPPORTED_ARCHITECTURES = 'SUPPORTED_ARCHITECTURES'\r
TAB_DSC_DEFINES_BUILD_TARGETS = 'BUILD_TARGETS'\r
TAB_DSC_DEFINES_SKUID_IDENTIFIER = 'SKUID_IDENTIFIER'\r
TAB_DSC_DEFINES_PCD_INFO_GENERATION = 'PCD_INFO_GENERATION'\r
TAB_DSC_DEFINES_PCD_VAR_CHECK_GENERATION = 'PCD_VAR_CHECK_GENERATION'\r
TAB_DSC_DEFINES_FLASH_DEFINITION = 'FLASH_DEFINITION'\r
TAB_DSC_DEFINES_BUILD_NUMBER = 'BUILD_NUMBER'\r
TAB_DSC_DEFINES_MAKEFILE_NAME = 'MAKEFILE_NAME'\r
TAB_DSC_DEFINES_BS_BASE_ADDRESS = 'BsBaseAddress'\r
TAB_DSC_DEFINES_RT_BASE_ADDRESS = 'RtBaseAddress'\r
TAB_DSC_DEFINES_RFC_LANGUAGES = 'RFC_LANGUAGES'\r
TAB_DSC_DEFINES_ISO_LANGUAGES = 'ISO_LANGUAGES'\r
TAB_DSC_DEFINES_DEFINE = 'DEFINE'\r
TAB_DSC_DEFINES_VPD_TOOL_GUID = 'VPD_TOOL_GUID'\r
TAB_FIX_LOAD_TOP_MEMORY_ADDRESS = 'FIX_LOAD_TOP_MEMORY_ADDRESS'\r
TAB_DSC_DEFINES_EDKGLOBAL = 'EDK_GLOBAL'\r
TAB_DSC_PREBUILD = 'PREBUILD'\r
TAB_DSC_POSTBUILD = 'POSTBUILD'\r
#\r
# TargetTxt Definitions\r
#\r
TAB_TAT_DEFINES_ACTIVE_PLATFORM = 'ACTIVE_PLATFORM'\r
TAB_TAT_DEFINES_ACTIVE_MODULE = 'ACTIVE_MODULE'\r
TAB_TAT_DEFINES_TOOL_CHAIN_CONF = 'TOOL_CHAIN_CONF'\r
TAB_TAT_DEFINES_MAX_CONCURRENT_THREAD_NUMBER = 'MAX_CONCURRENT_THREAD_NUMBER'\r
TAB_TAT_DEFINES_TARGET = 'TARGET'\r
TAB_TAT_DEFINES_TOOL_CHAIN_TAG = 'TOOL_CHAIN_TAG'\r
TAB_TAT_DEFINES_TARGET_ARCH = 'TARGET_ARCH'\r
TAB_TAT_DEFINES_BUILD_RULE_CONF = "BUILD_RULE_CONF"\r
\r
#\r
# ToolDef Definitions\r
#\r
TAB_TOD_DEFINES_TARGET = 'TARGET'\r
TAB_TOD_DEFINES_TOOL_CHAIN_TAG = 'TOOL_CHAIN_TAG'\r
TAB_TOD_DEFINES_TARGET_ARCH = 'TARGET_ARCH'\r
TAB_TOD_DEFINES_COMMAND_TYPE = 'COMMAND_TYPE'\r
TAB_TOD_DEFINES_FAMILY = 'FAMILY'\r
TAB_TOD_DEFINES_BUILDRULEFAMILY = 'BUILDRULEFAMILY'\r
TAB_TOD_DEFINES_BUILDRULEORDER = 'BUILDRULEORDER'\r
\r
#\r
# Conditional Statements\r
#\r
TAB_IF = '!if'\r
TAB_END_IF = '!endif'\r
TAB_ELSE_IF = '!elseif'\r
TAB_ELSE = '!else'\r
TAB_IF_DEF = '!ifdef'\r
TAB_IF_N_DEF = '!ifndef'\r
TAB_IF_EXIST = '!if exist'\r
TAB_ERROR = '!ERROR'\r
\r
#\r
# Unknown section\r
#\r
TAB_UNKNOWN = 'UNKNOWN'\r
\r
#\r
# Build database path\r
#\r
DATABASE_PATH = ":memory:" #"BuildDatabase.db"\r
\r
# used by ECC\r
MODIFIER_LIST = ['IN', 'OUT', 'OPTIONAL', 'UNALIGNED', 'EFI_RUNTIMESERVICE', 'EFI_BOOTSERVICE', 'EFIAPI']\r
\r
# Dependency Expression\r
DEPEX_SUPPORTED_OPCODE = ["BEFORE", "AFTER", "PUSH", "AND", "OR", "NOT", "END", "SOR", "TRUE", "FALSE", '(', ')']\r
\r
TAB_STATIC_LIBRARY = "STATIC-LIBRARY-FILE"\r
TAB_DYNAMIC_LIBRARY = "DYNAMIC-LIBRARY-FILE"\r
TAB_FRAMEWORK_IMAGE = "EFI-IMAGE-FILE"\r
TAB_C_CODE_FILE = "C-CODE-FILE"\r
TAB_C_HEADER_FILE = "C-HEADER-FILE"\r
TAB_UNICODE_FILE = "UNICODE-TEXT-FILE"\r
TAB_IMAGE_FILE = "IMAGE-DEFINITION-FILE"\r
TAB_DEPENDENCY_EXPRESSION_FILE = "DEPENDENCY-EXPRESSION-FILE"\r
TAB_UNKNOWN_FILE = "UNKNOWN-TYPE-FILE"\r
TAB_DEFAULT_BINARY_FILE = "_BINARY_FILE_"\r
TAB_OBJECT_FILE = "OBJECT-FILE"\r
TAB_VFR_FILE = 'VISUAL-FORM-REPRESENTATION-FILE'\r
\r
# used by BRG\r
TAB_BRG_PCD = 'PCD'\r
TAB_BRG_LIBRARY = 'Library'\r
\r
#\r
# Build Rule File Version Definition\r
#\r
TAB_BUILD_RULE_VERSION = "build_rule_version"\r
\r
# section name for PCDs\r
PCDS_DYNAMIC_DEFAULT = "PcdsDynamicDefault"\r
PCDS_DYNAMIC_VPD = "PcdsDynamicVpd"\r
PCDS_DYNAMIC_HII = "PcdsDynamicHii"\r
PCDS_DYNAMICEX_DEFAULT = "PcdsDynamicExDefault"\r
PCDS_DYNAMICEX_VPD = "PcdsDynamicExVpd"\r
PCDS_DYNAMICEX_HII = "PcdsDynamicExHii"\r
\r
SECTIONS_HAVE_ITEM_PCD = [PCDS_DYNAMIC_DEFAULT.upper(),PCDS_DYNAMIC_VPD.upper(),PCDS_DYNAMIC_HII.upper(), \\r
                          PCDS_DYNAMICEX_DEFAULT.upper(),PCDS_DYNAMICEX_VPD.upper(),PCDS_DYNAMICEX_HII.upper()]\r
# Section allowed to have items after arch\r
SECTIONS_HAVE_ITEM_AFTER_ARCH = [TAB_LIBRARY_CLASSES.upper(), TAB_DEPEX.upper(), TAB_USER_EXTENSIONS.upper(),\r
                                 PCDS_DYNAMIC_DEFAULT.upper(),\r
                                 PCDS_DYNAMIC_VPD.upper(),\r
                                 PCDS_DYNAMIC_HII.upper(),\r
                                 PCDS_DYNAMICEX_DEFAULT.upper(),\r
                                 PCDS_DYNAMICEX_VPD.upper(),\r
                                 PCDS_DYNAMICEX_HII.upper(),\r
                                 TAB_BUILD_OPTIONS.upper(),\r
                                 TAB_INCLUDES.upper()]\r