[PATCH] lib/crypto/aesgcm.c:add kernel docs for aesgcm_mac

[PATCH] lib/crypto/aesgcm.c:add kernel docs for aesgcm_mac

[Sagar Vashnav]

Add kernel documentation for the aesgcm_mac.
This function generates the authentication tag using the AES-GCM algorithm.

Signed-off-by: Sagar Vashnav <sagarvashnav72427@gmail.com>
---
 lib/crypto/aesgcm.c | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/lib/crypto/aesgcm.c b/lib/crypto/aesgcm.c
index c632d6e17..eb55cc57a 100644
--- a/lib/crypto/aesgcm.c
+++ b/lib/crypto/aesgcm.c
@@ -73,6 +73,19 @@ static void aesgcm_ghash(be128 *ghash, const be128 *key, const void *src,
 	}
 }
 
+/**
+ * aesgcm_mac - Generates the authentication tag using AES-GCM algorithm.
+ * @ctx: The data structure that will hold the AES-GCM key schedule
+ * @src: The input source data.
+ * @src_len: Length of the source data.
+ * @assoc: Points to the associated data.
+ * @assoc_len: Length of the associated data values.
+ * @ctr: Points to the counter value.
+ * @authtag: The output buffer for the authentication tag.
+ *
+ * It takes in the AES-GCM context, source data, associated data, counter value,
+ * and an output buffer for the authentication tag.
+ */
 static void aesgcm_mac(const struct aesgcm_ctx *ctx, const u8 *src, int src_len,
 		       const u8 *assoc, int assoc_len, __be32 *ctr, u8 *authtag)
 {
-- 
2.34.1

Re: [PATCH] lib/crypto/aesgcm.c:add kernel docs for aesgcm_mac

[Herbert Xu]

On Wed, Oct 25, 2023 at 08:57:07AM -0400, Sagar Vashnav wrote:
> Add kernel documentation for the aesgcm_mac.
> This function generates the authentication tag using the AES-GCM algorithm.
> 
> Signed-off-by: Sagar Vashnav <sagarvashnav72427@gmail.com>
> ---
>  lib/crypto/aesgcm.c | 13 +++++++++++++
>  1 file changed, 13 insertions(+)

Patch applied.  Thanks.
-- 
Email: Herbert Xu <herbert@gondor.apana.org.au>
Home Page: http://gondor.apana.org.au/~herbert/
PGP Key: http://gondor.apana.org.au/~herbert/pubkey.txt