1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2001-2019
8 #include "ice_flex_type.h"
9 #define ICE_IPV4_MAKE_PREFIX_MASK(prefix) ((u32)(~0) << (32 - (prefix)))
10 #define ICE_FLOW_PROF_ID_INVAL 0xfffffffffffffffful
11 #define ICE_FLOW_PROF_ID_BYPASS 0
12 #define ICE_FLOW_PROF_ID_DEFAULT 1
13 #define ICE_FLOW_ENTRY_HANDLE_INVAL 0
14 #define ICE_FLOW_VSI_INVAL 0xffff
15 #define ICE_FLOW_FLD_OFF_INVAL 0xffff
17 /* Generate flow hash field from flow field type(s) */
18 #define ICE_FLOW_HASH_ETH \
19 (BIT_ULL(ICE_FLOW_FIELD_IDX_ETH_DA) | \
20 BIT_ULL(ICE_FLOW_FIELD_IDX_ETH_SA))
21 #define ICE_FLOW_HASH_IPV4 \
22 (BIT_ULL(ICE_FLOW_FIELD_IDX_IPV4_SA) | \
23 BIT_ULL(ICE_FLOW_FIELD_IDX_IPV4_DA))
24 #define ICE_FLOW_HASH_IPV6 \
25 (BIT_ULL(ICE_FLOW_FIELD_IDX_IPV6_SA) | \
26 BIT_ULL(ICE_FLOW_FIELD_IDX_IPV6_DA))
27 #define ICE_FLOW_HASH_TCP_PORT \
28 (BIT_ULL(ICE_FLOW_FIELD_IDX_TCP_SRC_PORT) | \
29 BIT_ULL(ICE_FLOW_FIELD_IDX_TCP_DST_PORT))
30 #define ICE_FLOW_HASH_UDP_PORT \
31 (BIT_ULL(ICE_FLOW_FIELD_IDX_UDP_SRC_PORT) | \
32 BIT_ULL(ICE_FLOW_FIELD_IDX_UDP_DST_PORT))
33 #define ICE_FLOW_HASH_SCTP_PORT \
34 (BIT_ULL(ICE_FLOW_FIELD_IDX_SCTP_SRC_PORT) | \
35 BIT_ULL(ICE_FLOW_FIELD_IDX_SCTP_DST_PORT))
37 #define ICE_HASH_INVALID 0
38 #define ICE_HASH_TCP_IPV4 (ICE_FLOW_HASH_IPV4 | ICE_FLOW_HASH_TCP_PORT)
39 #define ICE_HASH_TCP_IPV6 (ICE_FLOW_HASH_IPV6 | ICE_FLOW_HASH_TCP_PORT)
40 #define ICE_HASH_UDP_IPV4 (ICE_FLOW_HASH_IPV4 | ICE_FLOW_HASH_UDP_PORT)
41 #define ICE_HASH_UDP_IPV6 (ICE_FLOW_HASH_IPV6 | ICE_FLOW_HASH_UDP_PORT)
42 #define ICE_HASH_SCTP_IPV4 (ICE_FLOW_HASH_IPV4 | ICE_FLOW_HASH_SCTP_PORT)
43 #define ICE_HASH_SCTP_IPV6 (ICE_FLOW_HASH_IPV6 | ICE_FLOW_HASH_SCTP_PORT)
45 #define ICE_FLOW_HASH_GTP_TEID \
46 (BIT_ULL(ICE_FLOW_FIELD_IDX_GTPC_TEID))
48 #define ICE_FLOW_HASH_GTP_IPV4_TEID \
49 (ICE_FLOW_HASH_IPV4 | ICE_FLOW_HASH_GTP_TEID)
50 #define ICE_FLOW_HASH_GTP_IPV6_TEID \
51 (ICE_FLOW_HASH_IPV6 | ICE_FLOW_HASH_GTP_TEID)
53 #define ICE_FLOW_HASH_GTP_U_TEID \
54 (BIT_ULL(ICE_FLOW_FIELD_IDX_GTPU_IP_TEID))
56 #define ICE_FLOW_HASH_GTP_U_IPV4_TEID \
57 (ICE_FLOW_HASH_IPV4 | ICE_FLOW_HASH_GTP_U_TEID)
58 #define ICE_FLOW_HASH_GTP_U_IPV6_TEID \
59 (ICE_FLOW_HASH_IPV6 | ICE_FLOW_HASH_GTP_U_TEID)
61 #define ICE_FLOW_HASH_GTP_U_EH_TEID \
62 (BIT_ULL(ICE_FLOW_FIELD_IDX_GTPU_EH_TEID))
64 #define ICE_FLOW_HASH_GTP_U_EH_QFI \
65 (BIT_ULL(ICE_FLOW_FIELD_IDX_GTPU_EH_QFI))
67 #define ICE_FLOW_HASH_GTP_U_IPV4_EH \
68 (ICE_FLOW_HASH_IPV4 | ICE_FLOW_HASH_GTP_U_EH_TEID | \
69 ICE_FLOW_HASH_GTP_U_EH_QFI)
70 #define ICE_FLOW_HASH_GTP_U_IPV6_EH \
71 (ICE_FLOW_HASH_IPV6 | ICE_FLOW_HASH_GTP_U_EH_TEID | \
72 ICE_FLOW_HASH_GTP_U_EH_QFI)
74 #define ICE_FLOW_HASH_PPPOE_SESS_ID \
75 (BIT_ULL(ICE_FLOW_FIELD_IDX_PPPOE_SESS_ID))
77 #define ICE_FLOW_HASH_PPPOE_SESS_ID_ETH \
78 (ICE_FLOW_HASH_ETH | ICE_FLOW_HASH_PPPOE_SESS_ID)
79 #define ICE_FLOW_HASH_PPPOE_TCP_ID \
80 (ICE_FLOW_HASH_TCP_PORT | ICE_FLOW_HASH_PPPOE_SESS_ID)
81 #define ICE_FLOW_HASH_PPPOE_UDP_ID \
82 (ICE_FLOW_HASH_UDP_PORT | ICE_FLOW_HASH_PPPOE_SESS_ID)
84 /* Protocol header fields within a packet segment. A segment consists of one or
85 * more protocol headers that make up a logical group of protocol headers. Each
86 * logical group of protocol headers encapsulates or is encapsulated using/by
87 * tunneling or encapsulation protocols for network virtualization such as GRE,
90 enum ice_flow_seg_hdr {
91 ICE_FLOW_SEG_HDR_NONE = 0x00000000,
92 ICE_FLOW_SEG_HDR_ETH = 0x00000001,
93 ICE_FLOW_SEG_HDR_VLAN = 0x00000002,
94 ICE_FLOW_SEG_HDR_IPV4 = 0x00000004,
95 ICE_FLOW_SEG_HDR_IPV6 = 0x00000008,
96 ICE_FLOW_SEG_HDR_ARP = 0x00000010,
97 ICE_FLOW_SEG_HDR_ICMP = 0x00000020,
98 ICE_FLOW_SEG_HDR_TCP = 0x00000040,
99 ICE_FLOW_SEG_HDR_UDP = 0x00000080,
100 ICE_FLOW_SEG_HDR_SCTP = 0x00000100,
101 ICE_FLOW_SEG_HDR_GRE = 0x00000200,
102 ICE_FLOW_SEG_HDR_GTPC = 0x00000400,
103 ICE_FLOW_SEG_HDR_GTPC_TEID = 0x00000800,
104 ICE_FLOW_SEG_HDR_GTPU_IP = 0x00001000,
105 ICE_FLOW_SEG_HDR_GTPU_EH = 0x00002000,
106 ICE_FLOW_SEG_HDR_GTPU_DWN = 0x00004000,
107 ICE_FLOW_SEG_HDR_GTPU_UP = 0x00008000,
108 ICE_FLOW_SEG_HDR_PPPOE = 0x00010000,
111 /* These segements all have the same PTYPES, but are otherwise distinguished by
112 * the value of the gtp_eh_pdu and gtp_eh_pdu_link flags:
114 * gtp_eh_pdu gtp_eh_pdu_link
115 * ICE_FLOW_SEG_HDR_GTPU_IP 0 0
116 * ICE_FLOW_SEG_HDR_GTPU_EH 1 don't care
117 * ICE_FLOW_SEG_HDR_GTPU_DWN 1 0
118 * ICE_FLOW_SEG_HDR_GTPU_UP 1 1
120 #define ICE_FLOW_SEG_HDR_GTPU (ICE_FLOW_SEG_HDR_GTPU_IP | \
121 ICE_FLOW_SEG_HDR_GTPU_DWN | \
122 ICE_FLOW_SEG_HDR_GTPU_UP)
124 enum ice_flow_field {
126 ICE_FLOW_FIELD_IDX_ETH_DA,
127 ICE_FLOW_FIELD_IDX_ETH_SA,
128 ICE_FLOW_FIELD_IDX_S_VLAN,
129 ICE_FLOW_FIELD_IDX_C_VLAN,
130 ICE_FLOW_FIELD_IDX_ETH_TYPE,
132 ICE_FLOW_FIELD_IDX_IPV4_DSCP,
133 ICE_FLOW_FIELD_IDX_IPV6_DSCP,
134 ICE_FLOW_FIELD_IDX_IPV4_TTL,
135 ICE_FLOW_FIELD_IDX_IPV4_PROT,
136 ICE_FLOW_FIELD_IDX_IPV6_TTL,
137 ICE_FLOW_FIELD_IDX_IPV6_PROT,
138 ICE_FLOW_FIELD_IDX_IPV4_SA,
139 ICE_FLOW_FIELD_IDX_IPV4_DA,
140 ICE_FLOW_FIELD_IDX_IPV6_SA,
141 ICE_FLOW_FIELD_IDX_IPV6_DA,
143 ICE_FLOW_FIELD_IDX_TCP_SRC_PORT,
144 ICE_FLOW_FIELD_IDX_TCP_DST_PORT,
145 ICE_FLOW_FIELD_IDX_UDP_SRC_PORT,
146 ICE_FLOW_FIELD_IDX_UDP_DST_PORT,
147 ICE_FLOW_FIELD_IDX_SCTP_SRC_PORT,
148 ICE_FLOW_FIELD_IDX_SCTP_DST_PORT,
149 ICE_FLOW_FIELD_IDX_TCP_FLAGS,
151 ICE_FLOW_FIELD_IDX_ARP_SIP,
152 ICE_FLOW_FIELD_IDX_ARP_DIP,
153 ICE_FLOW_FIELD_IDX_ARP_SHA,
154 ICE_FLOW_FIELD_IDX_ARP_DHA,
155 ICE_FLOW_FIELD_IDX_ARP_OP,
157 ICE_FLOW_FIELD_IDX_ICMP_TYPE,
158 ICE_FLOW_FIELD_IDX_ICMP_CODE,
160 ICE_FLOW_FIELD_IDX_GRE_KEYID,
162 ICE_FLOW_FIELD_IDX_GTPC_TEID,
164 ICE_FLOW_FIELD_IDX_GTPU_IP_TEID,
166 ICE_FLOW_FIELD_IDX_GTPU_EH_TEID,
167 ICE_FLOW_FIELD_IDX_GTPU_EH_QFI,
169 ICE_FLOW_FIELD_IDX_GTPU_UP_TEID,
171 ICE_FLOW_FIELD_IDX_GTPU_DWN_TEID,
173 ICE_FLOW_FIELD_IDX_PPPOE_SESS_ID,
174 /* The total number of enums must not exceed 64 */
175 ICE_FLOW_FIELD_IDX_MAX
178 /* Flow headers and fields for AVF support */
179 enum ice_flow_avf_hdr_field {
180 /* Values 0 - 28 are reserved for future use */
181 ICE_AVF_FLOW_FIELD_INVALID = 0,
182 ICE_AVF_FLOW_FIELD_UNICAST_IPV4_UDP = 29,
183 ICE_AVF_FLOW_FIELD_MULTICAST_IPV4_UDP,
184 ICE_AVF_FLOW_FIELD_IPV4_UDP,
185 ICE_AVF_FLOW_FIELD_IPV4_TCP_SYN_NO_ACK,
186 ICE_AVF_FLOW_FIELD_IPV4_TCP,
187 ICE_AVF_FLOW_FIELD_IPV4_SCTP,
188 ICE_AVF_FLOW_FIELD_IPV4_OTHER,
189 ICE_AVF_FLOW_FIELD_FRAG_IPV4,
190 /* Values 37-38 are reserved */
191 ICE_AVF_FLOW_FIELD_UNICAST_IPV6_UDP = 39,
192 ICE_AVF_FLOW_FIELD_MULTICAST_IPV6_UDP,
193 ICE_AVF_FLOW_FIELD_IPV6_UDP,
194 ICE_AVF_FLOW_FIELD_IPV6_TCP_SYN_NO_ACK,
195 ICE_AVF_FLOW_FIELD_IPV6_TCP,
196 ICE_AVF_FLOW_FIELD_IPV6_SCTP,
197 ICE_AVF_FLOW_FIELD_IPV6_OTHER,
198 ICE_AVF_FLOW_FIELD_FRAG_IPV6,
199 ICE_AVF_FLOW_FIELD_RSVD47,
200 ICE_AVF_FLOW_FIELD_FCOE_OX,
201 ICE_AVF_FLOW_FIELD_FCOE_RX,
202 ICE_AVF_FLOW_FIELD_FCOE_OTHER,
203 /* Values 51-62 are reserved */
204 ICE_AVF_FLOW_FIELD_L2_PAYLOAD = 63,
205 ICE_AVF_FLOW_FIELD_MAX
208 /* Supported RSS offloads This macro is defined to support
209 * VIRTCHNL_OP_GET_RSS_HENA_CAPS ops. PF driver sends the RSS hardware
210 * capabilities to the caller of this ops.
212 #define ICE_DEFAULT_RSS_HENA ( \
213 BIT_ULL(ICE_AVF_FLOW_FIELD_IPV4_UDP) | \
214 BIT_ULL(ICE_AVF_FLOW_FIELD_IPV4_SCTP) | \
215 BIT_ULL(ICE_AVF_FLOW_FIELD_IPV4_TCP) | \
216 BIT_ULL(ICE_AVF_FLOW_FIELD_IPV4_OTHER) | \
217 BIT_ULL(ICE_AVF_FLOW_FIELD_FRAG_IPV4) | \
218 BIT_ULL(ICE_AVF_FLOW_FIELD_IPV6_UDP) | \
219 BIT_ULL(ICE_AVF_FLOW_FIELD_IPV6_TCP) | \
220 BIT_ULL(ICE_AVF_FLOW_FIELD_IPV6_SCTP) | \
221 BIT_ULL(ICE_AVF_FLOW_FIELD_IPV6_OTHER) | \
222 BIT_ULL(ICE_AVF_FLOW_FIELD_FRAG_IPV6) | \
223 BIT_ULL(ICE_AVF_FLOW_FIELD_IPV4_TCP_SYN_NO_ACK) | \
224 BIT_ULL(ICE_AVF_FLOW_FIELD_UNICAST_IPV4_UDP) | \
225 BIT_ULL(ICE_AVF_FLOW_FIELD_MULTICAST_IPV4_UDP) | \
226 BIT_ULL(ICE_AVF_FLOW_FIELD_IPV6_TCP_SYN_NO_ACK) | \
227 BIT_ULL(ICE_AVF_FLOW_FIELD_UNICAST_IPV6_UDP) | \
228 BIT_ULL(ICE_AVF_FLOW_FIELD_MULTICAST_IPV6_UDP))
231 ICE_FLOW_DIR_UNDEFINED = 0,
234 ICE_FLOW_TX_RX = ICE_FLOW_RX | ICE_FLOW_TX
237 enum ice_flow_priority {
239 ICE_FLOW_PRIO_NORMAL,
243 #define ICE_FLOW_SEG_MAX 2
244 #define ICE_FLOW_SEG_RAW_FLD_MAX 2
245 #define ICE_FLOW_PROFILE_MAX 1024
246 #define ICE_FLOW_SW_FIELD_VECTOR_MAX 48
247 #define ICE_FLOW_ACL_FIELD_VECTOR_MAX 32
248 #define ICE_FLOW_FV_EXTRACT_SZ 2
250 #define ICE_FLOW_SET_HDRS(seg, val) ((seg)->hdrs |= (u32)(val))
252 struct ice_flow_seg_xtrct {
253 u8 prot_id; /* Protocol ID of extracted header field */
254 u16 off; /* Starting offset of the field in header in bytes */
255 u8 idx; /* Index of FV entry used */
256 u8 disp; /* Displacement of field in bits fr. FV entry's start */
257 u16 mask; /* Mask for field */
260 enum ice_flow_fld_match_type {
261 ICE_FLOW_FLD_TYPE_REG, /* Value, mask */
262 ICE_FLOW_FLD_TYPE_RANGE, /* Value, mask, last (upper bound) */
263 ICE_FLOW_FLD_TYPE_PREFIX, /* IP address, prefix, size of prefix */
264 ICE_FLOW_FLD_TYPE_SIZE, /* Value, mask, size of match */
267 struct ice_flow_fld_loc {
268 /* Describe offsets of field information relative to the beginning of
269 * input buffer provided when adding flow entries.
271 u16 val; /* Offset where the value is located */
272 u16 mask; /* Offset where the mask/prefix value is located */
273 u16 last; /* Length or offset where the upper value is located */
276 struct ice_flow_fld_info {
277 enum ice_flow_fld_match_type type;
278 /* Location where to retrieve data from an input buffer */
279 struct ice_flow_fld_loc src;
280 /* Location where to put the data into the final entry buffer */
281 struct ice_flow_fld_loc entry;
282 struct ice_flow_seg_xtrct xtrct;
285 struct ice_flow_seg_fld_raw {
286 struct ice_flow_fld_info info;
287 u16 off; /* Offset from the start of the segment */
290 struct ice_flow_seg_info {
291 u32 hdrs; /* Bitmask indicating protocol headers present */
292 u64 match; /* Bitmask indicating header fields to be matched */
293 u64 range; /* Bitmask indicating header fields matched as ranges */
295 struct ice_flow_fld_info fields[ICE_FLOW_FIELD_IDX_MAX];
297 u8 raws_cnt; /* Number of raw fields to be matched */
298 struct ice_flow_seg_fld_raw raws[ICE_FLOW_SEG_RAW_FLD_MAX];
301 /* This structure describes a flow entry, and is tracked only in this file */
302 struct ice_flow_entry {
303 struct LIST_ENTRY_TYPE l_entry;
306 struct ice_flow_prof *prof;
308 struct ice_flow_action *acts;
309 /* Flow entry's content */
311 enum ice_flow_priority priority;
317 #define ICE_FLOW_ENTRY_HNDL(e) ((unsigned long)e)
318 #define ICE_FLOW_ENTRY_PTR(h) ((struct ice_flow_entry *)(h))
320 struct ice_flow_prof {
321 struct LIST_ENTRY_TYPE l_entry;
324 enum ice_flow_dir dir;
328 /* Keep track of flow entries associated with this flow profile */
329 struct ice_lock entries_lock;
330 struct LIST_HEAD_TYPE entries;
332 struct ice_flow_seg_info segs[ICE_FLOW_SEG_MAX];
334 /* software VSI handles referenced by this flow profile */
335 ice_declare_bitmap(vsis, ICE_MAX_VSI);
338 /* struct sw_recipe */
341 /* Symmetric Hash for RSS */
345 /* Default actions */
346 struct ice_flow_action *acts;
350 struct LIST_ENTRY_TYPE l_entry;
351 /* bitmap of VSIs added to the RSS entry */
352 ice_declare_bitmap(vsis, ICE_MAX_VSI);
358 enum ice_flow_action_type {
362 ICE_FLOW_ACT_CNTR_PKT,
363 ICE_FLOW_ACT_FWD_VSI,
364 ICE_FLOW_ACT_FWD_VSI_LIST, /* Should be abstracted away */
365 ICE_FLOW_ACT_FWD_QUEUE, /* Can Queues be abstracted away? */
366 ICE_FLOW_ACT_FWD_QUEUE_GROUP, /* Can Queues be abstracted away? */
370 ICE_FLOW_ACT_CNTR_BYTES,
371 ICE_FLOW_ACT_CNTR_PKT_BYTES,
372 ICE_FLOW_ACT_GENERIC_0,
373 ICE_FLOW_ACT_GENERIC_1,
374 ICE_FLOW_ACT_GENERIC_2,
375 ICE_FLOW_ACT_GENERIC_3,
376 ICE_FLOW_ACT_GENERIC_4,
377 ICE_FLOW_ACT_RPT_FLOW_ID,
378 ICE_FLOW_ACT_BUILD_PROF_IDX,
381 struct ice_flow_action {
382 enum ice_flow_action_type type;
389 ice_flow_find_prof(struct ice_hw *hw, enum ice_block blk, enum ice_flow_dir dir,
390 struct ice_flow_seg_info *segs, u8 segs_cnt);
392 ice_flow_add_prof(struct ice_hw *hw, enum ice_block blk, enum ice_flow_dir dir,
393 u64 prof_id, struct ice_flow_seg_info *segs, u8 segs_cnt,
394 struct ice_flow_action *acts, u8 acts_cnt,
395 struct ice_flow_prof **prof);
397 ice_flow_rem_prof(struct ice_hw *hw, enum ice_block blk, u64 prof_id);
399 ice_flow_assoc_vsig_vsi(struct ice_hw *hw, enum ice_block blk, u16 vsi_handle,
402 ice_flow_get_hw_prof(struct ice_hw *hw, enum ice_block blk, u64 prof_id,
405 u64 ice_flow_find_entry(struct ice_hw *hw, enum ice_block blk, u64 entry_id);
407 ice_flow_add_entry(struct ice_hw *hw, enum ice_block blk, u64 prof_id,
408 u64 entry_id, u16 vsi, enum ice_flow_priority prio,
409 void *data, struct ice_flow_action *acts, u8 acts_cnt,
411 enum ice_status ice_flow_rem_entry(struct ice_hw *hw, u64 entry_h);
413 ice_flow_set_fld(struct ice_flow_seg_info *seg, enum ice_flow_field fld,
414 u16 val_loc, u16 mask_loc, u16 last_loc, bool range);
416 ice_flow_set_fld_prefix(struct ice_flow_seg_info *seg, enum ice_flow_field fld,
417 u16 val_loc, u16 prefix_loc, u8 prefix_sz);
419 ice_flow_add_fld_raw(struct ice_flow_seg_info *seg, u16 off, u8 len,
420 u16 val_loc, u16 mask_loc);
421 void ice_rem_vsi_rss_list(struct ice_hw *hw, u16 vsi_handle);
422 enum ice_status ice_replay_rss_cfg(struct ice_hw *hw, u16 vsi_handle);
424 ice_add_avf_rss_cfg(struct ice_hw *hw, u16 vsi_handle, u64 hashed_flds);
425 enum ice_status ice_rem_vsi_rss_cfg(struct ice_hw *hw, u16 vsi_handle);
427 ice_add_rss_cfg(struct ice_hw *hw, u16 vsi_handle, u64 hashed_flds,
428 u32 addl_hdrs, bool symm);
430 ice_rem_rss_cfg(struct ice_hw *hw, u16 vsi_handle, u64 hashed_flds,
432 u64 ice_get_rss_cfg(struct ice_hw *hw, u16 vsi_handle, u32 hdrs);
433 #endif /* _ICE_FLOW_H_ */