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

   1 /*******************************************************************************
   2
   3   Intel 10 Gigabit PCI Express Linux driver
   4   Copyright(c) 1999 - 2013 Intel Corporation.
   5
   6   This program is free software; you can redistribute it and/or modify it
   7   under the terms and conditions of the GNU General Public License,
   8   version 2, as published by the Free Software Foundation.
   9
  10   This program is distributed in the hope it will be useful, but WITHOUT
  11   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  13   more details.
  14
  15   You should have received a copy of the GNU General Public License along with
  16   this program; if not, write to the Free Software Foundation, Inc.,
  17   51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
  18
  19   The full GNU General Public License is included in this distribution in
  20   the file called "COPYING".
  21
  22   Contact Information:
  23   e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
  24   Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  25
  26 *******************************************************************************/
  27
  28 #ifndef _IXGBE_COMMON_H_
  29 #define _IXGBE_COMMON_H_
  30
  31 #include "ixgbe_type.h"
  32 #include "ixgbe.h"
  33
  34 u16 ixgbe_get_pcie_msix_count_generic(struct ixgbe_hw *hw);
  35 s32 ixgbe_init_ops_generic(struct ixgbe_hw *hw);
  36 s32 ixgbe_init_hw_generic(struct ixgbe_hw *hw);
  37 s32 ixgbe_start_hw_generic(struct ixgbe_hw *hw);
  38 s32 ixgbe_start_hw_gen2(struct ixgbe_hw *hw);
  39 s32 ixgbe_clear_hw_cntrs_generic(struct ixgbe_hw *hw);
  40 s32 ixgbe_read_pba_string_generic(struct ixgbe_hw *hw, u8 *pba_num,
  41                                   u32 pba_num_size);
  42 s32 ixgbe_get_mac_addr_generic(struct ixgbe_hw *hw, u8 *mac_addr);
  43 enum ixgbe_bus_width ixgbe_convert_bus_width(u16 link_status);
  44 enum ixgbe_bus_speed ixgbe_convert_bus_speed(u16 link_status);
  45 s32 ixgbe_get_bus_info_generic(struct ixgbe_hw *hw);
  46 void ixgbe_set_lan_id_multi_port_pcie(struct ixgbe_hw *hw);
  47 s32 ixgbe_stop_adapter_generic(struct ixgbe_hw *hw);
  48
  49 s32 ixgbe_led_on_generic(struct ixgbe_hw *hw, u32 index);
  50 s32 ixgbe_led_off_generic(struct ixgbe_hw *hw, u32 index);
  51
  52 s32 ixgbe_init_eeprom_params_generic(struct ixgbe_hw *hw);
  53 s32 ixgbe_write_eeprom_generic(struct ixgbe_hw *hw, u16 offset, u16 data);
  54 s32 ixgbe_write_eeprom_buffer_bit_bang_generic(struct ixgbe_hw *hw, u16 offset,
  55                                                u16 words, u16 *data);
  56 s32 ixgbe_read_eerd_generic(struct ixgbe_hw *hw, u16 offset, u16 *data);
  57 s32 ixgbe_read_eerd_buffer_generic(struct ixgbe_hw *hw, u16 offset,
  58                                    u16 words, u16 *data);
  59 s32 ixgbe_write_eewr_generic(struct ixgbe_hw *hw, u16 offset, u16 data);
  60 s32 ixgbe_write_eewr_buffer_generic(struct ixgbe_hw *hw, u16 offset,
  61                                     u16 words, u16 *data);
  62 s32 ixgbe_read_eeprom_bit_bang_generic(struct ixgbe_hw *hw, u16 offset,
  63                                        u16 *data);
  64 s32 ixgbe_read_eeprom_buffer_bit_bang_generic(struct ixgbe_hw *hw, u16 offset,
  65                                               u16 words, u16 *data);
  66 u16 ixgbe_calc_eeprom_checksum_generic(struct ixgbe_hw *hw);
  67 s32 ixgbe_validate_eeprom_checksum_generic(struct ixgbe_hw *hw,
  68                                            u16 *checksum_val);
  69 s32 ixgbe_update_eeprom_checksum_generic(struct ixgbe_hw *hw);
  70
  71 s32 ixgbe_set_rar_generic(struct ixgbe_hw *hw, u32 index, u8 *addr, u32 vmdq,
  72                           u32 enable_addr);
  73 s32 ixgbe_clear_rar_generic(struct ixgbe_hw *hw, u32 index);
  74 s32 ixgbe_init_rx_addrs_generic(struct ixgbe_hw *hw);
  75 s32 ixgbe_update_mc_addr_list_generic(struct ixgbe_hw *hw,
  76                                       struct net_device *netdev);
  77 s32 ixgbe_enable_mc_generic(struct ixgbe_hw *hw);
  78 s32 ixgbe_disable_mc_generic(struct ixgbe_hw *hw);
  79 s32 ixgbe_disable_rx_buff_generic(struct ixgbe_hw *hw);
  80 s32 ixgbe_enable_rx_buff_generic(struct ixgbe_hw *hw);
  81 s32 ixgbe_enable_rx_dma_generic(struct ixgbe_hw *hw, u32 regval);
  82 s32 ixgbe_fc_enable_generic(struct ixgbe_hw *hw);
  83 bool ixgbe_device_supports_autoneg_fc(struct ixgbe_hw *hw);
  84 void ixgbe_fc_autoneg(struct ixgbe_hw *hw);
  85
  86 s32 ixgbe_acquire_swfw_sync(struct ixgbe_hw *hw, u16 mask);
  87 void ixgbe_release_swfw_sync(struct ixgbe_hw *hw, u16 mask);
  88 s32 ixgbe_get_san_mac_addr_generic(struct ixgbe_hw *hw, u8 *san_mac_addr);
  89 s32 ixgbe_set_vmdq_generic(struct ixgbe_hw *hw, u32 rar, u32 vmdq);
  90 s32 ixgbe_set_vmdq_san_mac_generic(struct ixgbe_hw *hw, u32 vmdq);
  91 s32 ixgbe_clear_vmdq_generic(struct ixgbe_hw *hw, u32 rar, u32 vmdq);
  92 s32 ixgbe_init_uta_tables_generic(struct ixgbe_hw *hw);
  93 s32 ixgbe_set_vfta_generic(struct ixgbe_hw *hw, u32 vlan,
  94                            u32 vind, bool vlan_on);
  95 s32 ixgbe_clear_vfta_generic(struct ixgbe_hw *hw);
  96 s32 ixgbe_check_mac_link_generic(struct ixgbe_hw *hw,
  97                                  ixgbe_link_speed *speed,
  98                                  bool *link_up, bool link_up_wait_to_complete);
  99 s32 ixgbe_get_wwn_prefix_generic(struct ixgbe_hw *hw, u16 *wwnn_prefix,
 100                                  u16 *wwpn_prefix);
 101 s32 ixgbe_blink_led_start_generic(struct ixgbe_hw *hw, u32 index);
 102 s32 ixgbe_blink_led_stop_generic(struct ixgbe_hw *hw, u32 index);
 103 void ixgbe_set_mac_anti_spoofing(struct ixgbe_hw *hw, bool enable, int pf);
 104 void ixgbe_set_vlan_anti_spoofing(struct ixgbe_hw *hw, bool enable, int vf);
 105 s32 ixgbe_get_device_caps_generic(struct ixgbe_hw *hw, u16 *device_caps);
 106 s32 ixgbe_set_fw_drv_ver_generic(struct ixgbe_hw *hw, u8 maj, u8 min,
 107                                  u8 build, u8 ver);
 108 void ixgbe_clear_tx_pending(struct ixgbe_hw *hw);
 109
 110 void ixgbe_set_rxpba_generic(struct ixgbe_hw *hw, int num_pb,
 111                              u32 headroom, int strategy);
 112 s32 ixgbe_reset_pipeline_82599(struct ixgbe_hw *hw);
 113
 114 #define IXGBE_I2C_THERMAL_SENSOR_ADDR   0xF8
 115 #define IXGBE_EMC_INTERNAL_DATA         0x00
 116 #define IXGBE_EMC_INTERNAL_THERM_LIMIT  0x20
 117 #define IXGBE_EMC_DIODE1_DATA           0x01
 118 #define IXGBE_EMC_DIODE1_THERM_LIMIT    0x19
 119 #define IXGBE_EMC_DIODE2_DATA           0x23
 120 #define IXGBE_EMC_DIODE2_THERM_LIMIT    0x1A
 121 #define IXGBE_EMC_DIODE3_DATA           0x2A
 122 #define IXGBE_EMC_DIODE3_THERM_LIMIT    0x30
 123
 124 s32 ixgbe_get_thermal_sensor_data_generic(struct ixgbe_hw *hw);
 125 s32 ixgbe_init_thermal_sensor_thresh_generic(struct ixgbe_hw *hw);
 126
 127 #define IXGBE_FAILED_READ_REG 0xffffffffU
 128
 129 static inline bool ixgbe_removed(void __iomem *addr)
 130 {
 131         return unlikely(!addr);
 132 }
 133
 134 void ixgbe_check_remove(struct ixgbe_hw *hw, u32 reg);
 135
 136 static inline void ixgbe_write_reg(struct ixgbe_hw *hw, u32 reg, u32 value)
 137 {
 138         u8 __iomem *reg_addr = ACCESS_ONCE(hw->hw_addr);
 139
 140         if (ixgbe_removed(reg_addr))
 141                 return;
 142         writel(value, reg_addr + reg);
 143 }
 144 #define IXGBE_WRITE_REG(a, reg, value) ixgbe_write_reg((a), (reg), (value))
 145
 146 #ifndef writeq
 147 #define writeq writeq
 148 static inline void writeq(u64 val, void __iomem *addr)
 149 {
 150         writel((u32)val, addr);
 151         writel((u32)(val >> 32), addr + 4);
 152 }
 153 #endif
 154
 155 static inline void ixgbe_write_reg64(struct ixgbe_hw *hw, u32 reg, u64 value)
 156 {
 157         u8 __iomem *reg_addr = ACCESS_ONCE(hw->hw_addr);
 158
 159         if (ixgbe_removed(reg_addr))
 160                 return;
 161         writeq(value, reg_addr + reg);
 162 }
 163 #define IXGBE_WRITE_REG64(a, reg, value) ixgbe_write_reg64((a), (reg), (value))
 164
 165 static inline u32 ixgbe_read_reg(struct ixgbe_hw *hw, u32 reg)
 166 {
 167         u8 __iomem *reg_addr = ACCESS_ONCE(hw->hw_addr);
 168         u32 value;
 169
 170         if (ixgbe_removed(reg_addr))
 171                 return IXGBE_FAILED_READ_REG;
 172         value = readl(reg_addr + reg);
 173         if (unlikely(value == IXGBE_FAILED_READ_REG))
 174                 ixgbe_check_remove(hw, reg);
 175         return value;
 176 }
 177 #define IXGBE_READ_REG(a, reg) ixgbe_read_reg((a), (reg))
 178
 179 #define IXGBE_WRITE_REG_ARRAY(a, reg, offset, value) \
 180                 ixgbe_write_reg((a), (reg) + ((offset) << 2), (value))
 181
 182 #define IXGBE_READ_REG_ARRAY(a, reg, offset) \
 183                 ixgbe_read_reg((a), (reg) + ((offset) << 2))
 184
 185 #define IXGBE_WRITE_FLUSH(a) ixgbe_read_reg((a), IXGBE_STATUS)
 186
 187 #define ixgbe_hw_to_netdev(hw) (((struct ixgbe_adapter *)(hw)->back)->netdev)
 188
 189 #define hw_dbg(hw, format, arg...) \
 190         netdev_dbg(ixgbe_hw_to_netdev(hw), format, ## arg)
 191 #define hw_err(hw, format, arg...) \
 192         netdev_err(ixgbe_hw_to_netdev(hw), format, ## arg)
 193 #define e_dev_info(format, arg...) \
 194         dev_info(&adapter->pdev->dev, format, ## arg)
 195 #define e_dev_warn(format, arg...) \
 196         dev_warn(&adapter->pdev->dev, format, ## arg)
 197 #define e_dev_err(format, arg...) \
 198         dev_err(&adapter->pdev->dev, format, ## arg)
 199 #define e_dev_notice(format, arg...) \
 200         dev_notice(&adapter->pdev->dev, format, ## arg)
 201 #define e_info(msglvl, format, arg...) \
 202         netif_info(adapter, msglvl, adapter->netdev, format, ## arg)
 203 #define e_err(msglvl, format, arg...) \
 204         netif_err(adapter, msglvl, adapter->netdev, format, ## arg)
 205 #define e_warn(msglvl, format, arg...) \
 206         netif_warn(adapter, msglvl, adapter->netdev, format, ## arg)
 207 #define e_crit(msglvl, format, arg...) \
 208         netif_crit(adapter, msglvl, adapter->netdev, format, ## arg)
 209 #endif /* IXGBE_COMMON */