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

Commit 5ba643c6 authored by Tony Nguyen's avatar Tony Nguyen Committed by Jeff Kirsher
Browse files

ixgbe: Fix kernel-doc format warnings 



Recent checks added for formatting kernel-doc comments are causing warnings
if W= is run with a non-zero value.  This patch fixes function comments to
resolve warnings when W=1 is used.

Signed-off-by: default avatarTony Nguyen <anthony.l.nguyen@intel.com>
Tested-by: default avatarAndrew Bowers <andrewx.bowers@intel.com>
Signed-off-by: default avatarJeff Kirsher <jeffrey.t.kirsher@intel.com>
parent d584527c

drivers/net/ethernet/intel/ixgbe/ixgbe_82598.c

+2 −1
Original line number Diff line number Diff line
@@ -431,6 +431,7 @@ static s32 ixgbe_fc_enable_82598(struct ixgbe_hw *hw) 
/**

 *  ixgbe_start_mac_link_82598 - Configures MAC link settings

 *  @hw: pointer to hardware structure

 *  @autoneg_wait_to_complete: true when waiting for completion is needed

 *

 *  Configures link settings based on values in the ixgbe_hw struct.

 *  Restarts the link.  Performs autonegotiation if needed.
@@ -1054,7 +1055,7 @@ static s32 ixgbe_read_i2c_eeprom_82598(struct ixgbe_hw *hw, u8 byte_offset, 
 *  ixgbe_read_i2c_sff8472_82598 - Reads 8 bit word over I2C interface.

 *  @hw: pointer to hardware structure

 *  @byte_offset: byte offset at address 0xA2

 *  @eeprom_data: value read

 *  @sff8472_data: value read

 *

 *  Performs 8 byte read operation to SFP module's SFF-8472 data over I2C

 **/

drivers/net/ethernet/intel/ixgbe/ixgbe_82599.c

+7 −4
Original line number Diff line number Diff line
@@ -221,7 +221,7 @@ static s32 prot_autoc_read_82599(struct ixgbe_hw *hw, bool *locked, 
/**

 * prot_autoc_write_82599 - Hides MAC differences needed for AUTOC write

 * @hw: pointer to hardware structure

 * @reg_val: value to write to AUTOC

 * @autoc: value to write to AUTOC

 * @locked: bool to indicate whether the SW/FW lock was already taken by

 *	     previous proc_autoc_read_82599.

 *
@@ -1310,10 +1310,11 @@ do { \ 


/**

 *  ixgbe_atr_compute_sig_hash_82599 - Compute the signature hash

 *  @stream: input bitstream to compute the hash on

 *  @input: input bitstream to compute the hash on

 *  @common: compressed common input dword

 *

 *  This function is almost identical to the function above but contains

 *  several optomizations such as unwinding all of the loops, letting the

 *  several optimizations such as unwinding all of the loops, letting the

 *  compiler work out all of the conditional ifs since the keys are static

 *  defines, and computing two keys at once since the hashed dword stream

 *  will be the same for both keys.
@@ -1446,7 +1447,7 @@ do { \ 


/**

 *  ixgbe_atr_compute_perfect_hash_82599 - Compute the perfect filter hash

 *  @atr_input: input bitstream to compute the hash on

 *  @input: input bitstream to compute the hash on

 *  @input_mask: mask for the input bitstream

 *

 *  This function serves two main purposes.  First it applies the input_mask
@@ -2078,6 +2079,7 @@ static s32 ixgbe_reset_pipeline_82599(struct ixgbe_hw *hw) 
 *  ixgbe_read_i2c_byte_82599 - Reads 8 bit word over I2C

 *  @hw: pointer to hardware structure

 *  @byte_offset: byte offset to read

 *  @dev_addr: address to read from

 *  @data: value read

 *

 *  Performs byte read operation to SFP module's EEPROM over I2C interface at
@@ -2131,6 +2133,7 @@ static s32 ixgbe_read_i2c_byte_82599(struct ixgbe_hw *hw, u8 byte_offset, 
 *  ixgbe_write_i2c_byte_82599 - Writes 8 bit word over I2C

 *  @hw: pointer to hardware structure

 *  @byte_offset: byte offset to write

 *  @dev_addr: address to write to

 *  @data: value to write

 *

 *  Performs byte write operation to SFP module's EEPROM over I2C interface at

drivers/net/ethernet/intel/ixgbe/ixgbe_common.c

+6 −3
Original line number Diff line number Diff line
@@ -1613,6 +1613,7 @@ static void ixgbe_shift_out_eeprom_bits(struct ixgbe_hw *hw, u16 data, 
/**

 *  ixgbe_shift_in_eeprom_bits - Shift data bits in from the EEPROM

 *  @hw: pointer to hardware structure

 *  @count: number of bits to shift

 **/

static u16 ixgbe_shift_in_eeprom_bits(struct ixgbe_hw *hw, u16 count)

{
@@ -1667,7 +1668,7 @@ static void ixgbe_raise_eeprom_clk(struct ixgbe_hw *hw, u32 *eec) 
/**

 *  ixgbe_lower_eeprom_clk - Lowers the EEPROM's clock input.

 *  @hw: pointer to hardware structure

 *  @eecd: EECD's current value

 *  @eec: EEC's current value

 **/

static void ixgbe_lower_eeprom_clk(struct ixgbe_hw *hw, u32 *eec)

{
@@ -2037,7 +2038,7 @@ static s32 ixgbe_mta_vector(struct ixgbe_hw *hw, u8 *mc_addr) 
/**

 *  ixgbe_set_mta - Set bit-vector in multicast table

 *  @hw: pointer to hardware structure

 *  @hash_value: Multicast address hash value

 *  @mc_addr: Multicast address

 *

 *  Sets the bit-vector in the multicast table.

 **/
@@ -3086,6 +3087,8 @@ s32 ixgbe_init_uta_tables_generic(struct ixgbe_hw *hw) 
 *  ixgbe_find_vlvf_slot - find the vlanid or the first empty slot

 *  @hw: pointer to hardware structure

 *  @vlan: VLAN id to write to VLAN filter

 *  @vlvf_bypass: true to find vlanid only, false returns first empty slot if

 *		  vlanid not found

 *

 *  return the VLVF index where this VLAN id should be placed

 *
@@ -3476,7 +3479,7 @@ void ixgbe_set_mac_anti_spoofing(struct ixgbe_hw *hw, bool enable, int vf) 
 *  ixgbe_set_vlan_anti_spoofing - Enable/Disable VLAN anti-spoofing

 *  @hw: pointer to hardware structure

 *  @enable: enable or disable switch for VLAN anti-spoofing

 *  @pf: Virtual Function pool - VF Pool to set for VLAN anti-spoofing

 *  @vf: Virtual Function pool - VF Pool to set for VLAN anti-spoofing

 *

 **/

void ixgbe_set_vlan_anti_spoofing(struct ixgbe_hw *hw, bool enable, int vf)

drivers/net/ethernet/intel/ixgbe/ixgbe_dcb.c

+8 −2
Original line number Diff line number Diff line
@@ -39,6 +39,10 @@ 
 * are the smallest unit programmable into the underlying

 * hardware. The IEEE 802.1Qaz specification do not use bandwidth

 * groups so this is much simplified from the CEE case.

 * @bw: bandwidth index by traffic class

 * @refill: refill credits index by traffic class

 * @max: max credits by traffic class

 * @max_frame: maximum frame size

 */

static s32 ixgbe_ieee_credits(__u8 *bw, __u16 *refill,

			      __u16 *max, int max_frame)
@@ -72,8 +76,10 @@ static s32 ixgbe_ieee_credits(__u8 *bw, __u16 *refill, 


/**

 * ixgbe_dcb_calculate_tc_credits - Calculates traffic class credits

 * @ixgbe_dcb_config: Struct containing DCB settings.

 * @direction: Configuring either Tx or Rx.

 * @hw: pointer to hardware structure

 * @dcb_config: Struct containing DCB settings

 * @max_frame: Maximum frame size

 * @direction: Configuring either Tx or Rx

 *

 * This function calculates the credits allocated to each traffic class.

 * It should be called only after the rules are checked by

drivers/net/ethernet/intel/ixgbe/ixgbe_dcb_82598.c

+17 −5
Original line number Diff line number Diff line
@@ -34,7 +34,9 @@ 
/**

 * ixgbe_dcb_config_rx_arbiter_82598 - Config Rx data arbiter

 * @hw: pointer to hardware structure

 * @dcb_config: pointer to ixgbe_dcb_config structure

 * @refill: refill credits index by traffic class

 * @max: max credits index by traffic class

 * @prio_type: priority type indexed by traffic class

 *

 * Configure Rx Data Arbiter and credits for each traffic class.

 */
@@ -91,7 +93,10 @@ s32 ixgbe_dcb_config_rx_arbiter_82598(struct ixgbe_hw *hw, 
/**

 * ixgbe_dcb_config_tx_desc_arbiter_82598 - Config Tx Desc. arbiter

 * @hw: pointer to hardware structure

 * @dcb_config: pointer to ixgbe_dcb_config structure

 * @refill: refill credits index by traffic class

 * @max: max credits index by traffic class

 * @bwg_id: bandwidth grouping indexed by traffic class

 * @prio_type: priority type indexed by traffic class

 *

 * Configure Tx Descriptor Arbiter and credits for each traffic class.

 */
@@ -137,7 +142,10 @@ s32 ixgbe_dcb_config_tx_desc_arbiter_82598(struct ixgbe_hw *hw, 
/**

 * ixgbe_dcb_config_tx_data_arbiter_82598 - Config Tx data arbiter

 * @hw: pointer to hardware structure

 * @dcb_config: pointer to ixgbe_dcb_config structure

 * @refill: refill credits index by traffic class

 * @max: max credits index by traffic class

 * @bwg_id: bandwidth grouping indexed by traffic class

 * @prio_type: priority type indexed by traffic class

 *

 * Configure Tx Data Arbiter and credits for each traffic class.

 */
@@ -184,7 +192,7 @@ s32 ixgbe_dcb_config_tx_data_arbiter_82598(struct ixgbe_hw *hw, 
/**

 * ixgbe_dcb_config_pfc_82598 - Config priority flow control

 * @hw: pointer to hardware structure

 * @dcb_config: pointer to ixgbe_dcb_config structure

 * @pfc_en: enabled pfc bitmask

 *

 * Configure Priority Flow Control for each traffic class.

 */
@@ -269,7 +277,11 @@ static s32 ixgbe_dcb_config_tc_stats_82598(struct ixgbe_hw *hw) 
/**

 * ixgbe_dcb_hw_config_82598 - Config and enable DCB

 * @hw: pointer to hardware structure

 * @dcb_config: pointer to ixgbe_dcb_config structure

 * @pfc_en: enabled pfc bitmask

 * @refill: refill credits index by traffic class

 * @max: max credits index by traffic class

 * @bwg_id: bandwidth grouping indexed by traffic class

 * @prio_type: priority type indexed by traffic class

 *

 * Configure dcb settings and enable dcb mode.

 */