Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

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

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>

authored by

Randy Dunlap and committed by
Greg Kroah-Hartman
bd87458c a2450bdd

+19 -8
+19 -8
drivers/char/xilinx_hwicap/fifo_icap.c
··· 48 48 49 49 #define XHI_GIER_GIE_MASK 0x80000000 /* Global Interrupt enable Mask */ 50 50 51 - /** 51 + /* 52 52 * HwIcap Device Interrupt Status/Enable Registers 53 53 * 54 54 * Interrupt Status Register (IPISR) : This register holds the ··· 102 102 * @drvdata: a pointer to the drvdata. 103 103 * 104 104 * This function will silently fail if the fifo is empty. 105 + * 106 + * Returns: 32-bit data from the Read FIFO 105 107 **/ 106 108 static inline u32 fifo_icap_fifo_read(struct hwicap_drvdata *drvdata) 107 109 { ··· 158 156 * D2 - Always 1 159 157 * D1 - Always 1 160 158 * D0 - Done bit 159 + * 160 + * Returns: the 32-bit ICAP status register 161 161 **/ 162 162 u32 fifo_icap_get_status(struct hwicap_drvdata *drvdata) 163 163 { ··· 169 165 } 170 166 171 167 /** 172 - * fifo_icap_busy - Return true if the ICAP is still processing a transaction. 168 + * fifo_icap_busy - Check the ICAP busy status. 173 169 * @drvdata: a pointer to the drvdata. 170 + * 171 + * Returns: %true if the ICAP is still processing a transaction, 172 + * otherwise %false 174 173 **/ 175 174 static inline u32 fifo_icap_busy(struct hwicap_drvdata *drvdata) 176 175 { ··· 185 178 * fifo_icap_write_fifo_vacancy - Query the write fifo available space. 186 179 * @drvdata: a pointer to the drvdata. 187 180 * 188 - * Return the number of words that can be safely pushed into the write fifo. 181 + * Returns: the number of words that can be safely pushed into the write fifo. 189 182 **/ 190 183 static inline u32 fifo_icap_write_fifo_vacancy( 191 184 struct hwicap_drvdata *drvdata) ··· 197 190 * fifo_icap_read_fifo_occupancy - Query the read fifo available data. 198 191 * @drvdata: a pointer to the drvdata. 199 192 * 200 - * Return the number of words that can be safely read from the read fifo. 193 + * Returns: the number of words that can be safely read from the read fifo. 201 194 **/ 202 195 static inline u32 fifo_icap_read_fifo_occupancy( 203 196 struct hwicap_drvdata *drvdata) ··· 212 205 * ICAP device. 213 206 * @num_words: the number of words (32 bit) to write to the ICAP 214 207 * device. 215 - 208 + * 216 209 * This function writes the given user data to the Write FIFO in 217 210 * polled mode and starts the transfer of the data to 218 211 * the ICAP device. 212 + * 213 + * Returns: %0 on success or %-errno on failure. 219 214 **/ 220 215 int fifo_icap_set_configuration(struct hwicap_drvdata *drvdata, 221 216 u32 *frame_buffer, u32 num_words) ··· 289 280 /** 290 281 * fifo_icap_get_configuration - Read configuration data from the device. 291 282 * @drvdata: a pointer to the drvdata. 292 - * @data: Address of the data representing the partial bitstream 293 - * @size: the size of the partial bitstream in 32 bit words. 283 + * @frame_buffer: Address of the data representing the partial bitstream 284 + * @num_words: the size of the partial bitstream in 32 bit words. 294 285 * 295 286 * This function reads the specified number of words from the ICAP device in 296 287 * the polled mode. 288 + * 289 + * Returns: %0 on success or %-errno on failure. 297 290 */ 298 291 int fifo_icap_get_configuration(struct hwicap_drvdata *drvdata, 299 292 u32 *frame_buffer, u32 num_words) ··· 358 347 } 359 348 360 349 /** 361 - * buffer_icap_reset - Reset the logic of the icap device. 350 + * fifo_icap_reset - Reset the logic of the icap device. 362 351 * @drvdata: a pointer to the drvdata. 363 352 * 364 353 * This function forces the software reset of the complete HWICAP device.