drivers/net/ethernet/intel/i40e/i40e_prototype.h

   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 enum i40e_status_code i40e_aq_get_phy_capabilities(struct i40e_hw *hw,
 102                         bool qualified_modules, bool report_init,
 103                         struct i40e_aq_get_phy_abilities_resp *abilities,
 104                         struct i40e_asq_cmd_details *cmd_details);
 105 enum i40e_status_code i40e_aq_set_phy_config(struct i40e_hw *hw,
 106                                 struct i40e_aq_set_phy_config *config,
 107                                 struct i40e_asq_cmd_details *cmd_details);
 108 enum i40e_status_code i40e_set_fc(struct i40e_hw *hw, u8 *aq_failures,
 109                                   bool atomic_reset);
 110 i40e_status i40e_aq_set_phy_int_mask(struct i40e_hw *hw, u16 mask,
 111                                      struct i40e_asq_cmd_details *cmd_details);
 112 i40e_status i40e_aq_clear_pxe_mode(struct i40e_hw *hw,
 113                                 struct i40e_asq_cmd_details *cmd_details);
 114 i40e_status i40e_aq_set_link_restart_an(struct i40e_hw *hw,
 115                                         bool enable_link,
 116                                         struct i40e_asq_cmd_details *cmd_details);
 117 i40e_status i40e_aq_get_link_info(struct i40e_hw *hw,
 118                                 bool enable_lse, struct i40e_link_status *link,
 119                                 struct i40e_asq_cmd_details *cmd_details);
 120 i40e_status i40e_aq_set_local_advt_reg(struct i40e_hw *hw,
 121                                 u64 advt_reg,
 122                                 struct i40e_asq_cmd_details *cmd_details);
 123 i40e_status i40e_aq_send_driver_version(struct i40e_hw *hw,
 124                                 struct i40e_driver_version *dv,
 125                                 struct i40e_asq_cmd_details *cmd_details);
 126 i40e_status i40e_aq_add_vsi(struct i40e_hw *hw,
 127                                 struct i40e_vsi_context *vsi_ctx,
 128                                 struct i40e_asq_cmd_details *cmd_details);
 129 i40e_status i40e_aq_set_vsi_broadcast(struct i40e_hw *hw,
 130                                 u16 vsi_id, bool set_filter,
 131                                 struct i40e_asq_cmd_details *cmd_details);
 132 i40e_status i40e_aq_set_vsi_unicast_promiscuous(struct i40e_hw *hw,
 133                 u16 vsi_id, bool set, struct i40e_asq_cmd_details *cmd_details,
 134                 bool rx_only_promisc);
 135 i40e_status i40e_aq_set_vsi_multicast_promiscuous(struct i40e_hw *hw,
 136                 u16 vsi_id, bool set, struct i40e_asq_cmd_details *cmd_details);
 137 enum i40e_status_code i40e_aq_set_vsi_mc_promisc_on_vlan(struct i40e_hw *hw,
 138                                                          u16 seid, bool enable,
 139                                                          u16 vid,
 140                                 struct i40e_asq_cmd_details *cmd_details);
 141 enum i40e_status_code i40e_aq_set_vsi_uc_promisc_on_vlan(struct i40e_hw *hw,
 142                                                          u16 seid, bool enable,
 143                                                          u16 vid,
 144                                 struct i40e_asq_cmd_details *cmd_details);
 145 i40e_status i40e_aq_set_vsi_vlan_promisc(struct i40e_hw *hw,
 146                                 u16 seid, bool enable,
 147                                 struct i40e_asq_cmd_details *cmd_details);
 148 i40e_status i40e_aq_get_vsi_params(struct i40e_hw *hw,
 149                                 struct i40e_vsi_context *vsi_ctx,
 150                                 struct i40e_asq_cmd_details *cmd_details);
 151 i40e_status i40e_aq_update_vsi_params(struct i40e_hw *hw,
 152                                 struct i40e_vsi_context *vsi_ctx,
 153                                 struct i40e_asq_cmd_details *cmd_details);
 154 i40e_status i40e_aq_add_veb(struct i40e_hw *hw, u16 uplink_seid,
 155                                 u16 downlink_seid, u8 enabled_tc,
 156                                 bool default_port, u16 *pveb_seid,
 157                                 bool enable_stats,
 158                                 struct i40e_asq_cmd_details *cmd_details);
 159 i40e_status i40e_aq_get_veb_parameters(struct i40e_hw *hw,
 160                                 u16 veb_seid, u16 *switch_id, bool *floating,
 161                                 u16 *statistic_index, u16 *vebs_used,
 162                                 u16 *vebs_free,
 163                                 struct i40e_asq_cmd_details *cmd_details);
 164 i40e_status i40e_aq_add_macvlan(struct i40e_hw *hw, u16 vsi_id,
 165                         struct i40e_aqc_add_macvlan_element_data *mv_list,
 166                         u16 count, struct i40e_asq_cmd_details *cmd_details);
 167 i40e_status i40e_aq_remove_macvlan(struct i40e_hw *hw, u16 vsi_id,
 168                         struct i40e_aqc_remove_macvlan_element_data *mv_list,
 169                         u16 count, struct i40e_asq_cmd_details *cmd_details);
 170 i40e_status i40e_aq_add_mirrorrule(struct i40e_hw *hw, u16 sw_seid,
 171                         u16 rule_type, u16 dest_vsi, u16 count, __le16 *mr_list,
 172                         struct i40e_asq_cmd_details *cmd_details,
 173                         u16 *rule_id, u16 *rules_used, u16 *rules_free);
 174 i40e_status i40e_aq_delete_mirrorrule(struct i40e_hw *hw, u16 sw_seid,
 175                         u16 rule_type, u16 rule_id, u16 count, __le16 *mr_list,
 176                         struct i40e_asq_cmd_details *cmd_details,
 177                         u16 *rules_used, u16 *rules_free);
 178
 179 i40e_status i40e_aq_send_msg_to_vf(struct i40e_hw *hw, u16 vfid,
 180                                 u32 v_opcode, u32 v_retval, u8 *msg, u16 msglen,
 181                                 struct i40e_asq_cmd_details *cmd_details);
 182 i40e_status i40e_aq_get_switch_config(struct i40e_hw *hw,
 183                                 struct i40e_aqc_get_switch_config_resp *buf,
 184                                 u16 buf_size, u16 *start_seid,
 185                                 struct i40e_asq_cmd_details *cmd_details);
 186 enum i40e_status_code i40e_aq_set_switch_config(struct i40e_hw *hw,
 187                                                 u16 flags,
 188                                                 u16 valid_flags,
 189                                 struct i40e_asq_cmd_details *cmd_details);
 190 i40e_status i40e_aq_request_resource(struct i40e_hw *hw,
 191                                 enum i40e_aq_resources_ids resource,
 192                                 enum i40e_aq_resource_access_type access,
 193                                 u8 sdp_number, u64 *timeout,
 194                                 struct i40e_asq_cmd_details *cmd_details);
 195 i40e_status i40e_aq_release_resource(struct i40e_hw *hw,
 196                                 enum i40e_aq_resources_ids resource,
 197                                 u8 sdp_number,
 198                                 struct i40e_asq_cmd_details *cmd_details);
 199 i40e_status i40e_aq_read_nvm(struct i40e_hw *hw, u8 module_pointer,
 200                                 u32 offset, u16 length, void *data,
 201                                 bool last_command,
 202                                 struct i40e_asq_cmd_details *cmd_details);
 203 i40e_status i40e_aq_erase_nvm(struct i40e_hw *hw, u8 module_pointer,
 204                               u32 offset, u16 length, bool last_command,
 205                               struct i40e_asq_cmd_details *cmd_details);
 206 i40e_status i40e_aq_discover_capabilities(struct i40e_hw *hw,
 207                                 void *buff, u16 buff_size, u16 *data_size,
 208                                 enum i40e_admin_queue_opc list_type_opc,
 209                                 struct i40e_asq_cmd_details *cmd_details);
 210 i40e_status i40e_aq_update_nvm(struct i40e_hw *hw, u8 module_pointer,
 211                                 u32 offset, u16 length, void *data,
 212                                 bool last_command,
 213                                 struct i40e_asq_cmd_details *cmd_details);
 214 i40e_status i40e_aq_get_lldp_mib(struct i40e_hw *hw, u8 bridge_type,
 215                                 u8 mib_type, void *buff, u16 buff_size,
 216                                 u16 *local_len, u16 *remote_len,
 217                                 struct i40e_asq_cmd_details *cmd_details);
 218 i40e_status i40e_aq_cfg_lldp_mib_change_event(struct i40e_hw *hw,
 219                                 bool enable_update,
 220                                 struct i40e_asq_cmd_details *cmd_details);
 221 i40e_status i40e_aq_stop_lldp(struct i40e_hw *hw, bool shutdown_agent,
 222                                 struct i40e_asq_cmd_details *cmd_details);
 223 i40e_status i40e_aq_start_lldp(struct i40e_hw *hw,
 224                                 struct i40e_asq_cmd_details *cmd_details);
 225 i40e_status i40e_aq_get_cee_dcb_config(struct i40e_hw *hw,
 226                                        void *buff, u16 buff_size,
 227                                        struct i40e_asq_cmd_details *cmd_details);
 228 i40e_status i40e_aq_add_udp_tunnel(struct i40e_hw *hw,
 229                                 u16 udp_port, u8 protocol_index,
 230                                 u8 *filter_index,
 231                                 struct i40e_asq_cmd_details *cmd_details);
 232 i40e_status i40e_aq_del_udp_tunnel(struct i40e_hw *hw, u8 index,
 233                                 struct i40e_asq_cmd_details *cmd_details);
 234 i40e_status i40e_aq_delete_element(struct i40e_hw *hw, u16 seid,
 235                                 struct i40e_asq_cmd_details *cmd_details);
 236 i40e_status i40e_aq_mac_address_write(struct i40e_hw *hw,
 237                                     u16 flags, u8 *mac_addr,
 238                                     struct i40e_asq_cmd_details *cmd_details);
 239 i40e_status i40e_aq_config_vsi_bw_limit(struct i40e_hw *hw,
 240                                 u16 seid, u16 credit, u8 max_credit,
 241                                 struct i40e_asq_cmd_details *cmd_details);
 242 i40e_status i40e_aq_dcb_updated(struct i40e_hw *hw,
 243                                 struct i40e_asq_cmd_details *cmd_details);
 244 i40e_status i40e_aq_config_switch_comp_bw_limit(struct i40e_hw *hw,
 245                                 u16 seid, u16 credit, u8 max_bw,
 246                                 struct i40e_asq_cmd_details *cmd_details);
 247 i40e_status i40e_aq_config_vsi_tc_bw(struct i40e_hw *hw, u16 seid,
 248                         struct i40e_aqc_configure_vsi_tc_bw_data *bw_data,
 249                         struct i40e_asq_cmd_details *cmd_details);
 250 i40e_status i40e_aq_config_switch_comp_ets(struct i40e_hw *hw,
 251                 u16 seid,
 252                 struct i40e_aqc_configure_switching_comp_ets_data *ets_data,
 253                 enum i40e_admin_queue_opc opcode,
 254                 struct i40e_asq_cmd_details *cmd_details);
 255 i40e_status i40e_aq_config_switch_comp_bw_config(struct i40e_hw *hw,
 256         u16 seid,
 257         struct i40e_aqc_configure_switching_comp_bw_config_data *bw_data,
 258         struct i40e_asq_cmd_details *cmd_details);
 259 i40e_status i40e_aq_query_vsi_bw_config(struct i40e_hw *hw,
 260                         u16 seid,
 261                         struct i40e_aqc_query_vsi_bw_config_resp *bw_data,
 262                         struct i40e_asq_cmd_details *cmd_details);
 263 i40e_status i40e_aq_query_vsi_ets_sla_config(struct i40e_hw *hw,
 264                         u16 seid,
 265                         struct i40e_aqc_query_vsi_ets_sla_config_resp *bw_data,
 266                         struct i40e_asq_cmd_details *cmd_details);
 267 i40e_status i40e_aq_query_switch_comp_ets_config(struct i40e_hw *hw,
 268                 u16 seid,
 269                 struct i40e_aqc_query_switching_comp_ets_config_resp *bw_data,
 270                 struct i40e_asq_cmd_details *cmd_details);
 271 i40e_status i40e_aq_query_port_ets_config(struct i40e_hw *hw,
 272                 u16 seid,
 273                 struct i40e_aqc_query_port_ets_config_resp *bw_data,
 274                 struct i40e_asq_cmd_details *cmd_details);
 275 i40e_status i40e_aq_query_switch_comp_bw_config(struct i40e_hw *hw,
 276                 u16 seid,
 277                 struct i40e_aqc_query_switching_comp_bw_config_resp *bw_data,
 278                 struct i40e_asq_cmd_details *cmd_details);
 279 i40e_status i40e_aq_resume_port_tx(struct i40e_hw *hw,
 280                                    struct i40e_asq_cmd_details *cmd_details);
 281 i40e_status i40e_read_lldp_cfg(struct i40e_hw *hw,
 282                                struct i40e_lldp_variables *lldp_cfg);
 283 /* i40e_common */
 284 i40e_status i40e_init_shared_code(struct i40e_hw *hw);
 285 i40e_status i40e_pf_reset(struct i40e_hw *hw);
 286 void i40e_clear_hw(struct i40e_hw *hw);
 287 void i40e_clear_pxe_mode(struct i40e_hw *hw);
 288 i40e_status i40e_get_link_status(struct i40e_hw *hw, bool *link_up);
 289 i40e_status i40e_update_link_info(struct i40e_hw *hw);
 290 i40e_status i40e_get_mac_addr(struct i40e_hw *hw, u8 *mac_addr);
 291 i40e_status i40e_read_bw_from_alt_ram(struct i40e_hw *hw,
 292                                       u32 *max_bw, u32 *min_bw, bool *min_valid,
 293                                       bool *max_valid);
 294 i40e_status i40e_aq_configure_partition_bw(struct i40e_hw *hw,
 295                         struct i40e_aqc_configure_partition_bw_data *bw_data,
 296                         struct i40e_asq_cmd_details *cmd_details);
 297 i40e_status i40e_get_port_mac_addr(struct i40e_hw *hw, u8 *mac_addr);
 298 i40e_status i40e_read_pba_string(struct i40e_hw *hw, u8 *pba_num,
 299                                  u32 pba_num_size);
 300 i40e_status i40e_validate_mac_addr(u8 *mac_addr);
 301 void i40e_pre_tx_queue_cfg(struct i40e_hw *hw, u32 queue, bool enable);
 302 #ifdef I40E_FCOE
 303 i40e_status i40e_get_san_mac_addr(struct i40e_hw *hw, u8 *mac_addr);
 304 #endif
 305 /* prototype for functions used for NVM access */
 306 i40e_status i40e_init_nvm(struct i40e_hw *hw);
 307 i40e_status i40e_acquire_nvm(struct i40e_hw *hw,
 308                                       enum i40e_aq_resource_access_type access);
 309 void i40e_release_nvm(struct i40e_hw *hw);
 310 i40e_status i40e_read_nvm_word(struct i40e_hw *hw, u16 offset,
 311                                          u16 *data);
 312 i40e_status i40e_read_nvm_buffer(struct i40e_hw *hw, u16 offset,
 313                                            u16 *words, u16 *data);
 314 i40e_status i40e_update_nvm_checksum(struct i40e_hw *hw);
 315 i40e_status i40e_validate_nvm_checksum(struct i40e_hw *hw,
 316                                                  u16 *checksum);
 317 i40e_status i40e_nvmupd_command(struct i40e_hw *hw,
 318                                 struct i40e_nvm_access *cmd,
 319                                 u8 *bytes, int *);
 320 void i40e_nvmupd_check_wait_event(struct i40e_hw *hw, u16 opcode);
 321 void i40e_set_pci_config_data(struct i40e_hw *hw, u16 link_status);
 322
 323 extern struct i40e_rx_ptype_decoded i40e_ptype_lookup[];
 324
 325 static inline struct i40e_rx_ptype_decoded decode_rx_desc_ptype(u8 ptype)
 326 {
 327         return i40e_ptype_lookup[ptype];
 328 }
 329
 330 /* prototype for functions used for SW locks */
 331
 332 /* i40e_common for VF drivers*/
 333 void i40e_vf_parse_hw_config(struct i40e_hw *hw,
 334                              struct i40e_virtchnl_vf_resource *msg);
 335 i40e_status i40e_vf_reset(struct i40e_hw *hw);
 336 i40e_status i40e_aq_send_msg_to_pf(struct i40e_hw *hw,
 337                                 enum i40e_virtchnl_ops v_opcode,
 338                                 i40e_status v_retval,
 339                                 u8 *msg, u16 msglen,
 340                                 struct i40e_asq_cmd_details *cmd_details);
 341 i40e_status i40e_set_filter_control(struct i40e_hw *hw,
 342                                 struct i40e_filter_control_settings *settings);
 343 i40e_status i40e_aq_add_rem_control_packet_filter(struct i40e_hw *hw,
 344                                 u8 *mac_addr, u16 ethtype, u16 flags,
 345                                 u16 vsi_seid, u16 queue, bool is_add,
 346                                 struct i40e_control_filter_stats *stats,
 347                                 struct i40e_asq_cmd_details *cmd_details);
 348 i40e_status i40e_aq_debug_dump(struct i40e_hw *hw, u8 cluster_id,
 349                                u8 table_id, u32 start_index, u16 buff_size,
 350                                void *buff, u16 *ret_buff_size,
 351                                u8 *ret_next_table, u32 *ret_next_index,
 352                                struct i40e_asq_cmd_details *cmd_details);
 353 void i40e_add_filter_to_drop_tx_flow_control_frames(struct i40e_hw *hw,
 354                                                     u16 vsi_seid);
 355 i40e_status i40e_aq_rx_ctl_read_register(struct i40e_hw *hw,
 356                                 u32 reg_addr, u32 *reg_val,
 357                                 struct i40e_asq_cmd_details *cmd_details);
 358 u32 i40e_read_rx_ctl(struct i40e_hw *hw, u32 reg_addr);
 359 i40e_status i40e_aq_rx_ctl_write_register(struct i40e_hw *hw,
 360                                 u32 reg_addr, u32 reg_val,
 361                                 struct i40e_asq_cmd_details *cmd_details);
 362 void i40e_write_rx_ctl(struct i40e_hw *hw, u32 reg_addr, u32 reg_val);
 363 i40e_status i40e_read_phy_register(struct i40e_hw *hw, u8 page,
 364                                    u16 reg, u8 phy_addr, u16 *value);
 365 i40e_status i40e_write_phy_register(struct i40e_hw *hw, u8 page,
 366                                     u16 reg, u8 phy_addr, u16 value);
 367 u8 i40e_get_phy_address(struct i40e_hw *hw, u8 dev_num);
 368 i40e_status i40e_blink_phy_link_led(struct i40e_hw *hw,
 369                                     u32 time, u32 interval);
 370 #endif /* _I40E_PROTOTYPE_H_ */