lib/librte_pmd_e1000/e1000/e1000_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
  34 #ifndef _E1000_API_H_
  35 #define _E1000_API_H_
  36
  37 #include "e1000_hw.h"
  38
  39 extern void e1000_init_function_pointers_82542(struct e1000_hw *hw);
  40 extern void e1000_init_function_pointers_82543(struct e1000_hw *hw);
  41 extern void e1000_init_function_pointers_82540(struct e1000_hw *hw);
  42 extern void e1000_init_function_pointers_82571(struct e1000_hw *hw);
  43 extern void e1000_init_function_pointers_82541(struct e1000_hw *hw);
  44 extern void e1000_init_function_pointers_80003es2lan(struct e1000_hw *hw);
  45 extern void e1000_init_function_pointers_ich8lan(struct e1000_hw *hw);
  46 extern void e1000_init_function_pointers_82575(struct e1000_hw *hw);
  47 extern void e1000_rx_fifo_flush_82575(struct e1000_hw *hw);
  48 extern void e1000_init_function_pointers_vf(struct e1000_hw *hw);
  49 extern void e1000_power_up_fiber_serdes_link(struct e1000_hw *hw);
  50 extern void e1000_shutdown_fiber_serdes_link(struct e1000_hw *hw);
  51 extern void e1000_init_function_pointers_i210(struct e1000_hw *hw);
  52
  53 s32 e1000_set_obff_timer(struct e1000_hw *hw, u32 itr);
  54 s32 e1000_set_mac_type(struct e1000_hw *hw);
  55 s32 e1000_setup_init_funcs(struct e1000_hw *hw, bool init_device);
  56 s32 e1000_init_mac_params(struct e1000_hw *hw);
  57 s32 e1000_init_nvm_params(struct e1000_hw *hw);
  58 s32 e1000_init_phy_params(struct e1000_hw *hw);
  59 s32 e1000_init_mbx_params(struct e1000_hw *hw);
  60 s32 e1000_get_bus_info(struct e1000_hw *hw);
  61 void e1000_clear_vfta(struct e1000_hw *hw);
  62 void e1000_write_vfta(struct e1000_hw *hw, u32 offset, u32 value);
  63 s32 e1000_force_mac_fc(struct e1000_hw *hw);
  64 s32 e1000_check_for_link(struct e1000_hw *hw);
  65 s32 e1000_reset_hw(struct e1000_hw *hw);
  66 s32 e1000_init_hw(struct e1000_hw *hw);
  67 s32 e1000_setup_link(struct e1000_hw *hw);
  68 s32 e1000_get_speed_and_duplex(struct e1000_hw *hw, u16 *speed, u16 *duplex);
  69 s32 e1000_disable_pcie_master(struct e1000_hw *hw);
  70 void e1000_config_collision_dist(struct e1000_hw *hw);
  71 void e1000_rar_set(struct e1000_hw *hw, u8 *addr, u32 index);
  72 u32 e1000_hash_mc_addr(struct e1000_hw *hw, u8 *mc_addr);
  73 void e1000_update_mc_addr_list(struct e1000_hw *hw, u8 *mc_addr_list,
  74                                u32 mc_addr_count);
  75 s32 e1000_setup_led(struct e1000_hw *hw);
  76 s32 e1000_cleanup_led(struct e1000_hw *hw);
  77 s32 e1000_check_reset_block(struct e1000_hw *hw);
  78 s32 e1000_blink_led(struct e1000_hw *hw);
  79 s32 e1000_led_on(struct e1000_hw *hw);
  80 s32 e1000_led_off(struct e1000_hw *hw);
  81 s32 e1000_id_led_init(struct e1000_hw *hw);
  82 void e1000_reset_adaptive(struct e1000_hw *hw);
  83 void e1000_update_adaptive(struct e1000_hw *hw);
  84 s32 e1000_get_cable_length(struct e1000_hw *hw);
  85 s32 e1000_validate_mdi_setting(struct e1000_hw *hw);
  86 s32 e1000_read_phy_reg(struct e1000_hw *hw, u32 offset, u16 *data);
  87 s32 e1000_write_phy_reg(struct e1000_hw *hw, u32 offset, u16 data);
  88 s32 e1000_write_8bit_ctrl_reg(struct e1000_hw *hw, u32 reg, u32 offset,
  89                               u8 data);
  90 s32 e1000_get_phy_info(struct e1000_hw *hw);
  91 void e1000_release_phy(struct e1000_hw *hw);
  92 s32 e1000_acquire_phy(struct e1000_hw *hw);
  93 s32 e1000_cfg_on_link_up(struct e1000_hw *hw);
  94 s32 e1000_phy_hw_reset(struct e1000_hw *hw);
  95 s32 e1000_phy_commit(struct e1000_hw *hw);
  96 void e1000_power_up_phy(struct e1000_hw *hw);
  97 void e1000_power_down_phy(struct e1000_hw *hw);
  98 s32 e1000_read_mac_addr(struct e1000_hw *hw);
  99 s32 e1000_read_pba_num(struct e1000_hw *hw, u32 *part_num);
 100 s32 e1000_read_pba_string(struct e1000_hw *hw, u8 *pba_num, u32 pba_num_size);
 101 s32 e1000_read_pba_length(struct e1000_hw *hw, u32 *pba_num_size);
 102 void e1000_reload_nvm(struct e1000_hw *hw);
 103 s32 e1000_update_nvm_checksum(struct e1000_hw *hw);
 104 s32 e1000_validate_nvm_checksum(struct e1000_hw *hw);
 105 s32 e1000_read_nvm(struct e1000_hw *hw, u16 offset, u16 words, u16 *data);
 106 s32 e1000_read_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 *data);
 107 s32 e1000_write_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 data);
 108 s32 e1000_write_nvm(struct e1000_hw *hw, u16 offset, u16 words, u16 *data);
 109 s32 e1000_set_d3_lplu_state(struct e1000_hw *hw, bool active);
 110 s32 e1000_set_d0_lplu_state(struct e1000_hw *hw, bool active);
 111 bool e1000_check_mng_mode(struct e1000_hw *hw);
 112 bool e1000_enable_tx_pkt_filtering(struct e1000_hw *hw);
 113 s32 e1000_mng_enable_host_if(struct e1000_hw *hw);
 114 s32 e1000_mng_host_if_write(struct e1000_hw *hw, u8 *buffer, u16 length,
 115                             u16 offset, u8 *sum);
 116 s32 e1000_mng_write_cmd_header(struct e1000_hw *hw,
 117                                struct e1000_host_mng_command_header *hdr);
 118 s32 e1000_mng_write_dhcp_info(struct e1000_hw *hw, u8 *buffer, u16 length);
 119 u32  e1000_translate_register_82542(u32 reg);
 120
 121
 122
 123 /*
 124  * TBI_ACCEPT macro definition:
 125  *
 126  * This macro requires:
 127  *      adapter = a pointer to struct e1000_hw
 128  *      status = the 8 bit status field of the Rx descriptor with EOP set
 129  *      error = the 8 bit error field of the Rx descriptor with EOP set
 130  *      length = the sum of all the length fields of the Rx descriptors that
 131  *               make up the current frame
 132  *      last_byte = the last byte of the frame DMAed by the hardware
 133  *      max_frame_length = the maximum frame length we want to accept.
 134  *      min_frame_length = the minimum frame length we want to accept.
 135  *
 136  * This macro is a conditional that should be used in the interrupt
 137  * handler's Rx processing routine when RxErrors have been detected.
 138  *
 139  * Typical use:
 140  *  ...
 141  *  if (TBI_ACCEPT) {
 142  *      accept_frame = true;
 143  *      e1000_tbi_adjust_stats(adapter, MacAddress);
 144  *      frame_length--;
 145  *  } else {
 146  *      accept_frame = false;
 147  *  }
 148  *  ...
 149  */
 150
 151 /* The carrier extension symbol, as received by the NIC. */
 152 #define CARRIER_EXTENSION   0x0F
 153
 154 #define TBI_ACCEPT(a, status, errors, length, last_byte, \
 155                    min_frame_size, max_frame_size) \
 156         (e1000_tbi_sbp_enabled_82543(a) && \
 157          (((errors) & E1000_RXD_ERR_FRAME_ERR_MASK) == E1000_RXD_ERR_CE) && \
 158          ((last_byte) == CARRIER_EXTENSION) && \
 159          (((status) & E1000_RXD_STAT_VP) ? \
 160           (((length) > (min_frame_size - VLAN_TAG_SIZE)) && \
 161           ((length) <= (max_frame_size + 1))) : \
 162           (((length) > min_frame_size) && \
 163           ((length) <= (max_frame_size + VLAN_TAG_SIZE + 1)))))
 164
 165 #define E1000_MAX(a, b) ((a) > (b) ? (a) : (b))
 166 #define E1000_DIVIDE_ROUND_UP(a, b)     (((a) + (b) - 1) / (b)) /* ceil(a/b) */
 167 #endif /* _E1000_API_H_ */