175eba5b6SRobert Mustacchi /****************************************************************************** 275eba5b6SRobert Mustacchi 3*49b78600SRobert Mustacchi Copyright (c) 2001-2015, Intel Corporation 475eba5b6SRobert Mustacchi All rights reserved. 575eba5b6SRobert Mustacchi 675eba5b6SRobert Mustacchi Redistribution and use in source and binary forms, with or without 775eba5b6SRobert Mustacchi modification, are permitted provided that the following conditions are met: 875eba5b6SRobert Mustacchi 975eba5b6SRobert Mustacchi 1. Redistributions of source code must retain the above copyright notice, 1075eba5b6SRobert Mustacchi this list of conditions and the following disclaimer. 1175eba5b6SRobert Mustacchi 1275eba5b6SRobert Mustacchi 2. Redistributions in binary form must reproduce the above copyright 1375eba5b6SRobert Mustacchi notice, this list of conditions and the following disclaimer in the 1475eba5b6SRobert Mustacchi documentation and/or other materials provided with the distribution. 1575eba5b6SRobert Mustacchi 1675eba5b6SRobert Mustacchi 3. Neither the name of the Intel Corporation nor the names of its 1775eba5b6SRobert Mustacchi contributors may be used to endorse or promote products derived from 1875eba5b6SRobert Mustacchi this software without specific prior written permission. 1975eba5b6SRobert Mustacchi 2075eba5b6SRobert Mustacchi THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 2175eba5b6SRobert Mustacchi AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 2275eba5b6SRobert Mustacchi IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 2375eba5b6SRobert Mustacchi ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 2475eba5b6SRobert Mustacchi LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 2575eba5b6SRobert Mustacchi CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 2675eba5b6SRobert Mustacchi SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 2775eba5b6SRobert Mustacchi INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 2875eba5b6SRobert Mustacchi CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 2975eba5b6SRobert Mustacchi ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 3075eba5b6SRobert Mustacchi POSSIBILITY OF SUCH DAMAGE. 3175eba5b6SRobert Mustacchi 3275eba5b6SRobert Mustacchi ******************************************************************************/ 3375eba5b6SRobert Mustacchi /*$FreeBSD$*/ 3475eba5b6SRobert Mustacchi 3575eba5b6SRobert Mustacchi #ifndef _E1000_API_H_ 3675eba5b6SRobert Mustacchi #define _E1000_API_H_ 3775eba5b6SRobert Mustacchi 3875eba5b6SRobert Mustacchi #include "e1000_hw.h" 3975eba5b6SRobert Mustacchi 4075eba5b6SRobert Mustacchi extern void e1000_init_function_pointers_82542(struct e1000_hw *hw); 4175eba5b6SRobert Mustacchi extern void e1000_init_function_pointers_82543(struct e1000_hw *hw); 4275eba5b6SRobert Mustacchi extern void e1000_init_function_pointers_82540(struct e1000_hw *hw); 4375eba5b6SRobert Mustacchi extern void e1000_init_function_pointers_82571(struct e1000_hw *hw); 4475eba5b6SRobert Mustacchi extern void e1000_init_function_pointers_82541(struct e1000_hw *hw); 4575eba5b6SRobert Mustacchi extern void e1000_init_function_pointers_80003es2lan(struct e1000_hw *hw); 4675eba5b6SRobert Mustacchi extern void e1000_init_function_pointers_ich8lan(struct e1000_hw *hw); 4775eba5b6SRobert Mustacchi extern void e1000_init_function_pointers_82575(struct e1000_hw *hw); 4875eba5b6SRobert Mustacchi extern void e1000_rx_fifo_flush_82575(struct e1000_hw *hw); 4975eba5b6SRobert Mustacchi extern void e1000_init_function_pointers_vf(struct e1000_hw *hw); 5075eba5b6SRobert Mustacchi extern void e1000_power_up_fiber_serdes_link(struct e1000_hw *hw); 5175eba5b6SRobert Mustacchi extern void e1000_shutdown_fiber_serdes_link(struct e1000_hw *hw); 5275eba5b6SRobert Mustacchi extern void e1000_init_function_pointers_i210(struct e1000_hw *hw); 5375eba5b6SRobert Mustacchi 5475eba5b6SRobert Mustacchi s32 e1000_set_obff_timer(struct e1000_hw *hw, u32 itr); 5575eba5b6SRobert Mustacchi s32 e1000_set_mac_type(struct e1000_hw *hw); 5675eba5b6SRobert Mustacchi s32 e1000_setup_init_funcs(struct e1000_hw *hw, bool init_device); 5775eba5b6SRobert Mustacchi s32 e1000_init_mac_params(struct e1000_hw *hw); 5875eba5b6SRobert Mustacchi s32 e1000_init_nvm_params(struct e1000_hw *hw); 5975eba5b6SRobert Mustacchi s32 e1000_init_phy_params(struct e1000_hw *hw); 6075eba5b6SRobert Mustacchi s32 e1000_init_mbx_params(struct e1000_hw *hw); 6175eba5b6SRobert Mustacchi s32 e1000_get_bus_info(struct e1000_hw *hw); 6275eba5b6SRobert Mustacchi void e1000_clear_vfta(struct e1000_hw *hw); 6375eba5b6SRobert Mustacchi void e1000_write_vfta(struct e1000_hw *hw, u32 offset, u32 value); 6475eba5b6SRobert Mustacchi s32 e1000_force_mac_fc(struct e1000_hw *hw); 6575eba5b6SRobert Mustacchi s32 e1000_check_for_link(struct e1000_hw *hw); 6675eba5b6SRobert Mustacchi s32 e1000_reset_hw(struct e1000_hw *hw); 6775eba5b6SRobert Mustacchi s32 e1000_init_hw(struct e1000_hw *hw); 6875eba5b6SRobert Mustacchi s32 e1000_setup_link(struct e1000_hw *hw); 6975eba5b6SRobert Mustacchi s32 e1000_get_speed_and_duplex(struct e1000_hw *hw, u16 *speed, u16 *duplex); 7075eba5b6SRobert Mustacchi s32 e1000_disable_pcie_master(struct e1000_hw *hw); 7175eba5b6SRobert Mustacchi void e1000_config_collision_dist(struct e1000_hw *hw); 72c124a83eSRobert Mustacchi int e1000_rar_set(struct e1000_hw *hw, u8 *addr, u32 index); 7375eba5b6SRobert Mustacchi u32 e1000_hash_mc_addr(struct e1000_hw *hw, u8 *mc_addr); 7475eba5b6SRobert Mustacchi void e1000_update_mc_addr_list(struct e1000_hw *hw, u8 *mc_addr_list, 7575eba5b6SRobert Mustacchi u32 mc_addr_count); 7675eba5b6SRobert Mustacchi s32 e1000_setup_led(struct e1000_hw *hw); 7775eba5b6SRobert Mustacchi s32 e1000_cleanup_led(struct e1000_hw *hw); 7875eba5b6SRobert Mustacchi s32 e1000_check_reset_block(struct e1000_hw *hw); 7975eba5b6SRobert Mustacchi s32 e1000_blink_led(struct e1000_hw *hw); 8075eba5b6SRobert Mustacchi s32 e1000_led_on(struct e1000_hw *hw); 8175eba5b6SRobert Mustacchi s32 e1000_led_off(struct e1000_hw *hw); 8275eba5b6SRobert Mustacchi s32 e1000_id_led_init(struct e1000_hw *hw); 8375eba5b6SRobert Mustacchi void e1000_reset_adaptive(struct e1000_hw *hw); 8475eba5b6SRobert Mustacchi void e1000_update_adaptive(struct e1000_hw *hw); 8575eba5b6SRobert Mustacchi s32 e1000_get_cable_length(struct e1000_hw *hw); 8675eba5b6SRobert Mustacchi s32 e1000_validate_mdi_setting(struct e1000_hw *hw); 8775eba5b6SRobert Mustacchi s32 e1000_read_phy_reg(struct e1000_hw *hw, u32 offset, u16 *data); 8875eba5b6SRobert Mustacchi s32 e1000_write_phy_reg(struct e1000_hw *hw, u32 offset, u16 data); 8975eba5b6SRobert Mustacchi s32 e1000_write_8bit_ctrl_reg(struct e1000_hw *hw, u32 reg, u32 offset, 9075eba5b6SRobert Mustacchi u8 data); 9175eba5b6SRobert Mustacchi s32 e1000_get_phy_info(struct e1000_hw *hw); 9275eba5b6SRobert Mustacchi void e1000_release_phy(struct e1000_hw *hw); 9375eba5b6SRobert Mustacchi s32 e1000_acquire_phy(struct e1000_hw *hw); 9475eba5b6SRobert Mustacchi s32 e1000_cfg_on_link_up(struct e1000_hw *hw); 9575eba5b6SRobert Mustacchi s32 e1000_phy_hw_reset(struct e1000_hw *hw); 9675eba5b6SRobert Mustacchi s32 e1000_phy_commit(struct e1000_hw *hw); 9775eba5b6SRobert Mustacchi void e1000_power_up_phy(struct e1000_hw *hw); 9875eba5b6SRobert Mustacchi void e1000_power_down_phy(struct e1000_hw *hw); 9975eba5b6SRobert Mustacchi s32 e1000_read_mac_addr(struct e1000_hw *hw); 10075eba5b6SRobert Mustacchi s32 e1000_read_pba_string(struct e1000_hw *hw, u8 *pba_num, u32 pba_num_size); 10175eba5b6SRobert Mustacchi s32 e1000_read_pba_length(struct e1000_hw *hw, u32 *pba_num_size); 10275eba5b6SRobert Mustacchi void e1000_reload_nvm(struct e1000_hw *hw); 10375eba5b6SRobert Mustacchi s32 e1000_update_nvm_checksum(struct e1000_hw *hw); 10475eba5b6SRobert Mustacchi s32 e1000_validate_nvm_checksum(struct e1000_hw *hw); 10575eba5b6SRobert Mustacchi s32 e1000_read_nvm(struct e1000_hw *hw, u16 offset, u16 words, u16 *data); 10675eba5b6SRobert Mustacchi s32 e1000_read_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 *data); 10775eba5b6SRobert Mustacchi s32 e1000_write_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 data); 10875eba5b6SRobert Mustacchi s32 e1000_write_nvm(struct e1000_hw *hw, u16 offset, u16 words, u16 *data); 10975eba5b6SRobert Mustacchi s32 e1000_set_d3_lplu_state(struct e1000_hw *hw, bool active); 11075eba5b6SRobert Mustacchi s32 e1000_set_d0_lplu_state(struct e1000_hw *hw, bool active); 11175eba5b6SRobert Mustacchi bool e1000_check_mng_mode(struct e1000_hw *hw); 11275eba5b6SRobert Mustacchi bool e1000_enable_tx_pkt_filtering(struct e1000_hw *hw); 11375eba5b6SRobert Mustacchi s32 e1000_mng_enable_host_if(struct e1000_hw *hw); 11475eba5b6SRobert Mustacchi s32 e1000_mng_host_if_write(struct e1000_hw *hw, u8 *buffer, u16 length, 11575eba5b6SRobert Mustacchi u16 offset, u8 *sum); 11675eba5b6SRobert Mustacchi s32 e1000_mng_write_cmd_header(struct e1000_hw *hw, 11775eba5b6SRobert Mustacchi struct e1000_host_mng_command_header *hdr); 11875eba5b6SRobert Mustacchi s32 e1000_mng_write_dhcp_info(struct e1000_hw *hw, u8 *buffer, u16 length); 11975eba5b6SRobert Mustacchi u32 e1000_translate_register_82542(u32 reg); 12075eba5b6SRobert Mustacchi 12175eba5b6SRobert Mustacchi 12275eba5b6SRobert Mustacchi 12375eba5b6SRobert Mustacchi /* 12475eba5b6SRobert Mustacchi * TBI_ACCEPT macro definition: 12575eba5b6SRobert Mustacchi * 12675eba5b6SRobert Mustacchi * This macro requires: 127*49b78600SRobert Mustacchi * a = a pointer to struct e1000_hw 12875eba5b6SRobert Mustacchi * status = the 8 bit status field of the Rx descriptor with EOP set 129*49b78600SRobert Mustacchi * errors = the 8 bit error field of the Rx descriptor with EOP set 13075eba5b6SRobert Mustacchi * length = the sum of all the length fields of the Rx descriptors that 13175eba5b6SRobert Mustacchi * make up the current frame 13275eba5b6SRobert Mustacchi * last_byte = the last byte of the frame DMAed by the hardware 133*49b78600SRobert Mustacchi * min_frame_size = the minimum frame length we want to accept. 134*49b78600SRobert Mustacchi * max_frame_size = the maximum frame length we want to accept. 13575eba5b6SRobert Mustacchi * 13675eba5b6SRobert Mustacchi * This macro is a conditional that should be used in the interrupt 13775eba5b6SRobert Mustacchi * handler's Rx processing routine when RxErrors have been detected. 13875eba5b6SRobert Mustacchi * 13975eba5b6SRobert Mustacchi * Typical use: 14075eba5b6SRobert Mustacchi * ... 14175eba5b6SRobert Mustacchi * if (TBI_ACCEPT) { 14275eba5b6SRobert Mustacchi * accept_frame = TRUE; 14375eba5b6SRobert Mustacchi * e1000_tbi_adjust_stats(adapter, MacAddress); 14475eba5b6SRobert Mustacchi * frame_length--; 14575eba5b6SRobert Mustacchi * } else { 14675eba5b6SRobert Mustacchi * accept_frame = FALSE; 14775eba5b6SRobert Mustacchi * } 14875eba5b6SRobert Mustacchi * ... 14975eba5b6SRobert Mustacchi */ 15075eba5b6SRobert Mustacchi 15175eba5b6SRobert Mustacchi /* The carrier extension symbol, as received by the NIC. */ 15275eba5b6SRobert Mustacchi #define CARRIER_EXTENSION 0x0F 15375eba5b6SRobert Mustacchi 15475eba5b6SRobert Mustacchi #define TBI_ACCEPT(a, status, errors, length, last_byte, \ 15575eba5b6SRobert Mustacchi min_frame_size, max_frame_size) \ 15675eba5b6SRobert Mustacchi (e1000_tbi_sbp_enabled_82543(a) && \ 15775eba5b6SRobert Mustacchi (((errors) & E1000_RXD_ERR_FRAME_ERR_MASK) == E1000_RXD_ERR_CE) && \ 15875eba5b6SRobert Mustacchi ((last_byte) == CARRIER_EXTENSION) && \ 15975eba5b6SRobert Mustacchi (((status) & E1000_RXD_STAT_VP) ? \ 160*49b78600SRobert Mustacchi (((length) > ((min_frame_size) - VLAN_TAG_SIZE)) && \ 161*49b78600SRobert Mustacchi ((length) <= ((max_frame_size) + 1))) : \ 162*49b78600SRobert Mustacchi (((length) > (min_frame_size)) && \ 163*49b78600SRobert Mustacchi ((length) <= ((max_frame_size) + VLAN_TAG_SIZE + 1))))) 16475eba5b6SRobert Mustacchi 16575eba5b6SRobert Mustacchi #define E1000_MAX(a, b) ((a) > (b) ? (a) : (b)) 16675eba5b6SRobert Mustacchi #define E1000_DIVIDE_ROUND_UP(a, b) (((a) + (b) - 1) / (b)) /* ceil(a/b) */ 16775eba5b6SRobert Mustacchi #endif /* _E1000_API_H_ */ 168