e1000_api.h revision 256281 
118334Speter/******************************************************************************
218334Speter
318334Speter  Copyright (c) 2001-2013, Intel Corporation
490075Sobrien  All rights reserved.
518334Speter
690075Sobrien  Redistribution and use in source and binary forms, with or without
790075Sobrien  modification, are permitted provided that the following conditions are met:
890075Sobrien
990075Sobrien   1. Redistributions of source code must retain the above copyright notice,
1018334Speter      this list of conditions and the following disclaimer.
1190075Sobrien
1290075Sobrien   2. Redistributions in binary form must reproduce the above copyright
1390075Sobrien      notice, this list of conditions and the following disclaimer in the
1490075Sobrien      documentation and/or other materials provided with the distribution.
1518334Speter
1618334Speter   3. Neither the name of the Intel Corporation nor the names of its
1790075Sobrien      contributors may be used to endorse or promote products derived from
18169689Skan      this software without specific prior written permission.
19169689Skan
2018334Speter  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
2118334Speter  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
2218334Speter  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
2318334Speter  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
2418334Speter  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
2518334Speter  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
2618334Speter  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
2718334Speter  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
2818334Speter  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
2918334Speter  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
3018334Speter  POSSIBILITY OF SUCH DAMAGE.
3118334Speter
3218334Speter******************************************************************************/
3318334Speter/*$FreeBSD: stable/10/sys/dev/e1000/e1000_api.h 247064 2013-02-21 00:25:45Z jfv $*/
3418334Speter
3518334Speter#ifndef _E1000_API_H_
3618334Speter#define _E1000_API_H_
3718334Speter
3818334Speter#include "e1000_hw.h"
3918334Speter
4018334Speterextern void e1000_init_function_pointers_82542(struct e1000_hw *hw);
4118334Speterextern void e1000_init_function_pointers_82543(struct e1000_hw *hw);
4218334Speterextern void e1000_init_function_pointers_82540(struct e1000_hw *hw);
4318334Speterextern void e1000_init_function_pointers_82571(struct e1000_hw *hw);
4418334Speterextern void e1000_init_function_pointers_82541(struct e1000_hw *hw);
4518334Speterextern void e1000_init_function_pointers_80003es2lan(struct e1000_hw *hw);
4618334Speterextern void e1000_init_function_pointers_ich8lan(struct e1000_hw *hw);
4718334Speterextern void e1000_init_function_pointers_82575(struct e1000_hw *hw);
4818334Speterextern void e1000_rx_fifo_flush_82575(struct e1000_hw *hw);
4918334Speterextern void e1000_init_function_pointers_vf(struct e1000_hw *hw);
5018334Speterextern void e1000_power_up_fiber_serdes_link(struct e1000_hw *hw);
5118334Speterextern void e1000_shutdown_fiber_serdes_link(struct e1000_hw *hw);
5218334Speterextern void e1000_init_function_pointers_i210(struct e1000_hw *hw);
5318334Speter
5418334Speters32 e1000_set_obff_timer(struct e1000_hw *hw, u32 itr);
5518334Speters32 e1000_set_mac_type(struct e1000_hw *hw);
5618334Speters32 e1000_setup_init_funcs(struct e1000_hw *hw, bool init_device);
5718334Speters32 e1000_init_mac_params(struct e1000_hw *hw);
5818334Speters32 e1000_init_nvm_params(struct e1000_hw *hw);
5918334Speters32 e1000_init_phy_params(struct e1000_hw *hw);
6018334Speters32 e1000_init_mbx_params(struct e1000_hw *hw);
6118334Speters32 e1000_get_bus_info(struct e1000_hw *hw);
6218334Spetervoid e1000_clear_vfta(struct e1000_hw *hw);
6318334Spetervoid e1000_write_vfta(struct e1000_hw *hw, u32 offset, u32 value);
6418334Speters32 e1000_force_mac_fc(struct e1000_hw *hw);
6518334Speters32 e1000_check_for_link(struct e1000_hw *hw);
6618334Speters32 e1000_reset_hw(struct e1000_hw *hw);
6718334Speters32 e1000_init_hw(struct e1000_hw *hw);
6818334Speters32 e1000_setup_link(struct e1000_hw *hw);
6918334Speters32 e1000_get_speed_and_duplex(struct e1000_hw *hw, u16 *speed, u16 *duplex);
7018334Speters32 e1000_disable_pcie_master(struct e1000_hw *hw);
7118334Spetervoid e1000_config_collision_dist(struct e1000_hw *hw);
7218334Spetervoid e1000_rar_set(struct e1000_hw *hw, u8 *addr, u32 index);
7318334Speteru32 e1000_hash_mc_addr(struct e1000_hw *hw, u8 *mc_addr);
7418334Spetervoid e1000_update_mc_addr_list(struct e1000_hw *hw, u8 *mc_addr_list,
7518334Speter			       u32 mc_addr_count);
7618334Speters32 e1000_setup_led(struct e1000_hw *hw);
7718334Speters32 e1000_cleanup_led(struct e1000_hw *hw);
7818334Speters32 e1000_check_reset_block(struct e1000_hw *hw);
7918334Speters32 e1000_blink_led(struct e1000_hw *hw);
8018334Speters32 e1000_led_on(struct e1000_hw *hw);
8118334Speters32 e1000_led_off(struct e1000_hw *hw);
8218334Speters32 e1000_id_led_init(struct e1000_hw *hw);
8318334Spetervoid e1000_reset_adaptive(struct e1000_hw *hw);
8418334Spetervoid e1000_update_adaptive(struct e1000_hw *hw);
8518334Speters32 e1000_get_cable_length(struct e1000_hw *hw);
8618334Speters32 e1000_validate_mdi_setting(struct e1000_hw *hw);
8718334Speters32 e1000_read_phy_reg(struct e1000_hw *hw, u32 offset, u16 *data);
8850397Sobriens32 e1000_write_phy_reg(struct e1000_hw *hw, u32 offset, u16 data);
8950397Sobriens32 e1000_write_8bit_ctrl_reg(struct e1000_hw *hw, u32 reg, u32 offset,
9018334Speter			      u8 data);
9118334Speters32 e1000_get_phy_info(struct e1000_hw *hw);
9218334Spetervoid e1000_release_phy(struct e1000_hw *hw);
9318334Speters32 e1000_acquire_phy(struct e1000_hw *hw);
9418334Speters32 e1000_cfg_on_link_up(struct e1000_hw *hw);
9518334Speters32 e1000_phy_hw_reset(struct e1000_hw *hw);
9618334Speters32 e1000_phy_commit(struct e1000_hw *hw);
9718334Spetervoid e1000_power_up_phy(struct e1000_hw *hw);
9818334Spetervoid e1000_power_down_phy(struct e1000_hw *hw);
9918334Speters32 e1000_read_mac_addr(struct e1000_hw *hw);
10018334Speters32 e1000_read_pba_string(struct e1000_hw *hw, u8 *pba_num, u32 pba_num_size);
10118334Speters32 e1000_read_pba_length(struct e1000_hw *hw, u32 *pba_num_size);
10218334Spetervoid e1000_reload_nvm(struct e1000_hw *hw);
10318334Speters32 e1000_update_nvm_checksum(struct e1000_hw *hw);
10418334Speters32 e1000_validate_nvm_checksum(struct e1000_hw *hw);
10518334Speters32 e1000_read_nvm(struct e1000_hw *hw, u16 offset, u16 words, u16 *data);
10618334Speters32 e1000_read_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 *data);
10718334Speters32 e1000_write_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 data);
10890075Sobriens32 e1000_write_nvm(struct e1000_hw *hw, u16 offset, u16 words, u16 *data);
10918334Speters32 e1000_set_d3_lplu_state(struct e1000_hw *hw, bool active);
11018334Speters32 e1000_set_d0_lplu_state(struct e1000_hw *hw, bool active);
11118334Speterbool e1000_check_mng_mode(struct e1000_hw *hw);
11218334Speterbool e1000_enable_tx_pkt_filtering(struct e1000_hw *hw);
11318334Speters32 e1000_mng_enable_host_if(struct e1000_hw *hw);
11418334Speters32 e1000_mng_host_if_write(struct e1000_hw *hw, u8 *buffer, u16 length,
11518334Speter			    u16 offset, u8 *sum);
11618334Speters32 e1000_mng_write_cmd_header(struct e1000_hw *hw,
11718334Speter			       struct e1000_host_mng_command_header *hdr);
11818334Speters32 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 *      adapter = a pointer to struct e1000_hw
128 *      status = the 8 bit status field of the Rx descriptor with EOP set
129 *      error = 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 *      max_frame_length = the maximum frame length we want to accept.
134 *      min_frame_length = the minimum 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