mirror/mbedtls
1
0
Fork 0
mirror of https://github.com/Mbed-TLS/mbedtls.git synced 2025-02-04 06:40:03 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Bignum Mod: improve documentation

Browse Source 
Signed-off-by: Janos Follath <janos.follath@arm.com>
This commit is contained in:
Janos Follath 2022-11-25 15:54:40 +00:00
parent fc6fbb4e96
commit ee530cc644
1 changed files with 4 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
library/bignum_mod.h
View File

@ -86,8 +86,7 @@ typedef struct {
* equivalent to \p m (in the sense that all their fields or memory pointed to by * equivalent to \p m (in the sense that all their fields or memory pointed to by
* their fields hold the same value). * their fields hold the same value).
* *
* \param[out] r The address of the residue to setup. The resulting structure's * \param[out] r The address of the residue to setup.
* size is determined by \p m.
* \param[in] m The address of the modulus related to \p r. * \param[in] m The address of the modulus related to \p r.
* \param[in] p The address of the limb array containing the value of \p r. * \param[in] p The address of the limb array containing the value of \p r.
* The memory pointed to by \p p will be used by \p r and must * The memory pointed to by \p p will be used by \p r and must
@ -96,8 +95,8 @@ typedef struct {
* pointed to by \p p must be less than the modulus (the value * pointed to by \p p must be less than the modulus (the value
* pointed to by `m->p`) and already in the representation * pointed to by `m->p`) and already in the representation
* indicated by `m->int_rep`. * indicated by `m->int_rep`.
* \param p_limbs The number of limbs of \p p. Must be <= the number of * \param p_limbs The number of limbs of \p p. Must be the same as the number
* limbs in the modulus \p m.) * of limbs in the modulus \p m.)
* *
* \return \c 0 if successful. * \return \c 0 if successful.
* \return #MBEDTLS_ERR_MPI_BAD_INPUT_DATA if \p p_limbs is less than the * \return #MBEDTLS_ERR_MPI_BAD_INPUT_DATA if \p p_limbs is less than the
@ -138,8 +137,7 @@ void mbedtls_mpi_mod_modulus_init( mbedtls_mpi_mod_modulus *m );
* associated with \p m (see #mbedtls_mpi_mod_rep_selector). * associated with \p m (see #mbedtls_mpi_mod_rep_selector).
* *
* \return \c 0 if successful. * \return \c 0 if successful.
* \return #MBEDTLS_ERR_MPI_BAD_INPUT_DATA if \p ext_rep or \p int_rep is * \return #MBEDTLS_ERR_MPI_BAD_INPUT_DATA if \p int_rep is invalid.
* invalid.
*/ */
int mbedtls_mpi_mod_modulus_setup( mbedtls_mpi_mod_modulus *m, int mbedtls_mpi_mod_modulus_setup( mbedtls_mpi_mod_modulus *m,
const mbedtls_mpi_uint *p, const mbedtls_mpi_uint *p,