fd61c0eeace905186fee45563932a413c5c9cb2a
[dpdk.git] / drivers / net / ice / base / ice_switch.h
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2001-2019
3  */
4
5 #ifndef _ICE_SWITCH_H_
6 #define _ICE_SWITCH_H_
7
8 #include "ice_common.h"
9 #include "ice_protocol_type.h"
10
11 #define ICE_SW_CFG_MAX_BUF_LEN 2048
12 #define ICE_MAX_SW 256
13 #define ICE_DFLT_VSI_INVAL 0xff
14
15
16 /* Worst case buffer length for ice_aqc_opc_get_res_alloc */
17 #define ICE_MAX_RES_TYPES 0x80
18 #define ICE_AQ_GET_RES_ALLOC_BUF_LEN \
19         (ICE_MAX_RES_TYPES * sizeof(struct ice_aqc_get_res_resp_elem))
20
21 #define ICE_VSI_INVAL_ID 0xFFFF
22 #define ICE_INVAL_Q_HANDLE 0xFFFF
23
24 /* VSI queue context structure */
25 struct ice_q_ctx {
26         u16  q_handle;
27 };
28
29 /* VSI context structure for add/get/update/free operations */
30 struct ice_vsi_ctx {
31         u16 vsi_num;
32         u16 vsis_allocd;
33         u16 vsis_unallocated;
34         u16 flags;
35         struct ice_aqc_vsi_props info;
36         struct ice_sched_vsi_info sched;
37         u8 alloc_from_pool;
38         u16 num_lan_q_entries[ICE_MAX_TRAFFIC_CLASS];
39         struct ice_q_ctx *lan_q_ctx[ICE_MAX_TRAFFIC_CLASS];
40         struct ice_lock rss_locks;      /* protect rss config in VSI ctx */
41         struct LIST_HEAD_TYPE rss_list_head;
42 };
43
44 /* This is to be used by add/update mirror rule Admin Queue command */
45 struct ice_mir_rule_buf {
46         u16 vsi_idx; /* VSI index */
47
48         /* For each VSI, user can specify whether corresponding VSI
49          * should be added/removed to/from mirror rule
50          *
51          * add mirror rule: this should always be TRUE.
52          * update mirror rule:  add(true) or remove(false) VSI to/from
53          * mirror rule
54          */
55         u8 add;
56 };
57
58 /* Switch recipe ID enum values are specific to hardware */
59 enum ice_sw_lkup_type {
60         ICE_SW_LKUP_ETHERTYPE = 0,
61         ICE_SW_LKUP_MAC = 1,
62         ICE_SW_LKUP_MAC_VLAN = 2,
63         ICE_SW_LKUP_PROMISC = 3,
64         ICE_SW_LKUP_VLAN = 4,
65         ICE_SW_LKUP_DFLT = 5,
66         ICE_SW_LKUP_ETHERTYPE_MAC = 8,
67         ICE_SW_LKUP_PROMISC_VLAN = 9,
68         ICE_SW_LKUP_LAST
69 };
70
71 /* type of filter src ID */
72 enum ice_src_id {
73         ICE_SRC_ID_UNKNOWN = 0,
74         ICE_SRC_ID_VSI,
75         ICE_SRC_ID_QUEUE,
76         ICE_SRC_ID_LPORT,
77 };
78
79 struct ice_fltr_info {
80         /* Look up information: how to look up packet */
81         enum ice_sw_lkup_type lkup_type;
82         /* Forward action: filter action to do after lookup */
83         enum ice_sw_fwd_act_type fltr_act;
84         /* rule ID returned by firmware once filter rule is created */
85         u16 fltr_rule_id;
86         u16 flag;
87 #define ICE_FLTR_RX             BIT(0)
88 #define ICE_FLTR_TX             BIT(1)
89 #define ICE_FLTR_TX_RX          (ICE_FLTR_RX | ICE_FLTR_TX)
90
91         /* Source VSI for LOOKUP_TX or source port for LOOKUP_RX */
92         u16 src;
93         enum ice_src_id src_id;
94
95         union {
96                 struct {
97                         u8 mac_addr[ETH_ALEN];
98                 } mac;
99                 struct {
100                         u8 mac_addr[ETH_ALEN];
101                         u16 vlan_id;
102                 } mac_vlan;
103                 struct {
104                         u16 vlan_id;
105                 } vlan;
106                 /* Set lkup_type as ICE_SW_LKUP_ETHERTYPE
107                  * if just using ethertype as filter. Set lkup_type as
108                  * ICE_SW_LKUP_ETHERTYPE_MAC if MAC also needs to be
109                  * passed in as filter.
110                  */
111                 struct {
112                         u16 ethertype;
113                         u8 mac_addr[ETH_ALEN]; /* optional */
114                 } ethertype_mac;
115         } l_data; /* Make sure to zero out the memory of l_data before using
116                    * it or only set the data associated with lookup match
117                    * rest everything should be zero
118                    */
119
120         /* Depending on filter action */
121         union {
122                 /* queue ID in case of ICE_FWD_TO_Q and starting
123                  * queue ID in case of ICE_FWD_TO_QGRP.
124                  */
125                 u16 q_id:11;
126                 u16 hw_vsi_id:10;
127                 u16 vsi_id:10;
128                 u16 vsi_list_id:10;
129         } fwd_id;
130
131         /* Sw VSI handle */
132         u16 vsi_handle;
133
134         /* Set to num_queues if action is ICE_FWD_TO_QGRP. This field
135          * determines the range of queues the packet needs to be forwarded to.
136          * Note that qgrp_size must be set to a power of 2.
137          */
138         u8 qgrp_size;
139
140         /* Rule creations populate these indicators basing on the switch type */
141         u8 lb_en;       /* Indicate if packet can be looped back */
142         u8 lan_en;      /* Indicate if packet can be forwarded to the uplink */
143 };
144
145 struct ice_adv_lkup_elem {
146         enum ice_protocol_type type;
147         union ice_prot_hdr h_u; /* Header values */
148         union ice_prot_hdr m_u; /* Mask of header values to match */
149 };
150
151 struct ice_sw_act_ctrl {
152         /* Source VSI for LOOKUP_TX or source port for LOOKUP_RX */
153         u16 src;
154         u16 flag;
155 #define ICE_FLTR_RX             BIT(0)
156 #define ICE_FLTR_TX             BIT(1)
157 #define ICE_FLTR_TX_RX (ICE_FLTR_RX | ICE_FLTR_TX)
158
159         enum ice_sw_fwd_act_type fltr_act;
160         /* Depending on filter action */
161         union {
162                 /* This is a queue ID in case of ICE_FWD_TO_Q and starting
163                  * queue ID in case of ICE_FWD_TO_QGRP.
164                  */
165                 u16 q_id:11;
166                 u16 vsi_id:10;
167                 u16 hw_vsi_id:10;
168                 u16 vsi_list_id:10;
169         } fwd_id;
170         /* software VSI handle */
171         u16 vsi_handle;
172         u8 qgrp_size;
173 };
174
175 struct ice_adv_rule_info {
176         enum ice_sw_tunnel_type tun_type;
177         struct ice_sw_act_ctrl sw_act;
178         u32 priority;
179         u8 rx; /* true means LOOKUP_RX otherwise LOOKUP_TX */
180 };
181
182 /* A collection of one or more four word recipe */
183 struct ice_sw_recipe {
184         /* For a chained recipe the root recipe is what should be used for
185          * programming rules
186          */
187         u8 root_rid;
188         u8 recp_created;
189
190         /* Number of extraction words */
191         u8 n_ext_words;
192         /* Protocol ID and Offset pair (extraction word) to describe the
193          * recipe
194          */
195         struct ice_fv_word ext_words[ICE_MAX_CHAIN_WORDS];
196
197         /* if this recipe is a collection of other recipe */
198         u8 big_recp;
199
200         /* if this recipe is part of another bigger recipe then chain index
201          * corresponding to this recipe
202          */
203         u8 chain_idx;
204
205         /* if this recipe is a collection of other recipe then count of other
206          * recipes and recipe IDs of those recipes
207          */
208         u8 n_grp_count;
209
210         /* Bit map specifying the IDs associated with this group of recipe */
211         ice_declare_bitmap(r_bitmap, ICE_MAX_NUM_RECIPES);
212
213         enum ice_sw_tunnel_type tun_type;
214
215         /* List of type ice_fltr_mgmt_list_entry or adv_rule */
216         u8 adv_rule;
217         struct LIST_HEAD_TYPE filt_rules;
218         struct LIST_HEAD_TYPE filt_replay_rules;
219
220         struct ice_lock filt_rule_lock; /* protect filter rule structure */
221
222         /* Profiles this recipe should be associated with */
223         struct LIST_HEAD_TYPE fv_list;
224
225         /* Profiles this recipe is associated with */
226         u8 num_profs, *prof_ids;
227
228         /* This allows user to specify the recipe priority.
229          * For now, this becomes 'fwd_priority' when recipe
230          * is created, usually recipes can have 'fwd' and 'join'
231          * priority.
232          */
233         u8 priority;
234
235         struct LIST_HEAD_TYPE rg_list;
236
237         /* AQ buffer associated with this recipe */
238         struct ice_aqc_recipe_data_elem *root_buf;
239         /* This struct saves the fv_words for a given lookup */
240         struct ice_prot_lkup_ext lkup_exts;
241 };
242
243 /* Bookkeeping structure to hold bitmap of VSIs corresponding to VSI list ID */
244 struct ice_vsi_list_map_info {
245         struct LIST_ENTRY_TYPE list_entry;
246         ice_declare_bitmap(vsi_map, ICE_MAX_VSI);
247         u16 vsi_list_id;
248         /* counter to track how many rules are reusing this VSI list */
249         u16 ref_cnt;
250 };
251
252 struct ice_fltr_list_entry {
253         struct LIST_ENTRY_TYPE list_entry;
254         enum ice_status status;
255         struct ice_fltr_info fltr_info;
256 };
257
258 /* This defines an entry in the list that maintains MAC or VLAN membership
259  * to HW list mapping, since multiple VSIs can subscribe to the same MAC or
260  * VLAN. As an optimization the VSI list should be created only when a
261  * second VSI becomes a subscriber to the same MAC address. VSI lists are always
262  * used for VLAN membership.
263  */
264 struct ice_fltr_mgmt_list_entry {
265         /* back pointer to VSI list ID to VSI list mapping */
266         struct ice_vsi_list_map_info *vsi_list_info;
267         u16 vsi_count;
268 #define ICE_INVAL_LG_ACT_INDEX 0xffff
269         u16 lg_act_idx;
270 #define ICE_INVAL_SW_MARKER_ID 0xffff
271         u16 sw_marker_id;
272         struct LIST_ENTRY_TYPE list_entry;
273         struct ice_fltr_info fltr_info;
274 #define ICE_INVAL_COUNTER_ID 0xff
275         u8 counter_index;
276 };
277
278 struct ice_adv_fltr_mgmt_list_entry {
279         struct LIST_ENTRY_TYPE list_entry;
280
281         struct ice_adv_lkup_elem *lkups;
282         struct ice_adv_rule_info rule_info;
283         u16 lkups_cnt;
284 };
285
286 enum ice_promisc_flags {
287         ICE_PROMISC_UCAST_RX = 0x1,
288         ICE_PROMISC_UCAST_TX = 0x2,
289         ICE_PROMISC_MCAST_RX = 0x4,
290         ICE_PROMISC_MCAST_TX = 0x8,
291         ICE_PROMISC_BCAST_RX = 0x10,
292         ICE_PROMISC_BCAST_TX = 0x20,
293         ICE_PROMISC_VLAN_RX = 0x40,
294         ICE_PROMISC_VLAN_TX = 0x80,
295 };
296
297 /* VSI related commands */
298 enum ice_status
299 ice_aq_add_vsi(struct ice_hw *hw, struct ice_vsi_ctx *vsi_ctx,
300                struct ice_sq_cd *cd);
301 enum ice_status
302 ice_aq_free_vsi(struct ice_hw *hw, struct ice_vsi_ctx *vsi_ctx,
303                 bool keep_vsi_alloc, struct ice_sq_cd *cd);
304 enum ice_status
305 ice_aq_update_vsi(struct ice_hw *hw, struct ice_vsi_ctx *vsi_ctx,
306                   struct ice_sq_cd *cd);
307 enum ice_status
308 ice_add_vsi(struct ice_hw *hw, u16 vsi_handle, struct ice_vsi_ctx *vsi_ctx,
309             struct ice_sq_cd *cd);
310 enum ice_status
311 ice_free_vsi(struct ice_hw *hw, u16 vsi_handle, struct ice_vsi_ctx *vsi_ctx,
312              bool keep_vsi_alloc, struct ice_sq_cd *cd);
313 enum ice_status
314 ice_update_vsi(struct ice_hw *hw, u16 vsi_handle, struct ice_vsi_ctx *vsi_ctx,
315                struct ice_sq_cd *cd);
316 struct ice_vsi_ctx *ice_get_vsi_ctx(struct ice_hw *hw, u16 vsi_handle);
317 void ice_clear_all_vsi_ctx(struct ice_hw *hw);
318 enum ice_status
319 ice_aq_get_vsi_params(struct ice_hw *hw, struct ice_vsi_ctx *vsi_ctx,
320                       struct ice_sq_cd *cd);
321 enum ice_status
322 ice_aq_add_update_mir_rule(struct ice_hw *hw, u16 rule_type, u16 dest_vsi,
323                            u16 count, struct ice_mir_rule_buf *mr_buf,
324                            struct ice_sq_cd *cd, u16 *rule_id);
325 enum ice_status
326 ice_aq_delete_mir_rule(struct ice_hw *hw, u16 rule_id, bool keep_allocd,
327                        struct ice_sq_cd *cd);
328 enum ice_status
329 ice_aq_get_storm_ctrl(struct ice_hw *hw, u32 *bcast_thresh, u32 *mcast_thresh,
330                       u32 *ctl_bitmask);
331 enum ice_status
332 ice_aq_set_storm_ctrl(struct ice_hw *hw, u32 bcast_thresh, u32 mcast_thresh,
333                       u32 ctl_bitmask);
334 /* Switch config */
335 enum ice_status ice_get_initial_sw_cfg(struct ice_hw *hw);
336
337 enum ice_status
338 ice_alloc_vlan_res_counter(struct ice_hw *hw, u16 *counter_id);
339 enum ice_status
340 ice_free_vlan_res_counter(struct ice_hw *hw, u16 counter_id);
341 enum ice_status
342 ice_alloc_res_cntr(struct ice_hw *hw, u8 type, u8 alloc_shared, u16 num_items,
343                    u16 *counter_id);
344 enum ice_status
345 ice_free_res_cntr(struct ice_hw *hw, u8 type, u8 alloc_shared, u16 num_items,
346                   u16 counter_id);
347
348 /* Switch/bridge related commands */
349 enum ice_status ice_update_sw_rule_bridge_mode(struct ice_hw *hw);
350 enum ice_status
351 ice_alloc_sw(struct ice_hw *hw, bool ena_stats, bool shared_res, u16 *sw_id,
352              u16 *counter_id);
353 enum ice_status
354 ice_free_sw(struct ice_hw *hw, u16 sw_id, u16 counter_id);
355 enum ice_status
356 ice_aq_get_res_alloc(struct ice_hw *hw, u16 *num_entries, void *buf,
357                      u16 buf_size, struct ice_sq_cd *cd);
358 enum ice_status
359 ice_aq_get_res_descs(struct ice_hw *hw, u16 num_entries,
360                      struct ice_aqc_get_allocd_res_desc_resp *buf,
361                      u16 buf_size, u16 res_type, bool res_shared, u16 *desc_id,
362                      struct ice_sq_cd *cd);
363 enum ice_status
364 ice_add_vlan(struct ice_hw *hw, struct LIST_HEAD_TYPE *m_list);
365 void ice_rem_all_sw_rules_info(struct ice_hw *hw);
366 enum ice_status ice_add_mac(struct ice_hw *hw, struct LIST_HEAD_TYPE *m_lst);
367 enum ice_status ice_remove_mac(struct ice_hw *hw, struct LIST_HEAD_TYPE *m_lst);
368 enum ice_status
369 ice_add_eth_mac(struct ice_hw *hw, struct LIST_HEAD_TYPE *em_list);
370 enum ice_status
371 ice_remove_eth_mac(struct ice_hw *hw, struct LIST_HEAD_TYPE *em_list);
372 enum ice_status
373 ice_remove_vlan(struct ice_hw *hw, struct LIST_HEAD_TYPE *v_list);
374 #ifndef NO_MACVLAN_SUPPORT
375 enum ice_status
376 ice_add_mac_vlan(struct ice_hw *hw, struct LIST_HEAD_TYPE *m_list);
377 enum ice_status
378 ice_remove_mac_vlan(struct ice_hw *hw, struct LIST_HEAD_TYPE *v_list);
379 #endif /* !NO_MACVLAN_SUPPORT */
380
381 enum ice_status
382 ice_add_mac_with_sw_marker(struct ice_hw *hw, struct ice_fltr_info *f_info,
383                            u16 sw_marker);
384 enum ice_status
385 ice_add_mac_with_counter(struct ice_hw *hw, struct ice_fltr_info *f_info);
386 void ice_remove_vsi_fltr(struct ice_hw *hw, u16 vsi_handle);
387
388
389 /* Promisc/defport setup for VSIs */
390 enum ice_status
391 ice_cfg_dflt_vsi(struct ice_port_info *pi, u16 vsi_handle, bool set,
392                  u8 direction);
393 enum ice_status
394 ice_set_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 promisc_mask,
395                     u16 vid);
396 enum ice_status
397 ice_clear_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 promisc_mask,
398                       u16 vid);
399 enum ice_status
400 ice_set_vlan_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 promisc_mask,
401                          bool rm_vlan_promisc);
402
403 /* Get VSIs Promisc/defport settings */
404 enum ice_status
405 ice_get_vsi_promisc(struct ice_hw *hw, u16 vsi_handle, u8 *promisc_mask,
406                     u16 *vid);
407 enum ice_status
408 ice_get_vsi_vlan_promisc(struct ice_hw *hw, u16 vsi_handle, u8 *promisc_mask,
409                          u16 *vid);
410
411 enum ice_status
412 ice_aq_add_recipe(struct ice_hw *hw,
413                   struct ice_aqc_recipe_data_elem *s_recipe_list,
414                   u16 num_recipes, struct ice_sq_cd *cd);
415
416 enum ice_status
417 ice_aq_get_recipe(struct ice_hw *hw,
418                   struct ice_aqc_recipe_data_elem *s_recipe_list,
419                   u16 *num_recipes, u16 recipe_root, struct ice_sq_cd *cd);
420 enum ice_status
421 ice_aq_map_recipe_to_profile(struct ice_hw *hw, u32 profile_id, u8 *r_bitmap,
422                              struct ice_sq_cd *cd);
423
424 enum ice_status ice_alloc_recipe(struct ice_hw *hw, u16 *recipe_id);
425 enum ice_status ice_replay_all_fltr(struct ice_hw *hw);
426
427 enum ice_status ice_init_def_sw_recp(struct ice_hw *hw);
428 u16 ice_get_hw_vsi_num(struct ice_hw *hw, u16 vsi_handle);
429 bool ice_is_vsi_valid(struct ice_hw *hw, u16 vsi_handle);
430
431 enum ice_status ice_replay_vsi_all_fltr(struct ice_hw *hw, u16 vsi_handle);
432 void ice_rm_all_sw_replay_rule_info(struct ice_hw *hw);
433
434 #endif /* _ICE_SWITCH_H_ */