workbench/devs/networks/e1000/e1000_api.h

   1 /*******************************************************************************
   2
   3   Intel PRO/1000 Linux driver
   4   Copyright(c) 1999 - 2010 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   Linux NICS <linux.nics@intel.com>
  24   e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
  25   Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  26
  27 *******************************************************************************/
  28
  29 #ifndef _E1000_API_H_
  30 #define _E1000_API_H_
  31
  32 #include "e1000_hw.h"
  33
  34 extern void    e1000_init_function_pointers_82542(struct e1000_hw *hw);
  35 extern void    e1000_init_function_pointers_82543(struct e1000_hw *hw);
  36 extern void    e1000_init_function_pointers_82540(struct e1000_hw *hw);
  37 extern void    e1000_init_function_pointers_82541(struct e1000_hw *hw);
  38
  39 s32  e1000_set_mac_type(struct e1000_hw *hw);
  40 s32  e1000_setup_init_funcs(struct e1000_hw *hw, bool init_device);
  41 s32  e1000_init_mac_params(struct e1000_hw *hw);
  42 s32  e1000_init_nvm_params(struct e1000_hw *hw);
  43 s32  e1000_init_phy_params(struct e1000_hw *hw);
  44 s32  e1000_get_bus_info(struct e1000_hw *hw);
  45 void e1000_clear_vfta(struct e1000_hw *hw);
  46 void e1000_write_vfta(struct e1000_hw *hw, u32 offset, u32 value);
  47 s32  e1000_force_mac_fc(struct e1000_hw *hw);
  48 s32  e1000_check_for_link(struct e1000_hw *hw);
  49 s32  e1000_reset_hw(struct e1000_hw *hw);
  50 s32  e1000_init_hw(struct e1000_hw *hw);
  51 s32  e1000_setup_link(struct e1000_hw *hw);
  52 s32  e1000_get_speed_and_duplex(struct e1000_hw *hw, u16 *speed,
  53                                 u16 *duplex);
  54 s32  e1000_disable_pcie_master(struct e1000_hw *hw);
  55 void e1000_config_collision_dist(struct e1000_hw *hw);
  56 void e1000_rar_set(struct e1000_hw *hw, u8 *addr, u32 index);
  57 u32  e1000_hash_mc_addr(struct e1000_hw *hw, u8 *mc_addr);
  58 void e1000_update_mc_addr_list(struct e1000_hw *hw,
  59                                u8 *mc_addr_list, u32 mc_addr_count);
  60 s32  e1000_setup_led(struct e1000_hw *hw);
  61 s32  e1000_cleanup_led(struct e1000_hw *hw);
  62 s32  e1000_check_reset_block(struct e1000_hw *hw);
  63 s32  e1000_blink_led(struct e1000_hw *hw);
  64 s32  e1000_led_on(struct e1000_hw *hw);
  65 s32  e1000_led_off(struct e1000_hw *hw);
  66 s32 e1000_id_led_init(struct e1000_hw *hw);
  67 void e1000_reset_adaptive(struct e1000_hw *hw);
  68 void e1000_update_adaptive(struct e1000_hw *hw);
  69 s32  e1000_get_cable_length(struct e1000_hw *hw);
  70 s32  e1000_validate_mdi_setting(struct e1000_hw *hw);
  71 s32  e1000_read_phy_reg(struct e1000_hw *hw, u32 offset, u16 *data);
  72 s32  e1000_write_phy_reg(struct e1000_hw *hw, u32 offset, u16 data);
  73 s32  e1000_get_phy_info(struct e1000_hw *hw);
  74 void e1000_release_phy(struct e1000_hw *hw);
  75 s32  e1000_acquire_phy(struct e1000_hw *hw);
  76 s32  e1000_phy_hw_reset(struct e1000_hw *hw);
  77 s32  e1000_phy_commit(struct e1000_hw *hw);
  78 void e1000_power_up_phy(struct e1000_hw *hw);
  79 void e1000_power_down_phy(struct e1000_hw *hw);
  80 s32  e1000_read_mac_addr(struct e1000_hw *hw);
  81 s32  e1000_read_pba_string(struct e1000_hw *hw, u8 *pba_num,
  82                            u32 pba_num_size);
  83 void e1000_reload_nvm(struct e1000_hw *hw);
  84 s32  e1000_update_nvm_checksum(struct e1000_hw *hw);
  85 s32  e1000_validate_nvm_checksum(struct e1000_hw *hw);
  86 s32  e1000_read_nvm(struct e1000_hw *hw, u16 offset, u16 words, u16 *data);
  87 s32  e1000_read_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 *data);
  88 s32  e1000_write_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 data);
  89 s32  e1000_write_nvm(struct e1000_hw *hw, u16 offset, u16 words,
  90                      u16 *data);
  91 s32  e1000_wait_autoneg(struct e1000_hw *hw);
  92 s32  e1000_set_d3_lplu_state(struct e1000_hw *hw, bool active);
  93 s32  e1000_set_d0_lplu_state(struct e1000_hw *hw, bool active);
  94 bool e1000_check_mng_mode(struct e1000_hw *hw);
  95 bool e1000_enable_tx_pkt_filtering(struct e1000_hw *hw);
  96 s32  e1000_mng_enable_host_if(struct e1000_hw *hw);
  97 s32  e1000_mng_host_if_write(struct e1000_hw *hw,
  98                              u8 *buffer, u16 length, u16 offset, u8 *sum);
  99 s32  e1000_mng_write_cmd_header(struct e1000_hw *hw,
 100                                 struct e1000_host_mng_command_header *hdr);
 101 s32  e1000_mng_write_dhcp_info(struct e1000_hw * hw,
 102                                     u8 *buffer, u16 length);
 103 u32  e1000_translate_register_82542(u32 reg);
 104
 105
 106 /*
 107  * TBI_ACCEPT macro definition:
 108  *
 109  * This macro requires:
 110  *      adapter = a pointer to struct e1000_hw
 111  *      status = the 8 bit status field of the Rx descriptor with EOP set
 112  *      error = the 8 bit error field of the Rx descriptor with EOP set
 113  *      length = the sum of all the length fields of the Rx descriptors that
 114  *               make up the current frame
 115  *      last_byte = the last byte of the frame DMAed by the hardware
 116  *      max_frame_length = the maximum frame length we want to accept.
 117  *      min_frame_length = the minimum frame length we want to accept.
 118  *
 119  * This macro is a conditional that should be used in the interrupt
 120  * handler's Rx processing routine when RxErrors have been detected.
 121  *
 122  * Typical use:
 123  *  ...
 124  *  if (TBI_ACCEPT) {
 125  *      accept_frame = true;
 126  *      e1000_tbi_adjust_stats(adapter, MacAddress);
 127  *      frame_length--;
 128  *  } else {
 129  *      accept_frame = false;
 130  *  }
 131  *  ...
 132  */
 133
 134 /* The carrier extension symbol, as received by the NIC. */
 135 #define CARRIER_EXTENSION   0x0F
 136
 137 #define TBI_ACCEPT(a, status, errors, length, last_byte, min_frame_size, max_frame_size) \
 138     (e1000_tbi_sbp_enabled_82543(a) && \
 139      (((errors) & E1000_RXD_ERR_FRAME_ERR_MASK) == E1000_RXD_ERR_CE) && \
 140      ((last_byte) == CARRIER_EXTENSION) && \
 141      (((status) & E1000_RXD_STAT_VP) ? \
 142           (((length) > (min_frame_size - VLAN_TAG_SIZE)) && \
 143            ((length) <= (max_frame_size + 1))) : \
 144           (((length) > min_frame_size) && \
 145            ((length) <= (max_frame_size + VLAN_TAG_SIZE + 1)))))
 146
 147 #endif