[PATCH -next] rapidio/tsi721: Fix some kernel-doc comments

[PATCH -next] rapidio/tsi721: Fix some kernel-doc comments

[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'

Reported-by: Abaci Robot <abaci@linux.alibaba.com>
Closes: https://bugzilla.openanolis.cn/show_bug.cgi?id=5997
Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
---
 drivers/rapidio/devices/tsi721.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/drivers/rapidio/devices/tsi721.c b/drivers/rapidio/devices/tsi721.c
index 83323c3d10af..3e67001702bc 100644
--- a/drivers/rapidio/devices/tsi721.c
+++ b/drivers/rapidio/devices/tsi721.c
@@ -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.
  */
-- 
2.20.1.7.g153144c

Re: [PATCH -next] rapidio/tsi721: Fix some kernel-doc comments

[Randy Dunlap]

On 7/26/23 19:08, Yang Li wrote:
> 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'
> 
> Reported-by: Abaci Robot <abaci@linux.alibaba.com>
> Closes: https://bugzilla.openanolis.cn/show_bug.cgi?id=5997
> Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>


Tested-by: Randy Dunlap <rdunlap@infradead.org>
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.

> ---
>  drivers/rapidio/devices/tsi721.c | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/drivers/rapidio/devices/tsi721.c b/drivers/rapidio/devices/tsi721.c
> index 83323c3d10af..3e67001702bc 100644
> --- a/drivers/rapidio/devices/tsi721.c
> +++ b/drivers/rapidio/devices/tsi721.c
> @@ -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.
>   */

-- 
~Randy