2020-09-03 12:13:46

by Iuliana Prodan

Subject: Re: [PATCH 1/4] crypto: caam - Fix kerneldoc

On 9/2/2020 6:05 PM, Krzysztof Kozlowski wrote:
> Fix kerneldoc warnings:
>
> drivers/crypto/caam/caamalg_qi2.c:73: warning: cannot understand function prototype: 'struct caam_ctx '
> drivers/crypto/caam/caamalg_qi2.c:2962: warning: cannot understand function prototype: 'struct caam_hash_ctx '
>
> Signed-off-by: Krzysztof Kozlowski <[email protected]>
> ---
This LGTM, but, while here, can you, please, check the other kernel-doc
warnings:
drivers/crypto/caam/ctrl.c:449: warning: Function parameter or member
'ctrl' not described in 'caam_get_era'
drivers/crypto/caam/jr.c:331: warning: Function parameter or member
'rdev' not described in 'caam_jr_free'
drivers/crypto/caam/jr.c:369: warning: Excess function parameter
'status' description in 'caam_jr_enqueue'
drivers/crypto/caam/caamalg_desc.c:387: warning: Function parameter or
member 'geniv' not described in 'cnstr_shdsc_aead_decap'

Thanks,
Iulia

> drivers/crypto/caam/caamalg_qi2.c | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/drivers/crypto/caam/caamalg_qi2.c b/drivers/crypto/caam/caamalg_qi2.c
> index 66ae1d581168..0441e4ff2df2 100644
> --- a/drivers/crypto/caam/caamalg_qi2.c
> +++ b/drivers/crypto/caam/caamalg_qi2.c
> @@ -59,7 +59,7 @@ struct caam_skcipher_alg {
> };
>
> /**
> - * caam_ctx - per-session context
> + * struct caam_ctx - per-session context
> * @flc: Flow Contexts array
> * @key: [authentication key], encryption key
> * @flc_dma: I/O virtual addresses of the Flow Contexts
> @@ -2951,7 +2951,7 @@ enum hash_optype {
> };
>
> /**
> - * caam_hash_ctx - ahash per-session context
> + * struct caam_hash_ctx - ahash per-session context
> * @flc: Flow Contexts array
> * @key: authentication key
> * @flc_dma: I/O virtual addresses of the Flow Contexts
>

2020-09-03 12:32:54

by Krzysztof Kozlowski

Subject: Re: [PATCH 1/4] crypto: caam - Fix kerneldoc

On Thu, 3 Sep 2020 at 14:08, Iuliana Prodan <[email protected]> wrote:
>
> On 9/2/2020 6:05 PM, Krzysztof Kozlowski wrote:
> > Fix kerneldoc warnings:
> >
> > drivers/crypto/caam/caamalg_qi2.c:73: warning: cannot understand function prototype: 'struct caam_ctx '
> > drivers/crypto/caam/caamalg_qi2.c:2962: warning: cannot understand function prototype: 'struct caam_hash_ctx '
> >
> > Signed-off-by: Krzysztof Kozlowski <[email protected]>
> > ---
> This LGTM, but, while here, can you, please, check the other kernel-doc
> warnings:
> drivers/crypto/caam/ctrl.c:449: warning: Function parameter or member
> 'ctrl' not described in 'caam_get_era'
> drivers/crypto/caam/jr.c:331: warning: Function parameter or member
> 'rdev' not described in 'caam_jr_free'
> drivers/crypto/caam/jr.c:369: warning: Excess function parameter
> 'status' description in 'caam_jr_enqueue'
> drivers/crypto/caam/caamalg_desc.c:387: warning: Function parameter or
> member 'geniv' not described in 'cnstr_shdsc_aead_decap'

Sure, I'll take a look.

Best regards,
Krzysztof