Docs: Update Crypto docs
Updates the Crypto service documentation to reflect changes to the
code.
Change-Id: I5412348d9c1437a78c685cfa2f0a2f3bcea1ab62
Signed-off-by: Jamie Fox <jamie.fox@arm.com>
diff --git a/docs/design_documents/tfm_crypto_design.rst b/docs/design_documents/tfm_crypto_design.rst
index 9ad3312..d49c043 100644
--- a/docs/design_documents/tfm_crypto_design.rst
+++ b/docs/design_documents/tfm_crypto_design.rst
@@ -166,7 +166,7 @@
+-------------------------------+---------------------------+----------------------------------------------------------------+-----------------------------------------+----------------------------------------------------+
| **Parameter** | **Type** | **Description** | **Scope** | **Default** |
+===============================+===========================+================================================================+=========================================+====================================================+
- | ``CRYPTO_ENGINE_BUF_SIZE`` | CMake build | Buffer used by Mbed Crypto for its own allocations at runtime. | To be configured based on the desired | 1024 (bytes) |
+ | ``CRYPTO_ENGINE_BUF_SIZE`` | CMake build | Buffer used by Mbed Crypto for its own allocations at runtime. | To be configured based on the desired | 8096 (bytes) |
| | configuration parameter | This is a buffer allocated in static memory. | use case and application requirements. | |
+-------------------------------+---------------------------+----------------------------------------------------------------+-----------------------------------------+----------------------------------------------------+
| ``CRYPTO_CONC_OPER_NUM`` | CMake build | This parameter defines the maximum number of possible | To be configured based on the desire | 8 |
@@ -174,7 +174,7 @@
| | | for multi-part operations, that can be allocated simultaneously| | |
| | | at any time. | | |
+-------------------------------+---------------------------+----------------------------------------------------------------+-----------------------------------------+----------------------------------------------------+
- | ``CRYPTO_IOVEC_BUFFER_SIZE`` | CMake build | This parameter applies only to IPC mode builds. In IPC mode, | To be configured based on the desired | 1024 (bytes) |
+ | ``CRYPTO_IOVEC_BUFFER_SIZE`` | CMake build | This parameter applies only to IPC mode builds. In IPC mode, | To be configured based on the desired | 5120 (bytes) |
| | configuration parameter | during a Service call, input and outputs are allocated | use case and application requirements. | |
| | | temporarily in an internal scratch buffer whose size is | | |
| | | determined by this parameter. | | |
diff --git a/docs/user_guides/services/tfm_crypto_integration_guide.rst b/docs/user_guides/services/tfm_crypto_integration_guide.rst
index 214a3dc..ee391aa 100644
--- a/docs/user_guides/services/tfm_crypto_integration_guide.rst
+++ b/docs/user_guides/services/tfm_crypto_integration_guide.rst
@@ -12,11 +12,11 @@
**************
Code structure
**************
-The PSA interfaces for the Crypto service are located in ``interface\include``.
+The PSA interfaces for the Crypto service are located in ``interface/include``.
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/services/crypto``.
PSA interfaces
==============
@@ -33,8 +33,8 @@
- ``crypto_hash.c`` : This module handles requests for hashing operations
- ``crypto_mac.c`` : This module handles requests for MAC operations
- ``crypto_aead.c`` : This module handles requests for AEAD operations
-- ``crypto_generator.c`` : This module handles requests for generator related
- operations
+- ``crypto_key_derivation.c`` : This module handles requests for key derivation
+ related operations
- ``crypto_key.c`` : This module handles requests for key related operations
- ``crypto_asymmetric.c`` : This module handles requests for asymmetric
cryptographic operations
@@ -56,7 +56,7 @@
termination or an abort
- ``tfm_crypto_secure_api.c`` : This module implements the PSA Crypto API
client interface exposed to the Secure Processing Environment
-- ``tfm_crypto_api.c`` : This module is contained in ``interface\src`` and
+- ``tfm_crypto_api.c`` : This module is contained in ``interface/src`` and
implements the PSA Crypto API client interface exposed to the Non-Secure
Processing Environment.