Docs: Improve the documents for split build
Change-Id: I28831840a460a7d77e99690a9041911bcb2fc3be
Signed-off-by: Kevin Peng <kevin.peng@arm.com>
diff --git a/docs/building/tfm_build_instruction.rst b/docs/building/tfm_build_instruction.rst
index db2ab89..a75d705 100644
--- a/docs/building/tfm_build_instruction.rst
+++ b/docs/building/tfm_build_instruction.rst
@@ -328,7 +328,11 @@
- **platform** - source code for a selected hardware platform.
- **CMakeLists.txt** - CMake script for the artifacts integration in NSPE.
-The content of ``<Artifact Dir>`` is a prepared directory for integration with CMake projects.
+The content of ``<Artifact Dir>`` is an exported directory for integration with CMake projects.
+
+.. Note::
+ Attempting to change any file in <Artifact Dir> may cause incompatibility issues.
+ Instead, please change the corresponding file in the <TF-M source dir>.
.. _NSPE toolchains:
diff --git a/docs/getting_started/tfm_getting_started.rst b/docs/getting_started/tfm_getting_started.rst
index c5f21fc..b9dace5 100644
--- a/docs/getting_started/tfm_getting_started.rst
+++ b/docs/getting_started/tfm_getting_started.rst
@@ -116,7 +116,6 @@
.. code-block:: bash
- cd <base folder>
git clone https://git.trustedfirmware.org/TF-M/trusted-firmware-m.git
2. TF-M's ``tools/requirements.txt`` file declares additional Python
@@ -134,7 +133,6 @@
.. code-block:: bash
- cd <base folder>
git clone https://git.trustedfirmware.org/TF-M/trusted-firmware-m.git
2. TF-M's ``tools/requirements.txt`` file declares additional Python
@@ -250,21 +248,25 @@
.. group-tab:: Linux
- .. code-block:: bash
-
- cd trusted-firmware-m
- cmake -S . -B cmake_build -DTFM_PLATFORM=arm/mps2/an521 -DTFM_TOOLCHAIN_FILE=toolchain_GNUARM.cmake -DCMAKE_BUILD_TYPE=Debug -DTEST_S=ON -DTEST_NS=ON
- cmake --build cmake_build -- install
-
- Alternately using traditional cmake syntax
+ Get the TF-M tests source code:
.. code-block:: bash
- cd trusted-firmware-m
- mkdir cmake_build
- cd cmake_build
- cmake .. -DTFM_PLATFORM=arm/mps2/an521 -DTFM_TOOLCHAIN_FILE=../toolchain_GNUARM.cmake -DTEST_S=ON -DTEST_NS=ON
- make install
+ git clone https://git.trustedfirmware.org/TF-M/tf-m-tests.git
+
+ Build SPE and NSPE.
+
+ .. code-block:: bash
+
+ cd </tf-m-tests/tests_reg>
+ cmake -S spe -B build_spe -DTFM_PLATFORM=arm/mps2/an521 -DCONFIG_TFM_SOURCE_PATH=<TF-M source dir> \
+ -DCMAKE_BUILD_TYPE=Debug -DTFM_TOOLCHAIN_FILE=<Absolute path to>/toolchain_GNUARM.cmake \
+ -DTEST_S=ON -DTEST_NS=ON \
+ cmake --build build_spe -- install
+
+ cmake -S . -B build_test -DCONFIG_SPE_PATH=<absolute path to>/build_spe/api_ns \
+ -DCMAKE_BUILD_TYPE=Debug -DTFM_TOOLCHAIN_FILE=<Absolute path to>/toolchain_GNUARM.cmake
+ cmake --build build_test
.. group-tab:: Windows
@@ -272,35 +274,31 @@
Use "/" instead of "\\" when assigning Windows paths to CMAKE
variables, for example, use "c:/build" instead of "c:\\\\build".
- .. code-block:: bash
-
- cd trusted-firmware-m
- cmake -G"Unix Makefiles" -S . -B cmake_build -DTFM_PLATFORM=arm/mps2/an521 -DTFM_TOOLCHAIN_FILE=toolchain_GNUARM.cmake -DCMAKE_BUILD_TYPE=Debug -DTEST_S=ON -DTEST_NS=ON
- cmake --build cmake_build -- install
-
- Alternately using traditional cmake syntax
+ Get the TF-M tests source code:
.. code-block:: bash
- cd trusted-firmware-m
- mkdir cmake_build
- cd cmake_build
- cmake -G"Unix Makefiles" .. -DTFM_PLATFORM=arm/mps2/an521 -DTFM_TOOLCHAIN_FILE=../toolchain_GNUARM.cmake -DTEST_S=ON -DTEST_NS=ON
- make install
+ git clone https://git.trustedfirmware.org/TF-M/tf-m-tests.git
+ Build SPE and NSPE.
+
+ .. code-block:: bash
+
+ cd </tf-m-tests/tests_reg>
+ cmake -G"Unix Makefiles" -S spe -B build_spe -DTFM_PLATFORM=arm/mps2/an521 -DCONFIG_TFM_SOURCE_PATH=<TF-M source dir> \
+ -DCMAKE_BUILD_TYPE=Debug -DTFM_TOOLCHAIN_FILE=<Absolute path to>/toolchain_GNUARM.cmake \
+ -DTEST_S=ON -DTEST_NS=ON \
+ cmake --build build_spe -- install
+
+ cmake -G"Unix Makefiles" -S . -B build_test -DCONFIG_SPE_PATH=<absolute path to>/build_spe/api_ns \
+ -DCMAKE_BUILD_TYPE=Debug -DTFM_TOOLCHAIN_FILE=<Absolute path to>/toolchain_GNUARM.cmake
+ cmake --build build_test
.. note::
The latest Windows support long paths, but if you are less lucky
then you can reduce paths by moving the build directory closer to
- the root, using the 'out of tree' build.
- For example to build in ``C:\build`` folder you can:
-
- .. code-block:: bash
-
- cd trusted-firmware-m
- cmake -G"Unix Makefiles" -S . -B C:/build -DTFM_PLATFORM=arm/mps2/an521 -DTFM_TOOLCHAIN_FILE=toolchain_GNUARM.cmake -DCMAKE_BUILD_TYPE=Debug -DTEST_S=ON -DTEST_NS=ON
- cmake --build C:/build -- install
-
+ the root by changing the ``-B`` option of the commands, for example,
+ to ``C:\build_spe`` and ``C:\build_test`` folders.
###########################
Run AN521 regression sample
@@ -339,8 +337,8 @@
--parameter fvp_mps2.telnetterminal0.quiet=0 \
--parameter fvp_mps2.telnetterminal1.quiet=1 \
--parameter fvp_mps2.telnetterminal2.quiet=1 \
- --application cpu0=<build_dir>/bin/bl2.axf \
- --data cpu0=<build_dir>/bin/tfm_s_ns_signed.bin@0x10080000
+ --application cpu0=<build_spe>/api_ns/bin/bl2.axf \
+ --data cpu0=<build_test>/tfm_s_ns_signed.bin@0x10080000
.. note::
@@ -381,8 +379,8 @@
--parameter fvp_mps2.telnetterminal0.quiet=0 \
--parameter fvp_mps2.telnetterminal1.quiet=1 \
--parameter fvp_mps2.telnetterminal2.quiet=1 \
- --application cpu0=<build_dir>/bin/bl2.axf \
- --data cpu0=<build_dir>/bin/tfm_s_ns_signed.bin@0x10080000
+ --application cpu0=<build_spe>/api_ns/bin/bl2.axf \
+ --data cpu0=<build_test>/tfm_s_ns_signed.bin@0x10080000
.. note::
@@ -396,33 +394,21 @@
After completing the procedure you should see the following messages on the
DAPLink UART (baud 115200 8n1)::
- [INF] Starting bootloader
- [INF] Image 0: magic=good, copy_done=0xff, image_ok=0xff
- [INF] Scratch: magic=bad, copy_done=0x5, image_ok=0x9
- [INF] Boot source: primary slot
- [INF] Swap type: none
- [INF] Bootloader chainload address offset: 0x20000
- [INF] Jumping to the first image slot
- [Sec Thread] Secure image initializing!
-
- #### Execute test suites for the protected storage service ####
- Running Test Suite PS secure interface tests (TFM_PS_TEST_2XXX)...
- > Executing 'TFM_PS_TEST_2001'
- Description: 'Create interface'
- TEST PASSED!
- > Executing 'TFM_PS_TEST_2002'
- Description: 'Get handle interface (DEPRECATED)'
- This test is DEPRECATED and the test execution was SKIPPED
- TEST PASSED!
- > Executing 'TFM_PS_TEST_2003'
- Description: 'Get handle with null handle pointer (DEPRECATED)'
- This test is DEPRECATED and the test execution was SKIPPED
- TEST PASSED!
- > Executing 'TFM_PS_TEST_2004'
- Description: 'Get attributes interface'
- TEST PASSED!
- > Executing 'TFM_PS_TEST_2005'
- Description: 'Get attributes with null attributes struct pointer'
+ ...
+ #### Execute test suites for the Secure area ####
+ Running Test Suite PSA protected storage S interface tests (TFM_S_PS_TEST_1XXX)...
+ > Executing 'TFM_S_PS_TEST_1001'
+ Description: 'Set interface'
+ TEST: TFM_S_PS_TEST_1001 - PASSED!
+ > Executing 'TFM_S_PS_TEST_1002'
+ Description: 'Set interface with create flags'
+ TEST: TFM_S_PS_TEST_1002 - PASSED!
+ > Executing 'TFM_S_PS_TEST_1003'
+ Description: 'Set interface with NULL data pointer'
+ TEST: TFM_S_PS_TEST_1003 - PASSED!
+ > Executing 'TFM_S_PS_TEST_1005'
+ Description: 'Set interface with write once UID'
+ TEST: TFM_S_PS_TEST_1005 - PASSED!
....
##########################