Core: Refine veneer function description
Refine the description and some paramaters for veneer functions.
Change-Id: I6f22e9f2f6a419bb59f7b09a7c1d4756349ef7c0
Signed-off-by: Summer Qin <summer.qin@arm.com>
diff --git a/interface/include/tfm_api.h b/interface/include/tfm_api.h
index f3f3072..af2b492 100644
--- a/interface/include/tfm_api.h
+++ b/interface/include/tfm_api.h
@@ -20,18 +20,20 @@
/**
* \brief Checks if the provided client ID is a secure client ID.
*
- * \param[in] client_id Client ID to check
+ * \param[in] client_id Client ID to check.
*
- * \return Returns 1 if the client Id is secure. Otherwise, returns 0.
+ * \retval 1 Client ID is secure.
+ * \retval 0 Client ID is non-secure.
*/
#define TFM_CLIENT_ID_IS_S(client_id) ((client_id)>0)
/**
* \brief Checks if the provided client ID is a non-secure client ID.
*
- * \param[in] client_id Client ID to check
+ * \param[in] client_id Client ID to check.
*
- * \return Returns 1 if the client Id is non-secure. Otherwise, returns 0.
+ * \retval 1 Client ID is non-secure.
+ * \retval 0 Client ID is secure.
*/
#define TFM_CLIENT_ID_IS_NS(client_id) ((client_id)<0)
@@ -56,71 +58,71 @@
TFM_ERROR_GENERIC = 0x1F,
};
-//==================== Secure function declarations ==========================//
+/********************* Secure function declarations ***************************/
/**
- * \brief Assign client ID to the current TZ context
+ * \brief Assign client ID to the current TZ context.
*
- * \param[in] ns_client_id The client ID to be assigned to the current
- * context
- * \return TFM_SUCCESS if the client ID assigned successfully, an error code
- * according to \ref tfm_status_e in case of error.
- *
+ * \param[in] ns_client_id The client ID to be assigned to the current
+ * context.
+ * \retval TFM_SUCCESS The client ID assigned successfully.
+ * \retval error code The client ID assignment failed, an error code
+ * returned according to \ref tfm_status_e.
* \note This function have to be called from handler mode.
*/
enum tfm_status_e tfm_register_client_id (int32_t ns_client_id);
/**
- * \brief Retrieve the version of the PSA Framework API that is implemented
+ * \brief Retrieve the version of the PSA Framework API that is implemented.
*
- * \return The version of the PSA Framework
+ * \return The version of the PSA Framework.
*/
uint32_t tfm_psa_framework_version_veneer(void);
/**
- * \brief Return version of secure function provided by secure binary
+ * \brief Return version of secure function provided by secure binary.
*
- * \param[in] sid ID of secure service
+ * \param[in] sid ID of secure service.
*
- * \return Version number of secure function
+ * \return Version number of secure function.
*/
uint32_t tfm_psa_version_veneer(uint32_t sid);
/**
- * \brief Connect to secure function
+ * \brief Connect to secure function.
*
- * \param[in] sid ID of secure service
- * \param[in] version Version of SF requested by client
+ * \param[in] sid ID of secure service.
+ * \param[in] version Version of SF requested by client.
*
- * \return Returns handle to connection
+ * \return Returns handle to connection.
*/
psa_handle_t tfm_psa_connect_veneer(uint32_t sid, uint32_t version);
/**
- * \brief Call a secure function referenced by a connection handle
+ * \brief Call a secure function referenced by a connection handle.
*
- * \param[in] handle Handle to connection
- * \param[in] type The reuqest type. Must be zero(PSA_IPC_CALL) or
- * positive.
- * \param[in] in_vecs invec containing pointer/count of input vectors
- * \param[in] out_vecs invec containing pointer/count of output vectors
+ * \param[in] handle Handle to connection.
+ * \param[in] type The reuqest type. Must be zero(PSA_IPC_CALL) or
+ * positive.
+ * \param[in] in_vec Array of input \ref psa_invec structures.
+ * \param[in] out_vec Array of output \ref psa_invec structures.
*
- * \return Returns \ref psa_status_t status code
+ * \return Returns \ref psa_status_t status code.
*/
psa_status_t tfm_psa_call_veneer(psa_handle_t handle, int32_t type,
- const psa_invec *in_vecs,
- const psa_invec *out_vecs);
+ const psa_invec *in_vec,
+ const psa_invec *out_vec);
/**
- * \brief Close connection to secure function referenced by a connection handle
+ * \brief Close connection to secure function referenced by a connection handle.
*
- * \param[in] handle Handle to connection
+ * \param[in] handle Handle to connection
*
- * \return Returns \ref psa_status_t status code
+ * \return Returns \ref psa_status_t status code.
*/
psa_status_t tfm_psa_close_veneer(psa_handle_t handle);
-//================ End Secure function declarations ==========================//
+/***************** End Secure function declarations ***************************/
#ifdef __cplusplus
}