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