aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorGalanakis, Minos <minos.galanakis@arm.com>2020-01-21 15:27:14 +0000
committerMinos Galanakis <minos.galanakis@arm.com>2020-05-04 15:22:16 +0000
commitef5118b39700eb98bed37405a7b5a55aefa0fc88 (patch)
tree78c25a24641046b463039bb927afa856c73558e6 /docs
parent94d424a508d8b75befa9dc1c14a7e399dc120ba4 (diff)
downloadtrusted-firmware-m-ef5118b39700eb98bed37405a7b5a55aefa0fc88.tar.gz
Platform: Added a Non-Volatile counters service
This patch introduces a new platform service exposing the non-volatile counters. Secure partitions can use this secure API to access the initialisation, increment and read operations on the nv counters, by setting "TFM_SP_PLATFORM_NV_COUNTER" as a dependency. Change-Id: Ia564e24417dfd9bb95cc61634dbbea17caa5974c Signed-off-by: Minos Galanakis <minos.galanakis@arm.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/user_guides/services/tfm_platform_integration_guide.rst25
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/user_guides/services/tfm_platform_integration_guide.rst b/docs/user_guides/services/tfm_platform_integration_guide.rst
index db9d00dcee..767236e359 100644
--- a/docs/user_guides/services/tfm_platform_integration_guide.rst
+++ b/docs/user_guides/services/tfm_platform_integration_guide.rst
@@ -73,6 +73,31 @@ the service in ``out_vec``.
An IOCTL request type not supported on a particular platform should return
``TFM_PLATFORM_ERR_NOT_SUPPORTED``
+Non-Volatile counters
+=====================
+
+The Platform Service provides an abstracted service for exposing the NV counters
+to the secure world. The following operations are supported:
+
+- Increment a counter.
+- Read a counter value to a preallocated buffer.
+
+.. code-block:: c
+
+ enum tfm_platform_err_t
+ tfm_platform_nv_counter_increment(uint32_t counter_id);
+
+ enum tfm_platform_err_t
+ tfm_platform_nv_counter_read(uint32_t counter_id,
+ uint32_t size, uint8_t *val);
+
+The range of counters id is defined in :
+``platform/include/tfm_plat_nv_counters.h``
+
+For Level 2,3 isolation implementations, secure partitions in the
+Application Root of Trust, should have ``TFM_SP_PLATFORM_NV_COUNTER`` set as a
+dependency for access to the NV counter API.
+
***************************
Current Service Limitations
***************************