diff mbox series

[5/8] crypto: x86/sm3 - add kernel-doc comments to assembly

Message ID 20221215063857.161665-6-elliott@hpe.com
State New
Headers show
Series crypto: kernel-doc for assembly language | expand

Commit Message

Elliott, Robert (Servers) Dec. 15, 2022, 6:38 a.m. UTC 
Add kernel-doc comments for assembly language functions exported to
C glue code.

Signed-off-by: Robert Elliott <elliott@hpe.com>
---
 arch/x86/crypto/sm3-avx-asm_64.S | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)
diff mbox series

Patch

diff --git a/arch/x86/crypto/sm3-avx-asm_64.S b/arch/x86/crypto/sm3-avx-asm_64.S
index b12b9efb5ec5..d02ebe5e0bb5 100644
--- a/arch/x86/crypto/sm3-avx-asm_64.S
+++ b/arch/x86/crypto/sm3-avx-asm_64.S
@@ -321,19 +321,19 @@ 
 
 .text
 
-/*
- * Transform nblocks*64 bytes (nblocks*16 32-bit words) at DATA.
+/**
+ * sm3_transform_avx - Calculate SM3 hash using x86 AVX feature set
+ * @state:	address of 32-byte context (%rdi, RSTATE macro)
+ * @data:	address of data            (%rsi, RDATA macro);
+ *		must be at least 64 bytes and a multiple of 64 bytes
+ * @nblocks:	number of 64-byte blocks   (%rdx, RNBLKS macro);
+ *		must be >= 1
  *
- * void sm3_transform_avx(struct sm3_state *state,
- *                        const u8 *data, int nblocks);
+ * Return:	none. However, the @state buffer is updated.
+ * Prototype:	asmlinkage void sm3_transform_avx(u32 *state, const u8 *data, int nblocks);
  */
 .align 16
 SYM_FUNC_START(sm3_transform_avx)
-	/* input:
-	 *	%rdi: ctx, CTX
-	 *	%rsi: data (64*nblks bytes)
-	 *	%rdx: nblocks
-	 */
 	vzeroupper;
 
 	pushq %rbp;