aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMinos Galanakis <minos.galanakis@arm.com>2020-10-15 11:10:26 +0100
committerMinos Galanakis <minos.galanakis@arm.com>2020-11-03 16:49:59 +0000
commit3b740a1af4dfa8f8314c6aef33d6ca784e7f7c68 (patch)
treeda1a74c1f82b99923e9cd3197087cc5aa7949c74 /docs
parenta8d87df9dd53f6081e6b24212e7f6d52d60075bf (diff)
downloadtrusted-firmware-m-3b740a1af4dfa8f8314c6aef33d6ca784e7f7c68.tar.gz
Docs: Updating references to DS-5, and other content
This patch is updating the references to DS-5 to Arm Development Studio. The version numbers, and user instructions have also been updated to reflect the new name. It is also adding proper documentation to the appropriate arm developer pages for each toolchain, as well as fixing other minor formatting issues across documentation Signed-off-by: Minos Galanakis <minos.galanakis@arm.com> Change-Id: I99fd4ff3f127e6fe9f1f5384245770637fe41c11
Diffstat (limited to 'docs')
-rw-r--r--docs/contributing/code_review_guide.rst2
-rw-r--r--docs/design_documents/tfm_log_system_design_document.rst2
-rw-r--r--docs/getting_started/tfm_build_instruction.rst6
-rw-r--r--docs/getting_started/tfm_secure_boot.rst4
-rw-r--r--docs/getting_started/tfm_sw_requirement.rst34
-rw-r--r--docs/getting_started/tfm_user_guide.rst37
6 files changed, 50 insertions, 35 deletions
diff --git a/docs/contributing/code_review_guide.rst b/docs/contributing/code_review_guide.rst
index ed31ea0c08..e9470e66e8 100644
--- a/docs/contributing/code_review_guide.rst
+++ b/docs/contributing/code_review_guide.rst
@@ -4,7 +4,7 @@ Code Review Guideline
The purpose of this document is to clarify design items to be reviewed during
the code review process.
-Please contact :doc:`maintainers </docs/about/maintainers>` or write an e-mail
+Please contact :doc:`maintainers </docs/contributing/maintainers>` or write an e-mail
thread on the `TF-M mailing list <mailto:tf-m@lists.trustedfirmware.org>`_ for
any questions.
diff --git a/docs/design_documents/tfm_log_system_design_document.rst b/docs/design_documents/tfm_log_system_design_document.rst
index fe40383d91..269bcfc69d 100644
--- a/docs/design_documents/tfm_log_system_design_document.rst
+++ b/docs/design_documents/tfm_log_system_design_document.rst
@@ -177,7 +177,7 @@ Here is a table about the effective APIs with different partition log level.
+------------+-------------------------------+---------------------------------+---------------------------------+---------------------------------+
| | TFM_PARTITION_LOG_LEVEL_DEBUG | TFM_PARTITION_LOG_LEVEL_INFO | TFM_PARTITION_LOG_LEVEL_ERROR | TFM_PARTITION_LOG_LEVEL_SILENCE |
-+============+===============================+=================================+=================================+---------------------------------+
++============+===============================+=================================+=================================+=================================+
| LOG_DBGFMT | Yes | No | No | No |
+------------+-------------------------------+---------------------------------+---------------------------------+---------------------------------+
| LOG_INFFMT | Yes | Yes | No | No |
diff --git a/docs/getting_started/tfm_build_instruction.rst b/docs/getting_started/tfm_build_instruction.rst
index 70e6f86863..6ca626c965 100644
--- a/docs/getting_started/tfm_build_instruction.rst
+++ b/docs/getting_started/tfm_build_instruction.rst
@@ -25,10 +25,10 @@ dependency management`
.. Note::
- - For building with Armclang compiler version 6.10.0, please follow the note
- in :ref:`docs/getting_started/tfm_sw_requirement`.
+ - For building with Armclang compiler version 6.10.0+, please follow the note
+ in :doc:`software requirements <tfm_sw_requirement>`.
- For building with the IAR toolchain, please see the notes in
- :doc:`software requirements <tfm_build_instruction_iar>`
+ :doc:`IAR software requirements <tfm_build_instruction_iar>`
.. _tfm_cmake_configuration:
diff --git a/docs/getting_started/tfm_secure_boot.rst b/docs/getting_started/tfm_secure_boot.rst
index 61be329ce9..0aaabc37ea 100644
--- a/docs/getting_started/tfm_secure_boot.rst
+++ b/docs/getting_started/tfm_secure_boot.rst
@@ -529,7 +529,7 @@ Executing firmware upgrade on FVP_MPS2_AEMv8M
---------------------------------------------
.. code-block:: bash
- <DS5_PATH>/sw/models/bin/FVP_MPS2_AEMv8M \
+ <ARM_DS_PATH>/sw/models/bin/FVP_MPS2_AEMv8M \
--parameter fvp_mps2.platform_type=2 \
--parameter cpu0.baseline=0 \
--parameter cpu0.INITVTOR_S=0x10000000 \
@@ -672,7 +672,7 @@ Executing firmware upgrade on FVP_MPS2_AEMv8M
.. code-block:: bash
- <DS5_PATH>/sw/models/bin/FVP_MPS2_AEMv8M \
+ <ARM_DS_PATH>/sw/models/bin/FVP_MPS2_AEMv8M \
--parameter fvp_mps2.platform_type=2 \
--parameter cpu0.baseline=0 \
--parameter cpu0.INITVTOR_S=0x10000000 \
diff --git a/docs/getting_started/tfm_sw_requirement.rst b/docs/getting_started/tfm_sw_requirement.rst
index 331695e16a..df624f0a44 100644
--- a/docs/getting_started/tfm_sw_requirement.rst
+++ b/docs/getting_started/tfm_sw_requirement.rst
@@ -2,9 +2,8 @@
Software requirements
#####################
-.. |DS5_VERSION| replace:: v5.29.1
.. |KEIL_VERSION| replace:: v5.25.2
-.. |DEV_STUDIO_VERSION| replace:: 2018.0
+.. |DEV_STUDIO_VERSION| replace:: 2019.1
A quick reference table is included in the
:ref:`docs/getting_started/tfm_sw_requirement:Tool & Dependency overview` section
@@ -42,7 +41,7 @@ versions are:
.. Note::
- The Arm compilers above are provided via Keil uVision |KEIL_VERSION|
- or greater, DS-5 |DS5_VERSION| or greater, and Development Studio
+ or greater and Arm Development Studio
|DEV_STUDIO_VERSION| or greater, or they can be downloaded as standalone
packages from
`here <https://developer.arm.com/products/software-development-tools/compilers/arm-compiler/downloads/version-6>`__.
@@ -108,7 +107,7 @@ Ubuntu
Install the following tools:
- - DS-5 |DS5_VERSION|.
+ - Arm DS |DEV_STUDIO_VERSION|.
- Git tools v2.10.0
- CMake (see the `CMake`_ chapter)
- GNU Make (see the `GNU make`_ chapter)
@@ -125,13 +124,13 @@ Install the following tools:
Setup environment variables in Linux
------------------------------------
-To import Arm Compiler v6.10 in your bash shell console:
+To import Arm Compiler v6.13 in your bash shell console:
.. code-block:: bash
- export PATH=<DS-5_PATH>/sw/ARMCompiler6.10/bin:$PATH
+ export PATH=<ARM_DS_PATH>/sw/ARMCompiler6.13/bin:$PATH
export ARM_TOOL_VARIANT=ult
- export ARM_PRODUCT_PATH=<DS-5_PATH>/sw/mappings
+ export ARM_PRODUCT_PATH=<ARM_DS_PATH>/sw/mappings
export ARMLMD_LICENSE_FILE=<LICENSE_FILE_PATH>
To import CMake in your bash shell console:
@@ -157,7 +156,7 @@ Windows
Install the following tools:
- - uVision |KEIL_VERSION| or DS-5 |DS5_VERSION| (DS-5 Ultimate Edition)
+ - uVision |KEIL_VERSION| or Arm DS |DEV_STUDIO_VERSION| (Arm DS Ultimate Edition)
or GNU Arm compiler v6.3.1.
- Git client latest version (https://git-scm.com/download/win)
- CMake (`native Windows version <https://cmake.org/download/>`__,
@@ -186,12 +185,12 @@ Add CMake to your PATH variable:
There are several configurations depending on a toolset you are using.
The typical cases are listed below.
-Armclang + DS-5
-^^^^^^^^^^^^^^^
+Armclang + Arm DS
+^^^^^^^^^^^^^^^^^
.. code-block:: bash
- set PATH=<DS-5_PATH>\sw\ARMCompiler6.10\bin;$PATH
- set ARM_PRODUCT_PATH=<DS-5_PATH>\sw\mappings
+ 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>
@@ -258,7 +257,7 @@ Download and install the following tools:
1.8.8 <https://sourceforge.net/projects/doxygen/files/snapshots/doxygen-1.8-svn/windows/doxygenw20140924_1_8_8.zip/download>`__
- `Graphviz
2.38 <https://graphviz.gitlab.io/_pages/Download/windows/graphviz-2.38.msi>`__
- - The Java runtime is part of the DS5 installation or can be
+ - The Java runtime is part of the Arm DS installation or can be
`downloaded from here <https://www.java.com/en/download/>`__
- `PlantUML <http://sourceforge.net/projects/plantuml/files/plantuml.jar/download>`__
- `MikTeX <https://miktex.org/download>`__ - for PDF generation only
@@ -266,12 +265,12 @@ Download and install the following tools:
Set the environment variables, assuming that:
- doxygen, dot, and MikTeX binaries are available on the PATH.
- - Java JVM is used from DS5 installation.
+ - Java JVM is used from Arm DS installation.
::
set PLANTUML_JAR_PATH=<plantuml_Path>\plantuml.jar
- set PATH=$PATH;<DS-5_Path>\sw\java\bin
+ set PATH=$PATH;<ARM_DS_PATH>\sw\java\bin
To compile the TF-M User Guide
==============================
@@ -312,7 +311,7 @@ Set-up the tools and environment in Windows
Download and install the following tools:
- `Graphviz 2.38 <https://graphviz.gitlab.io/_pages/Download/windows/graphviz-2.38.msi>`__
- - The Java runtime is part of the DS5 installation or can be `downloaded from here <https://www.java.com/en/download/>`__
+ - The Java runtime is part of the Arm DS installation or can be `downloaded from here <https://www.java.com/en/download/>`__
- `PlantUML <http://sourceforge.net/projects/plantuml/files/plantuml.jar/download>`__
- `MikTeX <https://miktex.org/download>`__ - for PDF generation only
- Python3 `(native Windows version) <https://www.python.org/downloads/>`__
@@ -337,7 +336,7 @@ Set the environment variables, assuming that:
.. code-block:: bash
set PLANTUML_JAR_PATH=<plantuml_Path>\plantuml.jar
- set PATH=$PATH;<DS-5_Path>\sw\java\bin
+ set PATH=$PATH;<ARM_DS_PATH>\sw\java\bin
****************************
Exceptions and special cases
@@ -473,4 +472,3 @@ Dependency chain:
--------------
*Copyright (c) 2017-2020, Arm Limited. All rights reserved.*
-
diff --git a/docs/getting_started/tfm_user_guide.rst b/docs/getting_started/tfm_user_guide.rst
index a4f582286e..d834785da7 100644
--- a/docs/getting_started/tfm_user_guide.rst
+++ b/docs/getting_started/tfm_user_guide.rst
@@ -11,17 +11,27 @@ without BL2 bootloader.
****************************************************************
Execute TF-M example and regression tests on MPS2 boards and FVP
****************************************************************
-The BL2 bootloader and TF-M example application and tests run correctly on
-SMM-SSE-200 for MPS2 (AN521) and on the Fixed Virtual Platform model
-FVP_MPS2_AEMv8M version 11.2.23.
-
-To run the example code on FVP_MPS2_AEMv8M
-==========================================
-Using FVP_MPS2_AEMv8M provided by DS-5 v5.27.1.
+The BL2 bootloader and TF-M example application and tests have been verified
+using the reference model for MPS2 (AN521), in `Keil MDK`_ ,
+`Fixed Virtual Platforms`_ and `Arm Development Studio`_ .
.. Note::
- FVP reference guide can be found
- `here <https://developer.arm.com/docs/100966/latest>`__
+ The name of the reference model's executable can vary depending on toolchain.
+
+ - SMM-SSE-200 for `Keil MDK`_
+
+ - FVP_MPS2_AEMv8M for `Fixed Virtual Platforms`_ and `Arm Development Studio`_
+
+ For more information please refer to the appropriate toolchain's
+ documentation: `Keil MDK Documentation`_ ,
+ `Fixed Virtual Platforms Documentation`_ ,
+ `Arm Development Studio Documentation`_
+
+To run the example code on an SSE-200 Fast-Model
+================================================
+Using FVP_MPS2_AEMv8M provided by `Arm Development Studio`_ 2019.1.
+
+
Example application and regression tests without BL2 bootloader
---------------------------------------------------------------
@@ -30,7 +40,7 @@ menu.
.. code-block:: bash
- <DS5_PATH>/sw/models/bin/FVP_MPS2_AEMv8M \
+ <DS_PATH>/sw/models/bin/FVP_MPS2_AEMv8M \
--parameter fvp_mps2.platform_type=2 \
--parameter cpu0.baseline=0 \
--parameter cpu0.INITVTOR_S=0x10000000 \
@@ -568,4 +578,11 @@ upgrade is described in :doc:`secure boot <tfm_secure_boot>`.
--------------
+.. _Arm Development Studio: https://developer.arm.com/tools-and-software/embedded/arm-development-studio
+.. _Arm Development Studio Documentation: https://developer.arm.com/tools-and-software/embedded/arm-development-studio/learn/docs
+.. _Fixed Virtual Platforms: https://developer.arm.com/tools-and-software/simulation-models/fixed-virtual-platforms
+.. _Fixed Virtual Platforms Documentation: https://developer.arm.com/documentation/100966/latest
+.. _Keil MDK: http://www2.keil.com/mdk5
+.. _Keil MDK Documentation: https://www2.keil.com/mdk5/docs
+
*Copyright (c) 2017-2020, Arm Limited. All rights reserved.*