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'
Signed-off-by: Randy Dunlap <[email protected]>
Cc: Sudeep Holla <[email protected]>
Cc: Cristian Marussi <[email protected]>
Cc: [email protected]
---
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
*/
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 <[email protected]>
Cristian
>
> Signed-off-by: Randy Dunlap <[email protected]>
> Cc: Sudeep Holla <[email protected]>
> Cc: Cristian Marussi <[email protected]>
> Cc: [email protected]
> ---
> 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
> */
On Tue, 20 Feb 2024 22:21:57 -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'
>
>
> [...]
Applied to sudeep.holla/linux (for-next/scmi/updates), thanks!
[1/1] firmware: arm_scmi: optee: fix struct kernel-doc warnings
https://git.kernel.org/sudeep.holla/c/a9c049f47e06
--
Regards,
Sudeep