Commit 0bb87e01 authored by Lee Jones's avatar Lee Jones Committed by Martin K. Petersen

scsi: lpfc: Fix a bunch of kernel-doc misdemeanours

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

 drivers/scsi/lpfc/lpfc_scsi.c:746: warning: expecting prototype for lpfc_release_scsi_buf(). Prototype was for lpfc_release_scsi_buf_s3() instead
 drivers/scsi/lpfc/lpfc_scsi.c:979: warning: expecting prototype for App checking is required for(). Prototype was for BG_ERR_CHECK() instead
 drivers/scsi/lpfc/lpfc_scsi.c:3701: warning: Function parameter or member 'vport' not described in 'lpfc_scsi_prep_cmnd_buf'
 drivers/scsi/lpfc/lpfc_scsi.c:3701: warning: Excess function parameter 'phba' description in 'lpfc_scsi_prep_cmnd_buf'
 drivers/scsi/lpfc/lpfc_scsi.c:3717: warning: Function parameter or member 'fcpi_parm' not described in 'lpfc_send_scsi_error_event'
 drivers/scsi/lpfc/lpfc_scsi.c:3717: warning: Excess function parameter 'rsp_iocb' description in 'lpfc_send_scsi_error_event'
 drivers/scsi/lpfc/lpfc_scsi.c:3837: warning: Function parameter or member 'fcpi_parm' not described in 'lpfc_handle_fcp_err'
 drivers/scsi/lpfc/lpfc_scsi.c:3837: warning: expecting prototype for lpfc_handler_fcp_err(). Prototype was for lpfc_handle_fcp_err() instead
 drivers/scsi/lpfc/lpfc_scsi.c:4021: warning: Function parameter or member 'wcqe' not described in 'lpfc_fcp_io_cmd_wqe_cmpl'
 drivers/scsi/lpfc/lpfc_scsi.c:4021: warning: Excess function parameter 'pwqeOut' description in 'lpfc_fcp_io_cmd_wqe_cmpl'
 drivers/scsi/lpfc/lpfc_scsi.c:4621: warning: Function parameter or member 'vport' not described in 'lpfc_scsi_prep_cmnd_buf_s3'
 drivers/scsi/lpfc/lpfc_scsi.c:4621: warning: Excess function parameter 'phba' description in 'lpfc_scsi_prep_cmnd_buf_s3'
 drivers/scsi/lpfc/lpfc_scsi.c:4698: warning: Function parameter or member 'vport' not described in 'lpfc_scsi_prep_cmnd_buf_s4'
 drivers/scsi/lpfc/lpfc_scsi.c:4698: warning: Excess function parameter 'phba' description in 'lpfc_scsi_prep_cmnd_buf_s4'
 drivers/scsi/lpfc/lpfc_scsi.c:4954: warning: expecting prototype for lpfc_taskmgmt_def_cmpl(). Prototype was for lpfc_tskmgmt_def_cmpl() instead
 drivers/scsi/lpfc/lpfc_scsi.c:5094: warning: expecting prototype for lpfc_poll_rearm_time(). Prototype was for lpfc_poll_rearm_timer() instead

Link: https://lore.kernel.org/r/20210312094738.2207817-4-lee.jones@linaro.org
Cc: James Smart <james.smart@broadcom.com>
Cc: Dick Kennedy <dick.kennedy@broadcom.com>
Cc: "James E.J. Bottomley" <jejb@linux.ibm.com>
Cc: "Martin K. Petersen" <martin.petersen@oracle.com>
Cc: linux-scsi@vger.kernel.org
Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
Signed-off-by: default avatarMartin K. Petersen <martin.petersen@oracle.com>
parent 11eea9b3
...@@ -736,7 +736,7 @@ lpfc_get_scsi_buf(struct lpfc_hba *phba, struct lpfc_nodelist *ndlp, ...@@ -736,7 +736,7 @@ lpfc_get_scsi_buf(struct lpfc_hba *phba, struct lpfc_nodelist *ndlp,
} }
/** /**
* lpfc_release_scsi_buf - Return a scsi buffer back to hba scsi buf list * lpfc_release_scsi_buf_s3 - Return a scsi buffer back to hba scsi buf list
* @phba: The Hba for which this call is being executed. * @phba: The Hba for which this call is being executed.
* @psb: The scsi buffer which is being released. * @psb: The scsi buffer which is being released.
* *
...@@ -974,10 +974,10 @@ lpfc_scsi_prep_dma_buf_s3(struct lpfc_hba *phba, struct lpfc_io_buf *lpfc_cmd) ...@@ -974,10 +974,10 @@ lpfc_scsi_prep_dma_buf_s3(struct lpfc_hba *phba, struct lpfc_io_buf *lpfc_cmd)
#define BG_ERR_TGT 0x2 #define BG_ERR_TGT 0x2
/* Return BG_ERR_SWAP if swapping CSUM<-->CRC is required for error injection */ /* Return BG_ERR_SWAP if swapping CSUM<-->CRC is required for error injection */
#define BG_ERR_SWAP 0x10 #define BG_ERR_SWAP 0x10
/** /*
* Return BG_ERR_CHECK if disabling Guard/Ref/App checking is required for * Return BG_ERR_CHECK if disabling Guard/Ref/App checking is required for
* error injection * error injection
**/ */
#define BG_ERR_CHECK 0x20 #define BG_ERR_CHECK 0x20
/** /**
...@@ -3699,7 +3699,7 @@ lpfc_bg_scsi_prep_dma_buf(struct lpfc_hba *phba, struct lpfc_io_buf *lpfc_cmd) ...@@ -3699,7 +3699,7 @@ lpfc_bg_scsi_prep_dma_buf(struct lpfc_hba *phba, struct lpfc_io_buf *lpfc_cmd)
/** /**
* lpfc_scsi_prep_cmnd_buf - Wrapper function for IOCB/WQE mapping of scsi * lpfc_scsi_prep_cmnd_buf - Wrapper function for IOCB/WQE mapping of scsi
* buffer * buffer
* @phba: The Hba for which this call is being executed. * @vport: Pointer to vport object.
* @lpfc_cmd: The scsi buffer which is going to be mapped. * @lpfc_cmd: The scsi buffer which is going to be mapped.
* @tmo: Timeout value for IO * @tmo: Timeout value for IO
* *
...@@ -3721,7 +3721,7 @@ lpfc_scsi_prep_cmnd_buf(struct lpfc_vport *vport, struct lpfc_io_buf *lpfc_cmd, ...@@ -3721,7 +3721,7 @@ lpfc_scsi_prep_cmnd_buf(struct lpfc_vport *vport, struct lpfc_io_buf *lpfc_cmd,
* @phba: Pointer to hba context object. * @phba: Pointer to hba context object.
* @vport: Pointer to vport object. * @vport: Pointer to vport object.
* @lpfc_cmd: Pointer to lpfc scsi command which reported the error. * @lpfc_cmd: Pointer to lpfc scsi command which reported the error.
* @rsp_iocb: Pointer to response iocb object which reported error. * @fcpi_parm: FCP Initiator parameter.
* *
* This function posts an event when there is a SCSI command reporting * This function posts an event when there is a SCSI command reporting
* error from the scsi device. * error from the scsi device.
...@@ -3836,10 +3836,10 @@ lpfc_scsi_unprep_dma_buf(struct lpfc_hba *phba, struct lpfc_io_buf *psb) ...@@ -3836,10 +3836,10 @@ lpfc_scsi_unprep_dma_buf(struct lpfc_hba *phba, struct lpfc_io_buf *psb)
} }
/** /**
* lpfc_handler_fcp_err - FCP response handler * lpfc_handle_fcp_err - FCP response handler
* @vport: The virtual port for which this call is being executed. * @vport: The virtual port for which this call is being executed.
* @lpfc_cmd: Pointer to lpfc_io_buf data structure. * @lpfc_cmd: Pointer to lpfc_io_buf data structure.
* @rsp_iocb: The response IOCB which contains FCP error. * @fcpi_parm: FCP Initiator parameter.
* *
* This routine is called to process response IOCB with status field * This routine is called to process response IOCB with status field
* IOSTAT_FCP_RSP_ERROR. This routine sets result field of scsi command * IOSTAT_FCP_RSP_ERROR. This routine sets result field of scsi command
...@@ -4023,7 +4023,7 @@ lpfc_handle_fcp_err(struct lpfc_vport *vport, struct lpfc_io_buf *lpfc_cmd, ...@@ -4023,7 +4023,7 @@ lpfc_handle_fcp_err(struct lpfc_vport *vport, struct lpfc_io_buf *lpfc_cmd,
* lpfc_fcp_io_cmd_wqe_cmpl - Complete a FCP IO * lpfc_fcp_io_cmd_wqe_cmpl - Complete a FCP IO
* @phba: The hba for which this call is being executed. * @phba: The hba for which this call is being executed.
* @pwqeIn: The command WQE for the scsi cmnd. * @pwqeIn: The command WQE for the scsi cmnd.
* @pwqeOut: The response WQE for the scsi cmnd. * @wcqe: Pointer to driver response CQE object.
* *
* This routine assigns scsi command result by looking into response WQE * This routine assigns scsi command result by looking into response WQE
* status field appropriately. This routine handles QUEUE FULL condition as * status field appropriately. This routine handles QUEUE FULL condition as
...@@ -4619,7 +4619,7 @@ lpfc_scsi_cmd_iocb_cmpl(struct lpfc_hba *phba, struct lpfc_iocbq *pIocbIn, ...@@ -4619,7 +4619,7 @@ lpfc_scsi_cmd_iocb_cmpl(struct lpfc_hba *phba, struct lpfc_iocbq *pIocbIn,
/** /**
* lpfc_scsi_prep_cmnd_buf_s3 - SLI-3 IOCB init for the IO * lpfc_scsi_prep_cmnd_buf_s3 - SLI-3 IOCB init for the IO
* @phba: Pointer to vport object for which I/O is executed * @vport: Pointer to vport object.
* @lpfc_cmd: The scsi buffer which is going to be prep'ed. * @lpfc_cmd: The scsi buffer which is going to be prep'ed.
* @tmo: timeout value for the IO * @tmo: timeout value for the IO
* *
...@@ -4696,7 +4696,7 @@ static int lpfc_scsi_prep_cmnd_buf_s3(struct lpfc_vport *vport, ...@@ -4696,7 +4696,7 @@ static int lpfc_scsi_prep_cmnd_buf_s3(struct lpfc_vport *vport,
/** /**
* lpfc_scsi_prep_cmnd_buf_s4 - SLI-4 WQE init for the IO * lpfc_scsi_prep_cmnd_buf_s4 - SLI-4 WQE init for the IO
* @phba: Pointer to vport object for which I/O is executed * @vport: Pointer to vport object.
* @lpfc_cmd: The scsi buffer which is going to be prep'ed. * @lpfc_cmd: The scsi buffer which is going to be prep'ed.
* @tmo: timeout value for the IO * @tmo: timeout value for the IO
* *
...@@ -4953,7 +4953,7 @@ lpfc_scsi_api_table_setup(struct lpfc_hba *phba, uint8_t dev_grp) ...@@ -4953,7 +4953,7 @@ lpfc_scsi_api_table_setup(struct lpfc_hba *phba, uint8_t dev_grp)
} }
/** /**
* lpfc_taskmgmt_def_cmpl - IOCB completion routine for task management command * lpfc_tskmgmt_def_cmpl - IOCB completion routine for task management command
* @phba: The Hba for which this call is being executed. * @phba: The Hba for which this call is being executed.
* @cmdiocbq: Pointer to lpfc_iocbq data structure. * @cmdiocbq: Pointer to lpfc_iocbq data structure.
* @rspiocbq: Pointer to lpfc_iocbq data structure. * @rspiocbq: Pointer to lpfc_iocbq data structure.
...@@ -5098,7 +5098,7 @@ lpfc_info(struct Scsi_Host *host) ...@@ -5098,7 +5098,7 @@ lpfc_info(struct Scsi_Host *host)
} }
/** /**
* lpfc_poll_rearm_time - Routine to modify fcp_poll timer of hba * lpfc_poll_rearm_timer - Routine to modify fcp_poll timer of hba
* @phba: The Hba for which this call is being executed. * @phba: The Hba for which this call is being executed.
* *
* This routine modifies fcp_poll_timer field of @phba by cfg_poll_tmo. * This routine modifies fcp_poll_timer field of @phba by cfg_poll_tmo.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment