blob: 2a4226941a6435018f260fc015900458ab2aeef1 [file] [log] [blame]
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +01001Build Options
2=============
3
4The TF-A build system supports the following build options. Unless mentioned
5otherwise, these options are expected to be specified at the build command
6line and are not to be modified in any component makefiles. Note that the
7build system doesn't track dependency for build options. Therefore, if any of
8the build options are changed from a previous build, a clean build must be
9performed.
10
11.. _build_options_common:
12
13Common build options
14--------------------
15
16- ``AARCH32_INSTRUCTION_SET``: Choose the AArch32 instruction set that the
17 compiler should use. Valid values are T32 and A32. It defaults to T32 due to
18 code having a smaller resulting size.
19
20- ``AARCH32_SP`` : Choose the AArch32 Secure Payload component to be built as
21 as the BL32 image when ``ARCH=aarch32``. The value should be the path to the
22 directory containing the SP source, relative to the ``bl32/``; the directory
23 is expected to contain a makefile called ``<aarch32_sp-value>.mk``.
24
johpow01fa59c6f2020-10-02 13:41:11 -050025- ``AMU_RESTRICT_COUNTERS``: Register reads to the group 1 counters will return
Juan Pablo Conde79b5f572024-04-03 13:18:40 -050026 zero at all but the highest implemented exception level. External
27 memory-mapped debug accesses are unaffected by this control.
28 The default value is 1 for all platforms.
johpow01fa59c6f2020-10-02 13:41:11 -050029
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +010030- ``ARCH`` : Choose the target build architecture for TF-A. It can take either
31 ``aarch64`` or ``aarch32`` as values. By default, it is defined to
32 ``aarch64``.
33
Alexei Fedorov132e6652020-12-07 16:38:53 +000034- ``ARM_ARCH_FEATURE``: Optional Arm Architecture build option which specifies
35 one or more feature modifiers. This option has the form ``[no]feature+...``
36 and defaults to ``none``. It translates into compiler option
37 ``-march=armvX[.Y]-a+[no]feature+...``. See compiler's documentation for the
38 list of supported feature modifiers.
39
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +010040- ``ARM_ARCH_MAJOR``: The major version of Arm Architecture to target when
41 compiling TF-A. Its value must be numeric, and defaults to 8 . See also,
42 *Armv8 Architecture Extensions* and *Armv7 Architecture Extensions* in
43 :ref:`Firmware Design`.
44
45- ``ARM_ARCH_MINOR``: The minor version of Arm Architecture to target when
46 compiling TF-A. Its value must be a numeric, and defaults to 0. See also,
47 *Armv8 Architecture Extensions* in :ref:`Firmware Design`.
48
Manish V Badarkheb59efca2023-06-27 11:40:21 +010049- ``ARM_BL2_SP_LIST_DTS``: Path to DTS file snippet to override the hardcoded
50 SP nodes in tb_fw_config.
51
52- ``ARM_SPMC_MANIFEST_DTS`` : path to an alternate manifest file used as the
53 SPMC Core manifest. Valid when ``SPD=spmd`` is selected.
54
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +010055- ``BL2``: This is an optional build option which specifies the path to BL2
56 image for the ``fip`` target. In this case, the BL2 in the TF-A will not be
57 built.
58
59- ``BL2U``: This is an optional build option which specifies the path to
60 BL2U image. In this case, the BL2U in TF-A will not be built.
61
Arvind Ram Prakash11b9b492022-11-22 14:41:00 -060062- ``RESET_TO_BL2``: Boolean option to enable BL2 entrypoint as the CPU reset
63 vector instead of the BL1 entrypoint. It can take the value 0 (CPU reset to BL1
64 entrypoint) or 1 (CPU reset to BL2 entrypoint).
65 The default value is 0.
66
67- ``BL2_RUNS_AT_EL3``: This is an implicit flag to denote that BL2 runs at EL3.
68 While it is explicitly set to 1 when RESET_TO_BL2 is set to 1 it can also be
69 true in a 4-world system where RESET_TO_BL2 is 0.
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +010070
Balint Dobszay719ba9c2021-03-26 16:23:18 +010071- ``BL2_ENABLE_SP_LOAD``: Boolean option to enable loading SP packages from the
72 FIP. Automatically enabled if ``SP_LAYOUT_FILE`` is provided.
73
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +010074- ``BL2_IN_XIP_MEM``: In some use-cases BL2 will be stored in eXecute In Place
75 (XIP) memory, like BL1. In these use-cases, it is necessary to initialize
76 the RW sections in RAM, while leaving the RO sections in place. This option
Arvind Ram Prakash11b9b492022-11-22 14:41:00 -060077 enable this use-case. For now, this option is only supported
78 when RESET_TO_BL2 is set to '1'.
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +010079
80- ``BL31``: This is an optional build option which specifies the path to
81 BL31 image for the ``fip`` target. In this case, the BL31 in TF-A will not
82 be built.
83
Robin van der Gracht06b5cdb2023-09-12 11:16:23 +020084- ``BL31_KEY``: This option is used when ``GENERATE_COT=1``. It specifies a
85 file that contains the BL31 private key in PEM format or a PKCS11 URI. If
86 ``SAVE_KEYS=1``, only a file is accepted and it will be used to save the key.
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +010087
88- ``BL32``: This is an optional build option which specifies the path to
89 BL32 image for the ``fip`` target. In this case, the BL32 in TF-A will not
90 be built.
91
92- ``BL32_EXTRA1``: This is an optional build option which specifies the path to
93 Trusted OS Extra1 image for the ``fip`` target.
94
95- ``BL32_EXTRA2``: This is an optional build option which specifies the path to
96 Trusted OS Extra2 image for the ``fip`` target.
97
Robin van der Gracht06b5cdb2023-09-12 11:16:23 +020098- ``BL32_KEY``: This option is used when ``GENERATE_COT=1``. It specifies a
99 file that contains the BL32 private key in PEM format or a PKCS11 URI. If
100 ``SAVE_KEYS=1``, only a file is accepted and it will be used to save the key.
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100101
Jaylyn Renfd5ff022024-08-02 11:58:23 +0100102- ``RMM``: This is an optional build option used when ``ENABLE_RME`` is set.
103 It specifies the path to RMM binary for the ``fip`` target. If the RMM option
104 is not specified, TF-A builds the TRP to load and run at R-EL2.
105
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100106- ``BL33``: Path to BL33 image in the host file system. This is mandatory for
107 ``fip`` target in case TF-A BL2 is used.
108
Robin van der Gracht06b5cdb2023-09-12 11:16:23 +0200109- ``BL33_KEY``: This option is used when ``GENERATE_COT=1``. It specifies a
110 file that contains the BL33 private key in PEM format or a PKCS11 URI. If
111 ``SAVE_KEYS=1``, only a file is accepted and it will be used to save the key.
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100112
113- ``BRANCH_PROTECTION``: Numeric value to enable ARMv8.3 Pointer Authentication
114 and ARMv8.5 Branch Target Identification support for TF-A BL images themselves.
115 If enabled, it is needed to use a compiler that supports the option
Boyan Karatotevaebc7e92025-04-02 11:16:18 +0100116 ``-mbranch-protection``. The value of the ``-march`` (via ``ARM_ARCH_MINOR``
117 and ``ARM_ARCH_MAJOR``) option will control which instructions will be
118 emitted (HINT space or not). Selects the branch protection features to use:
119- 0: Default value turns off all types of branch protection (FEAT_STATE_DISABLED)
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100120- 1: Enables all types of branch protection features
121- 2: Return address signing to its standard level
122- 3: Extend the signing to include leaf functions
Alexei Fedorove039e482020-06-19 14:33:49 +0100123- 4: Turn on branch target identification mechanism
Boyan Karatotevaebc7e92025-04-02 11:16:18 +0100124- 5: Enables all types of branch protection features, only if present in
125 hardware (FEAT_STATE_CHECK).
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100126
127 The table below summarizes ``BRANCH_PROTECTION`` values, GCC compilation options
128 and resulting PAuth/BTI features.
129
130 +-------+--------------+-------+-----+
131 | Value | GCC option | PAuth | BTI |
132 +=======+==============+=======+=====+
133 | 0 | none | N | N |
134 +-------+--------------+-------+-----+
135 | 1 | standard | Y | Y |
136 +-------+--------------+-------+-----+
137 | 2 | pac-ret | Y | N |
138 +-------+--------------+-------+-----+
139 | 3 | pac-ret+leaf | Y | N |
140 +-------+--------------+-------+-----+
Alexei Fedorove039e482020-06-19 14:33:49 +0100141 | 4 | bti | N | Y |
142 +-------+--------------+-------+-----+
Boyan Karatotevaebc7e92025-04-02 11:16:18 +0100143 | 5 | dynamic | Y | Y |
144 +-------+--------------+-------+-----+
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100145
Manish Pandey34a305e2021-10-21 21:53:49 +0100146 This option defaults to 0.
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100147 Note that Pointer Authentication is enabled for Non-secure world
148 irrespective of the value of this option if the CPU supports it.
149
150- ``BUILD_MESSAGE_TIMESTAMP``: String used to identify the time and date of the
151 compilation of each build. It must be set to a C string (including quotes
152 where applicable). Defaults to a string that contains the time and date of
153 the compilation.
154
155- ``BUILD_STRING``: Input string for VERSION_STRING, which allows the TF-A
156 build to be uniquely identified. Defaults to the current git commit id.
157
Grant Likely388248a2020-07-30 08:50:10 +0100158- ``BUILD_BASE``: Output directory for the build. Defaults to ``./build``
159
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100160- ``CFLAGS``: Extra user options appended on the compiler's command line in
161 addition to the options set by the build system.
162
163- ``COLD_BOOT_SINGLE_CPU``: This option indicates whether the platform may
164 release several CPUs out of reset. It can take either 0 (several CPUs may be
165 brought up) or 1 (only one CPU will ever be brought up during cold reset).
166 Default is 0. If the platform always brings up a single CPU, there is no
167 need to distinguish between primary and secondary CPUs and the boot path can
168 be optimised. The ``plat_is_my_cpu_primary()`` and
169 ``plat_secondary_cold_boot_setup()`` platform porting interfaces do not need
170 to be implemented in this case.
171
Sandrine Bailleuxd4c1d442020-01-15 10:23:25 +0100172- ``COT``: When Trusted Boot is enabled, selects the desired chain of trust.
173 Defaults to ``tbbr``.
174
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100175- ``CRASH_REPORTING``: A non-zero value enables a console dump of processor
176 register state when an unexpected exception occurs during execution of
177 BL31. This option defaults to the value of ``DEBUG`` - i.e. by default
178 this is only enabled for a debug build of the firmware.
179
180- ``CREATE_KEYS``: This option is used when ``GENERATE_COT=1``. It tells the
181 certificate generation tool to create new keys in case no valid keys are
182 present or specified. Allowed options are '0' or '1'. Default is '1'.
183
184- ``CTX_INCLUDE_AARCH32_REGS`` : Boolean option that, when set to 1, will cause
185 the AArch32 system registers to be included when saving and restoring the
186 CPU context. The option must be set to 0 for AArch64-only platforms (that
187 is on hardware that does not implement AArch32, or at least not at EL1 and
188 higher ELs). Default value is 1.
189
190- ``CTX_INCLUDE_FPREGS``: Boolean option that, when set to 1, will cause the FP
191 registers to be included when saving and restoring the CPU context. Default
192 is 0.
193
Arvind Ram Prakash4851b492023-10-06 14:35:21 -0500194- ``CTX_INCLUDE_MPAM_REGS``: Boolean option that, when set to 1, will cause the
195 Memory System Resource Partitioning and Monitoring (MPAM)
196 registers to be included when saving and restoring the CPU context.
197 Default is '0'.
198
Jayanth Dodderi Chidanand38b461a2022-02-28 23:41:41 +0000199- ``CTX_INCLUDE_NEVE_REGS``: Numeric value, when set will cause the Armv8.4-NV
200 registers to be saved/restored when entering/exiting an EL2 execution
201 context. This flag can take values 0 to 2, to align with the
Andre Przywara9563c502023-11-23 16:40:13 +0000202 ``ENABLE_FEAT`` mechanism. Default value is 0.
Jayanth Dodderi Chidanand38b461a2022-02-28 23:41:41 +0000203
204- ``CTX_INCLUDE_PAUTH_REGS``: Numeric value to enable the Pointer
205 Authentication for Secure world. This will cause the ARMv8.3-PAuth registers
206 to be included when saving and restoring the CPU context as part of world
Boyan Karatotevaebc7e92025-04-02 11:16:18 +0100207 switch. Automatically enabled when ``BRANCH_PROTECTION`` is enabled. This flag
208 can take values 0 to 2, to align with ``ENABLE_FEAT`` mechanism. Default value
209 is 0.
Jayanth Dodderi Chidanand38b461a2022-02-28 23:41:41 +0000210
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100211 Note that Pointer Authentication is enabled for Non-secure world irrespective
Boyan Karatotevaebc7e92025-04-02 11:16:18 +0100212 of the value of this flag if the CPU supports it. Alternatively, when
213 ``BRANCH_PROTECTION`` is enabled, this flag is superseded.
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100214
Madhukar Pappireddy10a89192024-07-05 12:44:08 -0500215- ``CTX_INCLUDE_SVE_REGS``: Boolean option that, when set to 1, will cause the
216 SVE registers to be included when saving and restoring the CPU context. Note
217 that this build option requires ``ENABLE_SVE_FOR_SWD`` to be enabled. In
218 general, it is recommended to perform SVE context management in lower ELs
219 and skip in EL3 due to the additional cost of maintaining large data
220 structures to track the SVE state. Hence, the default value is 0.
221
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100222- ``DEBUG``: Chooses between a debug and release build. It can take either 0
223 (release) or 1 (debug) as values. 0 is the default.
224
Sumit Garg392e4df2019-11-15 10:43:00 +0530225- ``DECRYPTION_SUPPORT``: This build flag enables the user to select the
226 authenticated decryption algorithm to be used to decrypt firmware/s during
227 boot. It accepts 2 values: ``aes_gcm`` and ``none``. The default value of
228 this flag is ``none`` to disable firmware decryption which is an optional
Manish Pandey34a305e2021-10-21 21:53:49 +0100229 feature as per TBBR.
Sumit Garg392e4df2019-11-15 10:43:00 +0530230
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100231- ``DISABLE_BIN_GENERATION``: Boolean option to disable the generation
232 of the binary image. If set to 1, then only the ELF image is built.
233 0 is the default.
234
Boyan Karatotev677ed8a2023-02-16 09:45:29 +0000235- ``DISABLE_MTPMU``: Numeric option to disable ``FEAT_MTPMU`` (Multi Threaded
236 PMU). ``FEAT_MTPMU`` is an optional feature available on Armv8.6 onwards.
Andre Przywara9563c502023-11-23 16:40:13 +0000237 This flag can take values 0 to 2, to align with the ``ENABLE_FEAT``
Boyan Karatotev677ed8a2023-02-16 09:45:29 +0000238 mechanism. Default is ``0``.
Javier Almansa Sobrinof3a4c542020-11-23 18:38:15 +0000239
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100240- ``DYN_DISABLE_AUTH``: Provides the capability to dynamically disable Trusted
241 Board Boot authentication at runtime. This option is meant to be enabled only
242 for development platforms. ``TRUSTED_BOARD_BOOT`` flag must be set if this
243 flag has to be enabled. 0 is the default.
244
245- ``E``: Boolean option to make warnings into errors. Default is 1.
246
Boyan Karatoteve9e7e8a2022-12-07 10:26:48 +0000247 When specifying higher warnings levels (``W=1`` and higher), this option
248 defaults to 0. This is done to encourage contributors to use them, as they
249 are expected to produce warnings that would otherwise fail the build. New
250 contributions are still expected to build with ``W=0`` and ``E=1`` (the
251 default).
252
Yann Gautier5ae29c02024-01-16 19:39:31 +0100253- ``EARLY_CONSOLE``: This option is used to enable early traces before default
254 console is properly setup. It introduces EARLY_* traces macros, that will
255 use the non-EARLY traces macros if the flag is enabled, or do nothing
256 otherwise. To use this feature, platforms will have to create the function
257 plat_setup_early_console().
258 Default is 0 (disabled)
259
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100260- ``EL3_PAYLOAD_BASE``: This option enables booting an EL3 payload instead of
261 the normal boot flow. It must specify the entry point address of the EL3
262 payload. Please refer to the "Booting an EL3 payload" section for more
263 details.
264
Chris Kay925fda42021-05-25 10:42:56 +0100265- ``ENABLE_AMU_AUXILIARY_COUNTERS``: Enables support for AMU auxiliary counters
266 (also known as group 1 counters). These are implementation-defined counters,
267 and as such require additional platform configuration. Default is 0.
268
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100269- ``ENABLE_ASSERTIONS``: This option controls whether or not calls to ``assert()``
270 are compiled out. For debug builds, this option defaults to 1, and calls to
271 ``assert()`` are left in place. For release builds, this option defaults to 0
272 and calls to ``assert()`` function are compiled out. This option can be set
273 independently of ``DEBUG``. It can also be used to hide any auxiliary code
274 that is only required for the assertion and does not fit in the assertion
275 itself.
276
Alexei Fedorovb8f26e92020-02-06 17:11:03 +0000277- ``ENABLE_BACKTRACE``: This option controls whether to enable backtrace
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100278 dumps or not. It is supported in both AArch64 and AArch32. However, in
279 AArch32 the format of the frame records are not defined in the AAPCS and they
280 are defined by the implementation. This implementation of backtrace only
281 supports the format used by GCC when T32 interworking is disabled. For this
282 reason enabling this option in AArch32 will force the compiler to only
283 generate A32 code. This option is enabled by default only in AArch64 debug
284 builds, but this behaviour can be overridden in each platform's Makefile or
285 in the build command line.
286
Andre Przywara9563c502023-11-23 16:40:13 +0000287- ``ENABLE_FEAT``
288 The Arm architecture defines several architecture extension features,
289 named FEAT_xxx in the architecure manual. Some of those features require
290 setup code in higher exception levels, other features might be used by TF-A
291 code itself.
292 Most of the feature flags defined in the TF-A build system permit to take
293 the values 0, 1 or 2, with the following meaning:
294
295 ::
296
297 ENABLE_FEAT_* = 0: Feature is disabled statically at compile time.
298 ENABLE_FEAT_* = 1: Feature is enabled unconditionally at compile time.
299 ENABLE_FEAT_* = 2: Feature is enabled, but checked at runtime.
300
301 When setting the flag to 0, the feature is disabled during compilation,
302 and the compiler's optimisation stage and the linker will try to remove
303 as much of this code as possible.
304 If it is defined to 1, the code will use the feature unconditionally, so the
305 CPU is expected to support that feature. The FEATURE_DETECTION debug
306 feature, if enabled, will verify this.
307 If the feature flag is set to 2, support for the feature will be compiled
308 in, but its existence will be checked at runtime, so it works on CPUs with
309 or without the feature. This is mostly useful for platforms which either
310 support multiple different CPUs, or where the CPU is configured at runtime,
311 like in emulators.
312
Andre Przywara0b7f1b02023-03-21 13:53:19 +0000313- ``ENABLE_FEAT_AMU``: Numeric value to enable Activity Monitor Unit
314 extensions. This flag can take the values 0 to 2, to align with the
Andre Przywara9563c502023-11-23 16:40:13 +0000315 ``ENABLE_FEAT`` mechanism. This is an optional architectural feature
Andre Przywara0b7f1b02023-03-21 13:53:19 +0000316 available on v8.4 onwards. Some v8.2 implementations also implement an AMU
317 and this option can be used to enable this feature on those systems as well.
318 This flag can take the values 0 to 2, the default is 0.
Jayanth Dodderi Chidanand38b461a2022-02-28 23:41:41 +0000319
320- ``ENABLE_FEAT_AMUv1p1``: Numeric value to enable the ``FEAT_AMUv1p1``
321 extension. ``FEAT_AMUv1p1`` is an optional feature available on Arm v8.6
322 onwards. This flag can take the values 0 to 2, to align with the
Andre Przywara9563c502023-11-23 16:40:13 +0000323 ``ENABLE_FEAT`` mechanism. Default value is ``0``.
Jayanth Dodderi Chidanand38b461a2022-02-28 23:41:41 +0000324
325- ``ENABLE_FEAT_CSV2_2``: Numeric value to enable the ``FEAT_CSV2_2``
326 extension. It allows access to the SCXTNUM_EL2 (Software Context Number)
327 register during EL2 context save/restore operations. ``FEAT_CSV2_2`` is an
328 optional feature available on Arm v8.0 onwards. This flag can take values
Andre Przywara9563c502023-11-23 16:40:13 +0000329 0 to 2, to align with the ``ENABLE_FEAT`` mechanism.
Jayanth Dodderi Chidanand38b461a2022-02-28 23:41:41 +0000330 Default value is ``0``.
331
Sona Mathew3b84c962023-10-25 16:48:19 -0500332- ``ENABLE_FEAT_CSV2_3``: Numeric value to enable support for ``FEAT_CSV2_3``
333 extension. This feature is supported in AArch64 state only and is an optional
334 feature available in Arm v8.0 implementations.
335 ``FEAT_CSV2_3`` implies the implementation of ``FEAT_CSV2_2``.
336 The flag can take values 0 to 2, to align with the ``ENABLE_FEAT``
337 mechanism. Default value is ``0``.
338
Arvind Ram Prakash05b47632024-05-22 15:24:00 -0500339- ``ENABLE_FEAT_DEBUGV8P9``: Numeric value to enable ``FEAT_DEBUGV8P9``
340 extension which allows the ability to implement more than 16 breakpoints
341 and/or watchpoints. This feature is mandatory from v8.9 and is optional
342 from v8.8. This flag can take the values of 0 to 2, to align with the
343 ``ENABLE_FEAT`` mechanism. Default value is ``0``.
344
Jayanth Dodderi Chidanand38b461a2022-02-28 23:41:41 +0000345- ``ENABLE_FEAT_DIT``: Numeric value to enable ``FEAT_DIT`` (Data Independent
346 Timing) extension. It allows setting the ``DIT`` bit of PSTATE in EL3.
347 ``FEAT_DIT`` is a mandatory architectural feature and is enabled from v8.4
348 and upwards. This flag can take the values 0 to 2, to align with the
Andre Przywara9563c502023-11-23 16:40:13 +0000349 ``ENABLE_FEAT`` mechanism. Default value is ``0``.
Jayanth Dodderi Chidanand76ff3632021-12-05 19:21:14 +0000350
Jayanth Dodderi Chidanand38b461a2022-02-28 23:41:41 +0000351- ``ENABLE_FEAT_ECV``: Numeric value to enable support for the Enhanced Counter
Jayanth Dodderi Chidanand76ff3632021-12-05 19:21:14 +0000352 Virtualization feature, allowing for access to the CNTPOFF_EL2 (Counter-timer
353 Physical Offset register) during EL2 to EL3 context save/restore operations.
Jayanth Dodderi Chidanand38b461a2022-02-28 23:41:41 +0000354 Its a mandatory architectural feature and is enabled from v8.6 and upwards.
Andre Przywara9563c502023-11-23 16:40:13 +0000355 This flag can take the values 0 to 2, to align with the ``ENABLE_FEAT``
Jayanth Dodderi Chidanand38b461a2022-02-28 23:41:41 +0000356 mechanism. Default value is ``0``.
Jayanth Dodderi Chidanand76ff3632021-12-05 19:21:14 +0000357
Arvind Ram Prakashe558f9c2024-11-11 14:32:37 -0600358- ``ENABLE_FEAT_FPMR``: Numerical value to enable support for Floating Point
359 Mode Register feature, allowing access to the FPMR register. FPMR register
360 controls the behaviors of FP8 instructions. It is an optional architectural
361 feature from v9.2 and upwards. This flag can take value of 0 to 2, to align
362 with the ``FEATURE_DETECTION`` mechanism. Default value is ``0``.
363
Jayanth Dodderi Chidanand38b461a2022-02-28 23:41:41 +0000364- ``ENABLE_FEAT_FGT``: Numeric value to enable support for FGT (Fine Grain Traps)
Jayanth Dodderi Chidanand76ff3632021-12-05 19:21:14 +0000365 feature allowing for access to the HDFGRTR_EL2 (Hypervisor Debug Fine-Grained
Jayanth Dodderi Chidanand38b461a2022-02-28 23:41:41 +0000366 Read Trap Register) during EL2 to EL3 context save/restore operations.
367 Its a mandatory architectural feature and is enabled from v8.6 and upwards.
Andre Przywara9563c502023-11-23 16:40:13 +0000368 This flag can take the values 0 to 2, to align with the ``ENABLE_FEAT``
Jayanth Dodderi Chidanand38b461a2022-02-28 23:41:41 +0000369 mechanism. Default value is ``0``.
370
Arvind Ram Prakash62d87e72024-06-06 11:33:37 -0500371- ``ENABLE_FEAT_FGT2``: Numeric value to enable support for FGT2
372 (Fine Grain Traps 2) feature allowing for access to Fine-grained trap 2 registers
373 during EL2 to EL3 context save/restore operations.
374 Its an optional architectural feature and is available from v8.8 and upwards.
375 This flag can take the values 0 to 2, to align with the ``ENABLE_FEAT``
376 mechanism. Default value is ``0``.
377
Jayanth Dodderi Chidanand38b461a2022-02-28 23:41:41 +0000378- ``ENABLE_FEAT_HCX``: Numeric value to set the bit SCR_EL3.HXEn in EL3 to
379 allow access to HCRX_EL2 (extended hypervisor control register) from EL2 as
380 well as adding HCRX_EL2 to the EL2 context save/restore operations. Its a
381 mandatory architectural feature and is enabled from v8.7 and upwards. This
Andre Przywara9563c502023-11-23 16:40:13 +0000382 flag can take the values 0 to 2, to align with the ``ENABLE_FEAT``
Jayanth Dodderi Chidanand38b461a2022-02-28 23:41:41 +0000383 mechanism. Default value is ``0``.
384
Arvind Ram Prakashf915deb2025-01-09 17:18:30 -0600385- ``ENABLE_FEAT_MOPS``: Numeric value to enable FEAT_MOPS (Standardization
386 of memory operations) when INIT_UNUSED_NS_EL2=1.
387 This feature is mandatory from v8.8 and enabling of FEAT_MOPS does not
388 require any settings from EL3 as the controls are present in EL2 registers
389 (HCRX_EL2.{MSCEn,MCE2} and SCTLR_EL2.MSCEn) and in most configurations
390 we expect EL2 to be present. But in case of INIT_UNUSED_NS_EL2=1 ,
391 EL3 should configure the EL2 registers. This flag
392 can take values 0 to 2, to align with the ``ENABLE_FEAT`` mechanism.
393 Default value is ``0``.
394
Govindraj Rajad7b63ac2024-01-26 10:08:37 -0600395- ``ENABLE_FEAT_MTE2``: Numeric value to enable Memory Tagging Extension2
396 if the platform wants to use this feature and MTE2 is enabled at ELX.
397 This flag can take values 0 to 2, to align with the ``ENABLE_FEAT``
398 mechanism. Default value is ``0``.
Govindraj Raja24d3a4e2023-12-21 13:57:49 -0600399
Jayanth Dodderi Chidanand38b461a2022-02-28 23:41:41 +0000400- ``ENABLE_FEAT_PAN``: Numeric value to enable the ``FEAT_PAN`` (Privileged
401 Access Never) extension. ``FEAT_PAN`` adds a bit to PSTATE, generating a
402 permission fault for any privileged data access from EL1/EL2 to virtual
403 memory address, accessible at EL0, provided (HCR_EL2.E2H=1). It is a
404 mandatory architectural feature and is enabled from v8.1 and upwards. This
Andre Przywara9563c502023-11-23 16:40:13 +0000405 flag can take values 0 to 2, to align with the ``ENABLE_FEAT``
Jayanth Dodderi Chidanand38b461a2022-02-28 23:41:41 +0000406 mechanism. Default value is ``0``.
407
408- ``ENABLE_FEAT_RNG``: Numeric value to enable the ``FEAT_RNG`` extension.
409 ``FEAT_RNG`` is an optional feature available on Arm v8.5 onwards. This
Andre Przywara9563c502023-11-23 16:40:13 +0000410 flag can take the values 0 to 2, to align with the ``ENABLE_FEAT``
Juan Pablo Conde42305f22022-07-12 16:40:29 -0400411 mechanism. Default value is ``0``.
412
413- ``ENABLE_FEAT_RNG_TRAP``: Numeric value to enable the ``FEAT_RNG_TRAP``
414 extension. This feature is only supported in AArch64 state. This flag can
Andre Przywara9563c502023-11-23 16:40:13 +0000415 take values 0 to 2, to align with the ``ENABLE_FEAT`` mechanism.
Juan Pablo Conde42305f22022-07-12 16:40:29 -0400416 Default value is ``0``. ``FEAT_RNG_TRAP`` is an optional feature from
417 Armv8.5 onwards.
Jayanth Dodderi Chidanand38b461a2022-02-28 23:41:41 +0000418
Andre Przywara46880dc2022-11-17 16:42:09 +0000419- ``ENABLE_FEAT_SB``: Boolean option to let the TF-A code use the ``FEAT_SB``
420 (Speculation Barrier) instruction ``FEAT_SB`` is an optional feature and
421 defaults to ``0`` for pre-Armv8.5 CPUs, but is mandatory for Armv8.5 or
422 later CPUs. It is enabled from v8.5 and upwards and if needed can be
423 overidden from platforms explicitly.
Jayanth Dodderi Chidanand38b461a2022-02-28 23:41:41 +0000424
425- ``ENABLE_FEAT_SEL2``: Numeric value to enable the ``FEAT_SEL2`` (Secure EL2)
426 extension. ``FEAT_SEL2`` is a mandatory feature available on Arm v8.4.
Andre Przywara9563c502023-11-23 16:40:13 +0000427 This flag can take values 0 to 2, to align with the ``ENABLE_FEAT``
Jayanth Dodderi Chidanand38b461a2022-02-28 23:41:41 +0000428 mechanism. Default is ``0``.
Jayanth Dodderi Chidanand76ff3632021-12-05 19:21:14 +0000429
Jayanth Dodderi Chidanand4b5489c2022-03-28 15:28:55 +0100430- ``ENABLE_FEAT_TWED``: Numeric value to enable the ``FEAT_TWED`` (Delayed
431 trapping of WFE Instruction) extension. ``FEAT_TWED`` is a optional feature
432 available on Arm v8.6. This flag can take values 0 to 2, to align with the
Andre Przywara9563c502023-11-23 16:40:13 +0000433 ``ENABLE_FEAT`` mechanism. Default is ``0``.
Jayanth Dodderi Chidanand4b5489c2022-03-28 15:28:55 +0100434
435 When ``ENABLE_FEAT_TWED`` is set to ``1``, WFE instruction trapping gets
436 delayed by the amount of value in ``TWED_DELAY``.
437
Jayanth Dodderi Chidanand38b461a2022-02-28 23:41:41 +0000438- ``ENABLE_FEAT_VHE``: Numeric value to enable the ``FEAT_VHE`` (Virtualization
439 Host Extensions) extension. It allows access to CONTEXTIDR_EL2 register
440 during EL2 context save/restore operations.``FEAT_VHE`` is a mandatory
441 architectural feature and is enabled from v8.1 and upwards. It can take
Andre Przywara9563c502023-11-23 16:40:13 +0000442 values 0 to 2, to align with the ``ENABLE_FEAT`` mechanism.
Jayanth Dodderi Chidanand38b461a2022-02-28 23:41:41 +0000443 Default value is ``0``.
johpow01f91e59f2021-08-04 19:38:18 -0500444
Mark Brownc37eee72023-03-14 20:13:03 +0000445- ``ENABLE_FEAT_TCR2``: Numeric value to set the bit SCR_EL3.ENTCR2 in EL3 to
446 allow access to TCR2_EL2 (extended translation control) from EL2 as
447 well as adding TCR2_EL2 to the EL2 context save/restore operations. Its a
448 mandatory architectural feature and is enabled from v8.9 and upwards. This
Andre Przywara9563c502023-11-23 16:40:13 +0000449 flag can take the values 0 to 2, to align with the ``ENABLE_FEAT``
Mark Brownc37eee72023-03-14 20:13:03 +0000450 mechanism. Default value is ``0``.
451
Mark Brown293a6612023-03-14 20:48:43 +0000452- ``ENABLE_FEAT_S2PIE``: Numeric value to enable support for FEAT_S2PIE
453 at EL2 and below, and context switch relevant registers. This flag
Andre Przywara9563c502023-11-23 16:40:13 +0000454 can take the values 0 to 2, to align with the ``ENABLE_FEAT``
Mark Brown293a6612023-03-14 20:48:43 +0000455 mechanism. Default value is ``0``.
456
457- ``ENABLE_FEAT_S1PIE``: Numeric value to enable support for FEAT_S1PIE
458 at EL2 and below, and context switch relevant registers. This flag
Andre Przywara9563c502023-11-23 16:40:13 +0000459 can take the values 0 to 2, to align with the ``ENABLE_FEAT``
Mark Brown293a6612023-03-14 20:48:43 +0000460 mechanism. Default value is ``0``.
461
462- ``ENABLE_FEAT_S2POE``: Numeric value to enable support for FEAT_S2POE
463 at EL2 and below, and context switch relevant registers. This flag
Andre Przywara9563c502023-11-23 16:40:13 +0000464 can take the values 0 to 2, to align with the ``ENABLE_FEAT``
Mark Brown293a6612023-03-14 20:48:43 +0000465 mechanism. Default value is ``0``.
466
467- ``ENABLE_FEAT_S1POE``: Numeric value to enable support for FEAT_S1POE
468 at EL2 and below, and context switch relevant registers. This flag
Andre Przywara9563c502023-11-23 16:40:13 +0000469 can take the values 0 to 2, to align with the ``ENABLE_FEAT``
Mark Brown293a6612023-03-14 20:48:43 +0000470 mechanism. Default value is ``0``.
471
Mark Brown326f2952023-03-14 21:33:04 +0000472- ``ENABLE_FEAT_GCS``: Numeric value to set the bit SCR_EL3.GCSEn in EL3 to
473 allow use of Guarded Control Stack from EL2 as well as adding the GCS
474 registers to the EL2 context save/restore operations. This flag can take
Andre Przywara9563c502023-11-23 16:40:13 +0000475 the values 0 to 2, to align with the ``ENABLE_FEAT`` mechanism.
Mark Brown326f2952023-03-14 21:33:04 +0000476 Default value is ``0``.
477
Jayanth Dodderi Chidanand6b706862024-09-05 22:24:04 +0100478- ``ENABLE_FEAT_THE``: Numeric value to enable support for FEAT_THE
479 (Translation Hardening Extension) at EL2 and below, setting the bit
480 SCR_EL3.RCWMASKEn in EL3 to allow access to RCWMASK_EL1 and RCWSMASK_EL1
481 registers and context switch them.
482 Its an optional architectural feature and is available from v8.8 and upwards.
483 This flag can take the values 0 to 2, to align with the ``ENABLE_FEAT``
484 mechanism. Default value is ``0``.
485
Jayanth Dodderi Chidanand70cc1752024-09-06 13:49:31 +0100486- ``ENABLE_FEAT_SCTLR2``: Numeric value to enable support for FEAT_SCTLR2
487 (Extension to SCTLR_ELx) at EL2 and below, setting the bit
488 SCR_EL3.SCTLR2En in EL3 to allow access to SCTLR2_ELx registers and
489 context switch them. This feature is OPTIONAL from Armv8.0 implementations
490 and mandatory in Armv8.9 implementations.
491 This flag can take the values 0 to 2, to align with the ``ENABLE_FEAT``
492 mechanism. Default value is ``0``.
493
Govindraj Rajae63794e2024-09-06 15:43:43 +0100494- ``ENABLE_FEAT_D128``: Numeric value to enable support for FEAT_D128
495 at EL2 and below, setting the bit SCT_EL3.D128En in EL3 to allow access to
496 128 bit version of system registers like PAR_EL1, TTBR0_EL1, TTBR1_EL1,
497 TTBR0_EL2, TTBR1_EL2, TTBR0_EL12, TTBR1_EL12 , VTTBR_EL2, RCWMASK_EL1, and
498 RCWSMASK_EL1. Its an optional architectural feature and is available from
499 9.3 and upwards.
500 This flag can take the values 0 to 2, to align with the ``ENABLE_FEAT``
501 mechanism. Default value is ``0``.
502
Sandrine Bailleux11427302019-12-17 09:38:08 +0100503- ``ENABLE_LTO``: Boolean option to enable Link Time Optimization (LTO)
zelalem-aweked5f45272019-11-12 16:20:17 -0600504 support in GCC for TF-A. This option is currently only supported for
505 AArch64. Default is 0.
506
Arvind Ram Prakashab28d4b2023-10-11 12:10:56 -0500507- ``ENABLE_FEAT_MPAM``: Numeric value to enable lower ELs to use MPAM
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100508 feature. MPAM is an optional Armv8.4 extension that enables various memory
509 system components and resources to define partitions; software running at
510 various ELs can assign themselves to desired partition to control their
511 performance aspects.
512
Andre Przywara9563c502023-11-23 16:40:13 +0000513 This flag can take values 0 to 2, to align with the ``ENABLE_FEAT``
Jayanth Dodderi Chidanand38b461a2022-02-28 23:41:41 +0000514 mechanism. When this option is set to ``1`` or ``2``, EL3 allows lower ELs to
515 access their own MPAM registers without trapping into EL3. This option
516 doesn't make use of partitioning in EL3, however. Platform initialisation
517 code should configure and use partitions in EL3 as required. This option
Arvind Ram Prakashab28d4b2023-10-11 12:10:56 -0500518 defaults to ``2`` since MPAM is enabled by default for NS world only.
519 The flag is automatically disabled when the target
520 architecture is AArch32.
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100521
Andre Przywara8fc8e182024-08-09 17:04:22 +0100522- ``ENABLE_FEAT_LS64_ACCDATA``: Numeric value to enable access and save and
523 restore the ACCDATA_EL1 system register, at EL2 and below. This flag can
524 take the values 0 to 2, to align with the ``ENABLE_FEAT`` mechanism.
525 Default value is ``0``.
526
Chris Kay03be39d2021-05-05 13:38:30 +0100527- ``ENABLE_MPMM``: Boolean option to enable support for the Maximum Power
528 Mitigation Mechanism supported by certain Arm cores, which allows the SoC
529 firmware to detect and limit high activity events to assist in SoC processor
530 power domain dynamic power budgeting and limit the triggering of whole-rail
531 (i.e. clock chopping) responses to overcurrent conditions. Defaults to ``0``.
532
Boyan Karatotev7262eff2024-12-19 16:07:29 +0000533 - ``FEAT_PABANDON``: Boolean option to enable support for powerdown abandon on
534 Arm cores that support it (currently Gelas and Travis). Extends the PSCI
535 implementation to expect waking up after the terminal ``wfi``. Currently,
536 introduces a performance penalty. Once this is removed, this option will be
537 removed and the feature will be enabled by default. Defaults to ``0``.
538
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100539- ``ENABLE_PIE``: Boolean option to enable Position Independent Executable(PIE)
540 support within generic code in TF-A. This option is currently only supported
Arvind Ram Prakash11b9b492022-11-22 14:41:00 -0600541 in BL2, BL31, and BL32 (TSP) for AARCH64 binaries, and
542 in BL32 (SP_min) for AARCH32. Default is 0.
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100543
544- ``ENABLE_PMF``: Boolean option to enable support for optional Performance
545 Measurement Framework(PMF). Default is 0.
546
547- ``ENABLE_PSCI_STAT``: Boolean option to enable support for optional PSCI
548 functions ``PSCI_STAT_RESIDENCY`` and ``PSCI_STAT_COUNT``. Default is 0.
549 In the absence of an alternate stat collection backend, ``ENABLE_PMF`` must
550 be enabled. If ``ENABLE_PMF`` is set, the residency statistics are tracked in
551 software.
552
553- ``ENABLE_RUNTIME_INSTRUMENTATION``: Boolean option to enable runtime
554 instrumentation which injects timestamp collection points into TF-A to
555 allow runtime performance to be measured. Currently, only PSCI is
556 instrumented. Enabling this option enables the ``ENABLE_PMF`` build option
557 as well. Default is 0.
558
Andre Przywaraf3e8cfc2022-11-17 16:42:09 +0000559- ``ENABLE_SPE_FOR_NS`` : Numeric value to enable Statistical Profiling
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100560 extensions. This is an optional architectural feature for AArch64.
Andre Przywara9563c502023-11-23 16:40:13 +0000561 This flag can take the values 0 to 2, to align with the ``ENABLE_FEAT``
Andre Przywaraf3e8cfc2022-11-17 16:42:09 +0000562 mechanism. The default is 2 but is automatically disabled when the target
563 architecture is AArch32.
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100564
Jayanth Dodderi Chidanandd62c6812023-03-07 10:43:19 +0000565- ``ENABLE_SVE_FOR_NS``: Numeric value to enable Scalable Vector Extension
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100566 (SVE) for the Non-secure world only. SVE is an optional architectural feature
Madhukar Pappireddy10a89192024-07-05 12:44:08 -0500567 for AArch64. This flag can take the values 0 to 2, to align with the
568 ``ENABLE_FEAT`` mechanism. At this time, this build option cannot be used on
569 systems that have SPM_MM enabled. The default value is 2.
570
571 Note that when SVE is enabled for the Non-secure world, access
572 to SVE, SIMD and floating-point functionality from the Secure world is
573 independently controlled by build option ``ENABLE_SVE_FOR_SWD``. When enabling
574 ``CTX_INCLUDE_FPREGS`` and ``ENABLE_SVE_FOR_NS`` together, it is mandatory to
575 enable ``CTX_INCLUDE_SVE_REGS``. This is to avoid corruption of the Non-secure
576 world data in the Z-registers which are aliased by the SIMD and FP registers.
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100577
Madhukar Pappireddy10a89192024-07-05 12:44:08 -0500578- ``ENABLE_SVE_FOR_SWD``: Boolean option to enable SVE and FPU/SIMD functionality
579 for the Secure world. SVE is an optional architectural feature for AArch64.
580 The default is 0 and it is automatically disabled when the target architecture
581 is AArch32.
582
583 .. note::
584 This build flag requires ``ENABLE_SVE_FOR_NS`` to be enabled. When enabling
585 ``ENABLE_SVE_FOR_SWD``, a developer must carefully consider whether
586 ``CTX_INCLUDE_SVE_REGS`` is also needed.
Max Shvetsovc4502772021-03-22 11:59:37 +0000587
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100588- ``ENABLE_STACK_PROTECTOR``: String option to enable the stack protection
589 checks in GCC. Allowed values are "all", "strong", "default" and "none". The
590 default value is set to "none". "strong" is the recommended stack protection
591 level if this feature is desired. "none" disables the stack protection. For
592 all values other than "none", the ``plat_get_stack_protector_canary()``
593 platform hook needs to be implemented. The value is passed as the last
594 component of the option ``-fstack-protector-$ENABLE_STACK_PROTECTOR``.
595
Boyan Karatotev17e059e2023-03-22 15:55:36 +0000596- ``ENABLE_ERRATA_ALL``: This option is used only for testing purposes, Boolean
597 option to enable the workarounds for all errata that TF-A implements. Normally
598 they should be explicitly enabled depending on each platform's needs. Not
599 recommended for release builds. This option is default set to 0.
600
Sumit Gargc0c369c2019-11-15 18:47:53 +0530601- ``ENCRYPT_BL31``: Binary flag to enable encryption of BL31 firmware. This
Manish Pandey34a305e2021-10-21 21:53:49 +0100602 flag depends on ``DECRYPTION_SUPPORT`` build flag.
Sumit Gargc0c369c2019-11-15 18:47:53 +0530603
604- ``ENCRYPT_BL32``: Binary flag to enable encryption of Secure BL32 payload.
Manish Pandey34a305e2021-10-21 21:53:49 +0100605 This flag depends on ``DECRYPTION_SUPPORT`` build flag.
Sumit Gargc0c369c2019-11-15 18:47:53 +0530606
607- ``ENC_KEY``: A 32-byte (256-bit) symmetric key in hex string format. It could
608 either be SSK or BSSK depending on ``FW_ENC_STATUS`` flag. This value depends
Manish Pandey34a305e2021-10-21 21:53:49 +0100609 on ``DECRYPTION_SUPPORT`` build flag.
Sumit Gargc0c369c2019-11-15 18:47:53 +0530610
611- ``ENC_NONCE``: A 12-byte (96-bit) encryption nonce or Initialization Vector
612 (IV) in hex string format. This value depends on ``DECRYPTION_SUPPORT``
Manish Pandey34a305e2021-10-21 21:53:49 +0100613 build flag.
Sumit Gargc0c369c2019-11-15 18:47:53 +0530614
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100615- ``ERROR_DEPRECATED``: This option decides whether to treat the usage of
616 deprecated platform APIs, helper functions or drivers within Trusted
617 Firmware as error. It can take the value 1 (flag the use of deprecated
618 APIs as error) or 0. The default is 0.
619
Rajasekaran Kalidoss46359002023-05-09 12:28:07 +0200620- ``ETHOSN_NPU_DRIVER``: boolean option to enable a SiP service that can
621 configure an Arm® Ethos™-N NPU. To use this service the target platform's
622 ``HW_CONFIG`` must include the device tree nodes for the NPU. Currently, only
623 the Arm Juno platform has this included in its ``HW_CONFIG`` and the platform
624 only loads the ``HW_CONFIG`` in AArch64 builds. Default is 0.
625
626- ``ETHOSN_NPU_TZMP1``: boolean option to enable TZMP1 support for the
627 Arm® Ethos™-N NPU. Requires ``ETHOSN_NPU_DRIVER`` and
628 ``TRUSTED_BOARD_BOOT`` to be enabled.
629
630- ``ETHOSN_NPU_FW``: location of the NPU firmware binary
631 (```ethosn.bin```). This firmware image will be included in the FIP and
632 loaded at runtime.
633
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100634- ``EL3_EXCEPTION_HANDLING``: When set to ``1``, enable handling of exceptions
635 targeted at EL3. When set ``0`` (default), no exceptions are expected or
Raghu Krishnamurthy669bf402022-07-25 14:44:33 -0700636 handled at EL3, and a panic will result. The exception to this rule is when
637 ``SPMD_SPM_AT_SEL2`` is set to ``1``, in which case, only exceptions
638 occuring during normal world execution, are trapped to EL3. Any exception
639 trapped during secure world execution are trapped to the SPMC. This is
640 supported only for AArch64 builds.
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100641
Javier Almansa Sobrino0d1f6b12020-09-18 16:47:07 +0100642- ``EVENT_LOG_LEVEL``: Chooses the log level to use for Measured Boot when
643 ``MEASURED_BOOT`` is enabled. For a list of valid values, see ``LOG_LEVEL``.
644 Default value is 40 (LOG_LEVEL_INFO).
645
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100646- ``FAULT_INJECTION_SUPPORT``: ARMv8.4 extensions introduced support for fault
647 injection from lower ELs, and this build option enables lower ELs to use
648 Error Records accessed via System Registers to inject faults. This is
649 applicable only to AArch64 builds.
650
651 This feature is intended for testing purposes only, and is advisable to keep
652 disabled for production images.
653
654- ``FIP_NAME``: This is an optional build option which specifies the FIP
655 filename for the ``fip`` target. Default is ``fip.bin``.
656
657- ``FWU_FIP_NAME``: This is an optional build option which specifies the FWU
658 FIP filename for the ``fwu_fip`` target. Default is ``fwu_fip.bin``.
659
Sumit Gargc0c369c2019-11-15 18:47:53 +0530660- ``FW_ENC_STATUS``: Top level firmware's encryption numeric flag, values:
661
662 ::
663
664 0: Encryption is done with Secret Symmetric Key (SSK) which is common
665 for a class of devices.
666 1: Encryption is done with Binding Secret Symmetric Key (BSSK) which is
667 unique per device.
668
Manish Pandey34a305e2021-10-21 21:53:49 +0100669 This flag depends on ``DECRYPTION_SUPPORT`` build flag.
Sumit Gargc0c369c2019-11-15 18:47:53 +0530670
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100671- ``GENERATE_COT``: Boolean flag used to build and execute the ``cert_create``
672 tool to create certificates as per the Chain of Trust described in
673 :ref:`Trusted Board Boot`. The build system then calls ``fiptool`` to
674 include the certificates in the FIP and FWU_FIP. Default value is '0'.
675
676 Specify both ``TRUSTED_BOARD_BOOT=1`` and ``GENERATE_COT=1`` to include support
677 for the Trusted Board Boot feature in the BL1 and BL2 images, to generate
678 the corresponding certificates, and to include those certificates in the
679 FIP and FWU_FIP.
680
681 Note that if ``TRUSTED_BOARD_BOOT=0`` and ``GENERATE_COT=1``, the BL1 and BL2
682 images will not include support for Trusted Board Boot. The FIP will still
683 include the corresponding certificates. This FIP can be used to verify the
684 Chain of Trust on the host machine through other mechanisms.
685
686 Note that if ``TRUSTED_BOARD_BOOT=1`` and ``GENERATE_COT=0``, the BL1 and BL2
687 images will include support for Trusted Board Boot, but the FIP and FWU_FIP
688 will not include the corresponding certificates, causing a boot failure.
689
690- ``GICV2_G0_FOR_EL3``: Unlike GICv3, the GICv2 architecture doesn't have
691 inherent support for specific EL3 type interrupts. Setting this build option
692 to ``1`` assumes GICv2 *Group 0* interrupts are expected to target EL3, both
Madhukar Pappireddy86350ae2020-07-29 09:37:25 -0500693 by :ref:`platform abstraction layer<platform Interrupt Controller API>` and
694 :ref:`Interrupt Management Framework<Interrupt Management Framework>`.
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100695 This allows GICv2 platforms to enable features requiring EL3 interrupt type.
696 This also means that all GICv2 Group 0 interrupts are delivered to EL3, and
697 the Secure Payload interrupts needs to be synchronously handed over to Secure
698 EL1 for handling. The default value of this option is ``0``, which means the
699 Group 0 interrupts are assumed to be handled by Secure EL1.
700
Manish Pandey0e3379d2022-10-10 11:43:08 +0100701- ``HANDLE_EA_EL3_FIRST_NS``: When set to ``1``, External Aborts and SError
702 Interrupts, resulting from errors in NS world, will be always trapped in
703 EL3 i.e. in BL31 at runtime. When set to ``0`` (default), these exceptions
704 will be trapped in the current exception level (or in EL1 if the current
705 exception level is EL0).
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100706
707- ``HW_ASSISTED_COHERENCY``: On most Arm systems to-date, platform-specific
708 software operations are required for CPUs to enter and exit coherency.
709 However, newer systems exist where CPUs' entry to and exit from coherency
710 is managed in hardware. Such systems require software to only initiate these
711 operations, and the rest is managed in hardware, minimizing active software
712 management. In such systems, this boolean option enables TF-A to carry out
713 build and run-time optimizations during boot and power management operations.
714 This option defaults to 0 and if it is enabled, then it implies
715 ``WARMBOOT_ENABLE_DCACHE_EARLY`` is also enabled.
716
717 If this flag is disabled while the platform which TF-A is compiled for
718 includes cores that manage coherency in hardware, then a compilation error is
719 generated. This is based on the fact that a system cannot have, at the same
720 time, cores that manage coherency in hardware and cores that don't. In other
721 words, a platform cannot have, at the same time, cores that require
722 ``HW_ASSISTED_COHERENCY=1`` and cores that require
723 ``HW_ASSISTED_COHERENCY=0``.
724
725 Note that, when ``HW_ASSISTED_COHERENCY`` is enabled, version 2 of
726 translation library (xlat tables v2) must be used; version 1 of translation
727 library is not supported.
728
Varun Wadekar0a46eb12023-04-13 21:06:18 +0100729- ``IMPDEF_SYSREG_TRAP``: Numeric value to enable the handling traps for
730 implementation defined system register accesses from lower ELs. Default
731 value is ``0``.
732
Louis Mayencourtc1c2bf72020-02-13 08:21:34 +0000733- ``INVERTED_MEMMAP``: memmap tool print by default lower addresses at the
David Horstmannb2cc35f2021-01-21 12:29:59 +0000734 bottom, higher addresses at the top. This build flag can be set to '1' to
Louis Mayencourtc1c2bf72020-02-13 08:21:34 +0000735 invert this behavior. Lower addresses will be printed at the top and higher
736 addresses at the bottom.
737
Boyan Karatotev5b751432024-12-09 11:46:49 +0000738- ``INIT_UNUSED_NS_EL2``: This build flag guards code that disables EL2
739 safely in scenario where NS-EL2 is present but unused. This flag is set to 0
740 by default. Platforms without NS-EL2 in use must enable this flag.
741
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100742- ``KEY_ALG``: This build flag enables the user to select the algorithm to be
743 used for generating the PKCS keys and subsequent signing of the certificate.
Lionel Debievefefeffb2022-11-14 11:03:42 +0100744 It accepts 5 values: ``rsa``, ``rsa_1_5``, ``ecdsa``, ``ecdsa-brainpool-regular``
745 and ``ecdsa-brainpool-twisted``. The option ``rsa_1_5`` is the legacy PKCS#1
746 RSA 1.5 algorithm which is not TBBR compliant and is retained only for
747 compatibility. The default value of this flag is ``rsa`` which is the TBBR
748 compliant PKCS#1 RSA 2.1 scheme.
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100749
Gilad Ben-Yossefa6e53422019-09-15 13:29:29 +0300750- ``KEY_SIZE``: This build flag enables the user to select the key size for
751 the algorithm specified by ``KEY_ALG``. The valid values for ``KEY_SIZE``
752 depend on the chosen algorithm and the cryptographic module.
753
Lionel Debievefefeffb2022-11-14 11:03:42 +0100754 +---------------------------+------------------------------------+
755 | KEY_ALG | Possible key sizes |
756 +===========================+====================================+
Sandrine Bailleux2f37ce62023-10-26 15:14:42 +0200757 | rsa | 1024 , 2048 (default), 3072, 4096 |
Lionel Debievefefeffb2022-11-14 11:03:42 +0100758 +---------------------------+------------------------------------+
laurenw-armc2a5dce2023-10-03 15:36:25 -0500759 | ecdsa | 256 (default), 384 |
Lionel Debievefefeffb2022-11-14 11:03:42 +0100760 +---------------------------+------------------------------------+
Maxime Méré504c79c2024-09-18 17:53:21 +0200761 | ecdsa-brainpool-regular | 256 (default) |
Lionel Debievefefeffb2022-11-14 11:03:42 +0100762 +---------------------------+------------------------------------+
Maxime Méré504c79c2024-09-18 17:53:21 +0200763 | ecdsa-brainpool-twisted | 256 (default) |
Lionel Debievefefeffb2022-11-14 11:03:42 +0100764 +---------------------------+------------------------------------+
765
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100766- ``HASH_ALG``: This build flag enables the user to select the secure hash
767 algorithm. It accepts 3 values: ``sha256``, ``sha384`` and ``sha512``.
768 The default value of this flag is ``sha256``.
769
770- ``LDFLAGS``: Extra user options appended to the linkers' command line in
771 addition to the one set by the build system.
772
773- ``LOG_LEVEL``: Chooses the log level, which controls the amount of console log
774 output compiled into the build. This should be one of the following:
775
776 ::
777
778 0 (LOG_LEVEL_NONE)
779 10 (LOG_LEVEL_ERROR)
780 20 (LOG_LEVEL_NOTICE)
781 30 (LOG_LEVEL_WARNING)
782 40 (LOG_LEVEL_INFO)
783 50 (LOG_LEVEL_VERBOSE)
784
785 All log output up to and including the selected log level is compiled into
786 the build. The default value is 40 in debug builds and 20 in release builds.
787
Alexei Fedorov913cb7e2020-01-23 14:27:38 +0000788- ``MEASURED_BOOT``: Boolean flag to include support for the Measured Boot
Manish V Badarkhe92de80a2021-12-16 10:41:47 +0000789 feature. This flag can be enabled with ``TRUSTED_BOARD_BOOT`` in order to
790 provide trust that the code taking the measurements and recording them has
791 not been tampered with.
Sandrine Bailleux533d8b32021-06-10 11:18:04 +0200792
Manish Pandey34a305e2021-10-21 21:53:49 +0100793 This option defaults to 0.
Alexei Fedorov913cb7e2020-01-23 14:27:38 +0000794
Abhi Singh1f325e82024-10-21 13:21:42 -0500795- ``DISCRETE_TPM``: Boolean flag to include support for a Discrete TPM.
796
797 This option defaults to 0.
798
799- ``TPM_INTERFACE``: When ``DISCRETE_TPM=1``, this is a required flag to
800 select the TPM interface. Currently only one interface is supported:
801
802 ::
803
804 FIFO_SPI
805
806- ``MBOOT_TPM_HASH_ALG``: Build flag to select the TPM hash algorithm used during
807 Measured Boot. Currently only accepts ``sha256`` as a valid algorithm.
808
Govindraj Raja81525652023-07-18 13:55:33 -0500809- ``MARCH_DIRECTIVE``: used to pass a -march option from the platform build
810 options to the compiler. An example usage:
811
812 .. code:: make
813
814 MARCH_DIRECTIVE := -march=armv8.5-a
815
Bipin Ravie53e6ae2023-09-28 13:17:24 -0500816- ``HARDEN_SLS``: used to pass -mharden-sls=all from the TF-A build
817 options to the compiler currently supporting only of the options.
818 GCC documentation:
819 https://gcc.gnu.org/onlinedocs/gcc/AArch64-Options.html#index-mharden-sls
820
821 An example usage:
822
823 .. code:: make
824
825 HARDEN_SLS := 1
826
827 This option defaults to 0.
828
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100829- ``NON_TRUSTED_WORLD_KEY``: This option is used when ``GENERATE_COT=1``. It
Robin van der Gracht06b5cdb2023-09-12 11:16:23 +0200830 specifies a file that contains the Non-Trusted World private key in PEM
831 format or a PKCS11 URI. If ``SAVE_KEYS=1``, only a file is accepted and it
832 will be used to save the key.
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100833
834- ``NS_BL2U``: Path to NS_BL2U image in the host file system. This image is
835 optional. It is only needed if the platform makefile specifies that it
836 is required in order to build the ``fwu_fip`` target.
837
838- ``NS_TIMER_SWITCH``: Enable save and restore for non-secure timer register
839 contents upon world switch. It can take either 0 (don't save and restore) or
840 1 (do save and restore). 0 is the default. An SPD may set this to 1 if it
841 wants the timer registers to be saved and restored.
842
843- ``OVERRIDE_LIBC``: This option allows platforms to override the default libc
844 for the BL image. It can be either 0 (include) or 1 (remove). The default
845 value is 0.
846
847- ``PL011_GENERIC_UART``: Boolean option to indicate the PL011 driver that
848 the underlying hardware is not a full PL011 UART but a minimally compliant
849 generic UART, which is a subset of the PL011. The driver will not access
850 any register that is not part of the SBSA generic UART specification.
851 Default value is 0 (a full PL011 compliant UART is present).
852
853- ``PLAT``: Choose a platform to build TF-A for. The chosen platform name
854 must be subdirectory of any depth under ``plat/``, and must contain a
855 platform makefile named ``platform.mk``. For example, to build TF-A for the
856 Arm Juno board, select PLAT=juno.
857
Juan Pablo Condeb5ec1382023-11-08 16:14:28 -0600858- ``PLATFORM_REPORT_CTX_MEM_USE``: Reports the context memory allocated for
859 each core as well as the global context. The data includes the memory used
860 by each world and each privileged exception level. This build option is
861 applicable only for ``ARCH=aarch64`` builds. The default value is 0.
862
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100863- ``PRELOADED_BL33_BASE``: This option enables booting a preloaded BL33 image
864 instead of the normal boot flow. When defined, it must specify the entry
865 point address for the preloaded BL33 image. This option is incompatible with
866 ``EL3_PAYLOAD_BASE``. If both are defined, ``EL3_PAYLOAD_BASE`` has priority
867 over ``PRELOADED_BL33_BASE``.
868
Arvind Ram Prakasheaa90192023-12-21 00:25:52 -0600869- ``PRESERVE_DSU_PMU_REGS``: This options when enabled allows the platform to
870 save/restore the DynamIQ Shared Unit's(DSU) Performance Monitoring Unit(PMU)
871 registers when the cluster goes through a power cycle. This is disabled by
872 default and platforms that require this feature have to enable them.
873
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100874- ``PROGRAMMABLE_RESET_ADDRESS``: This option indicates whether the reset
875 vector address can be programmed or is fixed on the platform. It can take
876 either 0 (fixed) or 1 (programmable). Default is 0. If the platform has a
877 programmable reset address, it is expected that a CPU will start executing
878 code directly at the right address, both on a cold and warm reset. In this
879 case, there is no need to identify the entrypoint on boot and the boot path
880 can be optimised. The ``plat_get_my_entrypoint()`` platform porting interface
881 does not need to be implemented in this case.
882
883- ``PSCI_EXTENDED_STATE_ID``: As per PSCI1.0 Specification, there are 2 formats
884 possible for the PSCI power-state parameter: original and extended State-ID
885 formats. This flag if set to 1, configures the generic PSCI layer to use the
886 extended format. The default value of this flag is 0, which means by default
887 the original power-state format is used by the PSCI implementation. This flag
888 should be specified by the platform makefile and it governs the return value
889 of PSCI_FEATURES API for CPU_SUSPEND smc function id. When this option is
890 enabled on Arm platforms, the option ``ARM_RECOM_STATE_ID_ENC`` needs to be
891 set to 1 as well.
892
Wing Li1e9b68a2023-01-26 18:33:36 -0800893- ``PSCI_OS_INIT_MODE``: Boolean flag to enable support for optional PSCI
894 OS-initiated mode. This option defaults to 0.
895
Boyan Karatotev8e7c43c2024-10-25 11:38:41 +0100896- ``ARCH_FEATURE_AVAILABILITY``: Boolean flag to enable support for the
897 optional SMCCC_ARCH_FEATURE_AVAILABILITY call. This option implicitly
898 interacts with IMPDEF_SYSREG_TRAP and software emulation. This option
899 defaults to 0.
900
Manish Pandeyf90a73c2023-10-10 15:42:19 +0100901- ``ENABLE_FEAT_RAS``: Boolean flag to enable Armv8.2 RAS features. RAS features
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100902 are an optional extension for pre-Armv8.2 CPUs, but are mandatory for Armv8.2
Manish Pandey514a3012023-10-10 13:53:25 +0100903 or later CPUs. This flag can take the values 0 or 1. The default value is 0.
904 NOTE: This flag enables use of IESB capability to reduce entry latency into
905 EL3 even when RAS error handling is not performed on the platform. Hence this
906 flag is recommended to be turned on Armv8.2 and later CPUs.
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100907
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100908- ``RESET_TO_BL31``: Enable BL31 entrypoint as the CPU reset vector instead
909 of the BL1 entrypoint. It can take the value 0 (CPU reset to BL1
910 entrypoint) or 1 (CPU reset to BL31 entrypoint).
911 The default value is 0.
912
913- ``RESET_TO_SP_MIN``: SP_MIN is the minimal AArch32 Secure Payload provided
914 in TF-A. This flag configures SP_MIN entrypoint as the CPU reset vector
915 instead of the BL1 entrypoint. It can take the value 0 (CPU reset to BL1
916 entrypoint) or 1 (CPU reset to SP_MIN entrypoint). The default value is 0.
917
AlexeiFedorovc0ca2d72024-05-13 15:35:54 +0100918- ``RME_GPT_BITLOCK_BLOCK``: This defines the block size (in number of 512MB
919- blocks) covered by a single bit of the bitlock structure during RME GPT
920- operations. The lower the block size, the better opportunity for
921- parallelising GPT operations but at the cost of more bits being needed
922- for the bitlock structure. This numeric parameter can take the values
923- from 0 to 512 and must be a power of 2. The value of 0 is special and
924- and it chooses a single spinlock for all GPT L1 table entries. Default
925- value is 1 which corresponds to block size of 512MB per bit of bitlock
926- structure.
927
928- ``RME_GPT_MAX_BLOCK``: Numeric value in MB to define the maximum size of
AlexeiFedorovbd8b1bb2024-03-13 17:07:03 +0000929 supported contiguous blocks in GPT Library. This parameter can take the
930 values 0, 2, 32 and 512. Setting this value to 0 disables use of Contigious
Soby Mathewa16f40b2024-08-22 11:53:09 +0100931 descriptors. Default value is 512.
AlexeiFedorovbd8b1bb2024-03-13 17:07:03 +0000932
Robin van der Gracht06b5cdb2023-09-12 11:16:23 +0200933- ``ROT_KEY``: This option is used when ``GENERATE_COT=1``. It specifies a
934 file that contains the ROT private key in PEM format or a PKCS11 URI and
935 enforces public key hash generation. If ``SAVE_KEYS=1``, only a file is
936 accepted and it will be used to save the key.
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100937
938- ``SAVE_KEYS``: This option is used when ``GENERATE_COT=1``. It tells the
939 certificate generation tool to save the keys used to establish the Chain of
940 Trust. Allowed options are '0' or '1'. Default is '0' (do not save).
941
942- ``SCP_BL2``: Path to SCP_BL2 image in the host file system. This image is optional.
943 If a SCP_BL2 image is present then this option must be passed for the ``fip``
944 target.
945
Robin van der Gracht06b5cdb2023-09-12 11:16:23 +0200946- ``SCP_BL2_KEY``: This option is used when ``GENERATE_COT=1``. It specifies a
947 file that contains the SCP_BL2 private key in PEM format or a PKCS11 URI.
948 If ``SAVE_KEYS=1``, only a file is accepted and it will be used to save the key.
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100949
950- ``SCP_BL2U``: Path to SCP_BL2U image in the host file system. This image is
951 optional. It is only needed if the platform makefile specifies that it
952 is required in order to build the ``fwu_fip`` target.
953
954- ``SDEI_SUPPORT``: Setting this to ``1`` enables support for Software
955 Delegated Exception Interface to BL31 image. This defaults to ``0``.
956
957 When set to ``1``, the build option ``EL3_EXCEPTION_HANDLING`` must also be
958 set to ``1``.
959
960- ``SEPARATE_CODE_AND_RODATA``: Whether code and read-only data should be
961 isolated on separate memory pages. This is a trade-off between security and
962 memory usage. See "Isolating code and read-only data on separate memory
Olivier Deprez7efa3f12020-03-26 16:09:21 +0100963 pages" section in :ref:`Firmware Design`. This flag is disabled by default
964 and affects all BL images.
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100965
Samuel Holland31a14e12018-10-17 21:40:18 -0500966- ``SEPARATE_NOBITS_REGION``: Setting this option to ``1`` allows the NOBITS
967 sections of BL31 (.bss, stacks, page tables, and coherent memory) to be
968 allocated in RAM discontiguous from the loaded firmware image. When set, the
David Horstmannb2cc35f2021-01-21 12:29:59 +0000969 platform is expected to provide definitions for ``BL31_NOBITS_BASE`` and
Samuel Holland31a14e12018-10-17 21:40:18 -0500970 ``BL31_NOBITS_LIMIT``. When the option is ``0`` (the default), NOBITS
971 sections are placed in RAM immediately following the loaded firmware image.
972
Jiafei Pan0824b452022-02-24 10:47:33 +0800973- ``SEPARATE_BL2_NOLOAD_REGION``: Setting this option to ``1`` allows the
974 NOLOAD sections of BL2 (.bss, stacks, page tables) to be allocated in RAM
975 discontiguous from loaded firmware images. When set, the platform need to
976 provide definitions of ``BL2_NOLOAD_START`` and ``BL2_NOLOAD_LIMIT``. This
977 flag is disabled by default and NOLOAD sections are placed in RAM immediately
978 following the loaded firmware image.
979
Madhukar Pappireddy10a89192024-07-05 12:44:08 -0500980- ``SEPARATE_SIMD_SECTION``: Setting this option to ``1`` allows the SIMD context
981 data structures to be put in a dedicated memory region as decided by platform
982 integrator. Default value is ``0`` which means the SIMD context is put in BSS
983 section of EL3 firmware.
984
Jeremy Linton684a0792021-01-26 22:42:03 -0600985- ``SMC_PCI_SUPPORT``: This option allows platforms to handle PCI configuration
986 access requests via a standard SMCCC defined in `DEN0115`_. When combined with
987 UEFI+ACPI this can provide a certain amount of OS forward compatibility
988 with newer platforms that aren't ECAM compliant.
989
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100990- ``SPD``: Choose a Secure Payload Dispatcher component to be built into TF-A.
991 This build option is only valid if ``ARCH=aarch64``. The value should be
992 the path to the directory containing the SPD source, relative to
993 ``services/spd/``; the directory is expected to contain a makefile called
Olivier Deprez7efa3f12020-03-26 16:09:21 +0100994 ``<spd-value>.mk``. The SPM Dispatcher standard service is located in
995 services/std_svc/spmd and enabled by ``SPD=spmd``. The SPM Dispatcher
996 cannot be enabled when the ``SPM_MM`` option is enabled.
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100997
998- ``SPIN_ON_BL1_EXIT``: This option introduces an infinite loop in BL1. It can
999 take either 0 (no loop) or 1 (add a loop). 0 is the default. This loop stops
1000 execution in BL1 just before handing over to BL31. At this point, all
1001 firmware images have been loaded in memory, and the MMU and caches are
1002 turned off. Refer to the "Debugging options" section for more details.
1003
Marc Bonniciabaac162021-12-01 18:00:40 +00001004- ``SPMC_AT_EL3`` : This boolean option is used jointly with the SPM
1005 Dispatcher option (``SPD=spmd``). When enabled (1) it indicates the SPMC
1006 component runs at the EL3 exception level. The default value is ``0`` (
1007 disabled). This configuration supports pre-Armv8.4 platforms (aka not
Olivier Deprezb6cd6702023-11-03 11:49:47 +01001008 implementing the ``FEAT_SEL2`` extension).
Marc Bonniciabaac162021-12-01 18:00:40 +00001009
Nishant Sharma9e719112023-06-27 00:36:01 +01001010- ``SPMC_AT_EL3_SEL0_SP`` : Boolean option to enable SEL0 SP load support when
1011 ``SPMC_AT_EL3`` is enabled. The default value if ``0`` (disabled). This
1012 option cannot be enabled (``1``) when (``SPMC_AT_EL3``) is disabled.
1013
Jens Wiklanderba0ed3e2022-12-14 17:02:16 +01001014- ``SPMC_OPTEE`` : This boolean option is used jointly with the SPM
1015 Dispatcher option (``SPD=spmd``) and with ``SPMD_SPM_AT_SEL2=0`` to
1016 indicate that the SPMC at S-EL1 is OP-TEE and an OP-TEE specific loading
1017 mechanism should be used.
1018
Jayanth Dodderi Chidanand38b461a2022-02-28 23:41:41 +00001019- ``SPMD_SPM_AT_SEL2`` : This boolean option is used jointly with the SPM
Olivier Deprez7efa3f12020-03-26 16:09:21 +01001020 Dispatcher option (``SPD=spmd``). When enabled (1) it indicates the SPMC
Marc Bonniciabaac162021-12-01 18:00:40 +00001021 component runs at the S-EL2 exception level provided by the ``FEAT_SEL2``
Olivier Deprez7efa3f12020-03-26 16:09:21 +01001022 extension. This is the default when enabling the SPM Dispatcher. When
1023 disabled (0) it indicates the SPMC component runs at the S-EL1 execution
Marc Bonniciabaac162021-12-01 18:00:40 +00001024 state or at EL3 if ``SPMC_AT_EL3`` is enabled. The latter configurations
1025 support pre-Armv8.4 platforms (aka not implementing the ``FEAT_SEL2``
1026 extension).
Olivier Deprez7efa3f12020-03-26 16:09:21 +01001027
Paul Beesleyfe975b42019-09-16 11:29:03 +00001028- ``SPM_MM`` : Boolean option to enable the Management Mode (MM)-based Secure
Olivier Deprez7efa3f12020-03-26 16:09:21 +01001029 Partition Manager (SPM) implementation. The default value is ``0``
1030 (disabled). This option cannot be enabled (``1``) when SPM Dispatcher is
1031 enabled (``SPD=spmd``).
Paul Beesleyfe975b42019-09-16 11:29:03 +00001032
Manish Pandey3f90ad72020-01-14 11:52:05 +00001033- ``SP_LAYOUT_FILE``: Platform provided path to JSON file containing the
Olivier Deprez7efa3f12020-03-26 16:09:21 +01001034 description of secure partitions. The build system will parse this file and
1035 package all secure partition blobs into the FIP. This file is not
1036 necessarily part of TF-A tree. Only available when ``SPD=spmd``.
Manish Pandey3f90ad72020-01-14 11:52:05 +00001037
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +01001038- ``SP_MIN_WITH_SECURE_FIQ``: Boolean flag to indicate the SP_MIN handles
1039 secure interrupts (caught through the FIQ line). Platforms can enable
1040 this directive if they need to handle such interruption. When enabled,
1041 the FIQ are handled in monitor mode and non secure world is not allowed
1042 to mask these events. Platforms that enable FIQ handling in SP_MIN shall
1043 implement the api ``sp_min_plat_fiq_handler()``. The default value is 0.
1044
Mark Brown64869972022-04-20 18:14:32 +01001045- ``SVE_VECTOR_LEN``: SVE vector length to configure in ZCR_EL3.
1046 Platforms can configure this if they need to lower the hardware
1047 limit, for example due to asymmetric configuration or limitations of
1048 software run at lower ELs. The default is the architectural maximum
1049 of 2048 which should be suitable for most configurations, the
1050 hardware will limit the effective VL to the maximum physically supported
1051 VL.
1052
Jayanth Dodderi Chidanand7c7faff2022-10-11 17:16:07 +01001053- ``TRNG_SUPPORT``: Setting this to ``1`` enables support for True
1054 Random Number Generator Interface to BL31 image. This defaults to ``0``.
1055
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +01001056- ``TRUSTED_BOARD_BOOT``: Boolean flag to include support for the Trusted Board
1057 Boot feature. When set to '1', BL1 and BL2 images include support to load
1058 and verify the certificates and images in a FIP, and BL1 includes support
1059 for the Firmware Update. The default value is '0'. Generation and inclusion
1060 of certificates in the FIP and FWU_FIP depends upon the value of the
1061 ``GENERATE_COT`` option.
1062
1063 .. warning::
1064 This option depends on ``CREATE_KEYS`` to be enabled. If the keys
1065 already exist in disk, they will be overwritten without further notice.
1066
1067- ``TRUSTED_WORLD_KEY``: This option is used when ``GENERATE_COT=1``. It
Robin van der Gracht06b5cdb2023-09-12 11:16:23 +02001068 specifies a file that contains the Trusted World private key in PEM
1069 format or a PKCS11 URI. If ``SAVE_KEYS=1``, only a file is accepted and
1070 it will be used to save the key.
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +01001071
1072- ``TSP_INIT_ASYNC``: Choose BL32 initialization method as asynchronous or
1073 synchronous, (see "Initializing a BL32 Image" section in
1074 :ref:`Firmware Design`). It can take the value 0 (BL32 is initialized using
1075 synchronous method) or 1 (BL32 is initialized using asynchronous method).
1076 Default is 0.
1077
1078- ``TSP_NS_INTR_ASYNC_PREEMPT``: A non zero value enables the interrupt
1079 routing model which routes non-secure interrupts asynchronously from TSP
1080 to EL3 causing immediate preemption of TSP. The EL3 is responsible
1081 for saving and restoring the TSP context in this routing model. The
1082 default routing model (when the value is 0) is to route non-secure
1083 interrupts to TSP allowing it to save its context and hand over
1084 synchronously to EL3 via an SMC.
1085
1086 .. note::
1087 When ``EL3_EXCEPTION_HANDLING`` is ``1``, ``TSP_NS_INTR_ASYNC_PREEMPT``
1088 must also be set to ``1``.
1089
Manish V Badarkheb59efca2023-06-27 11:40:21 +01001090- ``TS_SP_FW_CONFIG``: DTC build flag to include Trusted Services (Crypto and
1091 internal-trusted-storage) as SP in tb_fw_config device tree.
1092
Jayanth Dodderi Chidanand4b5489c2022-03-28 15:28:55 +01001093- ``TWED_DELAY``: Numeric value to be set in order to delay the trapping of
1094 WFE instruction. ``ENABLE_FEAT_TWED`` build option must be enabled to set
1095 this delay. It can take values in the range (0-15). Default value is ``0``
1096 and based on this value, 2^(TWED_DELAY + 8) cycles will be delayed.
1097 Platforms need to explicitly update this value based on their requirements.
1098
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +01001099- ``USE_ARM_LINK``: This flag determines whether to enable support for ARM
1100 linker. When the ``LINKER`` build variable points to the armlink linker,
1101 this flag is enabled automatically. To enable support for armlink, platforms
1102 will have to provide a scatter file for the BL image. Currently, Tegra
1103 platforms use the armlink support to compile BL3-1 images.
1104
1105- ``USE_COHERENT_MEM``: This flag determines whether to include the coherent
1106 memory region in the BL memory map or not (see "Use of Coherent memory in
1107 TF-A" section in :ref:`Firmware Design`). It can take the value 1
1108 (Coherent memory region is included) or 0 (Coherent memory region is
1109 excluded). Default is 1.
1110
Louis Mayencourt6b232d92020-02-28 16:57:30 +00001111- ``ARM_IO_IN_DTB``: This flag determines whether to use IO based on the
1112 firmware configuration framework. This will move the io_policies into a
Louis Mayencourtbadcac82019-10-24 15:18:46 +01001113 configuration device tree, instead of static structure in the code base.
1114
Manish V Badarkhead339892020-06-29 10:32:53 +01001115- ``COT_DESC_IN_DTB``: This flag determines whether to create COT descriptors
1116 at runtime using fconf. If this flag is enabled, COT descriptors are
1117 statically captured in tb_fw_config file in the form of device tree nodes
1118 and properties. Currently, COT descriptors used by BL2 are moved to the
1119 device tree and COT descriptors used by BL1 are retained in the code
Manish Pandey34a305e2021-10-21 21:53:49 +01001120 base statically.
Manish V Badarkhead339892020-06-29 10:32:53 +01001121
Balint Dobszayd0dbd5e2019-12-18 15:28:00 +01001122- ``SDEI_IN_FCONF``: This flag determines whether to configure SDEI setup in
1123 runtime using firmware configuration framework. The platform specific SDEI
1124 shared and private events configuration is retrieved from device tree rather
Manish Pandey34a305e2021-10-21 21:53:49 +01001125 than static C structures at compile time. This is only supported if
1126 SDEI_SUPPORT build flag is enabled.
Louis Mayencourtbadcac82019-10-24 15:18:46 +01001127
Madhukar Pappireddy02cc3ff2020-06-02 09:26:30 -05001128- ``SEC_INT_DESC_IN_FCONF``: This flag determines whether to configure Group 0
1129 and Group1 secure interrupts using the firmware configuration framework. The
1130 platform specific secure interrupt property descriptor is retrieved from
1131 device tree in runtime rather than depending on static C structure at compile
Manish Pandey34a305e2021-10-21 21:53:49 +01001132 time.
Madhukar Pappireddy02cc3ff2020-06-02 09:26:30 -05001133
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +01001134- ``USE_ROMLIB``: This flag determines whether library at ROM will be used.
1135 This feature creates a library of functions to be placed in ROM and thus
1136 reduces SRAM usage. Refer to :ref:`Library at ROM` for further details. Default
1137 is 0.
1138
1139- ``V``: Verbose build. If assigned anything other than 0, the build commands
1140 are printed. Default is 0.
1141
1142- ``VERSION_STRING``: String used in the log output for each TF-A image.
1143 Defaults to a string formed by concatenating the version number, build type
1144 and build string.
1145
1146- ``W``: Warning level. Some compiler warning options of interest have been
1147 regrouped and put in the root Makefile. This flag can take the values 0 to 3,
1148 each level enabling more warning options. Default is 0.
1149
Boyan Karatoteve9e7e8a2022-12-07 10:26:48 +00001150 This option is closely related to the ``E`` option, which enables
1151 ``-Werror``.
1152
1153 - ``W=0`` (default)
1154
1155 Enables a wide assortment of warnings, most notably ``-Wall`` and
1156 ``-Wextra``, as well as various bad practices and things that are likely to
1157 result in errors. Includes some compiler specific flags. No warnings are
1158 expected at this level for any build.
1159
1160 - ``W=1``
1161
1162 Enables warnings we want the generic build to include but are too time
1163 consuming to fix at the moment. It re-enables warnings taken out for
1164 ``W=0`` builds (a few of the ``-Wextra`` additions). This level is expected
1165 to eventually be merged into ``W=0``. Some warnings are expected on some
1166 builds, but new contributions should not introduce new ones.
1167
1168 - ``W=2`` (recommended)
1169
1170 Enables warnings we want the generic build to include but cannot be enabled
1171 due to external libraries. This level is expected to eventually be merged
1172 into ``W=0``. Lots of warnings are expected, primarily from external
1173 libraries like zlib and compiler-rt, but new controbutions should not
1174 introduce new ones.
1175
1176 - ``W=3``
1177
1178 Enables warnings that are informative but not necessary and generally too
1179 verbose and frequently ignored. A very large number of warnings are
1180 expected.
1181
1182 The exact set of warning flags depends on the compiler and TF-A warning
1183 level, however they are all succinctly set in the top-level Makefile. Please
1184 refer to the `GCC`_ or `Clang`_ documentation for more information on the
1185 individual flags.
1186
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +01001187- ``WARMBOOT_ENABLE_DCACHE_EARLY`` : Boolean option to enable D-cache early on
1188 the CPU after warm boot. This is applicable for platforms which do not
1189 require interconnect programming to enable cache coherency (eg: single
1190 cluster platforms). If this option is enabled, then warm boot path
1191 enables D-caches immediately after enabling MMU. This option defaults to 0.
1192
Manish V Badarkhe75c972a2020-03-22 05:06:38 +00001193- ``SUPPORT_STACK_MEMTAG``: This flag determines whether to enable memory
1194 tagging for stack or not. It accepts 2 values: ``yes`` and ``no``. The
1195 default value of this flag is ``no``. Note this option must be enabled only
1196 for ARM architecture greater than Armv8.5-A.
1197
Manish V Badarkhea59fa012020-07-31 08:38:49 +01001198- ``ERRATA_SPECULATIVE_AT``: This flag determines whether to enable ``AT``
1199 speculative errata workaround or not. It accepts 2 values: ``1`` and ``0``.
1200 The default value of this flag is ``0``.
1201
1202 ``AT`` speculative errata workaround disables stage1 page table walk for
1203 lower ELs (EL1 and EL0) in EL3 so that ``AT`` speculative fetch at any point
1204 produces either the correct result or failure without TLB allocation.
Manish V Badarkhe2801ed42020-04-28 04:53:32 +01001205
1206 This boolean option enables errata for all below CPUs.
1207
Manish V Badarkhea59fa012020-07-31 08:38:49 +01001208 +---------+--------------+-------------------------+
1209 | Errata | CPU | Workaround Define |
1210 +=========+==============+=========================+
1211 | 1165522 | Cortex-A76 | ``ERRATA_A76_1165522`` |
1212 +---------+--------------+-------------------------+
1213 | 1319367 | Cortex-A72 | ``ERRATA_A72_1319367`` |
1214 +---------+--------------+-------------------------+
1215 | 1319537 | Cortex-A57 | ``ERRATA_A57_1319537`` |
1216 +---------+--------------+-------------------------+
1217 | 1530923 | Cortex-A55 | ``ERRATA_A55_1530923`` |
1218 +---------+--------------+-------------------------+
1219 | 1530924 | Cortex-A53 | ``ERRATA_A53_1530924`` |
1220 +---------+--------------+-------------------------+
1221
1222 .. note::
1223 This option is enabled by build only if platform sets any of above defines
1224 mentioned in ’Workaround Define' column in the table.
1225 If this option is enabled for the EL3 software then EL2 software also must
1226 implement this workaround due to the behaviour of the errata mentioned
1227 in new SDEN document which will get published soon.
Manish V Badarkhe2801ed42020-04-28 04:53:32 +01001228
Boyan Karatoteva6193b32024-09-20 13:37:51 +01001229- ``ERRATA_SME_POWER_DOWN``: Boolean option to disable SME (PSTATE.{ZA,SM}=0)
1230 before power down and downgrade a suspend to power down request to a normal
1231 suspend request. This is necessary when software running at lower ELs requests
1232 power down without first clearing these bits. On affected cores, the CME
1233 connected to it will reject its power down request. The default value is 0.
1234
Manish Pandey7c6fcb42022-09-27 14:30:34 +01001235- ``RAS_TRAP_NS_ERR_REC_ACCESS``: This flag enables/disables the SCR_EL3.TERR
Varun Wadekar92234852020-06-12 10:11:28 -07001236 bit, to trap access to the RAS ERR and RAS ERX registers from lower ELs.
1237 This flag is disabled by default.
1238
Juan Pablo Conde52865522022-06-28 16:56:32 -04001239- ``OPENSSL_DIR``: This option is used to provide the path to a directory on the
1240 host machine where a custom installation of OpenSSL is located, which is used
1241 to build the certificate generation, firmware encryption and FIP tools. If
1242 this option is not set, the default OS installation will be used.
Manish V Badarkhe3589b702020-07-29 10:58:44 +01001243
Madhukar Pappireddy7a554a12020-08-12 13:18:19 -05001244- ``USE_SP804_TIMER``: Use the SP804 timer instead of the Generic Timer for
1245 functions that wait for an arbitrary time length (udelay and mdelay). The
1246 default value is 0.
1247
Jayanth Dodderi Chidanand69316752022-05-09 12:33:03 +01001248- ``ENABLE_BRBE_FOR_NS``: Numeric value to enable access to the branch record
1249 buffer registers from NS ELs when FEAT_BRBE is implemented. BRBE is an
1250 optional architectural feature for AArch64. This flag can take the values
Andre Przywara9563c502023-11-23 16:40:13 +00001251 0 to 2, to align with the ``ENABLE_FEAT`` mechanism. The default is 0
Jayanth Dodderi Chidanand69316752022-05-09 12:33:03 +01001252 and it is automatically disabled when the target architecture is AArch32.
johpow0181865962022-01-28 17:06:20 -06001253
Jayanth Dodderi Chidananda793ccc2022-05-19 14:08:28 +01001254- ``ENABLE_TRBE_FOR_NS``: Numeric value to enable access of trace buffer
Manish V Badarkhe20df29c2021-07-02 09:10:56 +01001255 control registers from NS ELs, NS-EL2 or NS-EL1(when NS-EL2 is implemented
1256 but unused) when FEAT_TRBE is implemented. TRBE is an optional architectural
Jayanth Dodderi Chidananda793ccc2022-05-19 14:08:28 +01001257 feature for AArch64. This flag can take the values 0 to 2, to align with the
Andre Przywara9563c502023-11-23 16:40:13 +00001258 ``ENABLE_FEAT`` mechanism. The default is 0 and it is automatically
Jayanth Dodderi Chidananda793ccc2022-05-19 14:08:28 +01001259 disabled when the target architecture is AArch32.
Manish V Badarkhe20df29c2021-07-02 09:10:56 +01001260
Andre Przywara44e33e02022-11-17 16:42:09 +00001261- ``ENABLE_SYS_REG_TRACE_FOR_NS``: Numeric value to enable trace system
Manish V Badarkhef356f7e2021-06-29 11:44:20 +01001262 registers access from NS ELs, NS-EL2 or NS-EL1 (when NS-EL2 is implemented
1263 but unused). This feature is available if trace unit such as ETMv4.x, and
Andre Przywara44e33e02022-11-17 16:42:09 +00001264 ETE(extending ETM feature) is implemented. This flag can take the values
Andre Przywara9563c502023-11-23 16:40:13 +00001265 0 to 2, to align with the ``ENABLE_FEAT`` mechanism. The default is 0.
Manish V Badarkhef356f7e2021-06-29 11:44:20 +01001266
Jayanth Dodderi Chidanand38b461a2022-02-28 23:41:41 +00001267- ``ENABLE_TRF_FOR_NS``: Numeric value to enable trace filter control registers
Manish V Badarkhe51a97112021-07-08 09:33:18 +01001268 access from NS ELs, NS-EL2 or NS-EL1 (when NS-EL2 is implemented but unused),
Jayanth Dodderi Chidanand38b461a2022-02-28 23:41:41 +00001269 if FEAT_TRF is implemented. This flag can take the values 0 to 2, to align
Andre Przywara9563c502023-11-23 16:40:13 +00001270 with the ``ENABLE_FEAT`` mechanism. This flag is disabled by default.
Manish V Badarkhe51a97112021-07-08 09:33:18 +01001271
Okash Khawaja037b56e2022-11-04 12:38:01 +00001272- ``CONDITIONAL_CMO``: Boolean option to enable call to platform-defined routine
1273 ``plat_can_cmo`` which will return zero if cache management operations should
1274 be skipped and non-zero otherwise. By default, this option is disabled which
1275 means platform hook won't be checked and CMOs will always be performed when
1276 related functions are called.
1277
Sona Mathew6315c582023-03-15 09:40:36 -05001278- ``ERRATA_ABI_SUPPORT``: Boolean option to enable support for Errata management
1279 firmware interface for the BL31 image. By default its disabled (``0``).
1280
1281- ``ERRATA_NON_ARM_INTERCONNECT``: Boolean option to enable support for the
1282 errata mitigation for platforms with a non-arm interconnect using the errata
1283 ABI. By default its disabled (``0``).
1284
Sandrine Bailleuxf57e2032023-10-11 08:38:00 +02001285- ``ENABLE_CONSOLE_GETC``: Boolean option to enable `getc()` feature in console
1286 driver(s). By default it is disabled (``0``) because it constitutes an attack
1287 vector into TF-A by potentially allowing an attacker to inject arbitrary data.
1288 This option should only be enabled on a need basis if there is a use case for
1289 reading characters from the console.
1290
Alexei Fedorov84f1b5d2020-03-23 18:45:17 +00001291GICv3 driver options
1292--------------------
1293
1294GICv3 driver files are included using directive:
1295
1296``include drivers/arm/gic/v3/gicv3.mk``
1297
1298The driver can be configured with the following options set in the platform
1299makefile:
1300
Andre Przywarae1cc1302020-03-25 15:50:38 +00001301- ``GICV3_SUPPORT_GIC600``: Add support for the GIC-600 variants of GICv3.
1302 Enabling this option will add runtime detection support for the
1303 GIC-600, so is safe to select even for a GIC500 implementation.
1304 This option defaults to 0.
Alexei Fedorov84f1b5d2020-03-23 18:45:17 +00001305
Varun Wadekareea6dc12021-05-04 16:14:09 -07001306- ``GICV3_SUPPORT_GIC600AE_FMU``: Add support for the Fault Management Unit
1307 for GIC-600 AE. Enabling this option will introduce support to initialize
1308 the FMU. Platforms should call the init function during boot to enable the
1309 FMU and its safety mechanisms. This option defaults to 0.
1310
Alexei Fedorov84f1b5d2020-03-23 18:45:17 +00001311- ``GICV3_IMPL_GIC600_MULTICHIP``: Selects GIC-600 variant with multichip
1312 functionality. This option defaults to 0
1313
1314- ``GICV3_OVERRIDE_DISTIF_PWR_OPS``: Allows override of default implementation
1315 of ``arm_gicv3_distif_pre_save`` and ``arm_gicv3_distif_post_restore``
1316 functions. This is required for FVP platform which need to simulate GIC save
1317 and restore during SYSTEM_SUSPEND without powering down GIC. Default is 0.
1318
Alexei Fedorov19705932020-04-06 19:00:35 +01001319- ``GIC_ENABLE_V4_EXTN`` : Enables GICv4 related changes in GICv3 driver.
1320 This option defaults to 0.
1321
Alexei Fedorova6e6ae02020-04-06 16:27:54 +01001322- ``GIC_EXT_INTID``: When set to ``1``, GICv3 driver will support extended
1323 PPI (1056-1119) and SPI (4096-5119) range. This option defaults to 0.
1324
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +01001325Debugging options
1326-----------------
1327
1328To compile a debug version and make the build more verbose use
1329
1330.. code:: shell
1331
1332 make PLAT=<platform> DEBUG=1 V=1 all
1333
Daniel Boulbydf83a832022-05-03 16:46:16 +01001334AArch64 GCC 11 uses DWARF version 5 debugging symbols by default. Some tools
1335(for example Arm-DS) might not support this and may need an older version of
1336DWARF symbols to be emitted by GCC. This can be achieved by using the
1337``-gdwarf-<version>`` flag, with the version being set to 2, 3, 4 or 5. Setting
1338the version to 4 is recommended for Arm-DS.
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +01001339
1340When debugging logic problems it might also be useful to disable all compiler
1341optimizations by using ``-O0``.
1342
1343.. warning::
1344 Using ``-O0`` could cause output images to be larger and base addresses
1345 might need to be recalculated (see the **Memory layout on Arm development
1346 platforms** section in the :ref:`Firmware Design`).
1347
1348Extra debug options can be passed to the build system by setting ``CFLAGS`` or
1349``LDFLAGS``:
1350
1351.. code:: shell
1352
1353 CFLAGS='-O0 -gdwarf-2' \
1354 make PLAT=<platform> DEBUG=1 V=1 all
1355
1356Note that using ``-Wl,`` style compilation driver options in ``CFLAGS`` will be
1357ignored as the linker is called directly.
1358
1359It is also possible to introduce an infinite loop to help in debugging the
1360post-BL2 phase of TF-A. This can be done by rebuilding BL1 with the
1361``SPIN_ON_BL1_EXIT=1`` build flag. Refer to the :ref:`build_options_common`
1362section. In this case, the developer may take control of the target using a
Daniel Boulbydf83a832022-05-03 16:46:16 +01001363debugger when indicated by the console output. When using Arm-DS, the following
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +01001364commands can be used:
1365
1366::
1367
1368 # Stop target execution
1369 interrupt
1370
1371 #
1372 # Prepare your debugging environment, e.g. set breakpoints
1373 #
1374
1375 # Jump over the debug loop
1376 set var $AARCH64::$Core::$PC = $AARCH64::$Core::$PC + 4
1377
1378 # Resume execution
1379 continue
1380
Olivier Deprezb6cd6702023-11-03 11:49:47 +01001381.. _build_options_experimental:
1382
1383Experimental build options
1384---------------------------
1385
1386Common build options
1387~~~~~~~~~~~~~~~~~~~~
1388
Manish V Badarkhe9e3deb22024-05-22 14:06:00 +01001389- ``DICE_PROTECTION_ENVIRONMENT``: Boolean flag to specify the measured boot
1390 backend when ``MEASURED_BOOT`` is enabled. The default value is ``0``. When
1391 set to ``1`` then measurements and additional metadata collected during the
1392 measured boot process are sent to the DICE Protection Environment for storage
1393 and processing. A certificate chain, which represents the boot state of the
1394 device, can be queried from the DPE.
1395
Olivier Deprezb6cd6702023-11-03 11:49:47 +01001396- ``DRTM_SUPPORT``: Boolean flag to enable support for Dynamic Root of Trust
1397 for Measurement (DRTM). This feature has trust dependency on BL31 for taking
1398 the measurements and recording them as per `PSA DRTM specification`_. For
1399 platforms which use BL2 to load/authenticate BL31 ``TRUSTED_BOARD_BOOT`` can
1400 be used and for the platforms which use ``RESET_TO_BL31`` platform owners
1401 should have mechanism to authenticate BL31. This option defaults to 0.
1402
1403- ``ENABLE_RME``: Numeric value to enable support for the ARMv9 Realm
1404 Management Extension. This flag can take the values 0 to 2, to align with
Andre Przywara9563c502023-11-23 16:40:13 +00001405 the ``ENABLE_FEAT`` mechanism. Default value is 0.
Olivier Deprezb6cd6702023-11-03 11:49:47 +01001406
Tushar Khandelwalb59ded32024-03-15 15:00:29 +00001407- ``ENABLE_FEAT_MEC``: Numeric value to enable support for the ARMv9.2 Memory
1408 Encryption Contexts (MEC). This flag can take the values 0 to 2, to align
1409 with the ``ENABLE_FEAT`` mechanism. MEC supports multiple encryption
1410 contexts for Realm security state and only one encryption context for the
1411 rest of the security states. Default value is 0.
1412
Raghu Krishnamurthy5c737302024-10-13 17:22:43 -07001413- ``RMMD_ENABLE_EL3_TOKEN_SIGN``: Numeric value to enable support for singing
1414 realm attestation token signing requests in EL3. This flag can take the
1415 values 0 and 1. The default value is ``0``. When set to ``1``, this option
1416 enables additional RMMD SMCs to push and pop requests for signing to
1417 EL3 along with platform hooks that must be implemented to service those
1418 requests and responses.
1419
Olivier Deprezb6cd6702023-11-03 11:49:47 +01001420- ``ENABLE_SME_FOR_NS``: Numeric value to enable Scalable Matrix Extension
1421 (SME), SVE, and FPU/SIMD for the non-secure world only. These features share
1422 registers so are enabled together. Using this option without
1423 ENABLE_SME_FOR_SWD=1 will cause SME, SVE, and FPU/SIMD instructions in secure
1424 world to trap to EL3. Requires ``ENABLE_SVE_FOR_NS`` to be set as SME is a
1425 superset of SVE. SME is an optional architectural feature for AArch64.
1426 At this time, this build option cannot be used on systems that have
1427 SPD=spmd/SPM_MM and atempting to build with this option will fail.
Andre Przywara9563c502023-11-23 16:40:13 +00001428 This flag can take the values 0 to 2, to align with the ``ENABLE_FEAT``
Olivier Deprezb6cd6702023-11-03 11:49:47 +01001429 mechanism. Default is 0.
1430
1431- ``ENABLE_SME2_FOR_NS``: Numeric value to enable Scalable Matrix Extension
1432 version 2 (SME2) for the non-secure world only. SME2 is an optional
1433 architectural feature for AArch64.
1434 This should be set along with ENABLE_SME_FOR_NS=1, if not, the default SME
1435 accesses will still be trapped. This flag can take the values 0 to 2, to
Andre Przywara9563c502023-11-23 16:40:13 +00001436 align with the ``ENABLE_FEAT`` mechanism. Default is 0.
Olivier Deprezb6cd6702023-11-03 11:49:47 +01001437
1438- ``ENABLE_SME_FOR_SWD``: Boolean option to enable the Scalable Matrix
1439 Extension for secure world. Used along with SVE and FPU/SIMD.
1440 ENABLE_SME_FOR_NS and ENABLE_SVE_FOR_SWD must also be set to use this.
1441 Default is 0.
1442
1443- ``ENABLE_SPMD_LP`` : This boolean option is used jointly with the SPM
1444 Dispatcher option (``SPD=spmd``). When enabled (1) it indicates support
1445 for logical partitions in EL3, managed by the SPMD as defined in the
1446 FF-A v1.2 specification. This flag is disabled by default. This flag
1447 must not be used if ``SPMC_AT_EL3`` is enabled.
1448
1449- ``FEATURE_DETECTION``: Boolean option to enable the architectural features
Andre Przywara9563c502023-11-23 16:40:13 +00001450 verification mechanism. This is a debug feature that compares the
1451 architectural features enabled through the feature specific build flags
1452 (ENABLE_FEAT_xxx) with the features actually available on the CPU running,
1453 and reports any discrepancies.
1454 This flag will also enable errata ordering checking for ``DEBUG`` builds.
Olivier Deprezb6cd6702023-11-03 11:49:47 +01001455
Andre Przywara9563c502023-11-23 16:40:13 +00001456 It is expected that this feature is only used for flexible platforms like
1457 software emulators, or for hardware platforms at bringup time, to verify
1458 that the configured feature set matches the CPU.
1459 The ``FEATURE_DETECTION`` macro is disabled by default.
Olivier Deprezb6cd6702023-11-03 11:49:47 +01001460
1461- ``PSA_CRYPTO``: Boolean option for enabling MbedTLS PSA crypto APIs support.
1462 The platform will use PSA compliant Crypto APIs during authentication and
1463 image measurement process by enabling this option. It uses APIs defined as
1464 per the `PSA Crypto API specification`_. This feature is only supported if
1465 using MbedTLS 3.x version. It is disabled (``0``) by default.
1466
1467- ``TRANSFER_LIST``: Setting this to ``1`` enables support for Firmware
1468 Handoff using Transfer List defined in `Firmware Handoff specification`_.
1469 This defaults to ``0``. Current implementation follows the Firmware Handoff
1470 specification v0.9.
1471
1472- ``USE_DEBUGFS``: When set to 1 this option exposes a virtual filesystem
1473 interface through BL31 as a SiP SMC function.
1474 Default is disabled (0).
1475
Levi Yun03adb132024-05-13 10:24:31 +01001476- ``HOB_LIST``: Setting this to ``1`` enables support for passing boot
1477 information using HOB defined in `Platform Initialization specification`_.
1478 This defaults to ``0``.
1479
Manish V Badarkhe5c101ae2021-03-16 11:14:19 +00001480Firmware update options
Olivier Deprezb6cd6702023-11-03 11:49:47 +01001481~~~~~~~~~~~~~~~~~~~~~~~
1482
1483- ``PSA_FWU_SUPPORT``: Enable the firmware update mechanism as per the
1484 `PSA FW update specification`_. The default value is 0.
1485 PSA firmware update implementation has few limitations, such as:
1486
1487 - BL2 is not part of the protocol-updatable images. If BL2 needs to
1488 be updated, then it should be done through another platform-defined
1489 mechanism.
1490
1491 - It assumes the platform's hardware supports CRC32 instructions.
Manish V Badarkhe5c101ae2021-03-16 11:14:19 +00001492
1493- ``NR_OF_FW_BANKS``: Define the number of firmware banks. This flag is used
1494 in defining the firmware update metadata structure. This flag is by default
1495 set to '2'.
1496
1497- ``NR_OF_IMAGES_IN_FW_BANK``: Define the number of firmware images in each
1498 firmware bank. Each firmware bank must have the same number of images as per
1499 the `PSA FW update specification`_.
1500 This flag is used in defining the firmware update metadata structure. This
1501 flag is by default set to '1'.
1502
Sughosh Ganu401970b2024-02-01 12:42:40 +05301503- ``PSA_FWU_METADATA_FW_STORE_DESC``: To be enabled when the FWU
1504 metadata contains image description. The default value is 1.
1505
1506 The version 2 of the FWU metadata allows for an opaque metadata
1507 structure where a platform can choose to not include the firmware
1508 store description in the metadata structure. This option indicates
1509 if the firmware store description, which provides information on
1510 the updatable images is part of the structure.
1511
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +01001512--------------
1513
Boyan Karatotev17e059e2023-03-22 15:55:36 +00001514*Copyright (c) 2019-2025, Arm Limited. All rights reserved.*
Jeremy Linton684a0792021-01-26 22:42:03 -06001515
1516.. _DEN0115: https://developer.arm.com/docs/den0115/latest
Sughosh Ganuf01e1e72024-02-01 12:25:09 +05301517.. _PSA FW update specification: https://developer.arm.com/documentation/den0118/latest/
Manish V Badarkhe8564f772022-02-14 18:31:16 +00001518.. _PSA DRTM specification: https://developer.arm.com/documentation/den0113/a
Boyan Karatoteve9e7e8a2022-12-07 10:26:48 +00001519.. _GCC: https://gcc.gnu.org/onlinedocs/gcc/Warning-Options.html
1520.. _Clang: https://clang.llvm.org/docs/DiagnosticsReference.html
Raymond Mao98983392023-07-25 07:53:35 -07001521.. _Firmware Handoff specification: https://github.com/FirmwareHandoff/firmware_handoff/releases/tag/v0.9
Manish V Badarkhe78e14f82023-09-06 09:08:28 +01001522.. _PSA Crypto API specification: https://armmbed.github.io/mbed-crypto/html/
Levi Yun03adb132024-05-13 10:24:31 +01001523.. _Platform Initialization specification: https://uefi.org/specs/PI/1.8/index.html