1 /*******************************************************************************
3 * Intel Ethernet Controller XL710 Family Linux Driver
4 * Copyright(c) 2013 - 2015 Intel Corporation.
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms and conditions of the GNU General Public License,
8 * version 2, as published by the Free Software Foundation.
10 * This program is distributed in the hope it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
15 * You should have received a copy of the GNU General Public License along
16 * with this program. If not, see <http://www.gnu.org/licenses/>.
18 * The full GNU General Public License is included in this distribution in
19 * the file called "COPYING".
21 * Contact Information:
22 * e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
23 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
25 ******************************************************************************/
27 #ifndef _I40E_PROTOTYPE_H_
28 #define _I40E_PROTOTYPE_H_
30 #include "i40e_type.h"
31 #include "i40e_alloc.h"
32 #include "i40e_virtchnl.h"
34 /* Prototypes for shared code functions that are not in
35 * the standard function pointer structures. These are
36 * mostly because they are needed even before the init
37 * has happened and will assist in the early SW and FW
41 /* adminq functions */
42 i40e_status i40e_init_adminq(struct i40e_hw *hw);
43 i40e_status i40e_shutdown_adminq(struct i40e_hw *hw);
44 void i40e_adminq_init_ring_data(struct i40e_hw *hw);
45 i40e_status i40e_clean_arq_element(struct i40e_hw *hw,
46 struct i40e_arq_event_info *e,
48 i40e_status i40e_asq_send_command(struct i40e_hw *hw,
49 struct i40e_aq_desc *desc,
50 void *buff, /* can be NULL */
52 struct i40e_asq_cmd_details *cmd_details);
54 /* debug function for adminq */
55 void i40e_debug_aq(struct i40e_hw *hw, enum i40e_debug_mask mask,
56 void *desc, void *buffer, u16 buf_len);
58 void i40e_idle_aq(struct i40e_hw *hw);
59 bool i40e_check_asq_alive(struct i40e_hw *hw);
60 i40e_status i40e_aq_queue_shutdown(struct i40e_hw *hw, bool unloading);
61 const char *i40e_aq_str(struct i40e_hw *hw, enum i40e_admin_queue_err aq_err);
62 const char *i40e_stat_str(struct i40e_hw *hw, i40e_status stat_err);
64 i40e_status i40e_aq_get_rss_lut(struct i40e_hw *hw, u16 seid,
65 bool pf_lut, u8 *lut, u16 lut_size);
66 i40e_status i40e_aq_set_rss_lut(struct i40e_hw *hw, u16 seid,
67 bool pf_lut, u8 *lut, u16 lut_size);
68 i40e_status i40e_aq_get_rss_key(struct i40e_hw *hw,
70 struct i40e_aqc_get_set_rss_key_data *key);
71 i40e_status i40e_aq_set_rss_key(struct i40e_hw *hw,
73 struct i40e_aqc_get_set_rss_key_data *key);
75 u32 i40e_led_get(struct i40e_hw *hw);
76 void i40e_led_set(struct i40e_hw *hw, u32 mode, bool blink);
78 /* admin send queue commands */
80 i40e_status i40e_aq_get_firmware_version(struct i40e_hw *hw,
81 u16 *fw_major_version, u16 *fw_minor_version,
83 u16 *api_major_version, u16 *api_minor_version,
84 struct i40e_asq_cmd_details *cmd_details);
85 i40e_status i40e_aq_debug_write_register(struct i40e_hw *hw,
86 u32 reg_addr, u64 reg_val,
87 struct i40e_asq_cmd_details *cmd_details);
88 i40e_status i40e_aq_debug_read_register(struct i40e_hw *hw,
89 u32 reg_addr, u64 *reg_val,
90 struct i40e_asq_cmd_details *cmd_details);
91 i40e_status i40e_aq_set_phy_debug(struct i40e_hw *hw, u8 cmd_flags,
92 struct i40e_asq_cmd_details *cmd_details);
93 i40e_status i40e_aq_set_default_vsi(struct i40e_hw *hw, u16 vsi_id,
94 struct i40e_asq_cmd_details *cmd_details);
95 enum i40e_status_code i40e_aq_get_phy_capabilities(struct i40e_hw *hw,
96 bool qualified_modules, bool report_init,
97 struct i40e_aq_get_phy_abilities_resp *abilities,
98 struct i40e_asq_cmd_details *cmd_details);
99 enum i40e_status_code i40e_aq_set_phy_config(struct i40e_hw *hw,
100 struct i40e_aq_set_phy_config *config,
101 struct i40e_asq_cmd_details *cmd_details);
102 enum i40e_status_code i40e_set_fc(struct i40e_hw *hw, u8 *aq_failures,
104 i40e_status i40e_aq_set_phy_int_mask(struct i40e_hw *hw, u16 mask,
105 struct i40e_asq_cmd_details *cmd_details);
106 i40e_status i40e_aq_clear_pxe_mode(struct i40e_hw *hw,
107 struct i40e_asq_cmd_details *cmd_details);
108 i40e_status i40e_aq_set_link_restart_an(struct i40e_hw *hw,
110 struct i40e_asq_cmd_details *cmd_details);
111 i40e_status i40e_aq_get_link_info(struct i40e_hw *hw,
112 bool enable_lse, struct i40e_link_status *link,
113 struct i40e_asq_cmd_details *cmd_details);
114 i40e_status i40e_aq_set_local_advt_reg(struct i40e_hw *hw,
116 struct i40e_asq_cmd_details *cmd_details);
117 i40e_status i40e_aq_send_driver_version(struct i40e_hw *hw,
118 struct i40e_driver_version *dv,
119 struct i40e_asq_cmd_details *cmd_details);
120 i40e_status i40e_aq_add_vsi(struct i40e_hw *hw,
121 struct i40e_vsi_context *vsi_ctx,
122 struct i40e_asq_cmd_details *cmd_details);
123 i40e_status i40e_aq_set_vsi_broadcast(struct i40e_hw *hw,
124 u16 vsi_id, bool set_filter,
125 struct i40e_asq_cmd_details *cmd_details);
126 i40e_status i40e_aq_set_vsi_unicast_promiscuous(struct i40e_hw *hw,
127 u16 vsi_id, bool set, struct i40e_asq_cmd_details *cmd_details);
128 i40e_status i40e_aq_set_vsi_multicast_promiscuous(struct i40e_hw *hw,
129 u16 vsi_id, bool set, struct i40e_asq_cmd_details *cmd_details);
130 i40e_status i40e_aq_get_vsi_params(struct i40e_hw *hw,
131 struct i40e_vsi_context *vsi_ctx,
132 struct i40e_asq_cmd_details *cmd_details);
133 i40e_status i40e_aq_update_vsi_params(struct i40e_hw *hw,
134 struct i40e_vsi_context *vsi_ctx,
135 struct i40e_asq_cmd_details *cmd_details);
136 i40e_status i40e_aq_add_veb(struct i40e_hw *hw, u16 uplink_seid,
137 u16 downlink_seid, u8 enabled_tc,
138 bool default_port, bool enable_l2_filtering,
140 struct i40e_asq_cmd_details *cmd_details);
141 i40e_status i40e_aq_get_veb_parameters(struct i40e_hw *hw,
142 u16 veb_seid, u16 *switch_id, bool *floating,
143 u16 *statistic_index, u16 *vebs_used,
145 struct i40e_asq_cmd_details *cmd_details);
146 i40e_status i40e_aq_add_macvlan(struct i40e_hw *hw, u16 vsi_id,
147 struct i40e_aqc_add_macvlan_element_data *mv_list,
148 u16 count, struct i40e_asq_cmd_details *cmd_details);
149 i40e_status i40e_aq_remove_macvlan(struct i40e_hw *hw, u16 vsi_id,
150 struct i40e_aqc_remove_macvlan_element_data *mv_list,
151 u16 count, struct i40e_asq_cmd_details *cmd_details);
152 i40e_status i40e_aq_send_msg_to_vf(struct i40e_hw *hw, u16 vfid,
153 u32 v_opcode, u32 v_retval, u8 *msg, u16 msglen,
154 struct i40e_asq_cmd_details *cmd_details);
155 i40e_status i40e_aq_get_switch_config(struct i40e_hw *hw,
156 struct i40e_aqc_get_switch_config_resp *buf,
157 u16 buf_size, u16 *start_seid,
158 struct i40e_asq_cmd_details *cmd_details);
159 i40e_status i40e_aq_request_resource(struct i40e_hw *hw,
160 enum i40e_aq_resources_ids resource,
161 enum i40e_aq_resource_access_type access,
162 u8 sdp_number, u64 *timeout,
163 struct i40e_asq_cmd_details *cmd_details);
164 i40e_status i40e_aq_release_resource(struct i40e_hw *hw,
165 enum i40e_aq_resources_ids resource,
167 struct i40e_asq_cmd_details *cmd_details);
168 i40e_status i40e_aq_read_nvm(struct i40e_hw *hw, u8 module_pointer,
169 u32 offset, u16 length, void *data,
171 struct i40e_asq_cmd_details *cmd_details);
172 i40e_status i40e_aq_erase_nvm(struct i40e_hw *hw, u8 module_pointer,
173 u32 offset, u16 length, bool last_command,
174 struct i40e_asq_cmd_details *cmd_details);
175 i40e_status i40e_aq_discover_capabilities(struct i40e_hw *hw,
176 void *buff, u16 buff_size, u16 *data_size,
177 enum i40e_admin_queue_opc list_type_opc,
178 struct i40e_asq_cmd_details *cmd_details);
179 i40e_status i40e_aq_update_nvm(struct i40e_hw *hw, u8 module_pointer,
180 u32 offset, u16 length, void *data,
182 struct i40e_asq_cmd_details *cmd_details);
183 i40e_status i40e_aq_get_lldp_mib(struct i40e_hw *hw, u8 bridge_type,
184 u8 mib_type, void *buff, u16 buff_size,
185 u16 *local_len, u16 *remote_len,
186 struct i40e_asq_cmd_details *cmd_details);
187 i40e_status i40e_aq_cfg_lldp_mib_change_event(struct i40e_hw *hw,
189 struct i40e_asq_cmd_details *cmd_details);
190 i40e_status i40e_aq_stop_lldp(struct i40e_hw *hw, bool shutdown_agent,
191 struct i40e_asq_cmd_details *cmd_details);
192 i40e_status i40e_aq_start_lldp(struct i40e_hw *hw,
193 struct i40e_asq_cmd_details *cmd_details);
194 i40e_status i40e_aq_get_cee_dcb_config(struct i40e_hw *hw,
195 void *buff, u16 buff_size,
196 struct i40e_asq_cmd_details *cmd_details);
197 i40e_status i40e_aq_add_udp_tunnel(struct i40e_hw *hw,
198 u16 udp_port, u8 protocol_index,
200 struct i40e_asq_cmd_details *cmd_details);
201 i40e_status i40e_aq_del_udp_tunnel(struct i40e_hw *hw, u8 index,
202 struct i40e_asq_cmd_details *cmd_details);
203 i40e_status i40e_aq_delete_element(struct i40e_hw *hw, u16 seid,
204 struct i40e_asq_cmd_details *cmd_details);
205 i40e_status i40e_aq_mac_address_write(struct i40e_hw *hw,
206 u16 flags, u8 *mac_addr,
207 struct i40e_asq_cmd_details *cmd_details);
208 i40e_status i40e_aq_config_vsi_bw_limit(struct i40e_hw *hw,
209 u16 seid, u16 credit, u8 max_credit,
210 struct i40e_asq_cmd_details *cmd_details);
211 i40e_status i40e_aq_dcb_updated(struct i40e_hw *hw,
212 struct i40e_asq_cmd_details *cmd_details);
213 i40e_status i40e_aq_set_hmc_resource_profile(struct i40e_hw *hw,
214 enum i40e_aq_hmc_profile profile,
215 u8 pe_vf_enabled_count,
216 struct i40e_asq_cmd_details *cmd_details);
217 i40e_status i40e_aq_config_switch_comp_bw_limit(struct i40e_hw *hw,
218 u16 seid, u16 credit, u8 max_bw,
219 struct i40e_asq_cmd_details *cmd_details);
220 i40e_status i40e_aq_config_vsi_tc_bw(struct i40e_hw *hw, u16 seid,
221 struct i40e_aqc_configure_vsi_tc_bw_data *bw_data,
222 struct i40e_asq_cmd_details *cmd_details);
223 i40e_status i40e_aq_config_switch_comp_ets(struct i40e_hw *hw,
225 struct i40e_aqc_configure_switching_comp_ets_data *ets_data,
226 enum i40e_admin_queue_opc opcode,
227 struct i40e_asq_cmd_details *cmd_details);
228 i40e_status i40e_aq_config_switch_comp_bw_config(struct i40e_hw *hw,
230 struct i40e_aqc_configure_switching_comp_bw_config_data *bw_data,
231 struct i40e_asq_cmd_details *cmd_details);
232 i40e_status i40e_aq_query_vsi_bw_config(struct i40e_hw *hw,
234 struct i40e_aqc_query_vsi_bw_config_resp *bw_data,
235 struct i40e_asq_cmd_details *cmd_details);
236 i40e_status i40e_aq_query_vsi_ets_sla_config(struct i40e_hw *hw,
238 struct i40e_aqc_query_vsi_ets_sla_config_resp *bw_data,
239 struct i40e_asq_cmd_details *cmd_details);
240 i40e_status i40e_aq_query_switch_comp_ets_config(struct i40e_hw *hw,
242 struct i40e_aqc_query_switching_comp_ets_config_resp *bw_data,
243 struct i40e_asq_cmd_details *cmd_details);
244 i40e_status i40e_aq_query_port_ets_config(struct i40e_hw *hw,
246 struct i40e_aqc_query_port_ets_config_resp *bw_data,
247 struct i40e_asq_cmd_details *cmd_details);
248 i40e_status i40e_aq_query_switch_comp_bw_config(struct i40e_hw *hw,
250 struct i40e_aqc_query_switching_comp_bw_config_resp *bw_data,
251 struct i40e_asq_cmd_details *cmd_details);
252 i40e_status i40e_aq_resume_port_tx(struct i40e_hw *hw,
253 struct i40e_asq_cmd_details *cmd_details);
254 i40e_status i40e_read_lldp_cfg(struct i40e_hw *hw,
255 struct i40e_lldp_variables *lldp_cfg);
257 i40e_status i40e_init_shared_code(struct i40e_hw *hw);
258 i40e_status i40e_pf_reset(struct i40e_hw *hw);
259 void i40e_clear_hw(struct i40e_hw *hw);
260 void i40e_clear_pxe_mode(struct i40e_hw *hw);
261 i40e_status i40e_get_link_status(struct i40e_hw *hw, bool *link_up);
262 i40e_status i40e_update_link_info(struct i40e_hw *hw);
263 i40e_status i40e_get_mac_addr(struct i40e_hw *hw, u8 *mac_addr);
264 i40e_status i40e_read_bw_from_alt_ram(struct i40e_hw *hw,
265 u32 *max_bw, u32 *min_bw, bool *min_valid,
267 i40e_status i40e_aq_configure_partition_bw(struct i40e_hw *hw,
268 struct i40e_aqc_configure_partition_bw_data *bw_data,
269 struct i40e_asq_cmd_details *cmd_details);
270 i40e_status i40e_get_port_mac_addr(struct i40e_hw *hw, u8 *mac_addr);
271 i40e_status i40e_read_pba_string(struct i40e_hw *hw, u8 *pba_num,
273 i40e_status i40e_validate_mac_addr(u8 *mac_addr);
274 void i40e_pre_tx_queue_cfg(struct i40e_hw *hw, u32 queue, bool enable);
276 i40e_status i40e_get_san_mac_addr(struct i40e_hw *hw, u8 *mac_addr);
278 /* prototype for functions used for NVM access */
279 i40e_status i40e_init_nvm(struct i40e_hw *hw);
280 i40e_status i40e_acquire_nvm(struct i40e_hw *hw,
281 enum i40e_aq_resource_access_type access);
282 void i40e_release_nvm(struct i40e_hw *hw);
283 i40e_status i40e_read_nvm_word(struct i40e_hw *hw, u16 offset,
285 i40e_status i40e_read_nvm_buffer(struct i40e_hw *hw, u16 offset,
286 u16 *words, u16 *data);
287 i40e_status i40e_update_nvm_checksum(struct i40e_hw *hw);
288 i40e_status i40e_validate_nvm_checksum(struct i40e_hw *hw,
290 i40e_status i40e_nvmupd_command(struct i40e_hw *hw,
291 struct i40e_nvm_access *cmd,
293 void i40e_set_pci_config_data(struct i40e_hw *hw, u16 link_status);
295 extern struct i40e_rx_ptype_decoded i40e_ptype_lookup[];
297 static inline struct i40e_rx_ptype_decoded decode_rx_desc_ptype(u8 ptype)
299 return i40e_ptype_lookup[ptype];
302 /* prototype for functions used for SW locks */
304 /* i40e_common for VF drivers*/
305 void i40e_vf_parse_hw_config(struct i40e_hw *hw,
306 struct i40e_virtchnl_vf_resource *msg);
307 i40e_status i40e_vf_reset(struct i40e_hw *hw);
308 i40e_status i40e_aq_send_msg_to_pf(struct i40e_hw *hw,
309 enum i40e_virtchnl_ops v_opcode,
310 i40e_status v_retval,
312 struct i40e_asq_cmd_details *cmd_details);
313 i40e_status i40e_set_filter_control(struct i40e_hw *hw,
314 struct i40e_filter_control_settings *settings);
315 i40e_status i40e_aq_add_rem_control_packet_filter(struct i40e_hw *hw,
316 u8 *mac_addr, u16 ethtype, u16 flags,
317 u16 vsi_seid, u16 queue, bool is_add,
318 struct i40e_control_filter_stats *stats,
319 struct i40e_asq_cmd_details *cmd_details);
320 i40e_status i40e_aq_debug_dump(struct i40e_hw *hw, u8 cluster_id,
321 u8 table_id, u32 start_index, u16 buff_size,
322 void *buff, u16 *ret_buff_size,
323 u8 *ret_next_table, u32 *ret_next_index,
324 struct i40e_asq_cmd_details *cmd_details);
325 void i40e_add_filter_to_drop_tx_flow_control_frames(struct i40e_hw *hw,
327 #endif /* _I40E_PROTOTYPE_H_ */