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

scsi: lpfc: lpfc_bsg: Provide correct documentation for a bunch of functions 

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

 drivers/scsi/lpfc/lpfc_bsg.c:917: warning: Function parameter or member 'phba' not described in 'lpfc_bsg_ct_unsol_event'
 drivers/scsi/lpfc/lpfc_bsg.c:917: warning: Function parameter or member 'pring' not described in 'lpfc_bsg_ct_unsol_event'
 drivers/scsi/lpfc/lpfc_bsg.c:1484: warning: Function parameter or member 'cmp' not described in 'lpfc_issue_ct_rsp'
 drivers/scsi/lpfc/lpfc_bsg.c:3900: warning: Function parameter or member 'job' not described in 'lpfc_bsg_sli_cfg_read_cmd_ext'
 drivers/scsi/lpfc/lpfc_bsg.c:3900: warning: Function parameter or member 'dmabuf' not described in 'lpfc_bsg_sli_cfg_read_cmd_ext'
 drivers/scsi/lpfc/lpfc_bsg.c:3900: warning: Excess function parameter 'mb' description in 'lpfc_bsg_sli_cfg_read_cmd_ext'
 drivers/scsi/lpfc/lpfc_bsg.c:3900: warning: Excess function parameter 'dmabuff' description in 'lpfc_bsg_sli_cfg_read_cmd_ext'
 drivers/scsi/lpfc/lpfc_bsg.c:4088: warning: Function parameter or member 'job' not described in 'lpfc_bsg_sli_cfg_write_cmd_ext'
 drivers/scsi/lpfc/lpfc_bsg.c:4088: warning: Function parameter or member 'nemb_tp' not described in 'lpfc_bsg_sli_cfg_write_cmd_ext'
 drivers/scsi/lpfc/lpfc_bsg.c:4088: warning: Function parameter or member 'dmabuf' not described in 'lpfc_bsg_sli_cfg_write_cmd_ext'
 drivers/scsi/lpfc/lpfc_bsg.c:4088: warning: Excess function parameter 'mb' description in 'lpfc_bsg_sli_cfg_write_cmd_ext'
 drivers/scsi/lpfc/lpfc_bsg.c:4088: warning: Excess function parameter 'dmabuff' description in 'lpfc_bsg_sli_cfg_write_cmd_ext'
 drivers/scsi/lpfc/lpfc_bsg.c:4254: warning: Function parameter or member 'job' not described in 'lpfc_bsg_handle_sli_cfg_mbox'
 drivers/scsi/lpfc/lpfc_bsg.c:4254: warning: Function parameter or member 'dmabuf' not described in 'lpfc_bsg_handle_sli_cfg_mbox'
 drivers/scsi/lpfc/lpfc_bsg.c:4254: warning: Excess function parameter 'mb' description in 'lpfc_bsg_handle_sli_cfg_mbox'
 drivers/scsi/lpfc/lpfc_bsg.c:4254: warning: Excess function parameter 'dmabuff' description in 'lpfc_bsg_handle_sli_cfg_mbox'
 drivers/scsi/lpfc/lpfc_bsg.c:4403: warning: Function parameter or member 'job' not described in 'lpfc_bsg_read_ebuf_get'
 drivers/scsi/lpfc/lpfc_bsg.c:4403: warning: Excess function parameter 'dmabuf' description in 'lpfc_bsg_read_ebuf_get'
 drivers/scsi/lpfc/lpfc_bsg.c:4474: warning: Function parameter or member 'job' not described in 'lpfc_bsg_write_ebuf_set'
 drivers/scsi/lpfc/lpfc_bsg.c:4600: warning: Function parameter or member 'job' not described in 'lpfc_bsg_handle_sli_cfg_ebuf'
 drivers/scsi/lpfc/lpfc_bsg.c:4600: warning: Function parameter or member 'dmabuf' not described in 'lpfc_bsg_handle_sli_cfg_ebuf'
 drivers/scsi/lpfc/lpfc_bsg.c:4600: warning: Excess function parameter 'mb' description in 'lpfc_bsg_handle_sli_cfg_ebuf'
 drivers/scsi/lpfc/lpfc_bsg.c:4600: warning: Excess function parameter 'dmabuff' description in 'lpfc_bsg_handle_sli_cfg_ebuf'
 drivers/scsi/lpfc/lpfc_bsg.c:4645: warning: Function parameter or member 'job' not described in 'lpfc_bsg_handle_sli_cfg_ext'
 drivers/scsi/lpfc/lpfc_bsg.c:4645: warning: Function parameter or member 'dmabuf' not described in 'lpfc_bsg_handle_sli_cfg_ext'
 drivers/scsi/lpfc/lpfc_bsg.c:4645: warning: Excess function parameter 'mb' description in 'lpfc_bsg_handle_sli_cfg_ext'
 drivers/scsi/lpfc/lpfc_bsg.c:4645: warning: Excess function parameter 'dmabuff' description in 'lpfc_bsg_handle_sli_cfg_ext'
 drivers/scsi/lpfc/lpfc_bsg.c:4723: warning: Function parameter or member 'job' not described in 'lpfc_bsg_issue_mbox'
 drivers/scsi/lpfc/lpfc_bsg.c:4723: warning: Excess function parameter 'mb' description in 'lpfc_bsg_issue_mbox'

Link: https://lore.kernel.org/r/20201102142359.561122-8-lee.jones@linaro.org


Cc: James Smart <james.smart@broadcom.com>
Cc: Dick Kennedy <dick.kennedy@broadcom.com>
Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
Signed-off-by: default avatarMartin K. Petersen <martin.petersen@oracle.com>
parent e61e0740

drivers/scsi/lpfc/lpfc_bsg.c

+17 −17
Original line number Diff line number Diff line
@@ -902,11 +902,8 @@ diag_cmd_data_free(struct lpfc_hba *phba, struct lpfc_dmabufext *mlist) 
	return 0;

}



/**

/*

 * lpfc_bsg_ct_unsol_event - process an unsolicited CT command

 * @phba:

 * @pring:

 * @piocbq:

 *

 * This function is called when an unsolicited CT command is received.  It

 * forwards the event to any processes registered to receive CT events.
@@ -1455,7 +1452,8 @@ lpfc_issue_ct_rsp_cmp(struct lpfc_hba *phba, 
 * @phba: Pointer to HBA context object.

 * @job: Pointer to the job object.

 * @tag: tag index value into the ports context exchange array.

 * @bmp: Pointer to a dma buffer descriptor.

 * @cmp: Pointer to a cmp dma buffer descriptor.

 * @bmp: Pointer to a bmp dma buffer descriptor.

 * @num_entry: Number of enties in the bde.

 **/

static int
@@ -3867,9 +3865,9 @@ lpfc_bsg_sli_cfg_dma_desc_setup(struct lpfc_hba *phba, enum nemb_type nemb_tp, 
/**

 * lpfc_bsg_sli_cfg_mse_read_cmd_ext - sli_config non-embedded mailbox cmd read

 * @phba: Pointer to HBA context object.

 * @mb: Pointer to a BSG mailbox object.

 * @job: Pointer to the job object.

 * @nemb_tp: Enumerate of non-embedded mailbox command type.

 * @dmabuff: Pointer to a DMA buffer descriptor.

 * @dmabuf: Pointer to a DMA buffer descriptor.

 *

 * This routine performs SLI_CONFIG (0x9B) read mailbox command operation with

 * non-embedded external bufffers.
@@ -4056,8 +4054,9 @@ lpfc_bsg_sli_cfg_read_cmd_ext(struct lpfc_hba *phba, struct bsg_job *job, 
/**

 * lpfc_bsg_sli_cfg_write_cmd_ext - sli_config non-embedded mailbox cmd write

 * @phba: Pointer to HBA context object.

 * @mb: Pointer to a BSG mailbox object.

 * @dmabuff: Pointer to a DMA buffer descriptor.

 * @job: Pointer to the job object.

 * @nemb_tp: Enumerate of non-embedded mailbox command type.

 * @dmabuf: Pointer to a DMA buffer descriptor.

 *

 * This routine performs SLI_CONFIG (0x9B) write mailbox command operation with

 * non-embedded external bufffers.
@@ -4222,8 +4221,8 @@ lpfc_bsg_sli_cfg_write_cmd_ext(struct lpfc_hba *phba, struct bsg_job *job, 
/**

 * lpfc_bsg_handle_sli_cfg_mbox - handle sli-cfg mailbox cmd with ext buffer

 * @phba: Pointer to HBA context object.

 * @mb: Pointer to a BSG mailbox object.

 * @dmabuff: Pointer to a DMA buffer descriptor.

 * @job: Pointer to the job object.

 * @dmabuf: Pointer to a DMA buffer descriptor.

 *

 * This routine handles SLI_CONFIG (0x9B) mailbox command with non-embedded

 * external bufffers, including both 0x9B with non-embedded MSEs and 0x9B
@@ -4374,7 +4373,7 @@ lpfc_bsg_mbox_ext_abort(struct lpfc_hba *phba) 
/**

 * lpfc_bsg_read_ebuf_get - get the next mailbox read external buffer

 * @phba: Pointer to HBA context object.

 * @dmabuf: Pointer to a DMA buffer descriptor.

 * @job: Pointer to the job object.

 *

 * This routine extracts the next mailbox read external buffer back to

 * user space through BSG.
@@ -4444,6 +4443,7 @@ lpfc_bsg_read_ebuf_get(struct lpfc_hba *phba, struct bsg_job *job) 
/**

 * lpfc_bsg_write_ebuf_set - set the next mailbox write external buffer

 * @phba: Pointer to HBA context object.

 * @job: Pointer to the job object.

 * @dmabuf: Pointer to a DMA buffer descriptor.

 *

 * This routine sets up the next mailbox read external buffer obtained
@@ -4569,8 +4569,8 @@ lpfc_bsg_write_ebuf_set(struct lpfc_hba *phba, struct bsg_job *job, 
/**

 * lpfc_bsg_handle_sli_cfg_ebuf - handle ext buffer with sli-cfg mailbox cmd

 * @phba: Pointer to HBA context object.

 * @mb: Pointer to a BSG mailbox object.

 * @dmabuff: Pointer to a DMA buffer descriptor.

 * @job: Pointer to the job object.

 * @dmabuf: Pointer to a DMA buffer descriptor.

 *

 * This routine handles the external buffer with SLI_CONFIG (0x9B) mailbox

 * command with multiple non-embedded external buffers.
@@ -4614,8 +4614,8 @@ lpfc_bsg_handle_sli_cfg_ebuf(struct lpfc_hba *phba, struct bsg_job *job, 
/**

 * lpfc_bsg_handle_sli_cfg_ext - handle sli-cfg mailbox with external buffer

 * @phba: Pointer to HBA context object.

 * @mb: Pointer to a BSG mailbox object.

 * @dmabuff: Pointer to a DMA buffer descriptor.

 * @job: Pointer to the job object.

 * @dmabuf: Pointer to a DMA buffer descriptor.

 *

 * This routine checkes and handles non-embedded multi-buffer SLI_CONFIG

 * (0x9B) mailbox commands and external buffers.
@@ -4688,7 +4688,7 @@ lpfc_bsg_handle_sli_cfg_ext(struct lpfc_hba *phba, struct bsg_job *job, 
/**

 * lpfc_bsg_issue_mbox - issues a mailbox command on behalf of an app

 * @phba: Pointer to HBA context object.

 * @mb: Pointer to a mailbox object.

 * @job: Pointer to the job object.

 * @vport: Pointer to a vport object.

 *

 * Allocate a tracking object, mailbox command memory, get a mailbox