xref: /dpdk/drivers/net/ice/base/ice_fdir.h (revision bb07d96d)
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2001-2021 Intel Corporation
3  */
4 
5 #ifndef _ICE_FDIR_H_
6 #define _ICE_FDIR_H_
7 
8 #include "ice_common.h"
9 
10 #define ICE_FDIR_IP_PROTOCOLS
11 #define ICE_IP_PROTO_TCP		6
12 #define ICE_IP_PROTO_UDP		17
13 #define ICE_IP_PROTO_SCTP		132
14 #define ICE_IP_PROTO_IP			0
15 #define ICE_IP_PROTO_ESP		50
16 
17 #define ICE_FDIR_GTPU_IP_INNER_PKT_OFF 50
18 #define ICE_FDIR_GTPU_EH_INNER_PKT_OFF 58
19 
20 #define ICE_FDIR_TUN_PKT_OFF		50
21 #define ICE_FDIR_MAX_RAW_PKT_SIZE	(512 + ICE_FDIR_TUN_PKT_OFF)
22 #define ICE_FDIR_BUF_FULL_MARGIN	10
23 
24 /* macros for offsets into packets for flow director programming */
25 #define ICE_IPV4_SRC_ADDR_OFFSET	26
26 #define ICE_IPV4_DST_ADDR_OFFSET	30
27 #define ICE_IPV4_TCP_SRC_PORT_OFFSET	34
28 #define ICE_IPV4_TCP_DST_PORT_OFFSET	36
29 #define ICE_IPV4_UDP_SRC_PORT_OFFSET	34
30 #define ICE_IPV4_UDP_DST_PORT_OFFSET	36
31 #define ICE_IPV4_SCTP_SRC_PORT_OFFSET	34
32 #define ICE_IPV4_SCTP_DST_PORT_OFFSET	36
33 #define ICE_IPV4_PROTO_OFFSET		23
34 #define ICE_IPV6_SRC_ADDR_OFFSET	22
35 #define ICE_IPV6_DST_ADDR_OFFSET	38
36 #define ICE_IPV6_TCP_SRC_PORT_OFFSET	54
37 #define ICE_IPV6_TCP_DST_PORT_OFFSET	56
38 #define ICE_IPV6_UDP_SRC_PORT_OFFSET	54
39 #define ICE_IPV6_UDP_DST_PORT_OFFSET	56
40 #define ICE_IPV6_SCTP_SRC_PORT_OFFSET	54
41 #define ICE_IPV6_SCTP_DST_PORT_OFFSET	56
42 
43 #define ICE_MAC_ETHTYPE_OFFSET		12
44 #define ICE_IPV4_TOS_OFFSET		15
45 #define ICE_IPV4_TTL_OFFSET		22
46 #define ICE_IPV6_TC_OFFSET		14
47 #define ICE_IPV6_HLIM_OFFSET		21
48 #define ICE_IPV6_PROTO_OFFSET		20
49 /* For TUN inner (without inner MAC) */
50 #define ICE_IPV4_NO_MAC_TOS_OFFSET	1
51 #define ICE_IPV4_NO_MAC_TTL_OFFSET	8
52 #define ICE_IPV4_NO_MAC_PROTO_OFFSET	9
53 #define ICE_IPV4_NO_MAC_SRC_ADDR_OFFSET	12
54 #define ICE_IPV4_NO_MAC_DST_ADDR_OFFSET	16
55 #define ICE_TCP4_NO_MAC_SRC_PORT_OFFSET	20
56 #define ICE_TCP4_NO_MAC_DST_PORT_OFFSET	22
57 #define ICE_UDP4_NO_MAC_SRC_PORT_OFFSET	20
58 #define ICE_UDP4_NO_MAC_DST_PORT_OFFSET	22
59 #define ICE_IPV6_NO_MAC_TC_OFFSET	0
60 #define ICE_IPV6_NO_MAC_HLIM_OFFSET	7
61 #define ICE_IPV6_NO_MAC_PROTO_OFFSET	6
62 #define ICE_IPV6_NO_MAC_SRC_ADDR_OFFSET	8
63 #define ICE_IPV6_NO_MAC_DST_ADDR_OFFSET	24
64 #define ICE_TCP6_NO_MAC_SRC_PORT_OFFSET	40
65 #define ICE_TCP6_NO_MAC_DST_PORT_OFFSET	42
66 #define ICE_UDP6_NO_MAC_SRC_PORT_OFFSET	40
67 #define ICE_UDP6_NO_MAC_DST_PORT_OFFSET	42
68 #define ICE_IPV4_GTPU_TEID_OFFSET	46
69 #define ICE_IPV4_GTPU_QFI_OFFSET	56
70 #define ICE_IPV6_GTPU_TEID_OFFSET	66
71 #define ICE_IPV6_GTPU_QFI_OFFSET	76
72 #define ICE_IPV4_L2TPV3_SESS_ID_OFFSET	34
73 #define ICE_IPV6_L2TPV3_SESS_ID_OFFSET	54
74 #define ICE_IPV4_ESP_SPI_OFFSET		34
75 #define ICE_IPV6_ESP_SPI_OFFSET		54
76 #define ICE_IPV4_AH_SPI_OFFSET		38
77 #define ICE_IPV6_AH_SPI_OFFSET		58
78 #define ICE_IPV4_NAT_T_ESP_SPI_OFFSET	42
79 #define ICE_IPV6_NAT_T_ESP_SPI_OFFSET	62
80 #define ICE_IPV4_VXLAN_VNI_OFFSET	45
81 #define ICE_ECPRI_TP0_PC_ID_OFFSET	18
82 #define ICE_IPV4_UDP_ECPRI_TP0_PC_ID_OFFSET			46
83 
84 #define ICE_FDIR_MAX_FLTRS		16384
85 
86 /* IP v4 has 2 flag bits that enable fragment processing: DF and MF. DF
87  * requests that the packet not be fragmented. MF indicates that a packet has
88  * been fragmented.
89  */
90 #define ICE_FDIR_IPV4_PKT_FLAG_DF		0x20
91 #define ICE_FDIR_IPV4_PKT_FLAG_MF		0x40
92 
93 enum ice_fltr_prgm_desc_dest {
94 	ICE_FLTR_PRGM_DESC_DEST_DROP_PKT,
95 	ICE_FLTR_PRGM_DESC_DEST_DIRECT_PKT_QINDEX,
96 	ICE_FLTR_PRGM_DESC_DEST_DIRECT_PKT_QGROUP,
97 	ICE_FLTR_PRGM_DESC_DEST_DIRECT_PKT_OTHER,
98 };
99 
100 enum ice_fltr_prgm_desc_fd_status {
101 	ICE_FLTR_PRGM_DESC_FD_STATUS_NONE,
102 	ICE_FLTR_PRGM_DESC_FD_STATUS_FD_ID,
103 	ICE_FLTR_PRGM_DESC_FD_STATUS_FD_ID_4FLEX_BYTES,
104 	ICE_FLTR_PRGM_DESC_FD_STATUS_8FLEX_BYTES,
105 };
106 
107 /* Flow Director (FD) Filter Programming descriptor */
108 struct ice_fd_fltr_desc_ctx {
109 	u32 fdid;
110 	u16 qindex;
111 	u16 cnt_index;
112 	u16 fd_vsi;
113 	u16 flex_val;
114 	u8 comp_q;
115 	u8 comp_report;
116 	u8 fd_space;
117 	u8 cnt_ena;
118 	u8 evict_ena;
119 	u8 toq;
120 	u8 toq_prio;
121 	u8 dpu_recipe;
122 	u8 drop;
123 	u8 flex_prio;
124 	u8 flex_mdid;
125 	u8 dtype;
126 	u8 pcmd;
127 	u8 desc_prof_prio;
128 	u8 desc_prof;
129 	u8 swap;
130 	u8 fdid_prio;
131 	u8 fdid_mdid;
132 };
133 
134 #define ICE_FLTR_PRGM_FLEX_WORD_SIZE	sizeof(__be16)
135 
136 struct ice_rx_flow_userdef {
137 	u16 flex_word;
138 	u16 flex_offset;
139 	u16 flex_fltr;
140 };
141 
142 struct ice_fdir_v4 {
143 	__be32 dst_ip;
144 	__be32 src_ip;
145 	__be16 dst_port;
146 	__be16 src_port;
147 	__be32 l4_header;
148 	__be32 sec_parm_idx;	/* security parameter index */
149 	u8 tos;
150 	u8 ip_ver;
151 	u8 proto;
152 	u8 ttl;
153 };
154 
155 #define ICE_IPV6_ADDR_LEN_AS_U32		4
156 
157 struct ice_fdir_v6 {
158 	__be32 dst_ip[ICE_IPV6_ADDR_LEN_AS_U32];
159 	__be32 src_ip[ICE_IPV6_ADDR_LEN_AS_U32];
160 	__be16 dst_port;
161 	__be16 src_port;
162 	__be32 l4_header; /* next header */
163 	__be32 sec_parm_idx; /* security parameter index */
164 	u8 tc;
165 	u8 proto;
166 	u8 hlim;
167 };
168 
169 struct ice_fdir_udp_gtp {
170 	u8 flags;
171 	u8 msg_type;
172 	__be16 rsrvd_len;
173 	__be32 teid;
174 	__be16 rsrvd_seq_nbr;
175 	u8 rsrvd_n_pdu_nbr;
176 	u8 rsrvd_next_ext_type;
177 	u8 rsvrd_ext_len;
178 	u8	pdu_type:4,
179 		spare:4;
180 	u8	ppp:1,
181 		rqi:1,
182 		qfi:6;
183 	u32 rsvrd;
184 	u8 next_ext;
185 };
186 
187 struct ice_fdir_l2tpv3 {
188 	__be32 session_id;
189 };
190 
191 struct ice_fdir_udp_vxlan {
192 	__be32 vni; /* 8 bits reserved, always be zero */
193 };
194 
195 struct ice_fdir_ecpri {
196 	__be16 pc_id;
197 };
198 
199 struct ice_fdir_extra {
200 	u8 dst_mac[ETH_ALEN];	/* dest MAC address */
201 	u8 src_mac[ETH_ALEN];	/* src MAC address */
202 	__be16 ether_type;      /* for NON_IP_L2 */
203 	u32 usr_def[2];		/* user data */
204 	__be16 vlan_type;	/* VLAN ethertype */
205 	__be16 vlan_tag;	/* VLAN tag info */
206 };
207 
208 struct ice_fdir_fltr {
209 	struct LIST_ENTRY_TYPE fltr_node;
210 	enum ice_fltr_ptype flow_type;
211 
212 	union {
213 		struct ice_fdir_v4 v4;
214 		struct ice_fdir_v6 v6;
215 	} ip, mask;
216 
217 	/* for tunnel outer part */
218 	union {
219 		struct ice_fdir_v4 v4;
220 		struct ice_fdir_v6 v6;
221 	} ip_outer, mask_outer;
222 
223 	struct ice_fdir_extra ext_data_outer;
224 	struct ice_fdir_extra ext_mask_outer;
225 
226 	struct ice_fdir_udp_vxlan vxlan_data;
227 	struct ice_fdir_udp_vxlan vxlan_mask;
228 
229 	struct ice_fdir_udp_gtp gtpu_data;
230 	struct ice_fdir_udp_gtp gtpu_mask;
231 
232 	struct ice_fdir_l2tpv3 l2tpv3_data;
233 	struct ice_fdir_l2tpv3 l2tpv3_mask;
234 
235 	struct ice_fdir_ecpri ecpri_data;
236 	struct ice_fdir_ecpri ecpri_mask;
237 
238 	struct ice_fdir_extra ext_data;
239 	struct ice_fdir_extra ext_mask;
240 
241 	/* flex byte filter data */
242 	__be16 flex_word;
243 	/* queue region size (=2^q_region) */
244 	u8 q_region;
245 	u16 flex_offset;
246 	u16 flex_fltr;
247 
248 	/* filter control */
249 	u16 q_index;
250 	u16 dest_vsi;
251 	u8 dest_ctl;
252 	u8 cnt_ena;
253 	u8 fltr_status;
254 	u16 cnt_index;
255 	u32 fltr_id;
256 	u8 fdid_prio;
257 	u8 comp_report;
258 	/* Set to true for an ACL filter */
259 	bool acl_fltr;
260 };
261 
262 /* Dummy packet filter definition structure */
263 struct ice_fdir_base_pkt {
264 	enum ice_fltr_ptype flow;
265 	u16 pkt_len;
266 	const u8 *pkt;
267 	u16 tun_pkt_len;
268 	const u8 *tun_pkt;
269 };
270 
271 enum ice_status ice_alloc_fd_res_cntr(struct ice_hw *hw, u16 *cntr_id);
272 enum ice_status ice_free_fd_res_cntr(struct ice_hw *hw, u16 cntr_id);
273 enum ice_status
274 ice_alloc_fd_guar_item(struct ice_hw *hw, u16 *cntr_id, u16 num_fltr);
275 enum ice_status
276 ice_free_fd_guar_item(struct ice_hw *hw, u16 cntr_id, u16 num_fltr);
277 enum ice_status
278 ice_alloc_fd_shrd_item(struct ice_hw *hw, u16 *cntr_id, u16 num_fltr);
279 enum ice_status
280 ice_free_fd_shrd_item(struct ice_hw *hw, u16 cntr_id, u16 num_fltr);
281 enum ice_status ice_clear_pf_fd_table(struct ice_hw *hw);
282 void
283 ice_fdir_get_prgm_desc(struct ice_hw *hw, struct ice_fdir_fltr *input,
284 		       struct ice_fltr_desc *fdesc, bool add);
285 enum ice_status
286 ice_fdir_get_gen_prgm_pkt(struct ice_hw *hw, struct ice_fdir_fltr *input,
287 			  u8 *pkt, bool frag, bool tun);
288 enum ice_status
289 ice_fdir_get_prgm_pkt(struct ice_fdir_fltr *input, u8 *pkt, bool frag);
290 int ice_get_fdir_cnt_all(struct ice_hw *hw);
291 bool ice_fdir_is_dup_fltr(struct ice_hw *hw, struct ice_fdir_fltr *input);
292 bool ice_fdir_has_frag(enum ice_fltr_ptype flow);
293 struct ice_fdir_fltr *
294 ice_fdir_find_fltr_by_idx(struct ice_hw *hw, u32 fltr_idx);
295 void
296 ice_fdir_update_cntrs(struct ice_hw *hw, enum ice_fltr_ptype flow,
297 		      bool acl_fltr, bool add);
298 void ice_fdir_list_add_fltr(struct ice_hw *hw, struct ice_fdir_fltr *input);
299 #endif /* _ICE_FDIR_H_ */
300