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