lib/mbedtls
1
0
Fork 0
mirror of https://github.com/Mbed-TLS/mbedtls.git synced 2025-08-07 06:42:56 +03:00
Code Activity

Fix documentation where ciL should be biL

Browse Source 
Signed-off-by: Tom Cosgrove <tom.cosgrove@arm.com>
This commit is contained in:
Tom Cosgrove
2022-08-31 17:09:29 +01:00
parent ed43c6caeb
commit 630110ab23
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
library/bignum_core.h
View File

@@ -181,7 +181,7 @@ int mbedtls_mpi_core_write_be( const mbedtls_mpi_uint *A,
* is unspecified, and the resulting value in \p A might be * is unspecified, and the resulting value in \p A might be
* neither its original value nor \p A + \p B. * neither its original value nor \p A + \p B.
* *
* \return 1 if `A + cond * B >= (2^{ciL})^limbs`, 0 otherwise. * \return 1 if `A + cond * B >= 2^(biL*limbs)`, 0 otherwise.
*/ */
mbedtls_mpi_uint mbedtls_mpi_core_add_if( mbedtls_mpi_uint *A, mbedtls_mpi_uint mbedtls_mpi_core_add_if( mbedtls_mpi_uint *A,
const mbedtls_mpi_uint *B, const mbedtls_mpi_uint *B,
@@ -192,7 +192,7 @@ mbedtls_mpi_uint mbedtls_mpi_core_add_if( mbedtls_mpi_uint *A,
* \brief Subtract two known-size large unsigned integers, returning the borrow. * \brief Subtract two known-size large unsigned integers, returning the borrow.
* *
* Calculate `A - B` where \p A and \p B have the same size. * Calculate `A - B` where \p A and \p B have the same size.
* This function operates modulo `(2^ciL)^limbs` and returns the carry * This function operates modulo `2^(biL*limbs)` and returns the carry
* (1 if there was a wraparound, i.e. if `A < B`, and 0 otherwise). * (1 if there was a wraparound, i.e. if `A < B`, and 0 otherwise).
* *
* \p X may be aliased to \p A or \p B, or even both, but may not overlap * \p X may be aliased to \p A or \p B, or even both, but may not overlap
@@ -248,8 +248,8 @@ mbedtls_mpi_uint mbedtls_mpi_montg_init( const mbedtls_mpi_uint *N );
* \param[out] X The destination MPI, as a little-endian array of * \param[out] X The destination MPI, as a little-endian array of
* length \p AN_limbs. * length \p AN_limbs.
* On successful completion, X contains the result of * On successful completion, X contains the result of
* the multiplication A * B * R^-1 mod N where * the multiplication `A * B * R^-1` mod N where
* R = (2^ciL)^AN_limbs. * `R = 2^(biL*AN_limbs)`.
* \param[in] A Little-endian presentation of first operand. * \param[in] A Little-endian presentation of first operand.
* Must have the same number of limbs as \p N. * Must have the same number of limbs as \p N.
* \param[in] B Little-endian presentation of second operand. * \param[in] B Little-endian presentation of second operand.
@@ -259,7 +259,7 @@ mbedtls_mpi_uint mbedtls_mpi_montg_init( const mbedtls_mpi_uint *N );
* This must be odd, and have exactly the same number * This must be odd, and have exactly the same number
* of limbs as \p A. * of limbs as \p A.
* \param[in] AN_limbs The number of limbs in \p X, \p A and \p N. * \param[in] AN_limbs The number of limbs in \p X, \p A and \p N.
* \param mm The Montgomery constant for \p N: -N^-1 mod 2^ciL. * \param mm The Montgomery constant for \p N: -N^-1 mod 2^biL.
* This can be calculated by `mbedtls_mpi_montg_init()`. * This can be calculated by `mbedtls_mpi_montg_init()`.
* \param[in,out] T Temporary storage of size at least 2*AN_limbs+1 limbs. * \param[in,out] T Temporary storage of size at least 2*AN_limbs+1 limbs.
* Its initial content is unused and * Its initial content is unused and