ixgbe_api.h revision 230775 
1/******************************************************************************
2
3  Copyright (c) 2001-2012, 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/ixgbe/ixgbe_api.h 230775 2012-01-30 16:42:02Z jfv $*/
34
35#ifndef _IXGBE_API_H_
36#define _IXGBE_API_H_
37
38#include "ixgbe_type.h"
39
40s32 ixgbe_init_shared_code(struct ixgbe_hw *hw);
41
42extern s32 ixgbe_init_ops_82598(struct ixgbe_hw *hw);
43extern s32 ixgbe_init_ops_82599(struct ixgbe_hw *hw);
44extern s32 ixgbe_init_ops_X540(struct ixgbe_hw *hw);
45extern s32 ixgbe_init_ops_vf(struct ixgbe_hw *hw);
46
47s32 ixgbe_set_mac_type(struct ixgbe_hw *hw);
48s32 ixgbe_init_hw(struct ixgbe_hw *hw);
49s32 ixgbe_reset_hw(struct ixgbe_hw *hw);
50s32 ixgbe_start_hw(struct ixgbe_hw *hw);
51void ixgbe_enable_relaxed_ordering(struct ixgbe_hw *hw);
52s32 ixgbe_clear_hw_cntrs(struct ixgbe_hw *hw);
53enum ixgbe_media_type ixgbe_get_media_type(struct ixgbe_hw *hw);
54s32 ixgbe_get_mac_addr(struct ixgbe_hw *hw, u8 *mac_addr);
55s32 ixgbe_get_bus_info(struct ixgbe_hw *hw);
56u32 ixgbe_get_num_of_tx_queues(struct ixgbe_hw *hw);
57u32 ixgbe_get_num_of_rx_queues(struct ixgbe_hw *hw);
58s32 ixgbe_stop_adapter(struct ixgbe_hw *hw);
59s32 ixgbe_read_pba_num(struct ixgbe_hw *hw, u32 *pba_num);
60s32 ixgbe_read_pba_string(struct ixgbe_hw *hw, u8 *pba_num, u32 pba_num_size);
61
62s32 ixgbe_identify_phy(struct ixgbe_hw *hw);
63s32 ixgbe_reset_phy(struct ixgbe_hw *hw);
64s32 ixgbe_read_phy_reg(struct ixgbe_hw *hw, u32 reg_addr, u32 device_type,
65		       u16 *phy_data);
66s32 ixgbe_write_phy_reg(struct ixgbe_hw *hw, u32 reg_addr, u32 device_type,
67			u16 phy_data);
68
69s32 ixgbe_setup_phy_link(struct ixgbe_hw *hw);
70s32 ixgbe_check_phy_link(struct ixgbe_hw *hw,
71			 ixgbe_link_speed *speed,
72			 bool *link_up);
73s32 ixgbe_setup_phy_link_speed(struct ixgbe_hw *hw,
74			       ixgbe_link_speed speed,
75			       bool autoneg,
76			       bool autoneg_wait_to_complete);
77void ixgbe_disable_tx_laser(struct ixgbe_hw *hw);
78void ixgbe_enable_tx_laser(struct ixgbe_hw *hw);
79void ixgbe_flap_tx_laser(struct ixgbe_hw *hw);
80s32 ixgbe_setup_link(struct ixgbe_hw *hw, ixgbe_link_speed speed,
81		     bool autoneg, bool autoneg_wait_to_complete);
82s32 ixgbe_check_link(struct ixgbe_hw *hw, ixgbe_link_speed *speed,
83		     bool *link_up, bool link_up_wait_to_complete);
84s32 ixgbe_get_link_capabilities(struct ixgbe_hw *hw, ixgbe_link_speed *speed,
85				bool *autoneg);
86s32 ixgbe_led_on(struct ixgbe_hw *hw, u32 index);
87s32 ixgbe_led_off(struct ixgbe_hw *hw, u32 index);
88s32 ixgbe_blink_led_start(struct ixgbe_hw *hw, u32 index);
89s32 ixgbe_blink_led_stop(struct ixgbe_hw *hw, u32 index);
90
91s32 ixgbe_init_eeprom_params(struct ixgbe_hw *hw);
92s32 ixgbe_write_eeprom(struct ixgbe_hw *hw, u16 offset, u16 data);
93s32 ixgbe_write_eeprom_buffer(struct ixgbe_hw *hw, u16 offset,
94			      u16 words, u16 *data);
95s32 ixgbe_read_eeprom(struct ixgbe_hw *hw, u16 offset, u16 *data);
96s32 ixgbe_read_eeprom_buffer(struct ixgbe_hw *hw, u16 offset,
97			     u16 words, u16 *data);
98
99s32 ixgbe_validate_eeprom_checksum(struct ixgbe_hw *hw, u16 *checksum_val);
100s32 ixgbe_update_eeprom_checksum(struct ixgbe_hw *hw);
101
102s32 ixgbe_insert_mac_addr(struct ixgbe_hw *hw, u8 *addr, u32 vmdq);
103s32 ixgbe_set_rar(struct ixgbe_hw *hw, u32 index, u8 *addr, u32 vmdq,
104		  u32 enable_addr);
105s32 ixgbe_clear_rar(struct ixgbe_hw *hw, u32 index);
106s32 ixgbe_set_vmdq(struct ixgbe_hw *hw, u32 rar, u32 vmdq);
107s32 ixgbe_clear_vmdq(struct ixgbe_hw *hw, u32 rar, u32 vmdq);
108s32 ixgbe_init_rx_addrs(struct ixgbe_hw *hw);
109u32 ixgbe_get_num_rx_addrs(struct ixgbe_hw *hw);
110s32 ixgbe_update_uc_addr_list(struct ixgbe_hw *hw, u8 *addr_list,
111			      u32 addr_count, ixgbe_mc_addr_itr func);
112s32 ixgbe_update_mc_addr_list(struct ixgbe_hw *hw, u8 *mc_addr_list,
113			      u32 mc_addr_count, ixgbe_mc_addr_itr func,
114			      bool clear);
115void ixgbe_add_uc_addr(struct ixgbe_hw *hw, u8 *addr_list, u32 vmdq);
116s32 ixgbe_enable_mc(struct ixgbe_hw *hw);
117s32 ixgbe_disable_mc(struct ixgbe_hw *hw);
118s32 ixgbe_clear_vfta(struct ixgbe_hw *hw);
119s32 ixgbe_set_vfta(struct ixgbe_hw *hw, u32 vlan,
120		   u32 vind, bool vlan_on);
121s32 ixgbe_set_vlvf(struct ixgbe_hw *hw, u32 vlan, u32 vind,
122		   bool vlan_on, bool *vfta_changed);
123s32 ixgbe_fc_enable(struct ixgbe_hw *hw, s32 packetbuf_num);
124s32 ixgbe_set_fw_drv_ver(struct ixgbe_hw *hw, u8 maj, u8 min, u8 build,
125			 u8 ver);
126void ixgbe_set_mta(struct ixgbe_hw *hw, u8 *mc_addr);
127s32 ixgbe_get_phy_firmware_version(struct ixgbe_hw *hw,
128				   u16 *firmware_version);
129s32 ixgbe_read_analog_reg8(struct ixgbe_hw *hw, u32 reg, u8 *val);
130s32 ixgbe_write_analog_reg8(struct ixgbe_hw *hw, u32 reg, u8 val);
131s32 ixgbe_init_uta_tables(struct ixgbe_hw *hw);
132s32 ixgbe_read_i2c_eeprom(struct ixgbe_hw *hw, u8 byte_offset, u8 *eeprom_data);
133u32 ixgbe_get_supported_physical_layer(struct ixgbe_hw *hw);
134s32 ixgbe_enable_rx_dma(struct ixgbe_hw *hw, u32 regval);
135s32 ixgbe_disable_sec_rx_path(struct ixgbe_hw *hw);
136s32 ixgbe_enable_sec_rx_path(struct ixgbe_hw *hw);
137s32 ixgbe_reinit_fdir_tables_82599(struct ixgbe_hw *hw);
138s32 ixgbe_init_fdir_signature_82599(struct ixgbe_hw *hw, u32 fdirctrl);
139s32 ixgbe_init_fdir_perfect_82599(struct ixgbe_hw *hw, u32 fdirctrl);
140s32 ixgbe_fdir_add_signature_filter_82599(struct ixgbe_hw *hw,
141					  union ixgbe_atr_hash_dword input,
142					  union ixgbe_atr_hash_dword common,
143					  u8 queue);
144s32 ixgbe_fdir_set_input_mask_82599(struct ixgbe_hw *hw,
145				    union ixgbe_atr_input *input_mask);
146s32 ixgbe_fdir_write_perfect_filter_82599(struct ixgbe_hw *hw,
147					  union ixgbe_atr_input *input,
148					  u16 soft_id, u8 queue);
149s32 ixgbe_fdir_erase_perfect_filter_82599(struct ixgbe_hw *hw,
150					  union ixgbe_atr_input *input,
151					  u16 soft_id);
152s32 ixgbe_fdir_add_perfect_filter_82599(struct ixgbe_hw *hw,
153					union ixgbe_atr_input *input,
154					union ixgbe_atr_input *mask,
155					u16 soft_id,
156					u8 queue);
157void ixgbe_atr_compute_perfect_hash_82599(union ixgbe_atr_input *input,
158					  union ixgbe_atr_input *mask);
159u32 ixgbe_atr_compute_sig_hash_82599(union ixgbe_atr_hash_dword input,
160				     union ixgbe_atr_hash_dword common);
161s32 ixgbe_read_i2c_byte(struct ixgbe_hw *hw, u8 byte_offset, u8 dev_addr,
162			u8 *data);
163s32 ixgbe_write_i2c_byte(struct ixgbe_hw *hw, u8 byte_offset, u8 dev_addr,
164			 u8 data);
165s32 ixgbe_write_i2c_eeprom(struct ixgbe_hw *hw, u8 byte_offset, u8 eeprom_data);
166s32 ixgbe_get_san_mac_addr(struct ixgbe_hw *hw, u8 *san_mac_addr);
167s32 ixgbe_set_san_mac_addr(struct ixgbe_hw *hw, u8 *san_mac_addr);
168s32 ixgbe_get_device_caps(struct ixgbe_hw *hw, u16 *device_caps);
169s32 ixgbe_acquire_swfw_semaphore(struct ixgbe_hw *hw, u16 mask);
170void ixgbe_release_swfw_semaphore(struct ixgbe_hw *hw, u16 mask);
171s32 ixgbe_get_wwn_prefix(struct ixgbe_hw *hw, u16 *wwnn_prefix,
172			 u16 *wwpn_prefix);
173s32 ixgbe_get_fcoe_boot_status(struct ixgbe_hw *hw, u16 *bs);
174
175#endif /* _IXGBE_API_H_ */
176