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