Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit f5254429 authored by Jacob Keller's avatar Jacob Keller Committed by Jeff Kirsher
Browse files

i40e/i40evf: cleanup incorrect function doxygen comments 



Recent versions of the Linux kernel now warn about incorrect parameter
definitions for function comments. Fix up several function comments to
correctly reflect the current function arguments. This cleans up the
warnings and helps ensure our documentation is accurate.

Signed-off-by: default avatarJacob Keller <jacob.e.keller@intel.com>
Tested-by: default avatarAndrew Bowers <andrewx.bowers@intel.com>
Signed-off-by: default avatarJeff Kirsher <jeffrey.t.kirsher@intel.com>
parent 04a1e08c

drivers/net/ethernet/intel/i40e/i40e_client.c

+3 −3
Original line number Diff line number Diff line
@@ -40,7 +40,7 @@ static struct i40e_ops i40e_lan_ops = { 
/**

 * i40e_client_get_params - Get the params that can change at runtime

 * @vsi: the VSI with the message

 * @param: clinet param struct

 * @params: client param struct

 *

 **/

static
@@ -566,7 +566,7 @@ static int i40e_client_virtchnl_send(struct i40e_info *ldev, 
 * i40e_client_setup_qvlist

 * @ldev: pointer to L2 context.

 * @client: Client pointer.

 * @qv_info: queue and vector list

 * @qvlist_info: queue and vector list

 *

 * Return 0 on success or < 0 on error

 **/
@@ -641,7 +641,7 @@ static int i40e_client_setup_qvlist(struct i40e_info *ldev, 
 * i40e_client_request_reset

 * @ldev: pointer to L2 context.

 * @client: Client pointer.

 * @level: reset level

 * @reset_level: reset level

 **/

static void i40e_client_request_reset(struct i40e_info *ldev,

				      struct i40e_client *client,

drivers/net/ethernet/intel/i40e/i40e_common.c

+22 −15
Original line number Diff line number Diff line
@@ -1671,6 +1671,8 @@ enum i40e_status_code i40e_aq_set_phy_config(struct i40e_hw *hw, 
/**

 * i40e_set_fc

 * @hw: pointer to the hw struct

 * @aq_failures: buffer to return AdminQ failure information

 * @atomic_restart: whether to enable atomic link restart

 *

 * Set the requested flow control mode using set_phy_config.

 **/
@@ -2807,8 +2809,8 @@ i40e_status i40e_aq_remove_macvlan(struct i40e_hw *hw, u16 seid, 
 * @mr_list: list of mirrored VSI SEIDs or VLAN IDs

 * @cmd_details: pointer to command details structure or NULL

 * @rule_id: Rule ID returned from FW

 * @rule_used: Number of rules used in internal switch

 * @rule_free: Number of rules free in internal switch

 * @rules_used: Number of rules used in internal switch

 * @rules_free: Number of rules free in internal switch

 *

 * Add/Delete a mirror rule to a specific switch. Mirror rules are supported for

 * VEBs/VEPA elements only
@@ -2868,8 +2870,8 @@ static i40e_status i40e_mirrorrule_op(struct i40e_hw *hw, 
 * @mr_list: list of mirrored VSI SEIDs or VLAN IDs

 * @cmd_details: pointer to command details structure or NULL

 * @rule_id: Rule ID returned from FW

 * @rule_used: Number of rules used in internal switch

 * @rule_free: Number of rules free in internal switch

 * @rules_used: Number of rules used in internal switch

 * @rules_free: Number of rules free in internal switch

 *

 * Add mirror rule. Mirror rules are supported for VEBs or VEPA elements only

 **/
@@ -2899,8 +2901,8 @@ i40e_status i40e_aq_add_mirrorrule(struct i40e_hw *hw, u16 sw_seid, 
 *		add_mirrorrule.

 * @mr_list: list of mirrored VLAN IDs to be removed

 * @cmd_details: pointer to command details structure or NULL

 * @rule_used: Number of rules used in internal switch

 * @rule_free: Number of rules free in internal switch

 * @rules_used: Number of rules used in internal switch

 * @rules_free: Number of rules free in internal switch

 *

 * Delete a mirror rule. Mirror rules are supported for VEBs/VEPA elements only

 **/
@@ -3648,6 +3650,8 @@ i40e_status i40e_aq_stop_lldp(struct i40e_hw *hw, bool shutdown_agent, 
/**

 * i40e_aq_start_lldp

 * @hw: pointer to the hw struct

 * @buff: buffer for result

 * @buff_size: buffer size

 * @cmd_details: pointer to command details structure or NULL

 *

 * Start the embedded LLDP Agent on all ports.
@@ -3728,7 +3732,6 @@ i40e_status i40e_aq_get_cee_dcb_config(struct i40e_hw *hw, 
 * i40e_aq_add_udp_tunnel

 * @hw: pointer to the hw struct

 * @udp_port: the UDP port to add in Host byte order

 * @header_len: length of the tunneling header length in DWords

 * @protocol_index: protocol index type

 * @filter_index: pointer to filter index

 * @cmd_details: pointer to command details structure or NULL
@@ -3947,6 +3950,7 @@ i40e_status i40e_aq_config_vsi_tc_bw(struct i40e_hw *hw, 
 * @hw: pointer to the hw struct

 * @seid: seid of the switching component connected to Physical Port

 * @ets_data: Buffer holding ETS parameters

 * @opcode: Tx scheduler AQ command opcode

 * @cmd_details: pointer to command details structure or NULL

 **/

i40e_status i40e_aq_config_switch_comp_ets(struct i40e_hw *hw,
@@ -4290,10 +4294,10 @@ i40e_status i40e_aq_add_rem_control_packet_filter(struct i40e_hw *hw, 
 * @hw: pointer to the hw struct

 * @seid: VSI seid to add ethertype filter from

 **/

#define I40E_FLOW_CONTROL_ETHTYPE 0x8808

void i40e_add_filter_to_drop_tx_flow_control_frames(struct i40e_hw *hw,

						    u16 seid)

{

#define I40E_FLOW_CONTROL_ETHTYPE 0x8808

	u16 flag = I40E_AQC_ADD_CONTROL_PACKET_FLAGS_IGNORE_MAC |

		   I40E_AQC_ADD_CONTROL_PACKET_FLAGS_DROP |

		   I40E_AQC_ADD_CONTROL_PACKET_FLAGS_TX;
@@ -4424,6 +4428,7 @@ void i40e_set_pci_config_data(struct i40e_hw *hw, u16 link_status) 
 * @ret_buff_size: actual buffer size returned

 * @ret_next_table: next block to read

 * @ret_next_index: next index to read

 * @cmd_details: pointer to command details structure or NULL

 *

 * Dump internal FW/HW data for debug purposes.

 *
@@ -4550,7 +4555,7 @@ i40e_status i40e_aq_configure_partition_bw(struct i40e_hw *hw, 
 * i40e_read_phy_register_clause22

 * @hw: pointer to the HW structure

 * @reg: register address in the page

 * @phy_adr: PHY address on MDIO interface

 * @phy_addr: PHY address on MDIO interface

 * @value: PHY register value

 *

 * Reads specified PHY register value
@@ -4595,7 +4600,7 @@ i40e_status i40e_read_phy_register_clause22(struct i40e_hw *hw, 
 * i40e_write_phy_register_clause22

 * @hw: pointer to the HW structure

 * @reg: register address in the page

 * @phy_adr: PHY address on MDIO interface

 * @phy_addr: PHY address on MDIO interface

 * @value: PHY register value

 *

 * Writes specified PHY register value
@@ -4636,7 +4641,7 @@ i40e_status i40e_write_phy_register_clause22(struct i40e_hw *hw, 
 * @hw: pointer to the HW structure

 * @page: registers page number

 * @reg: register address in the page

 * @phy_adr: PHY address on MDIO interface

 * @phy_addr: PHY address on MDIO interface

 * @value: PHY register value

 *

 * Reads specified PHY register value
@@ -4710,7 +4715,7 @@ i40e_status i40e_read_phy_register_clause45(struct i40e_hw *hw, 
 * @hw: pointer to the HW structure

 * @page: registers page number

 * @reg: register address in the page

 * @phy_adr: PHY address on MDIO interface

 * @phy_addr: PHY address on MDIO interface

 * @value: PHY register value

 *

 * Writes value to specified PHY register
@@ -4777,7 +4782,7 @@ i40e_status i40e_write_phy_register_clause45(struct i40e_hw *hw, 
 * @hw: pointer to the HW structure

 * @page: registers page number

 * @reg: register address in the page

 * @phy_adr: PHY address on MDIO interface

 * @phy_addr: PHY address on MDIO interface

 * @value: PHY register value

 *

 * Writes value to specified PHY register
@@ -4813,7 +4818,7 @@ i40e_status i40e_write_phy_register(struct i40e_hw *hw, 
 * @hw: pointer to the HW structure

 * @page: registers page number

 * @reg: register address in the page

 * @phy_adr: PHY address on MDIO interface

 * @phy_addr: PHY address on MDIO interface

 * @value: PHY register value

 *

 * Reads specified PHY register value
@@ -4848,7 +4853,6 @@ i40e_status i40e_read_phy_register(struct i40e_hw *hw, 
 * i40e_get_phy_address

 * @hw: pointer to the HW structure

 * @dev_num: PHY port num that address we want

 * @phy_addr: Returned PHY address

 *

 * Gets PHY address for current port

 **/
@@ -5058,7 +5062,9 @@ i40e_status i40e_led_get_phy(struct i40e_hw *hw, u16 *led_addr, 
 * i40e_led_set_phy

 * @hw: pointer to the HW structure

 * @on: true or false

 * @led_addr: address of led register to use

 * @mode: original val plus bit for set or ignore

 *

 * Set led's on or off when controlled by the PHY

 *

 **/
@@ -5347,6 +5353,7 @@ i40e_status_code i40e_aq_write_ddp(struct i40e_hw *hw, void *buff, 
 * @hw: pointer to the hw struct

 * @buff: command buffer (size in bytes = buff_size)

 * @buff_size: buffer size in bytes

 * @flags: AdminQ command flags

 * @cmd_details: pointer to command details structure or NULL

 **/

enum

drivers/net/ethernet/intel/i40e/i40e_dcb_nl.c

+6 −5
Original line number Diff line number Diff line
@@ -23,7 +23,7 @@ static void i40e_get_pfc_delay(struct i40e_hw *hw, u16 *delay) 


/**

 * i40e_dcbnl_ieee_getets - retrieve local IEEE ETS configuration

 * @netdev: the corresponding netdev

 * @dev: the corresponding netdev

 * @ets: structure to hold the ETS information

 *

 * Returns local IEEE ETS configuration
@@ -62,8 +62,8 @@ static int i40e_dcbnl_ieee_getets(struct net_device *dev, 


/**

 * i40e_dcbnl_ieee_getpfc - retrieve local IEEE PFC configuration

 * @netdev: the corresponding netdev

 * @ets: structure to hold the PFC information

 * @dev: the corresponding netdev

 * @pfc: structure to hold the PFC information

 *

 * Returns local IEEE PFC configuration

 **/
@@ -95,7 +95,7 @@ static int i40e_dcbnl_ieee_getpfc(struct net_device *dev, 


/**

 * i40e_dcbnl_getdcbx - retrieve current DCBx capability

 * @netdev: the corresponding netdev

 * @dev: the corresponding netdev

 *

 * Returns DCBx capability features

 **/
@@ -108,7 +108,8 @@ static u8 i40e_dcbnl_getdcbx(struct net_device *dev) 


/**

 * i40e_dcbnl_get_perm_hw_addr - MAC address used by DCBx

 * @netdev: the corresponding netdev

 * @dev: the corresponding netdev

 * @perm_addr: buffer to store the MAC address

 *

 * Returns the SAN MAC address used for LLDP exchange

 **/

drivers/net/ethernet/intel/i40e/i40e_debugfs.c

+4 −4
Original line number Diff line number Diff line
@@ -12,8 +12,8 @@ static struct dentry *i40e_dbg_root; 


/**

 * i40e_dbg_find_vsi - searches for the vsi with the given seid

 * @pf - the PF structure to search for the vsi

 * @seid - seid of the vsi it is searching for

 * @pf: the PF structure to search for the vsi

 * @seid: seid of the vsi it is searching for

 **/

static struct i40e_vsi *i40e_dbg_find_vsi(struct i40e_pf *pf, int seid)

{
@@ -31,8 +31,8 @@ static struct i40e_vsi *i40e_dbg_find_vsi(struct i40e_pf *pf, int seid) 


/**

 * i40e_dbg_find_veb - searches for the veb with the given seid

 * @pf - the PF structure to search for the veb

 * @seid - seid of the veb it is searching for

 * @pf: the PF structure to search for the veb

 * @seid: seid of the veb it is searching for

 **/

static struct i40e_veb *i40e_dbg_find_veb(struct i40e_pf *pf, int seid)

{

drivers/net/ethernet/intel/i40e/i40e_ethtool.c

+15 −9
Original line number Diff line number Diff line
@@ -1055,6 +1055,9 @@ static int i40e_nway_reset(struct net_device *netdev) 


/**

 * i40e_get_pauseparam -  Get Flow Control status

 * @netdev: netdevice structure

 * @pause: buffer to return pause parameters

 *

 * Return tx/rx-pause status

 **/

static void i40e_get_pauseparam(struct net_device *netdev,
@@ -2526,7 +2529,7 @@ static int i40e_get_rss_hash_opts(struct i40e_pf *pf, struct ethtool_rxnfc *cmd) 
/**

 * i40e_check_mask - Check whether a mask field is set

 * @mask: the full mask value

 * @field; mask of the field to check

 * @field: mask of the field to check

 *

 * If the given mask is fully set, return positive value. If the mask for the

 * field is fully unset, return zero. Otherwise return a negative error code.
@@ -2597,6 +2600,7 @@ static int i40e_parse_rx_flow_user_data(struct ethtool_rx_flow_spec *fsp, 
/**

 * i40e_fill_rx_flow_user_data - Fill in user-defined data field

 * @fsp: pointer to rx_flow specification

 * @data: pointer to return userdef data

 *

 * Reads the userdef data structure and properly fills in the user defined

 * fields of the rx_flow_spec.
@@ -2775,6 +2779,7 @@ static int i40e_get_ethtool_fdir_entry(struct i40e_pf *pf, 
 * i40e_get_rxnfc - command to get RX flow classification rules

 * @netdev: network interface device structure

 * @cmd: ethtool rxnfc command

 * @rule_locs: pointer to store rule data

 *

 * Returns Success if the command is supported.

 **/
@@ -2816,7 +2821,7 @@ static int i40e_get_rxnfc(struct net_device *netdev, struct ethtool_rxnfc *cmd, 
/**

 * i40e_get_rss_hash_bits - Read RSS Hash bits from register

 * @nfc: pointer to user request

 * @i_setc bits currently set

 * @i_setc: bits currently set

 *

 * Returns value of bits to be set per user request

 **/
@@ -2861,7 +2866,7 @@ static u64 i40e_get_rss_hash_bits(struct ethtool_rxnfc *nfc, u64 i_setc) 
/**

 * i40e_set_rss_hash_opt - Enable/Disable flow types for RSS hash

 * @pf: pointer to the physical function struct

 * @cmd: ethtool rxnfc command

 * @nfc: ethtool rxnfc command

 *

 * Returns Success if the flow input set is supported.

 **/
@@ -3260,7 +3265,7 @@ static int i40e_add_flex_offset(struct list_head *flex_pit_list, 
 * __i40e_reprogram_flex_pit - Re-program specific FLX_PIT table

 * @pf: Pointer to the PF structure

 * @flex_pit_list: list of flexible src offsets in use

 * #flex_pit_start: index to first entry for this section of the table

 * @flex_pit_start: index to first entry for this section of the table

 *

 * In order to handle flexible data, the hardware uses a table of values

 * called the FLX_PIT table. This table is used to indicate which sections of
@@ -3374,7 +3379,7 @@ static void i40e_reprogram_flex_pit(struct i40e_pf *pf) 


/**

 * i40e_flow_str - Converts a flow_type into a human readable string

 * @flow_type: the flow type from a flow specification

 * @fsp: the flow specification

 *

 * Currently only flow types we support are included here, and the string

 * value attempts to match what ethtool would use to configure this flow type.
@@ -4079,7 +4084,7 @@ static unsigned int i40e_max_channels(struct i40e_vsi *vsi) 


/**

 * i40e_get_channels - Get the current channels enabled and max supported etc.

 * @netdev: network interface device structure

 * @dev: network interface device structure

 * @ch: ethtool channels structure

 *

 * We don't support separate tx and rx queues as channels. The other count
@@ -4107,7 +4112,7 @@ static void i40e_get_channels(struct net_device *dev, 


/**

 * i40e_set_channels - Set the new channels count.

 * @netdev: network interface device structure

 * @dev: network interface device structure

 * @ch: ethtool channels structure

 *

 * The new channels count may not be the same as requested by the user
@@ -4249,6 +4254,7 @@ static int i40e_get_rxfh(struct net_device *netdev, u32 *indir, u8 *key, 
 * @netdev: network interface device structure

 * @indir: indirection table

 * @key: hash key

 * @hfunc: hash function to use

 *

 * Returns -EINVAL if the table specifies an invalid queue id, otherwise

 * returns 0 after programming the table.