BaseTools/Common: add MM Module data types.
[mirror_edk2.git] / BaseTools / Source / Python / Common / DataType.py
CommitLineData
30fdf114
LG
1## @file\r
2# This file is used to define common static strings used by INF/DEC/DSC files\r
3#\r
5b97eb4c 4# Copyright (c) 2007 - 2017, Intel Corporation. All rights reserved.<BR>\r
4afd3d04 5# Portions copyright (c) 2011 - 2013, ARM Ltd. All rights reserved.<BR>\r
40d841f6 6# This program and the accompanying materials\r
30fdf114
LG
7# are licensed and made available under the terms and conditions of the BSD License\r
8# which accompanies this distribution. The full text of the license may be found at\r
9# http://opensource.org/licenses/bsd-license.php\r
10#\r
11# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
12# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
13\r
14##\r
15# Common Definitions\r
16#\r
17TAB_SPLIT = '.'\r
b36d134f
LG
18TAB_COMMENT_EDK_START = '/*'\r
19TAB_COMMENT_EDK_END = '*/'\r
20TAB_COMMENT_EDK_SPLIT = '//'\r
30fdf114 21TAB_COMMENT_SPLIT = '#'\r
4afd3d04 22TAB_SPECIAL_COMMENT = '##'\r
30fdf114
LG
23TAB_EQUAL_SPLIT = '='\r
24TAB_VALUE_SPLIT = '|'\r
25TAB_COMMA_SPLIT = ','\r
26TAB_SPACE_SPLIT = ' '\r
6780eef1 27TAB_SEMI_COLON_SPLIT = ';'\r
30fdf114
LG
28TAB_SECTION_START = '['\r
29TAB_SECTION_END = ']'\r
30TAB_OPTION_START = '<'\r
4afd3d04 31TAB_OPTION_END = '>'\r
30fdf114
LG
32TAB_SLASH = '\\'\r
33TAB_BACK_SLASH = '/'\r
64b2609f 34TAB_LINE_BREAK = '\n'\r
4afd3d04
LG
35TAB_PRINTCHAR_VT = '\x0b'\r
36TAB_PRINTCHAR_BS = '\b'\r
37TAB_PRINTCHAR_NUL = '\0'\r
38TAB_UINT8 = 'UINT8'\r
39TAB_UINT16 = 'UINT16'\r
40TAB_UINT32 = 'UINT32'\r
41TAB_UINT64 = 'UINT64'\r
42TAB_VOID = 'VOID*'\r
30fdf114
LG
43\r
44TAB_EDK_SOURCE = '$(EDK_SOURCE)'\r
45TAB_EFI_SOURCE = '$(EFI_SOURCE)'\r
46TAB_WORKSPACE = '$(WORKSPACE)'\r
47\r
48TAB_ARCH_NULL = ''\r
49TAB_ARCH_COMMON = 'COMMON'\r
50TAB_ARCH_IA32 = 'IA32'\r
51TAB_ARCH_X64 = 'X64'\r
52TAB_ARCH_IPF = 'IPF'\r
53TAB_ARCH_ARM = 'ARM'\r
54TAB_ARCH_EBC = 'EBC'\r
4afd3d04 55TAB_ARCH_AARCH64 = 'AARCH64'\r
30fdf114 56\r
4afd3d04 57ARCH_LIST = [TAB_ARCH_IA32, TAB_ARCH_X64, TAB_ARCH_IPF, TAB_ARCH_ARM, TAB_ARCH_EBC, TAB_ARCH_AARCH64]\r
30fdf114
LG
58ARCH_LIST_FULL = [TAB_ARCH_COMMON] + ARCH_LIST\r
59\r
60SUP_MODULE_BASE = 'BASE'\r
61SUP_MODULE_SEC = 'SEC'\r
62SUP_MODULE_PEI_CORE = 'PEI_CORE'\r
63SUP_MODULE_PEIM = 'PEIM'\r
64SUP_MODULE_DXE_CORE = 'DXE_CORE'\r
65SUP_MODULE_DXE_DRIVER = 'DXE_DRIVER'\r
66SUP_MODULE_DXE_RUNTIME_DRIVER = 'DXE_RUNTIME_DRIVER'\r
67SUP_MODULE_DXE_SAL_DRIVER = 'DXE_SAL_DRIVER'\r
68SUP_MODULE_DXE_SMM_DRIVER = 'DXE_SMM_DRIVER'\r
69SUP_MODULE_UEFI_DRIVER = 'UEFI_DRIVER'\r
70SUP_MODULE_UEFI_APPLICATION = 'UEFI_APPLICATION'\r
71SUP_MODULE_USER_DEFINED = 'USER_DEFINED'\r
30fdf114 72SUP_MODULE_SMM_CORE = 'SMM_CORE'\r
584e5cbb
SV
73SUP_MODULE_MM_STANDALONE = 'MM_STANDALONE'\r
74SUP_MODULE_MM_CORE_STANDALONE = 'MM_CORE_STANDALONE'\r
30fdf114
LG
75\r
76SUP_MODULE_LIST = [SUP_MODULE_BASE, SUP_MODULE_SEC, SUP_MODULE_PEI_CORE, SUP_MODULE_PEIM, SUP_MODULE_DXE_CORE, SUP_MODULE_DXE_DRIVER, \\r
77 SUP_MODULE_DXE_RUNTIME_DRIVER, SUP_MODULE_DXE_SAL_DRIVER, SUP_MODULE_DXE_SMM_DRIVER, SUP_MODULE_UEFI_DRIVER, \\r
584e5cbb 78 SUP_MODULE_UEFI_APPLICATION, SUP_MODULE_USER_DEFINED, SUP_MODULE_SMM_CORE, SUP_MODULE_MM_STANDALONE, SUP_MODULE_MM_CORE_STANDALONE]\r
30fdf114
LG
79SUP_MODULE_LIST_STRING = TAB_VALUE_SPLIT.join(l for l in SUP_MODULE_LIST)\r
80\r
81EDK_COMPONENT_TYPE_LIBRARY = 'LIBRARY'\r
82EDK_COMPONENT_TYPE_SECUARITY_CORE = 'SECUARITY_CORE'\r
83EDK_COMPONENT_TYPE_PEI_CORE = 'PEI_CORE'\r
84EDK_COMPONENT_TYPE_COMBINED_PEIM_DRIVER = 'COMBINED_PEIM_DRIVER'\r
85EDK_COMPONENT_TYPE_PIC_PEIM = 'PIC_PEIM'\r
86EDK_COMPONENT_TYPE_RELOCATABLE_PEIM = 'RELOCATABLE_PEIM'\r
87EDK_COMPONENT_TYPE_BS_DRIVER = 'BS_DRIVER'\r
88EDK_COMPONENT_TYPE_RT_DRIVER = 'RT_DRIVER'\r
89EDK_COMPONENT_TYPE_SAL_RT_DRIVER = 'SAL_RT_DRIVER'\r
90EDK_COMPONENT_TYPE_APPLICATION = 'APPLICATION'\r
4afd3d04 91EDK_NAME = 'EDK'\r
52302d4d 92EDKII_NAME = 'EDKII'\r
30fdf114
LG
93\r
94BINARY_FILE_TYPE_FW = 'FW'\r
95BINARY_FILE_TYPE_GUID = 'GUID'\r
96BINARY_FILE_TYPE_PREEFORM = 'PREEFORM'\r
97BINARY_FILE_TYPE_UEFI_APP = 'UEFI_APP'\r
98BINARY_FILE_TYPE_UNI_UI = 'UNI_UI'\r
99BINARY_FILE_TYPE_UNI_VER = 'UNI_VER'\r
100BINARY_FILE_TYPE_LIB = 'LIB'\r
101BINARY_FILE_TYPE_PE32 = 'PE32'\r
102BINARY_FILE_TYPE_PIC = 'PIC'\r
103BINARY_FILE_TYPE_PEI_DEPEX = 'PEI_DEPEX'\r
104BINARY_FILE_TYPE_DXE_DEPEX = 'DXE_DEPEX'\r
b303ea72 105BINARY_FILE_TYPE_SMM_DEPEX = 'SMM_DEPEX'\r
30fdf114
LG
106BINARY_FILE_TYPE_TE = 'TE'\r
107BINARY_FILE_TYPE_VER = 'VER'\r
108BINARY_FILE_TYPE_UI = 'UI'\r
109BINARY_FILE_TYPE_BIN = 'BIN'\r
110BINARY_FILE_TYPE_FV = 'FV'\r
111\r
112PLATFORM_COMPONENT_TYPE_LIBRARY = 'LIBRARY'\r
113PLATFORM_COMPONENT_TYPE_LIBRARY_CLASS = 'LIBRARY_CLASS'\r
114PLATFORM_COMPONENT_TYPE_MODULE = 'MODULE'\r
115\r
116TAB_LIBRARIES = 'Libraries'\r
117\r
118TAB_SOURCES = 'Sources'\r
119TAB_SOURCES_COMMON = TAB_SOURCES + TAB_SPLIT + TAB_ARCH_COMMON\r
120TAB_SOURCES_IA32 = TAB_SOURCES + TAB_SPLIT + TAB_ARCH_IA32\r
121TAB_SOURCES_X64 = TAB_SOURCES + TAB_SPLIT + TAB_ARCH_X64\r
122TAB_SOURCES_IPF = TAB_SOURCES + TAB_SPLIT + TAB_ARCH_IPF\r
123TAB_SOURCES_ARM = TAB_SOURCES + TAB_SPLIT + TAB_ARCH_ARM\r
124TAB_SOURCES_EBC = TAB_SOURCES + TAB_SPLIT + TAB_ARCH_EBC\r
4afd3d04 125TAB_SOURCES_AARCH64 = TAB_SOURCES + TAB_SPLIT + TAB_ARCH_AARCH64\r
30fdf114
LG
126\r
127TAB_BINARIES = 'Binaries'\r
128TAB_BINARIES_COMMON = TAB_BINARIES + TAB_SPLIT + TAB_ARCH_COMMON\r
129TAB_BINARIES_IA32 = TAB_BINARIES + TAB_SPLIT + TAB_ARCH_IA32\r
130TAB_BINARIES_X64 = TAB_BINARIES + TAB_SPLIT + TAB_ARCH_X64\r
131TAB_BINARIES_IPF = TAB_BINARIES + TAB_SPLIT + TAB_ARCH_IPF\r
132TAB_BINARIES_ARM = TAB_BINARIES + TAB_SPLIT + TAB_ARCH_ARM\r
133TAB_BINARIES_EBC = TAB_BINARIES + TAB_SPLIT + TAB_ARCH_EBC\r
4afd3d04 134TAB_BINARIES_AARCH64 = TAB_BINARIES + TAB_SPLIT + TAB_ARCH_AARCH64\r
30fdf114
LG
135\r
136TAB_INCLUDES = 'Includes'\r
137TAB_INCLUDES_COMMON = TAB_INCLUDES + TAB_SPLIT + TAB_ARCH_COMMON\r
138TAB_INCLUDES_IA32 = TAB_INCLUDES + TAB_SPLIT + TAB_ARCH_IA32\r
139TAB_INCLUDES_X64 = TAB_INCLUDES + TAB_SPLIT + TAB_ARCH_X64\r
140TAB_INCLUDES_IPF = TAB_INCLUDES + TAB_SPLIT + TAB_ARCH_IPF\r
141TAB_INCLUDES_ARM = TAB_INCLUDES + TAB_SPLIT + TAB_ARCH_ARM\r
142TAB_INCLUDES_EBC = TAB_INCLUDES + TAB_SPLIT + TAB_ARCH_EBC\r
4afd3d04 143TAB_INCLUDES_AARCH64 = TAB_INCLUDES + TAB_SPLIT + TAB_ARCH_AARCH64\r
30fdf114
LG
144\r
145TAB_GUIDS = 'Guids'\r
146TAB_GUIDS_COMMON = TAB_GUIDS + TAB_SPLIT + TAB_ARCH_COMMON\r
147TAB_GUIDS_IA32 = TAB_GUIDS + TAB_SPLIT + TAB_ARCH_IA32\r
148TAB_GUIDS_X64 = TAB_GUIDS + TAB_SPLIT + TAB_ARCH_X64\r
149TAB_GUIDS_IPF = TAB_GUIDS + TAB_SPLIT + TAB_ARCH_IPF\r
150TAB_GUIDS_ARM = TAB_GUIDS + TAB_SPLIT + TAB_ARCH_ARM\r
151TAB_GUIDS_EBC = TAB_GUIDS + TAB_SPLIT + TAB_ARCH_EBC\r
4afd3d04 152TAB_GUIDS_AARCH64 = TAB_GUIDS + TAB_SPLIT + TAB_ARCH_AARCH64\r
30fdf114
LG
153\r
154TAB_PROTOCOLS = 'Protocols'\r
155TAB_PROTOCOLS_COMMON = TAB_PROTOCOLS + TAB_SPLIT + TAB_ARCH_COMMON\r
156TAB_PROTOCOLS_IA32 = TAB_PROTOCOLS + TAB_SPLIT + TAB_ARCH_IA32\r
157TAB_PROTOCOLS_X64 = TAB_PROTOCOLS + TAB_SPLIT + TAB_ARCH_X64\r
158TAB_PROTOCOLS_IPF = TAB_PROTOCOLS + TAB_SPLIT + TAB_ARCH_IPF\r
159TAB_PROTOCOLS_ARM = TAB_PROTOCOLS + TAB_SPLIT + TAB_ARCH_ARM\r
160TAB_PROTOCOLS_EBC = TAB_PROTOCOLS + TAB_SPLIT + TAB_ARCH_EBC\r
4afd3d04 161TAB_PROTOCOLS_AARCH64 = TAB_PROTOCOLS + TAB_SPLIT + TAB_ARCH_AARCH64\r
30fdf114
LG
162\r
163TAB_PPIS = 'Ppis'\r
164TAB_PPIS_COMMON = TAB_PPIS + TAB_SPLIT + TAB_ARCH_COMMON\r
165TAB_PPIS_IA32 = TAB_PPIS + TAB_SPLIT + TAB_ARCH_IA32\r
166TAB_PPIS_X64 = TAB_PPIS + TAB_SPLIT + TAB_ARCH_X64\r
167TAB_PPIS_IPF = TAB_PPIS + TAB_SPLIT + TAB_ARCH_IPF\r
168TAB_PPIS_ARM = TAB_PPIS + TAB_SPLIT + TAB_ARCH_ARM\r
169TAB_PPIS_EBC = TAB_PPIS + TAB_SPLIT + TAB_ARCH_EBC\r
4afd3d04 170TAB_PPIS_AARCH64 = TAB_PPIS + TAB_SPLIT + TAB_ARCH_AARCH64\r
30fdf114
LG
171\r
172TAB_LIBRARY_CLASSES = 'LibraryClasses'\r
173TAB_LIBRARY_CLASSES_COMMON = TAB_LIBRARY_CLASSES + TAB_SPLIT + TAB_ARCH_COMMON\r
174TAB_LIBRARY_CLASSES_IA32 = TAB_LIBRARY_CLASSES + TAB_SPLIT + TAB_ARCH_IA32\r
175TAB_LIBRARY_CLASSES_X64 = TAB_LIBRARY_CLASSES + TAB_SPLIT + TAB_ARCH_X64\r
176TAB_LIBRARY_CLASSES_IPF = TAB_LIBRARY_CLASSES + TAB_SPLIT + TAB_ARCH_IPF\r
177TAB_LIBRARY_CLASSES_ARM = TAB_LIBRARY_CLASSES + TAB_SPLIT + TAB_ARCH_ARM\r
178TAB_LIBRARY_CLASSES_EBC = TAB_LIBRARY_CLASSES + TAB_SPLIT + TAB_ARCH_EBC\r
4afd3d04 179TAB_LIBRARY_CLASSES_AARCH64 = TAB_LIBRARY_CLASSES + TAB_SPLIT + TAB_ARCH_AARCH64\r
30fdf114
LG
180\r
181TAB_PACKAGES = 'Packages'\r
182TAB_PACKAGES_COMMON = TAB_PACKAGES + TAB_SPLIT + TAB_ARCH_COMMON\r
183TAB_PACKAGES_IA32 = TAB_PACKAGES + TAB_SPLIT + TAB_ARCH_IA32\r
184TAB_PACKAGES_X64 = TAB_PACKAGES + TAB_SPLIT + TAB_ARCH_X64\r
185TAB_PACKAGES_IPF = TAB_PACKAGES + TAB_SPLIT + TAB_ARCH_IPF\r
186TAB_PACKAGES_ARM = TAB_PACKAGES + TAB_SPLIT + TAB_ARCH_ARM\r
187TAB_PACKAGES_EBC = TAB_PACKAGES + TAB_SPLIT + TAB_ARCH_EBC\r
4afd3d04 188TAB_PACKAGES_AARCH64 = TAB_PACKAGES + TAB_SPLIT + TAB_ARCH_AARCH64\r
30fdf114
LG
189\r
190TAB_PCDS = 'Pcds'\r
191TAB_PCDS_FIXED_AT_BUILD = 'FixedAtBuild'\r
192TAB_PCDS_PATCHABLE_IN_MODULE = 'PatchableInModule'\r
193TAB_PCDS_FEATURE_FLAG = 'FeatureFlag'\r
194TAB_PCDS_DYNAMIC_EX = 'DynamicEx'\r
195TAB_PCDS_DYNAMIC_EX_DEFAULT = 'DynamicExDefault'\r
196TAB_PCDS_DYNAMIC_EX_VPD = 'DynamicExVpd'\r
197TAB_PCDS_DYNAMIC_EX_HII = 'DynamicExHii'\r
198TAB_PCDS_DYNAMIC = 'Dynamic'\r
199TAB_PCDS_DYNAMIC_DEFAULT = 'DynamicDefault'\r
200TAB_PCDS_DYNAMIC_VPD = 'DynamicVpd'\r
201TAB_PCDS_DYNAMIC_HII = 'DynamicHii'\r
202\r
203PCD_DYNAMIC_TYPE_LIST = [TAB_PCDS_DYNAMIC, TAB_PCDS_DYNAMIC_DEFAULT, TAB_PCDS_DYNAMIC_VPD, TAB_PCDS_DYNAMIC_HII]\r
204PCD_DYNAMIC_EX_TYPE_LIST = [TAB_PCDS_DYNAMIC_EX, TAB_PCDS_DYNAMIC_EX_DEFAULT, TAB_PCDS_DYNAMIC_EX_VPD, TAB_PCDS_DYNAMIC_EX_HII]\r
205\r
206## Dynamic-ex PCD types\r
207gDynamicExPcd = [TAB_PCDS_DYNAMIC_EX, TAB_PCDS_DYNAMIC_EX_DEFAULT, TAB_PCDS_DYNAMIC_EX_VPD, TAB_PCDS_DYNAMIC_EX_HII]\r
208\r
209TAB_PCDS_FIXED_AT_BUILD_NULL = TAB_PCDS + TAB_PCDS_FIXED_AT_BUILD\r
210TAB_PCDS_FIXED_AT_BUILD_COMMON = TAB_PCDS + TAB_PCDS_FIXED_AT_BUILD + TAB_SPLIT + TAB_ARCH_COMMON\r
211TAB_PCDS_FIXED_AT_BUILD_IA32 = TAB_PCDS + TAB_PCDS_FIXED_AT_BUILD + TAB_SPLIT + TAB_ARCH_IA32\r
212TAB_PCDS_FIXED_AT_BUILD_X64 = TAB_PCDS + TAB_PCDS_FIXED_AT_BUILD + TAB_SPLIT + TAB_ARCH_X64\r
213TAB_PCDS_FIXED_AT_BUILD_IPF = TAB_PCDS + TAB_PCDS_FIXED_AT_BUILD + TAB_SPLIT + TAB_ARCH_IPF\r
214TAB_PCDS_FIXED_AT_BUILD_ARM = TAB_PCDS + TAB_PCDS_FIXED_AT_BUILD + TAB_SPLIT + TAB_ARCH_ARM\r
215TAB_PCDS_FIXED_AT_BUILD_EBC = TAB_PCDS + TAB_PCDS_FIXED_AT_BUILD + TAB_SPLIT + TAB_ARCH_EBC\r
4afd3d04 216TAB_PCDS_FIXED_AT_BUILD_AARCH64 = TAB_PCDS + TAB_PCDS_FIXED_AT_BUILD + TAB_SPLIT + TAB_ARCH_AARCH64\r
30fdf114
LG
217\r
218TAB_PCDS_PATCHABLE_IN_MODULE_NULL = TAB_PCDS + TAB_PCDS_PATCHABLE_IN_MODULE\r
219TAB_PCDS_PATCHABLE_IN_MODULE_COMMON = TAB_PCDS + TAB_PCDS_PATCHABLE_IN_MODULE + TAB_SPLIT + TAB_ARCH_COMMON\r
220TAB_PCDS_PATCHABLE_IN_MODULE_IA32 = TAB_PCDS + TAB_PCDS_PATCHABLE_IN_MODULE + TAB_SPLIT + TAB_ARCH_IA32\r
221TAB_PCDS_PATCHABLE_IN_MODULE_X64 = TAB_PCDS + TAB_PCDS_PATCHABLE_IN_MODULE + TAB_SPLIT + TAB_ARCH_X64\r
222TAB_PCDS_PATCHABLE_IN_MODULE_IPF = TAB_PCDS + TAB_PCDS_PATCHABLE_IN_MODULE + TAB_SPLIT + TAB_ARCH_IPF\r
223TAB_PCDS_PATCHABLE_IN_MODULE_ARM = TAB_PCDS + TAB_PCDS_PATCHABLE_IN_MODULE + TAB_SPLIT + TAB_ARCH_ARM\r
224TAB_PCDS_PATCHABLE_IN_MODULE_EBC = TAB_PCDS + TAB_PCDS_PATCHABLE_IN_MODULE + TAB_SPLIT + TAB_ARCH_EBC\r
4afd3d04 225TAB_PCDS_PATCHABLE_IN_MODULE_AARCH64 = TAB_PCDS + TAB_PCDS_PATCHABLE_IN_MODULE + TAB_SPLIT + TAB_ARCH_AARCH64\r
30fdf114
LG
226\r
227TAB_PCDS_FEATURE_FLAG_NULL = TAB_PCDS + TAB_PCDS_FEATURE_FLAG\r
228TAB_PCDS_FEATURE_FLAG_COMMON = TAB_PCDS + TAB_PCDS_FEATURE_FLAG + TAB_SPLIT + TAB_ARCH_COMMON\r
229TAB_PCDS_FEATURE_FLAG_IA32 = TAB_PCDS + TAB_PCDS_FEATURE_FLAG + TAB_SPLIT + TAB_ARCH_IA32\r
230TAB_PCDS_FEATURE_FLAG_X64 = TAB_PCDS + TAB_PCDS_FEATURE_FLAG + TAB_SPLIT + TAB_ARCH_X64\r
231TAB_PCDS_FEATURE_FLAG_IPF = TAB_PCDS + TAB_PCDS_FEATURE_FLAG + TAB_SPLIT + TAB_ARCH_IPF\r
232TAB_PCDS_FEATURE_FLAG_ARM = TAB_PCDS + TAB_PCDS_FEATURE_FLAG + TAB_SPLIT + TAB_ARCH_ARM\r
233TAB_PCDS_FEATURE_FLAG_EBC = TAB_PCDS + TAB_PCDS_FEATURE_FLAG + TAB_SPLIT + TAB_ARCH_EBC\r
4afd3d04 234TAB_PCDS_FEATURE_FLAG_AARCH64 = TAB_PCDS + TAB_PCDS_FEATURE_FLAG + TAB_SPLIT + TAB_ARCH_AARCH64\r
30fdf114
LG
235\r
236TAB_PCDS_DYNAMIC_EX_NULL = TAB_PCDS + TAB_PCDS_DYNAMIC_EX\r
237TAB_PCDS_DYNAMIC_EX_DEFAULT_NULL = TAB_PCDS + TAB_PCDS_DYNAMIC_EX_DEFAULT\r
238TAB_PCDS_DYNAMIC_EX_HII_NULL = TAB_PCDS + TAB_PCDS_DYNAMIC_EX_HII\r
239TAB_PCDS_DYNAMIC_EX_VPD_NULL = TAB_PCDS + TAB_PCDS_DYNAMIC_EX_VPD\r
240TAB_PCDS_DYNAMIC_EX_COMMON = TAB_PCDS + TAB_PCDS_DYNAMIC_EX + TAB_SPLIT + TAB_ARCH_COMMON\r
241TAB_PCDS_DYNAMIC_EX_IA32 = TAB_PCDS + TAB_PCDS_DYNAMIC_EX + TAB_SPLIT + TAB_ARCH_IA32\r
242TAB_PCDS_DYNAMIC_EX_X64 = TAB_PCDS + TAB_PCDS_DYNAMIC_EX + TAB_SPLIT + TAB_ARCH_X64\r
243TAB_PCDS_DYNAMIC_EX_IPF = TAB_PCDS + TAB_PCDS_DYNAMIC_EX + TAB_SPLIT + TAB_ARCH_IPF\r
244TAB_PCDS_DYNAMIC_EX_ARM = TAB_PCDS + TAB_PCDS_DYNAMIC_EX + TAB_SPLIT + TAB_ARCH_ARM\r
245TAB_PCDS_DYNAMIC_EX_EBC = TAB_PCDS + TAB_PCDS_DYNAMIC_EX + TAB_SPLIT + TAB_ARCH_EBC\r
4afd3d04 246TAB_PCDS_DYNAMIC_EX_AARCH64 = TAB_PCDS + TAB_PCDS_DYNAMIC_EX + TAB_SPLIT + TAB_ARCH_AARCH64\r
30fdf114
LG
247\r
248TAB_PCDS_DYNAMIC_NULL = TAB_PCDS + TAB_PCDS_DYNAMIC\r
249TAB_PCDS_DYNAMIC_DEFAULT_NULL = TAB_PCDS + TAB_PCDS_DYNAMIC_DEFAULT\r
250TAB_PCDS_DYNAMIC_HII_NULL = TAB_PCDS + TAB_PCDS_DYNAMIC_HII\r
251TAB_PCDS_DYNAMIC_VPD_NULL = TAB_PCDS + TAB_PCDS_DYNAMIC_VPD\r
252TAB_PCDS_DYNAMIC_COMMON = TAB_PCDS + TAB_PCDS_DYNAMIC + TAB_SPLIT + TAB_ARCH_COMMON\r
253TAB_PCDS_DYNAMIC_IA32 = TAB_PCDS + TAB_PCDS_DYNAMIC + TAB_SPLIT + TAB_ARCH_IA32\r
254TAB_PCDS_DYNAMIC_X64 = TAB_PCDS + TAB_PCDS_DYNAMIC + TAB_SPLIT + TAB_ARCH_X64\r
255TAB_PCDS_DYNAMIC_IPF = TAB_PCDS + TAB_PCDS_DYNAMIC + TAB_SPLIT + TAB_ARCH_IPF\r
256TAB_PCDS_DYNAMIC_ARM = TAB_PCDS + TAB_PCDS_DYNAMIC + TAB_SPLIT + TAB_ARCH_ARM\r
257TAB_PCDS_DYNAMIC_EBC = TAB_PCDS + TAB_PCDS_DYNAMIC + TAB_SPLIT + TAB_ARCH_EBC\r
4afd3d04 258TAB_PCDS_DYNAMIC_AARCH64 = TAB_PCDS + TAB_PCDS_DYNAMIC + TAB_SPLIT + TAB_ARCH_AARCH64\r
30fdf114
LG
259\r
260TAB_PCD_DYNAMIC_TYPE_LIST = [TAB_PCDS_DYNAMIC_DEFAULT_NULL, TAB_PCDS_DYNAMIC_VPD_NULL, TAB_PCDS_DYNAMIC_HII_NULL]\r
261TAB_PCD_DYNAMIC_EX_TYPE_LIST = [TAB_PCDS_DYNAMIC_EX_DEFAULT_NULL, TAB_PCDS_DYNAMIC_EX_VPD_NULL, TAB_PCDS_DYNAMIC_EX_HII_NULL]\r
262\r
52302d4d
LG
263TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_PEI_PAGE_SIZE = 'PcdLoadFixAddressPeiCodePageNumber'\r
264TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_PEI_PAGE_SIZE_DATA_TYPE = 'UINT32'\r
265TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_DXE_PAGE_SIZE = 'PcdLoadFixAddressBootTimeCodePageNumber'\r
266TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_DXE_PAGE_SIZE_DATA_TYPE = 'UINT32'\r
267TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_RUNTIME_PAGE_SIZE = 'PcdLoadFixAddressRuntimeCodePageNumber'\r
268TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_RUNTIME_PAGE_SIZE_DATA_TYPE = 'UINT32'\r
269TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_SMM_PAGE_SIZE = 'PcdLoadFixAddressSmmCodePageNumber'\r
270TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_SMM_PAGE_SIZE_DATA_TYPE = 'UINT32'\r
271TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_LIST = [TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_PEI_PAGE_SIZE, \\r
272 TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_DXE_PAGE_SIZE, \\r
273 TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_RUNTIME_PAGE_SIZE, \\r
274 TAB_PCDS_PATCHABLE_LOAD_FIX_ADDRESS_SMM_PAGE_SIZE]\r
275\r
30fdf114
LG
276TAB_DEPEX = 'Depex'\r
277TAB_DEPEX_COMMON = TAB_DEPEX + TAB_SPLIT + TAB_ARCH_COMMON\r
278TAB_DEPEX_IA32 = TAB_DEPEX + TAB_SPLIT + TAB_ARCH_IA32\r
279TAB_DEPEX_X64 = TAB_DEPEX + TAB_SPLIT + TAB_ARCH_X64\r
280TAB_DEPEX_IPF = TAB_DEPEX + TAB_SPLIT + TAB_ARCH_IPF\r
281TAB_DEPEX_ARM = TAB_DEPEX + TAB_SPLIT + TAB_ARCH_ARM\r
282TAB_DEPEX_EBC = TAB_DEPEX + TAB_SPLIT + TAB_ARCH_EBC\r
4afd3d04 283TAB_DEPEX_AARCH64 = TAB_DEPEX + TAB_SPLIT + TAB_ARCH_AARCH64\r
30fdf114
LG
284\r
285TAB_SKUIDS = 'SkuIds'\r
286\r
287TAB_LIBRARIES = 'Libraries'\r
288TAB_LIBRARIES_COMMON = TAB_LIBRARIES + TAB_SPLIT + TAB_ARCH_COMMON\r
289TAB_LIBRARIES_IA32 = TAB_LIBRARIES + TAB_SPLIT + TAB_ARCH_IA32\r
290TAB_LIBRARIES_X64 = TAB_LIBRARIES + TAB_SPLIT + TAB_ARCH_X64\r
291TAB_LIBRARIES_IPF = TAB_LIBRARIES + TAB_SPLIT + TAB_ARCH_IPF\r
292TAB_LIBRARIES_ARM = TAB_LIBRARIES + TAB_SPLIT + TAB_ARCH_ARM\r
293TAB_LIBRARIES_EBC = TAB_LIBRARIES + TAB_SPLIT + TAB_ARCH_EBC\r
4afd3d04 294TAB_LIBRARIES_AARCH64 = TAB_LIBRARIES + TAB_SPLIT + TAB_ARCH_AARCH64\r
30fdf114
LG
295\r
296TAB_COMPONENTS = 'Components'\r
297TAB_COMPONENTS_COMMON = TAB_COMPONENTS + TAB_SPLIT + TAB_ARCH_COMMON\r
298TAB_COMPONENTS_IA32 = TAB_COMPONENTS + TAB_SPLIT + TAB_ARCH_IA32\r
299TAB_COMPONENTS_X64 = TAB_COMPONENTS + TAB_SPLIT + TAB_ARCH_X64\r
300TAB_COMPONENTS_IPF = TAB_COMPONENTS + TAB_SPLIT + TAB_ARCH_IPF\r
301TAB_COMPONENTS_ARM = TAB_COMPONENTS + TAB_SPLIT + TAB_ARCH_ARM\r
302TAB_COMPONENTS_EBC = TAB_COMPONENTS + TAB_SPLIT + TAB_ARCH_EBC\r
4afd3d04 303TAB_COMPONENTS_AARCH64 = TAB_COMPONENTS + TAB_SPLIT + TAB_ARCH_AARCH64\r
30fdf114
LG
304\r
305TAB_COMPONENTS_SOURCE_OVERRIDE_PATH = 'SOURCE_OVERRIDE_PATH'\r
306\r
307TAB_BUILD_OPTIONS = 'BuildOptions'\r
308\r
309TAB_DEFINE = 'DEFINE'\r
310TAB_NMAKE = 'Nmake'\r
311TAB_USER_EXTENSIONS = 'UserExtensions'\r
312TAB_INCLUDE = '!include'\r
313\r
314#\r
315# Common Define\r
316#\r
317TAB_COMMON_DEFINES = 'Defines'\r
318\r
319#\r
320# Inf Definitions\r
321#\r
322TAB_INF_DEFINES = TAB_COMMON_DEFINES\r
323TAB_INF_DEFINES_INF_VERSION = 'INF_VERSION'\r
324TAB_INF_DEFINES_BASE_NAME = 'BASE_NAME'\r
325TAB_INF_DEFINES_FILE_GUID = 'FILE_GUID'\r
326TAB_INF_DEFINES_MODULE_TYPE = 'MODULE_TYPE'\r
327TAB_INF_DEFINES_EFI_SPECIFICATION_VERSION = 'EFI_SPECIFICATION_VERSION'\r
328TAB_INF_DEFINES_UEFI_SPECIFICATION_VERSION = 'UEFI_SPECIFICATION_VERSION'\r
329TAB_INF_DEFINES_PI_SPECIFICATION_VERSION = 'PI_SPECIFICATION_VERSION'\r
330TAB_INF_DEFINES_EDK_RELEASE_VERSION = 'EDK_RELEASE_VERSION'\r
331TAB_INF_DEFINES_BINARY_MODULE = 'BINARY_MODULE'\r
332TAB_INF_DEFINES_LIBRARY_CLASS = 'LIBRARY_CLASS'\r
333TAB_INF_DEFINES_COMPONENT_TYPE = 'COMPONENT_TYPE'\r
334TAB_INF_DEFINES_MAKEFILE_NAME = 'MAKEFILE_NAME'\r
b36d134f 335TAB_INF_DEFINES_DPX_SOURCE = 'DPX_SOURCE'\r
30fdf114
LG
336TAB_INF_DEFINES_BUILD_NUMBER = 'BUILD_NUMBER'\r
337TAB_INF_DEFINES_BUILD_TYPE = 'BUILD_TYPE'\r
338TAB_INF_DEFINES_FFS_EXT = 'FFS_EXT'\r
339TAB_INF_DEFINES_FV_EXT = 'FV_EXT'\r
340TAB_INF_DEFINES_SOURCE_FV = 'SOURCE_FV'\r
341TAB_INF_DEFINES_VERSION_NUMBER = 'VERSION_NUMBER'\r
b36d134f 342TAB_INF_DEFINES_VERSION = 'VERSION' # for Edk inf, the same as VERSION_NUMBER\r
30fdf114
LG
343TAB_INF_DEFINES_VERSION_STRING = 'VERSION_STRING'\r
344TAB_INF_DEFINES_PCD_IS_DRIVER = 'PCD_IS_DRIVER'\r
b36d134f 345TAB_INF_DEFINES_TIANO_EDK_FLASHMAP_H = 'TIANO_EDK_FLASHMAP_H'\r
30fdf114
LG
346TAB_INF_DEFINES_ENTRY_POINT = 'ENTRY_POINT'\r
347TAB_INF_DEFINES_UNLOAD_IMAGE = 'UNLOAD_IMAGE'\r
348TAB_INF_DEFINES_CONSTRUCTOR = 'CONSTRUCTOR'\r
349TAB_INF_DEFINES_DESTRUCTOR = 'DESTRUCTOR'\r
350TAB_INF_DEFINES_DEFINE = 'DEFINE'\r
351TAB_INF_DEFINES_SPEC = 'SPEC'\r
352TAB_INF_DEFINES_CUSTOM_MAKEFILE = 'CUSTOM_MAKEFILE'\r
353TAB_INF_DEFINES_MACRO = '__MACROS__'\r
354TAB_INF_DEFINES_SHADOW = 'SHADOW'\r
355TAB_INF_FIXED_PCD = 'FixedPcd'\r
356TAB_INF_FEATURE_PCD = 'FeaturePcd'\r
357TAB_INF_PATCH_PCD = 'PatchPcd'\r
358TAB_INF_PCD = 'Pcd'\r
359TAB_INF_PCD_EX = 'PcdEx'\r
4afd3d04
LG
360TAB_INF_USAGE_PRO = 'PRODUCES'\r
361TAB_INF_USAGE_SOME_PRO = 'SOMETIMES_PRODUCES'\r
362TAB_INF_USAGE_CON = 'CONSUMES'\r
363TAB_INF_USAGE_SOME_CON = 'SOMETIMES_CONSUMES'\r
364TAB_INF_USAGE_NOTIFY = 'NOTIFY'\r
365TAB_INF_USAGE_TO_START = 'TO_START'\r
366TAB_INF_USAGE_BY_START = 'BY_START'\r
367TAB_INF_GUIDTYPE_EVENT = 'Event'\r
368TAB_INF_GUIDTYPE_FILE = 'File'\r
369TAB_INF_GUIDTYPE_FV = 'FV'\r
370TAB_INF_GUIDTYPE_GUID = 'GUID'\r
371TAB_INF_GUIDTYPE_HII = 'HII'\r
372TAB_INF_GUIDTYPE_HOB = 'HOB'\r
373TAB_INF_GUIDTYPE_ST = 'SystemTable'\r
374TAB_INF_GUIDTYPE_TSG = 'TokenSpaceGuid'\r
375TAB_INF_GUIDTYPE_VAR = 'Variable'\r
376TAB_INF_GUIDTYPE_PROTOCOL = 'PROTOCOL'\r
377TAB_INF_GUIDTYPE_PPI = 'PPI'\r
97fa0ee9 378TAB_INF_USAGE_UNDEFINED = 'UNDEFINED'\r
30fdf114
LG
379\r
380#\r
381# Dec Definitions\r
382#\r
383TAB_DEC_DEFINES = TAB_COMMON_DEFINES\r
384TAB_DEC_DEFINES_DEC_SPECIFICATION = 'DEC_SPECIFICATION'\r
385TAB_DEC_DEFINES_PACKAGE_NAME = 'PACKAGE_NAME'\r
386TAB_DEC_DEFINES_PACKAGE_GUID = 'PACKAGE_GUID'\r
387TAB_DEC_DEFINES_PACKAGE_VERSION = 'PACKAGE_VERSION'\r
e56468c0 388TAB_DEC_DEFINES_PKG_UNI_FILE = 'PKG_UNI_FILE'\r
30fdf114
LG
389\r
390#\r
391# Dsc Definitions\r
392#\r
393TAB_DSC_DEFINES = TAB_COMMON_DEFINES\r
394TAB_DSC_DEFINES_PLATFORM_NAME = 'PLATFORM_NAME'\r
395TAB_DSC_DEFINES_PLATFORM_GUID = 'PLATFORM_GUID'\r
396TAB_DSC_DEFINES_PLATFORM_VERSION = 'PLATFORM_VERSION'\r
397TAB_DSC_DEFINES_DSC_SPECIFICATION = 'DSC_SPECIFICATION'\r
398TAB_DSC_DEFINES_OUTPUT_DIRECTORY = 'OUTPUT_DIRECTORY'\r
399TAB_DSC_DEFINES_SUPPORTED_ARCHITECTURES = 'SUPPORTED_ARCHITECTURES'\r
400TAB_DSC_DEFINES_BUILD_TARGETS = 'BUILD_TARGETS'\r
401TAB_DSC_DEFINES_SKUID_IDENTIFIER = 'SKUID_IDENTIFIER'\r
e8a47801 402TAB_DSC_DEFINES_PCD_INFO_GENERATION = 'PCD_INFO_GENERATION'\r
82a6a960 403TAB_DSC_DEFINES_PCD_VAR_CHECK_GENERATION = 'PCD_VAR_CHECK_GENERATION'\r
30fdf114
LG
404TAB_DSC_DEFINES_FLASH_DEFINITION = 'FLASH_DEFINITION'\r
405TAB_DSC_DEFINES_BUILD_NUMBER = 'BUILD_NUMBER'\r
406TAB_DSC_DEFINES_MAKEFILE_NAME = 'MAKEFILE_NAME'\r
407TAB_DSC_DEFINES_BS_BASE_ADDRESS = 'BsBaseAddress'\r
408TAB_DSC_DEFINES_RT_BASE_ADDRESS = 'RtBaseAddress'\r
6780eef1
LG
409TAB_DSC_DEFINES_RFC_LANGUAGES = 'RFC_LANGUAGES'\r
410TAB_DSC_DEFINES_ISO_LANGUAGES = 'ISO_LANGUAGES'\r
30fdf114 411TAB_DSC_DEFINES_DEFINE = 'DEFINE'\r
e56468c0 412TAB_DSC_DEFINES_VPD_TOOL_GUID = 'VPD_TOOL_GUID'\r
52302d4d 413TAB_FIX_LOAD_TOP_MEMORY_ADDRESS = 'FIX_LOAD_TOP_MEMORY_ADDRESS'\r
0d2711a6 414TAB_DSC_DEFINES_EDKGLOBAL = 'EDK_GLOBAL'\r
f0dc69e6
YZ
415TAB_DSC_PREBUILD = 'PREBUILD'\r
416TAB_DSC_POSTBUILD = 'POSTBUILD'\r
30fdf114
LG
417#\r
418# TargetTxt Definitions\r
419#\r
420TAB_TAT_DEFINES_ACTIVE_PLATFORM = 'ACTIVE_PLATFORM'\r
421TAB_TAT_DEFINES_ACTIVE_MODULE = 'ACTIVE_MODULE'\r
422TAB_TAT_DEFINES_TOOL_CHAIN_CONF = 'TOOL_CHAIN_CONF'\r
30fdf114
LG
423TAB_TAT_DEFINES_MAX_CONCURRENT_THREAD_NUMBER = 'MAX_CONCURRENT_THREAD_NUMBER'\r
424TAB_TAT_DEFINES_TARGET = 'TARGET'\r
425TAB_TAT_DEFINES_TOOL_CHAIN_TAG = 'TOOL_CHAIN_TAG'\r
426TAB_TAT_DEFINES_TARGET_ARCH = 'TARGET_ARCH'\r
427TAB_TAT_DEFINES_BUILD_RULE_CONF = "BUILD_RULE_CONF"\r
428\r
429#\r
430# ToolDef Definitions\r
431#\r
432TAB_TOD_DEFINES_TARGET = 'TARGET'\r
433TAB_TOD_DEFINES_TOOL_CHAIN_TAG = 'TOOL_CHAIN_TAG'\r
434TAB_TOD_DEFINES_TARGET_ARCH = 'TARGET_ARCH'\r
435TAB_TOD_DEFINES_COMMAND_TYPE = 'COMMAND_TYPE'\r
436TAB_TOD_DEFINES_FAMILY = 'FAMILY'\r
437TAB_TOD_DEFINES_BUILDRULEFAMILY = 'BUILDRULEFAMILY'\r
fe4bf2f9 438TAB_TOD_DEFINES_BUILDRULEORDER = 'BUILDRULEORDER'\r
30fdf114
LG
439\r
440#\r
441# Conditional Statements\r
442#\r
443TAB_IF = '!if'\r
444TAB_END_IF = '!endif'\r
445TAB_ELSE_IF = '!elseif'\r
446TAB_ELSE = '!else'\r
447TAB_IF_DEF = '!ifdef'\r
448TAB_IF_N_DEF = '!ifndef'\r
449TAB_IF_EXIST = '!if exist'\r
8d62ae35 450TAB_ERROR = '!ERROR'\r
30fdf114
LG
451\r
452#\r
453# Unknown section\r
454#\r
455TAB_UNKNOWN = 'UNKNOWN'\r
456\r
457#\r
458# Build database path\r
459#\r
460DATABASE_PATH = ":memory:" #"BuildDatabase.db"\r
461\r
462# used by ECC\r
463MODIFIER_LIST = ['IN', 'OUT', 'OPTIONAL', 'UNALIGNED', 'EFI_RUNTIMESERVICE', 'EFI_BOOTSERVICE', 'EFIAPI']\r
464\r
465# Dependency Expression\r
466DEPEX_SUPPORTED_OPCODE = ["BEFORE", "AFTER", "PUSH", "AND", "OR", "NOT", "END", "SOR", "TRUE", "FALSE", '(', ')']\r
467\r
468TAB_STATIC_LIBRARY = "STATIC-LIBRARY-FILE"\r
469TAB_DYNAMIC_LIBRARY = "DYNAMIC-LIBRARY-FILE"\r
470TAB_FRAMEWORK_IMAGE = "EFI-IMAGE-FILE"\r
471TAB_C_CODE_FILE = "C-CODE-FILE"\r
472TAB_C_HEADER_FILE = "C-HEADER-FILE"\r
473TAB_UNICODE_FILE = "UNICODE-TEXT-FILE"\r
333ba578 474TAB_IMAGE_FILE = "IMAGE-DEFINITION-FILE"\r
30fdf114
LG
475TAB_DEPENDENCY_EXPRESSION_FILE = "DEPENDENCY-EXPRESSION-FILE"\r
476TAB_UNKNOWN_FILE = "UNKNOWN-TYPE-FILE"\r
477TAB_DEFAULT_BINARY_FILE = "_BINARY_FILE_"\r
07b8564b 478TAB_OBJECT_FILE = "OBJECT-FILE"\r
5b97eb4c 479TAB_VFR_FILE = 'VISUAL-FORM-REPRESENTATION-FILE'\r
30fdf114 480\r
64b2609f
LG
481# used by BRG\r
482TAB_BRG_PCD = 'PCD'\r
483TAB_BRG_LIBRARY = 'Library'\r
484\r
485#\r
486# Build Rule File Version Definition\r
487#\r
488TAB_BUILD_RULE_VERSION = "build_rule_version"\r
4afd3d04
LG
489\r
490# section name for PCDs\r
491PCDS_DYNAMIC_DEFAULT = "PcdsDynamicDefault"\r
492PCDS_DYNAMIC_VPD = "PcdsDynamicVpd"\r
493PCDS_DYNAMIC_HII = "PcdsDynamicHii"\r
494PCDS_DYNAMICEX_DEFAULT = "PcdsDynamicExDefault"\r
495PCDS_DYNAMICEX_VPD = "PcdsDynamicExVpd"\r
496PCDS_DYNAMICEX_HII = "PcdsDynamicExHii"\r
497\r
2bc3256c
LG
498SECTIONS_HAVE_ITEM_PCD = [PCDS_DYNAMIC_DEFAULT.upper(),PCDS_DYNAMIC_VPD.upper(),PCDS_DYNAMIC_HII.upper(), \\r
499 PCDS_DYNAMICEX_DEFAULT.upper(),PCDS_DYNAMICEX_VPD.upper(),PCDS_DYNAMICEX_HII.upper()]\r
4afd3d04
LG
500# Section allowed to have items after arch\r
501SECTIONS_HAVE_ITEM_AFTER_ARCH = [TAB_LIBRARY_CLASSES.upper(), TAB_DEPEX.upper(), TAB_USER_EXTENSIONS.upper(),\r
502 PCDS_DYNAMIC_DEFAULT.upper(),\r
503 PCDS_DYNAMIC_VPD.upper(),\r
504 PCDS_DYNAMIC_HII.upper(),\r
505 PCDS_DYNAMICEX_DEFAULT.upper(),\r
506 PCDS_DYNAMICEX_VPD.upper(),\r
507 PCDS_DYNAMICEX_HII.upper(),\r
508 TAB_BUILD_OPTIONS.upper(),\r
509 TAB_INCLUDES.upper()]\r