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

scsi: libfc: Provide missing and repair existing function documentation 

Mostly due to descriptions not keeping up with API changes.

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

 drivers/scsi/libfc/fc_fcp.c:299: warning: Function parameter or member 'status_code' not described in 'fc_fcp_retry_cmd'
 drivers/scsi/libfc/fc_fcp.c:595: warning: Function parameter or member 'seq' not described in 'fc_fcp_send_data'
 drivers/scsi/libfc/fc_fcp.c:595: warning: Excess function parameter 'sp' description in 'fc_fcp_send_data'
 drivers/scsi/libfc/fc_fcp.c:1289: warning: Function parameter or member 't' not described in 'fc_lun_reset_send'
 drivers/scsi/libfc/fc_fcp.c:1289: warning: Excess function parameter 'data' description in 'fc_lun_reset_send'
 drivers/scsi/libfc/fc_fcp.c:1422: warning: Function parameter or member 't' not described in 'fc_fcp_timeout'
 drivers/scsi/libfc/fc_fcp.c:1422: warning: Excess function parameter 'data' description in 'fc_fcp_timeout'
 drivers/scsi/libfc/fc_fcp.c:1696: warning: Function parameter or member 'code' not described in 'fc_fcp_recovery'
 drivers/scsi/libfc/fc_fcp.c:1716: warning: Function parameter or member 'offset' not described in 'fc_fcp_srr'
 drivers/scsi/libfc/fc_fcp.c:1859: warning: Function parameter or member 'sc_cmd' not described in 'fc_queuecommand'
 drivers/scsi/libfc/fc_fcp.c:1859: warning: Excess function parameter 'cmd' description in 'fc_queuecommand'

Link: https://lore.kernel.org/r/20200713074645.126138-13-lee.jones@linaro.org


Cc: Hannes Reinecke <hare@suse.de>
Reviewed-by: default avatarHannes Reinecke <hare@suse.de>
Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
Signed-off-by: default avatarMartin K. Petersen <martin.petersen@oracle.com>
parent f636acae

drivers/scsi/libfc/fc_fcp.c

+7 −4
Original line number Diff line number Diff line
@@ -289,6 +289,7 @@ static int fc_fcp_send_abort(struct fc_fcp_pkt *fsp) 
/**

 * fc_fcp_retry_cmd() - Retry a fcp_pkt

 * @fsp: The FCP packet to be retried

 * @status_code: The FCP status code to set

 *

 * Sets the status code to be FC_ERROR and then calls

 * fc_fcp_complete_locked() which in turn calls fc_io_compl().
@@ -580,7 +581,7 @@ static void fc_fcp_recv_data(struct fc_fcp_pkt *fsp, struct fc_frame *fp) 
/**

 * fc_fcp_send_data() - Send SCSI data to a target

 * @fsp:      The FCP packet the data is on

 * @sp:	      The sequence the data is to be sent on

 * @seq:      The sequence the data is to be sent on

 * @offset:   The starting offset for this data request

 * @seq_blen: The burst length for this data request

 *
@@ -1283,7 +1284,7 @@ static int fc_fcp_pkt_abort(struct fc_fcp_pkt *fsp) 


/**

 * fc_lun_reset_send() - Send LUN reset command

 * @data: The FCP packet that identifies the LUN to be reset

 * @t: Timer context used to fetch the FSP packet

 */

static void fc_lun_reset_send(struct timer_list *t)

{
@@ -1409,7 +1410,7 @@ static void fc_fcp_cleanup(struct fc_lport *lport) 


/**

 * fc_fcp_timeout() - Handler for fcp_pkt timeouts

 * @data: The FCP packet that has timed out

 * @t: Timer context used to fetch the FSP packet

 *

 * If REC is supported then just issue it and return. The REC exchange will

 * complete or time out and recovery can continue at that point. Otherwise,
@@ -1691,6 +1692,7 @@ static void fc_fcp_rec_error(struct fc_fcp_pkt *fsp, struct fc_frame *fp) 
/**

 * fc_fcp_recovery() - Handler for fcp_pkt recovery

 * @fsp: The FCP pkt that needs to be aborted

 * @code: The FCP status code to set

 */

static void fc_fcp_recovery(struct fc_fcp_pkt *fsp, u8 code)

{
@@ -1709,6 +1711,7 @@ static void fc_fcp_recovery(struct fc_fcp_pkt *fsp, u8 code) 
 * fc_fcp_srr() - Send a SRR request (Sequence Retransmission Request)

 * @fsp:   The FCP packet the SRR is to be sent on

 * @r_ctl: The R_CTL field for the SRR request

 * @offset: The SRR relative offset

 * This is called after receiving status but insufficient data, or

 * when expecting status but the request has timed out.

 */
@@ -1851,7 +1854,7 @@ static inline int fc_fcp_lport_queue_ready(struct fc_lport *lport) 
/**

 * fc_queuecommand() - The queuecommand function of the SCSI template

 * @shost: The Scsi_Host that the command was issued to

 * @cmd:   The scsi_cmnd to be executed

 * @sc_cmd:   The scsi_cmnd to be executed

 *

 * This is the i/o strategy routine, called by the SCSI layer.

 */