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