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