Skip to contentSkip to conversation

rapidio/tsi721: Fix some kernel-doc comments

PATCH In review Yang Li 2 participants 2 messages Jul 27, 2023 Rapidio

lore
Share & tools
lore

Yang Li

author
#0 lore raw

PATCH 1/1 rapidio/tsi721: Fix some kernel-doc comments

Fix some kernel-doc comments to silence the warnings:

drivers/rapidio/devices/tsi721.c:215: warning: Function parameter or member 'data' not described in 'tsi721_cread_dma' drivers/rapidio/devices/tsi721.c:215: warning: Excess function parameter 'val' description in 'tsi721_cread_dma' drivers/rapidio/devices/tsi721.c:238: warning: Function parameter or member 'data' not described in 'tsi721_cwrite_dma' drivers/rapidio/devices/tsi721.c:238: warning: Excess function parameter 'val' description in 'tsi721_cwrite_dma' drivers/rapidio/devices/tsi721.c:2548: warning: Function parameter or member 'attr' not described in 'tsi721_query_mport' drivers/rapidio/devices/tsi721.c:2548: warning: Excess function parameter 'mbox' description in 'tsi721_query_mport'

---
 drivers/rapidio/devices/tsi721.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
drivers/rapidio/devices/tsi721.c +3 -3
index 83323c3d10af..3e67001702bc 100644
@@ -205,7 +205,7 @@ static int tsi721_maint_dma(struct tsi721_device *priv, u32 sys_size,
  * @hopcount: Number of hops to target device
  * @offset: Offset into configuration space
  * @len: Length (in bytes) of the maintenance transaction
- * @val: Location to be read into
+ * @data: Location to be read into
  *
  * Generates a RapidIO maintenance read transaction.
  * Returns %0 on success and %-EINVAL or %-EFAULT on failure.
@@ -228,7 +228,7 @@ static int tsi721_cread_dma(struct rio_mport *mport, int index, u16 destid,
  * @hopcount: Number of hops to target device
  * @offset: Offset into configuration space
  * @len: Length (in bytes) of the maintenance transaction
- * @val: Value to be written
+ * @data: Value to be written
  *
  * Generates a RapidIO maintenance write transaction.
  * Returns %0 on success and %-EINVAL or %-EFAULT on failure.
@@ -2539,7 +2539,7 @@ static int tsi721_messages_init(struct tsi721_device *priv)
 /**
  * tsi721_query_mport - Fetch inbound message from the Tsi721 MSG Queue
  * @mport: Master port implementing the Inbound Messaging Engine
- * @mbox: Inbound mailbox number
+ * @attr: RIO mport device attributes
  *
  * Returns pointer to the message on success or NULL on failure.
  */
Signature · 1 line
2.20.1.7.g153144c
Tested-by Reviewed-by on v1 1/1
#1 lore raw
Quoted 9 lines · Yang Li

Fix some kernel-doc comments to silence the warnings:

drivers/rapidio/devices/tsi721.c:215: warning: Function parameter or member 'data' not described in 'tsi721_cread_dma' drivers/rapidio/devices/tsi721.c:215: warning: Excess function parameter 'val' description in 'tsi721_cread_dma' drivers/rapidio/devices/tsi721.c:238: warning: Function parameter or member 'data' not described in 'tsi721_cwrite_dma' drivers/rapidio/devices/tsi721.c:238: warning: Excess function parameter 'val' description in 'tsi721_cwrite_dma' drivers/rapidio/devices/tsi721.c:2548: warning: Function parameter or member 'attr' not described in 'tsi721_query_mport' drivers/rapidio/devices/tsi721.c:2548: warning: Excess function parameter 'mbox' description in 'tsi721_query_mport'

Quoted 3 lines

Thanks.

Quoted 35 lines
---
 drivers/rapidio/devices/tsi721.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
drivers/rapidio/devices/tsi721.c +3 -3
index 83323c3d10af..3e67001702bc 100644
@@ -205,7 +205,7 @@ static int tsi721_maint_dma(struct tsi721_device *priv, u32 sys_size,
  * @hopcount: Number of hops to target device
  * @offset: Offset into configuration space
  * @len: Length (in bytes) of the maintenance transaction
- * @val: Location to be read into
+ * @data: Location to be read into
  *
  * Generates a RapidIO maintenance read transaction.
  * Returns %0 on success and %-EINVAL or %-EFAULT on failure.
@@ -228,7 +228,7 @@ static int tsi721_cread_dma(struct rio_mport *mport, int index, u16 destid,
  * @hopcount: Number of hops to target device
  * @offset: Offset into configuration space
  * @len: Length (in bytes) of the maintenance transaction
- * @val: Value to be written
+ * @data: Value to be written
  *
  * Generates a RapidIO maintenance write transaction.
  * Returns %0 on success and %-EINVAL or %-EFAULT on failure.
@@ -2539,7 +2539,7 @@ static int tsi721_messages_init(struct tsi721_device *priv)
 /**
  * tsi721_query_mport - Fetch inbound message from the Tsi721 MSG Queue
  * @mport: Master port implementing the Inbound Messaging Engine
- * @mbox: Inbound mailbox number
+ * @attr: RIO mport device attributes
  *
  * Returns pointer to the message on success or NULL on failure.
  */
Signature · 1 line
~Randy