1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2001-2020
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 {
56 enum ice_sw_tunnel_type {
58 ICE_SW_TUN_AND_NON_TUN,
63 ICE_SW_TUN_UDP, /* This means all "UDP" tunnel types: VXLAN-GPE, VXLAN
68 ICE_SW_TUN_PROFID_IPV6_ESP,
69 ICE_SW_TUN_PROFID_IPV6_AH,
70 ICE_SW_TUN_PROFID_MAC_IPV6_L2TPV3,
71 ICE_SW_TUN_PROFID_IPV6_NAT_T,
72 ICE_SW_TUN_PROFID_IPV4_PFCP_NODE,
73 ICE_SW_TUN_PROFID_IPV4_PFCP_SESSION,
74 ICE_SW_TUN_PROFID_IPV6_PFCP_NODE,
75 ICE_SW_TUN_PROFID_IPV6_PFCP_SESSION,
76 ICE_ALL_TUNNELS /* All tunnel types including NVGRE */
79 /* Decoders for ice_prot_id:
87 ICE_PROT_ID_INVAL = 0,
88 ICE_PROT_MAC_OF_OR_S = 1,
91 ICE_PROT_MAC_IN_MAC = 7,
92 ICE_PROT_ETYPE_OL = 9,
93 ICE_PROT_ETYPE_IL = 10,
95 ICE_PROT_EVLAN_O = 16,
97 ICE_PROT_VLAN_IF = 18,
98 ICE_PROT_MPLS_OL_MINUS_1 = 27,
99 ICE_PROT_MPLS_OL_OR_OS = 28,
100 ICE_PROT_MPLS_IL = 29,
101 ICE_PROT_IPV4_OF_OR_S = 32,
102 ICE_PROT_IPV4_IL = 33,
103 ICE_PROT_IPV6_OF_OR_S = 40,
104 ICE_PROT_IPV6_IL = 41,
105 ICE_PROT_IPV6_FRAG = 47,
106 ICE_PROT_TCP_IL = 49,
107 ICE_PROT_UDP_OF = 52,
108 ICE_PROT_UDP_IL_OR_S = 53,
109 ICE_PROT_GRE_OF = 64,
113 ICE_PROT_SCTP_IL = 96,
114 ICE_PROT_ICMP_IL = 98,
115 ICE_PROT_ICMPV6_IL = 100,
116 ICE_PROT_VRRP_F = 101,
118 ICE_PROT_PPPOE = 103,
119 ICE_PROT_L2TPV3 = 104,
120 ICE_PROT_ATAOE_OF = 114,
121 ICE_PROT_CTRL_OF = 116,
122 ICE_PROT_LLDP_OF = 117,
123 ICE_PROT_ARP_OF = 118,
124 ICE_PROT_EAPOL_OF = 120,
125 ICE_PROT_META_ID = 255, /* when offset == metaddata */
126 ICE_PROT_INVALID = 255 /* when offset == ICE_FV_OFFSET_INVAL */
129 #define ICE_VNI_OFFSET 12 /* offset of VNI from ICE_PROT_UDP_OF */
131 #define ICE_MAC_OFOS_HW 1
132 #define ICE_MAC_IL_HW 4
133 #define ICE_ETYPE_OL_HW 9
134 #define ICE_VLAN_OL_HW 17
135 #define ICE_IPV4_OFOS_HW 32
136 #define ICE_IPV4_IL_HW 33
137 #define ICE_IPV6_OFOS_HW 40
138 #define ICE_IPV6_IL_HW 41
139 #define ICE_TCP_IL_HW 49
140 #define ICE_UDP_ILOS_HW 53
141 #define ICE_ESP_HW 88
143 #define ICE_SCTP_IL_HW 96
144 #define ICE_PPPOE_HW 103
145 #define ICE_L2TPV3_HW 104
147 /* ICE_UDP_OF is used to identify all 3 tunnel types
148 * VXLAN, GENEVE and VXLAN_GPE. To differentiate further
149 * need to use flags from the field vector
151 #define ICE_UDP_OF_HW 52 /* UDP Tunnels */
152 #define ICE_GRE_OF_HW 64 /* NVGRE */
153 #define ICE_META_DATA_ID_HW 255 /* this is used for tunnel type */
155 #define ICE_MDID_SIZE 2
156 #define ICE_TUN_FLAG_MDID 21
157 #define ICE_TUN_FLAG_MASK 0xFF
158 #define ICE_TUN_FLAG_FV_IND 2
160 #define ICE_PROTOCOL_MAX_ENTRIES 16
162 /* Mapping of software defined protocol ID to hardware defined protocol ID */
163 struct ice_protocol_entry {
164 enum ice_protocol_type type;
168 struct ice_ether_hdr {
169 u8 dst_addr[ETH_ALEN];
170 u8 src_addr[ETH_ALEN];
173 struct ice_ethtype_hdr {
177 struct ice_ether_vlan_hdr {
178 u8 dst_addr[ETH_ALEN];
179 u8 src_addr[ETH_ALEN];
183 struct ice_vlan_hdr {
188 struct ice_ipv4_hdr {
201 struct ice_le_ver_tc_flow {
212 struct ice_ipv6_hdr {
213 __be32 be_ver_tc_flow;
217 u8 src_addr[ICE_IPV6_ADDR_LENGTH];
218 u8 dst_addr[ICE_IPV6_ADDR_LENGTH];
221 struct ice_sctp_hdr {
224 __be32 verification_tag;
235 struct ice_udp_tnl_hdr {
238 __be32 vni; /* only use lower 24-bits */
241 struct ice_udp_gtp_hdr {
246 __be16 rsrvd_seq_nbr;
255 struct ice_pppoe_hdr {
260 __be16 ppp_prot_id; /* control and data only */
263 struct ice_pfcp_hdr {
272 struct ice_l2tpv3_sess_hdr {
297 struct ice_ether_hdr eth_hdr;
298 struct ice_ethtype_hdr ethertype;
299 struct ice_vlan_hdr vlan_hdr;
300 struct ice_ipv4_hdr ipv4_hdr;
301 struct ice_ipv6_hdr ipv6_hdr;
302 struct ice_l4_hdr l4_hdr;
303 struct ice_sctp_hdr sctp_hdr;
304 struct ice_udp_tnl_hdr tnl_hdr;
305 struct ice_nvgre nvgre_hdr;
306 struct ice_udp_gtp_hdr gtp_hdr;
307 struct ice_pppoe_hdr pppoe_hdr;
308 struct ice_pfcp_hdr pfcp_hdr;
309 struct ice_l2tpv3_sess_hdr l2tpv3_sess_hdr;
310 struct ice_esp_hdr esp_hdr;
311 struct ice_ah_hdr ah_hdr;
314 /* This is mapping table entry that maps every word within a given protocol
315 * structure to the real byte offset as per the specification of that
317 * for e.g. dst address is 3 words in ethertype header and corresponding bytes
318 * are 0, 2, 3 in the actual packet header and src address is at 4, 6, 8
320 struct ice_prot_ext_tbl_entry {
321 enum ice_protocol_type prot_type;
322 /* Byte offset into header of given protocol type */
323 u8 offs[sizeof(union ice_prot_hdr)];
326 /* Extractions to be looked up for a given recipe */
327 struct ice_prot_lkup_ext {
330 /* create a buffer to hold max words per recipe */
331 u16 field_off[ICE_MAX_CHAIN_WORDS];
332 u16 field_mask[ICE_MAX_CHAIN_WORDS];
334 struct ice_fv_word fv_words[ICE_MAX_CHAIN_WORDS];
336 /* Indicate field offsets that have field vector indices assigned */
337 ice_declare_bitmap(done, ICE_MAX_CHAIN_WORDS);
340 struct ice_pref_recipe_group {
341 u8 n_val_pairs; /* Number of valid pairs */
342 struct ice_fv_word pairs[ICE_NUM_WORDS_RECIPE];
343 u16 mask[ICE_NUM_WORDS_RECIPE];
346 struct ice_recp_grp_entry {
347 struct LIST_ENTRY_TYPE l_entry;
349 #define ICE_INVAL_CHAIN_IND 0xFF
352 u16 fv_idx[ICE_NUM_WORDS_RECIPE];
353 u16 fv_mask[ICE_NUM_WORDS_RECIPE];
354 struct ice_pref_recipe_group r_group;
356 #endif /* _ICE_PROTOCOL_TYPE_H_ */