Received-SPF: pass (google.com: domain of linux-crypto-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
From:   Robert Elliott <elliott@hpe.com>
To:     herbert@gondor.apana.org.au, davem@davemloft.net, corbet@lwn.net,
        linux-crypto@vger.kernel.org, linux-doc@vger.kernel.org,
        linux-kernel@vger.kernel.org
Cc:     Robert Elliott <elliott@hpe.com>
Subject: [PATCH 7/8] crypto: x86/blake2s - add kernel-doc comments to assembly
Date:   Thu, 15 Dec 2022 00:38:56 -0600
Message-Id: <20221215063857.161665-8-elliott@hpe.com>
In-Reply-To: <20221215063857.161665-1-elliott@hpe.com>
References: <20221215063857.161665-1-elliott@hpe.com>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Precedence: bulk

Add kernel-doc comments for assembly language functions exported to
C glue code.

Signed-off-by: Robert Elliott <elliott@hpe.com>
---
 arch/x86/crypto/blake2s-core.S | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/arch/x86/crypto/blake2s-core.S b/arch/x86/crypto/blake2s-core.S
index b50b35ff1fdb..7605e7d94fd2 100644
--- a/arch/x86/crypto/blake2s-core.S
+++ b/arch/x86/crypto/blake2s-core.S
@@ -46,6 +46,19 @@ SIGMA2:
 #endif /* CONFIG_AS_AVX512 */
 
 .text
+/**
+ * blake2s_compress_ssse3 - Calculate BLAKE2s hash using the x86 SSSE3 feature set
+ * @state:	pointer to 48-byte state (%rdi)
+ * @data:	pointer to data (%rsi)
+ * @nblocks:	number of 64-byte blocks of data (%rdx)
+ * @inc:	counter increment value (%rcx)
+ *
+ * This function supports 64-bit CPUs.
+ *
+ * Return:	none (but modifies state)
+ * Prototype:	asmlinkage void blake2s_compress_ssse3(struct blake2s_state *state, const u8 *data,
+ *						       unsigned int nblocks, u32 inc);
+ */
 SYM_FUNC_START(blake2s_compress_ssse3)
 	testq		%rdx,%rdx
 	je		.Lendofloop
@@ -175,6 +188,19 @@ SYM_FUNC_START(blake2s_compress_ssse3)
 SYM_FUNC_END(blake2s_compress_ssse3)
 
 #ifdef CONFIG_AS_AVX512
+/**
+ * blake2s_compress_avx512 - Calculate BLAKE2s hash using the x86 AVX-512VL feature set
+ * @state:	address of 48-byte state (%rdi)
+ * @data:	address of data (%rsi)
+ * @nblocks:	number of 64-byte blocks of data (%rdx)
+ * @inc:	counter increment value (%rcx)
+ *
+ * This function supports 64-bit CPUs.
+ *
+ * Return:	none (but modifies state)
+ * Prototype:	asmlinkage void blake2s_compress_avx512(struct blake2s_state *state, const u8 *data,
+ *							unsigned int nblocks, u32 inc);
+ */
 SYM_FUNC_START(blake2s_compress_avx512)
 	vmovdqu		(%rdi),%xmm0
 	vmovdqu		0x10(%rdi),%xmm1
-- 
2.38.1