1/* SPDX-License-Identifier: BSD-3-Clause */ 2/* Copyright (c) 2024, 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 32#ifndef _ICE_PROTOCOL_TYPE_H_ 33#define _ICE_PROTOCOL_TYPE_H_ 34#include "ice_flex_type.h" 35#define ICE_IPV6_ADDR_LENGTH 16 36 37/* Each recipe can match up to 5 different fields. Fields to match can be meta- 38 * data, values extracted from packet headers, or results from other recipes. 39 * One of the 5 fields is reserved for matching the switch ID. So, up to 4 40 * recipes can provide intermediate results to another one through chaining, 41 * e.g. recipes 0, 1, 2, and 3 can provide intermediate results to recipe 4. 42 */ 43#define ICE_NUM_WORDS_RECIPE 4 44 45/* Max recipes that can be chained */ 46#define ICE_MAX_CHAIN_RECIPE 5 47 48/* 1 word reserved for switch ID from allowed 5 words. 49 * So a recipe can have max 4 words. And you can chain 5 such recipes 50 * together. So maximum words that can be programmed for look up is 5 * 4. 51 */ 52#define ICE_MAX_CHAIN_WORDS (ICE_NUM_WORDS_RECIPE * ICE_MAX_CHAIN_RECIPE) 53 54/* Field vector index corresponding to chaining */ 55#define ICE_CHAIN_FV_INDEX_START 47 56 57enum ice_protocol_type { 58 ICE_MAC_OFOS = 0, 59 ICE_MAC_IL, 60 ICE_ETYPE_OL, 61 ICE_ETYPE_IL, 62 ICE_VLAN_OFOS, 63 ICE_IPV4_OFOS, 64 ICE_IPV4_IL, 65 ICE_IPV6_OFOS, 66 ICE_IPV6_IL, 67 ICE_TCP_IL, 68 ICE_UDP_OF, 69 ICE_UDP_ILOS, 70 ICE_SCTP_IL, 71 ICE_VXLAN, 72 ICE_GENEVE, 73 ICE_VXLAN_GPE, 74 ICE_NVGRE, 75 ICE_GTP, 76 ICE_GTP_NO_PAY, 77 ICE_PPPOE, 78 ICE_L2TPV3, 79 ICE_PROTOCOL_LAST 80}; 81 82enum ice_sw_tunnel_type { 83 ICE_NON_TUN = 0, 84 ICE_SW_TUN_AND_NON_TUN, 85 ICE_SW_TUN_VXLAN_GPE, 86 ICE_SW_TUN_GENEVE, /* GENEVE matches only non-VLAN pkts */ 87 ICE_SW_TUN_GENEVE_VLAN, /* GENEVE matches both VLAN and non-VLAN pkts */ 88 ICE_SW_TUN_VXLAN, /* VXLAN matches only non-VLAN pkts */ 89 ICE_SW_TUN_VXLAN_VLAN, /* VXLAN matches both VLAN and non-VLAN pkts */ 90 ICE_SW_TUN_NVGRE, 91 ICE_SW_TUN_UDP, /* This means all "UDP" tunnel types: VXLAN-GPE, VXLAN 92 * and GENEVE 93 */ 94 ICE_SW_TUN_GTPU, 95 ICE_SW_TUN_GTPC, 96 ICE_ALL_TUNNELS /* All tunnel types including NVGRE */ 97}; 98 99/* Decoders for ice_prot_id: 100 * - F: First 101 * - I: Inner 102 * - L: Last 103 * - O: Outer 104 * - S: Single 105 */ 106enum ice_prot_id { 107 ICE_PROT_ID_INVAL = 0, 108 ICE_PROT_MAC_OF_OR_S = 1, 109 ICE_PROT_MAC_O2 = 2, 110 ICE_PROT_MAC_IL = 4, 111 ICE_PROT_MAC_IN_MAC = 7, 112 ICE_PROT_ETYPE_OL = 9, 113 ICE_PROT_ETYPE_IL = 10, 114 ICE_PROT_PAY = 15, 115 ICE_PROT_EVLAN_O = 16, 116 ICE_PROT_VLAN_O = 17, 117 ICE_PROT_VLAN_IF = 18, 118 ICE_PROT_MPLS_OL_MINUS_1 = 27, 119 ICE_PROT_MPLS_OL_OR_OS = 28, 120 ICE_PROT_MPLS_IL = 29, 121 ICE_PROT_IPV4_OF_OR_S = 32, 122 ICE_PROT_IPV4_IL = 33, 123 ICE_PROT_IPV4_IL_IL = 34, 124 ICE_PROT_IPV6_OF_OR_S = 40, 125 ICE_PROT_IPV6_IL = 41, 126 ICE_PROT_IPV6_IL_IL = 42, 127 ICE_PROT_IPV6_NEXT_PROTO = 43, 128 ICE_PROT_IPV6_FRAG = 47, 129 ICE_PROT_TCP_IL = 49, 130 ICE_PROT_UDP_OF = 52, 131 ICE_PROT_UDP_IL_OR_S = 53, 132 ICE_PROT_GRE_OF = 64, 133 ICE_PROT_NSH_F = 84, 134 ICE_PROT_ESP_F = 88, 135 ICE_PROT_ESP_2 = 89, 136 ICE_PROT_SCTP_IL = 96, 137 ICE_PROT_ICMP_IL = 98, 138 ICE_PROT_ICMPV6_IL = 100, 139 ICE_PROT_VRRP_F = 101, 140 ICE_PROT_OSPF = 102, 141 ICE_PROT_ATAOE_OF = 114, 142 ICE_PROT_CTRL_OF = 116, 143 ICE_PROT_LLDP_OF = 117, 144 ICE_PROT_ARP_OF = 118, 145 ICE_PROT_EAPOL_OF = 120, 146 ICE_PROT_META_ID = 255, /* when offset == metaddata */ 147 ICE_PROT_INVALID = 255 /* when offset == ICE_FV_OFFSET_INVAL */ 148}; 149 150#define ICE_VNI_OFFSET 12 /* offset of VNI from ICE_PROT_UDP_OF */ 151 152#define ICE_NAN_OFFSET 511 153#define ICE_MAC_OFOS_HW 1 154#define ICE_MAC_IL_HW 4 155#define ICE_ETYPE_OL_HW 9 156#define ICE_ETYPE_IL_HW 10 157#define ICE_VLAN_OF_HW 16 158#define ICE_VLAN_OL_HW 17 159#define ICE_IPV4_OFOS_HW 32 160#define ICE_IPV4_IL_HW 33 161#define ICE_IPV6_OFOS_HW 40 162#define ICE_IPV6_IL_HW 41 163#define ICE_TCP_IL_HW 49 164#define ICE_UDP_ILOS_HW 53 165#define ICE_SCTP_IL_HW 96 166#define ICE_PPPOE_HW 103 167#define ICE_L2TPV3_HW 104 168 169/* ICE_UDP_OF is used to identify all 3 tunnel types 170 * VXLAN, GENEVE and VXLAN_GPE. To differentiate further 171 * need to use flags from the field vector 172 */ 173#define ICE_UDP_OF_HW 52 /* UDP Tunnels */ 174#define ICE_GRE_OF_HW 64 /* NVGRE */ 175#define ICE_META_DATA_ID_HW 255 /* this is used for tunnel and VLAN type */ 176 177#define ICE_MDID_SIZE 2 178#define ICE_TUN_FLAG_MDID 20 179#define ICE_TUN_FLAG_MDID_OFF(word) \ 180 (ICE_MDID_SIZE * (ICE_TUN_FLAG_MDID + (word))) 181#define ICE_TUN_FLAG_MASK 0xFF 182#define ICE_FROM_NETWORK_FLAG_MASK 0x8 183#define ICE_DIR_FLAG_MASK 0x10 184#define ICE_TUN_FLAG_IN_VLAN_MASK 0x80 /* VLAN inside tunneled header */ 185#define ICE_TUN_FLAG_VLAN_MASK 0x01 186#define ICE_TUN_FLAG_FV_IND 2 187 188#define ICE_VLAN_FLAG_MDID 20 189#define ICE_VLAN_FLAG_MDID_OFF (ICE_MDID_SIZE * ICE_VLAN_FLAG_MDID) 190#define ICE_PKT_FLAGS_0_TO_15_VLAN_FLAGS_MASK 0xD000 191 192#define ICE_PROTOCOL_MAX_ENTRIES 16 193 194/* Mapping of software defined protocol ID to hardware defined protocol ID */ 195struct ice_protocol_entry { 196 enum ice_protocol_type type; 197 u8 protocol_id; 198}; 199 200struct ice_ether_hdr { 201 u8 dst_addr[ETH_ALEN]; 202 u8 src_addr[ETH_ALEN]; 203}; 204 205struct ice_ethtype_hdr { 206 __be16 ethtype_id; 207}; 208 209struct ice_ether_vlan_hdr { 210 u8 dst_addr[ETH_ALEN]; 211 u8 src_addr[ETH_ALEN]; 212 __be32 vlan_id; 213}; 214 215struct ice_vlan_hdr { 216 __be16 type; 217 __be16 vlan; 218}; 219 220struct ice_ipv4_hdr { 221 u8 version; 222 u8 tos; 223 __be16 total_length; 224 __be16 id; 225 __be16 frag_off; 226 u8 time_to_live; 227 u8 protocol; 228 __be16 check; 229 __be32 src_addr; 230 __be32 dst_addr; 231}; 232 233struct ice_le_ver_tc_flow { 234 union { 235 struct { 236 u32 flow_label : 20; 237 u32 tc : 8; 238 u32 version : 4; 239 } fld; 240 u32 val; 241 } u; 242}; 243 244struct ice_ipv6_hdr { 245 __be32 be_ver_tc_flow; 246 __be16 payload_len; 247 u8 next_hdr; 248 u8 hop_limit; 249 u8 src_addr[ICE_IPV6_ADDR_LENGTH]; 250 u8 dst_addr[ICE_IPV6_ADDR_LENGTH]; 251}; 252 253struct ice_sctp_hdr { 254 __be16 src_port; 255 __be16 dst_port; 256 __be32 verification_tag; 257 __be32 check; 258}; 259 260struct ice_l4_hdr { 261 __be16 src_port; 262 __be16 dst_port; 263 __be16 len; 264 __be16 check; 265}; 266 267struct ice_udp_tnl_hdr { 268 __be16 field; 269 __be16 proto_type; 270 __be32 vni; /* only use lower 24-bits */ 271}; 272 273struct ice_udp_gtp_hdr { 274 u8 flags; 275 u8 msg_type; 276 __be16 rsrvd_len; 277 __be32 teid; 278 __be16 rsrvd_seq_nbr; 279 u8 rsrvd_n_pdu_nbr; 280 u8 rsrvd_next_ext; 281 u8 rsvrd_ext_len; 282 u8 pdu_type; 283 u8 qfi; 284 u8 rsvrd; 285}; 286struct ice_pppoe_hdr { 287 u8 rsrvd_ver_type; 288 u8 rsrvd_code; 289 __be16 session_id; 290 __be16 length; 291 __be16 ppp_prot_id; /* control and data only */ 292}; 293 294struct ice_l2tpv3_sess_hdr { 295 __be32 session_id; 296 __be64 cookie; 297}; 298 299struct ice_nvgre { 300 __be16 flags; 301 __be16 protocol; 302 __be32 tni_flow; 303}; 304 305union ice_prot_hdr { 306 struct ice_ether_hdr eth_hdr; 307 struct ice_ethtype_hdr ethertype; 308 struct ice_vlan_hdr vlan_hdr; 309 struct ice_ipv4_hdr ipv4_hdr; 310 struct ice_ipv6_hdr ipv6_hdr; 311 struct ice_l4_hdr l4_hdr; 312 struct ice_sctp_hdr sctp_hdr; 313 struct ice_udp_tnl_hdr tnl_hdr; 314 struct ice_nvgre nvgre_hdr; 315 struct ice_udp_gtp_hdr gtp_hdr; 316 struct ice_pppoe_hdr pppoe_hdr; 317 struct ice_l2tpv3_sess_hdr l2tpv3_sess_hdr; 318}; 319 320/* This is mapping table entry that maps every word within a given protocol 321 * structure to the real byte offset as per the specification of that 322 * protocol header. 323 * for e.g. dst address is 3 words in ethertype header and corresponding bytes 324 * are 0, 2, 3 in the actual packet header and src address is at 4, 6, 8 325 */ 326struct ice_prot_ext_tbl_entry { 327 enum ice_protocol_type prot_type; 328 /* Byte offset into header of given protocol type */ 329 u8 offs[sizeof(union ice_prot_hdr)]; 330}; 331 332/* Extractions to be looked up for a given recipe */ 333struct ice_prot_lkup_ext { 334 u16 prot_type; 335 u8 n_val_words; 336 /* create a buffer to hold max words per recipe */ 337 u16 field_off[ICE_MAX_CHAIN_WORDS]; 338 u16 field_mask[ICE_MAX_CHAIN_WORDS]; 339 340 struct ice_fv_word fv_words[ICE_MAX_CHAIN_WORDS]; 341 342 /* Indicate field offsets that have field vector indices assigned */ 343 ice_declare_bitmap(done, ICE_MAX_CHAIN_WORDS); 344}; 345 346struct ice_pref_recipe_group { 347 u8 n_val_pairs; /* Number of valid pairs */ 348 struct ice_fv_word pairs[ICE_NUM_WORDS_RECIPE]; 349 u16 mask[ICE_NUM_WORDS_RECIPE]; 350}; 351 352struct ice_recp_grp_entry { 353 struct LIST_ENTRY_TYPE l_entry; 354 355#define ICE_INVAL_CHAIN_IND 0xFF 356 u16 rid; 357 u8 chain_idx; 358 u16 fv_idx[ICE_NUM_WORDS_RECIPE]; 359 u16 fv_mask[ICE_NUM_WORDS_RECIPE]; 360 struct ice_pref_recipe_group r_group; 361}; 362#endif /* _ICE_PROTOCOL_TYPE_H_ */ 363