rpmsg: virtio: fix compilation warning for virtio_rpmsg_channel description
authorArnaud Pouliquen <arnaud.pouliquen@st.com>
Fri, 31 Jul 2020 07:48:50 +0000 (09:48 +0200)
committerBjorn Andersson <bjorn.andersson@linaro.org>
Tue, 15 Sep 2020 03:48:12 +0000 (03:48 +0000)
Complete the virtio_rpmsg_channel structure description to fix a
compilation warning with W=1 option:

drivers/rpmsg/virtio_rpmsg_bus.c:95: warning: Cannot understand
 * @vrp: the remote processor this channel belongs to

Reviewed-by: Mathieu Poirier <mathieu.poirier@linaro.org>
Signed-off-by: Arnaud Pouliquen <arnaud.pouliquen@st.com>
Link: https://lore.kernel.org/r/20200731074850.3262-1-arnaud.pouliquen@st.com
Signed-off-by: Bjorn Andersson <bjorn.andersson@linaro.org>
drivers/rpmsg/virtio_rpmsg_bus.c

index 9006fc7f73d09156b46558ff331efe78596c3d88..7d7ed4e5cce7b3d0cb281414f40e4d4694111b6c 100644 (file)
@@ -123,7 +123,12 @@ enum rpmsg_ns_flags {
 };
 
 /**
- * @vrp: the remote processor this channel belongs to
+ * struct virtio_rpmsg_channel - rpmsg channel descriptor
+ * @rpdev: the rpmsg channel device
+ * @vrp: the virtio remote processor device this channel belongs to
+ *
+ * This structure stores the channel that links the rpmsg device to the virtio
+ * remote processor device.
  */
 struct virtio_rpmsg_channel {
        struct rpmsg_device rpdev;