xref: /freebsd/sys/dev/ice/ice_flow.c (revision 3cbb4cc200f8a0ad7ed08233425ea54524a21f1c)
1 /* SPDX-License-Identifier: BSD-3-Clause */
2 /*  Copyright (c) 2020, Intel Corporation
3  *  All rights reserved.
4  *
5  *  Redistribution and use in source and binary forms, with or without
6  *  modification, are permitted provided that the following conditions are met:
7  *
8  *   1. Redistributions of source code must retain the above copyright notice,
9  *      this list of conditions and the following disclaimer.
10  *
11  *   2. Redistributions in binary form must reproduce the above copyright
12  *      notice, this list of conditions and the following disclaimer in the
13  *      documentation and/or other materials provided with the distribution.
14  *
15  *   3. Neither the name of the Intel Corporation nor the names of its
16  *      contributors may be used to endorse or promote products derived from
17  *      this software without specific prior written permission.
18  *
19  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20  *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
23  *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  *  POSSIBILITY OF SUCH DAMAGE.
30  */
31 /*$FreeBSD$*/
32 
33 #include "ice_common.h"
34 #include "ice_flow.h"
35 
36 /* Size of known protocol header fields */
37 #define ICE_FLOW_FLD_SZ_ETH_TYPE	2
38 #define ICE_FLOW_FLD_SZ_VLAN		2
39 #define ICE_FLOW_FLD_SZ_IPV4_ADDR	4
40 #define ICE_FLOW_FLD_SZ_IPV6_ADDR	16
41 #define ICE_FLOW_FLD_SZ_IP_DSCP		1
42 #define ICE_FLOW_FLD_SZ_IP_TTL		1
43 #define ICE_FLOW_FLD_SZ_IP_PROT		1
44 #define ICE_FLOW_FLD_SZ_PORT		2
45 #define ICE_FLOW_FLD_SZ_TCP_FLAGS	1
46 #define ICE_FLOW_FLD_SZ_ICMP_TYPE	1
47 #define ICE_FLOW_FLD_SZ_ICMP_CODE	1
48 #define ICE_FLOW_FLD_SZ_ARP_OPER	2
49 #define ICE_FLOW_FLD_SZ_GRE_KEYID	4
50 
51 /* Describe properties of a protocol header field */
52 struct ice_flow_field_info {
53 	enum ice_flow_seg_hdr hdr;
54 	s16 off;	/* Offset from start of a protocol header, in bits */
55 	u16 size;	/* Size of fields in bits */
56 };
57 
58 #define ICE_FLOW_FLD_INFO(_hdr, _offset_bytes, _size_bytes) { \
59 	.hdr = _hdr, \
60 	.off = (_offset_bytes) * BITS_PER_BYTE, \
61 	.size = (_size_bytes) * BITS_PER_BYTE, \
62 }
63 
64 /* Table containing properties of supported protocol header fields */
65 static const
66 struct ice_flow_field_info ice_flds_info[ICE_FLOW_FIELD_IDX_MAX] = {
67 	/* Ether */
68 	/* ICE_FLOW_FIELD_IDX_ETH_DA */
69 	ICE_FLOW_FLD_INFO(ICE_FLOW_SEG_HDR_ETH, 0, ETH_ALEN),
70 	/* ICE_FLOW_FIELD_IDX_ETH_SA */
71 	ICE_FLOW_FLD_INFO(ICE_FLOW_SEG_HDR_ETH, ETH_ALEN, ETH_ALEN),
72 	/* ICE_FLOW_FIELD_IDX_S_VLAN */
73 	ICE_FLOW_FLD_INFO(ICE_FLOW_SEG_HDR_VLAN, 12, ICE_FLOW_FLD_SZ_VLAN),
74 	/* ICE_FLOW_FIELD_IDX_C_VLAN */
75 	ICE_FLOW_FLD_INFO(ICE_FLOW_SEG_HDR_VLAN, 14, ICE_FLOW_FLD_SZ_VLAN),
76 	/* ICE_FLOW_FIELD_IDX_ETH_TYPE */
77 	ICE_FLOW_FLD_INFO(ICE_FLOW_SEG_HDR_ETH, 0, ICE_FLOW_FLD_SZ_ETH_TYPE),
78 	/* IPv4 / IPv6 */
79 	/* ICE_FLOW_FIELD_IDX_IPV4_DSCP */
80 	ICE_FLOW_FLD_INFO(ICE_FLOW_SEG_HDR_IPV4, 1, ICE_FLOW_FLD_SZ_IP_DSCP),
81 	/* ICE_FLOW_FIELD_IDX_IPV6_DSCP */
82 	ICE_FLOW_FLD_INFO(ICE_FLOW_SEG_HDR_IPV6, 0, ICE_FLOW_FLD_SZ_IP_DSCP),
83 	/* ICE_FLOW_FIELD_IDX_IPV4_TTL */
84 	ICE_FLOW_FLD_INFO(ICE_FLOW_SEG_HDR_NONE, 8, ICE_FLOW_FLD_SZ_IP_TTL),
85 	/* ICE_FLOW_FIELD_IDX_IPV4_PROT */
86 	ICE_FLOW_FLD_INFO(ICE_FLOW_SEG_HDR_NONE, 9, ICE_FLOW_FLD_SZ_IP_PROT),
87 	/* ICE_FLOW_FIELD_IDX_IPV6_TTL */
88 	ICE_FLOW_FLD_INFO(ICE_FLOW_SEG_HDR_NONE, 7, ICE_FLOW_FLD_SZ_IP_TTL),
89 	/* ICE_FLOW_FIELD_IDX_IPV4_PROT */
90 	ICE_FLOW_FLD_INFO(ICE_FLOW_SEG_HDR_NONE, 6, ICE_FLOW_FLD_SZ_IP_PROT),
91 	/* ICE_FLOW_FIELD_IDX_IPV4_SA */
92 	ICE_FLOW_FLD_INFO(ICE_FLOW_SEG_HDR_IPV4, 12, ICE_FLOW_FLD_SZ_IPV4_ADDR),
93 	/* ICE_FLOW_FIELD_IDX_IPV4_DA */
94 	ICE_FLOW_FLD_INFO(ICE_FLOW_SEG_HDR_IPV4, 16, ICE_FLOW_FLD_SZ_IPV4_ADDR),
95 	/* ICE_FLOW_FIELD_IDX_IPV6_SA */
96 	ICE_FLOW_FLD_INFO(ICE_FLOW_SEG_HDR_IPV6, 8, ICE_FLOW_FLD_SZ_IPV6_ADDR),
97 	/* ICE_FLOW_FIELD_IDX_IPV6_DA */
98 	ICE_FLOW_FLD_INFO(ICE_FLOW_SEG_HDR_IPV6, 24, ICE_FLOW_FLD_SZ_IPV6_ADDR),
99 	/* Transport */
100 	/* ICE_FLOW_FIELD_IDX_TCP_SRC_PORT */
101 	ICE_FLOW_FLD_INFO(ICE_FLOW_SEG_HDR_TCP, 0, ICE_FLOW_FLD_SZ_PORT),
102 	/* ICE_FLOW_FIELD_IDX_TCP_DST_PORT */
103 	ICE_FLOW_FLD_INFO(ICE_FLOW_SEG_HDR_TCP, 2, ICE_FLOW_FLD_SZ_PORT),
104 	/* ICE_FLOW_FIELD_IDX_UDP_SRC_PORT */
105 	ICE_FLOW_FLD_INFO(ICE_FLOW_SEG_HDR_UDP, 0, ICE_FLOW_FLD_SZ_PORT),
106 	/* ICE_FLOW_FIELD_IDX_UDP_DST_PORT */
107 	ICE_FLOW_FLD_INFO(ICE_FLOW_SEG_HDR_UDP, 2, ICE_FLOW_FLD_SZ_PORT),
108 	/* ICE_FLOW_FIELD_IDX_SCTP_SRC_PORT */
109 	ICE_FLOW_FLD_INFO(ICE_FLOW_SEG_HDR_SCTP, 0, ICE_FLOW_FLD_SZ_PORT),
110 	/* ICE_FLOW_FIELD_IDX_SCTP_DST_PORT */
111 	ICE_FLOW_FLD_INFO(ICE_FLOW_SEG_HDR_SCTP, 2, ICE_FLOW_FLD_SZ_PORT),
112 	/* ICE_FLOW_FIELD_IDX_TCP_FLAGS */
113 	ICE_FLOW_FLD_INFO(ICE_FLOW_SEG_HDR_TCP, 13, ICE_FLOW_FLD_SZ_TCP_FLAGS),
114 	/* ARP */
115 	/* ICE_FLOW_FIELD_IDX_ARP_SIP */
116 	ICE_FLOW_FLD_INFO(ICE_FLOW_SEG_HDR_ARP, 14, ICE_FLOW_FLD_SZ_IPV4_ADDR),
117 	/* ICE_FLOW_FIELD_IDX_ARP_DIP */
118 	ICE_FLOW_FLD_INFO(ICE_FLOW_SEG_HDR_ARP, 24, ICE_FLOW_FLD_SZ_IPV4_ADDR),
119 	/* ICE_FLOW_FIELD_IDX_ARP_SHA */
120 	ICE_FLOW_FLD_INFO(ICE_FLOW_SEG_HDR_ARP, 8, ETH_ALEN),
121 	/* ICE_FLOW_FIELD_IDX_ARP_DHA */
122 	ICE_FLOW_FLD_INFO(ICE_FLOW_SEG_HDR_ARP, 18, ETH_ALEN),
123 	/* ICE_FLOW_FIELD_IDX_ARP_OP */
124 	ICE_FLOW_FLD_INFO(ICE_FLOW_SEG_HDR_ARP, 6, ICE_FLOW_FLD_SZ_ARP_OPER),
125 	/* ICMP */
126 	/* ICE_FLOW_FIELD_IDX_ICMP_TYPE */
127 	ICE_FLOW_FLD_INFO(ICE_FLOW_SEG_HDR_ICMP, 0, ICE_FLOW_FLD_SZ_ICMP_TYPE),
128 	/* ICE_FLOW_FIELD_IDX_ICMP_CODE */
129 	ICE_FLOW_FLD_INFO(ICE_FLOW_SEG_HDR_ICMP, 1, ICE_FLOW_FLD_SZ_ICMP_CODE),
130 	/* GRE */
131 	/* ICE_FLOW_FIELD_IDX_GRE_KEYID */
132 	ICE_FLOW_FLD_INFO(ICE_FLOW_SEG_HDR_GRE, 12, ICE_FLOW_FLD_SZ_GRE_KEYID),
133 };
134 
135 /* Bitmaps indicating relevant packet types for a particular protocol header
136  *
137  * Packet types for packets with an Outer/First/Single MAC header
138  */
139 static const u32 ice_ptypes_mac_ofos[] = {
140 	0xFDC00846, 0xBFBF7F7E, 0xF70001DF, 0xFEFDFDFB,
141 	0x0000077E, 0x00000000, 0x00000000, 0x00000000,
142 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
143 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
144 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
145 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
146 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
147 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
148 };
149 
150 /* Packet types for packets with an Innermost/Last MAC VLAN header */
151 static const u32 ice_ptypes_macvlan_il[] = {
152 	0x00000000, 0xBC000000, 0x000001DF, 0xF0000000,
153 	0x0000077E, 0x00000000, 0x00000000, 0x00000000,
154 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
155 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
156 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
157 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
158 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
159 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
160 };
161 
162 /* Packet types for packets with an Outer/First/Single IPv4 header, does NOT
163  * include IPV4 other PTYPEs
164  */
165 static const u32 ice_ptypes_ipv4_ofos[] = {
166 	0x1DC00000, 0x04000800, 0x00000000, 0x00000000,
167 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
168 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
169 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
170 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
171 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
172 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
173 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
174 };
175 
176 /* Packet types for packets with an Outer/First/Single IPv4 header, includes
177  * IPV4 other PTYPEs
178  */
179 static const u32 ice_ptypes_ipv4_ofos_all[] = {
180 	0x1DC00000, 0x04000800, 0x00000000, 0x00000000,
181 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
182 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
183 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
184 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
185 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
186 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
187 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
188 };
189 
190 /* Packet types for packets with an Innermost/Last IPv4 header */
191 static const u32 ice_ptypes_ipv4_il[] = {
192 	0xE0000000, 0xB807700E, 0x80000003, 0xE01DC03B,
193 	0x0000000E, 0x00000000, 0x00000000, 0x00000000,
194 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
195 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
196 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
197 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
198 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
199 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
200 };
201 
202 /* Packet types for packets with an Outer/First/Single IPv6 header, does NOT
203  * include IVP6 other PTYPEs
204  */
205 static const u32 ice_ptypes_ipv6_ofos[] = {
206 	0x00000000, 0x00000000, 0x77000000, 0x10002000,
207 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
208 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
209 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
210 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
211 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
212 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
213 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
214 };
215 
216 /* Packet types for packets with an Outer/First/Single IPv6 header, includes
217  * IPV6 other PTYPEs
218  */
219 static const u32 ice_ptypes_ipv6_ofos_all[] = {
220 	0x00000000, 0x00000000, 0x77000000, 0x10002000,
221 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
222 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
223 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
224 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
225 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
226 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
227 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
228 };
229 
230 /* Packet types for packets with an Innermost/Last IPv6 header */
231 static const u32 ice_ptypes_ipv6_il[] = {
232 	0x00000000, 0x03B80770, 0x000001DC, 0x0EE00000,
233 	0x00000770, 0x00000000, 0x00000000, 0x00000000,
234 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
235 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
236 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
237 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
238 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
239 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
240 };
241 
242 /* Packet types for packets with an Outer/First/Single IPv4 header - no L4 */
243 static const u32 ice_ipv4_ofos_no_l4[] = {
244 	0x10C00000, 0x04000800, 0x00000000, 0x00000000,
245 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
246 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
247 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
248 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
249 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
250 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
251 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
252 };
253 
254 /* Packet types for packets with an Innermost/Last IPv4 header - no L4 */
255 static const u32 ice_ipv4_il_no_l4[] = {
256 	0x60000000, 0x18043008, 0x80000002, 0x6010c021,
257 	0x00000008, 0x00000000, 0x00000000, 0x00000000,
258 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
259 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
260 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
261 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
262 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
263 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
264 };
265 
266 /* Packet types for packets with an Outer/First/Single IPv6 header - no L4 */
267 static const u32 ice_ipv6_ofos_no_l4[] = {
268 	0x00000000, 0x00000000, 0x43000000, 0x10002000,
269 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
270 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
271 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
272 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
273 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
274 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
275 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
276 };
277 
278 /* Packet types for packets with an Innermost/Last IPv6 header - no L4 */
279 static const u32 ice_ipv6_il_no_l4[] = {
280 	0x00000000, 0x02180430, 0x0000010c, 0x086010c0,
281 	0x00000430, 0x00000000, 0x00000000, 0x00000000,
282 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
283 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
284 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
285 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
286 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
287 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
288 };
289 
290 /* Packet types for packets with an Outermost/First ARP header */
291 static const u32 ice_ptypes_arp_of[] = {
292 	0x00000800, 0x00000000, 0x00000000, 0x00000000,
293 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
294 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
295 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
296 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
297 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
298 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
299 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
300 };
301 
302 /* UDP Packet types for non-tunneled packets or tunneled
303  * packets with inner UDP.
304  */
305 static const u32 ice_ptypes_udp_il[] = {
306 	0x81000000, 0x20204040, 0x04000010, 0x80810102,
307 	0x00000040, 0x00000000, 0x00000000, 0x00000000,
308 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
309 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
310 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
311 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
312 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
313 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
314 };
315 
316 /* Packet types for packets with an Innermost/Last TCP header */
317 static const u32 ice_ptypes_tcp_il[] = {
318 	0x04000000, 0x80810102, 0x10000040, 0x02040408,
319 	0x00000102, 0x00000000, 0x00000000, 0x00000000,
320 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
321 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
322 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
323 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
324 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
325 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
326 };
327 
328 /* Packet types for packets with an Innermost/Last SCTP header */
329 static const u32 ice_ptypes_sctp_il[] = {
330 	0x08000000, 0x01020204, 0x20000081, 0x04080810,
331 	0x00000204, 0x00000000, 0x00000000, 0x00000000,
332 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
333 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
334 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
335 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
336 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
337 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
338 };
339 
340 /* Packet types for packets with an Outermost/First ICMP header */
341 static const u32 ice_ptypes_icmp_of[] = {
342 	0x10000000, 0x00000000, 0x00000000, 0x00000000,
343 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
344 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
345 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
346 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
347 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
348 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
349 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
350 };
351 
352 /* Packet types for packets with an Innermost/Last ICMP header */
353 static const u32 ice_ptypes_icmp_il[] = {
354 	0x00000000, 0x02040408, 0x40000102, 0x08101020,
355 	0x00000408, 0x00000000, 0x00000000, 0x00000000,
356 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
357 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
358 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
359 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
360 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
361 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
362 };
363 
364 /* Packet types for packets with an Outermost/First GRE header */
365 static const u32 ice_ptypes_gre_of[] = {
366 	0x00000000, 0xBFBF7800, 0x000001DF, 0xFEFDE000,
367 	0x0000017E, 0x00000000, 0x00000000, 0x00000000,
368 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
369 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
370 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
371 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
372 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
373 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
374 };
375 
376 /* Packet types for packets with an Innermost/Last MAC header */
377 static const u32 ice_ptypes_mac_il[] = {
378 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
379 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
380 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
381 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
382 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
383 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
384 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
385 	0x00000000, 0x00000000, 0x00000000, 0x00000000,
386 };
387 
388 /* Manage parameters and info. used during the creation of a flow profile */
389 struct ice_flow_prof_params {
390 	enum ice_block blk;
391 	u16 entry_length; /* # of bytes formatted entry will require */
392 	u8 es_cnt;
393 	struct ice_flow_prof *prof;
394 
395 	/* For ACL, the es[0] will have the data of ICE_RX_MDID_PKT_FLAGS_15_0
396 	 * This will give us the direction flags.
397 	 */
398 	struct ice_fv_word es[ICE_MAX_FV_WORDS];
399 	ice_declare_bitmap(ptypes, ICE_FLOW_PTYPE_MAX);
400 };
401 
402 #define ICE_FLOW_SEG_HDRS_L3_MASK	\
403 	(ICE_FLOW_SEG_HDR_IPV4 | ICE_FLOW_SEG_HDR_IPV6 | \
404 	 ICE_FLOW_SEG_HDR_ARP)
405 #define ICE_FLOW_SEG_HDRS_L4_MASK	\
406 	(ICE_FLOW_SEG_HDR_ICMP | ICE_FLOW_SEG_HDR_TCP | ICE_FLOW_SEG_HDR_UDP | \
407 	 ICE_FLOW_SEG_HDR_SCTP)
408 /* mask for L4 protocols that are NOT part of IPV4/6 OTHER PTYPE groups */
409 #define ICE_FLOW_SEG_HDRS_L4_MASK_NO_OTHER	\
410 	(ICE_FLOW_SEG_HDR_TCP | ICE_FLOW_SEG_HDR_UDP | ICE_FLOW_SEG_HDR_SCTP)
411 
412 /**
413  * ice_flow_val_hdrs - validates packet segments for valid protocol headers
414  * @segs: array of one or more packet segments that describe the flow
415  * @segs_cnt: number of packet segments provided
416  */
417 static enum ice_status
418 ice_flow_val_hdrs(struct ice_flow_seg_info *segs, u8 segs_cnt)
419 {
420 	u8 i;
421 
422 	for (i = 0; i < segs_cnt; i++) {
423 		/* Multiple L3 headers */
424 		if (segs[i].hdrs & ICE_FLOW_SEG_HDRS_L3_MASK &&
425 		    !ice_is_pow2(segs[i].hdrs & ICE_FLOW_SEG_HDRS_L3_MASK))
426 			return ICE_ERR_PARAM;
427 
428 		/* Multiple L4 headers */
429 		if (segs[i].hdrs & ICE_FLOW_SEG_HDRS_L4_MASK &&
430 		    !ice_is_pow2(segs[i].hdrs & ICE_FLOW_SEG_HDRS_L4_MASK))
431 			return ICE_ERR_PARAM;
432 	}
433 
434 	return ICE_SUCCESS;
435 }
436 
437 /**
438  * ice_flow_proc_seg_hdrs - process protocol headers present in pkt segments
439  * @params: information about the flow to be processed
440  *
441  * This function identifies the packet types associated with the protocol
442  * headers being present in packet segments of the specified flow profile.
443  */
444 static enum ice_status
445 ice_flow_proc_seg_hdrs(struct ice_flow_prof_params *params)
446 {
447 	struct ice_flow_prof *prof;
448 	u8 i;
449 
450 	ice_memset(params->ptypes, 0xff, sizeof(params->ptypes),
451 		   ICE_NONDMA_MEM);
452 
453 	prof = params->prof;
454 
455 	for (i = 0; i < params->prof->segs_cnt; i++) {
456 		const ice_bitmap_t *src;
457 		u32 hdrs;
458 
459 		hdrs = prof->segs[i].hdrs;
460 
461 		if (hdrs & ICE_FLOW_SEG_HDR_ETH) {
462 			src = !i ? (const ice_bitmap_t *)ice_ptypes_mac_ofos :
463 				(const ice_bitmap_t *)ice_ptypes_mac_il;
464 			ice_and_bitmap(params->ptypes, params->ptypes, src,
465 				       ICE_FLOW_PTYPE_MAX);
466 		}
467 
468 		if (i && hdrs & ICE_FLOW_SEG_HDR_VLAN) {
469 			src = (const ice_bitmap_t *)ice_ptypes_macvlan_il;
470 			ice_and_bitmap(params->ptypes, params->ptypes, src,
471 				       ICE_FLOW_PTYPE_MAX);
472 		}
473 
474 		if (!i && hdrs & ICE_FLOW_SEG_HDR_ARP) {
475 			ice_and_bitmap(params->ptypes, params->ptypes,
476 				       (const ice_bitmap_t *)ice_ptypes_arp_of,
477 				       ICE_FLOW_PTYPE_MAX);
478 		}
479 
480 		if ((hdrs & ICE_FLOW_SEG_HDR_IPV4) &&
481 		    (hdrs & ICE_FLOW_SEG_HDR_IPV_OTHER)) {
482 			src = i ?
483 				(const ice_bitmap_t *)ice_ptypes_ipv4_il :
484 				(const ice_bitmap_t *)ice_ptypes_ipv4_ofos_all;
485 			ice_and_bitmap(params->ptypes, params->ptypes, src,
486 				       ICE_FLOW_PTYPE_MAX);
487 		} else if ((hdrs & ICE_FLOW_SEG_HDR_IPV6) &&
488 			   (hdrs & ICE_FLOW_SEG_HDR_IPV_OTHER)) {
489 			src = i ?
490 				(const ice_bitmap_t *)ice_ptypes_ipv6_il :
491 				(const ice_bitmap_t *)ice_ptypes_ipv6_ofos_all;
492 			ice_and_bitmap(params->ptypes, params->ptypes, src,
493 				       ICE_FLOW_PTYPE_MAX);
494 		} else if ((hdrs & ICE_FLOW_SEG_HDR_IPV4) &&
495 			   !(hdrs & ICE_FLOW_SEG_HDRS_L4_MASK_NO_OTHER)) {
496 			src = !i ? (const ice_bitmap_t *)ice_ipv4_ofos_no_l4 :
497 				(const ice_bitmap_t *)ice_ipv4_il_no_l4;
498 			ice_and_bitmap(params->ptypes, params->ptypes, src,
499 				       ICE_FLOW_PTYPE_MAX);
500 		} else if (hdrs & ICE_FLOW_SEG_HDR_IPV4) {
501 			src = !i ? (const ice_bitmap_t *)ice_ptypes_ipv4_ofos :
502 				(const ice_bitmap_t *)ice_ptypes_ipv4_il;
503 			ice_and_bitmap(params->ptypes, params->ptypes, src,
504 				       ICE_FLOW_PTYPE_MAX);
505 		} else if ((hdrs & ICE_FLOW_SEG_HDR_IPV6) &&
506 			   !(hdrs & ICE_FLOW_SEG_HDRS_L4_MASK_NO_OTHER)) {
507 			src = !i ? (const ice_bitmap_t *)ice_ipv6_ofos_no_l4 :
508 				(const ice_bitmap_t *)ice_ipv6_il_no_l4;
509 			ice_and_bitmap(params->ptypes, params->ptypes, src,
510 				       ICE_FLOW_PTYPE_MAX);
511 		} else if (hdrs & ICE_FLOW_SEG_HDR_IPV6) {
512 			src = !i ? (const ice_bitmap_t *)ice_ptypes_ipv6_ofos :
513 				(const ice_bitmap_t *)ice_ptypes_ipv6_il;
514 			ice_and_bitmap(params->ptypes, params->ptypes, src,
515 				       ICE_FLOW_PTYPE_MAX);
516 		}
517 
518 		if (hdrs & ICE_FLOW_SEG_HDR_UDP) {
519 			src = (const ice_bitmap_t *)ice_ptypes_udp_il;
520 			ice_and_bitmap(params->ptypes, params->ptypes, src,
521 				       ICE_FLOW_PTYPE_MAX);
522 		} else if (hdrs & ICE_FLOW_SEG_HDR_TCP) {
523 			ice_and_bitmap(params->ptypes, params->ptypes,
524 				       (const ice_bitmap_t *)ice_ptypes_tcp_il,
525 				       ICE_FLOW_PTYPE_MAX);
526 		} else if (hdrs & ICE_FLOW_SEG_HDR_SCTP) {
527 			src = (const ice_bitmap_t *)ice_ptypes_sctp_il;
528 			ice_and_bitmap(params->ptypes, params->ptypes, src,
529 				       ICE_FLOW_PTYPE_MAX);
530 		}
531 
532 		if (hdrs & ICE_FLOW_SEG_HDR_ICMP) {
533 			src = !i ? (const ice_bitmap_t *)ice_ptypes_icmp_of :
534 				(const ice_bitmap_t *)ice_ptypes_icmp_il;
535 			ice_and_bitmap(params->ptypes, params->ptypes, src,
536 				       ICE_FLOW_PTYPE_MAX);
537 		} else if (hdrs & ICE_FLOW_SEG_HDR_GRE) {
538 			if (!i) {
539 				src = (const ice_bitmap_t *)ice_ptypes_gre_of;
540 				ice_and_bitmap(params->ptypes, params->ptypes,
541 					       src, ICE_FLOW_PTYPE_MAX);
542 			}
543 		}
544 	}
545 
546 	return ICE_SUCCESS;
547 }
548 
549 /**
550  * ice_flow_xtract_fld - Create an extraction sequence entry for the given field
551  * @hw: pointer to the HW struct
552  * @params: information about the flow to be processed
553  * @seg: packet segment index of the field to be extracted
554  * @fld: ID of field to be extracted
555  *
556  * This function determines the protocol ID, offset, and size of the given
557  * field. It then allocates one or more extraction sequence entries for the
558  * given field, and fill the entries with protocol ID and offset information.
559  */
560 static enum ice_status
561 ice_flow_xtract_fld(struct ice_hw *hw, struct ice_flow_prof_params *params,
562 		    u8 seg, enum ice_flow_field fld)
563 {
564 	enum ice_flow_field sib = ICE_FLOW_FIELD_IDX_MAX;
565 	enum ice_prot_id prot_id = ICE_PROT_ID_INVAL;
566 	u8 fv_words = hw->blk[params->blk].es.fvw;
567 	struct ice_flow_fld_info *flds;
568 	u16 cnt, ese_bits, i;
569 	u16 off;
570 
571 	flds = params->prof->segs[seg].fields;
572 
573 	switch (fld) {
574 	case ICE_FLOW_FIELD_IDX_ETH_DA:
575 	case ICE_FLOW_FIELD_IDX_ETH_SA:
576 	case ICE_FLOW_FIELD_IDX_S_VLAN:
577 	case ICE_FLOW_FIELD_IDX_C_VLAN:
578 		prot_id = seg == 0 ? ICE_PROT_MAC_OF_OR_S : ICE_PROT_MAC_IL;
579 		break;
580 	case ICE_FLOW_FIELD_IDX_ETH_TYPE:
581 		prot_id = seg == 0 ? ICE_PROT_ETYPE_OL : ICE_PROT_ETYPE_IL;
582 		break;
583 	case ICE_FLOW_FIELD_IDX_IPV4_DSCP:
584 		prot_id = seg == 0 ? ICE_PROT_IPV4_OF_OR_S : ICE_PROT_IPV4_IL;
585 		break;
586 	case ICE_FLOW_FIELD_IDX_IPV6_DSCP:
587 		prot_id = seg == 0 ? ICE_PROT_IPV6_OF_OR_S : ICE_PROT_IPV6_IL;
588 		break;
589 	case ICE_FLOW_FIELD_IDX_IPV4_TTL:
590 	case ICE_FLOW_FIELD_IDX_IPV4_PROT:
591 		prot_id = seg == 0 ? ICE_PROT_IPV4_OF_OR_S : ICE_PROT_IPV4_IL;
592 
593 		/* TTL and PROT share the same extraction seq. entry.
594 		 * Each is considered a sibling to the other in terms of sharing
595 		 * the same extraction sequence entry.
596 		 */
597 		if (fld == ICE_FLOW_FIELD_IDX_IPV4_TTL)
598 			sib = ICE_FLOW_FIELD_IDX_IPV4_PROT;
599 		else if (fld == ICE_FLOW_FIELD_IDX_IPV4_PROT)
600 			sib = ICE_FLOW_FIELD_IDX_IPV4_TTL;
601 		break;
602 	case ICE_FLOW_FIELD_IDX_IPV6_TTL:
603 	case ICE_FLOW_FIELD_IDX_IPV6_PROT:
604 		prot_id = seg == 0 ? ICE_PROT_IPV6_OF_OR_S : ICE_PROT_IPV6_IL;
605 
606 		/* TTL and PROT share the same extraction seq. entry.
607 		 * Each is considered a sibling to the other in terms of sharing
608 		 * the same extraction sequence entry.
609 		 */
610 		if (fld == ICE_FLOW_FIELD_IDX_IPV6_TTL)
611 			sib = ICE_FLOW_FIELD_IDX_IPV6_PROT;
612 		else if (fld == ICE_FLOW_FIELD_IDX_IPV6_PROT)
613 			sib = ICE_FLOW_FIELD_IDX_IPV6_TTL;
614 		break;
615 	case ICE_FLOW_FIELD_IDX_IPV4_SA:
616 	case ICE_FLOW_FIELD_IDX_IPV4_DA:
617 		prot_id = seg == 0 ? ICE_PROT_IPV4_OF_OR_S : ICE_PROT_IPV4_IL;
618 		break;
619 	case ICE_FLOW_FIELD_IDX_IPV6_SA:
620 	case ICE_FLOW_FIELD_IDX_IPV6_DA:
621 		prot_id = seg == 0 ? ICE_PROT_IPV6_OF_OR_S : ICE_PROT_IPV6_IL;
622 		break;
623 	case ICE_FLOW_FIELD_IDX_TCP_SRC_PORT:
624 	case ICE_FLOW_FIELD_IDX_TCP_DST_PORT:
625 	case ICE_FLOW_FIELD_IDX_TCP_FLAGS:
626 		prot_id = ICE_PROT_TCP_IL;
627 		break;
628 	case ICE_FLOW_FIELD_IDX_UDP_SRC_PORT:
629 	case ICE_FLOW_FIELD_IDX_UDP_DST_PORT:
630 		prot_id = ICE_PROT_UDP_IL_OR_S;
631 		break;
632 	case ICE_FLOW_FIELD_IDX_SCTP_SRC_PORT:
633 	case ICE_FLOW_FIELD_IDX_SCTP_DST_PORT:
634 		prot_id = ICE_PROT_SCTP_IL;
635 		break;
636 	case ICE_FLOW_FIELD_IDX_ARP_SIP:
637 	case ICE_FLOW_FIELD_IDX_ARP_DIP:
638 	case ICE_FLOW_FIELD_IDX_ARP_SHA:
639 	case ICE_FLOW_FIELD_IDX_ARP_DHA:
640 	case ICE_FLOW_FIELD_IDX_ARP_OP:
641 		prot_id = ICE_PROT_ARP_OF;
642 		break;
643 	case ICE_FLOW_FIELD_IDX_ICMP_TYPE:
644 	case ICE_FLOW_FIELD_IDX_ICMP_CODE:
645 		/* ICMP type and code share the same extraction seq. entry */
646 		prot_id = (params->prof->segs[seg].hdrs &
647 			   ICE_FLOW_SEG_HDR_IPV4) ?
648 			ICE_PROT_ICMP_IL : ICE_PROT_ICMPV6_IL;
649 		sib = fld == ICE_FLOW_FIELD_IDX_ICMP_TYPE ?
650 			ICE_FLOW_FIELD_IDX_ICMP_CODE :
651 			ICE_FLOW_FIELD_IDX_ICMP_TYPE;
652 		break;
653 	case ICE_FLOW_FIELD_IDX_GRE_KEYID:
654 		prot_id = ICE_PROT_GRE_OF;
655 		break;
656 	default:
657 		return ICE_ERR_NOT_IMPL;
658 	}
659 
660 	/* Each extraction sequence entry is a word in size, and extracts a
661 	 * word-aligned offset from a protocol header.
662 	 */
663 	ese_bits = ICE_FLOW_FV_EXTRACT_SZ * BITS_PER_BYTE;
664 
665 	flds[fld].xtrct.prot_id = prot_id;
666 	flds[fld].xtrct.off = (ice_flds_info[fld].off / ese_bits) *
667 		ICE_FLOW_FV_EXTRACT_SZ;
668 	flds[fld].xtrct.disp = (u8)(ice_flds_info[fld].off % ese_bits);
669 	flds[fld].xtrct.idx = params->es_cnt;
670 
671 	/* Adjust the next field-entry index after accommodating the number of
672 	 * entries this field consumes
673 	 */
674 	cnt = DIVIDE_AND_ROUND_UP(flds[fld].xtrct.disp +
675 				  ice_flds_info[fld].size, ese_bits);
676 
677 	/* Fill in the extraction sequence entries needed for this field */
678 	off = flds[fld].xtrct.off;
679 	for (i = 0; i < cnt; i++) {
680 		/* Only consume an extraction sequence entry if there is no
681 		 * sibling field associated with this field or the sibling entry
682 		 * already extracts the word shared with this field.
683 		 */
684 		if (sib == ICE_FLOW_FIELD_IDX_MAX ||
685 		    flds[sib].xtrct.prot_id == ICE_PROT_ID_INVAL ||
686 		    flds[sib].xtrct.off != off) {
687 			u8 idx;
688 
689 			/* Make sure the number of extraction sequence required
690 			 * does not exceed the block's capability
691 			 */
692 			if (params->es_cnt >= fv_words)
693 				return ICE_ERR_MAX_LIMIT;
694 
695 			/* some blocks require a reversed field vector layout */
696 			if (hw->blk[params->blk].es.reverse)
697 				idx = fv_words - params->es_cnt - 1;
698 			else
699 				idx = params->es_cnt;
700 
701 			params->es[idx].prot_id = prot_id;
702 			params->es[idx].off = off;
703 			params->es_cnt++;
704 		}
705 
706 		off += ICE_FLOW_FV_EXTRACT_SZ;
707 	}
708 
709 	return ICE_SUCCESS;
710 }
711 
712 /**
713  * ice_flow_create_xtrct_seq - Create an extraction sequence for given segments
714  * @hw: pointer to the HW struct
715  * @params: information about the flow to be processed
716  *
717  * This function iterates through all matched fields in the given segments, and
718  * creates an extraction sequence for the fields.
719  */
720 static enum ice_status
721 ice_flow_create_xtrct_seq(struct ice_hw *hw,
722 			  struct ice_flow_prof_params *params)
723 {
724 	enum ice_status status = ICE_SUCCESS;
725 	u8 i;
726 
727 	for (i = 0; i < params->prof->segs_cnt; i++) {
728 		u64 match = params->prof->segs[i].match;
729 		enum ice_flow_field j;
730 
731 		ice_for_each_set_bit(j, (ice_bitmap_t *)&match,
732 				     ICE_FLOW_FIELD_IDX_MAX) {
733 			status = ice_flow_xtract_fld(hw, params, i, j);
734 			if (status)
735 				return status;
736 			ice_clear_bit(j, (ice_bitmap_t *)&match);
737 		}
738 	}
739 
740 	return status;
741 }
742 
743 /**
744  * ice_flow_proc_segs - process all packet segments associated with a profile
745  * @hw: pointer to the HW struct
746  * @params: information about the flow to be processed
747  */
748 static enum ice_status
749 ice_flow_proc_segs(struct ice_hw *hw, struct ice_flow_prof_params *params)
750 {
751 	enum ice_status status;
752 
753 	status = ice_flow_proc_seg_hdrs(params);
754 	if (status)
755 		return status;
756 
757 	status = ice_flow_create_xtrct_seq(hw, params);
758 	if (status)
759 		return status;
760 
761 	switch (params->blk) {
762 	case ICE_BLK_RSS:
763 		status = ICE_SUCCESS;
764 		break;
765 	default:
766 		return ICE_ERR_NOT_IMPL;
767 	}
768 
769 	return status;
770 }
771 
772 #define ICE_FLOW_FIND_PROF_CHK_FLDS	0x00000001
773 #define ICE_FLOW_FIND_PROF_CHK_VSI	0x00000002
774 #define ICE_FLOW_FIND_PROF_NOT_CHK_DIR	0x00000004
775 
776 /**
777  * ice_flow_find_prof_conds - Find a profile matching headers and conditions
778  * @hw: pointer to the HW struct
779  * @blk: classification stage
780  * @dir: flow direction
781  * @segs: array of one or more packet segments that describe the flow
782  * @segs_cnt: number of packet segments provided
783  * @vsi_handle: software VSI handle to check VSI (ICE_FLOW_FIND_PROF_CHK_VSI)
784  * @conds: additional conditions to be checked (ICE_FLOW_FIND_PROF_CHK_*)
785  */
786 static struct ice_flow_prof *
787 ice_flow_find_prof_conds(struct ice_hw *hw, enum ice_block blk,
788 			 enum ice_flow_dir dir, struct ice_flow_seg_info *segs,
789 			 u8 segs_cnt, u16 vsi_handle, u32 conds)
790 {
791 	struct ice_flow_prof *p, *prof = NULL;
792 
793 	ice_acquire_lock(&hw->fl_profs_locks[blk]);
794 	LIST_FOR_EACH_ENTRY(p, &hw->fl_profs[blk], ice_flow_prof, l_entry)
795 		if ((p->dir == dir || conds & ICE_FLOW_FIND_PROF_NOT_CHK_DIR) &&
796 		    segs_cnt && segs_cnt == p->segs_cnt) {
797 			u8 i;
798 
799 			/* Check for profile-VSI association if specified */
800 			if ((conds & ICE_FLOW_FIND_PROF_CHK_VSI) &&
801 			    ice_is_vsi_valid(hw, vsi_handle) &&
802 			    !ice_is_bit_set(p->vsis, vsi_handle))
803 				continue;
804 
805 			/* Protocol headers must be checked. Matched fields are
806 			 * checked if specified.
807 			 */
808 			for (i = 0; i < segs_cnt; i++)
809 				if (segs[i].hdrs != p->segs[i].hdrs ||
810 				    ((conds & ICE_FLOW_FIND_PROF_CHK_FLDS) &&
811 				     segs[i].match != p->segs[i].match))
812 					break;
813 
814 			/* A match is found if all segments are matched */
815 			if (i == segs_cnt) {
816 				prof = p;
817 				break;
818 			}
819 		}
820 	ice_release_lock(&hw->fl_profs_locks[blk]);
821 
822 	return prof;
823 }
824 
825 /**
826  * ice_flow_find_prof - Look up a profile matching headers and matched fields
827  * @hw: pointer to the HW struct
828  * @blk: classification stage
829  * @dir: flow direction
830  * @segs: array of one or more packet segments that describe the flow
831  * @segs_cnt: number of packet segments provided
832  */
833 u64
834 ice_flow_find_prof(struct ice_hw *hw, enum ice_block blk, enum ice_flow_dir dir,
835 		   struct ice_flow_seg_info *segs, u8 segs_cnt)
836 {
837 	struct ice_flow_prof *p;
838 
839 	p = ice_flow_find_prof_conds(hw, blk, dir, segs, segs_cnt,
840 				     ICE_MAX_VSI, ICE_FLOW_FIND_PROF_CHK_FLDS);
841 
842 	return p ? p->id : ICE_FLOW_PROF_ID_INVAL;
843 }
844 
845 /**
846  * ice_flow_find_prof_id - Look up a profile with given profile ID
847  * @hw: pointer to the HW struct
848  * @blk: classification stage
849  * @prof_id: unique ID to identify this flow profile
850  */
851 static struct ice_flow_prof *
852 ice_flow_find_prof_id(struct ice_hw *hw, enum ice_block blk, u64 prof_id)
853 {
854 	struct ice_flow_prof *p;
855 
856 	LIST_FOR_EACH_ENTRY(p, &hw->fl_profs[blk], ice_flow_prof, l_entry)
857 		if (p->id == prof_id)
858 			return p;
859 
860 	return NULL;
861 }
862 
863 /**
864  * ice_flow_get_hw_prof - return the HW profile for a specific profile ID handle
865  * @hw: pointer to the HW struct
866  * @blk: classification stage
867  * @prof_id: the profile ID handle
868  * @hw_prof_id: pointer to variable to receive the HW profile ID
869  */
870 enum ice_status
871 ice_flow_get_hw_prof(struct ice_hw *hw, enum ice_block blk, u64 prof_id,
872 		     u8 *hw_prof_id)
873 {
874 	enum ice_status status = ICE_ERR_DOES_NOT_EXIST;
875 	struct ice_prof_map *map;
876 
877 	ice_acquire_lock(&hw->blk[blk].es.prof_map_lock);
878 	map = ice_search_prof_id(hw, blk, prof_id);
879 	if (map) {
880 		*hw_prof_id = map->prof_id;
881 		status = ICE_SUCCESS;
882 	}
883 	ice_release_lock(&hw->blk[blk].es.prof_map_lock);
884 	return status;
885 }
886 
887 /**
888  * ice_flow_add_prof_sync - Add a flow profile for packet segments and fields
889  * @hw: pointer to the HW struct
890  * @blk: classification stage
891  * @dir: flow direction
892  * @prof_id: unique ID to identify this flow profile
893  * @segs: array of one or more packet segments that describe the flow
894  * @segs_cnt: number of packet segments provided
895  * @acts: array of default actions
896  * @acts_cnt: number of default actions
897  * @prof: stores the returned flow profile added
898  *
899  * Assumption: the caller has acquired the lock to the profile list
900  */
901 static enum ice_status
902 ice_flow_add_prof_sync(struct ice_hw *hw, enum ice_block blk,
903 		       enum ice_flow_dir dir, u64 prof_id,
904 		       struct ice_flow_seg_info *segs, u8 segs_cnt,
905 		       struct ice_flow_action *acts, u8 acts_cnt,
906 		       struct ice_flow_prof **prof)
907 {
908 	struct ice_flow_prof_params *params;
909 	enum ice_status status;
910 	u8 i;
911 
912 	if (!prof || (acts_cnt && !acts))
913 		return ICE_ERR_BAD_PTR;
914 
915 	params = (struct ice_flow_prof_params *)ice_malloc(hw, sizeof(*params));
916 	if (!params)
917 		return ICE_ERR_NO_MEMORY;
918 
919 	params->prof = (struct ice_flow_prof *)
920 		ice_malloc(hw, sizeof(*params->prof));
921 	if (!params->prof) {
922 		status = ICE_ERR_NO_MEMORY;
923 		goto free_params;
924 	}
925 
926 	/* initialize extraction sequence to all invalid (0xff) */
927 	for (i = 0; i < ICE_MAX_FV_WORDS; i++) {
928 		params->es[i].prot_id = ICE_PROT_INVALID;
929 		params->es[i].off = ICE_FV_OFFSET_INVAL;
930 	}
931 
932 	params->blk = blk;
933 	params->prof->id = prof_id;
934 	params->prof->dir = dir;
935 	params->prof->segs_cnt = segs_cnt;
936 
937 	/* Make a copy of the segments that need to be persistent in the flow
938 	 * profile instance
939 	 */
940 	for (i = 0; i < segs_cnt; i++)
941 		ice_memcpy(&params->prof->segs[i], &segs[i], sizeof(*segs),
942 			   ICE_NONDMA_TO_NONDMA);
943 
944 	status = ice_flow_proc_segs(hw, params);
945 	if (status) {
946 		ice_debug(hw, ICE_DBG_FLOW, "Error processing a flow's packet segments\n");
947 		goto out;
948 	}
949 
950 	/* Add a HW profile for this flow profile */
951 	status = ice_add_prof(hw, blk, prof_id, (u8 *)params->ptypes,
952 			      params->es);
953 	if (status) {
954 		ice_debug(hw, ICE_DBG_FLOW, "Error adding a HW flow profile\n");
955 		goto out;
956 	}
957 
958 	*prof = params->prof;
959 
960 out:
961 	if (status) {
962 		ice_free(hw, params->prof);
963 	}
964 free_params:
965 	ice_free(hw, params);
966 
967 	return status;
968 }
969 
970 /**
971  * ice_flow_rem_prof_sync - remove a flow profile
972  * @hw: pointer to the hardware structure
973  * @blk: classification stage
974  * @prof: pointer to flow profile to remove
975  *
976  * Assumption: the caller has acquired the lock to the profile list
977  */
978 static enum ice_status
979 ice_flow_rem_prof_sync(struct ice_hw *hw, enum ice_block blk,
980 		       struct ice_flow_prof *prof)
981 {
982 	enum ice_status status;
983 
984 	/* Remove all hardware profiles associated with this flow profile */
985 	status = ice_rem_prof(hw, blk, prof->id);
986 	if (!status) {
987 		LIST_DEL(&prof->l_entry);
988 		ice_free(hw, prof);
989 	}
990 
991 	return status;
992 }
993 
994 /**
995  * ice_flow_assoc_vsig_vsi - associate a VSI with VSIG
996  * @hw: pointer to the hardware structure
997  * @blk: classification stage
998  * @vsi_handle: software VSI handle
999  * @vsig: target VSI group
1000  *
1001  * Assumption: the caller has already verified that the VSI to
1002  * be added has the same characteristics as the VSIG and will
1003  * thereby have access to all resources added to that VSIG.
1004  */
1005 enum ice_status
1006 ice_flow_assoc_vsig_vsi(struct ice_hw *hw, enum ice_block blk, u16 vsi_handle,
1007 			u16 vsig)
1008 {
1009 	enum ice_status status;
1010 
1011 	if (!ice_is_vsi_valid(hw, vsi_handle) || blk >= ICE_BLK_COUNT)
1012 		return ICE_ERR_PARAM;
1013 
1014 	ice_acquire_lock(&hw->fl_profs_locks[blk]);
1015 	status = ice_add_vsi_flow(hw, blk, ice_get_hw_vsi_num(hw, vsi_handle),
1016 				  vsig);
1017 	ice_release_lock(&hw->fl_profs_locks[blk]);
1018 
1019 	return status;
1020 }
1021 
1022 /**
1023  * ice_flow_assoc_prof - associate a VSI with a flow profile
1024  * @hw: pointer to the hardware structure
1025  * @blk: classification stage
1026  * @prof: pointer to flow profile
1027  * @vsi_handle: software VSI handle
1028  *
1029  * Assumption: the caller has acquired the lock to the profile list
1030  * and the software VSI handle has been validated
1031  */
1032 static enum ice_status
1033 ice_flow_assoc_prof(struct ice_hw *hw, enum ice_block blk,
1034 		    struct ice_flow_prof *prof, u16 vsi_handle)
1035 {
1036 	enum ice_status status = ICE_SUCCESS;
1037 
1038 	if (!ice_is_bit_set(prof->vsis, vsi_handle)) {
1039 		status = ice_add_prof_id_flow(hw, blk,
1040 					      ice_get_hw_vsi_num(hw,
1041 								 vsi_handle),
1042 					      prof->id);
1043 		if (!status)
1044 			ice_set_bit(vsi_handle, prof->vsis);
1045 		else
1046 			ice_debug(hw, ICE_DBG_FLOW, "HW profile add failed, %d\n",
1047 				  status);
1048 	}
1049 
1050 	return status;
1051 }
1052 
1053 /**
1054  * ice_flow_disassoc_prof - disassociate a VSI from a flow profile
1055  * @hw: pointer to the hardware structure
1056  * @blk: classification stage
1057  * @prof: pointer to flow profile
1058  * @vsi_handle: software VSI handle
1059  *
1060  * Assumption: the caller has acquired the lock to the profile list
1061  * and the software VSI handle has been validated
1062  */
1063 static enum ice_status
1064 ice_flow_disassoc_prof(struct ice_hw *hw, enum ice_block blk,
1065 		       struct ice_flow_prof *prof, u16 vsi_handle)
1066 {
1067 	enum ice_status status = ICE_SUCCESS;
1068 
1069 	if (ice_is_bit_set(prof->vsis, vsi_handle)) {
1070 		status = ice_rem_prof_id_flow(hw, blk,
1071 					      ice_get_hw_vsi_num(hw,
1072 								 vsi_handle),
1073 					      prof->id);
1074 		if (!status)
1075 			ice_clear_bit(vsi_handle, prof->vsis);
1076 		else
1077 			ice_debug(hw, ICE_DBG_FLOW, "HW profile remove failed, %d\n",
1078 				  status);
1079 	}
1080 
1081 	return status;
1082 }
1083 
1084 /**
1085  * ice_flow_add_prof - Add a flow profile for packet segments and matched fields
1086  * @hw: pointer to the HW struct
1087  * @blk: classification stage
1088  * @dir: flow direction
1089  * @prof_id: unique ID to identify this flow profile
1090  * @segs: array of one or more packet segments that describe the flow
1091  * @segs_cnt: number of packet segments provided
1092  * @acts: array of default actions
1093  * @acts_cnt: number of default actions
1094  * @prof: stores the returned flow profile added
1095  */
1096 static enum ice_status
1097 ice_flow_add_prof(struct ice_hw *hw, enum ice_block blk, enum ice_flow_dir dir,
1098 		  u64 prof_id, struct ice_flow_seg_info *segs, u8 segs_cnt,
1099 		  struct ice_flow_action *acts, u8 acts_cnt,
1100 		  struct ice_flow_prof **prof)
1101 {
1102 	enum ice_status status;
1103 
1104 	if (segs_cnt > ICE_FLOW_SEG_MAX)
1105 		return ICE_ERR_MAX_LIMIT;
1106 
1107 	if (!segs_cnt)
1108 		return ICE_ERR_PARAM;
1109 
1110 	if (!segs)
1111 		return ICE_ERR_BAD_PTR;
1112 
1113 	status = ice_flow_val_hdrs(segs, segs_cnt);
1114 	if (status)
1115 		return status;
1116 
1117 	ice_acquire_lock(&hw->fl_profs_locks[blk]);
1118 
1119 	status = ice_flow_add_prof_sync(hw, blk, dir, prof_id, segs, segs_cnt,
1120 					acts, acts_cnt, prof);
1121 	if (!status)
1122 		LIST_ADD(&(*prof)->l_entry, &hw->fl_profs[blk]);
1123 
1124 	ice_release_lock(&hw->fl_profs_locks[blk]);
1125 
1126 	return status;
1127 }
1128 
1129 /**
1130  * ice_flow_rem_prof - Remove a flow profile and all entries associated with it
1131  * @hw: pointer to the HW struct
1132  * @blk: the block for which the flow profile is to be removed
1133  * @prof_id: unique ID of the flow profile to be removed
1134  */
1135 static enum ice_status
1136 ice_flow_rem_prof(struct ice_hw *hw, enum ice_block blk, u64 prof_id)
1137 {
1138 	struct ice_flow_prof *prof;
1139 	enum ice_status status;
1140 
1141 	ice_acquire_lock(&hw->fl_profs_locks[blk]);
1142 
1143 	prof = ice_flow_find_prof_id(hw, blk, prof_id);
1144 	if (!prof) {
1145 		status = ICE_ERR_DOES_NOT_EXIST;
1146 		goto out;
1147 	}
1148 
1149 	/* prof becomes invalid after the call */
1150 	status = ice_flow_rem_prof_sync(hw, blk, prof);
1151 
1152 out:
1153 	ice_release_lock(&hw->fl_profs_locks[blk]);
1154 
1155 	return status;
1156 }
1157 
1158 /**
1159  * ice_flow_set_fld_ext - specifies locations of field from entry's input buffer
1160  * @seg: packet segment the field being set belongs to
1161  * @fld: field to be set
1162  * @field_type: type of the field
1163  * @val_loc: if not ICE_FLOW_FLD_OFF_INVAL, location of the value to match from
1164  *           entry's input buffer
1165  * @mask_loc: if not ICE_FLOW_FLD_OFF_INVAL, location of mask value from entry's
1166  *            input buffer
1167  * @last_loc: if not ICE_FLOW_FLD_OFF_INVAL, location of last/upper value from
1168  *            entry's input buffer
1169  *
1170  * This helper function stores information of a field being matched, including
1171  * the type of the field and the locations of the value to match, the mask, and
1172  * the upper-bound value in the start of the input buffer for a flow entry.
1173  * This function should only be used for fixed-size data structures.
1174  *
1175  * This function also opportunistically determines the protocol headers to be
1176  * present based on the fields being set. Some fields cannot be used alone to
1177  * determine the protocol headers present. Sometimes, fields for particular
1178  * protocol headers are not matched. In those cases, the protocol headers
1179  * must be explicitly set.
1180  */
1181 static void
1182 ice_flow_set_fld_ext(struct ice_flow_seg_info *seg, enum ice_flow_field fld,
1183 		     enum ice_flow_fld_match_type field_type, u16 val_loc,
1184 		     u16 mask_loc, u16 last_loc)
1185 {
1186 	u64 bit = BIT_ULL(fld);
1187 
1188 	seg->match |= bit;
1189 	if (field_type == ICE_FLOW_FLD_TYPE_RANGE)
1190 		seg->range |= bit;
1191 
1192 	seg->fields[fld].type = field_type;
1193 	seg->fields[fld].src.val = val_loc;
1194 	seg->fields[fld].src.mask = mask_loc;
1195 	seg->fields[fld].src.last = last_loc;
1196 
1197 	ICE_FLOW_SET_HDRS(seg, ice_flds_info[fld].hdr);
1198 }
1199 
1200 /**
1201  * ice_flow_set_fld - specifies locations of field from entry's input buffer
1202  * @seg: packet segment the field being set belongs to
1203  * @fld: field to be set
1204  * @val_loc: if not ICE_FLOW_FLD_OFF_INVAL, location of the value to match from
1205  *           entry's input buffer
1206  * @mask_loc: if not ICE_FLOW_FLD_OFF_INVAL, location of mask value from entry's
1207  *            input buffer
1208  * @last_loc: if not ICE_FLOW_FLD_OFF_INVAL, location of last/upper value from
1209  *            entry's input buffer
1210  * @range: indicate if field being matched is to be in a range
1211  *
1212  * This function specifies the locations, in the form of byte offsets from the
1213  * start of the input buffer for a flow entry, from where the value to match,
1214  * the mask value, and upper value can be extracted. These locations are then
1215  * stored in the flow profile. When adding a flow entry associated with the
1216  * flow profile, these locations will be used to quickly extract the values and
1217  * create the content of a match entry. This function should only be used for
1218  * fixed-size data structures.
1219  */
1220 static void
1221 ice_flow_set_fld(struct ice_flow_seg_info *seg, enum ice_flow_field fld,
1222 		 u16 val_loc, u16 mask_loc, u16 last_loc, bool range)
1223 {
1224 	enum ice_flow_fld_match_type t = range ?
1225 		ICE_FLOW_FLD_TYPE_RANGE : ICE_FLOW_FLD_TYPE_REG;
1226 
1227 	ice_flow_set_fld_ext(seg, fld, t, val_loc, mask_loc, last_loc);
1228 }
1229 
1230 /**
1231  * ice_flow_set_fld_prefix - sets locations of prefix field from entry's buf
1232  * @seg: packet segment the field being set belongs to
1233  * @fld: field to be set
1234  * @val_loc: if not ICE_FLOW_FLD_OFF_INVAL, location of the value to match from
1235  *           entry's input buffer
1236  * @pref_loc: location of prefix value from entry's input buffer
1237  * @pref_sz: size of the location holding the prefix value
1238  *
1239  * This function specifies the locations, in the form of byte offsets from the
1240  * start of the input buffer for a flow entry, from where the value to match
1241  * and the IPv4 prefix value can be extracted. These locations are then stored
1242  * in the flow profile. When adding flow entries to the associated flow profile,
1243  * these locations can be used to quickly extract the values to create the
1244  * content of a match entry. This function should only be used for fixed-size
1245  * data structures.
1246  */
1247 void
1248 ice_flow_set_fld_prefix(struct ice_flow_seg_info *seg, enum ice_flow_field fld,
1249 			u16 val_loc, u16 pref_loc, u8 pref_sz)
1250 {
1251 	/* For this type of field, the "mask" location is for the prefix value's
1252 	 * location and the "last" location is for the size of the location of
1253 	 * the prefix value.
1254 	 */
1255 	ice_flow_set_fld_ext(seg, fld, ICE_FLOW_FLD_TYPE_PREFIX, val_loc,
1256 			     pref_loc, (u16)pref_sz);
1257 }
1258 
1259 #define ICE_FLOW_RSS_SEG_HDR_L3_MASKS \
1260 	(ICE_FLOW_SEG_HDR_IPV4 | ICE_FLOW_SEG_HDR_IPV6)
1261 
1262 #define ICE_FLOW_RSS_SEG_HDR_L4_MASKS \
1263 	(ICE_FLOW_SEG_HDR_TCP | ICE_FLOW_SEG_HDR_UDP | ICE_FLOW_SEG_HDR_SCTP)
1264 
1265 #define ICE_FLOW_RSS_SEG_HDR_VAL_MASKS \
1266 	(ICE_FLOW_RSS_SEG_HDR_L3_MASKS | \
1267 	 ICE_FLOW_RSS_SEG_HDR_L4_MASKS)
1268 
1269 /**
1270  * ice_flow_set_rss_seg_info - setup packet segments for RSS
1271  * @segs: pointer to the flow field segment(s)
1272  * @hash_fields: fields to be hashed on for the segment(s)
1273  * @flow_hdr: protocol header fields within a packet segment
1274  *
1275  * Helper function to extract fields from hash bitmap and use flow
1276  * header value to set flow field segment for further use in flow
1277  * profile entry or removal.
1278  */
1279 static enum ice_status
1280 ice_flow_set_rss_seg_info(struct ice_flow_seg_info *segs, u64 hash_fields,
1281 			  u32 flow_hdr)
1282 {
1283 	u64 val;
1284 	u8 i;
1285 
1286 	ice_for_each_set_bit(i, (ice_bitmap_t *)&hash_fields,
1287 			     ICE_FLOW_FIELD_IDX_MAX)
1288 		ice_flow_set_fld(segs, (enum ice_flow_field)i,
1289 				 ICE_FLOW_FLD_OFF_INVAL, ICE_FLOW_FLD_OFF_INVAL,
1290 				 ICE_FLOW_FLD_OFF_INVAL, false);
1291 
1292 	ICE_FLOW_SET_HDRS(segs, flow_hdr);
1293 
1294 	if (segs->hdrs & ~ICE_FLOW_RSS_SEG_HDR_VAL_MASKS)
1295 		return ICE_ERR_PARAM;
1296 
1297 	val = (u64)(segs->hdrs & ICE_FLOW_RSS_SEG_HDR_L3_MASKS);
1298 	if (val && !ice_is_pow2(val))
1299 		return ICE_ERR_CFG;
1300 
1301 	val = (u64)(segs->hdrs & ICE_FLOW_RSS_SEG_HDR_L4_MASKS);
1302 	if (val && !ice_is_pow2(val))
1303 		return ICE_ERR_CFG;
1304 
1305 	return ICE_SUCCESS;
1306 }
1307 
1308 /**
1309  * ice_rem_vsi_rss_list - remove VSI from RSS list
1310  * @hw: pointer to the hardware structure
1311  * @vsi_handle: software VSI handle
1312  *
1313  * Remove the VSI from all RSS configurations in the list.
1314  */
1315 void ice_rem_vsi_rss_list(struct ice_hw *hw, u16 vsi_handle)
1316 {
1317 	struct ice_rss_cfg *r, *tmp;
1318 
1319 	if (LIST_EMPTY(&hw->rss_list_head))
1320 		return;
1321 
1322 	ice_acquire_lock(&hw->rss_locks);
1323 	LIST_FOR_EACH_ENTRY_SAFE(r, tmp, &hw->rss_list_head,
1324 				 ice_rss_cfg, l_entry)
1325 		if (ice_test_and_clear_bit(vsi_handle, r->vsis))
1326 			if (!ice_is_any_bit_set(r->vsis, ICE_MAX_VSI)) {
1327 				LIST_DEL(&r->l_entry);
1328 				ice_free(hw, r);
1329 			}
1330 	ice_release_lock(&hw->rss_locks);
1331 }
1332 
1333 /**
1334  * ice_rem_vsi_rss_cfg - remove RSS configurations associated with VSI
1335  * @hw: pointer to the hardware structure
1336  * @vsi_handle: software VSI handle
1337  *
1338  * This function will iterate through all flow profiles and disassociate
1339  * the VSI from that profile. If the flow profile has no VSIs it will
1340  * be removed.
1341  */
1342 enum ice_status ice_rem_vsi_rss_cfg(struct ice_hw *hw, u16 vsi_handle)
1343 {
1344 	const enum ice_block blk = ICE_BLK_RSS;
1345 	struct ice_flow_prof *p, *t;
1346 	enum ice_status status = ICE_SUCCESS;
1347 
1348 	if (!ice_is_vsi_valid(hw, vsi_handle))
1349 		return ICE_ERR_PARAM;
1350 
1351 	if (LIST_EMPTY(&hw->fl_profs[blk]))
1352 		return ICE_SUCCESS;
1353 
1354 	ice_acquire_lock(&hw->rss_locks);
1355 	LIST_FOR_EACH_ENTRY_SAFE(p, t, &hw->fl_profs[blk], ice_flow_prof,
1356 				 l_entry)
1357 		if (ice_is_bit_set(p->vsis, vsi_handle)) {
1358 			status = ice_flow_disassoc_prof(hw, blk, p, vsi_handle);
1359 			if (status)
1360 				break;
1361 
1362 			if (!ice_is_any_bit_set(p->vsis, ICE_MAX_VSI)) {
1363 				status = ice_flow_rem_prof(hw, blk, p->id);
1364 				if (status)
1365 					break;
1366 			}
1367 		}
1368 	ice_release_lock(&hw->rss_locks);
1369 
1370 	return status;
1371 }
1372 
1373 /**
1374  * ice_rem_rss_list - remove RSS configuration from list
1375  * @hw: pointer to the hardware structure
1376  * @vsi_handle: software VSI handle
1377  * @prof: pointer to flow profile
1378  *
1379  * Assumption: lock has already been acquired for RSS list
1380  */
1381 static void
1382 ice_rem_rss_list(struct ice_hw *hw, u16 vsi_handle, struct ice_flow_prof *prof)
1383 {
1384 	struct ice_rss_cfg *r, *tmp;
1385 
1386 	/* Search for RSS hash fields associated to the VSI that match the
1387 	 * hash configurations associated to the flow profile. If found
1388 	 * remove from the RSS entry list of the VSI context and delete entry.
1389 	 */
1390 	LIST_FOR_EACH_ENTRY_SAFE(r, tmp, &hw->rss_list_head,
1391 				 ice_rss_cfg, l_entry)
1392 		if (r->hashed_flds == prof->segs[prof->segs_cnt - 1].match &&
1393 		    r->packet_hdr == prof->segs[prof->segs_cnt - 1].hdrs) {
1394 			ice_clear_bit(vsi_handle, r->vsis);
1395 			if (!ice_is_any_bit_set(r->vsis, ICE_MAX_VSI)) {
1396 				LIST_DEL(&r->l_entry);
1397 				ice_free(hw, r);
1398 			}
1399 			return;
1400 		}
1401 }
1402 
1403 /**
1404  * ice_add_rss_list - add RSS configuration to list
1405  * @hw: pointer to the hardware structure
1406  * @vsi_handle: software VSI handle
1407  * @prof: pointer to flow profile
1408  *
1409  * Assumption: lock has already been acquired for RSS list
1410  */
1411 static enum ice_status
1412 ice_add_rss_list(struct ice_hw *hw, u16 vsi_handle, struct ice_flow_prof *prof)
1413 {
1414 	struct ice_rss_cfg *r, *rss_cfg;
1415 
1416 	LIST_FOR_EACH_ENTRY(r, &hw->rss_list_head,
1417 			    ice_rss_cfg, l_entry)
1418 		if (r->hashed_flds == prof->segs[prof->segs_cnt - 1].match &&
1419 		    r->packet_hdr == prof->segs[prof->segs_cnt - 1].hdrs) {
1420 			ice_set_bit(vsi_handle, r->vsis);
1421 			return ICE_SUCCESS;
1422 		}
1423 
1424 	rss_cfg = (struct ice_rss_cfg *)ice_malloc(hw, sizeof(*rss_cfg));
1425 	if (!rss_cfg)
1426 		return ICE_ERR_NO_MEMORY;
1427 
1428 	rss_cfg->hashed_flds = prof->segs[prof->segs_cnt - 1].match;
1429 	rss_cfg->packet_hdr = prof->segs[prof->segs_cnt - 1].hdrs;
1430 	ice_set_bit(vsi_handle, rss_cfg->vsis);
1431 
1432 	LIST_ADD_TAIL(&rss_cfg->l_entry, &hw->rss_list_head);
1433 
1434 	return ICE_SUCCESS;
1435 }
1436 
1437 #define ICE_FLOW_PROF_HASH_S	0
1438 #define ICE_FLOW_PROF_HASH_M	(0xFFFFFFFFULL << ICE_FLOW_PROF_HASH_S)
1439 #define ICE_FLOW_PROF_HDR_S	32
1440 #define ICE_FLOW_PROF_HDR_M	(0x3FFFFFFFULL << ICE_FLOW_PROF_HDR_S)
1441 #define ICE_FLOW_PROF_ENCAP_S	63
1442 #define ICE_FLOW_PROF_ENCAP_M	(BIT_ULL(ICE_FLOW_PROF_ENCAP_S))
1443 
1444 #define ICE_RSS_OUTER_HEADERS	1
1445 #define ICE_RSS_INNER_HEADERS	2
1446 
1447 /* Flow profile ID format:
1448  * [0:31] - Packet match fields
1449  * [32:62] - Protocol header
1450  * [63] - Encapsulation flag, 0 if non-tunneled, 1 if tunneled
1451  */
1452 #define ICE_FLOW_GEN_PROFID(hash, hdr, segs_cnt) \
1453 	(u64)(((u64)(hash) & ICE_FLOW_PROF_HASH_M) | \
1454 	      (((u64)(hdr) << ICE_FLOW_PROF_HDR_S) & ICE_FLOW_PROF_HDR_M) | \
1455 	      ((u8)((segs_cnt) - 1) ? ICE_FLOW_PROF_ENCAP_M : 0))
1456 
1457 /**
1458  * ice_add_rss_cfg_sync - add an RSS configuration
1459  * @hw: pointer to the hardware structure
1460  * @vsi_handle: software VSI handle
1461  * @hashed_flds: hash bit fields (ICE_FLOW_HASH_*) to configure
1462  * @addl_hdrs: protocol header fields
1463  * @segs_cnt: packet segment count
1464  *
1465  * Assumption: lock has already been acquired for RSS list
1466  */
1467 static enum ice_status
1468 ice_add_rss_cfg_sync(struct ice_hw *hw, u16 vsi_handle, u64 hashed_flds,
1469 		     u32 addl_hdrs, u8 segs_cnt)
1470 {
1471 	const enum ice_block blk = ICE_BLK_RSS;
1472 	struct ice_flow_prof *prof = NULL;
1473 	struct ice_flow_seg_info *segs;
1474 	enum ice_status status;
1475 
1476 	if (!segs_cnt || segs_cnt > ICE_FLOW_SEG_MAX)
1477 		return ICE_ERR_PARAM;
1478 
1479 	segs = (struct ice_flow_seg_info *)ice_calloc(hw, segs_cnt,
1480 						      sizeof(*segs));
1481 	if (!segs)
1482 		return ICE_ERR_NO_MEMORY;
1483 
1484 	/* Construct the packet segment info from the hashed fields */
1485 	status = ice_flow_set_rss_seg_info(&segs[segs_cnt - 1], hashed_flds,
1486 					   addl_hdrs);
1487 	if (status)
1488 		goto exit;
1489 
1490 	/* Search for a flow profile that has matching headers, hash fields
1491 	 * and has the input VSI associated to it. If found, no further
1492 	 * operations required and exit.
1493 	 */
1494 	prof = ice_flow_find_prof_conds(hw, blk, ICE_FLOW_RX, segs, segs_cnt,
1495 					vsi_handle,
1496 					ICE_FLOW_FIND_PROF_CHK_FLDS |
1497 					ICE_FLOW_FIND_PROF_CHK_VSI);
1498 	if (prof)
1499 		goto exit;
1500 
1501 	/* Check if a flow profile exists with the same protocol headers and
1502 	 * associated with the input VSI. If so disassociate the VSI from
1503 	 * this profile. The VSI will be added to a new profile created with
1504 	 * the protocol header and new hash field configuration.
1505 	 */
1506 	prof = ice_flow_find_prof_conds(hw, blk, ICE_FLOW_RX, segs, segs_cnt,
1507 					vsi_handle, ICE_FLOW_FIND_PROF_CHK_VSI);
1508 	if (prof) {
1509 		status = ice_flow_disassoc_prof(hw, blk, prof, vsi_handle);
1510 		if (!status)
1511 			ice_rem_rss_list(hw, vsi_handle, prof);
1512 		else
1513 			goto exit;
1514 
1515 		/* Remove profile if it has no VSIs associated */
1516 		if (!ice_is_any_bit_set(prof->vsis, ICE_MAX_VSI)) {
1517 			status = ice_flow_rem_prof(hw, blk, prof->id);
1518 			if (status)
1519 				goto exit;
1520 		}
1521 	}
1522 
1523 	/* Search for a profile that has same match fields only. If this
1524 	 * exists then associate the VSI to this profile.
1525 	 */
1526 	prof = ice_flow_find_prof_conds(hw, blk, ICE_FLOW_RX, segs, segs_cnt,
1527 					vsi_handle,
1528 					ICE_FLOW_FIND_PROF_CHK_FLDS);
1529 	if (prof) {
1530 		status = ice_flow_assoc_prof(hw, blk, prof, vsi_handle);
1531 		if (!status)
1532 			status = ice_add_rss_list(hw, vsi_handle, prof);
1533 		goto exit;
1534 	}
1535 
1536 	/* Create a new flow profile with generated profile and packet
1537 	 * segment information.
1538 	 */
1539 	status = ice_flow_add_prof(hw, blk, ICE_FLOW_RX,
1540 				   ICE_FLOW_GEN_PROFID(hashed_flds,
1541 						       segs[segs_cnt - 1].hdrs,
1542 						       segs_cnt),
1543 				   segs, segs_cnt, NULL, 0, &prof);
1544 	if (status)
1545 		goto exit;
1546 
1547 	status = ice_flow_assoc_prof(hw, blk, prof, vsi_handle);
1548 	/* If association to a new flow profile failed then this profile can
1549 	 * be removed.
1550 	 */
1551 	if (status) {
1552 		ice_flow_rem_prof(hw, blk, prof->id);
1553 		goto exit;
1554 	}
1555 
1556 	status = ice_add_rss_list(hw, vsi_handle, prof);
1557 
1558 exit:
1559 	ice_free(hw, segs);
1560 	return status;
1561 }
1562 
1563 /**
1564  * ice_add_rss_cfg - add an RSS configuration with specified hashed fields
1565  * @hw: pointer to the hardware structure
1566  * @vsi_handle: software VSI handle
1567  * @hashed_flds: hash bit fields (ICE_FLOW_HASH_*) to configure
1568  * @addl_hdrs: protocol header fields
1569  *
1570  * This function will generate a flow profile based on fields associated with
1571  * the input fields to hash on, the flow type and use the VSI number to add
1572  * a flow entry to the profile.
1573  */
1574 enum ice_status
1575 ice_add_rss_cfg(struct ice_hw *hw, u16 vsi_handle, u64 hashed_flds,
1576 		u32 addl_hdrs)
1577 {
1578 	enum ice_status status;
1579 
1580 	if (hashed_flds == ICE_HASH_INVALID ||
1581 	    !ice_is_vsi_valid(hw, vsi_handle))
1582 		return ICE_ERR_PARAM;
1583 
1584 	ice_acquire_lock(&hw->rss_locks);
1585 	status = ice_add_rss_cfg_sync(hw, vsi_handle, hashed_flds, addl_hdrs,
1586 				      ICE_RSS_OUTER_HEADERS);
1587 	if (!status)
1588 		status = ice_add_rss_cfg_sync(hw, vsi_handle, hashed_flds,
1589 					      addl_hdrs, ICE_RSS_INNER_HEADERS);
1590 	ice_release_lock(&hw->rss_locks);
1591 
1592 	return status;
1593 }
1594 
1595 /**
1596  * ice_rem_rss_cfg_sync - remove an existing RSS configuration
1597  * @hw: pointer to the hardware structure
1598  * @vsi_handle: software VSI handle
1599  * @hashed_flds: Packet hash types (ICE_FLOW_HASH_*) to remove
1600  * @addl_hdrs: Protocol header fields within a packet segment
1601  * @segs_cnt: packet segment count
1602  *
1603  * Assumption: lock has already been acquired for RSS list
1604  */
1605 static enum ice_status
1606 ice_rem_rss_cfg_sync(struct ice_hw *hw, u16 vsi_handle, u64 hashed_flds,
1607 		     u32 addl_hdrs, u8 segs_cnt)
1608 {
1609 	const enum ice_block blk = ICE_BLK_RSS;
1610 	struct ice_flow_seg_info *segs;
1611 	struct ice_flow_prof *prof;
1612 	enum ice_status status;
1613 
1614 	segs = (struct ice_flow_seg_info *)ice_calloc(hw, segs_cnt,
1615 						      sizeof(*segs));
1616 	if (!segs)
1617 		return ICE_ERR_NO_MEMORY;
1618 
1619 	/* Construct the packet segment info from the hashed fields */
1620 	status = ice_flow_set_rss_seg_info(&segs[segs_cnt - 1], hashed_flds,
1621 					   addl_hdrs);
1622 	if (status)
1623 		goto out;
1624 
1625 	prof = ice_flow_find_prof_conds(hw, blk, ICE_FLOW_RX, segs, segs_cnt,
1626 					vsi_handle,
1627 					ICE_FLOW_FIND_PROF_CHK_FLDS);
1628 	if (!prof) {
1629 		status = ICE_ERR_DOES_NOT_EXIST;
1630 		goto out;
1631 	}
1632 
1633 	status = ice_flow_disassoc_prof(hw, blk, prof, vsi_handle);
1634 	if (status)
1635 		goto out;
1636 
1637 	/* Remove RSS configuration from VSI context before deleting
1638 	 * the flow profile.
1639 	 */
1640 	ice_rem_rss_list(hw, vsi_handle, prof);
1641 
1642 	if (!ice_is_any_bit_set(prof->vsis, ICE_MAX_VSI))
1643 		status = ice_flow_rem_prof(hw, blk, prof->id);
1644 
1645 out:
1646 	ice_free(hw, segs);
1647 	return status;
1648 }
1649 
1650 /**
1651  * ice_rem_rss_cfg - remove an existing RSS config with matching hashed fields
1652  * @hw: pointer to the hardware structure
1653  * @vsi_handle: software VSI handle
1654  * @hashed_flds: Packet hash types (ICE_FLOW_HASH_*) to remove
1655  * @addl_hdrs: Protocol header fields within a packet segment
1656  *
1657  * This function will lookup the flow profile based on the input
1658  * hash field bitmap, iterate through the profile entry list of
1659  * that profile and find entry associated with input VSI to be
1660  * removed. Calls are made to underlying flow apis which will in
1661  * turn build or update buffers for RSS XLT1 section.
1662  */
1663 enum ice_status
1664 ice_rem_rss_cfg(struct ice_hw *hw, u16 vsi_handle, u64 hashed_flds,
1665 		u32 addl_hdrs)
1666 {
1667 	enum ice_status status;
1668 
1669 	if (hashed_flds == ICE_HASH_INVALID ||
1670 	    !ice_is_vsi_valid(hw, vsi_handle))
1671 		return ICE_ERR_PARAM;
1672 
1673 	ice_acquire_lock(&hw->rss_locks);
1674 	status = ice_rem_rss_cfg_sync(hw, vsi_handle, hashed_flds, addl_hdrs,
1675 				      ICE_RSS_OUTER_HEADERS);
1676 	if (!status)
1677 		status = ice_rem_rss_cfg_sync(hw, vsi_handle, hashed_flds,
1678 					      addl_hdrs, ICE_RSS_INNER_HEADERS);
1679 	ice_release_lock(&hw->rss_locks);
1680 
1681 	return status;
1682 }
1683 
1684 /* Mapping of AVF hash bit fields to an L3-L4 hash combination.
1685  * As the ice_flow_avf_hdr_field represent individual bit shifts in a hash,
1686  * convert its values to their appropriate flow L3, L4 values.
1687  */
1688 #define ICE_FLOW_AVF_RSS_IPV4_MASKS \
1689 	(BIT_ULL(ICE_AVF_FLOW_FIELD_IPV4_OTHER) | \
1690 	 BIT_ULL(ICE_AVF_FLOW_FIELD_FRAG_IPV4))
1691 #define ICE_FLOW_AVF_RSS_TCP_IPV4_MASKS \
1692 	(BIT_ULL(ICE_AVF_FLOW_FIELD_IPV4_TCP_SYN_NO_ACK) | \
1693 	 BIT_ULL(ICE_AVF_FLOW_FIELD_IPV4_TCP))
1694 #define ICE_FLOW_AVF_RSS_UDP_IPV4_MASKS \
1695 	(BIT_ULL(ICE_AVF_FLOW_FIELD_UNICAST_IPV4_UDP) | \
1696 	 BIT_ULL(ICE_AVF_FLOW_FIELD_MULTICAST_IPV4_UDP) | \
1697 	 BIT_ULL(ICE_AVF_FLOW_FIELD_IPV4_UDP))
1698 #define ICE_FLOW_AVF_RSS_ALL_IPV4_MASKS \
1699 	(ICE_FLOW_AVF_RSS_TCP_IPV4_MASKS | ICE_FLOW_AVF_RSS_UDP_IPV4_MASKS | \
1700 	 ICE_FLOW_AVF_RSS_IPV4_MASKS | BIT_ULL(ICE_AVF_FLOW_FIELD_IPV4_SCTP))
1701 
1702 #define ICE_FLOW_AVF_RSS_IPV6_MASKS \
1703 	(BIT_ULL(ICE_AVF_FLOW_FIELD_IPV6_OTHER) | \
1704 	 BIT_ULL(ICE_AVF_FLOW_FIELD_FRAG_IPV6))
1705 #define ICE_FLOW_AVF_RSS_UDP_IPV6_MASKS \
1706 	(BIT_ULL(ICE_AVF_FLOW_FIELD_UNICAST_IPV6_UDP) | \
1707 	 BIT_ULL(ICE_AVF_FLOW_FIELD_MULTICAST_IPV6_UDP) | \
1708 	 BIT_ULL(ICE_AVF_FLOW_FIELD_IPV6_UDP))
1709 #define ICE_FLOW_AVF_RSS_TCP_IPV6_MASKS \
1710 	(BIT_ULL(ICE_AVF_FLOW_FIELD_IPV6_TCP_SYN_NO_ACK) | \
1711 	 BIT_ULL(ICE_AVF_FLOW_FIELD_IPV6_TCP))
1712 #define ICE_FLOW_AVF_RSS_ALL_IPV6_MASKS \
1713 	(ICE_FLOW_AVF_RSS_TCP_IPV6_MASKS | ICE_FLOW_AVF_RSS_UDP_IPV6_MASKS | \
1714 	 ICE_FLOW_AVF_RSS_IPV6_MASKS | BIT_ULL(ICE_AVF_FLOW_FIELD_IPV6_SCTP))
1715 
1716 /**
1717  * ice_add_avf_rss_cfg - add an RSS configuration for AVF driver
1718  * @hw: pointer to the hardware structure
1719  * @vsi_handle: software VSI handle
1720  * @avf_hash: hash bit fields (ICE_AVF_FLOW_FIELD_*) to configure
1721  *
1722  * This function will take the hash bitmap provided by the AVF driver via a
1723  * message, convert it to ICE-compatible values, and configure RSS flow
1724  * profiles.
1725  */
1726 enum ice_status
1727 ice_add_avf_rss_cfg(struct ice_hw *hw, u16 vsi_handle, u64 avf_hash)
1728 {
1729 	enum ice_status status = ICE_SUCCESS;
1730 	u64 hash_flds;
1731 
1732 	if (avf_hash == ICE_AVF_FLOW_FIELD_INVALID ||
1733 	    !ice_is_vsi_valid(hw, vsi_handle))
1734 		return ICE_ERR_PARAM;
1735 
1736 	/* Make sure no unsupported bits are specified */
1737 	if (avf_hash & ~(ICE_FLOW_AVF_RSS_ALL_IPV4_MASKS |
1738 			 ICE_FLOW_AVF_RSS_ALL_IPV6_MASKS))
1739 		return ICE_ERR_CFG;
1740 
1741 	hash_flds = avf_hash;
1742 
1743 	/* Always create an L3 RSS configuration for any L4 RSS configuration */
1744 	if (hash_flds & ICE_FLOW_AVF_RSS_ALL_IPV4_MASKS)
1745 		hash_flds |= ICE_FLOW_AVF_RSS_IPV4_MASKS;
1746 
1747 	if (hash_flds & ICE_FLOW_AVF_RSS_ALL_IPV6_MASKS)
1748 		hash_flds |= ICE_FLOW_AVF_RSS_IPV6_MASKS;
1749 
1750 	/* Create the corresponding RSS configuration for each valid hash bit */
1751 	while (hash_flds) {
1752 		u64 rss_hash = ICE_HASH_INVALID;
1753 
1754 		if (hash_flds & ICE_FLOW_AVF_RSS_ALL_IPV4_MASKS) {
1755 			if (hash_flds & ICE_FLOW_AVF_RSS_IPV4_MASKS) {
1756 				rss_hash = ICE_FLOW_HASH_IPV4;
1757 				hash_flds &= ~ICE_FLOW_AVF_RSS_IPV4_MASKS;
1758 			} else if (hash_flds &
1759 				   ICE_FLOW_AVF_RSS_TCP_IPV4_MASKS) {
1760 				rss_hash = ICE_FLOW_HASH_IPV4 |
1761 					ICE_FLOW_HASH_TCP_PORT;
1762 				hash_flds &= ~ICE_FLOW_AVF_RSS_TCP_IPV4_MASKS;
1763 			} else if (hash_flds &
1764 				   ICE_FLOW_AVF_RSS_UDP_IPV4_MASKS) {
1765 				rss_hash = ICE_FLOW_HASH_IPV4 |
1766 					ICE_FLOW_HASH_UDP_PORT;
1767 				hash_flds &= ~ICE_FLOW_AVF_RSS_UDP_IPV4_MASKS;
1768 			} else if (hash_flds &
1769 				   BIT_ULL(ICE_AVF_FLOW_FIELD_IPV4_SCTP)) {
1770 				rss_hash = ICE_FLOW_HASH_IPV4 |
1771 					ICE_FLOW_HASH_SCTP_PORT;
1772 				hash_flds &=
1773 					~BIT_ULL(ICE_AVF_FLOW_FIELD_IPV4_SCTP);
1774 			}
1775 		} else if (hash_flds & ICE_FLOW_AVF_RSS_ALL_IPV6_MASKS) {
1776 			if (hash_flds & ICE_FLOW_AVF_RSS_IPV6_MASKS) {
1777 				rss_hash = ICE_FLOW_HASH_IPV6;
1778 				hash_flds &= ~ICE_FLOW_AVF_RSS_IPV6_MASKS;
1779 			} else if (hash_flds &
1780 				   ICE_FLOW_AVF_RSS_TCP_IPV6_MASKS) {
1781 				rss_hash = ICE_FLOW_HASH_IPV6 |
1782 					ICE_FLOW_HASH_TCP_PORT;
1783 				hash_flds &= ~ICE_FLOW_AVF_RSS_TCP_IPV6_MASKS;
1784 			} else if (hash_flds &
1785 				   ICE_FLOW_AVF_RSS_UDP_IPV6_MASKS) {
1786 				rss_hash = ICE_FLOW_HASH_IPV6 |
1787 					ICE_FLOW_HASH_UDP_PORT;
1788 				hash_flds &= ~ICE_FLOW_AVF_RSS_UDP_IPV6_MASKS;
1789 			} else if (hash_flds &
1790 				   BIT_ULL(ICE_AVF_FLOW_FIELD_IPV6_SCTP)) {
1791 				rss_hash = ICE_FLOW_HASH_IPV6 |
1792 					ICE_FLOW_HASH_SCTP_PORT;
1793 				hash_flds &=
1794 					~BIT_ULL(ICE_AVF_FLOW_FIELD_IPV6_SCTP);
1795 			}
1796 		}
1797 
1798 		if (rss_hash == ICE_HASH_INVALID)
1799 			return ICE_ERR_OUT_OF_RANGE;
1800 
1801 		status = ice_add_rss_cfg(hw, vsi_handle, rss_hash,
1802 					 ICE_FLOW_SEG_HDR_NONE);
1803 		if (status)
1804 			break;
1805 	}
1806 
1807 	return status;
1808 }
1809 
1810 /**
1811  * ice_replay_rss_cfg - replay RSS configurations associated with VSI
1812  * @hw: pointer to the hardware structure
1813  * @vsi_handle: software VSI handle
1814  */
1815 enum ice_status ice_replay_rss_cfg(struct ice_hw *hw, u16 vsi_handle)
1816 {
1817 	enum ice_status status = ICE_SUCCESS;
1818 	struct ice_rss_cfg *r;
1819 
1820 	if (!ice_is_vsi_valid(hw, vsi_handle))
1821 		return ICE_ERR_PARAM;
1822 
1823 	ice_acquire_lock(&hw->rss_locks);
1824 	LIST_FOR_EACH_ENTRY(r, &hw->rss_list_head,
1825 			    ice_rss_cfg, l_entry) {
1826 		if (ice_is_bit_set(r->vsis, vsi_handle)) {
1827 			status = ice_add_rss_cfg_sync(hw, vsi_handle,
1828 						      r->hashed_flds,
1829 						      r->packet_hdr,
1830 						      ICE_RSS_OUTER_HEADERS);
1831 			if (status)
1832 				break;
1833 			status = ice_add_rss_cfg_sync(hw, vsi_handle,
1834 						      r->hashed_flds,
1835 						      r->packet_hdr,
1836 						      ICE_RSS_INNER_HEADERS);
1837 			if (status)
1838 				break;
1839 		}
1840 	}
1841 	ice_release_lock(&hw->rss_locks);
1842 
1843 	return status;
1844 }
1845 
1846 /**
1847  * ice_get_rss_cfg - returns hashed fields for the given header types
1848  * @hw: pointer to the hardware structure
1849  * @vsi_handle: software VSI handle
1850  * @hdrs: protocol header type
1851  *
1852  * This function will return the match fields of the first instance of flow
1853  * profile having the given header types and containing input VSI
1854  */
1855 u64 ice_get_rss_cfg(struct ice_hw *hw, u16 vsi_handle, u32 hdrs)
1856 {
1857 	u64 rss_hash = ICE_HASH_INVALID;
1858 	struct ice_rss_cfg *r;
1859 
1860 	/* verify if the protocol header is non zero and VSI is valid */
1861 	if (hdrs == ICE_FLOW_SEG_HDR_NONE || !ice_is_vsi_valid(hw, vsi_handle))
1862 		return ICE_HASH_INVALID;
1863 
1864 	ice_acquire_lock(&hw->rss_locks);
1865 	LIST_FOR_EACH_ENTRY(r, &hw->rss_list_head,
1866 			    ice_rss_cfg, l_entry)
1867 		if (ice_is_bit_set(r->vsis, vsi_handle) &&
1868 		    r->packet_hdr == hdrs) {
1869 			rss_hash = r->hashed_flds;
1870 			break;
1871 		}
1872 	ice_release_lock(&hw->rss_locks);
1873 
1874 	return rss_hash;
1875 }
1876