linux-kernel - Re: [PATCH v2 8/8] crypto: x86/chacha - add kernel-doc comments to assembly

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <Y6FQtNgZy8lXKfiz@sol.localdomain>
Date:   Mon, 19 Dec 2022 22:05:40 -0800
From:   Eric Biggers <ebiggers@...nel.org>
To:     Robert Elliott <elliott@....com>
Cc:     herbert@...dor.apana.org.au, davem@...emloft.net, corbet@....net,
        linux-crypto@...r.kernel.org, linux-doc@...r.kernel.org,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH v2 8/8] crypto: x86/chacha - add kernel-doc comments to
 assembly

On Mon, Dec 19, 2022 at 12:55:55PM -0600, Robert Elliott wrote:
> +/**
> + * chacha_2block_xor_avx2 - Encrypt 2 blocks using the x86 AVX2 feature set
> + * @state:	address of input state matrix, s (%rdi)
> + * @dst:	address of up to 2 data blocks output, o (%rsi)
> + * @src:	address of up to 2 data blocks input, i (%rdx)
> + * @len:	input/output length in bytes (%rcx)
> + * @nrounds:	number of rounds (%r8d)
> + *
> + * This function encrypts two ChaCha blocks by loading the state
> + * matrix twice across four AVX registers. It performs matrix operations
> + * on four words in each matrix in parallel, but requires shuffling to
> + * rearrange the words after each round.

2 blocks, or up to 2 blocks?  What does that mean?

> + *
> + * Return:	none
> + * Prototype:	asmlinkage void chacha_2block_xor_avx2(u32 *state, u8 *dst, const u8 *src,
> + *						       unsigned int len, int nrounds);

When the return type is void, there is no need to write "Return: none".

- Eric