net/ice/base: add RSS support for PPPoE and GTPU
[dpdk.git] / drivers / net / ice / base / ice_flow.h
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2001-2019
3  */
4
5 #ifndef _ICE_FLOW_H_
6 #define _ICE_FLOW_H_
7
8 #include "ice_flex_type.h"
9 #define ICE_IPV4_MAKE_PREFIX_MASK(prefix) ((u32)(~0) << (32 - (prefix)))
10 #define ICE_FLOW_PROF_ID_INVAL          0xfffffffffffffffful
11 #define ICE_FLOW_PROF_ID_BYPASS         0
12 #define ICE_FLOW_PROF_ID_DEFAULT        1
13 #define ICE_FLOW_ENTRY_HANDLE_INVAL     0
14 #define ICE_FLOW_VSI_INVAL              0xffff
15 #define ICE_FLOW_FLD_OFF_INVAL          0xffff
16
17 /* Use any of the type from flow field to generate a equivalent hash field */
18 #define ICE_FLOW_HASH_FLD(t)    (1ULL << (t))
19
20 #define ICE_FLOW_HASH_IPV4      \
21         (ICE_FLOW_HASH_FLD(ICE_FLOW_FIELD_IDX_IPV4_SA) | \
22          ICE_FLOW_HASH_FLD(ICE_FLOW_FIELD_IDX_IPV4_DA))
23 #define ICE_FLOW_HASH_IPV6      \
24         (ICE_FLOW_HASH_FLD(ICE_FLOW_FIELD_IDX_IPV6_SA) | \
25          ICE_FLOW_HASH_FLD(ICE_FLOW_FIELD_IDX_IPV6_DA))
26 #define ICE_FLOW_HASH_TCP_PORT  \
27         (ICE_FLOW_HASH_FLD(ICE_FLOW_FIELD_IDX_TCP_SRC_PORT) | \
28          ICE_FLOW_HASH_FLD(ICE_FLOW_FIELD_IDX_TCP_DST_PORT))
29 #define ICE_FLOW_HASH_UDP_PORT  \
30         (ICE_FLOW_HASH_FLD(ICE_FLOW_FIELD_IDX_UDP_SRC_PORT) | \
31          ICE_FLOW_HASH_FLD(ICE_FLOW_FIELD_IDX_UDP_DST_PORT))
32 #define ICE_FLOW_HASH_SCTP_PORT \
33         (ICE_FLOW_HASH_FLD(ICE_FLOW_FIELD_IDX_SCTP_SRC_PORT) | \
34          ICE_FLOW_HASH_FLD(ICE_FLOW_FIELD_IDX_SCTP_DST_PORT))
35
36 #define ICE_HASH_INVALID        0
37 #define ICE_HASH_TCP_IPV4       (ICE_FLOW_HASH_IPV4 | ICE_FLOW_HASH_TCP_PORT)
38 #define ICE_HASH_TCP_IPV6       (ICE_FLOW_HASH_IPV6 | ICE_FLOW_HASH_TCP_PORT)
39 #define ICE_HASH_UDP_IPV4       (ICE_FLOW_HASH_IPV4 | ICE_FLOW_HASH_UDP_PORT)
40 #define ICE_HASH_UDP_IPV6       (ICE_FLOW_HASH_IPV6 | ICE_FLOW_HASH_UDP_PORT)
41 #define ICE_HASH_SCTP_IPV4      (ICE_FLOW_HASH_IPV4 | ICE_FLOW_HASH_SCTP_PORT)
42 #define ICE_HASH_SCTP_IPV6      (ICE_FLOW_HASH_IPV6 | ICE_FLOW_HASH_SCTP_PORT)
43
44 #define ICE_FLOW_HASH_GTP_TEID \
45         (BIT_ULL(ICE_FLOW_FIELD_IDX_GTPC_TEID))
46
47 #define ICE_FLOW_HASH_GTP_IPV4_TEID \
48         (ICE_FLOW_HASH_IPV4 | ICE_FLOW_HASH_GTP_TEID)
49 #define ICE_FLOW_HASH_GTP_IPV6_TEID \
50         (ICE_FLOW_HASH_IPV6 | ICE_FLOW_HASH_GTP_TEID)
51
52 #define ICE_FLOW_HASH_GTP_U_TEID \
53         (BIT_ULL(ICE_FLOW_FIELD_IDX_GTPU_IP_TEID))
54
55 #define ICE_FLOW_HASH_GTP_U_IPV4_TEID \
56         (ICE_FLOW_HASH_IPV4 | ICE_FLOW_HASH_GTP_U_TEID)
57 #define ICE_FLOW_HASH_GTP_U_IPV6_TEID \
58         (ICE_FLOW_HASH_IPV6 | ICE_FLOW_HASH_GTP_U_TEID)
59
60 #define ICE_FLOW_HASH_PPPOE_SESS_ID \
61         (BIT_ULL(ICE_FLOW_FIELD_IDX_PPPOE_SESS_ID))
62
63 #define ICE_FLOW_HASH_PPPOE_TCP_ID \
64         (ICE_FLOW_HASH_TCP_PORT | ICE_FLOW_HASH_PPPOE_SESS_ID)
65 #define ICE_FLOW_HASH_PPPOE_UDP_ID \
66         (ICE_FLOW_HASH_UDP_PORT | ICE_FLOW_HASH_PPPOE_SESS_ID)
67
68 /* Protocol header fields within a packet segment. A segment consists of one or
69  * more protocol headers that make up a logical group of protocol headers. Each
70  * logical group of protocol headers encapsulates or is encapsulated using/by
71  * tunneling or encapsulation protocols for network virtualization such as GRE,
72  * VxLAN, etc.
73  */
74 enum ice_flow_seg_hdr {
75         ICE_FLOW_SEG_HDR_NONE           = 0x00000000,
76         ICE_FLOW_SEG_HDR_ETH            = 0x00000001,
77         ICE_FLOW_SEG_HDR_VLAN           = 0x00000002,
78         ICE_FLOW_SEG_HDR_IPV4           = 0x00000004,
79         ICE_FLOW_SEG_HDR_IPV6           = 0x00000008,
80         ICE_FLOW_SEG_HDR_ARP            = 0x00000010,
81         ICE_FLOW_SEG_HDR_ICMP           = 0x00000020,
82         ICE_FLOW_SEG_HDR_TCP            = 0x00000040,
83         ICE_FLOW_SEG_HDR_UDP            = 0x00000080,
84         ICE_FLOW_SEG_HDR_SCTP           = 0x00000100,
85         ICE_FLOW_SEG_HDR_GRE            = 0x00000200,
86         ICE_FLOW_SEG_HDR_GTPC           = 0x00000400,
87         ICE_FLOW_SEG_HDR_GTPC_TEID      = 0x00000800,
88         ICE_FLOW_SEG_HDR_GTPU_IP        = 0x00001000,
89         ICE_FLOW_SEG_HDR_GTPU_DWN       = 0x00002000,
90         ICE_FLOW_SEG_HDR_GTPU_UP        = 0x00004000,
91         ICE_FLOW_SEG_HDR_PPPOE          = 0x00008000,
92 };
93
94 /* These segements all have the same PTYPES, but are otherwise distinguished by
95  * the value of the gtp_eh_pdu and gtp_eh_pdu_link flags:
96  *
97  *                                gtp_eh_pdu     gtp_eh_pdu_link
98  * ICE_FLOW_SEG_HDR_GTPU_IP           0              0
99  * ICE_FLOW_SEG_HDR_GTPU_DWN          1              0
100  * ICE_FLOW_SEG_HDR_GTPU_UP           1              1
101  */
102 #define ICE_FLOW_SEG_HDR_GTPU (ICE_FLOW_SEG_HDR_GTPU_IP | \
103                                ICE_FLOW_SEG_HDR_GTPU_DWN | \
104                                ICE_FLOW_SEG_HDR_GTPU_UP)
105
106 enum ice_flow_field {
107         /* L2 */
108         ICE_FLOW_FIELD_IDX_ETH_DA,
109         ICE_FLOW_FIELD_IDX_ETH_SA,
110         ICE_FLOW_FIELD_IDX_S_VLAN,
111         ICE_FLOW_FIELD_IDX_C_VLAN,
112         ICE_FLOW_FIELD_IDX_ETH_TYPE,
113         /* L3 */
114         ICE_FLOW_FIELD_IDX_IP_DSCP,
115         ICE_FLOW_FIELD_IDX_IP_TTL,
116         ICE_FLOW_FIELD_IDX_IP_PROT,
117         ICE_FLOW_FIELD_IDX_IPV4_SA,
118         ICE_FLOW_FIELD_IDX_IPV4_DA,
119         ICE_FLOW_FIELD_IDX_IPV6_SA,
120         ICE_FLOW_FIELD_IDX_IPV6_DA,
121         /* L4 */
122         ICE_FLOW_FIELD_IDX_TCP_SRC_PORT,
123         ICE_FLOW_FIELD_IDX_TCP_DST_PORT,
124         ICE_FLOW_FIELD_IDX_UDP_SRC_PORT,
125         ICE_FLOW_FIELD_IDX_UDP_DST_PORT,
126         ICE_FLOW_FIELD_IDX_SCTP_SRC_PORT,
127         ICE_FLOW_FIELD_IDX_SCTP_DST_PORT,
128         ICE_FLOW_FIELD_IDX_TCP_FLAGS,
129         /* ARP */
130         ICE_FLOW_FIELD_IDX_ARP_SIP,
131         ICE_FLOW_FIELD_IDX_ARP_DIP,
132         ICE_FLOW_FIELD_IDX_ARP_SHA,
133         ICE_FLOW_FIELD_IDX_ARP_DHA,
134         ICE_FLOW_FIELD_IDX_ARP_OP,
135         /* ICMP */
136         ICE_FLOW_FIELD_IDX_ICMP_TYPE,
137         ICE_FLOW_FIELD_IDX_ICMP_CODE,
138         /* GRE */
139         ICE_FLOW_FIELD_IDX_GRE_KEYID,
140         /* GTPC_TEID */
141         ICE_FLOW_FIELD_IDX_GTPC_TEID,
142         /* GTPU_IP */
143         ICE_FLOW_FIELD_IDX_GTPU_IP_TEID,
144         /* GTPU_UP */
145         ICE_FLOW_FIELD_IDX_GTPU_UP_TEID,
146         /* GTPU_DWN */
147         ICE_FLOW_FIELD_IDX_GTPU_DWN_TEID,
148         /* PPPOE */
149         ICE_FLOW_FIELD_IDX_PPPOE_SESS_ID,
150          /* The total number of enums must not exceed 64 */
151         ICE_FLOW_FIELD_IDX_MAX
152 };
153
154 /* Flow headers and fields for AVF support */
155 enum ice_flow_avf_hdr_field {
156         /* Values 0 - 28 are reserved for future use */
157         ICE_AVF_FLOW_FIELD_INVALID              = 0,
158         ICE_AVF_FLOW_FIELD_UNICAST_IPV4_UDP     = 29,
159         ICE_AVF_FLOW_FIELD_MULTICAST_IPV4_UDP,
160         ICE_AVF_FLOW_FIELD_IPV4_UDP,
161         ICE_AVF_FLOW_FIELD_IPV4_TCP_SYN_NO_ACK,
162         ICE_AVF_FLOW_FIELD_IPV4_TCP,
163         ICE_AVF_FLOW_FIELD_IPV4_SCTP,
164         ICE_AVF_FLOW_FIELD_IPV4_OTHER,
165         ICE_AVF_FLOW_FIELD_FRAG_IPV4,
166         ICE_AVF_FLOW_FIELD_UNICAST_IPV6_UDP     = 39,
167         ICE_AVF_FLOW_FIELD_MULTICAST_IPV6_UDP,
168         ICE_AVF_FLOW_FIELD_IPV6_UDP,
169         ICE_AVF_FLOW_FIELD_IPV6_TCP_SYN_NO_ACK,
170         ICE_AVF_FLOW_FIELD_IPV6_TCP,
171         ICE_AVF_FLOW_FIELD_IPV6_SCTP,
172         ICE_AVF_FLOW_FIELD_IPV6_OTHER,
173         ICE_AVF_FLOW_FIELD_FRAG_IPV6,
174         ICE_AVF_FLOW_FIELD_RSVD47,
175         ICE_AVF_FLOW_FIELD_FCOE_OX,
176         ICE_AVF_FLOW_FIELD_FCOE_RX,
177         ICE_AVF_FLOW_FIELD_FCOE_OTHER,
178         /* Values 51-62 are reserved */
179         ICE_AVF_FLOW_FIELD_L2_PAYLOAD           = 63,
180         ICE_AVF_FLOW_FIELD_MAX
181 };
182
183 /* Supported RSS offloads  This macro is defined to support
184  * VIRTCHNL_OP_GET_RSS_HENA_CAPS ops. PF driver sends the RSS hardware
185  * capabilities to the caller of this ops.
186  */
187 #define ICE_DEFAULT_RSS_HENA ( \
188         BIT_ULL(ICE_AVF_FLOW_FIELD_IPV4_UDP) | \
189         BIT_ULL(ICE_AVF_FLOW_FIELD_IPV4_SCTP) | \
190         BIT_ULL(ICE_AVF_FLOW_FIELD_IPV4_TCP) | \
191         BIT_ULL(ICE_AVF_FLOW_FIELD_IPV4_OTHER) | \
192         BIT_ULL(ICE_AVF_FLOW_FIELD_FRAG_IPV4) | \
193         BIT_ULL(ICE_AVF_FLOW_FIELD_IPV6_UDP) | \
194         BIT_ULL(ICE_AVF_FLOW_FIELD_IPV6_TCP) | \
195         BIT_ULL(ICE_AVF_FLOW_FIELD_IPV6_SCTP) | \
196         BIT_ULL(ICE_AVF_FLOW_FIELD_IPV6_OTHER) | \
197         BIT_ULL(ICE_AVF_FLOW_FIELD_FRAG_IPV6) | \
198         BIT_ULL(ICE_AVF_FLOW_FIELD_IPV4_TCP_SYN_NO_ACK) | \
199         BIT_ULL(ICE_AVF_FLOW_FIELD_UNICAST_IPV4_UDP) | \
200         BIT_ULL(ICE_AVF_FLOW_FIELD_MULTICAST_IPV4_UDP) | \
201         BIT_ULL(ICE_AVF_FLOW_FIELD_IPV6_TCP_SYN_NO_ACK) | \
202         BIT_ULL(ICE_AVF_FLOW_FIELD_UNICAST_IPV6_UDP) | \
203         BIT_ULL(ICE_AVF_FLOW_FIELD_MULTICAST_IPV6_UDP))
204
205 enum ice_flow_dir {
206         ICE_FLOW_DIR_UNDEFINED  = 0,
207         ICE_FLOW_TX             = 0x01,
208         ICE_FLOW_RX             = 0x02,
209         ICE_FLOW_TX_RX          = ICE_FLOW_RX | ICE_FLOW_TX
210 };
211
212 enum ice_flow_priority {
213         ICE_FLOW_PRIO_LOW,
214         ICE_FLOW_PRIO_NORMAL,
215         ICE_FLOW_PRIO_HIGH
216 };
217
218 #define ICE_FLOW_SEG_MAX                2
219 #define ICE_FLOW_SEG_RAW_FLD_MAX        2
220 #define ICE_FLOW_PROFILE_MAX            1024
221 #define ICE_FLOW_SW_FIELD_VECTOR_MAX    48
222 #define ICE_FLOW_ACL_FIELD_VECTOR_MAX   32
223 #define ICE_FLOW_FV_EXTRACT_SZ          2
224
225 #define ICE_FLOW_SET_HDRS(seg, val)     ((seg)->hdrs |= (u32)(val))
226
227 struct ice_flow_seg_xtrct {
228         u8 prot_id;     /* Protocol ID of extracted header field */
229         u16 off;        /* Starting offset of the field in header in bytes */
230         u8 idx;         /* Index of FV entry used */
231         u8 disp;        /* Displacement of field in bits fr. FV entry's start */
232 };
233
234 enum ice_flow_fld_match_type {
235         ICE_FLOW_FLD_TYPE_REG,          /* Value, mask */
236         ICE_FLOW_FLD_TYPE_RANGE,        /* Value, mask, last (upper bound) */
237         ICE_FLOW_FLD_TYPE_PREFIX,       /* IP address, prefix, size of prefix */
238         ICE_FLOW_FLD_TYPE_SIZE,         /* Value, mask, size of match */
239 };
240
241 struct ice_flow_fld_loc {
242         /* Describe offsets of field information relative to the beginning of
243          * input buffer provided when adding flow entries.
244          */
245         u16 val;        /* Offset where the value is located */
246         u16 mask;       /* Offset where the mask/prefix value is located */
247         u16 last;       /* Length or offset where the upper value is located */
248 };
249
250 struct ice_flow_fld_info {
251         enum ice_flow_fld_match_type type;
252         /* Location where to retrieve data from an input buffer */
253         struct ice_flow_fld_loc src;
254         /* Location where to put the data into the final entry buffer */
255         struct ice_flow_fld_loc entry;
256         struct ice_flow_seg_xtrct xtrct;
257 };
258
259 struct ice_flow_seg_fld_raw {
260         int off;        /* Offset from the start of the segment */
261         struct ice_flow_fld_info info;
262 };
263
264 struct ice_flow_seg_info {
265         u32 hdrs;       /* Bitmask indicating protocol headers present */
266         u64 match;      /* Bitmask indicating header fields to be matched */
267         u64 range;      /* Bitmask indicating header fields matched as ranges */
268
269         struct ice_flow_fld_info fields[ICE_FLOW_FIELD_IDX_MAX];
270
271         u8 raws_cnt;    /* Number of raw fields to be matched */
272         struct ice_flow_seg_fld_raw raws[ICE_FLOW_SEG_RAW_FLD_MAX];
273 };
274
275 /* This structure describes a flow entry, and is tracked only in this file */
276 struct ice_flow_entry {
277         struct LIST_ENTRY_TYPE l_entry;
278
279         u64 id;
280         struct ice_flow_prof *prof;
281         /* Action list */
282         struct ice_flow_action *acts;
283         /* Flow entry's content */
284         void *entry;
285         enum ice_flow_priority priority;
286         u16 vsi_handle;
287         u16 entry_sz;
288         u8 acts_cnt;
289 };
290
291 #define ICE_FLOW_ENTRY_HNDL(e)  ((unsigned long)e)
292 #define ICE_FLOW_ENTRY_PTR(h)   ((struct ice_flow_entry *)(h))
293
294 struct ice_flow_prof {
295         struct LIST_ENTRY_TYPE l_entry;
296
297         u64 id;
298         enum ice_flow_dir dir;
299         u8 segs_cnt;
300         u8 acts_cnt;
301
302         /* Keep track of flow entries associated with this flow profile */
303         struct ice_lock entries_lock;
304         struct LIST_HEAD_TYPE entries;
305
306         struct ice_flow_seg_info segs[ICE_FLOW_SEG_MAX];
307
308         /* software VSI handles referenced by this flow profile */
309         ice_declare_bitmap(vsis, ICE_MAX_VSI);
310
311         union {
312                 /* struct sw_recipe */
313                 /* struct fd */
314                 u32 data;
315         } cfg;
316
317         /* Default actions */
318         struct ice_flow_action *acts;
319 };
320
321 struct ice_rss_cfg {
322         struct LIST_ENTRY_TYPE l_entry;
323         /* bitmap of VSIs added to the RSS entry */
324         ice_declare_bitmap(vsis, ICE_MAX_VSI);
325         u64 hashed_flds;
326         u32 packet_hdr;
327 };
328
329 enum ice_flow_action_type {
330         ICE_FLOW_ACT_NOP,
331         ICE_FLOW_ACT_ALLOW,
332         ICE_FLOW_ACT_DROP,
333         ICE_FLOW_ACT_CNTR_PKT,
334         ICE_FLOW_ACT_FWD_VSI,
335         ICE_FLOW_ACT_FWD_VSI_LIST,      /* Should be abstracted away */
336         ICE_FLOW_ACT_FWD_QUEUE,         /* Can Queues be abstracted away? */
337         ICE_FLOW_ACT_FWD_QUEUE_GROUP,   /* Can Queues be abstracted away? */
338         ICE_FLOW_ACT_PUSH,
339         ICE_FLOW_ACT_POP,
340         ICE_FLOW_ACT_MODIFY,
341         ICE_FLOW_ACT_CNTR_BYTES,
342         ICE_FLOW_ACT_CNTR_PKT_BYTES,
343         ICE_FLOW_ACT_GENERIC_0,
344         ICE_FLOW_ACT_GENERIC_1,
345         ICE_FLOW_ACT_GENERIC_2,
346         ICE_FLOW_ACT_GENERIC_3,
347         ICE_FLOW_ACT_GENERIC_4,
348         ICE_FLOW_ACT_RPT_FLOW_ID,
349         ICE_FLOW_ACT_BUILD_PROF_IDX,
350 };
351
352 struct ice_flow_action {
353         enum ice_flow_action_type type;
354         union {
355                 u32 dummy;
356         } data;
357 };
358
359 /* TDD esp in the linux code doesn't like prototypes, so
360  * ifdef them all out, so they stop conflicting with our mocks
361  */
362 u64
363 ice_flow_find_prof(struct ice_hw *hw, enum ice_block blk, enum ice_flow_dir dir,
364                    struct ice_flow_seg_info *segs, u8 segs_cnt);
365 enum ice_status
366 ice_flow_add_prof(struct ice_hw *hw, enum ice_block blk, enum ice_flow_dir dir,
367                   u64 prof_id, struct ice_flow_seg_info *segs, u8 segs_cnt,
368                   struct ice_flow_action *acts, u8 acts_cnt,
369                   struct ice_flow_prof **prof);
370 enum ice_status
371 ice_flow_rem_prof(struct ice_hw *hw, enum ice_block blk, u64 prof_id);
372 enum ice_status
373 ice_flow_assoc_vsig_vsi(struct ice_hw *hw, enum ice_block blk, u16 vsi_handle,
374                         u16 vsig);
375 enum ice_status
376 ice_flow_get_hw_prof(struct ice_hw *hw, enum ice_block blk, u64 prof_id,
377                      u8 *hw_prof);
378
379 u64 ice_flow_find_entry(struct ice_hw *hw, enum ice_block blk, u64 entry_id);
380 enum ice_status
381 ice_flow_add_entry(struct ice_hw *hw, enum ice_block blk, u64 prof_id,
382                    u64 entry_id, u16 vsi, enum ice_flow_priority prio,
383                    void *data, struct ice_flow_action *acts, u8 acts_cnt,
384                    u64 *entry_h);
385 enum ice_status ice_flow_rem_entry(struct ice_hw *hw, u64 entry_h);
386 void
387 ice_flow_set_fld(struct ice_flow_seg_info *seg, enum ice_flow_field fld,
388                  u16 val_loc, u16 mask_loc, u16 last_loc, bool range);
389 void
390 ice_flow_set_fld_prefix(struct ice_flow_seg_info *seg, enum ice_flow_field fld,
391                         u16 val_loc, u16 prefix_loc, u8 prefix_sz);
392 void
393 ice_flow_add_fld_raw(struct ice_flow_seg_info *seg, u16 off, u8 len,
394                      u16 val_loc, u16 mask_loc);
395 void ice_rem_vsi_rss_list(struct ice_hw *hw, u16 vsi_handle);
396 enum ice_status ice_replay_rss_cfg(struct ice_hw *hw, u16 vsi_handle);
397 enum ice_status
398 ice_add_avf_rss_cfg(struct ice_hw *hw, u16 vsi_handle, u64 hashed_flds);
399 enum ice_status ice_rem_vsi_rss_cfg(struct ice_hw *hw, u16 vsi_handle);
400 enum ice_status
401 ice_add_rss_cfg(struct ice_hw *hw, u16 vsi_handle, u64 hashed_flds,
402                 u32 addl_hdrs);
403 enum ice_status
404 ice_rem_rss_cfg(struct ice_hw *hw, u16 vsi_handle, u64 hashed_flds,
405                 u32 addl_hdrs);
406 u64 ice_get_rss_cfg(struct ice_hw *hw, u16 vsi_handle, u32 hdrs);
407 #endif /* _ICE_FLOW_H_ */