Commit 012d019f authored by Lee Jones's avatar Lee Jones Committed by Martin K. Petersen

scsi: lpfc: Fix a bunch of kerneldoc misdemeanors

Adding, removing and correcting function parameter descriptions.

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

 drivers/scsi/lpfc/lpfc_mbox.c:886: warning: Function parameter or member 'vport' not described in 'lpfc_reg_vpi'
 drivers/scsi/lpfc/lpfc_mbox.c:886: warning: Excess function parameter 'phba' description in 'lpfc_reg_vpi'
 drivers/scsi/lpfc/lpfc_mbox.c:886: warning: Excess function parameter 'vpi' description in 'lpfc_reg_vpi'
 drivers/scsi/lpfc/lpfc_mbox.c:886: warning: Excess function parameter 'sid' description in 'lpfc_reg_vpi'
 drivers/scsi/lpfc/lpfc_mbox.c:1218: warning: Function parameter or member 'ring' not described in 'lpfc_config_ring'
 drivers/scsi/lpfc/lpfc_mbox.c:1626: warning: Function parameter or member 'mboxq' not described in 'lpfc_mbox_tmo_val'
 drivers/scsi/lpfc/lpfc_mbox.c:1626: warning: Excess function parameter 'cmd' description in 'lpfc_mbox_tmo_val'
 drivers/scsi/lpfc/lpfc_mbox.c:1710: warning: Function parameter or member 'sge' not described in 'lpfc_sli4_mbx_sge_get'
 drivers/scsi/lpfc/lpfc_mbox.c:1780: warning: Function parameter or member 'emb' not described in 'lpfc_sli4_config'
 drivers/scsi/lpfc/lpfc_mbox.c:2027: warning: Function parameter or member 'mboxq' not described in 'lpfc_sli4_mbx_read_fcf_rec'
 drivers/scsi/lpfc/lpfc_mbox.c:2078: warning: Function parameter or member 'phba' not described in 'lpfc_request_features'

Link: https://lore.kernel.org/r/20200723122446.1329773-19-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 d10d1df6
...@@ -868,9 +868,7 @@ lpfc_sli4_unreg_all_rpis(struct lpfc_vport *vport) ...@@ -868,9 +868,7 @@ lpfc_sli4_unreg_all_rpis(struct lpfc_vport *vport)
/** /**
* lpfc_reg_vpi - Prepare a mailbox command for registering vport identifier * lpfc_reg_vpi - Prepare a mailbox command for registering vport identifier
* @phba: pointer to lpfc hba data structure. * @vport: pointer to a vport object.
* @vpi: virtual N_Port identifier.
* @sid: Fibre Channel S_ID (N_Port_ID assigned to a virtual N_Port).
* @pmb: pointer to the driver internal queue element for mailbox command. * @pmb: pointer to the driver internal queue element for mailbox command.
* *
* The registration vport identifier mailbox command is used to activate a * The registration vport identifier mailbox command is used to activate a
...@@ -1199,7 +1197,7 @@ lpfc_config_hbq(struct lpfc_hba *phba, uint32_t id, ...@@ -1199,7 +1197,7 @@ lpfc_config_hbq(struct lpfc_hba *phba, uint32_t id,
/** /**
* lpfc_config_ring - Prepare a mailbox command for configuring an IOCB ring * lpfc_config_ring - Prepare a mailbox command for configuring an IOCB ring
* @phba: pointer to lpfc hba data structure. * @phba: pointer to lpfc hba data structure.
* @ring: * @ring: ring number/index
* @pmb: pointer to the driver internal queue element for mailbox command. * @pmb: pointer to the driver internal queue element for mailbox command.
* *
* The configure ring mailbox command is used to configure an IOCB ring. This * The configure ring mailbox command is used to configure an IOCB ring. This
...@@ -1613,7 +1611,7 @@ lpfc_mbox_dev_check(struct lpfc_hba *phba) ...@@ -1613,7 +1611,7 @@ lpfc_mbox_dev_check(struct lpfc_hba *phba)
/** /**
* lpfc_mbox_tmo_val - Retrieve mailbox command timeout value * lpfc_mbox_tmo_val - Retrieve mailbox command timeout value
* @phba: pointer to lpfc hba data structure. * @phba: pointer to lpfc hba data structure.
* @cmd: mailbox command code. * @mboxq: pointer to the driver internal queue element for mailbox command.
* *
* This routine retrieves the proper timeout value according to the mailbox * This routine retrieves the proper timeout value according to the mailbox
* command code. * command code.
...@@ -1700,6 +1698,7 @@ lpfc_sli4_mbx_sge_set(struct lpfcMboxq *mbox, uint32_t sgentry, ...@@ -1700,6 +1698,7 @@ lpfc_sli4_mbx_sge_set(struct lpfcMboxq *mbox, uint32_t sgentry,
* lpfc_sli4_mbx_sge_get - Get a sge entry from non-embedded mailbox command * lpfc_sli4_mbx_sge_get - Get a sge entry from non-embedded mailbox command
* @mbox: pointer to lpfc mbox command. * @mbox: pointer to lpfc mbox command.
* @sgentry: sge entry index. * @sgentry: sge entry index.
* @sge: pointer to lpfc mailbox sge to load into.
* *
* This routine gets an entry from the non-embedded mailbox command at the sge * This routine gets an entry from the non-embedded mailbox command at the sge
* index location. * index location.
...@@ -1767,6 +1766,7 @@ lpfc_sli4_mbox_cmd_free(struct lpfc_hba *phba, struct lpfcMboxq *mbox) ...@@ -1767,6 +1766,7 @@ lpfc_sli4_mbox_cmd_free(struct lpfc_hba *phba, struct lpfcMboxq *mbox)
* @subsystem: The sli4 config sub mailbox subsystem. * @subsystem: The sli4 config sub mailbox subsystem.
* @opcode: The sli4 config sub mailbox command opcode. * @opcode: The sli4 config sub mailbox command opcode.
* @length: Length of the sli4 config mailbox command (including sub-header). * @length: Length of the sli4 config mailbox command (including sub-header).
* @emb: True if embedded mbox command should be setup.
* *
* This routine sets up the header fields of SLI4 specific mailbox command * This routine sets up the header fields of SLI4 specific mailbox command
* for sending IOCTL command. * for sending IOCTL command.
...@@ -2012,6 +2012,7 @@ lpfc_sli_config_mbox_opcode_get(struct lpfc_hba *phba, LPFC_MBOXQ_t *mbox) ...@@ -2012,6 +2012,7 @@ lpfc_sli_config_mbox_opcode_get(struct lpfc_hba *phba, LPFC_MBOXQ_t *mbox)
/** /**
* lpfc_sli4_mbx_read_fcf_rec - Allocate and construct read fcf mbox cmd * lpfc_sli4_mbx_read_fcf_rec - Allocate and construct read fcf mbox cmd
* @phba: pointer to lpfc hba data structure. * @phba: pointer to lpfc hba data structure.
* @mboxq: pointer to lpfc mbox command.
* @fcf_index: index to fcf table. * @fcf_index: index to fcf table.
* *
* This routine routine allocates and constructs non-embedded mailbox command * This routine routine allocates and constructs non-embedded mailbox command
...@@ -2068,6 +2069,7 @@ lpfc_sli4_mbx_read_fcf_rec(struct lpfc_hba *phba, ...@@ -2068,6 +2069,7 @@ lpfc_sli4_mbx_read_fcf_rec(struct lpfc_hba *phba,
/** /**
* lpfc_request_features: Configure SLI4 REQUEST_FEATURES mailbox * lpfc_request_features: Configure SLI4 REQUEST_FEATURES mailbox
* @phba: pointer to lpfc hba data structure.
* @mboxq: pointer to lpfc mbox command. * @mboxq: pointer to lpfc mbox command.
* *
* This routine sets up the mailbox for an SLI4 REQUEST_FEATURES * This routine sets up the mailbox for an SLI4 REQUEST_FEATURES
......
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