Doc: Change TFM_PLATFORM description
TFM_PLATFORM has been simplified and can be configurated as board
name now. This patch adds the description of the new feature in
documents.
Signed-off-by: Jianliang Shen <jianliang.shen@arm.com>
Change-Id: Id6594c83039a37e04a0af77238bf6624cd4e3e9d
diff --git a/docs/integration_guide/porting_TFM_to_a_new_hardware.rst b/docs/integration_guide/porting_TFM_to_a_new_hardware.rst
index b569f98..3a37384 100644
--- a/docs/integration_guide/porting_TFM_to_a_new_hardware.rst
+++ b/docs/integration_guide/porting_TFM_to_a_new_hardware.rst
@@ -69,9 +69,9 @@
The platform selection when building TF-M is set via the CMake
variable TFM_PLATFORM. This variable holds part of the path to the platform.
-When using -DTFM_PLATFORM="``arm/mps2/an521``" (as in the build instruction example)
+When using ``-DTFM_PLATFORM=arm/mps2/an521`` or ``-DTFM_PLATFORM=an521``
TF-M build system will look for the platform in
-<TF-M ROOT>/platform/ext/target/``arm/mps2/an521``.
+<TF-M ROOT>/platform/ext/target/arm/mps2/an521.
Therefore all hardware dependent code for your platform should go to
<TF-M ROOT>/platform/ext/target/.
diff --git a/docs/technical_references/instructions/tfm_build_instruction.rst b/docs/technical_references/instructions/tfm_build_instruction.rst
index 144381a..4f700db 100644
--- a/docs/technical_references/instructions/tfm_build_instruction.rst
+++ b/docs/technical_references/instructions/tfm_build_instruction.rst
@@ -77,12 +77,13 @@
Required cmake parameters for building TF-M
-------------------------------------------
-+----------------------+-------------------------------------------------------+
-| Parameter | Description |
-+======================+=======================================================+
-| TFM_PLATFORM | The target platform as a path from the base directory |
-| | ``/platform/ext/target``, or as an absolute path. |
-+----------------------+-------------------------------------------------------+
+``TFM_PLATFORM`` is required to select the target platform, it can be:
+ - A relative path under ``<TF-M_root>/platform/ext/target``,
+ for example ``arm/mps2/an521``.
+ - An absolute path of target platform, mainly used for out-of-tree platform
+ build.
+ - A target platform name that is supported under
+ <TF-M_root>/platform/ext/target, for example ``an521``.
Build type
----------
@@ -531,5 +532,5 @@
--------------
-*Copyright (c) 2017-2021, Arm Limited. All rights reserved.*
+*Copyright (c) 2017-2022, Arm Limited. All rights reserved.*
*Copyright (c) 2022, Cypress Semiconductor Corporation. All rights reserved.*