Xenomai  3.0.8
e1000_api.h
1 /*******************************************************************************
2 
3  Intel PRO/1000 Linux driver
4  Copyright(c) 1999 - 2008 Intel Corporation.
5 
6  This program is free software; you can redistribute it and/or modify it
7  under the terms and conditions of the GNU General Public License,
8  version 2, as published by the Free Software Foundation.
9 
10  This program is distributed in the hope it will be useful, but WITHOUT
11  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13  more details.
14 
15  You should have received a copy of the GNU General Public License along with
16  this program; if not, write to the Free Software Foundation, Inc.,
17  51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
18 
19  The full GNU General Public License is included in this distribution in
20  the file called "COPYING".
21 
22  Contact Information:
23  Linux NICS <linux.nics@intel.com>
24  e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
25  Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
26 
27 *******************************************************************************/
28 
29 #ifndef _E1000_API_H_
30 #define _E1000_API_H_
31 
32 #include "e1000_hw.h"
33 
34 extern void e1000_init_function_pointers_82542(struct e1000_hw *hw);
35 extern void e1000_init_function_pointers_82543(struct e1000_hw *hw);
36 extern void e1000_init_function_pointers_82540(struct e1000_hw *hw);
37 extern void e1000_init_function_pointers_82571(struct e1000_hw *hw);
38 extern void e1000_init_function_pointers_82541(struct e1000_hw *hw);
39 extern void e1000_init_function_pointers_80003es2lan(struct e1000_hw *hw);
40 extern void e1000_init_function_pointers_ich8lan(struct e1000_hw *hw);
41 
42 s32 e1000_set_mac_type(struct e1000_hw *hw);
43 s32 e1000_setup_init_funcs(struct e1000_hw *hw, bool init_device);
44 s32 e1000_init_mac_params(struct e1000_hw *hw);
45 s32 e1000_init_nvm_params(struct e1000_hw *hw);
46 s32 e1000_init_phy_params(struct e1000_hw *hw);
47 void e1000_remove_device(struct e1000_hw *hw);
48 s32 e1000_get_bus_info(struct e1000_hw *hw);
49 void e1000_clear_vfta(struct e1000_hw *hw);
50 void e1000_write_vfta(struct e1000_hw *hw, u32 offset, u32 value);
51 s32 e1000_force_mac_fc(struct e1000_hw *hw);
52 s32 e1000_check_for_link(struct e1000_hw *hw);
53 s32 e1000_reset_hw(struct e1000_hw *hw);
54 s32 e1000_init_hw(struct e1000_hw *hw);
55 s32 e1000_setup_link(struct e1000_hw *hw);
56 s32 e1000_get_speed_and_duplex(struct e1000_hw *hw, u16 *speed,
57  u16 *duplex);
58 s32 e1000_disable_pcie_master(struct e1000_hw *hw);
59 void e1000_config_collision_dist(struct e1000_hw *hw);
60 void e1000_rar_set(struct e1000_hw *hw, u8 *addr, u32 index);
61 void e1000_mta_set(struct e1000_hw *hw, u32 hash_value);
62 u32 e1000_hash_mc_addr(struct e1000_hw *hw, u8 *mc_addr);
63 void e1000_update_mc_addr_list(struct e1000_hw *hw,
64  u8 *mc_addr_list, u32 mc_addr_count,
65  u32 rar_used_count, u32 rar_count);
66 s32 e1000_setup_led(struct e1000_hw *hw);
67 s32 e1000_cleanup_led(struct e1000_hw *hw);
68 s32 e1000_check_reset_block(struct e1000_hw *hw);
69 s32 e1000_blink_led(struct e1000_hw *hw);
70 s32 e1000_led_on(struct e1000_hw *hw);
71 s32 e1000_led_off(struct e1000_hw *hw);
72 void e1000_reset_adaptive(struct e1000_hw *hw);
73 void e1000_update_adaptive(struct e1000_hw *hw);
74 s32 e1000_get_cable_length(struct e1000_hw *hw);
75 s32 e1000_validate_mdi_setting(struct e1000_hw *hw);
76 s32 e1000_read_phy_reg(struct e1000_hw *hw, u32 offset, u16 *data);
77 s32 e1000_write_phy_reg(struct e1000_hw *hw, u32 offset, u16 data);
78 s32 e1000_write_8bit_ctrl_reg(struct e1000_hw *hw, u32 reg,
79  u32 offset, u8 data);
80 s32 e1000_get_phy_info(struct e1000_hw *hw);
81 s32 e1000_phy_hw_reset(struct e1000_hw *hw);
82 s32 e1000_phy_commit(struct e1000_hw *hw);
83 void e1000_power_up_phy(struct e1000_hw *hw);
84 void e1000_power_down_phy(struct e1000_hw *hw);
85 s32 e1000_read_mac_addr(struct e1000_hw *hw);
86 s32 e1000_read_pba_num(struct e1000_hw *hw, u32 *part_num);
87 void e1000_reload_nvm(struct e1000_hw *hw);
88 s32 e1000_update_nvm_checksum(struct e1000_hw *hw);
89 s32 e1000_validate_nvm_checksum(struct e1000_hw *hw);
90 s32 e1000_read_nvm(struct e1000_hw *hw, u16 offset, u16 words, u16 *data);
91 s32 e1000_read_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 *data);
92 s32 e1000_write_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 data);
93 s32 e1000_write_nvm(struct e1000_hw *hw, u16 offset, u16 words,
94  u16 *data);
95 s32 e1000_wait_autoneg(struct e1000_hw *hw);
96 s32 e1000_set_d3_lplu_state(struct e1000_hw *hw, bool active);
97 s32 e1000_set_d0_lplu_state(struct e1000_hw *hw, bool active);
98 bool e1000_check_mng_mode(struct e1000_hw *hw);
99 bool e1000_enable_mng_pass_thru(struct e1000_hw *hw);
100 bool e1000_enable_tx_pkt_filtering(struct e1000_hw *hw);
101 s32 e1000_mng_enable_host_if(struct e1000_hw *hw);
102 s32 e1000_mng_host_if_write(struct e1000_hw *hw,
103  u8 *buffer, u16 length, u16 offset, u8 *sum);
104 s32 e1000_mng_write_cmd_header(struct e1000_hw *hw,
105  struct e1000_host_mng_command_header *hdr);
106 s32 e1000_mng_write_dhcp_info(struct e1000_hw * hw,
107  u8 *buffer, u16 length);
108 void e1000_tbi_adjust_stats_82543(struct e1000_hw *hw,
109  struct e1000_hw_stats *stats,
110  u32 frame_len, u8 *mac_addr,
111  u32 max_frame_size);
112 void e1000_set_tbi_compatibility_82543(struct e1000_hw *hw,
113  bool state);
114 bool e1000_tbi_sbp_enabled_82543(struct e1000_hw *hw);
115 u32 e1000_translate_register_82542(u32 reg);
116 void e1000_init_script_state_82541(struct e1000_hw *hw, bool state);
117 bool e1000_get_laa_state_82571(struct e1000_hw *hw);
118 void e1000_set_laa_state_82571(struct e1000_hw *hw, bool state);
119 void e1000_set_kmrn_lock_loss_workaround_ich8lan(struct e1000_hw *hw,
120  bool state);
121 void e1000_igp3_phy_powerdown_workaround_ich8lan(struct e1000_hw *hw);
122 void e1000_gig_downshift_workaround_ich8lan(struct e1000_hw *hw);
123 
124 
125 /*
126  * TBI_ACCEPT macro definition:
127  *
128  * This macro requires:
129  * adapter = a pointer to struct e1000_hw
130  * status = the 8 bit status field of the Rx descriptor with EOP set
131  * error = the 8 bit error field of the Rx descriptor with EOP set
132  * length = the sum of all the length fields of the Rx descriptors that
133  * make up the current frame
134  * last_byte = the last byte of the frame DMAed by the hardware
135  * max_frame_length = the maximum frame length we want to accept.
136  * min_frame_length = the minimum frame length we want to accept.
137  *
138  * This macro is a conditional that should be used in the interrupt
139  * handler's Rx processing routine when RxErrors have been detected.
140  *
141  * Typical use:
142  * ...
143  * if (TBI_ACCEPT) {
144  * accept_frame = TRUE;
145  * e1000_tbi_adjust_stats(adapter, MacAddress);
146  * frame_length--;
147  * } else {
148  * accept_frame = FALSE;
149  * }
150  * ...
151  */
152 
153 /* The carrier extension symbol, as received by the NIC. */
154 #define CARRIER_EXTENSION 0x0F
155 
156 #define TBI_ACCEPT(a, status, errors, length, last_byte, min_frame_size, max_frame_size) \
157  (e1000_tbi_sbp_enabled_82543(a) && \
158  (((errors) & E1000_RXD_ERR_FRAME_ERR_MASK) == E1000_RXD_ERR_CE) && \
159  ((last_byte) == CARRIER_EXTENSION) && \
160  (((status) & E1000_RXD_STAT_VP) ? \
161  (((length) > (min_frame_size - VLAN_TAG_SIZE)) && \
162  ((length) <= (max_frame_size + 1))) : \
163  (((length) > min_frame_size) && \
164  ((length) <= (max_frame_size + VLAN_TAG_SIZE + 1)))))
165 
166 #endif