Reformat comments

This commit is contained in:
Frank Denis 2020-03-14 00:22:41 +01:00
parent a4e127567f
commit a89940d4aa
2 changed files with 17 additions and 15 deletions

View File

@ -106,7 +106,7 @@ blkxor(escrypt_block_t *dest, const escrypt_block_t *src, size_t len)
#endif #endif
} }
/** /*
* salsa20_8(B): * salsa20_8(B):
* Apply the salsa20/8 core to the provided block. * Apply the salsa20/8 core to the provided block.
*/ */
@ -168,11 +168,12 @@ salsa20_8(uint32_t B[16])
} }
} }
/** /*
* blockmix_salsa8(Bin, Bout, X, r): * blockmix_salsa8(Bin, Bout, X, r):
* Compute Bout = BlockMix_{salsa20/8, r}(Bin). The input Bin must be 128r * Compute Bout = BlockMix_{salsa20/8, r}(Bin).
* bytes in length; the output Bout must also be the same size. The * The input Bin must be 128r bytes in length;
* temporary space X must be 64 bytes. * The output Bout must also be the same size.
* The temporary space X must be 64 bytes.
*/ */
static void static void
blockmix_salsa8(const uint32_t *Bin, uint32_t *Bout, uint32_t *X, size_t r) blockmix_salsa8(const uint32_t *Bin, uint32_t *Bout, uint32_t *X, size_t r)
@ -207,7 +208,7 @@ blockmix_salsa8(const uint32_t *Bin, uint32_t *Bout, uint32_t *X, size_t r)
} }
} }
/** /*
* integerify(B, r): * integerify(B, r):
* Return the result of parsing B_{2r-1} as a little-endian integer. * Return the result of parsing B_{2r-1} as a little-endian integer.
*/ */
@ -219,7 +220,7 @@ integerify(const void *B, size_t r)
return ((uint64_t) (X[1]) << 32) + X[0]; return ((uint64_t) (X[1]) << 32) + X[0];
} }
/** /*
* smix(B, r, N, V, XY): * smix(B, r, N, V, XY):
* Compute B = SMix_r(B, N). The input B must be 128r bytes in length; * Compute B = SMix_r(B, N). The input B must be 128r bytes in length;
* the temporary storage V must be 128rN bytes in length; the temporary * the temporary storage V must be 128rN bytes in length; the temporary
@ -282,7 +283,7 @@ smix(uint8_t *B, size_t r, uint64_t N, uint32_t *V, uint32_t *XY)
} }
} }
/** /*
* escrypt_kdf(local, passwd, passwdlen, salt, saltlen, * escrypt_kdf(local, passwd, passwdlen, salt, saltlen,
* N, r, p, buf, buflen): * N, r, p, buf, buflen):
* Compute scrypt(passwd[0 .. passwdlen - 1], salt[0 .. saltlen - 1], N, r, * Compute scrypt(passwd[0 .. passwdlen - 1], salt[0 .. saltlen - 1], N, r,

View File

@ -85,7 +85,7 @@
X2 = _mm_shuffle_epi32(X2, 0x4E); \ X2 = _mm_shuffle_epi32(X2, 0x4E); \
X3 = _mm_shuffle_epi32(X3, 0x93); X3 = _mm_shuffle_epi32(X3, 0x93);
/** /*
* Apply the salsa20/8 core to the block provided in (X0 ... X3) ^ (Z0 ... Z3). * Apply the salsa20/8 core to the block provided in (X0 ... X3) ^ (Z0 ... Z3).
*/ */
# define SALSA20_8_XOR(in, out) \ # define SALSA20_8_XOR(in, out) \
@ -103,10 +103,11 @@
(out)[3] = X3 = _mm_add_epi32(X3, Y3); \ (out)[3] = X3 = _mm_add_epi32(X3, Y3); \
} }
/** /*
* blockmix_salsa8(Bin, Bout, r): * blockmix_salsa8(Bin, Bout, r):
* Compute Bout = BlockMix_{salsa20/8, r}(Bin). The input Bin must be 128r * Compute Bout = BlockMix_{salsa20/8, r}(Bin).
* bytes in length; the output Bout must also be the same size. * The input Bin must be 128r bytes in length;
* the output Bout must also be the same size.
*/ */
static inline void static inline void
blockmix_salsa8(const __m128i *Bin, __m128i *Bout, size_t r) blockmix_salsa8(const __m128i *Bin, __m128i *Bout, size_t r)
@ -208,7 +209,7 @@ blockmix_salsa8_xor(const __m128i *Bin1, const __m128i *Bin2, __m128i *Bout,
# undef XOR4 # undef XOR4
# undef XOR4_2 # undef XOR4_2
/** /*
* integerify(B, r): * integerify(B, r):
* Return the result of parsing B_{2r-1} as a little-endian integer. * Return the result of parsing B_{2r-1} as a little-endian integer.
* Note that B's layout is permuted compared to the generic implementation. * Note that B's layout is permuted compared to the generic implementation.
@ -221,7 +222,7 @@ integerify(const void *B, size_t r)
return *X; return *X;
} }
/** /*
* smix(B, r, N, V, XY): * smix(B, r, N, V, XY):
* Compute B = SMix_r(B, N). The input B must be 128r bytes in length; * Compute B = SMix_r(B, N). The input B must be 128r bytes in length;
* the temporary storage V must be 128rN bytes in length; the temporary * the temporary storage V must be 128rN bytes in length; the temporary
@ -297,7 +298,7 @@ smix(uint8_t *B, size_t r, uint64_t N, void *V, void *XY)
} }
} }
/** /*
* escrypt_kdf(local, passwd, passwdlen, salt, saltlen, * escrypt_kdf(local, passwd, passwdlen, salt, saltlen,
* N, r, p, buf, buflen): * N, r, p, buf, buflen):
* Compute scrypt(passwd[0 .. passwdlen - 1], salt[0 .. saltlen - 1], N, r, * Compute scrypt(passwd[0 .. passwdlen - 1], salt[0 .. saltlen - 1], N, r,