[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-ID: <5c4b306f-3075-b06d-4ed6-21271df2bd8d@nxp.com>
Date: Fri, 11 Sep 2020 12:16:09 +0300
From: Iuliana Prodan <iuliana.prodan@....com>
To: Krzysztof Kozlowski <krzk@...nel.org>,
Corentin Labbe <clabbe.montjoie@...il.com>,
Herbert Xu <herbert@...dor.apana.org.au>,
"David S. Miller" <davem@...emloft.net>,
Maxime Ripard <mripard@...nel.org>,
Chen-Yu Tsai <wens@...e.org>,
Horia Geantă <horia.geanta@....com>,
Aymen Sghaier <aymen.sghaier@....com>,
Maxime Coquelin <mcoquelin.stm32@...il.com>,
Alexandre Torgue <alexandre.torgue@...com>,
linux-crypto@...r.kernel.org, linux-arm-kernel@...ts.infradead.org,
linux-kernel@...r.kernel.org,
linux-stm32@...md-mailman.stormreply.com
Subject: Re: [PATCH v2 1/4] crypto: caam - Fix kerneldoc
On 9/10/2020 10:29 PM, Krzysztof Kozlowski wrote:
> Fix kerneldoc warnings like:
>
> 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'
> drivers/crypto/caam/ctrl.c:449: warning: Function parameter or member 'ctrl' not described in 'caam_get_era'
>
> Signed-off-by: Krzysztof Kozlowski <krzk@...nel.org>
Reviewed-by: Iuliana Prodan <iuliana.prodan@....com>
>
> ---
>
> Changes since v1:
> 1. Fix more warnings
> ---
> drivers/crypto/caam/caamalg_desc.c | 1 +
> drivers/crypto/caam/caamalg_qi2.c | 4 ++--
> drivers/crypto/caam/ctrl.c | 4 +++-
> drivers/crypto/caam/jr.c | 10 +++++-----
> 4 files changed, 11 insertions(+), 8 deletions(-)
>
> diff --git a/drivers/crypto/caam/caamalg_desc.c b/drivers/crypto/caam/caamalg_desc.c
> index d6c58184bb57..f0f0fdd1ef32 100644
> --- a/drivers/crypto/caam/caamalg_desc.c
> +++ b/drivers/crypto/caam/caamalg_desc.c
> @@ -373,6 +373,7 @@ EXPORT_SYMBOL(cnstr_shdsc_aead_encap);
> * with OP_ALG_AAI_HMAC_PRECOMP.
> * @ivsize: initialization vector size
> * @icvsize: integrity check value (ICV) size (truncated or full)
> + * @geniv: whether to generate Encrypted Chain IV
> * @is_rfc3686: true when ctr(aes) is wrapped by rfc3686 template
> * @nonce: pointer to rfc3686 nonce
> * @ctx1_iv_off: IV offset in CONTEXT1 register
> 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
> diff --git a/drivers/crypto/caam/ctrl.c b/drivers/crypto/caam/ctrl.c
> index 65de57f169d9..f7adcf6ecea5 100644
> --- a/drivers/crypto/caam/ctrl.c
> +++ b/drivers/crypto/caam/ctrl.c
> @@ -444,7 +444,9 @@ static int caam_get_era_from_hw(struct caam_ctrl __iomem *ctrl)
> * by u-boot.
> * In case this property is not passed an attempt to retrieve the CAAM
> * era via register reads will be made.
> - **/
> + *
> + * @ctrl: controller region
> + */
> static int caam_get_era(struct caam_ctrl __iomem *ctrl)
> {
> struct device_node *caam_node;
> diff --git a/drivers/crypto/caam/jr.c b/drivers/crypto/caam/jr.c
> index bf6b03b17251..6f669966ba2c 100644
> --- a/drivers/crypto/caam/jr.c
> +++ b/drivers/crypto/caam/jr.c
> @@ -324,7 +324,7 @@ EXPORT_SYMBOL(caam_jr_alloc);
>
> /**
> * caam_jr_free() - Free the Job Ring
> - * @rdev - points to the dev that identifies the Job ring to
> + * @rdev: points to the dev that identifies the Job ring to
> * be released.
> **/
> void caam_jr_free(struct device *rdev)
> @@ -349,15 +349,15 @@ EXPORT_SYMBOL(caam_jr_free);
> * of this request. This has the form:
> * callback(struct device *dev, u32 *desc, u32 stat, void *arg)
> * where:
> - * @dev: contains the job ring device that processed this
> + * dev: contains the job ring device that processed this
> * response.
> - * @desc: descriptor that initiated the request, same as
> + * desc: descriptor that initiated the request, same as
> * "desc" being argued to caam_jr_enqueue().
> - * @status: untranslated status received from CAAM. See the
> + * status: untranslated status received from CAAM. See the
> * reference manual for a detailed description of
> * error meaning, or see the JRSTA definitions in the
> * register header file
> - * @areq: optional pointer to an argument passed with the
> + * areq: optional pointer to an argument passed with the
> * original request
> * @areq: optional pointer to a user argument for use at callback
> * time.
>
Powered by blists - more mailing lists