All of lore.kernel.org
 help / color / mirror / Atom feed
From: Cristian Marussi <cristian.marussi@arm.com>
To: Randy Dunlap <rdunlap@infradead.org>
Cc: linux-kernel@vger.kernel.org, Sudeep Holla <sudeep.holla@arm.com>,
	linux-arm-kernel@lists.infradead.org
Subject: Re: [PATCH] firmware: arm_scmi: optee: fix struct kernel-doc warnings
Date: Wed, 21 Feb 2024 10:52:33 +0000	[thread overview]
Message-ID: <ZdXV8Tlig2qeIGD2@pluto> (raw)
In-Reply-To: <20240221062157.8694-1-rdunlap@infradead.org>

On Tue, Feb 20, 2024 at 10:21:57PM -0800, Randy Dunlap wrote:
> Fix the kernel-doc notation for the nested union in struct
> scmi_optee_channel to eliminate kerenl-doc warnings:
> 
> optee.c:130: warning: Excess struct member 'shmem' description in 'scmi_optee_channel'
> optee.c:131: warning: Function parameter or struct member 'req' not described in 'scmi_optee_channel'

Thanks for this, I've spotted it recently and didn't get time to address it.

Reviewed-by: Cristian Marussi <cristian.marussi@arm.com>

Cristian

> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Sudeep Holla <sudeep.holla@arm.com>
> Cc: Cristian Marussi <cristian.marussi@arm.com>
> Cc: linux-arm-kernel@lists.infradead.org
> ---
>  drivers/firmware/arm_scmi/optee.c |    6 ++++--
>  1 file changed, 4 insertions(+), 2 deletions(-)
> 
> diff -- a/drivers/firmware/arm_scmi/optee.c b/drivers/firmware/arm_scmi/optee.c
> --- a/drivers/firmware/arm_scmi/optee.c
> +++ b/drivers/firmware/arm_scmi/optee.c
> @@ -109,8 +109,10 @@ enum scmi_optee_pta_cmd {
>   * @rx_len: Response size
>   * @mu: Mutex protection on channel access
>   * @cinfo: SCMI channel information
> - * @shmem: Virtual base address of the shared memory
> - * @req: Shared memory protocol handle for SCMI request and synchronous response
> + * @req: union for SCMI interface
> + * @req.shmem: Virtual base address of the shared memory
> + * @req.msg: Shared memory protocol handle for SCMI request and
> + *   synchronous response
>   * @tee_shm: TEE shared memory handle @req or NULL if using IOMEM shmem
>   * @link: Reference in agent's channel list
>   */

_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel

WARNING: multiple messages have this Message-ID (diff)
From: Cristian Marussi <cristian.marussi@arm.com>
To: Randy Dunlap <rdunlap@infradead.org>
Cc: linux-kernel@vger.kernel.org, Sudeep Holla <sudeep.holla@arm.com>,
	linux-arm-kernel@lists.infradead.org
Subject: Re: [PATCH] firmware: arm_scmi: optee: fix struct kernel-doc warnings
Date: Wed, 21 Feb 2024 10:52:33 +0000	[thread overview]
Message-ID: <ZdXV8Tlig2qeIGD2@pluto> (raw)
In-Reply-To: <20240221062157.8694-1-rdunlap@infradead.org>

On Tue, Feb 20, 2024 at 10:21:57PM -0800, Randy Dunlap wrote:
> Fix the kernel-doc notation for the nested union in struct
> scmi_optee_channel to eliminate kerenl-doc warnings:
> 
> optee.c:130: warning: Excess struct member 'shmem' description in 'scmi_optee_channel'
> optee.c:131: warning: Function parameter or struct member 'req' not described in 'scmi_optee_channel'

Thanks for this, I've spotted it recently and didn't get time to address it.

Reviewed-by: Cristian Marussi <cristian.marussi@arm.com>

Cristian

> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Sudeep Holla <sudeep.holla@arm.com>
> Cc: Cristian Marussi <cristian.marussi@arm.com>
> Cc: linux-arm-kernel@lists.infradead.org
> ---
>  drivers/firmware/arm_scmi/optee.c |    6 ++++--
>  1 file changed, 4 insertions(+), 2 deletions(-)
> 
> diff -- a/drivers/firmware/arm_scmi/optee.c b/drivers/firmware/arm_scmi/optee.c
> --- a/drivers/firmware/arm_scmi/optee.c
> +++ b/drivers/firmware/arm_scmi/optee.c
> @@ -109,8 +109,10 @@ enum scmi_optee_pta_cmd {
>   * @rx_len: Response size
>   * @mu: Mutex protection on channel access
>   * @cinfo: SCMI channel information
> - * @shmem: Virtual base address of the shared memory
> - * @req: Shared memory protocol handle for SCMI request and synchronous response
> + * @req: union for SCMI interface
> + * @req.shmem: Virtual base address of the shared memory
> + * @req.msg: Shared memory protocol handle for SCMI request and
> + *   synchronous response
>   * @tee_shm: TEE shared memory handle @req or NULL if using IOMEM shmem
>   * @link: Reference in agent's channel list
>   */

  reply	other threads:[~2024-02-21 10:52 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-02-21  6:21 [PATCH] firmware: arm_scmi: optee: fix struct kernel-doc warnings Randy Dunlap
2024-02-21  6:21 ` Randy Dunlap
2024-02-21 10:52 ` Cristian Marussi [this message]
2024-02-21 10:52   ` Cristian Marussi
2024-02-22  8:25 ` Sudeep Holla
2024-02-22  8:25   ` Sudeep Holla

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=ZdXV8Tlig2qeIGD2@pluto \
    --to=cristian.marussi@arm.com \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=rdunlap@infradead.org \
    --cc=sudeep.holla@arm.com \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.