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

powerpc/mpc52xx_lpbfifo: fix all kernel-doc warnings

Fix multiple kernel-doc warnings in mpc52xx_lpbfifo.c:

arch/powerpc/platforms/52xx/mpc52xx_lpbfifo.c:377: warning: expecting prototype for mpc52xx_lpbfifo_bcom_poll(). Prototype was for mpc52xx_lpbfifo_poll() instead

mpc52xx_lpbfifo.c:221: warning: No description found for return value of 'mpc52xx_lpbfifo_irq'
mpc52xx_lpbfifo.c:327: warning: No description found for return value of 'mpc52xx_lpbfifo_bcom_irq'
mpc52xx_lpbfifo.c:398: warning: No description found for return value of 'mpc52xx_lpbfifo_submit'

mpc52xx_lpbfifo.c:64: warning: Function parameter or member 'req' not described in 'mpc52xx_lpbfifo_kick'
mpc52xx_lpbfifo.c:220: warning: contents before sections
mpc52xx_lpbfifo.c:223: warning: Function parameter or member 'irq' not described in 'mpc52xx_lpbfifo_irq'
mpc52xx_lpbfifo.c:223: warning: Function parameter or member 'dev_id' not described in 'mpc52xx_lpbfifo_irq'
mpc52xx_lpbfifo.c:328: warning: contents before sections
mpc52xx_lpbfifo.c:331: warning: Function parameter or member 'irq' not described in 'mpc52xx_lpbfifo_bcom_irq'
mpc52xx_lpbfifo.c:331: warning: Function parameter or member 'dev_id' not described in 'mpc52xx_lpbfifo_bcom_irq'

Reported-by: kernel test robot <lkp@intel.com>
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Michael Ellerman <mpe@ellerman.id.au>
Link: https://lore.kernel.org/r/20221124061918.1967-1-rdunlap@infradead.org

authored by

Randy Dunlap and committed by
Michael Ellerman
4562bffb e75d07bd

+13 -1
+13 -1
arch/powerpc/platforms/52xx/mpc52xx_lpbfifo.c
··· 59 59 60 60 /** 61 61 * mpc52xx_lpbfifo_kick - Trigger the next block of data to be transferred 62 + * 63 + * @req: Pointer to request structure 62 64 */ 63 65 static void mpc52xx_lpbfifo_kick(struct mpc52xx_lpbfifo_request *req) 64 66 { ··· 180 178 181 179 /** 182 180 * mpc52xx_lpbfifo_irq - IRQ handler for LPB FIFO 181 + * @irq: IRQ number to be handled 182 + * @dev_id: device ID cookie 183 183 * 184 184 * On transmit, the dma completion irq triggers before the fifo completion 185 185 * triggers. Handle the dma completion here instead of the LPB FIFO Bestcomm ··· 220 216 * or nested spinlock condition. The out path is non-trivial, so 221 217 * extra fiddling is done to make sure all paths lead to the same 222 218 * outbound code. 219 + * 220 + * Return: irqreturn code (%IRQ_HANDLED) 223 221 */ 224 222 static irqreturn_t mpc52xx_lpbfifo_irq(int irq, void *dev_id) 225 223 { ··· 326 320 327 321 /** 328 322 * mpc52xx_lpbfifo_bcom_irq - IRQ handler for LPB FIFO Bestcomm task 323 + * @irq: IRQ number to be handled 324 + * @dev_id: device ID cookie 329 325 * 330 326 * Only used when receiving data. 327 + * 328 + * Return: irqreturn code (%IRQ_HANDLED) 331 329 */ 332 330 static irqreturn_t mpc52xx_lpbfifo_bcom_irq(int irq, void *dev_id) 333 331 { ··· 382 372 } 383 373 384 374 /** 385 - * mpc52xx_lpbfifo_bcom_poll - Poll for DMA completion 375 + * mpc52xx_lpbfifo_poll - Poll for DMA completion 386 376 */ 387 377 void mpc52xx_lpbfifo_poll(void) 388 378 { ··· 403 393 /** 404 394 * mpc52xx_lpbfifo_submit - Submit an LPB FIFO transfer request. 405 395 * @req: Pointer to request structure 396 + * 397 + * Return: %0 on success, -errno code on error 406 398 */ 407 399 int mpc52xx_lpbfifo_submit(struct mpc52xx_lpbfifo_request *req) 408 400 {