1 /******************************************************************************* 2 * 3 * Intel Ethernet Controller XL710 Family Linux Driver 4 * Copyright(c) 2013 - 2016 Intel Corporation. 5 * 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. 9 * 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 13 * more details. 14 * 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/>. 17 * 18 * The full GNU General Public License is included in this distribution in 19 * the file called "COPYING". 20 * 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 24 * 25 ******************************************************************************/ 26 27 #ifndef _I40E_PROTOTYPE_H_ 28 #define _I40E_PROTOTYPE_H_ 29 30 #include "i40e_type.h" 31 #include "i40e_alloc.h" 32 #include "i40e_virtchnl.h" 33 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 38 * setup. 39 */ 40 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, 47 u16 *events_pending); 48 i40e_status i40e_asq_send_command(struct i40e_hw *hw, 49 struct i40e_aq_desc *desc, 50 void *buff, /* can be NULL */ 51 u16 buff_size, 52 struct i40e_asq_cmd_details *cmd_details); 53 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); 57 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); 63 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, 69 u16 seid, 70 struct i40e_aqc_get_set_rss_key_data *key); 71 i40e_status i40e_aq_set_rss_key(struct i40e_hw *hw, 72 u16 seid, 73 struct i40e_aqc_get_set_rss_key_data *key); 74 75 u32 i40e_led_get(struct i40e_hw *hw); 76 void i40e_led_set(struct i40e_hw *hw, u32 mode, bool blink); 77 i40e_status i40e_led_set_phy(struct i40e_hw *hw, bool on, 78 u16 led_addr, u32 mode); 79 i40e_status i40e_led_get_phy(struct i40e_hw *hw, u16 *led_addr, 80 u16 *val); 81 i40e_status i40e_blink_phy_link_led(struct i40e_hw *hw, 82 u32 time, u32 interval); 83 84 /* admin send queue commands */ 85 86 i40e_status i40e_aq_get_firmware_version(struct i40e_hw *hw, 87 u16 *fw_major_version, u16 *fw_minor_version, 88 u32 *fw_build, 89 u16 *api_major_version, u16 *api_minor_version, 90 struct i40e_asq_cmd_details *cmd_details); 91 i40e_status i40e_aq_debug_write_register(struct i40e_hw *hw, 92 u32 reg_addr, u64 reg_val, 93 struct i40e_asq_cmd_details *cmd_details); 94 i40e_status i40e_aq_debug_read_register(struct i40e_hw *hw, 95 u32 reg_addr, u64 *reg_val, 96 struct i40e_asq_cmd_details *cmd_details); 97 i40e_status i40e_aq_set_phy_debug(struct i40e_hw *hw, u8 cmd_flags, 98 struct i40e_asq_cmd_details *cmd_details); 99 i40e_status i40e_aq_set_default_vsi(struct i40e_hw *hw, u16 vsi_id, 100 struct i40e_asq_cmd_details *cmd_details); 101 i40e_status i40e_aq_clear_default_vsi(struct i40e_hw *hw, u16 vsi_id, 102 struct i40e_asq_cmd_details *cmd_details); 103 enum i40e_status_code i40e_aq_get_phy_capabilities(struct i40e_hw *hw, 104 bool qualified_modules, bool report_init, 105 struct i40e_aq_get_phy_abilities_resp *abilities, 106 struct i40e_asq_cmd_details *cmd_details); 107 enum i40e_status_code i40e_aq_set_phy_config(struct i40e_hw *hw, 108 struct i40e_aq_set_phy_config *config, 109 struct i40e_asq_cmd_details *cmd_details); 110 enum i40e_status_code i40e_set_fc(struct i40e_hw *hw, u8 *aq_failures, 111 bool atomic_reset); 112 i40e_status i40e_aq_set_phy_int_mask(struct i40e_hw *hw, u16 mask, 113 struct i40e_asq_cmd_details *cmd_details); 114 i40e_status i40e_aq_clear_pxe_mode(struct i40e_hw *hw, 115 struct i40e_asq_cmd_details *cmd_details); 116 i40e_status i40e_aq_set_link_restart_an(struct i40e_hw *hw, 117 bool enable_link, 118 struct i40e_asq_cmd_details *cmd_details); 119 i40e_status i40e_aq_get_link_info(struct i40e_hw *hw, 120 bool enable_lse, struct i40e_link_status *link, 121 struct i40e_asq_cmd_details *cmd_details); 122 i40e_status i40e_aq_set_local_advt_reg(struct i40e_hw *hw, 123 u64 advt_reg, 124 struct i40e_asq_cmd_details *cmd_details); 125 i40e_status i40e_aq_send_driver_version(struct i40e_hw *hw, 126 struct i40e_driver_version *dv, 127 struct i40e_asq_cmd_details *cmd_details); 128 i40e_status i40e_aq_add_vsi(struct i40e_hw *hw, 129 struct i40e_vsi_context *vsi_ctx, 130 struct i40e_asq_cmd_details *cmd_details); 131 i40e_status i40e_aq_set_vsi_broadcast(struct i40e_hw *hw, 132 u16 vsi_id, bool set_filter, 133 struct i40e_asq_cmd_details *cmd_details); 134 i40e_status i40e_aq_set_vsi_unicast_promiscuous(struct i40e_hw *hw, 135 u16 vsi_id, bool set, struct i40e_asq_cmd_details *cmd_details, 136 bool rx_only_promisc); 137 i40e_status i40e_aq_set_vsi_multicast_promiscuous(struct i40e_hw *hw, 138 u16 vsi_id, bool set, struct i40e_asq_cmd_details *cmd_details); 139 enum i40e_status_code i40e_aq_set_vsi_mc_promisc_on_vlan(struct i40e_hw *hw, 140 u16 seid, bool enable, 141 u16 vid, 142 struct i40e_asq_cmd_details *cmd_details); 143 enum i40e_status_code i40e_aq_set_vsi_uc_promisc_on_vlan(struct i40e_hw *hw, 144 u16 seid, bool enable, 145 u16 vid, 146 struct i40e_asq_cmd_details *cmd_details); 147 i40e_status i40e_aq_set_vsi_vlan_promisc(struct i40e_hw *hw, 148 u16 seid, bool enable, 149 struct i40e_asq_cmd_details *cmd_details); 150 i40e_status i40e_aq_get_vsi_params(struct i40e_hw *hw, 151 struct i40e_vsi_context *vsi_ctx, 152 struct i40e_asq_cmd_details *cmd_details); 153 i40e_status i40e_aq_update_vsi_params(struct i40e_hw *hw, 154 struct i40e_vsi_context *vsi_ctx, 155 struct i40e_asq_cmd_details *cmd_details); 156 i40e_status i40e_aq_add_veb(struct i40e_hw *hw, u16 uplink_seid, 157 u16 downlink_seid, u8 enabled_tc, 158 bool default_port, u16 *pveb_seid, 159 bool enable_stats, 160 struct i40e_asq_cmd_details *cmd_details); 161 i40e_status i40e_aq_get_veb_parameters(struct i40e_hw *hw, 162 u16 veb_seid, u16 *switch_id, bool *floating, 163 u16 *statistic_index, u16 *vebs_used, 164 u16 *vebs_free, 165 struct i40e_asq_cmd_details *cmd_details); 166 i40e_status i40e_aq_add_macvlan(struct i40e_hw *hw, u16 vsi_id, 167 struct i40e_aqc_add_macvlan_element_data *mv_list, 168 u16 count, struct i40e_asq_cmd_details *cmd_details); 169 i40e_status i40e_aq_remove_macvlan(struct i40e_hw *hw, u16 vsi_id, 170 struct i40e_aqc_remove_macvlan_element_data *mv_list, 171 u16 count, struct i40e_asq_cmd_details *cmd_details); 172 i40e_status i40e_aq_add_mirrorrule(struct i40e_hw *hw, u16 sw_seid, 173 u16 rule_type, u16 dest_vsi, u16 count, __le16 *mr_list, 174 struct i40e_asq_cmd_details *cmd_details, 175 u16 *rule_id, u16 *rules_used, u16 *rules_free); 176 i40e_status i40e_aq_delete_mirrorrule(struct i40e_hw *hw, u16 sw_seid, 177 u16 rule_type, u16 rule_id, u16 count, __le16 *mr_list, 178 struct i40e_asq_cmd_details *cmd_details, 179 u16 *rules_used, u16 *rules_free); 180 181 i40e_status i40e_aq_send_msg_to_vf(struct i40e_hw *hw, u16 vfid, 182 u32 v_opcode, u32 v_retval, u8 *msg, u16 msglen, 183 struct i40e_asq_cmd_details *cmd_details); 184 i40e_status i40e_aq_get_switch_config(struct i40e_hw *hw, 185 struct i40e_aqc_get_switch_config_resp *buf, 186 u16 buf_size, u16 *start_seid, 187 struct i40e_asq_cmd_details *cmd_details); 188 enum i40e_status_code i40e_aq_set_switch_config(struct i40e_hw *hw, 189 u16 flags, 190 u16 valid_flags, 191 struct i40e_asq_cmd_details *cmd_details); 192 i40e_status i40e_aq_request_resource(struct i40e_hw *hw, 193 enum i40e_aq_resources_ids resource, 194 enum i40e_aq_resource_access_type access, 195 u8 sdp_number, u64 *timeout, 196 struct i40e_asq_cmd_details *cmd_details); 197 i40e_status i40e_aq_release_resource(struct i40e_hw *hw, 198 enum i40e_aq_resources_ids resource, 199 u8 sdp_number, 200 struct i40e_asq_cmd_details *cmd_details); 201 i40e_status i40e_aq_read_nvm(struct i40e_hw *hw, u8 module_pointer, 202 u32 offset, u16 length, void *data, 203 bool last_command, 204 struct i40e_asq_cmd_details *cmd_details); 205 i40e_status i40e_aq_erase_nvm(struct i40e_hw *hw, u8 module_pointer, 206 u32 offset, u16 length, bool last_command, 207 struct i40e_asq_cmd_details *cmd_details); 208 i40e_status i40e_aq_discover_capabilities(struct i40e_hw *hw, 209 void *buff, u16 buff_size, u16 *data_size, 210 enum i40e_admin_queue_opc list_type_opc, 211 struct i40e_asq_cmd_details *cmd_details); 212 i40e_status i40e_aq_update_nvm(struct i40e_hw *hw, u8 module_pointer, 213 u32 offset, u16 length, void *data, 214 bool last_command, 215 struct i40e_asq_cmd_details *cmd_details); 216 i40e_status i40e_aq_get_lldp_mib(struct i40e_hw *hw, u8 bridge_type, 217 u8 mib_type, void *buff, u16 buff_size, 218 u16 *local_len, u16 *remote_len, 219 struct i40e_asq_cmd_details *cmd_details); 220 i40e_status i40e_aq_cfg_lldp_mib_change_event(struct i40e_hw *hw, 221 bool enable_update, 222 struct i40e_asq_cmd_details *cmd_details); 223 i40e_status i40e_aq_stop_lldp(struct i40e_hw *hw, bool shutdown_agent, 224 struct i40e_asq_cmd_details *cmd_details); 225 i40e_status i40e_aq_start_lldp(struct i40e_hw *hw, 226 struct i40e_asq_cmd_details *cmd_details); 227 i40e_status i40e_aq_get_cee_dcb_config(struct i40e_hw *hw, 228 void *buff, u16 buff_size, 229 struct i40e_asq_cmd_details *cmd_details); 230 i40e_status i40e_aq_add_udp_tunnel(struct i40e_hw *hw, 231 u16 udp_port, u8 protocol_index, 232 u8 *filter_index, 233 struct i40e_asq_cmd_details *cmd_details); 234 i40e_status i40e_aq_del_udp_tunnel(struct i40e_hw *hw, u8 index, 235 struct i40e_asq_cmd_details *cmd_details); 236 i40e_status i40e_aq_delete_element(struct i40e_hw *hw, u16 seid, 237 struct i40e_asq_cmd_details *cmd_details); 238 i40e_status i40e_aq_mac_address_write(struct i40e_hw *hw, 239 u16 flags, u8 *mac_addr, 240 struct i40e_asq_cmd_details *cmd_details); 241 i40e_status i40e_aq_config_vsi_bw_limit(struct i40e_hw *hw, 242 u16 seid, u16 credit, u8 max_credit, 243 struct i40e_asq_cmd_details *cmd_details); 244 i40e_status i40e_aq_dcb_updated(struct i40e_hw *hw, 245 struct i40e_asq_cmd_details *cmd_details); 246 i40e_status i40e_aq_config_switch_comp_bw_limit(struct i40e_hw *hw, 247 u16 seid, u16 credit, u8 max_bw, 248 struct i40e_asq_cmd_details *cmd_details); 249 i40e_status i40e_aq_config_vsi_tc_bw(struct i40e_hw *hw, u16 seid, 250 struct i40e_aqc_configure_vsi_tc_bw_data *bw_data, 251 struct i40e_asq_cmd_details *cmd_details); 252 i40e_status i40e_aq_config_switch_comp_ets(struct i40e_hw *hw, 253 u16 seid, 254 struct i40e_aqc_configure_switching_comp_ets_data *ets_data, 255 enum i40e_admin_queue_opc opcode, 256 struct i40e_asq_cmd_details *cmd_details); 257 i40e_status i40e_aq_config_switch_comp_bw_config(struct i40e_hw *hw, 258 u16 seid, 259 struct i40e_aqc_configure_switching_comp_bw_config_data *bw_data, 260 struct i40e_asq_cmd_details *cmd_details); 261 i40e_status i40e_aq_query_vsi_bw_config(struct i40e_hw *hw, 262 u16 seid, 263 struct i40e_aqc_query_vsi_bw_config_resp *bw_data, 264 struct i40e_asq_cmd_details *cmd_details); 265 i40e_status i40e_aq_query_vsi_ets_sla_config(struct i40e_hw *hw, 266 u16 seid, 267 struct i40e_aqc_query_vsi_ets_sla_config_resp *bw_data, 268 struct i40e_asq_cmd_details *cmd_details); 269 i40e_status i40e_aq_query_switch_comp_ets_config(struct i40e_hw *hw, 270 u16 seid, 271 struct i40e_aqc_query_switching_comp_ets_config_resp *bw_data, 272 struct i40e_asq_cmd_details *cmd_details); 273 i40e_status i40e_aq_query_port_ets_config(struct i40e_hw *hw, 274 u16 seid, 275 struct i40e_aqc_query_port_ets_config_resp *bw_data, 276 struct i40e_asq_cmd_details *cmd_details); 277 i40e_status i40e_aq_query_switch_comp_bw_config(struct i40e_hw *hw, 278 u16 seid, 279 struct i40e_aqc_query_switching_comp_bw_config_resp *bw_data, 280 struct i40e_asq_cmd_details *cmd_details); 281 i40e_status i40e_aq_resume_port_tx(struct i40e_hw *hw, 282 struct i40e_asq_cmd_details *cmd_details); 283 i40e_status i40e_read_lldp_cfg(struct i40e_hw *hw, 284 struct i40e_lldp_variables *lldp_cfg); 285 /* i40e_common */ 286 i40e_status i40e_init_shared_code(struct i40e_hw *hw); 287 i40e_status i40e_pf_reset(struct i40e_hw *hw); 288 void i40e_clear_hw(struct i40e_hw *hw); 289 void i40e_clear_pxe_mode(struct i40e_hw *hw); 290 i40e_status i40e_get_link_status(struct i40e_hw *hw, bool *link_up); 291 i40e_status i40e_update_link_info(struct i40e_hw *hw); 292 i40e_status i40e_get_mac_addr(struct i40e_hw *hw, u8 *mac_addr); 293 i40e_status i40e_read_bw_from_alt_ram(struct i40e_hw *hw, 294 u32 *max_bw, u32 *min_bw, bool *min_valid, 295 bool *max_valid); 296 i40e_status i40e_aq_configure_partition_bw(struct i40e_hw *hw, 297 struct i40e_aqc_configure_partition_bw_data *bw_data, 298 struct i40e_asq_cmd_details *cmd_details); 299 i40e_status i40e_get_port_mac_addr(struct i40e_hw *hw, u8 *mac_addr); 300 i40e_status i40e_read_pba_string(struct i40e_hw *hw, u8 *pba_num, 301 u32 pba_num_size); 302 i40e_status i40e_validate_mac_addr(u8 *mac_addr); 303 void i40e_pre_tx_queue_cfg(struct i40e_hw *hw, u32 queue, bool enable); 304 #ifdef I40E_FCOE 305 i40e_status i40e_get_san_mac_addr(struct i40e_hw *hw, u8 *mac_addr); 306 #endif 307 /* prototype for functions used for NVM access */ 308 i40e_status i40e_init_nvm(struct i40e_hw *hw); 309 i40e_status i40e_acquire_nvm(struct i40e_hw *hw, 310 enum i40e_aq_resource_access_type access); 311 void i40e_release_nvm(struct i40e_hw *hw); 312 i40e_status i40e_read_nvm_word(struct i40e_hw *hw, u16 offset, 313 u16 *data); 314 i40e_status i40e_read_nvm_buffer(struct i40e_hw *hw, u16 offset, 315 u16 *words, u16 *data); 316 i40e_status i40e_update_nvm_checksum(struct i40e_hw *hw); 317 i40e_status i40e_validate_nvm_checksum(struct i40e_hw *hw, 318 u16 *checksum); 319 i40e_status i40e_nvmupd_command(struct i40e_hw *hw, 320 struct i40e_nvm_access *cmd, 321 u8 *bytes, int *); 322 void i40e_nvmupd_check_wait_event(struct i40e_hw *hw, u16 opcode); 323 void i40e_set_pci_config_data(struct i40e_hw *hw, u16 link_status); 324 325 extern struct i40e_rx_ptype_decoded i40e_ptype_lookup[]; 326 327 static inline struct i40e_rx_ptype_decoded decode_rx_desc_ptype(u8 ptype) 328 { 329 return i40e_ptype_lookup[ptype]; 330 } 331 332 /* prototype for functions used for SW locks */ 333 334 /* i40e_common for VF drivers*/ 335 void i40e_vf_parse_hw_config(struct i40e_hw *hw, 336 struct i40e_virtchnl_vf_resource *msg); 337 i40e_status i40e_vf_reset(struct i40e_hw *hw); 338 i40e_status i40e_aq_send_msg_to_pf(struct i40e_hw *hw, 339 enum i40e_virtchnl_ops v_opcode, 340 i40e_status v_retval, 341 u8 *msg, u16 msglen, 342 struct i40e_asq_cmd_details *cmd_details); 343 i40e_status i40e_set_filter_control(struct i40e_hw *hw, 344 struct i40e_filter_control_settings *settings); 345 i40e_status i40e_aq_add_rem_control_packet_filter(struct i40e_hw *hw, 346 u8 *mac_addr, u16 ethtype, u16 flags, 347 u16 vsi_seid, u16 queue, bool is_add, 348 struct i40e_control_filter_stats *stats, 349 struct i40e_asq_cmd_details *cmd_details); 350 i40e_status i40e_aq_debug_dump(struct i40e_hw *hw, u8 cluster_id, 351 u8 table_id, u32 start_index, u16 buff_size, 352 void *buff, u16 *ret_buff_size, 353 u8 *ret_next_table, u32 *ret_next_index, 354 struct i40e_asq_cmd_details *cmd_details); 355 void i40e_add_filter_to_drop_tx_flow_control_frames(struct i40e_hw *hw, 356 u16 vsi_seid); 357 i40e_status i40e_aq_rx_ctl_read_register(struct i40e_hw *hw, 358 u32 reg_addr, u32 *reg_val, 359 struct i40e_asq_cmd_details *cmd_details); 360 u32 i40e_read_rx_ctl(struct i40e_hw *hw, u32 reg_addr); 361 i40e_status i40e_aq_rx_ctl_write_register(struct i40e_hw *hw, 362 u32 reg_addr, u32 reg_val, 363 struct i40e_asq_cmd_details *cmd_details); 364 void i40e_write_rx_ctl(struct i40e_hw *hw, u32 reg_addr, u32 reg_val); 365 i40e_status i40e_read_phy_register(struct i40e_hw *hw, u8 page, 366 u16 reg, u8 phy_addr, u16 *value); 367 i40e_status i40e_write_phy_register(struct i40e_hw *hw, u8 page, 368 u16 reg, u8 phy_addr, u16 value); 369 u8 i40e_get_phy_address(struct i40e_hw *hw, u8 dev_num); 370 i40e_status i40e_blink_phy_link_led(struct i40e_hw *hw, 371 u32 time, u32 interval); 372 #endif /* _I40E_PROTOTYPE_H_ */ 373