1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2001-2020 Intel Corporation
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
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.
16 #define ICE_NUM_WORDS_RECIPE 4
18 /* Max recipes that can be chained */
19 #define ICE_MAX_CHAIN_RECIPE 5
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.
25 #define ICE_MAX_CHAIN_WORDS (ICE_NUM_WORDS_RECIPE * ICE_MAX_CHAIN_RECIPE)
27 /* Field vector index corresponding to chaining */
28 #define ICE_CHAIN_FV_INDEX_START 47
30 enum ice_protocol_type {
58 enum ice_sw_tunnel_type {
60 ICE_SW_TUN_AND_NON_TUN,
62 ICE_SW_TUN_GENEVE, /* GENEVE matches only non-VLAN pkts */
63 ICE_SW_TUN_GENEVE_VLAN, /* GENEVE matches both VLAN and non-VLAN pkts */
64 ICE_SW_TUN_VXLAN, /* VXLAN matches only non-VLAN pkts */
65 ICE_SW_TUN_VXLAN_VLAN, /* VXLAN matches both VLAN and non-VLAN pkts */
67 ICE_SW_TUN_UDP, /* This means all "UDP" tunnel types: VXLAN-GPE, VXLAN
75 ICE_SW_TUN_IPV4_GTPU_NO_PAY,
76 ICE_SW_TUN_IPV6_GTPU_NO_PAY,
77 ICE_SW_TUN_IPV4_GTPU_IPV4,
78 ICE_SW_TUN_IPV4_GTPU_IPV6,
79 ICE_SW_TUN_IPV6_GTPU_IPV4,
80 ICE_SW_TUN_IPV6_GTPU_IPV6,
83 ICE_SW_TUN_PPPOE_IPV4,
84 ICE_SW_TUN_PPPOE_IPV4_TCP,
85 ICE_SW_TUN_PPPOE_IPV4_UDP,
86 ICE_SW_TUN_PPPOE_IPV6,
87 ICE_SW_TUN_PPPOE_IPV6_TCP,
88 ICE_SW_TUN_PPPOE_IPV6_UDP,
93 ICE_SW_TUN_IPV4_NAT_T,
94 ICE_SW_TUN_IPV6_NAT_T,
95 ICE_SW_TUN_IPV4_L2TPV3,
96 ICE_SW_TUN_IPV6_L2TPV3,
97 ICE_SW_TUN_PROFID_IPV6_ESP,
98 ICE_SW_TUN_PROFID_IPV6_AH,
99 ICE_SW_TUN_PROFID_MAC_IPV6_L2TPV3,
100 ICE_SW_TUN_PROFID_IPV6_NAT_T,
101 ICE_SW_TUN_PROFID_IPV4_PFCP_NODE,
102 ICE_SW_TUN_PROFID_IPV4_PFCP_SESSION,
103 ICE_SW_TUN_PROFID_IPV6_PFCP_NODE,
104 ICE_SW_TUN_PROFID_IPV6_PFCP_SESSION,
105 ICE_ALL_TUNNELS /* All tunnel types including NVGRE */
108 /* Decoders for ice_prot_id:
116 ICE_PROT_ID_INVAL = 0,
117 ICE_PROT_MAC_OF_OR_S = 1,
120 ICE_PROT_MAC_IN_MAC = 7,
121 ICE_PROT_ETYPE_OL = 9,
122 ICE_PROT_ETYPE_IL = 10,
124 ICE_PROT_EVLAN_O = 16,
125 ICE_PROT_VLAN_O = 17,
126 ICE_PROT_VLAN_IF = 18,
127 ICE_PROT_MPLS_OL_MINUS_1 = 27,
128 ICE_PROT_MPLS_OL_OR_OS = 28,
129 ICE_PROT_MPLS_IL = 29,
130 ICE_PROT_IPV4_OF_OR_S = 32,
131 ICE_PROT_IPV4_IL = 33,
132 ICE_PROT_IPV6_OF_OR_S = 40,
133 ICE_PROT_IPV6_IL = 41,
134 ICE_PROT_IPV6_FRAG = 47,
135 ICE_PROT_TCP_IL = 49,
136 ICE_PROT_UDP_OF = 52,
137 ICE_PROT_UDP_IL_OR_S = 53,
138 ICE_PROT_GRE_OF = 64,
142 ICE_PROT_SCTP_IL = 96,
143 ICE_PROT_ICMP_IL = 98,
144 ICE_PROT_ICMPV6_IL = 100,
145 ICE_PROT_VRRP_F = 101,
147 ICE_PROT_PPPOE = 103,
148 ICE_PROT_L2TPV3 = 104,
149 ICE_PROT_ATAOE_OF = 114,
150 ICE_PROT_CTRL_OF = 116,
151 ICE_PROT_LLDP_OF = 117,
152 ICE_PROT_ARP_OF = 118,
153 ICE_PROT_EAPOL_OF = 120,
154 ICE_PROT_META_ID = 255, /* when offset == metaddata */
155 ICE_PROT_INVALID = 255 /* when offset == ICE_FV_OFFSET_INVAL */
158 #define ICE_VNI_OFFSET 12 /* offset of VNI from ICE_PROT_UDP_OF */
160 #define ICE_MAC_OFOS_HW 1
161 #define ICE_MAC_IL_HW 4
162 #define ICE_ETYPE_OL_HW 9
163 #define ICE_VLAN_OL_HW 17
164 #define ICE_IPV4_OFOS_HW 32
165 #define ICE_IPV4_IL_HW 33
166 #define ICE_IPV6_OFOS_HW 40
167 #define ICE_IPV6_IL_HW 41
168 #define ICE_TCP_IL_HW 49
169 #define ICE_UDP_ILOS_HW 53
170 #define ICE_ESP_HW 88
172 #define ICE_SCTP_IL_HW 96
173 #define ICE_PPPOE_HW 103
174 #define ICE_L2TPV3_HW 104
176 /* ICE_UDP_OF is used to identify all 3 tunnel types
177 * VXLAN, GENEVE and VXLAN_GPE. To differentiate further
178 * need to use flags from the field vector
180 #define ICE_UDP_OF_HW 52 /* UDP Tunnels */
181 #define ICE_GRE_OF_HW 64 /* NVGRE */
182 #define ICE_META_DATA_ID_HW 255 /* this is used for tunnel type */
184 #define ICE_MDID_SIZE 2
185 #define ICE_TUN_FLAG_MDID 21
186 #define ICE_TUN_FLAG_MDID_OFF (ICE_MDID_SIZE * ICE_TUN_FLAG_MDID)
187 #define ICE_TUN_FLAG_MASK 0xFF
188 #define ICE_TUN_FLAG_VLAN_MASK 0x01
189 #define ICE_TUN_FLAG_FV_IND 2
191 #define ICE_PROTOCOL_MAX_ENTRIES 16
193 /* Mapping of software defined protocol ID to hardware defined protocol ID */
194 struct ice_protocol_entry {
195 enum ice_protocol_type type;
199 struct ice_ether_hdr {
200 u8 dst_addr[ETH_ALEN];
201 u8 src_addr[ETH_ALEN];
204 struct ice_ethtype_hdr {
208 struct ice_ether_vlan_hdr {
209 u8 dst_addr[ETH_ALEN];
210 u8 src_addr[ETH_ALEN];
214 struct ice_vlan_hdr {
219 struct ice_ipv4_hdr {
232 struct ice_le_ver_tc_flow {
243 struct ice_ipv6_hdr {
244 __be32 be_ver_tc_flow;
248 u8 src_addr[ICE_IPV6_ADDR_LENGTH];
249 u8 dst_addr[ICE_IPV6_ADDR_LENGTH];
252 struct ice_sctp_hdr {
255 __be32 verification_tag;
266 struct ice_udp_tnl_hdr {
269 __be32 vni; /* only use lower 24-bits */
272 struct ice_udp_gtp_hdr {
277 __be16 rsrvd_seq_nbr;
286 struct ice_pppoe_hdr {
291 __be16 ppp_prot_id; /* control and data only */
294 struct ice_pfcp_hdr {
303 struct ice_l2tpv3_sess_hdr {
321 struct ice_nat_t_hdr {
322 struct ice_esp_hdr esp;
332 struct ice_ether_hdr eth_hdr;
333 struct ice_ethtype_hdr ethertype;
334 struct ice_vlan_hdr vlan_hdr;
335 struct ice_ipv4_hdr ipv4_hdr;
336 struct ice_ipv6_hdr ipv6_hdr;
337 struct ice_l4_hdr l4_hdr;
338 struct ice_sctp_hdr sctp_hdr;
339 struct ice_udp_tnl_hdr tnl_hdr;
340 struct ice_nvgre nvgre_hdr;
341 struct ice_udp_gtp_hdr gtp_hdr;
342 struct ice_pppoe_hdr pppoe_hdr;
343 struct ice_pfcp_hdr pfcp_hdr;
344 struct ice_l2tpv3_sess_hdr l2tpv3_sess_hdr;
345 struct ice_esp_hdr esp_hdr;
346 struct ice_ah_hdr ah_hdr;
347 struct ice_nat_t_hdr nat_t_hdr;
350 /* This is mapping table entry that maps every word within a given protocol
351 * structure to the real byte offset as per the specification of that
353 * for e.g. dst address is 3 words in ethertype header and corresponding bytes
354 * are 0, 2, 3 in the actual packet header and src address is at 4, 6, 8
356 struct ice_prot_ext_tbl_entry {
357 enum ice_protocol_type prot_type;
358 /* Byte offset into header of given protocol type */
359 u8 offs[sizeof(union ice_prot_hdr)];
362 /* Extractions to be looked up for a given recipe */
363 struct ice_prot_lkup_ext {
366 /* create a buffer to hold max words per recipe */
367 u16 field_off[ICE_MAX_CHAIN_WORDS];
368 u16 field_mask[ICE_MAX_CHAIN_WORDS];
370 struct ice_fv_word fv_words[ICE_MAX_CHAIN_WORDS];
372 /* Indicate field offsets that have field vector indices assigned */
373 ice_declare_bitmap(done, ICE_MAX_CHAIN_WORDS);
376 struct ice_pref_recipe_group {
377 u8 n_val_pairs; /* Number of valid pairs */
378 struct ice_fv_word pairs[ICE_NUM_WORDS_RECIPE];
379 u16 mask[ICE_NUM_WORDS_RECIPE];
382 struct ice_recp_grp_entry {
383 struct LIST_ENTRY_TYPE l_entry;
385 #define ICE_INVAL_CHAIN_IND 0xFF
388 u16 fv_idx[ICE_NUM_WORDS_RECIPE];
389 u16 fv_mask[ICE_NUM_WORDS_RECIPE];
390 struct ice_pref_recipe_group r_group;
392 #endif /* _ICE_PROTOCOL_TYPE_H_ */