igb: cleanup function header comments

}

/**

 *  e1000_acquire_phy_82575 - Acquire rights to access PHY

 *  igb_acquire_phy_82575 - Acquire rights to access PHY

 *  @hw: pointer to the HW structure

 *

 *  Acquire access rights to the correct PHY.  This is a

}

/**

 *  e1000_release_phy_82575 - Release rights to access PHY

 *  igb_release_phy_82575 - Release rights to access PHY

 *  @hw: pointer to the HW structure

 *

 *  A wrapper to release access rights to the correct PHY.  This is a

}

/**

 *  e1000_read_phy_reg_sgmii_82575 - Read PHY register using sgmii

 *  igb_read_phy_reg_sgmii_82575 - Read PHY register using sgmii

 *  @hw: pointer to the HW structure

 *  @offset: register offset to be read

 *  @data: pointer to the read data

}

/**

 *  e1000_write_phy_reg_sgmii_82575 - Write PHY register using sgmii

 *  igb_write_phy_reg_sgmii_82575 - Write PHY register using sgmii

 *  @hw: pointer to the HW structure

 *  @offset: register offset to write to

 *  @data: data to write at register offset

}

/**

 *  e1000_get_phy_id_82575 - Retreive PHY addr and id

 *  igb_get_phy_id_82575 - Retrieve PHY addr and id

 *  @hw: pointer to the HW structure

 *

 *  Retreives the PHY address and ID for both PHY's which do and do not use

}

/**

 *  e1000_phy_hw_reset_sgmii_82575 - Performs a PHY reset

 *  igb_phy_hw_reset_sgmii_82575 - Performs a PHY reset

 *  @hw: pointer to the HW structure

 *

 *  Resets the PHY using the serial gigabit media independent interface.

}

/**

 *  e1000_set_d0_lplu_state_82575 - Set Low Power Linkup D0 state

 *  igb_set_d0_lplu_state_82575 - Set Low Power Linkup D0 state

 *  @hw: pointer to the HW structure

 *  @active: true to enable LPLU, false to disable

 *

}

/**

 *  e1000_acquire_nvm_82575 - Request for access to EEPROM

 *  igb_acquire_nvm_82575 - Request for access to EEPROM

 *  @hw: pointer to the HW structure

 *

 *  Acquire the necessary semaphores for exclussive access to the EEPROM.

}

/**

 *  e1000_release_nvm_82575 - Release exclusive access to EEPROM

 *  igb_release_nvm_82575 - Release exclusive access to EEPROM

 *  @hw: pointer to the HW structure

 *

 *  Stop any current commands to the EEPROM and clear the EEPROM request bit,

}

/**

 *  e1000_acquire_swfw_sync_82575 - Acquire SW/FW semaphore

 *  igb_acquire_swfw_sync_82575 - Acquire SW/FW semaphore

 *  @hw: pointer to the HW structure

 *  @mask: specifies which semaphore to acquire

 *

}

/**

 *  e1000_release_swfw_sync_82575 - Release SW/FW semaphore

 *  igb_release_swfw_sync_82575 - Release SW/FW semaphore

 *  @hw: pointer to the HW structure

 *  @mask: specifies which semaphore to acquire

 *

}

/**

 *  e1000_get_cfg_done_82575 - Read config done bit

 *  igb_get_cfg_done_82575 - Read config done bit

 *  @hw: pointer to the HW structure

 *

 *  Read the management control register for the config done bit for

}

/**

 *  e1000_check_for_link_82575 - Check for link

 *  igb_check_for_link_82575 - Check for link

 *  @hw: pointer to the HW structure

 *

 *  If sgmii is enabled, then use the pcs register to determine link, otherwise

}

/**

 *  e1000_get_pcs_speed_and_duplex_82575 - Retrieve current speed/duplex

 *  igb_get_pcs_speed_and_duplex_82575 - Retrieve current speed/duplex

 *  @hw: pointer to the HW structure

 *  @speed: stores the current speed

 *  @duplex: stores the current duplex

}

/**

 *  e1000_rar_set_82575 - Set receive address register

 *  igb_rar_set_82575 - Set receive address register

 *  @hw: pointer to the HW structure

 *  @addr: pointer to the receive address

 *  @index: receive address array register

}

/**

 *  e1000_reset_hw_82575 - Reset hardware

 *  igb_reset_hw_82575 - Reset hardware

 *  @hw: pointer to the HW structure

 *

 *  This resets the hardware into a known state.  This is a

}

/**

 *  e1000_init_hw_82575 - Initialize hardware

 *  igb_init_hw_82575 - Initialize hardware

 *  @hw: pointer to the HW structure

 *

 *  This inits the hardware readying it for operation.

}

/**

 *  e1000_setup_copper_link_82575 - Configure copper link settings

 *  igb_setup_copper_link_82575 - Configure copper link settings

 *  @hw: pointer to the HW structure

 *

 *  Configures the link for auto-neg or forced speed and duplex.  Then we check

}

/**

 *  e1000_setup_fiber_serdes_link_82575 - Setup link for fiber/serdes

 *  igb_setup_fiber_serdes_link_82575 - Setup link for fiber/serdes

 *  @hw: pointer to the HW structure

 *

 *  Configures speed and duplex for fiber and serdes links.

}

/**

 *  e1000_configure_pcs_link_82575 - Configure PCS link

 *  igb_configure_pcs_link_82575 - Configure PCS link

 *  @hw: pointer to the HW structure

 *

 *  Configure the physical coding sub-layer (PCS) link.  The PCS link is

}

/**

 *  e1000_sgmii_active_82575 - Return sgmii state

 *  igb_sgmii_active_82575 - Return sgmii state

 *  @hw: pointer to the HW structure

 *

 *  82575 silicon has a serialized gigabit media independent interface (sgmii)

}

/**

 *  e1000_reset_init_script_82575 - Inits HW defaults after reset

 *  igb_reset_init_script_82575 - Inits HW defaults after reset

 *  @hw: pointer to the HW structure

 *

 *  Inits recommended HW defaults after a reset when there is no EEPROM

}

/**

 *  e1000_read_mac_addr_82575 - Read device MAC address

 *  igb_read_mac_addr_82575 - Read device MAC address

 *  @hw: pointer to the HW structure

 **/

static s32 igb_read_mac_addr_82575(struct e1000_hw *hw)

}

/**

 *  e1000_clear_hw_cntrs_82575 - Clear device specific hardware counters

 *  igb_clear_hw_cntrs_82575 - Clear device specific hardware counters

 *  @hw: pointer to the HW structure

 *

 *  Clears the hardware counters by reading the counter registers.

static u32 igb_hash_mc_addr(struct e1000_hw *hw, u8 *mc_addr);

/**

 *  e1000_remove_device - Free device specific structure

 *  igb_remove_device - Free device specific structure

 *  @hw: pointer to the HW structure

 *

 *  If a device specific structure was allocated, this function will

}

/**

 *  e1000_get_bus_info_pcie - Get PCIe bus information

 *  igb_get_bus_info_pcie - Get PCIe bus information

 *  @hw: pointer to the HW structure

 *

 *  Determines and stores the system bus information for a particular

}

/**

 *  e1000_clear_vfta - Clear VLAN filter table

 *  igb_clear_vfta - Clear VLAN filter table

 *  @hw: pointer to the HW structure

 *

 *  Clears the register array which contains the VLAN filter table by

}

/**

 *  e1000_write_vfta - Write value to VLAN filter table

 *  igb_write_vfta - Write value to VLAN filter table

 *  @hw: pointer to the HW structure

 *  @offset: register offset in VLAN filter table

 *  @value: register value written to VLAN filter table

}

/**

 *  e1000_init_rx_addrs - Initialize receive address's

 *  igb_init_rx_addrs - Initialize receive address's

 *  @hw: pointer to the HW structure

 *  @rar_count: receive address registers

 *

}

/**

 *  e1000_check_alt_mac_addr - Check for alternate MAC addr

 *  igb_check_alt_mac_addr - Check for alternate MAC addr

 *  @hw: pointer to the HW structure

 *

 *  Checks the nvm for an alternate MAC address.  An alternate MAC address

}

/**

 *  e1000_rar_set - Set receive address register

 *  igb_rar_set - Set receive address register

 *  @hw: pointer to the HW structure

 *  @addr: pointer to the receive address

 *  @index: receive address array register

}

/**

 *  e1000_mta_set - Set multicast filter table address

 *  igb_mta_set - Set multicast filter table address

 *  @hw: pointer to the HW structure

 *  @hash_value: determines the MTA register and bit to set

 *

}

/**

 *  e1000_update_mc_addr_list - Update Multicast addresses

 *  igb_update_mc_addr_list - Update Multicast addresses

 *  @hw: pointer to the HW structure

 *  @mc_addr_list: array of multicast addresses to program

 *  @mc_addr_count: number of multicast addresses to program

}

/**

 *  e1000_hash_mc_addr - Generate a multicast hash value

 *  igb_hash_mc_addr - Generate a multicast hash value

 *  @hw: pointer to the HW structure

 *  @mc_addr: pointer to a multicast address

 *

}

/**

 *  e1000_clear_hw_cntrs_base - Clear base hardware counters

 *  igb_clear_hw_cntrs_base - Clear base hardware counters

 *  @hw: pointer to the HW structure

 *

 *  Clears the base hardware counters by reading the counter registers.

}

/**

 *  e1000_check_for_copper_link - Check for link (Copper)

 *  igb_check_for_copper_link - Check for link (Copper)

 *  @hw: pointer to the HW structure

 *

 *  Checks to see of the link status of the hardware has changed.  If a

}

/**

 *  e1000_setup_link - Setup flow control and link settings

 *  igb_setup_link - Setup flow control and link settings

 *  @hw: pointer to the HW structure

 *

 *  Determines which flow control settings to use, then configures flow

}

/**

 *  e1000_config_collision_dist - Configure collision distance

 *  igb_config_collision_dist - Configure collision distance

 *  @hw: pointer to the HW structure

 *

 *  Configures the collision distance to the default value and is used

}

/**

 *  e1000_set_fc_watermarks - Set flow control high/low watermarks

 *  igb_set_fc_watermarks - Set flow control high/low watermarks

 *  @hw: pointer to the HW structure

 *

 *  Sets the flow control high/low threshold (watermark) registers.  If

}

/**

 *  e1000_set_default_fc - Set flow control default values

 *  igb_set_default_fc - Set flow control default values

 *  @hw: pointer to the HW structure

 *

 *  Read the EEPROM for the default values for flow control and store the

}

/**

 *  e1000_force_mac_fc - Force the MAC's flow control settings

 *  igb_force_mac_fc - Force the MAC's flow control settings

 *  @hw: pointer to the HW structure

 *

 *  Force the MAC's flow control settings.  Sets the TFCE and RFCE bits in the

}

/**

 *  e1000_config_fc_after_link_up - Configures flow control after link

 *  igb_config_fc_after_link_up - Configures flow control after link

 *  @hw: pointer to the HW structure

 *

 *  Checks the status of auto-negotiation after link up to ensure that the

}

/**

 *  e1000_get_speed_and_duplex_copper - Retreive current speed/duplex

 *  igb_get_speed_and_duplex_copper - Retreive current speed/duplex

 *  @hw: pointer to the HW structure

 *  @speed: stores the current speed

 *  @duplex: stores the current duplex

}

/**

 *  e1000_get_hw_semaphore - Acquire hardware semaphore

 *  igb_get_hw_semaphore - Acquire hardware semaphore

 *  @hw: pointer to the HW structure

 *

 *  Acquire the HW semaphore to access the PHY or NVM

}

/**

 *  e1000_put_hw_semaphore - Release hardware semaphore

 *  igb_put_hw_semaphore - Release hardware semaphore

 *  @hw: pointer to the HW structure

 *

 *  Release hardware semaphore used to access the PHY or NVM

}

/**

 *  e1000_get_auto_rd_done - Check for auto read completion

 *  igb_get_auto_rd_done - Check for auto read completion

 *  @hw: pointer to the HW structure

 *

 *  Check EEPROM for Auto Read done bit.

}

/**

 *  e1000_valid_led_default - Verify a valid default LED config

 *  igb_valid_led_default - Verify a valid default LED config

 *  @hw: pointer to the HW structure

 *  @data: pointer to the NVM (EEPROM)

 *

}

/**

 *  e1000_id_led_init -

 *  igb_id_led_init -

 *  @hw: pointer to the HW structure

 *

 **/

}

/**

 *  e1000_cleanup_led - Set LED config to default operation

 *  igb_cleanup_led - Set LED config to default operation

 *  @hw: pointer to the HW structure

 *

 *  Remove the current LED configuration and set the LED configuration

}

/**

 *  e1000_blink_led - Blink LED

 *  igb_blink_led - Blink LED

 *  @hw: pointer to the HW structure

 *

 *  Blink the led's which are set to be on.

}

/**

 *  e1000_led_off - Turn LED off

 *  igb_led_off - Turn LED off

 *  @hw: pointer to the HW structure

 *

 *  Turn LED off.

}

/**

 *  e1000_disable_pcie_master - Disables PCI-express master access

 *  igb_disable_pcie_master - Disables PCI-express master access

 *  @hw: pointer to the HW structure

 *

 *  Returns 0 (0) if successful, else returns -10

}

/**

 *  e1000_reset_adaptive - Reset Adaptive Interframe Spacing

 *  igb_reset_adaptive - Reset Adaptive Interframe Spacing

 *  @hw: pointer to the HW structure

 *

 *  Reset the Adaptive Interframe Spacing throttle to default values.

}

/**

 *  e1000_update_adaptive - Update Adaptive Interframe Spacing

 *  igb_update_adaptive - Update Adaptive Interframe Spacing

 *  @hw: pointer to the HW structure

 *

 *  Update the Adaptive Interframe Spacing Throttle value based on the

}

/**

 *  e1000_validate_mdi_setting - Verify MDI/MDIx settings

 *  igb_validate_mdi_setting - Verify MDI/MDIx settings

 *  @hw: pointer to the HW structure

 *

 *  Verify that when not using auto-negotitation that MDI/MDIx is correctly

}

/**

 *  e1000_write_8bit_ctrl_reg - Write a 8bit CTRL register

 *  igb_write_8bit_ctrl_reg - Write a 8bit CTRL register

 *  @hw: pointer to the HW structure

 *  @reg: 32bit register offset such as E1000_SCTL

 *  @offset: register offset to write to

}

/**

 *  e1000_enable_mng_pass_thru - Enable processing of ARP's

 *  igb_enable_mng_pass_thru - Enable processing of ARP's

 *  @hw: pointer to the HW structure

 *

 *  Verifies the hardware needs to allow ARPs to be processed by the host.

#include "e1000_nvm.h"

/**

 *  e1000_raise_eec_clk - Raise EEPROM clock

 *  igb_raise_eec_clk - Raise EEPROM clock

 *  @hw: pointer to the HW structure

 *  @eecd: pointer to the EEPROM

 *

}

/**

 *  e1000_lower_eec_clk - Lower EEPROM clock

 *  igb_lower_eec_clk - Lower EEPROM clock

 *  @hw: pointer to the HW structure

 *  @eecd: pointer to the EEPROM

 *

}

/**

 *  e1000_shift_out_eec_bits - Shift data bits our to the EEPROM

 *  igb_shift_out_eec_bits - Shift data bits our to the EEPROM

 *  @hw: pointer to the HW structure

 *  @data: data to send to the EEPROM

 *  @count: number of bits to shift out

}

/**

 *  e1000_shift_in_eec_bits - Shift data bits in from the EEPROM

 *  igb_shift_in_eec_bits - Shift data bits in from the EEPROM

 *  @hw: pointer to the HW structure

 *  @count: number of bits to shift in

 *

}

/**

 *  e1000_poll_eerd_eewr_done - Poll for EEPROM read/write completion

 *  igb_poll_eerd_eewr_done - Poll for EEPROM read/write completion

 *  @hw: pointer to the HW structure

 *  @ee_reg: EEPROM flag for polling

 *

}

/**

 *  e1000_acquire_nvm - Generic request for access to EEPROM

 *  igb_acquire_nvm - Generic request for access to EEPROM

 *  @hw: pointer to the HW structure

 *

 *  Set the EEPROM access request bit and wait for EEPROM access grant bit.

}

/**

 *  e1000_standby_nvm - Return EEPROM to standby state

 *  igb_standby_nvm - Return EEPROM to standby state

 *  @hw: pointer to the HW structure

 *

 *  Return the EEPROM to a standby state.

}

/**

 *  e1000_release_nvm - Release exclusive access to EEPROM

 *  igb_release_nvm - Release exclusive access to EEPROM

 *  @hw: pointer to the HW structure

 *

 *  Stop any current commands to the EEPROM and clear the EEPROM request bit.

}

/**

 *  e1000_ready_nvm_eeprom - Prepares EEPROM for read/write

 *  igb_ready_nvm_eeprom - Prepares EEPROM for read/write

 *  @hw: pointer to the HW structure

 *

 *  Setups the EEPROM for reading and writing.

}

/**

 *  e1000_read_nvm_eerd - Reads EEPROM using EERD register

 *  igb_read_nvm_eerd - Reads EEPROM using EERD register

 *  @hw: pointer to the HW structure

 *  @offset: offset of word in the EEPROM to read

 *  @words: number of words to read

}

/**

 *  e1000_write_nvm_spi - Write to EEPROM using SPI

 *  igb_write_nvm_spi - Write to EEPROM using SPI

 *  @hw: pointer to the HW structure

 *  @offset: offset within the EEPROM to be written to

 *  @words: number of words to write

}

/**

 *  e1000_read_part_num - Read device part number

 *  igb_read_part_num - Read device part number

 *  @hw: pointer to the HW structure

 *  @part_num: pointer to device part number

 *

}

/**

 *  e1000_read_mac_addr - Read device MAC address

 *  igb_read_mac_addr - Read device MAC address

 *  @hw: pointer to the HW structure

 *

 *  Reads the device MAC address from the EEPROM and stores the value.

}

/**

 *  e1000_validate_nvm_checksum - Validate EEPROM checksum

 *  igb_validate_nvm_checksum - Validate EEPROM checksum

 *  @hw: pointer to the HW structure

 *

 *  Calculates the EEPROM checksum by reading/adding each word of the EEPROM

}

/**

 *  e1000_update_nvm_checksum - Update EEPROM checksum

 *  igb_update_nvm_checksum - Update EEPROM checksum

 *  @hw: pointer to the HW structure

 *

 *  Updates the EEPROM checksum by reading/adding each word of the EEPROM

		 sizeof(e1000_igp_2_cable_length_table[0]))

/**

 *  e1000_check_reset_block - Check if PHY reset is blocked

 *  igb_check_reset_block - Check if PHY reset is blocked

 *  @hw: pointer to the HW structure

 *

 *  Read the PHY management control register and check whether a PHY reset

}

/**

 *  e1000_get_phy_id - Retrieve the PHY ID and revision

 *  igb_get_phy_id - Retrieve the PHY ID and revision

 *  @hw: pointer to the HW structure

 *

 *  Reads the PHY registers and stores the PHY ID and possibly the PHY

}

/**

 *  e1000_phy_reset_dsp - Reset PHY DSP

 *  igb_phy_reset_dsp - Reset PHY DSP

 *  @hw: pointer to the HW structure

 *

 *  Reset the digital signal processor.

}

/**

 *  e1000_read_phy_reg_mdic - Read MDI control register

 *  igb_read_phy_reg_mdic - Read MDI control register

 *  @hw: pointer to the HW structure

 *  @offset: register offset to be read

 *  @data: pointer to the read data

}

/**

 *  e1000_write_phy_reg_mdic - Write MDI control register

 *  igb_write_phy_reg_mdic - Write MDI control register

 *  @hw: pointer to the HW structure

 *  @offset: register offset to write to

 *  @data: data to write to register at offset

}

/**

 *  e1000_read_phy_reg_igp - Read igp PHY register

 *  igb_read_phy_reg_igp - Read igp PHY register

 *  @hw: pointer to the HW structure

 *  @offset: register offset to be read

 *  @data: pointer to the read data

}

/**

 *  e1000_write_phy_reg_igp - Write igp PHY register

 *  igb_write_phy_reg_igp - Write igp PHY register

 *  @hw: pointer to the HW structure

 *  @offset: register offset to write to

 *  @data: data to write at register offset

}

/**

 *  e1000_copper_link_setup_m88 - Setup m88 PHY's for copper link

 *  igb_copper_link_setup_m88 - Setup m88 PHY's for copper link

 *  @hw: pointer to the HW structure

 *

 *  Sets up MDI/MDI-X and polarity for m88 PHY's.  If necessary, transmit clock

}

/**

 *  e1000_copper_link_setup_igp - Setup igp PHY's for copper link

 *  igb_copper_link_setup_igp - Setup igp PHY's for copper link

 *  @hw: pointer to the HW structure

 *

 *  Sets up LPLU, MDI/MDI-X, polarity, Smartspeed and Master/Slave config for

}

/**

 *  e1000_copper_link_autoneg - Setup/Enable autoneg for copper link

 *  igb_copper_link_autoneg - Setup/Enable autoneg for copper link

 *  @hw: pointer to the HW structure

 *

 *  Performs initial bounds checking on autoneg advertisement parameter, then

}

/**

 *  e1000_phy_setup_autoneg - Configure PHY for auto-negotiation

 *  igb_phy_setup_autoneg - Configure PHY for auto-negotiation

 *  @hw: pointer to the HW structure

 *

 *  Reads the MII auto-neg advertisement register and/or the 1000T control

}

/**

 *  e1000_phy_force_speed_duplex_igp - Force speed/duplex for igp PHY

 *  igb_phy_force_speed_duplex_igp - Force speed/duplex for igp PHY

 *  @hw: pointer to the HW structure

 *

 *  Calls the PHY setup function to force speed and duplex.  Clears the

}

/**

 *  e1000_phy_force_speed_duplex_m88 - Force speed/duplex for m88 PHY

 *  igb_phy_force_speed_duplex_m88 - Force speed/duplex for m88 PHY

 *  @hw: pointer to the HW structure

 *

 *  Calls the PHY setup function to force speed and duplex.  Clears the

}

/**

 *  e1000_phy_force_speed_duplex_setup - Configure forced PHY speed/duplex

 *  igb_phy_force_speed_duplex_setup - Configure forced PHY speed/duplex

 *  @hw: pointer to the HW structure

 *  @phy_ctrl: pointer to current value of PHY_CONTROL

 *

}

/**

 *  e1000_set_d3_lplu_state - Sets low power link up state for D3

 *  igb_set_d3_lplu_state - Sets low power link up state for D3

 *  @hw: pointer to the HW structure

 *  @active: boolean used to enable/disable lplu

 *

}

/**

 *  e1000_check_downshift - Checks whether a downshift in speed occured

 *  igb_check_downshift - Checks whether a downshift in speed occured