archives/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux.git synced 2026-03-08 04:04:43 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

xilinx_hwicap: fifo_icap.c: fix all kernel-doc warnings

Browse source 
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@infradead.org>
Reviewed-by: Michal Simek <michal.simek@amd.com>
Link: https://patch.msgid.link/20251214191750.2173225-1-rdunlap@infradead.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
This commit is contained in:
Randy Dunlap 2025-12-14 11:17:50 -08:00 • committed by Greg Kroah-Hartman
parent a2450bddb7
commit bd87458c16
1 changed files with 19 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

27
drivers/char/xilinx_hwicap/fifo_icap.c
View file

@ -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(struct hwicap_drvdata *drvdata,
* @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_readback(struct hwicap_drvdata *drvdata)
* 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_drvdata *drvdata)
}
/**
* 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 hwicap_drvdata *drvdata)
* 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_vacancy(
* 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_occupancy(
* 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 hwicap_drvdata *drvdata,
/**
* 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 hwicap_drvdata *drvdata,
}
/**
* 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.