xref: /freebsd/sys/dev/ixl/i40e_prototype.h (revision 71625ec9ad2a9bc8c09784fbd23b759830e0ee5f)
1 /******************************************************************************
2 
3   Copyright (c) 2013-2018, 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 
34 #ifndef _I40E_PROTOTYPE_H_
35 #define _I40E_PROTOTYPE_H_
36 
37 #include "i40e_type.h"
38 #include "i40e_alloc.h"
39 #include "virtchnl.h"
40 
41 /* Prototypes for shared code functions that are not in
42  * the standard function pointer structures.  These are
43  * mostly because they are needed even before the init
44  * has happened and will assist in the early SW and FW
45  * setup.
46  */
47 
48 /* adminq functions */
49 enum i40e_status_code i40e_init_adminq(struct i40e_hw *hw);
50 enum i40e_status_code i40e_shutdown_adminq(struct i40e_hw *hw);
51 enum i40e_status_code i40e_init_asq(struct i40e_hw *hw);
52 enum i40e_status_code i40e_init_arq(struct i40e_hw *hw);
53 enum i40e_status_code i40e_alloc_adminq_asq_ring(struct i40e_hw *hw);
54 enum i40e_status_code i40e_alloc_adminq_arq_ring(struct i40e_hw *hw);
55 enum i40e_status_code i40e_shutdown_asq(struct i40e_hw *hw);
56 enum i40e_status_code i40e_shutdown_arq(struct i40e_hw *hw);
57 u16 i40e_clean_asq(struct i40e_hw *hw);
58 void i40e_free_adminq_asq(struct i40e_hw *hw);
59 void i40e_free_adminq_arq(struct i40e_hw *hw);
60 enum i40e_status_code i40e_validate_mac_addr(u8 *mac_addr);
61 void i40e_adminq_init_ring_data(struct i40e_hw *hw);
62 enum i40e_status_code i40e_clean_arq_element(struct i40e_hw *hw,
63 					     struct i40e_arq_event_info *e,
64 					     u16 *events_pending);
65 enum i40e_status_code i40e_asq_send_command(struct i40e_hw *hw,
66 				struct i40e_aq_desc *desc,
67 				void *buff, /* can be NULL */
68 				u16  buff_size,
69 				struct i40e_asq_cmd_details *cmd_details);
70 bool i40e_asq_done(struct i40e_hw *hw);
71 
72 /* debug function for adminq */
73 void i40e_debug_aq(struct i40e_hw *hw, enum i40e_debug_mask mask,
74 		   void *desc, void *buffer, u16 buf_len);
75 
76 void i40e_idle_aq(struct i40e_hw *hw);
77 bool i40e_check_asq_alive(struct i40e_hw *hw);
78 enum i40e_status_code i40e_aq_queue_shutdown(struct i40e_hw *hw, bool unloading);
79 
80 enum i40e_status_code i40e_aq_get_rss_lut(struct i40e_hw *hw, u16 seid,
81 					  bool pf_lut, u8 *lut, u16 lut_size);
82 enum i40e_status_code i40e_aq_set_rss_lut(struct i40e_hw *hw, u16 seid,
83 					  bool pf_lut, u8 *lut, u16 lut_size);
84 enum i40e_status_code i40e_aq_get_rss_key(struct i40e_hw *hw,
85 				     u16 seid,
86 				     struct i40e_aqc_get_set_rss_key_data *key);
87 enum i40e_status_code i40e_aq_set_rss_key(struct i40e_hw *hw,
88 				     u16 seid,
89 				     struct i40e_aqc_get_set_rss_key_data *key);
90 const char *i40e_aq_str(struct i40e_hw *hw, enum i40e_admin_queue_err aq_err);
91 const char *i40e_stat_str(struct i40e_hw *hw, enum i40e_status_code stat_err);
92 
93 
94 u32 i40e_led_get(struct i40e_hw *hw);
95 void i40e_led_set(struct i40e_hw *hw, u32 mode, bool blink);
96 enum i40e_status_code i40e_led_set_phy(struct i40e_hw *hw, bool on,
97 				       u16 led_addr, u32 mode);
98 enum i40e_status_code i40e_led_get_phy(struct i40e_hw *hw, u16 *led_addr,
99 				       u16 *val);
100 enum i40e_status_code i40e_blink_phy_link_led(struct i40e_hw *hw,
101 					      u32 time, u32 interval);
102 enum i40e_status_code i40e_led_get_reg(struct i40e_hw *hw, u16 led_addr,
103 				       u32 *reg_val);
104 enum i40e_status_code i40e_led_set_reg(struct i40e_hw *hw, u16 led_addr,
105 				       u32 reg_val);
106 enum i40e_status_code i40e_get_phy_lpi_status(struct i40e_hw *hw,
107 					      struct i40e_hw_port_stats *stats);
108 enum i40e_status_code i40e_get_lpi_counters(struct i40e_hw *hw, u32 *tx_counter,
109 					    u32 *rx_counter, bool *is_clear);
110 enum i40e_status_code i40e_lpi_stat_update(struct i40e_hw *hw,
111 					   bool offset_loaded, u64 *tx_offset,
112 					   u64 *tx_stat, u64 *rx_offset,
113 					   u64 *rx_stat);
114 enum i40e_status_code i40e_get_lpi_duration(struct i40e_hw *hw,
115 					    struct i40e_hw_port_stats *stat,
116 					    u64 *tx_duration, u64 *rx_duration);
117 /* admin send queue commands */
118 
119 enum i40e_status_code i40e_aq_get_firmware_version(struct i40e_hw *hw,
120 				u16 *fw_major_version, u16 *fw_minor_version,
121 				u32 *fw_build,
122 				u16 *api_major_version, u16 *api_minor_version,
123 				struct i40e_asq_cmd_details *cmd_details);
124 enum i40e_status_code i40e_aq_debug_write_register(struct i40e_hw *hw,
125 				u32 reg_addr, u64 reg_val,
126 				struct i40e_asq_cmd_details *cmd_details);
127 enum i40e_status_code i40e_aq_debug_read_register(struct i40e_hw *hw,
128 				u32  reg_addr, u64 *reg_val,
129 				struct i40e_asq_cmd_details *cmd_details);
130 enum i40e_status_code i40e_aq_set_phy_debug(struct i40e_hw *hw, u8 cmd_flags,
131 				struct i40e_asq_cmd_details *cmd_details);
132 enum i40e_status_code i40e_aq_set_default_vsi(struct i40e_hw *hw, u16 vsi_id,
133 				struct i40e_asq_cmd_details *cmd_details);
134 enum i40e_status_code i40e_aq_clear_default_vsi(struct i40e_hw *hw, u16 vsi_id,
135 				struct i40e_asq_cmd_details *cmd_details);
136 enum i40e_status_code i40e_aq_get_phy_capabilities(struct i40e_hw *hw,
137 			bool qualified_modules, bool report_init,
138 			struct i40e_aq_get_phy_abilities_resp *abilities,
139 			struct i40e_asq_cmd_details *cmd_details);
140 enum i40e_status_code i40e_aq_set_phy_config(struct i40e_hw *hw,
141 				struct i40e_aq_set_phy_config *config,
142 				struct i40e_asq_cmd_details *cmd_details);
143 enum i40e_status_code i40e_set_fc(struct i40e_hw *hw, u8 *aq_failures,
144 				  bool atomic_reset);
145 enum i40e_status_code i40e_aq_set_phy_int_mask(struct i40e_hw *hw, u16 mask,
146 				struct i40e_asq_cmd_details *cmd_details);
147 enum i40e_status_code i40e_aq_set_mac_config(struct i40e_hw *hw,
148 				u16 max_frame_size, bool crc_en, u16 pacing,
149 				bool auto_drop_blocking_packets,
150 				struct i40e_asq_cmd_details *cmd_details);
151 enum i40e_status_code i40e_aq_get_local_advt_reg(struct i40e_hw *hw,
152 				u64 *advt_reg,
153 				struct i40e_asq_cmd_details *cmd_details);
154 enum i40e_status_code i40e_aq_get_partner_advt(struct i40e_hw *hw,
155 				u64 *advt_reg,
156 				struct i40e_asq_cmd_details *cmd_details);
157 enum i40e_status_code
158 i40e_aq_set_lb_modes(struct i40e_hw *hw, u8 lb_level, u8 lb_type, u8 speed,
159 		     struct i40e_asq_cmd_details *cmd_details);
160 enum i40e_status_code i40e_aq_clear_pxe_mode(struct i40e_hw *hw,
161 			struct i40e_asq_cmd_details *cmd_details);
162 enum i40e_status_code i40e_aq_set_link_restart_an(struct i40e_hw *hw,
163 		bool enable_link, struct i40e_asq_cmd_details *cmd_details);
164 enum i40e_status_code i40e_aq_get_link_info(struct i40e_hw *hw,
165 				bool enable_lse, struct i40e_link_status *link,
166 				struct i40e_asq_cmd_details *cmd_details);
167 enum i40e_status_code i40e_aq_set_local_advt_reg(struct i40e_hw *hw,
168 				u64 advt_reg,
169 				struct i40e_asq_cmd_details *cmd_details);
170 enum i40e_status_code i40e_aq_send_driver_version(struct i40e_hw *hw,
171 				struct i40e_driver_version *dv,
172 				struct i40e_asq_cmd_details *cmd_details);
173 enum i40e_status_code i40e_aq_add_vsi(struct i40e_hw *hw,
174 				struct i40e_vsi_context *vsi_ctx,
175 				struct i40e_asq_cmd_details *cmd_details);
176 enum i40e_status_code i40e_aq_set_vsi_broadcast(struct i40e_hw *hw,
177 				u16 vsi_id, bool set_filter,
178 				struct i40e_asq_cmd_details *cmd_details);
179 enum i40e_status_code i40e_aq_set_vsi_unicast_promiscuous(struct i40e_hw *hw,
180 		u16 vsi_id, bool set, struct i40e_asq_cmd_details *cmd_details,
181 		bool rx_only_promisc);
182 enum i40e_status_code i40e_aq_set_vsi_multicast_promiscuous(struct i40e_hw *hw,
183 		u16 vsi_id, bool set, struct i40e_asq_cmd_details *cmd_details);
184 enum i40e_status_code i40e_aq_set_vsi_full_promiscuous(struct i40e_hw *hw,
185 				u16 seid, bool set,
186 				struct i40e_asq_cmd_details *cmd_details);
187 enum i40e_status_code i40e_aq_set_vsi_mc_promisc_on_vlan(struct i40e_hw *hw,
188 				u16 seid, bool enable, u16 vid,
189 				struct i40e_asq_cmd_details *cmd_details);
190 enum i40e_status_code i40e_aq_set_vsi_uc_promisc_on_vlan(struct i40e_hw *hw,
191 				u16 seid, bool enable, u16 vid,
192 				struct i40e_asq_cmd_details *cmd_details);
193 enum i40e_status_code i40e_aq_set_vsi_bc_promisc_on_vlan(struct i40e_hw *hw,
194 				u16 seid, bool enable, u16 vid,
195 				struct i40e_asq_cmd_details *cmd_details);
196 enum i40e_status_code i40e_aq_set_vsi_vlan_promisc(struct i40e_hw *hw,
197 				u16 seid, bool enable,
198 				struct i40e_asq_cmd_details *cmd_details);
199 enum i40e_status_code i40e_aq_get_vsi_params(struct i40e_hw *hw,
200 				struct i40e_vsi_context *vsi_ctx,
201 				struct i40e_asq_cmd_details *cmd_details);
202 enum i40e_status_code i40e_aq_update_vsi_params(struct i40e_hw *hw,
203 				struct i40e_vsi_context *vsi_ctx,
204 				struct i40e_asq_cmd_details *cmd_details);
205 enum i40e_status_code i40e_aq_add_veb(struct i40e_hw *hw, u16 uplink_seid,
206 				u16 downlink_seid, u8 enabled_tc,
207 				bool default_port, u16 *pveb_seid,
208 				bool enable_stats,
209 				struct i40e_asq_cmd_details *cmd_details);
210 enum i40e_status_code i40e_aq_get_veb_parameters(struct i40e_hw *hw,
211 				u16 veb_seid, u16 *switch_id, bool *floating,
212 				u16 *statistic_index, u16 *vebs_used,
213 				u16 *vebs_free,
214 				struct i40e_asq_cmd_details *cmd_details);
215 enum i40e_status_code i40e_aq_add_macvlan(struct i40e_hw *hw, u16 vsi_id,
216 			struct i40e_aqc_add_macvlan_element_data *mv_list,
217 			u16 count, struct i40e_asq_cmd_details *cmd_details);
218 enum i40e_status_code i40e_aq_remove_macvlan(struct i40e_hw *hw, u16 vsi_id,
219 			struct i40e_aqc_remove_macvlan_element_data *mv_list,
220 			u16 count, struct i40e_asq_cmd_details *cmd_details);
221 enum i40e_status_code i40e_aq_add_mirrorrule(struct i40e_hw *hw, u16 sw_seid,
222 			u16 rule_type, u16 dest_vsi, u16 count, __le16 *mr_list,
223 			struct i40e_asq_cmd_details *cmd_details,
224 			u16 *rule_id, u16 *rules_used, u16 *rules_free);
225 enum i40e_status_code i40e_aq_delete_mirrorrule(struct i40e_hw *hw, u16 sw_seid,
226 			u16 rule_type, u16 rule_id, u16 count, __le16 *mr_list,
227 			struct i40e_asq_cmd_details *cmd_details,
228 			u16 *rules_used, u16 *rules_free);
229 
230 enum i40e_status_code i40e_aq_add_vlan(struct i40e_hw *hw, u16 vsi_id,
231 			struct i40e_aqc_add_remove_vlan_element_data *v_list,
232 			u8 count, struct i40e_asq_cmd_details *cmd_details);
233 enum i40e_status_code i40e_aq_remove_vlan(struct i40e_hw *hw, u16 vsi_id,
234 			struct i40e_aqc_add_remove_vlan_element_data *v_list,
235 			u8 count, struct i40e_asq_cmd_details *cmd_details);
236 enum i40e_status_code i40e_aq_send_msg_to_vf(struct i40e_hw *hw, u16 vfid,
237 				u32 v_opcode, u32 v_retval, u8 *msg, u16 msglen,
238 				struct i40e_asq_cmd_details *cmd_details);
239 enum i40e_status_code i40e_aq_get_switch_config(struct i40e_hw *hw,
240 				struct i40e_aqc_get_switch_config_resp *buf,
241 				u16 buf_size, u16 *start_seid,
242 				struct i40e_asq_cmd_details *cmd_details);
243 enum i40e_status_code i40e_aq_set_switch_config(struct i40e_hw *hw,
244 				u16 flags, u16 valid_flags, u8 mode,
245 				struct i40e_asq_cmd_details *cmd_details);
246 enum i40e_status_code i40e_aq_request_resource(struct i40e_hw *hw,
247 				enum i40e_aq_resources_ids resource,
248 				enum i40e_aq_resource_access_type access,
249 				u8 sdp_number, u64 *timeout,
250 				struct i40e_asq_cmd_details *cmd_details);
251 enum i40e_status_code i40e_aq_release_resource(struct i40e_hw *hw,
252 				enum i40e_aq_resources_ids resource,
253 				u8 sdp_number,
254 				struct i40e_asq_cmd_details *cmd_details);
255 enum i40e_status_code i40e_aq_read_nvm(struct i40e_hw *hw, u8 module_pointer,
256 				u32 offset, u16 length, void *data,
257 				bool last_command,
258 				struct i40e_asq_cmd_details *cmd_details);
259 enum i40e_status_code i40e_aq_erase_nvm(struct i40e_hw *hw, u8 module_pointer,
260 				u32 offset, u16 length, bool last_command,
261 				struct i40e_asq_cmd_details *cmd_details);
262 enum i40e_status_code i40e_aq_read_nvm_config(struct i40e_hw *hw,
263 				u8 cmd_flags, u32 field_id, void *data,
264 				u16 buf_size, u16 *element_count,
265 				struct i40e_asq_cmd_details *cmd_details);
266 enum i40e_status_code i40e_aq_write_nvm_config(struct i40e_hw *hw,
267 				u8 cmd_flags, void *data, u16 buf_size,
268 				u16 element_count,
269 				struct i40e_asq_cmd_details *cmd_details);
270 enum i40e_status_code
271 i40e_aq_min_rollback_rev_update(struct i40e_hw *hw, u8 mode, u8 module,
272 				u32 min_rrev,
273 				struct i40e_asq_cmd_details *cmd_details);
274 enum i40e_status_code i40e_aq_oem_post_update(struct i40e_hw *hw,
275 				void *buff, u16 buff_size,
276 				struct i40e_asq_cmd_details *cmd_details);
277 enum i40e_status_code i40e_aq_discover_capabilities(struct i40e_hw *hw,
278 				void *buff, u16 buff_size, u16 *data_size,
279 				enum i40e_admin_queue_opc list_type_opc,
280 				struct i40e_asq_cmd_details *cmd_details);
281 enum i40e_status_code i40e_aq_update_nvm(struct i40e_hw *hw, u8 module_pointer,
282 				u32 offset, u16 length, void *data,
283 				bool last_command, u8 preservation_flags,
284 				struct i40e_asq_cmd_details *cmd_details);
285 enum i40e_status_code i40e_aq_rearrange_nvm(struct i40e_hw *hw,
286 				u8 rearrange_nvm,
287 				struct i40e_asq_cmd_details *cmd_details);
288 enum i40e_status_code i40e_aq_nvm_update_in_process(struct i40e_hw *hw,
289 				bool update_flow_state,
290 				struct i40e_asq_cmd_details *cmd_details);
291 enum i40e_status_code i40e_aq_get_lldp_mib(struct i40e_hw *hw, u8 bridge_type,
292 				u8 mib_type, void *buff, u16 buff_size,
293 				u16 *local_len, u16 *remote_len,
294 				struct i40e_asq_cmd_details *cmd_details);
295 enum i40e_status_code i40e_aq_set_lldp_mib(struct i40e_hw *hw,
296 				u8 mib_type, void *buff, u16 buff_size,
297 				struct i40e_asq_cmd_details *cmd_details);
298 enum i40e_status_code i40e_aq_cfg_lldp_mib_change_event(struct i40e_hw *hw,
299 				bool enable_update,
300 				struct i40e_asq_cmd_details *cmd_details);
301 enum i40e_status_code
302 i40e_aq_restore_lldp(struct i40e_hw *hw, u8 *setting, bool restore,
303 		     struct i40e_asq_cmd_details *cmd_details);
304 enum i40e_status_code i40e_aq_stop_lldp(struct i40e_hw *hw, bool shutdown_agent,
305 				bool persist,
306 				struct i40e_asq_cmd_details *cmd_details);
307 enum i40e_status_code i40e_aq_set_dcb_parameters(struct i40e_hw *hw,
308 						 bool dcb_enable,
309 						 struct i40e_asq_cmd_details
310 						 *cmd_details);
311 enum i40e_status_code i40e_aq_start_lldp(struct i40e_hw *hw,
312 				bool persist,
313 				struct i40e_asq_cmd_details *cmd_details);
314 enum i40e_status_code i40e_aq_get_cee_dcb_config(struct i40e_hw *hw,
315 				void *buff, u16 buff_size,
316 				struct i40e_asq_cmd_details *cmd_details);
317 enum i40e_status_code i40e_aq_start_stop_dcbx(struct i40e_hw *hw,
318 				bool start_agent,
319 				struct i40e_asq_cmd_details *cmd_details);
320 enum i40e_status_code i40e_aq_add_udp_tunnel(struct i40e_hw *hw,
321 				u16 udp_port, u8 protocol_index,
322 				u8 *filter_index,
323 				struct i40e_asq_cmd_details *cmd_details);
324 enum i40e_status_code i40e_aq_del_udp_tunnel(struct i40e_hw *hw, u8 index,
325 				struct i40e_asq_cmd_details *cmd_details);
326 enum i40e_status_code i40e_aq_get_switch_resource_alloc(struct i40e_hw *hw,
327 			u8 *num_entries,
328 			struct i40e_aqc_switch_resource_alloc_element_resp *buf,
329 			u16 count,
330 			struct i40e_asq_cmd_details *cmd_details);
331 enum i40e_status_code i40e_aq_add_pvirt(struct i40e_hw *hw, u16 flags,
332 				       u16 mac_seid, u16 vsi_seid,
333 				       u16 *ret_seid);
334 enum i40e_status_code i40e_aq_add_tag(struct i40e_hw *hw, bool direct_to_queue,
335 				u16 vsi_seid, u16 tag, u16 queue_num,
336 				u16 *tags_used, u16 *tags_free,
337 				struct i40e_asq_cmd_details *cmd_details);
338 enum i40e_status_code i40e_aq_remove_tag(struct i40e_hw *hw, u16 vsi_seid,
339 				u16 tag, u16 *tags_used, u16 *tags_free,
340 				struct i40e_asq_cmd_details *cmd_details);
341 enum i40e_status_code i40e_aq_add_mcast_etag(struct i40e_hw *hw, u16 pe_seid,
342 				u16 etag, u8 num_tags_in_buf, void *buf,
343 				u16 *tags_used, u16 *tags_free,
344 				struct i40e_asq_cmd_details *cmd_details);
345 enum i40e_status_code i40e_aq_remove_mcast_etag(struct i40e_hw *hw, u16 pe_seid,
346 				u16 etag, u16 *tags_used, u16 *tags_free,
347 				struct i40e_asq_cmd_details *cmd_details);
348 enum i40e_status_code i40e_aq_update_tag(struct i40e_hw *hw, u16 vsi_seid,
349 				u16 old_tag, u16 new_tag, u16 *tags_used,
350 				u16 *tags_free,
351 				struct i40e_asq_cmd_details *cmd_details);
352 enum i40e_status_code i40e_aq_add_statistics(struct i40e_hw *hw, u16 seid,
353 				u16 vlan_id, u16 *stat_index,
354 				struct i40e_asq_cmd_details *cmd_details);
355 enum i40e_status_code i40e_aq_remove_statistics(struct i40e_hw *hw, u16 seid,
356 				u16 vlan_id, u16 stat_index,
357 				struct i40e_asq_cmd_details *cmd_details);
358 enum i40e_status_code i40e_aq_set_port_parameters(struct i40e_hw *hw,
359 				u16 bad_frame_vsi, bool save_bad_pac,
360 				bool pad_short_pac, bool double_vlan,
361 				struct i40e_asq_cmd_details *cmd_details);
362 enum i40e_status_code i40e_aq_delete_element(struct i40e_hw *hw, u16 seid,
363 				struct i40e_asq_cmd_details *cmd_details);
364 enum i40e_status_code i40e_aq_mac_address_write(struct i40e_hw *hw,
365 				    u16 flags, u8 *mac_addr,
366 				    struct i40e_asq_cmd_details *cmd_details);
367 enum i40e_status_code i40e_aq_config_vsi_bw_limit(struct i40e_hw *hw,
368 				u16 seid, u16 credit, u8 max_credit,
369 				struct i40e_asq_cmd_details *cmd_details);
370 enum i40e_status_code i40e_aq_dcb_ignore_pfc(struct i40e_hw *hw,
371 				u8 tcmap, bool request, u8 *tcmap_ret,
372 				struct i40e_asq_cmd_details *cmd_details);
373 enum i40e_status_code i40e_aq_config_switch_comp_ets_bw_limit(
374 	struct i40e_hw *hw, u16 seid,
375 	struct i40e_aqc_configure_switching_comp_ets_bw_limit_data *bw_data,
376 	struct i40e_asq_cmd_details *cmd_details);
377 enum i40e_status_code i40e_aq_config_vsi_ets_sla_bw_limit(struct i40e_hw *hw,
378 			u16 seid,
379 			struct i40e_aqc_configure_vsi_ets_sla_bw_data *bw_data,
380 			struct i40e_asq_cmd_details *cmd_details);
381 enum i40e_status_code i40e_aq_dcb_updated(struct i40e_hw *hw,
382 				struct i40e_asq_cmd_details *cmd_details);
383 enum i40e_status_code i40e_aq_config_switch_comp_bw_limit(struct i40e_hw *hw,
384 				u16 seid, u16 credit, u8 max_bw,
385 				struct i40e_asq_cmd_details *cmd_details);
386 enum i40e_status_code i40e_aq_config_vsi_tc_bw(struct i40e_hw *hw, u16 seid,
387 			struct i40e_aqc_configure_vsi_tc_bw_data *bw_data,
388 			struct i40e_asq_cmd_details *cmd_details);
389 enum i40e_status_code i40e_aq_query_vsi_bw_config(struct i40e_hw *hw,
390 			u16 seid,
391 			struct i40e_aqc_query_vsi_bw_config_resp *bw_data,
392 			struct i40e_asq_cmd_details *cmd_details);
393 enum i40e_status_code i40e_aq_query_vsi_ets_sla_config(struct i40e_hw *hw,
394 			u16 seid,
395 			struct i40e_aqc_query_vsi_ets_sla_config_resp *bw_data,
396 			struct i40e_asq_cmd_details *cmd_details);
397 enum i40e_status_code i40e_aq_query_switch_comp_ets_config(struct i40e_hw *hw,
398 		u16 seid,
399 		struct i40e_aqc_query_switching_comp_ets_config_resp *bw_data,
400 		struct i40e_asq_cmd_details *cmd_details);
401 enum i40e_status_code i40e_aq_query_port_ets_config(struct i40e_hw *hw,
402 		u16 seid,
403 		struct i40e_aqc_query_port_ets_config_resp *bw_data,
404 		struct i40e_asq_cmd_details *cmd_details);
405 enum i40e_status_code i40e_aq_query_switch_comp_bw_config(struct i40e_hw *hw,
406 		u16 seid,
407 		struct i40e_aqc_query_switching_comp_bw_config_resp *bw_data,
408 		struct i40e_asq_cmd_details *cmd_details);
409 enum i40e_status_code i40e_aq_resume_port_tx(struct i40e_hw *hw,
410 				struct i40e_asq_cmd_details *cmd_details);
411 enum i40e_status_code
412 i40e_aq_add_cloud_filters_bb(struct i40e_hw *hw, u16 seid,
413 			     struct i40e_aqc_cloud_filters_element_bb *filters,
414 			     u8 filter_count);
415 enum i40e_status_code
416 i40e_aq_add_cloud_filters(struct i40e_hw *hw, u16 vsi,
417 			  struct i40e_aqc_cloud_filters_element_data *filters,
418 			  u8 filter_count);
419 enum i40e_status_code
420 i40e_aq_rem_cloud_filters(struct i40e_hw *hw, u16 vsi,
421 			  struct i40e_aqc_cloud_filters_element_data *filters,
422 			  u8 filter_count);
423 enum i40e_status_code
424 i40e_aq_rem_cloud_filters_bb(struct i40e_hw *hw, u16 seid,
425 			     struct i40e_aqc_cloud_filters_element_bb *filters,
426 			     u8 filter_count);
427 enum i40e_status_code i40e_read_lldp_cfg(struct i40e_hw *hw,
428 					struct i40e_lldp_variables *lldp_cfg);
429 enum i40e_status_code i40e_aq_replace_cloud_filters(struct i40e_hw *hw,
430 		struct i40e_aqc_replace_cloud_filters_cmd *filters,
431 		struct i40e_aqc_replace_cloud_filters_cmd_buf *cmd_buf);
432 enum i40e_status_code i40e_aq_alternate_read(struct i40e_hw *hw,
433 				u32 reg_addr0, u32 *reg_val0,
434 				u32 reg_addr1, u32 *reg_val1);
435 enum i40e_status_code i40e_aq_alternate_read_indirect(struct i40e_hw *hw,
436 				u32 addr, u32 dw_count, void *buffer);
437 enum i40e_status_code i40e_aq_alternate_write(struct i40e_hw *hw,
438 				u32 reg_addr0, u32 reg_val0,
439 				u32 reg_addr1, u32 reg_val1);
440 enum i40e_status_code i40e_aq_alternate_write_indirect(struct i40e_hw *hw,
441 				u32 addr, u32 dw_count, void *buffer);
442 enum i40e_status_code i40e_aq_alternate_clear(struct i40e_hw *hw);
443 enum i40e_status_code i40e_aq_alternate_write_done(struct i40e_hw *hw,
444 				u8 bios_mode, bool *reset_needed);
445 enum i40e_status_code i40e_aq_set_oem_mode(struct i40e_hw *hw,
446 				u8 oem_mode);
447 
448 /* i40e_common */
449 enum i40e_status_code i40e_init_shared_code(struct i40e_hw *hw);
450 enum i40e_status_code i40e_pf_reset(struct i40e_hw *hw);
451 void i40e_clear_hw(struct i40e_hw *hw);
452 void i40e_clear_pxe_mode(struct i40e_hw *hw);
453 enum i40e_status_code i40e_get_link_status(struct i40e_hw *hw, bool *link_up);
454 enum i40e_status_code i40e_update_link_info(struct i40e_hw *hw);
455 enum i40e_status_code i40e_get_mac_addr(struct i40e_hw *hw, u8 *mac_addr);
456 enum i40e_status_code i40e_read_bw_from_alt_ram(struct i40e_hw *hw,
457 		u32 *max_bw, u32 *min_bw, bool *min_valid, bool *max_valid);
458 enum i40e_status_code i40e_aq_configure_partition_bw(struct i40e_hw *hw,
459 			struct i40e_aqc_configure_partition_bw_data *bw_data,
460 			struct i40e_asq_cmd_details *cmd_details);
461 enum i40e_status_code i40e_get_port_mac_addr(struct i40e_hw *hw, u8 *mac_addr);
462 enum i40e_status_code i40e_read_pba_string(struct i40e_hw *hw, u8 *pba_num,
463 					    u32 pba_num_size);
464 void i40e_pre_tx_queue_cfg(struct i40e_hw *hw, u32 queue, bool enable);
465 enum i40e_aq_link_speed i40e_get_link_speed(struct i40e_hw *hw);
466 /* prototype for functions used for NVM access */
467 enum i40e_status_code i40e_init_nvm(struct i40e_hw *hw);
468 enum i40e_status_code i40e_acquire_nvm(struct i40e_hw *hw,
469 				      enum i40e_aq_resource_access_type access);
470 void i40e_release_nvm(struct i40e_hw *hw);
471 enum i40e_status_code i40e_read_nvm_word(struct i40e_hw *hw, u16 offset,
472 					 u16 *data);
473 enum i40e_status_code
474 i40e_read_nvm_module_data(struct i40e_hw *hw, u8 module_ptr, u16 module_offset,
475 			  u16 data_offset, u16 words_data_size, u16 *data_ptr);
476 enum i40e_status_code i40e_read_nvm_buffer(struct i40e_hw *hw, u16 offset,
477 					   u16 *words, u16 *data);
478 enum i40e_status_code i40e_write_nvm_aq(struct i40e_hw *hw, u8 module,
479 					u32 offset, u16 words, void *data,
480 					bool last_command);
481 enum i40e_status_code __i40e_read_nvm_word(struct i40e_hw *hw, u16 offset,
482 					   u16 *data);
483 enum i40e_status_code __i40e_read_nvm_buffer(struct i40e_hw *hw, u16 offset,
484 					     u16 *words, u16 *data);
485 enum i40e_status_code __i40e_write_nvm_word(struct i40e_hw *hw, u32 offset,
486 					  void *data);
487 enum i40e_status_code __i40e_write_nvm_buffer(struct i40e_hw *hw, u8 module,
488 					    u32 offset, u16 words, void *data);
489 enum i40e_status_code i40e_calc_nvm_checksum(struct i40e_hw *hw, u16 *checksum);
490 enum i40e_status_code i40e_update_nvm_checksum(struct i40e_hw *hw);
491 enum i40e_status_code i40e_validate_nvm_checksum(struct i40e_hw *hw,
492 						 u16 *checksum);
493 enum i40e_status_code i40e_nvmupd_command(struct i40e_hw *hw,
494 					  struct i40e_nvm_access *cmd,
495 					  u8 *bytes, int *);
496 void i40e_nvmupd_check_wait_event(struct i40e_hw *hw, u16 opcode,
497 				  struct i40e_aq_desc *desc);
498 void i40e_nvmupd_clear_wait_state(struct i40e_hw *hw);
499 void i40e_set_pci_config_data(struct i40e_hw *hw, u16 link_status);
500 enum i40e_status_code i40e_enable_eee(struct i40e_hw *hw, bool enable);
501 
502 enum i40e_status_code i40e_set_mac_type(struct i40e_hw *hw);
503 
504 extern struct i40e_rx_ptype_decoded i40e_ptype_lookup[];
505 
decode_rx_desc_ptype(u8 ptype)506 static INLINE struct i40e_rx_ptype_decoded decode_rx_desc_ptype(u8 ptype)
507 {
508 	return i40e_ptype_lookup[ptype];
509 }
510 
511 /**
512  * i40e_virtchnl_link_speed - Convert AdminQ link_speed to virtchnl definition
513  * @link_speed: the speed to convert
514  *
515  * Returns the link_speed in terms of the virtchnl interface, for use in
516  * converting link_speed as reported by the AdminQ into the format used for
517  * talking to virtchnl devices. If we can't represent the link speed properly,
518  * report LINK_SPEED_UNKNOWN.
519  **/
520 static INLINE enum virtchnl_link_speed
i40e_virtchnl_link_speed(enum i40e_aq_link_speed link_speed)521 i40e_virtchnl_link_speed(enum i40e_aq_link_speed link_speed)
522 {
523 	switch (link_speed) {
524 	case I40E_LINK_SPEED_100MB:
525 		return VIRTCHNL_LINK_SPEED_100MB;
526 	case I40E_LINK_SPEED_1GB:
527 		return VIRTCHNL_LINK_SPEED_1GB;
528 	case I40E_LINK_SPEED_2_5GB:
529 		return VIRTCHNL_LINK_SPEED_2_5GB;
530 	case I40E_LINK_SPEED_5GB:
531 		return VIRTCHNL_LINK_SPEED_5GB;
532 	case I40E_LINK_SPEED_10GB:
533 		return VIRTCHNL_LINK_SPEED_10GB;
534 	case I40E_LINK_SPEED_40GB:
535 		return VIRTCHNL_LINK_SPEED_40GB;
536 	case I40E_LINK_SPEED_20GB:
537 		return VIRTCHNL_LINK_SPEED_20GB;
538 	case I40E_LINK_SPEED_25GB:
539 		return VIRTCHNL_LINK_SPEED_25GB;
540 	case I40E_LINK_SPEED_UNKNOWN:
541 	default:
542 		return VIRTCHNL_LINK_SPEED_UNKNOWN;
543 	}
544 }
545 
546 /* prototype for functions used for SW spinlocks */
547 void i40e_init_spinlock(struct i40e_spinlock *sp);
548 void i40e_acquire_spinlock(struct i40e_spinlock *sp);
549 void i40e_release_spinlock(struct i40e_spinlock *sp);
550 void i40e_destroy_spinlock(struct i40e_spinlock *sp);
551 
552 /* i40e_common for VF drivers*/
553 void i40e_vf_parse_hw_config(struct i40e_hw *hw,
554 			     struct virtchnl_vf_resource *msg);
555 enum i40e_status_code i40e_vf_reset(struct i40e_hw *hw);
556 enum i40e_status_code i40e_aq_send_msg_to_pf(struct i40e_hw *hw,
557 				enum virtchnl_ops v_opcode,
558 				enum i40e_status_code v_retval,
559 				u8 *msg, u16 msglen,
560 				struct i40e_asq_cmd_details *cmd_details);
561 enum i40e_status_code i40e_set_filter_control(struct i40e_hw *hw,
562 				struct i40e_filter_control_settings *settings);
563 enum i40e_status_code i40e_aq_add_rem_control_packet_filter(struct i40e_hw *hw,
564 				u8 *mac_addr, u16 ethtype, u16 flags,
565 				u16 vsi_seid, u16 queue, bool is_add,
566 				struct i40e_control_filter_stats *stats,
567 				struct i40e_asq_cmd_details *cmd_details);
568 enum i40e_status_code i40e_aq_debug_dump(struct i40e_hw *hw, u8 cluster_id,
569 				u8 table_id, u32 start_index, u16 buff_size,
570 				void *buff, u16 *ret_buff_size,
571 				u8 *ret_next_table, u32 *ret_next_index,
572 				struct i40e_asq_cmd_details *cmd_details);
573 void i40e_add_filter_to_drop_tx_flow_control_frames(struct i40e_hw *hw,
574 						    u16 vsi_seid);
575 enum i40e_status_code i40e_aq_rx_ctl_read_register(struct i40e_hw *hw,
576 				u32 reg_addr, u32 *reg_val,
577 				struct i40e_asq_cmd_details *cmd_details);
578 u32 i40e_read_rx_ctl(struct i40e_hw *hw, u32 reg_addr);
579 enum i40e_status_code i40e_aq_rx_ctl_write_register(struct i40e_hw *hw,
580 				u32 reg_addr, u32 reg_val,
581 				struct i40e_asq_cmd_details *cmd_details);
582 void i40e_write_rx_ctl(struct i40e_hw *hw, u32 reg_addr, u32 reg_val);
583 enum i40e_status_code
584 i40e_aq_set_phy_register_ext(struct i40e_hw *hw,
585 			     u8 phy_select, u8 dev_addr, bool page_change,
586 			     bool set_mdio, u8 mdio_num,
587 			     u32 reg_addr, u32 reg_val,
588 			     struct i40e_asq_cmd_details *cmd_details);
589 enum i40e_status_code
590 i40e_aq_get_phy_register_ext(struct i40e_hw *hw,
591 			     u8 phy_select, u8 dev_addr, bool page_change,
592 			     bool set_mdio, u8 mdio_num,
593 			     u32 reg_addr, u32 *reg_val,
594 			     struct i40e_asq_cmd_details *cmd_details);
595 
596 /* Convenience wrappers for most common use case */
597 #define i40e_aq_set_phy_register(hw, ps, da, pc, ra, rv, cd) \
598 	i40e_aq_set_phy_register_ext(hw, ps, da, pc, FALSE, 0, ra, rv, cd)
599 #define i40e_aq_get_phy_register(hw, ps, da, pc, ra, rv, cd) \
600 	i40e_aq_get_phy_register_ext(hw, ps, da, pc, FALSE, 0, ra, rv, cd)
601 
602 enum i40e_status_code
603 i40e_aq_run_phy_activity(struct i40e_hw *hw, u16 activity_id, u32 opcode,
604 			 u32 *cmd_status, u32 *data0, u32 *data1,
605 			 struct i40e_asq_cmd_details *cmd_details);
606 
607 enum i40e_status_code i40e_aq_set_arp_proxy_config(struct i40e_hw *hw,
608 			struct i40e_aqc_arp_proxy_data *proxy_config,
609 			struct i40e_asq_cmd_details *cmd_details);
610 enum i40e_status_code i40e_aq_set_ns_proxy_table_entry(struct i40e_hw *hw,
611 			struct i40e_aqc_ns_proxy_data *ns_proxy_table_entry,
612 			struct i40e_asq_cmd_details *cmd_details);
613 enum i40e_status_code i40e_aq_set_clear_wol_filter(struct i40e_hw *hw,
614 			u8 filter_index,
615 			struct i40e_aqc_set_wol_filter_data *filter,
616 			bool set_filter, bool no_wol_tco,
617 			bool filter_valid, bool no_wol_tco_valid,
618 			struct i40e_asq_cmd_details *cmd_details);
619 enum i40e_status_code i40e_aq_get_wake_event_reason(struct i40e_hw *hw,
620 			u16 *wake_reason,
621 			struct i40e_asq_cmd_details *cmd_details);
622 enum i40e_status_code i40e_aq_clear_all_wol_filters(struct i40e_hw *hw,
623 			struct i40e_asq_cmd_details *cmd_details);
624 enum i40e_status_code i40e_read_phy_register_clause22(struct i40e_hw *hw,
625 					u16 reg, u8 phy_addr, u16 *value);
626 enum i40e_status_code i40e_write_phy_register_clause22(struct i40e_hw *hw,
627 					u16 reg, u8 phy_addr, u16 value);
628 enum i40e_status_code i40e_read_phy_register_clause45(struct i40e_hw *hw,
629 				u8 page, u16 reg, u8 phy_addr, u16 *value);
630 enum i40e_status_code i40e_write_phy_register_clause45(struct i40e_hw *hw,
631 				u8 page, u16 reg, u8 phy_addr, u16 value);
632 enum i40e_status_code i40e_read_phy_register(struct i40e_hw *hw,
633 				u8 page, u16 reg, u8 phy_addr, u16 *value);
634 enum i40e_status_code i40e_write_phy_register(struct i40e_hw *hw,
635 				u8 page, u16 reg, u8 phy_addr, u16 value);
636 u8 i40e_get_phy_address(struct i40e_hw *hw, u8 dev_num);
637 #endif /* _I40E_PROTOTYPE_H_ */
638