Update documentation

Signed-off-by: Gabor Mezei <gabor.mezei@arm.com>
This commit is contained in:
Gabor Mezei 2022-10-03 17:01:02 +02:00
parent 02e5d439db
commit dba2677597
No known key found for this signature in database
GPG key ID: F072ACA227ACD71D
2 changed files with 6 additions and 1 deletions

View file

@ -79,7 +79,7 @@ void mbedtls_mpi_core_bigendian_to_host( mbedtls_mpi_uint *A,
* the condition was true or not. * the condition was true or not.
* *
* \param[out] X The address of the first MPI. This must be initialized. * \param[out] X The address of the first MPI. This must be initialized.
* It must have at least \p limbs limbs. * Must have enough limbs to store the full value of \p A.
* \param[in] A The address of the second MPI. This must be initialized. * \param[in] A The address of the second MPI. This must be initialized.
* \param limbs The number of limbs of \p A. * \param limbs The number of limbs of \p A.
* \param assign The condition deciding whether to perform the * \param assign The condition deciding whether to perform the

View file

@ -37,7 +37,10 @@
* \brief Perform a safe conditional copy of MPI which doesn't reveal whether * \brief Perform a safe conditional copy of MPI which doesn't reveal whether
* the condition was true or not. * the condition was true or not.
* *
* The size to copy is determined by \p N.
*
* \param[out] X The address of the first MPI. This must be initialized. * \param[out] X The address of the first MPI. This must be initialized.
* Must have enough limbs to store the full value of \p A.
* \param[in] A The address of the second MPI. This must be initialized. * \param[in] A The address of the second MPI. This must be initialized.
* \param[in] N The address of the modulus related to \p X and \p A. * \param[in] N The address of the modulus related to \p X and \p A.
* \param assign The condition deciding whether to perform the * \param assign The condition deciding whether to perform the
@ -61,6 +64,8 @@ void mbedtls_mpi_mod_raw_cond_assign( mbedtls_mpi_uint *X,
* \brief Perform a safe conditional swap of MPI which doesn't reveal whether * \brief Perform a safe conditional swap of MPI which doesn't reveal whether
* the condition was true or not. * the condition was true or not.
* *
* The size to swap is determined by \p N.
*
* \param[in,out] X The address of the first MPI. This must be initialized. * \param[in,out] X The address of the first MPI. This must be initialized.
* \param[in,out] Y The address of the second MPI. This must be initialized. * \param[in,out] Y The address of the second MPI. This must be initialized.
* \param[in] N The address of the modulus related to \p X and \p Y. * \param[in] N The address of the modulus related to \p X and \p Y.