net/ice/base: protect profile map list with locks
[dpdk.git] / drivers / net / ice / base / ice_sched.h
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2001-2019
3  */
4
5 #ifndef _ICE_SCHED_H_
6 #define _ICE_SCHED_H_
7
8 #include "ice_common.h"
9
10 #define ICE_QGRP_LAYER_OFFSET   2
11 #define ICE_VSI_LAYER_OFFSET    4
12 #define ICE_AGG_LAYER_OFFSET    6
13 #define ICE_SCHED_INVAL_LAYER_NUM       0xFF
14 /* Burst size is a 12 bits register that is configured while creating the RL
15  * profile(s). MSB is a granularity bit and tells the granularity type
16  * 0 - LSB bits are in bytes granularity
17  * 1 - LSB bits are in 1K bytes granularity
18  */
19 #define ICE_BYTE_GRANULARITY                    0
20 #define ICE_KBYTE_GRANULARITY                   0x800
21 #define ICE_MIN_BURST_SIZE_ALLOWED              1 /* In Bytes */
22 #define ICE_MAX_BURST_SIZE_ALLOWED              (2047 * 1024) /* In Bytes */
23 #define ICE_MAX_BURST_SIZE_BYTE_GRANULARITY     2047 /* In Bytes */
24 #define ICE_MAX_BURST_SIZE_KBYTE_GRANULARITY    ICE_MAX_BURST_SIZE_ALLOWED
25
26 #define ICE_RL_PROF_FREQUENCY 446000000
27 #define ICE_RL_PROF_ACCURACY_BYTES 128
28 #define ICE_RL_PROF_MULTIPLIER 10000
29 #define ICE_RL_PROF_TS_MULTIPLIER 32
30 #define ICE_RL_PROF_FRACTION 512
31
32 struct rl_profile_params {
33         u32 bw;                 /* in Kbps */
34         u16 rl_multiplier;
35         u16 wake_up_calc;
36         u16 rl_encode;
37 };
38
39 /* BW rate limit profile parameters list entry along
40  * with bandwidth maintained per layer in port info
41  */
42 struct ice_aqc_rl_profile_info {
43         struct ice_aqc_rl_profile_elem profile;
44         struct LIST_ENTRY_TYPE list_entry;
45         u32 bw;                 /* requested */
46         u16 prof_id_ref;        /* profile ID to node association ref count */
47 };
48
49 struct ice_sched_agg_vsi_info {
50         struct LIST_ENTRY_TYPE list_entry;
51         ice_declare_bitmap(tc_bitmap, ICE_MAX_TRAFFIC_CLASS);
52         u16 vsi_handle;
53         /* save aggregator VSI TC bitmap */
54         ice_declare_bitmap(replay_tc_bitmap, ICE_MAX_TRAFFIC_CLASS);
55 };
56
57 struct ice_sched_agg_info {
58         struct LIST_HEAD_TYPE agg_vsi_list;
59         struct LIST_ENTRY_TYPE list_entry;
60         ice_declare_bitmap(tc_bitmap, ICE_MAX_TRAFFIC_CLASS);
61         u32 agg_id;
62         enum ice_agg_type agg_type;
63         /* bw_t_info saves aggregator BW information */
64         struct ice_bw_type_info bw_t_info[ICE_MAX_TRAFFIC_CLASS];
65         /* save aggregator TC bitmap */
66         ice_declare_bitmap(replay_tc_bitmap, ICE_MAX_TRAFFIC_CLASS);
67 };
68
69 /* FW AQ command calls */
70 enum ice_status
71 ice_aq_query_rl_profile(struct ice_hw *hw, u16 num_profiles,
72                         struct ice_aqc_rl_profile_generic_elem *buf,
73                         u16 buf_size, struct ice_sq_cd *cd);
74 enum ice_status
75 ice_aq_cfg_l2_node_cgd(struct ice_hw *hw, u16 num_nodes,
76                        struct ice_aqc_cfg_l2_node_cgd_data *buf, u16 buf_size,
77                        struct ice_sq_cd *cd);
78 enum ice_status
79 ice_aq_query_sched_elems(struct ice_hw *hw, u16 elems_req,
80                          struct ice_aqc_get_elem *buf, u16 buf_size,
81                          u16 *elems_ret, struct ice_sq_cd *cd);
82 enum ice_status ice_sched_init_port(struct ice_port_info *pi);
83 enum ice_status ice_sched_query_res_alloc(struct ice_hw *hw);
84
85 /* Functions to cleanup scheduler SW DB */
86 void ice_sched_clear_port(struct ice_port_info *pi);
87 void ice_sched_cleanup_all(struct ice_hw *hw);
88 void ice_sched_clear_agg(struct ice_hw *hw);
89
90 /* Get a scheduling node from SW DB for given TEID */
91 struct ice_sched_node *ice_sched_get_node(struct ice_port_info *pi, u32 teid);
92 struct ice_sched_node *
93 ice_sched_find_node_by_teid(struct ice_sched_node *start_node, u32 teid);
94 /* Add a scheduling node into SW DB for given info */
95 enum ice_status
96 ice_sched_add_node(struct ice_port_info *pi, u8 layer,
97                    struct ice_aqc_txsched_elem_data *info);
98 void ice_free_sched_node(struct ice_port_info *pi, struct ice_sched_node *node);
99 struct ice_sched_node *ice_sched_get_tc_node(struct ice_port_info *pi, u8 tc);
100 struct ice_sched_node *
101 ice_sched_get_free_qparent(struct ice_port_info *pi, u16 vsi_handle, u8 tc,
102                            u8 owner);
103 enum ice_status
104 ice_sched_cfg_vsi(struct ice_port_info *pi, u16 vsi_handle, u8 tc, u16 maxqs,
105                   u8 owner, bool enable);
106 enum ice_status ice_rm_vsi_lan_cfg(struct ice_port_info *pi, u16 vsi_handle);
107 struct ice_sched_node *
108 ice_sched_get_vsi_node(struct ice_hw *hw, struct ice_sched_node *tc_node,
109                        u16 vsi_handle);
110 bool ice_sched_is_tree_balanced(struct ice_hw *hw, struct ice_sched_node *node);
111 enum ice_status
112 ice_aq_query_node_to_root(struct ice_hw *hw, u32 node_teid,
113                           struct ice_aqc_get_elem *buf, u16 buf_size,
114                           struct ice_sq_cd *cd);
115
116 /* Tx scheduler rate limiter functions */
117 enum ice_status
118 ice_cfg_agg(struct ice_port_info *pi, u32 agg_id,
119             enum ice_agg_type agg_type, u8 tc_bitmap);
120 enum ice_status
121 ice_move_vsi_to_agg(struct ice_port_info *pi, u32 agg_id, u16 vsi_handle,
122                     u8 tc_bitmap);
123 enum ice_status ice_rm_agg_cfg(struct ice_port_info *pi, u32 agg_id);
124 enum ice_status
125 ice_cfg_q_bw_lmt(struct ice_port_info *pi, u16 vsi_handle, u8 tc,
126                  u16 q_handle, enum ice_rl_type rl_type, u32 bw);
127 enum ice_status
128 ice_cfg_q_bw_dflt_lmt(struct ice_port_info *pi, u16 vsi_handle, u8 tc,
129                       u16 q_handle, enum ice_rl_type rl_type);
130 enum ice_status
131 ice_cfg_tc_node_bw_lmt(struct ice_port_info *pi, u8 tc,
132                        enum ice_rl_type rl_type, u32 bw);
133 enum ice_status
134 ice_cfg_tc_node_bw_dflt_lmt(struct ice_port_info *pi, u8 tc,
135                             enum ice_rl_type rl_type);
136 enum ice_status
137 ice_cfg_vsi_bw_lmt_per_tc(struct ice_port_info *pi, u16 vsi_handle, u8 tc,
138                           enum ice_rl_type rl_type, u32 bw);
139 enum ice_status
140 ice_cfg_vsi_bw_dflt_lmt_per_tc(struct ice_port_info *pi, u16 vsi_handle, u8 tc,
141                                enum ice_rl_type rl_type);
142 enum ice_status
143 ice_cfg_agg_bw_lmt_per_tc(struct ice_port_info *pi, u32 agg_id, u8 tc,
144                           enum ice_rl_type rl_type, u32 bw);
145 enum ice_status
146 ice_cfg_agg_bw_dflt_lmt_per_tc(struct ice_port_info *pi, u32 agg_id, u8 tc,
147                                enum ice_rl_type rl_type);
148 enum ice_status
149 ice_cfg_vsi_bw_shared_lmt(struct ice_port_info *pi, u16 vsi_handle, u32 bw);
150 enum ice_status
151 ice_cfg_vsi_bw_no_shared_lmt(struct ice_port_info *pi, u16 vsi_handle);
152 enum ice_status
153 ice_cfg_agg_bw_shared_lmt(struct ice_port_info *pi, u32 agg_id, u32 bw);
154 enum ice_status
155 ice_cfg_agg_bw_no_shared_lmt(struct ice_port_info *pi, u32 agg_id);
156 enum ice_status
157 ice_cfg_vsi_q_priority(struct ice_port_info *pi, u16 num_qs, u32 *q_ids,
158                        u8 *q_prio);
159 enum ice_status
160 ice_cfg_vsi_bw_alloc(struct ice_port_info *pi, u16 vsi_handle, u8 ena_tcmap,
161                      enum ice_rl_type rl_type, u8 *bw_alloc);
162 enum ice_status
163 ice_cfg_agg_vsi_priority_per_tc(struct ice_port_info *pi, u32 agg_id,
164                                 u16 num_vsis, u16 *vsi_handle_arr,
165                                 u8 *node_prio, u8 tc);
166 enum ice_status
167 ice_cfg_agg_bw_alloc(struct ice_port_info *pi, u32 agg_id, u8 ena_tcmap,
168                      enum ice_rl_type rl_type, u8 *bw_alloc);
169 bool
170 ice_sched_find_node_in_subtree(struct ice_hw *hw, struct ice_sched_node *base,
171                                struct ice_sched_node *node);
172 enum ice_status
173 ice_sched_set_agg_bw_dflt_lmt(struct ice_port_info *pi, u16 vsi_handle);
174 enum ice_status
175 ice_sched_set_node_bw_lmt_per_tc(struct ice_port_info *pi, u32 id,
176                                  enum ice_agg_type agg_type, u8 tc,
177                                  enum ice_rl_type rl_type, u32 bw);
178 enum ice_status
179 ice_sched_set_vsi_bw_shared_lmt(struct ice_port_info *pi, u16 vsi_handle,
180                                 u32 bw);
181 enum ice_status
182 ice_sched_set_agg_bw_shared_lmt(struct ice_port_info *pi, u32 agg_id, u32 bw);
183 enum ice_status
184 ice_sched_cfg_sibl_node_prio(struct ice_hw *hw, struct ice_sched_node *node,
185                              u8 priority);
186 #endif /* _ICE_SCHED_H_ */