upstream/opnsense-src
1
0
Fork 0
mirror of https://github.com/opnsense/src.git synced 2026-04-22 06:39:32 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

ixgbe: improve function comments

Browse source 
Some function comments have mismatches between actual function names and
function name in comments, which causes warnings with kernel-doc. Fix
comments to match function names.

Signed-off-by: Radoslaw Tyl <radoslawx.tyl@intel.com>
Reviewed-by: Piotr Skajewski <piotrx.skajewski@intel.com>
Reviewed-by: Slawomir Mrozowicz <slawomirx.mrozowicz@intel.com>
Reviewed-by: Alice Michael <alice.michael@intel.com>

Obtained from:	DPDK (7b5bc85)

(cherry picked from commit edef2769483b29457f028a508ea96fc1099a0a21)
This commit is contained in:
Radoslaw Tyl 2024-09-19 19:50:23 -07:00 committed by Kevin Bowling
parent 004a73f51d
commit dc3f0089b1
6 changed files with 16 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
sys/dev/ixgbe/ixgbe_82599.c
View file

@ -1537,7 +1537,7 @@ u32 ixgbe_atr_compute_sig_hash_82599(union ixgbe_atr_hash_dword input,
}
/**
* ixgbe_atr_add_signature_filter_82599 - Adds a signature hash filter
* ixgbe_fdir_add_signature_filter_82599 - Adds a signature hash filter
* @hw: pointer to hardware structure
* @input: unique input dword
* @common: compressed common input dword

2
sys/dev/ixgbe/ixgbe_api.c
View file

@ -904,7 +904,7 @@ s32 ixgbe_validate_eeprom_checksum(struct ixgbe_hw *hw, u16 *checksum_val)
}
/**
* ixgbe_eeprom_update_checksum - Updates the EEPROM checksum
* ixgbe_update_eeprom_checksum - Updates the EEPROM checksum
* @hw: pointer to hardware structure
**/
s32 ixgbe_update_eeprom_checksum(struct ixgbe_hw *hw)

11
sys/dev/ixgbe/ixgbe_common.c
View file

@ -3866,14 +3866,15 @@ s32 ixgbe_set_vmdq_generic(struct ixgbe_hw *hw, u32 rar, u32 vmdq)
}
/**
* ixgbe_set_vmdq_san_mac_generic - Associate default VMDq pool index with
* a rx address
* @hw: pointer to hardware struct
* @vmdq: VMDq pool index
*
* This function should only be involved in the IOV mode.
* In IOV mode, Default pool is next pool after the number of
* VFs advertized and not 0.
* MPSAR table needs to be updated for SAN_MAC RAR [hw->mac.san_mac_rar_index]
*
* ixgbe_set_vmdq_san_mac - Associate default VMDq pool index with a rx address
* @hw: pointer to hardware struct
* @vmdq: VMDq pool index
**/
s32 ixgbe_set_vmdq_san_mac_generic(struct ixgbe_hw *hw, u32 vmdq)
{
@ -4880,7 +4881,7 @@ static const u8 ixgbe_emc_therm_limit[4] = {
};
/**
* ixgbe_get_thermal_sensor_data - Gathers thermal sensor data
* ixgbe_get_thermal_sensor_data_generic - Gathers thermal sensor data
* @hw: pointer to hardware structure
*
* Returns the thermal sensor data structure

2
sys/dev/ixgbe/ixgbe_dcb.c
View file

@ -293,7 +293,7 @@ void ixgbe_dcb_unpack_map_cee(struct ixgbe_dcb_config *cfg, int direction,
}
/**
* ixgbe_dcb_config - Struct containing DCB settings.
* ixgbe_dcb_check_config_cee - Struct containing DCB settings.
* @dcb_config: Pointer to DCB config structure
*
* This function checks DCB rules for DCB settings.

2
sys/dev/ixgbe/ixgbe_phy.c
View file

@ -587,7 +587,7 @@ void ixgbe_restart_auto_neg(struct ixgbe_hw *hw)
}
/**
* ixgbe_read_phy_mdi - Reads a value from a specified PHY register without
* ixgbe_read_phy_reg_mdi - Reads a value from a specified PHY register without
* the SWFW lock
* @hw: pointer to hardware structure
* @reg_addr: 32 bit address of PHY register to read

12
sys/dev/ixgbe/ixgbe_x550.c
View file

@ -750,7 +750,7 @@ static s32 ixgbe_setup_fw_link(struct ixgbe_hw *hw)
}
/**
* ixgbe_fc_autoneg_fw _ Set up flow control for FW-controlled PHYs
* ixgbe_fc_autoneg_fw - Set up flow control for FW-controlled PHYs
* @hw: pointer to hardware structure
*
* Called at init time to set up flow control.
@ -1876,7 +1876,7 @@ void ixgbe_init_mac_link_ops_X550em(struct ixgbe_hw *hw)
}
/**
* ixgbe_get_link_capabilities_x550em - Determines link capabilities
* ixgbe_get_link_capabilities_X550em - Determines link capabilities
* @hw: pointer to hardware structure
* @speed: pointer to link speed
* @autoneg: true when autoneg or autotry is enabled
@ -3236,7 +3236,7 @@ out:
}
/**
* ixgbe_write_ee_hostif_X550 - Write EEPROM word using hostif
* ixgbe_write_ee_hostif_data_X550 - Write EEPROM word using hostif
* @hw: pointer to hardware structure
* @offset: offset of word in the EEPROM to write
* @data: word write to the EEPROM
@ -3704,7 +3704,7 @@ u64 ixgbe_get_supported_physical_layer_X550em(struct ixgbe_hw *hw)
}
/**
* ixgbe_get_bus_info_x550em - Set PCI bus info
* ixgbe_get_bus_info_X550em - Set PCI bus info
* @hw: pointer to hardware structure
*
* Sets bus link width and speed to unknown because X550em is
@ -3769,7 +3769,7 @@ void ixgbe_disable_rx_x550(struct ixgbe_hw *hw)
}
/**
* ixgbe_enter_lplu_x550em - Transition to low power states
* ixgbe_enter_lplu_t_x550em - Transition to low power states
* @hw: pointer to hardware structure
*
* Configures Low Power Link Up on transition to low power states
@ -3877,7 +3877,7 @@ s32 ixgbe_enter_lplu_t_x550em(struct ixgbe_hw *hw)
}
/**
* ixgbe_get_lcd_x550em - Determine lowest common denominator
* ixgbe_get_lcd_t_x550em - Determine lowest common denominator
* @hw: pointer to hardware structure
* @lcd_speed: pointer to lowest common link speed
*