sys/dev/ixgbe/ixgbe_common.h

   1 /******************************************************************************
   2
   3   Copyright (c) 2001-2010, 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$*/
  34
  35 #ifndef _IXGBE_COMMON_H_
  36 #define _IXGBE_COMMON_H_
  37
  38 #include "ixgbe_type.h"
  39 #define IXGBE_WRITE_REG64(hw, reg, value) \
  40         do { \
  41                 IXGBE_WRITE_REG(hw, reg, (u32) value); \
  42                 IXGBE_WRITE_REG(hw, reg + 4, (u32) (value >> 32)); \
  43         } while (0)
  44
  45 u32 ixgbe_get_pcie_msix_count_generic(struct ixgbe_hw *hw);
  46
  47 s32 ixgbe_init_ops_generic(struct ixgbe_hw *hw);
  48 s32 ixgbe_init_hw_generic(struct ixgbe_hw *hw);
  49 s32 ixgbe_start_hw_generic(struct ixgbe_hw *hw);
  50 s32 ixgbe_start_hw_gen2(struct ixgbe_hw *hw);
  51 s32 ixgbe_clear_hw_cntrs_generic(struct ixgbe_hw *hw);
  52 s32 ixgbe_read_pba_num_generic(struct ixgbe_hw *hw, u32 *pba_num);
  53 s32 ixgbe_read_pba_string_generic(struct ixgbe_hw *hw, u8 *pba_num,
  54                                   u32 pba_num_size);
  55 s32 ixgbe_read_pba_length_generic(struct ixgbe_hw *hw, u32 *pba_num_size);
  56 s32 ixgbe_get_mac_addr_generic(struct ixgbe_hw *hw, u8 *mac_addr);
  57 s32 ixgbe_get_bus_info_generic(struct ixgbe_hw *hw);
  58 void ixgbe_set_lan_id_multi_port_pcie(struct ixgbe_hw *hw);
  59 s32 ixgbe_stop_adapter_generic(struct ixgbe_hw *hw);
  60
  61 s32 ixgbe_led_on_generic(struct ixgbe_hw *hw, u32 index);
  62 s32 ixgbe_led_off_generic(struct ixgbe_hw *hw, u32 index);
  63
  64 s32 ixgbe_init_eeprom_params_generic(struct ixgbe_hw *hw);
  65 s32 ixgbe_write_eeprom_generic(struct ixgbe_hw *hw, u16 offset, u16 data);
  66 s32 ixgbe_read_eerd_generic(struct ixgbe_hw *hw, u16 offset, u16 *data);
  67 s32 ixgbe_write_eewr_generic(struct ixgbe_hw *hw, u16 offset, u16 data);
  68 s32 ixgbe_read_eeprom_bit_bang_generic(struct ixgbe_hw *hw, u16 offset,
  69                                        u16 *data);
  70 u16 ixgbe_calc_eeprom_checksum_generic(struct ixgbe_hw *hw);
  71 s32 ixgbe_validate_eeprom_checksum_generic(struct ixgbe_hw *hw,
  72                                            u16 *checksum_val);
  73 s32 ixgbe_update_eeprom_checksum_generic(struct ixgbe_hw *hw);
  74 s32 ixgbe_poll_eerd_eewr_done(struct ixgbe_hw *hw, u32 ee_reg);
  75
  76 s32 ixgbe_set_rar_generic(struct ixgbe_hw *hw, u32 index, u8 *addr, u32 vmdq,
  77                           u32 enable_addr);
  78 s32 ixgbe_clear_rar_generic(struct ixgbe_hw *hw, u32 index);
  79 s32 ixgbe_init_rx_addrs_generic(struct ixgbe_hw *hw);
  80 s32 ixgbe_update_mc_addr_list_generic(struct ixgbe_hw *hw, u8 *mc_addr_list,
  81                                       u32 mc_addr_count,
  82                                       ixgbe_mc_addr_itr func);
  83 s32 ixgbe_update_uc_addr_list_generic(struct ixgbe_hw *hw, u8 *addr_list,
  84                                       u32 addr_count, ixgbe_mc_addr_itr func);
  85 s32 ixgbe_enable_mc_generic(struct ixgbe_hw *hw);
  86 s32 ixgbe_disable_mc_generic(struct ixgbe_hw *hw);
  87 s32 ixgbe_enable_rx_dma_generic(struct ixgbe_hw *hw, u32 regval);
  88
  89 s32 ixgbe_setup_fc(struct ixgbe_hw *hw, s32 packetbuf_num);
  90 s32 ixgbe_fc_enable_generic(struct ixgbe_hw *hw, s32 packtetbuf_num);
  91 s32 ixgbe_fc_autoneg(struct ixgbe_hw *hw);
  92
  93 s32 ixgbe_validate_mac_addr(u8 *mac_addr);
  94 s32 ixgbe_acquire_swfw_sync(struct ixgbe_hw *hw, u16 mask);
  95 void ixgbe_release_swfw_sync(struct ixgbe_hw *hw, u16 mask);
  96 s32 ixgbe_disable_pcie_master(struct ixgbe_hw *hw);
  97
  98 s32 ixgbe_blink_led_start_generic(struct ixgbe_hw *hw, u32 index);
  99 s32 ixgbe_blink_led_stop_generic(struct ixgbe_hw *hw, u32 index);
 100
 101 s32 ixgbe_get_san_mac_addr_generic(struct ixgbe_hw *hw, u8 *san_mac_addr);
 102 s32 ixgbe_set_san_mac_addr_generic(struct ixgbe_hw *hw, u8 *san_mac_addr);
 103
 104 s32 ixgbe_set_vmdq_generic(struct ixgbe_hw *hw, u32 rar, u32 vmdq);
 105 s32 ixgbe_clear_vmdq_generic(struct ixgbe_hw *hw, u32 rar, u32 vmdq);
 106 s32 ixgbe_insert_mac_addr_generic(struct ixgbe_hw *hw, u8 *addr, u32 vmdq);
 107 s32 ixgbe_init_uta_tables_generic(struct ixgbe_hw *hw);
 108 s32 ixgbe_set_vfta_generic(struct ixgbe_hw *hw, u32 vlan,
 109                          u32 vind, bool vlan_on);
 110 s32 ixgbe_clear_vfta_generic(struct ixgbe_hw *hw);
 111
 112 s32 ixgbe_check_mac_link_generic(struct ixgbe_hw *hw,
 113                                ixgbe_link_speed *speed,
 114                                bool *link_up, bool link_up_wait_to_complete);
 115
 116 s32 ixgbe_get_wwn_prefix_generic(struct ixgbe_hw *hw, u16 *wwnn_prefix,
 117                                  u16 *wwpn_prefix);
 118
 119 s32 ixgbe_get_fcoe_boot_status_generic(struct ixgbe_hw *hw, u16 *bs);
 120 void ixgbe_set_mac_anti_spoofing(struct ixgbe_hw *hw, bool enable, int pf);
 121 void ixgbe_set_vlan_anti_spoofing(struct ixgbe_hw *hw, bool enable, int vf);
 122 s32 ixgbe_get_device_caps_generic(struct ixgbe_hw *hw, u16 *device_caps);
 123 void ixgbe_enable_relaxed_ordering_gen2(struct ixgbe_hw *hw);
 124 #endif /* IXGBE_COMMON */