docs/getting_started/build-options.rst

34 -  ``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
55 -  ``BL2``: This is an optional build option which specifies the path to BL2
59 -  ``BL2U``: This is an optional build option which specifies the path to
62 -  ``RESET_TO_BL2``: Boolean option to enable BL2 entrypoint as the CPU reset
71 -  ``BL2_ENABLE_SP_LOAD``: Boolean option to enable loading SP packages from the
76    the RW sections in RAM, while leaving the RO sections in place. This option
77    enable this use-case. For now, this option is only supported
80 -  ``BL31``: This is an optional build option which specifies the path to
84 -  ``BL31_KEY``: This option is used when ``GENERATE_COT=1``. It specifies a
88 -  ``BL32``: This is an optional build option which specifies the path to
92 -  ``BL32_EXTRA1``: This is an optional build option which specifies the path to
95 -  ``BL32_EXTRA2``: This is an optional build option which specifies the path to
98 -  ``BL32_KEY``: This option is used when ``GENERATE_COT=1``. It specifies a
102 -  ``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
109 -  ``BL33_KEY``: This option is used when ``GENERATE_COT=1``. It specifies a
115    If enabled, it is needed to use a compiler that supports the option
117    and ``ARM_ARCH_MAJOR``) option will control which instructions will be
131    | Value |  GCC option  | PAuth | BTI |
146    This option defaults to 0.
148    irrespective of the value of this option if the CPU supports it.
163 -  ``COLD_BOOT_SINGLE_CPU``: This option indicates whether the platform may
177    BL31. This option defaults to the value of ``DEBUG`` - i.e. by default
180 -  ``CREATE_KEYS``: This option is used when ``GENERATE_COT=1``. It tells the
184 -  ``CTX_INCLUDE_AARCH32_REGS`` : Boolean option that, when set to 1, will cause
186    CPU context. The option must be set to 0 for AArch64-only platforms (that
190 -  ``CTX_INCLUDE_FPREGS``: Boolean option that, when set to 1, will cause the FP
194 -  ``CTX_INCLUDE_MPAM_REGS``: Boolean option that, when set to 1, will cause the
215 -  ``CTX_INCLUDE_SVE_REGS``: Boolean option that, when set to 1, will cause the
217    that this build option requires ``ENABLE_SVE_FOR_SWD`` to be enabled. In
231 -  ``DISABLE_BIN_GENERATION``: Boolean option to disable the generation
235 -  ``DISABLE_MTPMU``: Numeric option to disable ``FEAT_MTPMU`` (Multi Threaded
241    Board Boot authentication at runtime. This option is meant to be enabled only
245 -  ``E``: Boolean option to make warnings into errors. Default is 1.
247    When specifying higher warnings levels (``W=1`` and higher), this option
253 -  ``EARLY_CONSOLE``: This option is used to enable early traces before default
260 -  ``EL3_PAYLOAD_BASE``: This option enables booting an EL3 payload instead of
269 -  ``ENABLE_ASSERTIONS``: This option controls whether or not calls to ``assert()``
270    are compiled out. For debug builds, this option defaults to 1, and calls to
271    ``assert()`` are left in place. For release builds, this option defaults to 0
272    and calls to ``assert()`` function are compiled out. This option can be set
277 -  ``ENABLE_BACKTRACE``: This option controls whether to enable backtrace
282    reason enabling this option in AArch32 will force the compiler to only
283    generate A32 code. This option is enabled by default only in AArch64 debug
291    and this option can be used to enable this feature on those systems as well.
443 -  ``ENABLE_FEAT_SB``: Boolean option to let the TF-A code use the ``FEAT_SB``
540 -  ``ENABLE_LTO``: Boolean option to enable Link Time Optimization (LTO)
541    support. This option is currently only supported for AArch64. On GCC it only
554    mechanism. When this option is set to ``1`` or ``2``, EL3 allows lower ELs to
555    access their own MPAM registers without trapping into EL3. This option
557    code should configure and use partitions in EL3 as required. This option
562 -  ``ENABLE_FEAT_MPAM_PE_BW_CTRL``: This option enables Armv9.3 MPAM
582 -  ``ENABLE_MPMM``: Boolean option to enable support for the Maximum Power
588 -  ``ENABLE_PIE``: Boolean option to enable Position Independent Executable(PIE)
589    support within generic code in TF-A. This option is currently only supported
593 -  ``ENABLE_PMF``: Boolean option to enable support for optional Performance
596 -  ``ENABLE_PSCI_STAT``: Boolean option to enable support for optional PSCI
602 -  ``ENABLE_RUNTIME_INSTRUMENTATION``: Boolean option to enable runtime
605    instrumented. Enabling this option enables the ``ENABLE_PMF`` build option
617    ``ENABLE_FEAT`` mechanism. At this time, this build option cannot be used on
622    independently controlled by build option ``ENABLE_SVE_FOR_SWD``. When enabling
627 -  ``ENABLE_SVE_FOR_SWD``: Boolean option to enable SVE and FPU/SIMD functionality
637 -  ``ENABLE_STACK_PROTECTOR``: String option to enable the stack protection
643    component of the option ``-fstack-protector-$ENABLE_STACK_PROTECTOR``.
645 - ``ENABLE_ERRATA_ALL``: This option is used only for testing purposes, Boolean
646    option to enable the workarounds for all errata that TF-A implements. Normally
648    recommended for release builds. This option is default set to 0.
664 -  ``ERROR_DEPRECATED``: This option decides whether to treat the usage of
669 -  ``ETHOSN_NPU_DRIVER``: boolean option to enable a SiP service that can
675 -  ``ETHOSN_NPU_TZMP1``: boolean option to enable TZMP1 support for the
692    injection from lower ELs, and this build option enables lower ELs to use
699 -  ``FIP_NAME``: This is an optional build option which specifies the FIP
702 -  ``FWU_FIP_NAME``: This is an optional build option which specifies the FWU
736    inherent support for specific EL3 type interrupts. Setting this build option
743    EL1 for handling. The default value of this option is ``0``, which means the
757    management. In such systems, this boolean option enables TF-A to carry out
759    This option defaults to 0 and if it is enabled, then it implies
790    and ``ecdsa-brainpool-twisted``. The option ``rsa_1_5`` is the legacy PKCS#1
815 - ``HW_CONFIG_BASE``: This option specifies the location in memory where the DTB
841    This option defaults to 0.
845    This option defaults to 0.
857 -  ``MARCH_DIRECTIVE``: used to pass a -march option from the platform build
875    This option defaults to 0.
877 -  ``NON_TRUSTED_WORLD_KEY``: This option is used when ``GENERATE_COT=1``. It
890    option has been deprecated since it breaks Linux preemption model.
892 -  ``OVERRIDE_LIBC``: This option allows platforms to override the default libc
896 -  ``PL011_GENERIC_UART``: Boolean option to indicate the PL011 driver that
909    by each world and each privileged exception level. This build option is
916 -  ``PRELOADED_BL33_BASE``: This option enables booting a preloaded BL33 image
918    point address for the preloaded BL33 image. This option is incompatible with
927 -  ``PROGRAMMABLE_RESET_ADDRESS``: This option indicates whether the reset
942    of PSCI_FEATURES API for CPU_SUSPEND smc function id. When this option is
943    enabled on Arm platforms, the option ``ARM_RECOM_STATE_ID_ENC`` needs to be
947    OS-initiated mode. This option defaults to 0.
950    optional SMCCC_ARCH_FEATURE_AVAILABILITY call. This option implicitly
951    interacts with IMPDEF_SYSREG_TRAP and software emulation. This option
986 -  ``ROT_KEY``: This option is used when ``GENERATE_COT=1``. It specifies a
991 -  ``SAVE_KEYS``: This option is used when ``GENERATE_COT=1``. It tells the
996    If a SCP_BL2 image is present then this option must be passed for the ``fip``
999 -  ``SCP_BL2_KEY``: This option is used when ``GENERATE_COT=1``. It specifies a
1010    When set to ``1``, the build option ``EL3_EXCEPTION_HANDLING`` must also be
1019 -  ``SEPARATE_NOBITS_REGION``: Setting this option to ``1`` allows the NOBITS
1023    ``BL31_NOBITS_LIMIT``. When the option is ``0`` (the default), NOBITS
1026 -  ``SEPARATE_BL2_NOLOAD_REGION``: Setting this option to ``1`` allows the
1033 -  ``SEPARATE_BL2_FIP``: This option enables the separation of the BL2 FIP image
1034    from the main FIP image. When this option is enabled, the BL2 FIP image is built
1037 -  ``SEPARATE_SIMD_SECTION``: Setting this option to ``1`` allows the SIMD context
1042 -  ``SMC_PCI_SUPPORT``: This option allows platforms to handle PCI configuration
1048    This build option is only valid if ``ARCH=aarch64``. The value should be
1053    cannot be enabled when the ``SPM_MM`` option is enabled.
1055 -  ``SPIN_ON_BL1_EXIT``: This option introduces an infinite loop in BL1. It can
1061 -  ``SPMC_AT_EL3`` : This boolean option is used jointly with the SPM
1062    Dispatcher option (``SPD=spmd``). When enabled (1) it indicates the SPMC
1067 -  ``SPMC_AT_EL3_SEL0_SP`` : Boolean option to enable SEL0 SP load support when
1069    option cannot be enabled (``1``) when (``SPMC_AT_EL3``) is disabled.
1071 -  ``SPMC_OPTEE`` : This boolean option is used jointly with the SPM
1072    Dispatcher option (``SPD=spmd``) and with ``SPMD_SPM_AT_SEL2=0`` to
1076 -  ``SPMD_SPM_AT_SEL2`` : This boolean option is used jointly with the SPM
1077    Dispatcher option (``SPD=spmd``). When enabled (1) it indicates the SPMC
1085 -  ``SPM_MM`` : Boolean option to enable the Management Mode (MM)-based Secure
1087    (disabled). This option cannot be enabled (``1``) when SPM Dispatcher is
1118    ``GENERATE_COT`` option.
1121       This option depends on ``CREATE_KEYS`` to be enabled. If the keys
1124 -  ``TRUSTED_WORLD_KEY``: This option is used when ``GENERATE_COT=1``. It
1151    WFE instruction. ``ENABLE_FEAT_TWED`` build option must be enabled to set
1168 -  ``USE_KERNEL_DT_CONVENTION``: When this option is enabled, the hardware
1170    of the Linux kernel on Arm platforms. If this option is disabled, a different
1171    register, typically x1, may be used instead. This build option is
1178    ``PRESERVE_DSU_PMU_REGS`` build option, provides access to PMU registers at
1220    This option is closely related to the ``E`` option, which enables
1257 -  ``WARMBOOT_ENABLE_DCACHE_EARLY`` : Boolean option to enable D-cache early on
1260    cluster platforms). If this option is enabled, then warm boot path
1261    enables D-caches immediately after enabling MMU. This option defaults to 0.
1271    This boolean option enables errata for all below CPUs.
1290       This option is enabled by build only if platform sets any of above defines
1292       If this option is enabled for the EL3 software then EL2 software also must
1296 - ``ERRATA_SME_POWER_DOWN``: Boolean option to disable SME (PSTATE.{ZA,SM}=0)
1306 - ``OPENSSL_DIR``: This option is used to provide the path to a directory on the
1309   this option is not set, the default OS installation will be used.
1348 - ``CONDITIONAL_CMO``: Boolean option to enable call to platform-defined routine
1350   be skipped and non-zero otherwise. By default, this option is disabled which
1354 - ``ERRATA_ABI_SUPPORT``: Boolean option to enable support for Errata management
1357 - ``ERRATA_NON_ARM_INTERCONNECT``: Boolean option to enable support for the
1361 - ``ENABLE_CONSOLE_GETC``: Boolean option to enable `getc()` feature in console
1364   This option should only be enabled on a need basis if there is a use case for
1370 The generic GIC driver can be included with the ``USE_GIC_DRIVER`` option. It is
1371 a numeric option that can take the following values:
1379    or an alternative interrupt controller design. Use of this option is strongly
1385    it. Use this option for GICv4 implementations. Requires calling
1407    Enabling this option will add runtime detection support for the
1409    This option defaults to 0.
1412    for GIC-600 AE. Enabling this option will introduce support to initialize
1414    FMU and its safety mechanisms. This option defaults to 0.
1417    functionality. This option defaults to 0
1425    This option defaults to 0.
1428    PPI (1056-1119) and SPI (4096-5119) range. This option defaults to 0.
1506    should have mechanism to authenticate BL31. This option defaults to 0.
1520    values 0 and 1. The default value is ``0``. When set to ``1``, this option
1527    registers so are enabled together. Using this option without
1531    At this time, this build option cannot be used on systems that have
1532    SPD=spmd/SPM_MM and atempting to build with this option will fail.
1543 -  ``ENABLE_SME_FOR_SWD``: Boolean option to enable the Scalable Matrix
1548 -  ``ENABLE_SPMD_LP`` : This boolean option is used jointly with the SPM
1549    Dispatcher option (``SPD=spmd``). When enabled (1) it indicates support
1554 -  ``FEATURE_DETECTION``: Boolean option to enable the architectural features
1566 -  ``PSA_CRYPTO``: Boolean option for enabling MbedTLS PSA crypto APIs support.
1568    image measurement process by enabling this option. It uses APIs defined as
1573    activation as per the specification. This option defaults to 0.
1580 -  ``USE_DEBUGFS``: When set to 1 this option exposes a virtual filesystem
1621    store description in the metadata structure. This option indicates