Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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: Lee Jones <lee.jones@linaro.org>
Signed-off-by: Martin K. Petersen <martin.petersen@oracle.com>

authored by

Lee Jones and committed by
Martin K. Petersen
012d019f d10d1df6

+7 -5
+7 -5
drivers/scsi/lpfc/lpfc_mbox.c
··· 868 868 869 869 /** 870 870 * lpfc_reg_vpi - Prepare a mailbox command for registering vport identifier 871 - * @phba: pointer to lpfc hba data structure. 872 - * @vpi: virtual N_Port identifier. 873 - * @sid: Fibre Channel S_ID (N_Port_ID assigned to a virtual N_Port). 871 + * @vport: pointer to a vport object. 874 872 * @pmb: pointer to the driver internal queue element for mailbox command. 875 873 * 876 874 * The registration vport identifier mailbox command is used to activate a ··· 1197 1199 /** 1198 1200 * lpfc_config_ring - Prepare a mailbox command for configuring an IOCB ring 1199 1201 * @phba: pointer to lpfc hba data structure. 1200 - * @ring: 1202 + * @ring: ring number/index 1201 1203 * @pmb: pointer to the driver internal queue element for mailbox command. 1202 1204 * 1203 1205 * The configure ring mailbox command is used to configure an IOCB ring. This ··· 1611 1613 /** 1612 1614 * lpfc_mbox_tmo_val - Retrieve mailbox command timeout value 1613 1615 * @phba: pointer to lpfc hba data structure. 1614 - * @cmd: mailbox command code. 1616 + * @mboxq: pointer to the driver internal queue element for mailbox command. 1615 1617 * 1616 1618 * This routine retrieves the proper timeout value according to the mailbox 1617 1619 * command code. ··· 1698 1700 * lpfc_sli4_mbx_sge_get - Get a sge entry from non-embedded mailbox command 1699 1701 * @mbox: pointer to lpfc mbox command. 1700 1702 * @sgentry: sge entry index. 1703 + * @sge: pointer to lpfc mailbox sge to load into. 1701 1704 * 1702 1705 * This routine gets an entry from the non-embedded mailbox command at the sge 1703 1706 * index location. ··· 1766 1767 * @subsystem: The sli4 config sub mailbox subsystem. 1767 1768 * @opcode: The sli4 config sub mailbox command opcode. 1768 1769 * @length: Length of the sli4 config mailbox command (including sub-header). 1770 + * @emb: True if embedded mbox command should be setup. 1769 1771 * 1770 1772 * This routine sets up the header fields of SLI4 specific mailbox command 1771 1773 * for sending IOCTL command. ··· 2012 2012 /** 2013 2013 * lpfc_sli4_mbx_read_fcf_rec - Allocate and construct read fcf mbox cmd 2014 2014 * @phba: pointer to lpfc hba data structure. 2015 + * @mboxq: pointer to lpfc mbox command. 2015 2016 * @fcf_index: index to fcf table. 2016 2017 * 2017 2018 * This routine routine allocates and constructs non-embedded mailbox command ··· 2069 2068 2070 2069 /** 2071 2070 * lpfc_request_features: Configure SLI4 REQUEST_FEATURES mailbox 2071 + * @phba: pointer to lpfc hba data structure. 2072 2072 * @mboxq: pointer to lpfc mbox command. 2073 2073 * 2074 2074 * This routine sets up the mailbox for an SLI4 REQUEST_FEATURES