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