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