xref: /dpdk/drivers/net/ice/base/ice_flow.h (revision e253c33d)
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 
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 /* Protocol header fields within a packet segment. A segment consists of one or
153  * more protocol headers that make up a logical group of protocol headers. Each
154  * logical group of protocol headers encapsulates or is encapsulated using/by
155  * tunneling or encapsulation protocols for network virtualization such as GRE,
156  * VxLAN, etc.
157  */
158 enum ice_flow_seg_hdr {
159 	ICE_FLOW_SEG_HDR_NONE		= 0x00000000,
160 	ICE_FLOW_SEG_HDR_ETH		= 0x00000001,
161 	ICE_FLOW_SEG_HDR_VLAN		= 0x00000002,
162 	ICE_FLOW_SEG_HDR_IPV4		= 0x00000004,
163 	ICE_FLOW_SEG_HDR_IPV6		= 0x00000008,
164 	ICE_FLOW_SEG_HDR_ARP		= 0x00000010,
165 	ICE_FLOW_SEG_HDR_ICMP		= 0x00000020,
166 	ICE_FLOW_SEG_HDR_TCP		= 0x00000040,
167 	ICE_FLOW_SEG_HDR_UDP		= 0x00000080,
168 	ICE_FLOW_SEG_HDR_SCTP		= 0x00000100,
169 	ICE_FLOW_SEG_HDR_GRE		= 0x00000200,
170 	ICE_FLOW_SEG_HDR_GTPC		= 0x00000400,
171 	ICE_FLOW_SEG_HDR_GTPC_TEID	= 0x00000800,
172 	ICE_FLOW_SEG_HDR_GTPU_IP	= 0x00001000,
173 	ICE_FLOW_SEG_HDR_GTPU_EH	= 0x00002000,
174 	ICE_FLOW_SEG_HDR_GTPU_DWN	= 0x00004000,
175 	ICE_FLOW_SEG_HDR_GTPU_UP	= 0x00008000,
176 	ICE_FLOW_SEG_HDR_PPPOE		= 0x00010000,
177 	ICE_FLOW_SEG_HDR_PFCP_NODE	= 0x00020000,
178 	ICE_FLOW_SEG_HDR_PFCP_SESSION	= 0x00040000,
179 	ICE_FLOW_SEG_HDR_L2TPV3		= 0x00080000,
180 	ICE_FLOW_SEG_HDR_ESP		= 0x00100000,
181 	ICE_FLOW_SEG_HDR_AH		= 0x00200000,
182 	ICE_FLOW_SEG_HDR_NAT_T_ESP	= 0x00400000,
183 	ICE_FLOW_SEG_HDR_ETH_NON_IP	= 0x00800000,
184 	ICE_FLOW_SEG_HDR_GTPU_NON_IP	= 0x01000000,
185 	ICE_FLOW_SEG_HDR_VXLAN		= 0x02000000,
186 	ICE_FLOW_SEG_HDR_ECPRI_TP0	= 0x04000000,
187 	ICE_FLOW_SEG_HDR_UDP_ECPRI_TP0	= 0x08000000,
188 	/* The following is an additive bit for ICE_FLOW_SEG_HDR_IPV4 and
189 	 * ICE_FLOW_SEG_HDR_IPV6 which include the IPV4 other PTYPEs
190 	 */
191 	ICE_FLOW_SEG_HDR_IPV_OTHER	= 0x20000000,
192 };
193 
194 /* These segements all have the same PTYPES, but are otherwise distinguished by
195  * the value of the gtp_eh_pdu and gtp_eh_pdu_link flags:
196  *
197  *                                gtp_eh_pdu     gtp_eh_pdu_link
198  * ICE_FLOW_SEG_HDR_GTPU_IP           0              0
199  * ICE_FLOW_SEG_HDR_GTPU_EH           1              don't care
200  * ICE_FLOW_SEG_HDR_GTPU_DWN          1              0
201  * ICE_FLOW_SEG_HDR_GTPU_UP           1              1
202  */
203 #define ICE_FLOW_SEG_HDR_GTPU (ICE_FLOW_SEG_HDR_GTPU_IP | \
204 			       ICE_FLOW_SEG_HDR_GTPU_EH | \
205 			       ICE_FLOW_SEG_HDR_GTPU_DWN | \
206 			       ICE_FLOW_SEG_HDR_GTPU_UP)
207 #define ICE_FLOW_SEG_HDR_PFCP (ICE_FLOW_SEG_HDR_PFCP_NODE | \
208 			       ICE_FLOW_SEG_HDR_PFCP_SESSION)
209 
210 enum ice_flow_field {
211 	/* L2 */
212 	ICE_FLOW_FIELD_IDX_ETH_DA,
213 	ICE_FLOW_FIELD_IDX_ETH_SA,
214 	ICE_FLOW_FIELD_IDX_S_VLAN,
215 	ICE_FLOW_FIELD_IDX_C_VLAN,
216 	ICE_FLOW_FIELD_IDX_ETH_TYPE,
217 	/* L3 */
218 	ICE_FLOW_FIELD_IDX_IPV4_DSCP,
219 	ICE_FLOW_FIELD_IDX_IPV6_DSCP,
220 	ICE_FLOW_FIELD_IDX_IPV4_TTL,
221 	ICE_FLOW_FIELD_IDX_IPV4_PROT,
222 	ICE_FLOW_FIELD_IDX_IPV6_TTL,
223 	ICE_FLOW_FIELD_IDX_IPV6_PROT,
224 	ICE_FLOW_FIELD_IDX_IPV4_SA,
225 	ICE_FLOW_FIELD_IDX_IPV4_DA,
226 	ICE_FLOW_FIELD_IDX_IPV6_SA,
227 	ICE_FLOW_FIELD_IDX_IPV6_DA,
228 	ICE_FLOW_FIELD_IDX_IPV6_PRE32_SA,
229 	ICE_FLOW_FIELD_IDX_IPV6_PRE32_DA,
230 	ICE_FLOW_FIELD_IDX_IPV6_PRE48_SA,
231 	ICE_FLOW_FIELD_IDX_IPV6_PRE48_DA,
232 	ICE_FLOW_FIELD_IDX_IPV6_PRE64_SA,
233 	ICE_FLOW_FIELD_IDX_IPV6_PRE64_DA,
234 	/* L4 */
235 	ICE_FLOW_FIELD_IDX_TCP_SRC_PORT,
236 	ICE_FLOW_FIELD_IDX_TCP_DST_PORT,
237 	ICE_FLOW_FIELD_IDX_UDP_SRC_PORT,
238 	ICE_FLOW_FIELD_IDX_UDP_DST_PORT,
239 	ICE_FLOW_FIELD_IDX_SCTP_SRC_PORT,
240 	ICE_FLOW_FIELD_IDX_SCTP_DST_PORT,
241 	ICE_FLOW_FIELD_IDX_TCP_FLAGS,
242 	/* ARP */
243 	ICE_FLOW_FIELD_IDX_ARP_SIP,
244 	ICE_FLOW_FIELD_IDX_ARP_DIP,
245 	ICE_FLOW_FIELD_IDX_ARP_SHA,
246 	ICE_FLOW_FIELD_IDX_ARP_DHA,
247 	ICE_FLOW_FIELD_IDX_ARP_OP,
248 	/* ICMP */
249 	ICE_FLOW_FIELD_IDX_ICMP_TYPE,
250 	ICE_FLOW_FIELD_IDX_ICMP_CODE,
251 	/* GRE */
252 	ICE_FLOW_FIELD_IDX_GRE_KEYID,
253 	/* GTPC_TEID */
254 	ICE_FLOW_FIELD_IDX_GTPC_TEID,
255 	/* GTPU_IP */
256 	ICE_FLOW_FIELD_IDX_GTPU_IP_TEID,
257 	/* GTPU_EH */
258 	ICE_FLOW_FIELD_IDX_GTPU_EH_TEID,
259 	ICE_FLOW_FIELD_IDX_GTPU_EH_QFI,
260 	/* GTPU_UP */
261 	ICE_FLOW_FIELD_IDX_GTPU_UP_TEID,
262 	/* GTPU_DWN */
263 	ICE_FLOW_FIELD_IDX_GTPU_DWN_TEID,
264 	/* PPPOE */
265 	ICE_FLOW_FIELD_IDX_PPPOE_SESS_ID,
266 	/* PFCP */
267 	ICE_FLOW_FIELD_IDX_PFCP_SEID,
268 	/* L2TPV3 */
269 	ICE_FLOW_FIELD_IDX_L2TPV3_SESS_ID,
270 	/* ESP */
271 	ICE_FLOW_FIELD_IDX_ESP_SPI,
272 	/* AH */
273 	ICE_FLOW_FIELD_IDX_AH_SPI,
274 	/* NAT_T ESP */
275 	ICE_FLOW_FIELD_IDX_NAT_T_ESP_SPI,
276 	/* VXLAN VNI */
277 	ICE_FLOW_FIELD_IDX_VXLAN_VNI,
278 	/* ECPRI_TP0 */
279 	ICE_FLOW_FIELD_IDX_ECPRI_TP0_PC_ID,
280 	/* UDP_ECPRI_TP0 */
281 	ICE_FLOW_FIELD_IDX_UDP_ECPRI_TP0_PC_ID,
282 	 /* The total number of enums must not exceed 64 */
283 	ICE_FLOW_FIELD_IDX_MAX
284 };
285 
286 /* Flow headers and fields for AVF support */
287 enum ice_flow_avf_hdr_field {
288 	/* Values 0 - 28 are reserved for future use */
289 	ICE_AVF_FLOW_FIELD_INVALID		= 0,
290 	ICE_AVF_FLOW_FIELD_UNICAST_IPV4_UDP	= 29,
291 	ICE_AVF_FLOW_FIELD_MULTICAST_IPV4_UDP,
292 	ICE_AVF_FLOW_FIELD_IPV4_UDP,
293 	ICE_AVF_FLOW_FIELD_IPV4_TCP_SYN_NO_ACK,
294 	ICE_AVF_FLOW_FIELD_IPV4_TCP,
295 	ICE_AVF_FLOW_FIELD_IPV4_SCTP,
296 	ICE_AVF_FLOW_FIELD_IPV4_OTHER,
297 	ICE_AVF_FLOW_FIELD_FRAG_IPV4,
298 	/* Values 37-38 are reserved */
299 	ICE_AVF_FLOW_FIELD_UNICAST_IPV6_UDP	= 39,
300 	ICE_AVF_FLOW_FIELD_MULTICAST_IPV6_UDP,
301 	ICE_AVF_FLOW_FIELD_IPV6_UDP,
302 	ICE_AVF_FLOW_FIELD_IPV6_TCP_SYN_NO_ACK,
303 	ICE_AVF_FLOW_FIELD_IPV6_TCP,
304 	ICE_AVF_FLOW_FIELD_IPV6_SCTP,
305 	ICE_AVF_FLOW_FIELD_IPV6_OTHER,
306 	ICE_AVF_FLOW_FIELD_FRAG_IPV6,
307 	ICE_AVF_FLOW_FIELD_RSVD47,
308 	ICE_AVF_FLOW_FIELD_FCOE_OX,
309 	ICE_AVF_FLOW_FIELD_FCOE_RX,
310 	ICE_AVF_FLOW_FIELD_FCOE_OTHER,
311 	/* Values 51-62 are reserved */
312 	ICE_AVF_FLOW_FIELD_L2_PAYLOAD		= 63,
313 	ICE_AVF_FLOW_FIELD_MAX
314 };
315 
316 /* Supported RSS offloads  This macro is defined to support
317  * VIRTCHNL_OP_GET_RSS_HENA_CAPS ops. PF driver sends the RSS hardware
318  * capabilities to the caller of this ops.
319  */
320 #define ICE_DEFAULT_RSS_HENA ( \
321 	BIT_ULL(ICE_AVF_FLOW_FIELD_IPV4_UDP) | \
322 	BIT_ULL(ICE_AVF_FLOW_FIELD_IPV4_SCTP) | \
323 	BIT_ULL(ICE_AVF_FLOW_FIELD_IPV4_TCP) | \
324 	BIT_ULL(ICE_AVF_FLOW_FIELD_IPV4_OTHER) | \
325 	BIT_ULL(ICE_AVF_FLOW_FIELD_FRAG_IPV4) | \
326 	BIT_ULL(ICE_AVF_FLOW_FIELD_IPV6_UDP) | \
327 	BIT_ULL(ICE_AVF_FLOW_FIELD_IPV6_TCP) | \
328 	BIT_ULL(ICE_AVF_FLOW_FIELD_IPV6_SCTP) | \
329 	BIT_ULL(ICE_AVF_FLOW_FIELD_IPV6_OTHER) | \
330 	BIT_ULL(ICE_AVF_FLOW_FIELD_FRAG_IPV6) | \
331 	BIT_ULL(ICE_AVF_FLOW_FIELD_IPV4_TCP_SYN_NO_ACK) | \
332 	BIT_ULL(ICE_AVF_FLOW_FIELD_UNICAST_IPV4_UDP) | \
333 	BIT_ULL(ICE_AVF_FLOW_FIELD_MULTICAST_IPV4_UDP) | \
334 	BIT_ULL(ICE_AVF_FLOW_FIELD_IPV6_TCP_SYN_NO_ACK) | \
335 	BIT_ULL(ICE_AVF_FLOW_FIELD_UNICAST_IPV6_UDP) | \
336 	BIT_ULL(ICE_AVF_FLOW_FIELD_MULTICAST_IPV6_UDP))
337 
338 enum ice_rss_cfg_hdr_type {
339 	ICE_RSS_OUTER_HEADERS, /* take outer headers as inputset. */
340 	ICE_RSS_INNER_HEADERS, /* take inner headers as inputset. */
341 	/* take inner headers as inputset for packet with outer ipv4. */
342 	ICE_RSS_INNER_HEADERS_W_OUTER_IPV4,
343 	/* take inner headers as inputset for packet with outer ipv6. */
344 	ICE_RSS_INNER_HEADERS_W_OUTER_IPV6,
345 	/* take outer headers first then inner headers as inputset */
346 	ICE_RSS_ANY_HEADERS
347 };
348 
349 struct ice_rss_hash_cfg {
350 	u32 addl_hdrs; /* protocol header fields */
351 	u64 hash_flds; /* hash bit field (ICE_FLOW_HASH_*) to configure */
352 	enum ice_rss_cfg_hdr_type hdr_type; /* to specify inner or outer */
353 	bool symm; /* symmetric or asymmetric hash */
354 };
355 
356 enum ice_flow_dir {
357 	ICE_FLOW_DIR_UNDEFINED	= 0,
358 	ICE_FLOW_TX		= 0x01,
359 	ICE_FLOW_RX		= 0x02,
360 	ICE_FLOW_TX_RX		= ICE_FLOW_RX | ICE_FLOW_TX
361 };
362 
363 enum ice_flow_priority {
364 	ICE_FLOW_PRIO_LOW,
365 	ICE_FLOW_PRIO_NORMAL,
366 	ICE_FLOW_PRIO_HIGH
367 };
368 
369 #define ICE_FLOW_SEG_SINGLE		1
370 #define ICE_FLOW_SEG_MAX		2
371 #define ICE_FLOW_SEG_RAW_FLD_MAX	2
372 #define ICE_FLOW_PROFILE_MAX		1024
373 #define ICE_FLOW_SW_FIELD_VECTOR_MAX	48
374 #define ICE_FLOW_ACL_FIELD_VECTOR_MAX	32
375 #define ICE_FLOW_FV_EXTRACT_SZ		2
376 
377 #define ICE_FLOW_SET_HDRS(seg, val)	((seg)->hdrs |= (u32)(val))
378 
379 struct ice_flow_seg_xtrct {
380 	u8 prot_id;	/* Protocol ID of extracted header field */
381 	u16 off;	/* Starting offset of the field in header in bytes */
382 	u8 idx;		/* Index of FV entry used */
383 	u8 disp;	/* Displacement of field in bits fr. FV entry's start */
384 	u16 mask;	/* Mask for field */
385 };
386 
387 enum ice_flow_fld_match_type {
388 	ICE_FLOW_FLD_TYPE_REG,		/* Value, mask */
389 	ICE_FLOW_FLD_TYPE_RANGE,	/* Value, mask, last (upper bound) */
390 	ICE_FLOW_FLD_TYPE_PREFIX,	/* IP address, prefix, size of prefix */
391 	ICE_FLOW_FLD_TYPE_SIZE,		/* Value, mask, size of match */
392 };
393 
394 struct ice_flow_fld_loc {
395 	/* Describe offsets of field information relative to the beginning of
396 	 * input buffer provided when adding flow entries.
397 	 */
398 	u16 val;	/* Offset where the value is located */
399 	u16 mask;	/* Offset where the mask/prefix value is located */
400 	u16 last;	/* Length or offset where the upper value is located */
401 };
402 
403 struct ice_flow_fld_info {
404 	enum ice_flow_fld_match_type type;
405 	/* Location where to retrieve data from an input buffer */
406 	struct ice_flow_fld_loc src;
407 	/* Location where to put the data into the final entry buffer */
408 	struct ice_flow_fld_loc entry;
409 	struct ice_flow_seg_xtrct xtrct;
410 };
411 
412 struct ice_flow_seg_fld_raw {
413 	struct ice_flow_fld_info info;
414 	u16 off;	/* Offset from the start of the segment */
415 };
416 
417 struct ice_flow_seg_info {
418 	u32 hdrs;	/* Bitmask indicating protocol headers present */
419 	u64 match;	/* Bitmask indicating header fields to be matched */
420 	u64 range;	/* Bitmask indicating header fields matched as ranges */
421 
422 	struct ice_flow_fld_info fields[ICE_FLOW_FIELD_IDX_MAX];
423 
424 	u8 raws_cnt;	/* Number of raw fields to be matched */
425 	struct ice_flow_seg_fld_raw raws[ICE_FLOW_SEG_RAW_FLD_MAX];
426 };
427 
428 /* This structure describes a flow entry, and is tracked only in this file */
429 struct ice_flow_entry {
430 	struct LIST_ENTRY_TYPE l_entry;
431 
432 	u64 id;
433 	struct ice_flow_prof *prof;
434 	/* Action list */
435 	struct ice_flow_action *acts;
436 	/* Flow entry's content */
437 	void *entry;
438 	/* Range buffer (For ACL only) */
439 	struct ice_aqc_acl_profile_ranges *range_buf;
440 	enum ice_flow_priority priority;
441 	u16 vsi_handle;
442 	u16 entry_sz;
443 	/* Entry index in the ACL's scenario */
444 	u16 scen_entry_idx;
445 #define ICE_FLOW_ACL_MAX_NUM_ACT	2
446 	u8 acts_cnt;
447 };
448 
449 #define ICE_FLOW_ENTRY_HNDL(e)	((unsigned long)e)
450 #define ICE_FLOW_ENTRY_PTR(h)	((struct ice_flow_entry *)(h))
451 
452 struct ice_flow_prof {
453 	struct LIST_ENTRY_TYPE l_entry;
454 
455 	u64 id;
456 	enum ice_flow_dir dir;
457 	u8 segs_cnt;
458 	u8 acts_cnt;
459 
460 	/* Keep track of flow entries associated with this flow profile */
461 	struct ice_lock entries_lock;
462 	struct LIST_HEAD_TYPE entries;
463 
464 	struct ice_flow_seg_info segs[ICE_FLOW_SEG_MAX];
465 
466 	/* software VSI handles referenced by this flow profile */
467 	ice_declare_bitmap(vsis, ICE_MAX_VSI);
468 
469 	union {
470 		/* struct sw_recipe */
471 		struct ice_acl_scen *scen;
472 		/* struct fd */
473 		u32 data;
474 		bool symm; /* Symmetric Hash for RSS */
475 	} cfg;
476 
477 	/* Default actions */
478 	struct ice_flow_action *acts;
479 };
480 
481 struct ice_rss_cfg {
482 	struct LIST_ENTRY_TYPE l_entry;
483 	/* bitmap of VSIs added to the RSS entry */
484 	ice_declare_bitmap(vsis, ICE_MAX_VSI);
485 	struct ice_rss_hash_cfg hash;
486 };
487 
488 enum ice_flow_action_type {
489 	ICE_FLOW_ACT_NOP,
490 	ICE_FLOW_ACT_ALLOW,
491 	ICE_FLOW_ACT_DROP,
492 	ICE_FLOW_ACT_CNTR_PKT,
493 	ICE_FLOW_ACT_FWD_VSI,
494 	ICE_FLOW_ACT_FWD_VSI_LIST,	/* Should be abstracted away */
495 	ICE_FLOW_ACT_FWD_QUEUE,		/* Can Queues be abstracted away? */
496 	ICE_FLOW_ACT_FWD_QUEUE_GROUP,	/* Can Queues be abstracted away? */
497 	ICE_FLOW_ACT_PUSH,
498 	ICE_FLOW_ACT_POP,
499 	ICE_FLOW_ACT_MODIFY,
500 	ICE_FLOW_ACT_CNTR_BYTES,
501 	ICE_FLOW_ACT_CNTR_PKT_BYTES,
502 	ICE_FLOW_ACT_GENERIC_0,
503 	ICE_FLOW_ACT_GENERIC_1,
504 	ICE_FLOW_ACT_GENERIC_2,
505 	ICE_FLOW_ACT_GENERIC_3,
506 	ICE_FLOW_ACT_GENERIC_4,
507 	ICE_FLOW_ACT_RPT_FLOW_ID,
508 	ICE_FLOW_ACT_BUILD_PROF_IDX,
509 };
510 
511 struct ice_flow_action {
512 	enum ice_flow_action_type type;
513 	union {
514 		struct ice_acl_act_entry acl_act;
515 		u32 dummy;
516 	} data;
517 };
518 
519 u64
520 ice_flow_find_prof(struct ice_hw *hw, enum ice_block blk, enum ice_flow_dir dir,
521 		   struct ice_flow_seg_info *segs, u8 segs_cnt);
522 enum ice_status
523 ice_flow_add_prof(struct ice_hw *hw, enum ice_block blk, enum ice_flow_dir dir,
524 		  u64 prof_id, struct ice_flow_seg_info *segs, u8 segs_cnt,
525 		  struct ice_flow_action *acts, u8 acts_cnt,
526 		  struct ice_flow_prof **prof);
527 enum ice_status
528 ice_flow_rem_prof(struct ice_hw *hw, enum ice_block blk, u64 prof_id);
529 enum ice_status
530 ice_flow_assoc_prof(struct ice_hw *hw, enum ice_block blk,
531 		    struct ice_flow_prof *prof, u16 vsi_handle);
532 enum ice_status
533 ice_flow_assoc_vsig_vsi(struct ice_hw *hw, enum ice_block blk, u16 vsi_handle,
534 			u16 vsig);
535 enum ice_status
536 ice_flow_get_hw_prof(struct ice_hw *hw, enum ice_block blk, u64 prof_id,
537 		     u8 *hw_prof);
538 
539 u64 ice_flow_find_entry(struct ice_hw *hw, enum ice_block blk, u64 entry_id);
540 enum ice_status
541 ice_flow_add_entry(struct ice_hw *hw, enum ice_block blk, u64 prof_id,
542 		   u64 entry_id, u16 vsi, enum ice_flow_priority prio,
543 		   void *data, struct ice_flow_action *acts, u8 acts_cnt,
544 		   u64 *entry_h);
545 enum ice_status
546 ice_flow_rem_entry(struct ice_hw *hw, enum ice_block blk, u64 entry_h);
547 void
548 ice_flow_set_fld(struct ice_flow_seg_info *seg, enum ice_flow_field fld,
549 		 u16 val_loc, u16 mask_loc, u16 last_loc, bool range);
550 void
551 ice_flow_set_fld_prefix(struct ice_flow_seg_info *seg, enum ice_flow_field fld,
552 			u16 val_loc, u16 prefix_loc, u8 prefix_sz);
553 void
554 ice_flow_add_fld_raw(struct ice_flow_seg_info *seg, u16 off, u8 len,
555 		     u16 val_loc, u16 mask_loc);
556 void ice_rem_vsi_rss_list(struct ice_hw *hw, u16 vsi_handle);
557 enum ice_status ice_replay_rss_cfg(struct ice_hw *hw, u16 vsi_handle);
558 enum ice_status
559 ice_add_avf_rss_cfg(struct ice_hw *hw, u16 vsi_handle, u64 hashed_flds);
560 enum ice_status ice_rem_vsi_rss_cfg(struct ice_hw *hw, u16 vsi_handle);
561 enum ice_status
562 ice_add_rss_cfg(struct ice_hw *hw, u16 vsi_handle,
563 		const struct ice_rss_hash_cfg *cfg);
564 enum ice_status
565 ice_rem_rss_cfg(struct ice_hw *hw, u16 vsi_handle,
566 		const struct ice_rss_hash_cfg *cfg);
567 u64 ice_get_rss_cfg(struct ice_hw *hw, u16 vsi_handle, u32 hdrs);
568 #endif /* _ICE_FLOW_H_ */
569