1 /* 2 * This file is provided under a CDDLv1 license. When using or 3 * redistributing this file, you may do so under this license. 4 * In redistributing this file this license must be included 5 * and no other modification of this header file is permitted. 6 * 7 * CDDL LICENSE SUMMARY 8 * 9 * Copyright(c) 1999 - 2008 Intel Corporation. All rights reserved. 10 * 11 * The contents of this file are subject to the terms of Version 12 * 1.0 of the Common Development and Distribution License (the "License"). 13 * 14 * You should have received a copy of the License with this software. 15 * You can obtain a copy of the License at 16 * http://www.opensolaris.org/os/licensing. 17 * See the License for the specific language governing permissions 18 * and limitations under the License. 19 */ 20 21 /* 22 * Copyright 2008 Sun Microsystems, Inc. All rights reserved. 23 * Use is subject to license terms of the CDDLv1. 24 */ 25 26 /* 27 * IntelVersion: 1.40 v2008-02-29 28 */ 29 #ifndef _E1000_API_H_ 30 #define _E1000_API_H_ 31 32 #pragma ident "%Z%%M% %I% %E% SMI" 33 34 #ifdef __cplusplus 35 extern "C" { 36 #endif 37 38 #include "e1000_hw.h" 39 40 extern void e1000_init_function_pointers_82542(struct e1000_hw *hw); 41 extern void e1000_init_function_pointers_82543(struct e1000_hw *hw); 42 extern void e1000_init_function_pointers_82540(struct e1000_hw *hw); 43 extern void e1000_init_function_pointers_82571(struct e1000_hw *hw); 44 extern void e1000_init_function_pointers_82541(struct e1000_hw *hw); 45 extern void e1000_init_function_pointers_80003es2lan(struct e1000_hw *hw); 46 extern void e1000_init_function_pointers_ich8lan(struct e1000_hw *hw); 47 48 s32 e1000_set_mac_type(struct e1000_hw *hw); 49 s32 e1000_setup_init_funcs(struct e1000_hw *hw, bool init_device); 50 s32 e1000_init_mac_params(struct e1000_hw *hw); 51 s32 e1000_init_nvm_params(struct e1000_hw *hw); 52 s32 e1000_init_phy_params(struct e1000_hw *hw); 53 void e1000_remove_device(struct e1000_hw *hw); 54 s32 e1000_get_bus_info(struct e1000_hw *hw); 55 void e1000_clear_vfta(struct e1000_hw *hw); 56 void e1000_write_vfta(struct e1000_hw *hw, u32 offset, u32 value); 57 s32 e1000_force_mac_fc(struct e1000_hw *hw); 58 s32 e1000_check_for_link(struct e1000_hw *hw); 59 s32 e1000_reset_hw(struct e1000_hw *hw); 60 s32 e1000_init_hw(struct e1000_hw *hw); 61 s32 e1000_setup_link(struct e1000_hw *hw); 62 s32 e1000_get_speed_and_duplex(struct e1000_hw *hw, u16 *speed, u16 *duplex); 63 s32 e1000_disable_pcie_master(struct e1000_hw *hw); 64 void e1000_config_collision_dist(struct e1000_hw *hw); 65 void e1000_rar_set(struct e1000_hw *hw, u8 *addr, u32 index); 66 void e1000_mta_set(struct e1000_hw *hw, u32 hash_value); 67 u32 e1000_hash_mc_addr(struct e1000_hw *hw, u8 *mc_addr); 68 void e1000_update_mc_addr_list(struct e1000_hw *hw, 69 u8 *mc_addr_list, u32 mc_addr_count, 70 u32 rar_used_count, u32 rar_count); 71 s32 e1000_setup_led(struct e1000_hw *hw); 72 s32 e1000_cleanup_led(struct e1000_hw *hw); 73 s32 e1000_check_reset_block(struct e1000_hw *hw); 74 s32 e1000_blink_led(struct e1000_hw *hw); 75 s32 e1000_led_on(struct e1000_hw *hw); 76 s32 e1000_led_off(struct e1000_hw *hw); 77 void e1000_reset_adaptive(struct e1000_hw *hw); 78 void e1000_update_adaptive(struct e1000_hw *hw); 79 s32 e1000_get_cable_length(struct e1000_hw *hw); 80 s32 e1000_validate_mdi_setting(struct e1000_hw *hw); 81 s32 e1000_read_phy_reg(struct e1000_hw *hw, u32 offset, u16 *data); 82 s32 e1000_write_phy_reg(struct e1000_hw *hw, u32 offset, u16 data); 83 s32 e1000_write_8bit_ctrl_reg(struct e1000_hw *hw, u32 reg, 84 u32 offset, u8 data); 85 s32 e1000_get_phy_info(struct e1000_hw *hw); 86 void e1000_release_phy(struct e1000_hw *hw); 87 s32 e1000_acquire_phy(struct e1000_hw *hw); 88 s32 e1000_phy_hw_reset(struct e1000_hw *hw); 89 s32 e1000_phy_commit(struct e1000_hw *hw); 90 void e1000_power_up_phy(struct e1000_hw *hw); 91 void e1000_power_down_phy(struct e1000_hw *hw); 92 s32 e1000_read_mac_addr(struct e1000_hw *hw); 93 s32 e1000_read_pba_num(struct e1000_hw *hw, u32 *pba_num); 94 void e1000_reload_nvm(struct e1000_hw *hw); 95 s32 e1000_update_nvm_checksum(struct e1000_hw *hw); 96 s32 e1000_validate_nvm_checksum(struct e1000_hw *hw); 97 s32 e1000_read_nvm(struct e1000_hw *hw, u16 offset, u16 words, u16 *data); 98 s32 e1000_read_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 *data); 99 s32 e1000_write_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 data); 100 s32 e1000_write_nvm(struct e1000_hw *hw, u16 offset, u16 words, u16 *data); 101 s32 e1000_wait_autoneg(struct e1000_hw *hw); 102 s32 e1000_set_d3_lplu_state(struct e1000_hw *hw, bool active); 103 s32 e1000_set_d0_lplu_state(struct e1000_hw *hw, bool active); 104 bool e1000_check_mng_mode(struct e1000_hw *hw); 105 bool e1000_enable_mng_pass_thru(struct e1000_hw *hw); 106 bool e1000_enable_tx_pkt_filtering(struct e1000_hw *hw); 107 s32 e1000_mng_enable_host_if(struct e1000_hw *hw); 108 s32 e1000_mng_host_if_write(struct e1000_hw *hw, 109 u8 *buffer, u16 length, u16 offset, u8 *sum); 110 s32 e1000_mng_write_cmd_header(struct e1000_hw *hw, 111 struct e1000_host_mng_command_header *hdr); 112 s32 e1000_mng_write_dhcp_info(struct e1000_hw *hw, 113 u8 *buffer, u16 length); 114 void e1000_tbi_adjust_stats_82543(struct e1000_hw *hw, 115 struct e1000_hw_stats *stats, 116 u32 frame_len, u8 *mac_addr, 117 u32 max_frame_size); 118 void e1000_set_tbi_compatibility_82543(struct e1000_hw *hw, 119 bool state); 120 bool e1000_tbi_sbp_enabled_82543(struct e1000_hw *hw); 121 u32 e1000_translate_register_82542(u32 reg); 122 void e1000_init_script_state_82541(struct e1000_hw *hw, bool state); 123 bool e1000_get_laa_state_82571(struct e1000_hw *hw); 124 void e1000_set_laa_state_82571(struct e1000_hw *hw, bool state); 125 void e1000_set_kmrn_lock_loss_workaround_ich8lan(struct e1000_hw *hw, 126 bool state); 127 void e1000_igp3_phy_powerdown_workaround_ich8lan(struct e1000_hw *hw); 128 void e1000_gig_downshift_workaround_ich8lan(struct e1000_hw *hw); 129 void e1000_disable_gig_wol_ich8lan(struct e1000_hw *hw); 130 #ifndef FIFO_WORKAROUND 131 s32 e1000_fifo_workaround_82547(struct e1000_hw *hw, u16 length); 132 void e1000_update_tx_fifo_head_82547(struct e1000_hw *hw, u32 length); 133 void e1000_set_ttl_workaround_state_82541(struct e1000_hw *hw, 134 bool state); 135 bool e1000_ttl_workaround_enabled_82541(struct e1000_hw *hw); 136 s32 e1000_igp_ttl_workaround_82547(struct e1000_hw *hw); 137 #endif 138 139 140 /* 141 * TBI_ACCEPT macro definition: 142 * 143 * This macro requires: 144 * adapter = a pointer to struct e1000_hw 145 * status = the 8 bit status field of the Rx descriptor with EOP set 146 * error = the 8 bit error field of the Rx descriptor with EOP set 147 * length = the sum of all the length fields of the Rx descriptors that 148 * make up the current frame 149 * last_byte = the last byte of the frame DMAed by the hardware 150 * max_frame_length = the maximum frame length we want to accept. 151 * min_frame_length = the minimum frame length we want to accept. 152 * 153 * This macro is a conditional that should be used in the interrupt 154 * handler's Rx processing routine when RxErrors have been detected. 155 * 156 * Typical use: 157 * ... 158 * if (TBI_ACCEPT) { 159 * accept_frame = TRUE; 160 * e1000_tbi_adjust_stats(adapter, MacAddress); 161 * frame_length--; 162 * } else { 163 * accept_frame = FALSE; 164 * } 165 * ... 166 */ 167 168 /* The carrier extension symbol, as received by the NIC. */ 169 #define CARRIER_EXTENSION 0x0F 170 171 #define TBI_ACCEPT(a, status, errors, length, last_byte, \ 172 min_frame_size, max_frame_size) \ 173 (e1000_tbi_sbp_enabled_82543(a) && \ 174 (((errors) & E1000_RXD_ERR_FRAME_ERR_MASK) == E1000_RXD_ERR_CE) && \ 175 ((last_byte) == CARRIER_EXTENSION) && \ 176 (((status) & E1000_RXD_STAT_VP) ? \ 177 (((length) > (min_frame_size - VLAN_TAG_SIZE)) && \ 178 ((length) <= (max_frame_size + 1))) : \ 179 (((length) > min_frame_size) && \ 180 ((length) <= (max_frame_size + VLAN_TAG_SIZE + 1))))) 181 182 #ifdef __cplusplus 183 } 184 #endif 185 186 #endif /* _E1000_API_H_ */ 187