Doc: Updating the user-guides
This documentation patch is updating the software requirements
and build instructions for the 1.0 release
* Removed win and msys2 from supported build enviroments.
* Added a note and guidance for compiling with ARMCLANG 6.10.0
* Added references between build-instructions and requirements
to improve user experiences
Change-Id: I20c70b9be208eb11b3810bf1e0dc43a4321e1229
Signed-off-by: Minos Galanakis <minos.galanakis@arm.com>
diff --git a/docs/user_guides/tfm_build_instruction.rst b/docs/user_guides/tfm_build_instruction.rst
index bb15f58..774061b 100644
--- a/docs/user_guides/tfm_build_instruction.rst
+++ b/docs/user_guides/tfm_build_instruction.rst
@@ -5,7 +5,7 @@
:doc:`software requirements <tfm_sw_requirement>`.
The external dependecies are briefly listed in the
-:ref:`docs/user_guides/tfm_build_instruction:External dependencies` section.
+:ref:`docs/user_guides/tfm_sw_requirement:External dependencies` section.
The configuration-table
:ref:`docs/user_guides/tfm_build_instruction:Configuring the build` section
@@ -36,6 +36,10 @@
process has changed from previous releases. Please refer to the `CMSIS_5`
documentation for more details.
+.. Note::
+ For building with Armclang compiler version 6.10.0, please follow the note
+ in :ref:`docs/user_guides/tfm_sw_requirement:External dependencies` section.
+
Build steps for the AN521 target platform:
==========================================
.. code-block:: bash
@@ -211,12 +215,6 @@
cmake_doc/install/doc/user_guide
*********************
-External dependencies
-*********************
-- `CMSIS_5` is used to import RTX for the example non-secure app
-- `Mbed Crypto` is used as crypto library on the secure side
-
-*********************
Configuring the build
*********************
The build configuration for TF-M is provided to the build system using command
diff --git a/docs/user_guides/tfm_sw_requirement.rst b/docs/user_guides/tfm_sw_requirement.rst
index 078ab1f..d9f0ac8 100644
--- a/docs/user_guides/tfm_sw_requirement.rst
+++ b/docs/user_guides/tfm_sw_requirement.rst
@@ -26,7 +26,6 @@
- Ubuntu 16.04 x64
- Ubuntu 18.04 x64
- - Windows 10 x64 + msys2 x64.
- Windows 10 x64 + git-bash (MinGW) + gnumake from DS-5 or msys2.
- Windows 10 x64 + Cygwin x64 (example configuration is provided for
this Windows setup only).
@@ -111,6 +110,33 @@
CMake generators other than "Unix Makefiles" may work, but are not
officially supported.
+*********************
+External dependencies
+*********************
+
+In order to build TF-M the following external projects are required:
+
+ - `Mbed Crypto library <https://github.com/ARMmbed/mbed-crypto>`__ v3.0.1
+ is used as crypto library on the secure side
+ - `CMSIS Version 5 <https://github.com/ARM-software/CMSIS_5>`__ v5.5.0
+ is used to import RTX for the example non-secure app
+
+Each of the listed dependencies should be placed in a common root directory
+with trustedfirmware-m
+
+.. code-block:: bash
+
+ .
+ ├── CMSIS_5
+ ├── mbed-crypto
+ └── trusted-firmware-m
+
+.. Note::
+ `CMSIS_5` v5.5.0 has a known issue, affecting compilation using
+ Arm Compiler v6.10. Please refer to
+ `CMSIS release notes <https://github.com/ARM-software/CMSIS_5/releases>`__.
+ for guidance.
+
**************
Example setups
**************
@@ -125,6 +151,7 @@
- DS-5 |DS5_VERSION|.
- Git tools v2.10.0
+- Git Large File Storage (git-lfs)
- CMake (see the "Supported CMake versions" chapter)
- GNU Make (see the "Supported make versions" chapter)
- Python3 and the pip package manager (from Python 3.4 it's included)
@@ -173,6 +200,7 @@
- uVision |KEIL_VERSION| or DS-5 |DS5_VERSION| (DS-5 Ultimate Edition) which
provides the Arm Compiler v6.10 compiler or GNU Arm compiler v6.3.1.
- Git client latest version (https://git-scm.com/download/win)
+- Git Large File Storage (`native Windows version <https://git-lfs.github.com/>`__,
- CMake (`native Windows version <https://cmake.org/download/>`__,
see the `Supported CMake versions`_ chapter)
- `Cygwin <https://www.cygwin.com/>`__. Tests done with version 2.877
@@ -435,6 +463,8 @@
"C compiler",See `Supported C compilers`_,"Firmware"
"CMake",See `Supported CMake versions`_,
"GNU Make",See `Supported GNU make versions`_,
+ "CMSIS 5",See `External dependencies`_,
+ "mbed-crypto",See `External dependencies`_,
"Python",3.x,"Firmware, User Guide"
"yaml",,"Firmware"
"pyasn1",,"Firmware"