diff options
authorKevin Peng <kevin.peng@arm.com>2020-05-21 16:52:14 +0800
committerKevin Peng <kevin.peng@arm.com>2020-06-24 10:40:22 +0800
commit6710c8219d16e346ecfeef4f3919493d9d0bdfa9 (patch)
parentb10e07119bc0a883fe714953a35c5352b272cadb (diff)
Docs: Update docs on removing dependencies on CMSIS_5
As the dependencies on CMSIS RTX moving from CMSIS_5 to tf-m-tests, update the documents accordingly. Removed IAR specific instructions on replacing the RTX libraries. Change-Id: I46befe3264c9d65251ebe427813b7956a1500e63 Signed-off-by: Kevin Peng <kevin.peng@arm.com> Signed-off-by: TTornblom <thomas.tornblom@iar.com>
3 files changed, 9 insertions, 22 deletions
diff --git a/docs/getting_started/tfm_build_instruction.rst b/docs/getting_started/tfm_build_instruction.rst
index 121ef84cd..fd80b037e 100644
--- a/docs/getting_started/tfm_build_instruction.rst
+++ b/docs/getting_started/tfm_build_instruction.rst
@@ -29,16 +29,7 @@ Getting the source-code
cd <TF-M base folder>
git clone https://git.trustedfirmware.org/TF-M/trusted-firmware-m.git
git clone https://github.com/ARMmbed/mbed-crypto.git -b mbedcrypto-3.0.1
- git clone https://github.com/ARM-software/CMSIS_5.git -b 5.5.0
- # If CMSIS was cloned before the git-lfs dependency was installed,
- # use the following command to download the binaries.
- cd CMSIS_5 && git lfs pull
-.. Note::
- `CMSIS_5` now uses `git-lfs` for storing large size binaries so the cloning
- process has changed from previous releases. Please refer to the `CMSIS_5`
- documentation for more details.
+ git clone https://git.trustedfirmware.org/TF-M/tf-m-tests.git
.. Note::
For building with Armclang compiler version 6.10.0, please follow the note
diff --git a/docs/getting_started/tfm_build_instruction_iar.rst b/docs/getting_started/tfm_build_instruction_iar.rst
index b62d51d74..6f3953986 100644
--- a/docs/getting_started/tfm_build_instruction_iar.rst
+++ b/docs/getting_started/tfm_build_instruction_iar.rst
@@ -19,11 +19,8 @@ Notes for building with IARARM
cmake needs to be version 3.14 or newer.
The V8M IAR CMSIS_5 RTX libraries in CMSIS_5 5.5.0 has a problem and has been updated in
- CMSIS_5 5.7.0. However 5.7.0 causes link errors and is currently unsupported in tf-m. Use
- the 5.5.0 branch and replace the libraries in .../CMSIS_5/CMSIS/RTOS2/RTX/Library/IAR
- with the ones from 5.7.0.
- This will be sorted out once tf-m upgrades to use CMSIS_5 5.7.0 (or later)
+ CMSIS_5 5.7.0. The updated libraries are part of the tf-m-tests repo and no special instructions
+ are needed when the libraries from this repo are used.
For all configurations and build options some of the QCBOR tests fail due to the tests not handling
double float NaN:s according to the Arm Runtime ABI. This should be sorted out in the future.
diff --git a/docs/getting_started/tfm_sw_requirement.rst b/docs/getting_started/tfm_sw_requirement.rst
index a291e97c4..61ddb9303 100644
--- a/docs/getting_started/tfm_sw_requirement.rst
+++ b/docs/getting_started/tfm_sw_requirement.rst
@@ -128,8 +128,9 @@ 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
+And the following TF-M projects as well:
+ - `TF-M tests <https://git.trustedfirmware.org/TF-M/tf-m-tests.git>`__
Each of the listed dependencies should be placed in a common root directory
with trustedfirmware-m
@@ -137,8 +138,8 @@ with trustedfirmware-m
.. code-block:: bash
- ├── CMSIS_5
├── mbed-crypto
+ ├── tf-m-tests
└── trusted-firmware-m
.. Note::
@@ -153,7 +154,7 @@ with trustedfirmware-m
Tools for configuring and programming boards
-For stm32l5xx boards, `STM32_Programmer_CLI <https://www.st.com/en/development-tools/stm32cubeprog.html>`__
+For stm32l5xx boards, `STM32_Programmer_CLI <https://www.st.com/en/development-tools/stm32cubeprog.html>`__
is used to configure security protections and to write the code in internal flash.
A version is available for Linux and Windows host machine.
@@ -171,7 +172,6 @@ Install the following tools:
- 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)
@@ -226,7 +226,6 @@ Install the following tools:
- 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
@@ -489,7 +488,7 @@ To build the TF-M firmware the following tools are needed:
"C compiler",See `Supported C compilers`_,"Firmware"
"CMake",See `Supported CMake versions`_,
"GNU Make",See `Supported GNU make versions`_,
- "CMSIS 5",See `External dependencies`_,
+ "tf-m-tests",See `External dependencies`_,
"mbed-crypto",See `External dependencies`_,
"Python",3.x,"Firmware, User Guide"