From: Lee Jones <lee.jones@linaro.org>
To: lee.jones@linaro.org
Cc: linux-kernel@vger.kernel.org,
Herbert Xu <herbert@gondor.apana.org.au>,
"David S. Miller" <davem@davemloft.net>,
Shujuan Chen <shujuan.chen@stericsson.com>,
Joakim Bech <joakim.xx.bech@stericsson.com>,
Berne Hebark <berne.herbark@stericsson.com>,
Niklas Hernaeus <niklas.hernaeus@stericsson.com>,
Andreas Westin <andreas.westin@stericsson.com>,
linux-crypto@vger.kernel.org
Subject: [PATCH 04/20] crypto: ux500: hash: hash_core: Fix worthy kernel-doc headers and remove others
Date: Thu, 4 Feb 2021 11:09:44 +0000 [thread overview]
Message-ID: <20210204111000.2800436-5-lee.jones@linaro.org> (raw)
In-Reply-To: <20210204111000.2800436-1-lee.jones@linaro.org>
The ones remove here not only fail to conform to kernel-doc, but also
provide no value, so let's remove them completely in this case.
Fixes the following W=1 kernel build warning(s):
drivers/crypto/ux500/hash/hash_core.c:368: warning: Function parameter or member 'ctx' not described in 'hash_get_device_data'
drivers/crypto/ux500/hash/hash_core.c:368: warning: Excess function parameter 'hash_ctx' description in 'hash_get_device_data'
drivers/crypto/ux500/hash/hash_core.c:551: warning: expecting prototype for hash_init(). Prototype was for ux500_hash_init() instead
drivers/crypto/ux500/hash/hash_core.c:592: warning: Function parameter or member 'length' not described in 'hash_processblock'
drivers/crypto/ux500/hash/hash_core.c:1302: warning: expecting prototype for hash_update(). Prototype was for ahash_update() instead
drivers/crypto/ux500/hash/hash_core.c:1322: warning: expecting prototype for hash_final(). Prototype was for ahash_final() instead
drivers/crypto/ux500/hash/hash_core.c:1622: warning: Function parameter or member 'device_data' not described in 'ahash_algs_register_all'
drivers/crypto/ux500/hash/hash_core.c:1622: warning: expecting prototype for hash_algs_register_all(). Prototype was for ahash_algs_register_all() instead
drivers/crypto/ux500/hash/hash_core.c:1647: warning: Function parameter or member 'device_data' not described in 'ahash_algs_unregister_all'
drivers/crypto/ux500/hash/hash_core.c:1647: warning: expecting prototype for hash_algs_unregister_all(). Prototype was for ahash_algs_unregister_all() instead
Cc: Herbert Xu <herbert@gondor.apana.org.au>
Cc: "David S. Miller" <davem@davemloft.net>
Cc: Shujuan Chen <shujuan.chen@stericsson.com>
Cc: Joakim Bech <joakim.xx.bech@stericsson.com>
Cc: Berne Hebark <berne.herbark@stericsson.com>
Cc: Niklas Hernaeus <niklas.hernaeus@stericsson.com>
Cc: Andreas Westin <andreas.westin@stericsson.com>
Cc: linux-crypto@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
drivers/crypto/ux500/hash/hash_core.c | 15 +++++----------
1 file changed, 5 insertions(+), 10 deletions(-)
diff --git a/drivers/crypto/ux500/hash/hash_core.c b/drivers/crypto/ux500/hash/hash_core.c
index da284b0ea1b26..bcaf6ba3e9235 100644
--- a/drivers/crypto/ux500/hash/hash_core.c
+++ b/drivers/crypto/ux500/hash/hash_core.c
@@ -356,7 +356,7 @@ static int hash_enable_power(struct hash_device_data *device_data,
/**
* hash_get_device_data - Checks for an available hash device and return it.
- * @hash_ctx: Structure for the hash context.
+ * @ctx: Structure for the hash context.
* @device_data: Structure for the hash device.
*
* This function check for an available hash device and return it to
@@ -542,7 +542,7 @@ static bool hash_dma_valid_data(struct scatterlist *sg, int datasize)
}
/**
- * hash_init - Common hash init function for SHA1/SHA2 (SHA256).
+ * ux500_hash_init - Common hash init function for SHA1/SHA2 (SHA256).
* @req: The hash request for the job.
*
* Initialize structures.
@@ -585,6 +585,7 @@ static int ux500_hash_init(struct ahash_request *req)
* @device_data: Structure for the hash device.
* @message: Block (512 bits) of message to be written to
* the HASH hardware.
+ * @length: Message length
*
*/
static void hash_processblock(struct hash_device_data *device_data,
@@ -1295,7 +1296,7 @@ void hash_get_digest(struct hash_device_data *device_data,
}
/**
- * hash_update - The hash update function for SHA1/SHA2 (SHA256).
+ * ahash_update - The hash update function for SHA1/SHA2 (SHA256).
* @req: The hash request for the job.
*/
static int ahash_update(struct ahash_request *req)
@@ -1315,7 +1316,7 @@ static int ahash_update(struct ahash_request *req)
}
/**
- * hash_final - The hash final function for SHA1/SHA2 (SHA256).
+ * ahash_final - The hash final function for SHA1/SHA2 (SHA256).
* @req: The hash request for the job.
*/
static int ahash_final(struct ahash_request *req)
@@ -1615,9 +1616,6 @@ static struct hash_algo_template hash_algs[] = {
}
};
-/**
- * hash_algs_register_all -
- */
static int ahash_algs_register_all(struct hash_device_data *device_data)
{
int ret;
@@ -1640,9 +1638,6 @@ static int ahash_algs_register_all(struct hash_device_data *device_data)
return ret;
}
-/**
- * hash_algs_unregister_all -
- */
static void ahash_algs_unregister_all(struct hash_device_data *device_data)
{
int i;
--
2.25.1
next prev parent reply other threads:[~2021-02-04 11:11 UTC|newest]
Thread overview: 28+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-02-04 11:09 [PATCH 00/20] Rid W=1 warnings in Crypto Lee Jones
2021-02-04 11:09 ` [PATCH 01/20] crypto: hisilicon: sec_drv: Supply missing description for 'sec_queue_empty()'s 'queue' param Lee Jones
2021-02-04 11:09 ` [PATCH 02/20] crypto: bcm: util: Repair a couple of documentation formatting issues Lee Jones
2021-02-04 11:09 ` [PATCH 03/20] crypto: chelsio: chcr_core: File headers are not good candidates for kernel-doc Lee Jones
2021-02-04 11:09 ` Lee Jones [this message]
2021-02-04 11:09 ` [PATCH 05/20] crypto: bcm: spu: Fix formatting and misspelling issues Lee Jones
2021-02-04 11:09 ` [PATCH 06/20] crypto: keembay: ocs-hcu: Fix incorrectly named functions/structs Lee Jones
2021-02-04 17:53 ` Alessandrelli, Daniele
2021-02-04 18:55 ` Lee Jones
2021-02-05 14:35 ` Alessandrelli, Daniele
2021-02-04 11:09 ` [PATCH 07/20] crypto: bcm: spu2: Fix a whole host of kernel-doc misdemeanours Lee Jones
2021-02-04 11:09 ` [PATCH 08/20] crypto: ux500: cryp: Demote some conformant non-kernel headers fix another Lee Jones
2021-02-04 11:09 ` [PATCH 09/20] crypto: ux500: cryp_irq: File headers are not good kernel-doc candidates Lee Jones
2021-02-04 11:09 ` [PATCH 10/20] crypto: chelsio: chcr_algo: Fix a couple of kernel-doc issues caused by doc-rot Lee Jones
2021-02-04 11:09 ` [PATCH 11/20] crypto: ux500: cryp_core: Fix formatting issue and add description for 'session_id' Lee Jones
2021-02-04 11:09 ` [PATCH 12/20] crypto: atmel-ecc: Struct headers need to start with keyword 'struct' Lee Jones
2021-02-04 15:49 ` Tudor.Ambarus
2021-02-04 11:09 ` [PATCH 13/20] crypto: bcm: cipher: Provide description for 'req' and fix formatting issues Lee Jones
2021-02-04 11:09 ` [PATCH 14/20] crypto: caam: caampkc: Provide the name of the function Lee Jones
2021-02-08 19:44 ` Horia Geantă
2021-02-04 11:09 ` [PATCH 15/20] crypto: caam: caamalg_qi2: Supply a couple of 'fallback' related descriptions Lee Jones
2021-02-08 19:49 ` Horia Geantă
2021-02-04 11:09 ` [PATCH 16/20] crypto: vmx: Source headers are not good kernel-doc candidates Lee Jones
2021-02-04 11:09 ` [PATCH 17/20] crypto: nx: nx-aes-cbc: Headers comments should not be kernel-doc Lee Jones
2021-02-04 11:09 ` [PATCH 18/20] crypto: nx: nx_debugfs: Header " Lee Jones
2021-02-04 11:09 ` [PATCH 19/20] crypto: nx: Demote header comment and add description for 'nbytes' Lee Jones
2021-02-04 11:10 ` [PATCH 20/20] crypto: cavium: nitrox_isr: Demote non-compliant kernel-doc headers Lee Jones
2021-02-10 6:51 ` [PATCH 00/20] Rid W=1 warnings in Crypto 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=20210204111000.2800436-5-lee.jones@linaro.org \
--to=lee.jones@linaro.org \
--cc=andreas.westin@stericsson.com \
--cc=berne.herbark@stericsson.com \
--cc=davem@davemloft.net \
--cc=herbert@gondor.apana.org.au \
--cc=joakim.xx.bech@stericsson.com \
--cc=linux-crypto@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=niklas.hernaeus@stericsson.com \
--cc=shujuan.chen@stericsson.com \
/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).