1 /* SPDX-License-Identifier: BSD-3-Clause */ 2 /* Copyright (c) 2023, 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 #ifndef _ICE_FLOW_H_ 34 #define _ICE_FLOW_H_ 35 36 #include "ice_flex_type.h" 37 38 #define ICE_IPV4_MAKE_PREFIX_MASK(prefix) ((u32)(~0) << (32 - (prefix))) 39 #define ICE_FLOW_PROF_ID_INVAL 0xfffffffffffffffful 40 #define ICE_FLOW_PROF_ID_BYPASS 0 41 #define ICE_FLOW_PROF_ID_DEFAULT 1 42 #define ICE_FLOW_ENTRY_HANDLE_INVAL 0 43 #define ICE_FLOW_VSI_INVAL 0xffff 44 #define ICE_FLOW_FLD_OFF_INVAL 0xffff 45 46 /* Generate flow hash field from flow field type(s) */ 47 #define ICE_FLOW_HASH_IPV4 \ 48 (BIT_ULL(ICE_FLOW_FIELD_IDX_IPV4_SA) | \ 49 BIT_ULL(ICE_FLOW_FIELD_IDX_IPV4_DA)) 50 #define ICE_FLOW_HASH_IPV6 \ 51 (BIT_ULL(ICE_FLOW_FIELD_IDX_IPV6_SA) | \ 52 BIT_ULL(ICE_FLOW_FIELD_IDX_IPV6_DA)) 53 #define ICE_FLOW_HASH_TCP_PORT \ 54 (BIT_ULL(ICE_FLOW_FIELD_IDX_TCP_SRC_PORT) | \ 55 BIT_ULL(ICE_FLOW_FIELD_IDX_TCP_DST_PORT)) 56 #define ICE_FLOW_HASH_UDP_PORT \ 57 (BIT_ULL(ICE_FLOW_FIELD_IDX_UDP_SRC_PORT) | \ 58 BIT_ULL(ICE_FLOW_FIELD_IDX_UDP_DST_PORT)) 59 #define ICE_FLOW_HASH_SCTP_PORT \ 60 (BIT_ULL(ICE_FLOW_FIELD_IDX_SCTP_SRC_PORT) | \ 61 BIT_ULL(ICE_FLOW_FIELD_IDX_SCTP_DST_PORT)) 62 63 #define ICE_HASH_INVALID 0 64 #define ICE_HASH_TCP_IPV4 (ICE_FLOW_HASH_IPV4 | ICE_FLOW_HASH_TCP_PORT) 65 #define ICE_HASH_TCP_IPV6 (ICE_FLOW_HASH_IPV6 | ICE_FLOW_HASH_TCP_PORT) 66 #define ICE_HASH_UDP_IPV4 (ICE_FLOW_HASH_IPV4 | ICE_FLOW_HASH_UDP_PORT) 67 #define ICE_HASH_UDP_IPV6 (ICE_FLOW_HASH_IPV6 | ICE_FLOW_HASH_UDP_PORT) 68 #define ICE_HASH_SCTP_IPV4 (ICE_FLOW_HASH_IPV4 | ICE_FLOW_HASH_SCTP_PORT) 69 #define ICE_HASH_SCTP_IPV6 (ICE_FLOW_HASH_IPV6 | ICE_FLOW_HASH_SCTP_PORT) 70 71 /* Protocol header fields within a packet segment. A segment consists of one or 72 * more protocol headers that make up a logical group of protocol headers. Each 73 * logical group of protocol headers encapsulates or is encapsulated using/by 74 * tunneling or encapsulation protocols for network virtualization such as GRE, 75 * VxLAN, etc. 76 */ 77 enum ice_flow_seg_hdr { 78 ICE_FLOW_SEG_HDR_NONE = 0x00000000, 79 ICE_FLOW_SEG_HDR_ETH = 0x00000001, 80 ICE_FLOW_SEG_HDR_VLAN = 0x00000002, 81 ICE_FLOW_SEG_HDR_IPV4 = 0x00000004, 82 ICE_FLOW_SEG_HDR_IPV6 = 0x00000008, 83 ICE_FLOW_SEG_HDR_ARP = 0x00000010, 84 ICE_FLOW_SEG_HDR_ICMP = 0x00000020, 85 ICE_FLOW_SEG_HDR_TCP = 0x00000040, 86 ICE_FLOW_SEG_HDR_UDP = 0x00000080, 87 ICE_FLOW_SEG_HDR_SCTP = 0x00000100, 88 ICE_FLOW_SEG_HDR_GRE = 0x00000200, 89 /* The following is an additive bit for ICE_FLOW_SEG_HDR_IPV4 and 90 * ICE_FLOW_SEG_HDR_IPV6. 91 */ 92 ICE_FLOW_SEG_HDR_IPV_FRAG = 0x40000000, 93 ICE_FLOW_SEG_HDR_IPV_OTHER = 0x80000000, 94 }; 95 96 enum ice_flow_field { 97 /* L2 */ 98 ICE_FLOW_FIELD_IDX_ETH_DA, 99 ICE_FLOW_FIELD_IDX_ETH_SA, 100 ICE_FLOW_FIELD_IDX_S_VLAN, 101 ICE_FLOW_FIELD_IDX_C_VLAN, 102 ICE_FLOW_FIELD_IDX_ETH_TYPE, 103 /* L3 */ 104 ICE_FLOW_FIELD_IDX_IPV4_DSCP, 105 ICE_FLOW_FIELD_IDX_IPV6_DSCP, 106 ICE_FLOW_FIELD_IDX_IPV4_TTL, 107 ICE_FLOW_FIELD_IDX_IPV4_PROT, 108 ICE_FLOW_FIELD_IDX_IPV6_TTL, 109 ICE_FLOW_FIELD_IDX_IPV6_PROT, 110 ICE_FLOW_FIELD_IDX_IPV4_SA, 111 ICE_FLOW_FIELD_IDX_IPV4_DA, 112 ICE_FLOW_FIELD_IDX_IPV6_SA, 113 ICE_FLOW_FIELD_IDX_IPV6_DA, 114 /* L4 */ 115 ICE_FLOW_FIELD_IDX_TCP_SRC_PORT, 116 ICE_FLOW_FIELD_IDX_TCP_DST_PORT, 117 ICE_FLOW_FIELD_IDX_UDP_SRC_PORT, 118 ICE_FLOW_FIELD_IDX_UDP_DST_PORT, 119 ICE_FLOW_FIELD_IDX_SCTP_SRC_PORT, 120 ICE_FLOW_FIELD_IDX_SCTP_DST_PORT, 121 ICE_FLOW_FIELD_IDX_TCP_FLAGS, 122 /* ARP */ 123 ICE_FLOW_FIELD_IDX_ARP_SIP, 124 ICE_FLOW_FIELD_IDX_ARP_DIP, 125 ICE_FLOW_FIELD_IDX_ARP_SHA, 126 ICE_FLOW_FIELD_IDX_ARP_DHA, 127 ICE_FLOW_FIELD_IDX_ARP_OP, 128 /* ICMP */ 129 ICE_FLOW_FIELD_IDX_ICMP_TYPE, 130 ICE_FLOW_FIELD_IDX_ICMP_CODE, 131 /* GRE */ 132 ICE_FLOW_FIELD_IDX_GRE_KEYID, 133 /* The total number of enums must not exceed 64 */ 134 ICE_FLOW_FIELD_IDX_MAX 135 }; 136 137 /* Flow headers and fields for AVF support */ 138 enum ice_flow_avf_hdr_field { 139 /* Values 0 - 28 are reserved for future use */ 140 ICE_AVF_FLOW_FIELD_INVALID = 0, 141 ICE_AVF_FLOW_FIELD_UNICAST_IPV4_UDP = 29, 142 ICE_AVF_FLOW_FIELD_MULTICAST_IPV4_UDP, 143 ICE_AVF_FLOW_FIELD_IPV4_UDP, 144 ICE_AVF_FLOW_FIELD_IPV4_TCP_SYN_NO_ACK, 145 ICE_AVF_FLOW_FIELD_IPV4_TCP, 146 ICE_AVF_FLOW_FIELD_IPV4_SCTP, 147 ICE_AVF_FLOW_FIELD_IPV4_OTHER, 148 ICE_AVF_FLOW_FIELD_FRAG_IPV4, 149 /* Values 37-38 are reserved */ 150 ICE_AVF_FLOW_FIELD_UNICAST_IPV6_UDP = 39, 151 ICE_AVF_FLOW_FIELD_MULTICAST_IPV6_UDP, 152 ICE_AVF_FLOW_FIELD_IPV6_UDP, 153 ICE_AVF_FLOW_FIELD_IPV6_TCP_SYN_NO_ACK, 154 ICE_AVF_FLOW_FIELD_IPV6_TCP, 155 ICE_AVF_FLOW_FIELD_IPV6_SCTP, 156 ICE_AVF_FLOW_FIELD_IPV6_OTHER, 157 ICE_AVF_FLOW_FIELD_FRAG_IPV6, 158 ICE_AVF_FLOW_FIELD_RSVD47, 159 ICE_AVF_FLOW_FIELD_FCOE_OX, 160 ICE_AVF_FLOW_FIELD_FCOE_RX, 161 ICE_AVF_FLOW_FIELD_FCOE_OTHER, 162 /* Values 51-62 are reserved */ 163 ICE_AVF_FLOW_FIELD_L2_PAYLOAD = 63, 164 ICE_AVF_FLOW_FIELD_MAX 165 }; 166 167 /* Supported RSS offloads This macro is defined to support 168 * VIRTCHNL_OP_GET_RSS_HENA_CAPS ops. PF driver sends the RSS hardware 169 * capabilities to the caller of this ops. 170 */ 171 #define ICE_DEFAULT_RSS_HENA ( \ 172 BIT_ULL(ICE_AVF_FLOW_FIELD_IPV4_UDP) | \ 173 BIT_ULL(ICE_AVF_FLOW_FIELD_IPV4_SCTP) | \ 174 BIT_ULL(ICE_AVF_FLOW_FIELD_IPV4_TCP) | \ 175 BIT_ULL(ICE_AVF_FLOW_FIELD_IPV4_OTHER) | \ 176 BIT_ULL(ICE_AVF_FLOW_FIELD_FRAG_IPV4) | \ 177 BIT_ULL(ICE_AVF_FLOW_FIELD_IPV6_UDP) | \ 178 BIT_ULL(ICE_AVF_FLOW_FIELD_IPV6_TCP) | \ 179 BIT_ULL(ICE_AVF_FLOW_FIELD_IPV6_SCTP) | \ 180 BIT_ULL(ICE_AVF_FLOW_FIELD_IPV6_OTHER) | \ 181 BIT_ULL(ICE_AVF_FLOW_FIELD_FRAG_IPV6) | \ 182 BIT_ULL(ICE_AVF_FLOW_FIELD_IPV4_TCP_SYN_NO_ACK) | \ 183 BIT_ULL(ICE_AVF_FLOW_FIELD_UNICAST_IPV4_UDP) | \ 184 BIT_ULL(ICE_AVF_FLOW_FIELD_MULTICAST_IPV4_UDP) | \ 185 BIT_ULL(ICE_AVF_FLOW_FIELD_IPV6_TCP_SYN_NO_ACK) | \ 186 BIT_ULL(ICE_AVF_FLOW_FIELD_UNICAST_IPV6_UDP) | \ 187 BIT_ULL(ICE_AVF_FLOW_FIELD_MULTICAST_IPV6_UDP)) 188 189 enum ice_rss_cfg_hdr_type { 190 ICE_RSS_OUTER_HEADERS, /* take outer headers as inputset. */ 191 ICE_RSS_INNER_HEADERS, /* take inner headers as inputset. */ 192 /* take inner headers as inputset for packet with outer ipv4. */ 193 ICE_RSS_INNER_HEADERS_W_OUTER_IPV4, 194 /* take inner headers as inputset for packet with outer ipv6. */ 195 ICE_RSS_INNER_HEADERS_W_OUTER_IPV6, 196 /* take outer headers first then inner headers as inputset */ 197 /* take inner as inputset for GTPoGRE with outer ipv4 + gre. */ 198 ICE_RSS_INNER_HEADERS_W_OUTER_IPV4_GRE, 199 /* take inner as inputset for GTPoGRE with outer ipv6 + gre. */ 200 ICE_RSS_INNER_HEADERS_W_OUTER_IPV6_GRE, 201 ICE_RSS_ANY_HEADERS 202 }; 203 204 struct ice_rss_hash_cfg { 205 u32 addl_hdrs; /* protocol header fields */ 206 u64 hash_flds; /* hash bit field (ICE_FLOW_HASH_*) to configure */ 207 enum ice_rss_cfg_hdr_type hdr_type; /* to specify inner or outer */ 208 bool symm; /* symmetric or asymmetric hash */ 209 }; 210 211 enum ice_flow_dir { 212 ICE_FLOW_DIR_UNDEFINED = 0, 213 ICE_FLOW_TX = 0x01, 214 ICE_FLOW_RX = 0x02, 215 ICE_FLOW_TX_RX = ICE_FLOW_RX | ICE_FLOW_TX 216 }; 217 218 enum ice_flow_priority { 219 ICE_FLOW_PRIO_LOW, 220 ICE_FLOW_PRIO_NORMAL, 221 ICE_FLOW_PRIO_HIGH 222 }; 223 224 #define ICE_FLOW_SEG_SINGLE 1 225 #define ICE_FLOW_SEG_MAX 2 226 #define ICE_FLOW_PROFILE_MAX 1024 227 #define ICE_FLOW_ACL_FIELD_VECTOR_MAX 32 228 #define ICE_FLOW_FV_EXTRACT_SZ 2 229 230 #define ICE_FLOW_SET_HDRS(seg, val) ((seg)->hdrs |= (u32)(val)) 231 232 struct ice_flow_seg_xtrct { 233 u8 prot_id; /* Protocol ID of extracted header field */ 234 u16 off; /* Starting offset of the field in header in bytes */ 235 u8 idx; /* Index of FV entry used */ 236 u8 disp; /* Displacement of field in bits fr. FV entry's start */ 237 }; 238 239 enum ice_flow_fld_match_type { 240 ICE_FLOW_FLD_TYPE_REG, /* Value, mask */ 241 ICE_FLOW_FLD_TYPE_RANGE, /* Value, mask, last (upper bound) */ 242 ICE_FLOW_FLD_TYPE_PREFIX, /* IP address, prefix, size of prefix */ 243 ICE_FLOW_FLD_TYPE_SIZE, /* Value, mask, size of match */ 244 }; 245 246 struct ice_flow_fld_loc { 247 /* Describe offsets of field information relative to the beginning of 248 * input buffer provided when adding flow entries. 249 */ 250 u16 val; /* Offset where the value is located */ 251 u16 mask; /* Offset where the mask/prefix value is located */ 252 u16 last; /* Length or offset where the upper value is located */ 253 }; 254 255 struct ice_flow_fld_info { 256 enum ice_flow_fld_match_type type; 257 /* Location where to retrieve data from an input buffer */ 258 struct ice_flow_fld_loc src; 259 /* Location where to put the data into the final entry buffer */ 260 struct ice_flow_fld_loc entry; 261 struct ice_flow_seg_xtrct xtrct; 262 }; 263 264 struct ice_flow_seg_info { 265 u32 hdrs; /* Bitmask indicating protocol headers present */ 266 u64 match; /* Bitmask indicating header fields to be matched */ 267 u64 range; /* Bitmask indicating header fields matched as ranges */ 268 269 struct ice_flow_fld_info fields[ICE_FLOW_FIELD_IDX_MAX]; 270 }; 271 272 #define ICE_FLOW_ENTRY_HNDL(e) ((u64)e) 273 274 struct ice_flow_prof { 275 struct LIST_ENTRY_TYPE l_entry; 276 277 u64 id; 278 enum ice_flow_dir dir; 279 u8 segs_cnt; 280 281 struct ice_flow_seg_info segs[ICE_FLOW_SEG_MAX]; 282 283 /* software VSI handles referenced by this flow profile */ 284 ice_declare_bitmap(vsis, ICE_MAX_VSI); 285 286 union { 287 /* struct sw_recipe */ 288 bool symm; /* Symmetric Hash for RSS */ 289 } cfg; 290 }; 291 292 struct ice_rss_cfg { 293 struct LIST_ENTRY_TYPE l_entry; 294 /* bitmap of VSIs added to the RSS entry */ 295 ice_declare_bitmap(vsis, ICE_MAX_VSI); 296 struct ice_rss_hash_cfg hash; 297 }; 298 299 enum ice_flow_action_type { 300 ICE_FLOW_ACT_NOP, 301 ICE_FLOW_ACT_ALLOW, 302 ICE_FLOW_ACT_DROP, 303 ICE_FLOW_ACT_CNTR_PKT, 304 ICE_FLOW_ACT_FWD_VSI, 305 ICE_FLOW_ACT_FWD_VSI_LIST, /* Should be abstracted away */ 306 ICE_FLOW_ACT_FWD_QUEUE, /* Can Queues be abstracted away? */ 307 ICE_FLOW_ACT_FWD_QUEUE_GROUP, /* Can Queues be abstracted away? */ 308 ICE_FLOW_ACT_PUSH, 309 ICE_FLOW_ACT_POP, 310 ICE_FLOW_ACT_MODIFY, 311 ICE_FLOW_ACT_CNTR_BYTES, 312 ICE_FLOW_ACT_CNTR_PKT_BYTES, 313 ICE_FLOW_ACT_GENERIC_0, 314 ICE_FLOW_ACT_GENERIC_1, 315 ICE_FLOW_ACT_GENERIC_2, 316 ICE_FLOW_ACT_GENERIC_3, 317 ICE_FLOW_ACT_GENERIC_4, 318 ICE_FLOW_ACT_RPT_FLOW_ID, 319 ICE_FLOW_ACT_BUILD_PROF_IDX, 320 }; 321 322 struct ice_flow_action { 323 enum ice_flow_action_type type; 324 union { 325 u32 dummy; 326 } data; 327 }; 328 329 u64 330 ice_flow_find_prof(struct ice_hw *hw, enum ice_block blk, enum ice_flow_dir dir, 331 struct ice_flow_seg_info *segs, u8 segs_cnt); 332 enum ice_status 333 ice_flow_assoc_vsig_vsi(struct ice_hw *hw, enum ice_block blk, u16 vsi_handle, 334 u16 vsig); 335 enum ice_status 336 ice_flow_get_hw_prof(struct ice_hw *hw, enum ice_block blk, u64 prof_id, 337 u8 *hw_prof); 338 void 339 ice_flow_set_fld_prefix(struct ice_flow_seg_info *seg, enum ice_flow_field fld, 340 u16 val_loc, u16 prefix_loc, u8 prefix_sz); 341 void ice_rem_vsi_rss_list(struct ice_hw *hw, u16 vsi_handle); 342 enum ice_status ice_replay_rss_cfg(struct ice_hw *hw, u16 vsi_handle); 343 enum ice_status 344 ice_add_avf_rss_cfg(struct ice_hw *hw, u16 vsi_handle, u64 hashed_flds); 345 enum ice_status ice_rem_vsi_rss_cfg(struct ice_hw *hw, u16 vsi_handle); 346 enum ice_status 347 ice_add_rss_cfg(struct ice_hw *hw, u16 vsi_handle, 348 const struct ice_rss_hash_cfg *cfg); 349 enum ice_status 350 ice_rem_rss_cfg(struct ice_hw *hw, u16 vsi_handle, 351 const struct ice_rss_hash_cfg *cfg); 352 u64 ice_get_rss_cfg(struct ice_hw *hw, u16 vsi_handle, u32 hdrs); 353 #endif /* _ICE_FLOW_H_ */ 354