1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2001-2019
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 {
52 enum ice_sw_tunnel_type {
54 ICE_SW_TUN_AND_NON_TUN,
59 ICE_SW_TUN_UDP, /* This means all "UDP" tunnel types: VXLAN-GPE, VXLAN
64 ICE_ALL_TUNNELS /* All tunnel types including NVGRE */
67 /* Decoders for ice_prot_id:
75 ICE_PROT_ID_INVAL = 0,
76 ICE_PROT_MAC_OF_OR_S = 1,
79 ICE_PROT_MAC_IN_MAC = 7,
80 ICE_PROT_ETYPE_OL = 9,
81 ICE_PROT_ETYPE_IL = 10,
83 ICE_PROT_EVLAN_O = 16,
85 ICE_PROT_VLAN_IF = 18,
86 ICE_PROT_MPLS_OL_MINUS_1 = 27,
87 ICE_PROT_MPLS_OL_OR_OS = 28,
88 ICE_PROT_MPLS_IL = 29,
89 ICE_PROT_IPV4_OF_OR_S = 32,
90 ICE_PROT_IPV4_IL = 33,
91 ICE_PROT_IPV6_OF_OR_S = 40,
92 ICE_PROT_IPV6_IL = 41,
93 ICE_PROT_IPV6_FRAG = 47,
96 ICE_PROT_UDP_IL_OR_S = 53,
101 ICE_PROT_SCTP_IL = 96,
102 ICE_PROT_ICMP_IL = 98,
103 ICE_PROT_ICMPV6_IL = 100,
104 ICE_PROT_VRRP_F = 101,
106 ICE_PROT_PPPOE = 103,
107 ICE_PROT_ATAOE_OF = 114,
108 ICE_PROT_CTRL_OF = 116,
109 ICE_PROT_LLDP_OF = 117,
110 ICE_PROT_ARP_OF = 118,
111 ICE_PROT_EAPOL_OF = 120,
112 ICE_PROT_META_ID = 255, /* when offset == metaddata */
113 ICE_PROT_INVALID = 255 /* when offset == ICE_FV_OFFSET_INVAL */
116 #define ICE_VNI_OFFSET 12 /* offset of VNI from ICE_PROT_UDP_OF */
118 #define ICE_MAC_OFOS_HW 1
119 #define ICE_MAC_IL_HW 4
120 #define ICE_ETYPE_OL_HW 9
121 #define ICE_VLAN_OL_HW 17
122 #define ICE_IPV4_OFOS_HW 32
123 #define ICE_IPV4_IL_HW 33
124 #define ICE_IPV6_OFOS_HW 40
125 #define ICE_IPV6_IL_HW 41
126 #define ICE_TCP_IL_HW 49
127 #define ICE_UDP_ILOS_HW 53
128 #define ICE_SCTP_IL_HW 96
129 #define ICE_PPPOE_HW 103
131 /* ICE_UDP_OF is used to identify all 3 tunnel types
132 * VXLAN, GENEVE and VXLAN_GPE. To differentiate further
133 * need to use flags from the field vector
135 #define ICE_UDP_OF_HW 52 /* UDP Tunnels */
136 #define ICE_GRE_OF_HW 64 /* NVGRE */
137 #define ICE_META_DATA_ID_HW 255 /* this is used for tunnel type */
139 #define ICE_MDID_SIZE 2
140 #define ICE_TUN_FLAG_MDID 21
141 #define ICE_TUN_FLAG_MASK 0xFF
142 #define ICE_TUN_FLAG_FV_IND 2
144 #define ICE_PROTOCOL_MAX_ENTRIES 16
146 /* Mapping of software defined protocol ID to hardware defined protocol ID */
147 struct ice_protocol_entry {
148 enum ice_protocol_type type;
152 struct ice_ether_hdr {
153 u8 dst_addr[ETH_ALEN];
154 u8 src_addr[ETH_ALEN];
157 struct ice_ethtype_hdr {
161 struct ice_ether_vlan_hdr {
162 u8 dst_addr[ETH_ALEN];
163 u8 src_addr[ETH_ALEN];
167 struct ice_vlan_hdr {
172 struct ice_ipv4_hdr {
185 struct ice_le_ver_tc_flow {
196 struct ice_ipv6_hdr {
197 __be32 be_ver_tc_flow;
201 u8 src_addr[ICE_IPV6_ADDR_LENGTH];
202 u8 dst_addr[ICE_IPV6_ADDR_LENGTH];
205 struct ice_sctp_hdr {
208 __be32 verification_tag;
219 struct ice_udp_tnl_hdr {
222 __be32 vni; /* only use lower 24-bits */
226 struct ice_udp_gtp_hdr {
231 __be16 rsrvd_seq_nbr;
240 struct ice_pppoe_hdr {
245 __be16 ppp_prot_id; /* control and data only */
256 struct ice_ether_hdr eth_hdr;
257 struct ice_ethtype_hdr ethertype;
258 struct ice_vlan_hdr vlan_hdr;
259 struct ice_ipv4_hdr ipv4_hdr;
260 struct ice_ipv6_hdr ipv6_hdr;
261 struct ice_l4_hdr l4_hdr;
262 struct ice_sctp_hdr sctp_hdr;
263 struct ice_udp_tnl_hdr tnl_hdr;
264 struct ice_nvgre nvgre_hdr;
265 struct ice_udp_gtp_hdr gtp_hdr;
266 struct ice_pppoe_hdr pppoe_hdr;
269 /* This is mapping table entry that maps every word within a given protocol
270 * structure to the real byte offset as per the specification of that
272 * for e.g. dst address is 3 words in ethertype header and corresponding bytes
273 * are 0, 2, 3 in the actual packet header and src address is at 4, 6, 8
275 struct ice_prot_ext_tbl_entry {
276 enum ice_protocol_type prot_type;
277 /* Byte offset into header of given protocol type */
278 u8 offs[sizeof(union ice_prot_hdr)];
281 /* Extractions to be looked up for a given recipe */
282 struct ice_prot_lkup_ext {
285 /* create a buffer to hold max words per recipe */
286 u16 field_off[ICE_MAX_CHAIN_WORDS];
287 u16 field_mask[ICE_MAX_CHAIN_WORDS];
289 struct ice_fv_word fv_words[ICE_MAX_CHAIN_WORDS];
291 /* Indicate field offsets that have field vector indices assigned */
292 ice_declare_bitmap(done, ICE_MAX_CHAIN_WORDS);
295 struct ice_pref_recipe_group {
296 u8 n_val_pairs; /* Number of valid pairs */
297 struct ice_fv_word pairs[ICE_NUM_WORDS_RECIPE];
298 u16 mask[ICE_NUM_WORDS_RECIPE];
301 struct ice_recp_grp_entry {
302 struct LIST_ENTRY_TYPE l_entry;
304 #define ICE_INVAL_CHAIN_IND 0xFF
307 u16 fv_idx[ICE_NUM_WORDS_RECIPE];
308 u16 fv_mask[ICE_NUM_WORDS_RECIPE];
309 struct ice_pref_recipe_group r_group;
311 #endif /* _ICE_PROTOCOL_TYPE_H_ */