sys/dev/netif/ixgbe/ixgbe_api.h

   1 /******************************************************************************
   2
   3   Copyright (c) 2001-2012, Intel Corporation
   4   All rights reserved.
   5
   6   Redistribution and use in source and binary forms, with or without
   7   modification, are permitted provided that the following conditions are met:
   8
   9    1. Redistributions of source code must retain the above copyright notice,
  10       this list of conditions and the following disclaimer.
  11
  12    2. Redistributions in binary form must reproduce the above copyright
  13       notice, this list of conditions and the following disclaimer in the
  14       documentation and/or other materials provided with the distribution.
  15
  16    3. Neither the name of the Intel Corporation nor the names of its
  17       contributors may be used to endorse or promote products derived from
  18       this software without specific prior written permission.
  19
  20   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  21   AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23   ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  24   LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  25   CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  26   SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  27   INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  28   CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  29   ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  30   POSSIBILITY OF SUCH DAMAGE.
  31
  32 ******************************************************************************/
  33 /*$FreeBSD: src/sys/dev/ixgbe/ixgbe_api.h,v 1.13 2012/01/30 16:42:02 jfv Exp $*/
  34
  35 #ifndef _IXGBE_API_H_
  36 #define _IXGBE_API_H_
  37
  38 #include "ixgbe_type.h"
  39
  40 s32 ixgbe_init_shared_code(struct ixgbe_hw *hw);
  41
  42 extern s32 ixgbe_init_ops_82598(struct ixgbe_hw *hw);
  43 extern s32 ixgbe_init_ops_82599(struct ixgbe_hw *hw);
  44 extern s32 ixgbe_init_ops_X540(struct ixgbe_hw *hw);
  45 extern s32 ixgbe_init_ops_vf(struct ixgbe_hw *hw);
  46
  47 s32 ixgbe_set_mac_type(struct ixgbe_hw *hw);
  48 s32 ixgbe_init_hw(struct ixgbe_hw *hw);
  49 s32 ixgbe_reset_hw(struct ixgbe_hw *hw);
  50 s32 ixgbe_start_hw(struct ixgbe_hw *hw);
  51 void ixgbe_enable_relaxed_ordering(struct ixgbe_hw *hw);
  52 s32 ixgbe_clear_hw_cntrs(struct ixgbe_hw *hw);
  53 enum ixgbe_media_type ixgbe_get_media_type(struct ixgbe_hw *hw);
  54 s32 ixgbe_get_mac_addr(struct ixgbe_hw *hw, u8 *mac_addr);
  55 s32 ixgbe_get_bus_info(struct ixgbe_hw *hw);
  56 u32 ixgbe_get_num_of_tx_queues(struct ixgbe_hw *hw);
  57 u32 ixgbe_get_num_of_rx_queues(struct ixgbe_hw *hw);
  58 s32 ixgbe_stop_adapter(struct ixgbe_hw *hw);
  59 s32 ixgbe_read_pba_num(struct ixgbe_hw *hw, u32 *pba_num);
  60 s32 ixgbe_read_pba_string(struct ixgbe_hw *hw, u8 *pba_num, u32 pba_num_size);
  61
  62 s32 ixgbe_identify_phy(struct ixgbe_hw *hw);
  63 s32 ixgbe_reset_phy(struct ixgbe_hw *hw);
  64 s32 ixgbe_read_phy_reg(struct ixgbe_hw *hw, u32 reg_addr, u32 device_type,
  65                        u16 *phy_data);
  66 s32 ixgbe_write_phy_reg(struct ixgbe_hw *hw, u32 reg_addr, u32 device_type,
  67                         u16 phy_data);
  68
  69 s32 ixgbe_setup_phy_link(struct ixgbe_hw *hw);
  70 s32 ixgbe_check_phy_link(struct ixgbe_hw *hw,
  71                          ixgbe_link_speed *speed,
  72                          bool *link_up);
  73 s32 ixgbe_setup_phy_link_speed(struct ixgbe_hw *hw,
  74                                ixgbe_link_speed speed,
  75                                bool autoneg,
  76                                bool autoneg_wait_to_complete);
  77 void ixgbe_disable_tx_laser(struct ixgbe_hw *hw);
  78 void ixgbe_enable_tx_laser(struct ixgbe_hw *hw);
  79 void ixgbe_flap_tx_laser(struct ixgbe_hw *hw);
  80 s32 ixgbe_setup_link(struct ixgbe_hw *hw, ixgbe_link_speed speed,
  81                      bool autoneg, bool autoneg_wait_to_complete);
  82 s32 ixgbe_check_link(struct ixgbe_hw *hw, ixgbe_link_speed *speed,
  83                      bool *link_up, bool link_up_wait_to_complete);
  84 s32 ixgbe_get_link_capabilities(struct ixgbe_hw *hw, ixgbe_link_speed *speed,
  85                                 bool *autoneg);
  86 s32 ixgbe_led_on(struct ixgbe_hw *hw, u32 index);
  87 s32 ixgbe_led_off(struct ixgbe_hw *hw, u32 index);
  88 s32 ixgbe_blink_led_start(struct ixgbe_hw *hw, u32 index);
  89 s32 ixgbe_blink_led_stop(struct ixgbe_hw *hw, u32 index);
  90
  91 s32 ixgbe_init_eeprom_params(struct ixgbe_hw *hw);
  92 s32 ixgbe_write_eeprom(struct ixgbe_hw *hw, u16 offset, u16 data);
  93 s32 ixgbe_write_eeprom_buffer(struct ixgbe_hw *hw, u16 offset,
  94                               u16 words, u16 *data);
  95 s32 ixgbe_read_eeprom(struct ixgbe_hw *hw, u16 offset, u16 *data);
  96 s32 ixgbe_read_eeprom_buffer(struct ixgbe_hw *hw, u16 offset,
  97                              u16 words, u16 *data);
  98
  99 s32 ixgbe_validate_eeprom_checksum(struct ixgbe_hw *hw, u16 *checksum_val);
 100 s32 ixgbe_update_eeprom_checksum(struct ixgbe_hw *hw);
 101
 102 s32 ixgbe_insert_mac_addr(struct ixgbe_hw *hw, u8 *addr, u32 vmdq);
 103 s32 ixgbe_set_rar(struct ixgbe_hw *hw, u32 index, u8 *addr, u32 vmdq,
 104                   u32 enable_addr);
 105 s32 ixgbe_clear_rar(struct ixgbe_hw *hw, u32 index);
 106 s32 ixgbe_set_vmdq(struct ixgbe_hw *hw, u32 rar, u32 vmdq);
 107 s32 ixgbe_clear_vmdq(struct ixgbe_hw *hw, u32 rar, u32 vmdq);
 108 s32 ixgbe_init_rx_addrs(struct ixgbe_hw *hw);
 109 u32 ixgbe_get_num_rx_addrs(struct ixgbe_hw *hw);
 110 s32 ixgbe_update_uc_addr_list(struct ixgbe_hw *hw, u8 *addr_list,
 111                               u32 addr_count, ixgbe_mc_addr_itr func);
 112 s32 ixgbe_update_mc_addr_list(struct ixgbe_hw *hw, u8 *mc_addr_list,
 113                               u32 mc_addr_count, ixgbe_mc_addr_itr func,
 114                               bool clear);
 115 void ixgbe_add_uc_addr(struct ixgbe_hw *hw, u8 *addr_list, u32 vmdq);
 116 s32 ixgbe_enable_mc(struct ixgbe_hw *hw);
 117 s32 ixgbe_disable_mc(struct ixgbe_hw *hw);
 118 s32 ixgbe_clear_vfta(struct ixgbe_hw *hw);
 119 s32 ixgbe_set_vfta(struct ixgbe_hw *hw, u32 vlan,
 120                    u32 vind, bool vlan_on);
 121 s32 ixgbe_set_vlvf(struct ixgbe_hw *hw, u32 vlan, u32 vind,
 122                    bool vlan_on, bool *vfta_changed);
 123 s32 ixgbe_fc_enable(struct ixgbe_hw *hw, s32 packetbuf_num);
 124 s32 ixgbe_set_fw_drv_ver(struct ixgbe_hw *hw, u8 maj, u8 min, u8 build,
 125                          u8 ver);
 126 void ixgbe_set_mta(struct ixgbe_hw *hw, u8 *mc_addr);
 127 s32 ixgbe_get_phy_firmware_version(struct ixgbe_hw *hw,
 128                                    u16 *firmware_version);
 129 s32 ixgbe_read_analog_reg8(struct ixgbe_hw *hw, u32 reg, u8 *val);
 130 s32 ixgbe_write_analog_reg8(struct ixgbe_hw *hw, u32 reg, u8 val);
 131 s32 ixgbe_init_uta_tables(struct ixgbe_hw *hw);
 132 s32 ixgbe_read_i2c_eeprom(struct ixgbe_hw *hw, u8 byte_offset, u8 *eeprom_data);
 133 u32 ixgbe_get_supported_physical_layer(struct ixgbe_hw *hw);
 134 s32 ixgbe_enable_rx_dma(struct ixgbe_hw *hw, u32 regval);
 135 s32 ixgbe_disable_sec_rx_path(struct ixgbe_hw *hw);
 136 s32 ixgbe_enable_sec_rx_path(struct ixgbe_hw *hw);
 137 s32 ixgbe_reinit_fdir_tables_82599(struct ixgbe_hw *hw);
 138 s32 ixgbe_init_fdir_signature_82599(struct ixgbe_hw *hw, u32 fdirctrl);
 139 s32 ixgbe_init_fdir_perfect_82599(struct ixgbe_hw *hw, u32 fdirctrl);
 140 s32 ixgbe_fdir_add_signature_filter_82599(struct ixgbe_hw *hw,
 141                                           union ixgbe_atr_hash_dword input,
 142                                           union ixgbe_atr_hash_dword common,
 143                                           u8 queue);
 144 s32 ixgbe_fdir_set_input_mask_82599(struct ixgbe_hw *hw,
 145                                     union ixgbe_atr_input *input_mask);
 146 s32 ixgbe_fdir_write_perfect_filter_82599(struct ixgbe_hw *hw,
 147                                           union ixgbe_atr_input *input,
 148                                           u16 soft_id, u8 queue);
 149 s32 ixgbe_fdir_erase_perfect_filter_82599(struct ixgbe_hw *hw,
 150                                           union ixgbe_atr_input *input,
 151                                           u16 soft_id);
 152 s32 ixgbe_fdir_add_perfect_filter_82599(struct ixgbe_hw *hw,
 153                                         union ixgbe_atr_input *input,
 154                                         union ixgbe_atr_input *mask,
 155                                         u16 soft_id,
 156                                         u8 queue);
 157 void ixgbe_atr_compute_perfect_hash_82599(union ixgbe_atr_input *input,
 158                                           union ixgbe_atr_input *mask);
 159 u32 ixgbe_atr_compute_sig_hash_82599(union ixgbe_atr_hash_dword input,
 160                                      union ixgbe_atr_hash_dword common);
 161 s32 ixgbe_read_i2c_byte(struct ixgbe_hw *hw, u8 byte_offset, u8 dev_addr,
 162                         u8 *data);
 163 s32 ixgbe_write_i2c_byte(struct ixgbe_hw *hw, u8 byte_offset, u8 dev_addr,
 164                          u8 data);
 165 s32 ixgbe_write_i2c_eeprom(struct ixgbe_hw *hw, u8 byte_offset, u8 eeprom_data);
 166 s32 ixgbe_get_san_mac_addr(struct ixgbe_hw *hw, u8 *san_mac_addr);
 167 s32 ixgbe_set_san_mac_addr(struct ixgbe_hw *hw, u8 *san_mac_addr);
 168 s32 ixgbe_get_device_caps(struct ixgbe_hw *hw, u16 *device_caps);
 169 s32 ixgbe_acquire_swfw_semaphore(struct ixgbe_hw *hw, u16 mask);
 170 void ixgbe_release_swfw_semaphore(struct ixgbe_hw *hw, u16 mask);
 171 s32 ixgbe_get_wwn_prefix(struct ixgbe_hw *hw, u16 *wwnn_prefix,
 172                          u16 *wwpn_prefix);
 173 s32 ixgbe_get_fcoe_boot_status(struct ixgbe_hw *hw, u16 *bs);
 174
 175 #endif /* _IXGBE_API_H_ */