aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorSummer Qin <summer.qin@arm.com>2021-05-14 13:44:14 +0800
committerKarl Zhang <karl.zhang@arm.com>2021-06-04 09:49:14 +0200
commit2de23d0367b545016ad134965343e8d39ae535fe (patch)
tree5871f6ac2051da872047370fd00269f75de74ab2 /docs
parentc4d8e2c5ab26706b510f35dac65354281bce7bb7 (diff)
downloadtrusted-firmware-m-2de23d0367b545016ad134965343e8d39ae535fe.tar.gz
Platform: Add arm folder for arm platforms
Put arm platforms into arm folder and remove some unused cryptocell-312-runtime. It will be convenient for users and developers. Signed-off-by: Summer Qin <summer.qin@arm.com> Change-Id: I1187a8f2b18903e531ce28b2d23be251ec1e2b45
Diffstat (limited to 'docs')
-rw-r--r--docs/getting_started/tfm_build_instruction.rst26
-rw-r--r--docs/getting_started/tfm_build_instruction_iar.rst8
-rw-r--r--docs/getting_started/tfm_user_guide.rst4
-rw-r--r--docs/releases/1.3.0.rst2
-rw-r--r--docs/technical_references/profiles/tfm_profile_large.rst4
-rw-r--r--docs/technical_references/profiles/tfm_profile_medium.rst4
-rw-r--r--docs/technical_references/profiles/tfm_profile_small.rst4
-rw-r--r--docs/technical_references/tfm_secure_boot.rst6
8 files changed, 29 insertions, 29 deletions
diff --git a/docs/getting_started/tfm_build_instruction.rst b/docs/getting_started/tfm_build_instruction.rst
index 403fccd50..f64528a89 100644
--- a/docs/getting_started/tfm_build_instruction.rst
+++ b/docs/getting_started/tfm_build_instruction.rst
@@ -262,7 +262,7 @@ Example: building TF-M for AN521 platform using GCC:
.. code-block:: bash
cd <TF-M base folder>
- cmake -S . -B cmake_build -DTFM_PLATFORM=mps2/an521 -DTFM_TOOLCHAIN_FILE=toolchain_GNUARM.cmake -DCMAKE_BUILD_TYPE=Debug
+ cmake -S . -B cmake_build -DTFM_PLATFORM=arm/mps2/an521 -DTFM_TOOLCHAIN_FILE=toolchain_GNUARM.cmake -DCMAKE_BUILD_TYPE=Debug
cmake --build cmake_build -- install
Alternately using traditional cmake syntax
@@ -272,7 +272,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
+ cmake .. -DTFM_PLATFORM=arm/mps2/an521 -DTFM_TOOLCHAIN_FILE=../toolchain_GNUARM.cmake
make install
.. Note::
@@ -292,7 +292,7 @@ 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 -S . -B cmake_build -DTFM_PLATFORM=arm/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
@@ -306,7 +306,7 @@ features are enabled.
.. code-block:: bash
cd <TF-M base folder>
- cmake -S . -B cmake_build -DTFM_PLATFORM=mps2/an521 -DTEST_S=ON -DTEST_NS=ON
+ cmake -S . -B cmake_build -DTFM_PLATFORM=arm/mps2/an521 -DTEST_S=ON -DTEST_NS=ON
cmake --build cmake_build -- install
Alternately using traditional cmake syntax
@@ -316,7 +316,7 @@ Alternately using traditional cmake syntax
cd <TF-M base folder>
mkdir cmake_build
cd cmake_build
- cmake .. -DTFM_PLATFORM=mps2/an521 -DTEST_S=ON -DTEST_NS=ON
+ cmake .. -DTFM_PLATFORM=arm/mps2/an521 -DTEST_S=ON -DTEST_NS=ON
make install
Build for PSA Functional API compliance tests
@@ -342,7 +342,7 @@ tests for the Crypto service:
.. code-block:: bash
cd <TF-M base folder>
- cmake -S . -B cmake_build -DTFM_PLATFORM=mps2/an521 -DTEST_PSA_API=CRYPTO
+ cmake -S . -B cmake_build -DTFM_PLATFORM=arm/mps2/an521 -DTEST_PSA_API=CRYPTO
cmake --build cmake_build -- install
Alternately using traditional cmake syntax
@@ -352,7 +352,7 @@ Alternately using traditional cmake syntax
cd <TF-M base folder>
mkdir cmake_build
cd cmake_build
- cmake .. -DTFM_PLATFORM=mps2/an521 -DTEST_PSA_API=CRYPTO
+ cmake .. -DTFM_PLATFORM=arm/mps2/an521 -DTEST_PSA_API=CRYPTO
make install
Build for PSA FF (IPC) compliance tests
@@ -368,7 +368,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 -DTEST_PSA_API=IPC -DTFM_PSA_API=ON
+ cmake -S . -B cmake_build -DTFM_PLATFORM=arm/mps2/an521 -DTEST_PSA_API=IPC -DTFM_PSA_API=ON
cmake --build cmake_build -- install
Alternately using traditional cmake syntax
@@ -378,7 +378,7 @@ Alternately using traditional cmake syntax
cd <TF-M base folder>
mkdir cmake_build
cd cmake_build
- cmake .. -DTFM_PLATFORM=mps2/an521 -DTEST_PSA_API=IPC -DTFM_PSA_API=ON
+ cmake .. -DTFM_PLATFORM=arm/mps2/an521 -DTEST_PSA_API=IPC -DTFM_PSA_API=ON
make install
Location of build artifacts
@@ -419,7 +419,7 @@ Building the Reference Manual
.. code-block:: bash
cd <TF-M base folder>
- cmake -S . -B cmake_doc -DTFM_PLATFORM=mps2/an521
+ cmake -S . -B cmake_doc -DTFM_PLATFORM=arm/mps2/an521
cmake --build cmake_doc -- tfm_docs_refman_html tfm_docs_refman_pdf
The documentation files will be available under the directory::
@@ -431,7 +431,7 @@ Building the User Guide
.. code-block:: bash
cd <TF-M base folder>
- cmake -S . -B cmake_doc -DTFM_PLATFORM=mps2/an521
+ cmake -S . -B cmake_doc -DTFM_PLATFORM=arm/mps2/an521
cmake --build cmake_doc -- tfm_docs_userguide_html tfm_docs_userguide_pdf
The documentation files will be available under the directory::
@@ -553,7 +553,7 @@ With new cmake syntax
.. code-block:: bash
cd <TF-M base folder>
- cmake -S . -B cmake_build -DTFM_PLATFORM=mps2/an521 -DMBEDCRYPTO_PATH=<Mbed Crypto base folder>/mbedtls
+ cmake -S . -B cmake_build -DTFM_PLATFORM=arm/mps2/an521 -DMBEDCRYPTO_PATH=<Mbed Crypto base folder>/mbedtls
cmake --build cmake_build -- install
Alternately using traditional cmake syntax
@@ -563,7 +563,7 @@ Alternately using traditional cmake syntax
cd <TF-M base folder>
mkdir cmake_build
cd cmake_build
- cmake .. -DTFM_PLATFORM=mps2/an521 -DMBEDCRYPTO_PATH=<Mbed Crypto base folder>/mbedtls
+ cmake .. -DTFM_PLATFORM=arm/mps2/an521 -DMBEDCRYPTO_PATH=<Mbed Crypto base folder>/mbedtls
make install
--------------
diff --git a/docs/getting_started/tfm_build_instruction_iar.rst b/docs/getting_started/tfm_build_instruction_iar.rst
index a32048836..b9e8b2de1 100644
--- a/docs/getting_started/tfm_build_instruction_iar.rst
+++ b/docs/getting_started/tfm_build_instruction_iar.rst
@@ -28,7 +28,7 @@ Example: building TF-M for AN521 platform using IAR:
.. code-block:: bash
cd <TF-M base folder>
- cmake -S . -B cmake_build -DTFM_PLATFORM=mps2/an521 -DTFM_TOOLCHAIN_FILE=toolchain_IARARM.cmake
+ cmake -S . -B cmake_build -DTFM_PLATFORM=arm/mps2/an521 -DTFM_TOOLCHAIN_FILE=toolchain_IARARM.cmake
cmake --build cmake_build -- install
Alternately using traditional cmake syntax
@@ -38,7 +38,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_IARARM.cmake
+ cmake .. -DTFM_PLATFORM=arm/mps2/an521 -DTFM_TOOLCHAIN_FILE=../toolchain_IARARM.cmake
make install
Regression Tests for the AN521 target platform
@@ -47,7 +47,7 @@ Regression Tests for the AN521 target platform
.. code-block:: bash
cd <TF-M base folder>
- cmake -S . -B cmake_build -DTFM_PLATFORM=mps2/an521 -DTFM_TOOLCHAIN_FILE=toolchain_IARARM.cmake -DTEST_S=ON -DTEST_NS=ON
+ cmake -S . -B cmake_build -DTFM_PLATFORM=arm/mps2/an521 -DTFM_TOOLCHAIN_FILE=toolchain_IARARM.cmake -DTEST_S=ON -DTEST_NS=ON
cmake --build cmake_build -- install
Alternately using traditional cmake syntax
@@ -57,7 +57,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_IARARM.cmake -DTEST_S=ON -DTEST_NS=ON
+ cmake .. -DTFM_PLATFORM=arm/mps2/an521 -DTFM_TOOLCHAIN_FILE=../toolchain_IARARM.cmake -DTEST_S=ON -DTEST_NS=ON
make install
*Copyright (c) 2020-2021, Arm Limited. All rights reserved.*
diff --git a/docs/getting_started/tfm_user_guide.rst b/docs/getting_started/tfm_user_guide.rst
index d2b01937c..bd9ce9111 100644
--- a/docs/getting_started/tfm_user_guide.rst
+++ b/docs/getting_started/tfm_user_guide.rst
@@ -224,7 +224,7 @@ Execute TF-M example and regression tests on Musca test chip boards
.. Note::
Before executing any images on Musca-B1 board, please check the
- :doc:`target platform readme </platform/ext/target/musca_b1/sse_200/readme>`
+ :doc:`target platform readme </platform/ext/target/arm/musca_b1/sse_200/readme>`
to have the correct setup.
Example application with BL2 bootloader
@@ -416,7 +416,7 @@ Example application or regression tests on Musca-B1 using the Secure Enclave
============================================================================
Follow the above procedures, but to create a unified hex please check the
-:doc:`Musca-B1 Secure Enclave readme </platform/ext/target/musca_b1/secure_enclave/readme>`.
+:doc:`Musca-B1 Secure Enclave readme </platform/ext/target/arm/musca_b1/secure_enclave/readme>`.
********************************************************
Execute TF-M example and regression tests on MPS3 boards
diff --git a/docs/releases/1.3.0.rst b/docs/releases/1.3.0.rst
index e246ad043..a68dbc9db 100644
--- a/docs/releases/1.3.0.rst
+++ b/docs/releases/1.3.0.rst
@@ -48,7 +48,7 @@ New platforms supported
- Secure Enclave system:
- - :doc:`Musca-B1 Secure Enclave. </platform/ext/target/musca_b1/secure_enclave/readme>`
+ - :doc:`Musca-B1 Secure Enclave. </platform/ext/target/arm/musca_b1/secure_enclave/readme>`
Deprecated platforms
====================
diff --git a/docs/technical_references/profiles/tfm_profile_large.rst b/docs/technical_references/profiles/tfm_profile_large.rst
index 2e0bc76de..89edd2978 100644
--- a/docs/technical_references/profiles/tfm_profile_large.rst
+++ b/docs/technical_references/profiles/tfm_profile_large.rst
@@ -407,7 +407,7 @@ build type **MinSizeRel**, built by **Armclang**.
cd <TFM root dir>
mkdir build && cd build
- cmake -DTFM_PLATFORM=mps2/an521 \
+ cmake -DTFM_PLATFORM=arm/mps2/an521 \
-DTFM_TOOLCHAIN_FILE=../toolchain_ARMCLANG.cmake \
-DTFM_PROFILE=profile_large \
-DCMAKE_BUILD_TYPE=MinSizeRel \
@@ -421,7 +421,7 @@ The following commands build Profile Large with regression test cases on
cd <TFM root dir>
mkdir build && cd build
- cmake -DTFM_PLATFORM=mps2/an521 \
+ cmake -DTFM_PLATFORM=arm/mps2/an521 \
-DTFM_TOOLCHAIN_FILE=../toolchain_ARMCLANG.cmake \
-DTFM_PROFILE=profile_large \
-DCMAKE_BUILD_TYPE=MinSizeRel \
diff --git a/docs/technical_references/profiles/tfm_profile_medium.rst b/docs/technical_references/profiles/tfm_profile_medium.rst
index ab552f18d..ae24b98db 100644
--- a/docs/technical_references/profiles/tfm_profile_medium.rst
+++ b/docs/technical_references/profiles/tfm_profile_medium.rst
@@ -430,7 +430,7 @@ build type **MinSizeRel**, built by **Armclang**.
cd <TFM root dir>
mkdir build && cd build
- cmake -DTFM_PLATFORM=mps2/an521 \
+ cmake -DTFM_PLATFORM=arm/mps2/an521 \
-DTFM_TOOLCHAIN_FILE=../toolchain_ARMCLANG.cmake \
-DTFM_PROFILE=profile_medium \
-DCMAKE_BUILD_TYPE=MinSizeRel \
@@ -444,7 +444,7 @@ The following commands build Profile Medium with regression test cases on
cd <TFM root dir>
mkdir build && cd build
- cmake -DTFM_PLATFORM=mps2/an521 \
+ cmake -DTFM_PLATFORM=arm/mps2/an521 \
-DTFM_TOOLCHAIN_FILE=../toolchain_ARMCLANG.cmake \
-DTFM_PROFILE=profile_medium \
-DCMAKE_BUILD_TYPE=MinSizeRel \
diff --git a/docs/technical_references/profiles/tfm_profile_small.rst b/docs/technical_references/profiles/tfm_profile_small.rst
index d95d69330..a97a1e11e 100644
--- a/docs/technical_references/profiles/tfm_profile_small.rst
+++ b/docs/technical_references/profiles/tfm_profile_small.rst
@@ -584,7 +584,7 @@ build type **MinSizeRel**, built by **Armclang**.
cd <TFM root dir>
mkdir build && cd build
- cmake -DTFM_PLATFORM=mps2/an521 \
+ cmake -DTFM_PLATFORM=arm/mps2/an521 \
-DTFM_TOOLCHAIN_FILE=../toolchain_ARMCLANG.cmake \
-DTFM_PROFILE=profile_small \
-DCMAKE_BUILD_TYPE=MinSizeRel \
@@ -598,7 +598,7 @@ with build type **MinSizeRel**, built by **Armclang**.
cd <TFM root dir>
mkdir build && cd build
- cmake -DTFM_PLATFORM=mps2/an521 \
+ cmake -DTFM_PLATFORM=arm/mps2/an521 \
-DTFM_TOOLCHAIN_FILE=../toolchain_ARMCLANG.cmake \
-DTFM_PROFILE=profile_small \
-DCMAKE_BUILD_TYPE=MinSizeRel \
diff --git a/docs/technical_references/tfm_secure_boot.rst b/docs/technical_references/tfm_secure_boot.rst
index 1907cea8a..61bdcb55f 100644
--- a/docs/technical_references/tfm_secure_boot.rst
+++ b/docs/technical_references/tfm_secure_boot.rst
@@ -309,7 +309,7 @@ compile time switches:
Example of how to provide the secure image minimum version::
- cmake -DTFM_PLATFORM=musca_b1/sse_200 -DMCUBOOT_S_IMAGE_MIN_VER=1.2.3+4 ..
+ cmake -DTFM_PLATFORM=arm/musca_b1/sse_200 -DMCUBOOT_S_IMAGE_MIN_VER=1.2.3+4 ..
********************
Signature algorithms
@@ -427,7 +427,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 -DIMAGE_VERSION_S=1.2.3+4 ..
+ cmake -DTFM_PLATFORM=arm/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
@@ -461,7 +461,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 -DSECURITY_COUNTER_S=42 ../
+ cmake -DTFM_PLATFORM=arm/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