e1000_api.h revision 218530
1327952Sdim/****************************************************************************** 2317017Sdim 3353358Sdim Copyright (c) 2001-2010, Intel Corporation 4353358Sdim All rights reserved. 5353358Sdim 6317017Sdim Redistribution and use in source and binary forms, with or without 7317017Sdim modification, are permitted provided that the following conditions are met: 8317017Sdim 9327952Sdim 1. Redistributions of source code must retain the above copyright notice, 10327952Sdim this list of conditions and the following disclaimer. 11317017Sdim 12327952Sdim 2. Redistributions in binary form must reproduce the above copyright 13317017Sdim notice, this list of conditions and the following disclaimer in the 14327952Sdim documentation and/or other materials provided with the distribution. 15327952Sdim 16327952Sdim 3. Neither the name of the Intel Corporation nor the names of its 17317017Sdim contributors may be used to endorse or promote products derived from 18317017Sdim this software without specific prior written permission. 19327952Sdim 20317017Sdim THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 21327952Sdim AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22317017Sdim IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23317017Sdim ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 24317017Sdim LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 25317017Sdim CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 26317017Sdim SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 27327952Sdim INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 28327952Sdim CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 29327952Sdim ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 30327952Sdim POSSIBILITY OF SUCH DAMAGE. 31317017Sdim 32327952Sdim******************************************************************************/ 33327952Sdim/*$FreeBSD: head/sys/dev/e1000/e1000_api.h 218530 2011-02-11 01:00:26Z jfv $*/ 34317017Sdim 35327952Sdim#ifndef _E1000_API_H_ 36317017Sdim#define _E1000_API_H_ 37327952Sdim 38327952Sdim#include "e1000_hw.h" 39327952Sdim 40327952Sdimextern void e1000_init_function_pointers_82542(struct e1000_hw *hw); 41327952Sdimextern void e1000_init_function_pointers_82543(struct e1000_hw *hw); 42360784Sdimextern void e1000_init_function_pointers_82540(struct e1000_hw *hw); 43327952Sdimextern void e1000_init_function_pointers_82571(struct e1000_hw *hw); 44317017Sdimextern void e1000_init_function_pointers_82541(struct e1000_hw *hw); 45327952Sdimextern void e1000_init_function_pointers_80003es2lan(struct e1000_hw *hw); 46327952Sdimextern void e1000_init_function_pointers_ich8lan(struct e1000_hw *hw); 47327952Sdimextern void e1000_init_function_pointers_82575(struct e1000_hw *hw); 48360784Sdimextern void e1000_rx_fifo_flush_82575(struct e1000_hw *hw); 49327952Sdimextern void e1000_init_function_pointers_vf(struct e1000_hw *hw); 50327952Sdimextern void e1000_power_up_fiber_serdes_link(struct e1000_hw *hw); 51327952Sdimextern void e1000_shutdown_fiber_serdes_link(struct e1000_hw *hw); 52327952Sdim 53317017Sdims32 e1000_set_mac_type(struct e1000_hw *hw); 54327952Sdims32 e1000_setup_init_funcs(struct e1000_hw *hw, bool init_device); 55317472Sdims32 e1000_init_mac_params(struct e1000_hw *hw); 56317017Sdims32 e1000_init_nvm_params(struct e1000_hw *hw); 57319799Sdims32 e1000_init_phy_params(struct e1000_hw *hw); 58341825Sdims32 e1000_init_mbx_params(struct e1000_hw *hw); 59360784Sdims32 e1000_get_bus_info(struct e1000_hw *hw); 60317017Sdimvoid e1000_clear_vfta(struct e1000_hw *hw); 61317017Sdimvoid e1000_write_vfta(struct e1000_hw *hw, u32 offset, u32 value); 62327952Sdims32 e1000_force_mac_fc(struct e1000_hw *hw); 63327952Sdims32 e1000_check_for_link(struct e1000_hw *hw); 64327952Sdims32 e1000_reset_hw(struct e1000_hw *hw); 65327952Sdims32 e1000_init_hw(struct e1000_hw *hw); 66327952Sdims32 e1000_setup_link(struct e1000_hw *hw); 67327952Sdims32 e1000_get_speed_and_duplex(struct e1000_hw *hw, u16 *speed, 68327952Sdim u16 *duplex); 69327952Sdims32 e1000_disable_pcie_master(struct e1000_hw *hw); 70327952Sdimvoid e1000_config_collision_dist(struct e1000_hw *hw); 71327952Sdimvoid e1000_rar_set(struct e1000_hw *hw, u8 *addr, u32 index); 72317017Sdimu32 e1000_hash_mc_addr(struct e1000_hw *hw, u8 *mc_addr); 73360784Sdimvoid e1000_update_mc_addr_list(struct e1000_hw *hw, 74360784Sdim u8 *mc_addr_list, u32 mc_addr_count); 75317017Sdims32 e1000_setup_led(struct e1000_hw *hw); 76317017Sdims32 e1000_cleanup_led(struct e1000_hw *hw); 77317017Sdims32 e1000_check_reset_block(struct e1000_hw *hw); 78317017Sdims32 e1000_blink_led(struct e1000_hw *hw); 79317017Sdims32 e1000_led_on(struct e1000_hw *hw); 80317017Sdims32 e1000_led_off(struct e1000_hw *hw); 81317017Sdims32 e1000_id_led_init(struct e1000_hw *hw); 82317017Sdimvoid e1000_reset_adaptive(struct e1000_hw *hw); 83317017Sdimvoid e1000_update_adaptive(struct e1000_hw *hw); 84317017Sdims32 e1000_get_cable_length(struct e1000_hw *hw); 85317017Sdims32 e1000_validate_mdi_setting(struct e1000_hw *hw); 86317017Sdims32 e1000_read_phy_reg(struct e1000_hw *hw, u32 offset, u16 *data); 87317017Sdims32 e1000_write_phy_reg(struct e1000_hw *hw, u32 offset, u16 data); 88317017Sdims32 e1000_write_8bit_ctrl_reg(struct e1000_hw *hw, u32 reg, 89317017Sdim u32 offset, u8 data); 90317017Sdims32 e1000_get_phy_info(struct e1000_hw *hw); 91317017Sdimvoid e1000_release_phy(struct e1000_hw *hw); 92317017Sdims32 e1000_acquire_phy(struct e1000_hw *hw); 93317017Sdims32 e1000_cfg_on_link_up(struct e1000_hw *hw); 94317017Sdims32 e1000_phy_hw_reset(struct e1000_hw *hw); 95317017Sdims32 e1000_phy_commit(struct e1000_hw *hw); 96317017Sdimvoid e1000_power_up_phy(struct e1000_hw *hw); 97317017Sdimvoid e1000_power_down_phy(struct e1000_hw *hw); 98360784Sdims32 e1000_read_mac_addr(struct e1000_hw *hw); 99360784Sdims32 e1000_read_pba_string(struct e1000_hw *hw, u8 *pba_num, 100360784Sdim u32 pba_num_size); 101317017Sdims32 e1000_read_pba_length(struct e1000_hw *hw, u32 *pba_num_size); 102319479Sdimvoid e1000_reload_nvm(struct e1000_hw *hw); 103319479Sdims32 e1000_update_nvm_checksum(struct e1000_hw *hw); 104319479Sdims32 e1000_validate_nvm_checksum(struct e1000_hw *hw); 105317017Sdims32 e1000_read_nvm(struct e1000_hw *hw, u16 offset, u16 words, u16 *data); 106317017Sdims32 e1000_read_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 *data); 107317017Sdims32 e1000_write_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 data); 108317017Sdims32 e1000_write_nvm(struct e1000_hw *hw, u16 offset, u16 words, 109317017Sdim u16 *data); 110327952Sdims32 e1000_wait_autoneg(struct e1000_hw *hw); 111317017Sdims32 e1000_set_d3_lplu_state(struct e1000_hw *hw, bool active); 112317017Sdims32 e1000_set_d0_lplu_state(struct e1000_hw *hw, bool active); 113317017Sdimbool e1000_check_mng_mode(struct e1000_hw *hw); 114327952Sdimbool e1000_enable_tx_pkt_filtering(struct e1000_hw *hw); 115327952Sdims32 e1000_mng_enable_host_if(struct e1000_hw *hw); 116317017Sdims32 e1000_mng_host_if_write(struct e1000_hw *hw, 117327952Sdim u8 *buffer, u16 length, u16 offset, u8 *sum); 118317017Sdims32 e1000_mng_write_cmd_header(struct e1000_hw *hw, 119317017Sdim struct e1000_host_mng_command_header *hdr); 120317017Sdims32 e1000_mng_write_dhcp_info(struct e1000_hw * hw, 121327952Sdim u8 *buffer, u16 length); 122317017Sdimu32 e1000_translate_register_82542(u32 reg); 123317017Sdim 124317017Sdim/* 125327952Sdim * TBI_ACCEPT macro definition: 126317017Sdim * 127317017Sdim * This macro requires: 128317017Sdim * adapter = a pointer to struct e1000_hw 129317017Sdim * status = the 8 bit status field of the Rx descriptor with EOP set 130317017Sdim * error = the 8 bit error field of the Rx descriptor with EOP set 131317017Sdim * length = the sum of all the length fields of the Rx descriptors that 132317017Sdim * make up the current frame 133317017Sdim * last_byte = the last byte of the frame DMAed by the hardware 134317017Sdim * max_frame_length = the maximum frame length we want to accept. 135317017Sdim * min_frame_length = the minimum frame length we want to accept. 136317017Sdim * 137317017Sdim * This macro is a conditional that should be used in the interrupt 138317017Sdim * handler's Rx processing routine when RxErrors have been detected. 139317017Sdim * 140317017Sdim * Typical use: 141317017Sdim * ... 142317017Sdim * if (TBI_ACCEPT) { 143317017Sdim * accept_frame = TRUE; 144317017Sdim * e1000_tbi_adjust_stats(adapter, MacAddress); 145317017Sdim * frame_length--; 146317017Sdim * } else { 147317017Sdim * accept_frame = FALSE; 148317017Sdim * } 149317017Sdim * ... 150317017Sdim */ 151317017Sdim 152317017Sdim/* The carrier extension symbol, as received by the NIC. */ 153317017Sdim#define CARRIER_EXTENSION 0x0F 154317017Sdim 155317017Sdim#define TBI_ACCEPT(a, status, errors, length, last_byte, min_frame_size, max_frame_size) \ 156317017Sdim (e1000_tbi_sbp_enabled_82543(a) && \ 157317017Sdim (((errors) & E1000_RXD_ERR_FRAME_ERR_MASK) == E1000_RXD_ERR_CE) && \ 158317017Sdim ((last_byte) == CARRIER_EXTENSION) && \ 159317017Sdim (((status) & E1000_RXD_STAT_VP) ? \ 160317017Sdim (((length) > (min_frame_size - VLAN_TAG_SIZE)) && \ 161317017Sdim ((length) <= (max_frame_size + 1))) : \ 162317017Sdim (((length) > min_frame_size) && \ 163317017Sdim ((length) <= (max_frame_size + VLAN_TAG_SIZE + 1))))) 164317017Sdim 165327952Sdim#endif 166327952Sdim