linux-crypto.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Eric Biggers <ebiggers@kernel.org>
To: linux-crypto@vger.kernel.org
Subject: [PATCH 25/30] crypto: ahash - improve file comment
Date: Sun, 22 Oct 2023 01:10:55 -0700	[thread overview]
Message-ID: <20231022081100.123613-26-ebiggers@kernel.org> (raw)
In-Reply-To: <20231022081100.123613-1-ebiggers@kernel.org>

From: Eric Biggers <ebiggers@google.com>

Improve the file comment for crypto/ahash.c.

Signed-off-by: Eric Biggers <ebiggers@google.com>
---
 crypto/ahash.c | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

diff --git a/crypto/ahash.c b/crypto/ahash.c
index 556c950100936..1ad402f4dac6c 100644
--- a/crypto/ahash.c
+++ b/crypto/ahash.c
@@ -1,16 +1,20 @@
 // SPDX-License-Identifier: GPL-2.0-or-later
 /*
  * Asynchronous Cryptographic Hash operations.
  *
- * This is the asynchronous version of hash.c with notification of
- * completion via a callback.
+ * This is the implementation of the ahash (asynchronous hash) API.  It differs
+ * from shash (synchronous hash) in that ahash supports asynchronous operations,
+ * and it hashes data from scatterlists instead of virtually addressed buffers.
+ *
+ * The ahash API provides access to both ahash and shash algorithms.  The shash
+ * API only provides access to shash algorithms.
  *
  * Copyright (c) 2008 Loc Ho <lho@amcc.com>
  */
 
 #include <crypto/scatterwalk.h>
 #include <linux/cryptouser.h>
 #include <linux/err.h>
 #include <linux/kernel.h>
 #include <linux/module.h>
 #include <linux/sched.h>
-- 
2.42.0


  parent reply	other threads:[~2023-10-22  8:19 UTC|newest]

Thread overview: 37+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-10-22  8:10 [PATCH 00/30] crypto: reduce ahash API overhead Eric Biggers
2023-10-22  8:10 ` [PATCH 01/30] crypto: shash - remove crypto_shash_ctx_aligned() Eric Biggers
2023-10-22  8:10 ` [PATCH 02/30] crypto: sun4i-ss - remove unnecessary alignmask for ahashes Eric Biggers
2023-10-25 13:15   ` Corentin Labbe
2023-10-22  8:10 ` [PATCH 03/30] crypto: sun8i-ce " Eric Biggers
2023-10-25 13:16   ` Corentin Labbe
2023-10-22  8:10 ` [PATCH 04/30] crypto: sun8i-ss " Eric Biggers
2023-10-25 13:16   ` Corentin Labbe
2023-10-22  8:10 ` [PATCH 05/30] crypto: atmel " Eric Biggers
2023-10-22  8:10 ` [PATCH 06/30] crypto: artpec6 - stop setting " Eric Biggers
2023-10-22  8:10 ` [PATCH 07/30] crypto: mxs-dcp - remove unnecessary " Eric Biggers
2023-10-22  8:10 ` [PATCH 08/30] crypto: s5p-sss " Eric Biggers
2023-10-22  8:10 ` [PATCH 09/30] crypto: talitos " Eric Biggers
2023-11-29 15:00   ` Christophe Leroy
2023-11-29 20:46     ` Eric Biggers
2023-10-22  8:10 ` [PATCH 10/30] crypto: omap-sham - stop setting " Eric Biggers
2023-10-22  8:10 ` [PATCH 11/30] crypto: rockchip - remove unnecessary " Eric Biggers
2023-10-22  8:10 ` [PATCH 12/30] crypto: starfive " Eric Biggers
2023-10-22  8:10 ` [PATCH 13/30] crypto: stm32 " Eric Biggers
2023-10-22  8:10 ` [PATCH 14/30] crypto: ahash - remove support for nonzero alignmask Eric Biggers
2023-10-22  8:10 ` [PATCH 15/30] crypto: authenc - stop using alignmask of ahash Eric Biggers
2023-10-22  8:10 ` [PATCH 16/30] crypto: authencesn " Eric Biggers
2023-10-22  8:10 ` [PATCH 17/30] crypto: testmgr - stop checking crypto_ahash_alignmask Eric Biggers
2023-10-22  8:10 ` [PATCH 18/30] net: ipv4: " Eric Biggers
2023-10-22  8:10 ` [PATCH 19/30] net: ipv6: " Eric Biggers
2023-10-22  8:10 ` [PATCH 20/30] crypto: ccm - stop using alignmask of ahash Eric Biggers
2023-10-22  8:10 ` [PATCH 21/30] crypto: chacha20poly1305 " Eric Biggers
2023-10-22  8:10 ` [PATCH 22/30] crypto: gcm " Eric Biggers
2023-10-22  8:10 ` [PATCH 23/30] crypto: ahash - remove crypto_ahash_alignmask Eric Biggers
2023-10-22  8:10 ` [PATCH 24/30] crypto: ahash - remove struct ahash_request_priv Eric Biggers
2023-10-22  8:10 ` Eric Biggers [this message]
2023-10-22  8:10 ` [PATCH 26/30] crypto: chelsio - stop using crypto_ahash::init Eric Biggers
2023-10-22  8:10 ` [PATCH 27/30] crypto: talitos " Eric Biggers
2023-10-22  8:10 ` [PATCH 28/30] crypto: hash - move "ahash wrapping shash" functions to ahash.c Eric Biggers
2023-10-22  8:10 ` [PATCH 29/30] crypto: ahash - check for shash type instead of not ahash type Eric Biggers
2023-10-22  8:11 ` [PATCH 30/30] crypto: ahash - optimize performance when wrapping shash Eric Biggers
2023-10-27 10:56 ` [PATCH 00/30] crypto: reduce ahash API overhead Herbert Xu

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=20231022081100.123613-26-ebiggers@kernel.org \
    --to=ebiggers@kernel.org \
    --cc=linux-crypto@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;
as well as URLs for NNTP newsgroup(s).