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

scsi: bnx2fc: Repair a range of kerneldoc issues 

>From bitrotted and missing function parameters to misuse of kerneldoc format.

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

 drivers/scsi/bnx2fc/bnx2fc_fcoe.c:1082: warning: Function parameter or member 'lport' not described in 'bnx2fc_update_src_mac'
 drivers/scsi/bnx2fc/bnx2fc_fcoe.c:1082: warning: Function parameter or member 'addr' not described in 'bnx2fc_update_src_mac'
 drivers/scsi/bnx2fc/bnx2fc_fcoe.c:1082: warning: Excess function parameter 'fip' description in 'bnx2fc_update_src_mac'
 drivers/scsi/bnx2fc/bnx2fc_fcoe.c:1082: warning: Excess function parameter 'old' description in 'bnx2fc_update_src_mac'
 drivers/scsi/bnx2fc/bnx2fc_fcoe.c:1082: warning: Excess function parameter 'new' description in 'bnx2fc_update_src_mac'
 drivers/scsi/bnx2fc/bnx2fc_fcoe.c:1670: warning: Function parameter or member 'netdev' not described in 'bnx2fc_destroy'
 drivers/scsi/bnx2fc/bnx2fc_fcoe.c:1670: warning: Excess function parameter 'buffer' description in 'bnx2fc_destroy'
 drivers/scsi/bnx2fc/bnx2fc_fcoe.c:1670: warning: Excess function parameter 'kp' description in 'bnx2fc_destroy'
 drivers/scsi/bnx2fc/bnx2fc_fcoe.c:2108: warning: Function parameter or member 'netdev' not described in 'bnx2fc_disable'
 drivers/scsi/bnx2fc/bnx2fc_fcoe.c:2236: warning: Function parameter or member 'netdev' not described in 'bnx2fc_enable'
 drivers/scsi/bnx2fc/bnx2fc_fcoe.c:2529: warning: Function parameter or member 'dev' not described in 'bnx2fc_ulp_exit'
 drivers/scsi/bnx2fc/bnx2fc_fcoe.c:2962: warning: cannot understand function prototype: 'struct scsi_host_template bnx2fc_shost_template = '
 drivers/scsi/bnx2fc/bnx2fc_fcoe.c:2996: warning: cannot understand function prototype: 'struct cnic_ulp_ops bnx2fc_cnic_cb = '

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


Cc: QLogic-Storage-Upstream@qlogic.com
Cc: Prakash Gollapudi <bprakash@broadcom.com>
Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
Signed-off-by: default avatarMartin K. Petersen <martin.petersen@oracle.com>
parent f2db5efe

drivers/scsi/bnx2fc/bnx2fc_fcoe.c

+8 −10
Original line number Diff line number Diff line
@@ -1071,9 +1071,8 @@ static int bnx2fc_fip_recv(struct sk_buff *skb, struct net_device *dev, 
/**

 * bnx2fc_update_src_mac - Update Ethernet MAC filters.

 *

 * @fip: FCoE controller.

 * @old: Unicast MAC address to delete if the MAC is non-zero.

 * @new: Unicast MAC address to add.

 * @lport: The local port

 * @addr: Location of data to copy

 *

 * Remove any previously-set unicast MAC filter.

 * Add secondary FCoE MAC address filter for our OUI.
@@ -1659,8 +1658,7 @@ static void __bnx2fc_destroy(struct bnx2fc_interface *interface) 
/**

 * bnx2fc_destroy - Destroy a bnx2fc FCoE interface

 *

 * @buffer: The name of the Ethernet interface to be destroyed

 * @kp:     The associated kernel parameter

 * @netdev: The net device that the FCoE interface is on

 *

 * Called from sysfs.

 *
@@ -2101,7 +2099,7 @@ static int __bnx2fc_disable(struct fcoe_ctlr *ctlr) 
	return 0;

}



/**

/*

 * Deperecated: Use bnx2fc_enabled()

 */

static int bnx2fc_disable(struct net_device *netdev)
@@ -2229,7 +2227,7 @@ static int __bnx2fc_enable(struct fcoe_ctlr *ctlr) 
	return 0;

}



/**

/*

 * Deprecated: Use bnx2fc_enabled()

 */

static int bnx2fc_enable(struct net_device *netdev)
@@ -2523,7 +2521,7 @@ static struct bnx2fc_hba *bnx2fc_hba_lookup(struct net_device 
/**

 * bnx2fc_ulp_exit - shuts down adapter instance and frees all resources

 *

 * @dev		cnic device handle

 * @dev:	cnic device handle

 */

static void bnx2fc_ulp_exit(struct cnic_dev *dev)

{
@@ -2956,7 +2954,7 @@ static struct device_attribute *bnx2fc_host_attrs[] = { 
	NULL,

};



/**

/*

 * scsi_host_template structure used while registering with SCSI-ml

 */

static struct scsi_host_template bnx2fc_shost_template = {
@@ -2989,7 +2987,7 @@ static struct libfc_function_template bnx2fc_libfc_fcn_templ = { 
	.rport_event_callback	= bnx2fc_rport_event_handler,

};



/**

/*

 * bnx2fc_cnic_cb - global template of bnx2fc - cnic driver interface

 *			structure carrying callback function pointers

 */