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