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 11Build Host 12---------- 13 14|TF-A| can be built using either a Linux or a Windows machine as the build host. 15 16A relatively recent Linux distribution is recommended for building |TF-A|. We 17have performed tests using Ubuntu 20.04 LTS (64-bit) but other distributions 18should also work fine as a base, provided that the necessary tools and libraries 19can be installed. 20 21.. _prerequisites_toolchain: 22 23Toolchain 24--------- 25 26|TF-A| can be built with any of the following *cross-compiler* toolchains that 27target the Armv7-A or Armv8-A architectures: 28 29- GCC >= 11.3.Rel1 (from the `Arm Developer website`_) 30 31 You will need the targets ``arm-none-eabi`` and ``aarch64-none-elf`` for 32 AArch32 and AArch64 builds respectively. 33 34- Clang == 14.0.0 35- Arm Compiler == 6.18 36 37In addition, a native compiler is required to build the supporting tools. 38 39.. note:: 40 Versions greater than the ones specified are likely but not guaranteed to 41 work. This is predominantly because TF-A carries its own copy of compiler-rt, 42 which may be older than the version expected by the compiler. Fixes and bug 43 reports are always welcome. 44 45.. note:: 46 The software has also been built on Windows 7 Enterprise SP1, using CMD.EXE, 47 Cygwin, and Msys (MinGW) shells, using version 5.3.1 of the GNU toolchain. 48 49.. note:: 50 For instructions on how to select the cross compiler refer to 51 :ref:`Performing an Initial Build`. 52 53.. _prerequisites_software_and_libraries: 54 55Software and Libraries 56---------------------- 57 58The following tools are required to obtain and build |TF-A|: 59 60- An appropriate toolchain (see :ref:`prerequisites_toolchain`) 61- GNU Make 62- Git 63 64The following libraries must be available to build one or more components or 65supporting tools: 66 67- OpenSSL >= 1.1.1 (v3.0.0 to v3.0.6 highly discouraged due to security issues) 68 69 Required to build the cert_create, encrypt_fw, and fiptool tools. 70 71 .. note:: 72 73 If using OpenSSL 3, older Linux versions may require it to be built from 74 source code, as it may not be available in the default package repositories. 75 Please refer to the OpenSSL project documentation for more information. 76 77The following libraries are required for Trusted Board Boot and Measured Boot 78support: 79 80- mbed TLS == 2.28.1 (tag: ``mbedtls-2.28.1``) 81 82These tools are optional: 83 84- Device Tree Compiler (DTC) >= 1.4.6 85 86 Needed if you want to rebuild the provided Flattened Device Tree (FDT) 87 source files (``.dts`` files). DTC is available for Linux through the package 88 repositories of most distributions. 89 90- Arm `Development Studio (Arm-DS)`_ 91 92 The standard software package used for debugging software on Arm development 93 platforms and |FVP| models. 94 95- Node.js >= 16 96 97 Highly recommended, and necessary in order to install and use the packaged 98 Git hooks and helper tools. Without these tools you will need to rely on the 99 CI for feedback on commit message conformance. 100 101Package Installation (Linux) 102^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 103 104If you are using the recommended Ubuntu distribution then you can install the 105required packages with the following command: 106 107.. code:: shell 108 109 sudo apt install build-essential git 110 111The optional packages can be installed using: 112 113.. code:: shell 114 115 sudo apt install device-tree-compiler 116 117Additionally, to install a version of Node.js compatible with TF-A's repository 118scripts, you can use the `Node Version Manager`_. To install both NVM and an 119appropriate version of Node.js, run the following **from the root directory of 120the repository**: 121 122.. code:: shell 123 124 curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash 125 exec "$SHELL" -ic "nvm install; exec $SHELL" 126 127.. _Node Version Manager: https://github.com/nvm-sh/nvm#install--update-script 128 129Supporting Files 130---------------- 131 132TF-A has been tested with pre-built binaries and file systems from `Linaro 133Release 20.01`_. Alternatively, you can build the binaries from source using 134instructions in :ref:`Performing an Initial Build`. 135 136.. _prerequisites_get_source: 137 138Getting the TF-A Source 139----------------------- 140 141Source code for |TF-A| is maintained in a Git repository hosted on 142TrustedFirmware.org. To clone this repository from the server, run the following 143in your shell: 144 145.. code:: shell 146 147 git clone "https://review.trustedfirmware.org/TF-A/trusted-firmware-a" 148 149Additional Steps for Contributors 150^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 151 152If you are planning on contributing back to TF-A, there are some things you'll 153want to know. 154 155TF-A is hosted by a `Gerrit Code Review`_ server. Gerrit requires that all 156commits include a ``Change-Id`` footer, and this footer is typically 157automatically generated by a Git hook installed by you, the developer. 158 159If you have Node.js installed already, you can automatically install this hook, 160along with any additional hooks and Javascript-based tooling that we use, by 161running from within your newly-cloned repository: 162 163.. code:: shell 164 165 npm install --no-save 166 167If you have opted **not** to install Node.js, you can install the Gerrit hook 168manually by running: 169 170.. code:: shell 171 172 curl -Lo $(git rev-parse --git-dir)/hooks/commit-msg https://review.trustedfirmware.org/tools/hooks/commit-msg 173 chmod +x $(git rev-parse --git-dir)/hooks/commit-msg 174 175You can read more about Git hooks in the *githooks* page of the Git 176documentation, available `here <https://git-scm.com/docs/githooks>`_. 177 178-------------- 179 180*Copyright (c) 2021-2022, Arm Limited. All rights reserved.* 181 182.. _Arm Developer website: https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/downloads 183.. _Gerrit Code Review: https://www.gerritcodereview.com/ 184.. _Linaro Release Notes: https://community.arm.com/dev-platforms/w/docs/226/old-release-notes 185.. _Linaro instructions: https://community.arm.com/dev-platforms/w/docs/304/arm-reference-platforms-deliverables 186.. _Development Studio (Arm-DS): https://developer.arm.com/Tools%20and%20Software/Arm%20Development%20Studio 187.. _Linaro Release 20.01: http://releases.linaro.org/members/arm/platforms/20.01 188