1/*******************************************************************************
2
3Copyright (c) 2001-2015, Intel Corporation
4All rights reserved.
5
6Redistribution and use in source and binary forms, with or without
7modification, 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
20THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
24LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30POSSIBILITY OF SUCH DAMAGE.
31
32***************************************************************************/
33
34#ifndef _E1000_API_H_
35#define _E1000_API_H_
36
37#include "e1000_hw.h"
38
39extern void e1000_init_function_pointers_82542(struct e1000_hw *hw);
40extern void e1000_init_function_pointers_82543(struct e1000_hw *hw);
41extern void e1000_init_function_pointers_82540(struct e1000_hw *hw);
42extern void e1000_init_function_pointers_82571(struct e1000_hw *hw);
43extern void e1000_init_function_pointers_82541(struct e1000_hw *hw);
44extern void e1000_init_function_pointers_80003es2lan(struct e1000_hw *hw);
45extern void e1000_init_function_pointers_ich8lan(struct e1000_hw *hw);
46extern void e1000_init_function_pointers_82575(struct e1000_hw *hw);
47extern void e1000_rx_fifo_flush_82575(struct e1000_hw *hw);
48extern void e1000_init_function_pointers_vf(struct e1000_hw *hw);
49extern void e1000_power_up_fiber_serdes_link(struct e1000_hw *hw);
50extern void e1000_shutdown_fiber_serdes_link(struct e1000_hw *hw);
51extern void e1000_init_function_pointers_i210(struct e1000_hw *hw);
52
53s32 e1000_set_obff_timer(struct e1000_hw *hw, u32 itr);
54s32 e1000_set_mac_type(struct e1000_hw *hw);
55s32 e1000_setup_init_funcs(struct e1000_hw *hw, bool init_device);
56s32 e1000_init_mac_params(struct e1000_hw *hw);
57s32 e1000_init_nvm_params(struct e1000_hw *hw);
58s32 e1000_init_phy_params(struct e1000_hw *hw);
59s32 e1000_init_mbx_params(struct e1000_hw *hw);
60s32 e1000_get_bus_info(struct e1000_hw *hw);
61void e1000_clear_vfta(struct e1000_hw *hw);
62void e1000_write_vfta(struct e1000_hw *hw, u32 offset, u32 value);
63s32 e1000_force_mac_fc(struct e1000_hw *hw);
64s32 e1000_check_for_link(struct e1000_hw *hw);
65s32 e1000_reset_hw(struct e1000_hw *hw);
66s32 e1000_init_hw(struct e1000_hw *hw);
67s32 e1000_setup_link(struct e1000_hw *hw);
68s32 e1000_get_speed_and_duplex(struct e1000_hw *hw, u16 *speed, u16 *duplex);
69s32 e1000_disable_pcie_master(struct e1000_hw *hw);
70void e1000_config_collision_dist(struct e1000_hw *hw);
71int e1000_rar_set(struct e1000_hw *hw, u8 *addr, u32 index);
72u32 e1000_hash_mc_addr(struct e1000_hw *hw, u8 *mc_addr);
73void e1000_update_mc_addr_list(struct e1000_hw *hw, u8 *mc_addr_list,
74			       u32 mc_addr_count);
75s32 e1000_setup_led(struct e1000_hw *hw);
76s32 e1000_cleanup_led(struct e1000_hw *hw);
77s32 e1000_check_reset_block(struct e1000_hw *hw);
78s32 e1000_blink_led(struct e1000_hw *hw);
79s32 e1000_led_on(struct e1000_hw *hw);
80s32 e1000_led_off(struct e1000_hw *hw);
81s32 e1000_id_led_init(struct e1000_hw *hw);
82void e1000_reset_adaptive(struct e1000_hw *hw);
83void e1000_update_adaptive(struct e1000_hw *hw);
84s32 e1000_get_cable_length(struct e1000_hw *hw);
85s32 e1000_validate_mdi_setting(struct e1000_hw *hw);
86s32 e1000_read_phy_reg(struct e1000_hw *hw, u32 offset, u16 *data);
87s32 e1000_write_phy_reg(struct e1000_hw *hw, u32 offset, u16 data);
88s32 e1000_write_8bit_ctrl_reg(struct e1000_hw *hw, u32 reg, u32 offset,
89			      u8 data);
90s32 e1000_get_phy_info(struct e1000_hw *hw);
91void e1000_release_phy(struct e1000_hw *hw);
92s32 e1000_acquire_phy(struct e1000_hw *hw);
93s32 e1000_cfg_on_link_up(struct e1000_hw *hw);
94s32 e1000_phy_hw_reset(struct e1000_hw *hw);
95s32 e1000_phy_commit(struct e1000_hw *hw);
96void e1000_power_up_phy(struct e1000_hw *hw);
97void e1000_power_down_phy(struct e1000_hw *hw);
98s32 e1000_read_mac_addr(struct e1000_hw *hw);
99s32 e1000_read_pba_num(struct e1000_hw *hw, u32 *part_num);
100s32 e1000_read_pba_string(struct e1000_hw *hw, u8 *pba_num, u32 pba_num_size);
101s32 e1000_read_pba_length(struct e1000_hw *hw, u32 *pba_num_size);
102void e1000_reload_nvm(struct e1000_hw *hw);
103s32 e1000_update_nvm_checksum(struct e1000_hw *hw);
104s32 e1000_validate_nvm_checksum(struct e1000_hw *hw);
105s32 e1000_read_nvm(struct e1000_hw *hw, u16 offset, u16 words, u16 *data);
106s32 e1000_read_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 *data);
107s32 e1000_write_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 data);
108s32 e1000_write_nvm(struct e1000_hw *hw, u16 offset, u16 words, u16 *data);
109s32 e1000_set_d3_lplu_state(struct e1000_hw *hw, bool active);
110s32 e1000_set_d0_lplu_state(struct e1000_hw *hw, bool active);
111bool e1000_check_mng_mode(struct e1000_hw *hw);
112bool e1000_enable_tx_pkt_filtering(struct e1000_hw *hw);
113s32 e1000_mng_enable_host_if(struct e1000_hw *hw);
114s32 e1000_mng_host_if_write(struct e1000_hw *hw, u8 *buffer, u16 length,
115			    u16 offset, u8 *sum);
116s32 e1000_mng_write_cmd_header(struct e1000_hw *hw,
117			       struct e1000_host_mng_command_header *hdr);
118s32 e1000_mng_write_dhcp_info(struct e1000_hw *hw, u8 *buffer, u16 length);
119u32  e1000_translate_register_82542(u32 reg);
120
121
122
123/*
124 * TBI_ACCEPT macro definition:
125 *
126 * This macro requires:
127 *      a = a pointer to struct e1000_hw
128 *      status = the 8 bit status field of the Rx descriptor with EOP set
129 *      errors = the 8 bit error field of the Rx descriptor with EOP set
130 *      length = the sum of all the length fields of the Rx descriptors that
131 *               make up the current frame
132 *      last_byte = the last byte of the frame DMAed by the hardware
133 *      min_frame_size = the minimum frame length we want to accept.
134 *      max_frame_size = the maximum frame length we want to accept.
135 *
136 * This macro is a conditional that should be used in the interrupt
137 * handler's Rx processing routine when RxErrors have been detected.
138 *
139 * Typical use:
140 *  ...
141 *  if (TBI_ACCEPT) {
142 *      accept_frame = true;
143 *      e1000_tbi_adjust_stats(adapter, MacAddress);
144 *      frame_length--;
145 *  } else {
146 *      accept_frame = false;
147 *  }
148 *  ...
149 */
150
151/* The carrier extension symbol, as received by the NIC. */
152#define CARRIER_EXTENSION   0x0F
153
154#define TBI_ACCEPT(a, status, errors, length, last_byte, \
155		   min_frame_size, max_frame_size) \
156	(e1000_tbi_sbp_enabled_82543(a) && \
157	 (((errors) & E1000_RXD_ERR_FRAME_ERR_MASK) == E1000_RXD_ERR_CE) && \
158	 ((last_byte) == CARRIER_EXTENSION) && \
159	 (((status) & E1000_RXD_STAT_VP) ? \
160	  (((length) > ((min_frame_size) - VLAN_TAG_SIZE)) && \
161	  ((length) <= ((max_frame_size) + 1))) : \
162	  (((length) > (min_frame_size)) && \
163	  ((length) <= ((max_frame_size) + VLAN_TAG_SIZE + 1)))))
164
165#define E1000_MAX(a, b) ((a) > (b) ? (a) : (b))
166#define E1000_DIVIDE_ROUND_UP(a, b)	(((a) + (b) - 1) / (b)) /* ceil(a/b) */
167#endif /* _E1000_API_H_ */
168