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

   1 /*******************************************************************************
   2  *
   3  * Intel Ethernet Controller XL710 Family Linux Driver
   4  * Copyright(c) 2013 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 with
  16  * this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * The full GNU General Public License is included in this distribution in
  20  * the file called "COPYING".
  21  *
  22  * Contact Information:
  23  * e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
  24  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  25  *
  26  ******************************************************************************/
  27
  28 #ifndef _I40E_PROTOTYPE_H_
  29 #define _I40E_PROTOTYPE_H_
  30
  31 #include "i40e_type.h"
  32 #include "i40e_alloc.h"
  33 #include "i40e_virtchnl.h"
  34
  35 /* Prototypes for shared code functions that are not in
  36  * the standard function pointer structures.  These are
  37  * mostly because they are needed even before the init
  38  * has happened and will assist in the early SW and FW
  39  * setup.
  40  */
  41
  42 /* adminq functions */
  43 i40e_status i40e_init_adminq(struct i40e_hw *hw);
  44 i40e_status i40e_shutdown_adminq(struct i40e_hw *hw);
  45 void i40e_adminq_init_ring_data(struct i40e_hw *hw);
  46 i40e_status i40e_clean_arq_element(struct i40e_hw *hw,
  47                                              struct i40e_arq_event_info *e,
  48                                              u16 *events_pending);
  49 i40e_status i40e_asq_send_command(struct i40e_hw *hw,
  50                                 struct i40e_aq_desc *desc,
  51                                 void *buff, /* can be NULL */
  52                                 u16  buff_size,
  53                                 struct i40e_asq_cmd_details *cmd_details);
  54 bool i40e_asq_done(struct i40e_hw *hw);
  55
  56 /* debug function for adminq */
  57 void i40e_debug_aq(struct i40e_hw *hw,
  58                    enum i40e_debug_mask mask,
  59                    void *desc,
  60                    void *buffer);
  61
  62 void i40e_idle_aq(struct i40e_hw *hw);
  63 void i40e_resume_aq(struct i40e_hw *hw);
  64
  65 u32 i40e_led_get(struct i40e_hw *hw);
  66 void i40e_led_set(struct i40e_hw *hw, u32 mode);
  67
  68 /* admin send queue commands */
  69
  70 i40e_status i40e_aq_get_firmware_version(struct i40e_hw *hw,
  71                                 u16 *fw_major_version, u16 *fw_minor_version,
  72                                 u16 *api_major_version, u16 *api_minor_version,
  73                                 struct i40e_asq_cmd_details *cmd_details);
  74 i40e_status i40e_aq_queue_shutdown(struct i40e_hw *hw,
  75                                              bool unloading);
  76 i40e_status i40e_aq_set_phy_reset(struct i40e_hw *hw,
  77                                 struct i40e_asq_cmd_details *cmd_details);
  78 i40e_status i40e_aq_set_default_vsi(struct i40e_hw *hw, u16 vsi_id,
  79                                 struct i40e_asq_cmd_details *cmd_details);
  80 i40e_status i40e_aq_set_link_restart_an(struct i40e_hw *hw,
  81                                 struct i40e_asq_cmd_details *cmd_details);
  82 i40e_status i40e_aq_get_link_info(struct i40e_hw *hw,
  83                                 bool enable_lse, struct i40e_link_status *link,
  84                                 struct i40e_asq_cmd_details *cmd_details);
  85 i40e_status i40e_aq_set_local_advt_reg(struct i40e_hw *hw,
  86                                 u64 advt_reg,
  87                                 struct i40e_asq_cmd_details *cmd_details);
  88 i40e_status i40e_aq_send_driver_version(struct i40e_hw *hw,
  89                                 struct i40e_driver_version *dv,
  90                                 struct i40e_asq_cmd_details *cmd_details);
  91 i40e_status i40e_aq_add_vsi(struct i40e_hw *hw,
  92                                 struct i40e_vsi_context *vsi_ctx,
  93                                 struct i40e_asq_cmd_details *cmd_details);
  94 i40e_status i40e_aq_set_vsi_broadcast(struct i40e_hw *hw,
  95                                 u16 vsi_id, bool set_filter,
  96                                 struct i40e_asq_cmd_details *cmd_details);
  97 i40e_status i40e_aq_set_vsi_unicast_promiscuous(struct i40e_hw *hw,
  98                                 u16 vsi_id, bool set, struct i40e_asq_cmd_details *cmd_details);
  99 i40e_status i40e_aq_set_vsi_multicast_promiscuous(struct i40e_hw *hw,
 100                                 u16 vsi_id, bool set, struct i40e_asq_cmd_details *cmd_details);
 101 i40e_status i40e_aq_get_vsi_params(struct i40e_hw *hw,
 102                                 struct i40e_vsi_context *vsi_ctx,
 103                                 struct i40e_asq_cmd_details *cmd_details);
 104 i40e_status i40e_aq_update_vsi_params(struct i40e_hw *hw,
 105                                 struct i40e_vsi_context *vsi_ctx,
 106                                 struct i40e_asq_cmd_details *cmd_details);
 107 i40e_status i40e_aq_add_veb(struct i40e_hw *hw, u16 uplink_seid,
 108                                 u16 downlink_seid, u8 enabled_tc,
 109                                 bool default_port, bool enable_l2_filtering,
 110                                 u16 *pveb_seid,
 111                                 struct i40e_asq_cmd_details *cmd_details);
 112 i40e_status i40e_aq_get_veb_parameters(struct i40e_hw *hw,
 113                                 u16 veb_seid, u16 *switch_id, bool *floating,
 114                                 u16 *statistic_index, u16 *vebs_used,
 115                                 u16 *vebs_free,
 116                                 struct i40e_asq_cmd_details *cmd_details);
 117 i40e_status i40e_aq_add_macvlan(struct i40e_hw *hw, u16 vsi_id,
 118                         struct i40e_aqc_add_macvlan_element_data *mv_list,
 119                         u16 count, struct i40e_asq_cmd_details *cmd_details);
 120 i40e_status i40e_aq_remove_macvlan(struct i40e_hw *hw, u16 vsi_id,
 121                         struct i40e_aqc_remove_macvlan_element_data *mv_list,
 122                         u16 count, struct i40e_asq_cmd_details *cmd_details);
 123 i40e_status i40e_aq_add_vlan(struct i40e_hw *hw, u16 vsi_id,
 124                         struct i40e_aqc_add_remove_vlan_element_data *v_list,
 125                         u8 count, struct i40e_asq_cmd_details *cmd_details);
 126 i40e_status i40e_aq_remove_vlan(struct i40e_hw *hw, u16 vsi_id,
 127                         struct i40e_aqc_add_remove_vlan_element_data *v_list,
 128                         u8 count, struct i40e_asq_cmd_details *cmd_details);
 129 i40e_status i40e_aq_send_msg_to_vf(struct i40e_hw *hw, u16 vfid,
 130                                 u32 v_opcode, u32 v_retval, u8 *msg, u16 msglen,
 131                                 struct i40e_asq_cmd_details *cmd_details);
 132 i40e_status i40e_aq_get_switch_config(struct i40e_hw *hw,
 133                                 struct i40e_aqc_get_switch_config_resp *buf,
 134                                 u16 buf_size, u16 *start_seid,
 135                                 struct i40e_asq_cmd_details *cmd_details);
 136 i40e_status i40e_aq_request_resource(struct i40e_hw *hw,
 137                                 enum i40e_aq_resources_ids resource,
 138                                 enum i40e_aq_resource_access_type access,
 139                                 u8 sdp_number, u64 *timeout,
 140                                 struct i40e_asq_cmd_details *cmd_details);
 141 i40e_status i40e_aq_release_resource(struct i40e_hw *hw,
 142                                 enum i40e_aq_resources_ids resource,
 143                                 u8 sdp_number,
 144                                 struct i40e_asq_cmd_details *cmd_details);
 145 i40e_status i40e_aq_read_nvm(struct i40e_hw *hw, u8 module_pointer,
 146                                 u32 offset, u16 length, void *data,
 147                                 bool last_command,
 148                                 struct i40e_asq_cmd_details *cmd_details);
 149 i40e_status i40e_aq_discover_capabilities(struct i40e_hw *hw,
 150                                 void *buff, u16 buff_size, u16 *data_size,
 151                                 enum i40e_admin_queue_opc list_type_opc,
 152                                 struct i40e_asq_cmd_details *cmd_details);
 153 i40e_status i40e_aq_update_nvm(struct i40e_hw *hw, u8 module_pointer,
 154                                 u32 offset, u16 length, void *data,
 155                                 bool last_command,
 156                                 struct i40e_asq_cmd_details *cmd_details);
 157 i40e_status i40e_aq_get_lldp_mib(struct i40e_hw *hw, u8 bridge_type,
 158                                 u8 mib_type, void *buff, u16 buff_size,
 159                                 u16 *local_len, u16 *remote_len,
 160                                 struct i40e_asq_cmd_details *cmd_details);
 161 i40e_status i40e_aq_cfg_lldp_mib_change_event(struct i40e_hw *hw,
 162                                 bool enable_update,
 163                                 struct i40e_asq_cmd_details *cmd_details);
 164 i40e_status i40e_aq_stop_lldp(struct i40e_hw *hw, bool shutdown_agent,
 165                                 struct i40e_asq_cmd_details *cmd_details);
 166 i40e_status i40e_aq_start_lldp(struct i40e_hw *hw,
 167                                 struct i40e_asq_cmd_details *cmd_details);
 168 i40e_status i40e_aq_delete_element(struct i40e_hw *hw, u16 seid,
 169                                 struct i40e_asq_cmd_details *cmd_details);
 170 i40e_status i40e_aq_mac_address_write(struct i40e_hw *hw,
 171                                     u16 flags, u8 *mac_addr,
 172                                     struct i40e_asq_cmd_details *cmd_details);
 173 i40e_status i40e_aq_set_hmc_resource_profile(struct i40e_hw *hw,
 174                                 enum i40e_aq_hmc_profile profile,
 175                                 u8 pe_vf_enabled_count,
 176                                 struct i40e_asq_cmd_details *cmd_details);
 177 i40e_status i40e_aq_config_switch_comp_bw_limit(struct i40e_hw *hw,
 178                                 u16 seid, u16 credit, u8 max_bw,
 179                                 struct i40e_asq_cmd_details *cmd_details);
 180 i40e_status i40e_aq_config_vsi_tc_bw(struct i40e_hw *hw, u16 seid,
 181                         struct i40e_aqc_configure_vsi_tc_bw_data *bw_data,
 182                         struct i40e_asq_cmd_details *cmd_details);
 183 i40e_status i40e_aq_query_vsi_bw_config(struct i40e_hw *hw,
 184                         u16 seid,
 185                         struct i40e_aqc_query_vsi_bw_config_resp *bw_data,
 186                         struct i40e_asq_cmd_details *cmd_details);
 187 i40e_status i40e_aq_query_vsi_ets_sla_config(struct i40e_hw *hw,
 188                         u16 seid,
 189                         struct i40e_aqc_query_vsi_ets_sla_config_resp *bw_data,
 190                         struct i40e_asq_cmd_details *cmd_details);
 191 i40e_status i40e_aq_query_switch_comp_ets_config(struct i40e_hw *hw,
 192                 u16 seid,
 193                 struct i40e_aqc_query_switching_comp_ets_config_resp *bw_data,
 194                 struct i40e_asq_cmd_details *cmd_details);
 195 i40e_status i40e_aq_query_port_ets_config(struct i40e_hw *hw,
 196                 u16 seid,
 197                 struct i40e_aqc_query_port_ets_config_resp *bw_data,
 198                 struct i40e_asq_cmd_details *cmd_details);
 199 i40e_status i40e_aq_query_switch_comp_bw_config(struct i40e_hw *hw,
 200                 u16 seid,
 201                 struct i40e_aqc_query_switching_comp_bw_config_resp *bw_data,
 202                 struct i40e_asq_cmd_details *cmd_details);
 203 /* i40e_common */
 204 i40e_status i40e_init_shared_code(struct i40e_hw *hw);
 205 i40e_status i40e_pf_reset(struct i40e_hw *hw);
 206 void i40e_clear_pxe_mode(struct i40e_hw *hw);
 207 bool i40e_get_link_status(struct i40e_hw *hw);
 208 i40e_status i40e_get_mac_addr(struct i40e_hw *hw,
 209                                                 u8 *mac_addr);
 210 i40e_status i40e_validate_mac_addr(u8 *mac_addr);
 211 i40e_status i40e_read_lldp_cfg(struct i40e_hw *hw,
 212                                         struct i40e_lldp_variables *lldp_cfg);
 213 /* prototype for functions used for NVM access */
 214 i40e_status i40e_init_nvm(struct i40e_hw *hw);
 215 i40e_status i40e_acquire_nvm(struct i40e_hw *hw,
 216                                       enum i40e_aq_resource_access_type access);
 217 void i40e_release_nvm(struct i40e_hw *hw);
 218 i40e_status i40e_read_nvm_srrd(struct i40e_hw *hw, u16 offset,
 219                                          u16 *data);
 220 i40e_status i40e_read_nvm_word(struct i40e_hw *hw, u16 offset,
 221                                          u16 *data);
 222 i40e_status i40e_read_nvm_buffer(struct i40e_hw *hw, u16 offset,
 223                                            u16 *words, u16 *data);
 224 i40e_status i40e_validate_nvm_checksum(struct i40e_hw *hw,
 225                                                  u16 *checksum);
 226
 227 /* prototype for functions used for SW locks */
 228
 229 /* i40e_common for VF drivers*/
 230 void i40e_vf_parse_hw_config(struct i40e_hw *hw,
 231                              struct i40e_virtchnl_vf_resource *msg);
 232 i40e_status i40e_vf_reset(struct i40e_hw *hw);
 233 i40e_status i40e_aq_send_msg_to_pf(struct i40e_hw *hw,
 234                                 enum i40e_virtchnl_ops v_opcode,
 235                                 i40e_status v_retval,
 236                                 u8 *msg, u16 msglen,
 237                                 struct i40e_asq_cmd_details *cmd_details);
 238 i40e_status i40e_set_filter_control(struct i40e_hw *hw,
 239                                 struct i40e_filter_control_settings *settings);
 240 #endif /* _I40E_PROTOTYPE_H_ */