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_SCHED_H_ 34 #define _ICE_SCHED_H_ 35 36 #include "ice_common.h" 37 38 #define ICE_QGRP_LAYER_OFFSET 2 39 #define ICE_VSI_LAYER_OFFSET 4 40 #define ICE_AGG_LAYER_OFFSET 6 41 #define ICE_SCHED_INVAL_LAYER_NUM 0xFF 42 /* Burst size is a 12 bits register that is configured while creating the RL 43 * profile(s). MSB is a granularity bit and tells the granularity type 44 * 0 - LSB bits are in 64 bytes granularity 45 * 1 - LSB bits are in 1K bytes granularity 46 */ 47 #define ICE_64_BYTE_GRANULARITY 0 48 #define ICE_KBYTE_GRANULARITY BIT(11) 49 #define ICE_MIN_BURST_SIZE_ALLOWED 64 /* In Bytes */ 50 #define ICE_MAX_BURST_SIZE_ALLOWED \ 51 ((BIT(11) - 1) * 1024) /* In Bytes */ 52 #define ICE_MAX_BURST_SIZE_64_BYTE_GRANULARITY \ 53 ((BIT(11) - 1) * 64) /* In Bytes */ 54 #define ICE_MAX_BURST_SIZE_KBYTE_GRANULARITY ICE_MAX_BURST_SIZE_ALLOWED 55 56 #define ICE_RL_PROF_ACCURACY_BYTES 128 57 #define ICE_RL_PROF_MULTIPLIER 10000 58 #define ICE_RL_PROF_TS_MULTIPLIER 32 59 #define ICE_RL_PROF_FRACTION 512 60 61 #define ICE_PSM_CLK_367MHZ_IN_HZ 367647059 62 #define ICE_PSM_CLK_416MHZ_IN_HZ 416666667 63 #define ICE_PSM_CLK_446MHZ_IN_HZ 446428571 64 #define ICE_PSM_CLK_390MHZ_IN_HZ 390625000 65 66 struct rl_profile_params { 67 u32 bw; /* in Kbps */ 68 u16 rl_multiplier; 69 u16 wake_up_calc; 70 u16 rl_encode; 71 }; 72 73 /* BW rate limit profile parameters list entry along 74 * with bandwidth maintained per layer in port info 75 */ 76 struct ice_aqc_rl_profile_info { 77 struct ice_aqc_rl_profile_elem profile; 78 struct LIST_ENTRY_TYPE list_entry; 79 u32 bw; /* requested */ 80 u16 prof_id_ref; /* profile ID to node association ref count */ 81 }; 82 83 struct ice_sched_agg_vsi_info { 84 struct LIST_ENTRY_TYPE list_entry; 85 ice_declare_bitmap(tc_bitmap, ICE_MAX_TRAFFIC_CLASS); 86 u16 vsi_handle; 87 /* save aggregator VSI TC bitmap */ 88 ice_declare_bitmap(replay_tc_bitmap, ICE_MAX_TRAFFIC_CLASS); 89 }; 90 91 struct ice_sched_agg_info { 92 struct LIST_HEAD_TYPE agg_vsi_list; 93 struct LIST_ENTRY_TYPE list_entry; 94 ice_declare_bitmap(tc_bitmap, ICE_MAX_TRAFFIC_CLASS); 95 u32 agg_id; 96 enum ice_agg_type agg_type; 97 /* bw_t_info saves aggregator BW information */ 98 struct ice_bw_type_info bw_t_info[ICE_MAX_TRAFFIC_CLASS]; 99 /* save aggregator TC bitmap */ 100 ice_declare_bitmap(replay_tc_bitmap, ICE_MAX_TRAFFIC_CLASS); 101 }; 102 103 /* FW AQ command calls */ 104 enum ice_status 105 ice_aq_query_rl_profile(struct ice_hw *hw, u16 num_profiles, 106 struct ice_aqc_rl_profile_elem *buf, u16 buf_size, 107 struct ice_sq_cd *cd); 108 enum ice_status 109 ice_aq_cfg_l2_node_cgd(struct ice_hw *hw, u16 num_nodes, 110 struct ice_aqc_cfg_l2_node_cgd_elem *buf, u16 buf_size, 111 struct ice_sq_cd *cd); 112 enum ice_status 113 ice_aq_query_sched_elems(struct ice_hw *hw, u16 elems_req, 114 struct ice_aqc_txsched_elem_data *buf, u16 buf_size, 115 u16 *elems_ret, struct ice_sq_cd *cd); 116 enum ice_status ice_sched_init_port(struct ice_port_info *pi); 117 enum ice_status ice_sched_query_res_alloc(struct ice_hw *hw); 118 void ice_sched_get_psm_clk_freq(struct ice_hw *hw); 119 120 /* Functions to cleanup scheduler SW DB */ 121 void ice_sched_clear_port(struct ice_port_info *pi); 122 void ice_sched_cleanup_all(struct ice_hw *hw); 123 void ice_sched_clear_agg(struct ice_hw *hw); 124 125 /* Get a scheduling node from SW DB for given TEID */ 126 struct ice_sched_node *ice_sched_get_node(struct ice_port_info *pi, u32 teid); 127 struct ice_sched_node * 128 ice_sched_find_node_by_teid(struct ice_sched_node *start_node, u32 teid); 129 /* Add a scheduling node into SW DB for given info */ 130 enum ice_status 131 ice_sched_add_node(struct ice_port_info *pi, u8 layer, 132 struct ice_aqc_txsched_elem_data *info); 133 void ice_free_sched_node(struct ice_port_info *pi, struct ice_sched_node *node); 134 struct ice_sched_node *ice_sched_get_tc_node(struct ice_port_info *pi, u8 tc); 135 struct ice_sched_node * 136 ice_sched_get_free_qparent(struct ice_port_info *pi, u16 vsi_handle, u8 tc, 137 u8 owner); 138 enum ice_status 139 ice_sched_cfg_vsi(struct ice_port_info *pi, u16 vsi_handle, u8 tc, u16 maxqs, 140 u8 owner, bool enable); 141 enum ice_status ice_rm_vsi_lan_cfg(struct ice_port_info *pi, u16 vsi_handle); 142 enum ice_status ice_rm_vsi_rdma_cfg(struct ice_port_info *pi, u16 vsi_handle); 143 struct ice_sched_node * 144 ice_sched_get_vsi_node(struct ice_port_info *pi, struct ice_sched_node *tc_node, 145 u16 vsi_handle); 146 bool ice_sched_is_tree_balanced(struct ice_hw *hw, struct ice_sched_node *node); 147 enum ice_status 148 ice_aq_query_node_to_root(struct ice_hw *hw, u32 node_teid, 149 struct ice_aqc_txsched_elem_data *buf, u16 buf_size, 150 struct ice_sq_cd *cd); 151 152 /* Tx scheduler rate limiter functions */ 153 enum ice_status 154 ice_cfg_agg(struct ice_port_info *pi, u32 agg_id, 155 enum ice_agg_type agg_type, u8 tc_bitmap); 156 enum ice_status 157 ice_move_vsi_to_agg(struct ice_port_info *pi, u32 agg_id, u16 vsi_handle, 158 u8 tc_bitmap); 159 enum ice_status ice_rm_agg_cfg(struct ice_port_info *pi, u32 agg_id); 160 enum ice_status 161 ice_cfg_q_bw_lmt(struct ice_port_info *pi, u16 vsi_handle, u8 tc, 162 u16 q_handle, enum ice_rl_type rl_type, u32 bw); 163 enum ice_status 164 ice_cfg_q_bw_dflt_lmt(struct ice_port_info *pi, u16 vsi_handle, u8 tc, 165 u16 q_handle, enum ice_rl_type rl_type); 166 enum ice_status 167 ice_cfg_tc_node_bw_lmt(struct ice_port_info *pi, u8 tc, 168 enum ice_rl_type rl_type, u32 bw); 169 enum ice_status 170 ice_cfg_tc_node_bw_dflt_lmt(struct ice_port_info *pi, u8 tc, 171 enum ice_rl_type rl_type); 172 enum ice_status 173 ice_cfg_vsi_bw_lmt_per_tc(struct ice_port_info *pi, u16 vsi_handle, u8 tc, 174 enum ice_rl_type rl_type, u32 bw); 175 enum ice_status 176 ice_cfg_vsi_bw_dflt_lmt_per_tc(struct ice_port_info *pi, u16 vsi_handle, u8 tc, 177 enum ice_rl_type rl_type); 178 enum ice_status 179 ice_cfg_agg_bw_lmt_per_tc(struct ice_port_info *pi, u32 agg_id, u8 tc, 180 enum ice_rl_type rl_type, u32 bw); 181 enum ice_status 182 ice_cfg_agg_bw_dflt_lmt_per_tc(struct ice_port_info *pi, u32 agg_id, u8 tc, 183 enum ice_rl_type rl_type); 184 enum ice_status 185 ice_cfg_vsi_bw_shared_lmt(struct ice_port_info *pi, u16 vsi_handle, u32 min_bw, 186 u32 max_bw, u32 shared_bw); 187 enum ice_status 188 ice_cfg_vsi_bw_no_shared_lmt(struct ice_port_info *pi, u16 vsi_handle); 189 enum ice_status 190 ice_cfg_agg_bw_shared_lmt(struct ice_port_info *pi, u32 agg_id, u32 min_bw, 191 u32 max_bw, u32 shared_bw); 192 enum ice_status 193 ice_cfg_agg_bw_no_shared_lmt(struct ice_port_info *pi, u32 agg_id); 194 enum ice_status 195 ice_cfg_agg_bw_shared_lmt_per_tc(struct ice_port_info *pi, u32 agg_id, u8 tc, 196 u32 min_bw, u32 max_bw, u32 shared_bw); 197 enum ice_status 198 ice_cfg_agg_bw_no_shared_lmt_per_tc(struct ice_port_info *pi, u32 agg_id, 199 u8 tc); 200 enum ice_status 201 ice_cfg_vsi_q_priority(struct ice_port_info *pi, u16 num_qs, u32 *q_ids, 202 u8 *q_prio); 203 enum ice_status 204 ice_cfg_vsi_bw_alloc(struct ice_port_info *pi, u16 vsi_handle, u8 ena_tcmap, 205 enum ice_rl_type rl_type, u8 *bw_alloc); 206 enum ice_status 207 ice_cfg_agg_vsi_priority_per_tc(struct ice_port_info *pi, u32 agg_id, 208 u16 num_vsis, u16 *vsi_handle_arr, 209 u8 *node_prio, u8 tc); 210 enum ice_status 211 ice_cfg_agg_bw_alloc(struct ice_port_info *pi, u32 agg_id, u8 ena_tcmap, 212 enum ice_rl_type rl_type, u8 *bw_alloc); 213 bool 214 ice_sched_find_node_in_subtree(struct ice_hw *hw, struct ice_sched_node *base, 215 struct ice_sched_node *node); 216 enum ice_status 217 ice_sched_set_agg_bw_dflt_lmt(struct ice_port_info *pi, u16 vsi_handle); 218 enum ice_status 219 ice_sched_set_node_bw_lmt_per_tc(struct ice_port_info *pi, u32 id, 220 enum ice_agg_type agg_type, u8 tc, 221 enum ice_rl_type rl_type, u32 bw); 222 enum ice_status 223 ice_sched_set_vsi_bw_shared_lmt(struct ice_port_info *pi, u16 vsi_handle, 224 u32 min_bw, u32 max_bw, u32 shared_bw); 225 enum ice_status 226 ice_sched_set_agg_bw_shared_lmt(struct ice_port_info *pi, u32 agg_id, u32 min_bw, 227 u32 max_bw, u32 shared_bw); 228 enum ice_status 229 ice_sched_set_agg_bw_shared_lmt_per_tc(struct ice_port_info *pi, u32 agg_id, 230 u8 tc, u32 min_bw, u32 max_bw, 231 u32 shared_bw); 232 enum ice_status 233 ice_sched_cfg_sibl_node_prio(struct ice_port_info *pi, 234 struct ice_sched_node *node, u8 priority); 235 enum ice_status 236 ice_cfg_tc_node_bw_alloc(struct ice_port_info *pi, u8 tc, 237 enum ice_rl_type rl_type, u8 bw_alloc); 238 enum ice_status ice_cfg_rl_burst_size(struct ice_hw *hw, u32 bytes); 239 void ice_sched_replay_agg_vsi_preinit(struct ice_hw *hw); 240 void ice_sched_replay_agg(struct ice_hw *hw); 241 enum ice_status ice_sched_replay_tc_node_bw(struct ice_port_info *pi); 242 enum ice_status ice_replay_vsi_agg(struct ice_hw *hw, u16 vsi_handle); 243 enum ice_status ice_sched_replay_root_node_bw(struct ice_port_info *pi); 244 enum ice_status 245 ice_sched_replay_q_bw(struct ice_port_info *pi, struct ice_q_ctx *q_ctx); 246 247 #endif /* _ICE_SCHED_H_ */ 248