blob: ab0b94d5144fb110b04a20a81c96f819fc7e7e22 [file] [log] [blame]
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +01001Build Options
2=============
3
4The TF-A build system supports the following build options. Unless mentioned
5otherwise, these options are expected to be specified at the build command
6line and are not to be modified in any component makefiles. Note that the
7build system doesn't track dependency for build options. Therefore, if any of
8the build options are changed from a previous build, a clean build must be
9performed.
10
11.. _build_options_common:
12
13Common build options
14--------------------
15
16- ``AARCH32_INSTRUCTION_SET``: Choose the AArch32 instruction set that the
17 compiler should use. Valid values are T32 and A32. It defaults to T32 due to
18 code having a smaller resulting size.
19
20- ``AARCH32_SP`` : Choose the AArch32 Secure Payload component to be built as
21 as the BL32 image when ``ARCH=aarch32``. The value should be the path to the
22 directory containing the SP source, relative to the ``bl32/``; the directory
23 is expected to contain a makefile called ``<aarch32_sp-value>.mk``.
24
johpow01fa59c6f2020-10-02 13:41:11 -050025- ``AMU_RESTRICT_COUNTERS``: Register reads to the group 1 counters will return
Juan Pablo Conde79b5f572024-04-03 13:18:40 -050026 zero at all but the highest implemented exception level. External
27 memory-mapped debug accesses are unaffected by this control.
28 The default value is 1 for all platforms.
johpow01fa59c6f2020-10-02 13:41:11 -050029
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +010030- ``ARCH`` : Choose the target build architecture for TF-A. It can take either
31 ``aarch64`` or ``aarch32`` as values. By default, it is defined to
32 ``aarch64``.
33
Alexei Fedorov132e6652020-12-07 16:38:53 +000034- ``ARM_ARCH_FEATURE``: Optional Arm Architecture build option which specifies
35 one or more feature modifiers. This option has the form ``[no]feature+...``
36 and defaults to ``none``. It translates into compiler option
37 ``-march=armvX[.Y]-a+[no]feature+...``. See compiler's documentation for the
38 list of supported feature modifiers.
39
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +010040- ``ARM_ARCH_MAJOR``: The major version of Arm Architecture to target when
41 compiling TF-A. Its value must be numeric, and defaults to 8 . See also,
42 *Armv8 Architecture Extensions* and *Armv7 Architecture Extensions* in
43 :ref:`Firmware Design`.
44
45- ``ARM_ARCH_MINOR``: The minor version of Arm Architecture to target when
46 compiling TF-A. Its value must be a numeric, and defaults to 0. See also,
47 *Armv8 Architecture Extensions* in :ref:`Firmware Design`.
48
Manish V Badarkheb59efca2023-06-27 11:40:21 +010049- ``ARM_BL2_SP_LIST_DTS``: Path to DTS file snippet to override the hardcoded
50 SP nodes in tb_fw_config.
51
52- ``ARM_SPMC_MANIFEST_DTS`` : path to an alternate manifest file used as the
53 SPMC Core manifest. Valid when ``SPD=spmd`` is selected.
54
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +010055- ``BL2``: This is an optional build option which specifies the path to BL2
56 image for the ``fip`` target. In this case, the BL2 in the TF-A will not be
57 built.
58
59- ``BL2U``: This is an optional build option which specifies the path to
60 BL2U image. In this case, the BL2U in TF-A will not be built.
61
Arvind Ram Prakash11b9b492022-11-22 14:41:00 -060062- ``RESET_TO_BL2``: Boolean option to enable BL2 entrypoint as the CPU reset
63 vector instead of the BL1 entrypoint. It can take the value 0 (CPU reset to BL1
64 entrypoint) or 1 (CPU reset to BL2 entrypoint).
65 The default value is 0.
66
67- ``BL2_RUNS_AT_EL3``: This is an implicit flag to denote that BL2 runs at EL3.
68 While it is explicitly set to 1 when RESET_TO_BL2 is set to 1 it can also be
69 true in a 4-world system where RESET_TO_BL2 is 0.
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +010070
Balint Dobszay719ba9c2021-03-26 16:23:18 +010071- ``BL2_ENABLE_SP_LOAD``: Boolean option to enable loading SP packages from the
72 FIP. Automatically enabled if ``SP_LAYOUT_FILE`` is provided.
73
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +010074- ``BL2_IN_XIP_MEM``: In some use-cases BL2 will be stored in eXecute In Place
75 (XIP) memory, like BL1. In these use-cases, it is necessary to initialize
76 the RW sections in RAM, while leaving the RO sections in place. This option
Arvind Ram Prakash11b9b492022-11-22 14:41:00 -060077 enable this use-case. For now, this option is only supported
78 when RESET_TO_BL2 is set to '1'.
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +010079
80- ``BL31``: This is an optional build option which specifies the path to
81 BL31 image for the ``fip`` target. In this case, the BL31 in TF-A will not
82 be built.
83
Robin van der Gracht06b5cdb2023-09-12 11:16:23 +020084- ``BL31_KEY``: This option is used when ``GENERATE_COT=1``. It specifies a
85 file that contains the BL31 private key in PEM format or a PKCS11 URI. If
86 ``SAVE_KEYS=1``, only a file is accepted and it will be used to save the key.
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +010087
88- ``BL32``: This is an optional build option which specifies the path to
89 BL32 image for the ``fip`` target. In this case, the BL32 in TF-A will not
90 be built.
91
92- ``BL32_EXTRA1``: This is an optional build option which specifies the path to
93 Trusted OS Extra1 image for the ``fip`` target.
94
95- ``BL32_EXTRA2``: This is an optional build option which specifies the path to
96 Trusted OS Extra2 image for the ``fip`` target.
97
Robin van der Gracht06b5cdb2023-09-12 11:16:23 +020098- ``BL32_KEY``: This option is used when ``GENERATE_COT=1``. It specifies a
99 file that contains the BL32 private key in PEM format or a PKCS11 URI. If
100 ``SAVE_KEYS=1``, only a file is accepted and it will be used to save the key.
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100101
Jaylyn Renfd5ff022024-08-02 11:58:23 +0100102- ``RMM``: This is an optional build option used when ``ENABLE_RME`` is set.
103 It specifies the path to RMM binary for the ``fip`` target. If the RMM option
104 is not specified, TF-A builds the TRP to load and run at R-EL2.
105
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100106- ``BL33``: Path to BL33 image in the host file system. This is mandatory for
107 ``fip`` target in case TF-A BL2 is used.
108
Robin van der Gracht06b5cdb2023-09-12 11:16:23 +0200109- ``BL33_KEY``: This option is used when ``GENERATE_COT=1``. It specifies a
110 file that contains the BL33 private key in PEM format or a PKCS11 URI. If
111 ``SAVE_KEYS=1``, only a file is accepted and it will be used to save the key.
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100112
113- ``BRANCH_PROTECTION``: Numeric value to enable ARMv8.3 Pointer Authentication
114 and ARMv8.5 Branch Target Identification support for TF-A BL images themselves.
115 If enabled, it is needed to use a compiler that supports the option
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 Fedorove039e482020-06-19 14:33:49 +0100121- 4: Turn on branch target identification mechanism
Paul Beesleyd2fcc4e2019-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 Fedorove039e482020-06-19 14:33:49 +0100137 | 4 | bti | N | Y |
138 +-------+--------------+-------+-----+
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100139
Manish Pandey34a305e2021-10-21 21:53:49 +0100140 This option defaults to 0.
Paul Beesleyd2fcc4e2019-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 Likely388248a2020-07-30 08:50:10 +0100152- ``BUILD_BASE``: Output directory for the build. Defaults to ``./build``
153
Paul Beesleyd2fcc4e2019-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 Bailleuxd4c1d442020-01-15 10:23:25 +0100166- ``COT``: When Trusted Boot is enabled, selects the desired chain of trust.
167 Defaults to ``tbbr``.
168
Paul Beesleyd2fcc4e2019-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 Prakash4851b492023-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 Chidanand38b461a2022-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 Przywara9563c502023-11-23 16:40:13 +0000196 ``ENABLE_FEAT`` mechanism. Default value is 0.
Jayanth Dodderi Chidanand38b461a2022-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 Przywara9563c502023-11-23 16:40:13 +0000201 switch. This flag can take values 0 to 2, to align with ``ENABLE_FEAT``
Jayanth Dodderi Chidanand38b461a2022-02-28 23:41:41 +0000202 mechanism. Default value is 0.
203
Paul Beesleyd2fcc4e2019-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 Pappireddy10a89192024-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 Beesleyd2fcc4e2019-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 Garg392e4df2019-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 Pandey34a305e2021-10-21 21:53:49 +0100221 feature as per TBBR.
Sumit Garg392e4df2019-11-15 10:43:00 +0530222
Paul Beesleyd2fcc4e2019-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 Karatotev677ed8a2023-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 Przywara9563c502023-11-23 16:40:13 +0000229 This flag can take values 0 to 2, to align with the ``ENABLE_FEAT``
Boyan Karatotev677ed8a2023-02-16 09:45:29 +0000230 mechanism. Default is ``0``.
Javier Almansa Sobrinof3a4c542020-11-23 18:38:15 +0000231
Paul Beesleyd2fcc4e2019-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 Karatoteve9e7e8a2022-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 Gautier5ae29c02024-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 Beesleyd2fcc4e2019-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 Kay925fda42021-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 Kayf11909f2021-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 Beesleyd2fcc4e2019-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 Fedorovb8f26e92020-02-06 17:11:03 +0000273- ``ENABLE_BACKTRACE``: This option controls whether to enable backtrace
Paul Beesleyd2fcc4e2019-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 Przywara9563c502023-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 Przywara0b7f1b02023-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 Przywara9563c502023-11-23 16:40:13 +0000311 ``ENABLE_FEAT`` mechanism. This is an optional architectural feature
Andre Przywara0b7f1b02023-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 Chidanand38b461a2022-02-28 23:41:41 +0000315
316- ``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 Przywara9563c502023-11-23 16:40:13 +0000319 ``ENABLE_FEAT`` mechanism. Default value is ``0``.
Jayanth Dodderi Chidanand38b461a2022-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 Przywara9563c502023-11-23 16:40:13 +0000325 0 to 2, to align with the ``ENABLE_FEAT`` mechanism.
Jayanth Dodderi Chidanand38b461a2022-02-28 23:41:41 +0000326 Default value is ``0``.
327
Sona Mathew3b84c962023-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 Prakash05b47632024-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 Chidanand38b461a2022-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 Przywara9563c502023-11-23 16:40:13 +0000345 ``ENABLE_FEAT`` mechanism. Default value is ``0``.
Jayanth Dodderi Chidanand76ff3632021-12-05 19:21:14 +0000346
Jayanth Dodderi Chidanand38b461a2022-02-28 23:41:41 +0000347- ``ENABLE_FEAT_ECV``: Numeric value to enable support for the Enhanced Counter
Jayanth Dodderi Chidanand76ff3632021-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 Chidanand38b461a2022-02-28 23:41:41 +0000350 Its a mandatory architectural feature and is enabled from v8.6 and upwards.
Andre Przywara9563c502023-11-23 16:40:13 +0000351 This flag can take the values 0 to 2, to align with the ``ENABLE_FEAT``
Jayanth Dodderi Chidanand38b461a2022-02-28 23:41:41 +0000352 mechanism. Default value is ``0``.
Jayanth Dodderi Chidanand76ff3632021-12-05 19:21:14 +0000353
Jayanth Dodderi Chidanand38b461a2022-02-28 23:41:41 +0000354- ``ENABLE_FEAT_FGT``: Numeric value to enable support for FGT (Fine Grain Traps)
Jayanth Dodderi Chidanand76ff3632021-12-05 19:21:14 +0000355 feature allowing for access to the HDFGRTR_EL2 (Hypervisor Debug Fine-Grained
Jayanth Dodderi Chidanand38b461a2022-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 Przywara9563c502023-11-23 16:40:13 +0000358 This flag can take the values 0 to 2, to align with the ``ENABLE_FEAT``
Jayanth Dodderi Chidanand38b461a2022-02-28 23:41:41 +0000359 mechanism. Default value is ``0``.
360
Arvind Ram Prakash62d87e72024-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 Chidanand38b461a2022-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 Przywara9563c502023-11-23 16:40:13 +0000372 flag can take the values 0 to 2, to align with the ``ENABLE_FEAT``
Jayanth Dodderi Chidanand38b461a2022-02-28 23:41:41 +0000373 mechanism. Default value is ``0``.
374
Govindraj Rajad7b63ac2024-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 Raja24d3a4e2023-12-21 13:57:49 -0600379
Jayanth Dodderi Chidanand38b461a2022-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 Przywara9563c502023-11-23 16:40:13 +0000385 flag can take values 0 to 2, to align with the ``ENABLE_FEAT``
Jayanth Dodderi Chidanand38b461a2022-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 Przywara9563c502023-11-23 16:40:13 +0000390 flag can take the values 0 to 2, to align with the ``ENABLE_FEAT``
Juan Pablo Conde42305f22022-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 Przywara9563c502023-11-23 16:40:13 +0000395 take values 0 to 2, to align with the ``ENABLE_FEAT`` mechanism.
Juan Pablo Conde42305f22022-07-12 16:40:29 -0400396 Default value is ``0``. ``FEAT_RNG_TRAP`` is an optional feature from
397 Armv8.5 onwards.
Jayanth Dodderi Chidanand38b461a2022-02-28 23:41:41 +0000398
Andre Przywara46880dc2022-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 Chidanand38b461a2022-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 Przywara9563c502023-11-23 16:40:13 +0000407 This flag can take values 0 to 2, to align with the ``ENABLE_FEAT``
Jayanth Dodderi Chidanand38b461a2022-02-28 23:41:41 +0000408 mechanism. Default is ``0``.
Jayanth Dodderi Chidanand76ff3632021-12-05 19:21:14 +0000409
Jayanth Dodderi Chidanand4b5489c2022-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 Przywara9563c502023-11-23 16:40:13 +0000413 ``ENABLE_FEAT`` mechanism. Default is ``0``.
Jayanth Dodderi Chidanand4b5489c2022-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 Chidanand38b461a2022-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 Przywara9563c502023-11-23 16:40:13 +0000422 values 0 to 2, to align with the ``ENABLE_FEAT`` mechanism.
Jayanth Dodderi Chidanand38b461a2022-02-28 23:41:41 +0000423 Default value is ``0``.
johpow01f91e59f2021-08-04 19:38:18 -0500424
Mark Brownc37eee72023-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 Przywara9563c502023-11-23 16:40:13 +0000429 flag can take the values 0 to 2, to align with the ``ENABLE_FEAT``
Mark Brownc37eee72023-03-14 20:13:03 +0000430 mechanism. Default value is ``0``.
431
Mark Brown293a6612023-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 Przywara9563c502023-11-23 16:40:13 +0000434 can take the values 0 to 2, to align with the ``ENABLE_FEAT``
Mark Brown293a6612023-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 Przywara9563c502023-11-23 16:40:13 +0000439 can take the values 0 to 2, to align with the ``ENABLE_FEAT``
Mark Brown293a6612023-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 Przywara9563c502023-11-23 16:40:13 +0000444 can take the values 0 to 2, to align with the ``ENABLE_FEAT``
Mark Brown293a6612023-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 Przywara9563c502023-11-23 16:40:13 +0000449 can take the values 0 to 2, to align with the ``ENABLE_FEAT``
Mark Brown293a6612023-03-14 20:48:43 +0000450 mechanism. Default value is ``0``.
451
Mark Brown326f2952023-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 Przywara9563c502023-11-23 16:40:13 +0000455 the values 0 to 2, to align with the ``ENABLE_FEAT`` mechanism.
Mark Brown326f2952023-03-14 21:33:04 +0000456 Default value is ``0``.
457
Jayanth Dodderi Chidanand6b706862024-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 Chidanand70cc1752024-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 Rajae63794e2024-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 Bailleux11427302019-12-17 09:38:08 +0100483- ``ENABLE_LTO``: Boolean option to enable Link Time Optimization (LTO)
zelalem-aweked5f45272019-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 Prakashab28d4b2023-10-11 12:10:56 -0500487- ``ENABLE_FEAT_MPAM``: Numeric value to enable lower ELs to use MPAM
Paul Beesleyd2fcc4e2019-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 Przywara9563c502023-11-23 16:40:13 +0000493 This flag can take values 0 to 2, to align with the ``ENABLE_FEAT``
Jayanth Dodderi Chidanand38b461a2022-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 Prakashab28d4b2023-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 Beesleyd2fcc4e2019-05-29 13:59:40 +0100501
Andre Przywara8fc8e182024-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 Kay03be39d2021-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 Beesleyd2fcc4e2019-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 Prakash11b9b492022-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 Beesleyd2fcc4e2019-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 Przywaraf3e8cfc2022-11-17 16:42:09 +0000537- ``ENABLE_SPE_FOR_NS`` : Numeric value to enable Statistical Profiling
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100538 extensions. This is an optional architectural feature for AArch64.
Andre Przywara9563c502023-11-23 16:40:13 +0000539 This flag can take the values 0 to 2, to align with the ``ENABLE_FEAT``
Andre Przywaraf3e8cfc2022-11-17 16:42:09 +0000540 mechanism. The default is 2 but is automatically disabled when the target
541 architecture is AArch32.
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100542
Jayanth Dodderi Chidanandd62c6812023-03-07 10:43:19 +0000543- ``ENABLE_SVE_FOR_NS``: Numeric value to enable Scalable Vector Extension
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100544 (SVE) for the Non-secure world only. SVE is an optional architectural feature
Madhukar Pappireddy10a89192024-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.
548
549 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.
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100555
Madhukar Pappireddy10a89192024-07-05 12:44:08 -0500556- ``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 Shvetsovc4502772021-03-22 11:59:37 +0000565
Paul Beesleyd2fcc4e2019-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
Sumit Gargc0c369c2019-11-15 18:47:53 +0530574- ``ENCRYPT_BL31``: Binary flag to enable encryption of BL31 firmware. This
Manish Pandey34a305e2021-10-21 21:53:49 +0100575 flag depends on ``DECRYPTION_SUPPORT`` build flag.
Sumit Gargc0c369c2019-11-15 18:47:53 +0530576
577- ``ENCRYPT_BL32``: Binary flag to enable encryption of Secure BL32 payload.
Manish Pandey34a305e2021-10-21 21:53:49 +0100578 This flag depends on ``DECRYPTION_SUPPORT`` build flag.
Sumit Gargc0c369c2019-11-15 18:47:53 +0530579
580- ``ENC_KEY``: A 32-byte (256-bit) symmetric key in hex string format. It could
581 either be SSK or BSSK depending on ``FW_ENC_STATUS`` flag. This value depends
Manish Pandey34a305e2021-10-21 21:53:49 +0100582 on ``DECRYPTION_SUPPORT`` build flag.
Sumit Gargc0c369c2019-11-15 18:47:53 +0530583
584- ``ENC_NONCE``: A 12-byte (96-bit) encryption nonce or Initialization Vector
585 (IV) in hex string format. This value depends on ``DECRYPTION_SUPPORT``
Manish Pandey34a305e2021-10-21 21:53:49 +0100586 build flag.
Sumit Gargc0c369c2019-11-15 18:47:53 +0530587
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100588- ``ERROR_DEPRECATED``: This option decides whether to treat the usage of
589 deprecated platform APIs, helper functions or drivers within Trusted
590 Firmware as error. It can take the value 1 (flag the use of deprecated
591 APIs as error) or 0. The default is 0.
592
Rajasekaran Kalidoss46359002023-05-09 12:28:07 +0200593- ``ETHOSN_NPU_DRIVER``: boolean option to enable a SiP service that can
594 configure an Arm® Ethos™-N NPU. To use this service the target platform's
595 ``HW_CONFIG`` must include the device tree nodes for the NPU. Currently, only
596 the Arm Juno platform has this included in its ``HW_CONFIG`` and the platform
597 only loads the ``HW_CONFIG`` in AArch64 builds. Default is 0.
598
599- ``ETHOSN_NPU_TZMP1``: boolean option to enable TZMP1 support for the
600 Arm® Ethos™-N NPU. Requires ``ETHOSN_NPU_DRIVER`` and
601 ``TRUSTED_BOARD_BOOT`` to be enabled.
602
603- ``ETHOSN_NPU_FW``: location of the NPU firmware binary
604 (```ethosn.bin```). This firmware image will be included in the FIP and
605 loaded at runtime.
606
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100607- ``EL3_EXCEPTION_HANDLING``: When set to ``1``, enable handling of exceptions
608 targeted at EL3. When set ``0`` (default), no exceptions are expected or
Raghu Krishnamurthy669bf402022-07-25 14:44:33 -0700609 handled at EL3, and a panic will result. The exception to this rule is when
610 ``SPMD_SPM_AT_SEL2`` is set to ``1``, in which case, only exceptions
611 occuring during normal world execution, are trapped to EL3. Any exception
612 trapped during secure world execution are trapped to the SPMC. This is
613 supported only for AArch64 builds.
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100614
Javier Almansa Sobrino0d1f6b12020-09-18 16:47:07 +0100615- ``EVENT_LOG_LEVEL``: Chooses the log level to use for Measured Boot when
616 ``MEASURED_BOOT`` is enabled. For a list of valid values, see ``LOG_LEVEL``.
617 Default value is 40 (LOG_LEVEL_INFO).
618
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100619- ``FAULT_INJECTION_SUPPORT``: ARMv8.4 extensions introduced support for fault
620 injection from lower ELs, and this build option enables lower ELs to use
621 Error Records accessed via System Registers to inject faults. This is
622 applicable only to AArch64 builds.
623
624 This feature is intended for testing purposes only, and is advisable to keep
625 disabled for production images.
626
627- ``FIP_NAME``: This is an optional build option which specifies the FIP
628 filename for the ``fip`` target. Default is ``fip.bin``.
629
630- ``FWU_FIP_NAME``: This is an optional build option which specifies the FWU
631 FIP filename for the ``fwu_fip`` target. Default is ``fwu_fip.bin``.
632
Sumit Gargc0c369c2019-11-15 18:47:53 +0530633- ``FW_ENC_STATUS``: Top level firmware's encryption numeric flag, values:
634
635 ::
636
637 0: Encryption is done with Secret Symmetric Key (SSK) which is common
638 for a class of devices.
639 1: Encryption is done with Binding Secret Symmetric Key (BSSK) which is
640 unique per device.
641
Manish Pandey34a305e2021-10-21 21:53:49 +0100642 This flag depends on ``DECRYPTION_SUPPORT`` build flag.
Sumit Gargc0c369c2019-11-15 18:47:53 +0530643
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100644- ``GENERATE_COT``: Boolean flag used to build and execute the ``cert_create``
645 tool to create certificates as per the Chain of Trust described in
646 :ref:`Trusted Board Boot`. The build system then calls ``fiptool`` to
647 include the certificates in the FIP and FWU_FIP. Default value is '0'.
648
649 Specify both ``TRUSTED_BOARD_BOOT=1`` and ``GENERATE_COT=1`` to include support
650 for the Trusted Board Boot feature in the BL1 and BL2 images, to generate
651 the corresponding certificates, and to include those certificates in the
652 FIP and FWU_FIP.
653
654 Note that if ``TRUSTED_BOARD_BOOT=0`` and ``GENERATE_COT=1``, the BL1 and BL2
655 images will not include support for Trusted Board Boot. The FIP will still
656 include the corresponding certificates. This FIP can be used to verify the
657 Chain of Trust on the host machine through other mechanisms.
658
659 Note that if ``TRUSTED_BOARD_BOOT=1`` and ``GENERATE_COT=0``, the BL1 and BL2
660 images will include support for Trusted Board Boot, but the FIP and FWU_FIP
661 will not include the corresponding certificates, causing a boot failure.
662
663- ``GICV2_G0_FOR_EL3``: Unlike GICv3, the GICv2 architecture doesn't have
664 inherent support for specific EL3 type interrupts. Setting this build option
665 to ``1`` assumes GICv2 *Group 0* interrupts are expected to target EL3, both
Madhukar Pappireddy86350ae2020-07-29 09:37:25 -0500666 by :ref:`platform abstraction layer<platform Interrupt Controller API>` and
667 :ref:`Interrupt Management Framework<Interrupt Management Framework>`.
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100668 This allows GICv2 platforms to enable features requiring EL3 interrupt type.
669 This also means that all GICv2 Group 0 interrupts are delivered to EL3, and
670 the Secure Payload interrupts needs to be synchronously handed over to Secure
671 EL1 for handling. The default value of this option is ``0``, which means the
672 Group 0 interrupts are assumed to be handled by Secure EL1.
673
Manish Pandey0e3379d2022-10-10 11:43:08 +0100674- ``HANDLE_EA_EL3_FIRST_NS``: When set to ``1``, External Aborts and SError
675 Interrupts, resulting from errors in NS world, will be always trapped in
676 EL3 i.e. in BL31 at runtime. When set to ``0`` (default), these exceptions
677 will be trapped in the current exception level (or in EL1 if the current
678 exception level is EL0).
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100679
680- ``HW_ASSISTED_COHERENCY``: On most Arm systems to-date, platform-specific
681 software operations are required for CPUs to enter and exit coherency.
682 However, newer systems exist where CPUs' entry to and exit from coherency
683 is managed in hardware. Such systems require software to only initiate these
684 operations, and the rest is managed in hardware, minimizing active software
685 management. In such systems, this boolean option enables TF-A to carry out
686 build and run-time optimizations during boot and power management operations.
687 This option defaults to 0 and if it is enabled, then it implies
688 ``WARMBOOT_ENABLE_DCACHE_EARLY`` is also enabled.
689
690 If this flag is disabled while the platform which TF-A is compiled for
691 includes cores that manage coherency in hardware, then a compilation error is
692 generated. This is based on the fact that a system cannot have, at the same
693 time, cores that manage coherency in hardware and cores that don't. In other
694 words, a platform cannot have, at the same time, cores that require
695 ``HW_ASSISTED_COHERENCY=1`` and cores that require
696 ``HW_ASSISTED_COHERENCY=0``.
697
698 Note that, when ``HW_ASSISTED_COHERENCY`` is enabled, version 2 of
699 translation library (xlat tables v2) must be used; version 1 of translation
700 library is not supported.
701
Varun Wadekar0a46eb12023-04-13 21:06:18 +0100702- ``IMPDEF_SYSREG_TRAP``: Numeric value to enable the handling traps for
703 implementation defined system register accesses from lower ELs. Default
704 value is ``0``.
705
Louis Mayencourtc1c2bf72020-02-13 08:21:34 +0000706- ``INVERTED_MEMMAP``: memmap tool print by default lower addresses at the
David Horstmannb2cc35f2021-01-21 12:29:59 +0000707 bottom, higher addresses at the top. This build flag can be set to '1' to
Louis Mayencourtc1c2bf72020-02-13 08:21:34 +0000708 invert this behavior. Lower addresses will be printed at the top and higher
709 addresses at the bottom.
710
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100711- ``KEY_ALG``: This build flag enables the user to select the algorithm to be
712 used for generating the PKCS keys and subsequent signing of the certificate.
Lionel Debievefefeffb2022-11-14 11:03:42 +0100713 It accepts 5 values: ``rsa``, ``rsa_1_5``, ``ecdsa``, ``ecdsa-brainpool-regular``
714 and ``ecdsa-brainpool-twisted``. The option ``rsa_1_5`` is the legacy PKCS#1
715 RSA 1.5 algorithm which is not TBBR compliant and is retained only for
716 compatibility. The default value of this flag is ``rsa`` which is the TBBR
717 compliant PKCS#1 RSA 2.1 scheme.
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100718
Gilad Ben-Yossefa6e53422019-09-15 13:29:29 +0300719- ``KEY_SIZE``: This build flag enables the user to select the key size for
720 the algorithm specified by ``KEY_ALG``. The valid values for ``KEY_SIZE``
721 depend on the chosen algorithm and the cryptographic module.
722
Lionel Debievefefeffb2022-11-14 11:03:42 +0100723 +---------------------------+------------------------------------+
724 | KEY_ALG | Possible key sizes |
725 +===========================+====================================+
Sandrine Bailleux2f37ce62023-10-26 15:14:42 +0200726 | rsa | 1024 , 2048 (default), 3072, 4096 |
Lionel Debievefefeffb2022-11-14 11:03:42 +0100727 +---------------------------+------------------------------------+
laurenw-armc2a5dce2023-10-03 15:36:25 -0500728 | ecdsa | 256 (default), 384 |
Lionel Debievefefeffb2022-11-14 11:03:42 +0100729 +---------------------------+------------------------------------+
730 | ecdsa-brainpool-regular | unavailable |
731 +---------------------------+------------------------------------+
732 | ecdsa-brainpool-twisted | unavailable |
733 +---------------------------+------------------------------------+
734
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100735- ``HASH_ALG``: This build flag enables the user to select the secure hash
736 algorithm. It accepts 3 values: ``sha256``, ``sha384`` and ``sha512``.
737 The default value of this flag is ``sha256``.
738
739- ``LDFLAGS``: Extra user options appended to the linkers' command line in
740 addition to the one set by the build system.
741
742- ``LOG_LEVEL``: Chooses the log level, which controls the amount of console log
743 output compiled into the build. This should be one of the following:
744
745 ::
746
747 0 (LOG_LEVEL_NONE)
748 10 (LOG_LEVEL_ERROR)
749 20 (LOG_LEVEL_NOTICE)
750 30 (LOG_LEVEL_WARNING)
751 40 (LOG_LEVEL_INFO)
752 50 (LOG_LEVEL_VERBOSE)
753
754 All log output up to and including the selected log level is compiled into
755 the build. The default value is 40 in debug builds and 20 in release builds.
756
Alexei Fedorov913cb7e2020-01-23 14:27:38 +0000757- ``MEASURED_BOOT``: Boolean flag to include support for the Measured Boot
Manish V Badarkhe92de80a2021-12-16 10:41:47 +0000758 feature. This flag can be enabled with ``TRUSTED_BOARD_BOOT`` in order to
759 provide trust that the code taking the measurements and recording them has
760 not been tampered with.
Sandrine Bailleux533d8b32021-06-10 11:18:04 +0200761
Manish Pandey34a305e2021-10-21 21:53:49 +0100762 This option defaults to 0.
Alexei Fedorov913cb7e2020-01-23 14:27:38 +0000763
Govindraj Raja81525652023-07-18 13:55:33 -0500764- ``MARCH_DIRECTIVE``: used to pass a -march option from the platform build
765 options to the compiler. An example usage:
766
767 .. code:: make
768
769 MARCH_DIRECTIVE := -march=armv8.5-a
770
Bipin Ravie53e6ae2023-09-28 13:17:24 -0500771- ``HARDEN_SLS``: used to pass -mharden-sls=all from the TF-A build
772 options to the compiler currently supporting only of the options.
773 GCC documentation:
774 https://gcc.gnu.org/onlinedocs/gcc/AArch64-Options.html#index-mharden-sls
775
776 An example usage:
777
778 .. code:: make
779
780 HARDEN_SLS := 1
781
782 This option defaults to 0.
783
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100784- ``NON_TRUSTED_WORLD_KEY``: This option is used when ``GENERATE_COT=1``. It
Robin van der Gracht06b5cdb2023-09-12 11:16:23 +0200785 specifies a file that contains the Non-Trusted World private key in PEM
786 format or a PKCS11 URI. If ``SAVE_KEYS=1``, only a file is accepted and it
787 will be used to save the key.
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100788
789- ``NS_BL2U``: Path to NS_BL2U image in the host file system. This image is
790 optional. It is only needed if the platform makefile specifies that it
791 is required in order to build the ``fwu_fip`` target.
792
793- ``NS_TIMER_SWITCH``: Enable save and restore for non-secure timer register
794 contents upon world switch. It can take either 0 (don't save and restore) or
795 1 (do save and restore). 0 is the default. An SPD may set this to 1 if it
796 wants the timer registers to be saved and restored.
797
798- ``OVERRIDE_LIBC``: This option allows platforms to override the default libc
799 for the BL image. It can be either 0 (include) or 1 (remove). The default
800 value is 0.
801
802- ``PL011_GENERIC_UART``: Boolean option to indicate the PL011 driver that
803 the underlying hardware is not a full PL011 UART but a minimally compliant
804 generic UART, which is a subset of the PL011. The driver will not access
805 any register that is not part of the SBSA generic UART specification.
806 Default value is 0 (a full PL011 compliant UART is present).
807
808- ``PLAT``: Choose a platform to build TF-A for. The chosen platform name
809 must be subdirectory of any depth under ``plat/``, and must contain a
810 platform makefile named ``platform.mk``. For example, to build TF-A for the
811 Arm Juno board, select PLAT=juno.
812
Juan Pablo Condeb5ec1382023-11-08 16:14:28 -0600813- ``PLATFORM_REPORT_CTX_MEM_USE``: Reports the context memory allocated for
814 each core as well as the global context. The data includes the memory used
815 by each world and each privileged exception level. This build option is
816 applicable only for ``ARCH=aarch64`` builds. The default value is 0.
817
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100818- ``PRELOADED_BL33_BASE``: This option enables booting a preloaded BL33 image
819 instead of the normal boot flow. When defined, it must specify the entry
820 point address for the preloaded BL33 image. This option is incompatible with
821 ``EL3_PAYLOAD_BASE``. If both are defined, ``EL3_PAYLOAD_BASE`` has priority
822 over ``PRELOADED_BL33_BASE``.
823
Arvind Ram Prakasheaa90192023-12-21 00:25:52 -0600824- ``PRESERVE_DSU_PMU_REGS``: This options when enabled allows the platform to
825 save/restore the DynamIQ Shared Unit's(DSU) Performance Monitoring Unit(PMU)
826 registers when the cluster goes through a power cycle. This is disabled by
827 default and platforms that require this feature have to enable them.
828
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100829- ``PROGRAMMABLE_RESET_ADDRESS``: This option indicates whether the reset
830 vector address can be programmed or is fixed on the platform. It can take
831 either 0 (fixed) or 1 (programmable). Default is 0. If the platform has a
832 programmable reset address, it is expected that a CPU will start executing
833 code directly at the right address, both on a cold and warm reset. In this
834 case, there is no need to identify the entrypoint on boot and the boot path
835 can be optimised. The ``plat_get_my_entrypoint()`` platform porting interface
836 does not need to be implemented in this case.
837
838- ``PSCI_EXTENDED_STATE_ID``: As per PSCI1.0 Specification, there are 2 formats
839 possible for the PSCI power-state parameter: original and extended State-ID
840 formats. This flag if set to 1, configures the generic PSCI layer to use the
841 extended format. The default value of this flag is 0, which means by default
842 the original power-state format is used by the PSCI implementation. This flag
843 should be specified by the platform makefile and it governs the return value
844 of PSCI_FEATURES API for CPU_SUSPEND smc function id. When this option is
845 enabled on Arm platforms, the option ``ARM_RECOM_STATE_ID_ENC`` needs to be
846 set to 1 as well.
847
Wing Li1e9b68a2023-01-26 18:33:36 -0800848- ``PSCI_OS_INIT_MODE``: Boolean flag to enable support for optional PSCI
849 OS-initiated mode. This option defaults to 0.
850
Manish Pandeyf90a73c2023-10-10 15:42:19 +0100851- ``ENABLE_FEAT_RAS``: Boolean flag to enable Armv8.2 RAS features. RAS features
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100852 are an optional extension for pre-Armv8.2 CPUs, but are mandatory for Armv8.2
Manish Pandey514a3012023-10-10 13:53:25 +0100853 or later CPUs. This flag can take the values 0 or 1. The default value is 0.
854 NOTE: This flag enables use of IESB capability to reduce entry latency into
855 EL3 even when RAS error handling is not performed on the platform. Hence this
856 flag is recommended to be turned on Armv8.2 and later CPUs.
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100857
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100858- ``RESET_TO_BL31``: Enable BL31 entrypoint as the CPU reset vector instead
859 of the BL1 entrypoint. It can take the value 0 (CPU reset to BL1
860 entrypoint) or 1 (CPU reset to BL31 entrypoint).
861 The default value is 0.
862
863- ``RESET_TO_SP_MIN``: SP_MIN is the minimal AArch32 Secure Payload provided
864 in TF-A. This flag configures SP_MIN entrypoint as the CPU reset vector
865 instead of the BL1 entrypoint. It can take the value 0 (CPU reset to BL1
866 entrypoint) or 1 (CPU reset to SP_MIN entrypoint). The default value is 0.
867
AlexeiFedorovc0ca2d72024-05-13 15:35:54 +0100868- ``RME_GPT_BITLOCK_BLOCK``: This defines the block size (in number of 512MB
869- blocks) covered by a single bit of the bitlock structure during RME GPT
870- operations. The lower the block size, the better opportunity for
871- parallelising GPT operations but at the cost of more bits being needed
872- for the bitlock structure. This numeric parameter can take the values
873- from 0 to 512 and must be a power of 2. The value of 0 is special and
874- and it chooses a single spinlock for all GPT L1 table entries. Default
875- value is 1 which corresponds to block size of 512MB per bit of bitlock
876- structure.
877
878- ``RME_GPT_MAX_BLOCK``: Numeric value in MB to define the maximum size of
AlexeiFedorovbd8b1bb2024-03-13 17:07:03 +0000879 supported contiguous blocks in GPT Library. This parameter can take the
880 values 0, 2, 32 and 512. Setting this value to 0 disables use of Contigious
Soby Mathewa16f40b2024-08-22 11:53:09 +0100881 descriptors. Default value is 512.
AlexeiFedorovbd8b1bb2024-03-13 17:07:03 +0000882
Robin van der Gracht06b5cdb2023-09-12 11:16:23 +0200883- ``ROT_KEY``: This option is used when ``GENERATE_COT=1``. It specifies a
884 file that contains the ROT private key in PEM format or a PKCS11 URI and
885 enforces public key hash generation. If ``SAVE_KEYS=1``, only a file is
886 accepted and it will be used to save the key.
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100887
888- ``SAVE_KEYS``: This option is used when ``GENERATE_COT=1``. It tells the
889 certificate generation tool to save the keys used to establish the Chain of
890 Trust. Allowed options are '0' or '1'. Default is '0' (do not save).
891
892- ``SCP_BL2``: Path to SCP_BL2 image in the host file system. This image is optional.
893 If a SCP_BL2 image is present then this option must be passed for the ``fip``
894 target.
895
Robin van der Gracht06b5cdb2023-09-12 11:16:23 +0200896- ``SCP_BL2_KEY``: This option is used when ``GENERATE_COT=1``. It specifies a
897 file that contains the SCP_BL2 private key in PEM format or a PKCS11 URI.
898 If ``SAVE_KEYS=1``, only a file is accepted and it will be used to save the key.
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100899
900- ``SCP_BL2U``: Path to SCP_BL2U image in the host file system. This image is
901 optional. It is only needed if the platform makefile specifies that it
902 is required in order to build the ``fwu_fip`` target.
903
904- ``SDEI_SUPPORT``: Setting this to ``1`` enables support for Software
905 Delegated Exception Interface to BL31 image. This defaults to ``0``.
906
907 When set to ``1``, the build option ``EL3_EXCEPTION_HANDLING`` must also be
908 set to ``1``.
909
910- ``SEPARATE_CODE_AND_RODATA``: Whether code and read-only data should be
911 isolated on separate memory pages. This is a trade-off between security and
912 memory usage. See "Isolating code and read-only data on separate memory
Olivier Deprez7efa3f12020-03-26 16:09:21 +0100913 pages" section in :ref:`Firmware Design`. This flag is disabled by default
914 and affects all BL images.
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100915
Samuel Holland31a14e12018-10-17 21:40:18 -0500916- ``SEPARATE_NOBITS_REGION``: Setting this option to ``1`` allows the NOBITS
917 sections of BL31 (.bss, stacks, page tables, and coherent memory) to be
918 allocated in RAM discontiguous from the loaded firmware image. When set, the
David Horstmannb2cc35f2021-01-21 12:29:59 +0000919 platform is expected to provide definitions for ``BL31_NOBITS_BASE`` and
Samuel Holland31a14e12018-10-17 21:40:18 -0500920 ``BL31_NOBITS_LIMIT``. When the option is ``0`` (the default), NOBITS
921 sections are placed in RAM immediately following the loaded firmware image.
922
Jiafei Pan0824b452022-02-24 10:47:33 +0800923- ``SEPARATE_BL2_NOLOAD_REGION``: Setting this option to ``1`` allows the
924 NOLOAD sections of BL2 (.bss, stacks, page tables) to be allocated in RAM
925 discontiguous from loaded firmware images. When set, the platform need to
926 provide definitions of ``BL2_NOLOAD_START`` and ``BL2_NOLOAD_LIMIT``. This
927 flag is disabled by default and NOLOAD sections are placed in RAM immediately
928 following the loaded firmware image.
929
Madhukar Pappireddy10a89192024-07-05 12:44:08 -0500930- ``SEPARATE_SIMD_SECTION``: Setting this option to ``1`` allows the SIMD context
931 data structures to be put in a dedicated memory region as decided by platform
932 integrator. Default value is ``0`` which means the SIMD context is put in BSS
933 section of EL3 firmware.
934
Jeremy Linton684a0792021-01-26 22:42:03 -0600935- ``SMC_PCI_SUPPORT``: This option allows platforms to handle PCI configuration
936 access requests via a standard SMCCC defined in `DEN0115`_. When combined with
937 UEFI+ACPI this can provide a certain amount of OS forward compatibility
938 with newer platforms that aren't ECAM compliant.
939
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100940- ``SPD``: Choose a Secure Payload Dispatcher component to be built into TF-A.
941 This build option is only valid if ``ARCH=aarch64``. The value should be
942 the path to the directory containing the SPD source, relative to
943 ``services/spd/``; the directory is expected to contain a makefile called
Olivier Deprez7efa3f12020-03-26 16:09:21 +0100944 ``<spd-value>.mk``. The SPM Dispatcher standard service is located in
945 services/std_svc/spmd and enabled by ``SPD=spmd``. The SPM Dispatcher
946 cannot be enabled when the ``SPM_MM`` option is enabled.
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100947
948- ``SPIN_ON_BL1_EXIT``: This option introduces an infinite loop in BL1. It can
949 take either 0 (no loop) or 1 (add a loop). 0 is the default. This loop stops
950 execution in BL1 just before handing over to BL31. At this point, all
951 firmware images have been loaded in memory, and the MMU and caches are
952 turned off. Refer to the "Debugging options" section for more details.
953
Marc Bonniciabaac162021-12-01 18:00:40 +0000954- ``SPMC_AT_EL3`` : This boolean option is used jointly with the SPM
955 Dispatcher option (``SPD=spmd``). When enabled (1) it indicates the SPMC
956 component runs at the EL3 exception level. The default value is ``0`` (
957 disabled). This configuration supports pre-Armv8.4 platforms (aka not
Olivier Deprezb6cd6702023-11-03 11:49:47 +0100958 implementing the ``FEAT_SEL2`` extension).
Marc Bonniciabaac162021-12-01 18:00:40 +0000959
Nishant Sharma9e719112023-06-27 00:36:01 +0100960- ``SPMC_AT_EL3_SEL0_SP`` : Boolean option to enable SEL0 SP load support when
961 ``SPMC_AT_EL3`` is enabled. The default value if ``0`` (disabled). This
962 option cannot be enabled (``1``) when (``SPMC_AT_EL3``) is disabled.
963
Jens Wiklanderba0ed3e2022-12-14 17:02:16 +0100964- ``SPMC_OPTEE`` : This boolean option is used jointly with the SPM
965 Dispatcher option (``SPD=spmd``) and with ``SPMD_SPM_AT_SEL2=0`` to
966 indicate that the SPMC at S-EL1 is OP-TEE and an OP-TEE specific loading
967 mechanism should be used.
968
Jayanth Dodderi Chidanand38b461a2022-02-28 23:41:41 +0000969- ``SPMD_SPM_AT_SEL2`` : This boolean option is used jointly with the SPM
Olivier Deprez7efa3f12020-03-26 16:09:21 +0100970 Dispatcher option (``SPD=spmd``). When enabled (1) it indicates the SPMC
Marc Bonniciabaac162021-12-01 18:00:40 +0000971 component runs at the S-EL2 exception level provided by the ``FEAT_SEL2``
Olivier Deprez7efa3f12020-03-26 16:09:21 +0100972 extension. This is the default when enabling the SPM Dispatcher. When
973 disabled (0) it indicates the SPMC component runs at the S-EL1 execution
Marc Bonniciabaac162021-12-01 18:00:40 +0000974 state or at EL3 if ``SPMC_AT_EL3`` is enabled. The latter configurations
975 support pre-Armv8.4 platforms (aka not implementing the ``FEAT_SEL2``
976 extension).
Olivier Deprez7efa3f12020-03-26 16:09:21 +0100977
Paul Beesleyfe975b42019-09-16 11:29:03 +0000978- ``SPM_MM`` : Boolean option to enable the Management Mode (MM)-based Secure
Olivier Deprez7efa3f12020-03-26 16:09:21 +0100979 Partition Manager (SPM) implementation. The default value is ``0``
980 (disabled). This option cannot be enabled (``1``) when SPM Dispatcher is
981 enabled (``SPD=spmd``).
Paul Beesleyfe975b42019-09-16 11:29:03 +0000982
Manish Pandey3f90ad72020-01-14 11:52:05 +0000983- ``SP_LAYOUT_FILE``: Platform provided path to JSON file containing the
Olivier Deprez7efa3f12020-03-26 16:09:21 +0100984 description of secure partitions. The build system will parse this file and
985 package all secure partition blobs into the FIP. This file is not
986 necessarily part of TF-A tree. Only available when ``SPD=spmd``.
Manish Pandey3f90ad72020-01-14 11:52:05 +0000987
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +0100988- ``SP_MIN_WITH_SECURE_FIQ``: Boolean flag to indicate the SP_MIN handles
989 secure interrupts (caught through the FIQ line). Platforms can enable
990 this directive if they need to handle such interruption. When enabled,
991 the FIQ are handled in monitor mode and non secure world is not allowed
992 to mask these events. Platforms that enable FIQ handling in SP_MIN shall
993 implement the api ``sp_min_plat_fiq_handler()``. The default value is 0.
994
Mark Brown64869972022-04-20 18:14:32 +0100995- ``SVE_VECTOR_LEN``: SVE vector length to configure in ZCR_EL3.
996 Platforms can configure this if they need to lower the hardware
997 limit, for example due to asymmetric configuration or limitations of
998 software run at lower ELs. The default is the architectural maximum
999 of 2048 which should be suitable for most configurations, the
1000 hardware will limit the effective VL to the maximum physically supported
1001 VL.
1002
Jayanth Dodderi Chidanand7c7faff2022-10-11 17:16:07 +01001003- ``TRNG_SUPPORT``: Setting this to ``1`` enables support for True
1004 Random Number Generator Interface to BL31 image. This defaults to ``0``.
1005
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +01001006- ``TRUSTED_BOARD_BOOT``: Boolean flag to include support for the Trusted Board
1007 Boot feature. When set to '1', BL1 and BL2 images include support to load
1008 and verify the certificates and images in a FIP, and BL1 includes support
1009 for the Firmware Update. The default value is '0'. Generation and inclusion
1010 of certificates in the FIP and FWU_FIP depends upon the value of the
1011 ``GENERATE_COT`` option.
1012
1013 .. warning::
1014 This option depends on ``CREATE_KEYS`` to be enabled. If the keys
1015 already exist in disk, they will be overwritten without further notice.
1016
1017- ``TRUSTED_WORLD_KEY``: This option is used when ``GENERATE_COT=1``. It
Robin van der Gracht06b5cdb2023-09-12 11:16:23 +02001018 specifies a file that contains the Trusted World private key in PEM
1019 format or a PKCS11 URI. If ``SAVE_KEYS=1``, only a file is accepted and
1020 it will be used to save the key.
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +01001021
1022- ``TSP_INIT_ASYNC``: Choose BL32 initialization method as asynchronous or
1023 synchronous, (see "Initializing a BL32 Image" section in
1024 :ref:`Firmware Design`). It can take the value 0 (BL32 is initialized using
1025 synchronous method) or 1 (BL32 is initialized using asynchronous method).
1026 Default is 0.
1027
1028- ``TSP_NS_INTR_ASYNC_PREEMPT``: A non zero value enables the interrupt
1029 routing model which routes non-secure interrupts asynchronously from TSP
1030 to EL3 causing immediate preemption of TSP. The EL3 is responsible
1031 for saving and restoring the TSP context in this routing model. The
1032 default routing model (when the value is 0) is to route non-secure
1033 interrupts to TSP allowing it to save its context and hand over
1034 synchronously to EL3 via an SMC.
1035
1036 .. note::
1037 When ``EL3_EXCEPTION_HANDLING`` is ``1``, ``TSP_NS_INTR_ASYNC_PREEMPT``
1038 must also be set to ``1``.
1039
Manish V Badarkheb59efca2023-06-27 11:40:21 +01001040- ``TS_SP_FW_CONFIG``: DTC build flag to include Trusted Services (Crypto and
1041 internal-trusted-storage) as SP in tb_fw_config device tree.
1042
Jayanth Dodderi Chidanand4b5489c2022-03-28 15:28:55 +01001043- ``TWED_DELAY``: Numeric value to be set in order to delay the trapping of
1044 WFE instruction. ``ENABLE_FEAT_TWED`` build option must be enabled to set
1045 this delay. It can take values in the range (0-15). Default value is ``0``
1046 and based on this value, 2^(TWED_DELAY + 8) cycles will be delayed.
1047 Platforms need to explicitly update this value based on their requirements.
1048
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +01001049- ``USE_ARM_LINK``: This flag determines whether to enable support for ARM
1050 linker. When the ``LINKER`` build variable points to the armlink linker,
1051 this flag is enabled automatically. To enable support for armlink, platforms
1052 will have to provide a scatter file for the BL image. Currently, Tegra
1053 platforms use the armlink support to compile BL3-1 images.
1054
1055- ``USE_COHERENT_MEM``: This flag determines whether to include the coherent
1056 memory region in the BL memory map or not (see "Use of Coherent memory in
1057 TF-A" section in :ref:`Firmware Design`). It can take the value 1
1058 (Coherent memory region is included) or 0 (Coherent memory region is
1059 excluded). Default is 1.
1060
Louis Mayencourt6b232d92020-02-28 16:57:30 +00001061- ``ARM_IO_IN_DTB``: This flag determines whether to use IO based on the
1062 firmware configuration framework. This will move the io_policies into a
Louis Mayencourtbadcac82019-10-24 15:18:46 +01001063 configuration device tree, instead of static structure in the code base.
1064
Manish V Badarkhead339892020-06-29 10:32:53 +01001065- ``COT_DESC_IN_DTB``: This flag determines whether to create COT descriptors
1066 at runtime using fconf. If this flag is enabled, COT descriptors are
1067 statically captured in tb_fw_config file in the form of device tree nodes
1068 and properties. Currently, COT descriptors used by BL2 are moved to the
1069 device tree and COT descriptors used by BL1 are retained in the code
Manish Pandey34a305e2021-10-21 21:53:49 +01001070 base statically.
Manish V Badarkhead339892020-06-29 10:32:53 +01001071
Balint Dobszayd0dbd5e2019-12-18 15:28:00 +01001072- ``SDEI_IN_FCONF``: This flag determines whether to configure SDEI setup in
1073 runtime using firmware configuration framework. The platform specific SDEI
1074 shared and private events configuration is retrieved from device tree rather
Manish Pandey34a305e2021-10-21 21:53:49 +01001075 than static C structures at compile time. This is only supported if
1076 SDEI_SUPPORT build flag is enabled.
Louis Mayencourtbadcac82019-10-24 15:18:46 +01001077
Madhukar Pappireddy02cc3ff2020-06-02 09:26:30 -05001078- ``SEC_INT_DESC_IN_FCONF``: This flag determines whether to configure Group 0
1079 and Group1 secure interrupts using the firmware configuration framework. The
1080 platform specific secure interrupt property descriptor is retrieved from
1081 device tree in runtime rather than depending on static C structure at compile
Manish Pandey34a305e2021-10-21 21:53:49 +01001082 time.
Madhukar Pappireddy02cc3ff2020-06-02 09:26:30 -05001083
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +01001084- ``USE_ROMLIB``: This flag determines whether library at ROM will be used.
1085 This feature creates a library of functions to be placed in ROM and thus
1086 reduces SRAM usage. Refer to :ref:`Library at ROM` for further details. Default
1087 is 0.
1088
1089- ``V``: Verbose build. If assigned anything other than 0, the build commands
1090 are printed. Default is 0.
1091
1092- ``VERSION_STRING``: String used in the log output for each TF-A image.
1093 Defaults to a string formed by concatenating the version number, build type
1094 and build string.
1095
1096- ``W``: Warning level. Some compiler warning options of interest have been
1097 regrouped and put in the root Makefile. This flag can take the values 0 to 3,
1098 each level enabling more warning options. Default is 0.
1099
Boyan Karatoteve9e7e8a2022-12-07 10:26:48 +00001100 This option is closely related to the ``E`` option, which enables
1101 ``-Werror``.
1102
1103 - ``W=0`` (default)
1104
1105 Enables a wide assortment of warnings, most notably ``-Wall`` and
1106 ``-Wextra``, as well as various bad practices and things that are likely to
1107 result in errors. Includes some compiler specific flags. No warnings are
1108 expected at this level for any build.
1109
1110 - ``W=1``
1111
1112 Enables warnings we want the generic build to include but are too time
1113 consuming to fix at the moment. It re-enables warnings taken out for
1114 ``W=0`` builds (a few of the ``-Wextra`` additions). This level is expected
1115 to eventually be merged into ``W=0``. Some warnings are expected on some
1116 builds, but new contributions should not introduce new ones.
1117
1118 - ``W=2`` (recommended)
1119
1120 Enables warnings we want the generic build to include but cannot be enabled
1121 due to external libraries. This level is expected to eventually be merged
1122 into ``W=0``. Lots of warnings are expected, primarily from external
1123 libraries like zlib and compiler-rt, but new controbutions should not
1124 introduce new ones.
1125
1126 - ``W=3``
1127
1128 Enables warnings that are informative but not necessary and generally too
1129 verbose and frequently ignored. A very large number of warnings are
1130 expected.
1131
1132 The exact set of warning flags depends on the compiler and TF-A warning
1133 level, however they are all succinctly set in the top-level Makefile. Please
1134 refer to the `GCC`_ or `Clang`_ documentation for more information on the
1135 individual flags.
1136
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +01001137- ``WARMBOOT_ENABLE_DCACHE_EARLY`` : Boolean option to enable D-cache early on
1138 the CPU after warm boot. This is applicable for platforms which do not
1139 require interconnect programming to enable cache coherency (eg: single
1140 cluster platforms). If this option is enabled, then warm boot path
1141 enables D-caches immediately after enabling MMU. This option defaults to 0.
1142
Manish V Badarkhe75c972a2020-03-22 05:06:38 +00001143- ``SUPPORT_STACK_MEMTAG``: This flag determines whether to enable memory
1144 tagging for stack or not. It accepts 2 values: ``yes`` and ``no``. The
1145 default value of this flag is ``no``. Note this option must be enabled only
1146 for ARM architecture greater than Armv8.5-A.
1147
Manish V Badarkhea59fa012020-07-31 08:38:49 +01001148- ``ERRATA_SPECULATIVE_AT``: This flag determines whether to enable ``AT``
1149 speculative errata workaround or not. It accepts 2 values: ``1`` and ``0``.
1150 The default value of this flag is ``0``.
1151
1152 ``AT`` speculative errata workaround disables stage1 page table walk for
1153 lower ELs (EL1 and EL0) in EL3 so that ``AT`` speculative fetch at any point
1154 produces either the correct result or failure without TLB allocation.
Manish V Badarkhe2801ed42020-04-28 04:53:32 +01001155
1156 This boolean option enables errata for all below CPUs.
1157
Manish V Badarkhea59fa012020-07-31 08:38:49 +01001158 +---------+--------------+-------------------------+
1159 | Errata | CPU | Workaround Define |
1160 +=========+==============+=========================+
1161 | 1165522 | Cortex-A76 | ``ERRATA_A76_1165522`` |
1162 +---------+--------------+-------------------------+
1163 | 1319367 | Cortex-A72 | ``ERRATA_A72_1319367`` |
1164 +---------+--------------+-------------------------+
1165 | 1319537 | Cortex-A57 | ``ERRATA_A57_1319537`` |
1166 +---------+--------------+-------------------------+
1167 | 1530923 | Cortex-A55 | ``ERRATA_A55_1530923`` |
1168 +---------+--------------+-------------------------+
1169 | 1530924 | Cortex-A53 | ``ERRATA_A53_1530924`` |
1170 +---------+--------------+-------------------------+
1171
1172 .. note::
1173 This option is enabled by build only if platform sets any of above defines
1174 mentioned in ’Workaround Define' column in the table.
1175 If this option is enabled for the EL3 software then EL2 software also must
1176 implement this workaround due to the behaviour of the errata mentioned
1177 in new SDEN document which will get published soon.
Manish V Badarkhe2801ed42020-04-28 04:53:32 +01001178
Manish Pandey7c6fcb42022-09-27 14:30:34 +01001179- ``RAS_TRAP_NS_ERR_REC_ACCESS``: This flag enables/disables the SCR_EL3.TERR
Varun Wadekar92234852020-06-12 10:11:28 -07001180 bit, to trap access to the RAS ERR and RAS ERX registers from lower ELs.
1181 This flag is disabled by default.
1182
Juan Pablo Conde52865522022-06-28 16:56:32 -04001183- ``OPENSSL_DIR``: This option is used to provide the path to a directory on the
1184 host machine where a custom installation of OpenSSL is located, which is used
1185 to build the certificate generation, firmware encryption and FIP tools. If
1186 this option is not set, the default OS installation will be used.
Manish V Badarkhe3589b702020-07-29 10:58:44 +01001187
Madhukar Pappireddy7a554a12020-08-12 13:18:19 -05001188- ``USE_SP804_TIMER``: Use the SP804 timer instead of the Generic Timer for
1189 functions that wait for an arbitrary time length (udelay and mdelay). The
1190 default value is 0.
1191
Jayanth Dodderi Chidanand69316752022-05-09 12:33:03 +01001192- ``ENABLE_BRBE_FOR_NS``: Numeric value to enable access to the branch record
1193 buffer registers from NS ELs when FEAT_BRBE is implemented. BRBE is an
1194 optional architectural feature for AArch64. This flag can take the values
Andre Przywara9563c502023-11-23 16:40:13 +00001195 0 to 2, to align with the ``ENABLE_FEAT`` mechanism. The default is 0
Jayanth Dodderi Chidanand69316752022-05-09 12:33:03 +01001196 and it is automatically disabled when the target architecture is AArch32.
johpow0181865962022-01-28 17:06:20 -06001197
Jayanth Dodderi Chidananda793ccc2022-05-19 14:08:28 +01001198- ``ENABLE_TRBE_FOR_NS``: Numeric value to enable access of trace buffer
Manish V Badarkhe20df29c2021-07-02 09:10:56 +01001199 control registers from NS ELs, NS-EL2 or NS-EL1(when NS-EL2 is implemented
1200 but unused) when FEAT_TRBE is implemented. TRBE is an optional architectural
Jayanth Dodderi Chidananda793ccc2022-05-19 14:08:28 +01001201 feature for AArch64. This flag can take the values 0 to 2, to align with the
Andre Przywara9563c502023-11-23 16:40:13 +00001202 ``ENABLE_FEAT`` mechanism. The default is 0 and it is automatically
Jayanth Dodderi Chidananda793ccc2022-05-19 14:08:28 +01001203 disabled when the target architecture is AArch32.
Manish V Badarkhe20df29c2021-07-02 09:10:56 +01001204
Andre Przywara44e33e02022-11-17 16:42:09 +00001205- ``ENABLE_SYS_REG_TRACE_FOR_NS``: Numeric value to enable trace system
Manish V Badarkhef356f7e2021-06-29 11:44:20 +01001206 registers access from NS ELs, NS-EL2 or NS-EL1 (when NS-EL2 is implemented
1207 but unused). This feature is available if trace unit such as ETMv4.x, and
Andre Przywara44e33e02022-11-17 16:42:09 +00001208 ETE(extending ETM feature) is implemented. This flag can take the values
Andre Przywara9563c502023-11-23 16:40:13 +00001209 0 to 2, to align with the ``ENABLE_FEAT`` mechanism. The default is 0.
Manish V Badarkhef356f7e2021-06-29 11:44:20 +01001210
Jayanth Dodderi Chidanand38b461a2022-02-28 23:41:41 +00001211- ``ENABLE_TRF_FOR_NS``: Numeric value to enable trace filter control registers
Manish V Badarkhe51a97112021-07-08 09:33:18 +01001212 access from NS ELs, NS-EL2 or NS-EL1 (when NS-EL2 is implemented but unused),
Jayanth Dodderi Chidanand38b461a2022-02-28 23:41:41 +00001213 if FEAT_TRF is implemented. This flag can take the values 0 to 2, to align
Andre Przywara9563c502023-11-23 16:40:13 +00001214 with the ``ENABLE_FEAT`` mechanism. This flag is disabled by default.
Manish V Badarkhe51a97112021-07-08 09:33:18 +01001215
Okash Khawaja037b56e2022-11-04 12:38:01 +00001216- ``CONDITIONAL_CMO``: Boolean option to enable call to platform-defined routine
1217 ``plat_can_cmo`` which will return zero if cache management operations should
1218 be skipped and non-zero otherwise. By default, this option is disabled which
1219 means platform hook won't be checked and CMOs will always be performed when
1220 related functions are called.
1221
Sona Mathew6315c582023-03-15 09:40:36 -05001222- ``ERRATA_ABI_SUPPORT``: Boolean option to enable support for Errata management
1223 firmware interface for the BL31 image. By default its disabled (``0``).
1224
1225- ``ERRATA_NON_ARM_INTERCONNECT``: Boolean option to enable support for the
1226 errata mitigation for platforms with a non-arm interconnect using the errata
1227 ABI. By default its disabled (``0``).
1228
Sandrine Bailleuxf57e2032023-10-11 08:38:00 +02001229- ``ENABLE_CONSOLE_GETC``: Boolean option to enable `getc()` feature in console
1230 driver(s). By default it is disabled (``0``) because it constitutes an attack
1231 vector into TF-A by potentially allowing an attacker to inject arbitrary data.
1232 This option should only be enabled on a need basis if there is a use case for
1233 reading characters from the console.
1234
Alexei Fedorov84f1b5d2020-03-23 18:45:17 +00001235GICv3 driver options
1236--------------------
1237
1238GICv3 driver files are included using directive:
1239
1240``include drivers/arm/gic/v3/gicv3.mk``
1241
1242The driver can be configured with the following options set in the platform
1243makefile:
1244
Andre Przywarae1cc1302020-03-25 15:50:38 +00001245- ``GICV3_SUPPORT_GIC600``: Add support for the GIC-600 variants of GICv3.
1246 Enabling this option will add runtime detection support for the
1247 GIC-600, so is safe to select even for a GIC500 implementation.
1248 This option defaults to 0.
Alexei Fedorov84f1b5d2020-03-23 18:45:17 +00001249
Varun Wadekareea6dc12021-05-04 16:14:09 -07001250- ``GICV3_SUPPORT_GIC600AE_FMU``: Add support for the Fault Management Unit
1251 for GIC-600 AE. Enabling this option will introduce support to initialize
1252 the FMU. Platforms should call the init function during boot to enable the
1253 FMU and its safety mechanisms. This option defaults to 0.
1254
Alexei Fedorov84f1b5d2020-03-23 18:45:17 +00001255- ``GICV3_IMPL_GIC600_MULTICHIP``: Selects GIC-600 variant with multichip
1256 functionality. This option defaults to 0
1257
1258- ``GICV3_OVERRIDE_DISTIF_PWR_OPS``: Allows override of default implementation
1259 of ``arm_gicv3_distif_pre_save`` and ``arm_gicv3_distif_post_restore``
1260 functions. This is required for FVP platform which need to simulate GIC save
1261 and restore during SYSTEM_SUSPEND without powering down GIC. Default is 0.
1262
Alexei Fedorov19705932020-04-06 19:00:35 +01001263- ``GIC_ENABLE_V4_EXTN`` : Enables GICv4 related changes in GICv3 driver.
1264 This option defaults to 0.
1265
Alexei Fedorova6e6ae02020-04-06 16:27:54 +01001266- ``GIC_EXT_INTID``: When set to ``1``, GICv3 driver will support extended
1267 PPI (1056-1119) and SPI (4096-5119) range. This option defaults to 0.
1268
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +01001269Debugging options
1270-----------------
1271
1272To compile a debug version and make the build more verbose use
1273
1274.. code:: shell
1275
1276 make PLAT=<platform> DEBUG=1 V=1 all
1277
Daniel Boulbydf83a832022-05-03 16:46:16 +01001278AArch64 GCC 11 uses DWARF version 5 debugging symbols by default. Some tools
1279(for example Arm-DS) might not support this and may need an older version of
1280DWARF symbols to be emitted by GCC. This can be achieved by using the
1281``-gdwarf-<version>`` flag, with the version being set to 2, 3, 4 or 5. Setting
1282the version to 4 is recommended for Arm-DS.
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +01001283
1284When debugging logic problems it might also be useful to disable all compiler
1285optimizations by using ``-O0``.
1286
1287.. warning::
1288 Using ``-O0`` could cause output images to be larger and base addresses
1289 might need to be recalculated (see the **Memory layout on Arm development
1290 platforms** section in the :ref:`Firmware Design`).
1291
1292Extra debug options can be passed to the build system by setting ``CFLAGS`` or
1293``LDFLAGS``:
1294
1295.. code:: shell
1296
1297 CFLAGS='-O0 -gdwarf-2' \
1298 make PLAT=<platform> DEBUG=1 V=1 all
1299
1300Note that using ``-Wl,`` style compilation driver options in ``CFLAGS`` will be
1301ignored as the linker is called directly.
1302
1303It is also possible to introduce an infinite loop to help in debugging the
1304post-BL2 phase of TF-A. This can be done by rebuilding BL1 with the
1305``SPIN_ON_BL1_EXIT=1`` build flag. Refer to the :ref:`build_options_common`
1306section. In this case, the developer may take control of the target using a
Daniel Boulbydf83a832022-05-03 16:46:16 +01001307debugger when indicated by the console output. When using Arm-DS, the following
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +01001308commands can be used:
1309
1310::
1311
1312 # Stop target execution
1313 interrupt
1314
1315 #
1316 # Prepare your debugging environment, e.g. set breakpoints
1317 #
1318
1319 # Jump over the debug loop
1320 set var $AARCH64::$Core::$PC = $AARCH64::$Core::$PC + 4
1321
1322 # Resume execution
1323 continue
1324
Olivier Deprezb6cd6702023-11-03 11:49:47 +01001325.. _build_options_experimental:
1326
1327Experimental build options
1328---------------------------
1329
1330Common build options
1331~~~~~~~~~~~~~~~~~~~~
1332
Manish V Badarkhe9e3deb22024-05-22 14:06:00 +01001333- ``DICE_PROTECTION_ENVIRONMENT``: Boolean flag to specify the measured boot
1334 backend when ``MEASURED_BOOT`` is enabled. The default value is ``0``. When
1335 set to ``1`` then measurements and additional metadata collected during the
1336 measured boot process are sent to the DICE Protection Environment for storage
1337 and processing. A certificate chain, which represents the boot state of the
1338 device, can be queried from the DPE.
1339
Olivier Deprezb6cd6702023-11-03 11:49:47 +01001340- ``DRTM_SUPPORT``: Boolean flag to enable support for Dynamic Root of Trust
1341 for Measurement (DRTM). This feature has trust dependency on BL31 for taking
1342 the measurements and recording them as per `PSA DRTM specification`_. For
1343 platforms which use BL2 to load/authenticate BL31 ``TRUSTED_BOARD_BOOT`` can
1344 be used and for the platforms which use ``RESET_TO_BL31`` platform owners
1345 should have mechanism to authenticate BL31. This option defaults to 0.
1346
1347- ``ENABLE_RME``: Numeric value to enable support for the ARMv9 Realm
1348 Management Extension. This flag can take the values 0 to 2, to align with
Andre Przywara9563c502023-11-23 16:40:13 +00001349 the ``ENABLE_FEAT`` mechanism. Default value is 0.
Olivier Deprezb6cd6702023-11-03 11:49:47 +01001350
Raghu Krishnamurthy5c737302024-10-13 17:22:43 -07001351- ``RMMD_ENABLE_EL3_TOKEN_SIGN``: Numeric value to enable support for singing
1352 realm attestation token signing requests in EL3. This flag can take the
1353 values 0 and 1. The default value is ``0``. When set to ``1``, this option
1354 enables additional RMMD SMCs to push and pop requests for signing to
1355 EL3 along with platform hooks that must be implemented to service those
1356 requests and responses.
1357
Olivier Deprezb6cd6702023-11-03 11:49:47 +01001358- ``ENABLE_SME_FOR_NS``: Numeric value to enable Scalable Matrix Extension
1359 (SME), SVE, and FPU/SIMD for the non-secure world only. These features share
1360 registers so are enabled together. Using this option without
1361 ENABLE_SME_FOR_SWD=1 will cause SME, SVE, and FPU/SIMD instructions in secure
1362 world to trap to EL3. Requires ``ENABLE_SVE_FOR_NS`` to be set as SME is a
1363 superset of SVE. SME is an optional architectural feature for AArch64.
1364 At this time, this build option cannot be used on systems that have
1365 SPD=spmd/SPM_MM and atempting to build with this option will fail.
Andre Przywara9563c502023-11-23 16:40:13 +00001366 This flag can take the values 0 to 2, to align with the ``ENABLE_FEAT``
Olivier Deprezb6cd6702023-11-03 11:49:47 +01001367 mechanism. Default is 0.
1368
1369- ``ENABLE_SME2_FOR_NS``: Numeric value to enable Scalable Matrix Extension
1370 version 2 (SME2) for the non-secure world only. SME2 is an optional
1371 architectural feature for AArch64.
1372 This should be set along with ENABLE_SME_FOR_NS=1, if not, the default SME
1373 accesses will still be trapped. This flag can take the values 0 to 2, to
Andre Przywara9563c502023-11-23 16:40:13 +00001374 align with the ``ENABLE_FEAT`` mechanism. Default is 0.
Olivier Deprezb6cd6702023-11-03 11:49:47 +01001375
1376- ``ENABLE_SME_FOR_SWD``: Boolean option to enable the Scalable Matrix
1377 Extension for secure world. Used along with SVE and FPU/SIMD.
1378 ENABLE_SME_FOR_NS and ENABLE_SVE_FOR_SWD must also be set to use this.
1379 Default is 0.
1380
1381- ``ENABLE_SPMD_LP`` : This boolean option is used jointly with the SPM
1382 Dispatcher option (``SPD=spmd``). When enabled (1) it indicates support
1383 for logical partitions in EL3, managed by the SPMD as defined in the
1384 FF-A v1.2 specification. This flag is disabled by default. This flag
1385 must not be used if ``SPMC_AT_EL3`` is enabled.
1386
1387- ``FEATURE_DETECTION``: Boolean option to enable the architectural features
Andre Przywara9563c502023-11-23 16:40:13 +00001388 verification mechanism. This is a debug feature that compares the
1389 architectural features enabled through the feature specific build flags
1390 (ENABLE_FEAT_xxx) with the features actually available on the CPU running,
1391 and reports any discrepancies.
1392 This flag will also enable errata ordering checking for ``DEBUG`` builds.
Olivier Deprezb6cd6702023-11-03 11:49:47 +01001393
Andre Przywara9563c502023-11-23 16:40:13 +00001394 It is expected that this feature is only used for flexible platforms like
1395 software emulators, or for hardware platforms at bringup time, to verify
1396 that the configured feature set matches the CPU.
1397 The ``FEATURE_DETECTION`` macro is disabled by default.
Olivier Deprezb6cd6702023-11-03 11:49:47 +01001398
1399- ``PSA_CRYPTO``: Boolean option for enabling MbedTLS PSA crypto APIs support.
1400 The platform will use PSA compliant Crypto APIs during authentication and
1401 image measurement process by enabling this option. It uses APIs defined as
1402 per the `PSA Crypto API specification`_. This feature is only supported if
1403 using MbedTLS 3.x version. It is disabled (``0``) by default.
1404
1405- ``TRANSFER_LIST``: Setting this to ``1`` enables support for Firmware
1406 Handoff using Transfer List defined in `Firmware Handoff specification`_.
1407 This defaults to ``0``. Current implementation follows the Firmware Handoff
1408 specification v0.9.
1409
1410- ``USE_DEBUGFS``: When set to 1 this option exposes a virtual filesystem
1411 interface through BL31 as a SiP SMC function.
1412 Default is disabled (0).
1413
Manish V Badarkhe5c101ae2021-03-16 11:14:19 +00001414Firmware update options
Olivier Deprezb6cd6702023-11-03 11:49:47 +01001415~~~~~~~~~~~~~~~~~~~~~~~
1416
1417- ``PSA_FWU_SUPPORT``: Enable the firmware update mechanism as per the
1418 `PSA FW update specification`_. The default value is 0.
1419 PSA firmware update implementation has few limitations, such as:
1420
1421 - BL2 is not part of the protocol-updatable images. If BL2 needs to
1422 be updated, then it should be done through another platform-defined
1423 mechanism.
1424
1425 - It assumes the platform's hardware supports CRC32 instructions.
Manish V Badarkhe5c101ae2021-03-16 11:14:19 +00001426
1427- ``NR_OF_FW_BANKS``: Define the number of firmware banks. This flag is used
1428 in defining the firmware update metadata structure. This flag is by default
1429 set to '2'.
1430
1431- ``NR_OF_IMAGES_IN_FW_BANK``: Define the number of firmware images in each
1432 firmware bank. Each firmware bank must have the same number of images as per
1433 the `PSA FW update specification`_.
1434 This flag is used in defining the firmware update metadata structure. This
1435 flag is by default set to '1'.
1436
Sughosh Ganu401970b2024-02-01 12:42:40 +05301437- ``PSA_FWU_METADATA_FW_STORE_DESC``: To be enabled when the FWU
1438 metadata contains image description. The default value is 1.
1439
1440 The version 2 of the FWU metadata allows for an opaque metadata
1441 structure where a platform can choose to not include the firmware
1442 store description in the metadata structure. This option indicates
1443 if the firmware store description, which provides information on
1444 the updatable images is part of the structure.
1445
Paul Beesleyd2fcc4e2019-05-29 13:59:40 +01001446--------------
1447
Govindraj Raja24d3a4e2023-12-21 13:57:49 -06001448*Copyright (c) 2019-2024, Arm Limited. All rights reserved.*
Jeremy Linton684a0792021-01-26 22:42:03 -06001449
1450.. _DEN0115: https://developer.arm.com/docs/den0115/latest
Sughosh Ganuf01e1e72024-02-01 12:25:09 +05301451.. _PSA FW update specification: https://developer.arm.com/documentation/den0118/latest/
Manish V Badarkhe8564f772022-02-14 18:31:16 +00001452.. _PSA DRTM specification: https://developer.arm.com/documentation/den0113/a
Boyan Karatoteve9e7e8a2022-12-07 10:26:48 +00001453.. _GCC: https://gcc.gnu.org/onlinedocs/gcc/Warning-Options.html
1454.. _Clang: https://clang.llvm.org/docs/DiagnosticsReference.html
Raymond Mao98983392023-07-25 07:53:35 -07001455.. _Firmware Handoff specification: https://github.com/FirmwareHandoff/firmware_handoff/releases/tag/v0.9
Manish V Badarkhe78e14f82023-09-06 09:08:28 +01001456.. _PSA Crypto API specification: https://armmbed.github.io/mbed-crypto/html/