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