2020-09-03 18:05:48

by Krzysztof Kozlowski

[permalink] [raw]
Subject: [PATCH 2/3] crypto: s5p-sss - Add and fix kerneldoc

Add missing and fix existing kerneldoc to silence W=1 warnings:

drivers/crypto/s5p-sss.c:333: warning: Function parameter or member 'pclk' not described in 's5p_aes_dev'
drivers/crypto/s5p-sss.c:373: warning: Function parameter or member 'sgl' not described in 's5p_hash_reqctx'
drivers/crypto/s5p-sss.c:373: warning: Function parameter or member 'buffer' not described in 's5p_hash_reqctx'
drivers/crypto/s5p-sss.c:1143: warning: Function parameter or member 'new_len' not described in 's5p_hash_prepare_sgs'
drivers/crypto/s5p-sss.c:1143: warning: Excess function parameter 'nbytes' description in 's5p_hash_prepare_sgs'

Signed-off-by: Krzysztof Kozlowski <[email protected]>
---
drivers/crypto/s5p-sss.c | 7 ++++---
1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/drivers/crypto/s5p-sss.c b/drivers/crypto/s5p-sss.c
index 341433fbcc4a..f67f1e22ecd1 100644
--- a/drivers/crypto/s5p-sss.c
+++ b/drivers/crypto/s5p-sss.c
@@ -260,6 +260,7 @@ struct s5p_aes_ctx {
* struct s5p_aes_dev - Crypto device state container
* @dev: Associated device
* @clk: Clock for accessing hardware
+ * @pclk: APB bus clock necessary to access the hardware
* @ioaddr: Mapped IO memory region
* @aes_ioaddr: Per-varian offset for AES block IO memory
* @irq_fc: Feed control interrupt line
@@ -342,13 +343,13 @@ struct s5p_aes_dev {
* @engine: Bits for selecting type of HASH in SSS block
* @sg: sg for DMA transfer
* @sg_len: Length of sg for DMA transfer
- * @sgl[]: sg for joining buffer and req->src scatterlist
+ * @sgl: sg for joining buffer and req->src scatterlist
* @skip: Skip offset in req->src for current op
* @total: Total number of bytes for current request
* @finup: Keep state for finup or final.
* @error: Keep track of error.
* @bufcnt: Number of bytes holded in buffer[]
- * @buffer[]: For byte(s) from end of req->src in UPDATE op
+ * @buffer: For byte(s) from end of req->src in UPDATE op
*/
struct s5p_hash_reqctx {
struct s5p_aes_dev *dd;
@@ -1125,7 +1126,7 @@ static int s5p_hash_copy_sg_lists(struct s5p_hash_reqctx *ctx,
* s5p_hash_prepare_sgs() - prepare sg for processing
* @ctx: request context
* @sg: source scatterlist request
- * @nbytes: number of bytes to process from sg
+ * @new_len: number of bytes to process from sg
* @final: final flag
*
* Check two conditions: (1) if buffers in sg have len aligned data, and (2)
--
2.17.1


2020-09-04 09:07:55

by Kamil Konieczny

[permalink] [raw]
Subject: Re: [PATCH 2/3] crypto: s5p-sss - Add and fix kerneldoc



On 9/3/20 8:03 PM, Krzysztof Kozlowski wrote:
> Add missing and fix existing kerneldoc to silence W=1 warnings:
>
> drivers/crypto/s5p-sss.c:333: warning: Function parameter or member 'pclk' not described in 's5p_aes_dev'
> drivers/crypto/s5p-sss.c:373: warning: Function parameter or member 'sgl' not described in 's5p_hash_reqctx'
> drivers/crypto/s5p-sss.c:373: warning: Function parameter or member 'buffer' not described in 's5p_hash_reqctx'
> drivers/crypto/s5p-sss.c:1143: warning: Function parameter or member 'new_len' not described in 's5p_hash_prepare_sgs'
> drivers/crypto/s5p-sss.c:1143: warning: Excess function parameter 'nbytes' description in 's5p_hash_prepare_sgs'
>
> Signed-off-by: Krzysztof Kozlowski <[email protected]>
> ---
> drivers/crypto/s5p-sss.c | 7 ++++---
> 1 file changed, 4 insertions(+), 3 deletions(-)
>
> diff --git a/drivers/crypto/s5p-sss.c b/drivers/crypto/s5p-sss.c
> index 341433fbcc4a..f67f1e22ecd1 100644
> --- a/drivers/crypto/s5p-sss.c
> +++ b/drivers/crypto/s5p-sss.c
> @@ -260,6 +260,7 @@ struct s5p_aes_ctx {
> * struct s5p_aes_dev - Crypto device state container
> * @dev: Associated device
> * @clk: Clock for accessing hardware
> + * @pclk: APB bus clock necessary to access the hardware
> * @ioaddr: Mapped IO memory region
> * @aes_ioaddr: Per-varian offset for AES block IO memory
> * @irq_fc: Feed control interrupt line
> @@ -342,13 +343,13 @@ struct s5p_aes_dev {
> * @engine: Bits for selecting type of HASH in SSS block
> * @sg: sg for DMA transfer
> * @sg_len: Length of sg for DMA transfer
> - * @sgl[]: sg for joining buffer and req->src scatterlist
> + * @sgl: sg for joining buffer and req->src scatterlist
> * @skip: Skip offset in req->src for current op
> * @total: Total number of bytes for current request
> * @finup: Keep state for finup or final.
> * @error: Keep track of error.
> * @bufcnt: Number of bytes holded in buffer[]
> - * @buffer[]: For byte(s) from end of req->src in UPDATE op
> + * @buffer: For byte(s) from end of req->src in UPDATE op
> */
> struct s5p_hash_reqctx {
> struct s5p_aes_dev *dd;
> @@ -1125,7 +1126,7 @@ static int s5p_hash_copy_sg_lists(struct s5p_hash_reqctx *ctx,
> * s5p_hash_prepare_sgs() - prepare sg for processing
> * @ctx: request context
> * @sg: source scatterlist request
> - * @nbytes: number of bytes to process from sg
> + * @new_len: number of bytes to process from sg
> * @final: final flag
> *
> * Check two conditions: (1) if buffers in sg have len aligned data, and (2)
>

Reviewed-by: Kamil Konieczny <[email protected]>
Acked-by: Kamil Konieczny <[email protected]>