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