build-options.rst 74 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456
  1. Build Options
  2. =============
  3. The TF-A build system supports the following build options. Unless mentioned
  4. otherwise, these options are expected to be specified at the build command
  5. line and are not to be modified in any component makefiles. Note that the
  6. build system doesn't track dependency for build options. Therefore, if any of
  7. the build options are changed from a previous build, a clean build must be
  8. performed.
  9. .. _build_options_common:
  10. Common build options
  11. --------------------
  12. - ``AARCH32_INSTRUCTION_SET``: Choose the AArch32 instruction set that the
  13. compiler should use. Valid values are T32 and A32. It defaults to T32 due to
  14. code having a smaller resulting size.
  15. - ``AARCH32_SP`` : Choose the AArch32 Secure Payload component to be built as
  16. as the BL32 image when ``ARCH=aarch32``. The value should be the path to the
  17. directory containing the SP source, relative to the ``bl32/``; the directory
  18. is expected to contain a makefile called ``<aarch32_sp-value>.mk``.
  19. - ``AMU_RESTRICT_COUNTERS``: Register reads to the group 1 counters will return
  20. zero at all but the highest implemented exception level. External
  21. memory-mapped debug accesses are unaffected by this control.
  22. The default value is 1 for all platforms.
  23. - ``ARCH`` : Choose the target build architecture for TF-A. It can take either
  24. ``aarch64`` or ``aarch32`` as values. By default, it is defined to
  25. ``aarch64``.
  26. - ``ARM_ARCH_FEATURE``: Optional Arm Architecture build option which specifies
  27. one or more feature modifiers. This option has the form ``[no]feature+...``
  28. and defaults to ``none``. It translates into compiler option
  29. ``-march=armvX[.Y]-a+[no]feature+...``. See compiler's documentation for the
  30. list of supported feature modifiers.
  31. - ``ARM_ARCH_MAJOR``: The major version of Arm Architecture to target when
  32. compiling TF-A. Its value must be numeric, and defaults to 8 . See also,
  33. *Armv8 Architecture Extensions* and *Armv7 Architecture Extensions* in
  34. :ref:`Firmware Design`.
  35. - ``ARM_ARCH_MINOR``: The minor version of Arm Architecture to target when
  36. compiling TF-A. Its value must be a numeric, and defaults to 0. See also,
  37. *Armv8 Architecture Extensions* in :ref:`Firmware Design`.
  38. - ``ARM_BL2_SP_LIST_DTS``: Path to DTS file snippet to override the hardcoded
  39. SP nodes in tb_fw_config.
  40. - ``ARM_SPMC_MANIFEST_DTS`` : path to an alternate manifest file used as the
  41. SPMC Core manifest. Valid when ``SPD=spmd`` is selected.
  42. - ``BL2``: This is an optional build option which specifies the path to BL2
  43. image for the ``fip`` target. In this case, the BL2 in the TF-A will not be
  44. built.
  45. - ``BL2U``: This is an optional build option which specifies the path to
  46. BL2U image. In this case, the BL2U in TF-A will not be built.
  47. - ``RESET_TO_BL2``: Boolean option to enable BL2 entrypoint as the CPU reset
  48. vector instead of the BL1 entrypoint. It can take the value 0 (CPU reset to BL1
  49. entrypoint) or 1 (CPU reset to BL2 entrypoint).
  50. The default value is 0.
  51. - ``BL2_RUNS_AT_EL3``: This is an implicit flag to denote that BL2 runs at EL3.
  52. While it is explicitly set to 1 when RESET_TO_BL2 is set to 1 it can also be
  53. true in a 4-world system where RESET_TO_BL2 is 0.
  54. - ``BL2_ENABLE_SP_LOAD``: Boolean option to enable loading SP packages from the
  55. FIP. Automatically enabled if ``SP_LAYOUT_FILE`` is provided.
  56. - ``BL2_IN_XIP_MEM``: In some use-cases BL2 will be stored in eXecute In Place
  57. (XIP) memory, like BL1. In these use-cases, it is necessary to initialize
  58. the RW sections in RAM, while leaving the RO sections in place. This option
  59. enable this use-case. For now, this option is only supported
  60. when RESET_TO_BL2 is set to '1'.
  61. - ``BL31``: This is an optional build option which specifies the path to
  62. BL31 image for the ``fip`` target. In this case, the BL31 in TF-A will not
  63. be built.
  64. - ``BL31_KEY``: This option is used when ``GENERATE_COT=1``. It specifies a
  65. file that contains the BL31 private key in PEM format or a PKCS11 URI. If
  66. ``SAVE_KEYS=1``, only a file is accepted and it will be used to save the key.
  67. - ``BL32``: This is an optional build option which specifies the path to
  68. BL32 image for the ``fip`` target. In this case, the BL32 in TF-A will not
  69. be built.
  70. - ``BL32_EXTRA1``: This is an optional build option which specifies the path to
  71. Trusted OS Extra1 image for the ``fip`` target.
  72. - ``BL32_EXTRA2``: This is an optional build option which specifies the path to
  73. Trusted OS Extra2 image for the ``fip`` target.
  74. - ``BL32_KEY``: This option is used when ``GENERATE_COT=1``. It specifies a
  75. file that contains the BL32 private key in PEM format or a PKCS11 URI. If
  76. ``SAVE_KEYS=1``, only a file is accepted and it will be used to save the key.
  77. - ``RMM``: This is an optional build option used when ``ENABLE_RME`` is set.
  78. It specifies the path to RMM binary for the ``fip`` target. If the RMM option
  79. is not specified, TF-A builds the TRP to load and run at R-EL2.
  80. - ``BL33``: Path to BL33 image in the host file system. This is mandatory for
  81. ``fip`` target in case TF-A BL2 is used.
  82. - ``BL33_KEY``: This option is used when ``GENERATE_COT=1``. It specifies a
  83. file that contains the BL33 private key in PEM format or a PKCS11 URI. If
  84. ``SAVE_KEYS=1``, only a file is accepted and it will be used to save the key.
  85. - ``BRANCH_PROTECTION``: Numeric value to enable ARMv8.3 Pointer Authentication
  86. and ARMv8.5 Branch Target Identification support for TF-A BL images themselves.
  87. If enabled, it is needed to use a compiler that supports the option
  88. ``-mbranch-protection``. Selects the branch protection features to use:
  89. - 0: Default value turns off all types of branch protection
  90. - 1: Enables all types of branch protection features
  91. - 2: Return address signing to its standard level
  92. - 3: Extend the signing to include leaf functions
  93. - 4: Turn on branch target identification mechanism
  94. The table below summarizes ``BRANCH_PROTECTION`` values, GCC compilation options
  95. and resulting PAuth/BTI features.
  96. +-------+--------------+-------+-----+
  97. | Value | GCC option | PAuth | BTI |
  98. +=======+==============+=======+=====+
  99. | 0 | none | N | N |
  100. +-------+--------------+-------+-----+
  101. | 1 | standard | Y | Y |
  102. +-------+--------------+-------+-----+
  103. | 2 | pac-ret | Y | N |
  104. +-------+--------------+-------+-----+
  105. | 3 | pac-ret+leaf | Y | N |
  106. +-------+--------------+-------+-----+
  107. | 4 | bti | N | Y |
  108. +-------+--------------+-------+-----+
  109. This option defaults to 0.
  110. Note that Pointer Authentication is enabled for Non-secure world
  111. irrespective of the value of this option if the CPU supports it.
  112. - ``BUILD_MESSAGE_TIMESTAMP``: String used to identify the time and date of the
  113. compilation of each build. It must be set to a C string (including quotes
  114. where applicable). Defaults to a string that contains the time and date of
  115. the compilation.
  116. - ``BUILD_STRING``: Input string for VERSION_STRING, which allows the TF-A
  117. build to be uniquely identified. Defaults to the current git commit id.
  118. - ``BUILD_BASE``: Output directory for the build. Defaults to ``./build``
  119. - ``CFLAGS``: Extra user options appended on the compiler's command line in
  120. addition to the options set by the build system.
  121. - ``COLD_BOOT_SINGLE_CPU``: This option indicates whether the platform may
  122. release several CPUs out of reset. It can take either 0 (several CPUs may be
  123. brought up) or 1 (only one CPU will ever be brought up during cold reset).
  124. Default is 0. If the platform always brings up a single CPU, there is no
  125. need to distinguish between primary and secondary CPUs and the boot path can
  126. be optimised. The ``plat_is_my_cpu_primary()`` and
  127. ``plat_secondary_cold_boot_setup()`` platform porting interfaces do not need
  128. to be implemented in this case.
  129. - ``COT``: When Trusted Boot is enabled, selects the desired chain of trust.
  130. Defaults to ``tbbr``.
  131. - ``CRASH_REPORTING``: A non-zero value enables a console dump of processor
  132. register state when an unexpected exception occurs during execution of
  133. BL31. This option defaults to the value of ``DEBUG`` - i.e. by default
  134. this is only enabled for a debug build of the firmware.
  135. - ``CREATE_KEYS``: This option is used when ``GENERATE_COT=1``. It tells the
  136. certificate generation tool to create new keys in case no valid keys are
  137. present or specified. Allowed options are '0' or '1'. Default is '1'.
  138. - ``CTX_INCLUDE_AARCH32_REGS`` : Boolean option that, when set to 1, will cause
  139. the AArch32 system registers to be included when saving and restoring the
  140. CPU context. The option must be set to 0 for AArch64-only platforms (that
  141. is on hardware that does not implement AArch32, or at least not at EL1 and
  142. higher ELs). Default value is 1.
  143. - ``CTX_INCLUDE_FPREGS``: Boolean option that, when set to 1, will cause the FP
  144. registers to be included when saving and restoring the CPU context. Default
  145. is 0.
  146. - ``CTX_INCLUDE_MPAM_REGS``: Boolean option that, when set to 1, will cause the
  147. Memory System Resource Partitioning and Monitoring (MPAM)
  148. registers to be included when saving and restoring the CPU context.
  149. Default is '0'.
  150. - ``CTX_INCLUDE_NEVE_REGS``: Numeric value, when set will cause the Armv8.4-NV
  151. registers to be saved/restored when entering/exiting an EL2 execution
  152. context. This flag can take values 0 to 2, to align with the
  153. ``ENABLE_FEAT`` mechanism. Default value is 0.
  154. - ``CTX_INCLUDE_PAUTH_REGS``: Numeric value to enable the Pointer
  155. Authentication for Secure world. This will cause the ARMv8.3-PAuth registers
  156. to be included when saving and restoring the CPU context as part of world
  157. switch. This flag can take values 0 to 2, to align with ``ENABLE_FEAT``
  158. mechanism. Default value is 0.
  159. Note that Pointer Authentication is enabled for Non-secure world irrespective
  160. of the value of this flag if the CPU supports it.
  161. - ``CTX_INCLUDE_SVE_REGS``: Boolean option that, when set to 1, will cause the
  162. SVE registers to be included when saving and restoring the CPU context. Note
  163. that this build option requires ``ENABLE_SVE_FOR_SWD`` to be enabled. In
  164. general, it is recommended to perform SVE context management in lower ELs
  165. and skip in EL3 due to the additional cost of maintaining large data
  166. structures to track the SVE state. Hence, the default value is 0.
  167. - ``DEBUG``: Chooses between a debug and release build. It can take either 0
  168. (release) or 1 (debug) as values. 0 is the default.
  169. - ``DECRYPTION_SUPPORT``: This build flag enables the user to select the
  170. authenticated decryption algorithm to be used to decrypt firmware/s during
  171. boot. It accepts 2 values: ``aes_gcm`` and ``none``. The default value of
  172. this flag is ``none`` to disable firmware decryption which is an optional
  173. feature as per TBBR.
  174. - ``DISABLE_BIN_GENERATION``: Boolean option to disable the generation
  175. of the binary image. If set to 1, then only the ELF image is built.
  176. 0 is the default.
  177. - ``DISABLE_MTPMU``: Numeric option to disable ``FEAT_MTPMU`` (Multi Threaded
  178. PMU). ``FEAT_MTPMU`` is an optional feature available on Armv8.6 onwards.
  179. This flag can take values 0 to 2, to align with the ``ENABLE_FEAT``
  180. mechanism. Default is ``0``.
  181. - ``DYN_DISABLE_AUTH``: Provides the capability to dynamically disable Trusted
  182. Board Boot authentication at runtime. This option is meant to be enabled only
  183. for development platforms. ``TRUSTED_BOARD_BOOT`` flag must be set if this
  184. flag has to be enabled. 0 is the default.
  185. - ``E``: Boolean option to make warnings into errors. Default is 1.
  186. When specifying higher warnings levels (``W=1`` and higher), this option
  187. defaults to 0. This is done to encourage contributors to use them, as they
  188. are expected to produce warnings that would otherwise fail the build. New
  189. contributions are still expected to build with ``W=0`` and ``E=1`` (the
  190. default).
  191. - ``EARLY_CONSOLE``: This option is used to enable early traces before default
  192. console is properly setup. It introduces EARLY_* traces macros, that will
  193. use the non-EARLY traces macros if the flag is enabled, or do nothing
  194. otherwise. To use this feature, platforms will have to create the function
  195. plat_setup_early_console().
  196. Default is 0 (disabled)
  197. - ``EL3_PAYLOAD_BASE``: This option enables booting an EL3 payload instead of
  198. the normal boot flow. It must specify the entry point address of the EL3
  199. payload. Please refer to the "Booting an EL3 payload" section for more
  200. details.
  201. - ``ENABLE_AMU_AUXILIARY_COUNTERS``: Enables support for AMU auxiliary counters
  202. (also known as group 1 counters). These are implementation-defined counters,
  203. and as such require additional platform configuration. Default is 0.
  204. - ``ENABLE_AMU_FCONF``: Enables configuration of the AMU through FCONF, which
  205. allows platforms with auxiliary counters to describe them via the
  206. ``HW_CONFIG`` device tree blob. Default is 0.
  207. - ``ENABLE_ASSERTIONS``: This option controls whether or not calls to ``assert()``
  208. are compiled out. For debug builds, this option defaults to 1, and calls to
  209. ``assert()`` are left in place. For release builds, this option defaults to 0
  210. and calls to ``assert()`` function are compiled out. This option can be set
  211. independently of ``DEBUG``. It can also be used to hide any auxiliary code
  212. that is only required for the assertion and does not fit in the assertion
  213. itself.
  214. - ``ENABLE_BACKTRACE``: This option controls whether to enable backtrace
  215. dumps or not. It is supported in both AArch64 and AArch32. However, in
  216. AArch32 the format of the frame records are not defined in the AAPCS and they
  217. are defined by the implementation. This implementation of backtrace only
  218. supports the format used by GCC when T32 interworking is disabled. For this
  219. reason enabling this option in AArch32 will force the compiler to only
  220. generate A32 code. This option is enabled by default only in AArch64 debug
  221. builds, but this behaviour can be overridden in each platform's Makefile or
  222. in the build command line.
  223. - ``ENABLE_FEAT``
  224. The Arm architecture defines several architecture extension features,
  225. named FEAT_xxx in the architecure manual. Some of those features require
  226. setup code in higher exception levels, other features might be used by TF-A
  227. code itself.
  228. Most of the feature flags defined in the TF-A build system permit to take
  229. the values 0, 1 or 2, with the following meaning:
  230. ::
  231. ENABLE_FEAT_* = 0: Feature is disabled statically at compile time.
  232. ENABLE_FEAT_* = 1: Feature is enabled unconditionally at compile time.
  233. ENABLE_FEAT_* = 2: Feature is enabled, but checked at runtime.
  234. When setting the flag to 0, the feature is disabled during compilation,
  235. and the compiler's optimisation stage and the linker will try to remove
  236. as much of this code as possible.
  237. If it is defined to 1, the code will use the feature unconditionally, so the
  238. CPU is expected to support that feature. The FEATURE_DETECTION debug
  239. feature, if enabled, will verify this.
  240. If the feature flag is set to 2, support for the feature will be compiled
  241. in, but its existence will be checked at runtime, so it works on CPUs with
  242. or without the feature. This is mostly useful for platforms which either
  243. support multiple different CPUs, or where the CPU is configured at runtime,
  244. like in emulators.
  245. - ``ENABLE_FEAT_AMU``: Numeric value to enable Activity Monitor Unit
  246. extensions. This flag can take the values 0 to 2, to align with the
  247. ``ENABLE_FEAT`` mechanism. This is an optional architectural feature
  248. available on v8.4 onwards. Some v8.2 implementations also implement an AMU
  249. and this option can be used to enable this feature on those systems as well.
  250. This flag can take the values 0 to 2, the default is 0.
  251. - ``ENABLE_FEAT_AMUv1p1``: Numeric value to enable the ``FEAT_AMUv1p1``
  252. extension. ``FEAT_AMUv1p1`` is an optional feature available on Arm v8.6
  253. onwards. This flag can take the values 0 to 2, to align with the
  254. ``ENABLE_FEAT`` mechanism. Default value is ``0``.
  255. - ``ENABLE_FEAT_CSV2_2``: Numeric value to enable the ``FEAT_CSV2_2``
  256. extension. It allows access to the SCXTNUM_EL2 (Software Context Number)
  257. register during EL2 context save/restore operations. ``FEAT_CSV2_2`` is an
  258. optional feature available on Arm v8.0 onwards. This flag can take values
  259. 0 to 2, to align with the ``ENABLE_FEAT`` mechanism.
  260. Default value is ``0``.
  261. - ``ENABLE_FEAT_CSV2_3``: Numeric value to enable support for ``FEAT_CSV2_3``
  262. extension. This feature is supported in AArch64 state only and is an optional
  263. feature available in Arm v8.0 implementations.
  264. ``FEAT_CSV2_3`` implies the implementation of ``FEAT_CSV2_2``.
  265. The flag can take values 0 to 2, to align with the ``ENABLE_FEAT``
  266. mechanism. Default value is ``0``.
  267. - ``ENABLE_FEAT_DEBUGV8P9``: Numeric value to enable ``FEAT_DEBUGV8P9``
  268. extension which allows the ability to implement more than 16 breakpoints
  269. and/or watchpoints. This feature is mandatory from v8.9 and is optional
  270. from v8.8. This flag can take the values of 0 to 2, to align with the
  271. ``ENABLE_FEAT`` mechanism. Default value is ``0``.
  272. - ``ENABLE_FEAT_DIT``: Numeric value to enable ``FEAT_DIT`` (Data Independent
  273. Timing) extension. It allows setting the ``DIT`` bit of PSTATE in EL3.
  274. ``FEAT_DIT`` is a mandatory architectural feature and is enabled from v8.4
  275. and upwards. This flag can take the values 0 to 2, to align with the
  276. ``ENABLE_FEAT`` mechanism. Default value is ``0``.
  277. - ``ENABLE_FEAT_ECV``: Numeric value to enable support for the Enhanced Counter
  278. Virtualization feature, allowing for access to the CNTPOFF_EL2 (Counter-timer
  279. Physical Offset register) during EL2 to EL3 context save/restore operations.
  280. Its a mandatory architectural feature and is enabled from v8.6 and upwards.
  281. This flag can take the values 0 to 2, to align with the ``ENABLE_FEAT``
  282. mechanism. Default value is ``0``.
  283. - ``ENABLE_FEAT_FGT``: Numeric value to enable support for FGT (Fine Grain Traps)
  284. feature allowing for access to the HDFGRTR_EL2 (Hypervisor Debug Fine-Grained
  285. Read Trap Register) during EL2 to EL3 context save/restore operations.
  286. Its a mandatory architectural feature and is enabled from v8.6 and upwards.
  287. This flag can take the values 0 to 2, to align with the ``ENABLE_FEAT``
  288. mechanism. Default value is ``0``.
  289. - ``ENABLE_FEAT_FGT2``: Numeric value to enable support for FGT2
  290. (Fine Grain Traps 2) feature allowing for access to Fine-grained trap 2 registers
  291. during EL2 to EL3 context save/restore operations.
  292. Its an optional architectural feature and is available from v8.8 and upwards.
  293. This flag can take the values 0 to 2, to align with the ``ENABLE_FEAT``
  294. mechanism. Default value is ``0``.
  295. - ``ENABLE_FEAT_HCX``: Numeric value to set the bit SCR_EL3.HXEn in EL3 to
  296. allow access to HCRX_EL2 (extended hypervisor control register) from EL2 as
  297. well as adding HCRX_EL2 to the EL2 context save/restore operations. Its a
  298. mandatory architectural feature and is enabled from v8.7 and upwards. This
  299. flag can take the values 0 to 2, to align with the ``ENABLE_FEAT``
  300. mechanism. Default value is ``0``.
  301. - ``ENABLE_FEAT_MTE2``: Numeric value to enable Memory Tagging Extension2
  302. if the platform wants to use this feature and MTE2 is enabled at ELX.
  303. This flag can take values 0 to 2, to align with the ``ENABLE_FEAT``
  304. mechanism. Default value is ``0``.
  305. - ``ENABLE_FEAT_PAN``: Numeric value to enable the ``FEAT_PAN`` (Privileged
  306. Access Never) extension. ``FEAT_PAN`` adds a bit to PSTATE, generating a
  307. permission fault for any privileged data access from EL1/EL2 to virtual
  308. memory address, accessible at EL0, provided (HCR_EL2.E2H=1). It is a
  309. mandatory architectural feature and is enabled from v8.1 and upwards. This
  310. flag can take values 0 to 2, to align with the ``ENABLE_FEAT``
  311. mechanism. Default value is ``0``.
  312. - ``ENABLE_FEAT_RNG``: Numeric value to enable the ``FEAT_RNG`` extension.
  313. ``FEAT_RNG`` is an optional feature available on Arm v8.5 onwards. This
  314. flag can take the values 0 to 2, to align with the ``ENABLE_FEAT``
  315. mechanism. Default value is ``0``.
  316. - ``ENABLE_FEAT_RNG_TRAP``: Numeric value to enable the ``FEAT_RNG_TRAP``
  317. extension. This feature is only supported in AArch64 state. This flag can
  318. take values 0 to 2, to align with the ``ENABLE_FEAT`` mechanism.
  319. Default value is ``0``. ``FEAT_RNG_TRAP`` is an optional feature from
  320. Armv8.5 onwards.
  321. - ``ENABLE_FEAT_SB``: Boolean option to let the TF-A code use the ``FEAT_SB``
  322. (Speculation Barrier) instruction ``FEAT_SB`` is an optional feature and
  323. defaults to ``0`` for pre-Armv8.5 CPUs, but is mandatory for Armv8.5 or
  324. later CPUs. It is enabled from v8.5 and upwards and if needed can be
  325. overidden from platforms explicitly.
  326. - ``ENABLE_FEAT_SEL2``: Numeric value to enable the ``FEAT_SEL2`` (Secure EL2)
  327. extension. ``FEAT_SEL2`` is a mandatory feature available on Arm v8.4.
  328. This flag can take values 0 to 2, to align with the ``ENABLE_FEAT``
  329. mechanism. Default is ``0``.
  330. - ``ENABLE_FEAT_TWED``: Numeric value to enable the ``FEAT_TWED`` (Delayed
  331. trapping of WFE Instruction) extension. ``FEAT_TWED`` is a optional feature
  332. available on Arm v8.6. This flag can take values 0 to 2, to align with the
  333. ``ENABLE_FEAT`` mechanism. Default is ``0``.
  334. When ``ENABLE_FEAT_TWED`` is set to ``1``, WFE instruction trapping gets
  335. delayed by the amount of value in ``TWED_DELAY``.
  336. - ``ENABLE_FEAT_VHE``: Numeric value to enable the ``FEAT_VHE`` (Virtualization
  337. Host Extensions) extension. It allows access to CONTEXTIDR_EL2 register
  338. during EL2 context save/restore operations.``FEAT_VHE`` is a mandatory
  339. architectural feature and is enabled from v8.1 and upwards. It can take
  340. values 0 to 2, to align with the ``ENABLE_FEAT`` mechanism.
  341. Default value is ``0``.
  342. - ``ENABLE_FEAT_TCR2``: Numeric value to set the bit SCR_EL3.ENTCR2 in EL3 to
  343. allow access to TCR2_EL2 (extended translation control) from EL2 as
  344. well as adding TCR2_EL2 to the EL2 context save/restore operations. Its a
  345. mandatory architectural feature and is enabled from v8.9 and upwards. This
  346. flag can take the values 0 to 2, to align with the ``ENABLE_FEAT``
  347. mechanism. Default value is ``0``.
  348. - ``ENABLE_FEAT_S2PIE``: Numeric value to enable support for FEAT_S2PIE
  349. at EL2 and below, and context switch relevant registers. This flag
  350. can take the values 0 to 2, to align with the ``ENABLE_FEAT``
  351. mechanism. Default value is ``0``.
  352. - ``ENABLE_FEAT_S1PIE``: Numeric value to enable support for FEAT_S1PIE
  353. at EL2 and below, and context switch relevant registers. This flag
  354. can take the values 0 to 2, to align with the ``ENABLE_FEAT``
  355. mechanism. Default value is ``0``.
  356. - ``ENABLE_FEAT_S2POE``: Numeric value to enable support for FEAT_S2POE
  357. at EL2 and below, and context switch relevant registers. This flag
  358. can take the values 0 to 2, to align with the ``ENABLE_FEAT``
  359. mechanism. Default value is ``0``.
  360. - ``ENABLE_FEAT_S1POE``: Numeric value to enable support for FEAT_S1POE
  361. at EL2 and below, and context switch relevant registers. This flag
  362. can take the values 0 to 2, to align with the ``ENABLE_FEAT``
  363. mechanism. Default value is ``0``.
  364. - ``ENABLE_FEAT_GCS``: Numeric value to set the bit SCR_EL3.GCSEn in EL3 to
  365. allow use of Guarded Control Stack from EL2 as well as adding the GCS
  366. registers to the EL2 context save/restore operations. This flag can take
  367. the values 0 to 2, to align with the ``ENABLE_FEAT`` mechanism.
  368. Default value is ``0``.
  369. - ``ENABLE_FEAT_THE``: Numeric value to enable support for FEAT_THE
  370. (Translation Hardening Extension) at EL2 and below, setting the bit
  371. SCR_EL3.RCWMASKEn in EL3 to allow access to RCWMASK_EL1 and RCWSMASK_EL1
  372. registers and context switch them.
  373. Its an optional architectural feature and is available from v8.8 and upwards.
  374. This flag can take the values 0 to 2, to align with the ``ENABLE_FEAT``
  375. mechanism. Default value is ``0``.
  376. - ``ENABLE_FEAT_SCTLR2``: Numeric value to enable support for FEAT_SCTLR2
  377. (Extension to SCTLR_ELx) at EL2 and below, setting the bit
  378. SCR_EL3.SCTLR2En in EL3 to allow access to SCTLR2_ELx registers and
  379. context switch them. This feature is OPTIONAL from Armv8.0 implementations
  380. and mandatory in Armv8.9 implementations.
  381. This flag can take the values 0 to 2, to align with the ``ENABLE_FEAT``
  382. mechanism. Default value is ``0``.
  383. - ``ENABLE_FEAT_D128``: Numeric value to enable support for FEAT_D128
  384. at EL2 and below, setting the bit SCT_EL3.D128En in EL3 to allow access to
  385. 128 bit version of system registers like PAR_EL1, TTBR0_EL1, TTBR1_EL1,
  386. TTBR0_EL2, TTBR1_EL2, TTBR0_EL12, TTBR1_EL12 , VTTBR_EL2, RCWMASK_EL1, and
  387. RCWSMASK_EL1. Its an optional architectural feature and is available from
  388. 9.3 and upwards.
  389. This flag can take the values 0 to 2, to align with the ``ENABLE_FEAT``
  390. mechanism. Default value is ``0``.
  391. - ``ENABLE_LTO``: Boolean option to enable Link Time Optimization (LTO)
  392. support in GCC for TF-A. This option is currently only supported for
  393. AArch64. Default is 0.
  394. - ``ENABLE_FEAT_MPAM``: Numeric value to enable lower ELs to use MPAM
  395. feature. MPAM is an optional Armv8.4 extension that enables various memory
  396. system components and resources to define partitions; software running at
  397. various ELs can assign themselves to desired partition to control their
  398. performance aspects.
  399. This flag can take values 0 to 2, to align with the ``ENABLE_FEAT``
  400. mechanism. When this option is set to ``1`` or ``2``, EL3 allows lower ELs to
  401. access their own MPAM registers without trapping into EL3. This option
  402. doesn't make use of partitioning in EL3, however. Platform initialisation
  403. code should configure and use partitions in EL3 as required. This option
  404. defaults to ``2`` since MPAM is enabled by default for NS world only.
  405. The flag is automatically disabled when the target
  406. architecture is AArch32.
  407. - ``ENABLE_FEAT_LS64_ACCDATA``: Numeric value to enable access and save and
  408. restore the ACCDATA_EL1 system register, at EL2 and below. This flag can
  409. take the values 0 to 2, to align with the ``ENABLE_FEAT`` mechanism.
  410. Default value is ``0``.
  411. - ``ENABLE_MPMM``: Boolean option to enable support for the Maximum Power
  412. Mitigation Mechanism supported by certain Arm cores, which allows the SoC
  413. firmware to detect and limit high activity events to assist in SoC processor
  414. power domain dynamic power budgeting and limit the triggering of whole-rail
  415. (i.e. clock chopping) responses to overcurrent conditions. Defaults to ``0``.
  416. - ``ENABLE_MPMM_FCONF``: Enables configuration of MPMM through FCONF, which
  417. allows platforms with cores supporting MPMM to describe them via the
  418. ``HW_CONFIG`` device tree blob. Default is 0.
  419. - ``ENABLE_PIE``: Boolean option to enable Position Independent Executable(PIE)
  420. support within generic code in TF-A. This option is currently only supported
  421. in BL2, BL31, and BL32 (TSP) for AARCH64 binaries, and
  422. in BL32 (SP_min) for AARCH32. Default is 0.
  423. - ``ENABLE_PMF``: Boolean option to enable support for optional Performance
  424. Measurement Framework(PMF). Default is 0.
  425. - ``ENABLE_PSCI_STAT``: Boolean option to enable support for optional PSCI
  426. functions ``PSCI_STAT_RESIDENCY`` and ``PSCI_STAT_COUNT``. Default is 0.
  427. In the absence of an alternate stat collection backend, ``ENABLE_PMF`` must
  428. be enabled. If ``ENABLE_PMF`` is set, the residency statistics are tracked in
  429. software.
  430. - ``ENABLE_RUNTIME_INSTRUMENTATION``: Boolean option to enable runtime
  431. instrumentation which injects timestamp collection points into TF-A to
  432. allow runtime performance to be measured. Currently, only PSCI is
  433. instrumented. Enabling this option enables the ``ENABLE_PMF`` build option
  434. as well. Default is 0.
  435. - ``ENABLE_SPE_FOR_NS`` : Numeric value to enable Statistical Profiling
  436. extensions. This is an optional architectural feature for AArch64.
  437. This flag can take the values 0 to 2, to align with the ``ENABLE_FEAT``
  438. mechanism. The default is 2 but is automatically disabled when the target
  439. architecture is AArch32.
  440. - ``ENABLE_SVE_FOR_NS``: Numeric value to enable Scalable Vector Extension
  441. (SVE) for the Non-secure world only. SVE is an optional architectural feature
  442. for AArch64. This flag can take the values 0 to 2, to align with the
  443. ``ENABLE_FEAT`` mechanism. At this time, this build option cannot be used on
  444. systems that have SPM_MM enabled. The default value is 2.
  445. Note that when SVE is enabled for the Non-secure world, access
  446. to SVE, SIMD and floating-point functionality from the Secure world is
  447. independently controlled by build option ``ENABLE_SVE_FOR_SWD``. When enabling
  448. ``CTX_INCLUDE_FPREGS`` and ``ENABLE_SVE_FOR_NS`` together, it is mandatory to
  449. enable ``CTX_INCLUDE_SVE_REGS``. This is to avoid corruption of the Non-secure
  450. world data in the Z-registers which are aliased by the SIMD and FP registers.
  451. - ``ENABLE_SVE_FOR_SWD``: Boolean option to enable SVE and FPU/SIMD functionality
  452. for the Secure world. SVE is an optional architectural feature for AArch64.
  453. The default is 0 and it is automatically disabled when the target architecture
  454. is AArch32.
  455. .. note::
  456. This build flag requires ``ENABLE_SVE_FOR_NS`` to be enabled. When enabling
  457. ``ENABLE_SVE_FOR_SWD``, a developer must carefully consider whether
  458. ``CTX_INCLUDE_SVE_REGS`` is also needed.
  459. - ``ENABLE_STACK_PROTECTOR``: String option to enable the stack protection
  460. checks in GCC. Allowed values are "all", "strong", "default" and "none". The
  461. default value is set to "none". "strong" is the recommended stack protection
  462. level if this feature is desired. "none" disables the stack protection. For
  463. all values other than "none", the ``plat_get_stack_protector_canary()``
  464. platform hook needs to be implemented. The value is passed as the last
  465. component of the option ``-fstack-protector-$ENABLE_STACK_PROTECTOR``.
  466. - ``ENCRYPT_BL31``: Binary flag to enable encryption of BL31 firmware. This
  467. flag depends on ``DECRYPTION_SUPPORT`` build flag.
  468. - ``ENCRYPT_BL32``: Binary flag to enable encryption of Secure BL32 payload.
  469. This flag depends on ``DECRYPTION_SUPPORT`` build flag.
  470. - ``ENC_KEY``: A 32-byte (256-bit) symmetric key in hex string format. It could
  471. either be SSK or BSSK depending on ``FW_ENC_STATUS`` flag. This value depends
  472. on ``DECRYPTION_SUPPORT`` build flag.
  473. - ``ENC_NONCE``: A 12-byte (96-bit) encryption nonce or Initialization Vector
  474. (IV) in hex string format. This value depends on ``DECRYPTION_SUPPORT``
  475. build flag.
  476. - ``ERROR_DEPRECATED``: This option decides whether to treat the usage of
  477. deprecated platform APIs, helper functions or drivers within Trusted
  478. Firmware as error. It can take the value 1 (flag the use of deprecated
  479. APIs as error) or 0. The default is 0.
  480. - ``ETHOSN_NPU_DRIVER``: boolean option to enable a SiP service that can
  481. configure an Arm® Ethos™-N NPU. To use this service the target platform's
  482. ``HW_CONFIG`` must include the device tree nodes for the NPU. Currently, only
  483. the Arm Juno platform has this included in its ``HW_CONFIG`` and the platform
  484. only loads the ``HW_CONFIG`` in AArch64 builds. Default is 0.
  485. - ``ETHOSN_NPU_TZMP1``: boolean option to enable TZMP1 support for the
  486. Arm® Ethos™-N NPU. Requires ``ETHOSN_NPU_DRIVER`` and
  487. ``TRUSTED_BOARD_BOOT`` to be enabled.
  488. - ``ETHOSN_NPU_FW``: location of the NPU firmware binary
  489. (```ethosn.bin```). This firmware image will be included in the FIP and
  490. loaded at runtime.
  491. - ``EL3_EXCEPTION_HANDLING``: When set to ``1``, enable handling of exceptions
  492. targeted at EL3. When set ``0`` (default), no exceptions are expected or
  493. handled at EL3, and a panic will result. The exception to this rule is when
  494. ``SPMD_SPM_AT_SEL2`` is set to ``1``, in which case, only exceptions
  495. occuring during normal world execution, are trapped to EL3. Any exception
  496. trapped during secure world execution are trapped to the SPMC. This is
  497. supported only for AArch64 builds.
  498. - ``EVENT_LOG_LEVEL``: Chooses the log level to use for Measured Boot when
  499. ``MEASURED_BOOT`` is enabled. For a list of valid values, see ``LOG_LEVEL``.
  500. Default value is 40 (LOG_LEVEL_INFO).
  501. - ``FAULT_INJECTION_SUPPORT``: ARMv8.4 extensions introduced support for fault
  502. injection from lower ELs, and this build option enables lower ELs to use
  503. Error Records accessed via System Registers to inject faults. This is
  504. applicable only to AArch64 builds.
  505. This feature is intended for testing purposes only, and is advisable to keep
  506. disabled for production images.
  507. - ``FIP_NAME``: This is an optional build option which specifies the FIP
  508. filename for the ``fip`` target. Default is ``fip.bin``.
  509. - ``FWU_FIP_NAME``: This is an optional build option which specifies the FWU
  510. FIP filename for the ``fwu_fip`` target. Default is ``fwu_fip.bin``.
  511. - ``FW_ENC_STATUS``: Top level firmware's encryption numeric flag, values:
  512. ::
  513. 0: Encryption is done with Secret Symmetric Key (SSK) which is common
  514. for a class of devices.
  515. 1: Encryption is done with Binding Secret Symmetric Key (BSSK) which is
  516. unique per device.
  517. This flag depends on ``DECRYPTION_SUPPORT`` build flag.
  518. - ``GENERATE_COT``: Boolean flag used to build and execute the ``cert_create``
  519. tool to create certificates as per the Chain of Trust described in
  520. :ref:`Trusted Board Boot`. The build system then calls ``fiptool`` to
  521. include the certificates in the FIP and FWU_FIP. Default value is '0'.
  522. Specify both ``TRUSTED_BOARD_BOOT=1`` and ``GENERATE_COT=1`` to include support
  523. for the Trusted Board Boot feature in the BL1 and BL2 images, to generate
  524. the corresponding certificates, and to include those certificates in the
  525. FIP and FWU_FIP.
  526. Note that if ``TRUSTED_BOARD_BOOT=0`` and ``GENERATE_COT=1``, the BL1 and BL2
  527. images will not include support for Trusted Board Boot. The FIP will still
  528. include the corresponding certificates. This FIP can be used to verify the
  529. Chain of Trust on the host machine through other mechanisms.
  530. Note that if ``TRUSTED_BOARD_BOOT=1`` and ``GENERATE_COT=0``, the BL1 and BL2
  531. images will include support for Trusted Board Boot, but the FIP and FWU_FIP
  532. will not include the corresponding certificates, causing a boot failure.
  533. - ``GICV2_G0_FOR_EL3``: Unlike GICv3, the GICv2 architecture doesn't have
  534. inherent support for specific EL3 type interrupts. Setting this build option
  535. to ``1`` assumes GICv2 *Group 0* interrupts are expected to target EL3, both
  536. by :ref:`platform abstraction layer<platform Interrupt Controller API>` and
  537. :ref:`Interrupt Management Framework<Interrupt Management Framework>`.
  538. This allows GICv2 platforms to enable features requiring EL3 interrupt type.
  539. This also means that all GICv2 Group 0 interrupts are delivered to EL3, and
  540. the Secure Payload interrupts needs to be synchronously handed over to Secure
  541. EL1 for handling. The default value of this option is ``0``, which means the
  542. Group 0 interrupts are assumed to be handled by Secure EL1.
  543. - ``HANDLE_EA_EL3_FIRST_NS``: When set to ``1``, External Aborts and SError
  544. Interrupts, resulting from errors in NS world, will be always trapped in
  545. EL3 i.e. in BL31 at runtime. When set to ``0`` (default), these exceptions
  546. will be trapped in the current exception level (or in EL1 if the current
  547. exception level is EL0).
  548. - ``HW_ASSISTED_COHERENCY``: On most Arm systems to-date, platform-specific
  549. software operations are required for CPUs to enter and exit coherency.
  550. However, newer systems exist where CPUs' entry to and exit from coherency
  551. is managed in hardware. Such systems require software to only initiate these
  552. operations, and the rest is managed in hardware, minimizing active software
  553. management. In such systems, this boolean option enables TF-A to carry out
  554. build and run-time optimizations during boot and power management operations.
  555. This option defaults to 0 and if it is enabled, then it implies
  556. ``WARMBOOT_ENABLE_DCACHE_EARLY`` is also enabled.
  557. If this flag is disabled while the platform which TF-A is compiled for
  558. includes cores that manage coherency in hardware, then a compilation error is
  559. generated. This is based on the fact that a system cannot have, at the same
  560. time, cores that manage coherency in hardware and cores that don't. In other
  561. words, a platform cannot have, at the same time, cores that require
  562. ``HW_ASSISTED_COHERENCY=1`` and cores that require
  563. ``HW_ASSISTED_COHERENCY=0``.
  564. Note that, when ``HW_ASSISTED_COHERENCY`` is enabled, version 2 of
  565. translation library (xlat tables v2) must be used; version 1 of translation
  566. library is not supported.
  567. - ``IMPDEF_SYSREG_TRAP``: Numeric value to enable the handling traps for
  568. implementation defined system register accesses from lower ELs. Default
  569. value is ``0``.
  570. - ``INVERTED_MEMMAP``: memmap tool print by default lower addresses at the
  571. bottom, higher addresses at the top. This build flag can be set to '1' to
  572. invert this behavior. Lower addresses will be printed at the top and higher
  573. addresses at the bottom.
  574. - ``KEY_ALG``: This build flag enables the user to select the algorithm to be
  575. used for generating the PKCS keys and subsequent signing of the certificate.
  576. It accepts 5 values: ``rsa``, ``rsa_1_5``, ``ecdsa``, ``ecdsa-brainpool-regular``
  577. and ``ecdsa-brainpool-twisted``. The option ``rsa_1_5`` is the legacy PKCS#1
  578. RSA 1.5 algorithm which is not TBBR compliant and is retained only for
  579. compatibility. The default value of this flag is ``rsa`` which is the TBBR
  580. compliant PKCS#1 RSA 2.1 scheme.
  581. - ``KEY_SIZE``: This build flag enables the user to select the key size for
  582. the algorithm specified by ``KEY_ALG``. The valid values for ``KEY_SIZE``
  583. depend on the chosen algorithm and the cryptographic module.
  584. +---------------------------+------------------------------------+
  585. | KEY_ALG | Possible key sizes |
  586. +===========================+====================================+
  587. | rsa | 1024 , 2048 (default), 3072, 4096 |
  588. +---------------------------+------------------------------------+
  589. | ecdsa | 256 (default), 384 |
  590. +---------------------------+------------------------------------+
  591. | ecdsa-brainpool-regular | unavailable |
  592. +---------------------------+------------------------------------+
  593. | ecdsa-brainpool-twisted | unavailable |
  594. +---------------------------+------------------------------------+
  595. - ``HASH_ALG``: This build flag enables the user to select the secure hash
  596. algorithm. It accepts 3 values: ``sha256``, ``sha384`` and ``sha512``.
  597. The default value of this flag is ``sha256``.
  598. - ``LDFLAGS``: Extra user options appended to the linkers' command line in
  599. addition to the one set by the build system.
  600. - ``LOG_LEVEL``: Chooses the log level, which controls the amount of console log
  601. output compiled into the build. This should be one of the following:
  602. ::
  603. 0 (LOG_LEVEL_NONE)
  604. 10 (LOG_LEVEL_ERROR)
  605. 20 (LOG_LEVEL_NOTICE)
  606. 30 (LOG_LEVEL_WARNING)
  607. 40 (LOG_LEVEL_INFO)
  608. 50 (LOG_LEVEL_VERBOSE)
  609. All log output up to and including the selected log level is compiled into
  610. the build. The default value is 40 in debug builds and 20 in release builds.
  611. - ``MEASURED_BOOT``: Boolean flag to include support for the Measured Boot
  612. feature. This flag can be enabled with ``TRUSTED_BOARD_BOOT`` in order to
  613. provide trust that the code taking the measurements and recording them has
  614. not been tampered with.
  615. This option defaults to 0.
  616. - ``MARCH_DIRECTIVE``: used to pass a -march option from the platform build
  617. options to the compiler. An example usage:
  618. .. code:: make
  619. MARCH_DIRECTIVE := -march=armv8.5-a
  620. - ``HARDEN_SLS``: used to pass -mharden-sls=all from the TF-A build
  621. options to the compiler currently supporting only of the options.
  622. GCC documentation:
  623. https://gcc.gnu.org/onlinedocs/gcc/AArch64-Options.html#index-mharden-sls
  624. An example usage:
  625. .. code:: make
  626. HARDEN_SLS := 1
  627. This option defaults to 0.
  628. - ``NON_TRUSTED_WORLD_KEY``: This option is used when ``GENERATE_COT=1``. It
  629. specifies a file that contains the Non-Trusted World private key in PEM
  630. format or a PKCS11 URI. If ``SAVE_KEYS=1``, only a file is accepted and it
  631. will be used to save the key.
  632. - ``NS_BL2U``: Path to NS_BL2U image in the host file system. This image is
  633. optional. It is only needed if the platform makefile specifies that it
  634. is required in order to build the ``fwu_fip`` target.
  635. - ``NS_TIMER_SWITCH``: Enable save and restore for non-secure timer register
  636. contents upon world switch. It can take either 0 (don't save and restore) or
  637. 1 (do save and restore). 0 is the default. An SPD may set this to 1 if it
  638. wants the timer registers to be saved and restored.
  639. - ``OVERRIDE_LIBC``: This option allows platforms to override the default libc
  640. for the BL image. It can be either 0 (include) or 1 (remove). The default
  641. value is 0.
  642. - ``PL011_GENERIC_UART``: Boolean option to indicate the PL011 driver that
  643. the underlying hardware is not a full PL011 UART but a minimally compliant
  644. generic UART, which is a subset of the PL011. The driver will not access
  645. any register that is not part of the SBSA generic UART specification.
  646. Default value is 0 (a full PL011 compliant UART is present).
  647. - ``PLAT``: Choose a platform to build TF-A for. The chosen platform name
  648. must be subdirectory of any depth under ``plat/``, and must contain a
  649. platform makefile named ``platform.mk``. For example, to build TF-A for the
  650. Arm Juno board, select PLAT=juno.
  651. - ``PLATFORM_REPORT_CTX_MEM_USE``: Reports the context memory allocated for
  652. each core as well as the global context. The data includes the memory used
  653. by each world and each privileged exception level. This build option is
  654. applicable only for ``ARCH=aarch64`` builds. The default value is 0.
  655. - ``PRELOADED_BL33_BASE``: This option enables booting a preloaded BL33 image
  656. instead of the normal boot flow. When defined, it must specify the entry
  657. point address for the preloaded BL33 image. This option is incompatible with
  658. ``EL3_PAYLOAD_BASE``. If both are defined, ``EL3_PAYLOAD_BASE`` has priority
  659. over ``PRELOADED_BL33_BASE``.
  660. - ``PRESERVE_DSU_PMU_REGS``: This options when enabled allows the platform to
  661. save/restore the DynamIQ Shared Unit's(DSU) Performance Monitoring Unit(PMU)
  662. registers when the cluster goes through a power cycle. This is disabled by
  663. default and platforms that require this feature have to enable them.
  664. - ``PROGRAMMABLE_RESET_ADDRESS``: This option indicates whether the reset
  665. vector address can be programmed or is fixed on the platform. It can take
  666. either 0 (fixed) or 1 (programmable). Default is 0. If the platform has a
  667. programmable reset address, it is expected that a CPU will start executing
  668. code directly at the right address, both on a cold and warm reset. In this
  669. case, there is no need to identify the entrypoint on boot and the boot path
  670. can be optimised. The ``plat_get_my_entrypoint()`` platform porting interface
  671. does not need to be implemented in this case.
  672. - ``PSCI_EXTENDED_STATE_ID``: As per PSCI1.0 Specification, there are 2 formats
  673. possible for the PSCI power-state parameter: original and extended State-ID
  674. formats. This flag if set to 1, configures the generic PSCI layer to use the
  675. extended format. The default value of this flag is 0, which means by default
  676. the original power-state format is used by the PSCI implementation. This flag
  677. should be specified by the platform makefile and it governs the return value
  678. of PSCI_FEATURES API for CPU_SUSPEND smc function id. When this option is
  679. enabled on Arm platforms, the option ``ARM_RECOM_STATE_ID_ENC`` needs to be
  680. set to 1 as well.
  681. - ``PSCI_OS_INIT_MODE``: Boolean flag to enable support for optional PSCI
  682. OS-initiated mode. This option defaults to 0.
  683. - ``ENABLE_FEAT_RAS``: Boolean flag to enable Armv8.2 RAS features. RAS features
  684. are an optional extension for pre-Armv8.2 CPUs, but are mandatory for Armv8.2
  685. or later CPUs. This flag can take the values 0 or 1. The default value is 0.
  686. NOTE: This flag enables use of IESB capability to reduce entry latency into
  687. EL3 even when RAS error handling is not performed on the platform. Hence this
  688. flag is recommended to be turned on Armv8.2 and later CPUs.
  689. - ``RESET_TO_BL31``: Enable BL31 entrypoint as the CPU reset vector instead
  690. of the BL1 entrypoint. It can take the value 0 (CPU reset to BL1
  691. entrypoint) or 1 (CPU reset to BL31 entrypoint).
  692. The default value is 0.
  693. - ``RESET_TO_SP_MIN``: SP_MIN is the minimal AArch32 Secure Payload provided
  694. in TF-A. This flag configures SP_MIN entrypoint as the CPU reset vector
  695. instead of the BL1 entrypoint. It can take the value 0 (CPU reset to BL1
  696. entrypoint) or 1 (CPU reset to SP_MIN entrypoint). The default value is 0.
  697. - ``RME_GPT_BITLOCK_BLOCK``: This defines the block size (in number of 512MB
  698. - blocks) covered by a single bit of the bitlock structure during RME GPT
  699. - operations. The lower the block size, the better opportunity for
  700. - parallelising GPT operations but at the cost of more bits being needed
  701. - for the bitlock structure. This numeric parameter can take the values
  702. - from 0 to 512 and must be a power of 2. The value of 0 is special and
  703. - and it chooses a single spinlock for all GPT L1 table entries. Default
  704. - value is 1 which corresponds to block size of 512MB per bit of bitlock
  705. - structure.
  706. - ``RME_GPT_MAX_BLOCK``: Numeric value in MB to define the maximum size of
  707. supported contiguous blocks in GPT Library. This parameter can take the
  708. values 0, 2, 32 and 512. Setting this value to 0 disables use of Contigious
  709. descriptors. Default value is 512.
  710. - ``ROT_KEY``: This option is used when ``GENERATE_COT=1``. It specifies a
  711. file that contains the ROT private key in PEM format or a PKCS11 URI and
  712. enforces public key hash generation. If ``SAVE_KEYS=1``, only a file is
  713. accepted and it will be used to save the key.
  714. - ``SAVE_KEYS``: This option is used when ``GENERATE_COT=1``. It tells the
  715. certificate generation tool to save the keys used to establish the Chain of
  716. Trust. Allowed options are '0' or '1'. Default is '0' (do not save).
  717. - ``SCP_BL2``: Path to SCP_BL2 image in the host file system. This image is optional.
  718. If a SCP_BL2 image is present then this option must be passed for the ``fip``
  719. target.
  720. - ``SCP_BL2_KEY``: This option is used when ``GENERATE_COT=1``. It specifies a
  721. file that contains the SCP_BL2 private key in PEM format or a PKCS11 URI.
  722. If ``SAVE_KEYS=1``, only a file is accepted and it will be used to save the key.
  723. - ``SCP_BL2U``: Path to SCP_BL2U image in the host file system. This image is
  724. optional. It is only needed if the platform makefile specifies that it
  725. is required in order to build the ``fwu_fip`` target.
  726. - ``SDEI_SUPPORT``: Setting this to ``1`` enables support for Software
  727. Delegated Exception Interface to BL31 image. This defaults to ``0``.
  728. When set to ``1``, the build option ``EL3_EXCEPTION_HANDLING`` must also be
  729. set to ``1``.
  730. - ``SEPARATE_CODE_AND_RODATA``: Whether code and read-only data should be
  731. isolated on separate memory pages. This is a trade-off between security and
  732. memory usage. See "Isolating code and read-only data on separate memory
  733. pages" section in :ref:`Firmware Design`. This flag is disabled by default
  734. and affects all BL images.
  735. - ``SEPARATE_NOBITS_REGION``: Setting this option to ``1`` allows the NOBITS
  736. sections of BL31 (.bss, stacks, page tables, and coherent memory) to be
  737. allocated in RAM discontiguous from the loaded firmware image. When set, the
  738. platform is expected to provide definitions for ``BL31_NOBITS_BASE`` and
  739. ``BL31_NOBITS_LIMIT``. When the option is ``0`` (the default), NOBITS
  740. sections are placed in RAM immediately following the loaded firmware image.
  741. - ``SEPARATE_BL2_NOLOAD_REGION``: Setting this option to ``1`` allows the
  742. NOLOAD sections of BL2 (.bss, stacks, page tables) to be allocated in RAM
  743. discontiguous from loaded firmware images. When set, the platform need to
  744. provide definitions of ``BL2_NOLOAD_START`` and ``BL2_NOLOAD_LIMIT``. This
  745. flag is disabled by default and NOLOAD sections are placed in RAM immediately
  746. following the loaded firmware image.
  747. - ``SEPARATE_SIMD_SECTION``: Setting this option to ``1`` allows the SIMD context
  748. data structures to be put in a dedicated memory region as decided by platform
  749. integrator. Default value is ``0`` which means the SIMD context is put in BSS
  750. section of EL3 firmware.
  751. - ``SMC_PCI_SUPPORT``: This option allows platforms to handle PCI configuration
  752. access requests via a standard SMCCC defined in `DEN0115`_. When combined with
  753. UEFI+ACPI this can provide a certain amount of OS forward compatibility
  754. with newer platforms that aren't ECAM compliant.
  755. - ``SPD``: Choose a Secure Payload Dispatcher component to be built into TF-A.
  756. This build option is only valid if ``ARCH=aarch64``. The value should be
  757. the path to the directory containing the SPD source, relative to
  758. ``services/spd/``; the directory is expected to contain a makefile called
  759. ``<spd-value>.mk``. The SPM Dispatcher standard service is located in
  760. services/std_svc/spmd and enabled by ``SPD=spmd``. The SPM Dispatcher
  761. cannot be enabled when the ``SPM_MM`` option is enabled.
  762. - ``SPIN_ON_BL1_EXIT``: This option introduces an infinite loop in BL1. It can
  763. take either 0 (no loop) or 1 (add a loop). 0 is the default. This loop stops
  764. execution in BL1 just before handing over to BL31. At this point, all
  765. firmware images have been loaded in memory, and the MMU and caches are
  766. turned off. Refer to the "Debugging options" section for more details.
  767. - ``SPMC_AT_EL3`` : This boolean option is used jointly with the SPM
  768. Dispatcher option (``SPD=spmd``). When enabled (1) it indicates the SPMC
  769. component runs at the EL3 exception level. The default value is ``0`` (
  770. disabled). This configuration supports pre-Armv8.4 platforms (aka not
  771. implementing the ``FEAT_SEL2`` extension).
  772. - ``SPMC_AT_EL3_SEL0_SP`` : Boolean option to enable SEL0 SP load support when
  773. ``SPMC_AT_EL3`` is enabled. The default value if ``0`` (disabled). This
  774. option cannot be enabled (``1``) when (``SPMC_AT_EL3``) is disabled.
  775. - ``SPMC_OPTEE`` : This boolean option is used jointly with the SPM
  776. Dispatcher option (``SPD=spmd``) and with ``SPMD_SPM_AT_SEL2=0`` to
  777. indicate that the SPMC at S-EL1 is OP-TEE and an OP-TEE specific loading
  778. mechanism should be used.
  779. - ``SPMD_SPM_AT_SEL2`` : This boolean option is used jointly with the SPM
  780. Dispatcher option (``SPD=spmd``). When enabled (1) it indicates the SPMC
  781. component runs at the S-EL2 exception level provided by the ``FEAT_SEL2``
  782. extension. This is the default when enabling the SPM Dispatcher. When
  783. disabled (0) it indicates the SPMC component runs at the S-EL1 execution
  784. state or at EL3 if ``SPMC_AT_EL3`` is enabled. The latter configurations
  785. support pre-Armv8.4 platforms (aka not implementing the ``FEAT_SEL2``
  786. extension).
  787. - ``SPM_MM`` : Boolean option to enable the Management Mode (MM)-based Secure
  788. Partition Manager (SPM) implementation. The default value is ``0``
  789. (disabled). This option cannot be enabled (``1``) when SPM Dispatcher is
  790. enabled (``SPD=spmd``).
  791. - ``SP_LAYOUT_FILE``: Platform provided path to JSON file containing the
  792. description of secure partitions. The build system will parse this file and
  793. package all secure partition blobs into the FIP. This file is not
  794. necessarily part of TF-A tree. Only available when ``SPD=spmd``.
  795. - ``SP_MIN_WITH_SECURE_FIQ``: Boolean flag to indicate the SP_MIN handles
  796. secure interrupts (caught through the FIQ line). Platforms can enable
  797. this directive if they need to handle such interruption. When enabled,
  798. the FIQ are handled in monitor mode and non secure world is not allowed
  799. to mask these events. Platforms that enable FIQ handling in SP_MIN shall
  800. implement the api ``sp_min_plat_fiq_handler()``. The default value is 0.
  801. - ``SVE_VECTOR_LEN``: SVE vector length to configure in ZCR_EL3.
  802. Platforms can configure this if they need to lower the hardware
  803. limit, for example due to asymmetric configuration or limitations of
  804. software run at lower ELs. The default is the architectural maximum
  805. of 2048 which should be suitable for most configurations, the
  806. hardware will limit the effective VL to the maximum physically supported
  807. VL.
  808. - ``TRNG_SUPPORT``: Setting this to ``1`` enables support for True
  809. Random Number Generator Interface to BL31 image. This defaults to ``0``.
  810. - ``TRUSTED_BOARD_BOOT``: Boolean flag to include support for the Trusted Board
  811. Boot feature. When set to '1', BL1 and BL2 images include support to load
  812. and verify the certificates and images in a FIP, and BL1 includes support
  813. for the Firmware Update. The default value is '0'. Generation and inclusion
  814. of certificates in the FIP and FWU_FIP depends upon the value of the
  815. ``GENERATE_COT`` option.
  816. .. warning::
  817. This option depends on ``CREATE_KEYS`` to be enabled. If the keys
  818. already exist in disk, they will be overwritten without further notice.
  819. - ``TRUSTED_WORLD_KEY``: This option is used when ``GENERATE_COT=1``. It
  820. specifies a file that contains the Trusted World private key in PEM
  821. format or a PKCS11 URI. If ``SAVE_KEYS=1``, only a file is accepted and
  822. it will be used to save the key.
  823. - ``TSP_INIT_ASYNC``: Choose BL32 initialization method as asynchronous or
  824. synchronous, (see "Initializing a BL32 Image" section in
  825. :ref:`Firmware Design`). It can take the value 0 (BL32 is initialized using
  826. synchronous method) or 1 (BL32 is initialized using asynchronous method).
  827. Default is 0.
  828. - ``TSP_NS_INTR_ASYNC_PREEMPT``: A non zero value enables the interrupt
  829. routing model which routes non-secure interrupts asynchronously from TSP
  830. to EL3 causing immediate preemption of TSP. The EL3 is responsible
  831. for saving and restoring the TSP context in this routing model. The
  832. default routing model (when the value is 0) is to route non-secure
  833. interrupts to TSP allowing it to save its context and hand over
  834. synchronously to EL3 via an SMC.
  835. .. note::
  836. When ``EL3_EXCEPTION_HANDLING`` is ``1``, ``TSP_NS_INTR_ASYNC_PREEMPT``
  837. must also be set to ``1``.
  838. - ``TS_SP_FW_CONFIG``: DTC build flag to include Trusted Services (Crypto and
  839. internal-trusted-storage) as SP in tb_fw_config device tree.
  840. - ``TWED_DELAY``: Numeric value to be set in order to delay the trapping of
  841. WFE instruction. ``ENABLE_FEAT_TWED`` build option must be enabled to set
  842. this delay. It can take values in the range (0-15). Default value is ``0``
  843. and based on this value, 2^(TWED_DELAY + 8) cycles will be delayed.
  844. Platforms need to explicitly update this value based on their requirements.
  845. - ``USE_ARM_LINK``: This flag determines whether to enable support for ARM
  846. linker. When the ``LINKER`` build variable points to the armlink linker,
  847. this flag is enabled automatically. To enable support for armlink, platforms
  848. will have to provide a scatter file for the BL image. Currently, Tegra
  849. platforms use the armlink support to compile BL3-1 images.
  850. - ``USE_COHERENT_MEM``: This flag determines whether to include the coherent
  851. memory region in the BL memory map or not (see "Use of Coherent memory in
  852. TF-A" section in :ref:`Firmware Design`). It can take the value 1
  853. (Coherent memory region is included) or 0 (Coherent memory region is
  854. excluded). Default is 1.
  855. - ``ARM_IO_IN_DTB``: This flag determines whether to use IO based on the
  856. firmware configuration framework. This will move the io_policies into a
  857. configuration device tree, instead of static structure in the code base.
  858. - ``COT_DESC_IN_DTB``: This flag determines whether to create COT descriptors
  859. at runtime using fconf. If this flag is enabled, COT descriptors are
  860. statically captured in tb_fw_config file in the form of device tree nodes
  861. and properties. Currently, COT descriptors used by BL2 are moved to the
  862. device tree and COT descriptors used by BL1 are retained in the code
  863. base statically.
  864. - ``SDEI_IN_FCONF``: This flag determines whether to configure SDEI setup in
  865. runtime using firmware configuration framework. The platform specific SDEI
  866. shared and private events configuration is retrieved from device tree rather
  867. than static C structures at compile time. This is only supported if
  868. SDEI_SUPPORT build flag is enabled.
  869. - ``SEC_INT_DESC_IN_FCONF``: This flag determines whether to configure Group 0
  870. and Group1 secure interrupts using the firmware configuration framework. The
  871. platform specific secure interrupt property descriptor is retrieved from
  872. device tree in runtime rather than depending on static C structure at compile
  873. time.
  874. - ``USE_ROMLIB``: This flag determines whether library at ROM will be used.
  875. This feature creates a library of functions to be placed in ROM and thus
  876. reduces SRAM usage. Refer to :ref:`Library at ROM` for further details. Default
  877. is 0.
  878. - ``V``: Verbose build. If assigned anything other than 0, the build commands
  879. are printed. Default is 0.
  880. - ``VERSION_STRING``: String used in the log output for each TF-A image.
  881. Defaults to a string formed by concatenating the version number, build type
  882. and build string.
  883. - ``W``: Warning level. Some compiler warning options of interest have been
  884. regrouped and put in the root Makefile. This flag can take the values 0 to 3,
  885. each level enabling more warning options. Default is 0.
  886. This option is closely related to the ``E`` option, which enables
  887. ``-Werror``.
  888. - ``W=0`` (default)
  889. Enables a wide assortment of warnings, most notably ``-Wall`` and
  890. ``-Wextra``, as well as various bad practices and things that are likely to
  891. result in errors. Includes some compiler specific flags. No warnings are
  892. expected at this level for any build.
  893. - ``W=1``
  894. Enables warnings we want the generic build to include but are too time
  895. consuming to fix at the moment. It re-enables warnings taken out for
  896. ``W=0`` builds (a few of the ``-Wextra`` additions). This level is expected
  897. to eventually be merged into ``W=0``. Some warnings are expected on some
  898. builds, but new contributions should not introduce new ones.
  899. - ``W=2`` (recommended)
  900. Enables warnings we want the generic build to include but cannot be enabled
  901. due to external libraries. This level is expected to eventually be merged
  902. into ``W=0``. Lots of warnings are expected, primarily from external
  903. libraries like zlib and compiler-rt, but new controbutions should not
  904. introduce new ones.
  905. - ``W=3``
  906. Enables warnings that are informative but not necessary and generally too
  907. verbose and frequently ignored. A very large number of warnings are
  908. expected.
  909. The exact set of warning flags depends on the compiler and TF-A warning
  910. level, however they are all succinctly set in the top-level Makefile. Please
  911. refer to the `GCC`_ or `Clang`_ documentation for more information on the
  912. individual flags.
  913. - ``WARMBOOT_ENABLE_DCACHE_EARLY`` : Boolean option to enable D-cache early on
  914. the CPU after warm boot. This is applicable for platforms which do not
  915. require interconnect programming to enable cache coherency (eg: single
  916. cluster platforms). If this option is enabled, then warm boot path
  917. enables D-caches immediately after enabling MMU. This option defaults to 0.
  918. - ``SUPPORT_STACK_MEMTAG``: This flag determines whether to enable memory
  919. tagging for stack or not. It accepts 2 values: ``yes`` and ``no``. The
  920. default value of this flag is ``no``. Note this option must be enabled only
  921. for ARM architecture greater than Armv8.5-A.
  922. - ``ERRATA_SPECULATIVE_AT``: This flag determines whether to enable ``AT``
  923. speculative errata workaround or not. It accepts 2 values: ``1`` and ``0``.
  924. The default value of this flag is ``0``.
  925. ``AT`` speculative errata workaround disables stage1 page table walk for
  926. lower ELs (EL1 and EL0) in EL3 so that ``AT`` speculative fetch at any point
  927. produces either the correct result or failure without TLB allocation.
  928. This boolean option enables errata for all below CPUs.
  929. +---------+--------------+-------------------------+
  930. | Errata | CPU | Workaround Define |
  931. +=========+==============+=========================+
  932. | 1165522 | Cortex-A76 | ``ERRATA_A76_1165522`` |
  933. +---------+--------------+-------------------------+
  934. | 1319367 | Cortex-A72 | ``ERRATA_A72_1319367`` |
  935. +---------+--------------+-------------------------+
  936. | 1319537 | Cortex-A57 | ``ERRATA_A57_1319537`` |
  937. +---------+--------------+-------------------------+
  938. | 1530923 | Cortex-A55 | ``ERRATA_A55_1530923`` |
  939. +---------+--------------+-------------------------+
  940. | 1530924 | Cortex-A53 | ``ERRATA_A53_1530924`` |
  941. +---------+--------------+-------------------------+
  942. .. note::
  943. This option is enabled by build only if platform sets any of above defines
  944. mentioned in ’Workaround Define' column in the table.
  945. If this option is enabled for the EL3 software then EL2 software also must
  946. implement this workaround due to the behaviour of the errata mentioned
  947. in new SDEN document which will get published soon.
  948. - ``RAS_TRAP_NS_ERR_REC_ACCESS``: This flag enables/disables the SCR_EL3.TERR
  949. bit, to trap access to the RAS ERR and RAS ERX registers from lower ELs.
  950. This flag is disabled by default.
  951. - ``OPENSSL_DIR``: This option is used to provide the path to a directory on the
  952. host machine where a custom installation of OpenSSL is located, which is used
  953. to build the certificate generation, firmware encryption and FIP tools. If
  954. this option is not set, the default OS installation will be used.
  955. - ``USE_SP804_TIMER``: Use the SP804 timer instead of the Generic Timer for
  956. functions that wait for an arbitrary time length (udelay and mdelay). The
  957. default value is 0.
  958. - ``ENABLE_BRBE_FOR_NS``: Numeric value to enable access to the branch record
  959. buffer registers from NS ELs when FEAT_BRBE is implemented. BRBE is an
  960. optional architectural feature for AArch64. This flag can take the values
  961. 0 to 2, to align with the ``ENABLE_FEAT`` mechanism. The default is 0
  962. and it is automatically disabled when the target architecture is AArch32.
  963. - ``ENABLE_TRBE_FOR_NS``: Numeric value to enable access of trace buffer
  964. control registers from NS ELs, NS-EL2 or NS-EL1(when NS-EL2 is implemented
  965. but unused) when FEAT_TRBE is implemented. TRBE is an optional architectural
  966. feature for AArch64. This flag can take the values 0 to 2, to align with the
  967. ``ENABLE_FEAT`` mechanism. The default is 0 and it is automatically
  968. disabled when the target architecture is AArch32.
  969. - ``ENABLE_SYS_REG_TRACE_FOR_NS``: Numeric value to enable trace system
  970. registers access from NS ELs, NS-EL2 or NS-EL1 (when NS-EL2 is implemented
  971. but unused). This feature is available if trace unit such as ETMv4.x, and
  972. ETE(extending ETM feature) is implemented. This flag can take the values
  973. 0 to 2, to align with the ``ENABLE_FEAT`` mechanism. The default is 0.
  974. - ``ENABLE_TRF_FOR_NS``: Numeric value to enable trace filter control registers
  975. access from NS ELs, NS-EL2 or NS-EL1 (when NS-EL2 is implemented but unused),
  976. if FEAT_TRF is implemented. This flag can take the values 0 to 2, to align
  977. with the ``ENABLE_FEAT`` mechanism. This flag is disabled by default.
  978. - ``CONDITIONAL_CMO``: Boolean option to enable call to platform-defined routine
  979. ``plat_can_cmo`` which will return zero if cache management operations should
  980. be skipped and non-zero otherwise. By default, this option is disabled which
  981. means platform hook won't be checked and CMOs will always be performed when
  982. related functions are called.
  983. - ``ERRATA_ABI_SUPPORT``: Boolean option to enable support for Errata management
  984. firmware interface for the BL31 image. By default its disabled (``0``).
  985. - ``ERRATA_NON_ARM_INTERCONNECT``: Boolean option to enable support for the
  986. errata mitigation for platforms with a non-arm interconnect using the errata
  987. ABI. By default its disabled (``0``).
  988. - ``ENABLE_CONSOLE_GETC``: Boolean option to enable `getc()` feature in console
  989. driver(s). By default it is disabled (``0``) because it constitutes an attack
  990. vector into TF-A by potentially allowing an attacker to inject arbitrary data.
  991. This option should only be enabled on a need basis if there is a use case for
  992. reading characters from the console.
  993. GICv3 driver options
  994. --------------------
  995. GICv3 driver files are included using directive:
  996. ``include drivers/arm/gic/v3/gicv3.mk``
  997. The driver can be configured with the following options set in the platform
  998. makefile:
  999. - ``GICV3_SUPPORT_GIC600``: Add support for the GIC-600 variants of GICv3.
  1000. Enabling this option will add runtime detection support for the
  1001. GIC-600, so is safe to select even for a GIC500 implementation.
  1002. This option defaults to 0.
  1003. - ``GICV3_SUPPORT_GIC600AE_FMU``: Add support for the Fault Management Unit
  1004. for GIC-600 AE. Enabling this option will introduce support to initialize
  1005. the FMU. Platforms should call the init function during boot to enable the
  1006. FMU and its safety mechanisms. This option defaults to 0.
  1007. - ``GICV3_IMPL_GIC600_MULTICHIP``: Selects GIC-600 variant with multichip
  1008. functionality. This option defaults to 0
  1009. - ``GICV3_OVERRIDE_DISTIF_PWR_OPS``: Allows override of default implementation
  1010. of ``arm_gicv3_distif_pre_save`` and ``arm_gicv3_distif_post_restore``
  1011. functions. This is required for FVP platform which need to simulate GIC save
  1012. and restore during SYSTEM_SUSPEND without powering down GIC. Default is 0.
  1013. - ``GIC_ENABLE_V4_EXTN`` : Enables GICv4 related changes in GICv3 driver.
  1014. This option defaults to 0.
  1015. - ``GIC_EXT_INTID``: When set to ``1``, GICv3 driver will support extended
  1016. PPI (1056-1119) and SPI (4096-5119) range. This option defaults to 0.
  1017. Debugging options
  1018. -----------------
  1019. To compile a debug version and make the build more verbose use
  1020. .. code:: shell
  1021. make PLAT=<platform> DEBUG=1 V=1 all
  1022. AArch64 GCC 11 uses DWARF version 5 debugging symbols by default. Some tools
  1023. (for example Arm-DS) might not support this and may need an older version of
  1024. DWARF symbols to be emitted by GCC. This can be achieved by using the
  1025. ``-gdwarf-<version>`` flag, with the version being set to 2, 3, 4 or 5. Setting
  1026. the version to 4 is recommended for Arm-DS.
  1027. When debugging logic problems it might also be useful to disable all compiler
  1028. optimizations by using ``-O0``.
  1029. .. warning::
  1030. Using ``-O0`` could cause output images to be larger and base addresses
  1031. might need to be recalculated (see the **Memory layout on Arm development
  1032. platforms** section in the :ref:`Firmware Design`).
  1033. Extra debug options can be passed to the build system by setting ``CFLAGS`` or
  1034. ``LDFLAGS``:
  1035. .. code:: shell
  1036. CFLAGS='-O0 -gdwarf-2' \
  1037. make PLAT=<platform> DEBUG=1 V=1 all
  1038. Note that using ``-Wl,`` style compilation driver options in ``CFLAGS`` will be
  1039. ignored as the linker is called directly.
  1040. It is also possible to introduce an infinite loop to help in debugging the
  1041. post-BL2 phase of TF-A. This can be done by rebuilding BL1 with the
  1042. ``SPIN_ON_BL1_EXIT=1`` build flag. Refer to the :ref:`build_options_common`
  1043. section. In this case, the developer may take control of the target using a
  1044. debugger when indicated by the console output. When using Arm-DS, the following
  1045. commands can be used:
  1046. ::
  1047. # Stop target execution
  1048. interrupt
  1049. #
  1050. # Prepare your debugging environment, e.g. set breakpoints
  1051. #
  1052. # Jump over the debug loop
  1053. set var $AARCH64::$Core::$PC = $AARCH64::$Core::$PC + 4
  1054. # Resume execution
  1055. continue
  1056. .. _build_options_experimental:
  1057. Experimental build options
  1058. ---------------------------
  1059. Common build options
  1060. ~~~~~~~~~~~~~~~~~~~~
  1061. - ``DICE_PROTECTION_ENVIRONMENT``: Boolean flag to specify the measured boot
  1062. backend when ``MEASURED_BOOT`` is enabled. The default value is ``0``. When
  1063. set to ``1`` then measurements and additional metadata collected during the
  1064. measured boot process are sent to the DICE Protection Environment for storage
  1065. and processing. A certificate chain, which represents the boot state of the
  1066. device, can be queried from the DPE.
  1067. - ``DRTM_SUPPORT``: Boolean flag to enable support for Dynamic Root of Trust
  1068. for Measurement (DRTM). This feature has trust dependency on BL31 for taking
  1069. the measurements and recording them as per `PSA DRTM specification`_. For
  1070. platforms which use BL2 to load/authenticate BL31 ``TRUSTED_BOARD_BOOT`` can
  1071. be used and for the platforms which use ``RESET_TO_BL31`` platform owners
  1072. should have mechanism to authenticate BL31. This option defaults to 0.
  1073. - ``ENABLE_RME``: Numeric value to enable support for the ARMv9 Realm
  1074. Management Extension. This flag can take the values 0 to 2, to align with
  1075. the ``ENABLE_FEAT`` mechanism. Default value is 0.
  1076. - ``RMMD_ENABLE_EL3_TOKEN_SIGN``: Numeric value to enable support for singing
  1077. realm attestation token signing requests in EL3. This flag can take the
  1078. values 0 and 1. The default value is ``0``. When set to ``1``, this option
  1079. enables additional RMMD SMCs to push and pop requests for signing to
  1080. EL3 along with platform hooks that must be implemented to service those
  1081. requests and responses.
  1082. - ``ENABLE_SME_FOR_NS``: Numeric value to enable Scalable Matrix Extension
  1083. (SME), SVE, and FPU/SIMD for the non-secure world only. These features share
  1084. registers so are enabled together. Using this option without
  1085. ENABLE_SME_FOR_SWD=1 will cause SME, SVE, and FPU/SIMD instructions in secure
  1086. world to trap to EL3. Requires ``ENABLE_SVE_FOR_NS`` to be set as SME is a
  1087. superset of SVE. SME is an optional architectural feature for AArch64.
  1088. At this time, this build option cannot be used on systems that have
  1089. SPD=spmd/SPM_MM and atempting to build with this option will fail.
  1090. This flag can take the values 0 to 2, to align with the ``ENABLE_FEAT``
  1091. mechanism. Default is 0.
  1092. - ``ENABLE_SME2_FOR_NS``: Numeric value to enable Scalable Matrix Extension
  1093. version 2 (SME2) for the non-secure world only. SME2 is an optional
  1094. architectural feature for AArch64.
  1095. This should be set along with ENABLE_SME_FOR_NS=1, if not, the default SME
  1096. accesses will still be trapped. This flag can take the values 0 to 2, to
  1097. align with the ``ENABLE_FEAT`` mechanism. Default is 0.
  1098. - ``ENABLE_SME_FOR_SWD``: Boolean option to enable the Scalable Matrix
  1099. Extension for secure world. Used along with SVE and FPU/SIMD.
  1100. ENABLE_SME_FOR_NS and ENABLE_SVE_FOR_SWD must also be set to use this.
  1101. Default is 0.
  1102. - ``ENABLE_SPMD_LP`` : This boolean option is used jointly with the SPM
  1103. Dispatcher option (``SPD=spmd``). When enabled (1) it indicates support
  1104. for logical partitions in EL3, managed by the SPMD as defined in the
  1105. FF-A v1.2 specification. This flag is disabled by default. This flag
  1106. must not be used if ``SPMC_AT_EL3`` is enabled.
  1107. - ``FEATURE_DETECTION``: Boolean option to enable the architectural features
  1108. verification mechanism. This is a debug feature that compares the
  1109. architectural features enabled through the feature specific build flags
  1110. (ENABLE_FEAT_xxx) with the features actually available on the CPU running,
  1111. and reports any discrepancies.
  1112. This flag will also enable errata ordering checking for ``DEBUG`` builds.
  1113. It is expected that this feature is only used for flexible platforms like
  1114. software emulators, or for hardware platforms at bringup time, to verify
  1115. that the configured feature set matches the CPU.
  1116. The ``FEATURE_DETECTION`` macro is disabled by default.
  1117. - ``PSA_CRYPTO``: Boolean option for enabling MbedTLS PSA crypto APIs support.
  1118. The platform will use PSA compliant Crypto APIs during authentication and
  1119. image measurement process by enabling this option. It uses APIs defined as
  1120. per the `PSA Crypto API specification`_. This feature is only supported if
  1121. using MbedTLS 3.x version. It is disabled (``0``) by default.
  1122. - ``TRANSFER_LIST``: Setting this to ``1`` enables support for Firmware
  1123. Handoff using Transfer List defined in `Firmware Handoff specification`_.
  1124. This defaults to ``0``. Current implementation follows the Firmware Handoff
  1125. specification v0.9.
  1126. - ``USE_DEBUGFS``: When set to 1 this option exposes a virtual filesystem
  1127. interface through BL31 as a SiP SMC function.
  1128. Default is disabled (0).
  1129. Firmware update options
  1130. ~~~~~~~~~~~~~~~~~~~~~~~
  1131. - ``PSA_FWU_SUPPORT``: Enable the firmware update mechanism as per the
  1132. `PSA FW update specification`_. The default value is 0.
  1133. PSA firmware update implementation has few limitations, such as:
  1134. - BL2 is not part of the protocol-updatable images. If BL2 needs to
  1135. be updated, then it should be done through another platform-defined
  1136. mechanism.
  1137. - It assumes the platform's hardware supports CRC32 instructions.
  1138. - ``NR_OF_FW_BANKS``: Define the number of firmware banks. This flag is used
  1139. in defining the firmware update metadata structure. This flag is by default
  1140. set to '2'.
  1141. - ``NR_OF_IMAGES_IN_FW_BANK``: Define the number of firmware images in each
  1142. firmware bank. Each firmware bank must have the same number of images as per
  1143. the `PSA FW update specification`_.
  1144. This flag is used in defining the firmware update metadata structure. This
  1145. flag is by default set to '1'.
  1146. - ``PSA_FWU_METADATA_FW_STORE_DESC``: To be enabled when the FWU
  1147. metadata contains image description. The default value is 1.
  1148. The version 2 of the FWU metadata allows for an opaque metadata
  1149. structure where a platform can choose to not include the firmware
  1150. store description in the metadata structure. This option indicates
  1151. if the firmware store description, which provides information on
  1152. the updatable images is part of the structure.
  1153. --------------
  1154. *Copyright (c) 2019-2024, Arm Limited. All rights reserved.*
  1155. .. _DEN0115: https://developer.arm.com/docs/den0115/latest
  1156. .. _PSA FW update specification: https://developer.arm.com/documentation/den0118/latest/
  1157. .. _PSA DRTM specification: https://developer.arm.com/documentation/den0113/a
  1158. .. _GCC: https://gcc.gnu.org/onlinedocs/gcc/Warning-Options.html
  1159. .. _Clang: https://clang.llvm.org/docs/DiagnosticsReference.html
  1160. .. _Firmware Handoff specification: https://github.com/FirmwareHandoff/firmware_handoff/releases/tag/v0.9
  1161. .. _PSA Crypto API specification: https://armmbed.github.io/mbed-crypto/html/