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