drivers/net/ice/base/ice_common.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2001-2019
   3  */
   4
   5 #ifndef _ICE_COMMON_H_
   6 #define _ICE_COMMON_H_
   7
   8 #include "ice_type.h"
   9
  10 #include "ice_flex_pipe.h"
  11 #include "ice_switch.h"
  12
  13 enum ice_fw_modes {
  14         ICE_FW_MODE_NORMAL,
  15         ICE_FW_MODE_DBG,
  16         ICE_FW_MODE_REC,
  17         ICE_FW_MODE_DBG_REC
  18 };
  19
  20 enum ice_status ice_nvm_validate_checksum(struct ice_hw *hw);
  21
  22 void
  23 ice_debug_cq(struct ice_hw *hw, u32 mask, void *desc, void *buf, u16 buf_len);
  24 enum ice_status ice_init_hw(struct ice_hw *hw);
  25 void ice_deinit_hw(struct ice_hw *hw);
  26 enum ice_status ice_check_reset(struct ice_hw *hw);
  27 enum ice_status ice_reset(struct ice_hw *hw, enum ice_reset_req req);
  28
  29 enum ice_status ice_init_all_ctrlq(struct ice_hw *hw);
  30 void ice_shutdown_all_ctrlq(struct ice_hw *hw);
  31 enum ice_status
  32 ice_clean_rq_elem(struct ice_hw *hw, struct ice_ctl_q_info *cq,
  33                   struct ice_rq_event_info *e, u16 *pending);
  34 enum ice_status
  35 ice_get_link_status(struct ice_port_info *pi, bool *link_up);
  36 enum ice_status
  37 ice_update_link_info(struct ice_port_info *pi);
  38 enum ice_status
  39 ice_acquire_res(struct ice_hw *hw, enum ice_aq_res_ids res,
  40                 enum ice_aq_res_access_type access, u32 timeout);
  41 void ice_release_res(struct ice_hw *hw, enum ice_aq_res_ids res);
  42 enum ice_status
  43 ice_alloc_hw_res(struct ice_hw *hw, u16 type, u16 num, bool sh, u16 *res);
  44 enum ice_status
  45 ice_free_hw_res(struct ice_hw *hw, u16 type, u16 num, u16 *res);
  46 enum ice_status
  47 ice_aq_alloc_free_res(struct ice_hw *hw, u16 num_entries,
  48                       struct ice_aqc_alloc_free_res_elem *buf, u16 buf_size,
  49                       enum ice_adminq_opc opc, struct ice_sq_cd *cd);
  50 enum ice_status ice_init_nvm(struct ice_hw *hw);
  51 enum ice_status ice_read_sr_word(struct ice_hw *hw, u16 offset, u16 *data);
  52 enum ice_status
  53 ice_read_sr_buf(struct ice_hw *hw, u16 offset, u16 *words, u16 *data);
  54 enum ice_status
  55 ice_sq_send_cmd(struct ice_hw *hw, struct ice_ctl_q_info *cq,
  56                 struct ice_aq_desc *desc, void *buf, u16 buf_size,
  57                 struct ice_sq_cd *cd);
  58 void ice_clear_pxe_mode(struct ice_hw *hw);
  59
  60 enum ice_status ice_get_caps(struct ice_hw *hw);
  61
  62 /* Define a macro that will align a pointer to point to the next memory address
  63  * that falls on the given power of 2 (i.e., 2, 4, 8, 16, 32, 64...). For
  64  * example, given the variable pointer = 0x1006, then after the following call:
  65  *
  66  *      pointer = ICE_ALIGN(pointer, 4)
  67  *
  68  * ... the value of pointer would equal 0x1008, since 0x1008 is the next
  69  * address after 0x1006 which is divisible by 4.
  70  */
  71 #define ICE_ALIGN(ptr, align)   (((ptr) + ((align) - 1)) & ~((align) - 1))
  72
  73 enum ice_status
  74 ice_write_rxq_ctx(struct ice_hw *hw, struct ice_rlan_ctx *rlan_ctx,
  75                   u32 rxq_index);
  76 #if !defined(NO_UNUSED_CTX_CODE) || defined(AE_DRIVER)
  77 enum ice_status ice_clear_rxq_ctx(struct ice_hw *hw, u32 rxq_index);
  78 enum ice_status
  79 ice_clear_tx_cmpltnq_ctx(struct ice_hw *hw, u32 tx_cmpltnq_index);
  80 enum ice_status
  81 ice_write_tx_cmpltnq_ctx(struct ice_hw *hw,
  82                          struct ice_tx_cmpltnq_ctx *tx_cmpltnq_ctx,
  83                          u32 tx_cmpltnq_index);
  84 enum ice_status
  85 ice_clear_tx_drbell_q_ctx(struct ice_hw *hw, u32 tx_drbell_q_index);
  86 enum ice_status
  87 ice_write_tx_drbell_q_ctx(struct ice_hw *hw,
  88                           struct ice_tx_drbell_q_ctx *tx_drbell_q_ctx,
  89                           u32 tx_drbell_q_index);
  90 #endif /* !NO_UNUSED_CTX_CODE || AE_DRIVER */
  91
  92 enum ice_status
  93 ice_aq_get_rss_lut(struct ice_hw *hw, u16 vsi_handle, u8 lut_type, u8 *lut,
  94                    u16 lut_size);
  95 enum ice_status
  96 ice_aq_set_rss_lut(struct ice_hw *hw, u16 vsi_handle, u8 lut_type, u8 *lut,
  97                    u16 lut_size);
  98 enum ice_status
  99 ice_aq_get_rss_key(struct ice_hw *hw, u16 vsi_handle,
 100                    struct ice_aqc_get_set_rss_keys *keys);
 101 enum ice_status
 102 ice_aq_set_rss_key(struct ice_hw *hw, u16 vsi_handle,
 103                    struct ice_aqc_get_set_rss_keys *keys);
 104 enum ice_status
 105 ice_aq_add_lan_txq(struct ice_hw *hw, u8 count,
 106                    struct ice_aqc_add_tx_qgrp *qg_list, u16 buf_size,
 107                    struct ice_sq_cd *cd);
 108
 109 bool ice_check_sq_alive(struct ice_hw *hw, struct ice_ctl_q_info *cq);
 110 enum ice_status ice_aq_q_shutdown(struct ice_hw *hw, bool unloading);
 111 void ice_fill_dflt_direct_cmd_desc(struct ice_aq_desc *desc, u16 opcode);
 112 extern const struct ice_ctx_ele ice_tlan_ctx_info[];
 113 enum ice_status
 114 ice_set_ctx(u8 *src_ctx, u8 *dest_ctx, const struct ice_ctx_ele *ce_info);
 115 enum ice_status
 116 ice_aq_send_cmd(struct ice_hw *hw, struct ice_aq_desc *desc,
 117                 void *buf, u16 buf_size, struct ice_sq_cd *cd);
 118 enum ice_status ice_aq_get_fw_ver(struct ice_hw *hw, struct ice_sq_cd *cd);
 119
 120 enum ice_status
 121 ice_aq_get_phy_caps(struct ice_port_info *pi, bool qual_mods, u8 report_mode,
 122                     struct ice_aqc_get_phy_caps_data *caps,
 123                     struct ice_sq_cd *cd);
 124 void
 125 ice_update_phy_type(u64 *phy_type_low, u64 *phy_type_high,
 126                     u16 link_speeds_bitmap);
 127 enum ice_status
 128 ice_aq_manage_mac_write(struct ice_hw *hw, const u8 *mac_addr, u8 flags,
 129                         struct ice_sq_cd *cd);
 130
 131 enum ice_status ice_clear_pf_cfg(struct ice_hw *hw);
 132 enum ice_status
 133 ice_aq_set_phy_cfg(struct ice_hw *hw, u8 lport,
 134                    struct ice_aqc_set_phy_cfg_data *cfg, struct ice_sq_cd *cd);
 135 enum ice_status
 136 ice_set_fc(struct ice_port_info *pi, u8 *aq_failures,
 137            bool ena_auto_link_update);
 138 void
 139 ice_cfg_phy_fec(struct ice_aqc_set_phy_cfg_data *cfg, enum ice_fec_mode fec);
 140 void
 141 ice_copy_phy_caps_to_cfg(struct ice_aqc_get_phy_caps_data *caps,
 142                          struct ice_aqc_set_phy_cfg_data *cfg);
 143 enum ice_status
 144 ice_aq_set_link_restart_an(struct ice_port_info *pi, bool ena_link,
 145                            struct ice_sq_cd *cd);
 146 enum ice_status
 147 ice_aq_set_mac_cfg(struct ice_hw *hw, u16 max_frame_size, struct ice_sq_cd *cd);
 148 enum ice_status
 149 ice_aq_get_link_info(struct ice_port_info *pi, bool ena_lse,
 150                      struct ice_link_status *link, struct ice_sq_cd *cd);
 151 enum ice_status
 152 ice_aq_set_event_mask(struct ice_hw *hw, u8 port_num, u16 mask,
 153                       struct ice_sq_cd *cd);
 154 enum ice_status
 155 ice_aq_set_mac_loopback(struct ice_hw *hw, bool ena_lpbk, struct ice_sq_cd *cd);
 156
 157
 158 enum ice_status
 159 ice_aq_set_port_id_led(struct ice_port_info *pi, bool is_orig_mode,
 160                        struct ice_sq_cd *cd);
 161
 162
 163
 164 enum ice_status
 165 ice_get_ctx(u8 *src_ctx, u8 *dest_ctx, struct ice_ctx_ele *ce_info);
 166 enum ice_status
 167 ice_dis_vsi_txq(struct ice_port_info *pi, u16 vsi_handle, u8 tc, u8 num_queues,
 168                 u16 *q_handle, u16 *q_ids, u32 *q_teids,
 169                 enum ice_disq_rst_src rst_src, u16 vmvf_num,
 170                 struct ice_sq_cd *cd);
 171 enum ice_status
 172 ice_cfg_vsi_lan(struct ice_port_info *pi, u16 vsi_handle, u8 tc_bitmap,
 173                 u16 *max_lanqs);
 174 enum ice_status
 175 ice_ena_vsi_txq(struct ice_port_info *pi, u16 vsi_handle, u8 tc, u16 q_handle,
 176                 u8 num_qgrps, struct ice_aqc_add_tx_qgrp *buf, u16 buf_size,
 177                 struct ice_sq_cd *cd);
 178 enum ice_status ice_replay_vsi(struct ice_hw *hw, u16 vsi_handle);
 179 void ice_replay_post(struct ice_hw *hw);
 180 void ice_sched_replay_agg_vsi_preinit(struct ice_hw *hw);
 181 void ice_sched_replay_agg(struct ice_hw *hw);
 182 enum ice_status ice_sched_replay_tc_node_bw(struct ice_hw *hw);
 183 enum ice_status ice_replay_vsi_agg(struct ice_hw *hw, u16 vsi_handle);
 184 enum ice_status
 185 ice_cfg_tc_node_bw_alloc(struct ice_port_info *pi, u8 tc,
 186                          enum ice_rl_type rl_type, u8 bw_alloc);
 187 enum ice_status ice_cfg_rl_burst_size(struct ice_hw *hw, u32 bytes);
 188 void ice_output_fw_log(struct ice_hw *hw, struct ice_aq_desc *desc, void *buf);
 189 void
 190 ice_stat_update40(struct ice_hw *hw, u32 hireg, u32 loreg,
 191                   bool prev_stat_loaded, u64 *prev_stat, u64 *cur_stat);
 192 void
 193 ice_stat_update32(struct ice_hw *hw, u32 reg, bool prev_stat_loaded,
 194                   u64 *prev_stat, u64 *cur_stat);
 195 enum ice_status
 196 ice_sched_query_elem(struct ice_hw *hw, u32 node_teid,
 197                      struct ice_aqc_get_elem *buf);
 198 bool ice_is_fw_in_rec_mode(struct ice_hw *hw);
 199 #endif /* _ICE_COMMON_H_ */