blob: bcef239c0f484f2408b18e54eefb45376a90c95f [file] [log] [blame]
Paul Beesley43f35ef2019-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
johpow01873d4242020-10-02 13:41:11 -050025- ``AMU_RESTRICT_COUNTERS``: Register reads to the group 1 counters will return
Juan Pablo Conde14c27f82024-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.
johpow01873d4242020-10-02 13:41:11 -050029
Paul Beesley43f35ef2019-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 Fedorovf1821792020-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 Beesley43f35ef2019-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 Badarkheacd03f42023-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 Beesley43f35ef2019-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 Prakash42d4d3b2022-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 Beesley43f35ef2019-05-29 13:59:40 +010070
Balint Dobszay46789a72021-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 Beesley43f35ef2019-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 Prakash42d4d3b2022-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 Beesley43f35ef2019-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 Gracht616b3ce2023-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 Beesley43f35ef2019-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 Gracht616b3ce2023-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 Beesley43f35ef2019-05-29 13:59:40 +0100101
Jaylyn Ren1b7f51e2024-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 Beesley43f35ef2019-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 Gracht616b3ce2023-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 Beesley43f35ef2019-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
116 ``-mbranch-protection``. Selects the branch protection features to use:
117- 0: Default value turns off all types of branch protection
118- 1: Enables all types of branch protection features
119- 2: Return address signing to its standard level
120- 3: Extend the signing to include leaf functions
Alexei Fedorov3768fec2020-06-19 14:33:49 +0100121- 4: Turn on branch target identification mechanism
Paul Beesley43f35ef2019-05-29 13:59:40 +0100122
123 The table below summarizes ``BRANCH_PROTECTION`` values, GCC compilation options
124 and resulting PAuth/BTI features.
125
126 +-------+--------------+-------+-----+
127 | Value | GCC option | PAuth | BTI |
128 +=======+==============+=======+=====+
129 | 0 | none | N | N |
130 +-------+--------------+-------+-----+
131 | 1 | standard | Y | Y |
132 +-------+--------------+-------+-----+
133 | 2 | pac-ret | Y | N |
134 +-------+--------------+-------+-----+
135 | 3 | pac-ret+leaf | Y | N |
136 +-------+--------------+-------+-----+
Alexei Fedorov3768fec2020-06-19 14:33:49 +0100137 | 4 | bti | N | Y |
138 +-------+--------------+-------+-----+
Paul Beesley43f35ef2019-05-29 13:59:40 +0100139
Manish Pandey700e7682021-10-21 21:53:49 +0100140 This option defaults to 0.
Paul Beesley43f35ef2019-05-29 13:59:40 +0100141 Note that Pointer Authentication is enabled for Non-secure world
142 irrespective of the value of this option if the CPU supports it.
143
144- ``BUILD_MESSAGE_TIMESTAMP``: String used to identify the time and date of the
145 compilation of each build. It must be set to a C string (including quotes
146 where applicable). Defaults to a string that contains the time and date of
147 the compilation.
148
149- ``BUILD_STRING``: Input string for VERSION_STRING, which allows the TF-A
150 build to be uniquely identified. Defaults to the current git commit id.
151
Grant Likely29214e92020-07-30 08:50:10 +0100152- ``BUILD_BASE``: Output directory for the build. Defaults to ``./build``
153
Paul Beesley43f35ef2019-05-29 13:59:40 +0100154- ``CFLAGS``: Extra user options appended on the compiler's command line in
155 addition to the options set by the build system.
156
157- ``COLD_BOOT_SINGLE_CPU``: This option indicates whether the platform may
158 release several CPUs out of reset. It can take either 0 (several CPUs may be
159 brought up) or 1 (only one CPU will ever be brought up during cold reset).
160 Default is 0. If the platform always brings up a single CPU, there is no
161 need to distinguish between primary and secondary CPUs and the boot path can
162 be optimised. The ``plat_is_my_cpu_primary()`` and
163 ``plat_secondary_cold_boot_setup()`` platform porting interfaces do not need
164 to be implemented in this case.
165
Sandrine Bailleux3bff9102020-01-15 10:23:25 +0100166- ``COT``: When Trusted Boot is enabled, selects the desired chain of trust.
167 Defaults to ``tbbr``.
168
Paul Beesley43f35ef2019-05-29 13:59:40 +0100169- ``CRASH_REPORTING``: A non-zero value enables a console dump of processor
170 register state when an unexpected exception occurs during execution of
171 BL31. This option defaults to the value of ``DEBUG`` - i.e. by default
172 this is only enabled for a debug build of the firmware.
173
174- ``CREATE_KEYS``: This option is used when ``GENERATE_COT=1``. It tells the
175 certificate generation tool to create new keys in case no valid keys are
176 present or specified. Allowed options are '0' or '1'. Default is '1'.
177
178- ``CTX_INCLUDE_AARCH32_REGS`` : Boolean option that, when set to 1, will cause
179 the AArch32 system registers to be included when saving and restoring the
180 CPU context. The option must be set to 0 for AArch64-only platforms (that
181 is on hardware that does not implement AArch32, or at least not at EL1 and
182 higher ELs). Default value is 1.
183
184- ``CTX_INCLUDE_FPREGS``: Boolean option that, when set to 1, will cause the FP
185 registers to be included when saving and restoring the CPU context. Default
186 is 0.
187
Arvind Ram Prakash9acff282023-10-06 14:35:21 -0500188- ``CTX_INCLUDE_MPAM_REGS``: Boolean option that, when set to 1, will cause the
189 Memory System Resource Partitioning and Monitoring (MPAM)
190 registers to be included when saving and restoring the CPU context.
191 Default is '0'.
192
Jayanth Dodderi Chidanandd9e984c2022-02-28 23:41:41 +0000193- ``CTX_INCLUDE_NEVE_REGS``: Numeric value, when set will cause the Armv8.4-NV
194 registers to be saved/restored when entering/exiting an EL2 execution
195 context. This flag can take values 0 to 2, to align with the
Andre Przywara641571c2023-11-23 16:40:13 +0000196 ``ENABLE_FEAT`` mechanism. Default value is 0.
Jayanth Dodderi Chidanandd9e984c2022-02-28 23:41:41 +0000197
198- ``CTX_INCLUDE_PAUTH_REGS``: Numeric value to enable the Pointer
199 Authentication for Secure world. This will cause the ARMv8.3-PAuth registers
200 to be included when saving and restoring the CPU context as part of world
Andre Przywara641571c2023-11-23 16:40:13 +0000201 switch. This flag can take values 0 to 2, to align with ``ENABLE_FEAT``
Jayanth Dodderi Chidanandd9e984c2022-02-28 23:41:41 +0000202 mechanism. Default value is 0.
203
Paul Beesley43f35ef2019-05-29 13:59:40 +0100204 Note that Pointer Authentication is enabled for Non-secure world irrespective
205 of the value of this flag if the CPU supports it.
206
Madhukar Pappireddy50fba2d2024-07-05 12:44:08 -0500207- ``CTX_INCLUDE_SVE_REGS``: Boolean option that, when set to 1, will cause the
208 SVE registers to be included when saving and restoring the CPU context. Note
209 that this build option requires ``ENABLE_SVE_FOR_SWD`` to be enabled. In
210 general, it is recommended to perform SVE context management in lower ELs
211 and skip in EL3 due to the additional cost of maintaining large data
212 structures to track the SVE state. Hence, the default value is 0.
213
Paul Beesley43f35ef2019-05-29 13:59:40 +0100214- ``DEBUG``: Chooses between a debug and release build. It can take either 0
215 (release) or 1 (debug) as values. 0 is the default.
216
Sumit Garg7cda17b2019-11-15 10:43:00 +0530217- ``DECRYPTION_SUPPORT``: This build flag enables the user to select the
218 authenticated decryption algorithm to be used to decrypt firmware/s during
219 boot. It accepts 2 values: ``aes_gcm`` and ``none``. The default value of
220 this flag is ``none`` to disable firmware decryption which is an optional
Manish Pandey700e7682021-10-21 21:53:49 +0100221 feature as per TBBR.
Sumit Garg7cda17b2019-11-15 10:43:00 +0530222
Paul Beesley43f35ef2019-05-29 13:59:40 +0100223- ``DISABLE_BIN_GENERATION``: Boolean option to disable the generation
224 of the binary image. If set to 1, then only the ELF image is built.
225 0 is the default.
226
Boyan Karatotev83a4dae2023-02-16 09:45:29 +0000227- ``DISABLE_MTPMU``: Numeric option to disable ``FEAT_MTPMU`` (Multi Threaded
228 PMU). ``FEAT_MTPMU`` is an optional feature available on Armv8.6 onwards.
Andre Przywara641571c2023-11-23 16:40:13 +0000229 This flag can take values 0 to 2, to align with the ``ENABLE_FEAT``
Boyan Karatotev83a4dae2023-02-16 09:45:29 +0000230 mechanism. Default is ``0``.
Javier Almansa Sobrino0063dd12020-11-23 18:38:15 +0000231
Paul Beesley43f35ef2019-05-29 13:59:40 +0100232- ``DYN_DISABLE_AUTH``: Provides the capability to dynamically disable Trusted
233 Board Boot authentication at runtime. This option is meant to be enabled only
234 for development platforms. ``TRUSTED_BOARD_BOOT`` flag must be set if this
235 flag has to be enabled. 0 is the default.
236
237- ``E``: Boolean option to make warnings into errors. Default is 1.
238
Boyan Karatotev291be192022-12-07 10:26:48 +0000239 When specifying higher warnings levels (``W=1`` and higher), this option
240 defaults to 0. This is done to encourage contributors to use them, as they
241 are expected to produce warnings that would otherwise fail the build. New
242 contributions are still expected to build with ``W=0`` and ``E=1`` (the
243 default).
244
Yann Gautierae770fe2024-01-16 19:39:31 +0100245- ``EARLY_CONSOLE``: This option is used to enable early traces before default
246 console is properly setup. It introduces EARLY_* traces macros, that will
247 use the non-EARLY traces macros if the flag is enabled, or do nothing
248 otherwise. To use this feature, platforms will have to create the function
249 plat_setup_early_console().
250 Default is 0 (disabled)
251
Paul Beesley43f35ef2019-05-29 13:59:40 +0100252- ``EL3_PAYLOAD_BASE``: This option enables booting an EL3 payload instead of
253 the normal boot flow. It must specify the entry point address of the EL3
254 payload. Please refer to the "Booting an EL3 payload" section for more
255 details.
256
Chris Kay1fd685a2021-05-25 10:42:56 +0100257- ``ENABLE_AMU_AUXILIARY_COUNTERS``: Enables support for AMU auxiliary counters
258 (also known as group 1 counters). These are implementation-defined counters,
259 and as such require additional platform configuration. Default is 0.
260
Chris Kay742ca232021-08-19 11:21:52 +0100261- ``ENABLE_AMU_FCONF``: Enables configuration of the AMU through FCONF, which
262 allows platforms with auxiliary counters to describe them via the
263 ``HW_CONFIG`` device tree blob. Default is 0.
264
Paul Beesley43f35ef2019-05-29 13:59:40 +0100265- ``ENABLE_ASSERTIONS``: This option controls whether or not calls to ``assert()``
266 are compiled out. For debug builds, this option defaults to 1, and calls to
267 ``assert()`` are left in place. For release builds, this option defaults to 0
268 and calls to ``assert()`` function are compiled out. This option can be set
269 independently of ``DEBUG``. It can also be used to hide any auxiliary code
270 that is only required for the assertion and does not fit in the assertion
271 itself.
272
Alexei Fedorov68c76082020-02-06 17:11:03 +0000273- ``ENABLE_BACKTRACE``: This option controls whether to enable backtrace
Paul Beesley43f35ef2019-05-29 13:59:40 +0100274 dumps or not. It is supported in both AArch64 and AArch32. However, in
275 AArch32 the format of the frame records are not defined in the AAPCS and they
276 are defined by the implementation. This implementation of backtrace only
277 supports the format used by GCC when T32 interworking is disabled. For this
278 reason enabling this option in AArch32 will force the compiler to only
279 generate A32 code. This option is enabled by default only in AArch64 debug
280 builds, but this behaviour can be overridden in each platform's Makefile or
281 in the build command line.
282
Andre Przywara641571c2023-11-23 16:40:13 +0000283- ``ENABLE_FEAT``
284 The Arm architecture defines several architecture extension features,
285 named FEAT_xxx in the architecure manual. Some of those features require
286 setup code in higher exception levels, other features might be used by TF-A
287 code itself.
288 Most of the feature flags defined in the TF-A build system permit to take
289 the values 0, 1 or 2, with the following meaning:
290
291 ::
292
293 ENABLE_FEAT_* = 0: Feature is disabled statically at compile time.
294 ENABLE_FEAT_* = 1: Feature is enabled unconditionally at compile time.
295 ENABLE_FEAT_* = 2: Feature is enabled, but checked at runtime.
296
297 When setting the flag to 0, the feature is disabled during compilation,
298 and the compiler's optimisation stage and the linker will try to remove
299 as much of this code as possible.
300 If it is defined to 1, the code will use the feature unconditionally, so the
301 CPU is expected to support that feature. The FEATURE_DETECTION debug
302 feature, if enabled, will verify this.
303 If the feature flag is set to 2, support for the feature will be compiled
304 in, but its existence will be checked at runtime, so it works on CPUs with
305 or without the feature. This is mostly useful for platforms which either
306 support multiple different CPUs, or where the CPU is configured at runtime,
307 like in emulators.
308
Andre Przywarad23acc92023-03-21 13:53:19 +0000309- ``ENABLE_FEAT_AMU``: Numeric value to enable Activity Monitor Unit
310 extensions. This flag can take the values 0 to 2, to align with the
Andre Przywara641571c2023-11-23 16:40:13 +0000311 ``ENABLE_FEAT`` mechanism. This is an optional architectural feature
Andre Przywarad23acc92023-03-21 13:53:19 +0000312 available on v8.4 onwards. Some v8.2 implementations also implement an AMU
313 and this option can be used to enable this feature on those systems as well.
314 This flag can take the values 0 to 2, the default is 0.
Jayanth Dodderi Chidanand64017762021-12-05 19:21:14 +0000315
Jayanth Dodderi Chidanandd9e984c2022-02-28 23:41:41 +0000316- ``ENABLE_FEAT_AMUv1p1``: Numeric value to enable the ``FEAT_AMUv1p1``
317 extension. ``FEAT_AMUv1p1`` is an optional feature available on Arm v8.6
318 onwards. This flag can take the values 0 to 2, to align with the
Andre Przywara641571c2023-11-23 16:40:13 +0000319 ``ENABLE_FEAT`` mechanism. Default value is ``0``.
Jayanth Dodderi Chidanandd9e984c2022-02-28 23:41:41 +0000320
321- ``ENABLE_FEAT_CSV2_2``: Numeric value to enable the ``FEAT_CSV2_2``
322 extension. It allows access to the SCXTNUM_EL2 (Software Context Number)
323 register during EL2 context save/restore operations. ``FEAT_CSV2_2`` is an
324 optional feature available on Arm v8.0 onwards. This flag can take values
Andre Przywara641571c2023-11-23 16:40:13 +0000325 0 to 2, to align with the ``ENABLE_FEAT`` mechanism.
Jayanth Dodderi Chidanandd9e984c2022-02-28 23:41:41 +0000326 Default value is ``0``.
327
Sona Mathew30019d82023-10-25 16:48:19 -0500328- ``ENABLE_FEAT_CSV2_3``: Numeric value to enable support for ``FEAT_CSV2_3``
329 extension. This feature is supported in AArch64 state only and is an optional
330 feature available in Arm v8.0 implementations.
331 ``FEAT_CSV2_3`` implies the implementation of ``FEAT_CSV2_2``.
332 The flag can take values 0 to 2, to align with the ``ENABLE_FEAT``
333 mechanism. Default value is ``0``.
334
Arvind Ram Prakash83271d52024-05-22 15:24:00 -0500335- ``ENABLE_FEAT_DEBUGV8P9``: Numeric value to enable ``FEAT_DEBUGV8P9``
336 extension which allows the ability to implement more than 16 breakpoints
337 and/or watchpoints. This feature is mandatory from v8.9 and is optional
338 from v8.8. This flag can take the values of 0 to 2, to align with the
339 ``ENABLE_FEAT`` mechanism. Default value is ``0``.
340
Jayanth Dodderi Chidanandd9e984c2022-02-28 23:41:41 +0000341- ``ENABLE_FEAT_DIT``: Numeric value to enable ``FEAT_DIT`` (Data Independent
342 Timing) extension. It allows setting the ``DIT`` bit of PSTATE in EL3.
343 ``FEAT_DIT`` is a mandatory architectural feature and is enabled from v8.4
344 and upwards. This flag can take the values 0 to 2, to align with the
Andre Przywara641571c2023-11-23 16:40:13 +0000345 ``ENABLE_FEAT`` mechanism. Default value is ``0``.
Jayanth Dodderi Chidanandd9e984c2022-02-28 23:41:41 +0000346
347- ``ENABLE_FEAT_ECV``: Numeric value to enable support for the Enhanced Counter
Jayanth Dodderi Chidanand64017762021-12-05 19:21:14 +0000348 Virtualization feature, allowing for access to the CNTPOFF_EL2 (Counter-timer
349 Physical Offset register) during EL2 to EL3 context save/restore operations.
Jayanth Dodderi Chidanandd9e984c2022-02-28 23:41:41 +0000350 Its a mandatory architectural feature and is enabled from v8.6 and upwards.
Andre Przywara641571c2023-11-23 16:40:13 +0000351 This flag can take the values 0 to 2, to align with the ``ENABLE_FEAT``
Jayanth Dodderi Chidanandd9e984c2022-02-28 23:41:41 +0000352 mechanism. Default value is ``0``.
Jayanth Dodderi Chidanand64017762021-12-05 19:21:14 +0000353
Jayanth Dodderi Chidanandd9e984c2022-02-28 23:41:41 +0000354- ``ENABLE_FEAT_FGT``: Numeric value to enable support for FGT (Fine Grain Traps)
Jayanth Dodderi Chidanand64017762021-12-05 19:21:14 +0000355 feature allowing for access to the HDFGRTR_EL2 (Hypervisor Debug Fine-Grained
Jayanth Dodderi Chidanandd9e984c2022-02-28 23:41:41 +0000356 Read Trap Register) during EL2 to EL3 context save/restore operations.
357 Its a mandatory architectural feature and is enabled from v8.6 and upwards.
Andre Przywara641571c2023-11-23 16:40:13 +0000358 This flag can take the values 0 to 2, to align with the ``ENABLE_FEAT``
Jayanth Dodderi Chidanandd9e984c2022-02-28 23:41:41 +0000359 mechanism. Default value is ``0``.
Jayanth Dodderi Chidanand64017762021-12-05 19:21:14 +0000360
Arvind Ram Prakash33e6aaa2024-06-06 11:33:37 -0500361- ``ENABLE_FEAT_FGT2``: Numeric value to enable support for FGT2
362 (Fine Grain Traps 2) feature allowing for access to Fine-grained trap 2 registers
363 during EL2 to EL3 context save/restore operations.
364 Its an optional architectural feature and is available from v8.8 and upwards.
365 This flag can take the values 0 to 2, to align with the ``ENABLE_FEAT``
366 mechanism. Default value is ``0``.
367
Jayanth Dodderi Chidanandd9e984c2022-02-28 23:41:41 +0000368- ``ENABLE_FEAT_HCX``: Numeric value to set the bit SCR_EL3.HXEn in EL3 to
369 allow access to HCRX_EL2 (extended hypervisor control register) from EL2 as
370 well as adding HCRX_EL2 to the EL2 context save/restore operations. Its a
371 mandatory architectural feature and is enabled from v8.7 and upwards. This
Andre Przywara641571c2023-11-23 16:40:13 +0000372 flag can take the values 0 to 2, to align with the ``ENABLE_FEAT``
Jayanth Dodderi Chidanandd9e984c2022-02-28 23:41:41 +0000373 mechanism. Default value is ``0``.
374
Govindraj Raja8e397882024-01-26 10:08:37 -0600375- ``ENABLE_FEAT_MTE2``: Numeric value to enable Memory Tagging Extension2
376 if the platform wants to use this feature and MTE2 is enabled at ELX.
377 This flag can take values 0 to 2, to align with the ``ENABLE_FEAT``
378 mechanism. Default value is ``0``.
Govindraj Raja0a33adc2023-12-21 13:57:49 -0600379
Jayanth Dodderi Chidanandd9e984c2022-02-28 23:41:41 +0000380- ``ENABLE_FEAT_PAN``: Numeric value to enable the ``FEAT_PAN`` (Privileged
381 Access Never) extension. ``FEAT_PAN`` adds a bit to PSTATE, generating a
382 permission fault for any privileged data access from EL1/EL2 to virtual
383 memory address, accessible at EL0, provided (HCR_EL2.E2H=1). It is a
384 mandatory architectural feature and is enabled from v8.1 and upwards. This
Andre Przywara641571c2023-11-23 16:40:13 +0000385 flag can take values 0 to 2, to align with the ``ENABLE_FEAT``
Jayanth Dodderi Chidanandd9e984c2022-02-28 23:41:41 +0000386 mechanism. Default value is ``0``.
387
388- ``ENABLE_FEAT_RNG``: Numeric value to enable the ``FEAT_RNG`` extension.
389 ``FEAT_RNG`` is an optional feature available on Arm v8.5 onwards. This
Andre Przywara641571c2023-11-23 16:40:13 +0000390 flag can take the values 0 to 2, to align with the ``ENABLE_FEAT``
Juan Pablo Condeff86e0b2022-07-12 16:40:29 -0400391 mechanism. Default value is ``0``.
392
393- ``ENABLE_FEAT_RNG_TRAP``: Numeric value to enable the ``FEAT_RNG_TRAP``
394 extension. This feature is only supported in AArch64 state. This flag can
Andre Przywara641571c2023-11-23 16:40:13 +0000395 take values 0 to 2, to align with the ``ENABLE_FEAT`` mechanism.
Juan Pablo Condeff86e0b2022-07-12 16:40:29 -0400396 Default value is ``0``. ``FEAT_RNG_TRAP`` is an optional feature from
397 Armv8.5 onwards.
Jayanth Dodderi Chidanandd9e984c2022-02-28 23:41:41 +0000398
Andre Przywara24077092022-11-17 16:42:09 +0000399- ``ENABLE_FEAT_SB``: Boolean option to let the TF-A code use the ``FEAT_SB``
400 (Speculation Barrier) instruction ``FEAT_SB`` is an optional feature and
401 defaults to ``0`` for pre-Armv8.5 CPUs, but is mandatory for Armv8.5 or
402 later CPUs. It is enabled from v8.5 and upwards and if needed can be
403 overidden from platforms explicitly.
Jayanth Dodderi Chidanandd9e984c2022-02-28 23:41:41 +0000404
405- ``ENABLE_FEAT_SEL2``: Numeric value to enable the ``FEAT_SEL2`` (Secure EL2)
406 extension. ``FEAT_SEL2`` is a mandatory feature available on Arm v8.4.
Andre Przywara641571c2023-11-23 16:40:13 +0000407 This flag can take values 0 to 2, to align with the ``ENABLE_FEAT``
Jayanth Dodderi Chidanandd9e984c2022-02-28 23:41:41 +0000408 mechanism. Default is ``0``.
409
Jayanth Dodderi Chidanand781d07a2022-03-28 15:28:55 +0100410- ``ENABLE_FEAT_TWED``: Numeric value to enable the ``FEAT_TWED`` (Delayed
411 trapping of WFE Instruction) extension. ``FEAT_TWED`` is a optional feature
412 available on Arm v8.6. This flag can take values 0 to 2, to align with the
Andre Przywara641571c2023-11-23 16:40:13 +0000413 ``ENABLE_FEAT`` mechanism. Default is ``0``.
Jayanth Dodderi Chidanand781d07a2022-03-28 15:28:55 +0100414
415 When ``ENABLE_FEAT_TWED`` is set to ``1``, WFE instruction trapping gets
416 delayed by the amount of value in ``TWED_DELAY``.
417
Jayanth Dodderi Chidanandd9e984c2022-02-28 23:41:41 +0000418- ``ENABLE_FEAT_VHE``: Numeric value to enable the ``FEAT_VHE`` (Virtualization
419 Host Extensions) extension. It allows access to CONTEXTIDR_EL2 register
420 during EL2 context save/restore operations.``FEAT_VHE`` is a mandatory
421 architectural feature and is enabled from v8.1 and upwards. It can take
Andre Przywara641571c2023-11-23 16:40:13 +0000422 values 0 to 2, to align with the ``ENABLE_FEAT`` mechanism.
Jayanth Dodderi Chidanandd9e984c2022-02-28 23:41:41 +0000423 Default value is ``0``.
johpow01cb4ec472021-08-04 19:38:18 -0500424
Mark Brownd3331602023-03-14 20:13:03 +0000425- ``ENABLE_FEAT_TCR2``: Numeric value to set the bit SCR_EL3.ENTCR2 in EL3 to
426 allow access to TCR2_EL2 (extended translation control) from EL2 as
427 well as adding TCR2_EL2 to the EL2 context save/restore operations. Its a
428 mandatory architectural feature and is enabled from v8.9 and upwards. This
Andre Przywara641571c2023-11-23 16:40:13 +0000429 flag can take the values 0 to 2, to align with the ``ENABLE_FEAT``
Mark Brownd3331602023-03-14 20:13:03 +0000430 mechanism. Default value is ``0``.
431
Mark Brown062b6c62023-03-14 20:48:43 +0000432- ``ENABLE_FEAT_S2PIE``: Numeric value to enable support for FEAT_S2PIE
433 at EL2 and below, and context switch relevant registers. This flag
Andre Przywara641571c2023-11-23 16:40:13 +0000434 can take the values 0 to 2, to align with the ``ENABLE_FEAT``
Mark Brown062b6c62023-03-14 20:48:43 +0000435 mechanism. Default value is ``0``.
436
437- ``ENABLE_FEAT_S1PIE``: Numeric value to enable support for FEAT_S1PIE
438 at EL2 and below, and context switch relevant registers. This flag
Andre Przywara641571c2023-11-23 16:40:13 +0000439 can take the values 0 to 2, to align with the ``ENABLE_FEAT``
Mark Brown062b6c62023-03-14 20:48:43 +0000440 mechanism. Default value is ``0``.
441
442- ``ENABLE_FEAT_S2POE``: Numeric value to enable support for FEAT_S2POE
443 at EL2 and below, and context switch relevant registers. This flag
Andre Przywara641571c2023-11-23 16:40:13 +0000444 can take the values 0 to 2, to align with the ``ENABLE_FEAT``
Mark Brown062b6c62023-03-14 20:48:43 +0000445 mechanism. Default value is ``0``.
446
447- ``ENABLE_FEAT_S1POE``: Numeric value to enable support for FEAT_S1POE
448 at EL2 and below, and context switch relevant registers. This flag
Andre Przywara641571c2023-11-23 16:40:13 +0000449 can take the values 0 to 2, to align with the ``ENABLE_FEAT``
Mark Brown062b6c62023-03-14 20:48:43 +0000450 mechanism. Default value is ``0``.
451
Mark Brown688ab572023-03-14 21:33:04 +0000452- ``ENABLE_FEAT_GCS``: Numeric value to set the bit SCR_EL3.GCSEn in EL3 to
453 allow use of Guarded Control Stack from EL2 as well as adding the GCS
454 registers to the EL2 context save/restore operations. This flag can take
Andre Przywara641571c2023-11-23 16:40:13 +0000455 the values 0 to 2, to align with the ``ENABLE_FEAT`` mechanism.
Mark Brown688ab572023-03-14 21:33:04 +0000456 Default value is ``0``.
457
Jayanth Dodderi Chidanand6d0433f2024-09-05 22:24:04 +0100458- ``ENABLE_FEAT_THE``: Numeric value to enable support for FEAT_THE
459 (Translation Hardening Extension) at EL2 and below, setting the bit
460 SCR_EL3.RCWMASKEn in EL3 to allow access to RCWMASK_EL1 and RCWSMASK_EL1
461 registers and context switch them.
462 Its an optional architectural feature and is available from v8.8 and upwards.
463 This flag can take the values 0 to 2, to align with the ``ENABLE_FEAT``
464 mechanism. Default value is ``0``.
465
Jayanth Dodderi Chidanand4ec4e542024-09-06 13:49:31 +0100466- ``ENABLE_FEAT_SCTLR2``: Numeric value to enable support for FEAT_SCTLR2
467 (Extension to SCTLR_ELx) at EL2 and below, setting the bit
468 SCR_EL3.SCTLR2En in EL3 to allow access to SCTLR2_ELx registers and
469 context switch them. This feature is OPTIONAL from Armv8.0 implementations
470 and mandatory in Armv8.9 implementations.
471 This flag can take the values 0 to 2, to align with the ``ENABLE_FEAT``
472 mechanism. Default value is ``0``.
473
Govindraj Raja30655132024-09-06 15:43:43 +0100474- ``ENABLE_FEAT_D128``: Numeric value to enable support for FEAT_D128
475 at EL2 and below, setting the bit SCT_EL3.D128En in EL3 to allow access to
476 128 bit version of system registers like PAR_EL1, TTBR0_EL1, TTBR1_EL1,
477 TTBR0_EL2, TTBR1_EL2, TTBR0_EL12, TTBR1_EL12 , VTTBR_EL2, RCWMASK_EL1, and
478 RCWSMASK_EL1. Its an optional architectural feature and is available from
479 9.3 and upwards.
480 This flag can take the values 0 to 2, to align with the ``ENABLE_FEAT``
481 mechanism. Default value is ``0``.
482
Sandrine Bailleux535fa662019-12-17 09:38:08 +0100483- ``ENABLE_LTO``: Boolean option to enable Link Time Optimization (LTO)
zelalem-awekeedbce9a2019-11-12 16:20:17 -0600484 support in GCC for TF-A. This option is currently only supported for
485 AArch64. Default is 0.
486
Arvind Ram Prakashedebefb2023-10-11 12:10:56 -0500487- ``ENABLE_FEAT_MPAM``: Numeric value to enable lower ELs to use MPAM
Paul Beesley43f35ef2019-05-29 13:59:40 +0100488 feature. MPAM is an optional Armv8.4 extension that enables various memory
489 system components and resources to define partitions; software running at
490 various ELs can assign themselves to desired partition to control their
491 performance aspects.
492
Andre Przywara641571c2023-11-23 16:40:13 +0000493 This flag can take values 0 to 2, to align with the ``ENABLE_FEAT``
Jayanth Dodderi Chidanandd9e984c2022-02-28 23:41:41 +0000494 mechanism. When this option is set to ``1`` or ``2``, EL3 allows lower ELs to
495 access their own MPAM registers without trapping into EL3. This option
496 doesn't make use of partitioning in EL3, however. Platform initialisation
497 code should configure and use partitions in EL3 as required. This option
Arvind Ram Prakashedebefb2023-10-11 12:10:56 -0500498 defaults to ``2`` since MPAM is enabled by default for NS world only.
499 The flag is automatically disabled when the target
500 architecture is AArch32.
Paul Beesley43f35ef2019-05-29 13:59:40 +0100501
Andre Przywara19d52a82024-08-09 17:04:22 +0100502- ``ENABLE_FEAT_LS64_ACCDATA``: Numeric value to enable access and save and
503 restore the ACCDATA_EL1 system register, at EL2 and below. This flag can
504 take the values 0 to 2, to align with the ``ENABLE_FEAT`` mechanism.
505 Default value is ``0``.
506
Chris Kay68120782021-05-05 13:38:30 +0100507- ``ENABLE_MPMM``: Boolean option to enable support for the Maximum Power
508 Mitigation Mechanism supported by certain Arm cores, which allows the SoC
509 firmware to detect and limit high activity events to assist in SoC processor
510 power domain dynamic power budgeting and limit the triggering of whole-rail
511 (i.e. clock chopping) responses to overcurrent conditions. Defaults to ``0``.
512
513- ``ENABLE_MPMM_FCONF``: Enables configuration of MPMM through FCONF, which
514 allows platforms with cores supporting MPMM to describe them via the
515 ``HW_CONFIG`` device tree blob. Default is 0.
516
Paul Beesley43f35ef2019-05-29 13:59:40 +0100517- ``ENABLE_PIE``: Boolean option to enable Position Independent Executable(PIE)
518 support within generic code in TF-A. This option is currently only supported
Arvind Ram Prakash42d4d3b2022-11-22 14:41:00 -0600519 in BL2, BL31, and BL32 (TSP) for AARCH64 binaries, and
520 in BL32 (SP_min) for AARCH32. Default is 0.
Paul Beesley43f35ef2019-05-29 13:59:40 +0100521
522- ``ENABLE_PMF``: Boolean option to enable support for optional Performance
523 Measurement Framework(PMF). Default is 0.
524
525- ``ENABLE_PSCI_STAT``: Boolean option to enable support for optional PSCI
526 functions ``PSCI_STAT_RESIDENCY`` and ``PSCI_STAT_COUNT``. Default is 0.
527 In the absence of an alternate stat collection backend, ``ENABLE_PMF`` must
528 be enabled. If ``ENABLE_PMF`` is set, the residency statistics are tracked in
529 software.
530
531- ``ENABLE_RUNTIME_INSTRUMENTATION``: Boolean option to enable runtime
532 instrumentation which injects timestamp collection points into TF-A to
533 allow runtime performance to be measured. Currently, only PSCI is
534 instrumented. Enabling this option enables the ``ENABLE_PMF`` build option
535 as well. Default is 0.
536
Andre Przywara6437a092022-11-17 16:42:09 +0000537- ``ENABLE_SPE_FOR_NS`` : Numeric value to enable Statistical Profiling
Paul Beesley43f35ef2019-05-29 13:59:40 +0100538 extensions. This is an optional architectural feature for AArch64.
Andre Przywara641571c2023-11-23 16:40:13 +0000539 This flag can take the values 0 to 2, to align with the ``ENABLE_FEAT``
Andre Przywara6437a092022-11-17 16:42:09 +0000540 mechanism. The default is 2 but is automatically disabled when the target
541 architecture is AArch32.
Paul Beesley43f35ef2019-05-29 13:59:40 +0100542
Jayanth Dodderi Chidanand2b0bc4e2023-03-07 10:43:19 +0000543- ``ENABLE_SVE_FOR_NS``: Numeric value to enable Scalable Vector Extension
Paul Beesley43f35ef2019-05-29 13:59:40 +0100544 (SVE) for the Non-secure world only. SVE is an optional architectural feature
Madhukar Pappireddy50fba2d2024-07-05 12:44:08 -0500545 for AArch64. This flag can take the values 0 to 2, to align with the
546 ``ENABLE_FEAT`` mechanism. At this time, this build option cannot be used on
547 systems that have SPM_MM enabled. The default value is 2.
Paul Beesley43f35ef2019-05-29 13:59:40 +0100548
Madhukar Pappireddy50fba2d2024-07-05 12:44:08 -0500549 Note that when SVE is enabled for the Non-secure world, access
550 to SVE, SIMD and floating-point functionality from the Secure world is
551 independently controlled by build option ``ENABLE_SVE_FOR_SWD``. When enabling
552 ``CTX_INCLUDE_FPREGS`` and ``ENABLE_SVE_FOR_NS`` together, it is mandatory to
553 enable ``CTX_INCLUDE_SVE_REGS``. This is to avoid corruption of the Non-secure
554 world data in the Z-registers which are aliased by the SIMD and FP registers.
555
556- ``ENABLE_SVE_FOR_SWD``: Boolean option to enable SVE and FPU/SIMD functionality
557 for the Secure world. SVE is an optional architectural feature for AArch64.
558 The default is 0 and it is automatically disabled when the target architecture
559 is AArch32.
560
561 .. note::
562 This build flag requires ``ENABLE_SVE_FOR_NS`` to be enabled. When enabling
563 ``ENABLE_SVE_FOR_SWD``, a developer must carefully consider whether
564 ``CTX_INCLUDE_SVE_REGS`` is also needed.
Max Shvetsov0c5e7d12021-03-22 11:59:37 +0000565
Paul Beesley43f35ef2019-05-29 13:59:40 +0100566- ``ENABLE_STACK_PROTECTOR``: String option to enable the stack protection
567 checks in GCC. Allowed values are "all", "strong", "default" and "none". The
568 default value is set to "none". "strong" is the recommended stack protection
569 level if this feature is desired. "none" disables the stack protection. For
570 all values other than "none", the ``plat_get_stack_protector_canary()``
571 platform hook needs to be implemented. The value is passed as the last
572 component of the option ``-fstack-protector-$ENABLE_STACK_PROTECTOR``.
573
Boyan Karatotev04aca842023-03-22 15:55:36 +0000574- ``ENABLE_ERRATA_ALL``: This option is used only for testing purposes, Boolean
575 option to enable the workarounds for all errata that TF-A implements. Normally
576 they should be explicitly enabled depending on each platform's needs. Not
577 recommended for release builds. This option is default set to 0.
578
Sumit Gargf97062a2019-11-15 18:47:53 +0530579- ``ENCRYPT_BL31``: Binary flag to enable encryption of BL31 firmware. This
Manish Pandey700e7682021-10-21 21:53:49 +0100580 flag depends on ``DECRYPTION_SUPPORT`` build flag.
Sumit Gargf97062a2019-11-15 18:47:53 +0530581
582- ``ENCRYPT_BL32``: Binary flag to enable encryption of Secure BL32 payload.
Manish Pandey700e7682021-10-21 21:53:49 +0100583 This flag depends on ``DECRYPTION_SUPPORT`` build flag.
Sumit Gargf97062a2019-11-15 18:47:53 +0530584
585- ``ENC_KEY``: A 32-byte (256-bit) symmetric key in hex string format. It could
586 either be SSK or BSSK depending on ``FW_ENC_STATUS`` flag. This value depends
Manish Pandey700e7682021-10-21 21:53:49 +0100587 on ``DECRYPTION_SUPPORT`` build flag.
Sumit Gargf97062a2019-11-15 18:47:53 +0530588
589- ``ENC_NONCE``: A 12-byte (96-bit) encryption nonce or Initialization Vector
590 (IV) in hex string format. This value depends on ``DECRYPTION_SUPPORT``
Manish Pandey700e7682021-10-21 21:53:49 +0100591 build flag.
Sumit Gargf97062a2019-11-15 18:47:53 +0530592
Paul Beesley43f35ef2019-05-29 13:59:40 +0100593- ``ERROR_DEPRECATED``: This option decides whether to treat the usage of
594 deprecated platform APIs, helper functions or drivers within Trusted
595 Firmware as error. It can take the value 1 (flag the use of deprecated
596 APIs as error) or 0. The default is 0.
597
Rajasekaran Kalidossffdf5ea2023-05-09 12:28:07 +0200598- ``ETHOSN_NPU_DRIVER``: boolean option to enable a SiP service that can
599 configure an Arm® Ethos™-N NPU. To use this service the target platform's
600 ``HW_CONFIG`` must include the device tree nodes for the NPU. Currently, only
601 the Arm Juno platform has this included in its ``HW_CONFIG`` and the platform
602 only loads the ``HW_CONFIG`` in AArch64 builds. Default is 0.
603
604- ``ETHOSN_NPU_TZMP1``: boolean option to enable TZMP1 support for the
605 Arm® Ethos™-N NPU. Requires ``ETHOSN_NPU_DRIVER`` and
606 ``TRUSTED_BOARD_BOOT`` to be enabled.
607
608- ``ETHOSN_NPU_FW``: location of the NPU firmware binary
609 (```ethosn.bin```). This firmware image will be included in the FIP and
610 loaded at runtime.
611
Paul Beesley43f35ef2019-05-29 13:59:40 +0100612- ``EL3_EXCEPTION_HANDLING``: When set to ``1``, enable handling of exceptions
613 targeted at EL3. When set ``0`` (default), no exceptions are expected or
Raghu Krishnamurthy7c2fe622022-07-25 14:44:33 -0700614 handled at EL3, and a panic will result. The exception to this rule is when
615 ``SPMD_SPM_AT_SEL2`` is set to ``1``, in which case, only exceptions
616 occuring during normal world execution, are trapped to EL3. Any exception
617 trapped during secure world execution are trapped to the SPMC. This is
618 supported only for AArch64 builds.
Paul Beesley43f35ef2019-05-29 13:59:40 +0100619
Javier Almansa Sobrino6ac269d2020-09-18 16:47:07 +0100620- ``EVENT_LOG_LEVEL``: Chooses the log level to use for Measured Boot when
621 ``MEASURED_BOOT`` is enabled. For a list of valid values, see ``LOG_LEVEL``.
622 Default value is 40 (LOG_LEVEL_INFO).
623
Paul Beesley43f35ef2019-05-29 13:59:40 +0100624- ``FAULT_INJECTION_SUPPORT``: ARMv8.4 extensions introduced support for fault
625 injection from lower ELs, and this build option enables lower ELs to use
626 Error Records accessed via System Registers to inject faults. This is
627 applicable only to AArch64 builds.
628
629 This feature is intended for testing purposes only, and is advisable to keep
630 disabled for production images.
631
632- ``FIP_NAME``: This is an optional build option which specifies the FIP
633 filename for the ``fip`` target. Default is ``fip.bin``.
634
635- ``FWU_FIP_NAME``: This is an optional build option which specifies the FWU
636 FIP filename for the ``fwu_fip`` target. Default is ``fwu_fip.bin``.
637
Sumit Gargf97062a2019-11-15 18:47:53 +0530638- ``FW_ENC_STATUS``: Top level firmware's encryption numeric flag, values:
639
640 ::
641
642 0: Encryption is done with Secret Symmetric Key (SSK) which is common
643 for a class of devices.
644 1: Encryption is done with Binding Secret Symmetric Key (BSSK) which is
645 unique per device.
646
Manish Pandey700e7682021-10-21 21:53:49 +0100647 This flag depends on ``DECRYPTION_SUPPORT`` build flag.
Sumit Gargf97062a2019-11-15 18:47:53 +0530648
Paul Beesley43f35ef2019-05-29 13:59:40 +0100649- ``GENERATE_COT``: Boolean flag used to build and execute the ``cert_create``
650 tool to create certificates as per the Chain of Trust described in
651 :ref:`Trusted Board Boot`. The build system then calls ``fiptool`` to
652 include the certificates in the FIP and FWU_FIP. Default value is '0'.
653
654 Specify both ``TRUSTED_BOARD_BOOT=1`` and ``GENERATE_COT=1`` to include support
655 for the Trusted Board Boot feature in the BL1 and BL2 images, to generate
656 the corresponding certificates, and to include those certificates in the
657 FIP and FWU_FIP.
658
659 Note that if ``TRUSTED_BOARD_BOOT=0`` and ``GENERATE_COT=1``, the BL1 and BL2
660 images will not include support for Trusted Board Boot. The FIP will still
661 include the corresponding certificates. This FIP can be used to verify the
662 Chain of Trust on the host machine through other mechanisms.
663
664 Note that if ``TRUSTED_BOARD_BOOT=1`` and ``GENERATE_COT=0``, the BL1 and BL2
665 images will include support for Trusted Board Boot, but the FIP and FWU_FIP
666 will not include the corresponding certificates, causing a boot failure.
667
668- ``GICV2_G0_FOR_EL3``: Unlike GICv3, the GICv2 architecture doesn't have
669 inherent support for specific EL3 type interrupts. Setting this build option
670 to ``1`` assumes GICv2 *Group 0* interrupts are expected to target EL3, both
Madhukar Pappireddy6844c342020-07-29 09:37:25 -0500671 by :ref:`platform abstraction layer<platform Interrupt Controller API>` and
672 :ref:`Interrupt Management Framework<Interrupt Management Framework>`.
Paul Beesley43f35ef2019-05-29 13:59:40 +0100673 This allows GICv2 platforms to enable features requiring EL3 interrupt type.
674 This also means that all GICv2 Group 0 interrupts are delivered to EL3, and
675 the Secure Payload interrupts needs to be synchronously handed over to Secure
676 EL1 for handling. The default value of this option is ``0``, which means the
677 Group 0 interrupts are assumed to be handled by Secure EL1.
678
Manish Pandey46cc41d2022-10-10 11:43:08 +0100679- ``HANDLE_EA_EL3_FIRST_NS``: When set to ``1``, External Aborts and SError
680 Interrupts, resulting from errors in NS world, will be always trapped in
681 EL3 i.e. in BL31 at runtime. When set to ``0`` (default), these exceptions
682 will be trapped in the current exception level (or in EL1 if the current
683 exception level is EL0).
Paul Beesley43f35ef2019-05-29 13:59:40 +0100684
685- ``HW_ASSISTED_COHERENCY``: On most Arm systems to-date, platform-specific
686 software operations are required for CPUs to enter and exit coherency.
687 However, newer systems exist where CPUs' entry to and exit from coherency
688 is managed in hardware. Such systems require software to only initiate these
689 operations, and the rest is managed in hardware, minimizing active software
690 management. In such systems, this boolean option enables TF-A to carry out
691 build and run-time optimizations during boot and power management operations.
692 This option defaults to 0 and if it is enabled, then it implies
693 ``WARMBOOT_ENABLE_DCACHE_EARLY`` is also enabled.
694
695 If this flag is disabled while the platform which TF-A is compiled for
696 includes cores that manage coherency in hardware, then a compilation error is
697 generated. This is based on the fact that a system cannot have, at the same
698 time, cores that manage coherency in hardware and cores that don't. In other
699 words, a platform cannot have, at the same time, cores that require
700 ``HW_ASSISTED_COHERENCY=1`` and cores that require
701 ``HW_ASSISTED_COHERENCY=0``.
702
703 Note that, when ``HW_ASSISTED_COHERENCY`` is enabled, version 2 of
704 translation library (xlat tables v2) must be used; version 1 of translation
705 library is not supported.
706
Varun Wadekar0ed3be62023-04-13 21:06:18 +0100707- ``IMPDEF_SYSREG_TRAP``: Numeric value to enable the handling traps for
708 implementation defined system register accesses from lower ELs. Default
709 value is ``0``.
710
Louis Mayencourtb890b362020-02-13 08:21:34 +0000711- ``INVERTED_MEMMAP``: memmap tool print by default lower addresses at the
David Horstmann47147012021-01-21 12:29:59 +0000712 bottom, higher addresses at the top. This build flag can be set to '1' to
Louis Mayencourtb890b362020-02-13 08:21:34 +0000713 invert this behavior. Lower addresses will be printed at the top and higher
714 addresses at the bottom.
715
Paul Beesley43f35ef2019-05-29 13:59:40 +0100716- ``KEY_ALG``: This build flag enables the user to select the algorithm to be
717 used for generating the PKCS keys and subsequent signing of the certificate.
Lionel Debievee78ba692022-11-14 11:03:42 +0100718 It accepts 5 values: ``rsa``, ``rsa_1_5``, ``ecdsa``, ``ecdsa-brainpool-regular``
719 and ``ecdsa-brainpool-twisted``. The option ``rsa_1_5`` is the legacy PKCS#1
720 RSA 1.5 algorithm which is not TBBR compliant and is retained only for
721 compatibility. The default value of this flag is ``rsa`` which is the TBBR
722 compliant PKCS#1 RSA 2.1 scheme.
Paul Beesley43f35ef2019-05-29 13:59:40 +0100723
Gilad Ben-Yossefb8622922019-09-15 13:29:29 +0300724- ``KEY_SIZE``: This build flag enables the user to select the key size for
725 the algorithm specified by ``KEY_ALG``. The valid values for ``KEY_SIZE``
726 depend on the chosen algorithm and the cryptographic module.
727
Lionel Debievee78ba692022-11-14 11:03:42 +0100728 +---------------------------+------------------------------------+
729 | KEY_ALG | Possible key sizes |
730 +===========================+====================================+
Sandrine Bailleuxb65dfe42023-10-26 15:14:42 +0200731 | rsa | 1024 , 2048 (default), 3072, 4096 |
Lionel Debievee78ba692022-11-14 11:03:42 +0100732 +---------------------------+------------------------------------+
laurenw-arm6adeeb42023-10-03 15:36:25 -0500733 | ecdsa | 256 (default), 384 |
Lionel Debievee78ba692022-11-14 11:03:42 +0100734 +---------------------------+------------------------------------+
735 | ecdsa-brainpool-regular | unavailable |
736 +---------------------------+------------------------------------+
737 | ecdsa-brainpool-twisted | unavailable |
738 +---------------------------+------------------------------------+
739
Paul Beesley43f35ef2019-05-29 13:59:40 +0100740- ``HASH_ALG``: This build flag enables the user to select the secure hash
741 algorithm. It accepts 3 values: ``sha256``, ``sha384`` and ``sha512``.
742 The default value of this flag is ``sha256``.
743
744- ``LDFLAGS``: Extra user options appended to the linkers' command line in
745 addition to the one set by the build system.
746
747- ``LOG_LEVEL``: Chooses the log level, which controls the amount of console log
748 output compiled into the build. This should be one of the following:
749
750 ::
751
752 0 (LOG_LEVEL_NONE)
753 10 (LOG_LEVEL_ERROR)
754 20 (LOG_LEVEL_NOTICE)
755 30 (LOG_LEVEL_WARNING)
756 40 (LOG_LEVEL_INFO)
757 50 (LOG_LEVEL_VERBOSE)
758
759 All log output up to and including the selected log level is compiled into
760 the build. The default value is 40 in debug builds and 20 in release builds.
761
Alexei Fedorov8c105292020-01-23 14:27:38 +0000762- ``MEASURED_BOOT``: Boolean flag to include support for the Measured Boot
Manish V Badarkhe0aa0b3a2021-12-16 10:41:47 +0000763 feature. This flag can be enabled with ``TRUSTED_BOARD_BOOT`` in order to
764 provide trust that the code taking the measurements and recording them has
765 not been tampered with.
Sandrine Bailleuxcc255b92021-06-10 11:18:04 +0200766
Manish Pandey700e7682021-10-21 21:53:49 +0100767 This option defaults to 0.
Alexei Fedorov8c105292020-01-23 14:27:38 +0000768
Govindraj Raja019311e2023-07-18 13:55:33 -0500769- ``MARCH_DIRECTIVE``: used to pass a -march option from the platform build
770 options to the compiler. An example usage:
771
772 .. code:: make
773
774 MARCH_DIRECTIVE := -march=armv8.5-a
775
Bipin Ravi538516f2023-09-28 13:17:24 -0500776- ``HARDEN_SLS``: used to pass -mharden-sls=all from the TF-A build
777 options to the compiler currently supporting only of the options.
778 GCC documentation:
779 https://gcc.gnu.org/onlinedocs/gcc/AArch64-Options.html#index-mharden-sls
780
781 An example usage:
782
783 .. code:: make
784
785 HARDEN_SLS := 1
786
787 This option defaults to 0.
788
Paul Beesley43f35ef2019-05-29 13:59:40 +0100789- ``NON_TRUSTED_WORLD_KEY``: This option is used when ``GENERATE_COT=1``. It
Robin van der Gracht616b3ce2023-09-12 11:16:23 +0200790 specifies a file that contains the Non-Trusted World private key in PEM
791 format or a PKCS11 URI. If ``SAVE_KEYS=1``, only a file is accepted and it
792 will be used to save the key.
Paul Beesley43f35ef2019-05-29 13:59:40 +0100793
794- ``NS_BL2U``: Path to NS_BL2U image in the host file system. This image is
795 optional. It is only needed if the platform makefile specifies that it
796 is required in order to build the ``fwu_fip`` target.
797
798- ``NS_TIMER_SWITCH``: Enable save and restore for non-secure timer register
799 contents upon world switch. It can take either 0 (don't save and restore) or
800 1 (do save and restore). 0 is the default. An SPD may set this to 1 if it
801 wants the timer registers to be saved and restored.
802
803- ``OVERRIDE_LIBC``: This option allows platforms to override the default libc
804 for the BL image. It can be either 0 (include) or 1 (remove). The default
805 value is 0.
806
807- ``PL011_GENERIC_UART``: Boolean option to indicate the PL011 driver that
808 the underlying hardware is not a full PL011 UART but a minimally compliant
809 generic UART, which is a subset of the PL011. The driver will not access
810 any register that is not part of the SBSA generic UART specification.
811 Default value is 0 (a full PL011 compliant UART is present).
812
813- ``PLAT``: Choose a platform to build TF-A for. The chosen platform name
814 must be subdirectory of any depth under ``plat/``, and must contain a
815 platform makefile named ``platform.mk``. For example, to build TF-A for the
816 Arm Juno board, select PLAT=juno.
817
Juan Pablo Condebfef8b92023-11-08 16:14:28 -0600818- ``PLATFORM_REPORT_CTX_MEM_USE``: Reports the context memory allocated for
819 each core as well as the global context. The data includes the memory used
820 by each world and each privileged exception level. This build option is
821 applicable only for ``ARCH=aarch64`` builds. The default value is 0.
822
Paul Beesley43f35ef2019-05-29 13:59:40 +0100823- ``PRELOADED_BL33_BASE``: This option enables booting a preloaded BL33 image
824 instead of the normal boot flow. When defined, it must specify the entry
825 point address for the preloaded BL33 image. This option is incompatible with
826 ``EL3_PAYLOAD_BASE``. If both are defined, ``EL3_PAYLOAD_BASE`` has priority
827 over ``PRELOADED_BL33_BASE``.
828
Arvind Ram Prakashf99a69c2023-12-21 00:25:52 -0600829- ``PRESERVE_DSU_PMU_REGS``: This options when enabled allows the platform to
830 save/restore the DynamIQ Shared Unit's(DSU) Performance Monitoring Unit(PMU)
831 registers when the cluster goes through a power cycle. This is disabled by
832 default and platforms that require this feature have to enable them.
833
Paul Beesley43f35ef2019-05-29 13:59:40 +0100834- ``PROGRAMMABLE_RESET_ADDRESS``: This option indicates whether the reset
835 vector address can be programmed or is fixed on the platform. It can take
836 either 0 (fixed) or 1 (programmable). Default is 0. If the platform has a
837 programmable reset address, it is expected that a CPU will start executing
838 code directly at the right address, both on a cold and warm reset. In this
839 case, there is no need to identify the entrypoint on boot and the boot path
840 can be optimised. The ``plat_get_my_entrypoint()`` platform porting interface
841 does not need to be implemented in this case.
842
843- ``PSCI_EXTENDED_STATE_ID``: As per PSCI1.0 Specification, there are 2 formats
844 possible for the PSCI power-state parameter: original and extended State-ID
845 formats. This flag if set to 1, configures the generic PSCI layer to use the
846 extended format. The default value of this flag is 0, which means by default
847 the original power-state format is used by the PSCI implementation. This flag
848 should be specified by the platform makefile and it governs the return value
849 of PSCI_FEATURES API for CPU_SUSPEND smc function id. When this option is
850 enabled on Arm platforms, the option ``ARM_RECOM_STATE_ID_ENC`` needs to be
851 set to 1 as well.
852
Wing Li64b47102023-01-26 18:33:36 -0800853- ``PSCI_OS_INIT_MODE``: Boolean flag to enable support for optional PSCI
854 OS-initiated mode. This option defaults to 0.
855
Manish Pandeyf87e54f2023-10-10 15:42:19 +0100856- ``ENABLE_FEAT_RAS``: Boolean flag to enable Armv8.2 RAS features. RAS features
Paul Beesley43f35ef2019-05-29 13:59:40 +0100857 are an optional extension for pre-Armv8.2 CPUs, but are mandatory for Armv8.2
Manish Pandey970a4a82023-10-10 13:53:25 +0100858 or later CPUs. This flag can take the values 0 or 1. The default value is 0.
859 NOTE: This flag enables use of IESB capability to reduce entry latency into
860 EL3 even when RAS error handling is not performed on the platform. Hence this
861 flag is recommended to be turned on Armv8.2 and later CPUs.
Paul Beesley43f35ef2019-05-29 13:59:40 +0100862
Paul Beesley43f35ef2019-05-29 13:59:40 +0100863- ``RESET_TO_BL31``: Enable BL31 entrypoint as the CPU reset vector instead
864 of the BL1 entrypoint. It can take the value 0 (CPU reset to BL1
865 entrypoint) or 1 (CPU reset to BL31 entrypoint).
866 The default value is 0.
867
868- ``RESET_TO_SP_MIN``: SP_MIN is the minimal AArch32 Secure Payload provided
869 in TF-A. This flag configures SP_MIN entrypoint as the CPU reset vector
870 instead of the BL1 entrypoint. It can take the value 0 (CPU reset to BL1
871 entrypoint) or 1 (CPU reset to SP_MIN entrypoint). The default value is 0.
872
AlexeiFedorovd7660842024-05-13 15:35:54 +0100873- ``RME_GPT_BITLOCK_BLOCK``: This defines the block size (in number of 512MB
874- blocks) covered by a single bit of the bitlock structure during RME GPT
875- operations. The lower the block size, the better opportunity for
876- parallelising GPT operations but at the cost of more bits being needed
877- for the bitlock structure. This numeric parameter can take the values
878- from 0 to 512 and must be a power of 2. The value of 0 is special and
879- and it chooses a single spinlock for all GPT L1 table entries. Default
880- value is 1 which corresponds to block size of 512MB per bit of bitlock
881- structure.
882
883- ``RME_GPT_MAX_BLOCK``: Numeric value in MB to define the maximum size of
AlexeiFedorovec0088b2024-03-13 17:07:03 +0000884 supported contiguous blocks in GPT Library. This parameter can take the
885 values 0, 2, 32 and 512. Setting this value to 0 disables use of Contigious
Soby Mathew01faa992024-08-22 11:53:09 +0100886 descriptors. Default value is 512.
AlexeiFedorovec0088b2024-03-13 17:07:03 +0000887
Robin van der Gracht616b3ce2023-09-12 11:16:23 +0200888- ``ROT_KEY``: This option is used when ``GENERATE_COT=1``. It specifies a
889 file that contains the ROT private key in PEM format or a PKCS11 URI and
890 enforces public key hash generation. If ``SAVE_KEYS=1``, only a file is
891 accepted and it will be used to save the key.
Paul Beesley43f35ef2019-05-29 13:59:40 +0100892
893- ``SAVE_KEYS``: This option is used when ``GENERATE_COT=1``. It tells the
894 certificate generation tool to save the keys used to establish the Chain of
895 Trust. Allowed options are '0' or '1'. Default is '0' (do not save).
896
897- ``SCP_BL2``: Path to SCP_BL2 image in the host file system. This image is optional.
898 If a SCP_BL2 image is present then this option must be passed for the ``fip``
899 target.
900
Robin van der Gracht616b3ce2023-09-12 11:16:23 +0200901- ``SCP_BL2_KEY``: This option is used when ``GENERATE_COT=1``. It specifies a
902 file that contains the SCP_BL2 private key in PEM format or a PKCS11 URI.
903 If ``SAVE_KEYS=1``, only a file is accepted and it will be used to save the key.
Paul Beesley43f35ef2019-05-29 13:59:40 +0100904
905- ``SCP_BL2U``: Path to SCP_BL2U image in the host file system. This image is
906 optional. It is only needed if the platform makefile specifies that it
907 is required in order to build the ``fwu_fip`` target.
908
909- ``SDEI_SUPPORT``: Setting this to ``1`` enables support for Software
910 Delegated Exception Interface to BL31 image. This defaults to ``0``.
911
912 When set to ``1``, the build option ``EL3_EXCEPTION_HANDLING`` must also be
913 set to ``1``.
914
915- ``SEPARATE_CODE_AND_RODATA``: Whether code and read-only data should be
916 isolated on separate memory pages. This is a trade-off between security and
917 memory usage. See "Isolating code and read-only data on separate memory
Olivier Deprez4c65b4d2020-03-26 16:09:21 +0100918 pages" section in :ref:`Firmware Design`. This flag is disabled by default
919 and affects all BL images.
Paul Beesley43f35ef2019-05-29 13:59:40 +0100920
Samuel Hollandf8578e62018-10-17 21:40:18 -0500921- ``SEPARATE_NOBITS_REGION``: Setting this option to ``1`` allows the NOBITS
922 sections of BL31 (.bss, stacks, page tables, and coherent memory) to be
923 allocated in RAM discontiguous from the loaded firmware image. When set, the
David Horstmann47147012021-01-21 12:29:59 +0000924 platform is expected to provide definitions for ``BL31_NOBITS_BASE`` and
Samuel Hollandf8578e62018-10-17 21:40:18 -0500925 ``BL31_NOBITS_LIMIT``. When the option is ``0`` (the default), NOBITS
926 sections are placed in RAM immediately following the loaded firmware image.
927
Jiafei Pan96a8ed12022-02-24 10:47:33 +0800928- ``SEPARATE_BL2_NOLOAD_REGION``: Setting this option to ``1`` allows the
929 NOLOAD sections of BL2 (.bss, stacks, page tables) to be allocated in RAM
930 discontiguous from loaded firmware images. When set, the platform need to
931 provide definitions of ``BL2_NOLOAD_START`` and ``BL2_NOLOAD_LIMIT``. This
932 flag is disabled by default and NOLOAD sections are placed in RAM immediately
933 following the loaded firmware image.
934
Madhukar Pappireddy50fba2d2024-07-05 12:44:08 -0500935- ``SEPARATE_SIMD_SECTION``: Setting this option to ``1`` allows the SIMD context
936 data structures to be put in a dedicated memory region as decided by platform
937 integrator. Default value is ``0`` which means the SIMD context is put in BSS
938 section of EL3 firmware.
939
Jeremy Linton2d31cb02021-01-26 22:42:03 -0600940- ``SMC_PCI_SUPPORT``: This option allows platforms to handle PCI configuration
941 access requests via a standard SMCCC defined in `DEN0115`_. When combined with
942 UEFI+ACPI this can provide a certain amount of OS forward compatibility
943 with newer platforms that aren't ECAM compliant.
944
Paul Beesley43f35ef2019-05-29 13:59:40 +0100945- ``SPD``: Choose a Secure Payload Dispatcher component to be built into TF-A.
946 This build option is only valid if ``ARCH=aarch64``. The value should be
947 the path to the directory containing the SPD source, relative to
948 ``services/spd/``; the directory is expected to contain a makefile called
Olivier Deprez4c65b4d2020-03-26 16:09:21 +0100949 ``<spd-value>.mk``. The SPM Dispatcher standard service is located in
950 services/std_svc/spmd and enabled by ``SPD=spmd``. The SPM Dispatcher
951 cannot be enabled when the ``SPM_MM`` option is enabled.
Paul Beesley43f35ef2019-05-29 13:59:40 +0100952
953- ``SPIN_ON_BL1_EXIT``: This option introduces an infinite loop in BL1. It can
954 take either 0 (no loop) or 1 (add a loop). 0 is the default. This loop stops
955 execution in BL1 just before handing over to BL31. At this point, all
956 firmware images have been loaded in memory, and the MMU and caches are
957 turned off. Refer to the "Debugging options" section for more details.
958
Marc Bonnici1d63ae42021-12-01 18:00:40 +0000959- ``SPMC_AT_EL3`` : This boolean option is used jointly with the SPM
960 Dispatcher option (``SPD=spmd``). When enabled (1) it indicates the SPMC
961 component runs at the EL3 exception level. The default value is ``0`` (
962 disabled). This configuration supports pre-Armv8.4 platforms (aka not
Olivier Deprez48856002023-11-03 11:49:47 +0100963 implementing the ``FEAT_SEL2`` extension).
Marc Bonnici1d63ae42021-12-01 18:00:40 +0000964
Nishant Sharma801cd3c2023-06-27 00:36:01 +0100965- ``SPMC_AT_EL3_SEL0_SP`` : Boolean option to enable SEL0 SP load support when
966 ``SPMC_AT_EL3`` is enabled. The default value if ``0`` (disabled). This
967 option cannot be enabled (``1``) when (``SPMC_AT_EL3``) is disabled.
968
Jens Wiklanderbb0e3362022-12-14 17:02:16 +0100969- ``SPMC_OPTEE`` : This boolean option is used jointly with the SPM
970 Dispatcher option (``SPD=spmd``) and with ``SPMD_SPM_AT_SEL2=0`` to
971 indicate that the SPMC at S-EL1 is OP-TEE and an OP-TEE specific loading
972 mechanism should be used.
973
Jayanth Dodderi Chidanandd9e984c2022-02-28 23:41:41 +0000974- ``SPMD_SPM_AT_SEL2`` : This boolean option is used jointly with the SPM
Olivier Deprez4c65b4d2020-03-26 16:09:21 +0100975 Dispatcher option (``SPD=spmd``). When enabled (1) it indicates the SPMC
Marc Bonnici1d63ae42021-12-01 18:00:40 +0000976 component runs at the S-EL2 exception level provided by the ``FEAT_SEL2``
Olivier Deprez4c65b4d2020-03-26 16:09:21 +0100977 extension. This is the default when enabling the SPM Dispatcher. When
978 disabled (0) it indicates the SPMC component runs at the S-EL1 execution
Marc Bonnici1d63ae42021-12-01 18:00:40 +0000979 state or at EL3 if ``SPMC_AT_EL3`` is enabled. The latter configurations
980 support pre-Armv8.4 platforms (aka not implementing the ``FEAT_SEL2``
981 extension).
Olivier Deprez4c65b4d2020-03-26 16:09:21 +0100982
Paul Beesley3f3c3412019-09-16 11:29:03 +0000983- ``SPM_MM`` : Boolean option to enable the Management Mode (MM)-based Secure
Olivier Deprez4c65b4d2020-03-26 16:09:21 +0100984 Partition Manager (SPM) implementation. The default value is ``0``
985 (disabled). This option cannot be enabled (``1``) when SPM Dispatcher is
986 enabled (``SPD=spmd``).
Paul Beesley3f3c3412019-09-16 11:29:03 +0000987
Manish Pandeyce2b1ec2020-01-14 11:52:05 +0000988- ``SP_LAYOUT_FILE``: Platform provided path to JSON file containing the
Olivier Deprez4c65b4d2020-03-26 16:09:21 +0100989 description of secure partitions. The build system will parse this file and
990 package all secure partition blobs into the FIP. This file is not
991 necessarily part of TF-A tree. Only available when ``SPD=spmd``.
Manish Pandeyce2b1ec2020-01-14 11:52:05 +0000992
Paul Beesley43f35ef2019-05-29 13:59:40 +0100993- ``SP_MIN_WITH_SECURE_FIQ``: Boolean flag to indicate the SP_MIN handles
994 secure interrupts (caught through the FIQ line). Platforms can enable
995 this directive if they need to handle such interruption. When enabled,
996 the FIQ are handled in monitor mode and non secure world is not allowed
997 to mask these events. Platforms that enable FIQ handling in SP_MIN shall
998 implement the api ``sp_min_plat_fiq_handler()``. The default value is 0.
999
Mark Brownbebcf272022-04-20 18:14:32 +01001000- ``SVE_VECTOR_LEN``: SVE vector length to configure in ZCR_EL3.
1001 Platforms can configure this if they need to lower the hardware
1002 limit, for example due to asymmetric configuration or limitations of
1003 software run at lower ELs. The default is the architectural maximum
1004 of 2048 which should be suitable for most configurations, the
1005 hardware will limit the effective VL to the maximum physically supported
1006 VL.
1007
Jayanth Dodderi Chidanand0b22e592022-10-11 17:16:07 +01001008- ``TRNG_SUPPORT``: Setting this to ``1`` enables support for True
1009 Random Number Generator Interface to BL31 image. This defaults to ``0``.
1010
Paul Beesley43f35ef2019-05-29 13:59:40 +01001011- ``TRUSTED_BOARD_BOOT``: Boolean flag to include support for the Trusted Board
1012 Boot feature. When set to '1', BL1 and BL2 images include support to load
1013 and verify the certificates and images in a FIP, and BL1 includes support
1014 for the Firmware Update. The default value is '0'. Generation and inclusion
1015 of certificates in the FIP and FWU_FIP depends upon the value of the
1016 ``GENERATE_COT`` option.
1017
1018 .. warning::
1019 This option depends on ``CREATE_KEYS`` to be enabled. If the keys
1020 already exist in disk, they will be overwritten without further notice.
1021
1022- ``TRUSTED_WORLD_KEY``: This option is used when ``GENERATE_COT=1``. It
Robin van der Gracht616b3ce2023-09-12 11:16:23 +02001023 specifies a file that contains the Trusted World private key in PEM
1024 format or a PKCS11 URI. If ``SAVE_KEYS=1``, only a file is accepted and
1025 it will be used to save the key.
Paul Beesley43f35ef2019-05-29 13:59:40 +01001026
1027- ``TSP_INIT_ASYNC``: Choose BL32 initialization method as asynchronous or
1028 synchronous, (see "Initializing a BL32 Image" section in
1029 :ref:`Firmware Design`). It can take the value 0 (BL32 is initialized using
1030 synchronous method) or 1 (BL32 is initialized using asynchronous method).
1031 Default is 0.
1032
1033- ``TSP_NS_INTR_ASYNC_PREEMPT``: A non zero value enables the interrupt
1034 routing model which routes non-secure interrupts asynchronously from TSP
1035 to EL3 causing immediate preemption of TSP. The EL3 is responsible
1036 for saving and restoring the TSP context in this routing model. The
1037 default routing model (when the value is 0) is to route non-secure
1038 interrupts to TSP allowing it to save its context and hand over
1039 synchronously to EL3 via an SMC.
1040
1041 .. note::
1042 When ``EL3_EXCEPTION_HANDLING`` is ``1``, ``TSP_NS_INTR_ASYNC_PREEMPT``
1043 must also be set to ``1``.
1044
Manish V Badarkheacd03f42023-06-27 11:40:21 +01001045- ``TS_SP_FW_CONFIG``: DTC build flag to include Trusted Services (Crypto and
1046 internal-trusted-storage) as SP in tb_fw_config device tree.
1047
Jayanth Dodderi Chidanand781d07a2022-03-28 15:28:55 +01001048- ``TWED_DELAY``: Numeric value to be set in order to delay the trapping of
1049 WFE instruction. ``ENABLE_FEAT_TWED`` build option must be enabled to set
1050 this delay. It can take values in the range (0-15). Default value is ``0``
1051 and based on this value, 2^(TWED_DELAY + 8) cycles will be delayed.
1052 Platforms need to explicitly update this value based on their requirements.
1053
Paul Beesley43f35ef2019-05-29 13:59:40 +01001054- ``USE_ARM_LINK``: This flag determines whether to enable support for ARM
1055 linker. When the ``LINKER`` build variable points to the armlink linker,
1056 this flag is enabled automatically. To enable support for armlink, platforms
1057 will have to provide a scatter file for the BL image. Currently, Tegra
1058 platforms use the armlink support to compile BL3-1 images.
1059
1060- ``USE_COHERENT_MEM``: This flag determines whether to include the coherent
1061 memory region in the BL memory map or not (see "Use of Coherent memory in
1062 TF-A" section in :ref:`Firmware Design`). It can take the value 1
1063 (Coherent memory region is included) or 0 (Coherent memory region is
1064 excluded). Default is 1.
1065
Louis Mayencourta6de8242020-02-28 16:57:30 +00001066- ``ARM_IO_IN_DTB``: This flag determines whether to use IO based on the
1067 firmware configuration framework. This will move the io_policies into a
Louis Mayencourt0a6e7e32019-10-24 15:18:46 +01001068 configuration device tree, instead of static structure in the code base.
1069
Manish V Badarkhe84ef9cd2020-06-29 10:32:53 +01001070- ``COT_DESC_IN_DTB``: This flag determines whether to create COT descriptors
1071 at runtime using fconf. If this flag is enabled, COT descriptors are
1072 statically captured in tb_fw_config file in the form of device tree nodes
1073 and properties. Currently, COT descriptors used by BL2 are moved to the
1074 device tree and COT descriptors used by BL1 are retained in the code
Manish Pandey700e7682021-10-21 21:53:49 +01001075 base statically.
Manish V Badarkhe84ef9cd2020-06-29 10:32:53 +01001076
Balint Dobszaycbf9e842019-12-18 15:28:00 +01001077- ``SDEI_IN_FCONF``: This flag determines whether to configure SDEI setup in
1078 runtime using firmware configuration framework. The platform specific SDEI
1079 shared and private events configuration is retrieved from device tree rather
Manish Pandey700e7682021-10-21 21:53:49 +01001080 than static C structures at compile time. This is only supported if
1081 SDEI_SUPPORT build flag is enabled.
Louis Mayencourt0a6e7e32019-10-24 15:18:46 +01001082
Madhukar Pappireddy452d5e52020-06-02 09:26:30 -05001083- ``SEC_INT_DESC_IN_FCONF``: This flag determines whether to configure Group 0
1084 and Group1 secure interrupts using the firmware configuration framework. The
1085 platform specific secure interrupt property descriptor is retrieved from
1086 device tree in runtime rather than depending on static C structure at compile
Manish Pandey700e7682021-10-21 21:53:49 +01001087 time.
Madhukar Pappireddy452d5e52020-06-02 09:26:30 -05001088
Paul Beesley43f35ef2019-05-29 13:59:40 +01001089- ``USE_ROMLIB``: This flag determines whether library at ROM will be used.
1090 This feature creates a library of functions to be placed in ROM and thus
1091 reduces SRAM usage. Refer to :ref:`Library at ROM` for further details. Default
1092 is 0.
1093
1094- ``V``: Verbose build. If assigned anything other than 0, the build commands
1095 are printed. Default is 0.
1096
1097- ``VERSION_STRING``: String used in the log output for each TF-A image.
1098 Defaults to a string formed by concatenating the version number, build type
1099 and build string.
1100
1101- ``W``: Warning level. Some compiler warning options of interest have been
1102 regrouped and put in the root Makefile. This flag can take the values 0 to 3,
1103 each level enabling more warning options. Default is 0.
1104
Boyan Karatotev291be192022-12-07 10:26:48 +00001105 This option is closely related to the ``E`` option, which enables
1106 ``-Werror``.
1107
1108 - ``W=0`` (default)
1109
1110 Enables a wide assortment of warnings, most notably ``-Wall`` and
1111 ``-Wextra``, as well as various bad practices and things that are likely to
1112 result in errors. Includes some compiler specific flags. No warnings are
1113 expected at this level for any build.
1114
1115 - ``W=1``
1116
1117 Enables warnings we want the generic build to include but are too time
1118 consuming to fix at the moment. It re-enables warnings taken out for
1119 ``W=0`` builds (a few of the ``-Wextra`` additions). This level is expected
1120 to eventually be merged into ``W=0``. Some warnings are expected on some
1121 builds, but new contributions should not introduce new ones.
1122
1123 - ``W=2`` (recommended)
1124
1125 Enables warnings we want the generic build to include but cannot be enabled
1126 due to external libraries. This level is expected to eventually be merged
1127 into ``W=0``. Lots of warnings are expected, primarily from external
1128 libraries like zlib and compiler-rt, but new controbutions should not
1129 introduce new ones.
1130
1131 - ``W=3``
1132
1133 Enables warnings that are informative but not necessary and generally too
1134 verbose and frequently ignored. A very large number of warnings are
1135 expected.
1136
1137 The exact set of warning flags depends on the compiler and TF-A warning
1138 level, however they are all succinctly set in the top-level Makefile. Please
1139 refer to the `GCC`_ or `Clang`_ documentation for more information on the
1140 individual flags.
1141
Paul Beesley43f35ef2019-05-29 13:59:40 +01001142- ``WARMBOOT_ENABLE_DCACHE_EARLY`` : Boolean option to enable D-cache early on
1143 the CPU after warm boot. This is applicable for platforms which do not
1144 require interconnect programming to enable cache coherency (eg: single
1145 cluster platforms). If this option is enabled, then warm boot path
1146 enables D-caches immediately after enabling MMU. This option defaults to 0.
1147
Manish V Badarkhe7ff088d2020-03-22 05:06:38 +00001148- ``SUPPORT_STACK_MEMTAG``: This flag determines whether to enable memory
1149 tagging for stack or not. It accepts 2 values: ``yes`` and ``no``. The
1150 default value of this flag is ``no``. Note this option must be enabled only
1151 for ARM architecture greater than Armv8.5-A.
1152
Manish V Badarkhee008a292020-07-31 08:38:49 +01001153- ``ERRATA_SPECULATIVE_AT``: This flag determines whether to enable ``AT``
1154 speculative errata workaround or not. It accepts 2 values: ``1`` and ``0``.
1155 The default value of this flag is ``0``.
1156
1157 ``AT`` speculative errata workaround disables stage1 page table walk for
1158 lower ELs (EL1 and EL0) in EL3 so that ``AT`` speculative fetch at any point
1159 produces either the correct result or failure without TLB allocation.
Manish V Badarkhe45aecff2020-04-28 04:53:32 +01001160
1161 This boolean option enables errata for all below CPUs.
1162
Manish V Badarkhee008a292020-07-31 08:38:49 +01001163 +---------+--------------+-------------------------+
1164 | Errata | CPU | Workaround Define |
1165 +=========+==============+=========================+
1166 | 1165522 | Cortex-A76 | ``ERRATA_A76_1165522`` |
1167 +---------+--------------+-------------------------+
1168 | 1319367 | Cortex-A72 | ``ERRATA_A72_1319367`` |
1169 +---------+--------------+-------------------------+
1170 | 1319537 | Cortex-A57 | ``ERRATA_A57_1319537`` |
1171 +---------+--------------+-------------------------+
1172 | 1530923 | Cortex-A55 | ``ERRATA_A55_1530923`` |
1173 +---------+--------------+-------------------------+
1174 | 1530924 | Cortex-A53 | ``ERRATA_A53_1530924`` |
1175 +---------+--------------+-------------------------+
1176
1177 .. note::
1178 This option is enabled by build only if platform sets any of above defines
1179 mentioned in ’Workaround Define' column in the table.
1180 If this option is enabled for the EL3 software then EL2 software also must
1181 implement this workaround due to the behaviour of the errata mentioned
1182 in new SDEN document which will get published soon.
Manish V Badarkhe45aecff2020-04-28 04:53:32 +01001183
Manish Pandey00e8f792022-09-27 14:30:34 +01001184- ``RAS_TRAP_NS_ERR_REC_ACCESS``: This flag enables/disables the SCR_EL3.TERR
Varun Wadekarfbc44bd2020-06-12 10:11:28 -07001185 bit, to trap access to the RAS ERR and RAS ERX registers from lower ELs.
1186 This flag is disabled by default.
1187
Juan Pablo Conde8caf10a2022-06-28 16:56:32 -04001188- ``OPENSSL_DIR``: This option is used to provide the path to a directory on the
1189 host machine where a custom installation of OpenSSL is located, which is used
1190 to build the certificate generation, firmware encryption and FIP tools. If
1191 this option is not set, the default OS installation will be used.
Manish V Badarkhe582e4e72020-07-29 10:58:44 +01001192
Madhukar Pappireddyfddfb3b2020-08-12 13:18:19 -05001193- ``USE_SP804_TIMER``: Use the SP804 timer instead of the Generic Timer for
1194 functions that wait for an arbitrary time length (udelay and mdelay). The
1195 default value is 0.
1196
Jayanth Dodderi Chidanand1298f2f2022-05-09 12:33:03 +01001197- ``ENABLE_BRBE_FOR_NS``: Numeric value to enable access to the branch record
1198 buffer registers from NS ELs when FEAT_BRBE is implemented. BRBE is an
1199 optional architectural feature for AArch64. This flag can take the values
Andre Przywara641571c2023-11-23 16:40:13 +00001200 0 to 2, to align with the ``ENABLE_FEAT`` mechanism. The default is 0
Jayanth Dodderi Chidanand1298f2f2022-05-09 12:33:03 +01001201 and it is automatically disabled when the target architecture is AArch32.
johpow01744ad972022-01-28 17:06:20 -06001202
Jayanth Dodderi Chidanand47c681b2022-05-19 14:08:28 +01001203- ``ENABLE_TRBE_FOR_NS``: Numeric value to enable access of trace buffer
Manish V Badarkhe813524e2021-07-02 09:10:56 +01001204 control registers from NS ELs, NS-EL2 or NS-EL1(when NS-EL2 is implemented
1205 but unused) when FEAT_TRBE is implemented. TRBE is an optional architectural
Jayanth Dodderi Chidanand47c681b2022-05-19 14:08:28 +01001206 feature for AArch64. This flag can take the values 0 to 2, to align with the
Andre Przywara641571c2023-11-23 16:40:13 +00001207 ``ENABLE_FEAT`` mechanism. The default is 0 and it is automatically
Jayanth Dodderi Chidanand47c681b2022-05-19 14:08:28 +01001208 disabled when the target architecture is AArch32.
Manish V Badarkhe813524e2021-07-02 09:10:56 +01001209
Andre Przywara603a0c62022-11-17 16:42:09 +00001210- ``ENABLE_SYS_REG_TRACE_FOR_NS``: Numeric value to enable trace system
Manish V Badarkhed4582d32021-06-29 11:44:20 +01001211 registers access from NS ELs, NS-EL2 or NS-EL1 (when NS-EL2 is implemented
1212 but unused). This feature is available if trace unit such as ETMv4.x, and
Andre Przywara603a0c62022-11-17 16:42:09 +00001213 ETE(extending ETM feature) is implemented. This flag can take the values
Andre Przywara641571c2023-11-23 16:40:13 +00001214 0 to 2, to align with the ``ENABLE_FEAT`` mechanism. The default is 0.
Manish V Badarkhed4582d32021-06-29 11:44:20 +01001215
Jayanth Dodderi Chidanandd9e984c2022-02-28 23:41:41 +00001216- ``ENABLE_TRF_FOR_NS``: Numeric value to enable trace filter control registers
Manish V Badarkhe8fcd3d92021-07-08 09:33:18 +01001217 access from NS ELs, NS-EL2 or NS-EL1 (when NS-EL2 is implemented but unused),
Jayanth Dodderi Chidanandd9e984c2022-02-28 23:41:41 +00001218 if FEAT_TRF is implemented. This flag can take the values 0 to 2, to align
Andre Przywara641571c2023-11-23 16:40:13 +00001219 with the ``ENABLE_FEAT`` mechanism. This flag is disabled by default.
Manish V Badarkhe8fcd3d92021-07-08 09:33:18 +01001220
Okash Khawaja04c73032022-11-04 12:38:01 +00001221- ``CONDITIONAL_CMO``: Boolean option to enable call to platform-defined routine
1222 ``plat_can_cmo`` which will return zero if cache management operations should
1223 be skipped and non-zero otherwise. By default, this option is disabled which
1224 means platform hook won't be checked and CMOs will always be performed when
1225 related functions are called.
1226
Sona Mathewe5d9b6f2023-03-15 09:40:36 -05001227- ``ERRATA_ABI_SUPPORT``: Boolean option to enable support for Errata management
1228 firmware interface for the BL31 image. By default its disabled (``0``).
1229
1230- ``ERRATA_NON_ARM_INTERCONNECT``: Boolean option to enable support for the
1231 errata mitigation for platforms with a non-arm interconnect using the errata
1232 ABI. By default its disabled (``0``).
1233
Sandrine Bailleux85bebe12023-10-11 08:38:00 +02001234- ``ENABLE_CONSOLE_GETC``: Boolean option to enable `getc()` feature in console
1235 driver(s). By default it is disabled (``0``) because it constitutes an attack
1236 vector into TF-A by potentially allowing an attacker to inject arbitrary data.
1237 This option should only be enabled on a need basis if there is a use case for
1238 reading characters from the console.
1239
Alexei Fedorova6ea06f2020-03-23 18:45:17 +00001240GICv3 driver options
1241--------------------
1242
1243GICv3 driver files are included using directive:
1244
1245``include drivers/arm/gic/v3/gicv3.mk``
1246
1247The driver can be configured with the following options set in the platform
1248makefile:
1249
Andre Przywarab4ad3652020-03-25 15:50:38 +00001250- ``GICV3_SUPPORT_GIC600``: Add support for the GIC-600 variants of GICv3.
1251 Enabling this option will add runtime detection support for the
1252 GIC-600, so is safe to select even for a GIC500 implementation.
1253 This option defaults to 0.
Alexei Fedorova6ea06f2020-03-23 18:45:17 +00001254
Varun Wadekar2c248ad2021-05-04 16:14:09 -07001255- ``GICV3_SUPPORT_GIC600AE_FMU``: Add support for the Fault Management Unit
1256 for GIC-600 AE. Enabling this option will introduce support to initialize
1257 the FMU. Platforms should call the init function during boot to enable the
1258 FMU and its safety mechanisms. This option defaults to 0.
1259
Alexei Fedorova6ea06f2020-03-23 18:45:17 +00001260- ``GICV3_IMPL_GIC600_MULTICHIP``: Selects GIC-600 variant with multichip
1261 functionality. This option defaults to 0
1262
1263- ``GICV3_OVERRIDE_DISTIF_PWR_OPS``: Allows override of default implementation
1264 of ``arm_gicv3_distif_pre_save`` and ``arm_gicv3_distif_post_restore``
1265 functions. This is required for FVP platform which need to simulate GIC save
1266 and restore during SYSTEM_SUSPEND without powering down GIC. Default is 0.
1267
Alexei Fedorov5875f262020-04-06 19:00:35 +01001268- ``GIC_ENABLE_V4_EXTN`` : Enables GICv4 related changes in GICv3 driver.
1269 This option defaults to 0.
1270
Alexei Fedorov8f3ad762020-04-06 16:27:54 +01001271- ``GIC_EXT_INTID``: When set to ``1``, GICv3 driver will support extended
1272 PPI (1056-1119) and SPI (4096-5119) range. This option defaults to 0.
1273
Paul Beesley43f35ef2019-05-29 13:59:40 +01001274Debugging options
1275-----------------
1276
1277To compile a debug version and make the build more verbose use
1278
1279.. code:: shell
1280
1281 make PLAT=<platform> DEBUG=1 V=1 all
1282
Daniel Boulby4466cf82022-05-03 16:46:16 +01001283AArch64 GCC 11 uses DWARF version 5 debugging symbols by default. Some tools
1284(for example Arm-DS) might not support this and may need an older version of
1285DWARF symbols to be emitted by GCC. This can be achieved by using the
1286``-gdwarf-<version>`` flag, with the version being set to 2, 3, 4 or 5. Setting
1287the version to 4 is recommended for Arm-DS.
Paul Beesley43f35ef2019-05-29 13:59:40 +01001288
1289When debugging logic problems it might also be useful to disable all compiler
1290optimizations by using ``-O0``.
1291
1292.. warning::
1293 Using ``-O0`` could cause output images to be larger and base addresses
1294 might need to be recalculated (see the **Memory layout on Arm development
1295 platforms** section in the :ref:`Firmware Design`).
1296
1297Extra debug options can be passed to the build system by setting ``CFLAGS`` or
1298``LDFLAGS``:
1299
1300.. code:: shell
1301
1302 CFLAGS='-O0 -gdwarf-2' \
1303 make PLAT=<platform> DEBUG=1 V=1 all
1304
1305Note that using ``-Wl,`` style compilation driver options in ``CFLAGS`` will be
1306ignored as the linker is called directly.
1307
1308It is also possible to introduce an infinite loop to help in debugging the
1309post-BL2 phase of TF-A. This can be done by rebuilding BL1 with the
1310``SPIN_ON_BL1_EXIT=1`` build flag. Refer to the :ref:`build_options_common`
1311section. In this case, the developer may take control of the target using a
Daniel Boulby4466cf82022-05-03 16:46:16 +01001312debugger when indicated by the console output. When using Arm-DS, the following
Paul Beesley43f35ef2019-05-29 13:59:40 +01001313commands can be used:
1314
1315::
1316
1317 # Stop target execution
1318 interrupt
1319
1320 #
1321 # Prepare your debugging environment, e.g. set breakpoints
1322 #
1323
1324 # Jump over the debug loop
1325 set var $AARCH64::$Core::$PC = $AARCH64::$Core::$PC + 4
1326
1327 # Resume execution
1328 continue
1329
Olivier Deprez48856002023-11-03 11:49:47 +01001330.. _build_options_experimental:
1331
1332Experimental build options
1333---------------------------
1334
1335Common build options
1336~~~~~~~~~~~~~~~~~~~~
1337
Manish V Badarkheb5ead352024-05-22 14:06:00 +01001338- ``DICE_PROTECTION_ENVIRONMENT``: Boolean flag to specify the measured boot
1339 backend when ``MEASURED_BOOT`` is enabled. The default value is ``0``. When
1340 set to ``1`` then measurements and additional metadata collected during the
1341 measured boot process are sent to the DICE Protection Environment for storage
1342 and processing. A certificate chain, which represents the boot state of the
1343 device, can be queried from the DPE.
1344
Olivier Deprez48856002023-11-03 11:49:47 +01001345- ``DRTM_SUPPORT``: Boolean flag to enable support for Dynamic Root of Trust
1346 for Measurement (DRTM). This feature has trust dependency on BL31 for taking
1347 the measurements and recording them as per `PSA DRTM specification`_. For
1348 platforms which use BL2 to load/authenticate BL31 ``TRUSTED_BOARD_BOOT`` can
1349 be used and for the platforms which use ``RESET_TO_BL31`` platform owners
1350 should have mechanism to authenticate BL31. This option defaults to 0.
1351
1352- ``ENABLE_RME``: Numeric value to enable support for the ARMv9 Realm
1353 Management Extension. This flag can take the values 0 to 2, to align with
Andre Przywara641571c2023-11-23 16:40:13 +00001354 the ``ENABLE_FEAT`` mechanism. Default value is 0.
Olivier Deprez48856002023-11-03 11:49:47 +01001355
Raghu Krishnamurthyb2263572024-10-13 17:22:43 -07001356- ``RMMD_ENABLE_EL3_TOKEN_SIGN``: Numeric value to enable support for singing
1357 realm attestation token signing requests in EL3. This flag can take the
1358 values 0 and 1. The default value is ``0``. When set to ``1``, this option
1359 enables additional RMMD SMCs to push and pop requests for signing to
1360 EL3 along with platform hooks that must be implemented to service those
1361 requests and responses.
1362
Olivier Deprez48856002023-11-03 11:49:47 +01001363- ``ENABLE_SME_FOR_NS``: Numeric value to enable Scalable Matrix Extension
1364 (SME), SVE, and FPU/SIMD for the non-secure world only. These features share
1365 registers so are enabled together. Using this option without
1366 ENABLE_SME_FOR_SWD=1 will cause SME, SVE, and FPU/SIMD instructions in secure
1367 world to trap to EL3. Requires ``ENABLE_SVE_FOR_NS`` to be set as SME is a
1368 superset of SVE. SME is an optional architectural feature for AArch64.
1369 At this time, this build option cannot be used on systems that have
1370 SPD=spmd/SPM_MM and atempting to build with this option will fail.
Andre Przywara641571c2023-11-23 16:40:13 +00001371 This flag can take the values 0 to 2, to align with the ``ENABLE_FEAT``
Olivier Deprez48856002023-11-03 11:49:47 +01001372 mechanism. Default is 0.
1373
1374- ``ENABLE_SME2_FOR_NS``: Numeric value to enable Scalable Matrix Extension
1375 version 2 (SME2) for the non-secure world only. SME2 is an optional
1376 architectural feature for AArch64.
1377 This should be set along with ENABLE_SME_FOR_NS=1, if not, the default SME
1378 accesses will still be trapped. This flag can take the values 0 to 2, to
Andre Przywara641571c2023-11-23 16:40:13 +00001379 align with the ``ENABLE_FEAT`` mechanism. Default is 0.
Olivier Deprez48856002023-11-03 11:49:47 +01001380
1381- ``ENABLE_SME_FOR_SWD``: Boolean option to enable the Scalable Matrix
1382 Extension for secure world. Used along with SVE and FPU/SIMD.
1383 ENABLE_SME_FOR_NS and ENABLE_SVE_FOR_SWD must also be set to use this.
1384 Default is 0.
1385
1386- ``ENABLE_SPMD_LP`` : This boolean option is used jointly with the SPM
1387 Dispatcher option (``SPD=spmd``). When enabled (1) it indicates support
1388 for logical partitions in EL3, managed by the SPMD as defined in the
1389 FF-A v1.2 specification. This flag is disabled by default. This flag
1390 must not be used if ``SPMC_AT_EL3`` is enabled.
1391
1392- ``FEATURE_DETECTION``: Boolean option to enable the architectural features
Andre Przywara641571c2023-11-23 16:40:13 +00001393 verification mechanism. This is a debug feature that compares the
1394 architectural features enabled through the feature specific build flags
1395 (ENABLE_FEAT_xxx) with the features actually available on the CPU running,
1396 and reports any discrepancies.
1397 This flag will also enable errata ordering checking for ``DEBUG`` builds.
Olivier Deprez48856002023-11-03 11:49:47 +01001398
Andre Przywara641571c2023-11-23 16:40:13 +00001399 It is expected that this feature is only used for flexible platforms like
1400 software emulators, or for hardware platforms at bringup time, to verify
1401 that the configured feature set matches the CPU.
1402 The ``FEATURE_DETECTION`` macro is disabled by default.
Olivier Deprez48856002023-11-03 11:49:47 +01001403
1404- ``PSA_CRYPTO``: Boolean option for enabling MbedTLS PSA crypto APIs support.
1405 The platform will use PSA compliant Crypto APIs during authentication and
1406 image measurement process by enabling this option. It uses APIs defined as
1407 per the `PSA Crypto API specification`_. This feature is only supported if
1408 using MbedTLS 3.x version. It is disabled (``0``) by default.
1409
1410- ``TRANSFER_LIST``: Setting this to ``1`` enables support for Firmware
1411 Handoff using Transfer List defined in `Firmware Handoff specification`_.
1412 This defaults to ``0``. Current implementation follows the Firmware Handoff
1413 specification v0.9.
1414
1415- ``USE_DEBUGFS``: When set to 1 this option exposes a virtual filesystem
1416 interface through BL31 as a SiP SMC function.
1417 Default is disabled (0).
1418
Manish V Badarkhe34f702d2021-03-16 11:14:19 +00001419Firmware update options
Olivier Deprez48856002023-11-03 11:49:47 +01001420~~~~~~~~~~~~~~~~~~~~~~~
1421
1422- ``PSA_FWU_SUPPORT``: Enable the firmware update mechanism as per the
1423 `PSA FW update specification`_. The default value is 0.
1424 PSA firmware update implementation has few limitations, such as:
1425
1426 - BL2 is not part of the protocol-updatable images. If BL2 needs to
1427 be updated, then it should be done through another platform-defined
1428 mechanism.
1429
1430 - It assumes the platform's hardware supports CRC32 instructions.
Manish V Badarkhe34f702d2021-03-16 11:14:19 +00001431
1432- ``NR_OF_FW_BANKS``: Define the number of firmware banks. This flag is used
1433 in defining the firmware update metadata structure. This flag is by default
1434 set to '2'.
1435
1436- ``NR_OF_IMAGES_IN_FW_BANK``: Define the number of firmware images in each
1437 firmware bank. Each firmware bank must have the same number of images as per
1438 the `PSA FW update specification`_.
1439 This flag is used in defining the firmware update metadata structure. This
1440 flag is by default set to '1'.
1441
Sughosh Ganu7ae16192024-02-01 12:42:40 +05301442- ``PSA_FWU_METADATA_FW_STORE_DESC``: To be enabled when the FWU
1443 metadata contains image description. The default value is 1.
1444
1445 The version 2 of the FWU metadata allows for an opaque metadata
1446 structure where a platform can choose to not include the firmware
1447 store description in the metadata structure. This option indicates
1448 if the firmware store description, which provides information on
1449 the updatable images is part of the structure.
1450
Paul Beesley43f35ef2019-05-29 13:59:40 +01001451--------------
1452
Govindraj Raja0a33adc2023-12-21 13:57:49 -06001453*Copyright (c) 2019-2024, Arm Limited. All rights reserved.*
Jeremy Linton2d31cb02021-01-26 22:42:03 -06001454
1455.. _DEN0115: https://developer.arm.com/docs/den0115/latest
Sughosh Ganue106a782024-02-01 12:25:09 +05301456.. _PSA FW update specification: https://developer.arm.com/documentation/den0118/latest/
Manish V Badarkhe859eabd2022-02-14 18:31:16 +00001457.. _PSA DRTM specification: https://developer.arm.com/documentation/den0113/a
Boyan Karatotev291be192022-12-07 10:26:48 +00001458.. _GCC: https://gcc.gnu.org/onlinedocs/gcc/Warning-Options.html
1459.. _Clang: https://clang.llvm.org/docs/DiagnosticsReference.html
Raymond Mao3ba2c152023-07-25 07:53:35 -07001460.. _Firmware Handoff specification: https://github.com/FirmwareHandoff/firmware_handoff/releases/tag/v0.9
Manish V Badarkhe5782b892023-09-06 09:08:28 +01001461.. _PSA Crypto API specification: https://armmbed.github.io/mbed-crypto/html/