e1000_api.h revision 169240 
1/*******************************************************************************
2
3  Copyright (c) 2001-2007, Intel Corporation
4  All rights reserved.
5
6  Redistribution and use in source and binary forms, with or without
7  modification, are permitted provided that the following conditions are met:
8
9   1. Redistributions of source code must retain the above copyright notice,
10      this list of conditions and the following disclaimer.
11
12   2. Redistributions in binary form must reproduce the above copyright
13      notice, this list of conditions and the following disclaimer in the
14      documentation and/or other materials provided with the distribution.
15
16   3. Neither the name of the Intel Corporation nor the names of its
17      contributors may be used to endorse or promote products derived from
18      this software without specific prior written permission.
19
20  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
24  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  POSSIBILITY OF SUCH DAMAGE.
31
32*******************************************************************************/
33$FreeBSD: head/sys/dev/em/e1000_api.h 169240 2007-05-04 00:00:12Z jfv $
34
35
36#ifndef _E1000_API_H_
37#define _E1000_API_H_
38
39#include "e1000_hw.h"
40
41s32       e1000_set_mac_type(struct e1000_hw *hw);
42s32       e1000_setup_init_funcs(struct e1000_hw *hw, boolean_t init_device);
43s32       e1000_init_mac_params(struct e1000_hw *hw);
44s32       e1000_init_nvm_params(struct e1000_hw *hw);
45s32       e1000_init_phy_params(struct e1000_hw *hw);
46void      e1000_remove_device(struct e1000_hw *hw);
47s32       e1000_get_bus_info(struct e1000_hw *hw);
48void      e1000_clear_vfta(struct e1000_hw *hw);
49void      e1000_write_vfta(struct e1000_hw *hw, u32 offset, u32 value);
50s32       e1000_force_mac_fc(struct e1000_hw *hw);
51s32       e1000_check_for_link(struct e1000_hw *hw);
52s32       e1000_reset_hw(struct e1000_hw *hw);
53s32       e1000_init_hw(struct e1000_hw *hw);
54s32       e1000_setup_link(struct e1000_hw *hw);
55s32       e1000_get_speed_and_duplex(struct e1000_hw *hw, u16 *speed,
56                                     u16 *duplex);
57s32       e1000_disable_pcie_master(struct e1000_hw *hw);
58void      e1000_config_collision_dist(struct e1000_hw *hw);
59void      e1000_rar_set(struct e1000_hw *hw, u8 *addr, u32 index);
60void      e1000_mta_set(struct e1000_hw *hw, u32 hash_value);
61u32       e1000_hash_mc_addr(struct e1000_hw *hw, u8 *mc_addr);
62void      e1000_mc_addr_list_update(struct e1000_hw *hw,
63                                    u8 *mc_addr_list, u32 mc_addr_count,
64                                    u32 rar_used_count, u32 rar_count);
65s32       e1000_setup_led(struct e1000_hw *hw);
66s32       e1000_cleanup_led(struct e1000_hw *hw);
67s32       e1000_check_reset_block(struct e1000_hw *hw);
68s32       e1000_blink_led(struct e1000_hw *hw);
69s32       e1000_led_on(struct e1000_hw *hw);
70s32       e1000_led_off(struct e1000_hw *hw);
71void      e1000_reset_adaptive(struct e1000_hw *hw);
72void      e1000_update_adaptive(struct e1000_hw *hw);
73s32       e1000_get_cable_length(struct e1000_hw *hw);
74s32       e1000_validate_mdi_setting(struct e1000_hw *hw);
75s32       e1000_read_phy_reg(struct e1000_hw *hw, u32 offset, u16 *data);
76s32       e1000_write_phy_reg(struct e1000_hw *hw, u32 offset, u16 data);
77s32       e1000_write_8bit_ctrl_reg(struct e1000_hw *hw, u32 reg,
78                                 u32 offset, u8 data);
79s32       e1000_get_phy_info(struct e1000_hw *hw);
80s32       e1000_phy_hw_reset(struct e1000_hw *hw);
81s32       e1000_phy_commit(struct e1000_hw *hw);
82s32       e1000_read_mac_addr(struct e1000_hw *hw);
83s32       e1000_read_part_num(struct e1000_hw *hw, u32 *part_num);
84void      e1000_reload_nvm(struct e1000_hw *hw);
85s32       e1000_update_nvm_checksum(struct e1000_hw *hw);
86s32       e1000_validate_nvm_checksum(struct e1000_hw *hw);
87s32       e1000_read_nvm(struct e1000_hw *hw, u16 offset, u16 words, u16 *data);
88s32       e1000_read_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 *data);
89s32       e1000_write_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 data);
90s32       e1000_write_nvm(struct e1000_hw *hw, u16 offset, u16 words,
91                          u16 *data);
92s32       e1000_wait_autoneg(struct e1000_hw *hw);
93s32       e1000_set_d3_lplu_state(struct e1000_hw *hw, boolean_t active);
94s32       e1000_set_d0_lplu_state(struct e1000_hw *hw, boolean_t active);
95boolean_t e1000_check_mng_mode(struct e1000_hw *hw);
96boolean_t e1000_enable_mng_pass_thru(struct e1000_hw *hw);
97boolean_t e1000_enable_tx_pkt_filtering(struct e1000_hw *hw);
98s32       e1000_mng_enable_host_if(struct e1000_hw *hw);
99s32       e1000_mng_host_if_write(struct e1000_hw *hw,
100                                  u8 *buffer, u16 length, u16 offset, u8 *sum);
101s32       e1000_mng_write_cmd_header(struct e1000_hw *hw,
102                                     struct e1000_host_mng_command_header *hdr);
103s32       e1000_mng_write_dhcp_info(struct e1000_hw * hw,
104                                    u8 *buffer, u16 length);
105void      e1000_tbi_adjust_stats_82543(struct e1000_hw *hw,
106                                       struct e1000_hw_stats *stats,
107                                       u32 frame_len, u8 *mac_addr);
108void      e1000_set_tbi_compatibility_82543(struct e1000_hw *hw,
109                                            boolean_t state);
110boolean_t e1000_tbi_sbp_enabled_82543(struct e1000_hw *hw);
111#ifndef NO_82542_SUPPORT
112u32       e1000_translate_register_82542(u32 reg);
113#endif
114void      e1000_init_script_state_82541(struct e1000_hw *hw, boolean_t state);
115boolean_t e1000_get_laa_state_82571(struct e1000_hw *hw);
116void      e1000_set_laa_state_82571(struct e1000_hw *hw, boolean_t state);
117void      e1000_set_kmrn_lock_loss_workaround_ich8lan(struct e1000_hw *hw,
118                                                      boolean_t state);
119void      e1000_igp3_phy_powerdown_workaround_ich8lan(struct e1000_hw *hw);
120void      e1000_gig_downshift_workaround_ich8lan(struct e1000_hw *hw);
121u32       e1000_translate_register_adoram(u32 reg);
122
123/* TBI_ACCEPT macro definition:
124 *
125 * This macro requires:
126 *      adapter = a pointer to struct e1000_hw
127 *      status = the 8 bit status field of the RX descriptor with EOP set
128 *      error = the 8 bit error field of the RX descriptor with EOP set
129 *      length = the sum of all the length fields of the RX descriptors that
130 *               make up the current frame
131 *      last_byte = the last byte of the frame DMAed by the hardware
132 *      max_frame_length = the maximum frame length we want to accept.
133 *      min_frame_length = the minimum frame length we want to accept.
134 *
135 * This macro is a conditional that should be used in the interrupt
136 * handler's Rx processing routine when RxErrors have been detected.
137 *
138 * Typical use:
139 *  ...
140 *  if (TBI_ACCEPT) {
141 *      accept_frame = TRUE;
142 *      e1000_tbi_adjust_stats(adapter, MacAddress);
143 *      frame_length--;
144 *  } else {
145 *      accept_frame = FALSE;
146 *  }
147 *  ...
148 */
149
150/* The carrier extension symbol, as received by the NIC. */
151#define CARRIER_EXTENSION   0x0F
152
153#define TBI_ACCEPT(a, status, errors, length, last_byte) \
154    (e1000_tbi_sbp_enabled_82543(a) && \
155     (((errors) & E1000_RXD_ERR_FRAME_ERR_MASK) == E1000_RXD_ERR_CE) && \
156     ((last_byte) == CARRIER_EXTENSION) && \
157     (((status) & E1000_RXD_STAT_VP) ? \
158          (((length) > ((a)->mac.min_frame_size - VLAN_TAG_SIZE)) && \
159           ((length) <= ((a)->mac.max_frame_size + 1))) : \
160          (((length) > (a)->mac.min_frame_size) && \
161           ((length) <= ((a)->mac.max_frame_size + VLAN_TAG_SIZE + 1)))))
162
163#endif
164