Commit cf93fffa authored by Lee Jones's avatar Lee Jones Committed by Martin K. Petersen
Browse files

scsi: aacraid: Fix a few kerneldoc issues 

Functions must follow imediately after the header documenting them and all
parameters must be present.

Fixes the following W=1 kernel build warning(s):

 drivers/scsi/aacraid/commctrl.c:43: warning: Excess function parameter 'dev' description in 'AAC_DEBUG_PREAMBLE'
 drivers/scsi/aacraid/commctrl.c:43: warning: Excess function parameter 'arg' description in 'AAC_DEBUG_PREAMBLE'
 drivers/scsi/aacraid/commctrl.c:167: warning: Function parameter or member 'dev' not described in 'open_getadapter_fib'
 drivers/scsi/aacraid/commctrl.c:167: warning: Function parameter or member 'arg' not described in 'open_getadapter_fib'
 drivers/scsi/aacraid/commctrl.c:458: warning: Cannot understand  *
 on line 458 - I thought it was a doc line

Link: https://lore.kernel.org/r/20200713080001.128044-3-lee.jones@linaro.org


Cc: Adaptec OEM Raid Solutions <aacraid@microsemi.com>
Cc: "PMC-Sierra, Inc" <aacraid@pmc-sierra.com>
Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
Signed-off-by: default avatarMartin K. Petersen <martin.petersen@oracle.com>
parent b115958d

drivers/scsi/aacraid/commctrl.c

+6 −8
Original line number Diff line number Diff line
@@ -32,6 +32,8 @@ 


#include "aacraid.h"



# define AAC_DEBUG_PREAMBLE	KERN_INFO

# define AAC_DEBUG_POSTAMBLE

/**

 *	ioctl_send_fib	-	send a FIB from userspace

 *	@dev:	adapter is being processed
@@ -40,9 +42,6 @@ 
 *	This routine sends a fib to the adapter on behalf of a user level

 *	program.

 */

# define AAC_DEBUG_PREAMBLE	KERN_INFO

# define AAC_DEBUG_POSTAMBLE



static int ioctl_send_fib(struct aac_dev * dev, void __user *arg)

{

	struct hw_fib * kfib;
@@ -158,11 +157,12 @@ static int ioctl_send_fib(struct aac_dev * dev, void __user *arg) 


/**

 *	open_getadapter_fib	-	Get the next fib

 *	@dev:	adapter is being processed

 *	@arg:	arguments to the open call

 *

 *	This routine will get the next Fib, if available, from the AdapterFibContext

 *	passed in from the user.

 */



static int open_getadapter_fib(struct aac_dev * dev, void __user *arg)

{

	struct aac_fib_context * fibctx;
@@ -234,7 +234,6 @@ static int open_getadapter_fib(struct aac_dev * dev, void __user *arg) 
 *	This routine will get the next Fib, if available, from the AdapterFibContext

 *	passed in from the user.

 */



static int next_getadapter_fib(struct aac_dev * dev, void __user *arg)

{

	struct fib_ioctl f;
@@ -455,11 +454,10 @@ static int check_revision(struct aac_dev *dev, void __user *arg) 




/**

 *

 * aac_send_raw_scb

 *

 *	@dev:	adapter is being processed

 *	@arg:	arguments to the send call

 */



static int aac_send_raw_srb(struct aac_dev* dev, void __user * arg)

{

	struct fib* srbfib;