public inbox for linux-doc@vger.kernel.org
 help / color / mirror / Atom feed
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	[thread overview]
Message-ID: <20221215063857.161665-8-elliott@hpe.com> (raw)
In-Reply-To: <20221215063857.161665-1-elliott@hpe.com>

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


  parent reply	other threads:[~2022-12-15  6:40 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-12-15  6:38 [PATCH 0/8] crypto: kernel-doc for assembly language Robert Elliott
2022-12-15  6:38 ` [PATCH 1/8] crypto: clean up kernel-doc headers Robert Elliott
2022-12-15  6:38 ` [PATCH 2/8] doc: support kernel-doc for asm functions Robert Elliott
2022-12-15  6:38 ` [PATCH 3/8] crypto: x86/sha - add kernel-doc comments to assembly Robert Elliott
2022-12-15  6:38 ` [PATCH 4/8] crypto: x86/crc " Robert Elliott
2022-12-15  6:38 ` [PATCH 5/8] crypto: x86/sm3 " Robert Elliott
2022-12-15  6:38 ` [PATCH 6/8] crypto: x86/ghash " Robert Elliott
2022-12-15  6:38 ` Robert Elliott [this message]
2022-12-15  6:38 ` [PATCH 8/8] crypto: x86/chacha " Robert Elliott
2022-12-19 18:55 ` [PATCH v2 0/8] crypto: kernel-doc for assembly language Robert Elliott
2022-12-19 18:55   ` [PATCH v2 1/8] crypto: clean up kernel-doc headers Robert Elliott
2022-12-19 18:55   ` [PATCH v2 2/8] doc: support kernel-doc for asm functions Robert Elliott
2022-12-19 18:55   ` [PATCH v2 3/8] crypto: x86/sha - add kernel-doc comments to assembly Robert Elliott
2022-12-19 18:55   ` [PATCH v2 4/8] crypto: x86/crc " Robert Elliott
2022-12-19 18:55   ` [PATCH v2 5/8] crypto: x86/sm3 " Robert Elliott
2022-12-19 18:55   ` [PATCH v2 6/8] crypto: x86/ghash " Robert Elliott
2022-12-20  6:01     ` Eric Biggers
2022-12-19 18:55   ` [PATCH v2 7/8] crypto: x86/blake2s " Robert Elliott
2022-12-19 18:55   ` [PATCH v2 8/8] crypto: x86/chacha " Robert Elliott
2022-12-20  6:05     ` Eric Biggers

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20221215063857.161665-8-elliott@hpe.com \
    --to=elliott@hpe.com \
    --cc=corbet@lwn.net \
    --cc=davem@davemloft.net \
    --cc=herbert@gondor.apana.org.au \
    --cc=linux-crypto@vger.kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox