* [PATCH 16/20] crypto: vmx: Source headers are not good kernel-doc candidates
2021-02-04 11:09 [PATCH 00/20] Rid W=1 warnings in Crypto Lee Jones
@ 2021-02-04 11:09 ` Lee Jones
2021-02-04 11:09 ` [PATCH 17/20] crypto: nx: nx-aes-cbc: Headers comments should not be kernel-doc Lee Jones
` (3 subsequent siblings)
4 siblings, 0 replies; 6+ messages in thread
From: Lee Jones @ 2021-02-04 11:09 UTC (permalink / raw)
To: lee.jones
Cc: Herbert Xu, Nayna Jain, linux-kernel, Henrique Cerri,
Paulo Flabiano Smorigo, linux-crypto, Breno Leitão,
Paul Mackerras, linuxppc-dev, David S. Miller
Fixes the following W=1 kernel build warning(s):
drivers/crypto/vmx/vmx.c:23: warning: expecting prototype for Routines supporting VMX instructions on the Power 8(). Prototype was for p8_init() instead
Cc: "Breno Leitão" <leitao@debian.org>
Cc: Nayna Jain <nayna@linux.ibm.com>
Cc: Paulo Flabiano Smorigo <pfsmorigo@gmail.com>
Cc: Michael Ellerman <mpe@ellerman.id.au>
Cc: Benjamin Herrenschmidt <benh@kernel.crashing.org>
Cc: Paul Mackerras <paulus@samba.org>
Cc: Herbert Xu <herbert@gondor.apana.org.au>
Cc: "David S. Miller" <davem@davemloft.net>
Cc: Henrique Cerri <mhcerri@br.ibm.com>
Cc: linux-crypto@vger.kernel.org
Cc: linuxppc-dev@lists.ozlabs.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
drivers/crypto/vmx/vmx.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/drivers/crypto/vmx/vmx.c b/drivers/crypto/vmx/vmx.c
index a40d08e75fc0b..7eb713cc87c8c 100644
--- a/drivers/crypto/vmx/vmx.c
+++ b/drivers/crypto/vmx/vmx.c
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: GPL-2.0-only
-/**
+/*
* Routines supporting VMX instructions on the Power 8
*
* Copyright (C) 2015 International Business Machines Inc.
--
2.25.1
^ permalink raw reply related [flat|nested] 6+ messages in thread* [PATCH 17/20] crypto: nx: nx-aes-cbc: Headers comments should not be kernel-doc
2021-02-04 11:09 [PATCH 00/20] Rid W=1 warnings in Crypto Lee Jones
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 ` Lee Jones
2021-02-04 11:09 ` [PATCH 18/20] crypto: nx: nx_debugfs: Header " Lee Jones
` (2 subsequent siblings)
4 siblings, 0 replies; 6+ messages in thread
From: Lee Jones @ 2021-02-04 11:09 UTC (permalink / raw)
To: lee.jones
Cc: Herbert Xu, Kent Yoder, Nayna Jain, linux-kernel,
Paulo Flabiano Smorigo, linux-crypto, Breno Leitão,
Paul Mackerras, linuxppc-dev, David S. Miller
Fixes the following W=1 kernel build warning(s):
drivers/crypto/nx/nx-aes-cbc.c:24: warning: Function parameter or member 'tfm' not described in 'cbc_aes_nx_set_key'
drivers/crypto/nx/nx-aes-cbc.c:24: warning: Function parameter or member 'in_key' not described in 'cbc_aes_nx_set_key'
drivers/crypto/nx/nx-aes-cbc.c:24: warning: Function parameter or member 'key_len' not described in 'cbc_aes_nx_set_key'
drivers/crypto/nx/nx-aes-cbc.c:24: warning: expecting prototype for Nest Accelerators driver(). Prototype was for cbc_aes_nx_set_key() instead
Cc: "Breno Leitão" <leitao@debian.org>
Cc: Nayna Jain <nayna@linux.ibm.com>
Cc: Paulo Flabiano Smorigo <pfsmorigo@gmail.com>
Cc: Michael Ellerman <mpe@ellerman.id.au>
Cc: Benjamin Herrenschmidt <benh@kernel.crashing.org>
Cc: Paul Mackerras <paulus@samba.org>
Cc: Herbert Xu <herbert@gondor.apana.org.au>
Cc: "David S. Miller" <davem@davemloft.net>
Cc: Kent Yoder <yoder1@us.ibm.com>
Cc: linux-crypto@vger.kernel.org
Cc: linuxppc-dev@lists.ozlabs.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
drivers/crypto/nx/nx-aes-cbc.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/drivers/crypto/nx/nx-aes-cbc.c b/drivers/crypto/nx/nx-aes-cbc.c
index 92e921eceed75..d6314ea9ae896 100644
--- a/drivers/crypto/nx/nx-aes-cbc.c
+++ b/drivers/crypto/nx/nx-aes-cbc.c
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: GPL-2.0-only
-/**
+/*
* AES CBC routines supporting the Power 7+ Nest Accelerators driver
*
* Copyright (C) 2011-2012 International Business Machines Inc.
--
2.25.1
^ permalink raw reply related [flat|nested] 6+ messages in thread* [PATCH 18/20] crypto: nx: nx_debugfs: Header comments should not be kernel-doc
2021-02-04 11:09 [PATCH 00/20] Rid W=1 warnings in Crypto Lee Jones
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 ` Lee Jones
2021-02-04 11:09 ` [PATCH 19/20] crypto: nx: Demote header comment and add description for 'nbytes' Lee Jones
2021-02-10 6:51 ` [PATCH 00/20] Rid W=1 warnings in Crypto Herbert Xu
4 siblings, 0 replies; 6+ messages in thread
From: Lee Jones @ 2021-02-04 11:09 UTC (permalink / raw)
To: lee.jones
Cc: Herbert Xu, Kent Yoder, Nayna Jain, linux-kernel,
Paulo Flabiano Smorigo, linux-crypto, Breno Leitão,
Paul Mackerras, linuxppc-dev, David S. Miller
Fixes the following W=1 kernel build warning(s):
drivers/crypto/nx/nx_debugfs.c:34: warning: Function parameter or member 'drv' not described in 'nx_debugfs_init'
drivers/crypto/nx/nx_debugfs.c:34: warning: expecting prototype for Nest Accelerators driver(). Prototype was for nx_debugfs_init() instead
Cc: "Breno Leitão" <leitao@debian.org>
Cc: Nayna Jain <nayna@linux.ibm.com>
Cc: Paulo Flabiano Smorigo <pfsmorigo@gmail.com>
Cc: Michael Ellerman <mpe@ellerman.id.au>
Cc: Benjamin Herrenschmidt <benh@kernel.crashing.org>
Cc: Paul Mackerras <paulus@samba.org>
Cc: Herbert Xu <herbert@gondor.apana.org.au>
Cc: "David S. Miller" <davem@davemloft.net>
Cc: Kent Yoder <yoder1@us.ibm.com>
Cc: linux-crypto@vger.kernel.org
Cc: linuxppc-dev@lists.ozlabs.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
drivers/crypto/nx/nx_debugfs.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/drivers/crypto/nx/nx_debugfs.c b/drivers/crypto/nx/nx_debugfs.c
index 1975bcbee9974..ee7cd88bb10a7 100644
--- a/drivers/crypto/nx/nx_debugfs.c
+++ b/drivers/crypto/nx/nx_debugfs.c
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: GPL-2.0-only
-/**
+/*
* debugfs routines supporting the Power 7+ Nest Accelerators driver
*
* Copyright (C) 2011-2012 International Business Machines Inc.
--
2.25.1
^ permalink raw reply related [flat|nested] 6+ messages in thread
* [PATCH 19/20] crypto: nx: Demote header comment and add description for 'nbytes'
2021-02-04 11:09 [PATCH 00/20] Rid W=1 warnings in Crypto Lee Jones
` (2 preceding siblings ...)
2021-02-04 11:09 ` [PATCH 18/20] crypto: nx: nx_debugfs: Header " Lee Jones
@ 2021-02-04 11:09 ` Lee Jones
2021-02-10 6:51 ` [PATCH 00/20] Rid W=1 warnings in Crypto Herbert Xu
4 siblings, 0 replies; 6+ messages in thread
From: Lee Jones @ 2021-02-04 11:09 UTC (permalink / raw)
To: lee.jones
Cc: Herbert Xu, Kent Yoder, Nayna Jain, linux-kernel,
Paulo Flabiano Smorigo, linux-crypto, Breno Leitão,
Paul Mackerras, linuxppc-dev, David S. Miller
Fixes the following W=1 kernel build warning(s):
drivers/crypto/nx/nx.c:31: warning: Incorrect use of kernel-doc format: * nx_hcall_sync - make an H_COP_OP hcall for the passed in op structure
drivers/crypto/nx/nx.c:43: warning: Function parameter or member 'nx_ctx' not described in 'nx_hcall_sync'
drivers/crypto/nx/nx.c:43: warning: Function parameter or member 'op' not described in 'nx_hcall_sync'
drivers/crypto/nx/nx.c:43: warning: Function parameter or member 'may_sleep' not described in 'nx_hcall_sync'
drivers/crypto/nx/nx.c:43: warning: expecting prototype for Nest Accelerators driver(). Prototype was for nx_hcall_sync() instead
drivers/crypto/nx/nx.c:209: warning: Function parameter or member 'nbytes' not described in 'trim_sg_list'
Cc: "Breno Leitão" <leitao@debian.org>
Cc: Nayna Jain <nayna@linux.ibm.com>
Cc: Paulo Flabiano Smorigo <pfsmorigo@gmail.com>
Cc: Michael Ellerman <mpe@ellerman.id.au>
Cc: Benjamin Herrenschmidt <benh@kernel.crashing.org>
Cc: Paul Mackerras <paulus@samba.org>
Cc: Herbert Xu <herbert@gondor.apana.org.au>
Cc: "David S. Miller" <davem@davemloft.net>
Cc: Kent Yoder <yoder1@us.ibm.com>
Cc: linux-crypto@vger.kernel.org
Cc: linuxppc-dev@lists.ozlabs.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
drivers/crypto/nx/nx.c | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/drivers/crypto/nx/nx.c b/drivers/crypto/nx/nx.c
index 0d2dc5be7f192..010be6793c9fc 100644
--- a/drivers/crypto/nx/nx.c
+++ b/drivers/crypto/nx/nx.c
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: GPL-2.0-only
-/**
+/*
* Routines supporting the Power 7+ Nest Accelerators driver
*
* Copyright (C) 2011-2012 International Business Machines Inc.
@@ -200,7 +200,8 @@ struct nx_sg *nx_walk_and_build(struct nx_sg *nx_dst,
* @sg: sg list head
* @end: sg lisg end
* @delta: is the amount we need to crop in order to bound the list.
- *
+ * @nbytes: length of data in the scatterlists or data length - whichever
+ * is greater.
*/
static long int trim_sg_list(struct nx_sg *sg,
struct nx_sg *end,
--
2.25.1
^ permalink raw reply related [flat|nested] 6+ messages in thread* Re: [PATCH 00/20] Rid W=1 warnings in Crypto
2021-02-04 11:09 [PATCH 00/20] Rid W=1 warnings in Crypto Lee Jones
` (3 preceding siblings ...)
2021-02-04 11:09 ` [PATCH 19/20] crypto: nx: Demote header comment and add description for 'nbytes' Lee Jones
@ 2021-02-10 6:51 ` Herbert Xu
4 siblings, 0 replies; 6+ messages in thread
From: Herbert Xu @ 2021-02-10 6:51 UTC (permalink / raw)
To: Lee Jones
Cc: Alexandre Belloni, Aymen Sghaier, Takashi Iwai, Kent Yoder,
Ayush Sawal, Joakim Bech, Gustavo A. R. Silva, Paul Mackerras,
Andreas Westin, Breno Leitão, Atul Gupta, Niklas Hernaeus,
M R Gowda, Horia Geantă, Rohit Maheshwari, Nayna Jain,
Manoj Malviya, Ludovic Desroches, Jonas Linde, Rob Rice, Zaibo Xu,
Harsh Jain, Declan Murphy, Vinay Kumar Yadav, Tudor Ambarus,
Nicolas Ferre, Shujuan Chen, Henrique Cerri,
Daniele Alessandrelli, linux-arm-kernel, Jonathan Cameron,
linux-kernel, Berne Hebark, linux-crypto, Jitendra Lulla,
Paulo Flabiano Smorigo, linuxppc-dev, David S. Miller
On Thu, Feb 04, 2021 at 11:09:40AM +0000, Lee Jones wrote:
> This set is part of a larger effort attempting to clean-up W=1
> kernel builds, which are currently overwhelmingly riddled with
> niggly little warnings.
>
> This is set 1 of 2 sets required to fully clean Crypto.
>
> Lee Jones (20):
> crypto: hisilicon: sec_drv: Supply missing description for
> 'sec_queue_empty()'s 'queue' param
> crypto: bcm: util: Repair a couple of documentation formatting issues
> crypto: chelsio: chcr_core: File headers are not good candidates for
> kernel-doc
> crypto: ux500: hash: hash_core: Fix worthy kernel-doc headers and
> remove others
> crypto: bcm: spu: Fix formatting and misspelling issues
> crypto: keembay: ocs-hcu: Fix incorrectly named functions/structs
> crypto: bcm: spu2: Fix a whole host of kernel-doc misdemeanours
> crypto: ux500: cryp: Demote some conformant non-kernel headers fix
> another
> crypto: ux500: cryp_irq: File headers are not good kernel-doc
> candidates
> crypto: chelsio: chcr_algo: Fix a couple of kernel-doc issues caused
> by doc-rot
> crypto: ux500: cryp_core: Fix formatting issue and add description for
> 'session_id'
> crypto: atmel-ecc: Struct headers need to start with keyword 'struct'
> crypto: bcm: cipher: Provide description for 'req' and fix formatting
> issues
> crypto: caam: caampkc: Provide the name of the function
> crypto: caam: caamalg_qi2: Supply a couple of 'fallback' related
> descriptions
> crypto: vmx: Source headers are not good kernel-doc candidates
> crypto: nx: nx-aes-cbc: Headers comments should not be kernel-doc
> crypto: nx: nx_debugfs: Header comments should not be kernel-doc
> crypto: nx: Demote header comment and add description for 'nbytes'
> crypto: cavium: nitrox_isr: Demote non-compliant kernel-doc headers
Thanks for doing this. But please don't split the patches at the
file level. Instead split them at the driver level. For example,
all of your bcm changes should be one patch.
--
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
^ permalink raw reply [flat|nested] 6+ messages in thread