1/* SPDX-License-Identifier: BSD-3-Clause */ 2/* Copyright (c) 2021, Intel Corporation 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions are met: 7 * 8 * 1. Redistributions of source code must retain the above copyright notice, 9 * this list of conditions and the following disclaimer. 10 * 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 15 * 3. Neither the name of the Intel Corporation nor the names of its 16 * contributors may be used to endorse or promote products derived from 17 * this software without specific prior written permission. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 20 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 22 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 23 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 29 * POSSIBILITY OF SUCH DAMAGE. 30 */ 31/*$FreeBSD$*/ 32 33#ifndef _ICE_COMMON_H_ 34#define _ICE_COMMON_H_ 35 36#include "ice_type.h" 37#include "ice_nvm.h" 38#include "ice_flex_pipe.h" 39#include "virtchnl.h" 40#include "ice_switch.h" 41 42enum ice_fw_modes { 43 ICE_FW_MODE_NORMAL, 44 ICE_FW_MODE_DBG, 45 ICE_FW_MODE_REC, 46 ICE_FW_MODE_ROLLBACK 47}; 48 49void ice_idle_aq(struct ice_hw *hw, struct ice_ctl_q_info *cq); 50bool ice_sq_done(struct ice_hw *hw, struct ice_ctl_q_info *cq); 51 52enum ice_status ice_init_hw(struct ice_hw *hw); 53void ice_deinit_hw(struct ice_hw *hw); 54enum ice_status ice_check_reset(struct ice_hw *hw); 55enum ice_status ice_reset(struct ice_hw *hw, enum ice_reset_req req); 56 57enum ice_status ice_create_all_ctrlq(struct ice_hw *hw); 58enum ice_status ice_init_all_ctrlq(struct ice_hw *hw); 59void ice_shutdown_all_ctrlq(struct ice_hw *hw); 60void ice_destroy_all_ctrlq(struct ice_hw *hw); 61enum ice_status 62ice_clean_rq_elem(struct ice_hw *hw, struct ice_ctl_q_info *cq, 63 struct ice_rq_event_info *e, u16 *pending); 64enum ice_status 65ice_get_link_status(struct ice_port_info *pi, bool *link_up); 66enum ice_status ice_update_link_info(struct ice_port_info *pi); 67enum ice_status 68ice_acquire_res(struct ice_hw *hw, enum ice_aq_res_ids res, 69 enum ice_aq_res_access_type access, u32 timeout); 70void ice_release_res(struct ice_hw *hw, enum ice_aq_res_ids res); 71enum ice_status 72ice_alloc_hw_res(struct ice_hw *hw, u16 type, u16 num, bool btm, u16 *res); 73enum ice_status 74ice_free_hw_res(struct ice_hw *hw, u16 type, u16 num, u16 *res); 75enum ice_status 76ice_aq_alloc_free_res(struct ice_hw *hw, u16 num_entries, 77 struct ice_aqc_alloc_free_res_elem *buf, u16 buf_size, 78 enum ice_adminq_opc opc, struct ice_sq_cd *cd); 79enum ice_status 80ice_sq_send_cmd(struct ice_hw *hw, struct ice_ctl_q_info *cq, 81 struct ice_aq_desc *desc, void *buf, u16 buf_size, 82 struct ice_sq_cd *cd); 83void ice_clear_pxe_mode(struct ice_hw *hw); 84 85enum ice_status ice_get_caps(struct ice_hw *hw); 86 87void ice_set_safe_mode_caps(struct ice_hw *hw); 88 89enum ice_status ice_set_mac_type(struct ice_hw *hw); 90 91/* Define a macro that will align a pointer to point to the next memory address 92 * that falls on the given power of 2 (i.e., 2, 4, 8, 16, 32, 64...). For 93 * example, given the variable pointer = 0x1006, then after the following call: 94 * 95 * pointer = ICE_ALIGN(pointer, 4) 96 * 97 * ... the value of pointer would equal 0x1008, since 0x1008 is the next 98 * address after 0x1006 which is divisible by 4. 99 */ 100#define ICE_ALIGN(ptr, align) (((ptr) + ((align) - 1)) & ~((align) - 1)) 101 102enum ice_status 103ice_write_rxq_ctx(struct ice_hw *hw, struct ice_rlan_ctx *rlan_ctx, 104 u32 rxq_index); 105enum ice_status ice_clear_rxq_ctx(struct ice_hw *hw, u32 rxq_index); 106enum ice_status 107ice_clear_tx_cmpltnq_ctx(struct ice_hw *hw, u32 tx_cmpltnq_index); 108enum ice_status 109ice_write_tx_cmpltnq_ctx(struct ice_hw *hw, 110 struct ice_tx_cmpltnq_ctx *tx_cmpltnq_ctx, 111 u32 tx_cmpltnq_index); 112enum ice_status 113ice_clear_tx_drbell_q_ctx(struct ice_hw *hw, u32 tx_drbell_q_index); 114enum ice_status 115ice_write_tx_drbell_q_ctx(struct ice_hw *hw, 116 struct ice_tx_drbell_q_ctx *tx_drbell_q_ctx, 117 u32 tx_drbell_q_index); 118 119enum ice_status 120ice_aq_get_rss_lut(struct ice_hw *hw, struct ice_aq_get_set_rss_lut_params *get_params); 121enum ice_status 122ice_aq_set_rss_lut(struct ice_hw *hw, struct ice_aq_get_set_rss_lut_params *set_params); 123enum ice_status 124ice_aq_get_rss_key(struct ice_hw *hw, u16 vsi_handle, 125 struct ice_aqc_get_set_rss_keys *keys); 126enum ice_status 127ice_aq_set_rss_key(struct ice_hw *hw, u16 vsi_handle, 128 struct ice_aqc_get_set_rss_keys *keys); 129enum ice_status 130ice_aq_add_lan_txq(struct ice_hw *hw, u8 count, 131 struct ice_aqc_add_tx_qgrp *qg_list, u16 buf_size, 132 struct ice_sq_cd *cd); 133enum ice_status 134ice_aq_move_recfg_lan_txq(struct ice_hw *hw, u8 num_qs, bool is_move, 135 bool is_tc_change, bool subseq_call, bool flush_pipe, 136 u8 timeout, u32 *blocked_cgds, 137 struct ice_aqc_move_txqs_data *buf, u16 buf_size, 138 u8 *txqs_moved, struct ice_sq_cd *cd); 139 140bool ice_check_sq_alive(struct ice_hw *hw, struct ice_ctl_q_info *cq); 141enum ice_status ice_aq_q_shutdown(struct ice_hw *hw, bool unloading); 142void ice_fill_dflt_direct_cmd_desc(struct ice_aq_desc *desc, u16 opcode); 143extern const struct ice_ctx_ele ice_tlan_ctx_info[]; 144enum ice_status 145ice_set_ctx(struct ice_hw *hw, u8 *src_ctx, u8 *dest_ctx, 146 const struct ice_ctx_ele *ce_info); 147 148enum ice_status 149ice_aq_send_cmd(struct ice_hw *hw, struct ice_aq_desc *desc, 150 void *buf, u16 buf_size, struct ice_sq_cd *cd); 151enum ice_status ice_aq_get_fw_ver(struct ice_hw *hw, struct ice_sq_cd *cd); 152 153enum ice_status 154ice_aq_send_driver_ver(struct ice_hw *hw, struct ice_driver_ver *dv, 155 struct ice_sq_cd *cd); 156enum ice_status 157ice_aq_set_port_params(struct ice_port_info *pi, u16 bad_frame_vsi, 158 bool save_bad_pac, bool pad_short_pac, bool double_vlan, 159 struct ice_sq_cd *cd); 160enum ice_status 161ice_aq_get_phy_caps(struct ice_port_info *pi, bool qual_mods, u8 report_mode, 162 struct ice_aqc_get_phy_caps_data *caps, 163 struct ice_sq_cd *cd); 164void 165ice_update_phy_type(u64 *phy_type_low, u64 *phy_type_high, 166 u16 link_speeds_bitmap); 167enum ice_status 168ice_aq_manage_mac_read(struct ice_hw *hw, void *buf, u16 buf_size, 169 struct ice_sq_cd *cd); 170enum ice_status 171ice_aq_manage_mac_write(struct ice_hw *hw, const u8 *mac_addr, u8 flags, 172 struct ice_sq_cd *cd); 173 174enum ice_status ice_clear_pf_cfg(struct ice_hw *hw); 175enum ice_status 176ice_aq_set_phy_cfg(struct ice_hw *hw, struct ice_port_info *pi, 177 struct ice_aqc_set_phy_cfg_data *cfg, struct ice_sq_cd *cd); 178bool ice_fw_supports_link_override(struct ice_hw *hw); 179enum ice_status 180ice_get_link_default_override(struct ice_link_default_override_tlv *ldo, 181 struct ice_port_info *pi); 182bool ice_is_phy_caps_an_enabled(struct ice_aqc_get_phy_caps_data *caps); 183 184enum ice_fc_mode ice_caps_to_fc_mode(u8 caps); 185enum ice_fec_mode ice_caps_to_fec_mode(u8 caps, u8 fec_options); 186enum ice_status 187ice_set_fc(struct ice_port_info *pi, u8 *aq_failures, 188 bool ena_auto_link_update); 189bool 190ice_phy_caps_equals_cfg(struct ice_aqc_get_phy_caps_data *caps, 191 struct ice_aqc_set_phy_cfg_data *cfg); 192void 193ice_copy_phy_caps_to_cfg(struct ice_port_info *pi, 194 struct ice_aqc_get_phy_caps_data *caps, 195 struct ice_aqc_set_phy_cfg_data *cfg); 196enum ice_status 197ice_cfg_phy_fec(struct ice_port_info *pi, struct ice_aqc_set_phy_cfg_data *cfg, 198 enum ice_fec_mode fec); 199enum ice_status 200ice_aq_set_link_restart_an(struct ice_port_info *pi, bool ena_link, 201 struct ice_sq_cd *cd); 202enum ice_status 203ice_aq_set_mac_cfg(struct ice_hw *hw, u16 max_frame_size, struct ice_sq_cd *cd); 204enum ice_status 205ice_aq_get_link_info(struct ice_port_info *pi, bool ena_lse, 206 struct ice_link_status *link, struct ice_sq_cd *cd); 207enum ice_status 208ice_aq_set_event_mask(struct ice_hw *hw, u8 port_num, u16 mask, 209 struct ice_sq_cd *cd); 210enum ice_status 211ice_aq_set_mac_loopback(struct ice_hw *hw, bool ena_lpbk, struct ice_sq_cd *cd); 212 213enum ice_status 214ice_aq_set_port_id_led(struct ice_port_info *pi, bool is_orig_mode, 215 struct ice_sq_cd *cd); 216enum ice_status 217ice_aq_sff_eeprom(struct ice_hw *hw, u16 lport, u8 bus_addr, 218 u16 mem_addr, u8 page, u8 set_page, u8 *data, u8 length, 219 bool write, struct ice_sq_cd *cd); 220 221enum ice_status 222ice_get_ctx(u8 *src_ctx, u8 *dest_ctx, struct ice_ctx_ele *ce_info); 223enum ice_status 224__ice_write_sr_word(struct ice_hw *hw, u32 offset, const u16 *data); 225enum ice_status 226__ice_write_sr_buf(struct ice_hw *hw, u32 offset, u16 words, const u16 *data); 227enum ice_status 228ice_dis_vsi_txq(struct ice_port_info *pi, u16 vsi_handle, u8 tc, u8 num_queues, 229 u16 *q_handle, u16 *q_ids, u32 *q_teids, 230 enum ice_disq_rst_src rst_src, u16 vmvf_num, 231 struct ice_sq_cd *cd); 232enum ice_status 233ice_cfg_vsi_lan(struct ice_port_info *pi, u16 vsi_handle, u16 tc_bitmap, 234 u16 *max_lanqs); 235enum ice_status 236ice_ena_vsi_txq(struct ice_port_info *pi, u16 vsi_handle, u8 tc, u16 q_handle, 237 u8 num_qgrps, struct ice_aqc_add_tx_qgrp *buf, u16 buf_size, 238 struct ice_sq_cd *cd); 239enum ice_status ice_replay_vsi(struct ice_hw *hw, u16 vsi_handle); 240void ice_replay_post(struct ice_hw *hw); 241struct ice_q_ctx * 242ice_get_lan_q_ctx(struct ice_hw *hw, u16 vsi_handle, u8 tc, u16 q_handle); 243void 244ice_stat_update40(struct ice_hw *hw, u32 reg, bool prev_stat_loaded, 245 u64 *prev_stat, u64 *cur_stat); 246void 247ice_stat_update32(struct ice_hw *hw, u32 reg, bool prev_stat_loaded, 248 u64 *prev_stat, u64 *cur_stat); 249void 250ice_stat_update_repc(struct ice_hw *hw, u16 vsi_handle, bool prev_stat_loaded, 251 struct ice_eth_stats *cur_stats); 252enum ice_fw_modes ice_get_fw_mode(struct ice_hw *hw); 253void ice_print_rollback_msg(struct ice_hw *hw); 254enum ice_status 255ice_aq_alternate_write(struct ice_hw *hw, u32 reg_addr0, u32 reg_val0, 256 u32 reg_addr1, u32 reg_val1); 257enum ice_status 258ice_aq_alternate_read(struct ice_hw *hw, u32 reg_addr0, u32 *reg_val0, 259 u32 reg_addr1, u32 *reg_val1); 260enum ice_status 261ice_aq_alternate_write_done(struct ice_hw *hw, u8 bios_mode, 262 bool *reset_needed); 263enum ice_status ice_aq_alternate_clear(struct ice_hw *hw); 264enum ice_status 265ice_sched_query_elem(struct ice_hw *hw, u32 node_teid, 266 struct ice_aqc_txsched_elem_data *buf); 267enum ice_status 268ice_get_cur_lldp_persist_status(struct ice_hw *hw, u32 *lldp_status); 269enum ice_status 270ice_get_dflt_lldp_persist_status(struct ice_hw *hw, u32 *lldp_status); 271enum ice_status ice_get_netlist_ver_info(struct ice_hw *hw, struct ice_netlist_info *netlist); 272enum ice_status 273ice_aq_set_lldp_mib(struct ice_hw *hw, u8 mib_type, void *buf, u16 buf_size, 274 struct ice_sq_cd *cd); 275bool ice_fw_supports_lldp_fltr_ctrl(struct ice_hw *hw); 276enum ice_status 277ice_lldp_fltr_add_remove(struct ice_hw *hw, u16 vsi_num, bool add); 278#endif /* _ICE_COMMON_H_ */ 279