e1000_api.h revision 169240
1169240Sjfv/******************************************************************************* 2169240Sjfv 3169240Sjfv Copyright (c) 2001-2007, Intel Corporation 4169240Sjfv All rights reserved. 5169240Sjfv 6169240Sjfv Redistribution and use in source and binary forms, with or without 7169240Sjfv modification, are permitted provided that the following conditions are met: 8169240Sjfv 9169240Sjfv 1. Redistributions of source code must retain the above copyright notice, 10169240Sjfv this list of conditions and the following disclaimer. 11169240Sjfv 12169240Sjfv 2. Redistributions in binary form must reproduce the above copyright 13169240Sjfv notice, this list of conditions and the following disclaimer in the 14169240Sjfv documentation and/or other materials provided with the distribution. 15169240Sjfv 16169240Sjfv 3. Neither the name of the Intel Corporation nor the names of its 17169240Sjfv contributors may be used to endorse or promote products derived from 18169240Sjfv this software without specific prior written permission. 19169240Sjfv 20169240Sjfv THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 21169240Sjfv AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22169240Sjfv IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23169240Sjfv ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 24169240Sjfv LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 25169240Sjfv CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 26169240Sjfv SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 27169240Sjfv INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 28169240Sjfv CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 29169240Sjfv ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 30169240Sjfv POSSIBILITY OF SUCH DAMAGE. 31169240Sjfv 32169240Sjfv*******************************************************************************/ 33169240Sjfv$FreeBSD: head/sys/dev/em/e1000_api.h 169240 2007-05-04 00:00:12Z jfv $ 34169240Sjfv 35169240Sjfv 36169240Sjfv#ifndef _E1000_API_H_ 37169240Sjfv#define _E1000_API_H_ 38169240Sjfv 39169240Sjfv#include "e1000_hw.h" 40169240Sjfv 41169240Sjfvs32 e1000_set_mac_type(struct e1000_hw *hw); 42169240Sjfvs32 e1000_setup_init_funcs(struct e1000_hw *hw, boolean_t init_device); 43169240Sjfvs32 e1000_init_mac_params(struct e1000_hw *hw); 44169240Sjfvs32 e1000_init_nvm_params(struct e1000_hw *hw); 45169240Sjfvs32 e1000_init_phy_params(struct e1000_hw *hw); 46169240Sjfvvoid e1000_remove_device(struct e1000_hw *hw); 47169240Sjfvs32 e1000_get_bus_info(struct e1000_hw *hw); 48169240Sjfvvoid e1000_clear_vfta(struct e1000_hw *hw); 49169240Sjfvvoid e1000_write_vfta(struct e1000_hw *hw, u32 offset, u32 value); 50169240Sjfvs32 e1000_force_mac_fc(struct e1000_hw *hw); 51169240Sjfvs32 e1000_check_for_link(struct e1000_hw *hw); 52169240Sjfvs32 e1000_reset_hw(struct e1000_hw *hw); 53169240Sjfvs32 e1000_init_hw(struct e1000_hw *hw); 54169240Sjfvs32 e1000_setup_link(struct e1000_hw *hw); 55169240Sjfvs32 e1000_get_speed_and_duplex(struct e1000_hw *hw, u16 *speed, 56169240Sjfv u16 *duplex); 57169240Sjfvs32 e1000_disable_pcie_master(struct e1000_hw *hw); 58169240Sjfvvoid e1000_config_collision_dist(struct e1000_hw *hw); 59169240Sjfvvoid e1000_rar_set(struct e1000_hw *hw, u8 *addr, u32 index); 60169240Sjfvvoid e1000_mta_set(struct e1000_hw *hw, u32 hash_value); 61169240Sjfvu32 e1000_hash_mc_addr(struct e1000_hw *hw, u8 *mc_addr); 62169240Sjfvvoid e1000_mc_addr_list_update(struct e1000_hw *hw, 63169240Sjfv u8 *mc_addr_list, u32 mc_addr_count, 64169240Sjfv u32 rar_used_count, u32 rar_count); 65169240Sjfvs32 e1000_setup_led(struct e1000_hw *hw); 66169240Sjfvs32 e1000_cleanup_led(struct e1000_hw *hw); 67169240Sjfvs32 e1000_check_reset_block(struct e1000_hw *hw); 68169240Sjfvs32 e1000_blink_led(struct e1000_hw *hw); 69169240Sjfvs32 e1000_led_on(struct e1000_hw *hw); 70169240Sjfvs32 e1000_led_off(struct e1000_hw *hw); 71169240Sjfvvoid e1000_reset_adaptive(struct e1000_hw *hw); 72169240Sjfvvoid e1000_update_adaptive(struct e1000_hw *hw); 73169240Sjfvs32 e1000_get_cable_length(struct e1000_hw *hw); 74169240Sjfvs32 e1000_validate_mdi_setting(struct e1000_hw *hw); 75169240Sjfvs32 e1000_read_phy_reg(struct e1000_hw *hw, u32 offset, u16 *data); 76169240Sjfvs32 e1000_write_phy_reg(struct e1000_hw *hw, u32 offset, u16 data); 77169240Sjfvs32 e1000_write_8bit_ctrl_reg(struct e1000_hw *hw, u32 reg, 78169240Sjfv u32 offset, u8 data); 79169240Sjfvs32 e1000_get_phy_info(struct e1000_hw *hw); 80169240Sjfvs32 e1000_phy_hw_reset(struct e1000_hw *hw); 81169240Sjfvs32 e1000_phy_commit(struct e1000_hw *hw); 82169240Sjfvs32 e1000_read_mac_addr(struct e1000_hw *hw); 83169240Sjfvs32 e1000_read_part_num(struct e1000_hw *hw, u32 *part_num); 84169240Sjfvvoid e1000_reload_nvm(struct e1000_hw *hw); 85169240Sjfvs32 e1000_update_nvm_checksum(struct e1000_hw *hw); 86169240Sjfvs32 e1000_validate_nvm_checksum(struct e1000_hw *hw); 87169240Sjfvs32 e1000_read_nvm(struct e1000_hw *hw, u16 offset, u16 words, u16 *data); 88169240Sjfvs32 e1000_read_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 *data); 89169240Sjfvs32 e1000_write_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 data); 90169240Sjfvs32 e1000_write_nvm(struct e1000_hw *hw, u16 offset, u16 words, 91169240Sjfv u16 *data); 92169240Sjfvs32 e1000_wait_autoneg(struct e1000_hw *hw); 93169240Sjfvs32 e1000_set_d3_lplu_state(struct e1000_hw *hw, boolean_t active); 94169240Sjfvs32 e1000_set_d0_lplu_state(struct e1000_hw *hw, boolean_t active); 95169240Sjfvboolean_t e1000_check_mng_mode(struct e1000_hw *hw); 96169240Sjfvboolean_t e1000_enable_mng_pass_thru(struct e1000_hw *hw); 97169240Sjfvboolean_t e1000_enable_tx_pkt_filtering(struct e1000_hw *hw); 98169240Sjfvs32 e1000_mng_enable_host_if(struct e1000_hw *hw); 99169240Sjfvs32 e1000_mng_host_if_write(struct e1000_hw *hw, 100169240Sjfv u8 *buffer, u16 length, u16 offset, u8 *sum); 101169240Sjfvs32 e1000_mng_write_cmd_header(struct e1000_hw *hw, 102169240Sjfv struct e1000_host_mng_command_header *hdr); 103169240Sjfvs32 e1000_mng_write_dhcp_info(struct e1000_hw * hw, 104169240Sjfv u8 *buffer, u16 length); 105169240Sjfvvoid e1000_tbi_adjust_stats_82543(struct e1000_hw *hw, 106169240Sjfv struct e1000_hw_stats *stats, 107169240Sjfv u32 frame_len, u8 *mac_addr); 108169240Sjfvvoid e1000_set_tbi_compatibility_82543(struct e1000_hw *hw, 109169240Sjfv boolean_t state); 110169240Sjfvboolean_t e1000_tbi_sbp_enabled_82543(struct e1000_hw *hw); 111169240Sjfv#ifndef NO_82542_SUPPORT 112169240Sjfvu32 e1000_translate_register_82542(u32 reg); 113169240Sjfv#endif 114169240Sjfvvoid e1000_init_script_state_82541(struct e1000_hw *hw, boolean_t state); 115169240Sjfvboolean_t e1000_get_laa_state_82571(struct e1000_hw *hw); 116169240Sjfvvoid e1000_set_laa_state_82571(struct e1000_hw *hw, boolean_t state); 117169240Sjfvvoid e1000_set_kmrn_lock_loss_workaround_ich8lan(struct e1000_hw *hw, 118169240Sjfv boolean_t state); 119169240Sjfvvoid e1000_igp3_phy_powerdown_workaround_ich8lan(struct e1000_hw *hw); 120169240Sjfvvoid e1000_gig_downshift_workaround_ich8lan(struct e1000_hw *hw); 121169240Sjfvu32 e1000_translate_register_adoram(u32 reg); 122169240Sjfv 123169240Sjfv/* TBI_ACCEPT macro definition: 124169240Sjfv * 125169240Sjfv * This macro requires: 126169240Sjfv * adapter = a pointer to struct e1000_hw 127169240Sjfv * status = the 8 bit status field of the RX descriptor with EOP set 128169240Sjfv * error = the 8 bit error field of the RX descriptor with EOP set 129169240Sjfv * length = the sum of all the length fields of the RX descriptors that 130169240Sjfv * make up the current frame 131169240Sjfv * last_byte = the last byte of the frame DMAed by the hardware 132169240Sjfv * max_frame_length = the maximum frame length we want to accept. 133169240Sjfv * min_frame_length = the minimum frame length we want to accept. 134169240Sjfv * 135169240Sjfv * This macro is a conditional that should be used in the interrupt 136169240Sjfv * handler's Rx processing routine when RxErrors have been detected. 137169240Sjfv * 138169240Sjfv * Typical use: 139169240Sjfv * ... 140169240Sjfv * if (TBI_ACCEPT) { 141169240Sjfv * accept_frame = TRUE; 142169240Sjfv * e1000_tbi_adjust_stats(adapter, MacAddress); 143169240Sjfv * frame_length--; 144169240Sjfv * } else { 145169240Sjfv * accept_frame = FALSE; 146169240Sjfv * } 147169240Sjfv * ... 148169240Sjfv */ 149169240Sjfv 150169240Sjfv/* The carrier extension symbol, as received by the NIC. */ 151169240Sjfv#define CARRIER_EXTENSION 0x0F 152169240Sjfv 153169240Sjfv#define TBI_ACCEPT(a, status, errors, length, last_byte) \ 154169240Sjfv (e1000_tbi_sbp_enabled_82543(a) && \ 155169240Sjfv (((errors) & E1000_RXD_ERR_FRAME_ERR_MASK) == E1000_RXD_ERR_CE) && \ 156169240Sjfv ((last_byte) == CARRIER_EXTENSION) && \ 157169240Sjfv (((status) & E1000_RXD_STAT_VP) ? \ 158169240Sjfv (((length) > ((a)->mac.min_frame_size - VLAN_TAG_SIZE)) && \ 159169240Sjfv ((length) <= ((a)->mac.max_frame_size + 1))) : \ 160169240Sjfv (((length) > (a)->mac.min_frame_size) && \ 161169240Sjfv ((length) <= ((a)->mac.max_frame_size + VLAN_TAG_SIZE + 1))))) 162169240Sjfv 163169240Sjfv#endif 164