xref: /dpdk/drivers/net/i40e/i40e_ethdev.h (revision a3c8a446)
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2010-2017 Intel Corporation
3  */
4 
5 #ifndef _I40E_ETHDEV_H_
6 #define _I40E_ETHDEV_H_
7 
8 #include <stdint.h>
9 
10 #include <rte_time.h>
11 #include <rte_kvargs.h>
12 #include <rte_hash.h>
13 #include <rte_flow.h>
14 #include <rte_flow_driver.h>
15 #include <rte_tm_driver.h>
16 #include "rte_pmd_i40e.h"
17 
18 #include "base/i40e_register.h"
19 #include "base/i40e_type.h"
20 #include "base/virtchnl.h"
21 
22 #define I40E_VLAN_TAG_SIZE        4
23 
24 #define I40E_AQ_LEN               32
25 #define I40E_AQ_BUF_SZ            4096
26 /* Number of queues per TC should be one of 1, 2, 4, 8, 16, 32, 64 */
27 #define I40E_MAX_Q_PER_TC         64
28 #define I40E_NUM_DESC_DEFAULT     512
29 #define I40E_NUM_DESC_ALIGN       32
30 #define I40E_BUF_SIZE_MIN         1024
31 #define I40E_FRAME_SIZE_MAX       9728
32 #define I40E_TSO_FRAME_SIZE_MAX   262144
33 #define I40E_QUEUE_BASE_ADDR_UNIT 128
34 /* number of VSIs and queue default setting */
35 #define I40E_MAX_QP_NUM_PER_VF    16
36 #define I40E_DEFAULT_QP_NUM_FDIR  1
37 #define I40E_UINT32_BIT_SIZE      (CHAR_BIT * sizeof(uint32_t))
38 #define I40E_VFTA_SIZE            (4096 / I40E_UINT32_BIT_SIZE)
39 /* Maximun number of MAC addresses */
40 #define I40E_NUM_MACADDR_MAX       64
41 /* Maximum number of VFs */
42 #define I40E_MAX_VF               128
43 /*flag of no loopback*/
44 #define I40E_AQ_LB_MODE_NONE	  0x0
45 /*
46  * vlan_id is a 12 bit number.
47  * The VFTA array is actually a 4096 bit array, 128 of 32bit elements.
48  * 2^5 = 32. The val of lower 5 bits specifies the bit in the 32bit element.
49  * The higher 7 bit val specifies VFTA array index.
50  */
51 #define I40E_VFTA_BIT(vlan_id)    (1 << ((vlan_id) & 0x1F))
52 #define I40E_VFTA_IDX(vlan_id)    ((vlan_id) >> 5)
53 
54 /* Default TC traffic in case DCB is not enabled */
55 #define I40E_DEFAULT_TCMAP        0x1
56 #define I40E_FDIR_QUEUE_ID        0
57 
58 /* Always assign pool 0 to main VSI, VMDQ will start from 1 */
59 #define I40E_VMDQ_POOL_BASE       1
60 
61 #define I40E_DEFAULT_RX_FREE_THRESH  32
62 #define I40E_DEFAULT_RX_PTHRESH      8
63 #define I40E_DEFAULT_RX_HTHRESH      8
64 #define I40E_DEFAULT_RX_WTHRESH      0
65 
66 #define I40E_DEFAULT_TX_FREE_THRESH  32
67 #define I40E_DEFAULT_TX_PTHRESH      32
68 #define I40E_DEFAULT_TX_HTHRESH      0
69 #define I40E_DEFAULT_TX_WTHRESH      0
70 #define I40E_DEFAULT_TX_RSBIT_THRESH 32
71 
72 /* Bit shift and mask */
73 #define I40E_4_BIT_WIDTH  (CHAR_BIT / 2)
74 #define I40E_4_BIT_MASK   RTE_LEN2MASK(I40E_4_BIT_WIDTH, uint8_t)
75 #define I40E_8_BIT_WIDTH  CHAR_BIT
76 #define I40E_8_BIT_MASK   UINT8_MAX
77 #define I40E_16_BIT_WIDTH (CHAR_BIT * 2)
78 #define I40E_16_BIT_MASK  UINT16_MAX
79 #define I40E_32_BIT_WIDTH (CHAR_BIT * 4)
80 #define I40E_32_BIT_MASK  UINT32_MAX
81 #define I40E_48_BIT_WIDTH (CHAR_BIT * 6)
82 #define I40E_48_BIT_MASK  RTE_LEN2MASK(I40E_48_BIT_WIDTH, uint64_t)
83 
84 /* Linux PF host with virtchnl version 1.1 */
85 #define PF_IS_V11(vf) \
86 	(((vf)->version_major == VIRTCHNL_VERSION_MAJOR) && \
87 	((vf)->version_minor == 1))
88 
89 #define I40E_WRITE_GLB_REG(hw, reg, value)				\
90 	do {								\
91 		uint32_t ori_val;					\
92 		struct rte_eth_dev *dev;				\
93 		ori_val = I40E_READ_REG((hw), (reg));			\
94 		dev = ((struct i40e_adapter *)hw->back)->eth_dev;	\
95 		I40E_PCI_REG_WRITE(I40E_PCI_REG_ADDR((hw),		\
96 						     (reg)), (value));	\
97 		if (ori_val != value)					\
98 			PMD_DRV_LOG(WARNING,				\
99 				    "i40e device %s changed global "	\
100 				    "register [0x%08x]. original: 0x%08x, " \
101 				    "new: 0x%08x ",			\
102 				    (dev->device->name), (reg),		\
103 				    (ori_val), (value));		\
104 	} while (0)
105 
106 /* index flex payload per layer */
107 enum i40e_flxpld_layer_idx {
108 	I40E_FLXPLD_L2_IDX    = 0,
109 	I40E_FLXPLD_L3_IDX    = 1,
110 	I40E_FLXPLD_L4_IDX    = 2,
111 	I40E_MAX_FLXPLD_LAYER = 3,
112 };
113 #define I40E_MAX_FLXPLD_FIED        3  /* max number of flex payload fields */
114 #define I40E_FDIR_BITMASK_NUM_WORD  2  /* max number of bitmask words */
115 #define I40E_FDIR_MAX_FLEXWORD_NUM  8  /* max number of flexpayload words */
116 #define I40E_FDIR_MAX_FLEX_LEN      16 /* len in bytes of flex payload */
117 #define I40E_INSET_MASK_NUM_REG     2  /* number of input set mask registers */
118 
119 /* i40e flags */
120 #define I40E_FLAG_RSS                   (1ULL << 0)
121 #define I40E_FLAG_DCB                   (1ULL << 1)
122 #define I40E_FLAG_VMDQ                  (1ULL << 2)
123 #define I40E_FLAG_SRIOV                 (1ULL << 3)
124 #define I40E_FLAG_HEADER_SPLIT_DISABLED (1ULL << 4)
125 #define I40E_FLAG_HEADER_SPLIT_ENABLED  (1ULL << 5)
126 #define I40E_FLAG_FDIR                  (1ULL << 6)
127 #define I40E_FLAG_VXLAN                 (1ULL << 7)
128 #define I40E_FLAG_RSS_AQ_CAPABLE        (1ULL << 8)
129 #define I40E_FLAG_ALL (I40E_FLAG_RSS | \
130 		       I40E_FLAG_DCB | \
131 		       I40E_FLAG_VMDQ | \
132 		       I40E_FLAG_SRIOV | \
133 		       I40E_FLAG_HEADER_SPLIT_DISABLED | \
134 		       I40E_FLAG_HEADER_SPLIT_ENABLED | \
135 		       I40E_FLAG_FDIR | \
136 		       I40E_FLAG_VXLAN | \
137 		       I40E_FLAG_RSS_AQ_CAPABLE)
138 
139 #define I40E_RSS_OFFLOAD_ALL ( \
140 	ETH_RSS_FRAG_IPV4 | \
141 	ETH_RSS_NONFRAG_IPV4_TCP | \
142 	ETH_RSS_NONFRAG_IPV4_UDP | \
143 	ETH_RSS_NONFRAG_IPV4_SCTP | \
144 	ETH_RSS_NONFRAG_IPV4_OTHER | \
145 	ETH_RSS_FRAG_IPV6 | \
146 	ETH_RSS_NONFRAG_IPV6_TCP | \
147 	ETH_RSS_NONFRAG_IPV6_UDP | \
148 	ETH_RSS_NONFRAG_IPV6_SCTP | \
149 	ETH_RSS_NONFRAG_IPV6_OTHER | \
150 	ETH_RSS_L2_PAYLOAD)
151 
152 /* All bits of RSS hash enable for X722*/
153 #define I40E_RSS_HENA_ALL_X722 ( \
154 	(1ULL << I40E_FILTER_PCTYPE_NONF_UNICAST_IPV4_UDP) | \
155 	(1ULL << I40E_FILTER_PCTYPE_NONF_MULTICAST_IPV4_UDP) | \
156 	(1ULL << I40E_FILTER_PCTYPE_NONF_IPV4_TCP_SYN_NO_ACK) | \
157 	(1ULL << I40E_FILTER_PCTYPE_NONF_UNICAST_IPV6_UDP) | \
158 	(1ULL << I40E_FILTER_PCTYPE_NONF_MULTICAST_IPV6_UDP) | \
159 	(1ULL << I40E_FILTER_PCTYPE_NONF_IPV6_TCP_SYN_NO_ACK) | \
160 	I40E_RSS_HENA_ALL)
161 
162 /* All bits of RSS hash enable */
163 #define I40E_RSS_HENA_ALL ( \
164 	(1ULL << I40E_FILTER_PCTYPE_NONF_IPV4_UDP) | \
165 	(1ULL << I40E_FILTER_PCTYPE_NONF_IPV4_TCP) | \
166 	(1ULL << I40E_FILTER_PCTYPE_NONF_IPV4_SCTP) | \
167 	(1ULL << I40E_FILTER_PCTYPE_NONF_IPV4_OTHER) | \
168 	(1ULL << I40E_FILTER_PCTYPE_FRAG_IPV4) | \
169 	(1ULL << I40E_FILTER_PCTYPE_NONF_IPV6_UDP) | \
170 	(1ULL << I40E_FILTER_PCTYPE_NONF_IPV6_TCP) | \
171 	(1ULL << I40E_FILTER_PCTYPE_NONF_IPV6_SCTP) | \
172 	(1ULL << I40E_FILTER_PCTYPE_NONF_IPV6_OTHER) | \
173 	(1ULL << I40E_FILTER_PCTYPE_FRAG_IPV6) | \
174 	(1ULL << I40E_FILTER_PCTYPE_FCOE_OX) | \
175 	(1ULL << I40E_FILTER_PCTYPE_FCOE_RX) | \
176 	(1ULL << I40E_FILTER_PCTYPE_FCOE_OTHER) | \
177 	(1ULL << I40E_FILTER_PCTYPE_L2_PAYLOAD))
178 
179 #define I40E_MISC_VEC_ID                RTE_INTR_VEC_ZERO_OFFSET
180 #define I40E_RX_VEC_START               RTE_INTR_VEC_RXTX_OFFSET
181 
182 /* Default queue interrupt throttling time in microseconds */
183 #define I40E_ITR_INDEX_DEFAULT          0
184 #define I40E_ITR_INDEX_NONE             3
185 #define I40E_QUEUE_ITR_INTERVAL_DEFAULT 32 /* 32 us */
186 #define I40E_QUEUE_ITR_INTERVAL_MAX     8160 /* 8160 us */
187 #define I40E_VF_QUEUE_ITR_INTERVAL_DEFAULT 32 /* 32 us */
188 /* Special FW support this floating VEB feature */
189 #define FLOATING_VEB_SUPPORTED_FW_MAJ 5
190 #define FLOATING_VEB_SUPPORTED_FW_MIN 0
191 
192 #define I40E_GL_SWT_L2TAGCTRL(_i)             (0x001C0A70 + ((_i) * 4))
193 #define I40E_GL_SWT_L2TAGCTRL_ETHERTYPE_SHIFT 16
194 #define I40E_GL_SWT_L2TAGCTRL_ETHERTYPE_MASK  \
195 	I40E_MASK(0xFFFF, I40E_GL_SWT_L2TAGCTRL_ETHERTYPE_SHIFT)
196 
197 #define I40E_RSS_TYPE_NONE           0ULL
198 #define I40E_RSS_TYPE_INVALID        1ULL
199 
200 #define I40E_INSET_NONE            0x00000000000000000ULL
201 
202 /* bit0 ~ bit 7 */
203 #define I40E_INSET_DMAC            0x0000000000000001ULL
204 #define I40E_INSET_SMAC            0x0000000000000002ULL
205 #define I40E_INSET_VLAN_OUTER      0x0000000000000004ULL
206 #define I40E_INSET_VLAN_INNER      0x0000000000000008ULL
207 #define I40E_INSET_VLAN_TUNNEL     0x0000000000000010ULL
208 
209 /* bit 8 ~ bit 15 */
210 #define I40E_INSET_IPV4_SRC        0x0000000000000100ULL
211 #define I40E_INSET_IPV4_DST        0x0000000000000200ULL
212 #define I40E_INSET_IPV6_SRC        0x0000000000000400ULL
213 #define I40E_INSET_IPV6_DST        0x0000000000000800ULL
214 #define I40E_INSET_SRC_PORT        0x0000000000001000ULL
215 #define I40E_INSET_DST_PORT        0x0000000000002000ULL
216 #define I40E_INSET_SCTP_VT         0x0000000000004000ULL
217 
218 /* bit 16 ~ bit 31 */
219 #define I40E_INSET_IPV4_TOS        0x0000000000010000ULL
220 #define I40E_INSET_IPV4_PROTO      0x0000000000020000ULL
221 #define I40E_INSET_IPV4_TTL        0x0000000000040000ULL
222 #define I40E_INSET_IPV6_TC         0x0000000000080000ULL
223 #define I40E_INSET_IPV6_FLOW       0x0000000000100000ULL
224 #define I40E_INSET_IPV6_NEXT_HDR   0x0000000000200000ULL
225 #define I40E_INSET_IPV6_HOP_LIMIT  0x0000000000400000ULL
226 #define I40E_INSET_TCP_FLAGS       0x0000000000800000ULL
227 
228 /* bit 32 ~ bit 47, tunnel fields */
229 #define I40E_INSET_TUNNEL_IPV4_DST       0x0000000100000000ULL
230 #define I40E_INSET_TUNNEL_IPV6_DST       0x0000000200000000ULL
231 #define I40E_INSET_TUNNEL_DMAC           0x0000000400000000ULL
232 #define I40E_INSET_TUNNEL_SRC_PORT       0x0000000800000000ULL
233 #define I40E_INSET_TUNNEL_DST_PORT       0x0000001000000000ULL
234 #define I40E_INSET_TUNNEL_ID             0x0000002000000000ULL
235 
236 /* bit 48 ~ bit 55 */
237 #define I40E_INSET_LAST_ETHER_TYPE 0x0001000000000000ULL
238 
239 /* bit 56 ~ bit 63, Flex Payload */
240 #define I40E_INSET_FLEX_PAYLOAD_W1 0x0100000000000000ULL
241 #define I40E_INSET_FLEX_PAYLOAD_W2 0x0200000000000000ULL
242 #define I40E_INSET_FLEX_PAYLOAD_W3 0x0400000000000000ULL
243 #define I40E_INSET_FLEX_PAYLOAD_W4 0x0800000000000000ULL
244 #define I40E_INSET_FLEX_PAYLOAD_W5 0x1000000000000000ULL
245 #define I40E_INSET_FLEX_PAYLOAD_W6 0x2000000000000000ULL
246 #define I40E_INSET_FLEX_PAYLOAD_W7 0x4000000000000000ULL
247 #define I40E_INSET_FLEX_PAYLOAD_W8 0x8000000000000000ULL
248 #define I40E_INSET_FLEX_PAYLOAD \
249 	(I40E_INSET_FLEX_PAYLOAD_W1 | I40E_INSET_FLEX_PAYLOAD_W2 | \
250 	I40E_INSET_FLEX_PAYLOAD_W3 | I40E_INSET_FLEX_PAYLOAD_W4 | \
251 	I40E_INSET_FLEX_PAYLOAD_W5 | I40E_INSET_FLEX_PAYLOAD_W6 | \
252 	I40E_INSET_FLEX_PAYLOAD_W7 | I40E_INSET_FLEX_PAYLOAD_W8)
253 
254 /* The max bandwidth of i40e is 40Gbps. */
255 #define I40E_QOS_BW_MAX 40000
256 /* The bandwidth should be the multiple of 50Mbps. */
257 #define I40E_QOS_BW_GRANULARITY 50
258 /* The min bandwidth weight is 1. */
259 #define I40E_QOS_BW_WEIGHT_MIN 1
260 /* The max bandwidth weight is 127. */
261 #define I40E_QOS_BW_WEIGHT_MAX 127
262 /* The max queue region index is 7. */
263 #define I40E_REGION_MAX_INDEX 7
264 
265 #define I40E_MAX_PERCENT            100
266 #define I40E_DEFAULT_DCB_APP_NUM    1
267 #define I40E_DEFAULT_DCB_APP_PRIO   3
268 
269 #define I40E_FDIR_PRG_PKT_CNT       128
270 
271 /*
272  * Struct to store flow created.
273  */
274 struct rte_flow {
275 	TAILQ_ENTRY(rte_flow) node;
276 	enum rte_filter_type filter_type;
277 	void *rule;
278 };
279 
280 /**
281  * The overhead from MTU to max frame size.
282  * Considering QinQ packet, the VLAN tag needs to be counted twice.
283  */
284 #define I40E_ETH_OVERHEAD \
285 	(RTE_ETHER_HDR_LEN + RTE_ETHER_CRC_LEN + I40E_VLAN_TAG_SIZE * 2)
286 #define I40E_ETH_MAX_LEN (RTE_ETHER_MTU + I40E_ETH_OVERHEAD)
287 
288 #define I40E_RXTX_BYTES_H_16_BIT(bytes) ((bytes) & ~I40E_48_BIT_MASK)
289 #define I40E_RXTX_BYTES_L_48_BIT(bytes) ((bytes) & I40E_48_BIT_MASK)
290 
291 struct i40e_adapter;
292 struct rte_pci_driver;
293 
294 /**
295  * MAC filter type
296  */
297 enum i40e_mac_filter_type {
298 	I40E_MAC_PERFECT_MATCH = 1, /**< exact match of MAC addr. */
299 	I40E_MACVLAN_PERFECT_MATCH, /**< exact match of MAC addr and VLAN ID. */
300 	I40E_MAC_HASH_MATCH, /**< hash match of MAC addr. */
301 	/** hash match of MAC addr and exact match of VLAN ID. */
302 	I40E_MACVLAN_HASH_MATCH,
303 };
304 
305 /**
306  * MAC filter structure
307  */
308 struct i40e_mac_filter_info {
309 	enum i40e_mac_filter_type filter_type;
310 	struct rte_ether_addr mac_addr;
311 };
312 
313 TAILQ_HEAD(i40e_mac_filter_list, i40e_mac_filter);
314 
315 /* MAC filter list structure */
316 struct i40e_mac_filter {
317 	TAILQ_ENTRY(i40e_mac_filter) next;
318 	struct i40e_mac_filter_info mac_info;
319 };
320 
321 TAILQ_HEAD(i40e_vsi_list_head, i40e_vsi_list);
322 
323 struct i40e_vsi;
324 
325 /* VSI list structure */
326 struct i40e_vsi_list {
327 	TAILQ_ENTRY(i40e_vsi_list) list;
328 	struct i40e_vsi *vsi;
329 };
330 
331 struct i40e_rx_queue;
332 struct i40e_tx_queue;
333 
334 /* Bandwidth limit information */
335 struct i40e_bw_info {
336 	uint16_t bw_limit;      /* BW Limit (0 = disabled) */
337 	uint8_t  bw_max;        /* Max BW limit if enabled */
338 
339 	/* Relative credits within same TC with respect to other VSIs or Comps */
340 	uint8_t  bw_ets_share_credits[I40E_MAX_TRAFFIC_CLASS];
341 	/* Bandwidth limit per TC */
342 	uint16_t bw_ets_credits[I40E_MAX_TRAFFIC_CLASS];
343 	/* Max bandwidth limit per TC */
344 	uint8_t  bw_ets_max[I40E_MAX_TRAFFIC_CLASS];
345 };
346 
347 /* Structure that defines a VEB */
348 struct i40e_veb {
349 	struct i40e_vsi_list_head head;
350 	struct i40e_vsi *associate_vsi; /* Associate VSI who owns the VEB */
351 	struct i40e_pf *associate_pf; /* Associate PF who owns the VEB */
352 	uint16_t seid; /* The seid of VEB itself */
353 	uint16_t uplink_seid; /* The uplink seid of this VEB */
354 	uint16_t stats_idx;
355 	struct i40e_eth_stats stats;
356 	uint8_t enabled_tc;   /* The traffic class enabled */
357 	uint8_t strict_prio_tc; /* bit map of TCs set to strict priority mode */
358 	struct i40e_bw_info bw_info; /* VEB bandwidth information */
359 };
360 
361 /* i40e MACVLAN filter structure */
362 struct i40e_macvlan_filter {
363 	struct rte_ether_addr macaddr;
364 	enum i40e_mac_filter_type filter_type;
365 	uint16_t vlan_id;
366 };
367 
368 /*
369  * Structure that defines a VSI, associated with a adapter.
370  */
371 struct i40e_vsi {
372 	struct i40e_adapter *adapter; /* Backreference to associated adapter */
373 	struct i40e_aqc_vsi_properties_data info; /* VSI properties */
374 
375 	struct i40e_eth_stats eth_stats_offset;
376 	struct i40e_eth_stats eth_stats;
377 	/*
378 	 * When drivers loaded, only a default main VSI exists. In case new VSI
379 	 * needs to add, HW needs to know the layout that VSIs are organized.
380 	 * Besides that, VSI isan element and can't switch packets, which needs
381 	 * to add new component VEB to perform switching. So, a new VSI needs
382 	 * to specify the uplink VSI (Parent VSI) before created. The
383 	 * uplink VSI will check whether it had a VEB to switch packets. If no,
384 	 * it will try to create one. Then, uplink VSI will move the new VSI
385 	 * into its' sib_vsi_list to manage all the downlink VSI.
386 	 *  sib_vsi_list: the VSI list that shared the same uplink VSI.
387 	 *  parent_vsi  : the uplink VSI. It's NULL for main VSI.
388 	 *  veb         : the VEB associates with the VSI.
389 	 */
390 	struct i40e_vsi_list sib_vsi_list; /* sibling vsi list */
391 	struct i40e_vsi *parent_vsi;
392 	struct i40e_veb *veb;    /* Associated veb, could be null */
393 	struct i40e_veb *floating_veb; /* Associated floating veb */
394 	bool offset_loaded;
395 	enum i40e_vsi_type type; /* VSI types */
396 	uint16_t vlan_num;       /* Total VLAN number */
397 	uint16_t mac_num;        /* Total mac number */
398 	uint32_t vfta[I40E_VFTA_SIZE];        /* VLAN bitmap */
399 	struct i40e_mac_filter_list mac_list; /* macvlan filter list */
400 	/* specific VSI-defined parameters, SRIOV stored the vf_id */
401 	uint32_t user_param;
402 	uint16_t seid;           /* The seid of VSI itself */
403 	uint16_t uplink_seid;    /* The uplink seid of this VSI */
404 	uint16_t nb_qps;         /* Number of queue pairs VSI can occupy */
405 	uint16_t nb_used_qps;    /* Number of queue pairs VSI uses */
406 	uint16_t max_macaddrs;   /* Maximum number of MAC addresses */
407 	uint16_t base_queue;     /* The first queue index of this VSI */
408 	/*
409 	 * The offset to visit VSI related register, assigned by HW when
410 	 * creating VSI
411 	 */
412 	uint16_t vsi_id;
413 	uint16_t msix_intr; /* The MSIX interrupt binds to VSI */
414 	uint16_t nb_msix;   /* The max number of msix vector */
415 	uint8_t enabled_tc; /* The traffic class enabled */
416 	uint8_t vlan_anti_spoof_on; /* The VLAN anti-spoofing enabled */
417 	uint8_t vlan_filter_on; /* The VLAN filter enabled */
418 	struct i40e_bw_info bw_info; /* VSI bandwidth information */
419 	uint64_t prev_rx_bytes;
420 	uint64_t prev_tx_bytes;
421 };
422 
423 struct pool_entry {
424 	LIST_ENTRY(pool_entry) next;
425 	uint16_t base;
426 	uint16_t len;
427 };
428 
429 LIST_HEAD(res_list, pool_entry);
430 
431 struct i40e_res_pool_info {
432 	uint32_t base;              /* Resource start index */
433 	uint32_t num_alloc;         /* Allocated resource number */
434 	uint32_t num_free;          /* Total available resource number */
435 	struct res_list alloc_list; /* Allocated resource list */
436 	struct res_list free_list;  /* Available resource list */
437 };
438 
439 enum I40E_VF_STATE {
440 	I40E_VF_INACTIVE = 0,
441 	I40E_VF_INRESET,
442 	I40E_VF_ININIT,
443 	I40E_VF_ACTIVE,
444 };
445 
446 /*
447  * Structure to store private data for PF host.
448  */
449 struct i40e_pf_vf {
450 	struct i40e_pf *pf;
451 	struct i40e_vsi *vsi;
452 	enum I40E_VF_STATE state; /* The number of queue pairs available */
453 	uint16_t vf_idx; /* VF index in pf->vfs */
454 	uint16_t lan_nb_qps; /* Actual queues allocated */
455 	uint16_t reset_cnt; /* Total vf reset times */
456 	struct rte_ether_addr mac_addr;  /* Default MAC address */
457 	/* version of the virtchnl from VF */
458 	struct virtchnl_version_info version;
459 	uint32_t request_caps; /* offload caps requested from VF */
460 	uint64_t num_mdd_events; /* num of mdd events detected */
461 
462 	/*
463 	 * Variables for store the arrival timestamp of VF messages.
464 	 * If the timestamp of latest message stored at
465 	 * `msg_timestamps[index % max]` then the timestamp of
466 	 * earliest message stored at `msg_time[(index + 1) % max]`.
467 	 * When a new message come, the timestamp of this message
468 	 * will be stored at `msg_timestamps[(index + 1) % max]` and the
469 	 * earliest message timestamp is at
470 	 * `msg_timestamps[(index + 2) % max]` now...
471 	 */
472 	uint32_t msg_index;
473 	uint64_t *msg_timestamps;
474 
475 	/* cycle of stop ignoring VF message */
476 	uint64_t ignore_end_cycle;
477 };
478 
479 /*
480  * Structure to store private data for flow control.
481  */
482 struct i40e_fc_conf {
483 	uint16_t pause_time; /* Flow control pause timer */
484 	/* FC high water 0-7 for pfc and 8 for lfc unit:kilobytes */
485 	uint32_t high_water[I40E_MAX_TRAFFIC_CLASS + 1];
486 	/* FC low water  0-7 for pfc and 8 for lfc unit:kilobytes */
487 	uint32_t low_water[I40E_MAX_TRAFFIC_CLASS + 1];
488 };
489 
490 /*
491  * Structure to store private data for VMDQ instance
492  */
493 struct i40e_vmdq_info {
494 	struct i40e_pf *pf;
495 	struct i40e_vsi *vsi;
496 };
497 
498 #define I40E_FDIR_MAX_FLEXLEN      16  /**< Max length of flexbytes. */
499 #define I40E_MAX_FLX_SOURCE_OFF    480
500 #define NONUSE_FLX_PIT_DEST_OFF 63
501 #define NONUSE_FLX_PIT_FSIZE    1
502 #define I40E_FLX_OFFSET_IN_FIELD_VECTOR   50
503 #define MK_FLX_PIT(src_offset, fsize, dst_offset) ( \
504 	(((src_offset) << I40E_PRTQF_FLX_PIT_SOURCE_OFF_SHIFT) & \
505 		I40E_PRTQF_FLX_PIT_SOURCE_OFF_MASK) | \
506 	(((fsize) << I40E_PRTQF_FLX_PIT_FSIZE_SHIFT) & \
507 			I40E_PRTQF_FLX_PIT_FSIZE_MASK) | \
508 	((((dst_offset) == NONUSE_FLX_PIT_DEST_OFF ? \
509 			NONUSE_FLX_PIT_DEST_OFF : \
510 			((dst_offset) + I40E_FLX_OFFSET_IN_FIELD_VECTOR)) << \
511 			I40E_PRTQF_FLX_PIT_DEST_OFF_SHIFT) & \
512 			I40E_PRTQF_FLX_PIT_DEST_OFF_MASK))
513 #define I40E_WORD(hi, lo) (uint16_t)((((hi) << 8) & 0xFF00) | ((lo) & 0xFF))
514 #define I40E_FLEX_WORD_MASK(off) (0x80 >> (off))
515 #define I40E_FDIR_IPv6_TC_OFFSET	20
516 
517 /* A structure used to define the input for GTP flow */
518 struct i40e_gtp_flow {
519 	struct rte_eth_udpv4_flow udp; /* IPv4 UDP fields to match. */
520 	uint8_t msg_type;              /* Message type. */
521 	uint32_t teid;                 /* TEID in big endian. */
522 };
523 
524 /* A structure used to define the input for GTP IPV4 flow */
525 struct i40e_gtp_ipv4_flow {
526 	struct i40e_gtp_flow gtp;
527 	struct rte_eth_ipv4_flow ip4;
528 };
529 
530 /* A structure used to define the input for GTP IPV6 flow */
531 struct i40e_gtp_ipv6_flow {
532 	struct i40e_gtp_flow gtp;
533 	struct rte_eth_ipv6_flow ip6;
534 };
535 
536 /* A structure used to define the input for ESP IPV4 flow */
537 struct i40e_esp_ipv4_flow {
538 	struct rte_eth_ipv4_flow ipv4;
539 	uint32_t spi;	/* SPI in big endian. */
540 };
541 
542 /* A structure used to define the input for ESP IPV6 flow */
543 struct i40e_esp_ipv6_flow {
544 	struct rte_eth_ipv6_flow ipv6;
545 	uint32_t spi;	/* SPI in big endian. */
546 };
547 /* A structure used to define the input for ESP IPV4 UDP flow */
548 struct i40e_esp_ipv4_udp_flow {
549 	struct rte_eth_udpv4_flow udp;
550 	uint32_t spi;	/* SPI in big endian. */
551 };
552 
553 /* A structure used to define the input for ESP IPV6 UDP flow */
554 struct i40e_esp_ipv6_udp_flow {
555 	struct rte_eth_udpv6_flow udp;
556 	uint32_t spi;	/* SPI in big endian. */
557 };
558 
559 /* A structure used to define the input for raw type flow */
560 struct i40e_raw_flow {
561 	uint16_t pctype;
562 	void *packet;
563 	uint32_t length;
564 };
565 
566 /* A structure used to define the input for L2TPv3 over IPv4 flow */
567 struct i40e_ipv4_l2tpv3oip_flow {
568 	struct rte_eth_ipv4_flow ip4;
569 	uint32_t session_id; /* Session ID in big endian. */
570 };
571 
572 /* A structure used to define the input for L2TPv3 over IPv6 flow */
573 struct i40e_ipv6_l2tpv3oip_flow {
574 	struct rte_eth_ipv6_flow ip6;
575 	uint32_t session_id; /* Session ID in big endian. */
576 };
577 
578 /* A structure used to define the input for l2 dst type flow */
579 struct i40e_l2_flow {
580 	struct rte_ether_addr dst;
581 	struct rte_ether_addr src;
582 	uint16_t ether_type;          /**< Ether type in big endian */
583 };
584 
585 /*
586  * A union contains the inputs for all types of flow
587  * items in flows need to be in big endian
588  */
589 union i40e_fdir_flow {
590 	struct i40e_l2_flow             l2_flow;
591 	struct rte_eth_udpv4_flow       udp4_flow;
592 	struct rte_eth_tcpv4_flow       tcp4_flow;
593 	struct rte_eth_sctpv4_flow      sctp4_flow;
594 	struct rte_eth_ipv4_flow        ip4_flow;
595 	struct rte_eth_udpv6_flow       udp6_flow;
596 	struct rte_eth_tcpv6_flow       tcp6_flow;
597 	struct rte_eth_sctpv6_flow      sctp6_flow;
598 	struct rte_eth_ipv6_flow        ipv6_flow;
599 	struct i40e_gtp_flow            gtp_flow;
600 	struct i40e_gtp_ipv4_flow       gtp_ipv4_flow;
601 	struct i40e_gtp_ipv6_flow       gtp_ipv6_flow;
602 	struct i40e_raw_flow            raw_flow;
603 	struct i40e_ipv4_l2tpv3oip_flow ip4_l2tpv3oip_flow;
604 	struct i40e_ipv6_l2tpv3oip_flow ip6_l2tpv3oip_flow;
605 	struct i40e_esp_ipv4_flow       esp_ipv4_flow;
606 	struct i40e_esp_ipv6_flow       esp_ipv6_flow;
607 	struct i40e_esp_ipv4_udp_flow   esp_ipv4_udp_flow;
608 	struct i40e_esp_ipv6_udp_flow   esp_ipv6_udp_flow;
609 };
610 
611 enum i40e_fdir_ip_type {
612 	I40E_FDIR_IPTYPE_IPV4,
613 	I40E_FDIR_IPTYPE_IPV6,
614 };
615 
616 /**
617  * Structure to store flex pit for flow diretor.
618  */
619 struct i40e_fdir_flex_pit {
620 	uint8_t src_offset; /* offset in words from the beginning of payload */
621 	uint8_t size;       /* size in words */
622 	uint8_t dst_offset; /* offset in words of flexible payload */
623 };
624 
625 /* A structure used to contain extend input of flow */
626 struct i40e_fdir_flow_ext {
627 	uint16_t vlan_tci;
628 	uint8_t flexbytes[RTE_ETH_FDIR_MAX_FLEXLEN];
629 	/* It is filled by the flexible payload to match. */
630 	uint8_t flex_mask[I40E_FDIR_MAX_FLEX_LEN];
631 	uint8_t raw_id;
632 	uint8_t is_vf;   /* 1 for VF, 0 for port dev */
633 	uint16_t dst_id; /* VF ID, available when is_vf is 1*/
634 	uint64_t input_set;
635 	bool inner_ip;   /* If there is inner ip */
636 	enum i40e_fdir_ip_type iip_type; /* ip type for inner ip */
637 	enum i40e_fdir_ip_type oip_type; /* ip type for outer ip */
638 	bool customized_pctype; /* If customized pctype is used */
639 	bool pkt_template; /* If raw packet template is used */
640 	bool is_udp; /* ipv4|ipv6 udp flow */
641 	enum i40e_flxpld_layer_idx layer_idx;
642 	struct i40e_fdir_flex_pit flex_pit[I40E_MAX_FLXPLD_LAYER * I40E_MAX_FLXPLD_FIED];
643 	bool is_flex_flow;
644 };
645 
646 /* A structure used to define the input for a flow director filter entry */
647 struct i40e_fdir_input {
648 	enum i40e_filter_pctype pctype;
649 	union i40e_fdir_flow flow;
650 	/* Flow fields to match, dependent on flow_type */
651 	struct i40e_fdir_flow_ext flow_ext;
652 	/* Additional fields to match */
653 };
654 
655 /* Behavior will be taken if FDIR match */
656 enum i40e_fdir_behavior {
657 	I40E_FDIR_ACCEPT = 0,
658 	I40E_FDIR_REJECT,
659 	I40E_FDIR_PASSTHRU,
660 };
661 
662 /* Flow director report status
663  * It defines what will be reported if FDIR entry is matched.
664  */
665 enum i40e_fdir_status {
666 	I40E_FDIR_NO_REPORT_STATUS = 0, /* Report nothing. */
667 	I40E_FDIR_REPORT_ID,            /* Only report FD ID. */
668 	I40E_FDIR_REPORT_ID_FLEX_4,     /* Report FD ID and 4 flex bytes. */
669 	I40E_FDIR_REPORT_FLEX_8,        /* Report 8 flex bytes. */
670 };
671 
672 /* A structure used to define an action when match FDIR packet filter. */
673 struct i40e_fdir_action {
674 	uint16_t rx_queue;        /* Queue assigned to if FDIR match. */
675 	enum i40e_fdir_behavior behavior;     /* Behavior will be taken */
676 	enum i40e_fdir_status report_status;  /* Status report option */
677 	/* If report_status is I40E_FDIR_REPORT_ID_FLEX_4 or
678 	 * I40E_FDIR_REPORT_FLEX_8, flex_off specifies where the reported
679 	 * flex bytes start from in flexible payload.
680 	 */
681 	uint8_t flex_off;
682 };
683 
684 /* A structure used to define the flow director filter entry by filter_ctrl API
685  * It supports RTE_ETH_FILTER_FDIR data representation.
686  */
687 struct i40e_fdir_filter_conf {
688 	uint32_t soft_id;
689 	/* ID, an unique value is required when deal with FDIR entry */
690 	struct i40e_fdir_input input;    /* Input set */
691 	struct i40e_fdir_action action;  /* Action taken when match */
692 };
693 
694 struct i40e_fdir_flex_mask {
695 	uint8_t word_mask;  /**< Bit i enables word i of flexible payload */
696 	uint8_t nb_bitmask;
697 	struct {
698 		uint8_t offset;
699 		uint16_t mask;
700 	} bitmask[I40E_FDIR_BITMASK_NUM_WORD];
701 };
702 
703 #define I40E_FILTER_PCTYPE_INVALID 0
704 #define I40E_FILTER_PCTYPE_MAX     64
705 #define I40E_MAX_FDIR_FILTER_NUM   (1024 * 8)
706 
707 struct i40e_fdir_filter {
708 	TAILQ_ENTRY(i40e_fdir_filter) rules;
709 	struct i40e_fdir_filter_conf fdir;
710 };
711 
712 /* fdir memory pool entry */
713 struct i40e_fdir_entry {
714 	struct rte_flow flow;
715 	uint32_t idx;
716 };
717 
718 /* pre-allocated fdir memory pool */
719 struct i40e_fdir_flow_pool {
720 	/* a bitmap to manage the fdir pool */
721 	struct rte_bitmap *bitmap;
722 	/* the size the pool is pf->fdir->fdir_space_size */
723 	struct i40e_fdir_entry *pool;
724 };
725 
726 #define FLOW_TO_FLOW_BITMAP(f) \
727 	container_of((f), struct i40e_fdir_entry, flow)
728 
729 TAILQ_HEAD(i40e_fdir_filter_list, i40e_fdir_filter);
730 /*
731  *  A structure used to define fields of a FDIR related info.
732  */
733 struct i40e_fdir_info {
734 	struct i40e_vsi *fdir_vsi;     /* pointer to fdir VSI structure */
735 	uint16_t match_counter_index;  /* Statistic counter index used for fdir*/
736 	struct i40e_tx_queue *txq;
737 	struct i40e_rx_queue *rxq;
738 	void *prg_pkt[I40E_FDIR_PRG_PKT_CNT];     /* memory for fdir program packet */
739 	uint64_t dma_addr[I40E_FDIR_PRG_PKT_CNT]; /* physic address of packet memory*/
740 	/*
741 	 * txq available buffer counter, indicates how many available buffers
742 	 * for fdir programming, initialized as I40E_FDIR_PRG_PKT_CNT
743 	 */
744 	int txq_available_buf_count;
745 
746 	/* input set bits for each pctype */
747 	uint64_t input_set[I40E_FILTER_PCTYPE_MAX];
748 	/*
749 	 * the rule how bytes stream is extracted as flexible payload
750 	 * for each payload layer, the setting can up to three elements
751 	 */
752 	struct i40e_fdir_flex_pit flex_set[I40E_MAX_FLXPLD_LAYER * I40E_MAX_FLXPLD_FIED];
753 	struct i40e_fdir_flex_mask flex_mask[I40E_FILTER_PCTYPE_MAX];
754 
755 	struct i40e_fdir_filter_list fdir_list;
756 	struct i40e_fdir_filter **hash_map;
757 	struct rte_hash *hash_table;
758 	/* An array to store the inserted rules input */
759 	struct i40e_fdir_filter *fdir_filter_array;
760 
761 	/*
762 	 * Priority ordering at filter invalidation(destroying a flow) between
763 	 * "best effort" space and "guaranteed" space.
764 	 *
765 	 * 0 = At filter invalidation, the hardware first tries to increment the
766 	 * "best effort" space. The "guaranteed" space is incremented only when
767 	 * the global "best effort" space is at it max value or the "best effort"
768 	 * space of the PF is at its max value.
769 	 * 1 = At filter invalidation, the hardware first tries to increment its
770 	 * "guaranteed" space. The "best effort" space is incremented only when
771 	 * it is already at its max value.
772 	 */
773 	uint32_t fdir_invalprio;
774 	/* the total size of the fdir, this number is the sum of the guaranteed +
775 	 * shared space
776 	 */
777 	uint32_t fdir_space_size;
778 	/* the actual number of the fdir rules in hardware, initialized as 0 */
779 	uint32_t fdir_actual_cnt;
780 	/* the free guaranteed space of the fdir */
781 	uint32_t fdir_guarantee_free_space;
782 	/* the fdir total guaranteed space */
783 	uint32_t fdir_guarantee_total_space;
784 	/* the pre-allocated pool of the rte_flow */
785 	struct i40e_fdir_flow_pool fdir_flow_pool;
786 
787 	/* Mark if flex pit and mask is set */
788 	bool flex_pit_flag[I40E_MAX_FLXPLD_LAYER];
789 	bool flex_mask_flag[I40E_FILTER_PCTYPE_MAX];
790 
791 	bool inset_flag[I40E_FILTER_PCTYPE_MAX]; /* Mark if input set is set */
792 
793 	uint32_t flex_flow_count[I40E_MAX_FLXPLD_LAYER];
794 };
795 
796 /* Ethertype filter number HW supports */
797 #define I40E_MAX_ETHERTYPE_FILTER_NUM 768
798 
799 /* Ethertype filter struct */
800 struct i40e_ethertype_filter_input {
801 	struct rte_ether_addr mac_addr;   /* Mac address to match */
802 	uint16_t ether_type;          /* Ether type to match */
803 };
804 
805 struct i40e_ethertype_filter {
806 	TAILQ_ENTRY(i40e_ethertype_filter) rules;
807 	struct i40e_ethertype_filter_input input;
808 	uint16_t flags;              /* Flags from RTE_ETHTYPE_FLAGS_* */
809 	uint16_t queue;              /* Queue assigned to when match */
810 };
811 
812 TAILQ_HEAD(i40e_ethertype_filter_list, i40e_ethertype_filter);
813 
814 struct i40e_ethertype_rule {
815 	struct i40e_ethertype_filter_list ethertype_list;
816 	struct i40e_ethertype_filter  **hash_map;
817 	struct rte_hash *hash_table;
818 };
819 
820 /* queue region info */
821 struct i40e_queue_region_info {
822 	/* the region id for this configuration */
823 	uint8_t region_id;
824 	/* the start queue index for this region */
825 	uint8_t queue_start_index;
826 	/* the total queue number of this queue region */
827 	uint8_t queue_num;
828 	/* the total number of user priority for this region */
829 	uint8_t user_priority_num;
830 	/* the packet's user priority for this region */
831 	uint8_t user_priority[I40E_MAX_USER_PRIORITY];
832 	/* the total number of flowtype for this region */
833 	uint8_t flowtype_num;
834 	/**
835 	 * the pctype or hardware flowtype of packet,
836 	 * the specific index for each type has been defined
837 	 * in file i40e_type.h as enum i40e_filter_pctype.
838 	 */
839 	uint8_t hw_flowtype[I40E_FILTER_PCTYPE_MAX];
840 };
841 
842 struct i40e_queue_regions {
843 	/* the total number of queue region for this port */
844 	uint16_t queue_region_number;
845 	struct i40e_queue_region_info region[I40E_REGION_MAX_INDEX + 1];
846 };
847 
848 struct i40e_rss_pattern_info {
849 	uint8_t action_flag;
850 	uint64_t types;
851 };
852 
853 /* Tunnel filter number HW supports */
854 #define I40E_MAX_TUNNEL_FILTER_NUM 400
855 
856 #define I40E_AQC_REPLACE_CLOUD_CMD_INPUT_FV_TEID_WORD0 44
857 #define I40E_AQC_REPLACE_CLOUD_CMD_INPUT_FV_TEID_WORD1 45
858 #define I40E_AQC_REPLACE_CLOUD_CMD_INPUT_FV_SRC_PORT 29
859 #define I40E_AQC_REPLACE_CLOUD_CMD_INPUT_FV_DST_PORT 30
860 #define I40E_AQC_ADD_CLOUD_TNL_TYPE_MPLSOUDP	8
861 #define I40E_AQC_ADD_CLOUD_TNL_TYPE_MPLSOGRE	9
862 #define I40E_AQC_ADD_CLOUD_FILTER_0X10		0x10
863 #define I40E_AQC_ADD_CLOUD_FILTER_0X11		0x11
864 #define I40E_AQC_ADD_CLOUD_FILTER_0X12		0x12
865 #define I40E_AQC_ADD_L1_FILTER_0X10		0x10
866 #define I40E_AQC_ADD_L1_FILTER_0X11		0x11
867 #define I40E_AQC_ADD_L1_FILTER_0X12		0x12
868 #define I40E_AQC_ADD_L1_FILTER_0X13		0x13
869 #define I40E_AQC_NEW_TR_21			21
870 #define I40E_AQC_NEW_TR_22			22
871 
872 enum i40e_tunnel_iptype {
873 	I40E_TUNNEL_IPTYPE_IPV4,
874 	I40E_TUNNEL_IPTYPE_IPV6,
875 };
876 
877 /* Tunnel filter struct */
878 struct i40e_tunnel_filter_input {
879 	uint8_t outer_mac[6];    /* Outer mac address to match */
880 	uint8_t inner_mac[6];    /* Inner mac address to match */
881 	uint16_t inner_vlan;     /* Inner vlan address to match */
882 	enum i40e_tunnel_iptype ip_type;
883 	uint16_t flags;          /* Filter type flag */
884 	uint32_t tenant_id;      /* Tenant id to match */
885 	uint16_t general_fields[32];  /* Big buffer */
886 };
887 
888 struct i40e_tunnel_filter {
889 	TAILQ_ENTRY(i40e_tunnel_filter) rules;
890 	struct i40e_tunnel_filter_input input;
891 	uint8_t is_to_vf; /* 0 - to PF, 1 - to VF */
892 	uint16_t vf_id;   /* VF id, avaiblable when is_to_vf is 1. */
893 	uint16_t queue; /* Queue assigned to when match */
894 };
895 
896 TAILQ_HEAD(i40e_tunnel_filter_list, i40e_tunnel_filter);
897 
898 struct i40e_tunnel_rule {
899 	struct i40e_tunnel_filter_list tunnel_list;
900 	struct i40e_tunnel_filter  **hash_map;
901 	struct rte_hash *hash_table;
902 };
903 
904 /**
905  * Tunnel type.
906  */
907 enum i40e_tunnel_type {
908 	I40E_TUNNEL_TYPE_NONE = 0,
909 	I40E_TUNNEL_TYPE_VXLAN,
910 	I40E_TUNNEL_TYPE_GENEVE,
911 	I40E_TUNNEL_TYPE_TEREDO,
912 	I40E_TUNNEL_TYPE_NVGRE,
913 	I40E_TUNNEL_TYPE_IP_IN_GRE,
914 	I40E_L2_TUNNEL_TYPE_E_TAG,
915 	I40E_TUNNEL_TYPE_MPLSoUDP,
916 	I40E_TUNNEL_TYPE_MPLSoGRE,
917 	I40E_TUNNEL_TYPE_QINQ,
918 	I40E_TUNNEL_TYPE_GTPC,
919 	I40E_TUNNEL_TYPE_GTPU,
920 	I40E_TUNNEL_TYPE_ESPoUDP,
921 	I40E_TUNNEL_TYPE_ESPoIP,
922 	I40E_CLOUD_TYPE_UDP,
923 	I40E_CLOUD_TYPE_TCP,
924 	I40E_CLOUD_TYPE_SCTP,
925 	I40E_TUNNEL_TYPE_MAX,
926 };
927 
928 /**
929  * L4 port type.
930  */
931 enum i40e_l4_port_type {
932 	I40E_L4_PORT_TYPE_SRC = 0,
933 	I40E_L4_PORT_TYPE_DST,
934 };
935 
936 /**
937  * Tunneling Packet filter configuration.
938  */
939 struct i40e_tunnel_filter_conf {
940 	struct rte_ether_addr outer_mac;    /**< Outer MAC address to match. */
941 	struct rte_ether_addr inner_mac;    /**< Inner MAC address to match. */
942 	uint16_t inner_vlan;            /**< Inner VLAN to match. */
943 	uint32_t outer_vlan;            /**< Outer VLAN to match */
944 	enum i40e_tunnel_iptype ip_type; /**< IP address type. */
945 	/**
946 	 * Outer destination IP address to match if ETH_TUNNEL_FILTER_OIP
947 	 * is set in filter_type, or inner destination IP address to match
948 	 * if ETH_TUNNEL_FILTER_IIP is set in filter_type.
949 	 */
950 	union {
951 		uint32_t ipv4_addr;     /**< IPv4 address in big endian. */
952 		uint32_t ipv6_addr[4];  /**< IPv6 address in big endian. */
953 	} ip_addr;
954 	/** Flags from ETH_TUNNEL_FILTER_XX - see above. */
955 	uint16_t filter_type;
956 	enum i40e_tunnel_type tunnel_type; /**< Tunnel Type. */
957 	enum i40e_l4_port_type l4_port_type; /**< L4 Port Type. */
958 	uint32_t tenant_id;     /**< Tenant ID to match. VNI, GRE key... */
959 	uint16_t queue_id;      /**< Queue assigned to if match. */
960 	uint8_t is_to_vf;       /**< 0 - to PF, 1 - to VF */
961 	uint16_t vf_id;         /**< VF id, avaiblable when is_to_vf is 1. */
962 };
963 
964 #define I40E_MIRROR_MAX_ENTRIES_PER_RULE   64
965 #define I40E_MAX_MIRROR_RULES           64
966 /*
967  * Mirror rule structure
968  */
969 struct i40e_mirror_rule {
970 	TAILQ_ENTRY(i40e_mirror_rule) rules;
971 	uint8_t rule_type;
972 	uint16_t index;          /* the sw index of mirror rule */
973 	uint16_t id;             /* the rule id assigned by firmware */
974 	uint16_t dst_vsi_seid;   /* destination vsi for this mirror rule. */
975 	uint16_t num_entries;
976 	/* the info stores depend on the rule type.
977 	    If type is I40E_MIRROR_TYPE_VLAN, vlan ids are stored here.
978 	    If type is I40E_MIRROR_TYPE_VPORT_*, vsi's seid are stored.
979 	 */
980 	uint16_t entries[I40E_MIRROR_MAX_ENTRIES_PER_RULE];
981 };
982 
983 TAILQ_HEAD(i40e_mirror_rule_list, i40e_mirror_rule);
984 
985 TAILQ_HEAD(i40e_flow_list, rte_flow);
986 
987 /* Struct to store Traffic Manager shaper profile. */
988 struct i40e_tm_shaper_profile {
989 	TAILQ_ENTRY(i40e_tm_shaper_profile) node;
990 	uint32_t shaper_profile_id;
991 	uint32_t reference_count;
992 	struct rte_tm_shaper_params profile;
993 };
994 
995 TAILQ_HEAD(i40e_shaper_profile_list, i40e_tm_shaper_profile);
996 
997 /* node type of Traffic Manager */
998 enum i40e_tm_node_type {
999 	I40E_TM_NODE_TYPE_PORT,
1000 	I40E_TM_NODE_TYPE_TC,
1001 	I40E_TM_NODE_TYPE_QUEUE,
1002 	I40E_TM_NODE_TYPE_MAX,
1003 };
1004 
1005 /* Struct to store Traffic Manager node configuration. */
1006 struct i40e_tm_node {
1007 	TAILQ_ENTRY(i40e_tm_node) node;
1008 	uint32_t id;
1009 	uint32_t priority;
1010 	uint32_t weight;
1011 	uint32_t reference_count;
1012 	struct i40e_tm_node *parent;
1013 	struct i40e_tm_shaper_profile *shaper_profile;
1014 	struct rte_tm_node_params params;
1015 };
1016 
1017 TAILQ_HEAD(i40e_tm_node_list, i40e_tm_node);
1018 
1019 /* Struct to store all the Traffic Manager configuration. */
1020 struct i40e_tm_conf {
1021 	struct i40e_shaper_profile_list shaper_profile_list;
1022 	struct i40e_tm_node *root; /* root node - port */
1023 	struct i40e_tm_node_list tc_list; /* node list for all the TCs */
1024 	struct i40e_tm_node_list queue_list; /* node list for all the queues */
1025 	/**
1026 	 * The number of added TC nodes.
1027 	 * It should be no more than the TC number of this port.
1028 	 */
1029 	uint32_t nb_tc_node;
1030 	/**
1031 	 * The number of added queue nodes.
1032 	 * It should be no more than the queue number of this port.
1033 	 */
1034 	uint32_t nb_queue_node;
1035 	/**
1036 	 * This flag is used to check if APP can change the TM node
1037 	 * configuration.
1038 	 * When it's true, means the configuration is applied to HW,
1039 	 * APP should not change the configuration.
1040 	 * As we don't support on-the-fly configuration, when starting
1041 	 * the port, APP should call the hierarchy_commit API to set this
1042 	 * flag to true. When stopping the port, this flag should be set
1043 	 * to false.
1044 	 */
1045 	bool committed;
1046 };
1047 
1048 enum i40e_new_pctype {
1049 	I40E_CUSTOMIZED_GTPC = 0,
1050 	I40E_CUSTOMIZED_GTPU_IPV4,
1051 	I40E_CUSTOMIZED_GTPU_IPV6,
1052 	I40E_CUSTOMIZED_GTPU,
1053 	I40E_CUSTOMIZED_IPV4_L2TPV3,
1054 	I40E_CUSTOMIZED_IPV6_L2TPV3,
1055 	I40E_CUSTOMIZED_ESP_IPV4,
1056 	I40E_CUSTOMIZED_ESP_IPV6,
1057 	I40E_CUSTOMIZED_ESP_IPV4_UDP,
1058 	I40E_CUSTOMIZED_ESP_IPV6_UDP,
1059 	I40E_CUSTOMIZED_AH_IPV4,
1060 	I40E_CUSTOMIZED_AH_IPV6,
1061 	I40E_CUSTOMIZED_MAX,
1062 };
1063 
1064 #define I40E_FILTER_PCTYPE_INVALID     0
1065 struct i40e_customized_pctype {
1066 	enum i40e_new_pctype index;  /* Indicate which customized pctype */
1067 	uint8_t pctype;   /* New pctype value */
1068 	bool valid;   /* Check if it's valid */
1069 };
1070 
1071 struct i40e_rte_flow_rss_conf {
1072 	struct rte_flow_action_rss conf;	/**< RSS parameters. */
1073 
1074 	uint8_t key[(I40E_VFQF_HKEY_MAX_INDEX > I40E_PFQF_HKEY_MAX_INDEX ?
1075 		     I40E_VFQF_HKEY_MAX_INDEX : I40E_PFQF_HKEY_MAX_INDEX + 1) *
1076 		    sizeof(uint32_t)];		/**< Hash key. */
1077 	uint16_t queue[ETH_RSS_RETA_SIZE_512];	/**< Queues indices to use. */
1078 
1079 	bool symmetric_enable;		/**< true, if enable symmetric */
1080 	uint64_t config_pctypes;	/**< All PCTYPES with the flow  */
1081 	uint64_t inset;			/**< input sets */
1082 
1083 	uint8_t region_priority;	/**< queue region priority */
1084 	uint8_t region_queue_num;	/**< region queue number */
1085 	uint16_t region_queue_start;	/**< region queue start */
1086 
1087 	uint32_t misc_reset_flags;
1088 #define I40E_HASH_FLOW_RESET_FLAG_FUNC		0x01UL
1089 #define I40E_HASH_FLOW_RESET_FLAG_KEY		0x02UL
1090 #define I40E_HASH_FLOW_RESET_FLAG_QUEUE		0x04UL
1091 #define I40E_HASH_FLOW_RESET_FLAG_REGION	0x08UL
1092 
1093 	/**< All PCTYPES that reset with the flow  */
1094 	uint64_t reset_config_pctypes;
1095 	/**< Symmetric function should reset on PCTYPES */
1096 	uint64_t reset_symmetric_pctypes;
1097 };
1098 
1099 /* RSS filter list structure */
1100 struct i40e_rss_filter {
1101 	TAILQ_ENTRY(i40e_rss_filter) next;
1102 	struct i40e_rte_flow_rss_conf rss_filter_info;
1103 };
1104 
1105 TAILQ_HEAD(i40e_rss_conf_list, i40e_rss_filter);
1106 
1107 struct i40e_vf_msg_cfg {
1108 	/* maximal VF message during a statistic period */
1109 	uint32_t max_msg;
1110 
1111 	/* statistic period, in second */
1112 	uint32_t period;
1113 	/*
1114 	 * If message statistics from a VF exceed the maximal limitation,
1115 	 * the PF will ignore any new message from that VF for
1116 	 * 'ignor_second' time.
1117 	 */
1118 	uint32_t ignore_second;
1119 };
1120 
1121 /*
1122  * Structure to store private data specific for PF instance.
1123  */
1124 struct i40e_pf {
1125 	struct i40e_adapter *adapter; /* The adapter this PF associate to */
1126 	struct i40e_vsi *main_vsi; /* pointer to main VSI structure */
1127 	uint16_t mac_seid; /* The seid of the MAC of this PF */
1128 	uint16_t main_vsi_seid; /* The seid of the main VSI */
1129 	uint16_t max_num_vsi;
1130 	struct i40e_res_pool_info qp_pool;    /*Queue pair pool */
1131 	struct i40e_res_pool_info msix_pool;  /* MSIX interrupt pool */
1132 
1133 	struct i40e_hw_port_stats stats_offset;
1134 	struct i40e_hw_port_stats stats;
1135 	/* internal packet statistics, it should be excluded from the total */
1136 	struct i40e_eth_stats internal_stats_offset;
1137 	struct i40e_eth_stats internal_stats;
1138 	bool offset_loaded;
1139 
1140 	struct rte_eth_dev_data *dev_data; /* Pointer to the device data */
1141 	struct rte_ether_addr dev_addr; /* PF device mac address */
1142 	uint64_t flags; /* PF feature flags */
1143 	/* All kinds of queue pair setting for different VSIs */
1144 	struct i40e_pf_vf *vfs;
1145 	uint16_t vf_num;
1146 	/* Each of below queue pairs should be power of 2 since it's the
1147 	   precondition after TC configuration applied */
1148 	uint16_t lan_nb_qp_max;
1149 	uint16_t lan_nb_qps; /* The number of queue pairs of LAN */
1150 	uint16_t lan_qp_offset;
1151 	uint16_t vmdq_nb_qp_max;
1152 	uint16_t vmdq_nb_qps; /* The number of queue pairs of VMDq */
1153 	uint16_t vmdq_qp_offset;
1154 	uint16_t vf_nb_qp_max;
1155 	uint16_t vf_nb_qps; /* The number of queue pairs of VF */
1156 	uint16_t vf_qp_offset;
1157 	uint16_t fdir_nb_qps; /* The number of queue pairs of Flow Director */
1158 	uint16_t fdir_qp_offset;
1159 
1160 	uint16_t hash_lut_size; /* The size of hash lookup table */
1161 	bool hash_filter_enabled;
1162 	uint64_t hash_enabled_queues;
1163 	/* input set bits for each pctype */
1164 	uint64_t hash_input_set[I40E_FILTER_PCTYPE_MAX];
1165 	/* store VXLAN UDP ports */
1166 	uint16_t vxlan_ports[I40E_MAX_PF_UDP_OFFLOAD_PORTS];
1167 	uint16_t vxlan_bitmap; /* Vxlan bit mask */
1168 
1169 	/* VMDQ related info */
1170 	uint16_t max_nb_vmdq_vsi; /* Max number of VMDQ VSIs supported */
1171 	uint16_t nb_cfg_vmdq_vsi; /* number of VMDQ VSIs configured */
1172 	struct i40e_vmdq_info *vmdq;
1173 
1174 	struct i40e_fdir_info fdir; /* flow director info */
1175 	struct i40e_ethertype_rule ethertype; /* Ethertype filter rule */
1176 	struct i40e_tunnel_rule tunnel; /* Tunnel filter rule */
1177 	struct i40e_rss_conf_list rss_config_list; /* RSS rule list */
1178 	struct i40e_queue_regions queue_region; /* queue region info */
1179 	struct i40e_fc_conf fc_conf; /* Flow control conf */
1180 	struct i40e_mirror_rule_list mirror_list;
1181 	uint16_t nb_mirror_rule;   /* The number of mirror rules */
1182 	bool floating_veb; /* The flag to use the floating VEB */
1183 	/* The floating enable flag for the specific VF */
1184 	bool floating_veb_list[I40E_MAX_VF];
1185 	struct i40e_flow_list flow_list;
1186 	bool mpls_replace_flag;  /* 1 - MPLS filter replace is done */
1187 	bool gtp_replace_flag;   /* 1 - GTP-C/U filter replace is done */
1188 	bool qinq_replace_flag;  /* QINQ filter replace is done */
1189 	/* l4 port flag */
1190 	bool sport_replace_flag;   /* Source port replace is done */
1191 	bool dport_replace_flag;   /* Destination port replace is done */
1192 	struct i40e_tm_conf tm_conf;
1193 	bool support_multi_driver; /* 1 - support multiple driver */
1194 
1195 	/* Dynamic Device Personalization */
1196 	bool gtp_support; /* 1 - support GTP-C and GTP-U */
1197 	bool esp_support; /* 1 - support ESP SPI */
1198 	/* customer customized pctype */
1199 	struct i40e_customized_pctype customized_pctype[I40E_CUSTOMIZED_MAX];
1200 	/* Switch Domain Id */
1201 	uint16_t switch_domain_id;
1202 
1203 	struct i40e_vf_msg_cfg vf_msg_cfg;
1204 	uint64_t prev_rx_bytes;
1205 	uint64_t prev_tx_bytes;
1206 	uint64_t internal_prev_rx_bytes;
1207 	uint64_t internal_prev_tx_bytes;
1208 };
1209 
1210 enum pending_msg {
1211 	PFMSG_LINK_CHANGE = 0x1,
1212 	PFMSG_RESET_IMPENDING = 0x2,
1213 	PFMSG_DRIVER_CLOSE = 0x4,
1214 };
1215 
1216 struct i40e_vsi_vlan_pvid_info {
1217 	uint16_t on;            /* Enable or disable pvid */
1218 	union {
1219 		uint16_t pvid;  /* Valid in case 'on' is set to set pvid */
1220 		struct {
1221 		/*  Valid in case 'on' is cleared. 'tagged' will reject tagged packets,
1222 		 *  while 'untagged' will reject untagged packets.
1223 		 */
1224 			uint8_t tagged;
1225 			uint8_t untagged;
1226 		} reject;
1227 	} config;
1228 };
1229 
1230 struct i40e_vf_rx_queues {
1231 	uint64_t rx_dma_addr;
1232 	uint32_t rx_ring_len;
1233 	uint32_t buff_size;
1234 };
1235 
1236 struct i40e_vf_tx_queues {
1237 	uint64_t tx_dma_addr;
1238 	uint32_t tx_ring_len;
1239 };
1240 
1241 /*
1242  * Structure to store private data specific for VF instance.
1243  */
1244 struct i40e_vf {
1245 	struct i40e_adapter *adapter; /* The adapter this VF associate to */
1246 	struct rte_eth_dev_data *dev_data; /* Pointer to the device data */
1247 	uint16_t num_queue_pairs;
1248 	uint16_t max_pkt_len; /* Maximum packet length */
1249 	bool promisc_unicast_enabled;
1250 	bool promisc_multicast_enabled;
1251 
1252 	rte_spinlock_t cmd_send_lock;
1253 	uint32_t version_major; /* Major version number */
1254 	uint32_t version_minor; /* Minor version number */
1255 	uint16_t promisc_flags; /* Promiscuous setting */
1256 	uint32_t vlan[I40E_VFTA_SIZE]; /* VLAN bit map */
1257 
1258 	/* Multicast addrs */
1259 	struct rte_ether_addr mc_addrs[I40E_NUM_MACADDR_MAX];
1260 	uint16_t mc_addrs_num;   /* Multicast mac addresses number */
1261 
1262 	/* Event from pf */
1263 	bool dev_closed;
1264 	bool link_up;
1265 	enum virtchnl_link_speed link_speed;
1266 	bool vf_reset;
1267 	volatile uint32_t pend_cmd; /* pending command not finished yet */
1268 	int32_t cmd_retval; /* return value of the cmd response from PF */
1269 	u16 pend_msg; /* flags indicates events from pf not handled yet */
1270 	uint8_t *aq_resp; /* buffer to store the adminq response from PF */
1271 
1272 	/* VSI info */
1273 	struct virtchnl_vf_resource *vf_res; /* All VSIs */
1274 	struct virtchnl_vsi_resource *vsi_res; /* LAN VSI */
1275 	struct i40e_vsi vsi;
1276 	uint64_t flags;
1277 };
1278 
1279 #define I40E_MAX_PKT_TYPE  256
1280 #define I40E_FLOW_TYPE_MAX 64
1281 
1282 /*
1283  * Structure to store private data for each PF/VF instance.
1284  */
1285 struct i40e_adapter {
1286 	/* Common for both PF and VF */
1287 	struct i40e_hw hw;
1288 	struct rte_eth_dev *eth_dev;
1289 
1290 	/* Specific for PF or VF */
1291 	union {
1292 		struct i40e_pf pf;
1293 		struct i40e_vf vf;
1294 	};
1295 
1296 	/* For vector PMD */
1297 	bool rx_bulk_alloc_allowed;
1298 	bool rx_vec_allowed;
1299 	bool tx_simple_allowed;
1300 	bool tx_vec_allowed;
1301 
1302 	/* For PTP */
1303 	struct rte_timecounter systime_tc;
1304 	struct rte_timecounter rx_tstamp_tc;
1305 	struct rte_timecounter tx_tstamp_tc;
1306 
1307 	/* ptype mapping table */
1308 	uint32_t ptype_tbl[I40E_MAX_PKT_TYPE] __rte_cache_min_aligned;
1309 	/* flow type to pctype mapping table */
1310 	uint64_t pctypes_tbl[I40E_FLOW_TYPE_MAX] __rte_cache_min_aligned;
1311 	uint64_t flow_types_mask;
1312 	uint64_t pctypes_mask;
1313 
1314 	/* For RSS reta table update */
1315 	uint8_t rss_reta_updated;
1316 };
1317 
1318 /**
1319  * Strucute to store private data for each VF representor instance
1320  */
1321 struct i40e_vf_representor {
1322 	uint16_t switch_domain_id;
1323 	/**< Virtual Function ID */
1324 	uint16_t vf_id;
1325 	/**< Virtual Function ID */
1326 	struct i40e_adapter *adapter;
1327 	/**< Private data store of assocaiated physical function */
1328 	struct i40e_eth_stats stats_offset;
1329 	/**< Zero-point of VF statistics*/
1330 };
1331 
1332 extern const struct rte_flow_ops i40e_flow_ops;
1333 
1334 union i40e_filter_t {
1335 	struct rte_eth_ethertype_filter ethertype_filter;
1336 	struct i40e_fdir_filter_conf fdir_filter;
1337 	struct rte_eth_tunnel_filter_conf tunnel_filter;
1338 	struct i40e_tunnel_filter_conf consistent_tunnel_filter;
1339 	struct i40e_rte_flow_rss_conf rss_conf;
1340 };
1341 
1342 typedef int (*parse_filter_t)(struct rte_eth_dev *dev,
1343 			      const struct rte_flow_attr *attr,
1344 			      const struct rte_flow_item pattern[],
1345 			      const struct rte_flow_action actions[],
1346 			      struct rte_flow_error *error,
1347 			      union i40e_filter_t *filter);
1348 struct i40e_valid_pattern {
1349 	enum rte_flow_item_type *items;
1350 	parse_filter_t parse_filter;
1351 };
1352 
1353 int i40e_dev_switch_queues(struct i40e_pf *pf, bool on);
1354 int i40e_vsi_release(struct i40e_vsi *vsi);
1355 struct i40e_vsi *i40e_vsi_setup(struct i40e_pf *pf,
1356 				enum i40e_vsi_type type,
1357 				struct i40e_vsi *uplink_vsi,
1358 				uint16_t user_param);
1359 int i40e_switch_rx_queue(struct i40e_hw *hw, uint16_t q_idx, bool on);
1360 int i40e_switch_tx_queue(struct i40e_hw *hw, uint16_t q_idx, bool on);
1361 int i40e_vsi_add_vlan(struct i40e_vsi *vsi, uint16_t vlan);
1362 int i40e_vsi_delete_vlan(struct i40e_vsi *vsi, uint16_t vlan);
1363 int i40e_vsi_add_mac(struct i40e_vsi *vsi, struct i40e_mac_filter_info *filter);
1364 int i40e_vsi_delete_mac(struct i40e_vsi *vsi, struct rte_ether_addr *addr);
1365 void i40e_update_vsi_stats(struct i40e_vsi *vsi);
1366 void i40e_pf_disable_irq0(struct i40e_hw *hw);
1367 void i40e_pf_enable_irq0(struct i40e_hw *hw);
1368 int i40e_dev_link_update(struct rte_eth_dev *dev, int wait_to_complete);
1369 int i40e_vsi_queues_bind_intr(struct i40e_vsi *vsi, uint16_t itr_idx);
1370 void i40e_vsi_queues_unbind_intr(struct i40e_vsi *vsi);
1371 void i40e_vsi_disable_queues_intr(struct i40e_vsi *vsi);
1372 int i40e_vsi_vlan_pvid_set(struct i40e_vsi *vsi,
1373 			   struct i40e_vsi_vlan_pvid_info *info);
1374 int i40e_vsi_config_vlan_stripping(struct i40e_vsi *vsi, bool on);
1375 int i40e_vsi_config_vlan_filter(struct i40e_vsi *vsi, bool on);
1376 uint64_t i40e_config_hena(const struct i40e_adapter *adapter, uint64_t flags);
1377 uint64_t i40e_parse_hena(const struct i40e_adapter *adapter, uint64_t flags);
1378 enum i40e_status_code i40e_fdir_setup_tx_resources(struct i40e_pf *pf);
1379 enum i40e_status_code i40e_fdir_setup_rx_resources(struct i40e_pf *pf);
1380 int i40e_fdir_setup(struct i40e_pf *pf);
1381 void i40e_vsi_enable_queues_intr(struct i40e_vsi *vsi);
1382 const struct rte_memzone *i40e_memzone_reserve(const char *name,
1383 					uint32_t len,
1384 					int socket_id);
1385 int i40e_fdir_configure(struct rte_eth_dev *dev);
1386 void i40e_fdir_rx_proc_enable(struct rte_eth_dev *dev, bool on);
1387 void i40e_fdir_teardown(struct i40e_pf *pf);
1388 enum i40e_filter_pctype
1389 	i40e_flowtype_to_pctype(const struct i40e_adapter *adapter,
1390 				uint16_t flow_type);
1391 uint16_t i40e_pctype_to_flowtype(const struct i40e_adapter *adapter,
1392 				 enum i40e_filter_pctype pctype);
1393 int i40e_dev_set_gre_key_len(struct i40e_hw *hw, uint8_t len);
1394 void i40e_fdir_info_get(struct rte_eth_dev *dev,
1395 			struct rte_eth_fdir_info *fdir);
1396 void i40e_fdir_stats_get(struct rte_eth_dev *dev,
1397 			 struct rte_eth_fdir_stats *stat);
1398 int i40e_select_filter_input_set(struct i40e_hw *hw,
1399 				 struct rte_eth_input_set_conf *conf,
1400 				 enum rte_filter_type filter);
1401 void i40e_fdir_filter_restore(struct i40e_pf *pf);
1402 int i40e_set_hash_inset(struct i40e_hw *hw, uint64_t input_set,
1403 			uint32_t pctype, bool add);
1404 int i40e_pf_host_send_msg_to_vf(struct i40e_pf_vf *vf, uint32_t opcode,
1405 				uint32_t retval, uint8_t *msg,
1406 				uint16_t msglen);
1407 void i40e_rxq_info_get(struct rte_eth_dev *dev, uint16_t queue_id,
1408 	struct rte_eth_rxq_info *qinfo);
1409 void i40e_txq_info_get(struct rte_eth_dev *dev, uint16_t queue_id,
1410 	struct rte_eth_txq_info *qinfo);
1411 int i40e_rx_burst_mode_get(struct rte_eth_dev *dev, uint16_t queue_id,
1412 			   struct rte_eth_burst_mode *mode);
1413 int i40e_tx_burst_mode_get(struct rte_eth_dev *dev, uint16_t queue_id,
1414 			   struct rte_eth_burst_mode *mode);
1415 struct i40e_ethertype_filter *
1416 i40e_sw_ethertype_filter_lookup(struct i40e_ethertype_rule *ethertype_rule,
1417 			const struct i40e_ethertype_filter_input *input);
1418 int i40e_sw_ethertype_filter_del(struct i40e_pf *pf,
1419 				 struct i40e_ethertype_filter_input *input);
1420 int i40e_sw_fdir_filter_del(struct i40e_pf *pf,
1421 			    struct i40e_fdir_input *input);
1422 struct i40e_tunnel_filter *
1423 i40e_sw_tunnel_filter_lookup(struct i40e_tunnel_rule *tunnel_rule,
1424 			     const struct i40e_tunnel_filter_input *input);
1425 int i40e_sw_tunnel_filter_del(struct i40e_pf *pf,
1426 			      struct i40e_tunnel_filter_input *input);
1427 uint64_t i40e_get_default_input_set(uint16_t pctype);
1428 int i40e_ethertype_filter_set(struct i40e_pf *pf,
1429 			      struct rte_eth_ethertype_filter *filter,
1430 			      bool add);
1431 struct rte_flow *
1432 i40e_fdir_entry_pool_get(struct i40e_fdir_info *fdir_info);
1433 void i40e_fdir_entry_pool_put(struct i40e_fdir_info *fdir_info,
1434 		struct rte_flow *flow);
1435 int i40e_flow_add_del_fdir_filter(struct rte_eth_dev *dev,
1436 			      const struct i40e_fdir_filter_conf *filter,
1437 			      bool add);
1438 int i40e_dev_tunnel_filter_set(struct i40e_pf *pf,
1439 			       struct rte_eth_tunnel_filter_conf *tunnel_filter,
1440 			       uint8_t add);
1441 int i40e_dev_consistent_tunnel_filter_set(struct i40e_pf *pf,
1442 				  struct i40e_tunnel_filter_conf *tunnel_filter,
1443 				  uint8_t add);
1444 int i40e_fdir_flush(struct rte_eth_dev *dev);
1445 int i40e_find_all_vlan_for_mac(struct i40e_vsi *vsi,
1446 			       struct i40e_macvlan_filter *mv_f,
1447 			       int num, struct rte_ether_addr *addr);
1448 int i40e_remove_macvlan_filters(struct i40e_vsi *vsi,
1449 				struct i40e_macvlan_filter *filter,
1450 				int total);
1451 void i40e_set_vlan_filter(struct i40e_vsi *vsi, uint16_t vlan_id, bool on);
1452 int i40e_add_macvlan_filters(struct i40e_vsi *vsi,
1453 			     struct i40e_macvlan_filter *filter,
1454 			     int total);
1455 bool is_device_supported(struct rte_eth_dev *dev, struct rte_pci_driver *drv);
1456 bool is_i40e_supported(struct rte_eth_dev *dev);
1457 bool is_i40evf_supported(struct rte_eth_dev *dev);
1458 void i40e_set_symmetric_hash_enable_per_port(struct i40e_hw *hw,
1459 					     uint8_t enable);
1460 int i40e_validate_input_set(enum i40e_filter_pctype pctype,
1461 			    enum rte_filter_type filter, uint64_t inset);
1462 int i40e_generate_inset_mask_reg(struct i40e_hw *hw, uint64_t inset,
1463 				 uint32_t *mask, uint8_t nb_elem);
1464 uint64_t i40e_translate_input_set_reg(enum i40e_mac_type type, uint64_t input);
1465 void i40e_check_write_reg(struct i40e_hw *hw, uint32_t addr, uint32_t val);
1466 void i40e_check_write_global_reg(struct i40e_hw *hw,
1467 				 uint32_t addr, uint32_t val);
1468 
1469 int i40e_tm_ops_get(struct rte_eth_dev *dev, void *ops);
1470 void i40e_tm_conf_init(struct rte_eth_dev *dev);
1471 void i40e_tm_conf_uninit(struct rte_eth_dev *dev);
1472 struct i40e_customized_pctype*
1473 i40e_find_customized_pctype(struct i40e_pf *pf, uint8_t index);
1474 void i40e_update_customized_info(struct rte_eth_dev *dev, uint8_t *pkg,
1475 				 uint32_t pkg_size,
1476 				 enum rte_pmd_i40e_package_op op);
1477 int i40e_dcb_init_configure(struct rte_eth_dev *dev, bool sw_dcb);
1478 int i40e_flush_queue_region_all_conf(struct rte_eth_dev *dev,
1479 		struct i40e_hw *hw, struct i40e_pf *pf, uint16_t on);
1480 void i40e_init_queue_region_conf(struct rte_eth_dev *dev);
1481 void i40e_flex_payload_reg_set_default(struct i40e_hw *hw);
1482 void i40e_pf_disable_rss(struct i40e_pf *pf);
1483 int i40e_pf_calc_configured_queues_num(struct i40e_pf *pf);
1484 int i40e_pf_reset_rss_reta(struct i40e_pf *pf);
1485 int i40e_pf_reset_rss_key(struct i40e_pf *pf);
1486 int i40e_pf_config_rss(struct i40e_pf *pf);
1487 int i40e_set_rss_key(struct i40e_vsi *vsi, uint8_t *key, uint8_t key_len);
1488 int i40e_set_rss_lut(struct i40e_vsi *vsi, uint8_t *lut, uint16_t lut_size);
1489 int i40e_vf_representor_init(struct rte_eth_dev *ethdev, void *init_params);
1490 int i40e_vf_representor_uninit(struct rte_eth_dev *ethdev);
1491 
1492 #define I40E_DEV_TO_PCI(eth_dev) \
1493 	RTE_DEV_TO_PCI((eth_dev)->device)
1494 
1495 /* I40E_DEV_PRIVATE_TO */
1496 #define I40E_DEV_PRIVATE_TO_PF(adapter) \
1497 	(&((struct i40e_adapter *)adapter)->pf)
1498 #define I40E_DEV_PRIVATE_TO_HW(adapter) \
1499 	(&((struct i40e_adapter *)adapter)->hw)
1500 #define I40E_DEV_PRIVATE_TO_ADAPTER(adapter) \
1501 	((struct i40e_adapter *)adapter)
1502 
1503 /* I40EVF_DEV_PRIVATE_TO */
1504 #define I40EVF_DEV_PRIVATE_TO_VF(adapter) \
1505 	(&((struct i40e_adapter *)adapter)->vf)
1506 
1507 static inline struct i40e_vsi *
1508 i40e_get_vsi_from_adapter(struct i40e_adapter *adapter)
1509 {
1510 	struct i40e_hw *hw;
1511 
1512         if (!adapter)
1513                 return NULL;
1514 
1515 	hw = I40E_DEV_PRIVATE_TO_HW(adapter);
1516 	if (hw->mac.type == I40E_MAC_VF || hw->mac.type == I40E_MAC_X722_VF) {
1517 		struct i40e_vf *vf = I40EVF_DEV_PRIVATE_TO_VF(adapter);
1518 		return &vf->vsi;
1519 	} else {
1520 		struct i40e_pf *pf = I40E_DEV_PRIVATE_TO_PF(adapter);
1521 		return pf->main_vsi;
1522 	}
1523 }
1524 #define I40E_DEV_PRIVATE_TO_MAIN_VSI(adapter) \
1525 	i40e_get_vsi_from_adapter((struct i40e_adapter *)adapter)
1526 
1527 /* I40E_VSI_TO */
1528 #define I40E_VSI_TO_HW(vsi) \
1529 	(&(((struct i40e_vsi *)vsi)->adapter->hw))
1530 #define I40E_VSI_TO_PF(vsi) \
1531 	(&(((struct i40e_vsi *)vsi)->adapter->pf))
1532 #define I40E_VSI_TO_VF(vsi) \
1533 	(&(((struct i40e_vsi *)vsi)->adapter->vf))
1534 #define I40E_VSI_TO_DEV_DATA(vsi) \
1535 	(((struct i40e_vsi *)vsi)->adapter->pf.dev_data)
1536 #define I40E_VSI_TO_ETH_DEV(vsi) \
1537 	(((struct i40e_vsi *)vsi)->adapter->eth_dev)
1538 
1539 /* I40E_PF_TO */
1540 #define I40E_PF_TO_HW(pf) \
1541 	(&(((struct i40e_pf *)pf)->adapter->hw))
1542 #define I40E_PF_TO_ADAPTER(pf) \
1543 	((struct i40e_adapter *)pf->adapter)
1544 
1545 /* I40E_VF_TO */
1546 #define I40E_VF_TO_HW(vf) \
1547 	(&(((struct i40e_vf *)vf)->adapter->hw))
1548 
1549 static inline void
1550 i40e_init_adminq_parameter(struct i40e_hw *hw)
1551 {
1552 	hw->aq.num_arq_entries = I40E_AQ_LEN;
1553 	hw->aq.num_asq_entries = I40E_AQ_LEN;
1554 	hw->aq.arq_buf_size = I40E_AQ_BUF_SZ;
1555 	hw->aq.asq_buf_size = I40E_AQ_BUF_SZ;
1556 }
1557 
1558 static inline int
1559 i40e_align_floor(int n)
1560 {
1561 	if (n == 0)
1562 		return 0;
1563 	return 1 << (sizeof(n) * CHAR_BIT - 1 - __builtin_clz(n));
1564 }
1565 
1566 static inline uint16_t
1567 i40e_calc_itr_interval(bool is_pf, bool is_multi_drv)
1568 {
1569 	uint16_t interval = 0;
1570 
1571 	if (is_multi_drv) {
1572 		interval = I40E_QUEUE_ITR_INTERVAL_MAX;
1573 	} else {
1574 		if (is_pf)
1575 			interval = I40E_QUEUE_ITR_INTERVAL_DEFAULT;
1576 		else
1577 			interval = I40E_VF_QUEUE_ITR_INTERVAL_DEFAULT;
1578 	}
1579 
1580 	/* Convert to hardware count, as writing each 1 represents 2 us */
1581 	return interval / 2;
1582 }
1583 
1584 #define I40E_VALID_FLOW(flow_type) \
1585 	((flow_type) == RTE_ETH_FLOW_FRAG_IPV4 || \
1586 	(flow_type) == RTE_ETH_FLOW_NONFRAG_IPV4_TCP || \
1587 	(flow_type) == RTE_ETH_FLOW_NONFRAG_IPV4_UDP || \
1588 	(flow_type) == RTE_ETH_FLOW_NONFRAG_IPV4_SCTP || \
1589 	(flow_type) == RTE_ETH_FLOW_NONFRAG_IPV4_OTHER || \
1590 	(flow_type) == RTE_ETH_FLOW_FRAG_IPV6 || \
1591 	(flow_type) == RTE_ETH_FLOW_NONFRAG_IPV6_TCP || \
1592 	(flow_type) == RTE_ETH_FLOW_NONFRAG_IPV6_UDP || \
1593 	(flow_type) == RTE_ETH_FLOW_NONFRAG_IPV6_SCTP || \
1594 	(flow_type) == RTE_ETH_FLOW_NONFRAG_IPV6_OTHER || \
1595 	(flow_type) == RTE_ETH_FLOW_L2_PAYLOAD)
1596 
1597 #define I40E_VALID_PCTYPE_X722(pctype) \
1598 	((pctype) == I40E_FILTER_PCTYPE_FRAG_IPV4 || \
1599 	(pctype) == I40E_FILTER_PCTYPE_NONF_IPV4_TCP || \
1600 	(pctype) == I40E_FILTER_PCTYPE_NONF_IPV4_TCP_SYN_NO_ACK || \
1601 	(pctype) == I40E_FILTER_PCTYPE_NONF_IPV4_UDP || \
1602 	(pctype) == I40E_FILTER_PCTYPE_NONF_UNICAST_IPV4_UDP || \
1603 	(pctype) == I40E_FILTER_PCTYPE_NONF_MULTICAST_IPV4_UDP || \
1604 	(pctype) == I40E_FILTER_PCTYPE_NONF_IPV4_SCTP || \
1605 	(pctype) == I40E_FILTER_PCTYPE_NONF_IPV4_OTHER || \
1606 	(pctype) == I40E_FILTER_PCTYPE_FRAG_IPV6 || \
1607 	(pctype) == I40E_FILTER_PCTYPE_NONF_IPV6_UDP || \
1608 	(pctype) == I40E_FILTER_PCTYPE_NONF_UNICAST_IPV6_UDP || \
1609 	(pctype) == I40E_FILTER_PCTYPE_NONF_MULTICAST_IPV6_UDP || \
1610 	(pctype) == I40E_FILTER_PCTYPE_NONF_IPV6_TCP || \
1611 	(pctype) == I40E_FILTER_PCTYPE_NONF_IPV6_TCP_SYN_NO_ACK || \
1612 	(pctype) == I40E_FILTER_PCTYPE_NONF_IPV6_SCTP || \
1613 	(pctype) == I40E_FILTER_PCTYPE_NONF_IPV6_OTHER || \
1614 	(pctype) == I40E_FILTER_PCTYPE_L2_PAYLOAD)
1615 
1616 #define I40E_VALID_PCTYPE(pctype) \
1617 	((pctype) == I40E_FILTER_PCTYPE_FRAG_IPV4 || \
1618 	(pctype) == I40E_FILTER_PCTYPE_NONF_IPV4_TCP || \
1619 	(pctype) == I40E_FILTER_PCTYPE_NONF_IPV4_UDP || \
1620 	(pctype) == I40E_FILTER_PCTYPE_NONF_IPV4_SCTP || \
1621 	(pctype) == I40E_FILTER_PCTYPE_NONF_IPV4_OTHER || \
1622 	(pctype) == I40E_FILTER_PCTYPE_FRAG_IPV6 || \
1623 	(pctype) == I40E_FILTER_PCTYPE_NONF_IPV6_UDP || \
1624 	(pctype) == I40E_FILTER_PCTYPE_NONF_IPV6_TCP || \
1625 	(pctype) == I40E_FILTER_PCTYPE_NONF_IPV6_SCTP || \
1626 	(pctype) == I40E_FILTER_PCTYPE_NONF_IPV6_OTHER || \
1627 	(pctype) == I40E_FILTER_PCTYPE_L2_PAYLOAD)
1628 
1629 #define I40E_PHY_TYPE_SUPPORT_40G(phy_type) \
1630 	(((phy_type) & I40E_CAP_PHY_TYPE_40GBASE_KR4) || \
1631 	((phy_type) & I40E_CAP_PHY_TYPE_40GBASE_CR4_CU) || \
1632 	((phy_type) & I40E_CAP_PHY_TYPE_40GBASE_AOC) || \
1633 	((phy_type) & I40E_CAP_PHY_TYPE_40GBASE_CR4) || \
1634 	((phy_type) & I40E_CAP_PHY_TYPE_40GBASE_SR4) || \
1635 	((phy_type) & I40E_CAP_PHY_TYPE_40GBASE_LR4))
1636 
1637 #define I40E_PHY_TYPE_SUPPORT_25G(phy_type) \
1638 	(((phy_type) & I40E_CAP_PHY_TYPE_25GBASE_KR) || \
1639 	((phy_type) & I40E_CAP_PHY_TYPE_25GBASE_CR) || \
1640 	((phy_type) & I40E_CAP_PHY_TYPE_25GBASE_SR) || \
1641 	((phy_type) & I40E_CAP_PHY_TYPE_25GBASE_LR) || \
1642 	((phy_type) & I40E_CAP_PHY_TYPE_25GBASE_AOC) || \
1643 	((phy_type) & I40E_CAP_PHY_TYPE_25GBASE_ACC))
1644 
1645 #endif /* _I40E_ETHDEV_H_ */
1646