[PATCH 6/8] crypto: x86/ghash - add kernel-doc comments to assembly

Robert Elliott
2022-12-15T06:40:03Z

arch/x86/crypto/ghash-clmulni-intel_asm.S | 27 +++++++++++++++++++----
1 file changed, 23 insertions(+), 4 deletions(-)

diff --git a/arch/x86/crypto/ghash-clmulni-intel_asm.S b/arch/x86/crypto/ghash-clmulni-intel_asm.S
index 2bf871899920..09cf9271b83a 100644
--- a/arch/x86/crypto/ghash-clmulni-intel_asm.S
+++ b/arch/x86/crypto/ghash-clmulni-intel_asm.S
@@ -88,7 +88,16 @@ SYM_FUNC_START_LOCAL(__clmul_gf128mul_ble)
RET
SYM_FUNC_END(__clmul_gf128mul_ble)

-/* void clmul_ghash_mul(char *dst, const u128 *shash) */
+/**
+ * clmul_ghash_mul - Calculate GHASH final multiplication using x86 PCLMULQDQ instructions
+ * @dst: address of hash value to update (%rdi)
+ * @shash: address of hash context (%rsi)
+ *
+ * This supports 64-bit CPUs.
+ *
+ * Return: none (but @dst is updated)
+ * Prototype: asmlinkage void clmul_ghash_mul(char *dst, const u128 *shash)
+ */
SYM_FUNC_START(clmul_ghash_mul)
FRAME_BEGIN
movups (%rdi), DATA
@@ -102,9 +111,19 @@ SYM_FUNC_START(clmul_ghash_mul)
RET
SYM_FUNC_END(clmul_ghash_mul)

-/*
- * void clmul_ghash_update(char *dst, const char *src, unsigned int srclen,
- * const u128 *shash);
+/**
+ * clmul_ghash_update - Calculate GHASH using x86 PCLMULQDQ instructions
+ * @dst: address of hash value to update (%rdi)
+ * @src: address of data to hash (%rsi)
+ * @srclen: number of bytes in data buffer (%rdx);
+ * function does nothing and returns if below 16
+ * @shash: address of hash context (%rcx)
+ *
+ * This supports 64-bit CPUs.
+ *
+ * Return: none (but @dst is updated)
+ * Prototype: asmlinkage clmul_ghash_update(char *dst, const char *src,
+ * unsigned int srclen, const u128 *shash);
*/
SYM_FUNC_START(clmul_ghash_update)
FRAME_BEGIN
--
2.38.1