e1000_api.h revision 203049
191586Smarkm/****************************************************************************** 212099Sjoerg 312099Sjoerg Copyright (c) 2001-2010, Intel Corporation 412099Sjoerg All rights reserved. 512099Sjoerg 612099Sjoerg Redistribution and use in source and binary forms, with or without 712099Sjoerg modification, are permitted provided that the following conditions are met: 812099Sjoerg 912099Sjoerg 1. Redistributions of source code must retain the above copyright notice, 1012099Sjoerg this list of conditions and the following disclaimer. 1112099Sjoerg 1212099Sjoerg 2. Redistributions in binary form must reproduce the above copyright 1312099Sjoerg notice, this list of conditions and the following disclaimer in the 1412099Sjoerg documentation and/or other materials provided with the distribution. 1512099Sjoerg 1612099Sjoerg 3. Neither the name of the Intel Corporation nor the names of its 1712099Sjoerg contributors may be used to endorse or promote products derived from 1812099Sjoerg this software without specific prior written permission. 1912099Sjoerg 2012099Sjoerg THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 2112099Sjoerg AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 2212099Sjoerg IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 2312099Sjoerg ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 2412099Sjoerg LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 2512099Sjoerg CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 2612099Sjoerg SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 2712099Sjoerg INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 2812099Sjoerg CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 2912099Sjoerg ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 3012099Sjoerg POSSIBILITY OF SUCH DAMAGE. 3112099Sjoerg 3212099Sjoerg******************************************************************************/ 3312099Sjoerg/*$FreeBSD: head/sys/dev/e1000/e1000_api.h 203049 2010-01-26 22:32:22Z jfv $*/ 3491586Smarkm 3591586Smarkm#ifndef _E1000_API_H_ 3691586Smarkm#define _E1000_API_H_ 3712099Sjoerg 38108532Sschweikh#include "e1000_hw.h" 3912099Sjoerg 4012099Sjoergextern void e1000_init_function_pointers_82542(struct e1000_hw *hw); 4112099Sjoergextern void e1000_init_function_pointers_82543(struct e1000_hw *hw); 4212099Sjoergextern void e1000_init_function_pointers_82540(struct e1000_hw *hw); 4312099Sjoergextern void e1000_init_function_pointers_82571(struct e1000_hw *hw); 4412099Sjoergextern void e1000_init_function_pointers_82541(struct e1000_hw *hw); 4512099Sjoergextern void e1000_init_function_pointers_80003es2lan(struct e1000_hw *hw); 4612099Sjoergextern void e1000_init_function_pointers_ich8lan(struct e1000_hw *hw); 4712099Sjoergextern void e1000_init_function_pointers_82575(struct e1000_hw *hw); 4812099Sjoergextern void e1000_rx_fifo_flush_82575(struct e1000_hw *hw); 4912099Sjoergextern void e1000_init_function_pointers_vf(struct e1000_hw *hw); 5012099Sjoergextern void e1000_power_up_fiber_serdes_link(struct e1000_hw *hw); 5112099Sjoergextern void e1000_shutdown_fiber_serdes_link(struct e1000_hw *hw); 5212099Sjoerg 5312099Sjoergs32 e1000_set_mac_type(struct e1000_hw *hw); 5412099Sjoergs32 e1000_setup_init_funcs(struct e1000_hw *hw, bool init_device); 5512099Sjoergs32 e1000_init_mac_params(struct e1000_hw *hw); 5612099Sjoergs32 e1000_init_nvm_params(struct e1000_hw *hw); 5712099Sjoergs32 e1000_init_phy_params(struct e1000_hw *hw); 5812099Sjoergs32 e1000_get_bus_info(struct e1000_hw *hw); 5912099Sjoergvoid e1000_clear_vfta(struct e1000_hw *hw); 6012099Sjoergvoid e1000_write_vfta(struct e1000_hw *hw, u32 offset, u32 value); 6112099Sjoergs32 e1000_force_mac_fc(struct e1000_hw *hw); 6212099Sjoergs32 e1000_check_for_link(struct e1000_hw *hw); 6391586Smarkms32 e1000_reset_hw(struct e1000_hw *hw); 6412099Sjoergs32 e1000_init_hw(struct e1000_hw *hw); 6512099Sjoergs32 e1000_setup_link(struct e1000_hw *hw); 6612099Sjoergs32 e1000_get_speed_and_duplex(struct e1000_hw *hw, u16 *speed, 6712099Sjoerg u16 *duplex); 6812099Sjoergs32 e1000_disable_pcie_master(struct e1000_hw *hw); 6912099Sjoergvoid e1000_config_collision_dist(struct e1000_hw *hw); 7012099Sjoergvoid e1000_rar_set(struct e1000_hw *hw, u8 *addr, u32 index); 71108532Sschweikhu32 e1000_hash_mc_addr(struct e1000_hw *hw, u8 *mc_addr); 7212099Sjoergvoid e1000_update_mc_addr_list(struct e1000_hw *hw, 7312099Sjoerg u8 *mc_addr_list, u32 mc_addr_count); 7412099Sjoergs32 e1000_setup_led(struct e1000_hw *hw); 7512099Sjoergs32 e1000_cleanup_led(struct e1000_hw *hw); 7612099Sjoergs32 e1000_check_reset_block(struct e1000_hw *hw); 7712099Sjoergs32 e1000_blink_led(struct e1000_hw *hw); 7812099Sjoergs32 e1000_led_on(struct e1000_hw *hw); 7912099Sjoergs32 e1000_led_off(struct e1000_hw *hw); 8012099Sjoergs32 e1000_id_led_init(struct e1000_hw *hw); 8112099Sjoergvoid e1000_reset_adaptive(struct e1000_hw *hw); 8212099Sjoergvoid e1000_update_adaptive(struct e1000_hw *hw); 8312099Sjoergs32 e1000_get_cable_length(struct e1000_hw *hw); 8412099Sjoergs32 e1000_validate_mdi_setting(struct e1000_hw *hw); 8512099Sjoergs32 e1000_read_phy_reg(struct e1000_hw *hw, u32 offset, u16 *data); 8612099Sjoergs32 e1000_write_phy_reg(struct e1000_hw *hw, u32 offset, u16 data); 8712099Sjoergs32 e1000_write_8bit_ctrl_reg(struct e1000_hw *hw, u32 reg, 8891586Smarkm u32 offset, u8 data); 8912099Sjoergs32 e1000_get_phy_info(struct e1000_hw *hw); 9091586Smarkmvoid e1000_release_phy(struct e1000_hw *hw); 9112099Sjoergs32 e1000_acquire_phy(struct e1000_hw *hw); 9212099Sjoergs32 e1000_cfg_on_link_up(struct e1000_hw *hw); 9391586Smarkms32 e1000_phy_hw_reset(struct e1000_hw *hw); 9412099Sjoergs32 e1000_phy_commit(struct e1000_hw *hw); 9512099Sjoergvoid e1000_power_up_phy(struct e1000_hw *hw); 9612099Sjoergvoid e1000_power_down_phy(struct e1000_hw *hw); 9712099Sjoergs32 e1000_read_mac_addr(struct e1000_hw *hw); 9812099Sjoergs32 e1000_read_pba_num(struct e1000_hw *hw, u32 *part_num); 9912099Sjoergvoid e1000_reload_nvm(struct e1000_hw *hw); 10012099Sjoergs32 e1000_update_nvm_checksum(struct e1000_hw *hw); 10112099Sjoergs32 e1000_validate_nvm_checksum(struct e1000_hw *hw); 10212099Sjoergs32 e1000_read_nvm(struct e1000_hw *hw, u16 offset, u16 words, u16 *data); 10312099Sjoergs32 e1000_read_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 *data); 10412099Sjoergs32 e1000_write_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 data); 10512099Sjoergs32 e1000_write_nvm(struct e1000_hw *hw, u16 offset, u16 words, 10612099Sjoerg u16 *data); 10712099Sjoergs32 e1000_wait_autoneg(struct e1000_hw *hw); 10812099Sjoergs32 e1000_set_d3_lplu_state(struct e1000_hw *hw, bool active); 10912099Sjoergs32 e1000_set_d0_lplu_state(struct e1000_hw *hw, bool active); 11012099Sjoergbool e1000_check_mng_mode(struct e1000_hw *hw); 11112099Sjoergbool e1000_enable_tx_pkt_filtering(struct e1000_hw *hw); 11212099Sjoergs32 e1000_mng_enable_host_if(struct e1000_hw *hw); 11312099Sjoergs32 e1000_mng_host_if_write(struct e1000_hw *hw, 11412099Sjoerg u8 *buffer, u16 length, u16 offset, u8 *sum); 11512099Sjoergs32 e1000_mng_write_cmd_header(struct e1000_hw *hw, 11612099Sjoerg struct e1000_host_mng_command_header *hdr); 11712099Sjoergs32 e1000_mng_write_dhcp_info(struct e1000_hw * hw, 11812099Sjoerg u8 *buffer, u16 length); 11912099Sjoergu32 e1000_translate_register_82542(u32 reg); 12012099Sjoerg 12112099Sjoerg/* 12212099Sjoerg * TBI_ACCEPT macro definition: 12312099Sjoerg * 12412099Sjoerg * This macro requires: 12512099Sjoerg * adapter = a pointer to struct e1000_hw 12612099Sjoerg * status = the 8 bit status field of the Rx descriptor with EOP set 12712099Sjoerg * error = the 8 bit error field of the Rx descriptor with EOP set 12812099Sjoerg * length = the sum of all the length fields of the Rx descriptors that 12912099Sjoerg * make up the current frame 13012099Sjoerg * last_byte = the last byte of the frame DMAed by the hardware 13112099Sjoerg * max_frame_length = the maximum frame length we want to accept. 13212099Sjoerg * min_frame_length = the minimum frame length we want to accept. 13312099Sjoerg * 13412099Sjoerg * This macro is a conditional that should be used in the interrupt 13512099Sjoerg * handler's Rx processing routine when RxErrors have been detected. 13612099Sjoerg * 13791586Smarkm * Typical use: 13891586Smarkm * ... 13991586Smarkm * if (TBI_ACCEPT) { 14012099Sjoerg * accept_frame = TRUE; 14112099Sjoerg * e1000_tbi_adjust_stats(adapter, MacAddress); 14212099Sjoerg * frame_length--; 14312099Sjoerg * } else { 14412099Sjoerg * accept_frame = FALSE; 14512099Sjoerg * } 14612099Sjoerg * ... 14791586Smarkm */ 14812099Sjoerg 14912099Sjoerg/* The carrier extension symbol, as received by the NIC. */ 15012099Sjoerg#define CARRIER_EXTENSION 0x0F 15112099Sjoerg 15212099Sjoerg#define TBI_ACCEPT(a, status, errors, length, last_byte, min_frame_size, max_frame_size) \ 15312099Sjoerg (e1000_tbi_sbp_enabled_82543(a) && \ 15412099Sjoerg (((errors) & E1000_RXD_ERR_FRAME_ERR_MASK) == E1000_RXD_ERR_CE) && \ 15512099Sjoerg ((last_byte) == CARRIER_EXTENSION) && \ 15612099Sjoerg (((status) & E1000_RXD_STAT_VP) ? \ 15712099Sjoerg (((length) > (min_frame_size - VLAN_TAG_SIZE)) && \ 15812099Sjoerg ((length) <= (max_frame_size + 1))) : \ 15912099Sjoerg (((length) > min_frame_size) && \ 16012099Sjoerg ((length) <= (max_frame_size + VLAN_TAG_SIZE + 1))))) 16112099Sjoerg 16212099Sjoerg#endif 16312099Sjoerg