xref: /f-stack/dpdk/drivers/net/ice/base/ice_fdir.h (revision 2d9fd380)
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2001-2020 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 
59 #define ICE_FDIR_MAX_FLTRS		16384
60 
61 /* IP v4 has 2 flag bits that enable fragment processing: DF and MF. DF
62  * requests that the packet not be fragmented. MF indicates that a packet has
63  * been fragmented.
64  */
65 #define ICE_FDIR_IPV4_PKT_FLAG_DF		0x20
66 #define ICE_FDIR_IPV4_PKT_FLAG_MF		0x40
67 
68 enum ice_fltr_prgm_desc_dest {
69 	ICE_FLTR_PRGM_DESC_DEST_DROP_PKT,
70 	ICE_FLTR_PRGM_DESC_DEST_DIRECT_PKT_QINDEX,
71 	ICE_FLTR_PRGM_DESC_DEST_DIRECT_PKT_QGROUP,
72 	ICE_FLTR_PRGM_DESC_DEST_DIRECT_PKT_OTHER,
73 };
74 
75 enum ice_fltr_prgm_desc_fd_status {
76 	ICE_FLTR_PRGM_DESC_FD_STATUS_NONE,
77 	ICE_FLTR_PRGM_DESC_FD_STATUS_FD_ID,
78 	ICE_FLTR_PRGM_DESC_FD_STATUS_FD_ID_4FLEX_BYTES,
79 	ICE_FLTR_PRGM_DESC_FD_STATUS_8FLEX_BYTES,
80 };
81 
82 /* Flow Director (FD) Filter Programming descriptor */
83 struct ice_fd_fltr_desc_ctx {
84 	u32 fdid;
85 	u16 qindex;
86 	u16 cnt_index;
87 	u16 fd_vsi;
88 	u16 flex_val;
89 	u8 comp_q;
90 	u8 comp_report;
91 	u8 fd_space;
92 	u8 cnt_ena;
93 	u8 evict_ena;
94 	u8 toq;
95 	u8 toq_prio;
96 	u8 dpu_recipe;
97 	u8 drop;
98 	u8 flex_prio;
99 	u8 flex_mdid;
100 	u8 dtype;
101 	u8 pcmd;
102 	u8 desc_prof_prio;
103 	u8 desc_prof;
104 	u8 swap;
105 	u8 fdid_prio;
106 	u8 fdid_mdid;
107 };
108 
109 #define ICE_FLTR_PRGM_FLEX_WORD_SIZE	sizeof(__be16)
110 
111 struct ice_rx_flow_userdef {
112 	u16 flex_word;
113 	u16 flex_offset;
114 	u16 flex_fltr;
115 };
116 
117 struct ice_fdir_v4 {
118 	__be32 dst_ip;
119 	__be32 src_ip;
120 	__be16 dst_port;
121 	__be16 src_port;
122 	__be32 l4_header;
123 	__be32 sec_parm_idx;	/* security parameter index */
124 	u8 tos;
125 	u8 ip_ver;
126 	u8 proto;
127 	u8 ttl;
128 };
129 
130 #define ICE_IPV6_ADDR_LEN_AS_U32		4
131 
132 struct ice_fdir_v6 {
133 	__be32 dst_ip[ICE_IPV6_ADDR_LEN_AS_U32];
134 	__be32 src_ip[ICE_IPV6_ADDR_LEN_AS_U32];
135 	__be16 dst_port;
136 	__be16 src_port;
137 	__be32 l4_header; /* next header */
138 	__be32 sec_parm_idx; /* security parameter index */
139 	u8 tc;
140 	u8 proto;
141 	u8 hlim;
142 };
143 
144 struct ice_fdir_udp_gtp {
145 	u8 flags;
146 	u8 msg_type;
147 	__be16 rsrvd_len;
148 	__be32 teid;
149 	__be16 rsrvd_seq_nbr;
150 	u8 rsrvd_n_pdu_nbr;
151 	u8 rsrvd_next_ext_type;
152 	u8 rsvrd_ext_len;
153 	u8	pdu_type:4,
154 		spare:4;
155 	u8	ppp:1,
156 		rqi:1,
157 		qfi:6;
158 	u32 rsvrd;
159 	u8 next_ext;
160 };
161 
162 struct ice_fdir_l2tpv3 {
163 	__be32 session_id;
164 };
165 
166 struct ice_fdir_extra {
167 	u8 dst_mac[ETH_ALEN];	/* dest MAC address */
168 	u8 src_mac[ETH_ALEN];	/* src MAC address */
169 	__be16 ether_type;      /* for NON_IP_L2 */
170 	u32 usr_def[2];		/* user data */
171 	__be16 vlan_type;	/* VLAN ethertype */
172 	__be16 vlan_tag;	/* VLAN tag info */
173 };
174 
175 struct ice_fdir_fltr {
176 	struct LIST_ENTRY_TYPE fltr_node;
177 	enum ice_fltr_ptype flow_type;
178 
179 	union {
180 		struct ice_fdir_v4 v4;
181 		struct ice_fdir_v6 v6;
182 	} ip, mask;
183 
184 	/* for tunnel outer part */
185 	union {
186 		struct ice_fdir_v4 v4;
187 		struct ice_fdir_v6 v6;
188 	} ip_outer, mask_outer;
189 
190 	struct ice_fdir_extra ext_data_outer;
191 	struct ice_fdir_extra ext_mask_outer;
192 
193 	struct ice_fdir_udp_gtp gtpu_data;
194 	struct ice_fdir_udp_gtp gtpu_mask;
195 
196 	struct ice_fdir_l2tpv3 l2tpv3_data;
197 	struct ice_fdir_l2tpv3 l2tpv3_mask;
198 
199 	struct ice_fdir_extra ext_data;
200 	struct ice_fdir_extra ext_mask;
201 
202 	/* flex byte filter data */
203 	__be16 flex_word;
204 	/* queue region size (=2^q_region) */
205 	u8 q_region;
206 	u16 flex_offset;
207 	u16 flex_fltr;
208 
209 	/* filter control */
210 	u16 q_index;
211 	u16 dest_vsi;
212 	u8 dest_ctl;
213 	u8 cnt_ena;
214 	u8 fltr_status;
215 	u16 cnt_index;
216 	u32 fltr_id;
217 	u8 fdid_prio;
218 	u8 comp_report;
219 	/* Set to true for an ACL filter */
220 	bool acl_fltr;
221 };
222 
223 /* Dummy packet filter definition structure */
224 struct ice_fdir_base_pkt {
225 	enum ice_fltr_ptype flow;
226 	u16 pkt_len;
227 	const u8 *pkt;
228 	u16 tun_pkt_len;
229 	const u8 *tun_pkt;
230 };
231 
232 enum ice_status ice_alloc_fd_res_cntr(struct ice_hw *hw, u16 *cntr_id);
233 enum ice_status ice_free_fd_res_cntr(struct ice_hw *hw, u16 cntr_id);
234 enum ice_status
235 ice_alloc_fd_guar_item(struct ice_hw *hw, u16 *cntr_id, u16 num_fltr);
236 enum ice_status
237 ice_free_fd_guar_item(struct ice_hw *hw, u16 cntr_id, u16 num_fltr);
238 enum ice_status
239 ice_alloc_fd_shrd_item(struct ice_hw *hw, u16 *cntr_id, u16 num_fltr);
240 enum ice_status
241 ice_free_fd_shrd_item(struct ice_hw *hw, u16 cntr_id, u16 num_fltr);
242 enum ice_status ice_clear_pf_fd_table(struct ice_hw *hw);
243 void
244 ice_fdir_get_prgm_desc(struct ice_hw *hw, struct ice_fdir_fltr *input,
245 		       struct ice_fltr_desc *fdesc, bool add);
246 enum ice_status
247 ice_fdir_get_gen_prgm_pkt(struct ice_hw *hw, struct ice_fdir_fltr *input,
248 			  u8 *pkt, bool frag, bool tun);
249 enum ice_status
250 ice_fdir_get_prgm_pkt(struct ice_fdir_fltr *input, u8 *pkt, bool frag);
251 int ice_get_fdir_cnt_all(struct ice_hw *hw);
252 bool ice_fdir_is_dup_fltr(struct ice_hw *hw, struct ice_fdir_fltr *input);
253 bool ice_fdir_has_frag(enum ice_fltr_ptype flow);
254 struct ice_fdir_fltr *
255 ice_fdir_find_fltr_by_idx(struct ice_hw *hw, u32 fltr_idx);
256 void
257 ice_fdir_update_cntrs(struct ice_hw *hw, enum ice_fltr_ptype flow,
258 		      bool acl_fltr, bool add);
259 void ice_fdir_list_add_fltr(struct ice_hw *hw, struct ice_fdir_fltr *input);
260 #endif /* _ICE_FDIR_H_ */
261