xref: /freebsd/sys/dev/ixl/i40e_prototype.h (revision 4f52dfbb)
1 /******************************************************************************
2 
3   Copyright (c) 2013-2017, 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 
104 /* admin send queue commands */
105 
106 enum i40e_status_code i40e_aq_get_firmware_version(struct i40e_hw *hw,
107 				u16 *fw_major_version, u16 *fw_minor_version,
108 				u32 *fw_build,
109 				u16 *api_major_version, u16 *api_minor_version,
110 				struct i40e_asq_cmd_details *cmd_details);
111 enum i40e_status_code i40e_aq_debug_write_register(struct i40e_hw *hw,
112 				u32 reg_addr, u64 reg_val,
113 				struct i40e_asq_cmd_details *cmd_details);
114 enum i40e_status_code i40e_aq_debug_read_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_set_phy_debug(struct i40e_hw *hw, u8 cmd_flags,
118 				struct i40e_asq_cmd_details *cmd_details);
119 enum i40e_status_code i40e_aq_set_default_vsi(struct i40e_hw *hw, u16 vsi_id,
120 				struct i40e_asq_cmd_details *cmd_details);
121 enum i40e_status_code i40e_aq_clear_default_vsi(struct i40e_hw *hw, u16 vsi_id,
122 				struct i40e_asq_cmd_details *cmd_details);
123 enum i40e_status_code i40e_aq_get_phy_capabilities(struct i40e_hw *hw,
124 			bool qualified_modules, bool report_init,
125 			struct i40e_aq_get_phy_abilities_resp *abilities,
126 			struct i40e_asq_cmd_details *cmd_details);
127 enum i40e_status_code i40e_aq_set_phy_config(struct i40e_hw *hw,
128 				struct i40e_aq_set_phy_config *config,
129 				struct i40e_asq_cmd_details *cmd_details);
130 enum i40e_status_code i40e_set_fc(struct i40e_hw *hw, u8 *aq_failures,
131 				  bool atomic_reset);
132 enum i40e_status_code i40e_aq_set_phy_int_mask(struct i40e_hw *hw, u16 mask,
133 				struct i40e_asq_cmd_details *cmd_details);
134 enum i40e_status_code i40e_aq_set_mac_config(struct i40e_hw *hw,
135 				u16 max_frame_size, bool crc_en, u16 pacing,
136 				struct i40e_asq_cmd_details *cmd_details);
137 enum i40e_status_code i40e_aq_get_local_advt_reg(struct i40e_hw *hw,
138 				u64 *advt_reg,
139 				struct i40e_asq_cmd_details *cmd_details);
140 enum i40e_status_code i40e_aq_get_partner_advt(struct i40e_hw *hw,
141 				u64 *advt_reg,
142 				struct i40e_asq_cmd_details *cmd_details);
143 enum i40e_status_code
144 i40e_aq_set_lb_modes(struct i40e_hw *hw, u8 lb_level, u8 lb_type, u8 speed,
145 		     struct i40e_asq_cmd_details *cmd_details);
146 enum i40e_status_code i40e_aq_clear_pxe_mode(struct i40e_hw *hw,
147 			struct i40e_asq_cmd_details *cmd_details);
148 enum i40e_status_code i40e_aq_set_link_restart_an(struct i40e_hw *hw,
149 		bool enable_link, struct i40e_asq_cmd_details *cmd_details);
150 enum i40e_status_code i40e_aq_get_link_info(struct i40e_hw *hw,
151 				bool enable_lse, struct i40e_link_status *link,
152 				struct i40e_asq_cmd_details *cmd_details);
153 enum i40e_status_code i40e_aq_set_local_advt_reg(struct i40e_hw *hw,
154 				u64 advt_reg,
155 				struct i40e_asq_cmd_details *cmd_details);
156 enum i40e_status_code i40e_aq_send_driver_version(struct i40e_hw *hw,
157 				struct i40e_driver_version *dv,
158 				struct i40e_asq_cmd_details *cmd_details);
159 enum i40e_status_code i40e_aq_add_vsi(struct i40e_hw *hw,
160 				struct i40e_vsi_context *vsi_ctx,
161 				struct i40e_asq_cmd_details *cmd_details);
162 enum i40e_status_code i40e_aq_set_vsi_broadcast(struct i40e_hw *hw,
163 				u16 vsi_id, bool set_filter,
164 				struct i40e_asq_cmd_details *cmd_details);
165 enum i40e_status_code i40e_aq_set_vsi_unicast_promiscuous(struct i40e_hw *hw,
166 		u16 vsi_id, bool set, struct i40e_asq_cmd_details *cmd_details,
167 		bool rx_only_promisc);
168 enum i40e_status_code i40e_aq_set_vsi_multicast_promiscuous(struct i40e_hw *hw,
169 		u16 vsi_id, bool set, struct i40e_asq_cmd_details *cmd_details);
170 enum i40e_status_code i40e_aq_set_vsi_full_promiscuous(struct i40e_hw *hw,
171 				u16 seid, bool set,
172 				struct i40e_asq_cmd_details *cmd_details);
173 enum i40e_status_code i40e_aq_set_vsi_mc_promisc_on_vlan(struct i40e_hw *hw,
174 				u16 seid, bool enable, u16 vid,
175 				struct i40e_asq_cmd_details *cmd_details);
176 enum i40e_status_code i40e_aq_set_vsi_uc_promisc_on_vlan(struct i40e_hw *hw,
177 				u16 seid, bool enable, u16 vid,
178 				struct i40e_asq_cmd_details *cmd_details);
179 enum i40e_status_code i40e_aq_set_vsi_bc_promisc_on_vlan(struct i40e_hw *hw,
180 				u16 seid, bool enable, u16 vid,
181 				struct i40e_asq_cmd_details *cmd_details);
182 enum i40e_status_code i40e_aq_set_vsi_vlan_promisc(struct i40e_hw *hw,
183 				u16 seid, bool enable,
184 				struct i40e_asq_cmd_details *cmd_details);
185 enum i40e_status_code i40e_aq_get_vsi_params(struct i40e_hw *hw,
186 				struct i40e_vsi_context *vsi_ctx,
187 				struct i40e_asq_cmd_details *cmd_details);
188 enum i40e_status_code i40e_aq_update_vsi_params(struct i40e_hw *hw,
189 				struct i40e_vsi_context *vsi_ctx,
190 				struct i40e_asq_cmd_details *cmd_details);
191 enum i40e_status_code i40e_aq_add_veb(struct i40e_hw *hw, u16 uplink_seid,
192 				u16 downlink_seid, u8 enabled_tc,
193 				bool default_port, u16 *pveb_seid,
194 				bool enable_stats,
195 				struct i40e_asq_cmd_details *cmd_details);
196 enum i40e_status_code i40e_aq_get_veb_parameters(struct i40e_hw *hw,
197 				u16 veb_seid, u16 *switch_id, bool *floating,
198 				u16 *statistic_index, u16 *vebs_used,
199 				u16 *vebs_free,
200 				struct i40e_asq_cmd_details *cmd_details);
201 enum i40e_status_code i40e_aq_add_macvlan(struct i40e_hw *hw, u16 vsi_id,
202 			struct i40e_aqc_add_macvlan_element_data *mv_list,
203 			u16 count, struct i40e_asq_cmd_details *cmd_details);
204 enum i40e_status_code i40e_aq_remove_macvlan(struct i40e_hw *hw, u16 vsi_id,
205 			struct i40e_aqc_remove_macvlan_element_data *mv_list,
206 			u16 count, struct i40e_asq_cmd_details *cmd_details);
207 enum i40e_status_code i40e_aq_add_mirrorrule(struct i40e_hw *hw, u16 sw_seid,
208 			u16 rule_type, u16 dest_vsi, u16 count, __le16 *mr_list,
209 			struct i40e_asq_cmd_details *cmd_details,
210 			u16 *rule_id, u16 *rules_used, u16 *rules_free);
211 enum i40e_status_code i40e_aq_delete_mirrorrule(struct i40e_hw *hw, u16 sw_seid,
212 			u16 rule_type, u16 rule_id, u16 count, __le16 *mr_list,
213 			struct i40e_asq_cmd_details *cmd_details,
214 			u16 *rules_used, u16 *rules_free);
215 
216 enum i40e_status_code i40e_aq_add_vlan(struct i40e_hw *hw, u16 vsi_id,
217 			struct i40e_aqc_add_remove_vlan_element_data *v_list,
218 			u8 count, struct i40e_asq_cmd_details *cmd_details);
219 enum i40e_status_code i40e_aq_remove_vlan(struct i40e_hw *hw, u16 vsi_id,
220 			struct i40e_aqc_add_remove_vlan_element_data *v_list,
221 			u8 count, struct i40e_asq_cmd_details *cmd_details);
222 enum i40e_status_code i40e_aq_send_msg_to_vf(struct i40e_hw *hw, u16 vfid,
223 				u32 v_opcode, u32 v_retval, u8 *msg, u16 msglen,
224 				struct i40e_asq_cmd_details *cmd_details);
225 enum i40e_status_code i40e_aq_get_switch_config(struct i40e_hw *hw,
226 				struct i40e_aqc_get_switch_config_resp *buf,
227 				u16 buf_size, u16 *start_seid,
228 				struct i40e_asq_cmd_details *cmd_details);
229 enum i40e_status_code i40e_aq_set_switch_config(struct i40e_hw *hw,
230 				u16 flags, u16 valid_flags, u8 mode,
231 				struct i40e_asq_cmd_details *cmd_details);
232 enum i40e_status_code i40e_aq_request_resource(struct i40e_hw *hw,
233 				enum i40e_aq_resources_ids resource,
234 				enum i40e_aq_resource_access_type access,
235 				u8 sdp_number, u64 *timeout,
236 				struct i40e_asq_cmd_details *cmd_details);
237 enum i40e_status_code i40e_aq_release_resource(struct i40e_hw *hw,
238 				enum i40e_aq_resources_ids resource,
239 				u8 sdp_number,
240 				struct i40e_asq_cmd_details *cmd_details);
241 enum i40e_status_code i40e_aq_read_nvm(struct i40e_hw *hw, u8 module_pointer,
242 				u32 offset, u16 length, void *data,
243 				bool last_command,
244 				struct i40e_asq_cmd_details *cmd_details);
245 enum i40e_status_code i40e_aq_erase_nvm(struct i40e_hw *hw, u8 module_pointer,
246 				u32 offset, u16 length, bool last_command,
247 				struct i40e_asq_cmd_details *cmd_details);
248 enum i40e_status_code i40e_aq_read_nvm_config(struct i40e_hw *hw,
249 				u8 cmd_flags, u32 field_id, void *data,
250 				u16 buf_size, u16 *element_count,
251 				struct i40e_asq_cmd_details *cmd_details);
252 enum i40e_status_code i40e_aq_write_nvm_config(struct i40e_hw *hw,
253 				u8 cmd_flags, void *data, u16 buf_size,
254 				u16 element_count,
255 				struct i40e_asq_cmd_details *cmd_details);
256 enum i40e_status_code i40e_aq_oem_post_update(struct i40e_hw *hw,
257 				void *buff, u16 buff_size,
258 				struct i40e_asq_cmd_details *cmd_details);
259 enum i40e_status_code i40e_aq_discover_capabilities(struct i40e_hw *hw,
260 				void *buff, u16 buff_size, u16 *data_size,
261 				enum i40e_admin_queue_opc list_type_opc,
262 				struct i40e_asq_cmd_details *cmd_details);
263 enum i40e_status_code i40e_aq_update_nvm(struct i40e_hw *hw, u8 module_pointer,
264 				u32 offset, u16 length, void *data,
265 				bool last_command, u8 preservation_flags,
266 				struct i40e_asq_cmd_details *cmd_details);
267 enum i40e_status_code i40e_aq_nvm_progress(struct i40e_hw *hw, u8 *progress,
268 				struct i40e_asq_cmd_details *cmd_details);
269 enum i40e_status_code i40e_aq_get_lldp_mib(struct i40e_hw *hw, u8 bridge_type,
270 				u8 mib_type, void *buff, u16 buff_size,
271 				u16 *local_len, u16 *remote_len,
272 				struct i40e_asq_cmd_details *cmd_details);
273 enum i40e_status_code i40e_aq_set_lldp_mib(struct i40e_hw *hw,
274 				u8 mib_type, void *buff, u16 buff_size,
275 				struct i40e_asq_cmd_details *cmd_details);
276 enum i40e_status_code i40e_aq_cfg_lldp_mib_change_event(struct i40e_hw *hw,
277 				bool enable_update,
278 				struct i40e_asq_cmd_details *cmd_details);
279 enum i40e_status_code i40e_aq_add_lldp_tlv(struct i40e_hw *hw, u8 bridge_type,
280 				void *buff, u16 buff_size, u16 tlv_len,
281 				u16 *mib_len,
282 				struct i40e_asq_cmd_details *cmd_details);
283 enum i40e_status_code i40e_aq_update_lldp_tlv(struct i40e_hw *hw,
284 				u8 bridge_type, void *buff, u16 buff_size,
285 				u16 old_len, u16 new_len, u16 offset,
286 				u16 *mib_len,
287 				struct i40e_asq_cmd_details *cmd_details);
288 enum i40e_status_code i40e_aq_delete_lldp_tlv(struct i40e_hw *hw,
289 				u8 bridge_type, void *buff, u16 buff_size,
290 				u16 tlv_len, u16 *mib_len,
291 				struct i40e_asq_cmd_details *cmd_details);
292 enum i40e_status_code i40e_aq_stop_lldp(struct i40e_hw *hw, bool shutdown_agent,
293 				struct i40e_asq_cmd_details *cmd_details);
294 enum i40e_status_code i40e_aq_set_dcb_parameters(struct i40e_hw *hw,
295 						 bool dcb_enable,
296 						 struct i40e_asq_cmd_details
297 						 *cmd_details);
298 enum i40e_status_code i40e_aq_start_lldp(struct i40e_hw *hw,
299 				struct i40e_asq_cmd_details *cmd_details);
300 enum i40e_status_code i40e_aq_get_cee_dcb_config(struct i40e_hw *hw,
301 				void *buff, u16 buff_size,
302 				struct i40e_asq_cmd_details *cmd_details);
303 enum i40e_status_code i40e_aq_start_stop_dcbx(struct i40e_hw *hw,
304 				bool start_agent,
305 				struct i40e_asq_cmd_details *cmd_details);
306 enum i40e_status_code i40e_aq_add_udp_tunnel(struct i40e_hw *hw,
307 				u16 udp_port, u8 protocol_index,
308 				u8 *filter_index,
309 				struct i40e_asq_cmd_details *cmd_details);
310 enum i40e_status_code i40e_aq_del_udp_tunnel(struct i40e_hw *hw, u8 index,
311 				struct i40e_asq_cmd_details *cmd_details);
312 enum i40e_status_code i40e_aq_get_switch_resource_alloc(struct i40e_hw *hw,
313 			u8 *num_entries,
314 			struct i40e_aqc_switch_resource_alloc_element_resp *buf,
315 			u16 count,
316 			struct i40e_asq_cmd_details *cmd_details);
317 enum i40e_status_code i40e_aq_add_pvirt(struct i40e_hw *hw, u16 flags,
318 				       u16 mac_seid, u16 vsi_seid,
319 				       u16 *ret_seid);
320 enum i40e_status_code i40e_aq_add_tag(struct i40e_hw *hw, bool direct_to_queue,
321 				u16 vsi_seid, u16 tag, u16 queue_num,
322 				u16 *tags_used, u16 *tags_free,
323 				struct i40e_asq_cmd_details *cmd_details);
324 enum i40e_status_code i40e_aq_remove_tag(struct i40e_hw *hw, u16 vsi_seid,
325 				u16 tag, u16 *tags_used, u16 *tags_free,
326 				struct i40e_asq_cmd_details *cmd_details);
327 enum i40e_status_code i40e_aq_add_mcast_etag(struct i40e_hw *hw, u16 pe_seid,
328 				u16 etag, u8 num_tags_in_buf, void *buf,
329 				u16 *tags_used, u16 *tags_free,
330 				struct i40e_asq_cmd_details *cmd_details);
331 enum i40e_status_code i40e_aq_remove_mcast_etag(struct i40e_hw *hw, u16 pe_seid,
332 				u16 etag, u16 *tags_used, u16 *tags_free,
333 				struct i40e_asq_cmd_details *cmd_details);
334 enum i40e_status_code i40e_aq_update_tag(struct i40e_hw *hw, u16 vsi_seid,
335 				u16 old_tag, u16 new_tag, u16 *tags_used,
336 				u16 *tags_free,
337 				struct i40e_asq_cmd_details *cmd_details);
338 enum i40e_status_code i40e_aq_add_statistics(struct i40e_hw *hw, u16 seid,
339 				u16 vlan_id, u16 *stat_index,
340 				struct i40e_asq_cmd_details *cmd_details);
341 enum i40e_status_code i40e_aq_remove_statistics(struct i40e_hw *hw, u16 seid,
342 				u16 vlan_id, u16 stat_index,
343 				struct i40e_asq_cmd_details *cmd_details);
344 enum i40e_status_code i40e_aq_set_port_parameters(struct i40e_hw *hw,
345 				u16 bad_frame_vsi, bool save_bad_pac,
346 				bool pad_short_pac, bool double_vlan,
347 				struct i40e_asq_cmd_details *cmd_details);
348 enum i40e_status_code i40e_aq_delete_element(struct i40e_hw *hw, u16 seid,
349 				struct i40e_asq_cmd_details *cmd_details);
350 enum i40e_status_code i40e_aq_mac_address_write(struct i40e_hw *hw,
351 				    u16 flags, u8 *mac_addr,
352 				    struct i40e_asq_cmd_details *cmd_details);
353 enum i40e_status_code i40e_aq_config_vsi_bw_limit(struct i40e_hw *hw,
354 				u16 seid, u16 credit, u8 max_credit,
355 				struct i40e_asq_cmd_details *cmd_details);
356 enum i40e_status_code i40e_aq_dcb_ignore_pfc(struct i40e_hw *hw,
357 				u8 tcmap, bool request, u8 *tcmap_ret,
358 				struct i40e_asq_cmd_details *cmd_details);
359 enum i40e_status_code i40e_aq_config_switch_comp_ets_bw_limit(
360 	struct i40e_hw *hw, u16 seid,
361 	struct i40e_aqc_configure_switching_comp_ets_bw_limit_data *bw_data,
362 	struct i40e_asq_cmd_details *cmd_details);
363 enum i40e_status_code i40e_aq_config_vsi_ets_sla_bw_limit(struct i40e_hw *hw,
364 			u16 seid,
365 			struct i40e_aqc_configure_vsi_ets_sla_bw_data *bw_data,
366 			struct i40e_asq_cmd_details *cmd_details);
367 enum i40e_status_code i40e_aq_dcb_updated(struct i40e_hw *hw,
368 				struct i40e_asq_cmd_details *cmd_details);
369 enum i40e_status_code i40e_aq_config_switch_comp_bw_limit(struct i40e_hw *hw,
370 				u16 seid, u16 credit, u8 max_bw,
371 				struct i40e_asq_cmd_details *cmd_details);
372 enum i40e_status_code i40e_aq_config_vsi_tc_bw(struct i40e_hw *hw, u16 seid,
373 			struct i40e_aqc_configure_vsi_tc_bw_data *bw_data,
374 			struct i40e_asq_cmd_details *cmd_details);
375 enum i40e_status_code i40e_aq_query_vsi_bw_config(struct i40e_hw *hw,
376 			u16 seid,
377 			struct i40e_aqc_query_vsi_bw_config_resp *bw_data,
378 			struct i40e_asq_cmd_details *cmd_details);
379 enum i40e_status_code i40e_aq_query_vsi_ets_sla_config(struct i40e_hw *hw,
380 			u16 seid,
381 			struct i40e_aqc_query_vsi_ets_sla_config_resp *bw_data,
382 			struct i40e_asq_cmd_details *cmd_details);
383 enum i40e_status_code i40e_aq_query_switch_comp_ets_config(struct i40e_hw *hw,
384 		u16 seid,
385 		struct i40e_aqc_query_switching_comp_ets_config_resp *bw_data,
386 		struct i40e_asq_cmd_details *cmd_details);
387 enum i40e_status_code i40e_aq_query_port_ets_config(struct i40e_hw *hw,
388 		u16 seid,
389 		struct i40e_aqc_query_port_ets_config_resp *bw_data,
390 		struct i40e_asq_cmd_details *cmd_details);
391 enum i40e_status_code i40e_aq_query_switch_comp_bw_config(struct i40e_hw *hw,
392 		u16 seid,
393 		struct i40e_aqc_query_switching_comp_bw_config_resp *bw_data,
394 		struct i40e_asq_cmd_details *cmd_details);
395 enum i40e_status_code i40e_aq_resume_port_tx(struct i40e_hw *hw,
396 				struct i40e_asq_cmd_details *cmd_details);
397 enum i40e_status_code i40e_read_lldp_cfg(struct i40e_hw *hw,
398 					struct i40e_lldp_variables *lldp_cfg);
399 enum i40e_status_code i40e_aq_add_cloud_filters(struct i40e_hw *hw,
400 		u16 vsi,
401 		struct i40e_aqc_add_remove_cloud_filters_element_data *filters,
402 		u8 filter_count);
403 
404 enum i40e_status_code i40e_aq_remove_cloud_filters(struct i40e_hw *hw,
405 		u16 vsi,
406 		struct i40e_aqc_add_remove_cloud_filters_element_data *filters,
407 		u8 filter_count);
408 enum i40e_status_code i40e_aq_alternate_read(struct i40e_hw *hw,
409 				u32 reg_addr0, u32 *reg_val0,
410 				u32 reg_addr1, u32 *reg_val1);
411 enum i40e_status_code i40e_aq_alternate_read_indirect(struct i40e_hw *hw,
412 				u32 addr, u32 dw_count, void *buffer);
413 enum i40e_status_code i40e_aq_alternate_write(struct i40e_hw *hw,
414 				u32 reg_addr0, u32 reg_val0,
415 				u32 reg_addr1, u32 reg_val1);
416 enum i40e_status_code i40e_aq_alternate_write_indirect(struct i40e_hw *hw,
417 				u32 addr, u32 dw_count, void *buffer);
418 enum i40e_status_code i40e_aq_alternate_clear(struct i40e_hw *hw);
419 enum i40e_status_code i40e_aq_alternate_write_done(struct i40e_hw *hw,
420 				u8 bios_mode, bool *reset_needed);
421 enum i40e_status_code i40e_aq_set_oem_mode(struct i40e_hw *hw,
422 				u8 oem_mode);
423 
424 /* i40e_common */
425 enum i40e_status_code i40e_init_shared_code(struct i40e_hw *hw);
426 enum i40e_status_code i40e_pf_reset(struct i40e_hw *hw);
427 void i40e_clear_hw(struct i40e_hw *hw);
428 void i40e_clear_pxe_mode(struct i40e_hw *hw);
429 enum i40e_status_code i40e_get_link_status(struct i40e_hw *hw, bool *link_up);
430 enum i40e_status_code i40e_update_link_info(struct i40e_hw *hw);
431 enum i40e_status_code i40e_get_mac_addr(struct i40e_hw *hw, u8 *mac_addr);
432 enum i40e_status_code i40e_read_bw_from_alt_ram(struct i40e_hw *hw,
433 		u32 *max_bw, u32 *min_bw, bool *min_valid, bool *max_valid);
434 enum i40e_status_code i40e_aq_configure_partition_bw(struct i40e_hw *hw,
435 			struct i40e_aqc_configure_partition_bw_data *bw_data,
436 			struct i40e_asq_cmd_details *cmd_details);
437 enum i40e_status_code i40e_get_port_mac_addr(struct i40e_hw *hw, u8 *mac_addr);
438 enum i40e_status_code i40e_read_pba_string(struct i40e_hw *hw, u8 *pba_num,
439 					    u32 pba_num_size);
440 void i40e_pre_tx_queue_cfg(struct i40e_hw *hw, u32 queue, bool enable);
441 enum i40e_aq_link_speed i40e_get_link_speed(struct i40e_hw *hw);
442 /* prototype for functions used for NVM access */
443 enum i40e_status_code i40e_init_nvm(struct i40e_hw *hw);
444 enum i40e_status_code i40e_acquire_nvm(struct i40e_hw *hw,
445 				      enum i40e_aq_resource_access_type access);
446 void i40e_release_nvm(struct i40e_hw *hw);
447 enum i40e_status_code i40e_read_nvm_word(struct i40e_hw *hw, u16 offset,
448 					 u16 *data);
449 enum i40e_status_code i40e_read_nvm_buffer(struct i40e_hw *hw, u16 offset,
450 					   u16 *words, u16 *data);
451 enum i40e_status_code i40e_write_nvm_aq(struct i40e_hw *hw, u8 module,
452 					u32 offset, u16 words, void *data,
453 					bool last_command);
454 enum i40e_status_code __i40e_read_nvm_word(struct i40e_hw *hw, u16 offset,
455 					   u16 *data);
456 enum i40e_status_code __i40e_read_nvm_buffer(struct i40e_hw *hw, u16 offset,
457 					     u16 *words, u16 *data);
458 enum i40e_status_code __i40e_write_nvm_word(struct i40e_hw *hw, u32 offset,
459 					  void *data);
460 enum i40e_status_code __i40e_write_nvm_buffer(struct i40e_hw *hw, u8 module,
461 					    u32 offset, u16 words, void *data);
462 enum i40e_status_code i40e_calc_nvm_checksum(struct i40e_hw *hw, u16 *checksum);
463 enum i40e_status_code i40e_update_nvm_checksum(struct i40e_hw *hw);
464 enum i40e_status_code i40e_validate_nvm_checksum(struct i40e_hw *hw,
465 						 u16 *checksum);
466 enum i40e_status_code i40e_nvmupd_command(struct i40e_hw *hw,
467 					  struct i40e_nvm_access *cmd,
468 					  u8 *bytes, int *);
469 void i40e_nvmupd_check_wait_event(struct i40e_hw *hw, u16 opcode,
470 				  struct i40e_aq_desc *desc);
471 void i40e_nvmupd_clear_wait_state(struct i40e_hw *hw);
472 void i40e_set_pci_config_data(struct i40e_hw *hw, u16 link_status);
473 
474 enum i40e_status_code i40e_set_mac_type(struct i40e_hw *hw);
475 
476 extern struct i40e_rx_ptype_decoded i40e_ptype_lookup[];
477 
478 static INLINE struct i40e_rx_ptype_decoded decode_rx_desc_ptype(u8 ptype)
479 {
480 	return i40e_ptype_lookup[ptype];
481 }
482 
483 /**
484  * i40e_virtchnl_link_speed - Convert AdminQ link_speed to virtchnl definition
485  * @link_speed: the speed to convert
486  *
487  * Returns the link_speed in terms of the virtchnl interface, for use in
488  * converting link_speed as reported by the AdminQ into the format used for
489  * talking to virtchnl devices. If we can't represent the link speed properly,
490  * report LINK_SPEED_UNKNOWN.
491  **/
492 static INLINE enum virtchnl_link_speed
493 i40e_virtchnl_link_speed(enum i40e_aq_link_speed link_speed)
494 {
495 	switch (link_speed) {
496 	case I40E_LINK_SPEED_100MB:
497 		return VIRTCHNL_LINK_SPEED_100MB;
498 	case I40E_LINK_SPEED_1GB:
499 		return VIRTCHNL_LINK_SPEED_1GB;
500 	case I40E_LINK_SPEED_10GB:
501 		return VIRTCHNL_LINK_SPEED_10GB;
502 	case I40E_LINK_SPEED_40GB:
503 		return VIRTCHNL_LINK_SPEED_40GB;
504 	case I40E_LINK_SPEED_20GB:
505 		return VIRTCHNL_LINK_SPEED_20GB;
506 	case I40E_LINK_SPEED_25GB:
507 		return VIRTCHNL_LINK_SPEED_25GB;
508 	case I40E_LINK_SPEED_UNKNOWN:
509 	default:
510 		return VIRTCHNL_LINK_SPEED_UNKNOWN;
511 	}
512 }
513 
514 /* prototype for functions used for SW spinlocks */
515 void i40e_init_spinlock(struct i40e_spinlock *sp);
516 void i40e_acquire_spinlock(struct i40e_spinlock *sp);
517 void i40e_release_spinlock(struct i40e_spinlock *sp);
518 void i40e_destroy_spinlock(struct i40e_spinlock *sp);
519 
520 /* i40e_common for VF drivers*/
521 void i40e_vf_parse_hw_config(struct i40e_hw *hw,
522 			     struct virtchnl_vf_resource *msg);
523 enum i40e_status_code i40e_vf_reset(struct i40e_hw *hw);
524 enum i40e_status_code i40e_aq_send_msg_to_pf(struct i40e_hw *hw,
525 				enum virtchnl_ops v_opcode,
526 				enum i40e_status_code v_retval,
527 				u8 *msg, u16 msglen,
528 				struct i40e_asq_cmd_details *cmd_details);
529 enum i40e_status_code i40e_set_filter_control(struct i40e_hw *hw,
530 				struct i40e_filter_control_settings *settings);
531 enum i40e_status_code i40e_aq_add_rem_control_packet_filter(struct i40e_hw *hw,
532 				u8 *mac_addr, u16 ethtype, u16 flags,
533 				u16 vsi_seid, u16 queue, bool is_add,
534 				struct i40e_control_filter_stats *stats,
535 				struct i40e_asq_cmd_details *cmd_details);
536 enum i40e_status_code i40e_aq_debug_dump(struct i40e_hw *hw, u8 cluster_id,
537 				u8 table_id, u32 start_index, u16 buff_size,
538 				void *buff, u16 *ret_buff_size,
539 				u8 *ret_next_table, u32 *ret_next_index,
540 				struct i40e_asq_cmd_details *cmd_details);
541 void i40e_add_filter_to_drop_tx_flow_control_frames(struct i40e_hw *hw,
542 						    u16 vsi_seid);
543 enum i40e_status_code i40e_aq_rx_ctl_read_register(struct i40e_hw *hw,
544 				u32 reg_addr, u32 *reg_val,
545 				struct i40e_asq_cmd_details *cmd_details);
546 u32 i40e_read_rx_ctl(struct i40e_hw *hw, u32 reg_addr);
547 enum i40e_status_code i40e_aq_rx_ctl_write_register(struct i40e_hw *hw,
548 				u32 reg_addr, u32 reg_val,
549 				struct i40e_asq_cmd_details *cmd_details);
550 void i40e_write_rx_ctl(struct i40e_hw *hw, u32 reg_addr, u32 reg_val);
551 enum i40e_status_code i40e_aq_set_phy_register(struct i40e_hw *hw,
552 				u8 phy_select, u8 dev_addr,
553 				u32 reg_addr, u32 reg_val,
554 				struct i40e_asq_cmd_details *cmd_details);
555 enum i40e_status_code i40e_aq_get_phy_register(struct i40e_hw *hw,
556 				u8 phy_select, u8 dev_addr,
557 				u32 reg_addr, u32 *reg_val,
558 				struct i40e_asq_cmd_details *cmd_details);
559 
560 enum i40e_status_code i40e_aq_set_arp_proxy_config(struct i40e_hw *hw,
561 			struct i40e_aqc_arp_proxy_data *proxy_config,
562 			struct i40e_asq_cmd_details *cmd_details);
563 enum i40e_status_code i40e_aq_set_ns_proxy_table_entry(struct i40e_hw *hw,
564 			struct i40e_aqc_ns_proxy_data *ns_proxy_table_entry,
565 			struct i40e_asq_cmd_details *cmd_details);
566 enum i40e_status_code i40e_aq_set_clear_wol_filter(struct i40e_hw *hw,
567 			u8 filter_index,
568 			struct i40e_aqc_set_wol_filter_data *filter,
569 			bool set_filter, bool no_wol_tco,
570 			bool filter_valid, bool no_wol_tco_valid,
571 			struct i40e_asq_cmd_details *cmd_details);
572 enum i40e_status_code i40e_aq_get_wake_event_reason(struct i40e_hw *hw,
573 			u16 *wake_reason,
574 			struct i40e_asq_cmd_details *cmd_details);
575 enum i40e_status_code i40e_aq_clear_all_wol_filters(struct i40e_hw *hw,
576 			struct i40e_asq_cmd_details *cmd_details);
577 enum i40e_status_code i40e_read_phy_register_clause22(struct i40e_hw *hw,
578 					u16 reg, u8 phy_addr, u16 *value);
579 enum i40e_status_code i40e_write_phy_register_clause22(struct i40e_hw *hw,
580 					u16 reg, u8 phy_addr, u16 value);
581 enum i40e_status_code i40e_read_phy_register_clause45(struct i40e_hw *hw,
582 				u8 page, u16 reg, u8 phy_addr, u16 *value);
583 enum i40e_status_code i40e_write_phy_register_clause45(struct i40e_hw *hw,
584 				u8 page, u16 reg, u8 phy_addr, u16 value);
585 enum i40e_status_code i40e_read_phy_register(struct i40e_hw *hw,
586 				u8 page, u16 reg, u8 phy_addr, u16 *value);
587 enum i40e_status_code i40e_write_phy_register(struct i40e_hw *hw,
588 				u8 page, u16 reg, u8 phy_addr, u16 value);
589 u8 i40e_get_phy_address(struct i40e_hw *hw, u8 dev_num);
590 #endif /* _I40E_PROTOTYPE_H_ */
591