Docs: Update path 'services' to 'partitions'
Due to the folder name is updated from 'secure_fw/services' to
'secure_fw/partitions', update related documents with updated name.
Change-Id: I5b85d3c2c4f2a4e1f7fd422910e968e970d70527
Signed-off-by: Ken Liu <ken.liu@arm.com>
diff --git a/docs/design_documents/tfm_crypto_design.rst b/docs/design_documents/tfm_crypto_design.rst
index d49c043..e2785a5 100644
--- a/docs/design_documents/tfm_crypto_design.rst
+++ b/docs/design_documents/tfm_crypto_design.rst
@@ -39,7 +39,7 @@
+-----------------------------+---------------------------------------------------------------+----------------------------------------------------------------------+
| **Component name** | **Description** | **Location** |
+=============================+===============================================================+======================================================================+
- | SPE client API interface | This module exports the client API of PSA Crypto to the other | ``./secure_fw/services/crypto/tfm_crypto_secure_api.c`` |
+ | SPE client API interface | This module exports the client API of PSA Crypto to the other | ``./secure_fw/partitions/crypto/tfm_crypto_secure_api.c`` |
| | services available in TF-M. | |
+-----------------------------+---------------------------------------------------------------+----------------------------------------------------------------------+
| NSPE client API interface | This module exports the client API of PSA Crypto to the NSPE | ``./interface/src/tfm_crypto_api.c`` |
@@ -48,7 +48,7 @@
| Mbed Crypto | The Mbed Crypto library is used in the service as a | Needed as dependency at the same level of the TF-M folder, |
| | cryptographic library exposing the PSA Crypto API interface. | i.e. ``../mbed-crypto`` |
+-----------------------------+---------------------------------------------------------------+----------------------------------------------------------------------+
- | Init module | This module handles the initialisation of the service objects | ``./secure_fw/services/crypto/crypto_init.c`` |
+ | Init module | This module handles the initialisation of the service objects | ``./secure_fw/partitions/crypto/crypto_init.c`` |
| | during TF-M boot and provides the infrastructure to service | |
| | requests when TF-M is built for IPC mode. | |
| | Due to the fact that the functions available in the Service | |
@@ -59,28 +59,28 @@
| | higher number of Secure functions with minimal overhead and | |
| | duplication of code. | |
+-----------------------------+---------------------------------------------------------------+----------------------------------------------------------------------+
- | Alloc module | This module handles the allocation of contexts for multipart | ``./secure_fw/services/crypto/crypto_alloc.c`` |
+ | Alloc module | This module handles the allocation of contexts for multipart | ``./secure_fw/partitions/crypto/crypto_alloc.c`` |
| | operations in the Secure world. | |
+-----------------------------+---------------------------------------------------------------+----------------------------------------------------------------------+
- | Service modules | These modules (AEAD, Asymmetric, Cipher, Key Deriv, Hash, Key,| ``./secure_fw/services/crypto/crypto_aead.c`` |
- | | MAC) represent a thin layer which is in charge of servicing | ``./secure_fw/services/crypto/crypto_asymmetric.c`` |
- | | the calls from the SPE/NSPE client API interfaces. | ``./secure_fw/services/crypto/crypto_cipher.c`` |
- | | They provide parameter sanitation and context retrieval for | ``./secure_fw/services/crypto/crypto_key_derivation.c`` |
- | | multipart operations, and dispatching to the corresponding | ``./secure_fw/services/crypto/crypto_hash.c`` |
- | | library function exposed by Mbed Crypto for the desired | ``./secure_fw/services/crypto/crypto_key.c`` |
- | | functionality. | ``./secure_fw/services/crypto/crypto_mac.c`` |
+ | Service modules | These modules (AEAD, Asymmetric, Cipher, Key Deriv, Hash, Key,| ``./secure_fw/partitions/crypto/crypto_aead.c`` |
+ | | MAC) represent a thin layer which is in charge of servicing | ``./secure_fw/partitions/crypto/crypto_asymmetric.c`` |
+ | | the calls from the SPE/NSPE client API interfaces. | ``./secure_fw/partitions/crypto/crypto_cipher.c`` |
+ | | They provide parameter sanitation and context retrieval for | ``./secure_fw/partitions/crypto/crypto_key_derivation.c`` |
+ | | multipart operations, and dispatching to the corresponding | ``./secure_fw/partitions/crypto/crypto_hash.c`` |
+ | | library function exposed by Mbed Crypto for the desired | ``./secure_fw/partitions/crypto/crypto_key.c`` |
+ | | functionality. | ``./secure_fw/partitions/crypto/crypto_mac.c`` |
| | All the functions in the Service modules are based on the | |
| | Uniform Signature prototype [2]_ . | |
+-----------------------------+---------------------------------------------------------------+----------------------------------------------------------------------+
- | Manifest | The manifest file is a description of the service components | ``./secure_fw/services/crypto/manifest.yaml`` |
+ | Manifest | The manifest file is a description of the service components | ``./secure_fw/partitions/crypto/manifest.yaml`` |
| | for both library mode and IPC mode. | |
+-----------------------------+---------------------------------------------------------------+----------------------------------------------------------------------+
- | CMake files and headers | The CMake files are used by the TF-M CMake build system to | ``./secure_fw/services/crypto/CMakeLists.inc`` |
- | | build the service as part of the Secure FW build. The service | ``./secure_fw/services/crypto/CMakeLists.txt`` |
+ | CMake files and headers | The CMake files are used by the TF-M CMake build system to | ``./secure_fw/partitions/crypto/CMakeLists.inc`` |
+ | | build the service as part of the Secure FW build. The service | ``./secure_fw/partitions/crypto/CMakeLists.txt`` |
| | is built as a static library (``tfm_crypto.a``). | ``./interface/include/tfm_crypto_defs.h`` |
- | | The build system allows to build as well the Mbed Crypto | ``./secure_fw/services/crypto/tfm_crypto_api.h`` |
- | | library as part of the Secure FW build process and archive it | ``./secure_fw/services/crypto/tfm_crypto_signal.h`` |
- | | with the static library of the Crypto service. | ``./secure_fw/services/crypto/spe_crypto.h`` |
+ | | The build system allows to build as well the Mbed Crypto | ``./secure_fw/partitions/crypto/tfm_crypto_api.h`` |
+ | | library as part of the Secure FW build process and archive it | ``./secure_fw/partitions/crypto/tfm_crypto_signal.h`` |
+ | | with the static library of the Crypto service. | ``./secure_fw/partitions/crypto/spe_crypto.h`` |
| | The headers are used to export the public prototypes of the | |
| | functions in the Service modules ``tfm_crypto_api.h``, and | |
| | to provide the necessary defines (i.e. ``TFM_CRYPTO_SIG``). | |
diff --git a/docs/design_documents/tfm_its_service.rst b/docs/design_documents/tfm_its_service.rst
index 27f9300..c2315ea 100644
--- a/docs/design_documents/tfm_its_service.rst
+++ b/docs/design_documents/tfm_its_service.rst
@@ -70,7 +70,7 @@
``secure_fw/ns_callable/tfm_veneers.c`` - ITS veneers (auto-generated from
manifest)
-``secure_fw/services/internal_trusted_storage/``
+``secure_fw/partitions/internal_trusted_storage/``
- ``tfm_internal_trusted_storage.yaml`` - Partition manifest
- ``tfm_its_secure_api.c`` - PSA ITS API implementation for SPE
diff --git a/docs/design_documents/tfm_partition_and_service_design_document.rst b/docs/design_documents/tfm_partition_and_service_design_document.rst
index e20f701..33edbe2 100644
--- a/docs/design_documents/tfm_partition_and_service_design_document.rst
+++ b/docs/design_documents/tfm_partition_and_service_design_document.rst
@@ -95,7 +95,7 @@
.. code-block:: c
- #include "secure_fw/services/tfm_spm_db.inc"
+ #include "secure_fw/partitions/tfm_spm_db.inc"
Built-in Partitions
===================
diff --git a/docs/user_guides/services/tfm_attestation_integration_guide.rst b/docs/user_guides/services/tfm_attestation_integration_guide.rst
index 364fbe4..e0399b4 100644
--- a/docs/user_guides/services/tfm_attestation_integration_guide.rst
+++ b/docs/user_guides/services/tfm_attestation_integration_guide.rst
@@ -127,7 +127,7 @@
to use functions from the PSA API is ``psa/initial_attestation.h``.
The TF-M Initial Attestation Service source files are located in
-``secure_fw/services/initial_attestation``.
+``secure_fw/partitions/initial_attestation``.
The CBOR library is located in ``lib/ext/qcbor`` folder.
Service source files
@@ -231,7 +231,7 @@
implementation for library model
- ``interface/src/tfm_initial_attestation_ipc_api.c``: non-secure interface
implementation for IPC model
-- ``secure_fw/services/initial_attestation/tfm_attestation_secure_api.c``:
+- ``secure_fw/partitions/initial_attestation/tfm_attestation_secure_api.c``:
secure interface implementation
Secure Partition Manager (SPM) interface
diff --git a/docs/user_guides/services/tfm_audit_integration_guide.rst b/docs/user_guides/services/tfm_audit_integration_guide.rst
index b82f816..248f0f9 100644
--- a/docs/user_guides/services/tfm_audit_integration_guide.rst
+++ b/docs/user_guides/services/tfm_audit_integration_guide.rst
@@ -40,7 +40,7 @@
``interface/include``.
The TF-M Audit logging service source files are located in
-``secure_fw/services/audit_logging``.
+``secure_fw/partitions/audit_logging``.
PSA interfaces
==============
diff --git a/docs/user_guides/services/tfm_crypto_integration_guide.rst b/docs/user_guides/services/tfm_crypto_integration_guide.rst
index f60bc76..4065930 100644
--- a/docs/user_guides/services/tfm_crypto_integration_guide.rst
+++ b/docs/user_guides/services/tfm_crypto_integration_guide.rst
@@ -16,7 +16,7 @@
The only header to be included by applications that want to use functions from
the PSA API is ``psa/crypto.h``.
The TF-M Crypto service source files are located in
-``secure_fw/services/crypto``.
+``secure_fw/partitions/crypto``.
PSA interfaces
==============
diff --git a/docs/user_guides/services/tfm_its_integration_guide.rst b/docs/user_guides/services/tfm_its_integration_guide.rst
index 9aff2d8..f668913 100644
--- a/docs/user_guides/services/tfm_its_integration_guide.rst
+++ b/docs/user_guides/services/tfm_its_integration_guide.rst
@@ -78,7 +78,7 @@
Code Structure
**************
TF-M Internal Trusted Storage service code is located in
-``secure_fw/services/internal_trusted_storage/`` and is divided as follows:
+``secure_fw/partitions/internal_trusted_storage/`` and is divided as follows:
- Core files
- Flash filesystem interfaces
@@ -254,7 +254,7 @@
update operations.
For API specification, please check:
-``secure_fw/services/internal_trusted_storage/flash/its_flash.h``
+``secure_fw/partitions/internal_trusted_storage/flash/its_flash.h``
ITS Service Features Flags
==========================
diff --git a/docs/user_guides/services/tfm_platform_integration_guide.rst b/docs/user_guides/services/tfm_platform_integration_guide.rst
index 767236e..7858435 100644
--- a/docs/user_guides/services/tfm_platform_integration_guide.rst
+++ b/docs/user_guides/services/tfm_platform_integration_guide.rst
@@ -22,7 +22,7 @@
The TF-M interfaces for the Platform service are located in
``interface/include/``.
The TF-M Platform service source files are located in
-``secure_fw/services/platform``.
+``secure_fw/partitions/platform``.
*********************
TF-M Platform service
diff --git a/docs/user_guides/services/tfm_secure_partition_addition.rst b/docs/user_guides/services/tfm_secure_partition_addition.rst
index bbb0ecc..174ae4e 100644
--- a/docs/user_guides/services/tfm_secure_partition_addition.rst
+++ b/docs/user_guides/services/tfm_secure_partition_addition.rst
@@ -64,7 +64,7 @@
Add source folder
=================
-Add a source folder under ``<TF-M base folder>/secure_fw/services`` for the new
+Add a source folder under ``<TF-M base folder>/secure_fw/partitions`` for the new
secure partition (Let's take EXAMPLE as the folder name):
This folder should include those parts:
@@ -299,7 +299,7 @@
{
"name": "Example Service",
"short_name": "TFM_SP_EXAMPLE",
- "manifest": "secure_fw/services/EXAMPLE/tfm_example.yaml",
+ "manifest": "secure_fw/partitions/EXAMPLE/tfm_example.yaml",
"tfm_extensions": true,
"tfm_partition_ipc": true,
"conditional": "TFM_PARTITION_EXAMPLE_ENABLE",
diff --git a/docs/user_guides/services/tfm_sst_integration_guide.rst b/docs/user_guides/services/tfm_sst_integration_guide.rst
index 4de5462..6c860d2 100644
--- a/docs/user_guides/services/tfm_sst_integration_guide.rst
+++ b/docs/user_guides/services/tfm_sst_integration_guide.rst
@@ -91,7 +91,7 @@
**************
Code Structure
**************
-Secure storage service code is located in ``secure_fw/services/secure_storage/``
+Secure storage service code is located in ``secure_fw/partitions/secure_storage/``
and is divided as follows:
- Core files
@@ -154,15 +154,15 @@
the external flash device.
The ITS filesystem and flash interfaces and their implementation can be found in
-``secure_fw/services/internal_trusted_storage/flash_fs`` and
-``secure_fw/services/internal_trusted_storage/flash`` respectively. More
+``secure_fw/partitions/internal_trusted_storage/flash_fs`` and
+``secure_fw/partitions/internal_trusted_storage/flash`` respectively. More
information about the filesystem and flash interfaces can be found in the
:doc:`ITS integration guide
</docs/user_guides/services/tfm_its_integration_guide>`.
The structure containing info about the external flash device, used by the ITS
service to handle requests from the SST partition, is defined in
-``secure_fw/services/internal_trusted_storage/flash/its_flash_info_external.c``,
+``secure_fw/partitions/internal_trusted_storage/flash/its_flash_info_external.c``,
which depends on target-specific definitions from
``platform/ext/target/<TARGET_NAME>/partition/flash_layout.h``. Please see the
`Secure Storage Service Definitions` section for details.
@@ -293,10 +293,10 @@
The SST service abstracts all the cryptographic requirements and specifies the
required cryptographic interface in
-``secure_fw/services/secure_storage/crypto/sst_crypto_interface.h``
+``secure_fw/partitions/secure_storage/crypto/sst_crypto_interface.h``
The SST service cryptographic operations are implemented in
-``secure_fw/services/secure_storage/crypto/sst_crypto_interface.c``, using calls
+``secure_fw/partitions/secure_storage/crypto/sst_crypto_interface.c``, using calls
to the TF-M Crypto service.
SST Service Features Flags