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