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

scsi: lpfc: Fix kerneldoc parameter formatting/misnaming/missing issues

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

drivers/scsi/lpfc/lpfc_hbadisc.c:1209: warning: Function parameter or member 'phba' not described in 'lpfc_sli4_clear_fcf_rr_bmask'
drivers/scsi/lpfc/lpfc_hbadisc.c:1309: warning: Function parameter or member 'sw_name' not described in 'lpfc_sw_name_match'
drivers/scsi/lpfc/lpfc_hbadisc.c:1309: warning: Excess function parameter 'fab_name' description in 'lpfc_sw_name_match'
drivers/scsi/lpfc/lpfc_hbadisc.c:1397: warning: Function parameter or member 'fcf_rec' not described in 'lpfc_copy_fcf_record'
drivers/scsi/lpfc/lpfc_hbadisc.c:1397: warning: Excess function parameter 'fcf' description in 'lpfc_copy_fcf_record'
drivers/scsi/lpfc/lpfc_hbadisc.c:1956: warning: Cannot understand lpfc_sli4_fcf_record_match - testing new FCF record for matching existing FCF
on line 1956 - I thought it was a doc line
drivers/scsi/lpfc/lpfc_hbadisc.c:2078: warning: Function parameter or member 'fcf_index' not described in 'lpfc_sli4_fcf_pri_list_del'
drivers/scsi/lpfc/lpfc_hbadisc.c:2109: warning: Function parameter or member 'fcf_index' not described in 'lpfc_sli4_set_fcf_flogi_fail'
drivers/scsi/lpfc/lpfc_hbadisc.c:2135: warning: Function parameter or member 'fcf_index' not described in 'lpfc_sli4_fcf_pri_list_add'
drivers/scsi/lpfc/lpfc_hbadisc.c:2135: warning: Function parameter or member 'new_fcf_record' not described in 'lpfc_sli4_fcf_pri_list_add'

Link: https://lore.kernel.org/r/20200723122446.1329773-3-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
e415f2a2 a0e4a64f

+8 -7
+8 -7
drivers/scsi/lpfc/lpfc_hbadisc.c
··· 1198 1198 1199 1199 /** 1200 1200 * lpfc_sli4_clear_fcf_rr_bmask 1201 - * @phba pointer to the struct lpfc_hba for this port. 1201 + * @phba: pointer to the struct lpfc_hba for this port. 1202 1202 * This fucnction resets the round robin bit mask and clears the 1203 1203 * fcf priority list. The list deletions are done while holding the 1204 1204 * hbalock. The ON_LIST flag and the FLOGI_FAILED flags are cleared ··· 1297 1297 1298 1298 /** 1299 1299 * lpfc_sw_name_match - Check if the fcf switch name match. 1300 - * @fab_name: pointer to fabric name. 1300 + * @sw_name: pointer to switch name. 1301 1301 * @new_fcf_record: pointer to fcf record. 1302 1302 * 1303 1303 * This routine compare the fcf record's switch name with provided ··· 1385 1385 1386 1386 /** 1387 1387 * lpfc_copy_fcf_record - Copy fcf information to lpfc_hba. 1388 - * @fcf: pointer to driver fcf record. 1388 + * @fcf_rec: pointer to driver fcf record. 1389 1389 * @new_fcf_record: pointer to fcf record. 1390 1390 * 1391 1391 * This routine copies the FCF information from the FCF ··· 1953 1953 } 1954 1954 1955 1955 /** 1956 - lpfc_sli4_fcf_record_match - testing new FCF record for matching existing FCF 1956 + * lpfc_sli4_fcf_record_match - testing new FCF record for matching existing FCF 1957 1957 * @phba: pointer to lpfc hba data structure. 1958 1958 * @fcf_rec: pointer to an existing FCF record. 1959 1959 * @new_fcf_record: pointer to a new FCF record. ··· 2067 2067 /** 2068 2068 * lpfc_sli4_fcf_pri_list_del 2069 2069 * @phba: pointer to lpfc hba data structure. 2070 - * @fcf_index the index of the fcf record to delete 2070 + * @fcf_index: the index of the fcf record to delete 2071 2071 * This routine checks the on list flag of the fcf_index to be deleted. 2072 2072 * If it is one the list then it is removed from the list, and the flag 2073 2073 * is cleared. This routine grab the hbalock before removing the fcf ··· 2097 2097 /** 2098 2098 * lpfc_sli4_set_fcf_flogi_fail 2099 2099 * @phba: pointer to lpfc hba data structure. 2100 - * @fcf_index the index of the fcf record to update 2100 + * @fcf_index: the index of the fcf record to update 2101 2101 * This routine acquires the hbalock and then set the LPFC_FCF_FLOGI_FAILED 2102 2102 * flag so the the round robin slection for the particular priority level 2103 2103 * will try a different fcf record that does not have this bit set. ··· 2117 2117 /** 2118 2118 * lpfc_sli4_fcf_pri_list_add 2119 2119 * @phba: pointer to lpfc hba data structure. 2120 - * @fcf_index the index of the fcf record to add 2120 + * @fcf_index: the index of the fcf record to add 2121 + * @new_fcf_record: pointer to a new FCF record. 2121 2122 * This routine checks the priority of the fcf_index to be added. 2122 2123 * If it is a lower priority than the current head of the fcf_pri list 2123 2124 * then it is added to the list in the right order.