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

scsi: aacraid: Fix a bunch of function doc formatting errors 

And a few missing/excessive parameter descriptions.

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

 drivers/scsi/aacraid/aachba.c:358: warning: Function parameter or member 'dev' not described in 'aac_get_config_status'
 drivers/scsi/aacraid/aachba.c:358: warning: Function parameter or member 'commit_flag' not described in 'aac_get_config_status'
 drivers/scsi/aacraid/aachba.c:358: warning: Excess function parameter 'common' description in 'aac_get_config_status'
 drivers/scsi/aacraid/aachba.c:450: warning: Function parameter or member 'dev' not described in 'aac_get_containers'
 drivers/scsi/aacraid/aachba.c:450: warning: Excess function parameter 'common' description in 'aac_get_containers'
 drivers/scsi/aacraid/aachba.c:568: warning: Function parameter or member 'scsicmd' not described in 'aac_get_container_name'
 drivers/scsi/aacraid/aachba.c:796: warning: Function parameter or member 'scsicmd' not described in 'aac_probe_container_callback1'
 drivers/scsi/aacraid/aachba.c:796: warning: Excess function parameter 'dev' description in 'aac_probe_container_callback1'
 drivers/scsi/aacraid/aachba.c:796: warning: Excess function parameter 'cid' description in 'aac_probe_container_callback1'
 drivers/scsi/aacraid/aachba.c:1105: warning: Function parameter or member 'scsicmd' not described in 'aac_get_container_serial'
 drivers/scsi/aacraid/aachba.c:1961: warning: Excess function parameter 'phys_luns' description in 'aac_set_safw_attr_all_targets'
 drivers/scsi/aacraid/aachba.c:1961: warning: Excess function parameter 'rescan' description in 'aac_set_safw_attr_all_targets'
 drivers/scsi/aacraid/aachba.c:3394: warning: Cannot understand  *
 on line 3394 - I thought it was a doc line
 drivers/scsi/aacraid/aachba.c:3687: warning: Cannot understand  *
 on line 3687 - I thought it was a doc line
 drivers/scsi/aacraid/aachba.c:3752: warning: Cannot understand  *
 on line 3752 - I thought it was a doc line
 drivers/scsi/aacraid/aachba.c:3795: warning: Cannot understand  *
 on line 3795 - I thought it was a doc line

Link: https://lore.kernel.org/r/20200713074645.126138-29-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 bb458974

drivers/scsi/aacraid/aachba.c

+3 −14
Original line number Diff line number Diff line
@@ -561,7 +561,7 @@ static void get_container_name_callback(void *context, struct fib * fibptr) 
	scsicmd->scsi_done(scsicmd);

}



/**

/*

 *	aac_get_container_name	-	get container name, none blocking.

 */

static int aac_get_container_name(struct scsi_cmnd * scsicmd)
@@ -786,8 +786,7 @@ static int _aac_probe_container(struct scsi_cmnd * scsicmd, int (*callback)(stru 


/**

 *	aac_probe_container		-	query a logical volume

 *	@dev: device to query

 *	@cid: container identifier

 * @scsicmd: the scsi command block

 *

 *	Queries the controller about the given volume. The volume information

 *	is updated in the struct fsa_dev_info structure rather than returned.
@@ -1098,7 +1097,7 @@ static void get_container_serial_callback(void *context, struct fib * fibptr) 
	scsicmd->scsi_done(scsicmd);

}



/**

/*

 *	aac_get_container_serial - get container serial, none blocking.

 */

static int aac_get_container_serial(struct scsi_cmnd * scsicmd)
@@ -1952,8 +1951,6 @@ static int aac_get_safw_attr_all_targets(struct aac_dev *dev) 
/**

 *	aac_set_safw_attr_all_targets-	update current hba map with data from FW

 *	@dev:	aac_dev structure

 *	@phys_luns: FW information from report phys luns

 *	@rescan: Indicates scan type

 *

 *	Update our hba map with the information gathered from the FW

 */
@@ -3391,15 +3388,12 @@ int aac_dev_ioctl(struct aac_dev *dev, unsigned int cmd, void __user *arg) 
}



/**

 *

 * aac_srb_callback

 * @context: the context set in the fib - here it is scsi cmd

 * @fibptr: pointer to the fib

 *

 * Handles the completion of a scsi command to a non dasd device

 *

 */



static void aac_srb_callback(void *context, struct fib * fibptr)

{

	struct aac_srb_reply *srbreply;
@@ -3684,13 +3678,11 @@ static void hba_resp_task_failure(struct aac_dev *dev, 
}



/**

 *

 * aac_hba_callback

 * @context: the context set in the fib - here it is scsi cmd

 * @fibptr: pointer to the fib

 *

 * Handles the completion of a native HBA scsi command

 *

 */

void aac_hba_callback(void *context, struct fib *fibptr)

{
@@ -3749,14 +3741,12 @@ void aac_hba_callback(void *context, struct fib *fibptr) 
}



/**

 *

 * aac_send_srb_fib

 * @scsicmd: the scsi command block

 *

 * This routine will form a FIB and fill in the aac_srb from the

 * scsicmd passed in.

 */



static int aac_send_srb_fib(struct scsi_cmnd* scsicmd)

{

	struct fib* cmd_fibcontext;
@@ -3792,7 +3782,6 @@ static int aac_send_srb_fib(struct scsi_cmnd* scsicmd) 
}



/**

 *

 * aac_send_hba_fib

 * @scsicmd: the scsi command block

 *