aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLeonardo Sandoval <leonardo.sandoval@linaro.org>2021-02-03 17:04:22 -0600
committerAnton Komlev <Anton.Komlev@arm.com>2021-04-29 10:38:18 +0200
commit49a558c40931a4ee873a98c0dfbf53cf8947cfbb (patch)
tree7fff7ba7e39c6cd1bf227571ba493dbedb483d4e
parent9835014b67c394ed36b04621b456d7558f4d42cf (diff)
downloadtrusted-firmware-m-49a558c40931a4ee873a98c0dfbf53cf8947cfbb.tar.gz
docs: avoid indicating default toolchain (GNU ARM) in sample commands
By default the project picks 'toolchain_GNUARM.cmake' as toolchain value through the 'TFM_TOOLCHAIN_FILE' build variable so there is no need to explicitly indicate it in every command, resulting in shorter and clearer build commands. Signed-off-by: Leonardo Sandoval <leonardo.sandoval@linaro.org> Change-Id: Idc7dffdefc441ba6b5a94086dda39d8f8414134a
-rw-r--r--docs/getting_started/tfm_build_instruction.rst33
-rw-r--r--docs/technical_references/tfm_secure_boot.rst6
2 files changed, 23 insertions, 16 deletions
diff --git a/docs/getting_started/tfm_build_instruction.rst b/docs/getting_started/tfm_build_instruction.rst
index 23220a611..9779d0900 100644
--- a/docs/getting_started/tfm_build_instruction.rst
+++ b/docs/getting_started/tfm_build_instruction.rst
@@ -74,9 +74,6 @@ Required cmake parameters for building TF-M
| TFM_PLATFORM | The target platform as a path from the base directory |
| | ``/platform/ext/target``, or as an absolute path. |
+----------------------+-------------------------------------------------------+
-| TFM_TOOLCHAIN_FILE | The path to the toolchain file that corresponds to |
-| | the desired compiler. |
-+----------------------+-------------------------------------------------------+
By default release configuration builds. Alternate build types can be controlled
by the CMAKE_BUILD_TYPE variable.
@@ -283,6 +280,16 @@ Alternately using traditional cmake syntax
It is recommended to build each different build configuration in a separate
build directory.
+As seen above, the toolchain can be set using the -DTFM_TOOLCHAIN_FILE parameter. Without
+it, the build command takes the GNU ARM toolchain as default, so there is no need
+to explicitly include it. In case other toolchain is required, i.e. ARM Clang, simply
+specify in the command line
+
+.. code-block:: bash
+ cd <TF-M base folder>
+ cmake -S . -B cmake_build -DTFM_PLATFORM=mps2/an521 -DTFM_TOOLCHAIN_FILE=toolchain_ARMCLANG.cmake -DTEST_S=ON -DTEST_NS=ON
+ cmake --build cmake_build -- install
+
Regression Tests for the AN521 target platform
==============================================
@@ -294,7 +301,7 @@ features are enabled.
.. code-block:: bash
cd <TF-M base folder>
- cmake -S . -B cmake_build -DTFM_PLATFORM=mps2/an521 -DTFM_TOOLCHAIN_FILE=toolchain_GNUARM.cmake -DTEST_S=ON -DTEST_NS=ON
+ cmake -S . -B cmake_build -DTFM_PLATFORM=mps2/an521 -DTEST_S=ON -DTEST_NS=ON
cmake --build cmake_build -- install
Alternately using traditional cmake syntax
@@ -304,7 +311,7 @@ Alternately using traditional cmake syntax
cd <TF-M base folder>
mkdir cmake_build
cd cmake_build
- cmake .. -DTFM_PLATFORM=mps2/an521 -DTFM_TOOLCHAIN_FILE=../toolchain_GNUARM.cmake -DTEST_S=ON -DTEST_NS=ON
+ cmake .. -DTFM_PLATFORM=mps2/an521 -DTEST_S=ON -DTEST_NS=ON
make install
Build for PSA Functional API compliance tests
@@ -330,7 +337,7 @@ tests for the Crypto service:
.. code-block:: bash
cd <TF-M base folder>
- cmake -S . -B cmake_build -DTFM_PLATFORM=mps2/an521 -DTFM_TOOLCHAIN_FILE=toolchain_GNUARM.cmake -DTEST_PSA_API=CRYPTO
+ cmake -S . -B cmake_build -DTFM_PLATFORM=mps2/an521 -DTEST_PSA_API=CRYPTO
cmake --build cmake_build -- install
Alternately using traditional cmake syntax
@@ -340,7 +347,7 @@ Alternately using traditional cmake syntax
cd <TF-M base folder>
mkdir cmake_build
cd cmake_build
- cmake .. -DTFM_PLATFORM=mps2/an521 -DTFM_TOOLCHAIN_FILE=../toolchain_GNUARM.cmake -DTEST_PSA_API=CRYPTO
+ cmake .. -DTFM_PLATFORM=mps2/an521 -DTEST_PSA_API=CRYPTO
make install
Build for PSA FF (IPC) compliance tests
@@ -356,7 +363,7 @@ compliance test. This support is controlled by the TEST_PSA_API variable:
.. code-block:: bash
cd <TF-M base folder>
- cmake -S . -B cmake_build -DTFM_PLATFORM=mps2/an521 -DTFM_TOOLCHAIN_FILE=toolchain_GNUARM.cmake -DTEST_PSA_API=IPC -DTFM_PSA_API=ON
+ cmake -S . -B cmake_build -DTFM_PLATFORM=mps2/an521 -DTEST_PSA_API=IPC -DTFM_PSA_API=ON
cmake --build cmake_build -- install
Alternately using traditional cmake syntax
@@ -366,7 +373,7 @@ Alternately using traditional cmake syntax
cd <TF-M base folder>
mkdir cmake_build
cd cmake_build
- cmake .. -DTFM_PLATFORM=mps2/an521 -DTFM_TOOLCHAIN_FILE=../toolchain_GNUARM.cmake -DTEST_PSA_API=IPC -DTFM_PSA_API=ON
+ cmake .. -DTFM_PLATFORM=mps2/an521 -DTEST_PSA_API=IPC -DTFM_PSA_API=ON
make install
Location of build artifacts
@@ -407,7 +414,7 @@ Building the Reference Manual
.. code-block:: bash
cd <TF-M base folder>
- cmake -S . -B cmake_doc -DTFM_PLATFORM=mps2/an521 -DTFM_TOOLCHAIN_FILE=toolchain_GNUARM.cmake
+ cmake -S . -B cmake_doc -DTFM_PLATFORM=mps2/an521
cmake --build cmake_doc -- tfm_docs_refman_html tfm_docs_refman_pdf
The documentation files will be available under the directory::
@@ -419,7 +426,7 @@ Building the User Guide
.. code-block:: bash
cd <TF-M base folder>
- cmake -S . -B cmake_doc -DTFM_PLATFORM=mps2/an521 -DTFM_TOOLCHAIN_FILE=toolchain_GNUARM.cmake
+ cmake -S . -B cmake_doc -DTFM_PLATFORM=mps2/an521
cmake --build cmake_doc -- tfm_docs_userguide_html tfm_docs_userguide_pdf
The documentation files will be available under the directory::
@@ -541,7 +548,7 @@ With new cmake syntax
.. code-block:: bash
cd <TF-M base folder>
- cmake -S . -B cmake_build -DTFM_PLATFORM=mps2/an521 -DTFM_TOOLCHAIN_FILE=toolchain_GNUARM.cmake -DMBEDCRYPTO_PATH=<Mbed Crypto base folder>/mbedtls
+ cmake -S . -B cmake_build -DTFM_PLATFORM=mps2/an521 -DMBEDCRYPTO_PATH=<Mbed Crypto base folder>/mbedtls
cmake --build cmake_build -- install
Alternately using traditional cmake syntax
@@ -551,7 +558,7 @@ Alternately using traditional cmake syntax
cd <TF-M base folder>
mkdir cmake_build
cd cmake_build
- cmake .. -DTFM_PLATFORM=mps2/an521 -DTFM_TOOLCHAIN_FILE=../toolchain_GNUARM.cmake -DMBEDCRYPTO_PATH=<Mbed Crypto base folder>/mbedtls
+ cmake .. -DTFM_PLATFORM=mps2/an521 -DMBEDCRYPTO_PATH=<Mbed Crypto base folder>/mbedtls
make install
--------------
diff --git a/docs/technical_references/tfm_secure_boot.rst b/docs/technical_references/tfm_secure_boot.rst
index 087a2dc9d..36ea03654 100644
--- a/docs/technical_references/tfm_secure_boot.rst
+++ b/docs/technical_references/tfm_secure_boot.rst
@@ -307,7 +307,7 @@ compile time switches:
Example of how to provide the secure image minimum version::
- cmake -DTFM_PLATFORM=musca_b1/sse_200 -DTFM_TOOLCHAIN_FILE=../toolchain_GNUARM.cmake -DMCUBOOT_S_IMAGE_MIN_VER=1.2.3+4 ..
+ cmake -DTFM_PLATFORM=musca_b1/sse_200 -DMCUBOOT_S_IMAGE_MIN_VER=1.2.3+4 ..
********************
Signature algorithms
@@ -425,7 +425,7 @@ images.
The version number of the image (single image boot) can manually be passed in
through the command line in the cmake configuration step::
- cmake -DTFM_PLATFORM=musca_b1/sse_200 -DTFM_TOOLCHAIN_FILE=../toolchain_GNUARM.cmake -DIMAGE_VERSION_S=1.2.3+4 ..
+ cmake -DTFM_PLATFORM=musca_b1/sse_200 -DIMAGE_VERSION_S=1.2.3+4 ..
Alternatively, the version number can be less specific (e.g 1, 1.2, or 1.2.3),
where the missing numbers are automatically set to zero. The image version
@@ -459,7 +459,7 @@ and its value should always be increased if a security flaw was fixed in the
current image version. The value of the security counter (single image boot) can
be specified at build time in the cmake configuration step::
- cmake -DTFM_PLATFORM=musca_b1/sse_200 -DTFM_TOOLCHAIN_FILE=../toolchain_GNUARM.cmake -DSECURITY_COUNTER_S=42 ../
+ cmake -DTFM_PLATFORM=musca_b1/sse_200 -DSECURITY_COUNTER_S=42 ../
The security counter can be independent from the image version, but not
necessarily. Alternatively, if it is not specified at build time with the