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>,
linux-crypto@vger.kernel.org
Subject: [PATCH 05/20] crypto: bcm: spu: Fix formatting and misspelling issues
Date: Thu, 4 Feb 2021 11:09:45 +0000 [thread overview]
Message-ID: <20210204111000.2800436-6-lee.jones@linaro.org> (raw)
In-Reply-To: <20210204111000.2800436-1-lee.jones@linaro.org>
Fixes the following W=1 kernel build warning(s):
drivers/crypto/bcm/spu.c:464: warning: Excess function parameter 'Return' description in 'spum_gcm_ccm_pad_len'
drivers/crypto/bcm/spu.c:524: warning: Function parameter or member 'iv_len' not described in 'spum_aead_ivlen'
drivers/crypto/bcm/spu.c:524: warning: expecting prototype for spu_aead_ivlen(). Prototype was for spum_aead_ivlen() instead
drivers/crypto/bcm/spu.c:556: warning: Function parameter or member 'alg_digest_size' not described in 'spum_digest_size'
drivers/crypto/bcm/spu.c:556: warning: Function parameter or member 'alg' not described in 'spum_digest_size'
drivers/crypto/bcm/spu.c:556: warning: Function parameter or member 'htype' not described in 'spum_digest_size'
drivers/crypto/bcm/spu.c:583: warning: bad line:
drivers/crypto/bcm/spu.c:927: warning: Function parameter or member 'is_inbound' not described in 'spum_cipher_req_finish'
drivers/crypto/bcm/spu.c:927: warning: Excess function parameter 'isInbound' description in 'spum_cipher_req_finish'
Cc: Herbert Xu <herbert@gondor.apana.org.au>
Cc: "David S. Miller" <davem@davemloft.net>
Cc: linux-crypto@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
drivers/crypto/bcm/spu.c | 16 ++++++++--------
1 file changed, 8 insertions(+), 8 deletions(-)
diff --git a/drivers/crypto/bcm/spu.c b/drivers/crypto/bcm/spu.c
index 007abf92cc05b..6283e8c6d51d3 100644
--- a/drivers/crypto/bcm/spu.c
+++ b/drivers/crypto/bcm/spu.c
@@ -457,7 +457,7 @@ u16 spum_hash_pad_len(enum hash_alg hash_alg, enum hash_mode hash_mode,
* @cipher_mode: Algo type
* @data_size: Length of plaintext (bytes)
*
- * @Return: Length of padding, in bytes
+ * Return: Length of padding, in bytes
*/
u32 spum_gcm_ccm_pad_len(enum spu_cipher_mode cipher_mode,
unsigned int data_size)
@@ -510,10 +510,10 @@ u32 spum_assoc_resp_len(enum spu_cipher_mode cipher_mode,
}
/**
- * spu_aead_ivlen() - Calculate the length of the AEAD IV to be included
+ * spum_aead_ivlen() - Calculate the length of the AEAD IV to be included
* in a SPU request after the AAD and before the payload.
* @cipher_mode: cipher mode
- * @iv_ctr_len: initialization vector length in bytes
+ * @iv_len: initialization vector length in bytes
*
* In Linux ~4.2 and later, the assoc_data sg includes the IV. So no need
* to include the IV as a separate field in the SPU request msg.
@@ -543,9 +543,9 @@ enum hash_type spum_hash_type(u32 src_sent)
/**
* spum_digest_size() - Determine the size of a hash digest to expect the SPU to
* return.
- * alg_digest_size: Number of bytes in the final digest for the given algo
- * alg: The hash algorithm
- * htype: Type of hash operation (init, update, full, etc)
+ * @alg_digest_size: Number of bytes in the final digest for the given algo
+ * @alg: The hash algorithm
+ * @htype: Type of hash operation (init, update, full, etc)
*
* When doing incremental hashing for an algorithm with a truncated hash
* (e.g., SHA224), the SPU returns the full digest so that it can be fed back as
@@ -580,7 +580,7 @@ u32 spum_digest_size(u32 alg_digest_size, enum hash_alg alg,
* @aead_parms: Parameters related to AEAD operation
* @data_size: Length of data to be encrypted or authenticated. If AEAD, does
* not include length of AAD.
-
+ *
* Return: the length of the SPU header in bytes. 0 if an error occurs.
*/
u32 spum_create_request(u8 *spu_hdr,
@@ -911,7 +911,7 @@ u16 spum_cipher_req_init(u8 *spu_hdr, struct spu_cipher_parms *cipher_parms)
* setkey() time in spu_cipher_req_init().
* @spu_hdr: Start of the request message header (MH field)
* @spu_req_hdr_len: Length in bytes of the SPU request header
- * @isInbound: 0 encrypt, 1 decrypt
+ * @is_inbound: 0 encrypt, 1 decrypt
* @cipher_parms: Parameters describing cipher operation to be performed
* @data_size: Length of the data in the BD field
*
--
2.25.1
next prev parent reply other threads:[~2021-02-04 11:12 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 ` [PATCH 04/20] crypto: ux500: hash: hash_core: Fix worthy kernel-doc headers and remove others Lee Jones
2021-02-04 11:09 ` Lee Jones [this message]
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-6-lee.jones@linaro.org \
--to=lee.jones@linaro.org \
--cc=davem@davemloft.net \
--cc=herbert@gondor.apana.org.au \
--cc=linux-crypto@vger.kernel.org \
--cc=linux-kernel@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).