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