1Prerequisites 2============= 3 4This document describes the software requirements for building |TF-A| for 5AArch32 and AArch64 target platforms. 6 7It may possible to build |TF-A| with combinations of software packages that are 8different from those listed below, however only the software described in this 9document can be officially supported. 10 11Getting the TF-A Source 12----------------------- 13 14Source code for |TF-A| is maintained in a Git repository hosted on 15`TrustedFirmware.org`_. To clone this repository from the server, run the following 16in your shell: 17 18.. code:: shell 19 20 git clone "https://review.trustedfirmware.org/TF-A/trusted-firmware-a" 21 22 23Requirements 24------------ 25 26======================== ===================== 27 Program Min supported version 28======================== ===================== 29Arm Compiler 6.18 30Arm GNU Compiler 13.3 31Clang/LLVM 18.1.8 32Device Tree Compiler 1.6.1 33GNU make 3.81 34mbed TLS\ [#f1]_ 3.6.1 35Node.js [#f2]_ 16 36OpenSSL 1.0.0 37Poetry 1.3.2 38QCBOR\ [#f3]_ 1.2 39Sphinx\ [#f2]_ 5.3.0 40======================== ===================== 41 42.. [#f1] Required for Trusted Board Boot and Measured Boot. 43.. [#f2] Required only for building TF-A documentation. 44.. [#f3] Required only when enabling DICE Protection Environment support. 45 46Toolchain 47^^^^^^^^^ 48 49|TF-A| can be compiled using any cross-compiler toolchain specified in the 50preceding table that target Armv7-A or Armv8-A. For AArch32 and 51AArch64 builds, the respective targets required are ``arm-none-eabi`` and 52``aarch64-none-elf``. 53 54Testing has been performed with version 13.3.Rel1 (gcc 13.3) of the Arm 55GNU compiler, which can be installed from the `Arm Developer website`_. 56 57In addition, a native compiler is required to build supporting tools. 58 59.. note:: 60 Versions greater than the ones specified are likely but not guaranteed to 61 work. This is predominantly because TF-A carries its own copy of compiler-rt, 62 which may be older than the version expected by the compiler. Fixes and bug 63 reports are always welcome. 64 65.. note:: 66 For instructions on how to select the cross compiler refer to 67 :ref:`Performing an Initial Build`. 68 69OpenSSL 70^^^^^^^ 71 72OpenSSL is required to build the cert_create, encrypt_fw, and fiptool tools. 73 74If using OpenSSL 3, older Linux versions may require it to be built from 75source code, as it may not be available in the default package repositories. 76Please refer to the OpenSSL project documentation for more information. 77 78.. warning:: 79 Versions 1.0.x and from v3.0.0 up to v3.0.6 are strongly advised against due 80 to concerns regarding security vulnerabilities! 81 82Device Tree Compiler (DTC) 83^^^^^^^^^^^^^^^^^^^^^^^^^^ 84 85Needed if you want to rebuild the provided Flattened Device Tree (FDT) 86source files (``.dts`` files). DTC is available for Linux through the package 87repositories of most distributions. 88 89Arm Development Studio (`Arm-DS`_) 90^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 91 92The standard software package used for debugging software on Arm development 93platforms and |FVP| models. 94 95Node.js 96^^^^^^^ 97 98Highly recommended, and necessary in order to install and use the packaged 99Git hooks and helper tools. Without these tools you will need to rely on the 100CI for feedback on commit message conformance. 101 102Poetry 103^^^^^^ 104 105Required for managing Python dependencies, this will allow you to reliably 106reproduce a Python environment to build documentation and run some of the 107integrated Python tools. Most importantly, it ensures your system environment 108will not be affected by dependencies in the Python scripts. 109 110For installation instructions, see the `official Poetry documentation`_. 111 112.. _prerequisites_software_and_libraries: 113 114Package Installation (Linux) 115---------------------------- 116 117|TF-A| can be compiled on both Linux and Windows-based machines. 118However, we strongly recommend using a UNIX-compatible build environment. 119 120Testing is performed using Ubuntu 22.04 LTS (64-bit), but other distributions 121should also work, provided the necessary tools and libraries are installed. 122 123The following are steps to install the required packages: 124 125.. code:: shell 126 127 sudo apt install build-essential 128 129The optional packages can be installed using: 130 131.. code:: shell 132 133 sudo apt install device-tree-compiler 134 135Additionally, to install a version of Node.js compatible with TF-A's repository 136scripts, you can use the `Node Version Manager`_. To install both NVM and an 137appropriate version of Node.js, run the following **from the root directory of 138the repository**: 139 140.. code:: shell 141 142 curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash 143 exec "$SHELL" -ic "nvm install; exec $SHELL" 144 145.. _Node Version Manager: https://github.com/nvm-sh/nvm#install--update-script 146 147Supporting Files 148---------------- 149 150TF-A has been tested with pre-built binaries and file systems from `Linaro 151Release 20.01`_. Alternatively, you can build the binaries from source using 152instructions in :ref:`Performing an Initial Build`. 153 154.. _prerequisites_get_source: 155 156Additional Steps for Contributors 157^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 158 159If you are planning on contributing back to TF-A, there are some things you'll 160want to know. 161 162TF-A is hosted by a `Gerrit Code Review`_ server. Gerrit requires that all 163commits include a ``Change-Id`` footer, and this footer is typically 164automatically generated by a Git hook installed by you, the developer. 165 166If you have Node.js installed already, you can automatically install this hook, 167along with any additional hooks and Javascript-based tooling that we use, by 168running from within your newly-cloned repository: 169 170.. code:: shell 171 172 npm install --no-save 173 174If you have opted **not** to install Node.js, you can install the Gerrit hook 175manually by running: 176 177.. code:: shell 178 179 curl -Lo $(git rev-parse --git-dir)/hooks/commit-msg https://review.trustedfirmware.org/tools/hooks/commit-msg 180 chmod +x $(git rev-parse --git-dir)/hooks/commit-msg 181 182You can read more about Git hooks in the *githooks* page of the Git 183documentation, available `here <https://git-scm.com/docs/githooks>`_. 184 185-------------- 186 187*Copyright (c) 2021-2024, Arm Limited. All rights reserved.* 188 189.. _Arm Developer website: https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/downloads 190.. _Gerrit Code Review: https://www.gerritcodereview.com/ 191.. _Linaro Release Notes: https://community.arm.com/dev-platforms/w/docs/226/old-release-notes 192.. _Linaro instructions: https://community.arm.com/dev-platforms/w/docs/304/arm-reference-platforms-deliverables 193.. _Arm-DS: https://developer.arm.com/Tools%20and%20Software/Arm%20Development%20Studio 194.. _Linaro Release 20.01: http://releases.linaro.org/members/arm/platforms/20.01 195.. _TrustedFirmware.org: https://www.trustedfirmware.org/ 196.. _official Poetry documentation: https://python-poetry.org/docs/#installation 197