xref: /rk3399_ARM-atf/make_helpers/defaults.mk (revision ed8f06ddda52bc0333f79e9ff798419e67771ae5)
1#
2# Copyright (c) 2016-2023, Arm Limited. All rights reserved.
3#
4# SPDX-License-Identifier: BSD-3-Clause
5#
6
7# Default, static values for build variables, listed in alphabetic order.
8# Dependencies between build options, if any, are handled in the top-level
9# Makefile, after this file is included. This ensures that the former is better
10# poised to handle dependencies, as all build variables would have a default
11# value by then.
12
13# Use T32 by default
14AARCH32_INSTRUCTION_SET		:= T32
15
16# The AArch32 Secure Payload to be built as BL32 image
17AARCH32_SP			:= none
18
19# The Target build architecture. Supported values are: aarch64, aarch32.
20ARCH				:= aarch64
21
22# ARM Architecture feature modifiers: none by default
23ARM_ARCH_FEATURE		:= none
24
25# ARM Architecture major and minor versions: 8.0 by default.
26ARM_ARCH_MAJOR			:= 8
27ARM_ARCH_MINOR			:= 0
28
29# Base commit to perform code check on
30BASE_COMMIT			:= origin/master
31
32# Execute BL2 at EL3
33RESET_TO_BL2			:= 0
34
35# Only use SP packages if SP layout JSON is defined
36BL2_ENABLE_SP_LOAD		:= 0
37
38# BL2 image is stored in XIP memory, for now, this option is only supported
39# when RESET_TO_BL2 is 1.
40BL2_IN_XIP_MEM			:= 0
41
42# Do dcache invalidate upon BL2 entry at EL3
43BL2_INV_DCACHE			:= 1
44
45# Select the branch protection features to use.
46BRANCH_PROTECTION		:= 0
47
48# By default, consider that the platform may release several CPUs out of reset.
49# The platform Makefile is free to override this value.
50COLD_BOOT_SINGLE_CPU		:= 0
51
52# Flag to compile in coreboot support code. Exclude by default. The coreboot
53# Makefile system will set this when compiling TF as part of a coreboot image.
54COREBOOT			:= 0
55
56# For Chain of Trust
57CREATE_KEYS			:= 1
58
59# Build flag to include AArch32 registers in cpu context save and restore during
60# world switch. This flag must be set to 0 for AArch64-only platforms.
61CTX_INCLUDE_AARCH32_REGS	:= 1
62
63# Include FP registers in cpu context
64CTX_INCLUDE_FPREGS		:= 0
65
66# Include pointer authentication (ARMv8.3-PAuth) registers in cpu context. This
67# must be set to 1 if the platform wants to use this feature in the Secure
68# world. It is not needed to use it in the Non-secure world.
69CTX_INCLUDE_PAUTH_REGS		:= 0
70
71# Include Nested virtualization control (Armv8.4-NV) registers in cpu context.
72# This must be set to 1 if architecture implements Nested Virtualization
73# Extension and platform wants to use this feature in the Secure world
74CTX_INCLUDE_NEVE_REGS		:= 0
75
76# Debug build
77DEBUG				:= 0
78
79# By default disable authenticated decryption support.
80DECRYPTION_SUPPORT		:= none
81
82# Build platform
83DEFAULT_PLAT			:= fvp
84
85# Disable the generation of the binary image (ELF only).
86DISABLE_BIN_GENERATION		:= 0
87
88# Disable MTPMU if FEAT_MTPMU is supported. Default is 0 to keep backwards
89# compatibility.
90DISABLE_MTPMU			:= 0
91
92# Enable capability to disable authentication dynamically. Only meant for
93# development platforms.
94DYN_DISABLE_AUTH		:= 0
95
96# Build option to enable MPAM for lower ELs
97ENABLE_MPAM_FOR_LOWER_ELS	:= 0
98
99# Enable the Maximum Power Mitigation Mechanism on supporting cores.
100ENABLE_MPMM			:= 0
101
102# Enable MPMM configuration via FCONF.
103ENABLE_MPMM_FCONF		:= 0
104
105# Flag to Enable Position Independant support (PIE)
106ENABLE_PIE			:= 0
107
108# Flag to enable Performance Measurement Framework
109ENABLE_PMF			:= 0
110
111# Flag to enable PSCI STATs functionality
112ENABLE_PSCI_STAT		:= 0
113
114# Flag to enable Realm Management Extension (FEAT_RME)
115ENABLE_RME			:= 0
116
117# Flag to enable runtime instrumentation using PMF
118ENABLE_RUNTIME_INSTRUMENTATION	:= 0
119
120# Flag to enable stack corruption protection
121ENABLE_STACK_PROTECTOR		:= 0
122
123# Flag to enable exception handling in EL3
124EL3_EXCEPTION_HANDLING		:= 0
125
126# Flag to enable Branch Target Identification.
127# Internal flag not meant for direct setting.
128# Use BRANCH_PROTECTION to enable BTI.
129ENABLE_BTI			:= 0
130
131# Flag to enable Pointer Authentication.
132# Internal flag not meant for direct setting.
133# Use BRANCH_PROTECTION to enable PAUTH.
134ENABLE_PAUTH			:= 0
135
136# Flag to enable AMUv1p1 extension.
137ENABLE_FEAT_AMUv1p1		:= 0
138
139# Flag to enable CSV2_2 extension.
140ENABLE_FEAT_CSV2_2 		:= 0
141
142# Flag to enable access to the HCRX_EL2 register by setting SCR_EL3.HXEn.
143ENABLE_FEAT_HCX			:= 0
144
145# Flag to enable access to the HDFGRTR_EL2 register
146ENABLE_FEAT_FGT			:= 0
147
148# Flag to enable access to the CNTPOFF_EL2 register
149ENABLE_FEAT_ECV			:= 0
150
151# Flag to enable use of the DIT feature.
152ENABLE_FEAT_DIT			:= 0
153
154# Flag to enable access to Privileged Access Never bit of PSTATE.
155ENABLE_FEAT_PAN			:= 0
156
157# Flag to enable access to the Random Number Generator registers
158ENABLE_FEAT_RNG			:= 0
159
160# Flag to enable support for EL3 trapping of reads of the RNDR and RNDRRS
161# registers, by setting SCR_EL3.TRNDR.
162ENABLE_FEAT_RNG_TRAP		:= 0
163
164# Flag to enable Speculation Barrier Instruction
165ENABLE_FEAT_SB			:= 0
166
167# Flag to enable Secure EL-2 feature.
168ENABLE_FEAT_SEL2		:= 0
169
170# Flag to enable Virtualization Host Extensions
171ENABLE_FEAT_VHE 		:= 0
172
173# Flag to enable delayed trapping of WFE instruction (FEAT_TWED)
174ENABLE_FEAT_TWED		:= 0
175
176# Flag to enable access to TCR2 (FEAT_TCR2)
177ENABLE_FEAT_TCR2		:= 0
178
179# Flag to enable access to Stage 2 Permission Indirection (FEAT_S2PIE)
180ENABLE_FEAT_S2PIE		:= 0
181
182# Flag to enable access to Stage 1 Permission Indirection (FEAT_S1PIE)
183ENABLE_FEAT_S1PIE		:= 0
184
185# Flag to enable access to Stage 2 Permission Overlay (FEAT_S2POE)
186ENABLE_FEAT_S2POE		:= 0
187
188# Flag to enable access to Stage 1 Permission Overlay (FEAT_S1POE)
189ENABLE_FEAT_S1POE		:= 0
190
191# Flag to enable access to Guarded Control Stack (FEAT_GCS)
192ENABLE_FEAT_GCS			:= 0
193
194# Flag to enable NoTagAccess memory region attribute for stage 2 of translation.
195ENABLE_FEAT_MTE_PERM		:= 0
196
197# By default BL31 encryption disabled
198ENCRYPT_BL31			:= 0
199
200# By default BL32 encryption disabled
201ENCRYPT_BL32			:= 0
202
203# Default dummy firmware encryption key
204ENC_KEY	:= 1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
205
206# Default dummy nonce for firmware encryption
207ENC_NONCE			:= 1234567890abcdef12345678
208
209# Build flag to treat usage of deprecated platform and framework APIs as error.
210ERROR_DEPRECATED		:= 0
211
212# Fault injection support
213FAULT_INJECTION_SUPPORT		:= 0
214
215# Flag to enable architectural features detection mechanism
216FEATURE_DETECTION		:= 0
217
218# Byte alignment that each component in FIP is aligned to
219FIP_ALIGN			:= 0
220
221# Default FIP file name
222FIP_NAME			:= fip.bin
223
224# Default FWU_FIP file name
225FWU_FIP_NAME			:= fwu_fip.bin
226
227# By default firmware encryption with SSK
228FW_ENC_STATUS			:= 0
229
230# For Chain of Trust
231GENERATE_COT			:= 0
232
233# Hint platform interrupt control layer that Group 0 interrupts are for EL3. By
234# default, they are for Secure EL1.
235GICV2_G0_FOR_EL3		:= 0
236
237# Route NS External Aborts to EL3. Disabled by default; External Aborts are handled
238# by lower ELs.
239HANDLE_EA_EL3_FIRST_NS		:= 0
240
241# Secure hash algorithm flag, accepts 3 values: sha256, sha384 and sha512.
242# The default value is sha256.
243HASH_ALG			:= sha256
244
245# Whether system coherency is managed in hardware, without explicit software
246# operations.
247HW_ASSISTED_COHERENCY		:= 0
248
249# Flag to enable trapping of implementation defined sytem registers
250IMPDEF_SYSREG_TRAP		:= 0
251
252# Set the default algorithm for the generation of Trusted Board Boot keys
253KEY_ALG				:= rsa
254
255# Set the default key size in case KEY_ALG is rsa
256ifeq ($(KEY_ALG),rsa)
257KEY_SIZE			:= 2048
258endif
259
260# Option to build TF with Measured Boot support
261MEASURED_BOOT			:= 0
262
263# NS timer register save and restore
264NS_TIMER_SWITCH			:= 0
265
266# Include lib/libc in the final image
267OVERRIDE_LIBC			:= 0
268
269# Build PL011 UART driver in minimal generic UART mode
270PL011_GENERIC_UART		:= 0
271
272# By default, consider that the platform's reset address is not programmable.
273# The platform Makefile is free to override this value.
274PROGRAMMABLE_RESET_ADDRESS	:= 0
275
276# Flag used to choose the power state format: Extended State-ID or Original
277PSCI_EXTENDED_STATE_ID		:= 0
278
279# Enable PSCI OS-initiated mode support
280PSCI_OS_INIT_MODE		:= 0
281
282# Enable RAS Support
283ENABLE_FEAT_RAS			:= 0
284RAS_FFH_SUPPORT			:= 0
285
286# By default, BL1 acts as the reset handler, not BL31
287RESET_TO_BL31			:= 0
288
289# For Chain of Trust
290SAVE_KEYS			:= 0
291
292# Software Delegated Exception support
293SDEI_SUPPORT			:= 0
294
295# True Random Number firmware Interface support
296TRNG_SUPPORT			:= 0
297
298# Check to see if Errata ABI is supported
299ERRATA_ABI_SUPPORT		:= 0
300
301# Check to enable Errata ABI for platforms with non-arm interconnect
302ERRATA_NON_ARM_INTERCONNECT	:= 0
303
304# SMCCC PCI support
305SMC_PCI_SUPPORT			:= 0
306
307# Whether code and read-only data should be put on separate memory pages. The
308# platform Makefile is free to override this value.
309SEPARATE_CODE_AND_RODATA	:= 0
310
311# Put NOBITS sections (.bss, stacks, page tables, and coherent memory) in a
312# separate memory region, which may be discontiguous from the rest of BL31.
313SEPARATE_NOBITS_REGION		:= 0
314
315# Put BL2 NOLOAD sections (.bss, stacks, page tables) in a separate memory
316# region, platform Makefile is free to override this value.
317SEPARATE_BL2_NOLOAD_REGION	:= 0
318
319# If the BL31 image initialisation code is recalimed after use for the secondary
320# cores stack
321RECLAIM_INIT_CODE		:= 0
322
323# SPD choice
324SPD				:= none
325
326# Enable the Management Mode (MM)-based Secure Partition Manager implementation
327SPM_MM				:= 0
328
329# Use the FF-A SPMC implementation in EL3.
330SPMC_AT_EL3			:= 0
331
332# Use SPM at S-EL2 as a default config for SPMD
333SPMD_SPM_AT_SEL2		:= 1
334
335# Flag to introduce an infinite loop in BL1 just before it exits into the next
336# image. This is meant to help debugging the post-BL2 phase.
337SPIN_ON_BL1_EXIT		:= 0
338
339# Flags to build TF with Trusted Boot support
340TRUSTED_BOARD_BOOT		:= 0
341
342# Build option to choose whether Trusted Firmware uses Coherent memory or not.
343USE_COHERENT_MEM		:= 1
344
345# Build option to add debugfs support
346USE_DEBUGFS			:= 0
347
348# Build option to fconf based io
349ARM_IO_IN_DTB			:= 0
350
351# Build option to support SDEI through fconf
352SDEI_IN_FCONF			:= 0
353
354# Build option to support Secure Interrupt descriptors through fconf
355SEC_INT_DESC_IN_FCONF		:= 0
356
357# Build option to choose whether Trusted Firmware uses library at ROM
358USE_ROMLIB			:= 0
359
360# Build option to choose whether the xlat tables of BL images can be read-only.
361# Note that this only serves as a higher level option to PLAT_RO_XLAT_TABLES,
362# which is the per BL-image option that actually enables the read-only tables
363# API. The reason for having this additional option is to have a common high
364# level makefile where we can check for incompatible features/build options.
365ALLOW_RO_XLAT_TABLES		:= 0
366
367# Chain of trust.
368COT				:= tbbr
369
370# Use tbbr_oid.h instead of platform_oid.h
371USE_TBBR_DEFS			:= 1
372
373# Build verbosity
374V				:= 0
375
376# Whether to enable D-Cache early during warm boot. This is usually
377# applicable for platforms wherein interconnect programming is not
378# required to enable cache coherency after warm reset (eg: single cluster
379# platforms).
380WARMBOOT_ENABLE_DCACHE_EARLY	:= 0
381
382# Build option to enable/disable the Statistical Profiling Extensions
383ENABLE_SPE_FOR_NS		:= 2
384
385# SPE is only supported on AArch64 so disable it on AArch32.
386ifeq (${ARCH},aarch32)
387	override ENABLE_SPE_FOR_NS := 0
388endif
389
390# Include Memory Tagging Extension registers in cpu context. This must be set
391# to 1 if the platform wants to use this feature in the Secure world and MTE is
392# enabled at ELX.
393CTX_INCLUDE_MTE_REGS		:= 0
394
395ENABLE_FEAT_AMU			:= 0
396ENABLE_AMU_AUXILIARY_COUNTERS	:= 0
397ENABLE_AMU_FCONF		:= 0
398AMU_RESTRICT_COUNTERS		:= 0
399
400# Enable SVE for non-secure world by default
401ENABLE_SVE_FOR_NS		:= 2
402# SVE is only supported on AArch64 so disable it on AArch32.
403ifeq (${ARCH},aarch32)
404	override ENABLE_SVE_FOR_NS	:= 0
405endif
406ENABLE_SVE_FOR_SWD		:= 0
407
408# Default SVE vector length to maximum architected value
409SVE_VECTOR_LEN			:= 2048
410
411# SME defaults to disabled
412ENABLE_SME_FOR_NS		:= 0
413ENABLE_SME_FOR_SWD		:= 0
414ENABLE_SME2_FOR_NS		:= 0
415
416SANITIZE_UB := off
417
418# For ARMv8.1 (AArch64) platforms, enabling this option selects the spinlock
419# implementation variant using the ARMv8.1-LSE compare-and-swap instruction.
420# Default: disabled
421USE_SPINLOCK_CAS := 0
422
423# Enable Link Time Optimization
424ENABLE_LTO			:= 0
425
426# This option will include EL2 registers in cpu context save and restore during
427# EL2 firmware entry/exit. Internal flag not meant for direct setting.
428# Use SPD=spmd and SPMD_SPM_AT_SEL2=1 or ENABLE_RME=1 to enable
429# CTX_INCLUDE_EL2_REGS.
430CTX_INCLUDE_EL2_REGS		:= 0
431
432# Enable Memory tag extension which is supported for architecture greater
433# than Armv8.5-A
434# By default it is set to "no"
435SUPPORT_STACK_MEMTAG		:= no
436
437# Select workaround for AT speculative behaviour.
438ERRATA_SPECULATIVE_AT		:= 0
439
440# Trap RAS error record access from Non secure
441RAS_TRAP_NS_ERR_REC_ACCESS	:= 0
442
443# Build option to create cot descriptors using fconf
444COT_DESC_IN_DTB			:= 0
445
446# Build option to provide OpenSSL directory path
447OPENSSL_DIR			:= /usr
448
449# Select the openssl binary provided in OPENSSL_DIR variable
450ifeq ("$(wildcard ${OPENSSL_DIR}/bin)", "")
451    OPENSSL_BIN_PATH = ${OPENSSL_DIR}/apps
452else
453    OPENSSL_BIN_PATH = ${OPENSSL_DIR}/bin
454endif
455
456# Build option to use the SP804 timer instead of the generic one
457USE_SP804_TIMER			:= 0
458
459# Build option to define number of firmware banks, used in firmware update
460# metadata structure.
461NR_OF_FW_BANKS			:= 2
462
463# Build option to define number of images in firmware bank, used in firmware
464# update metadata structure.
465NR_OF_IMAGES_IN_FW_BANK		:= 1
466
467# Disable Firmware update support by default
468PSA_FWU_SUPPORT			:= 0
469
470# By default, disable access of trace buffer control registers from NS
471# lower ELs  i.e. NS-EL2, or NS-EL1 if NS-EL2 implemented but unused
472# if FEAT_TRBE is implemented.
473# Note FEAT_TRBE is only supported on AArch64 - therefore do not enable in
474# AArch32.
475ifneq (${ARCH},aarch32)
476	ENABLE_TRBE_FOR_NS		:= 0
477else
478	override ENABLE_TRBE_FOR_NS	:= 0
479endif
480
481# By default, disable access to branch record buffer control registers from NS
482# lower ELs i.e. NS-EL2, or NS-EL1 if NS-EL2 implemented but unused
483# if FEAT_BRBE is implemented.
484ENABLE_BRBE_FOR_NS		:= 0
485
486# By default, disable access of trace system registers from NS lower
487# ELs  i.e. NS-EL2, or NS-EL1 if NS-EL2 implemented but unused if
488# system register trace is implemented.
489ENABLE_SYS_REG_TRACE_FOR_NS	:= 0
490
491# By default, disable trace filter control registers access to NS
492# lower ELs, i.e. NS-EL2, or NS-EL1 if NS-EL2 implemented but unused
493# if FEAT_TRF is implemented.
494ENABLE_TRF_FOR_NS		:= 0
495
496# In v8.6+ platforms with delayed trapping of WFE being supported
497# via FEAT_TWED, this flag takes the delay value to be set in the
498# SCR_EL3.TWEDEL(4bit) field, when FEAT_TWED is implemented.
499# By default it takes 0, and need to be updated by the platforms.
500TWED_DELAY			:= 0
501
502# By default, disable the mocking of RSS provided services
503PLAT_RSS_NOT_SUPPORTED		:= 0
504
505# Dynamic Root of Trust for Measurement support
506DRTM_SUPPORT			:= 0
507
508# Check platform if cache management operations should be performed.
509# Disabled by default.
510CONDITIONAL_CMO			:= 0
511
512# By default, disable SPMD Logical partitions
513ENABLE_SPMD_LP			:= 0
514