8. Software requirements¶
A quick reference table is included in the Tool & Dependency overview section of this document.
8.1. Supported build environments¶
TF-M officially supports a limited set of build environments and setups. In this context, official support means that the environments listed below are actively used by team members and active developers hence users should be able to recreate the same configurations by following the instructions described below. In case of problems, the TF-M team provides support only for these environments, but building in other environments can still be possible.
The following environments are supported:
Ubuntu 16.04 x64
Ubuntu 18.04 x64
Windows 10 x64
8.2. C compilers¶
To compile TF-M code, at least one of the supported compiler toolchains have to be available in the build environment. The currently supported compiler versions are:
Arm Compiler v6.10.1+, v6.11, v6.12, v6.13
GNU Arm compiler v7.3.1+
IAR Arm compiler v8.42.x, v8.50.x
Note
The Arm compilers above are provided via Keil uVision v5.25.2 or greater and Arm Development Studio 2019.1 or greater, or they can be downloaded as standalone packages from here.
The GNU Arm compiler can be downloaded from here. On the page select GNU Arm Embedded Toolchain: 6-2017-q1-update or GNU Arm Embedded Toolchain: 7-2018-q2-update
The IAR Arm compilers above are provided via IAR Embedded Workbench (Windows) or IAR build tools for linux. For information, see here or here.
8.3. CMake¶
The build-system is CMake based and supports the version 3.15 or higher.
Please use the latest build version available.
Recent versions of CMake can be downloaded from https://cmake.org/download/, and older releases are available from https://cmake.org/files.
CMake handles all external dependencies, but if you wish to alter this behaviour, see Manual dependency management
8.4. GNU make¶
TF-M project builds using the “Unix Makefiles” generator of CMake and thus GNU make is needed for the build.
On Linux please use the version available in your distribution.
On Windows, GNU make v3.81 or higher shall work fine.
CMake generators other than “Unix Makefiles” may work too, but are not officially supported. You may have a good luck with Ninja.
8.5. Tools for configuring and programming boards¶
Please follow a board secific documentation for building and programming tools.
8.6. Typical setups¶
This section lists steps to set-up TF-M build environment under Linux and Windows. Please also check the Exceptions and special cases chapter for any special requirements depending on the tools you are using.
8.6.1. Ubuntu¶
Install the following tools:
Arm DS 2019.1.
Git tools v2.10.0
CMake (see the CMake chapter)
GNU Make (see the GNU make chapter)
SRecord v1.58 (for Musca test chip boards)
Python3 and the pip package manager (from Python 3.4 it’s included)
The necessary Python3 packages are listed in the requirements.txt file. To install all needed just do:
pip install -r tools/requirements.txt
8.6.1.1. Setup environment variables in Linux¶
To import Arm Compiler v6.13 in your bash shell console:
export PATH=<ARM_DS_PATH>/sw/ARMCompiler6.13/bin:$PATH
export ARM_TOOL_VARIANT=ult
export ARM_PRODUCT_PATH=<ARM_DS_PATH>/sw/mappings
export ARMLMD_LICENSE_FILE=<LICENSE_FILE_PATH>
To import CMake in your bash shell console:
export PATH=<CMake path>/bin:$PATH
To import GNU Arm in your bash shell console:
export PATH=<bash path>/bin:$PATH
To import IAR Arm compiler in your bash shell console:
export PATH=<IAR compiler path>/bin:$PATH
8.6.2. Windows¶
Install the following tools:
uVision v5.25.2 or Arm DS 2019.1 (Arm DS Ultimate Edition) or GNU Arm compiler v7.3.1+
Git client latest version (https://git-scm.com/download/win)
CMake (native Windows version, see the CMake chapter)
GNU make
SRecord v1.63 (for Musca test chip boards)
Python3 (native Windows version) and the pip package manager (from Python 3.4 it’s included)
The necessary Python3 packages are listed in the requirements.txt file. To install all needed just do:
pip install -r tools\requirements.txt
8.6.2.1. Setup environment variables in Windows¶
Add CMake to your PATH variable:
set PATH=<CMake_Path>\bin;$PATH
There are several configurations depending on a toolset you are using. The typical cases are listed below.
8.6.2.1.1. Armclang + Arm DS¶
set PATH=<ARM_DS_PATH>\sw\ARMCompiler6.13\bin;$PATH
set ARM_PRODUCT_PATH=<ARM_DS_PATH>\sw\mappings
set ARM_TOOL_VARIANT=ult
set ARMLMD_LICENSE_FILE=<LICENSE_FILE_PATH>
8.6.2.1.2. Armclang + Keil MDK Arm¶
set PATH=<uVision path>\ARM\ARMCLANG\bin;$PATH
8.6.2.1.3. GNU Arm¶
set PATH=<GNU Arm path>\bin;$PATH
8.7. Building the documentation¶
The build system is prepared to support generation of two documents: The Reference Manual and the User Guide. The Reference Manual is Doxygen based, while the User Guide is Sphinx based. Both document can be generated in HTML and PDF format.
Support for document generation in the build environment is not mandatory. Missing document generation tools will not block building the TF-M firmware.
8.7.1. To compile the TF-M Reference Manual¶
The following additional tools are needed:
Doxygen v1.8.0 or later
Graphviz dot v2.38.0 or later
PlantUML v1.2018.11 or later
Java runtime environment 1.8 or later (for running PlantUML)
LaTeX - for PDF generation only
PdfLaTeX - for PDF generation only
8.7.1.1. Set-up the needed tools and environment in Linux¶
sudo apt-get install -y doxygen graphviz default-jre
mkdir ~/plantuml
curl -L http://sourceforge.net/projects/plantuml/files/plantuml.jar/download --output ~/plantuml/plantuml.jar
export PLANTUML_JAR_PATH=~/plantuml/plantuml.jar
For PDF generation:
sudo apt-get install -y doxygen-latex
8.7.1.2. Set-up the needed tools and environment in Windows¶
Download and install the following tools:
The Java runtime is part of the Arm DS installation or can be downloaded from here
MikTeX - for PDF generation only
Set the environment variables, assuming that:
doxygen, dot, and MikTeX binaries are available on the PATH.
Java JVM is used from Arm DS installation.
set PLANTUML_JAR_PATH=<plantuml_Path>\plantuml.jar
set PATH=$PATH;<ARM_DS_PATH>\sw\java\bin
8.7.2. To compile the TF-M User Guide¶
The following additional tools are needed:
Python3 and the following modules:
Sphinx v1.7.9
m2r v0.2.0
sphinxcontrib-plantuml
sphinx-rtd-theme
Graphviz dot v2.38.0 or later
PlantUML v1.2018.11 or later
Java runtime environment 1.8 or later (for running PlantUML)
LaTeX - for PDF generation only
PdfLaTeX - for PDF generation only
8.7.2.1. Set-up the tools and environment in Linux¶
sudo apt-get install -y python3 graphviz default-jre
pip install -r tools/requirements.txt
mkdir ~/plantuml
curl -L http://sourceforge.net/projects/plantuml/files/plantuml.jar/download --output ~/plantuml/plantuml.jar
For PDF generation:
sudo apt-get install -y doxygen-latex
export PLANTUML_JAR_PATH=~/plantuml/plantuml.jar
8.7.2.2. Set-up the tools and environment in Windows¶
Download and install the following tools:
The Java runtime is part of the Arm DS installation or can be downloaded from here
MikTeX - for PDF generation only
Python3 (native Windows version)
The necessary Python3 packages are listed in the requirements.txt file. To install all needed packages just do:
pip install -r tools\requirements.txt
Note
When building the documentation the first time, MikTeX might prompt for installing missing LaTeX components. Please allow the MikTeX package manager to set-up these.
Set the environment variables, assuming that:
plantuml.jar is available at c:\plantuml\plantuml.jar
doxygen, dot, and MikTeX binaries are available on the PATH.
Java JVM is used from DS5 installation.
set PLANTUML_JAR_PATH=<plantuml_Path>\plantuml.jar
set PATH=$PATH;<ARM_DS_PATH>\sw\java\bin
8.8. Exceptions and special cases¶
8.8.1. ArmClang¶
Arm compiler specific environment variable may need updating based on specific products and licenses as explained in product-and-toolkit-configuration.
8.8.2. MikTeX¶
When building the documentation the first time, MikTeX might prompt for installing missing LaTeX components. Please allow the MikTeX package manager to set-up these.
8.9. Tool & Dependency overview¶
To build the TF-M firmware the following tools are needed:
Name |
Version |
Component |
---|---|---|
C compiler |
See C compilers |
Firmware |
CMake |
See CMake |
|
GNU Make |
See GNU make |
|
tf-m-tests |
CMake handles it |
|
mbed-crypto |
CMake handles it |
|
MCUboot |
CMake handles it |
|
Python |
3.x |
Firmware, User Guide |
yaml |
Firmware |
|
pyasn1 |
Firmware |
|
jinja2 |
Firmware |
|
cryptography |
Firmware |
|
cbor |
Firmware |
|
click |
Firmware |
|
imgtool |
Firmware |
|
Doxygen |
>1.8 |
Reference manual |
Sphinx |
>1.4 |
User Guide |
sphinxcontrib-plantuml |
User Guide |
|
sphinx-trd-theme |
User Guide |
|
Git |
||
PlantUML |
>v1.2018.11 |
Reference Manual, User Guide |
Graphviz dot |
>v2.38.0 |
Reference manual |
Java runtime environment (JRE) |
>1.8 |
Reference Manual, User Guide |
LaTex |
pdf version of Reference Manual and User Guide |
|
PdfLaTex |
pdf version of Reference Manual and User Guide |
Dependency chain:
Copyright (c) 2017-2020, Arm Limited. All rights reserved.