Re: [PATCH] rpmsg: ctrl: use kernel-doc format for ioctl macros

[Mathieu Poirier]

On Wed, 29 Jul 2026 at 23:29, Randy Dunlap <rdunlap@xxxxxxxxxxxxx> wrote:
>
> Convert the ioctl macros to kernel-doc format to avoid kernel-doc
> warnings:
>
> Warning: include/uapi/linux/rpmsg.h:26 This comment starts with '/**',
>  but isn't a kernel-doc comment.
>  * Instantiate a new rmpsg char device endpoint.
> Warning: include/uapi/linux/rpmsg.h:31 This comment starts with '/**',
>  but isn't a kernel-doc comment.
>  * Destroy a rpmsg char device endpoint created by the RPMSG_CREATE_EPT_IOCTL.
> Warning: include/uapi/linux/rpmsg.h:36 This comment starts with '/**',
>  but isn't a kernel-doc comment.
>  * Instantiate a new local rpmsg service device.
> Warning: include/uapi/linux/rpmsg.h:41 This comment starts with '/**',
>  but isn't a kernel-doc comment.
>  * Release a local rpmsg device.
> Warning: include/uapi/linux/rpmsg.h:46 This comment starts with '/**',
>  but isn't a kernel-doc comment.
>  * Get the flow control state of the remote rpmsg char device.
> Warning: include/uapi/linux/rpmsg.h:51 This comment starts with '/**',
>  but isn't a kernel-doc comment.
>  * Set the flow control state of the local rpmsg char device.
>
> Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
> ---
> Cc: Bjorn Andersson <andersson@xxxxxxxxxx>
> Cc: Mathieu Poirier <mathieu.poirier@xxxxxxxxxx>
> Cc: linux-remoteproc@xxxxxxxxxxxxxxx
>

If Bjorn doesn't do so in his PR for this merge window, I'll pick this
up when rc1 comes out.

Thanks,
Mathieu

>  include/uapi/linux/rpmsg.h |   15 +++++++++------
>  1 file changed, 9 insertions(+), 6 deletions(-)
>
> --- linux-next-20260729.orig/include/uapi/linux/rpmsg.h
> +++ linux-next-20260729/include/uapi/linux/rpmsg.h
> @@ -24,32 +24,35 @@ struct rpmsg_endpoint_info {
>  };
>
>  /**
> - * Instantiate a new rmpsg char device endpoint.
> + * RPMSG_CREATE_EPT_IOCTL - Instantiate a new rmpsg char device endpoint.
>   */
>  #define RPMSG_CREATE_EPT_IOCTL _IOW(0xb5, 0x1, struct rpmsg_endpoint_info)
>
>  /**
> - * Destroy a rpmsg char device endpoint created by the RPMSG_CREATE_EPT_IOCTL.
> + * RPMSG_DESTROY_EPT_IOCTL - Destroy a rpmsg char device endpoint created
> + * by the RPMSG_CREATE_EPT_IOCTL.
>   */
>  #define RPMSG_DESTROY_EPT_IOCTL        _IO(0xb5, 0x2)
>
>  /**
> - * Instantiate a new local rpmsg service device.
> + * RPMSG_CREATE_DEV_IOCTL - Instantiate a new local rpmsg service device.
>   */
>  #define RPMSG_CREATE_DEV_IOCTL _IOW(0xb5, 0x3, struct rpmsg_endpoint_info)
>
>  /**
> - * Release a local rpmsg device.
> + * RPMSG_RELEASE_DEV_IOCTL - Release a local rpmsg device.
>   */
>  #define RPMSG_RELEASE_DEV_IOCTL        _IOW(0xb5, 0x4, struct rpmsg_endpoint_info)
>
>  /**
> - * Get the flow control state of the remote rpmsg char device.
> + * RPMSG_GET_OUTGOING_FLOWCONTROL - Get the flow control state of the
> + * remote rpmsg char device.
>   */
>  #define RPMSG_GET_OUTGOING_FLOWCONTROL _IOR(0xb5, 0x5, int)
>
>  /**
> - * Set the flow control state of the local rpmsg char device.
> + * RPMSG_SET_INCOMING_FLOWCONTROL - Set the flow control state of the
> + * local rpmsg char device.
>   */
>  #define RPMSG_SET_INCOMING_FLOWCONTROL _IOR(0xb5, 0x6, int)
>