doxygen: Fixes to warnings for FWU and IA
Documentation is not aligned with the functions signatures,
and doxygen throws warnings.
Fix it.
At the same time, add missing references for 'component' field
in documentation for fwu_bootloader_xx.
Signed-off-by: Nicola Mazzucato <nicola.mazzucato@arm.com>
Change-Id: Ib101cf09067e986c460d69efab59f7a25ebe8594
diff --git a/secure_fw/partitions/firmware_update/bootloader/tfm_bootloader_fwu_abstraction.h b/secure_fw/partitions/firmware_update/bootloader/tfm_bootloader_fwu_abstraction.h
index 599ccc3..5230667 100644
--- a/secure_fw/partitions/firmware_update/bootloader/tfm_bootloader_fwu_abstraction.h
+++ b/secure_fw/partitions/firmware_update/bootloader/tfm_bootloader_fwu_abstraction.h
@@ -115,7 +115,7 @@
* revert when next time boot-up. Usually, this API is called after the running
* images have been verified as valid.
*
- * \param[in] candidates A list of components in TRIAL state.
+ * \param[in] trials A list of components in TRIAL state.
* \param[in] number Number of components in TRIAL state.
*
* \return PSA_SUCCESS On success
@@ -133,6 +133,8 @@
* The component is in STAGED state. Uninstall the staged image in the component
* so that this image will not be treated as a candidate next time boot-up.
*
+ * \param[in] component The identifier of the target component.
+ *
* \return PSA_SUCCESS On success
* PSA_ERROR_INSUFFICIENT_MEMORY
* PSA_ERROR_INSUFFICIENT_STORAGE
@@ -147,6 +149,8 @@
* The component is in TRIAL state. Mark the running image in the component as
* rejected.
*
+ * \param[in] component The identifier of the target component.
+ *
* \return PSA_SUCCESS On success
* PSA_ERROR_INSUFFICIENT_MEMORY
* PSA_ERROR_INSUFFICIENT_STORAGE
@@ -158,6 +162,8 @@
/**
* \brief The component is in FAILED or UPDATED state. Clean the staging area of the component.
*
+ * \param[in] component The identifier of the target component.
+ *
* \return PSA_SUCCESS On success
* PSA_ERROR_INVALID_ARGUMENT Invalid input parameter
* PSA_ERROR_STORAGE_FAILURE
diff --git a/secure_fw/partitions/initial_attestation/attest.h b/secure_fw/partitions/initial_attestation/attest.h
index 4d8212b..5b0e99f 100644
--- a/secure_fw/partitions/initial_attestation/attest.h
+++ b/secure_fw/partitions/initial_attestation/attest.h
@@ -48,7 +48,7 @@
* to service memory area
*
* \param[in] major_type Major type of TLV entries to copy
- * \param[out] ptr Pointer to the buffer to store the boot data
+ * \param[out] boot_data Pointer to the buffer to store the boot data
* \param[in] len Size of the buffer to store the boot data
*
* \return Returns error code as specified in \ref psa_attest_err_t
@@ -80,12 +80,14 @@
/*!
* \brief Get initial attestation token
*
- * \param[in] in_vec Pointer to in_vec array, which contains input data
- * to attestation service
- * \param[in] num_invec Number of elements in in_vec array
- * \param[in,out] out_vec Pointer out_vec array, which contains output data
- * to attestation service
- * \param[in] num_outvec Number of elements in out_vec array
+ * \param[in] challenge_buf Pointer to buffer where challenge input is
+ * stored.
+ * \param[in] challenge_size Size of challenge object in bytes.
+ * \param[out] token_buf Pointer to the buffer where attestation token
+ * will be stored.
+ * \param[in] token_buf_size Size of allocated buffer for token, in bytes.
+ * \param[out] token_size Size of the token that has been returned, in
+ * bytes.
*
* \return Returns error code as specified in \ref psa_status_t
*/
@@ -97,12 +99,10 @@
/**
* \brief Get the size of the initial attestation token
*
- * \param[in] in_vec Pointer to in_vec array, which contains input data
- * to attestation service
- * \param[in] num_invec Number of elements in in_vec array
- * \param[out] out_vec Pointer to out_vec array, which contains pointer
- * where to store the output data
- * \param[in] num_outvec Number of elements in out_vec array
+ * \param[in] challenge_size Size of challenge object in bytes. This must be
+ * a supported challenge size.
+ * \param[out] token_size Size of the token in bytes, which is created by
+ * initial attestation service.
*
* \return Returns error code as specified in \ref psa_status_t
*/