Message-ID: <efb1de24-059d-4bd0-8578-d3f47ef8e432@amd.com>
Date: Mon, 15 Dec 2025 09:04:56 +0100
From: Michal Simek <michal.simek@....com>
To: Randy Dunlap <rdunlap@...radead.org>, linux-kernel@...r.kernel.org
Cc: Arnd Bergmann <arnd@...db.de>,
 Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
 linux-arm-kernel@...ts.infradead.org
Subject: Re: [PATCH] xilinx_hwicap: fifo_icap.c: fix all kernel-doc warnings



On 12/14/25 20:17, Randy Dunlap wrote:
> Modify comments in fifo_icap.c to prevent all kernel-doc warnings:
> 
> Warning: fifo_icap.c:51 This comment starts with '/**', but isn't a
>   kernel-doc comment.
>   * HwIcap Device Interrupt Status/Enable Registers
> Warning: fifo_icap.c:106 No description found for return value
>   of 'fifo_icap_fifo_read'
> Warning: fifo_icap.c:160 No description found for return value
>   of 'fifo_icap_get_status'
> Warning: fifo_icap.c:171 No description found for return value
>   of 'fifo_icap_busy'
> Warning: fifo_icap.c:184 No description found for return value
>   of 'fifo_icap_write_fifo_vacancy'
> Warning: fifo_icap.c:196 No description found for return value
>   of 'fifo_icap_read_fifo_occupancy'
> Warning: fifo_icap.c:207 bad line:
> Warning: fifo_icap.c:214 No description found for return value
>   of 'fifo_icap_set_configuration'
> Warning: fifo_icap.c:290 function parameter 'frame_buffer' not described
>   in 'fifo_icap_get_configuration'
> Warning: fifo_icap.c:290 function parameter 'num_words' not described
>   in 'fifo_icap_get_configuration'
> Warning: fifo_icap.c:290 No description found for return value
>   of 'fifo_icap_get_configuration'
> Warning: fifo_icap.c:357 expecting prototype for buffer_icap_reset().
>   Prototype was for fifo_icap_reset() instead
> 
> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
> ---
> Cc: Arnd Bergmann <arnd@...db.de>
> Cc: Greg Kroah-Hartman <gregkh@...uxfoundation.org>
> Cc: Michal Simek <michal.simek@....com>
> Cc: linux-arm-kernel@...ts.infradead.org
> ---
>   drivers/char/xilinx_hwicap/fifo_icap.c |   27 ++++++++++++++++-------
>   1 file changed, 19 insertions(+), 8 deletions(-)
> 
> --- linux-next-20251128.orig/drivers/char/xilinx_hwicap/fifo_icap.c
> +++ linux-next-20251128/drivers/char/xilinx_hwicap/fifo_icap.c
> @@ -48,7 +48,7 @@
>   
>   #define XHI_GIER_GIE_MASK 0x80000000 /* Global Interrupt enable Mask */
>   
> -/**
> +/*
>    * HwIcap Device Interrupt Status/Enable Registers
>    *
>    * Interrupt Status Register (IPISR) : This register holds the
> @@ -102,6 +102,8 @@ static inline void fifo_icap_fifo_write(
>    * @drvdata: a pointer to the drvdata.
>    *
>    * This function will silently fail if the fifo is empty.
> + *
> + * Returns: 32-bit data from the Read FIFO
>    **/
>   static inline u32 fifo_icap_fifo_read(struct hwicap_drvdata *drvdata)
>   {
> @@ -156,6 +158,8 @@ static inline void fifo_icap_start_readb
>    * D2 - Always 1
>    * D1 - Always 1
>    * D0 - Done bit
> + *
> + * Returns: the 32-bit ICAP status register
>    **/
>   u32 fifo_icap_get_status(struct hwicap_drvdata *drvdata)
>   {
> @@ -165,8 +169,11 @@ u32 fifo_icap_get_status(struct hwicap_d
>   }
>   
>   /**
> - * fifo_icap_busy - Return true if the ICAP is still processing a transaction.
> + * fifo_icap_busy - Check the ICAP busy status.
>    * @drvdata: a pointer to the drvdata.
> + *
> + * Returns: %true if the ICAP is still processing a transaction,
> + *	otherwise %false
>    **/
>   static inline u32 fifo_icap_busy(struct hwicap_drvdata *drvdata)
>   {
> @@ -178,7 +185,7 @@ static inline u32 fifo_icap_busy(struct
>    * fifo_icap_write_fifo_vacancy - Query the write fifo available space.
>    * @drvdata: a pointer to the drvdata.
>    *
> - * Return the number of words that can be safely pushed into the write fifo.
> + * Returns: the number of words that can be safely pushed into the write fifo.
>    **/
>   static inline u32 fifo_icap_write_fifo_vacancy(
>   		struct hwicap_drvdata *drvdata)
> @@ -190,7 +197,7 @@ static inline u32 fifo_icap_write_fifo_v
>    * fifo_icap_read_fifo_occupancy - Query the read fifo available data.
>    * @drvdata: a pointer to the drvdata.
>    *
> - * Return the number of words that can be safely read from the read fifo.
> + * Returns: the number of words that can be safely read from the read fifo.
>    **/
>   static inline u32 fifo_icap_read_fifo_occupancy(
>   		struct hwicap_drvdata *drvdata)
> @@ -205,10 +212,12 @@ static inline u32 fifo_icap_read_fifo_oc
>    *		ICAP device.
>    * @num_words: the number of words (32 bit) to write to the ICAP
>    *		device.
> -
> + *
>    * This function writes the given user data to the Write FIFO in
>    * polled mode and starts the transfer of the data to
>    * the ICAP device.
> + *
> + * Returns: %0 on success or %-errno on failure.
>    **/
>   int fifo_icap_set_configuration(struct hwicap_drvdata *drvdata,
>   		u32 *frame_buffer, u32 num_words)
> @@ -280,11 +289,13 @@ int fifo_icap_set_configuration(struct h
>   /**
>    * fifo_icap_get_configuration - Read configuration data from the device.
>    * @drvdata: a pointer to the drvdata.
> - * @data: Address of the data representing the partial bitstream
> - * @size: the size of the partial bitstream in 32 bit words.
> + * @frame_buffer: Address of the data representing the partial bitstream
> + * @num_words: the size of the partial bitstream in 32 bit words.
>    *
>    * This function reads the specified number of words from the ICAP device in
>    * the polled mode.
> + *
> + * Returns: %0 on success or %-errno on failure.
>    */
>   int fifo_icap_get_configuration(struct hwicap_drvdata *drvdata,
>   		u32 *frame_buffer, u32 num_words)
> @@ -347,7 +358,7 @@ int fifo_icap_get_configuration(struct h
>   }
>   
>   /**
> - * buffer_icap_reset - Reset the logic of the icap device.
> + * fifo_icap_reset - Reset the logic of the icap device.
>    * @drvdata: a pointer to the drvdata.
>    *
>    * This function forces the software reset of the complete HWICAP device.

Reviewed-by: Michal Simek <michal.simek@....com>

Thanks,
Michal

Powered by blists - more mailing lists