lib/mbedtls
1
0
Fork 0
mirror of https://github.com/Mbed-TLS/mbedtls.git synced 2025-07-29 11:41:15 +03:00
Code Activity

Fix documentation

Browse Source 
Signed-off-by: Gabor Mezei <gabor.mezei@arm.com>
This commit is contained in:
Gabor Mezei
2022-11-23 13:09:43 +01:00
parent 3411e949cd
commit 02d2313829
1 changed files with 8 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
library/bignum_mod_raw.h
View File

@ -144,20 +144,22 @@ int mbedtls_mpi_mod_raw_write( const mbedtls_mpi_uint *A,
/* BEGIN MERGE SLOT 2 */ /* BEGIN MERGE SLOT 2 */
/** \brief Perform a subtraction of two MPIs and return the modulus /** \brief Subtract two MPIs, returning the residue modulo the specified
* of the result. * modulus.
* *
* The size of the operation is determined by \p N. * The size of the operation is determined by \p N. \p A and \p B must have
* the same number of limbs as \p N.
*
* \p X may be aliased to \p A or \p B, or even both, but may not overlap
* either otherwise.
* *
* \param[out] X The address of the result MPI. * \param[out] X The address of the result MPI.
* This must be initialized. Must have enough limbs to * This must be initialized. Must have enough limbs to
* store the full value of the result. * store the full value of the result.
* \param[in] A The address of the first MPI. This must be initialized. * \param[in] A The address of the first MPI. This must be initialized.
* \param[in] B The address of the second MPI. This must be initialized. * \param[in] B The address of the second MPI. This must be initialized.
* \param[in] N The address of the modulus. Use to perform a modulu * \param[in] N The address of the modulus. Used to perform a modulo
* operation on the result of the subtraction. * operation on the result of the subtraction.
*
* \note Both \p A and \p B must be smaller than the modulus \p N.
*/ */
void mbedtls_mpi_mod_raw_sub( mbedtls_mpi_uint *X, void mbedtls_mpi_mod_raw_sub( mbedtls_mpi_uint *X,
const mbedtls_mpi_uint *A, const mbedtls_mpi_uint *A,