Commit 4562bffb authored by Randy Dunlap's avatar Randy Dunlap Committed by Michael Ellerman
Browse files

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: default avatarkernel test robot <lkp@intel.com>
Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Signed-off-by: default avatarMichael Ellerman <mpe@ellerman.id.au>
Link: https://lore.kernel.org/r/20221124061918.1967-1-rdunlap@infradead.org
parent e75d07bd

arch/powerpc/platforms/52xx/mpc52xx_lpbfifo.c

+13 −1
Original line number Diff line number Diff line
@@ -59,6 +59,8 @@ static struct mpc52xx_lpbfifo lpbfifo; 


/**

 * mpc52xx_lpbfifo_kick - Trigger the next block of data to be transferred

 *

 * @req: Pointer to request structure

 */

static void mpc52xx_lpbfifo_kick(struct mpc52xx_lpbfifo_request *req)

{
@@ -178,6 +180,8 @@ static void mpc52xx_lpbfifo_kick(struct mpc52xx_lpbfifo_request *req) 


/**

 * mpc52xx_lpbfifo_irq - IRQ handler for LPB FIFO

 * @irq: IRQ number to be handled

 * @dev_id: device ID cookie

 *

 * On transmit, the dma completion irq triggers before the fifo completion

 * triggers.  Handle the dma completion here instead of the LPB FIFO Bestcomm
@@ -216,6 +220,8 @@ static void mpc52xx_lpbfifo_kick(struct mpc52xx_lpbfifo_request *req) 
 * or nested spinlock condition.  The out path is non-trivial, so

 * extra fiddling is done to make sure all paths lead to the same

 * outbound code.

 *

 * Return: irqreturn code (%IRQ_HANDLED)

 */

static irqreturn_t mpc52xx_lpbfifo_irq(int irq, void *dev_id)

{
@@ -320,8 +326,12 @@ static irqreturn_t mpc52xx_lpbfifo_irq(int irq, void *dev_id) 


/**

 * mpc52xx_lpbfifo_bcom_irq - IRQ handler for LPB FIFO Bestcomm task

 * @irq: IRQ number to be handled

 * @dev_id: device ID cookie

 *

 * Only used when receiving data.

 *

 * Return: irqreturn code (%IRQ_HANDLED)

 */

static irqreturn_t mpc52xx_lpbfifo_bcom_irq(int irq, void *dev_id)

{
@@ -372,7 +382,7 @@ static irqreturn_t mpc52xx_lpbfifo_bcom_irq(int irq, void *dev_id) 
}



/**

 * mpc52xx_lpbfifo_bcom_poll - Poll for DMA completion

 * mpc52xx_lpbfifo_poll - Poll for DMA completion

 */

void mpc52xx_lpbfifo_poll(void)

{
@@ -393,6 +403,8 @@ EXPORT_SYMBOL(mpc52xx_lpbfifo_poll); 
/**

 * mpc52xx_lpbfifo_submit - Submit an LPB FIFO transfer request.

 * @req: Pointer to request structure

 *

 * Return: %0 on success, -errno code on error

 */

int mpc52xx_lpbfifo_submit(struct mpc52xx_lpbfifo_request *req)

{