ixgbe: Fix kernel-doc format warnings
Subsystems (2)
Tony Nguyen
maintainerPATCH 1/2 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.
--- drivers/net/ethernet/intel/ixgbe/ixgbe_82598.c | 3 ++- drivers/net/ethernet/intel/ixgbe/ixgbe_82599.c | 11 +++++--- drivers/net/ethernet/intel/ixgbe/ixgbe_common.c | 9 ++++--- drivers/net/ethernet/intel/ixgbe/ixgbe_dcb.c | 10 +++++-- drivers/net/ethernet/intel/ixgbe/ixgbe_dcb_82598.c | 22 +++++++++++---- drivers/net/ethernet/intel/ixgbe/ixgbe_dcb_82599.c | 5 +++- drivers/net/ethernet/intel/ixgbe/ixgbe_debugfs.c | 2 +- drivers/net/ethernet/intel/ixgbe/ixgbe_fcoe.c | 3 ++- drivers/net/ethernet/intel/ixgbe/ixgbe_main.c | 31 ++++++++++++++-------- drivers/net/ethernet/intel/ixgbe/ixgbe_phy.c | 15 +++++++++-- drivers/net/ethernet/intel/ixgbe/ixgbe_ptp.c | 8 +++--- drivers/net/ethernet/intel/ixgbe/ixgbe_x550.c | 19 ++++++++++--- 12 files changed, 99 insertions(+), 39 deletions(-)
drivers/net/ethernet/intel/ixgbe/ixgbe_82598.c +2 -1
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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. */
drivers/net/ethernet/intel/ixgbe/ixgbe_dcb_82599.c +4 -1
@@ -38,6 +38,7 @@* @max: max credits index by traffic class * @bwg_id: bandwidth grouping indexed by traffic class * @prio_type: priority type indexed by traffic class +* @prio_tc: priority to tc assignments indexed by priority * * Configure Rx Packet Arbiter and credits for each traffic class. */
@@ -148,6 +149,7 @@ s32 ixgbe_dcb_config_tx_desc_arbiter_82599(struct ixgbe_hw *hw,* @max: max credits index by traffic class * @bwg_id: bandwidth grouping indexed by traffic class * @prio_type: priority type indexed by traffic class +* @prio_tc: priority to tc assignments indexed by priority * * Configure Tx Packet Arbiter and credits for each traffic class. */
@@ -344,11 +346,12 @@ static s32 ixgbe_dcb_config_tc_stats_82599(struct ixgbe_hw *hw)/** * ixgbe_dcb_hw_config_82599 - Configure and enable DCB * @hw: pointer to hardware 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 -* @pfc_en: enabled pfc bitmask +* @prio_tc: priority to tc assignments indexed by priority * * Configure dcb settings and enable dcb mode. */
drivers/net/ethernet/intel/ixgbe/ixgbe_debugfs.c +1 -1
@@ -249,7 +249,7 @@ void ixgbe_dbg_adapter_init(struct ixgbe_adapter *adapter)/** * ixgbe_dbg_adapter_exit - clear out the adapter's debugfs entries -* @pf: the pf that is stopping +* @adapter: the adapter that is exiting **/ void ixgbe_dbg_adapter_exit (struct ixgbe_adapter *adapter) {
drivers/net/ethernet/intel/ixgbe/ixgbe_fcoe.c +2 -1
@@ -150,6 +150,7 @@ int ixgbe_fcoe_ddp_put(struct net_device *netdev, u16 xid)* @xid: the exchange id requesting ddp * @sgl: the scatter-gather list for this request * @sgc: the number of scatter-gather items +* @target_mode: 1 to setup target mode, 0 to setup initiator mode * * Returns : 1 for success and 0 for no ddp */
@@ -1063,7 +1064,7 @@ int ixgbe_fcoe_get_hbainfo(struct net_device *netdev,/** * ixgbe_fcoe_get_tc - get the current TC that fcoe is mapped to -* @adapter - pointer to the device adapter structure +* @adapter: pointer to the device adapter structure * * Return : TC that FCoE is mapped to */
drivers/net/ethernet/intel/ixgbe/ixgbe_main.c +20 -11
@@ -1128,6 +1128,9 @@ static void ixgbe_tx_timeout_reset(struct ixgbe_adapter *adapter)/** * ixgbe_tx_maxrate - callback to set the maximum per-queue bitrate +* @netdev: network interface device structure +* @queue_index: Tx queue to set +* @maxrate: desired maximum transmit bitrate **/ static int ixgbe_tx_maxrate (struct net_device *netdev,int queue_index,u32 maxrate)
@@ -2025,8 +2028,8 @@ static bool ixgbe_can_reuse_rx_page(struct ixgbe_rx_buffer *rx_buffer)* ixgbe_add_rx_frag - Add contents of Rx buffer to sk_buff * @rx_ring: rx descriptor ring to transact packets on * @rx_buffer: buffer containing page to add -* @rx_desc: descriptor containing length of buffer written by hardware * @skb: sk_buff to place the data into +* @size: size of data in rx_buffer * * This function will add the data contained in rx_buffer->page to the skb. * This is done either through a direct copy if the data in the buffer is
@@ -3015,6 +3018,8 @@ static inline void ixgbe_irq_disable_queues(struct ixgbe_adapter *adapter,/** * ixgbe_irq_enable - Enable default interrupt generation settings * @adapter: board private structure +* @queues: enable irqs for queues +* @flush: flush register write **/ static inline void ixgbe_irq_enable (struct ixgbe_adapter *adapter,bool queues,bool flush)
@@ -3470,6 +3475,7 @@ static inline void ixgbe_irq_disable(struct ixgbe_adapter *adapter)/** * ixgbe_configure_msi_and_legacy - Initialize PIN (INTA...) and MSI interrupts +* @adapter: board private structure * **/ static void ixgbe_configure_msi_and_legacy (struct ixgbe_adapter *adapter)
@@ -3998,8 +4004,8 @@ static void ixgbe_setup_mrqc(struct ixgbe_adapter *adapter)/** * ixgbe_configure_rscctl - enable RSC for the indicated ring -* @adapter: address of board private structure -* @index: index of ring to set +* @adapter: address of board private structure +* @ring: structure containing ring specific data **/ static void ixgbe_configure_rscctl (struct ixgbe_adapter *adapter,struct ixgbe_ring *ring)
@@ -4855,9 +4861,11 @@ int ixgbe_del_mac_filter(struct ixgbe_adapter *adapter,return -ENOMEM ; } +/** * ixgbe_write_uc_addr_list - write unicast addresses to RAR table * @netdev: network interface device structure +* @vfn: pool to associate with unicast addresses * * Writes unicast address list to the RAR table. * Returns: -ENOMEM on failure/insufficient address space
@@ -6035,6 +6043,7 @@ static void ixgbe_init_dcb(struct ixgbe_adapter *adapter)/** * ixgbe_sw_init - Initialize general software structures (struct ixgbe_adapter) * @adapter: board private structure to initialize +* @ii: pointer to ixgbe_info for device * * ixgbe_sw_init initializes the Adapter private data structure. * Fields are initialized based on PCI device information and
@@ -6319,6 +6328,7 @@ static int ixgbe_setup_all_tx_resources(struct ixgbe_adapter *adapter)/** * ixgbe_setup_rx_resources - allocate Rx resources (Descriptors) +* @adapter: pointer to ixgbe_adapter * @rx_ring: rx descriptor ring (for a specific queue) to setup * * Returns 0 on success, negative on failure
@@ -7125,7 +7135,6 @@ static void ixgbe_check_hang_subtask(struct ixgbe_adapter *adapter)/** * ixgbe_watchdog_update_link - update the link status * @adapter: pointer to the device adapter structure -* @link_speed: pointer to a u32 to store the link_speed **/ static void ixgbe_watchdog_update_link (struct ixgbe_adapter *adapter) {
@@ -7578,7 +7587,7 @@ static void ixgbe_sfp_link_config_subtask(struct ixgbe_adapter *adapter)/** * ixgbe_service_timer - Timer Call-back -* @data: pointer to adapter cast into an unsigned long +* @t: pointer to timer_list structure **/ static void ixgbe_service_timer (struct timer_list *t) {
@@ -8566,7 +8575,7 @@ static int ixgbe_ioctl(struct net_device *netdev, struct ifreq *req, int cmd)/** * ixgbe_add_sanmac_netdev - Add the SAN MAC address to the corresponding * netdev->dev_addrs -* @netdev: network interface device structure +* @dev: network interface device structure * * Returns non-zero on failure **/
@@ -8590,7 +8599,7 @@ static int ixgbe_add_sanmac_netdev(struct net_device *dev)/** * ixgbe_del_sanmac_netdev - Removes the SAN MAC address to the corresponding * netdev->dev_addrs -* @netdev: network interface device structure +* @dev: network interface device structure * * Returns non-zero on failure **/
@@ -8757,7 +8766,7 @@ static void ixgbe_set_prio_tc_map(struct ixgbe_adapter *adapter)/** * ixgbe_setup_tc - configure net_device for multiple traffic classes * -* @netdev: net device to configure +* @dev: net device to configure * @tc: number of traffic classes to enable */ int ixgbe_setup_tc (struct net_device *dev,u8 tc)
@@ -9592,8 +9601,8 @@ static int ixgbe_ndo_fdb_add(struct ndmsg *ndm, struct nlattr *tb[],/** * ixgbe_configure_bridge_mode - set various bridge modes -* @adapter - the private structure -* @mode - requested bridge mode +* @adapter: the private structure +* @mode: requested bridge mode * * Configure some settings require for various bridge modes. **/
@@ -10061,7 +10070,7 @@ static inline int ixgbe_enumerate_functions(struct ixgbe_adapter *adapter)* ixgbe_wol_supported - Check whether device supports WoL * @adapter: the adapter private structure * @device_id: the device ID -* @subdev_id: the subsystem device ID +* @subdevice_id: the subsystem device ID * * This function is used by probe and ethtool to determine * which devices have WoL support
drivers/net/ethernet/intel/ixgbe/ixgbe_phy.c +13 -2
@@ -378,7 +378,7 @@ static s32 ixgbe_get_phy_id(struct ixgbe_hw *hw)/** * ixgbe_get_phy_type_from_id - Get the phy type -* @hw: pointer to hardware structure +* @phy_id: hardware phy id * **/ static enum ixgbe_phy_type ixgbe_get_phy_type_from_id (u32 phy_id)
@@ -489,6 +489,7 @@ s32 ixgbe_reset_phy_generic(struct ixgbe_hw *hw)* the SWFW lock * @hw: pointer to hardware structure * @reg_addr: 32 bit address of PHY register to read +* @device_type: 5 bit device type * @phy_data: Pointer to read data from PHY register **/ s32 ixgbe_read_phy_reg_mdi(struct ixgbe_hw *hw, u32 reg_addr, u32 device_type,
@@ -564,6 +565,7 @@ s32 ixgbe_read_phy_reg_mdi(struct ixgbe_hw *hw, u32 reg_addr, u32 device_type,* using the SWFW lock - this function is needed in most cases * @hw: pointer to hardware structure * @reg_addr: 32 bit address of PHY register to read +* @device_type: 5 bit device type * @phy_data: Pointer to read data from PHY register **/ s32 ixgbe_read_phy_reg_generic(struct ixgbe_hw *hw, u32 reg_addr,
@@ -763,6 +765,7 @@ s32 ixgbe_setup_phy_link_generic(struct ixgbe_hw *hw)* ixgbe_setup_phy_link_speed_generic - Sets the auto advertised capabilities * @hw: pointer to hardware structure * @speed: new link speed +* @autoneg_wait_to_complete: unused **/ s32 ixgbe_setup_phy_link_speed_generic(struct ixgbe_hw *hw, ixgbe_link_speed speed,
@@ -861,6 +864,8 @@ s32 ixgbe_get_copper_link_capabilities_generic(struct ixgbe_hw *hw,/** * ixgbe_check_phy_link_tnx - Determine link and speed status * @hw: pointer to hardware structure +* @speed: link speed +* @link_up: status of link * * Reads the VS1 register to determine if link is up and the current speed for * the PHY.
@@ -1667,7 +1672,7 @@ s32 ixgbe_read_i2c_eeprom_generic(struct ixgbe_hw *hw, u8 byte_offset,* ixgbe_read_i2c_sff8472_generic - 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 byte read operation to SFP module's SFF-8472 data over I2C **/
@@ -1714,6 +1719,7 @@ static bool ixgbe_is_sfp_probe(struct ixgbe_hw *hw, u8 offset, u8 addr)* ixgbe_read_i2c_byte_generic_int - Reads 8 bit word over I2C * @hw: pointer to hardware structure * @byte_offset: byte offset to read +* @dev_addr: device address * @data: value read * @lock: true if to take and release semaphore *
@@ -1804,6 +1810,7 @@ static s32 ixgbe_read_i2c_byte_generic_int(struct ixgbe_hw *hw, u8 byte_offset,* ixgbe_read_i2c_byte_generic - Reads 8 bit word over I2C * @hw: pointer to hardware structure * @byte_offset: byte offset to read +* @dev_addr: device address * @data: value read * * Performs byte read operation to SFP module's EEPROM over I2C interface at
@@ -1820,6 +1827,7 @@ s32 ixgbe_read_i2c_byte_generic(struct ixgbe_hw *hw, u8 byte_offset,* ixgbe_read_i2c_byte_generic_unlocked - Reads 8 bit word over I2C * @hw: pointer to hardware structure * @byte_offset: byte offset to read +* @dev_addr: device address * @data: value read * * Performs byte read operation to SFP module's EEPROM over I2C interface at
@@ -1836,6 +1844,7 @@ s32 ixgbe_read_i2c_byte_generic_unlocked(struct ixgbe_hw *hw, u8 byte_offset,* ixgbe_write_i2c_byte_generic_int - Writes 8 bit word over I2C * @hw: pointer to hardware structure * @byte_offset: byte offset to write +* @dev_addr: device address * @data: value to write * @lock: true if to take and release semaphore *
@@ -1904,6 +1913,7 @@ static s32 ixgbe_write_i2c_byte_generic_int(struct ixgbe_hw *hw, u8 byte_offset,* ixgbe_write_i2c_byte_generic - Writes 8 bit word over I2C * @hw: pointer to hardware structure * @byte_offset: byte offset to write +* @dev_addr: device address * @data: value to write * * Performs byte write operation to SFP module's EEPROM over I2C interface at
@@ -1920,6 +1930,7 @@ s32 ixgbe_write_i2c_byte_generic(struct ixgbe_hw *hw, u8 byte_offset,* ixgbe_write_i2c_byte_generic_unlocked - Writes 8 bit word over I2C * @hw: pointer to hardware structure * @byte_offset: byte offset to write +* @dev_addr: device address * @data: value to write * * Performs byte write operation to SFP module's EEPROM over I2C interface at
drivers/net/ethernet/intel/ixgbe/ixgbe_ptp.c +4 -4
@@ -166,7 +166,7 @@/** * ixgbe_ptp_setup_sdp_x540 -* @hw: the hardware private structure +* @adapter: private adapter structure * * this function enables or disables the clock out feature on SDP0 for * the X540 device. It will create a 1second periodic output that can
@@ -299,7 +299,7 @@ static u64 ixgbe_ptp_read_82599(const struct cyclecounter *cc)* ixgbe_ptp_convert_to_hwtstamp - convert register value to hw timestamp * @adapter: private adapter structure * @hwtstamp: stack timestamp structure -* @systim: unsigned 64bit system time value +* @timestamp: unsigned 64bit system time value * * We need to convert the adapter's RX/TXSTMP registers into a hwtstamp value * which can be used by the stack's ptp functions.
@@ -1015,7 +1015,7 @@ static int ixgbe_ptp_set_timestamp_mode(struct ixgbe_adapter *adapter,/** * ixgbe_ptp_set_ts_config - user entry point for timestamp mode * @adapter: pointer to adapter struct -* @ifreq: ioctl data +* @ifr: ioctl data * * Set hardware to requested mode. If unsupported, return an error with no * changes. Otherwise, store the mode for future reference.
@@ -1338,7 +1338,7 @@ void ixgbe_ptp_init(struct ixgbe_adapter *adapter)/** * ixgbe_ptp_suspend - stop PTP work items -* @ adapter: pointer to adapter struct +* @adapter: pointer to adapter struct * * this function suspends PTP activity, and prevents more PTP work from being * generated, but does not destroy the PTP clock device.
drivers/net/ethernet/intel/ixgbe/ixgbe_x550.c +15 -4
@@ -1642,10 +1642,12 @@ static s32 ixgbe_supported_sfp_modules_X550em(struct ixgbe_hw *hw, bool *linear) }/** -* ixgbe_setup_mac_link_sfp_x550em - Configure the KR PHY for SFP. -* @hw: pointer to hardware structure +* ixgbe_setup_mac_link_sfp_x550em - Configure the KR PHY for SFP. +* @hw: pointer to hardware structure +* @speed: the link speed to force +* @autoneg_wait_to_complete: unused * -* Configures the extern PHY and the integrated KR PHY for SFP support. +* Configures the extern PHY and the integrated KR PHY for SFP support. */ static s32 ixgbe_setup_mac_link_sfp_x550em(struct ixgbe_hw *hw,
@@ -1737,6 +1739,8 @@ static s32 ixgbe_setup_sfi_x550a(struct ixgbe_hw *hw, ixgbe_link_speed *speed)/** * ixgbe_setup_mac_link_sfp_n - Setup internal PHY for native SFP * @hw: pointer to hardware structure +* @speed: link speed +* @autoneg_wait_to_complete: unused * * Configure the the integrated PHY for native SFP support. */
@@ -1784,6 +1788,8 @@ ixgbe_setup_mac_link_sfp_n(struct ixgbe_hw *hw, ixgbe_link_speed speed,/** * ixgbe_setup_mac_link_sfp_x550a - Setup internal PHY for SFP * @hw: pointer to hardware structure +* @speed: link speed +* @autoneg_wait_to_complete: unused * * Configure the the integrated PHY for SFP support. */
@@ -1859,7 +1865,7 @@ ixgbe_setup_mac_link_sfp_x550a(struct ixgbe_hw *hw, ixgbe_link_speed speed,* ixgbe_setup_mac_link_t_X550em - Sets the auto advertised link speed * @hw: pointer to hardware structure * @speed: new link speed -* @autoneg_wait_to_complete: true when waiting for completion is needed +* @autoneg_wait: true when waiting for completion is needed * * Setup internal/external PHY link speed based on link speed, then set * external PHY auto advertised link speed.
@@ -1943,6 +1949,8 @@ static s32 ixgbe_check_link_t_X550em(struct ixgbe_hw *hw,/** * ixgbe_setup_sgmii - Set up link for sgmii * @hw: pointer to hardware structure +* @speed: unused +* @autoneg_wait_to_complete: unused */ static s32 ixgbe_setup_sgmii(struct ixgbe_hw *hw, __always_unused ixgbe_link_speed speed,
@@ -2014,6 +2022,8 @@ ixgbe_setup_sgmii(struct ixgbe_hw *hw, __always_unused ixgbe_link_speed speed,/** * ixgbe_setup_sgmii_fw - Set up link for sgmii with firmware-controlled PHYs * @hw: pointer to hardware structure +* @speed: the link speed to force +* @autoneg_wait: true when waiting for completion is needed */ static s32 ixgbe_setup_sgmii_fw (struct ixgbe_hw *hw,ixgbe_link_speed speed,bool autoneg_wait)
@@ -3735,6 +3745,7 @@ static void ixgbe_release_swfw_sync_x550em_a(struct ixgbe_hw *hw, u32 mask)* ixgbe_read_phy_reg_x550a - Reads specified PHY register * @hw: pointer to hardware structure * @reg_addr: 32 bit address of PHY register to read +* @device_type: 5 bit device type * @phy_data: Pointer to read data from PHY register * * Reads a value from a specified PHY register using the SWFW lock and PHY
Signature · 1 line
2.9.5
Tony Nguyen
maintainerPATCH 2/2 ixgbevf: 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.
--- drivers/net/ethernet/intel/ixgbevf/ixgbevf_main.c | 6 +++--- drivers/net/ethernet/intel/ixgbevf/vf.c | 17 +++++++++++++++-- 2 files changed, 18 insertions(+), 5 deletions(-)
drivers/net/ethernet/intel/ixgbevf/ixgbevf_main.c +3 -3
@@ -554,7 +554,6 @@ static void ixgbevf_process_skb_fields(struct ixgbevf_ring *rx_ring,* ixgbevf_is_non_eop - process handling of non-EOP buffers * @rx_ring: Rx ring being processed * @rx_desc: Rx descriptor for current buffer -* @skb: current socket buffer containing buffer in progress * * This function updates next to clean. If the buffer is an EOP buffer * this function exits returning false, otherwise it will place the
@@ -2741,7 +2740,7 @@ void ixgbevf_update_stats(struct ixgbevf_adapter *adapter)/** * ixgbevf_service_timer - Timer Call-back -* @data: pointer to adapter cast into an unsigned long +* @t: pointer to timer_list struct **/ static void ixgbevf_service_timer (struct timer_list *t) {
@@ -2884,7 +2883,7 @@ static void ixgbevf_watchdog_link_is_down(struct ixgbevf_adapter *adapter)/** * ixgbevf_watchdog_subtask - worker thread to bring link up -* @work: pointer to work_struct containing our data +* @adapter: board private structure **/ static void ixgbevf_watchdog_subtask (struct ixgbevf_adapter *adapter) {
@@ -4364,6 +4363,7 @@ static void __exit ixgbevf_exit_module(void)/** * ixgbevf_get_hw_dev_name - return device name string * used by hardware layer to print debugging information +* @hw: pointer to private hardware struct **/ char *ixgbevf_get_hw_dev_name (struct ixgbe_hw *hw) {
drivers/net/ethernet/intel/ixgbevf/vf.c +15 -2
@@ -146,6 +146,7 @@ static s32 ixgbevf_reset_hw_vf(struct ixgbe_hw *hw)/** * Hyper-V variant; the VF/PF communication is through the PCI * config space. +* @hw: pointer to private hardware struct */ static s32 ixgbevf_hv_reset_hw_vf (struct ixgbe_hw *hw) {
@@ -303,7 +304,7 @@ static s32 ixgbevf_hv_set_uc_addr_vf(struct ixgbe_hw *hw, u32 index, u8 *addr)/** * ixgbevf_get_reta_locked - get the RSS redirection table (RETA) contents. -* @adapter: pointer to the port handle +* @hw: pointer to hardware structure * @reta: buffer to fill with RETA contents. * @num_rx_queues: Number of Rx queues configured for this port *
@@ -536,6 +537,8 @@ static s32 ixgbevf_update_mc_addr_list_vf(struct ixgbe_hw *hw,/** * Hyper-V variant - just a stub. +* @hw: unused +* @netdev: unused */ static s32 ixgbevf_hv_update_mc_addr_list_vf (struct ixgbe_hw *hw,struct net_device *netdev)
@@ -584,6 +587,8 @@ static s32 ixgbevf_update_xcast_mode(struct ixgbe_hw *hw, int xcast_mode)/** * Hyper-V variant - just a stub. +* @hw: unused +* @xcast_mode: unused */ static s32 ixgbevf_hv_update_xcast_mode (struct ixgbe_hw *hw,int xcast_mode) {
@@ -626,6 +631,10 @@ static s32 ixgbevf_set_vfta_vf(struct ixgbe_hw *hw, u32 vlan, u32 vind,/** * Hyper-V variant - just a stub. +* @hw: unused +* @vlan: unused +* @vind: unused +* @vlan_on: unused */ static s32 ixgbevf_hv_set_vfta_vf (struct ixgbe_hw *hw,u32 vlan,u32 vind,bool vlan_on)
@@ -655,7 +664,7 @@ static s32 ixgbevf_setup_mac_link_vf(struct ixgbe_hw *hw,* @hw: pointer to hardware structure * @speed: pointer to link speed * @link_up: true is link is up, false otherwise -* @autoneg_wait_to_complete: true when waiting for completion is needed +* @autoneg_wait_to_complete: unused * * Reads the links register to determine if link is up and the current speed **/
@@ -740,6 +749,10 @@ static s32 ixgbevf_check_mac_link_vf(struct ixgbe_hw *hw,/** * Hyper-V variant; there is no mailbox communication. +* @hw: pointer to private hardware struct +* @speed: pointer to link speed +* @link_up: true is link is up, false otherwise +* @autoneg_wait_to_complete: unused */ static s32 ixgbevf_hv_check_mac_link_vf(struct ixgbe_hw *hw, ixgbe_link_speed *speed,
Signature · 1 line
2.9.5
Bowers
PATCH 2/2 ixgbevf: Fix kernel-doc format warnings
Quoted 12 lines
-----Original Message-----
From: Intel-wired-lan [mailto:intel-wired-lan-bounces at osuosl.org] On Behalf Of Tony Nguyen
Sent: Monday, December 4, 2017 11:29 AM
To: intel-wired-lan at lists.osuosl.org
Subject: [Intel-wired-lan] [PATCH 2/2] ixgbevf: Fix kernel-doc format warningsRecent 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.
Quoted 5 lines
Signed-off-by Tony Nguyen <[email protected]>--- drivers/net/ethernet/intel/ixgbevf/ixgbevf_main.c | 6 +++--- drivers/net/ethernet/intel/ixgbevf/vf.c | 17 +++++++++++++++-- 2 files changed, 18 insertions(+), 5 deletions(-)
Bowers
PATCH 1/2 ixgbe: Fix kernel-doc format warnings
In reply to Tony NguyenQuoted 12 lines
-----Original Message-----
From: Intel-wired-lan [mailto:intel-wired-lan-bounces at osuosl.org] On Behalf Of Tony Nguyen
Sent: Monday, December 4, 2017 11:29 AM
To: intel-wired-lan at lists.osuosl.org
Subject: [Intel-wired-lan] [PATCH 1/2] ixgbe: Fix kernel-doc format warningsRecent 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 Tony Nguyen <[email protected]>
Quoted 15 lines
--- drivers/net/ethernet/intel/ixgbe/ixgbe_82598.c | 3 ++- drivers/net/ethernet/intel/ixgbe/ixgbe_82599.c | 11 +++++--- drivers/net/ethernet/intel/ixgbe/ixgbe_common.c | 9 ++++--- drivers/net/ethernet/intel/ixgbe/ixgbe_dcb.c | 10 +++++-- drivers/net/ethernet/intel/ixgbe/ixgbe_dcb_82598.c | 22 +++++++++++---- drivers/net/ethernet/intel/ixgbe/ixgbe_dcb_82599.c | 5 +++- drivers/net/ethernet/intel/ixgbe/ixgbe_debugfs.c | 2 +- drivers/net/ethernet/intel/ixgbe/ixgbe_fcoe.c | 3 ++- drivers/net/ethernet/intel/ixgbe/ixgbe_main.c | 31 ++++++++++++++---- ---- drivers/net/ethernet/intel/ixgbe/ixgbe_phy.c | 15 +++++++++-- drivers/net/ethernet/intel/ixgbe/ixgbe_ptp.c | 8 +++--- drivers/net/ethernet/intel/ixgbe/ixgbe_x550.c | 19 ++++++++++--- 12 files changed, 99 insertions(+), 39 deletions(-)