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