1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2001-2019
8 #include "ice_flex_type.h"
10 #define ICE_IPV4_MAKE_PREFIX_MASK(prefix) ((u32)(~0) << (32 - (prefix)))
11 #define ICE_FLOW_PROF_ID_INVAL 0xfffffffffffffffful
12 #define ICE_FLOW_PROF_ID_BYPASS 0
13 #define ICE_FLOW_PROF_ID_DEFAULT 1
14 #define ICE_FLOW_ENTRY_HANDLE_INVAL 0
15 #define ICE_FLOW_VSI_INVAL 0xffff
16 #define ICE_FLOW_FLD_OFF_INVAL 0xffff
18 /* Generate flow hash field from flow field type(s) */
19 #define ICE_FLOW_HASH_ETH \
20 (BIT_ULL(ICE_FLOW_FIELD_IDX_ETH_DA) | \
21 BIT_ULL(ICE_FLOW_FIELD_IDX_ETH_SA))
22 #define ICE_FLOW_HASH_IPV4 \
23 (BIT_ULL(ICE_FLOW_FIELD_IDX_IPV4_SA) | \
24 BIT_ULL(ICE_FLOW_FIELD_IDX_IPV4_DA))
25 #define ICE_FLOW_HASH_IPV6 \
26 (BIT_ULL(ICE_FLOW_FIELD_IDX_IPV6_SA) | \
27 BIT_ULL(ICE_FLOW_FIELD_IDX_IPV6_DA))
28 #define ICE_FLOW_HASH_TCP_PORT \
29 (BIT_ULL(ICE_FLOW_FIELD_IDX_TCP_SRC_PORT) | \
30 BIT_ULL(ICE_FLOW_FIELD_IDX_TCP_DST_PORT))
31 #define ICE_FLOW_HASH_UDP_PORT \
32 (BIT_ULL(ICE_FLOW_FIELD_IDX_UDP_SRC_PORT) | \
33 BIT_ULL(ICE_FLOW_FIELD_IDX_UDP_DST_PORT))
34 #define ICE_FLOW_HASH_SCTP_PORT \
35 (BIT_ULL(ICE_FLOW_FIELD_IDX_SCTP_SRC_PORT) | \
36 BIT_ULL(ICE_FLOW_FIELD_IDX_SCTP_DST_PORT))
38 #define ICE_HASH_INVALID 0
39 #define ICE_HASH_TCP_IPV4 (ICE_FLOW_HASH_IPV4 | ICE_FLOW_HASH_TCP_PORT)
40 #define ICE_HASH_TCP_IPV6 (ICE_FLOW_HASH_IPV6 | ICE_FLOW_HASH_TCP_PORT)
41 #define ICE_HASH_UDP_IPV4 (ICE_FLOW_HASH_IPV4 | ICE_FLOW_HASH_UDP_PORT)
42 #define ICE_HASH_UDP_IPV6 (ICE_FLOW_HASH_IPV6 | ICE_FLOW_HASH_UDP_PORT)
43 #define ICE_HASH_SCTP_IPV4 (ICE_FLOW_HASH_IPV4 | ICE_FLOW_HASH_SCTP_PORT)
44 #define ICE_HASH_SCTP_IPV6 (ICE_FLOW_HASH_IPV6 | ICE_FLOW_HASH_SCTP_PORT)
46 #define ICE_FLOW_HASH_GTP_TEID \
47 (BIT_ULL(ICE_FLOW_FIELD_IDX_GTPC_TEID))
49 #define ICE_FLOW_HASH_GTP_IPV4_TEID \
50 (ICE_FLOW_HASH_IPV4 | ICE_FLOW_HASH_GTP_TEID)
51 #define ICE_FLOW_HASH_GTP_IPV6_TEID \
52 (ICE_FLOW_HASH_IPV6 | ICE_FLOW_HASH_GTP_TEID)
54 #define ICE_FLOW_HASH_GTP_U_TEID \
55 (BIT_ULL(ICE_FLOW_FIELD_IDX_GTPU_IP_TEID))
57 #define ICE_FLOW_HASH_GTP_U_IPV4_TEID \
58 (ICE_FLOW_HASH_IPV4 | ICE_FLOW_HASH_GTP_U_TEID)
59 #define ICE_FLOW_HASH_GTP_U_IPV6_TEID \
60 (ICE_FLOW_HASH_IPV6 | ICE_FLOW_HASH_GTP_U_TEID)
62 #define ICE_FLOW_HASH_GTP_U_EH_TEID \
63 (BIT_ULL(ICE_FLOW_FIELD_IDX_GTPU_EH_TEID))
65 #define ICE_FLOW_HASH_GTP_U_EH_QFI \
66 (BIT_ULL(ICE_FLOW_FIELD_IDX_GTPU_EH_QFI))
68 #define ICE_FLOW_HASH_GTP_U_IPV4_EH \
69 (ICE_FLOW_HASH_IPV4 | ICE_FLOW_HASH_GTP_U_EH_TEID | \
70 ICE_FLOW_HASH_GTP_U_EH_QFI)
71 #define ICE_FLOW_HASH_GTP_U_IPV6_EH \
72 (ICE_FLOW_HASH_IPV6 | ICE_FLOW_HASH_GTP_U_EH_TEID | \
73 ICE_FLOW_HASH_GTP_U_EH_QFI)
75 #define ICE_FLOW_HASH_PPPOE_SESS_ID \
76 (BIT_ULL(ICE_FLOW_FIELD_IDX_PPPOE_SESS_ID))
78 #define ICE_FLOW_HASH_PPPOE_SESS_ID_ETH \
79 (ICE_FLOW_HASH_ETH | ICE_FLOW_HASH_PPPOE_SESS_ID)
80 #define ICE_FLOW_HASH_PPPOE_TCP_ID \
81 (ICE_FLOW_HASH_TCP_PORT | ICE_FLOW_HASH_PPPOE_SESS_ID)
82 #define ICE_FLOW_HASH_PPPOE_UDP_ID \
83 (ICE_FLOW_HASH_UDP_PORT | ICE_FLOW_HASH_PPPOE_SESS_ID)
85 /* Protocol header fields within a packet segment. A segment consists of one or
86 * more protocol headers that make up a logical group of protocol headers. Each
87 * logical group of protocol headers encapsulates or is encapsulated using/by
88 * tunneling or encapsulation protocols for network virtualization such as GRE,
91 enum ice_flow_seg_hdr {
92 ICE_FLOW_SEG_HDR_NONE = 0x00000000,
93 ICE_FLOW_SEG_HDR_ETH = 0x00000001,
94 ICE_FLOW_SEG_HDR_VLAN = 0x00000002,
95 ICE_FLOW_SEG_HDR_IPV4 = 0x00000004,
96 ICE_FLOW_SEG_HDR_IPV6 = 0x00000008,
97 ICE_FLOW_SEG_HDR_ARP = 0x00000010,
98 ICE_FLOW_SEG_HDR_ICMP = 0x00000020,
99 ICE_FLOW_SEG_HDR_TCP = 0x00000040,
100 ICE_FLOW_SEG_HDR_UDP = 0x00000080,
101 ICE_FLOW_SEG_HDR_SCTP = 0x00000100,
102 ICE_FLOW_SEG_HDR_GRE = 0x00000200,
103 ICE_FLOW_SEG_HDR_GTPC = 0x00000400,
104 ICE_FLOW_SEG_HDR_GTPC_TEID = 0x00000800,
105 ICE_FLOW_SEG_HDR_GTPU_IP = 0x00001000,
106 ICE_FLOW_SEG_HDR_GTPU_EH = 0x00002000,
107 ICE_FLOW_SEG_HDR_GTPU_DWN = 0x00004000,
108 ICE_FLOW_SEG_HDR_GTPU_UP = 0x00008000,
109 ICE_FLOW_SEG_HDR_PPPOE = 0x00010000,
112 /* These segements all have the same PTYPES, but are otherwise distinguished by
113 * the value of the gtp_eh_pdu and gtp_eh_pdu_link flags:
115 * gtp_eh_pdu gtp_eh_pdu_link
116 * ICE_FLOW_SEG_HDR_GTPU_IP 0 0
117 * ICE_FLOW_SEG_HDR_GTPU_EH 1 don't care
118 * ICE_FLOW_SEG_HDR_GTPU_DWN 1 0
119 * ICE_FLOW_SEG_HDR_GTPU_UP 1 1
121 #define ICE_FLOW_SEG_HDR_GTPU (ICE_FLOW_SEG_HDR_GTPU_IP | \
122 ICE_FLOW_SEG_HDR_GTPU_DWN | \
123 ICE_FLOW_SEG_HDR_GTPU_UP)
125 enum ice_flow_field {
127 ICE_FLOW_FIELD_IDX_ETH_DA,
128 ICE_FLOW_FIELD_IDX_ETH_SA,
129 ICE_FLOW_FIELD_IDX_S_VLAN,
130 ICE_FLOW_FIELD_IDX_C_VLAN,
131 ICE_FLOW_FIELD_IDX_ETH_TYPE,
133 ICE_FLOW_FIELD_IDX_IPV4_DSCP,
134 ICE_FLOW_FIELD_IDX_IPV6_DSCP,
135 ICE_FLOW_FIELD_IDX_IPV4_TTL,
136 ICE_FLOW_FIELD_IDX_IPV4_PROT,
137 ICE_FLOW_FIELD_IDX_IPV6_TTL,
138 ICE_FLOW_FIELD_IDX_IPV6_PROT,
139 ICE_FLOW_FIELD_IDX_IPV4_SA,
140 ICE_FLOW_FIELD_IDX_IPV4_DA,
141 ICE_FLOW_FIELD_IDX_IPV6_SA,
142 ICE_FLOW_FIELD_IDX_IPV6_DA,
144 ICE_FLOW_FIELD_IDX_TCP_SRC_PORT,
145 ICE_FLOW_FIELD_IDX_TCP_DST_PORT,
146 ICE_FLOW_FIELD_IDX_UDP_SRC_PORT,
147 ICE_FLOW_FIELD_IDX_UDP_DST_PORT,
148 ICE_FLOW_FIELD_IDX_SCTP_SRC_PORT,
149 ICE_FLOW_FIELD_IDX_SCTP_DST_PORT,
150 ICE_FLOW_FIELD_IDX_TCP_FLAGS,
152 ICE_FLOW_FIELD_IDX_ARP_SIP,
153 ICE_FLOW_FIELD_IDX_ARP_DIP,
154 ICE_FLOW_FIELD_IDX_ARP_SHA,
155 ICE_FLOW_FIELD_IDX_ARP_DHA,
156 ICE_FLOW_FIELD_IDX_ARP_OP,
158 ICE_FLOW_FIELD_IDX_ICMP_TYPE,
159 ICE_FLOW_FIELD_IDX_ICMP_CODE,
161 ICE_FLOW_FIELD_IDX_GRE_KEYID,
163 ICE_FLOW_FIELD_IDX_GTPC_TEID,
165 ICE_FLOW_FIELD_IDX_GTPU_IP_TEID,
167 ICE_FLOW_FIELD_IDX_GTPU_EH_TEID,
168 ICE_FLOW_FIELD_IDX_GTPU_EH_QFI,
170 ICE_FLOW_FIELD_IDX_GTPU_UP_TEID,
172 ICE_FLOW_FIELD_IDX_GTPU_DWN_TEID,
174 ICE_FLOW_FIELD_IDX_PPPOE_SESS_ID,
175 /* The total number of enums must not exceed 64 */
176 ICE_FLOW_FIELD_IDX_MAX
179 /* Flow headers and fields for AVF support */
180 enum ice_flow_avf_hdr_field {
181 /* Values 0 - 28 are reserved for future use */
182 ICE_AVF_FLOW_FIELD_INVALID = 0,
183 ICE_AVF_FLOW_FIELD_UNICAST_IPV4_UDP = 29,
184 ICE_AVF_FLOW_FIELD_MULTICAST_IPV4_UDP,
185 ICE_AVF_FLOW_FIELD_IPV4_UDP,
186 ICE_AVF_FLOW_FIELD_IPV4_TCP_SYN_NO_ACK,
187 ICE_AVF_FLOW_FIELD_IPV4_TCP,
188 ICE_AVF_FLOW_FIELD_IPV4_SCTP,
189 ICE_AVF_FLOW_FIELD_IPV4_OTHER,
190 ICE_AVF_FLOW_FIELD_FRAG_IPV4,
191 /* Values 37-38 are reserved */
192 ICE_AVF_FLOW_FIELD_UNICAST_IPV6_UDP = 39,
193 ICE_AVF_FLOW_FIELD_MULTICAST_IPV6_UDP,
194 ICE_AVF_FLOW_FIELD_IPV6_UDP,
195 ICE_AVF_FLOW_FIELD_IPV6_TCP_SYN_NO_ACK,
196 ICE_AVF_FLOW_FIELD_IPV6_TCP,
197 ICE_AVF_FLOW_FIELD_IPV6_SCTP,
198 ICE_AVF_FLOW_FIELD_IPV6_OTHER,
199 ICE_AVF_FLOW_FIELD_FRAG_IPV6,
200 ICE_AVF_FLOW_FIELD_RSVD47,
201 ICE_AVF_FLOW_FIELD_FCOE_OX,
202 ICE_AVF_FLOW_FIELD_FCOE_RX,
203 ICE_AVF_FLOW_FIELD_FCOE_OTHER,
204 /* Values 51-62 are reserved */
205 ICE_AVF_FLOW_FIELD_L2_PAYLOAD = 63,
206 ICE_AVF_FLOW_FIELD_MAX
209 /* Supported RSS offloads This macro is defined to support
210 * VIRTCHNL_OP_GET_RSS_HENA_CAPS ops. PF driver sends the RSS hardware
211 * capabilities to the caller of this ops.
213 #define ICE_DEFAULT_RSS_HENA ( \
214 BIT_ULL(ICE_AVF_FLOW_FIELD_IPV4_UDP) | \
215 BIT_ULL(ICE_AVF_FLOW_FIELD_IPV4_SCTP) | \
216 BIT_ULL(ICE_AVF_FLOW_FIELD_IPV4_TCP) | \
217 BIT_ULL(ICE_AVF_FLOW_FIELD_IPV4_OTHER) | \
218 BIT_ULL(ICE_AVF_FLOW_FIELD_FRAG_IPV4) | \
219 BIT_ULL(ICE_AVF_FLOW_FIELD_IPV6_UDP) | \
220 BIT_ULL(ICE_AVF_FLOW_FIELD_IPV6_TCP) | \
221 BIT_ULL(ICE_AVF_FLOW_FIELD_IPV6_SCTP) | \
222 BIT_ULL(ICE_AVF_FLOW_FIELD_IPV6_OTHER) | \
223 BIT_ULL(ICE_AVF_FLOW_FIELD_FRAG_IPV6) | \
224 BIT_ULL(ICE_AVF_FLOW_FIELD_IPV4_TCP_SYN_NO_ACK) | \
225 BIT_ULL(ICE_AVF_FLOW_FIELD_UNICAST_IPV4_UDP) | \
226 BIT_ULL(ICE_AVF_FLOW_FIELD_MULTICAST_IPV4_UDP) | \
227 BIT_ULL(ICE_AVF_FLOW_FIELD_IPV6_TCP_SYN_NO_ACK) | \
228 BIT_ULL(ICE_AVF_FLOW_FIELD_UNICAST_IPV6_UDP) | \
229 BIT_ULL(ICE_AVF_FLOW_FIELD_MULTICAST_IPV6_UDP))
232 ICE_FLOW_DIR_UNDEFINED = 0,
235 ICE_FLOW_TX_RX = ICE_FLOW_RX | ICE_FLOW_TX
238 enum ice_flow_priority {
240 ICE_FLOW_PRIO_NORMAL,
244 #define ICE_FLOW_SEG_MAX 2
245 #define ICE_FLOW_SEG_RAW_FLD_MAX 2
246 #define ICE_FLOW_PROFILE_MAX 1024
247 #define ICE_FLOW_SW_FIELD_VECTOR_MAX 48
248 #define ICE_FLOW_ACL_FIELD_VECTOR_MAX 32
249 #define ICE_FLOW_FV_EXTRACT_SZ 2
251 #define ICE_FLOW_SET_HDRS(seg, val) ((seg)->hdrs |= (u32)(val))
253 struct ice_flow_seg_xtrct {
254 u8 prot_id; /* Protocol ID of extracted header field */
255 u16 off; /* Starting offset of the field in header in bytes */
256 u8 idx; /* Index of FV entry used */
257 u8 disp; /* Displacement of field in bits fr. FV entry's start */
258 u16 mask; /* Mask for field */
261 enum ice_flow_fld_match_type {
262 ICE_FLOW_FLD_TYPE_REG, /* Value, mask */
263 ICE_FLOW_FLD_TYPE_RANGE, /* Value, mask, last (upper bound) */
264 ICE_FLOW_FLD_TYPE_PREFIX, /* IP address, prefix, size of prefix */
265 ICE_FLOW_FLD_TYPE_SIZE, /* Value, mask, size of match */
268 struct ice_flow_fld_loc {
269 /* Describe offsets of field information relative to the beginning of
270 * input buffer provided when adding flow entries.
272 u16 val; /* Offset where the value is located */
273 u16 mask; /* Offset where the mask/prefix value is located */
274 u16 last; /* Length or offset where the upper value is located */
277 struct ice_flow_fld_info {
278 enum ice_flow_fld_match_type type;
279 /* Location where to retrieve data from an input buffer */
280 struct ice_flow_fld_loc src;
281 /* Location where to put the data into the final entry buffer */
282 struct ice_flow_fld_loc entry;
283 struct ice_flow_seg_xtrct xtrct;
286 struct ice_flow_seg_fld_raw {
287 struct ice_flow_fld_info info;
288 u16 off; /* Offset from the start of the segment */
291 struct ice_flow_seg_info {
292 u32 hdrs; /* Bitmask indicating protocol headers present */
293 u64 match; /* Bitmask indicating header fields to be matched */
294 u64 range; /* Bitmask indicating header fields matched as ranges */
296 struct ice_flow_fld_info fields[ICE_FLOW_FIELD_IDX_MAX];
298 u8 raws_cnt; /* Number of raw fields to be matched */
299 struct ice_flow_seg_fld_raw raws[ICE_FLOW_SEG_RAW_FLD_MAX];
302 /* This structure describes a flow entry, and is tracked only in this file */
303 struct ice_flow_entry {
304 struct LIST_ENTRY_TYPE l_entry;
307 struct ice_flow_prof *prof;
309 struct ice_flow_action *acts;
310 /* Flow entry's content */
312 /* Range buffer (For ACL only) */
313 struct ice_aqc_acl_profile_ranges *range_buf;
314 enum ice_flow_priority priority;
317 /* Entry index in the ACL's scenario */
319 #define ICE_FLOW_ACL_MAX_NUM_ACT 2
323 #define ICE_FLOW_ENTRY_HNDL(e) ((unsigned long)e)
324 #define ICE_FLOW_ENTRY_PTR(h) ((struct ice_flow_entry *)(h))
326 struct ice_flow_prof {
327 struct LIST_ENTRY_TYPE l_entry;
330 enum ice_flow_dir dir;
334 /* Keep track of flow entries associated with this flow profile */
335 struct ice_lock entries_lock;
336 struct LIST_HEAD_TYPE entries;
338 struct ice_flow_seg_info segs[ICE_FLOW_SEG_MAX];
340 /* software VSI handles referenced by this flow profile */
341 ice_declare_bitmap(vsis, ICE_MAX_VSI);
344 /* struct sw_recipe */
345 struct ice_acl_scen *scen;
348 /* Symmetric Hash for RSS */
352 /* Default actions */
353 struct ice_flow_action *acts;
357 struct LIST_ENTRY_TYPE l_entry;
358 /* bitmap of VSIs added to the RSS entry */
359 ice_declare_bitmap(vsis, ICE_MAX_VSI);
365 enum ice_flow_action_type {
369 ICE_FLOW_ACT_CNTR_PKT,
370 ICE_FLOW_ACT_FWD_VSI,
371 ICE_FLOW_ACT_FWD_VSI_LIST, /* Should be abstracted away */
372 ICE_FLOW_ACT_FWD_QUEUE, /* Can Queues be abstracted away? */
373 ICE_FLOW_ACT_FWD_QUEUE_GROUP, /* Can Queues be abstracted away? */
377 ICE_FLOW_ACT_CNTR_BYTES,
378 ICE_FLOW_ACT_CNTR_PKT_BYTES,
379 ICE_FLOW_ACT_GENERIC_0,
380 ICE_FLOW_ACT_GENERIC_1,
381 ICE_FLOW_ACT_GENERIC_2,
382 ICE_FLOW_ACT_GENERIC_3,
383 ICE_FLOW_ACT_GENERIC_4,
384 ICE_FLOW_ACT_RPT_FLOW_ID,
385 ICE_FLOW_ACT_BUILD_PROF_IDX,
388 struct ice_flow_action {
389 enum ice_flow_action_type type;
391 struct ice_acl_act_entry acl_act;
397 ice_flow_find_prof(struct ice_hw *hw, enum ice_block blk, enum ice_flow_dir dir,
398 struct ice_flow_seg_info *segs, u8 segs_cnt);
400 ice_flow_add_prof(struct ice_hw *hw, enum ice_block blk, enum ice_flow_dir dir,
401 u64 prof_id, struct ice_flow_seg_info *segs, u8 segs_cnt,
402 struct ice_flow_action *acts, u8 acts_cnt,
403 struct ice_flow_prof **prof);
405 ice_flow_rem_prof(struct ice_hw *hw, enum ice_block blk, u64 prof_id);
407 ice_flow_assoc_vsig_vsi(struct ice_hw *hw, enum ice_block blk, u16 vsi_handle,
410 ice_flow_get_hw_prof(struct ice_hw *hw, enum ice_block blk, u64 prof_id,
413 u64 ice_flow_find_entry(struct ice_hw *hw, enum ice_block blk, u64 entry_id);
415 ice_flow_add_entry(struct ice_hw *hw, enum ice_block blk, u64 prof_id,
416 u64 entry_id, u16 vsi, enum ice_flow_priority prio,
417 void *data, struct ice_flow_action *acts, u8 acts_cnt,
419 enum ice_status ice_flow_rem_entry(struct ice_hw *hw, enum ice_block blk,
422 ice_flow_set_fld(struct ice_flow_seg_info *seg, enum ice_flow_field fld,
423 u16 val_loc, u16 mask_loc, u16 last_loc, bool range);
425 ice_flow_set_fld_prefix(struct ice_flow_seg_info *seg, enum ice_flow_field fld,
426 u16 val_loc, u16 prefix_loc, u8 prefix_sz);
428 ice_flow_add_fld_raw(struct ice_flow_seg_info *seg, u16 off, u8 len,
429 u16 val_loc, u16 mask_loc);
430 void ice_rem_vsi_rss_list(struct ice_hw *hw, u16 vsi_handle);
431 enum ice_status ice_replay_rss_cfg(struct ice_hw *hw, u16 vsi_handle);
433 ice_add_avf_rss_cfg(struct ice_hw *hw, u16 vsi_handle, u64 hashed_flds);
434 enum ice_status ice_rem_vsi_rss_cfg(struct ice_hw *hw, u16 vsi_handle);
436 ice_add_rss_cfg(struct ice_hw *hw, u16 vsi_handle, u64 hashed_flds,
437 u32 addl_hdrs, bool symm);
439 ice_rem_rss_cfg(struct ice_hw *hw, u16 vsi_handle, u64 hashed_flds,
441 u64 ice_get_rss_cfg(struct ice_hw *hw, u16 vsi_handle, u32 hdrs);
442 #endif /* _ICE_FLOW_H_ */